rspec-mocks 3.0.4 → 3.12.6

data/lib/rspec/mocks/message_expectation.rb

@@ -1,15 +1,15 @@
+RSpec::Support.require_rspec_support 'mutex'
+
 module RSpec
   module Mocks
-
     # A message expectation that only allows concrete return values to be set
     # for a message. While this same effect can be achieved using a standard
-    # MessageExpecation, this version is much faster and so can be used as an
+    # MessageExpectation, this version is much faster and so can be used as an
     # optimization.
     #
     # @private
     class SimpleMessageExpectation
-
-      def initialize(message, response, error_generator, backtrace_line = nil)
+      def initialize(message, response, error_generator, backtrace_line=nil)
         @message, @response, @error_generator, @backtrace_line = message.to_sym, response, error_generator, backtrace_line
         @received = false
       end
@@ -28,53 +28,21 @@ module RSpec
       end
 
       def verify_messages_received
-        InsertOntoBacktrace.line(@backtrace_line) do
-          unless @received
-            @error_generator.raise_expectation_error(@message, 1, ArgumentListMatcher::MATCH_ALL, 0, nil)
-          end
-        end
+        return if @received
+        @error_generator.raise_expectation_error(
+          @message, 1, ArgumentListMatcher::MATCH_ALL, 0, nil, [], @backtrace_line
+        )
       end
-    end
 
-    # @private
-    class MessageExpectation
-      # @private
-      attr_accessor :error_generator, :implementation
-      attr_reader :message
-      attr_reader :orig_object
-      attr_writer :expected_received_count, :expected_from, :argument_list_matcher
-      protected :expected_received_count=, :expected_from=, :error_generator, :error_generator=, :implementation=
-
-      # @private
-      def initialize(error_generator, expectation_ordering, expected_from, method_double,
-                     type=:expectation, opts={}, &implementation_block)
-        @error_generator = error_generator
-        @error_generator.opts = opts
-        @expected_from = expected_from
-        @method_double = method_double
-        @orig_object = @method_double.object
-        @message = @method_double.method_name
-        @actual_received_count = 0
-        @expected_received_count = type == :expectation ? 1 : :any
-        @argument_list_matcher = ArgumentListMatcher::MATCH_ALL
-        @order_group = expectation_ordering
-        @order_group.register(self) unless type == :stub
-        @expectation_type = type
-        @ordered = false
-        @at_least = @at_most = @exactly = nil
-        @args_to_yield = []
-        @failed_fast = nil
-        @eval_context = nil
-        @yield_receiver_to_implementation_block = false
-
-        @implementation = Implementation.new
-        self.inner_implementation_action = implementation_block
+      def unadvise(_)
       end
+    end
 
-      # @private
-      def expected_args
-        @argument_list_matcher.expected_args
-      end
+    # Represents an individual method stub or message expectation. The methods
+    # defined here can be used to configure how it behaves. The methods return
+    # `self` so that they can be chained together to form a fluent interface.
+    class MessageExpectation
+      # @!group Configuring Responses
 
       # @overload and_return(value)
       # @overload and_return(first_value, second_value)
@@ -85,10 +53,10 @@ module RSpec
       # etc.
       #
       # If the message is received more times than there are values, the last
-      # value is received for every subsequent call.
+      # value is returned for every subsequent call.
       #
+      # @return [nil] No further chaining is supported after this.
       # @example
-      #
       #   allow(counter).to receive(:count).and_return(1)
       #   counter.count # => 1
       #   counter.count # => 1
@@ -101,6 +69,7 @@ module RSpec
       #   counter.count # => 3
       #   # etc
       def and_return(first_value, *values)
+        raise_already_invoked_error_if_necessary(__method__)
         if negative?
           raise "`and_return` is not supported with negative message expectations"
         end
@@ -110,19 +79,52 @@ module RSpec
         end
 
         values.unshift(first_value)
-        @expected_received_count = [@expected_received_count, values.size].max unless ignoring_args? || (@expected_received_count == 0 and @at_least)
+        @expected_received_count = [@expected_received_count, values.size].max unless ignoring_args? || (@expected_received_count == 0 && @at_least)
         self.terminal_implementation_action = AndReturnImplementation.new(values)
 
         nil
       end
 
