rspec-mocks 3.0.0 → 3.1.0

data/lib/rspec/mocks/proxy.rb

@@ -8,6 +8,11 @@ module RSpec
         end
       end
 
+      # @private
+      def ensure_implemented(*_args)
+        # noop for basic proxies, see VerifyingProxy for behaviour.
+      end
+
       # @private
       def initialize(object, order_group, name=nil, options={})
         @object = object
@@ -37,7 +42,7 @@ module RSpec
       end
 
       # @private
-      def original_method_handle_for(message)
+      def original_method_handle_for(_message)
         nil
       end
 
@@ -84,20 +89,19 @@ module RSpec
         end
 
         @messages_received.each do |(actual_method_name, args, _)|
-          if expectation.matches?(actual_method_name, *args)
-            expectation.invoke(nil)
-            block.call(*args) if block
-          end
-        end
+          next unless expectation.matches?(actual_method_name, *args)
 
+          expectation.invoke(nil)
+          block.call(*args) if block
+        end
       end
 
       # @private
       def check_for_unexpected_arguments(expectation)
         @messages_received.each do |(method_name, args, _)|
-          if expectation.matches_name_but_not_args(method_name, *args)
-            raise_unexpected_message_args_error(expectation, *args)
-          end
+          next unless expectation.matches_name_but_not_args(method_name, *args)
+
+          raise_unexpected_message_args_error(expectation, *args)
         end
       end
 
@@ -124,7 +128,7 @@ module RSpec
 
       # @private
       def verify
-        @method_doubles.each_value {|d| d.verify}
+        @method_doubles.each_value { |d| d.verify }
       end
 
       # @private
@@ -134,12 +138,12 @@ module RSpec
 
       # @private
       def received_message?(method_name, *args, &block)
-        @messages_received.any? {|array| array == [method_name, args, block]}
+        @messages_received.any? { |array| array == [method_name, args, block] }
       end
 
       # @private
       def has_negative_expectation?(message)
-        method_double_for(message).expectations.detect {|expectation| expectation.negative_expectation_for?(message)}
+        method_double_for(message).expectations.find { |expectation| expectation.negative_expectation_for?(message) }
       end
 
       # @private
@@ -157,16 +161,19 @@ module RSpec
 
         if (stub && expectation && expectation.called_max_times?) || (stub && !expectation)
           expectation.increase_actual_received_count! if expectation && expectation.actual_received_count_matters?
-          if expectation = find_almost_matching_expectation(message, *args)
+          if (expectation = find_almost_matching_expectation(message, *args))
             expectation.advise(*args) unless expectation.expected_messages_received?
           end
           stub.invoke(nil, *args, &block)
         elsif expectation
           expectation.invoke(stub, *args, &block)
-        elsif expectation = find_almost_matching_expectation(message, *args)
+        elsif (expectation = find_almost_matching_expectation(message, *args))
           expectation.advise(*args) if null_object? unless expectation.expected_messages_received?
-          raise_unexpected_message_args_error(expectation, *args) unless (has_negative_expectation?(message) or null_object?)
-        elsif stub = find_almost_matching_stub(message, *args)
+
+          if null_object? || !has_negative_expectation?(message)
+            raise_unexpected_message_args_error(expectation, *args)
+          end
+        elsif (stub = find_almost_matching_stub(message, *args))
           stub.advise(*args)
           raise_missing_default_stub_error(stub, *args)
         elsif Class === @object
@@ -192,7 +199,7 @@ module RSpec
       end
 
       # @private
-      def visibility_for(method_name)
+      def visibility_for(_method_name)
         # This is the default (for test doubles). Subclasses override this.
         :public
       end
@@ -201,9 +208,13 @@ module RSpec
         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 || @object.equal?(mod))
-            end
+            ancestors       = singleton_class.ancestors
+
+            # `|| 0` is necessary for Ruby 2.0, where the singleton class
+            # is only in the ancestor list when there are prepended modules.
+            singleton_index = ancestors.index(singleton_class) || 0
+
+            ancestors[0, singleton_index]
           end
         end
       end
@@ -239,11 +250,11 @@ module RSpec
       end
 
       def find_matching_method_stub(method_name, *args)
-        method_double_for(method_name).stubs.find {|stub| stub.matches?(method_name, *args)}
+        method_double_for(method_name).stubs.find { |stub| stub.matches?(method_name, *args) }
       end
 
       def find_almost_matching_stub(method_name, *args)
