Class: RSpec::Matchers::BuiltIn::RespondTo Private

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

Constant Summary

Constants inherited from BaseMatcher

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(*names) ⇒ RespondTo

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

10
11
12
13
14
15
16
 
# File 'lib/rspec/matchers/built_in/respond_to.rb', line 10
def initialize(*names)
  @names = names
  @expected_arity = nil
  @expected_keywords = []
  @unlimited_arguments = nil
  @arbitrary_keywords = nil
end

Instance Method Details

#argument ⇒ Object Also known as: arguments

No-op. Intended to be used as syntactic sugar when using with.

Examples:

expect(obj).to respond_to(:message).with(3).arguments
70
71
72
 
# File 'lib/rspec/matchers/built_in/respond_to.rb', line 70
def argument
  self
end

#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) 
99
100
101
 
# File 'lib/rspec/matchers/built_in/respond_to.rb', line 99
def description
  "respond to #{pp_names}#{with_arity}"
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) 
87
88
89
 
# File 'lib/rspec/matchers/built_in/respond_to.rb', line 87
def failure_message
  "expected #{actual_formatted} to respond to #{@failing_method_names.map { |name| description_of(name) }.join(', ')}#{with_arity}"
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) 
93
94
95
 
# File 'lib/rspec/matchers/built_in/respond_to.rb', line 93
def failure_message_when_negated
  failure_message.sub(/to respond to/, 'not to respond to')
end

#with(n) ⇒ Object

Specifies the number of expected arguments.

Examples:

expect(obj).to respond_to(:message).with(3).arguments
23
24
25
26
 
# File 'lib/rspec/matchers/built_in/respond_to.rb', line 23
def with(n)
  @expected_arity = n
  self
end

#with_any_keywords ⇒ Object Also known as: and_any_keywords

Specifies that the method accepts any keyword, i.e. the method has a splatted keyword parameter of the form **kw_args.

Examples:

expect(obj).to respond_to(:message).with_any_keywords
47
48
49
50
 
# File 'lib/rspec/matchers/built_in/respond_to.rb', line 47
def with_any_keywords
  @arbitrary_keywords = true
  self
end

#with_keywords(*keywords) ⇒ Object Also known as: and_keywords

Specifies keyword arguments, if any.

Examples:

expect(obj).to respond_to(:message).with_keywords(:color, :shape)

with an expected number of arguments

expect(obj).to respond_to(:message).with(3).arguments.and_keywords(:color, :shape)
35
36
37
38
 
# File 'lib/rspec/matchers/built_in/respond_to.rb', line 35
def with_keywords(*keywords)
  @expected_keywords = keywords
  self
end

#with_unlimited_arguments ⇒ Object Also known as: and_unlimited_arguments

Specifies that the number of arguments has no upper limit, i.e. the method has a splatted parameter of the form *args.

Examples:

expect(obj).to respond_to(:message).with_unlimited_arguments
59
60
61
62
 
# File 'lib/rspec/matchers/built_in/respond_to.rb', line 59
def with_unlimited_arguments
  @unlimited_arguments = true
  self
end