-      def and_yield_receiver_to_implementation
-        @yield_receiver_to_implementation_block = true
-        self
-      end
+      # Tells the object to invoke a Proc when it receives the message. Given
+      # more than one value, the result of the first Proc is returned the first
+      # time the message is received, the result of the second Proc is returned
+      # the next time, etc, etc.
+      #
+      # If the message is received more times than there are Procs, the result of
+      # the last Proc is returned for every subsequent call.
+      #
+      # @return [nil] No further chaining is supported after this.
+      # @example
+      #   allow(api).to receive(:get_foo).and_invoke(-> { raise ApiTimeout })
+      #   api.get_foo # => raises ApiTimeout
+      #   api.get_foo # => raises ApiTimeout
+      #
+      #   allow(api).to receive(:get_foo).and_invoke(-> { raise ApiTimeout }, -> { raise ApiTimeout }, -> { :a_foo })
+      #   api.get_foo # => raises ApiTimeout
+      #   api.get_foo # => rasies ApiTimeout
+      #   api.get_foo # => :a_foo
+      #   api.get_foo # => :a_foo
+      #   api.get_foo # => :a_foo
+      #   # etc
+      def and_invoke(first_proc, *procs)
+        raise_already_invoked_error_if_necessary(__method__)
+        if negative?
+          raise "`and_invoke` is not supported with negative message expectations"
+        end
+
+        if block_given?
+          raise ArgumentError, "Implementation blocks aren't supported with `and_invoke`"
+        end
 
-      def yield_receiver_to_implementation_block?
-        @yield_receiver_to_implementation_block
+        procs.unshift(first_proc)
+        if procs.any? { |p| !p.respond_to?(:call) }
+          raise ArgumentError, "Arguments to `and_invoke` must be callable."
+        end
+
+        @expected_received_count = [@expected_received_count, procs.size].max unless ignoring_args? || (@expected_received_count == 0 && @at_least)
+        self.terminal_implementation_action = AndInvokeImplementation.new(procs)
+
+        nil
       end
 
       # Tells the object to delegate to the original unmodified method
@@ -130,20 +132,35 @@ module RSpec
       #
       # @note This is only available on partial doubles.
       #
+      # @return [nil] No further chaining is supported after this.
       # @example
-      #
       #   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_double(:and_call_original)
-        else
-          warn_about_stub_override if implementation.inner_action
-          @implementation = AndCallOriginalImplementation.new(@method_double.original_method)
-          @yield_receiver_to_implementation_block = false
+        block = lambda do |original, *args, &b|
+          original.call(*args, &b)
         end
+        block = block.ruby2_keywords if block.respond_to?(:ruby2_keywords)
+
+        wrap_original(__method__, &block)
+      end
+
+      # Decorates the stubbed method with the supplied block. The original
+      # unmodified method is passed to the block along with any method call
+      # arguments so you can delegate to it, whilst still being able to
+      # change what args are passed to it and/or change the return value.
+      #
+      # @note This is only available on partial doubles.
+      #
+      # @return [nil] No further chaining is supported after this.
+      # @example
+      #   expect(api).to receive(:large_list).and_wrap_original do |original_method, *args, &block|
+      #     original_method.call(*args, &block).first(10)
+      #   end
+      def and_wrap_original(&block)
+        wrap_original(__method__, &block)
       end
 
       # @overload and_raise
@@ -153,8 +170,8 @@ module RSpec
       #
       # Tells the object to raise an exception when the message is received.
       #
+      # @return [nil] No further chaining is supported after this.
       # @note
-      #
       #   When you pass an exception class, the MessageExpectation will raise
       #   an instance of it, creating it with `exception` and passing `message`
       #   if specified.  If the exception class initializer requires more than
@@ -162,17 +179,13 @@ module RSpec
       #   otherwise this method will raise an ArgumentError exception.
       #
       # @example
-      #
       #   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
-        end
-
-        self.terminal_implementation_action = Proc.new { raise exception }
+      def and_raise(*args)
+        raise_already_invoked_error_if_necessary(__method__)
+        self.terminal_implementation_action = Proc.new { raise(*args) }
         nil
       end
 
@@ -182,11 +195,12 @@ module RSpec
       # Tells the object to throw a symbol (with the object if that form is
       # used) when the message is received.
       #
+      # @return [nil] No further chaining is supported after this.
       # @example
-      #
       #   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)
