rspec-mocks 2.11.3 → 2.12.0

data/features/mutating_constants/hiding_defined_constant.feature

@@ -0,0 +1,64 @@
+Feature: Hide Defined Constant
+
+  Use `hide_const` to remove a constant for the duration of a test.
+
+  Scenario: Hide top-level constant
+    Given a file named "hide_const_spec.rb" with:
+      """ruby
+      FOO = 7
+
+      describe "hiding FOO" do
+        it "can hide FOO" do
+          hide_const("FOO")
+          expect { FOO }.to raise_error(NameError)
+        end
+
+        it "restores the hidden constant when the example completes" do
+          FOO.should eq(7)
+        end
+      end
+      """
+    When I run `rspec hide_const_spec.rb`
+    Then the examples should all pass
+
+  Scenario: Hide nested constant
+    Given a file named "hide_const_spec.rb" with:
+      """ruby
+      module MyGem
+        class SomeClass
+          FOO = 7
+        end
+      end
+
+      module MyGem
+        describe SomeClass do
+          it "hides the nested constant when it is fully qualified" do
+            hide_const("MyGem::SomeClass::FOO")
+            expect { SomeClass::FOO }.to raise_error(NameError)
+          end
+
+          it "restores the hidden constant when the example completes" do
+            MyGem::SomeClass::FOO.should eq(7)
+          end
+        end
+      end
+      """
+    When I run `rspec hide_const_spec.rb`
+    Then the examples should all pass
+
+  Scenario: Hiding undefined constant
+    Given a file named "hide_const_spec.rb" with:
+      """
+      describe "hiding UNDEFINED_CONSTANT" do
+        it "has no effect" do
+          hide_const("UNDEFINED_CONSTANT")
+          expect { UNDEFINED_CONSTANT }.to raise_error(NameError)
+        end
+
+        it "is still undefined after the example completes" do
+          expect { UNDEFINED_CONSTANT }.to raise_error(NameError)
+        end
+      end
+      """
+    When I run `rspec hide_const_spec.rb`
+    Then the examples should all pass

data/features/outside_rspec/configuration.feature

@@ -25,7 +25,7 @@ Feature: configure any test framework to use rspec-mocks
 
   Scenario: RSpec::Mocks::setup(object) adds double, mock, and stub methods to the submitted object
     Given a file named "foo.rb" with:
-      """
+      """ruby
       require 'rspec/mocks'
 
       class CodeExample
@@ -48,7 +48,7 @@ Feature: configure any test framework to use rspec-mocks
 
   Scenario: RSpec::Mocks::setup(anything) adds methods to Object
     Given a file named "foo.rb" with:
-      """
+      """ruby
       require 'rspec/mocks'
 
       RSpec::Mocks::setup(Object.new)
@@ -66,7 +66,7 @@ Feature: configure any test framework to use rspec-mocks
 
   Scenario: require "rspec/mocks" does not add methods to Object
     Given a file named "foo.rb" with:
-      """
+      """ruby
       require 'rspec/mocks'
 
       obj = Object.new

data/features/outside_rspec/standalone.feature

@@ -6,7 +6,7 @@ Feature: standalone
 
   Scenario: method stub outside rspec
     Given a file named "example.rb" with:
-      """
+      """ruby
       require "rspec/mocks/standalone"
 
       greeter = double("greeter")
@@ -18,7 +18,7 @@ Feature: standalone
 
   Scenario: message expectation outside rspec
     Given a file named "example.rb" with:
-      """
+      """ruby
       require "rspec/mocks/standalone"
 
       greeter = double("greeter")
