rspec-mocks 3.0.0 → 3.1.0

data/lib/rspec/mocks/message_expectation.rb

@@ -1,6 +1,5 @@
 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
@@ -8,8 +7,7 @@ module RSpec
     #
     # @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
@@ -45,6 +43,7 @@ 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,
                      type=:expectation, opts={}, &implementation_block)
@@ -59,6 +58,7 @@ module RSpec
         @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 = []
@@ -69,6 +69,7 @@ module RSpec
         @implementation = Implementation.new
         self.inner_implementation_action = implementation_block
       end
+      # rubocop:enable Style/ParameterLists
 
       # @private
       def expected_args
@@ -109,7 +110,7 @@ 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
@@ -136,11 +137,30 @@ module RSpec
       #   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_double(:and_call_original)
         else
           warn_about_stub_override if implementation.inner_action
-          @implementation = AndCallOriginalImplementation.new(@method_double.original_method)
+          @implementation = AndWrapOriginalImplementation.new(@method_double.original_method, block)
           @yield_receiver_to_implementation_block = false
         end
       end
@@ -166,7 +186,7 @@ module RSpec
       #   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)
+      def and_raise(exception=RuntimeError, message=nil)
         if exception.respond_to?(:exception)
           exception = message ? exception.exception(message) : exception.exception
         end
@@ -233,7 +253,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
@@ -295,7 +315,7 @@ module RSpec
       def expectation_count_type
         return :at_least if @at_least
         return :at_most if @at_most
-        return nil
+        nil
       end
 
       # @private
@@ -334,7 +354,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
@@ -429,6 +449,17 @@ module RSpec
         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
@@ -438,10 +469,19 @@ module RSpec
       #   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
@@ -465,15 +505,13 @@ 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
+        args.unshift(orig_object) if yield_receiver_to_implementation_block?
 
         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
+          # 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
 
@@ -502,6 +540,7 @@ module RSpec
                                    when Numeric then n
                                    when :once   then 1
                                    when :twice  then 2
+                                   when :thrice then 3
                                    end
       end
 
@@ -521,7 +560,7 @@ module RSpec
 
       def warn_about_stub_override
         RSpec.warning(
-          "You're overriding a previous stub implementation of `#{@message}`. " +
+          "You're overriding a previous stub implementation of `#{@message}`. " \
           "Called from #{CallerFilter.first_non_rspec_line}."
         )
       end
@@ -536,7 +575,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
@@ -544,7 +583,7 @@ 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
 
@@ -561,7 +600,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
@@ -595,22 +634,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
 
@@ -623,13 +663,13 @@ 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
@@ -642,9 +682,8 @@ module RSpec
         yield
       rescue RSpec::Mocks::MockExpectationError => error
         error.backtrace.insert(0, location)
-        Kernel::raise error
+        Kernel.raise error
       end
     end
-
   end
 end

data/lib/rspec/mocks/method_double.rb

@@ -59,7 +59,7 @@ module RSpec
           define_method(method_name) do |*args, &block|
             method_double.proxy_method_invoked(self, *args, &block)
           end
-          self.__send__ visibility, method_name
+          __send__(visibility, method_name)
         end
 
         @method_is_proxied = true
@@ -69,7 +69,7 @@ module RSpec
       # method to perform additional operations.
       #
       # @private
-      def proxy_method_invoked(obj, *args, &block)
+      def proxy_method_invoked(_obj, *args, &block)
         @proxy.message_received method_name, *args, &block
       end
 
@@ -80,9 +80,7 @@ module RSpec
 
         definition_target.__send__(:remove_method, @method_name)
 
-        if @method_stasher.method_is_stashed?
-          @method_stasher.restore
-        end
+        @method_stasher.restore if @method_stasher.method_is_stashed?
         restore_original_visibility
 
         @method_is_proxied = false
@@ -91,7 +89,9 @@ module RSpec
       # @private
       def show_frozen_warning
         RSpec.warn_with(
-          "WARNING: rspec-mocks was unable to restore the original `#{@method_name}` method on #{@object.inspect} because it has been frozen.  If you reuse this object, `#{@method_name}` will continue to respond with its stub implementation.",
+          "WARNING: rspec-mocks was unable to restore the original `#{@method_name}` " \
+          "method on #{@object.inspect} because it has been frozen.  If you reuse this " \
+          "object, `#{@method_name}` will continue to respond with its stub implementation.",
           :call_site                      => nil,
           :use_spec_location_as_call_site => true
         )
