rspec-mocks 2.13.1 → 2.14.0.rc1

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

@@ -0,0 +1,92 @@
+module RSpec
+  module Mocks
+    module Matchers
+      class Receive
+        def initialize(message, block)
+          @message                 = message
+          @block                   = block
+          @recorded_customizations = []
+
+          # MRI, JRuby and RBX report the caller inconsistently; MRI
+          # reports an extra "in `new'" line in the backtrace that the
+          # others do not include. The safest way to find the right
+          # line is to search for the first line BEFORE rspec/mocks/syntax.rb.
+          @backtrace_line          = caller.find do |line|
+            !line.split(':').first.end_with?('rspec/mocks/syntax.rb')
+          end
+        end
+
+        def setup_expectation(subject, &block)
+          setup_mock_proxy_method_substitute(subject, :add_message_expectation, block)
+        end
+        alias matches? setup_expectation
+
+        def setup_negative_expectation(subject, &block)
+          setup_mock_proxy_method_substitute(subject, :add_negative_message_expectation, block)
+        end
+        alias does_not_match? setup_negative_expectation
+
+        def setup_allowance(subject, &block)
+          setup_mock_proxy_method_substitute(subject, :add_stub, block)
+        end
+
+        def setup_any_instance_expectation(subject, &block)
+          setup_any_instance_method_substitute(subject, :should_receive, block)
+        end
+
+        def setup_any_instance_negative_expectation(subject, &block)
+          setup_any_instance_method_substitute(subject, :should_not_receive, block)
+        end
+
+        def setup_any_instance_allowance(subject, &block)
+          setup_any_instance_method_substitute(subject, :stub, block)
+        end
+
+        MessageExpectation.public_instance_methods(false).each do |method|
+          next if method_defined?(method)
+
+          class_eval(<<-RUBY)
+            def #{method}(*args, &block)
+              @recorded_customizations << Customization.new(#{method.inspect}, args, block)
+              self
+            end
+          RUBY
+        end
+
+      private
+
+        def setup_mock_proxy_method_substitute(subject, method, block)
+          proxy = ::RSpec::Mocks.proxy_for(subject)
+          setup_method_substitute(proxy, method, block, @backtrace_line)
+        end
+
+        def setup_any_instance_method_substitute(subject, method, block)
+          any_instance_recorder = ::RSpec::Mocks.any_instance_recorder_for(subject)
+          setup_method_substitute(any_instance_recorder, method, block)
+        end
+
+        def setup_method_substitute(host, method, block, *args)
+          args << @message.to_sym
+          expectation = host.__send__(method, *args, &(@block || block))
+
+          @recorded_customizations.each do |customization|
+            customization.playback_onto(expectation)
+          end
+        end
+
+        class Customization
+          def initialize(method_name, args, block)
+            @method_name = method_name
+            @args        = args
+            @block       = block
+          end
+
+          def playback_onto(expectation)
+            expectation.__send__(@method_name, *@args, &@block)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rspec/mocks/message_expectation.rb

@@ -10,7 +10,7 @@ module RSpec
 
       # @private
       def initialize(error_generator, expectation_ordering, expected_from, method_double,
-                     expected_received_count=1, opts={}, &implementation_block)
+                     expected_received_count=1, opts={}, &implementation)
         @error_generator = error_generator
         @error_generator.opts = opts
         @expected_from = expected_from
@@ -24,9 +24,8 @@ module RSpec
         @args_to_yield = []
         @failed_fast = nil
         @eval_context = nil
-
-        @implementation = Implementation.new
-        self.inner_implementation_action = implementation_block
+        @implementation = implementation
+        @values_to_return = nil
       end
 
       # @private
@@ -77,12 +76,11 @@ module RSpec
 
         if implementation
           # TODO: deprecate `and_return { value }`
-          self.inner_implementation_action = implementation
+          @implementation = implementation
         else
-          self.terminal_implementation_action = AndReturnImplementation.new(values)
+          @values_to_return = values
+          @implementation = build_implementation
         end
-
-        nil
       end
 
       # Tells the object to delegate to the original unmodified method
@@ -100,7 +98,7 @@ module RSpec
         if @method_double.object.is_a?(RSpec::Mocks::TestDouble)
           @error_generator.raise_only_valid_on_a_partial_mock(:and_call_original)
         else
-          @implementation = AndCallOriginalImplementation.new(@method_double.original_method)
+          @implementation = @method_double.original_method
         end
       end
 
@@ -130,8 +128,7 @@ module RSpec
           exception = message ? exception.exception(message) : exception.exception
         end
 
-        self.terminal_implementation_action = Proc.new { raise exception }
-        nil
+        @implementation = Proc.new { raise exception }
       end
 
       # @overload and_throw(symbol)
