rspec-mocks 3.0.0.beta1 → 3.0.0.beta2

data/lib/rspec/mocks/configuration.rb

@@ -39,20 +39,44 @@ module RSpec
         end
       end
 
-      def syntax=(values)
-        if Array(values).include?(:expect)
+      # Provides the ability to set either `expect`,
+      # `should` or both syntaxes. RSpec uses `expect`
+      # syntax by default. This is needed if you want to
+      # explicitly enable `should` syntax and/or explicitly
+      # disable `expect` syntax.
+      #
+      # @example
+      #
+      #   RSpec.configure do |rspec|
+      #     rspec.mock_with :rspec do |mocks|
+      #       mocks.syntax = [:expect, :should]
+      #     end
+      #  end
+      #
+      def syntax=(*values)
+        syntaxes = values.flatten
+        if syntaxes.include?(:expect)
           Syntax.enable_expect
         else
           Syntax.disable_expect
         end
 
-        if Array(values).include?(:should)
+        if syntaxes.include?(:should)
           Syntax.enable_should
         else
           Syntax.disable_should
         end
       end
 
+      # Returns an array with a list of syntaxes
+      # that are enabled.
+      #
+      # @example
+      #
+      #   unless RSpec::Mocks.configuration.syntax.include?(:expect)
+      #     raise "this RSpec extension gem requires the rspec-mocks `:expect` syntax"
+      #   end
+      #
       def syntax
         syntaxes = []
         syntaxes << :should  if Syntax.should_enabled?
@@ -84,7 +108,7 @@ module RSpec
       end
 
       # When set to true, partial mocks will be verified the same as object
-      # doubles. Any stubs will have their arity checked against the original
+      # doubles. Any stubs will have their arguments checked against the original
       # method, and methods that do not exist cannot be stubbed.
       def verify_partial_doubles=(val)
         @verify_partial_doubles = !!val

data/lib/rspec/mocks/error_generator.rb

@@ -1,5 +1,25 @@
 module RSpec
   module Mocks
+    # @public
+    # Raised when a message expectation is not satisfied.
+    MockExpectationError = Class.new(Exception)
+
+    # @public
+    # Raised when a test double is used after it has been torn
+    # down (typically at the end of an rspec-core example).
+    ExpiredTestDoubleError = Class.new(MockExpectationError)
+
+    # @public
+    # Raised when doubles or partial doubles are used outside of the per-test lifecycle.
+    OutsideOfExampleError = Class.new(StandardError)
+
+    # @private
+    UnsupportedMatcherError  = Class.new(StandardError)
+    # @private
+    NegationUnsupportedError = Class.new(StandardError)
+
+    VerifyingDoubleNotDefinedError = Class.new(StandardError)
+
     # @private
     class ErrorGenerator
       attr_writer :opts
@@ -56,13 +76,26 @@ module RSpec
       end
 
       # @private
