class RSpec::Mocks::AnyInstance::Recorder

Given a class `TheClass`, `TheClass.any_instance` returns a `Recorder`, which records stubs and message expectations for later playback on instances of `TheClass`.

Further constraints are stored in instances of [Chain](Chain).

@see AnyInstance @see Chain

Attributes

message_chains[R]

@private

stubs[R]

@private

Public Class Methods

new(klass) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 16
def initialize(klass)
  @message_chains = MessageChains.new
  @stubs = Hash.new { |hash,key| hash[key] = [] }
  @observed_methods = []
  @played_methods = {}
  @klass = klass
  @expectation_set = false
end

Public Instance Methods

already_observing?(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 125
def already_observing?(method_name)
  @observed_methods.include?(method_name)
end
build_alias_method_name(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 121
def build_alias_method_name(method_name)
  "__#{method_name}_without_any_instance__"
end
instance_that_received(method_name) click to toggle source

@private

# File lib/rspec/mocks/any_instance/recorder.rb, line 117
def instance_that_received(method_name)
  @played_methods[method_name]
end
playback!(instance, method_name) click to toggle source

@private

# File lib/rspec/mocks/any_instance/recorder.rb, line 109
def playback!(instance, method_name)
  RSpec::Mocks.space.ensure_registered(instance)
  message_chains.playback!(instance, method_name)
  @played_methods[method_name] = instance
  received_expected_message!(method_name) if message_chains.has_expectation?(method_name)
end
should_not_receive(method_name, &block) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 63
def should_not_receive(method_name, &block)
  should_receive(method_name, &block).never
end
should_receive(method_name, &block) click to toggle source

Initializes the recording a message expectation to be played back against any instance of this object that invokes the submitted method.

@see Methods#should_receive

# File lib/rspec/mocks/any_instance/recorder.rb, line 57
def should_receive(method_name, &block)
  @expectation_set = true
  observe!(method_name)
  message_chains.add(method_name, PositiveExpectationChain.new(self, method_name, &block))
end
stop_all_observation!() click to toggle source

@private

# File lib/rspec/mocks/any_instance/recorder.rb, line 104
def stop_all_observation!
  @observed_methods.each {|method_name| restore_method!(method_name)}
end
stub(method_name_or_method_map, &block) click to toggle source

Initializes the recording a stub to be played back against any instance of this object that invokes the submitted method.

@see Methods#stub

# File lib/rspec/mocks/any_instance/recorder.rb, line 29
def stub(method_name_or_method_map, &block)
  if method_name_or_method_map.is_a?(Hash)
    method_name_or_method_map.each do |method_name, return_value|
      stub(method_name).and_return(return_value)
    end
  else
    observe!(method_name_or_method_map)
    message_chains.add(method_name_or_method_map, StubChain.new(self, method_name_or_method_map, &block))
  end
end
stub!(*) click to toggle source

@private

# File lib/rspec/mocks/any_instance/recorder.rb, line 94
def stub!(*)
  raise "stub! is not supported on any_instance. Use stub instead."
end
stub_chain(*method_names_and_optional_return_values, &block) click to toggle source

Initializes the recording a stub chain to be played back against any instance of this object that invokes the method matching the first argument.

@see Methods#stub_chain

# File lib/rspec/mocks/any_instance/recorder.rb, line 45
def stub_chain(*method_names_and_optional_return_values, &block)
  normalize_chain(*method_names_and_optional_return_values) do |method_name, args|
    observe!(method_name)
    message_chains.add(method_name, StubChainChain.new(self, *args, &block))
  end
end
unstub(method_name) click to toggle source

Removes any previously recorded stubs, stub_chains or message expectations that use `method_name`.

@see Methods#unstub

# File lib/rspec/mocks/any_instance/recorder.rb, line 71
def unstub(method_name)
  unless @observed_methods.include?(method_name.to_sym)
    raise RSpec::Mocks::MockExpectationError, "The method `#{method_name}` was not stubbed or was already unstubbed"
  end
  message_chains.remove_stub_chains_for!(method_name)
  ::RSpec::Mocks.proxies_of(@klass).each do |proxy|
    stubs[method_name].each { |stub| proxy.remove_single_stub(method_name, stub) }
  end
  stubs[method_name].clear
  stop_observing!(method_name) unless message_chains.has_expectation?(method_name)
end
unstub!(*) click to toggle source

@private

# File lib/rspec/mocks/any_instance/recorder.rb, line 99
def unstub!(*)
  raise "unstub! is not supported on any_instance. Use unstub instead."
end
verify() click to toggle source

@api private

Used internally to verify that message expectations have been fulfilled.

# File lib/rspec/mocks/any_instance/recorder.rb, line 87
def verify
  if @expectation_set && !message_chains.all_expectations_fulfilled?
    raise RSpec::Mocks::MockExpectationError, "Exactly one instance should have received the following message(s) but didn't: #{message_chains.unfulfilled_expectations.sort.join(', ')}"
  end
end

Private Instance Methods

backup_method!(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 165
def backup_method!(method_name)
  alias_method_name = build_alias_method_name(method_name)
  @klass.class_eval do
    alias_method alias_method_name, method_name
  end if public_protected_or_private_method_defined?(method_name)
end
mark_invoked!(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 194
        def mark_invoked!(method_name)
          backup_method!(method_name)
          @klass.class_eval(<<-EOM, __FILE__, __LINE__ + 1)
            def #{method_name}(*args, &blk)
              method_name = :#{method_name}
              klass = ::RSpec::Mocks.method_handle_for(self, :#{method_name}).owner
              invoked_instance = ::RSpec::Mocks.any_instance_recorder_for(klass).instance_that_received(method_name)
              raise RSpec::Mocks::MockExpectationError, "The message '#{method_name}' was received by \#{self.inspect} but has already been received by \#{invoked_instance}"
            end
          EOM
        end
normalize_chain(*args) { |first, args| ... } click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 131
def normalize_chain(*args)
  args.shift.to_s.split('.').map {|s| s.to_sym}.reverse.each {|a| args.unshift a}
  yield args.first, args
end
observe!(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 181
        def observe!(method_name)
          stop_observing!(method_name) if already_observing?(method_name)
          @observed_methods << method_name
          backup_method!(method_name)
          @klass.class_eval(<<-EOM, __FILE__, __LINE__ + 1)
            def #{method_name}(*args, &blk)
              klass = ::RSpec::Mocks.method_handle_for(self, :#{method_name}).owner
              ::RSpec::Mocks.any_instance_recorder_for(klass).playback!(self, :#{method_name})
              self.__send__(:#{method_name}, *args, &blk)
            end
          EOM
        end
public_protected_or_private_method_defined?(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 172
def public_protected_or_private_method_defined?(method_name)
  @klass.method_defined?(method_name) || @klass.private_method_defined?(method_name)
end
received_expected_message!(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 136
def received_expected_message!(method_name)
  message_chains.received_expected_message!(method_name)
  restore_method!(method_name)
  mark_invoked!(method_name)
end
remove_dummy_method!(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 159
def remove_dummy_method!(method_name)
  @klass.class_eval do
    remove_method method_name
  end
end
restore_method!(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 142
def restore_method!(method_name)
  if public_protected_or_private_method_defined?(build_alias_method_name(method_name))
    restore_original_method!(method_name)
  else
    remove_dummy_method!(method_name)
  end
end
restore_original_method!(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 150
def restore_original_method!(method_name)
  alias_method_name = build_alias_method_name(method_name)
  @klass.class_eval do
    remove_method method_name
    alias_method  method_name, alias_method_name
    remove_method alias_method_name
  end
end
stop_observing!(method_name) click to toggle source
# File lib/rspec/mocks/any_instance/recorder.rb, line 176
def stop_observing!(method_name)
  restore_method!(method_name)
  @observed_methods.delete(method_name)
end