-        method_double_for(method_name).stubs.find {|stub| stub.matches_name_but_not_args(method_name, *args)}
+        method_double_for(method_name).stubs.find { |stub| stub.matches_name_but_not_args(method_name, *args) }
       end
     end
 
@@ -290,7 +301,7 @@ module RSpec
       end
 
       def reset
-        @method_doubles.each_value {|d| d.reset}
+        @method_doubles.each_value { |d| d.reset }
         super
       end
 
@@ -410,7 +421,7 @@ module RSpec
 
     private
 
-      def warn method_name
+      def warn(method_name)
         source = CallerFilter.first_non_rspec_line
         Kernel.warn("An expectation of :#{method_name} was set on nil. Called from #{source}. Use allow_message_expectations_on_nil to disable warnings.")
       end

data/lib/rspec/mocks/space.rb

@@ -5,23 +5,23 @@ module RSpec
     # the scope of an example. Called "root" because it serves
     # as the root of the space stack.
     class RootSpace
-      def proxy_for(*args)
+      def proxy_for(*_args)
         raise_lifecycle_message
       end
 
-      def any_instance_recorder_for(*args)
+      def any_instance_recorder_for(*_args)
         raise_lifecycle_message
       end
 
-      def any_instance_proxy_for(*args)
+      def any_instance_proxy_for(*_args)
         raise_lifecycle_message
       end
 
-      def register_constant_mutator(mutator)
+      def register_constant_mutator(_mutator)
         raise_lifecycle_message
       end
 
-      def any_instance_recorders_from_ancestry_of(object)
+      def any_instance_recorders_from_ancestry_of(_object)
         raise_lifecycle_message
       end
 
@@ -31,7 +31,7 @@ module RSpec
       def verify_all
       end
 
-      def registered?(object)
+      def registered?(_object)
         false
       end
 
@@ -43,7 +43,7 @@ module RSpec
 
       def raise_lifecycle_message
         raise OutsideOfExampleError,
-          "The use of doubles or partial doubles from rspec-mocks outside of the per-test lifecycle is not supported."
+              "The use of doubles or partial doubles from rspec-mocks outside of the per-test lifecycle is not supported."
       end
     end
 
@@ -65,7 +65,7 @@ module RSpec
       end
 
       def verify_all
-        proxies.each_value { |proxy| proxy.verify }
+        proxies.values.each { |proxy| proxy.verify }
         any_instance_recorders.each_value { |recorder| recorder.verify }
       end
 
@@ -84,7 +84,7 @@ module RSpec
         @constant_mutators.find { |m| m.full_constant_name == name }
       end
 
-      def any_instance_recorder_for(klass, only_return_existing = false)
+      def any_instance_recorder_for(klass, only_return_existing=false)
         any_instance_mutex.synchronize do
           id = klass.__id__
           any_instance_recorders.fetch(id) do
@@ -112,7 +112,7 @@ module RSpec
       alias ensure_registered proxy_for
 
       def registered?(object)
-        proxies.has_key?(id_for object)
+        proxies.key?(id_for object)
       end
 
       def any_instance_recorders_from_ancestry_of(object)
@@ -147,21 +147,21 @@ module RSpec
 
       def proxy_not_found_for(id, object)
         proxies[id] = case object
-          when NilClass   then ProxyForNil.new(@expectation_ordering)
-          when TestDouble then object.__build_mock_proxy(@expectation_ordering)
-          when Class
-            if RSpec::Mocks.configuration.verify_partial_doubles?
-              VerifyingPartialClassDoubleProxy.new(self, object, @expectation_ordering)
-            else
-              PartialClassDoubleProxy.new(self, object, @expectation_ordering)
-            end
-          else
-            if RSpec::Mocks.configuration.verify_partial_doubles?
-              VerifyingPartialDoubleProxy.new(object, @expectation_ordering)
-            else
-              PartialDoubleProxy.new(object, @expectation_ordering)
-            end
-        end
+                      when NilClass   then ProxyForNil.new(@expectation_ordering)
+                      when TestDouble then object.__build_mock_proxy_unless_expired(@expectation_ordering)
+                      when Class
+                        if RSpec::Mocks.configuration.verify_partial_doubles?
+                          VerifyingPartialClassDoubleProxy.new(self, object, @expectation_ordering)
+                        else
+                          PartialClassDoubleProxy.new(self, object, @expectation_ordering)
+                        end
+                      else
+                        if RSpec::Mocks.configuration.verify_partial_doubles?
+                          VerifyingPartialDoubleProxy.new(object, @expectation_ordering)
+                        else
+                          PartialDoubleProxy.new(object, @expectation_ordering)
+                        end
+                      end
       end
 
       def any_instance_recorder_not_found_for(id, klass)