-      def raise_arity_error(calculator, actual)
-        __raise "Wrong number of arguments. Expected %s, got %s." % [
-          calculator.range_description,
-          actual
+      def raise_non_public_error(method_name, visibility)
+        raise NoMethodError, "%s method `%s' called on %s" % [
+          visibility, method_name, intro
         ]
       end
 
+      # @private
+      def raise_invalid_arguments_error(verifier)
+        __raise verifier.error_message
+      end
+
+      # @private
+      def raise_expired_test_double_error
+        raise ExpiredTestDoubleError,
+          "#{intro} was originally created in one example but has leaked into " +
+          "another example and can no longer be used. rspec-mocks' doubles are " +
+          "designed to only last for one example, and you need to create a new " +
+          "one in each example you wish to use it for."
+      end
+
       # @private
       def received_part_of_expectation_error(actual_received_count, *args)
         "received: #{count_message(actual_received_count)}" +
@@ -112,14 +145,14 @@ module RSpec
       end
 
       # @private
-      def raise_wrong_arity_error(args_to_yield, arity)
-        __raise "#{intro} yielded |#{arg_list(*args_to_yield)}| to block with arity of #{arity}"
+      def raise_wrong_arity_error(args_to_yield, signature)
+        __raise "#{intro} yielded |#{arg_list(*args_to_yield)}| to block with #{signature.description}"
       end
 
       # @private
-      def raise_only_valid_on_a_partial_mock(method)
-        __raise "#{intro} is a pure mock object. `#{method}` is only " +
-                "available on a partial mock object."
+      def raise_only_valid_on_a_partial_double(method)
+        __raise "#{intro} is a pure test double. `#{method}` is only " +
+                "available on a partial double."
       end
 
       # @private
@@ -189,12 +222,12 @@ module RSpec
       end
 
       def count_message(count, expectation_count_type=nil)
-        return "at least #{pretty_print(count.abs)}" if count < 0 || expectation_count_type == :at_least
-        return "at most #{pretty_print(count)}" if expectation_count_type == :at_most
-        return pretty_print(count)
+        return "at least #{times(count.abs)}" if count < 0 || expectation_count_type == :at_least
+        return "at most #{times(count)}" if expectation_count_type == :at_most
+        return times(count)
       end
 
-      def pretty_print(count)
+      def times(count)
         "#{count} time#{count == 1 ? '' : 's'}"
       end
 

data/lib/rspec/mocks/example_methods.rb

@@ -12,9 +12,9 @@ module RSpec
       # @param name [String/Symbol] (optional) used in
       #   clarify intent
       # @param stubs (Hash) (optional) hash of message/return-value pairs
-      # @return (Mock)
+      # @return (Double)
       #
-      # Constructs an instance of [RSpec::Mocks::Mock](RSpec::Mocks::Mock) configured
+      # Constructs an instance of [RSpec::Mocks::Double](RSpec::Mocks::Double) configured
       # with an optional name, used for reporting in failure messages, and an optional
       # hash of message/return-value pairs.
       #
@@ -28,7 +28,7 @@ module RSpec
       #   card.rank  #=> "A"
       #
       def double(*args)
-        declare_double(Mock, *args)
+        ExampleMethods.declare_double(Double, *args)
       end
 
       # @overload instance_double(doubled_class)
@@ -43,7 +43,7 @@ module RSpec
       # [double](double).
       def instance_double(doubled_class, *args)
         ref = ObjectReference.for(doubled_class)
-        declare_verifying_double(InstanceVerifyingDouble, ref, *args)
+        ExampleMethods.declare_verifying_double(InstanceVerifyingDouble, ref, *args)
       end
 
       # @overload class_double(doubled_class)
@@ -58,7 +58,7 @@ module RSpec
       # [double](double).
       def class_double(doubled_class, *args)
         ref = ObjectReference.for(doubled_class)
-        declare_verifying_double(ClassVerifyingDouble, ref, *args)
+        ExampleMethods.declare_verifying_double(ClassVerifyingDouble, ref, *args)
       end
 
       # @overload object_double(object_or_name)
@@ -73,7 +73,7 @@ module RSpec
       # for verification. In all other ways it behaves like a [double](double).
       def object_double(object_or_name, *args)
         ref = ObjectReference.for(object_or_name, :allow_direct_object_refs)
-        declare_verifying_double(ObjectVerifyingDouble, ref, *args)
+        ExampleMethods.declare_verifying_double(ObjectVerifyingDouble, ref, *args)
       end
 
       # Disables warning messages about expectations being set on nil.
@@ -164,6 +164,7 @@ module RSpec
         Matchers::HaveReceived.new(method_name, &block)
       end
 
+      # @api private
       def self.included(klass)
         klass.class_exec do
           # This gets mixed in so that if `RSpec::Matchers` is included in
@@ -172,14 +173,13 @@ module RSpec
         end
       end
 
-    private
-
-      def declare_verifying_double(type, ref, *args)
+      # @api private
+      def self.declare_verifying_double(type, ref, *args)
         if RSpec::Mocks.configuration.verify_doubled_constant_names? &&
           !ref.defined?
 
-          raise NameError,
-            "#{ref.name} is not a defined constant. " +
+          raise VerifyingDoubleNotDefinedError,
+            "#{ref.description} is not a defined constant. " +
             "Perhaps you misspelt it? " +
             "Disable check with verify_doubled_constant_names configuration option."
         end
@@ -187,7 +187,8 @@ module RSpec
         declare_double(type, ref, *args)
       end
 
-      def declare_double(type, *args)
+      # @api private
+      def self.declare_double(type, *args)
         args << {} unless Hash === args.last
         type.new(*args)
       end

data/lib/rspec/mocks/extensions/marshal.rb

@@ -3,7 +3,7 @@ module Marshal
     # Duplicates any mock objects before serialization. Otherwise,
     # serialization will fail because methods exist on the singleton class.
     def dump_with_mocks(object, *rest)
-      if ::RSpec::Mocks.space.nil? || !::RSpec::Mocks.space.registered?(object) || NilClass === object
+      if !::RSpec::Mocks.space.registered?(object) || NilClass === object
         dump_without_mocks(object, *rest)
       else
         dump_without_mocks(object.dup, *rest)

data/lib/rspec/mocks/framework.rb

@@ -9,19 +9,17 @@ require 'rspec/mocks/method_double'
 require 'rspec/mocks/argument_matchers'
 require 'rspec/mocks/example_methods'
 require 'rspec/mocks/proxy'
-require 'rspec/mocks/proxy_for_nil'
 require 'rspec/mocks/test_double'
-require 'rspec/mocks/mock'
 require 'rspec/mocks/argument_list_matcher'
 require 'rspec/mocks/message_expectation'
 require 'rspec/mocks/order_group'
-require 'rspec/mocks/errors'
 require 'rspec/mocks/error_generator'
 require 'rspec/mocks/space'
 require 'rspec/mocks/extensions/marshal'
 require 'rspec/mocks/any_instance/chain'
 require 'rspec/mocks/any_instance/stub_chain'
 require 'rspec/mocks/any_instance/stub_chain_chain'
+require 'rspec/mocks/any_instance/expect_chain_chain'
 require 'rspec/mocks/any_instance/expectation_chain'
 require 'rspec/mocks/any_instance/message_chains'
 require 'rspec/mocks/any_instance/recorder'
@@ -29,7 +27,8 @@ require 'rspec/mocks/mutate_const'
 require 'rspec/mocks/matchers/have_received'
 require 'rspec/mocks/matchers/receive'
 require 'rspec/mocks/matchers/receive_messages'
-require 'rspec/mocks/stub_chain'
+require 'rspec/mocks/matchers/receive_message_chain'
+require 'rspec/mocks/message_chain'
 require 'rspec/mocks/targets'
 require 'rspec/mocks/syntax'
 require 'rspec/mocks/configuration'

data/lib/rspec/mocks/instance_method_stasher.rb

@@ -54,7 +54,7 @@ module RSpec
         # @private
         def stash
           return if !method_defined_directly_on_klass?
-          @original_method ||= ::RSpec::Mocks.method_handle_for(@object, @method)
+          @original_method ||= ::RSpec::Support.method_handle_for(@object, @method)
         end
 
         # @private
@@ -79,7 +79,7 @@ module RSpec
 
       # @private
       def method_defined_on_klass?(klass = @klass)
-        klass.method_defined?(@method) || klass.private_method_defined?(@method)
+        MethodReference.method_defined_at_any_visibility?(klass, @method)
       end
 
       def method_owned_by_klass?
@@ -109,4 +109,3 @@ module RSpec
     end
   end
 end
-

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

@@ -1,6 +1,7 @@
 module RSpec
   module Mocks
     module Matchers
+      # @private
       class HaveReceived
         COUNT_CONSTRAINTS = %w(exactly at_least at_most times once twice)
         ARGS_CONSTRAINTS = %w(with)
@@ -35,7 +36,7 @@ module RSpec
           generate_failure_message
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           generate_failure_message
         end
 
@@ -53,9 +54,11 @@ module RSpec
       private
 
         def expect
-          expectation = mock_proxy.build_expectation(@method_name)
-          apply_constraints_to expectation
-          expectation
+          @expectation ||= begin
+            expectation = mock_proxy.build_expectation(@method_name)
+            apply_constraints_to expectation
+            expectation
+          end
         end
 
         def apply_constraints_to(expectation)
@@ -90,10 +93,9 @@ module RSpec
         end
 
         def mock_proxy
-          RSpec::Mocks.proxy_for(@subject)
+          RSpec::Mocks.space.proxy_for(@subject)
         end
       end
     end
   end
 end
-

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

@@ -1,17 +1,13 @@
 module RSpec
   module Mocks
     module Matchers
+      # @private
       class Receive
         def initialize(message, block)
           @message                 = message
           @block                   = block
           @recorded_customizations = []
-
-          # MRI, JRuby and RBX report the caller inconsistently; MRI
-          # reports an extra "in `new'" line in the backtrace that the
-          # others do not include. The safest way to find the right
-          # line is to search for the first line BEFORE rspec/mocks/syntax.rb.
-          @backtrace_line = CallerFilter.first_non_rspec_line
+          @backtrace_line          = CallerFilter.first_non_rspec_line
         end
 
         def name
@@ -27,7 +23,7 @@ module RSpec
         def setup_negative_expectation(subject, &block)
           # ensure `never` goes first for cases like `never.and_return(5)`,
           # where `and_return` is meant to raise an error
-          @recorded_customizations.unshift Customization.new(:never, [], nil)
+          @recorded_customizations.unshift ExpectationCustomization.new(:never, [], nil)
 
           warn_if_any_instance("expect", subject)
 
@@ -56,7 +52,7 @@ module RSpec
           next if method_defined?(method)
 
           define_method(method) do |*args, &block|
-            @recorded_customizations << Customization.new(method, args, block)
+            @recorded_customizations << ExpectationCustomization.new(method, args, block)
             self
           end
         end
@@ -75,17 +71,19 @@ module RSpec
         end
 
         def setup_mock_proxy_method_substitute(subject, method, block)
-          proxy = ::RSpec::Mocks.proxy_for(subject)
+          proxy = ::RSpec::Mocks.space.proxy_for(subject)
           setup_method_substitute(proxy, method, block, @backtrace_line)
         end
 
         def setup_any_instance_method_substitute(subject, method, block)
-          any_instance_recorder = ::RSpec::Mocks.any_instance_recorder_for(subject)
+          any_instance_recorder = ::RSpec::Mocks.space.any_instance_recorder_for(subject)
           setup_method_substitute(any_instance_recorder, method, block)
         end
 
         def setup_method_substitute(host, method, block, *args)
           args << @message.to_sym
+          block = move_block_to_last_customization(block)
+
           expectation = host.__send__(method, *args, &(@block || block))
 
           @recorded_customizations.each do |customization|
@@ -94,19 +92,29 @@ module RSpec
           expectation
         end
 
-        class Customization
-          def initialize(method_name, args, block)
-            @method_name = method_name
-            @args        = args
-            @block       = block
-          end
+        def move_block_to_last_customization(block)
+          last = @recorded_customizations.last
+          return block unless last
 
-          def playback_onto(expectation)
-            expectation.__send__(@method_name, *@args, &@block)
-          end
+          last.block ||= block
+          nil
         end
       end
     end
+
+    # @private
+    class ExpectationCustomization
+      attr_accessor :block
+
+      def initialize(method_name, args, block)
+        @method_name = method_name
+        @args        = args
+        @block       = block
+      end
+
+      def playback_onto(expectation)
+        expectation.__send__(@method_name, *@args, &@block)
+      end
+    end
   end
 end
-

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

@@ -0,0 +1,65 @@
+module RSpec
+  module Mocks
+    module Matchers
+      # @private
+      class ReceiveMessageChain
+        def initialize(chain, &block)
+          @chain = chain
+          @block = block
+          @recorded_customizations  = []
+        end
+
+        [:and_return, :and_throw, :and_raise, :and_yield, :and_call_original].each do |msg|
+          define_method(msg) do |*args, &block|
+            @recorded_customizations << ExpectationCustomization.new(msg, args, block)
+            self
+          end
+        end
+
+        def name
+          "receive_message_chain"
+        end
+
+        def setup_allowance(subject, &block)
+          chain = StubChain.stub_chain_on(subject, *@chain, &(@block || block))
+          replay_customizations(chain)
+        end
+
+        def setup_any_instance_allowance(subject, &block)
+          recorder = ::RSpec::Mocks.space.any_instance_recorder_for(subject)
+          chain = recorder.stub_chain(*@chain, &(@block || block))
+          replay_customizations(chain)
+        end
+
+        def setup_any_instance_expectation(subject, &block)
+          recorder = ::RSpec::Mocks.space.any_instance_recorder_for(subject)
+          chain = recorder.expect_chain(*@chain, &(@block || block))
+          replay_customizations(chain)
+        end
+
+        def setup_expectation(subject, &block)
+          chain = ExpectChain.expect_chain_on(subject, *@chain, &(@block || block))
+          replay_customizations(chain)
+        end
+
+        def setup_negative_expectation(*args)
+          raise NegationUnsupportedError.new(
+            "`expect(...).not_to receive_message_chain` is not supported " +
+            "since it doesn't really make sense. What would it even mean?"
+          )
+        end
+
+        alias matches? setup_expectation
+        alias does_not_match? setup_negative_expectation
+
+        private
+
+        def replay_customizations(chain)
+          @recorded_customizations.each do |customization|
+            customization.playback_onto(chain)
+          end
+        end
+      end
+    end
+  end
+end