@@ -27,6 +27,7 @@ Feature: standalone
       RSpec::Mocks.verify
       """
     When I run `ruby example.rb`
-    Then the output should contain "say_hi(any args) (RSpec::Mocks::MockExpectationError)"
-    Then the output should contain "expected: 1 time"
-    Then the output should contain "received: 0 times"
+    Then the output should contain "RSpec::Mocks::MockExpectationError"
+    And the output should contain "say_hi(any args)"
+    And the output should contain "expected: 1 time"
+    And the output should contain "received: 0 times"

data/lib/rspec/mocks.rb

@@ -23,10 +23,14 @@ module RSpec
         space.reset_all
       end
 
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
     private
 
       def add_extensions
-        Object.class_eval { include RSpec::Mocks::Methods }
+        method_host.class_eval { include RSpec::Mocks::Methods }
         Class.class_eval  { include RSpec::Mocks::AnyInstance }
         $_rspec_mocks_extensions_added = true
       end
@@ -34,6 +38,18 @@ module RSpec
       def extensions_added?
         defined?($_rspec_mocks_extensions_added)
       end
+
+      def method_host
+        # On 1.8.7, Object.ancestors.last == Kernel but
+        # things blow up if we include `RSpec::Mocks::Methods`
+        # into Kernel...not sure why.
+        return Object unless defined?(::BasicObject)
+
+        # MacRuby has BasicObject but it's not the root class.
+        return Object unless Object.ancestors.last == ::BasicObject
+
+        ::BasicObject
+      end
     end
   end
 end

data/lib/rspec/mocks/any_instance.rb

@@ -30,7 +30,7 @@ module RSpec
         modify_dup_to_remove_mock_proxy_when_invoked
         __recorder
       end
-      
+
       # @private
       def rspec_verify
         __recorder.verify
@@ -40,36 +40,36 @@ module RSpec
         restore_dup
         @__recorder = nil
       end
-      
+
       # @private
       def rspec_reset
         restore_dup
         __mock_proxy.reset
       end
-      
+
       # @private
       def __recorder
         @__recorder ||= AnyInstance::Recorder.new(self)
       end
-      
+
       private
       def modify_dup_to_remove_mock_proxy_when_invoked
-        if self.method_defined?(:dup) and !self.method_defined?(:__rspec_original_dup)
-          self.class_eval do
-            def __rspec_dup
+        if method_defined?(:dup) and !method_defined?(:__rspec_original_dup)
+          class_eval do
+            def __rspec_dup(*arguments, &block)
               __remove_mock_proxy
-              __rspec_original_dup
+              __rspec_original_dup(*arguments, &block)
             end
-            
+
             alias_method  :__rspec_original_dup, :dup
             alias_method  :dup, :__rspec_dup
           end
         end
       end
-      
+
       def restore_dup
-        if self.method_defined?(:__rspec_original_dup)
-          self.class_eval do
+        if method_defined?(:__rspec_original_dup)
+          class_eval do
             alias_method  :dup, :__rspec_original_dup
             remove_method :__rspec_original_dup
             remove_method :__rspec_dup

data/lib/rspec/mocks/configuration.rb

@@ -0,0 +1,28 @@
+module RSpec
+  module Mocks
+    # Provides configuration options for rspec-mocks.
+    class Configuration
+      # Adds `stub` and `should_receive` to the given
+      # modules or classes. This is usually only necessary
+      # if you application uses some proxy classes that
+      # "strip themselves down" to a bare minimum set of
+      # methods and remove `stub` and `should_receive` in
+      # the process.
+      #
+      # @example
+      #
+      #   RSpec.configure do |rspec|
+      #     rspec.mock_with :rspec do |mocks|
+      #       mocks.add_stub_and_should_receive_to Delegator
+      #     end
+      #   end
+      #
+      def add_stub_and_should_receive_to(*modules)
+        modules.each do |mod|
+          mod.__send__(:include, RSpec::Mocks::Methods)
+        end
+      end
+    end
+  end
+end
+

data/lib/rspec/mocks/error_generator.rb

@@ -66,6 +66,12 @@ module RSpec
         __raise "#{intro} yielded |#{arg_list(*args_to_yield)}| to block with arity of #{arity}"
       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."
+      end
+
       private
 
       def intro

data/lib/rspec/mocks/example_methods.rb

@@ -3,12 +3,18 @@ module RSpec
     module ExampleMethods
       include RSpec::Mocks::ArgumentMatchers
 
-      # Creates an instance of RSpec::Mocks::Mock.
+      # @overload double()
+      # @overload double(name)
+      # @overload double(stubs)
+      # @overload double(name, stubs)
+      # @param name [String/Symbol] (optional) used in
+      #   clarify intent
+      # @param stubs (Hash) (optional) hash of method/return-value pairs
+      # @return (Mock)
       #
-      # `name` is used for failure reporting, so you should use the role that
-      # the mock is playing in the example.
-      #
-      # Use `stubs` to declare one or more method stubs in one statement.
+      # Constructs an instance of [RSpec::Mocks::Mock](RSpec::Mocks::Mock) configured
+      # with an optional name, used for reporting in failure messages, and an optional
+      # hash of method/return-value pairs.
       #
       # @example
       #
@@ -18,16 +24,19 @@ module RSpec
       #   card = double("card", :suit => "Spades", :rank => "A")
       #   card.suit  #=> "Spades"
       #   card.rank  #=> "A"
+      #
+      # @see #mock
+      # @see #stub
       def double(*args)
         declare_double('Double', *args)
       end
 
-      # Just like double
+      # Effectively an alias for [double](#double-instance_method).
       def mock(*args)
         declare_double('Mock', *args)
       end
 
-      # Just like double
+      # Effectively an alias for [double](#double-instance_method).
       def stub(*args)
         declare_double('Stub', *args)
       end
@@ -79,11 +88,27 @@ module RSpec
       #   CardDeck::SUITS # => our suits array
       #   CardDeck::NUM_CARDS # => uninitialized constant error
       def stub_const(constant_name, value, options = {})
-        ConstantStubber.stub(constant_name, value, options)
+        ConstantMutator.stub(constant_name, value, options)
+      end
+
+      # Hides the named constant with the given value. The constant will be
+      # undefined for the duration of the test.
+      #
+      # Like method stubs, the constant will be restored to its original value
+      # when the example completes.
+      #
+      # @param constant_name [String] The fully qualified name of the constant.
+      #   The current constant scoping at the point of call is not considered.
+      #
+      # @example
+      #
+      #   hide_const("MyClass") # => MyClass is now an undefined constant
+      def hide_const(constant_name)
+        ConstantMutator.hide(constant_name)
       end
 
     private
-      
+
       def declare_double(declared_as, *args)
         args << {} unless Hash === args.last
         args.last[:__declared_as] = declared_as

data/lib/rspec/mocks/framework.rb

@@ -2,8 +2,9 @@
 # supports wrapping rspec's mocking functionality without invading every
 # object in the system.
 
+require 'rspec/mocks/configuration'
 require 'rspec/mocks/extensions/instance_exec'
-require 'rspec/mocks/stashed_instance_method'
+require 'rspec/mocks/instance_method_stasher'
 require 'rspec/mocks/method_double'
 require 'rspec/mocks/methods'
 require 'rspec/mocks/argument_matchers'
@@ -18,4 +19,4 @@ require 'rspec/mocks/error_generator'
 require 'rspec/mocks/space'
 require 'rspec/mocks/serialization'
 require 'rspec/mocks/any_instance'
-require 'rspec/mocks/stub_const'
+require 'rspec/mocks/mutate_const'

data/lib/rspec/mocks/instance_method_stasher.rb

@@ -0,0 +1,70 @@
+module RSpec
+  module Mocks
+    # @private
+    class InstanceMethodStasher
+      def initialize(klass, method)
+        @klass = klass
+        @method = method
+
+        @method_is_stashed = false
+      end
+
+      # @private
+      def method_is_stashed?
+        @method_is_stashed
+      end
+
+      # @private
+      def stash
+        return if !method_defined_directly_on_klass? || @method_is_stashed
+
+        @klass.__send__(:alias_method, stashed_method_name, @method)
+        @method_is_stashed = true
+      end
+
+      private
+
+      # @private
+      def method_defined_directly_on_klass?
+        method_defined_on_klass? && method_owned_by_klass?
+      end
+
+      # @private
+      def method_defined_on_klass?
+        @klass.method_defined?(@method) || @klass.private_method_defined?(@method)
+      end
+
+      if ::UnboundMethod.method_defined?(:owner)
+        # @private
+        def method_owned_by_klass?
+          @klass.instance_method(@method).owner == @klass
+        end
+      else
+        # @private
+        def method_owned_by_klass?
+          # On 1.8.6, which does not support Method#owner, we have no choice but
+          # to assume it's defined on the klass even if it may be defined on
+          # a superclass.
+          true
+        end
+      end
+
+      public
+
+      # @private
+      def stashed_method_name
+        "obfuscated_by_rspec_mocks__#{@method}"
+      end
+
+      # @private
+      def restore
+        return unless @method_is_stashed
+
+        @klass.__send__(:alias_method, @method, stashed_method_name)
+        @klass.__send__(:remove_method, stashed_method_name)
+        @method_is_stashed = false
+      end
+    end
+  end
+end
+

data/lib/rspec/mocks/message_expectation.rb

@@ -9,11 +9,13 @@ module RSpec
       protected :expected_received_count=, :expected_from=, :error_generator, :error_generator=
 
       # @private
-      def initialize(error_generator, expectation_ordering, expected_from, message, expected_received_count=1, opts={}, &implementation)
+      def initialize(error_generator, expectation_ordering, expected_from, method_double,
+                     expected_received_count=1, opts={}, &implementation)
         @error_generator = error_generator
         @error_generator.opts = opts
         @expected_from = expected_from
-        @message = message
+        @method_double = method_double
+        @message = @method_double.method_name
         @actual_received_count = 0
         @expected_received_count = expected_received_count
         @argument_list_matcher = ArgumentListMatcher.new(ArgumentMatchers::AnyArgsMatcher.new)
@@ -97,8 +99,28 @@ module RSpec
         @implementation = implementation || build_implementation(values)
       end
 
+      # Tells the object to delegate to the original unmodified method
+      # when it receives the message.
+      #
+      # @note This is only available on partial mock objects.
+      #
+      # @example
+      #
+      #   counter.should_receive(:increment).and_call_original
+      #   original_count = counter.count
+      #   counter.increment
+      #   expect(counter.count).to eq(original_count + 1)
+      def and_call_original
+        if @method_double.object.is_a?(RSpec::Mocks::TestDouble)
+          @error_generator.raise_only_valid_on_a_partial_mock(:and_call_original)
+        else
+          self.implementation = @method_double.original_method
+        end
+      end
+
       # @overload and_raise
       # @overload and_raise(ExceptionClass)
+      # @overload and_raise(ExceptionClass, message)
       # @overload and_raise(exception_instance)
       #
       # Tells the object to raise an exception when the message is received.
@@ -106,17 +128,23 @@ module RSpec
       # @note
       #
       #   When you pass an exception class, the MessageExpectation will raise
-      #   an instance of it, creating it with `new`. If the exception class
-      #   initializer requires any parameters, you must pass in an instance and
-      #   not the class.
+      #   an instance of it, creating it with `exception` and passing `message`
+      #   if specified.  If the exception class initializer requires more than
+      #   one parameters, you must pass in an instance and not the class,
+      #   otherwise this method will raise an ArgumentError exception.
       #
       # @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)
-        @exception_to_raise = exception
+      def and_raise(exception = RuntimeError, message = nil)
+        if exception.respond_to?(:exception)
+          @exception_to_raise = message ? exception.exception(message) : exception.exception
+        else
+          @exception_to_raise = exception
+        end
       end
 
       # @overload and_throw(symbol)
@@ -167,7 +195,7 @@ module RSpec
         @order_group.handle_order_constraint self
 
         begin
-          raise_exception unless @exception_to_raise.nil?
+          raise(@exception_to_raise) unless @exception_to_raise.nil?
           Kernel::throw(*@args_to_throw) unless @args_to_throw.empty?
 
           default_return_val = call_with_yield(&block) if !@args_to_yield.empty? || @eval_context
@@ -184,19 +212,6 @@ module RSpec
         end
       end
 
-      # @private
-      def raise_exception
-        if !@exception_to_raise.respond_to?(:instance_method) ||
-            @exception_to_raise.instance_method(:initialize).arity <= 0
-          raise(@exception_to_raise)
-        else
-          raise ArgumentError.new(<<-MESSAGE)
-'and_raise' can only accept an Exception class if an instance can be constructed with no arguments.
-#{@exception_to_raise.to_s}'s initialize method requires #{@exception_to_raise.instance_method(:initialize).arity} arguments, so you have to supply an instance instead.
-MESSAGE
-        end
-      end
-
       # @private
       def called_max_times?
         @expected_received_count != :any &&
@@ -301,7 +316,7 @@ MESSAGE
       #
       # @example
       #
-      #   dealer.should_recieve(:deal_card).exactly(10).times
+      #   dealer.should_receive(:deal_card).exactly(10).times
       def exactly(n, &block)
         @implementation = block if block
         set_expected_received_count :exactly, n
@@ -313,7 +328,7 @@ MESSAGE
       #
       # @example
       #
-      #   dealer.should_recieve(:deal_card).at_least(9).times
+      #   dealer.should_receive(:deal_card).at_least(9).times
       def at_least(n, &block)
         @implementation = block if block
         set_expected_received_count :at_least, n
@@ -325,7 +340,7 @@ MESSAGE
       #
       # @example
       #
-      #   dealer.should_recieve(:deal_card).at_most(10).times
+      #   dealer.should_receive(:deal_card).at_most(10).times
       def at_most(n, &block)
         @implementation = block if block
         set_expected_received_count :at_most, n
@@ -336,9 +351,9 @@ MESSAGE
       #
       # @example
       #
-      #   dealer.should_recieve(:deal_card).exactly(10).times
-      #   dealer.should_recieve(:deal_card).at_least(10).times
-      #   dealer.should_recieve(:deal_card).at_most(10).times
+      #   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
       def times(&block)
         @implementation = block if block
         self
@@ -471,12 +486,17 @@ MESSAGE
     # @private
     class NegativeMessageExpectation < MessageExpectation
       # @private
-      def initialize(error_generator, expectation_ordering, expected_from, message, &implementation)
-        super(error_generator, expectation_ordering, expected_from, message, 0, {}, &implementation)
+      def initialize(error_generator, expectation_ordering, expected_from, method_double, &implementation)
+        super(error_generator, expectation_ordering, expected_from, method_double, 0, {}, &implementation)
       end
 
       def and_return(*)
         # no-op
+        # @deprecated and_return is not supported with negative message expectations.
+        RSpec.warn_deprecation <<-MSG
+
+DEPRECATION: `and_return` with `should_not_receive` is deprecated. Called from #{caller(0)[1]}
+MSG
       end
 
       # @private