data/lib/rspec/mocks/syntax.rb

@@ -10,7 +10,7 @@ module RSpec
       end
 
       # @private
-      def self.warn_unless_should_configured(method_name ,replacement = "the new `:expect` syntax or explicitly enable `:should`")
+      def self.warn_unless_should_configured(method_name , replacement="the new `:expect` syntax or explicitly enable `:should`")
         if @warn_about_should
           RSpec.deprecate(
             "Using `#{method_name}` from rspec-mocks' old `:should` syntax without explicitly enabling the syntax",
@@ -23,7 +23,7 @@ module RSpec
 
       # @api private
       # Enables the should syntax (`dbl.stub`, `dbl.should_receive`, etc).
-      def self.enable_should(syntax_host = default_should_syntax_host)
+      def self.enable_should(syntax_host=default_should_syntax_host)
         @warn_about_should = false if syntax_host == default_should_syntax_host
         return if should_enabled?(syntax_host)
 
@@ -41,7 +41,7 @@ module RSpec
           def stub(message_or_hash, opts={}, &block)
             ::RSpec::Mocks::Syntax.warn_unless_should_configured(__method__)
             if ::Hash === message_or_hash
-              message_or_hash.each {|message, value| stub(message).and_return value }
+              message_or_hash.each { |message, value| stub(message).and_return value }
             else
               ::RSpec::Mocks.allow_message(self, message_or_hash, opts, &block)
             end
@@ -86,7 +86,7 @@ module RSpec
 
       # @api private
       # Disables the should syntax (`dbl.stub`, `dbl.should_receive`, etc).
-      def self.disable_should(syntax_host = default_should_syntax_host)
+      def self.disable_should(syntax_host=default_should_syntax_host)
         return unless should_enabled?(syntax_host)
 
         syntax_host.class_exec do
@@ -107,7 +107,7 @@ module RSpec
 
       # @api private
       # Enables the expect syntax (`expect(dbl).to receive`, `allow(dbl).to receive`, etc).
-      def self.enable_expect(syntax_host = ::RSpec::Mocks::ExampleMethods)
+      def self.enable_expect(syntax_host=::RSpec::Mocks::ExampleMethods)
         return if expect_enabled?(syntax_host)
 
         syntax_host.class_exec do
@@ -147,7 +147,7 @@ module RSpec
 
       # @api private
       # Disables the expect syntax (`expect(dbl).to receive`, `allow(dbl).to receive`, etc).
-      def self.disable_expect(syntax_host = ::RSpec::Mocks::ExampleMethods)
+      def self.disable_expect(syntax_host=::RSpec::Mocks::ExampleMethods)
         return unless expect_enabled?(syntax_host)
 
         syntax_host.class_exec do
@@ -166,13 +166,13 @@ module RSpec
 
       # @api private
       # Indicates whether or not the should syntax is enabled.
-      def self.should_enabled?(syntax_host = default_should_syntax_host)
+      def self.should_enabled?(syntax_host=default_should_syntax_host)
         syntax_host.method_defined?(:should_receive)
       end
 
       # @api private
       # Indicates whether or not the expect syntax is enabled.
-      def self.expect_enabled?(syntax_host = ::RSpec::Mocks::ExampleMethods)
+      def self.expect_enabled?(syntax_host=::RSpec::Mocks::ExampleMethods)
         syntax_host.method_defined?(:allow)
       end
 
@@ -202,97 +202,99 @@ module RSpec
   end
 end
 
-# The legacy `:should` syntax adds the following methods directly to
-# `BasicObject` so that they are available off of any object. Note, however,
-# that this syntax does not always play nice with delegate/proxy objects.
-# We recommend you use the non-monkeypatching `:expect` syntax instead.
-# @see Class
-class BasicObject
-  # @method should_receive
-  # Sets an expectation that this object should receive a message before
-  # the end of the example.
-  #
-  # @example
-  #
-  #     logger = double('logger')
-  #     thing_that_logs = ThingThatLogs.new(logger)
-  #     logger.should_receive(:log)
-  #     thing_that_logs.do_something_that_logs_a_message
-  #
-  # @note This is only available when you have enabled the `should` syntax.
-  # @see RSpec::Mocks::ExampleMethods#expect
-
-  # @method should_not_receive
-  # Sets and expectation that this object should _not_ receive a message
-  # during this example.
-  # @see RSpec::Mocks::ExampleMethods#expect
-
-  # @method stub
-  # Tells the object to respond to the message with the specified value.
-  #
-  # @example
-  #
-  #     counter.stub(:count).and_return(37)
-  #     counter.stub(:count => 37)
-  #     counter.stub(:count) { 37 }
-  #
-  # @note This is only available when you have enabled the `should` syntax.
-  # @see RSpec::Mocks::ExampleMethods#allow
-
-  # @method unstub
-  # Removes a stub. On a double, the object will no longer respond to
-  # `message`. On a real object, the original method (if it exists) is
-  # restored.
-  #
-  # This is rarely used, but can be useful when a stub is set up during a
-  # shared `before` hook for the common case, but you want to replace it
-  # for a special case.
-  #
-  # @note This is only available when you have enabled the `should` syntax.
-
-  # @method stub_chain
-  # @overload stub_chain(method1, method2)
-  # @overload stub_chain("method1.method2")
-  # @overload stub_chain(method1, method_to_value_hash)
-  #
-  # Stubs a chain of methods.
-  #
-  # ## Warning:
-  #
-  # Chains can be arbitrarily long, which makes it quite painless to
-  # violate the Law of Demeter in violent ways, so you should consider any
-  # use of `stub_chain` a code smell. Even though not all code smells
-  # indicate real problems (think fluent interfaces), `stub_chain` still
-  # results in brittle examples.  For example, if you write
-  # `foo.stub_chain(:bar, :baz => 37)` in a spec and then the
-  # implementation calls `foo.baz.bar`, the stub will not work.
-  #
-  # @example
-  #
-  #     double.stub_chain("foo.bar") { :baz }
-  #     double.stub_chain(:foo, :bar => :baz)
-  #     double.stub_chain(:foo, :bar) { :baz }
-  #
-  #     # Given any of ^^ these three forms ^^:
-  #     double.foo.bar # => :baz
-  #
-  #     # Common use in Rails/ActiveRecord:
-  #     Article.stub_chain("recent.published") { [Article.new] }
-  #
-  # @note This is only available when you have enabled the `should` syntax.
-  # @see RSpec::Mocks::ExampleMethods#receive_message_chain
-
-  # @method as_null_object
-  # Tells the object to respond to all messages. If specific stub values
-  # are declared, they'll work as expected. If not, the receiver is
-  # returned.
-  #
-  # @note This is only available when you have enabled the `should` syntax.
-
-  # @method null_object?
-  # Returns true if this object has received `as_null_object`
-  #
-  # @note This is only available when you have enabled the `should` syntax.
+if defined?(BasicObject)
+  # The legacy `:should` syntax adds the following methods directly to
+  # `BasicObject` so that they are available off of any object. Note, however,
+  # that this syntax does not always play nice with delegate/proxy objects.
+  # We recommend you use the non-monkeypatching `:expect` syntax instead.
+  # @see Class
+  class BasicObject
+    # @method should_receive
+    # Sets an expectation that this object should receive a message before
+    # the end of the example.
+    #
+    # @example
+    #
+    #     logger = double('logger')
+    #     thing_that_logs = ThingThatLogs.new(logger)
+    #     logger.should_receive(:log)
+    #     thing_that_logs.do_something_that_logs_a_message
+    #
+    # @note This is only available when you have enabled the `should` syntax.
+    # @see RSpec::Mocks::ExampleMethods#expect
+
+    # @method should_not_receive
+    # Sets and expectation that this object should _not_ receive a message
+    # during this example.
+    # @see RSpec::Mocks::ExampleMethods#expect
+
+    # @method stub
+    # Tells the object to respond to the message with the specified value.
+    #
+    # @example
+    #
+    #     counter.stub(:count).and_return(37)
+    #     counter.stub(:count => 37)
+    #     counter.stub(:count) { 37 }
+    #
+    # @note This is only available when you have enabled the `should` syntax.
+    # @see RSpec::Mocks::ExampleMethods#allow
+
+    # @method unstub
+    # Removes a stub. On a double, the object will no longer respond to
+    # `message`. On a real object, the original method (if it exists) is
+    # restored.
+    #
+    # This is rarely used, but can be useful when a stub is set up during a
+    # shared `before` hook for the common case, but you want to replace it
+    # for a special case.
+    #
+    # @note This is only available when you have enabled the `should` syntax.
+
+    # @method stub_chain
+    # @overload stub_chain(method1, method2)
+    # @overload stub_chain("method1.method2")
+    # @overload stub_chain(method1, method_to_value_hash)
+    #
+    # Stubs a chain of methods.
+    #
+    # ## Warning:
+    #
+    # Chains can be arbitrarily long, which makes it quite painless to
+    # violate the Law of Demeter in violent ways, so you should consider any
+    # use of `stub_chain` a code smell. Even though not all code smells
+    # indicate real problems (think fluent interfaces), `stub_chain` still
+    # results in brittle examples.  For example, if you write
+    # `foo.stub_chain(:bar, :baz => 37)` in a spec and then the
+    # implementation calls `foo.baz.bar`, the stub will not work.
+    #
+    # @example
+    #
+    #     double.stub_chain("foo.bar") { :baz }
+    #     double.stub_chain(:foo, :bar => :baz)
+    #     double.stub_chain(:foo, :bar) { :baz }
+    #
+    #     # Given any of ^^ these three forms ^^:
+    #     double.foo.bar # => :baz
+    #
+    #     # Common use in Rails/ActiveRecord:
+    #     Article.stub_chain("recent.published") { [Article.new] }
+    #
+    # @note This is only available when you have enabled the `should` syntax.
+    # @see RSpec::Mocks::ExampleMethods#receive_message_chain
+
+    # @method as_null_object
+    # Tells the object to respond to all messages. If specific stub values
+    # are declared, they'll work as expected. If not, the receiver is
+    # returned.
+    #
+    # @note This is only available when you have enabled the `should` syntax.
+
+    # @method null_object?
+    # Returns true if this object has received `as_null_object`
+    #
+    # @note This is only available when you have enabled the `should` syntax.
+  end
 end
 
 # The legacy `:should` syntax adds the `any_instance` to `Class`.

data/lib/rspec/mocks/targets.rb

@@ -15,7 +15,7 @@ module RSpec
         end
       end
 
-      def self.delegate_not_to(matcher_method, options = {})
+      def self.delegate_not_to(matcher_method, options={})
         method_name = options.fetch(:from)
         define_method(method_name) do |matcher, &block|
           case matcher
@@ -30,7 +30,7 @@ module RSpec
       end
 
       def self.disallow_negation(method_name)
-        define_method(method_name) do |matcher, *args|
+        define_method(method_name) do |matcher, *_args|
           raise_negation_unsupported(method_name, matcher)
         end
       end
@@ -47,14 +47,14 @@ module RSpec
 
       def raise_unsupported_matcher(method_name, matcher)
         raise UnsupportedMatcherError,
-          "only the `receive` or `receive_messages` matchers are supported " +
-          "with `#{expression}(...).#{method_name}`, but you have provided: #{matcher}"
+              "only the `receive` or `receive_messages` matchers are supported " \
+              "with `#{expression}(...).#{method_name}`, but you have provided: #{matcher}"
       end
 
       def raise_negation_unsupported(method_name, matcher)
         raise NegationUnsupportedError,
-          "`#{expression}(...).#{method_name} #{matcher.name}` is not supported since it " +
-          "doesn't really make sense. What would it even mean?"
+              "`#{expression}(...).#{method_name} #{matcher.name}` is not supported since it " \
+              "doesn't really make sense. What would it even mean?"
       end
 
       def expression

data/lib/rspec/mocks/test_double.rb

@@ -39,12 +39,12 @@ module RSpec
 
       # @private
       def inspect
-        "#<#{self.class}:#{sprintf '0x%x', self.object_id} @name=#{@name.inspect}>"
+        "#<#{self.class}:#{'0x%x' % object_id} @name=#{@name.inspect}>"
       end
 
       # @private
       def to_s
-        inspect.gsub('<','[').gsub('>',']')
+        inspect.gsub('<', '[').gsub('>', ']')
       end
 
       # @private
@@ -53,8 +53,8 @@ module RSpec
       end
 
       # @private
-      def __build_mock_proxy(order_group)
-        __raise_expired_error or TestDoubleProxy.new(self, order_group, @name)
+      def __build_mock_proxy_unless_expired(order_group)
+        __raise_expired_error || __build_mock_proxy(order_group)
       end
 
       # @private
@@ -111,10 +111,19 @@ module RSpec
         ::RSpec::Mocks.space.proxy_for(self)
       end
 
+      def __build_mock_proxy(order_group)
+        TestDoubleProxy.new(self, order_group, @name)
+      end
+
       def __raise_expired_error
         return false unless @__expired
         ErrorGenerator.new(self, @name).raise_expired_test_double_error
       end
+
+      def initialize_copy(other)
+        as_null_object if other.null_object?
+        super
+      end
     end
 
     # A generic test double object. `double`, `instance_double` and friends