123456789_123456789_123456789_123456789_123456789_

Class: RSpec::Matchers::BuiltIn::Equal 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/equal.rb

Overview

Provides the implementation for RSpec::Matchers#equal. 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

#diffable? ⇒ Boolean (readonly)

[ GitHub ] 

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/equal.rb', line 33



def diffable?
  !expected_is_a_literal_singleton?
end


  








  

    #expected_is_a_literal_singleton?  ⇒ Boolean  (readonly, private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/equal.rb', line 45



def expected_is_a_literal_singleton?
  LITERAL_SINGLETONS.include?(expected)
end


  







Instance Method Details



  

    #actual_inspected   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/equal.rb', line 49



def actual_inspected
  if LITERAL_SINGLETONS.include?(actual)
    actual_formatted
  else
    inspect_object(actual)
  end
end


  








  

    #detailed_failure_message   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/equal.rb', line 61



def detailed_failure_message
  <<-MESSAGE

expected #{inspect_object(expected)}
     got #{inspect_object(actual)}

Compared using equal?, which compares object identity,
but expected and actual are not the same object. Use
`expect(actual).to eq(expected)` if you don't care about
object identity in this example.

MESSAGE
end


  








  

    #failure_message  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/equal.rb', line 10



def failure_message
  if expected_is_a_literal_singleton?
    simple_failure_message
  else
    detailed_failure_message
  end
end


  








  

    #failure_message_when_negated  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/equal.rb', line 20



def failure_message_when_negated
  <<-MESSAGE

expected not #{inspect_object(actual)}
 got #{inspect_object(expected)}

Compared using equal?, which compares object identity.

MESSAGE
end


  








  

    #inspect_object(o)   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/equal.rb', line 75



def inspect_object(o)
  "#<#{o.class}:#{o.object_id}> => #{RSpec::Support::ObjectFormatter.format(o)}"
end


  








  

    #match(expected, actual)   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/equal.rb', line 39



def match(expected, actual)
  actual.equal? expected
end


  








  

    #simple_failure_message   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/equal.rb', line 57



def simple_failure_message
  "\nexpected #{expected_formatted}\n     got #{actual_inspected}\n"
end