rspec-mocks 3.0.0.beta2 → 3.0.0.rc1

data/lib/rspec/mocks/matchers/receive_messages.rb

@@ -58,7 +58,7 @@ module RSpec
         end
 
         def any_instance_of(subject)
-          ::RSpec::Mocks.space.any_instance_recorder_for(subject)
+          ::RSpec::Mocks.space.any_instance_proxy_for(subject)
         end
 
         def each_message_on(host)
@@ -66,7 +66,6 @@ module RSpec
             yield host, message, value
           end
         end
-
       end
     end
   end

data/lib/rspec/mocks/message_chain.rb

@@ -20,17 +20,17 @@ module RSpec
             chain_on(matching_expectation.invoke_without_incrementing_received_count(nil), *chain, &@block)
           else
             next_in_chain = Double.new
-            expectation(object, chain.shift, next_in_chain)
+            expectation(object, chain.shift) { next_in_chain }
             chain_on(next_in_chain, *chain, &@block)
           end
         else
-          ::RSpec::Mocks.allow_message(object, chain.shift, {}, &block)
+          expectation(object, chain.shift, &@block)
         end
       end
 
     private
 
-      def expectation(object, message, returned_object)
+      def expectation(object, message, &return_block)
         raise NotImplementedError.new
       end
 
@@ -68,10 +68,10 @@ module RSpec
         new(object, *chain, &blk).setup_chain
       end
 
-      private
+    private
 
-      def expectation(object, message, returned_object)
-        ::RSpec::Mocks.expect_message(object, message, {}) { returned_object }
+      def expectation(object, message, &return_block)
+        ::RSpec::Mocks.expect_message(object, message, {}, &return_block)
       end
     end
 
@@ -81,10 +81,10 @@ module RSpec
         new(object, *chain, &blk).setup_chain
       end
 
-      private
+    private
 
-      def expectation(object, message, returned_object)
-        ::RSpec::Mocks.allow_message(object, message, {}) { returned_object }
+      def expectation(object, message, &return_block)
+        ::RSpec::Mocks.allow_message(object, message, {}, &return_block)
       end
     end
   end

data/lib/rspec/mocks/message_expectation.rb

@@ -5,6 +5,8 @@ module RSpec
     # for a message. While this same effect can be achieved using a standard
     # MessageExpecation, this version is much faster and so can be used as an
     # optimization.
+    #
+    # @private
     class SimpleMessageExpectation
 
       def initialize(message, response, error_generator, backtrace_line = nil)
@@ -68,8 +70,6 @@ module RSpec
         self.inner_implementation_action = implementation_block
       end
 
-      # @private
-
       # @private
       def expected_args
         @argument_list_matcher.expected_args
@@ -541,10 +541,10 @@ module RSpec
 
         @error_generator.raise_missing_block_error @args_to_yield unless block
         value = nil
-        block_signature = BlockSignature.new(block)
+        block_signature = Support::BlockSignature.new(block)
 
         @args_to_yield.each do |args|
-          unless MethodSignatureVerifier.new(block_signature, args).valid?
+          unless Support::MethodSignatureVerifier.new(block_signature, args).valid?
             @error_generator.raise_wrong_arity_error(args, block_signature)
           end
 
@@ -635,7 +635,8 @@ module RSpec
     end
 
     # Insert original locations into stacktraces
-    # @api private
+    #
+    # @private
     class InsertOntoBacktrace
       def self.line(location)
         yield

data/lib/rspec/mocks/method_double.rb

@@ -25,7 +25,7 @@ module RSpec
         # method handles for missing methods even if `respond_to?` is correct.
         @original_method ||=
           @method_stasher.original_method ||
-          @proxy.method_handle_for(method_name) ||
+          @proxy.original_method_handle_for(method_name) ||
           Proc.new do |*args, &block|
             @object.__send__(:method_missing, @method_name, *args, &block)
           end
@@ -55,8 +55,7 @@ module RSpec
         return if @method_is_proxied
 
         save_original_method!
