Class: RSpec::Matchers::BuiltIn::YieldProbe

### Home Classes Methods

### In Files

- lib/rspec/matchers/built_in/yield.rb

### Parent

Object

### Methods

- ::assert_valid_expect_block!
- ::new
- ::probe
- #assert_used!
- #single_yield_args
- #successive_yield_args
- #to_proc
- #yielded_once?

### Class/Module Index

Quicksearch

- RSpec
- RSpec::Expectations
- RSpec::Expectations::DeprecatedConstants
- RSpec::Expectations::Deprecation
- RSpec::Expectations::Differ
- RSpec::Expectations::ExpectationHandler
- RSpec::Expectations::ExpectationNotMetError
- RSpec::Expectations::ExpectationTarget
- RSpec::Expectations::NegativeExpectationHandler
- RSpec::Expectations::PositiveExpectationHandler
- RSpec::Expectations::Syntax
- RSpec::Expectations::Syntax::ExpectExpressionGenerator
- RSpec::Expectations::Syntax::ShouldExpressionGenerator
- RSpec::Expectations::Version
- RSpec::Matchers
- RSpec::Matchers::BuiltIn
- RSpec::Matchers::BuiltIn::BaseMatcher
- RSpec::Matchers::BuiltIn::Be
- RSpec::Matchers::BuiltIn::BeAKindOf
- RSpec::Matchers::BuiltIn::BeAnInstanceOf
- RSpec::Matchers::BuiltIn::BeComparedTo
- RSpec::Matchers::BuiltIn::BeFalse
- RSpec::Matchers::BuiltIn::BeHelpers
- RSpec::Matchers::BuiltIn::BeNil
- RSpec::Matchers::BuiltIn::BePredicate
- RSpec::Matchers::BuiltIn::BeTrue
- RSpec::Matchers::BuiltIn::BeWithin
- RSpec::Matchers::BuiltIn::Change
- RSpec::Matchers::BuiltIn::Cover
- RSpec::Matchers::BuiltIn::EndWith
- RSpec::Matchers::BuiltIn::Eq
- RSpec::Matchers::BuiltIn::Eql
- RSpec::Matchers::BuiltIn::Equal
- RSpec::Matchers::BuiltIn::Exist
- RSpec::Matchers::BuiltIn::Has
- RSpec::Matchers::BuiltIn::Have
- RSpec::Matchers::BuiltIn::Include
- RSpec::Matchers::BuiltIn::Match
- RSpec::Matchers::BuiltIn::MatchArray
- RSpec::Matchers::BuiltIn::NegativeOperatorMatcher
- RSpec::Matchers::BuiltIn::PositiveOperatorMatcher
- RSpec::Matchers::BuiltIn::RaiseError
- RSpec::Matchers::BuiltIn::RespondTo
- RSpec::Matchers::BuiltIn::Satisfy
- RSpec::Matchers::BuiltIn::StartAndEndWith
- RSpec::Matchers::BuiltIn::StartWith
- RSpec::Matchers::BuiltIn::ThrowSymbol
- RSpec::Matchers::BuiltIn::YieldControl
- RSpec::Matchers::BuiltIn::YieldProbe
- RSpec::Matchers::BuiltIn::YieldSuccessiveArgs
- RSpec::Matchers::BuiltIn::YieldWithArgs
- RSpec::Matchers::BuiltIn::YieldWithNoArgs
- RSpec::Matchers::Configuration
- RSpec::Matchers::DSL
- RSpec::Matchers::DSL::Matcher
- RSpec::Matchers::Extensions
- RSpec::Matchers::Extensions::InstanceEvalWithArgs
- RSpec::Matchers::OperatorMatcher
- RSpec::Matchers::Pretty
- Array

No matching classes.

# RSpec::Matchers::BuiltIn::YieldProbe

### Attributes

num_yields[RW]
yielded_args[RW]

### Public Class Methods

assert_valid_expect_block!(block) click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 60
    def self.assert_valid_expect_block!(block)
      return if block.arity == 1
      raise "Your expect block must accept an argument to be used with this " +
            "matcher. Pass the argument as a block on to the method you are testing."
    end

new() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 15
    def initialize
      @used = false
      self.num_yields, self.yielded_args = 0, []
    end

probe(block) click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 5
    def self.probe(block)
      probe = new
      assert_valid_expect_block!(block)
      block.call(probe)
      probe.assert_used!
      probe
    end

### Public Instance Methods

assert_used!() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 51
    def assert_used!
      return if @used
      raise "You must pass the argument yielded to your expect block on " +
            "to the method-under-test as a block. It acts as a probe that " +
            "allows the matcher to detect whether or not the method-under-test " +
            "yields, and, if so, how many times, and what the yielded arguments " +
            "are."
    end

single_yield_args() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 30
    def single_yield_args
      yielded_args.first
    end

successive_yield_args() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 45
    def successive_yield_args
      yielded_args.map do |arg_array|
        arg_array.size == 1 ? arg_array.first : arg_array
      end
    end

to_proc() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 20
    def to_proc
      @used = true

      probe = self
      Proc.new do |*args|
        probe.num_yields += 1
        probe.yielded_args << args
      end
    end

yielded_once?(matcher_name) click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 34
    def yielded_once?(matcher_name)
      case num_yields
      when 1 then true
      when 0 then false
      else
        raise "The #{matcher_name} matcher is not designed to be used with a " +
              "method that yields multiple times. Use the yield_successive_args " +
              "matcher for that case."
      end
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.