123456789_123456789_123456789_123456789_123456789_

Class: RSpec::Matchers::BuiltIn::YieldSuccessiveArgs 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, 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_successive_args. 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

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

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 342



def supports_block_expectations?
  true
end


  








  

    #supports_value_expectations?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


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



def supports_value_expectations?
  false
end


  







Instance Method Details



  

    #description  
  

  [ GitHub ]


  

  


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



def description
  "yield successive args(#{expected_arg_description})"
end


  








  

    #does_not_match?(block)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


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



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


  








  

    #expected_arg_description   (private)
  

  [ GitHub ]


  

  


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



def expected_arg_description
  @expected.map { |e| description_of e }.join(', ')
end


  








  

    #failure_message  
  

  [ GitHub ]


  

  


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



def failure_message
  'expected given block to yield successively with arguments, ' \
  "but #{positive_failure_reason}"
end


  








  

    #failure_message_when_negated  
  

  [ GitHub ]


  

  


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



def failure_message_when_negated
  'expected given block not to yield successively with arguments, ' \
  "but #{negative_failure_reason}"
end


  








  

    #matches?(block)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


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



def matches?(block)
  @actual_formatted = []
  @actual = []
  args_matched_when_yielded = true
  yield_count = 0

  @probe = YieldProbe.probe(block) do |*arg_array|
    arg_or_args = arg_array.size == 1 ? arg_array.first : arg_array
    @actual_formatted << RSpec::Support::ObjectFormatter.format(arg_or_args)
    @actual << arg_or_args
    args_matched_when_yielded &&= values_match?(@expected[yield_count], arg_or_args)
    yield_count += 1
  end

  return false unless @probe.has_block?
  args_matched_when_yielded && yield_count == @expected.length
end


  








  

    #negative_failure_reason   (private)
  

  [ GitHub ]


  

  


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



def negative_failure_reason
  return 'was not a block' unless @probe.has_block?

  'yielded with expected arguments' \
  "\nexpected not: #{surface_descriptions_in(@expected).inspect}" \
  "\n         got: [#{@actual_formatted.join(", ")}]"
end


  








  

    #positive_failure_reason   (private)
  

  [ GitHub ]


  

  


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



def positive_failure_reason
  return 'was not a block' unless @probe.has_block?

  'yielded with unexpected arguments' \
  "\nexpected: #{surface_descriptions_in(@expected).inspect}" \
  "\n     got: [#{@actual_formatted.join(", ")}]"
end