-
-        object_singleton_class.class_exec(self, method_name, visibility) do |method_double, method_name, visibility|
+        definition_target.class_exec(self, method_name, visibility) do |method_double, method_name, visibility|
           define_method(method_name) do |*args, &block|
             method_double.proxy_method_invoked(self, *args, &block)
           end
@@ -76,9 +75,11 @@ module RSpec
 
       # @private
       def restore_original_method
+        return show_frozen_warning if object_singleton_class.frozen?
         return unless @method_is_proxied
 
-        object_singleton_class.__send__(:remove_method, @method_name)
+        definition_target.__send__(:remove_method, @method_name)
+
         if @method_stasher.method_is_stashed?
           @method_stasher.restore
         end
@@ -87,6 +88,15 @@ module RSpec
         @method_is_proxied = false
       end
 
+      # @private
+      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
+
       # @private
       def restore_original_visibility
         return unless @original_visibility &&
@@ -179,13 +189,12 @@ module RSpec
       # @private
       def remove_stub
         raise_method_not_stubbed_error if stubs.empty?
-        expectations.empty? ? reset : stubs.clear
+        remove_stub_if_present
       end
 
       # @private
-      def remove_single_stub(stub)
-        stubs.delete(stub)
-        restore_original_method if stubs.empty? && expectations.empty?
+      def remove_stub_if_present
+        expectations.empty? ? reset : stubs.clear
       end
 
       # @private
@@ -193,8 +202,56 @@ module RSpec
         raise MockExpectationError, "The method `#{method_name}` was not stubbed or was already unstubbed"
       end
 
-      # @private
-      IGNORED_BACKTRACE_LINE = 'this backtrace line is ignored'
+    private
+
+      # In Ruby 2.0.0 and above prepend will alter the method lookup chain.
+      # We use an object's singleton class to define method doubles upon,
+      # however if the object has had it's singleton class (as opposed to
+      # it's actual class) prepended too then the the method lookup chain
+      # will look in the prepended module first, **before** the singleton
+      # class.
+      #
+      # This code works around that by providing a mock definition target
+      # that is either the singleton class, or if necessary, a prepended module
+      # of our own.
+      #
+      if Support::RubyFeatures.module_prepends_supported?
+        # We subclass `Module` in order to be able to easily detect our prepended module.
+        RSpecPrependedModule = Class.new(Module)
+
+        def definition_target
+          @definition_target ||= usable_rspec_prepended_module || object_singleton_class
+        end
+
+        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
+
+        def new_rspec_prepended_module
+          RSpecPrependedModule.new.tap do |mod|
+            object_singleton_class.__send__ :prepend, mod
+          end
+        end
+
+      else
+
+        def definition_target
+          object_singleton_class
+        end
+
+      end
     end
   end
 end

data/lib/rspec/mocks/method_reference.rb

@@ -45,7 +45,7 @@ module RSpec
 
       def with_signature
         if original = original_method
-          yield MethodSignature.new(original)
+          yield Support::MethodSignature.new(original)
         end
       end
 

data/lib/rspec/mocks/mutate_const.rb

@@ -2,7 +2,8 @@ module RSpec
   module Mocks
     # Provides recursive constant lookup methods useful for
     # constant stubbing.
-    # @api private
+    #
+    # @private
     module RecursiveConstMethods
       # We only want to consider constants that are defined directly on a
       # particular module, and not include top-level/inherited constants.
@@ -96,7 +97,7 @@ module RSpec
       #   nil if the constant was not previously defined.
       attr_accessor :original_value
 
-      # @api private
+      # @private
       attr_writer :previously_defined, :stubbed, :hidden
 
       # @return [Boolean] Whether or not the constant was defined
@@ -123,12 +124,13 @@ module RSpec
         @hidden
       end
 
+      # The default `to_s` isn't very useful, so a custom version is provided.
       def to_s
         "#<#{self.class.name} #{name}>"
       end
       alias inspect to_s
 
-      # @api private
+      # @private
       def self.unmutated(name)
         const = new(name)
         const.previously_defined = recursive_const_defined?(name)
@@ -195,7 +197,7 @@ module RSpec
 
       # Contains common functionality used by all of the constant mutators.
       #
-      # @api private
+      # @private
       class BaseMutator
         include RecursiveConstMethods
 