+        raise_already_invoked_error_if_necessary(__method__)
         self.terminal_implementation_action = Proc.new { throw(*args) }
         nil
       end
@@ -194,162 +208,33 @@ module RSpec
       # Tells the object to yield one or more args to a block when the message
       # is received.
       #
+      # @return [MessageExpectation] self, to support further chaining.
       # @example
-      #
       #   stream.stub(:open).and_yield(StringIO.new)
       def and_yield(*args, &block)
+        raise_already_invoked_error_if_necessary(__method__)
         yield @eval_context = Object.new if block
+
+        # Initialize args to yield now that it's being used, see also: comment
+        # in constructor.
+        @args_to_yield ||= []
+
         @args_to_yield << args
         self.initial_implementation_action = AndYieldImplementation.new(@args_to_yield, @eval_context, @error_generator)
         self
       end
+      # @!endgroup
 
-      # @private
-      def matches?(message, *args)
-        @message == message && @argument_list_matcher.args_match?(*args)
-      end
-
-      # @private
-      def invoke(parent_stub, *args, &block)
-        invoke_incrementing_actual_calls_by(1, parent_stub, *args, &block)
-      end
-
-      # @private
-      def invoke_without_incrementing_received_count(parent_stub, *args, &block)
-        invoke_incrementing_actual_calls_by(0, parent_stub, *args, &block)
-      end
-
-      # @private
-      def negative?
-        @expected_received_count == 0 && !@at_least
-      end
-
-      # @private
-      def called_max_times?
-        @expected_received_count != :any &&
-          !@at_least &&
-          @expected_received_count > 0 &&
-          @actual_received_count >= @expected_received_count
-      end
-
-      # @private
-      def matches_name_but_not_args(message, *args)
-        @message == message and not @argument_list_matcher.args_match?(*args)
-      end
-
-      # @private
-      def verify_messages_received
-        InsertOntoBacktrace.line(@expected_from) do
-          generate_error unless expected_messages_received? || failed_fast?
-        end
-      end
-
-      # @private
-      def expected_messages_received?
-        ignoring_args? || matches_exact_count? || matches_at_least_count? || matches_at_most_count?
-      end
-
-      def ensure_expected_ordering_received!
-        @order_group.verify_invocation_order(self) if @ordered
-        true
-      end
-
-      # @private
-      def ignoring_args?
-        @expected_received_count == :any
-      end
-
-      # @private
-      def matches_at_least_count?
-        @at_least && @actual_received_count >= @expected_received_count
-      end
-
-      # @private
-      def matches_at_most_count?
-        @at_most && @actual_received_count <= @expected_received_count
-      end
-
-      # @private
-      def matches_exact_count?
-        @expected_received_count == @actual_received_count
-      end
-
-      # @private
-      def similar_messages
-        @similar_messages ||= []
-      end
-
-      # @private
-      def advise(*args)
-        similar_messages << args
-      end
-
-      # @private
-      def generate_error
-        if similar_messages.empty?
-          @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
-
-      # Constrains a stub or message expectation to invocations with specific
-      # arguments.
-      #
-      # With a stub, if the message might be received with other args as well,
-      # you should stub a default value first, and then stub or mock the same
-      # message using `with` to constrain to specific arguments.
-      #
-      # A message expectation will fail if the message is received with different
-      # arguments.
-      #
-      # @example
-      #
-      #   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
-      #
-      #   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))
-      #   # => passes
-      def with(*args, &block)
-        if args.empty?
-          raise ArgumentError,
-            "`with` must have at least one argument. Use `no_args` matcher to set the expectation of receiving no arguments."
-        end
-
-        self.inner_implementation_action = block
-        @argument_list_matcher = ArgumentListMatcher.new(*args)
-        self
-      end
+      # @!group Constraining Receive Counts
 
       # Constrain a message expectation to be received a specific number of
       # times.
       #
+      # @return [MessageExpectation] self, to support further chaining.
       # @example
-      #
       #   expect(dealer).to receive(:deal_card).exactly(10).times
       def exactly(n, &block)
+        raise_already_invoked_error_if_necessary(__method__)
         self.inner_implementation_action = block
         set_expected_received_count :exactly, n
         self
@@ -358,10 +243,11 @@ module RSpec
       # Constrain a message expectation to be received at least a specific
       # number of times.
       #
+      # @return [MessageExpectation] self, to support further chaining.
       # @example
