opal-rspec 0.4.3 → 0.5.0.beta1

data/{vendor_lib → rspec-mocks/lib}/rspec/mocks/message_expectation.rb

@@ -1,14 +1,14 @@
 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
     # optimization.
+    #
+    # @private
     class SimpleMessageExpectation
-
-      def initialize(message, response, error_generator, backtrace_line = nil)
-        @message, @response, @error_generator, @backtrace_line = message, response, error_generator, backtrace_line
+      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
 
@@ -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
@@ -42,9 +43,10 @@ module RSpec
       attr_writer :expected_received_count, :expected_from, :argument_list_matcher
       protected :expected_received_count=, :expected_from=, :error_generator, :error_generator=, :implementation=
 
+      # rubocop:disable Style/ParameterLists
       # @private
       def initialize(error_generator, expectation_ordering, expected_from, method_double,
-                     expected_received_count=1, opts={}, &implementation_block)
+                     type=:expectation, opts={}, &implementation_block)
         @error_generator = error_generator
         @error_generator.opts = opts
         @expected_from = expected_from
@@ -52,10 +54,11 @@ module RSpec
         @orig_object = @method_double.object
         @message = @method_double.method_name
         @actual_received_count = 0
-        @expected_received_count = expected_received_count
+        @expected_received_count = type == :expectation ? 1 : :any
         @argument_list_matcher = ArgumentListMatcher::MATCH_ALL
         @order_group = expectation_ordering
-        @order_group.register(self)
+        @order_group.register(self) unless type == :stub
+        @expectation_type = type
         @ordered = false
         @at_least = @at_most = @exactly = nil
         @args_to_yield = []
@@ -66,8 +69,7 @@ module RSpec
         @implementation = Implementation.new
         self.inner_implementation_action = implementation_block
       end
-
-      # @private
+      # rubocop:enable Style/ParameterLists
 
       # @private
       def expected_args
@@ -76,7 +78,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 +87,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 && @at_least)
+        self.terminal_implementation_action = AndReturnImplementation.new(values)
+
+        nil
       end
 
       def and_yield_receiver_to_implementation
@@ -139,22 +128,39 @@ 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
+        and_wrap_original do |original, *args, &block|
+          original.call(*args, &block)
+        end
+      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.
+      #
+      # @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)
         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
-          @implementation = AndCallOriginalImplementation.new(@method_double.original_method)
+          warn_about_stub_override if implementation.inner_action
+          @implementation = AndWrapOriginalImplementation.new(@method_double.original_method, block)
           @yield_receiver_to_implementation_block = false
         end
       end
@@ -176,11 +182,11 @@ 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))
-      def and_raise(exception = RuntimeError, message = nil)
+      #   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
@@ -197,8 +203,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
@@ -223,30 +229,18 @@ module RSpec
       end
 
       # @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
+      def safe_invoke(parent_stub, *args, &block)
+        invoke_incrementing_actual_calls_by(1, false, parent_stub, *args, &block)
+      end
 
-        @order_group.handle_order_constraint self
+      # @private
+      def invoke(parent_stub, *args, &block)
+        invoke_incrementing_actual_calls_by(1, true, 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, true, parent_stub, *args, &block)
       end
 
       # @private
@@ -264,7 +258,7 @@ module RSpec
 
       # @private
       def matches_name_but_not_args(message, *args)
-        @message == message and not @argument_list_matcher.args_match?(*args)
+        @message == message && !@argument_list_matcher.args_match?(*args)
       end
 
       # @private
@@ -326,7 +320,7 @@ module RSpec
       def expectation_count_type
         return :at_least if @at_least
         return :at_most if @at_most
-        return nil
+        nil
       end
 
       # @private
@@ -350,14 +344,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))
@@ -365,7 +359,7 @@ module RSpec
       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."
+                "`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
@@ -378,7 +372,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 +384,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 +402,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 +413,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 +425,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 +436,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,26 +447,46 @@ 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
         self
       end
 
+      # Expect a message to be received exactly three times.
+      #
+      # @example
+      #
+      #   expect(car).to receive(:go).thrice
+      def thrice(&block)
+        self.inner_implementation_action = block
+        set_expected_received_count :exactly, 3
+        self
+      end
+
       # Expect messages to be received in a specific order.
       #
       # @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
+        additional_expected_calls.times do
+          @order_group.register(self)
+        end
         @ordered = true
         self
       end
 
+      # @private
+      def additional_expected_calls
+        return 0 if @expectation_type == :stub || !@exactly
+        @expected_received_count - 1
+      end
+
       # @private
       def ordered?
         @ordered
@@ -495,6 +509,30 @@ module RSpec
 
     private
 
+      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))
+          @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
@@ -507,6 +545,7 @@ module RSpec
                                    when Numeric then n
                                    when :once   then 1
                                    when :twice  then 2
+                                   when :thrice then 3
                                    end
       end
 
@@ -515,13 +554,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.
@@ -533,15 +580,18 @@ 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
         value = nil
+        block_signature = Support::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 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)
         end
         value
@@ -555,7 +605,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
@@ -589,22 +639,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
 
@@ -617,27 +668,27 @@ module RSpec
       end
 
       def call(*args, &block)
-        @method.call(*args, &block)
+        @block.call(@method, *args, &block)
       end
 
     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
-    # @api private
+    #
+    # @private
     class InsertOntoBacktrace
       def self.line(location)
         yield
       rescue RSpec::Mocks::MockExpectationError => error
         error.backtrace.insert(0, location)
-        Kernel::raise error
+        Kernel.raise error
       end
     end
-
   end
 end