rspec-mocks 3.0.0.beta1 → 3.0.0.beta2

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

@@ -1,6 +1,7 @@
 module RSpec
   module Mocks
     module Matchers
+      # @private
       class ReceiveMessages
 
         def initialize(message_return_value_hash)
@@ -53,11 +54,11 @@ module RSpec
       private
 
         def proxy_on(subject)
-          ::RSpec::Mocks.proxy_for(subject)
+          ::RSpec::Mocks.space.proxy_for(subject)
         end
 
         def any_instance_of(subject)
-          ::RSpec::Mocks.any_instance_recorder_for(subject)
+          ::RSpec::Mocks.space.any_instance_recorder_for(subject)
         end
 
         def each_message_on(host)

data/lib/rspec/mocks/message_chain.rb

@@ -0,0 +1,91 @@
+module RSpec
+  module Mocks
+    # @private
+    class MessageChain
+      attr_reader :object, :chain, :block
+
+      def initialize(object, *chain, &blk)
+        @object = object
+        @chain, @block = format_chain(*chain, &blk)
+      end
+
+      # @api private
+      def setup_chain
+        if chain.length > 1
+          if matching_stub = find_matching_stub
+            chain.shift
+            chain_on(matching_stub.invoke(nil), *chain, &@block)
+          elsif matching_expectation = find_matching_expectation
+            chain.shift
+            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)
+            chain_on(next_in_chain, *chain, &@block)
+          end
+        else
+          ::RSpec::Mocks.allow_message(object, chain.shift, {}, &block)
+        end
+      end
+
+    private
+
+      def expectation(object, message, returned_object)
+        raise NotImplementedError.new
+      end
+
+      def chain_on(object, *chain, &block)
+        initialize(object, *chain, &block)
+        setup_chain
+      end
+
+      def format_chain(*chain, &blk)
+        if Hash === chain.last
+          hash = chain.pop
+          hash.each do |k,v|
+            chain << k
+            blk = Proc.new { v }
+          end
+        end
+        return chain.join('.').split('.'), blk
+      end
+
+      def find_matching_stub
+        ::RSpec::Mocks.space.proxy_for(object).
+          __send__(:find_matching_method_stub, chain.first.to_sym)
+      end
+
+      def find_matching_expectation
+        ::RSpec::Mocks.space.proxy_for(object).
+          __send__(:find_matching_expectation, chain.first.to_sym)
+      end
+    end
+
+    # @private
+    class ExpectChain < MessageChain
+      # @api private
+      def self.expect_chain_on(object, *chain, &blk)
+        new(object, *chain, &blk).setup_chain
+      end
+
+      private
+
+      def expectation(object, message, returned_object)
+        ::RSpec::Mocks.expect_message(object, message, {}) { returned_object }
+      end
+    end
+
+    # @private
+    class StubChain < MessageChain
+      def self.stub_chain_on(object, *chain, &blk)
+        new(object, *chain, &blk).setup_chain
+      end
+
+      private
+
+      def expectation(object, message, returned_object)
+        ::RSpec::Mocks.allow_message(object, message, {}) { returned_object }
+      end
+    end
+  end
+end

data/lib/rspec/mocks/message_expectation.rb

@@ -8,7 +8,7 @@ module RSpec
     class SimpleMessageExpectation
 
       def initialize(message, response, error_generator, backtrace_line = nil)
-        @message, @response, @error_generator, @backtrace_line = message, response, error_generator, backtrace_line
+        @message, @response, @error_generator, @backtrace_line = message.to_sym, response, error_generator, backtrace_line
         @received = false
       end
 
@@ -18,7 +18,7 @@ module RSpec
       end
 
       def matches?(message, *_)
-        @message == message
+        @message == message.to_sym
       end
 
       def called_max_times?
@@ -34,6 +34,7 @@ module RSpec
       end
     end
 
+    # @private
     class MessageExpectation
       # @private
       attr_accessor :error_generator, :implementation
@@ -76,7 +77,6 @@ module RSpec
 
       # @overload and_return(value)
       # @overload and_return(first_value, second_value)
-      # @overload and_return(&block)
       #
       # Tells the object to return a value when it receives the message.  Given
       # more than one value, the first value is returned the first time the
@@ -86,45 +86,33 @@ module RSpec
       # If the message is received more times than there are values, the last
       # value is received for every subsequent call.
       #
-      # The block format is still supported, but is unofficially deprecated in
-      # favor of just passing a block to the stub method.
-      #
       # @example
       #
-      #   counter.stub(:count).and_return(1)
+      #   allow(counter).to receive(:count).and_return(1)
       #   counter.count # => 1
       #   counter.count # => 1
       #
-      #   counter.stub(:count).and_return(1,2,3)
+      #   allow(counter).to receive(:count).and_return(1,2,3)
       #   counter.count # => 1
       #   counter.count # => 2
       #   counter.count # => 3
       #   counter.count # => 3
       #   counter.count # => 3
       #   # etc