-      #
       #   expect(dealer).to receive(:deal_card).at_least(9).times
       def at_least(n, &block)
+        raise_already_invoked_error_if_necessary(__method__)
         set_expected_received_count :at_least, n
 
         if n == 0
@@ -376,10 +262,11 @@ module RSpec
       # Constrain a message expectation to be received at most a specific
       # number of times.
       #
+      # @return [MessageExpectation] self, to support further chaining.
       # @example
-      #
       #   expect(dealer).to receive(:deal_card).at_most(10).times
       def at_most(n, &block)
+        raise_already_invoked_error_if_necessary(__method__)
         self.inner_implementation_action = block
         set_expected_received_count :at_most, n
         self
@@ -387,8 +274,8 @@ module RSpec
 
       # Syntactic sugar for `exactly`, `at_least` and `at_most`
       #
+      # @return [MessageExpectation] self, to support further chaining.
       # @example
-      #
       #   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
@@ -396,22 +283,23 @@ module RSpec
         self.inner_implementation_action = block
         self
       end
+      alias time times
 
       # Expect a message not to be received at all.
       #
+      # @return [MessageExpectation] self, to support further chaining.
       # @example
-      #
       #   expect(car).to receive(:stop).never
       def never
-        ErrorGenerator.raise_double_negation_error("expect(obj)") if negative?
+        error_generator.raise_double_negation_error("expect(obj)") if negative?
         @expected_received_count = 0
         self
       end
 
       # Expect a message to be received exactly one time.
       #
+      # @return [MessageExpectation] self, to support further chaining.
       # @example
-      #
       #   expect(car).to receive(:go).once
       def once(&block)
         self.inner_implementation_action = block
@@ -421,8 +309,8 @@ module RSpec
 
       # Expect a message to be received exactly two times.
       #
+      # @return [MessageExpectation] self, to support further chaining.
       # @example
-      #
       #   expect(car).to receive(:go).twice
       def twice(&block)
         self.inner_implementation_action = block
@@ -430,14 +318,72 @@ module RSpec
         self
       end
 
-      # Expect messages to be received in a specific order.
+      # Expect a message to be received exactly three times.
       #
+      # @return [MessageExpectation] self, to support further chaining.
       # @example
+      #   expect(car).to receive(:go).thrice
+      def thrice(&block)
+        self.inner_implementation_action = block
+        set_expected_received_count :exactly, 3
+        self
+      end
+      # @!endgroup
+
+      # @!group Other Constraints
+
+      # Constrains a stub or message expectation to invocations with specific
+      # arguments.
+      #
+      # With a stub, if the message might be received with other args as well,
+      # you should stub a default value first, and then stub or mock the same
+      # message using `with` to constrain to specific arguments.
+      #
+      # A message expectation will fail if the message is received with different
+      # arguments.
+      #
+      # @return [MessageExpectation] self, to support further chaining.
+      # @example
+      #   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
+      #
+      #   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))
+      #   # => passes
+      def with(*args, &block)
+        raise_already_invoked_error_if_necessary(__method__)
+        if args.empty?
+          raise ArgumentError,
+                "`with` must have at least one argument. Use `no_args` matcher to set the expectation of receiving no arguments."
+        end
+
+        self.inner_implementation_action = block
+        @argument_list_matcher = ArgumentListMatcher.new(*args)
+        self
+      end
+      ruby2_keywords(:with) if respond_to?(:ruby2_keywords, true)
+
+      # Expect messages to be received in a specific order.
       #
+      # @return [MessageExpectation] self, to support further chaining.
+      # @example
       #   expect(api).to receive(:prepare).ordered
       #   expect(api).to receive(:run).ordered
       #   expect(api).to receive(:finish).ordered
       def ordered(&block)
+        if type == :stub
+          RSpec.warning(
+            "`allow(...).to receive(..).ordered` is not supported and will " \
+            "have no effect, use `and_return(*ordered_values)` instead."
+          )
+        end
+
         self.inner_implementation_action = block
         additional_expected_calls.times do
           @order_group.register(self)
@@ -446,96 +392,301 @@ module RSpec
         self
       end
 