@@ -225,7 +227,7 @@ module RSpec
 
       # Hides a defined constant for the duration of an example.
       #
-      # @api private
+      # @private
       class ConstantHider < BaseMutator
         def mutate
           return unless @defined = recursive_const_defined?(full_constant_name)
@@ -253,7 +255,7 @@ module RSpec
 
       # Replaces a defined constant for the duration of an example.
       #
-      # @api private
+      # @private
       class DefinedConstantReplacer < BaseMutator
         def mutate
           @context = recursive_const_get(@context_parts.join('::'))
@@ -319,7 +321,7 @@ module RSpec
 
       # Sets an undefined constant for the duration of an example.
       #
-      # @api private
+      # @private
       class UndefinedConstantSetter < BaseMutator
         def mutate
           @parent = @context_parts.inject(Object) do |klass, name|
@@ -361,7 +363,7 @@ module RSpec
       # the mutator is correctly registered so it can be backed out at the end
       # of the test.
       #
-      # @api private
+      # @private
       def self.mutate(mutator)
         ::RSpec::Mocks.space.register_constant_mutator(mutator)
         mutator.mutate
@@ -380,11 +382,5 @@ module RSpec
         end
       end
     end
-
-    # Keeps backwards compatibility since we had released an rspec-mocks that
-    # only supported stubbing. Later, we released the hide_const feature and
-    # decided that the term "mutator" was a better term to wrap up the concept
-    # of both stubbing and hiding.
-    ConstantStubber = ConstantMutator
   end
 end

data/lib/rspec/mocks/object_reference.rb

@@ -1,7 +1,7 @@
 module RSpec
   module Mocks
 
-    # @api private
+    # @private
     class ObjectReference
       # Returns an appropriate Object or Module reference based
       # on the given argument.
@@ -22,7 +22,8 @@ module RSpec
 
     # Used when an object is passed to `object_double`.
     # Represents a reference to that object.
-    # @api private
+    #
+    # @private
     class DirectObjectReference
       def initialize(object)
         @object = object
@@ -48,7 +49,8 @@ module RSpec
 
     # Used when a module is passed to `class_double` or `instance_double`.
     # Represents a reference to that module.
-    # @api private
+    #
+    # @private
     class DirectModuleReference < DirectObjectReference
       def const_to_replace
         @object.name
@@ -60,7 +62,8 @@ module RSpec
     # or `object_double`.
     # Represents a reference to the object named (via a constant lookup)
     # by the string.
-    # @api private
+    #
+    # @private
     class NamedObjectReference
       def initialize(const_name)
         @const_name = const_name

data/lib/rspec/mocks/proxy.rb

@@ -37,12 +37,13 @@ module RSpec
       end
 
       # @private
-      def method_handle_for(message)
+      def original_method_handle_for(message)
         nil
       end
 
       # @private
-      def add_message_expectation(location, method_name, opts={}, &block)
+      def add_message_expectation(method_name, opts={}, &block)
+        location = opts.fetch(:expected_from) { CallerFilter.first_non_rspec_line }
         meth_double = method_double_for(method_name)
 
         if null_object? && !block
@@ -101,7 +102,8 @@ module RSpec
       end
 
       # @private
-      def add_stub(location, method_name, opts={}, &implementation)
+      def add_stub(method_name, opts={}, &implementation)
+        location = opts.fetch(:expected_from) { CallerFilter.first_non_rspec_line }
         method_double_for(method_name).add_stub @error_generator, @order_group, location, opts, &implementation
       end
 
@@ -116,8 +118,8 @@ module RSpec
       end
 
       # @private
-      def remove_single_stub(method_name, stub)
-        method_double_for(method_name).remove_single_stub(stub)
+      def remove_stub_if_present(method_name)
+        method_double_for(method_name).remove_stub_if_present
       end
 
       # @private
@@ -149,6 +151,11 @@ module RSpec
       # @private
       def message_received(message, *args, &block)
         record_message_received message, *args, &block
