class RSpec::Matchers::BuiltIn::RespondTo
@api private Provides the implementation for ‘respond_to`. Not intended to be instantiated directly.
Public Class Methods
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 10 def initialize(*names) @names = names @expected_arity = nil @expected_keywords = [] @ignoring_method_signature_failure = false @unlimited_arguments = nil @arbitrary_keywords = nil end
Public Instance Methods
@api public No-op. Intended to be used as syntactic sugar when using ‘with`.
@example
expect(obj).to respond_to(:message).with(3).arguments
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 71 def argument self end
Also aliased as: arguments
@api private @return [String]
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 100 def description "respond to #{pp_names}#{with_arity}" end
@private
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 82 def does_not_match?(actual) find_failing_method_names(actual, :select).empty? end
@api private @return [String]
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 88 def failure_message "expected #{actual_formatted} to respond to #{@failing_method_names.map { |name| description_of(name) }.join(', ')}#{with_arity}" end
@api private @return [String]
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 94 def failure_message_when_negated failure_message.sub(/to respond to/, 'not to respond to') end
@api private Used by other matchers to suppress a check
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 106 def ignoring_method_signature_failure! @ignoring_method_signature_failure = true end
@private
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 77 def matches?(actual) find_failing_method_names(actual, :reject).empty? end
@api public Specifies the number of expected arguments.
@example
expect(obj).to respond_to(:message).with(3).arguments
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 24 def with(n) @expected_arity = n self end
@api public Specifies that the method accepts any keyword, i.e. the method has
a splatted keyword parameter of the form **kw_args.
@example
expect(obj).to respond_to(:message).with_any_keywords
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 48 def with_any_keywords @arbitrary_keywords = true self end
Also aliased as: and_any_keywords
@api public Specifies keyword arguments, if any.
@example
expect(obj).to respond_to(:message).with_keywords(:color, :shape)
@example with an expected number of arguments
expect(obj).to respond_to(:message).with(3).arguments.and_keywords(:color, :shape)
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 36 def with_keywords(*keywords) @expected_keywords = keywords self end
Also aliased as: and_keywords
@api public Specifies that the number of arguments has no upper limit, i.e. the
method has a splatted parameter of the form *args.
@example
expect(obj).to respond_to(:message).with_unlimited_arguments
# File rspec-expectations/lib/rspec/matchers/built_in/respond_to.rb, line 60 def with_unlimited_arguments @unlimited_arguments = true self end
Also aliased as: and_unlimited_arguments