-      # @private
-      def additional_expected_calls
-        return 0 if @expectation_type == :stub || !@exactly
-        @expected_received_count - 1
+      # @return [String] a nice representation of the message expectation
+      def to_s
+        args_description = error_generator.method_call_args_description(@argument_list_matcher.expected_args, "", "") { true }
+        args_description = "(#{args_description})" unless args_description.start_with?("(")
+        "#<#{self.class} #{error_generator.intro}.#{message}#{args_description}>"
       end
-
+      alias inspect to_s
 
       # @private
-      def ordered?
-        @ordered
-      end
+      # Contains the parts of `MessageExpectation` that aren't part of
+      # rspec-mocks' public API. The class is very big and could really use
+      # some collaborators it delegates to for this stuff but for now this was
+      # the simplest way to split the public from private stuff to make it
+      # easier to publish the docs for the APIs we want published.
+      module ImplementationDetails
+        attr_accessor :error_generator, :implementation
+        attr_reader :message
+        attr_reader :orig_object
+        attr_writer :expected_received_count, :expected_from, :argument_list_matcher
+        protected :expected_received_count=, :expected_from=, :error_generator=, :implementation=
+
+        # @private
+        attr_reader :type
+
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(error_generator, expectation_ordering, expected_from, method_double,
+                       type=:expectation, opts={}, &implementation_block)
+          @type = type
+          @error_generator = error_generator
+          @error_generator.opts = error_generator.opts.merge(opts)
+          @expected_from = expected_from
+          @method_double = method_double
+          @orig_object = @method_double.object
+          @message = @method_double.method_name
+          @actual_received_count = 0
+          @actual_received_count_write_mutex = Support::Mutex.new
+          @expected_received_count = type == :expectation ? 1 : :any
+          @argument_list_matcher = ArgumentListMatcher::MATCH_ALL
+          @order_group = expectation_ordering
+          @order_group.register(self) unless type == :stub
+          @expectation_type = type
+          @ordered = false
+          @at_least = @at_most = @exactly = nil
+
+          # Initialized to nil so that we don't allocate an array for every
+          # mock or stub. See also comment in `and_yield`.
+          @args_to_yield = nil
+          @eval_context = nil
+          @yield_receiver_to_implementation_block = false
 
-      # @private
-      def negative_expectation_for?(message)
-        @message == message && negative?
-      end
+          @implementation = Implementation.new
+          self.inner_implementation_action = implementation_block
+        end
+        # rubocop:enable Metrics/ParameterLists
 
-      # @private
-      def actual_received_count_matters?
-        @at_least || @at_most || @exactly
-      end
+        def expected_args
+          @argument_list_matcher.expected_args
+        end
 
-      # @private
-      def increase_actual_received_count!
-        @actual_received_count += 1
-      end
+        def and_yield_receiver_to_implementation
+          @yield_receiver_to_implementation_block = true
+          self
+        end
 
-    private
+        def yield_receiver_to_implementation_block?
+          @yield_receiver_to_implementation_block
+        end
+
+        def matches?(message, *args)
+          @message == message && @argument_list_matcher.args_match?(*args)
+        end
+        ruby2_keywords :matches? if respond_to?(:ruby2_keywords, true)
+
+        def safe_invoke(parent_stub, *args, &block)
+          invoke_incrementing_actual_calls_by(1, false, parent_stub, *args, &block)
+        end
+        ruby2_keywords :safe_invoke if respond_to?(:ruby2_keywords, true)
+
+        def invoke(parent_stub, *args, &block)
+          invoke_incrementing_actual_calls_by(1, true, parent_stub, *args, &block)
+        end
+        ruby2_keywords :invoke if respond_to?(:ruby2_keywords, true)
+
+        def invoke_without_incrementing_received_count(parent_stub, *args, &block)
+          invoke_incrementing_actual_calls_by(0, true, parent_stub, *args, &block)
+        end
+        ruby2_keywords :invoke_without_incrementing_received_count if respond_to?(:ruby2_keywords, true)
+
+        def negative?
+          @expected_received_count == 0 && !@at_least
+        end
+
+        def called_max_times?
+          @expected_received_count != :any &&
+            !@at_least &&
+            @expected_received_count > 0 &&
+            @actual_received_count >= @expected_received_count
+        end
+
+        def matches_name_but_not_args(message, *args)
+          @message == message && !@argument_list_matcher.args_match?(*args)
+        end
+
+        def verify_messages_received
+          return if expected_messages_received?
+          generate_error
+        end
+
+        def expected_messages_received?
+          ignoring_args? || matches_exact_count? || matches_at_least_count? || matches_at_most_count?
+        end
 
