rspec-mocks 3.0.0.beta1 → 3.0.0.beta2

data/lib/rspec/mocks/object_reference.rb

@@ -87,4 +87,3 @@ module RSpec
     end
   end
 end
-

data/lib/rspec/mocks/proxy.rb

@@ -14,7 +14,6 @@ module RSpec
         @order_group = order_group
         @name = name
         @error_generator = ErrorGenerator.new(object, name)
-        @expectation_ordering = RSpec::Mocks::space.expectation_ordering
         @messages_received = []
         @options = options
         @null_object = false
@@ -47,12 +46,12 @@ module RSpec
         meth_double = method_double_for(method_name)
 
         if null_object? && !block
-          meth_double.add_default_stub(@error_generator, @expectation_ordering, location, opts) do
+          meth_double.add_default_stub(@error_generator, @order_group, location, opts) do
             @object
           end
         end
 
-        meth_double.add_expectation @error_generator, @expectation_ordering, location, opts, &block
+        meth_double.add_expectation @error_generator, @order_group, location, opts, &block
       end
 
       # @private
@@ -66,7 +65,7 @@ module RSpec
 
         meth_double.build_expectation(
           @error_generator,
-          @expectation_ordering
+          @order_group
         )
       end
 
@@ -103,7 +102,7 @@ module RSpec
 
       # @private
       def add_stub(location, method_name, opts={}, &implementation)
-        method_double_for(method_name).add_stub @error_generator, @expectation_ordering, location, opts, &implementation
+        method_double_for(method_name).add_stub @error_generator, @order_group, location, opts, &implementation
       end
 
       # @private
@@ -124,13 +123,10 @@ module RSpec
       # @private
       def verify
         @method_doubles.each_value {|d| d.verify}
-      ensure
-        reset
       end
 
       # @private
       def reset
-        @method_doubles.each_value {|d| d.reset}
         @messages_received.clear
       end
 
@@ -192,7 +188,13 @@ module RSpec
         @error_generator.raise_missing_default_stub_error(expectation, *args)
       end
 
-      private
+      # @private
+      def visibility_for(method_name)
+        # This is the default (for test doubles). Subclasses override this.
+        :public
+      end
+
+    private
 
       def method_double_for(message)
         @method_doubles[message.to_sym]
@@ -231,15 +233,25 @@ module RSpec
       end
     end
 
-    class PartialMockProxy < Proxy
+    # @private
+    class TestDoubleProxy < Proxy
+      def reset
+        @method_doubles.clear
+        object.__disallow_further_usage!
+        super
+      end
+    end
+
+    # @private
+    class PartialDoubleProxy < Proxy
       def method_handle_for(message)
         if any_instance_class_recorder_observing_method?(@object.class, message)
-          message = ::RSpec::Mocks.
+          message = ::RSpec::Mocks.space.
             any_instance_recorder_for(@object.class).
             build_alias_method_name(message)
         end
 
-        ::RSpec::Mocks.method_handle_for(@object, message)
+        ::RSpec::Support.method_handle_for(@object, message)
       rescue NameError
         nil
       end
@@ -256,14 +268,59 @@ module RSpec
         super
       end
 
+      # @private
+      def visibility_for(method_name)
+        # We fall back to :public because by default we allow undefined methods
+        # to be stubbed, and when we do so, we make them public.
+        MethodReference.method_visibility_for(@object, method_name) || :public
+      end
+
+      def reset
+        @method_doubles.each_value {|d| d.reset}
+        super
+      end
+
     private
 
       def any_instance_class_recorder_observing_method?(klass, method_name)
-        return true if ::RSpec::Mocks.any_instance_recorder_for(klass).already_observing?(method_name)
+        return true if ::RSpec::Mocks.space.any_instance_recorder_for(klass).already_observing?(method_name)
         superklass = klass.superclass
         return false if superklass.nil?
         any_instance_class_recorder_observing_method?(superklass, method_name)
       end
     end
+
+    # @private
+    class ProxyForNil < PartialDoubleProxy
+      def initialize(order_group)
+        @warn_about_expectations = true
+        super(nil, order_group)
+      end
+
+      attr_accessor :warn_about_expectations
+      alias warn_about_expectations? warn_about_expectations
+
+      def add_message_expectation(location, method_name, opts={}, &block)
+        warn(method_name) if warn_about_expectations?
+        super
+      end
+
+      def add_negative_message_expectation(location, method_name, &implementation)
+        warn(method_name) if warn_about_expectations?
+        super
+      end
+
+      def add_stub(location, method_name, opts={}, &implementation)
+        warn(method_name) if warn_about_expectations?
+        super
+      end
+
+    private
+
+      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
+    end
   end
 end

