Class: RSpec::Matchers::BuiltIn::Match Private

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

API:

  • private

Constant Summary

Constants inherited from BaseMatcher

BaseMatcher::UNDEFINED

Instance Method Summary collapse

Methods inherited from BaseMatcher

#expects_call_stack_jump?, #match_unless_raises, #matches?, #supports_block_expectations?

Methods included from BaseMatcher::DefaultFailureMessages

#failure_message_when_negated

Methods included from Composable

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

Constructor Details

#initialize(expected) ⇒ Match

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

API:

  • private



8
9
10
11
12
 
# File 'lib/rspec/matchers/built_in/match.rb', line 8

def initialize(expected)
  super(expected)

  @expected_captures = nil
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:

API:

  • private



15
16
17
18
19
20
21
 
# File 'lib/rspec/matchers/built_in/match.rb', line 15

def description
  if @expected_captures && @expected.match(actual)
    "match #{surface_descriptions_in(expected).inspect} with captures #{surface_descriptions_in(@expected_captures).inspect}"
  else
    "match #{surface_descriptions_in(expected).inspect}"
  end
end

#diffable? ⇒ Boolean

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:

API:

  • private



25
26
27
 
# File 'lib/rspec/matchers/built_in/match.rb', line 25

def diffable?
  true
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:

API:

  • private



38
39
40
41
42
43
44
45
 
# File 'lib/rspec/matchers/built_in/match.rb', line 38

def failure_message
  if Array === expected && !(actual.respond_to?(:to_a) || actual.respond_to?(:to_ary))
    return "expected a collection that can be converted to an array with " \
           "`#to_ary` or `#to_a`, but got #{actual_formatted}"
  end

  super
end

#with_captures(*captures) ⇒ self

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.

Used to specify the captures we match against

Returns:

API:

  • private



31
32
33
34
 
# File 'lib/rspec/matchers/built_in/match.rb', line 31

def with_captures(*captures)
  @expected_captures = captures
  self
end