-      def invoke_incrementing_actual_calls_by(increment, parent_stub, *args, &block)
-        if yield_receiver_to_implementation_block?
-          args.unshift(orig_object)
+        def ensure_expected_ordering_received!
+          @order_group.verify_invocation_order(self) if @ordered
+          true
         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)
+        def ignoring_args?
+          @expected_received_count == :any
         end
 
-        @order_group.handle_order_constraint self
+        def matches_at_least_count?
+          @at_least && @actual_received_count >= @expected_received_count
+        end
+
+        def matches_at_most_count?
+          @at_most && @actual_received_count <= @expected_received_count
+        end
+
+        def matches_exact_count?
+          @expected_received_count == @actual_received_count
+        end
+
+        def similar_messages
+          @similar_messages ||= []
+        end
+
+        def advise(*args)
+          similar_messages << args
+        end
+
+        def unadvise(args)
+          similar_messages.delete_if { |message| args.include?(message) }
+        end
+
+        def generate_error
+          if similar_messages.empty?
+            @error_generator.raise_expectation_error(
+              @message, @expected_received_count, @argument_list_matcher,
+              @actual_received_count, expectation_count_type, expected_args,
+              @expected_from, exception_source_id
+            )
+          else
+            @error_generator.raise_similar_message_args_error(
+              self, @similar_messages, @expected_from
+            )
+          end
+        end
+
+        def raise_unexpected_message_args_error(args_for_multiple_calls)
+          @error_generator.raise_unexpected_message_args_error(self, args_for_multiple_calls, exception_source_id)
+        end
+
+        def expectation_count_type
+          return :at_least if @at_least
+          return :at_most if @at_most
+          nil
+        end
+
+        def description_for(verb)
+          @error_generator.describe_expectation(
+            verb, @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
+
+        def additional_expected_calls
+          return 0 if @expectation_type == :stub || !@exactly
+          @expected_received_count - 1
+        end
+
+        def ordered?
+          @ordered
+        end
+
+        def negative_expectation_for?(message)
+          @message == message && negative?
+        end
+
+        def actual_received_count_matters?
+          @at_least || @at_most || @exactly
+        end
+
+        def increase_actual_received_count!
+          @actual_received_count_write_mutex.synchronize do
+            @actual_received_count += 1
+          end
+        end
+
+      private
+
+        def exception_source_id
+          @exception_source_id ||= "#{self.class.name} #{__id__}"
+        end
+
+        def invoke_incrementing_actual_calls_by(increment, allowed_to_fail, parent_stub, *args, &block)
+          args.unshift(orig_object) if yield_receiver_to_implementation_block?
+
+          if negative? || (allowed_to_fail && (@exactly || @at_most) && (@actual_received_count == @expected_received_count))
+            # 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 + increment,
+              expectation_count_type, args, nil, exception_source_id
+            )
+          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
+          @actual_received_count_write_mutex.synchronize do
+            @actual_received_count += increment
+          end
         end
-      end
+        ruby2_keywords :invoke_incrementing_actual_calls_by if respond_to?(:ruby2_keywords, true)
 
-      def failed_fast?
-        @failed_fast
-      end
+        def has_been_invoked?
+          @actual_received_count > 0
+        end
 
-      def set_expected_received_count(relativity, n)
-        @at_least = (relativity == :at_least)
-        @at_most  = (relativity == :at_most)
-        @exactly  = (relativity == :exactly)
-        @expected_received_count = case n
-                                   when Numeric then n
-                                   when :once   then 1
-                                   when :twice  then 2
-                                   end
-      end
+        def raise_already_invoked_error_if_necessary(calling_customization)
+          return unless has_been_invoked?
 
-      def initial_implementation_action=(action)
-        implementation.initial_action = action
-      end
+          error_generator.raise_already_invoked_error(message, calling_customization)
+        end
 
-      def inner_implementation_action=(action)
-        return unless action
-        warn_about_stub_override if implementation.inner_action
-        implementation.inner_action = action
-      end
+        def set_expected_received_count(relativity, n)
+          raise "`count` is not supported with negative message expectations" if negative?
+          @at_least = (relativity == :at_least)
+          @at_most  = (relativity == :at_most)
+          @exactly  = (relativity == :exactly)
+          @expected_received_count = case n
+                                     when Numeric then n
+                                     when :once   then 1
+                                     when :twice  then 2
+                                     when :thrice then 3
+                                     end
+        end
 