@@ -107,7 +107,7 @@ module RSpec
 
       # @private
       def verify
-        expectations.each {|e| e.verify_messages_received}
+        expectations.each { |e| e.verify_messages_received }
       end
 
       # @private
@@ -134,7 +134,7 @@ module RSpec
       def add_expectation(error_generator, expectation_ordering, expected_from, opts, &implementation)
         configure_method
         expectation = message_expectation_class.new(error_generator, expectation_ordering,
-                                             expected_from, self, :expectation, opts, &implementation)
+                                                    expected_from, self, :expectation, opts, &implementation)
         expectations << expectation
         expectation
       end
@@ -149,7 +149,7 @@ module RSpec
       def add_stub(error_generator, expectation_ordering, expected_from, opts={}, &implementation)
         configure_method
         stub = message_expectation_class.new(error_generator, expectation_ordering, expected_from,
-                                      self, :stub, opts, &implementation)
+                                             self, :stub, opts, &implementation)
         stubs.unshift stub
         stub
       end
@@ -172,7 +172,7 @@ module RSpec
       end
 
       # @private
-      def setup_simple_method_double(method_name, response, collection, error_generator = nil, backtrace_line = nil)
+      def setup_simple_method_double(method_name, response, collection, error_generator=nil, backtrace_line=nil)
         define_proxy_method
 
         me = SimpleMessageExpectation.new(method_name, response, error_generator, backtrace_line)
@@ -202,8 +202,6 @@ module RSpec
         raise MockExpectationError, "The method `#{method_name}` was not stubbed or was already unstubbed"
       end
 
-    private
-
       # In Ruby 2.0.0 and above prepend will alter the method lookup chain.
       # We use an object's singleton class to define method doubles upon,
       # however if the object has had it's singleton class (as opposed to
@@ -216,6 +214,9 @@ module RSpec
       # of our own.
       #
       if Support::RubyFeatures.module_prepends_supported?
+
+        private
+
         # We subclass `Module` in order to be able to easily detect our prepended module.
         RSpecPrependedModule = Class.new(Module)
 
@@ -247,6 +248,8 @@ module RSpec
 
       else
 
+        private
+
         def definition_target
           object_singleton_class
         end

data/lib/rspec/mocks/method_reference.rb

@@ -27,7 +27,7 @@ module RSpec
       # cases when we don't know if a method is implemented and
       # both `implemented?` and `unimplemented?` will return false.
       def unimplemented?
-        @object_reference.when_loaded do |m|
+        @object_reference.when_loaded do |_m|
           return !implemented?
         end
 
@@ -44,9 +44,8 @@ module RSpec
       end
 
       def with_signature
-        if original = original_method
-          yield Support::MethodSignature.new(original)
-        end
+        return unless (original = original_method)
+        yield Support::MethodSignature.new(original)
       end
 
       def visibility
@@ -59,7 +58,7 @@ module RSpec
         :public
       end
 
-      private
+    private
 
       def original_method
         @object_reference.when_loaded do |m|
@@ -98,7 +97,8 @@ module RSpec
 
     # @private
     class InstanceMethodReference < MethodReference
-      private
+    private
+
       def method_implemented?(mod)
         MethodReference.method_defined_at_any_visibility?(mod, @method_name)
       end
@@ -133,7 +133,8 @@ module RSpec
 
     # @private
     class ObjectMethodReference < MethodReference
-      private
+    private
+
       def method_implemented?(object)
         object.respond_to?(@method_name, true)
       end

data/lib/rspec/mocks/mutate_const.rb

@@ -1,85 +1,11 @@
+RSpec::Support.require_rspec_support 'recursive_const_methods'
+
 module RSpec
   module Mocks
