rspec-mocks 2.99.4 → 3.0.0.beta1

data/features/verifying_doubles/object_doubles.feature

@@ -0,0 +1,65 @@
+Feature: Using an object double
+
+  `object_double` can be used to create a double from an existing "template"
+  object, from which it verifies that any stubbed methods on the double also
+  exist on the template. This is useful for objects that are readily
+  constructable, but may have far-reaching side-effects such as talking to a
+  database or external API. In this case, using a double rather than the real
+  thing allows you to focus on the communication patterns of the object's
+  interface without having to worry about accidentally causing side-effects.
+  Object doubles can also be used to verify methods defined on an object using
+  `method_missing`, which is not possible with `instance_double`.
+
+  In addition, `object_double` can be used with specific constant values, as
+  shown below. This is for niche situations, such as when dealing with
+  singleton objects.
+
+  Scenario: doubling an existing object
+    Given a file named "spec/user_spec.rb" with:
+      """ruby
+      class User
+        # Don't want to accidentally trigger this!
+        def save; sleep 100; end
+      end
+
+      def save_user(user)
+        "saved!" if user.save
+      end
+
+      describe '#save_user' do
+        it 'renders message on success' do
+          user = object_double(User.new, :save => true)
+          expect(save_user(user)).to eq("saved!")
+        end
+      end
+      """
+    When I run `rspec spec/user_spec.rb`
+    Then the examples should all pass
+
+
+  Scenario: doubling a constant object
+    Given a file named "spec/email_spec.rb" with:
+      """ruby
+      require 'logger'
+
+      module MyApp
+        LOGGER = Logger.new("myapp")
+      end
+
+      class Email
+        def self.send_to(recipient)
+          MyApp::LOGGER.info("Sent to #{recipient}")
+          # other emailing logic
+        end
+      end
+
+      describe Email do
+        it 'logs a message when sending' do
+          logger = object_double("MyApp::LOGGER", :info => nil).as_stubbed_const
+          Email.send_to('hello@foo.com')
+          expect(logger).to have_received(:info).with("Sent to hello@foo.com")
+        end
+      end
+      """
+    When I run `rspec spec/email_spec.rb`
+    Then the examples should all pass

data/features/verifying_doubles/partial_doubles.feature

@@ -0,0 +1,34 @@
+Feature: Partial doubles
+
+  When the `verify_partial_doubles` configuration option is set, the same arity
+  and method existince checks that are performed for `object_double` are also
+  performed on partial doubles. You should set this unless you have a good
+  reason not to. It defaults to off only for backwards compatibility.
+
+  Scenario: doubling an existing object
+    Given a file named "spec/user_spec.rb" with:
+      """ruby
+      class User
+        def save; false; end
+      end
+
+      def save_user(user)
+        "saved!" if user.save
+      end
+
+      RSpec.configure do |config|
+        config.mock_with :rspec do |mocks|
+          mocks.verify_partial_doubles = true
+        end
+      end
+
+      describe '#save_user' do
+        it 'renders message on success' do
+          user = User.new
+          expect(user).to receive(:saave).and_return(true) # Typo in name
+          expect(save_user(user)).to eq("saved!")
+        end
+      end
+      """
+    When I run `rspec spec/user_spec.rb`
+    Then the output should contain "1 example, 1 failure"

data/lib/rspec/mocks.rb

@@ -2,25 +2,16 @@ require 'rspec/mocks/framework'
 require 'rspec/mocks/version'
 
 module RSpec
+
   module Mocks
     class << self
       attr_accessor :space
 
-      def setup(host=nil)
-        host_is_from_rspec_core = defined?(::RSpec::Core::ExampleGroup) && host.is_a?(::RSpec::Core::ExampleGroup)
-        if host
-          unless host_is_from_rspec_core
-            RSpec.deprecate(
-              "The host argument to `RSpec::Mocks.setup`",
-              :replacement => "`include RSpec::Mocks::ExampleMethods` in #{host.inspect}"
-            )
-          end
-
-          (class << host; self; end).class_eval do
-            include RSpec::Mocks::ExampleMethods
-          end
+      def setup(host)
+        (class << host; self; end).class_exec do
+          include RSpec::Mocks::ExampleMethods
         end
-        space.outside_example = false
+        self.space ||= RSpec::Mocks::Space.new
       end
 
       def verify
@@ -29,7 +20,6 @@ module RSpec
 
       def teardown
         space.reset_all
-        space.outside_example = true
       end
 
       def proxy_for(object)
@@ -61,7 +51,7 @@ module RSpec
           CallerFilter.first_non_rspec_line
         }
         ::RSpec::Mocks.proxy_for(subject).
-          add_stub(orig_caller, message.to_sym, opts, &block)
+          add_stub(orig_caller, message, opts, &block)
       end
 
       # Sets a message expectation on `subject`.
