Class: RSpec::Matchers::BuiltIn::YieldControl

### Home Classes Methods

### In Files

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

### Parent

RSpec::Matchers::BuiltIn::BaseMatcher

### Methods

- ::new
- #at_least
- #at_most
- #exactly
- #failure_message_for_should
- #failure_message_for_should_not
- #matches?
- #once
- #times
- #twice

### 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::YieldControl

### Public Class Methods

new() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 68
    def initialize
      @expectation_type = nil
      @expected_yields_count = nil
    end

### Public Instance Methods

at_least(number) click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 103
    def at_least(number)
      set_expected_yields_count(:>=, number)
      self
    end

at_most(number) click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 98
    def at_most(number)
      set_expected_yields_count(:<=, number)
      self
    end

exactly(number) click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 93
    def exactly(number)
      set_expected_yields_count(:==, number)
      self
    end

failure_message_for_should() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 112
    def failure_message_for_should
      'expected given block to yield control'.tap do |failure_message|
        failure_message << relativity_failure_message
      end
    end

failure_message_for_should_not() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 118
    def failure_message_for_should_not
      'expected given block not to yield control'.tap do |failure_message|
        failure_message << relativity_failure_message
      end
    end

matches?(block) click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 73
    def matches?(block)
      probe = YieldProbe.probe(block)

      if @expectation_type
        probe.num_yields.send(@expectation_type, @expected_yields_count)
      else
        probe.yielded_once?(:yield_control)
      end
    end

once() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 83
    def once
      exactly(1)
      self
    end

times() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 108
    def times
      self
    end

twice() click to toggle source

    # File lib/rspec/matchers/built_in/yield.rb, line 88
    def twice
      exactly(2)
      self
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.