123456789_123456789_123456789_123456789_123456789_

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

Overview

Provides the implementation for ‘be_between`. 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?

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.
#assert_ivars,
#present_ivars

:nocov:

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.

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

#comparable? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/be_between.rb', line 63



def comparable?
  @actual.respond_to?(@less_than_operator) && @actual.respond_to?(@greater_than_operator)
end


  







Instance Method Details



  

    #compare   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/be_between.rb', line 71



def compare
  @actual.__send__(@greater_than_operator, @min) && @actual.__send__(@less_than_operator, @max)
end


  








  

    #description  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


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



def description
  "be between #{description_of @min} and #{description_of @max} (#{@mode})"
end


  








  

    #exclusive  
  



  

    

Makes the between comparison exclusive.


  





    

    
Examples:

      
expect(3).to be_between(2, 4).exclusive

  




  [ GitHub ]


  

  


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



def exclusive
  @less_than_operator = :<
  @greater_than_operator = :>
  @mode = :exclusive
  self
end


  








  

    #failure_message  ⇒ String 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/be_between.rb', line 51



def failure_message
  "#{super}#{not_comparable_clause}"
end


  








  

    #inclusive  
  



  

    
  

    Note:
    


The matcher is inclusive by default; this simply provides a way to be more explicit about it.



  




Makes the between comparison inclusive.


  





    

    
Examples:

      
expect(3).to be_between(2, 3).inclusive

  




  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/be_between.rb', line 21



def inclusive
  @less_than_operator = :<=
  @greater_than_operator = :>=
  @mode = :inclusive
  self
end


  








  

    #matches?(actual)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/be_between.rb', line 42



def matches?(actual)
  @actual = actual
  comparable? && compare
rescue ArgumentError
  false
end


  








  

    #not_comparable_clause   (private)
  

  [ GitHub ]


  

  


# File 'rspec-expectations/lib/rspec/matchers/built_in/be_between.rb', line 67



def not_comparable_clause
  ", but it does not respond to `#{@less_than_operator}` and `#{@greater_than_operator}`" unless comparable?
end