@@ -145,8 +142,7 @@ module RSpec
       #   car.stub(:go).and_throw(:out_of_gas)
       #   car.stub(:go).and_throw(:out_of_gas, :level => 0.1)
       def and_throw(*args)
-        self.terminal_implementation_action = Proc.new { throw *args }
-        nil
+        @implementation = Proc.new { throw(*args) }
       end
 
       # Tells the object to yield one or more args to a block when the message
@@ -158,7 +154,7 @@ module RSpec
       def and_yield(*args, &block)
         yield @eval_context = Object.new.extend(RSpec::Mocks::InstanceExec) if block
         @args_to_yield << args
-        self.initial_implementation_action = AndYieldImplementation.new(@args_to_yield, @eval_context, @error_generator)
+        @implementation = build_implementation
         self
       end
 
@@ -172,14 +168,16 @@ module RSpec
         if (@expected_received_count == 0 && !@at_least) || ((@exactly || @at_most) && (@actual_received_count == @expected_received_count))
           @actual_received_count += 1
           @failed_fast = true
-          @error_generator.raise_expectation_error(@message, @expected_received_count, @actual_received_count, *args)
+          #args are the args we actually received, @argument_list_matcher is the
+          #list of args we were expecting
+          @error_generator.raise_expectation_error(@message, @expected_received_count, @argument_list_matcher, @actual_received_count, expectation_count_type, *args)
         end
 
         @order_group.handle_order_constraint self
 
         begin
-          if implementation.present?
-            implementation.call(*args, &block)
+          if @implementation
+            @implementation.call(*args, &block)
           elsif parent_stub
             parent_stub.invoke(nil, *args, &block)
           end
@@ -247,12 +245,23 @@ module RSpec
       # @private
       def generate_error
         if similar_messages.empty?
-          @error_generator.raise_expectation_error(@message, @expected_received_count, @actual_received_count, *expected_args)
+          @error_generator.raise_expectation_error(@message, @expected_received_count, @argument_list_matcher, @actual_received_count, expectation_count_type, *expected_args)
         else
           @error_generator.raise_similar_message_args_error(self, *@similar_messages)
         end
       end
 
+      def expectation_count_type
+        return :at_least if @at_least
+        return :at_most if @at_most
+        return nil
+      end
+
+      # @private
+      def description
+        @error_generator.describe_expectation(@message, @expected_received_count, @actual_received_count, *expected_args)
+      end
+
       def raise_out_of_order_error
         @error_generator.raise_out_of_order_error @message
       end
@@ -282,7 +291,7 @@ module RSpec
       #   cart.add(Book.new(:isbn => 1934356379))
       #   # => passes
       def with(*args, &block)
-        self.inner_implementation_action = block if block_given? unless args.empty?
+        @implementation = block if block_given? unless args.empty?
         @argument_list_matcher = ArgumentListMatcher.new(*args, &block)
         self
       end
@@ -294,7 +303,7 @@ module RSpec
       #
       #   dealer.should_receive(:deal_card).exactly(10).times
       def exactly(n, &block)
-        self.inner_implementation_action = block
+        @implementation = block if block
         set_expected_received_count :exactly, n
         self
       end
@@ -306,7 +315,11 @@ module RSpec
       #
       #   dealer.should_receive(:deal_card).at_least(9).times
       def at_least(n, &block)
-        self.inner_implementation_action = block
+        if n == 0
+          RSpec.deprecate "at_least(0) with should_receive", :replacement => "stub"
+        end
+
+        @implementation = block if block
         set_expected_received_count :at_least, n
         self
       end
@@ -318,7 +331,7 @@ module RSpec
       #
       #   dealer.should_receive(:deal_card).at_most(10).times
       def at_most(n, &block)
-        self.inner_implementation_action = block
+        @implementation = block if block
         set_expected_received_count :at_most, n
         self
       end
@@ -331,14 +344,15 @@ module RSpec
       #   dealer.should_receive(:deal_card).at_least(10).times
       #   dealer.should_receive(:deal_card).at_most(10).times
       def times(&block)
-        self.inner_implementation_action = block
+        @implementation = block if block
         self
       end
 
 
       # Allows an expected message to be received any number of times.
       def any_number_of_times(&block)
-        self.inner_implementation_action = block
+        RSpec.deprecate "any_number_of_times", :replacement => "stub"
+        @implementation = block if block
         @expected_received_count = :any
         self
       end
@@ -359,7 +373,7 @@ module RSpec
       #
       #   car.should_receive(:go).once
       def once(&block)
-        self.inner_implementation_action = block
+        @implementation = block if block
         set_expected_received_count :exactly, 1
         self
       end