-      def terminal_implementation_action=(action)
-        implementation.terminal_action = action
-      end
+        def initial_implementation_action=(action)
+          implementation.initial_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}."
-        )
+        def inner_implementation_action=(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
+
+        def wrap_original(method_name, &block)
+          if RSpec::Mocks::TestDouble === @method_double.object
+            @error_generator.raise_only_valid_on_a_partial_double(method_name)
+          else
+            warn_about_stub_override if implementation.inner_action
+            @implementation = AndWrapOriginalImplementation.new(@method_double.original_implementation_callable, block)
+            @yield_receiver_to_implementation_block = false
+          end
+
+          nil
+        end
       end
+
+      include ImplementationDetails
     end
 
     # Handles the implementation of an `and_yield` declaration.
@@ -547,7 +698,7 @@ module RSpec
         @error_generator = error_generator
       end
 
-      def call(*args_to_ignore, &block)
+      def call(*_args_to_ignore, &block)
         return if @args_to_yield.empty? && @eval_context.nil?
 
         @error_generator.raise_missing_block_error @args_to_yield unless block
@@ -555,11 +706,11 @@ module RSpec
         block_signature = Support::BlockSignature.new(block)
 
         @args_to_yield.each do |args|
-          unless Support::MethodSignatureVerifier.new(block_signature, args).valid?
+          unless Support::StrictSignatureVerifier.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)
+          value = @eval_context ? @eval_context.instance_exec(*args, &block) : yield(*args)
         end
         value
       end
@@ -572,7 +723,7 @@ module RSpec
         @values_to_return = values_to_return
       end
 
-      def call(*args_to_ignore, &block)
+      def call(*_args_to_ignore, &_block)
         if @values_to_return.size > 1
           @values_to_return.shift
         else
@@ -581,6 +732,24 @@ module RSpec
       end
     end
 
+    # Handles the implementation of an `and_invoke` implementation.
+    # @private
+    class AndInvokeImplementation
+      def initialize(procs_to_invoke)
+        @procs_to_invoke = procs_to_invoke
+      end
+
+      def call(*args, &block)
+        proc = if @procs_to_invoke.size > 1
+                 @procs_to_invoke.shift
+               else
+                 @procs_to_invoke.first
+               end
+
+        proc.call(*args, &block)
+      end
+    end
+
     # Represents a configured implementation. Takes into account
     # any number of sub-implementations.
     # @private
@@ -592,6 +761,7 @@ module RSpec
           action.call(*args, &block)
         end.last
       end
+      ruby2_keywords :call if respond_to?(:ruby2_keywords, true)
 
       def present?
         actions.any?
@@ -606,22 +776,23 @@ module RSpec
 
     # Represents an `and_call_original` implementation.
     # @private
-    class AndCallOriginalImplementation
-      def initialize(method)
+    class AndWrapOriginalImplementation
+      def initialize(method, block)
         @method = method
+        @block = block
       end
 
       CannotModifyFurtherError = Class.new(StandardError)
 
-      def initial_action=(value)
+      def initial_action=(_value)
         raise cannot_modify_further_error
       end
 
-      def inner_action=(value)
+      def inner_action=(_value)
         raise cannot_modify_further_error
       end
 
-      def terminal_action=(value)
+      def terminal_action=(_value)
         raise cannot_modify_further_error
       end
 
@@ -634,28 +805,16 @@ module RSpec
       end
 
       def call(*args, &block)
-        @method.call(*args, &block)
+        @block.call(@method, *args, &block)
       end
+      ruby2_keywords :call if respond_to?(:ruby2_keywords, true)
 
     private
 
       def cannot_modify_further_error
-        CannotModifyFurtherError.new "This method has already been configured " +
+        CannotModifyFurtherError.new "This method has already been configured " \
           "to call the original implementation, and cannot be modified further."
       end
     end
-
-    # Insert original locations into stacktraces
-    #
-    # @private
-    class InsertOntoBacktrace
-      def self.line(location)
-        yield
-      rescue RSpec::Mocks::MockExpectationError => error
-        error.backtrace.insert(0, location)
-        Kernel::raise error
-      end
-    end
-
   end
 end