Class: RSpec::Matchers::BuiltIn::BeComparedTo Private

Inherits:
BaseMatcher
  • Object
show all
Defined in:
lib/rspec/matchers/built_in/be.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Provides the implementation of be <operator> value. Not intended to be instantiated directly.

Constant Summary

Constant Summary

Constants inherited from BaseMatcher

RSpec::Matchers::BuiltIn::BaseMatcher::UNDEFINED

Instance Method Summary (collapse)

Methods inherited from BaseMatcher

#diffable?, #expects_call_stack_jump?, #match_unless_raises, #supports_block_expectations?

Methods included from Composable

#===, #and, #description_of, #or, should_enumerate?, surface_descriptions_in, unreadable_io?, #values_match?

Constructor Details

- (BeComparedTo) initialize(operand, operator)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of BeComparedTo

139
140
141
142
 
# File 'lib/rspec/matchers/built_in/be.rb', line 139
def initialize(operand, operator)
  @expected, @operator = operand, operator
  @args = []
end

Instance Method Details

- (String) description

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 
170
171
172
 
# File 'lib/rspec/matchers/built_in/be.rb', line 170
def description
  "be #{@operator} #{expected_to_sentence}#{args_to_sentence}"
end

- (String) failure_message

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 
153
154
155
 
# File 'lib/rspec/matchers/built_in/be.rb', line 153
def failure_message
  "expected: #{@operator} #{expected_formatted}\n     got: #{@operator.to_s.gsub(/./, ' ')} #{actual_formatted}"
end

- (String) failure_message_when_negated

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 
159
160
161
162
163
164
165
166
 
# File 'lib/rspec/matchers/built_in/be.rb', line 159
def failure_message_when_negated
  message = "`expect(#{actual_formatted}).not_to be #{@operator} #{expected_formatted}`"
  if [:<, :>, :<=, :>=].include?(@operator)
    message + " not only FAILED, it is a bit confusing."
  else
    message
  end
end

- (Boolean) matches?(actual)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 
144
145
146
147
148
149
 
# File 'lib/rspec/matchers/built_in/be.rb', line 144
def matches?(actual)
  @actual = actual
  @actual.__send__ @operator, @expected
rescue ArgumentError
  false
end