-    # Provides recursive constant lookup methods useful for
-    # constant stubbing.
-    #
-    # @private
-    module RecursiveConstMethods
-      # We only want to consider constants that are defined directly on a
-      # particular module, and not include top-level/inherited constants.
-      # Unfortunately, the constant API changed between 1.8 and 1.9, so
-      # we need to conditionally define methods to ignore the top-level/inherited
-      # constants.
-      #
-      # Given:
-      #   class A; B = 1; end
-      #   class C < A; end
-      #
-      # On 1.8:
-      #   - C.const_get("Hash") # => ::Hash
-      #   - C.const_defined?("Hash") # => false
-      #   - C.constants # => ["B"]
-      #   - None of these methods accept the extra `inherit` argument
-      # On 1.9:
-      #   - C.const_get("Hash") # => ::Hash
-      #   - C.const_defined?("Hash") # => true
-      #   - C.const_get("Hash", false) # => raises NameError
-      #   - C.const_defined?("Hash", false) # => false
-      #   - C.constants # => [:B]
-      #   - C.constants(false) #=> []
-      if Module.method(:const_defined?).arity == 1
-        def const_defined_on?(mod, const_name)
-          mod.const_defined?(const_name)
-        end
-
-        def get_const_defined_on(mod, const_name)
-          if const_defined_on?(mod, const_name)
-            return mod.const_get(const_name)
-          end
-
-          raise NameError, "uninitialized constant #{mod.name}::#{const_name}"
-        end
-
-        def constants_defined_on(mod)
-          mod.constants.select { |c| const_defined_on?(mod, c) }
-        end
-      else
-        def const_defined_on?(mod, const_name)
-          mod.const_defined?(const_name, false)
-        end
-
-        def get_const_defined_on(mod, const_name)
-          mod.const_get(const_name, false)
-        end
-
-        def constants_defined_on(mod)
-          mod.constants(false)
-        end
-      end
-
-      def recursive_const_get(const_name)
-        normalize_const_name(const_name).split('::').inject(Object) do |mod, name|
-          get_const_defined_on(mod, name)
-        end
-      end
-
-      def recursive_const_defined?(const_name)
-        normalize_const_name(const_name).split('::').inject([Object, '']) do |(mod, full_name), name|
-          yield(full_name, name) if block_given? && !(Module === mod)
-          return false unless const_defined_on?(mod, name)
-          [get_const_defined_on(mod, name), [mod, name].join('::')]
-        end
-      end
-
-      def normalize_const_name(const_name)
-        const_name.sub(/\A::/, '')
-      end
-    end
-
     # Provides information about constants that may (or may not)
     # have been mutated by rspec-mocks.
     class Constant
-      extend RecursiveConstMethods
+      extend Support::RecursiveConstMethods
 
       # @api private
       def initialize(name)
@@ -154,7 +80,7 @@ module RSpec
 
     # Provides a means to stub constants.
     class ConstantMutator
-      extend RecursiveConstMethods
+      extend Support::RecursiveConstMethods
 
       # Stubs a constant.
       #
@@ -167,12 +93,12 @@ module RSpec
       #  examples. This is an alternate public API that is provided
       #  so you can stub constants in other contexts (e.g. helper
       #  classes).
-      def self.stub(constant_name, value, options = {})
+      def self.stub(constant_name, value, options={})
         mutator = if recursive_const_defined?(constant_name, &raise_on_invalid_const)
-          DefinedConstantReplacer
-        else
-          UndefinedConstantSetter
-        end
+                    DefinedConstantReplacer
+                  else
+                    UndefinedConstantSetter
+                  end
 
         mutate(mutator.new(constant_name, value, options[:transfer_nested_constants]))
         value
@@ -188,7 +114,7 @@ module RSpec
       #  so you can hide constants in other contexts (e.g. helper
       #  classes).
       def self.hide(constant_name)
-        mutate(ConstantHider.new(constant_name, nil, { }))
+        mutate(ConstantHider.new(constant_name, nil, {}))
         nil
       end
 
@@ -196,7 +122,7 @@ module RSpec
       #
       # @private
       class BaseMutator
-        include RecursiveConstMethods
+        include Support::RecursiveConstMethods
 
         attr_reader :original_value, :full_constant_name
 
@@ -227,7 +153,7 @@ module RSpec
       # @private
       class ConstantHider < BaseMutator
         def mutate
-          return unless @defined = recursive_const_defined?(full_constant_name)
+          return unless (@defined = recursive_const_defined?(full_constant_name))
           @context = recursive_const_get(@context_parts.join('::'))
           @original_value = get_const_defined_on(@context, @const_name)
 
