class RSpec::Mocks::MethodDouble

@private

Constants

FROZEN_ERROR_MSG: @private TODO: drop in favor of FrozenError in ruby 2.5+
RSpecPrependedModule: We subclass ‘Module` in order to be able to easily detect our prepended module.

Attributes

expectations [R]

@private

method_name [R]

@private

method_stasher [R]

@private

object [R]

@private

stubs [R]

@private

Public Class Methods

new (object, method_name, proxy)

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 12
def initialize(object, method_name, proxy)
  @method_name = method_name
  @object = object
  @proxy = proxy

  @original_visibility = nil
  @method_stasher = InstanceMethodStasher.new(object, method_name)
  @method_is_proxied = false
  @expectations = []
  @stubs = []
end

Public Instance Methods

add_default_stub (*args, &implementation)

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 216
def add_default_stub(*args, &implementation)
  return if stubs.any?
  add_stub(*args, &implementation)
end

add_expectation (error_generator, expectation_ordering, expected_from, opts, &implementation)

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 166
def add_expectation(error_generator, expectation_ordering, expected_from, opts, &implementation)
  configure_method
  expectation = message_expectation_class.new(error_generator, expectation_ordering,
                                              expected_from, self, :expectation, opts, &implementation)
  expectations << expectation
  expectation
end

add_simple_expectation (method_name, response, error_generator, backtrace_line)

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 202
def add_simple_expectation(method_name, response, error_generator, backtrace_line)
  setup_simple_method_double method_name, response, expectations, error_generator, backtrace_line
end

add_simple_stub (method_name, response)

A simple stub can only return a concrete value for a message, and cannot match on arguments. It is used as an optimization over ‘add_stub` / `add_expectation` where it is known in advance that this is all that will be required of a stub, such as when passing attributes to the `double` example method. They do not stash or restore existing method definitions.

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 197
def add_simple_stub(method_name, response)
  setup_simple_method_double method_name, response, stubs
end

add_stub (error_generator, expectation_ordering, expected_from, opts={}, &implementation)

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 181
def add_stub(error_generator, expectation_ordering, expected_from, opts={}, &implementation)
  configure_method
  stub = message_expectation_class.new(error_generator, expectation_ordering, expected_from,
                                       self, :stub, opts, &implementation)
  stubs.unshift stub
  stub
end

build_expectation (error_generator, expectation_ordering)

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 175
def build_expectation(error_generator, expectation_ordering)
  expected_from = IGNORED_BACKTRACE_LINE
  message_expectation_class.new(error_generator, expectation_ordering, expected_from, self)
end

clear ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 152
def clear
  expectations.clear
  stubs.clear
end

configure_method ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 61
def configure_method
  @original_visibility = visibility
  @method_stasher.stash unless @method_is_proxied
  define_proxy_method
end

define_proxy_method ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 68
def define_proxy_method
  return if @method_is_proxied

  save_original_implementation_callable!
  definition_target.class_exec(self, method_name, @original_visibility || visibility) do |method_double, method_name, visibility|
    define_method(method_name) do |*args, &block|
      method_double.proxy_method_invoked(self, *args, &block)
    end
    # This can't be `if respond_to?(:ruby2_keywords, true)`,
    # see https://github.com/rspec/rspec-mocks/pull/1385#issuecomment-755340298
    ruby2_keywords(method_name) if Module.private_method_defined?(:ruby2_keywords)
    __send__(visibility, method_name)
  end

  @method_is_proxied = true
rescue RuntimeError, TypeError => e
  # TODO: drop in favor of FrozenError in ruby 2.5+
  #  RuntimeError (and FrozenError) for ruby 2.x
  #  TypeError for ruby 1.x
  if (defined?(FrozenError) && e.is_a?(FrozenError)) || FROZEN_ERROR_MSG === e.message
    raise ArgumentError, "Cannot proxy frozen objects, rspec-mocks relies on proxies for method stubbing and expectations."
  end
  raise
end

definition_target ()

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 255
def definition_target
  @definition_target ||= usable_rspec_prepended_module || object_singleton_class
end

message_expectation_class ()

The type of message expectation to create has been extracted to its own method so that subclasses can override it.

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 161
def message_expectation_class
  MessageExpectation
end