-      #
-      #   # Supported, but ...
-      #   counter.stub(:count).and_return { 1 }
-      #   counter.count # => 1
-      #
-      #   # ... this is prefered
-      #   counter.stub(:count) { 1 }
-      #   counter.count # => 1
-      def and_return(*values, &implementation)
+      def and_return(first_value, *values)
         if negative?
           raise "`and_return` is not supported with negative message expectations"
-        else
-          @expected_received_count = [@expected_received_count, values.size].max unless ignoring_args? || (@expected_received_count == 0 and @at_least)
-
-          if implementation
-            # TODO: deprecate `and_return { value }`
-            self.inner_implementation_action = implementation
-          else
-            self.terminal_implementation_action = AndReturnImplementation.new(values)
-          end
+        end
 
-          nil
+        if block_given?
+          raise ArgumentError, "Implementation blocks aren't supported with `and_return`"
         end
+
+        values.unshift(first_value)
+        @expected_received_count = [@expected_received_count, values.size].max unless ignoring_args? || (@expected_received_count == 0 and @at_least)
+        self.terminal_implementation_action = AndReturnImplementation.new(values)
+
+        nil
       end
 
       def and_yield_receiver_to_implementation
@@ -139,21 +127,19 @@ module RSpec
       # Tells the object to delegate to the original unmodified method
       # when it receives the message.
       #
-      # @note This is only available on partial mock objects.
+      # @note This is only available on partial doubles.
       #
       # @example
       #
-      #   counter.should_receive(:increment).and_call_original
+      #   expect(counter).to receive(:increment).and_call_original
       #   original_count = counter.count
       #   counter.increment
       #   expect(counter.count).to eq(original_count + 1)
       def and_call_original
         if RSpec::Mocks::TestDouble === @method_double.object
-          @error_generator.raise_only_valid_on_a_partial_mock(:and_call_original)
+          @error_generator.raise_only_valid_on_a_partial_double(:and_call_original)
         else
-          if implementation.inner_action
-            RSpec.warning("You're overriding a previous implementation for this stub")
-          end
+          warn_about_stub_override if implementation.inner_action
           @implementation = AndCallOriginalImplementation.new(@method_double.original_method)
           @yield_receiver_to_implementation_block = false
         end
@@ -176,10 +162,10 @@ module RSpec
       #
       # @example
       #
-      #   car.stub(:go).and_raise
-      #   car.stub(:go).and_raise(OutOfGas)
-      #   car.stub(:go).and_raise(OutOfGas, "At least 2 oz of gas needed to drive")
-      #   car.stub(:go).and_raise(OutOfGas.new(2, :oz))
+      #   allow(car).to receive(:go).and_raise
+      #   allow(car).to receive(:go).and_raise(OutOfGas)
+      #   allow(car).to receive(:go).and_raise(OutOfGas, "At least 2 oz of gas needed to drive")
+      #   allow(car).to receive(:go).and_raise(OutOfGas.new(2, :oz))
       def and_raise(exception = RuntimeError, message = nil)
         if exception.respond_to?(:exception)
           exception = message ? exception.exception(message) : exception.exception
@@ -197,8 +183,8 @@ module RSpec
       #
       # @example
       #
-      #   car.stub(:go).and_throw(:out_of_gas)
-      #   car.stub(:go).and_throw(:out_of_gas, :level => 0.1)
+      #   allow(car).to receive(:go).and_throw(:out_of_gas)
+      #   allow(car).to receive(:go).and_throw(:out_of_gas, :level => 0.1)
       def and_throw(*args)
         self.terminal_implementation_action = Proc.new { throw(*args) }
         nil
@@ -224,29 +210,12 @@ module RSpec
 
       # @private
       def invoke(parent_stub, *args, &block)
-        if yield_receiver_to_implementation_block?
-          args.unshift(orig_object)
-        end
-
-        if negative? || ((@exactly || @at_most) && (@actual_received_count == @expected_received_count))
-          @actual_received_count += 1
-          @failed_fast = true
-          #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
+        invoke_incrementing_actual_calls_by(1, parent_stub, *args, &block)
+      end
 
-        begin
-          if implementation.present?
-            implementation.call(*args, &block)
-          elsif parent_stub
-            parent_stub.invoke(nil, *args, &block)
-          end
-        ensure
-          @actual_received_count += 1
-        end
+      # @private
+      def invoke_without_incrementing_received_count(parent_stub, *args, &block)
+        invoke_incrementing_actual_calls_by(0, parent_stub, *args, &block)
       end
 
       # @private
@@ -350,14 +319,14 @@ module RSpec
       #
       # @example
       #
-      #   cart.stub(:add) { :failure }
-      #   cart.stub(:add).with(Book.new(:isbn => 1934356379)) { :success }
+      #   allow(cart).to receive(:add) { :failure }
+      #   allow(cart).to receive(:add).with(Book.new(:isbn => 1934356379)) { :success }
       #   cart.add(Book.new(:isbn => 1234567890))
       #   # => :failure
       #   cart.add(Book.new(:isbn => 1934356379))
       #   # => :success
       #