+
+        RSpec::Mocks.space.any_instance_recorders_from_ancestry_of(object).each do |subscriber|
+          subscriber.notify_received_message(object, message, args, block)
+        end
+
         expectation = find_matching_expectation(message, *args)
         stub = find_matching_method_stub(message, *args)
 
@@ -194,6 +201,17 @@ module RSpec
         :public
       end
 
+      if Support::RubyFeatures.module_prepends_supported?
+        def prepended_modules_of_singleton_class
+          @prepended_modules_of_singleton_class ||= begin
+            singleton_class = @object.singleton_class
+            singleton_class.ancestors.take_while do |mod|
+              !(Class === mod)
+            end
+          end
+        end
+      end
+
     private
 
       def method_double_for(message)
@@ -244,7 +262,7 @@ module RSpec
 
     # @private
     class PartialDoubleProxy < Proxy
-      def method_handle_for(message)
+      def original_method_handle_for(message)
         if any_instance_class_recorder_observing_method?(@object.class, message)
           message = ::RSpec::Mocks.space.
             any_instance_recorder_for(@object.class).
@@ -290,6 +308,75 @@ module RSpec
       end
     end
 
+    # @private
+    # When we mock or stub a method on a class, we have to treat it a bit different,
+    # because normally singleton method definitions only affect the object on which
+    # they are defined, but on classes they affect subclasses, too. As a result,
+    # we need some special handling to get the original method.
+    module PartialClassDoubleProxyMethods
+      def initialize(source_space, *args)
+        @source_space = source_space
+        super(*args)
+      end
+
+      # Consider this situation:
+      #
+      #   class A; end
+      #   class B < A; end
+      #
+      #   allow(A).to receive(:new)
+      #   expect(B).to receive(:new).and_call_original
+      #
+      # When getting the original definition for `B.new`, we cannot rely purely on
+      # using `B.method(:new)` before our redefinition is defined on `B`, because
+      # `B.method(:new)` will return a method that will execute the stubbed version
+      # of the method on `A` since singleton methods on classes are in the lookup
+      # hierarchy.
+      #
+      # To do it properly, we need to find the original definition of `new` from `A`
+      # from _before_ `A` was stubbed, and we need to rebind it to `B` so that it will
+      # run with the proper `self`.
+      #
+      # That's what this method (together with `original_unbound_method_handle_from_ancestor_for`)
+      # does.
+      def original_method_handle_for(message)
+        unbound_method = superclass_proxy &&
+          superclass_proxy.original_unbound_method_handle_from_ancestor_for(message.to_sym)
+
+        return super unless unbound_method
+        unbound_method.bind(object)
+      end
+
+    protected
+
+      def original_unbound_method_handle_from_ancestor_for(message)
+        method_double = @method_doubles.fetch(message) do
+          # The fact that there is no method double for this message indicates
+          # that it has not been redefined by rspec-mocks. We need to continue
+          # looking up the ancestor chain.
+          return superclass_proxy &&
+            superclass_proxy.original_unbound_method_handle_from_ancestor_for(message)
+        end
+
+        method_double.original_method.unbind
+      end
+
+      def superclass_proxy
+        return @superclass_proxy if defined?(@superclass_proxy)
+
+        if (superclass = object.superclass)
+          @superclass_proxy = @source_space.proxy_for(superclass)
+        else
+          @superclass_proxy = nil
+        end
+      end
+    end
+
+    # @private
+    class PartialClassDoubleProxy < PartialDoubleProxy
+      include PartialClassDoubleProxyMethods
+    end
+
     # @private
     class ProxyForNil < PartialDoubleProxy
       def initialize(order_group)
@@ -300,7 +387,7 @@ module RSpec
       attr_accessor :warn_about_expectations
       alias warn_about_expectations? warn_about_expectations
 
-      def add_message_expectation(location, method_name, opts={}, &block)
+      def add_message_expectation(method_name, opts={}, &block)
         warn(method_name) if warn_about_expectations?
         super
       end
@@ -310,7 +397,7 @@ module RSpec
         super
       end
 
-      def add_stub(location, method_name, opts={}, &implementation)
+      def add_stub(method_name, opts={}, &implementation)
         warn(method_name) if warn_about_expectations?
         super
       end