rspec-mocks 2.10.1 → 2.11.0

data/Changelog.md

@@ -1,3 +1,28 @@
+### 2.11.0 / 2012-07-07
+[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.10.1...v2.11.0)
+
+Enhancements
+
+* expose ArgumentListMatcher as a formal API
+    * supports use by 3rd party mock frameworks like Surrogate
+* Add `stub_const` API to stub constants for the duration of an
+  example (Myron Marston).
+
+Bug fixes
+
+* Fix regression of edge case behavior. `double.should_receive(:foo) { a }`
+  was causing a NoMethodError when `double.stub(:foo).and_return(a, b)`
+  had been setup before (Myron Marston).
+* Infinite loop generated by using `any_instance` and `dup`. (Sidu Ponnappa @kaiwren)
+* `double.should_receive(:foo).at_least(:once).and_return(a)` always returns a
+  even if `:foo` is already stubbed.
+* Prevent infinite loop when interpolating a null double into a string
+  as an integer (`"%i" % double.as_null_object`). (Myron Marston)
+* Fix `should_receive` so that null object behavior (e.g. returning
+  self) is preserved if no implementation is given (Myron Marston).
+* Fix `and_raise` so that it raises `RuntimeError` rather than
+  `Exception` by default, just like ruby does. (Andrew Marshall)
+
 ### 2.10.1 / 2012-05-05
 [full changelog](http://github.com/rspec/rspec-mocks/compare/v2.10.0...v2.10.1)
 
@@ -13,7 +38,7 @@ Bug fixes
 
 Bug fixes
 
-* fail fast when an `exactly` or `at_most` expectation is exceeded 
+* fail fast when an `exactly` or `at_most` expectation is exceeded
 
 ### 2.9.0 / 2012-03-17
 [full changelog](http://github.com/rspec/rspec-mocks/compare/v2.8.0...v2.9.0)

data/README.md

@@ -1,4 +1,4 @@
-# RSpec Mocks
+# RSpec Mocks [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/rspec/rspec-mocks)
 
 rspec-mocks is a test-double framework for rspec with support for method stubs,
 fakes, and message expectations on generated test-doubles and real objects
@@ -156,7 +156,7 @@ double.should_receive(:msg).with(1, kind_of(Numeric), "b") #2nd argument can any
 double.should_receive(:msg).with(1, boolean(), "b") #2nd argument can true or false
 double.should_receive(:msg).with(1, /abc/, "b") #2nd argument can be any String matching the submitted Regexp
 double.should_receive(:msg).with(1, anything(), "b") #2nd argument can be anything at all
-double.should_receive(:msg).with(1, ducktype(:abs, :div), "b")
+double.should_receive(:msg).with(1, duck_type(:abs, :div), "b")
                     #2nd argument can be object that responds to #abs and #div
 ```
 
@@ -246,6 +246,18 @@ While this is a good thing when you really need it, you probably don't really
 need it! Take care to specify only the things that matter to the behavior of
 your code.
 
+## Stubbing Constants
+
+See the [stubbing constants
+README](https://github.com/rspec/rspec-mocks/blob/master/features/stubbing_constants/README.md)
+for info on this feature.
+
+## Use `before(:each)`, not `before(:all)`
+
+Stubs in `before(:all)` are not supported. The reason is that all stubs and mocks get cleared out after each example, so any stub that is set in `before(:all)` would work in the first example that happens to run in that group, but not for any others.
+
+Instead of `before(:all)`, use `before(:each)`.
+
 ## Further Reading
 
 There are many different viewpoints about the meaning of mocks and stubs. If

data/features/stubbing_constants/README.md

@@ -0,0 +1,62 @@
+## Stubbing Constants
+
+Support is provided for stubbing constants. Like with method stubs, the
+stubbed constants will be restored to their original state when an
+example completes.
+
+``` ruby
+stub_const("Foo", fake_foo)
+Foo # => fake_foo
+```
+
+Stubbed constant names must be fully qualified; the current module
+nesting is not considered.
+
+``` ruby
+module MyGem
+  class SomeClass; end
+end
+
+module MyGem
+  describe "Something" do
+    let(:fake_class) { Class.new }
+
+    it "accidentally stubs the wrong constant" do
+      # this stubs ::SomeClass (in the top-level namespace),
+      # not MyGem::SomeClass like you probably mean.
+      stub_const("SomeClass", fake_class)
+    end
+
+    it "stubs the right constant" do
+      stub_const("MyGem::SomeClass", fake_class)
+    end
+  end
+end
+```
+
+When you stub a constant that is a module or a class, nested
+constants on the original module or class are not transferred
+by default, but you can use the `:transfer_nested_constants`
+option to tell rspec-mocks to transfer them:
+
+``` ruby
+class CardDeck
+  SUITS = [:Spades, :Diamonds, :Clubs, :Hearts]
+  NUM_CARDS = 52
+end
+
+fake_class = Class.new
+stub_const("CardDeck", fake_class)
+CardDeck # => fake_class
+CardDeck::SUITS # => raises uninitialized constant error
+CardDeck::NUM_CARDS # => raises uninitialized constant error
+
+stub_const("CardDeck", fake_class, :transfer_nested_constants => true)
+CardDeck::SUITS # => [:Spades, :Diamonds, :Clubs, :Hearts]
+CardDeck::NUM_CARDS # => 52
+
+stub_const("CardDeck", fake_class, :transfer_nested_constants => [:SUITS])
+CardDeck::SUITS # => [:Spades, :Diamonds, :Clubs, :Hearts]
+CardDeck::NUM_CARDS # => raises uninitialized constant error
+```
+

data/features/stubbing_constants/stub_defined_constant.feature

@@ -0,0 +1,79 @@
+Feature: Stub Defined Constant
+
+  Use `stub_const` to stub constants. When the constant is already defined,
+  the stubbed value will replace the original value for the duration of the
+  example.
+
+  Scenario: Stub top-level constant
+    Given a file named "stub_const_spec.rb" with:
+      """ruby
+      FOO = 7
+
+      describe "stubbing FOO" do
+        it "can stub FOO with a different value" do
+          stub_const("FOO", 5)
+          FOO.should eq(5)
+        end
+
+        it "restores the stubbed constant when the example completes" do
+          FOO.should eq(7)
+        end
+      end
+      """
+    When I run `rspec stub_const_spec.rb`
+    Then the examples should all pass
+
+  Scenario: Stub nested constant
+    Given a file named "stub_const_spec.rb" with:
+      """ruby
+      module MyGem
+        class SomeClass
+          FOO = 7
+        end
+      end
+
+      module MyGem
+        describe SomeClass do
+          it "stubs the nested constant when it is fully qualified" do
+            stub_const("MyGem::SomeClass::FOO", 5)
+            SomeClass::FOO.should eq(5)
+          end
+        end
+      end
+      """
+    When I run `rspec stub_const_spec.rb`
+    Then the examples should all pass
+
+  Scenario: Transfer nested constants
+    Given a file named "stub_const_spec.rb" with:
+      """ruby
+      module MyGem
+        class SomeClass
+          FOO = 7
+        end
+      end
+
+      module MyGem
+        describe SomeClass do
+          let(:fake_class) { Class.new }
+
+          it "does not transfer nested constants by default" do
+            stub_const("MyGem::SomeClass", fake_class)
+            expect { SomeClass::FOO }.to raise_error(NameError)
+          end
+
+          it "transfers nested constants when using :transfer_nested_constants => true" do
+            stub_const("MyGem::SomeClass", fake_class, :transfer_nested_constants => true)
+            SomeClass::FOO.should eq(7)
+          end
+
+          it "can specify a list of nested constants to transfer" do
+            stub_const("MyGem::SomeClass", fake_class, :transfer_nested_constants => [:FOO])
+            SomeClass::FOO.should eq(7)
+          end
+        end
+      end
+      """
+    When I run `rspec stub_const_spec.rb`
+    Then the examples should all pass
+

data/features/stubbing_constants/stub_undefined_constant.feature

@@ -0,0 +1,50 @@
+Feature: Stub Undefined Constant
+
+  Use `stub_const` to stub constants. When the constant is not already defined,
+  all the necessary intermediary modules will be dynamically created. When the
+  example completes, the intermediary module constants will be removed to return
+  the constant state to how it started.
+
+  Scenario: Stub top-level constant
+    Given a file named "stub_const_spec.rb" with:
+      """ruby
+      describe "stubbing FOO" do
+        it "can stub undefined constant FOO" do
+          stub_const("FOO", 5)
+          FOO.should eq(5)
+        end
+
+        it "undefines the constant when the example completes" do
+          expect { FOO }.to raise_error(NameError)
+        end
+      end
+      """
+    When I run `rspec stub_const_spec.rb`
+    Then the examples should all pass
+
+  Scenario: Stub nested constant
+    Given a file named "stub_const_spec.rb" with:
+      """ruby
+      module MyGem
+        class SomeClass
+        end
+      end
+
+      module MyGem
+        describe SomeClass do
+          it "can stub an arbitrarily deep constant that is undefined" do
+            defined?(SomeClass::A).should be_false
+            stub_const("MyGem::SomeClass::A::B::C", 3)
+            SomeClass::A::B::C.should eq(3)
+            SomeClass::A.should be_a(Module)
+          end
+
+          it 'undefines the intermediary constants that were dynamically created' do
+            defined?(SomeClass).should be_true
+            defined?(SomeClass::A).should be_false
+          end
+        end
+      end
+      """
+    When I run `rspec stub_const_spec.rb`
+    Then the examples should all pass

data/lib/rspec/mocks/any_instance.rb

@@ -1,4 +1,7 @@
 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/expectation_chain'
 require 'rspec/mocks/any_instance/message_chains'
 require 'rspec/mocks/any_instance/recorder'
 
@@ -24,6 +27,7 @@ module RSpec
       # @return [Recorder]
       def any_instance
         RSpec::Mocks::space.add(self)
+        modify_dup_to_remove_mock_proxy_when_invoked
         __recorder
       end
       
@@ -33,13 +37,45 @@ module RSpec
         super
       ensure
         __recorder.stop_all_observation!
+        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
+        unless self.method_defined?(:__rspec_original_dup)
+          self.class_eval do
+            def __rspec_dup
+              __remove_mock_proxy
+              __rspec_original_dup
+            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
+            alias_method  :dup, :__rspec_original_dup
+            remove_method :__rspec_original_dup
+            remove_method :__rspec_dup
+          end
+        end
+      end
     end
   end
 end

data/lib/rspec/mocks/any_instance/chain.rb

@@ -72,87 +72,6 @@ module RSpec
           self
         end
       end
-
-      # @private
-      class ExpectationChain < Chain
-
-        # @private
-        def initialize(*args, &block)
-          record(:should_receive, *args, &block)
-          @expectation_fulfilled = false
-        end
-
-        # @private
-        def expectation_fulfilled?
-          @expectation_fulfilled || constrained_to_any_of?(:never, :any_number_of_times)
-        end
-
-        private
-
-        def verify_invocation_order(rspec_method_name, *args, &block)
-        end
-
-        def invocation_order
-          @invocation_order ||= {
-            :should_receive => [nil],
-            :with => [:should_receive],
-            :and_return => [:with, :should_receive],
-            :and_raise => [:with, :should_receive]
-          }
-        end
-      end
-
-      # @private
-      class StubChain < Chain
-
-        # @private
-        def initialize(*args, &block)
-          record(:stub, *args, &block)
-        end
-
-        # @private
-        def expectation_fulfilled?
-          true
-        end
-
-        private
-
-        def invocation_order
-          @invocation_order ||= {
-            :stub => [nil],
-            :with => [:stub],
-            :and_return => [:with, :stub],
-            :and_raise => [:with, :stub],
-            :and_yield => [:with, :stub]
-          }
-        end
-
-        def verify_invocation_order(rspec_method_name, *args, &block)
-          unless invocation_order[rspec_method_name].include?(last_message)
-            raise(NoMethodError, "Undefined method #{rspec_method_name}")
-          end
-        end
-      end
-
-      # @private
-      class StubChainChain < StubChain
-
-        # @private
-        def initialize(*args, &block)
-          record(:stub_chain, *args, &block)
-        end
-
-        private
-
-        def invocation_order
-          @invocation_order ||= {
-            :stub_chain => [nil],
-            :and_return => [:stub_chain],
-            :and_raise => [:stub_chain],
-            :and_yield => [:stub_chain]
-          }
-        end
-      end
     end
   end
 end

data/lib/rspec/mocks/any_instance/expectation_chain.rb

@@ -0,0 +1,57 @@
+module RSpec
+  module Mocks
+    module AnyInstance
+      # @api private
+      class ExpectationChain < Chain
+        def expectation_fulfilled?
+          @expectation_fulfilled || constrained_to_any_of?(:never, :any_number_of_times)
+        end
+
+        def initialize(*args, &block)
+          record(*args, &block)
+          @expectation_fulfilled = false
+        end
+
+        private
+        def verify_invocation_order(rspec_method_name, *args, &block)
+        end
+      end
+
+      # @api private
+      class PositiveExpectationChain < ExpectationChain
+        def initialize(*args, &block)
+          super(:should_receive, *args, &block)
+        end
+
+        private
+
+        def invocation_order
+          @invocation_order ||= {
+            :should_receive => [nil],
+            :with => [:should_receive],
+            :and_return => [:with, :should_receive],
+            :and_raise => [:with, :should_receive]
+          }
+        end
+      end
+
+      # @api private
+      class NegativeExpectationChain < ExpectationChain
+        def initialize(*args, &block)
+          super(:should_not_receive, *args, &block)
+        end
+
+        private
+
+        def invocation_order
+          @invocation_order ||= {
+            :should_not_receive => [nil],
+            :with => [:should_receive],
+            :and_return => [:with, :should_receive],
+            :and_raise => [:with, :should_receive]
+          }
+        end
+      end
+    end
+  end
+end