@@ -370,7 +384,7 @@ module RSpec
       #
       #   car.should_receive(:go).twice
       def twice(&block)
-        self.inner_implementation_action = block
+        @implementation = block if block
         set_expected_received_count :exactly, 2
         self
       end
@@ -383,7 +397,7 @@ module RSpec
       #   api.should_receive(:run).ordered
       #   api.should_receive(:finish).ordered
       def ordered(&block)
-        self.inner_implementation_action = block
+        @implementation = block if block
         @order_group.register(self)
         @ordered = true
         self
@@ -404,7 +418,7 @@ module RSpec
         @actual_received_count += 1
       end
 
-    private
+      protected
 
       def failed_fast?
         @failed_fast
@@ -421,16 +435,13 @@ module RSpec
                                    end
       end
 
-      def initial_implementation_action=(action)
-        implementation.initial_action = action
-      end
-
-      def inner_implementation_action=(action)
-        implementation.inner_action = action if action
-      end
+      private
 
-      def terminal_implementation_action=(action)
-        implementation.terminal_action = action
+      def build_implementation
+        Implementation.new(
+          @values_to_return, @args_to_yield,
+          @eval_context, @error_generator
+        ).method(:call)
       end
     end
 
@@ -441,13 +452,10 @@ module RSpec
         super(error_generator, expectation_ordering, expected_from, method_double, 0, {}, &implementation)
       end
 
+      # no-op
+      # @deprecated and_return is not supported with negative message expectations.
       def and_return(*)
-        # no-op
-        # @deprecated and_return is not supported with negative message expectations.
-        RSpec::Mocks.warn_deprecation <<-MSG
-
-DEPRECATION: `and_return` with `should_not_receive` is deprecated. Called from #{caller(0)[1]}
-MSG
+        RSpec.deprecate "and_return with should_not_receive"
       end
 
       # @private
@@ -456,20 +464,29 @@ MSG
       end
     end
 
-    # Handles the implementation of an `and_yield` declaration.
+    # Represents a configured implementation. Takes into account
+    # `and_return` and `and_yield` instructions.
     # @private
-    class AndYieldImplementation
-      def initialize(args_to_yield, eval_context, error_generator)
+    class Implementation
+      def initialize(values_to_return, args_to_yield, eval_context, error_generator)
+        @values_to_return = values_to_return
         @args_to_yield = args_to_yield
         @eval_context = eval_context
         @error_generator = error_generator
       end
 
-      def arity
-        0
+      def call(*args_to_ignore, &block)
+        default_return_value = perform_yield(&block)
+        return default_return_value unless @values_to_return
+
+        if @values_to_return.size > 1
+          @values_to_return.shift
+        else
+          @values_to_return.first
+        end
       end
 
-      def call(&block)
+      def perform_yield(&block)
         return if @args_to_yield.empty? && @eval_context.nil?
 
         @error_generator.raise_missing_block_error @args_to_yield unless block
@@ -483,85 +500,5 @@ MSG
         value
       end
     end
-
-    # Handles the implementation of an `and_return` implementation.
-    # @private
-    class AndReturnImplementation
-      def initialize(values_to_return)
-        @values_to_return = values_to_return
-      end
-
-      def arity
-        0
-      end
-
-      def call(&block)
-        if @values_to_return.size > 1
-          @values_to_return.shift
-        else
-          @values_to_return.first
-        end
-      end
-    end
-
-    # Represents a configured implementation. Takes into account
-    # any number of sub-implementations.
-    # @private
-    class Implementation
-      attr_accessor :initial_action, :inner_action, :terminal_action
-
-      def call(*args, &block)
-        actions.map do |action|
-          action.arity.zero? ? action.call(&block) : action.call(*args, &block)
-        end.last
-      end
-
-      def present?
-        actions.any?
-      end
-
-    private
-
-      def actions
-        [initial_action, inner_action, terminal_action].compact
-      end
-    end
-
-    # Represents an `and_call_original` implementation.
-    # @private
-    class AndCallOriginalImplementation
-      def initialize(method)
-        @method = method
-      end
-
-      CannotModifyFurtherError = Class.new(StandardError)
-
-      def initial_action=(value)
-        raise cannot_modify_further_error
-      end
-
-      def inner_action=(value)
-        raise cannot_modify_further_error
-      end
-
-      def terminal_action=(value)
-        raise cannot_modify_further_error
-      end
-
-      def present?
-        true
-      end
-
-      def call(*args, &block)
-        @method.call(*args, &block)
-      end
-
-    private
-
-      def cannot_modify_further_error
-        CannotModifyFurtherError.new "This method has already been configured " +
-          "to call the original implementation, and cannot be modified further."
-      end
-    end
   end
 end