@@ -80,7 +70,7 @@ module RSpec
           CallerFilter.first_non_rspec_line
         }
         ::RSpec::Mocks.proxy_for(subject).
-          add_message_expectation(orig_caller, message.to_sym, opts, &block)
+          add_message_expectation(orig_caller, message, opts, &block)
       end
 
       # @api private
@@ -105,22 +95,6 @@ module RSpec
 
     # @private
     IGNORED_BACKTRACE_LINE = 'this backtrace line is ignored'
-
-    self.space = RSpec::Mocks::Space.new
-
-    DEPRECATED_CONSTANTS =
-      {
-        :Mock            => Double,
-        :ConstantStubber => ConstantMutator,
-      }
-
-    def self.const_missing(name)
-      if const = DEPRECATED_CONSTANTS[name]
-        RSpec.deprecate("RSpec::Mocks::#{name}", :replacement => const.name)
-        const
-      else
-        super
-      end
-    end
   end
 end
+

data/lib/rspec/mocks/any_instance/chain.rb

@@ -6,8 +6,6 @@ module RSpec
           @recorder          = recorder
           @expectation_args  = args
           @expectation_block = block
-          @source_line       = CallerFilter.first_non_rspec_line
-          ensure_expectation_block_has_source_location
         end
 
         module Customizations
@@ -19,11 +17,9 @@ module RSpec
           #   @see RSpec::Mocks::MessageExpectation#$1
           #
           def self.record(method_name)