@@ -298,12 +224,12 @@ module RSpec
           return [] unless should_transfer_nested_constants?
 
           { @original_value => "the original value", @mutated_value => "the stubbed value" }.each do |value, description|
-            unless value.respond_to?(:constants)
-              raise ArgumentError,
-                "Cannot transfer nested constants for #{@full_constant_name} " +
-                "since #{description} is not a class or module and only classes " +
-                "and modules support nested constants."
-            end
+            next if value.respond_to?(:constants)
+
+            raise ArgumentError,
+                  "Cannot transfer nested constants for #{@full_constant_name} " \
+                  "since #{description} is not a class or module and only classes " \
+                  "and modules support nested constants."
           end
 
           if Array === @transfer_nested_constants
@@ -313,9 +239,9 @@ module RSpec
             if undefined_constants.any?
               available_constants = constants_defined_on(@original_value) - @transfer_nested_constants
               raise ArgumentError,
-                "Cannot transfer nested constant(s) #{undefined_constants.join(' and ')} " +
-                "for #{@full_constant_name} since they are not defined. Did you mean " +
-                "#{available_constants.join(' or ')}?"
+                    "Cannot transfer nested constant(s) #{undefined_constants.join(' and ')} " \
+                    "for #{@full_constant_name} since they are not defined. Did you mean " \
+                    "#{available_constants.join(' or ')}?"
             end
 
             @transfer_nested_constants
@@ -363,10 +289,10 @@ module RSpec
 
         def name_for(parent, name)
           root = if parent == Object
-            ''
-          else
-            parent.name
-          end
+                   ''
+                 else
+                   parent.name
+                 end
           root + '::' + name
         end
       end
@@ -389,7 +315,7 @@ module RSpec
       # @api private
       def self.raise_on_invalid_const
         lambda do |const_name, failed_name|
-          raise "Cannot stub constant #{failed_name} on #{const_name} " +
+          raise "Cannot stub constant #{failed_name} on #{const_name} " \
                 "since #{const_name} is not a module."
         end
       end

data/lib/rspec/mocks/object_reference.rb

@@ -1,21 +1,20 @@
 module RSpec
   module Mocks
-
     # @private
     class ObjectReference
       # Returns an appropriate Object or Module reference based
       # on the given argument.
-      def self.for(object_module_or_name, allow_direct_object_refs = false)
+      def self.for(object_module_or_name, allow_direct_object_refs=false)
         case object_module_or_name
-          when Module then DirectModuleReference.new(object_module_or_name)
-          when String then NamedObjectReference.new(object_module_or_name)
+        when Module then DirectModuleReference.new(object_module_or_name)
+        when String then NamedObjectReference.new(object_module_or_name)
+        else
+          if allow_direct_object_refs
+            DirectObjectReference.new(object_module_or_name)
           else
-            if allow_direct_object_refs
-              DirectObjectReference.new(object_module_or_name)
-            else
-              raise ArgumentError,
-                "Module or String expected, got #{object_module_or_name.inspect}"
-            end
+            raise ArgumentError,
+                  "Module or String expected, got #{object_module_or_name.inspect}"
+          end
         end
       end
     end
@@ -35,7 +34,7 @@ module RSpec
 
       def const_to_replace
         raise ArgumentError,
-          "Can not perform constant replacement with an object."
+              "Can not perform constant replacement with an object."
       end
 
       def defined?
@@ -78,11 +77,11 @@ module RSpec
       end
       alias description const_to_replace
 
-      def when_loaded(&block)
+      def when_loaded(&_block)
         yield object if object
       end
 
-   private
+    private
 
       def object
         @object ||= Constant.original(@const_name).original_value

data/lib/rspec/mocks/order_group.rb

@@ -25,10 +25,10 @@ module RSpec
       # @private
       def consume
         remaining_expectations.each_with_index do |expectation, index|
-          if expectation.ordered?
-            @index += index + 1
-            return expectation
-          end
+          next unless expectation.ordered?
+
+          @index += index + 1
+          return expectation
         end
         nil
       end
@@ -76,7 +76,6 @@ module RSpec
       def expectation_for(message)
         @expectations.find { |e| message == e }
       end
-
     end
   end
 end