class RSpec::Matchers::BuiltIn::RespondTo

@api private Provides the implementation for ‘respond_to`. Not intended to be instantiated directly.

Public Class Methods

new(*names) click to toggle source
# File 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

and_any_keywords()
Alias for: with_any_keywords
and_keywords(*keywords)
Alias for: with_keywords
and_unlimited_arguments()
argument() click to toggle source

@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 lib/rspec/matchers/built_in/respond_to.rb, line 71
def argument
  self
end
Also aliased as: arguments
arguments()
Alias for: argument
description() click to toggle source

@api private @return [String]

# File lib/rspec/matchers/built_in/respond_to.rb, line 100
def description
  "respond to #{pp_names}#{with_arity}"
end
does_not_match?(actual) click to toggle source

@private

# File lib/rspec/matchers/built_in/respond_to.rb, line 82
def does_not_match?(actual)
  find_failing_method_names(actual, :select).empty?
end
failure_message() click to toggle source

@api private @return [String]

# File 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
failure_message_when_negated() click to toggle source

@api private @return [String]

# File 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
ignoring_method_signature_failure!() click to toggle source

@api private Used by other matchers to suppress a check

# File lib/rspec/matchers/built_in/respond_to.rb, line 106
def ignoring_method_signature_failure!
  @ignoring_method_signature_failure = true
end
matches?(actual) click to toggle source

@private

# File lib/rspec/matchers/built_in/respond_to.rb, line 77
def matches?(actual)
  find_failing_method_names(actual, :reject).empty?
end
with(n) click to toggle source

@api public Specifies the number of expected arguments.

@example

expect(obj).to respond_to(:message).with(3).arguments
# File lib/rspec/matchers/built_in/respond_to.rb, line 24
def with(n)
  @expected_arity = n
  self
end
with_any_keywords() click to toggle source

@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 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
with_keywords(*keywords) click to toggle source

@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 lib/rspec/matchers/built_in/respond_to.rb, line 36
def with_keywords(*keywords)
  @expected_keywords = keywords
  self
end
Also aliased as: and_keywords
with_unlimited_arguments() click to toggle source

@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 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

Private Instance Methods

find_failing_method_names(actual, filter_method) click to toggle source
# File lib/rspec/matchers/built_in/respond_to.rb, line 112
def find_failing_method_names(actual, filter_method)
  @actual = actual
  @failing_method_names = @names.__send__(filter_method) do |name|
    @actual.respond_to?(name) && matches_arity?(actual, name)
  end
end
matches_arity?(actual, name) click to toggle source
# File lib/rspec/matchers/built_in/respond_to.rb, line 119
def matches_arity?(actual, name)
  ArityCheck.new(@expected_arity, @expected_keywords, @arbitrary_keywords, @unlimited_arguments).matches?(actual, name)
rescue NameError
  return true if @ignoring_method_signature_failure
  raise ArgumentError, "The #{matcher_name} matcher requires that " \
                       "the actual object define the method(s) in " \
                       "order to check arity, but the method " \
                       "`#{name}` is not defined. Remove the arity " \
                       "check or define the method to continue."
end
pp_names() click to toggle source
# File lib/rspec/matchers/built_in/respond_to.rb, line 156
def pp_names
  @names.length == 1 ? "##{@names.first}" : description_of(@names)
end
with_arity() click to toggle source
# File lib/rspec/matchers/built_in/respond_to.rb, line 130
def with_arity
  str = ''.dup
  str << " with #{with_arity_string}" if @expected_arity
  str << " #{str.length == 0 ? 'with' : 'and'} #{with_keywords_string}" if @expected_keywords && @expected_keywords.count > 0
  str << " #{str.length == 0 ? 'with' : 'and'} unlimited arguments" if @unlimited_arguments
  str << " #{str.length == 0 ? 'with' : 'and'} any keywords" if @arbitrary_keywords
  str
end
with_arity_string() click to toggle source
# File lib/rspec/matchers/built_in/respond_to.rb, line 139
def with_arity_string
  "#{@expected_arity} argument#{@expected_arity == 1 ? '' : 's'}"
end
with_keywords_string() click to toggle source
# File lib/rspec/matchers/built_in/respond_to.rb, line 143
def with_keywords_string
  kw_str = case @expected_keywords.count
           when 1
             @expected_keywords.first.inspect
           when 2
             @expected_keywords.map(&:inspect).join(' and ')
           else
             "#{@expected_keywords[0...-1].map(&:inspect).join(', ')}, and #{@expected_keywords.last.inspect}"
           end

  "keyword#{@expected_keywords.count == 1 ? '' : 's'} #{kw_str}"
end