method_missing_block ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 41
def method_missing_block
  block = Proc.new do |*args, &b|
    @object.__send__(:method_missing, @method_name, *args, &b)
  end
  block.ruby2_keywords if block.respond_to?(:ruby2_keywords)

  block
end

new_rspec_prepended_module ()

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 275
def new_rspec_prepended_module
  RSpecPrependedModule.new.tap do |mod|
    object_singleton_class.__send__ :prepend, mod
  end
end

object_singleton_class ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 56
def object_singleton_class
  class << @object; self; end
end

original_implementation_callable ()

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 24
def original_implementation_callable
  # If original method is not present, uses the `method_missing`
  # handler of the object. This accounts for cases where the user has not
  # correctly defined `respond_to?`, and also 1.8 which does not provide
  # method handles for missing methods even if `respond_to?` is correct.
  @original_implementation_callable ||= original_method || method_missing_block
end

Also aliased as: save_original_implementation_callable!

original_method ()

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 34
def original_method
  @original_method ||=
    @method_stasher.original_method ||
    @proxy.original_method_handle_for(method_name)
end

proxy_method_invoked (_obj, *args, &block)

The implementation of the proxied method. Subclasses may override this method to perform additional operations.

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 97
def proxy_method_invoked(_obj, *args, &block)
  @proxy.message_received method_name, *args, &block
end

raise_method_not_stubbed_error ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 233
def raise_method_not_stubbed_error
  RSpec::Mocks.error_generator.raise_method_not_stubbed_error(method_name)
end

remove_stub ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 222
def remove_stub
  raise_method_not_stubbed_error if stubs.empty?
  remove_stub_if_present
end

remove_stub_if_present ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 228
def remove_stub_if_present
  expectations.empty? ? reset : stubs.clear
end

reset ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 146
def reset
  restore_original_method
  clear
end

restore_original_method ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 103
def restore_original_method
  return unless @method_is_proxied

  remove_method_from_definition_target
  @method_stasher.restore if @method_stasher.method_is_stashed?
  restore_original_visibility

  @method_is_proxied = false
rescue RuntimeError, TypeError => e
  # TODO: drop in favor of FrozenError in ruby 2.5+
  #  RuntimeError (and FrozenError) for ruby 2.x
  #  TypeError for ruby 1.x
  if (defined?(FrozenError) && e.is_a?(FrozenError)) || FROZEN_ERROR_MSG === e.message
    return show_frozen_warning
  end
  raise
end

restore_original_visibility ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 133
def restore_original_visibility
  return unless @original_visibility &&
    MethodReference.method_defined_at_any_visibility?(object_singleton_class, @method_name)

  object_singleton_class.__send__(@original_visibility, method_name)
end

save_original_implementation_callable! ()

Alias for: original_implementation_callable

setup_simple_method_double (method_name, response, collection, error_generator=nil, backtrace_line=nil)

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 207
def setup_simple_method_double(method_name, response, collection, error_generator=nil, backtrace_line=nil)
  define_proxy_method

  me = SimpleMessageExpectation.new(method_name, response, error_generator, backtrace_line)
  collection.unshift me
  me
end

show_frozen_warning ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 122
def show_frozen_warning
  RSpec.warn_with(
    "WARNING: rspec-mocks was unable to restore the original `#{@method_name}` " \
    "method on #{@object.inspect} because it has been frozen.  If you reuse this " \
    "object, `#{@method_name}` will continue to respond with its stub implementation.",
    :call_site                      => nil,
    :use_spec_location_as_call_site => true
  )
end

usable_rspec_prepended_module ()

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 259
def usable_rspec_prepended_module
  @proxy.prepended_modules_of_singleton_class.each do |mod|
    # If we have one of our modules prepended before one of the user's
    # modules that defines the method, use that, since our module's
    # definition will take precedence.
    return mod if RSpecPrependedModule === mod

    # If we hit a user module with the method defined first,
    # we must create a new prepend module, even if one exists later,
    # because ours will only take precedence if it comes first.
    return new_rspec_prepended_module if mod.method_defined?(method_name)
  end

  nil
end

verify ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 141
def verify
  expectations.each { |e| e.verify_messages_received }
end

visibility ()

@private

# File rspec-mocks/lib/rspec/mocks/method_double.rb, line 51
def visibility
  @proxy.visibility_for(@method_name)
end