-            class_eval(<<-EOM, __FILE__, __LINE__ + 1)
-              def #{method_name}(*args, &block)
-                record(:#{method_name}, *args, &block)
-              end
-            EOM
+            define_method(method_name) do |*args, &block|
+              record(method_name, *args, &block)
+            end
           end
 
           record :and_return
@@ -73,21 +69,8 @@ module RSpec
 
         private
 
-        def create_message_expectation_on(instance)
-          me = yield(::RSpec::Mocks.proxy_for(instance), IGNORED_BACKTRACE_LINE)
-
-          if RSpec::Mocks.configuration.should_warn_about_any_instance_blocks?
-            me.warn_about_receiver_passing(@source_line)
-            me.display_any_instance_deprecation_warning_if_necessary(@expectation_block)
-          elsif RSpec::Mocks.configuration.yield_receiver_to_any_instance_implementation_blocks?
-            me.and_yield_receiver_to_implementation
-          end
-
-          me
-        end
-
         def negated?
-          messages.any? { |(message, *_), _| message.to_sym == :never }
+          messages.any? { |(message, *_), _| message == :never }
         end
 
         def messages
@@ -103,19 +86,6 @@ module RSpec
           messages << [args.unshift(rspec_method_name), block]
           self
         end
-
-        if Proc.method_defined?(:source_location)
-          def ensure_expectation_block_has_source_location; end
-        else
-          def ensure_expectation_block_has_source_location
-            return unless @expectation_block
-            source_location = CallerFilter.first_non_rspec_line.split(':')
-
-            @expectation_block.extend Module.new {
-              define_method(:source_location) { source_location }
-            }
-          end
-        end
       end
     end
   end

data/lib/rspec/mocks/any_instance/expectation_chain.rb

@@ -12,15 +12,25 @@ module RSpec
           super
         end
 
-      private
-
+        private
         def verify_invocation_order(rspec_method_name, *args, &block)
         end
+      end
+
+      # @api private
+      class PositiveExpectationChain < ExpectationChain
+
+        private
 
         def create_message_expectation_on(instance)
-          super do |proxy, expected_from|
-            proxy.add_message_expectation(expected_from, *@expectation_args, &@expectation_block)
+          proxy = ::RSpec::Mocks.proxy_for(instance)
+          expected_from = IGNORED_BACKTRACE_LINE
+          me = proxy.add_message_expectation(expected_from, *@expectation_args, &@expectation_block)
+          if RSpec::Mocks.configuration.yield_receiver_to_any_instance_implementation_blocks?
+            me.and_yield_receiver_to_implementation
           end
+
+          me
         end
 
         def invocation_order

data/lib/rspec/mocks/any_instance/message_chains.rb

@@ -2,55 +2,70 @@ module RSpec
   module Mocks
     module AnyInstance
       # @private
-      class MessageChains < Hash
+      class MessageChains
         def initialize
-          super {|h,k| h[k] = []}
+          @chains_by_method_name = Hash.new { |h, k| h[k] = [] }
+        end
+
+        # @private
+        def [](method_name)
+          @chains_by_method_name[method_name]
         end
 
         # @private
         def add(method_name, chain)
-          self[method_name] << chain
+          @chains_by_method_name[method_name] << chain
           chain
         end
 
         # @private
         def remove_stub_chains_for!(method_name)
-          self[method_name].reject! {|chain| chain.is_a?(StubChain)}
+          @chains_by_method_name[method_name].reject! do |chain|
+            StubChain === chain
+          end
         end
 
         # @private
         def has_expectation?(method_name)
-          self[method_name].find {|chain| chain.is_a?(ExpectationChain)}
+          @chains_by_method_name[method_name].find do |chain|
+            ExpectationChain === chain
+          end
         end
 
         # @private
         def all_expectations_fulfilled?
-          all? {|method_name, chains| chains.all? {|chain| chain.expectation_fulfilled?}}
+          @chains_by_method_name.all? do |method_name, chains|
+            chains.all? { |chain| chain.expectation_fulfilled? }
+          end
         end
 
         # @private
         def unfulfilled_expectations
-          map do |method_name, chains|
-            method_name.to_s if chains.last.is_a?(ExpectationChain) unless chains.last.expectation_fulfilled?
+          @chains_by_method_name.map do |method_name, chains|
+            method_name.to_s if ExpectationChain === chains.last unless chains.last.expectation_fulfilled?
           end.compact
         end
 
         # @private
         def received_expected_message!(method_name)
-          self[method_name].each {|chain| chain.expectation_fulfilled!}
+          @chains_by_method_name[method_name].each do |chain|
+            chain.expectation_fulfilled!
+          end
         end
 
         # @private
         def playback!(instance, method_name)
           raise_if_second_instance_to_receive_message(instance)
-          self[method_name].each {|chain| chain.playback!(instance)}
+          @chains_by_method_name[method_name].each do |chain|
+            chain.playback!(instance)
+          end
         end
 
         private
 
         def raise_if_second_instance_to_receive_message(instance)
-          @instance_with_expectation ||= instance if instance.is_a?(ExpectationChain)
-          if instance.is_a?(ExpectationChain) && !@instance_with_expectation.equal?(instance)
+          @instance_with_expectation ||= instance if ExpectationChain === instance
+          if ExpectationChain === instance && !@instance_with_expectation.equal?(instance)
             raise RSpec::Mocks::MockExpectationError, "Exactly one instance should have received the following message(s) but didn't: #{unfulfilled_expectations.sort.join(', ')}"
           end
         end

data/lib/rspec/mocks/any_instance/recorder.rb

@@ -11,7 +11,7 @@ module RSpec
       # @see Chain
       class Recorder
         # @private
-        attr_reader :message_chains, :stubs
+        attr_reader :message_chains, :stubs, :klass
 
         def initialize(klass)
           @message_chains = MessageChains.new
@@ -27,7 +27,7 @@ module RSpec
         #
         # @see Methods#stub
         def stub(method_name_or_method_map, &block)
-          if method_name_or_method_map.is_a?(Hash)
+          if Hash === method_name_or_method_map
             method_name_or_method_map.each do |method_name, return_value|
               stub(method_name).and_return(return_value)
             end
@@ -57,7 +57,7 @@ module RSpec
         def should_receive(method_name, &block)
           @expectation_set = true
           observe!(method_name)
-          message_chains.add(method_name, ExpectationChain.new(self, method_name, &block))
+          message_chains.add(method_name, PositiveExpectationChain.new(self, method_name, &block))
         end
 
         def should_not_receive(method_name, &block)
@@ -88,16 +88,9 @@ module RSpec
           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
-        def stub!(*)
-          raise "stub! is not supported on any_instance. Use stub instead."
-        end
-
-        # @private
-        def unstub!(*)
-          raise "unstub! is not supported on any_instance. Use unstub instead."
+        ensure
+          stop_all_observation!
+          ::RSpec::Mocks.space.remove_any_instance_recorder_for(@klass)
         end
 
         # @private
@@ -149,7 +142,7 @@ module RSpec
 
         def restore_original_method!(method_name)
           alias_method_name = build_alias_method_name(method_name)
-          @klass.class_eval do
+          @klass.class_exec do
             remove_method method_name
             alias_method  method_name, alias_method_name
             remove_method alias_method_name
@@ -157,14 +150,14 @@ module RSpec
         end
 
         def remove_dummy_method!(method_name)
-          @klass.class_eval do
+          @klass.class_exec do
             remove_method method_name
           end
         end
 
         def backup_method!(method_name)
           alias_method_name = build_alias_method_name(method_name)
-          @klass.class_eval do
+          @klass.class_exec do
             alias_method alias_method_name, method_name
           end if public_protected_or_private_method_defined?(method_name)
         end
@@ -179,28 +172,27 @@ module RSpec
         end
 
         def observe!(method_name)
+          if RSpec::Mocks.configuration.verify_partial_doubles?
+            raise MockExpectationError unless @klass.method_defined?(method_name)
+          end
+
           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
+          @klass.__send__(:define_method, method_name) do |*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
         end
 
         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
+          @klass.__send__(:define_method, method_name) do |*args, &blk|
+            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
         end
       end
     end