-      #   cart.should_receive(:add).with(Book.new(:isbn => 1934356379)) { :success }
+      #   expect(cart).to receive(:add).with(Book.new(:isbn => 1934356379)) { :success }
       #   cart.add(Book.new(:isbn => 1234567890))
       #   # => failed expectation
       #   cart.add(Book.new(:isbn => 1934356379))
@@ -378,7 +347,7 @@ module RSpec
       #
       # @example
       #
-      #   dealer.should_receive(:deal_card).exactly(10).times
+      #   expect(dealer).to receive(:deal_card).exactly(10).times
       def exactly(n, &block)
         self.inner_implementation_action = block
         set_expected_received_count :exactly, n
@@ -390,7 +359,7 @@ module RSpec
       #
       # @example
       #
-      #   dealer.should_receive(:deal_card).at_least(9).times
+      #   expect(dealer).to receive(:deal_card).at_least(9).times
       def at_least(n, &block)
         set_expected_received_count :at_least, n
 
@@ -408,7 +377,7 @@ module RSpec
       #
       # @example
       #
-      #   dealer.should_receive(:deal_card).at_most(10).times
+      #   expect(dealer).to receive(:deal_card).at_most(10).times
       def at_most(n, &block)
         self.inner_implementation_action = block
         set_expected_received_count :at_most, n
@@ -419,9 +388,9 @@ module RSpec
       #
       # @example
       #
-      #   dealer.should_receive(:deal_card).exactly(10).times
-      #   dealer.should_receive(:deal_card).at_least(10).times
-      #   dealer.should_receive(:deal_card).at_most(10).times
+      #   expect(dealer).to receive(:deal_card).exactly(10).times
+      #   expect(dealer).to receive(:deal_card).at_least(10).times
+      #   expect(dealer).to receive(:deal_card).at_most(10).times
       def times(&block)
         self.inner_implementation_action = block
         self
@@ -431,7 +400,7 @@ module RSpec
       #
       # @example
       #
-      #   car.should_receive(:stop).never
+      #   expect(car).to receive(:stop).never
       def never
         ErrorGenerator.raise_double_negation_error("expect(obj)") if negative?
         @expected_received_count = 0
@@ -442,7 +411,7 @@ module RSpec
       #
       # @example
       #
-      #   car.should_receive(:go).once
+      #   expect(car).to receive(:go).once
       def once(&block)
         self.inner_implementation_action = block
         set_expected_received_count :exactly, 1
@@ -453,7 +422,7 @@ module RSpec
       #
       # @example
       #
-      #   car.should_receive(:go).twice
+      #   expect(car).to receive(:go).twice
       def twice(&block)
         self.inner_implementation_action = block
         set_expected_received_count :exactly, 2
@@ -464,9 +433,9 @@ module RSpec
       #
       # @example
       #
-      #   api.should_receive(:prepare).ordered
-      #   api.should_receive(:run).ordered
-      #   api.should_receive(:finish).ordered
+      #   expect(api).to receive(:prepare).ordered
+      #   expect(api).to receive(:run).ordered
+      #   expect(api).to receive(:finish).ordered
       def ordered(&block)
         self.inner_implementation_action = block
         @ordered = true
@@ -495,6 +464,32 @@ module RSpec
 
     private
 
+      def invoke_incrementing_actual_calls_by(increment, parent_stub, *args, &block)
+        if yield_receiver_to_implementation_block?
+          args.unshift(orig_object)
+        end
+
+        if negative? || ((@exactly || @at_most) && (@actual_received_count == @expected_received_count))
+          @actual_received_count += increment
+          @failed_fast = true
+          #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)
+          elsif parent_stub
+            parent_stub.invoke(nil, *args, &block)
+          end
+        ensure
+          @actual_received_count += increment
+        end
+      end
+
       def failed_fast?
         @failed_fast
       end
@@ -515,13 +510,21 @@ module RSpec
       end
 
       def inner_implementation_action=(action)
-        RSpec.warning("You're overriding a previous implementation for this stub") if implementation.inner_action
-        implementation.inner_action = action if action
+        return unless action
+        warn_about_stub_override if implementation.inner_action
+        implementation.inner_action = action
       end
 
       def terminal_implementation_action=(action)
         implementation.terminal_action = action
       end
+
+      def warn_about_stub_override
+        RSpec.warning(
+          "You're overriding a previous stub implementation of `#{@message}`. " +
+          "Called from #{CallerFilter.first_non_rspec_line}."
+        )
+      end
     end
 
     # Handles the implementation of an `and_yield` declaration.
@@ -538,10 +541,13 @@ module RSpec
 
         @error_generator.raise_missing_block_error @args_to_yield unless block
         value = nil
+        block_signature = BlockSignature.new(block)
+
         @args_to_yield.each do |args|
-          if block.arity > -1 && args.length != block.arity
-            @error_generator.raise_wrong_arity_error args, block.arity
+          unless MethodSignatureVerifier.new(block_signature, args).valid?
+            @error_generator.raise_wrong_arity_error(args, block_signature)
           end
+
           value = @eval_context ? @eval_context.instance_exec(*args, &block) : block.call(*args)
         end
         value