data/lib/rspec/mocks/ruby_features.rb

@@ -0,0 +1,24 @@
+module RSpec
+  module Mocks
+    # @api private
+    #
+    # Provides query methods for ruby features that differ among
+    # implementations.
+    module RubyFeatures
+      def optional_and_splat_args_supported?
+        Method.method_defined?(:parameters)
+      end
+      module_function :optional_and_splat_args_supported?
+
+      def kw_args_supported?
+        RUBY_VERSION >= '2.0.0' && RUBY_ENGINE != 'rbx'
+      end
+      module_function :kw_args_supported?
+
+      def required_kw_args_supported?
+        RUBY_VERSION >= '2.1.0' && RUBY_ENGINE != 'rbx'
+      end
+      module_function :required_kw_args_supported?
+    end
+  end
+end

data/lib/rspec/mocks/space.rb

@@ -1,44 +1,81 @@
 module RSpec
   module Mocks
+    # @private
+    # Provides a default space implementation for outside
+    # the scope of an example. Called "root" because it serves
+    # as the root of the space stack.
+    class RootSpace
+      def proxy_for(*args)
+        raise_lifecycle_message
+      end
+
+      def any_instance_recorder_for(*args)
+        raise_lifecycle_message
+      end
+
+      def register_constant_mutator(mutator)
+        raise_lifecycle_message
+      end
+
+      def reset_all
+      end
+
+      def verify_all
+      end
+
+      def registered?(object)
+        false
+      end
+
+      def new_scope
+        Space.new
+      end
+
+    private
+
+      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."
+      end
+    end
+
     # @api private
     class Space
-      attr_reader :proxies, :any_instance_recorders
+      attr_reader :proxies, :any_instance_recorders, :expectation_ordering
 
       def initialize
         @proxies                 = {}
         @any_instance_recorders  = {}
+        @constant_mutators       = []
+        @expectation_ordering    = OrderGroup.new
       end
 
-      def verify_all
-        proxies.each_value do |object|
-          object.verify
-        end
+      def new_scope
+        NestedSpace.new(self)
+      end
 
-        any_instance_recorders.each_value do |recorder|
-          recorder.verify
-        end
+      def verify_all
+        proxies.each_value { |proxy| proxy.verify }
+        any_instance_recorders.each_value { |recorder| recorder.verify }
       end
 
       def reset_all
-        ConstantMutator.reset_all
-
-        proxies.each_value do |object|
-          object.reset
-        end
+        proxies.each_value { |proxy| proxy.reset }
+        @constant_mutators.reverse.each { |mut| mut.idempotently_reset }
+      end
 
-        proxies.clear
-        any_instance_recorders.clear
-        expectation_ordering.clear
+      def register_constant_mutator(mutator)
+        @constant_mutators << mutator
       end
 
-      def expectation_ordering
-        @expectation_ordering ||= OrderGroup.new
+      def constant_mutator_for(name)
+        @constant_mutators.find { |m| m.full_constant_name == name }
       end
 
       def any_instance_recorder_for(klass)
         id = klass.__id__
         any_instance_recorders.fetch(id) do
-          any_instance_recorders[id] = AnyInstance::Recorder.new(klass)
+          any_instance_recorder_not_found_for(id, klass)
         end
       end
 
@@ -52,18 +89,7 @@ module RSpec
 
       def proxy_for(object)
         id = id_for(object)
-        proxies.fetch(id) do
-          proxies[id] = case object
-                        when NilClass   then ProxyForNil.new(expectation_ordering)
-                        when TestDouble then object.__build_mock_proxy(expectation_ordering)
-                        else
-                          if RSpec::Mocks.configuration.verify_partial_doubles?
-                            VerifyingPartialMockProxy.new(object, expectation_ordering)
-                          else
-                            PartialMockProxy.new(object, expectation_ordering)
-                          end
-                        end
-        end
+        proxies.fetch(id) { proxy_not_found_for(id, object) }
       end
 
       alias ensure_registered proxy_for
@@ -72,6 +98,25 @@ module RSpec
         proxies.has_key?(id_for object)
       end
 
+    private
+
+      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)
+          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)
+        any_instance_recorders[id] = AnyInstance::Recorder.new(klass)
+      end
+
       if defined?(::BasicObject) && !::BasicObject.method_defined?(:__id__) # for 1.9.2
         require 'securerandom'
 
@@ -91,5 +136,34 @@ module RSpec
         end
       end
     end
