Class: RSpec::Matchers::BuiltIn::BeWithin Private

Inherits:
BaseMatcher
  • Object
show all
Defined in:
lib/rspec/matchers/built_in/be_within.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 for be_within. Not intended to be instantiated directly.

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

#initialize(delta) ⇒ BeWithin

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 BeWithin.

8
9
10
 
# File 'lib/rspec/matchers/built_in/be_within.rb', line 8
def initialize(delta)
  @delta = delta
end

Instance Method Details

#description ⇒ String

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) 
52
53
54
 
# File 'lib/rspec/matchers/built_in/be_within.rb', line 52
def description
  "be within #{@delta}#{@unit} of #{expected_formatted}"
end

#failure_message ⇒ String

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) 
40
41
42
 
# File 'lib/rspec/matchers/built_in/be_within.rb', line 40
def failure_message
  "expected #{actual_formatted} to #{description}#{not_numeric_clause}"
end

#failure_message_when_negated ⇒ String

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) 
46
47
48
 
# File 'lib/rspec/matchers/built_in/be_within.rb', line 46
def failure_message_when_negated
  "expected #{actual_formatted} not to #{description}"
end

#of(expected) ⇒ Object

Sets the expected value.

14
15
16
17
18
19
 
# File 'lib/rspec/matchers/built_in/be_within.rb', line 14
def of(expected)
  @expected  = expected
  @tolerance = @delta
  @unit      = ''
  self
end

#percent_of(expected) ⇒ Object

Sets the expected value, and makes the matcher do a percent comparison.

24
25
26
27
28
29
 
# File 'lib/rspec/matchers/built_in/be_within.rb', line 24
def percent_of(expected)
  @expected  = expected
  @tolerance = @expected.abs * @delta / 100.0
  @unit      = '%'
  self
end