123456789_123456789_123456789_123456789_123456789_

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

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, BaseMatcher
Instance Chain:
self, CountExpectation, BaseMatcher, BaseMatcher::DefaultFailureMessages, BaseMatcher::StringEncodingFormatting, BaseMatcher::HashFormatting, ::RSpec::Matchers::Composable
Inherits: RSpec::Matchers::BuiltIn::BaseMatcher
Defined in: rspec-expectations/lib/rspec/matchers/built_in/yield.rb

Overview

Provides the implementation for RSpec::Matchers#yield_control. Not intended to be instantiated directly.

Constant Summary

BaseMatcher - Inherited

UNDEFINED

Class Method Summary

BaseMatcher - Inherited

.matcher_name, .new,
.underscore

Borrowed from ActiveSupport.

Instance Attribute Summary

CountExpectation - Included

#count_expectation_type, #expected_count, #has_expected_count?

BaseMatcher - Inherited

#actual,
#diffable?

::RSpec::Matchers are not diffable by default.
#expected, #expects_call_stack_jump?, #matcher_name, #matcher_name=, #rescued_exception,
#supports_block_expectations?

Most matchers are value matchers (i.e. meant to work with ‘expect(value)`) rather than block matchers (i.e. meant to work with `expect { }`), so this defaults to false.
#supports_value_expectations?

BaseMatcher::StringEncodingFormatting - Included

#string_encoding_differs?

:nocov:

Instance Method Summary

CountExpectation - Included

#at_least

Specifies the minimum number of times the method is expected to match.
#at_most

Specifies the maximum number of times the method is expected to match.
#exactly

Specifies that the method is expected to match the given number of times.
#once

Specifies that the method is expected to match once.
#thrice

Specifies that the method is expected to match thrice.
#times

No-op.
#twice

Specifies that the method is expected to match twice.
#count_constraint_to_number, #count_expectation_description, #count_failure_reason,
#cover?

:nocov:
#expected_count_matches?, #human_readable_count, #human_readable_expectation_type, #raise_impossible_count_expectation, #raise_unsupported_count_expectation, #set_expected_count, #unsupported_count_expectation?

BaseMatcher - Inherited

#actual_formatted,
#description

Generates a description using ::RSpec::Matchers::EnglishPhrasing.
#expected_formatted,
#match_unless_raises

Used to wrap a block of code that will indicate failure by raising one of the named exceptions.
#matches?

Indicates if the match is successful.

BaseMatcher::DefaultFailureMessages - Included

#failure_message

Provides a good generic failure message.
#failure_message_when_negated

Provides a good generic negative failure message.

BaseMatcher::StringEncodingFormatting - Included

#format_encoding

Formats a String’s encoding as a human readable string :nocov:

BaseMatcher::HashFormatting - Included

#improve_hash_formatting

‘{ :a => 5, :b => 2 }.inspect` produces:

::RSpec::Matchers::Composable - Included

#&

Alias for Composable#and.
#===

Delegates to #matches?.
#and

Creates a compound and expectation.
#description_of

Returns the description of the given object in a way that is aware of composed matchers.
#or

Creates a compound or expectation.
#values_match?

This provides a generic way to fuzzy-match an expected value against an actual value.
#|

Alias for Composable#or.
#should_enumerate?

We should enumerate arrays as long as they are not recursive.
#surface_descriptions_in

Transforms the given data structure (typically a hash or array) into a new data structure that, when #inspect is called on it, will provide descriptions of any contained matchers rather than the normal #inspect output.
#unreadable_io?,
#with_matchers_cloned

Historically, a single matcher instance was only checked against a single value.

Instance Attribute Details

#supports_block_expectations? ⇒ Boolean (readonly)

[ GitHub ] 

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/yield.rb', line 128



def supports_block_expectations?
  true
end


  








  

    #supports_value_expectations?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/yield.rb', line 133



def supports_value_expectations?
  false
end


  







Instance Method Details



  

    #does_not_match?(block)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/yield.rb', line 111



def does_not_match?(block)
  !matches?(block) && @probe.has_block?
end


  








  

    #failure_message  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/yield.rb', line 117



def failure_message
  'expected given block to yield control' + failure_reason
end


  








  

    #failure_message_when_negated  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/yield.rb', line 123



def failure_message_when_negated
  'expected given block not to yield control' + failure_reason
end


  








  

    #failure_reason   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/yield.rb', line 139



def failure_reason
  return ' but was not a block' unless @probe.has_block?
  return "#{count_expectation_description} but did not yield" if @probe.num_yields == 0
  count_failure_reason('yielded')
end


  








  

    #matches?(block)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/yield.rb', line 104



def matches?(block)
  @probe = YieldProbe.probe(block)
  return false unless @probe.has_block?
  expected_count_matches?(@probe.num_yields)
end