+
+    class NestedSpace < Space
+      def initialize(parent)
+        @parent = parent
+        super()
+      end
+
+      def proxies_of(klass)
+        super + @parent.proxies_of(klass)
+      end
+
+      def constant_mutator_for(name)
+        super || @parent.constant_mutator_for(name)
+      end
+
+      def registered?(object)
+        super || @parent.registered?(object)
+      end
+
+    private
+
+      def proxy_not_found_for(id, object)
+        @parent.proxies[id] || super
+      end
+
+      def any_instance_recorder_not_found_for(id, klass)
+        @parent.any_instance_recorders[id] || super
+      end
+    end
   end
 end

data/lib/rspec/mocks/standalone.rb

@@ -1,3 +1,3 @@
 require 'rspec/mocks'
-
-RSpec::Mocks.setup(self)
+include RSpec::Mocks::ExampleMethods
+RSpec::Mocks.setup

data/lib/rspec/mocks/syntax.rb

@@ -10,11 +10,11 @@ module RSpec
       end
 
       # @api private
-      def self.warn_unless_should_configured(method_name)
+      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",
-            :replacement => "the new `:expect` syntax or explicitly enable `:should`"
+            :replacement => replacement
           )
 
           @warn_about_should = false
@@ -24,7 +24,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)
-        @warn_about_should = false
+        @warn_about_should = false if syntax_host == default_should_syntax_host
         return if should_enabled?(syntax_host)
 
         syntax_host.class_exec do
@@ -51,7 +51,7 @@ module RSpec
           end
 
           def unstub(message)
-            ::RSpec::Mocks::Syntax.warn_unless_should_configured(__method__)
+            ::RSpec::Mocks::Syntax.warn_unless_should_configured(__method__, "`allow(...).to_receive(...).and_call_original` or explicitly enable `:should`")
             ::RSpec::Mocks.space.proxy_for(self).remove_stub(message)
           end
 
@@ -63,7 +63,7 @@ module RSpec
           def as_null_object
             ::RSpec::Mocks::Syntax.warn_unless_should_configured(__method__)
             @_null_object = true
-            ::RSpec::Mocks.proxy_for(self).as_null_object
+            ::RSpec::Mocks.space.proxy_for(self).as_null_object
           end
 
           def null_object?
@@ -73,14 +73,14 @@ module RSpec
 
           def received_message?(message, *args, &block)
             ::RSpec::Mocks::Syntax.warn_unless_should_configured(__method__)
-            ::RSpec::Mocks.proxy_for(self).received_message?(message, *args, &block)
+            ::RSpec::Mocks.space.proxy_for(self).received_message?(message, *args, &block)
           end
 
           unless Class.respond_to? :any_instance
             Class.class_exec do
               def any_instance
                 ::RSpec::Mocks::Syntax.warn_unless_should_configured(__method__)
-                ::RSpec::Mocks.any_instance_recorder_for(self)
+                ::RSpec::Mocks.space.any_instance_recorder_for(self)
               end
             end
           end
@@ -124,6 +124,10 @@ module RSpec
             matcher
           end
 
+          def receive_message_chain(*messages, &block)
+            Matchers::ReceiveMessageChain.new(messages, &block)
+          end
+
           def allow(target)
             AllowanceTarget.new(target)
           end
@@ -152,6 +156,7 @@ module RSpec
         syntax_host.class_exec do
           undef receive
           undef receive_messages
+          undef receive_message_chain
           undef allow
           undef expect_any_instance_of
           undef allow_any_instance_of
@@ -368,7 +373,37 @@ module RSpec
       #   allow(obj).to receive_messages(:speak => "Hello", :meow => "Meow")
       #
       # @note This is only available when you have enabled the `expect` syntax.
+      #
+      # @method receive_message_chain
+      # @overload receive_message_chain(method1, method2)
+      # @overload receive_message_chain("method1.method2")
+      # @overload receive_message_chain(method1, method_to_value_hash)
+      #
+      # stubs/mocks a chain of messages on an object or test double.
+      #
+      # ## 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 `receive_message_chain` a code smell. Even though not all code smells
+      # indicate real problems (think fluent interfaces), `receive_message_chain` still
+      # results in brittle examples.  For example, if you write
+      # `foo.receive_message_chain(:bar, :baz => 37)` in a spec and then the
+      # implementation calls `foo.baz.bar`, the stub will not work.
+      #
+      # @example
+      #
+      #     allow(double).to receive_message_chain("foo.bar") { :baz }
+      #     allow(double).to receive_message_chain(:foo, :bar => :baz)
+      #     allow(double).to receive_message_chain(:foo, :bar) { :baz }
+      #
+      #     # Given any of ^^ these three forms ^^:
+      #     double.foo.bar # => :baz
+      #
+      #     # Common use in Rails/ActiveRecord:
+      #     allow(Article).to receive_message_chain("recent.published") { [Article.new] }
+      #
+      # @note This is only available when you have enabled the `expect` syntax.
     end
   end
 end
-