rspec-mocks 2.11.3 → 2.12.0

data/Changelog.md

@@ -1,3 +1,19 @@
+### 2.12.0 / 2012-11-12
+[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.11.3...2.12.0)
+
+Enhancements
+
+* `and_raise` can accept an exception class and message, more closely
+  matching `Kernel#raise` (e.g., `foo.stub(:bar).and_raise(RuntimeError, "message")`)
+  (Bas Vodde)
+* Add `and_call_original`, which will delegate the message to the
+  original method (Myron Marston).
+
+Deprecations:
+
+* Add deprecation warning when using `and_return` with `should_not_receive`
+  (Neha Kumari)
+
 ### 2.11.3 / 2012-09-19
 [full changelog](http://github.com/rspec/rspec-mocks/compare/v2.11.2...v2.11.3)
 

data/README.md

@@ -38,7 +38,7 @@ method stub in one statement:
 book = double("book", :title => "The RSpec Book")
 ```
 
-The first argment is a name, which is used for documentation and appears in
+The first argument is a name, which is used for documentation and appears in
 failure messages. If you don't care about the name, you can leave it out,
 making the combined instantiation/stub declaration very terse:
 
@@ -233,6 +233,31 @@ double.should_receive(:msg) do |arg|
 end
 ```
 
+If the method being stubbed itself takes a block, and you need to yield to it 
+in some special way, you can use this:
+
+```ruby
+double.should_receive(:msg) do |&arg|
+  begin
+    arg.call
+  ensure
+    # cleanup
+  end
+end
+```
+
+## Delegating to the Original Implementation
+
+When working with a partial mock object, you may occasionally
+want to set a message expecation without interfering with how
+the object responds to the message. You can use `and_call_original`
+to achieve this:
+
+```ruby
+Person.should_receive(:find).and_call_original
+Person.find # => executes the original find method and returns the result
+```
+
 ## Combining Expectation Details
 
 Combining the message name with specific arguments, receive counts and responses

data/features/argument_matchers/explicit.feature

@@ -4,7 +4,7 @@ Feature: explicit arguments
 
   Scenario: explicit arguments
     Given a file named "stub_explicit_args_spec.rb" with:
-      """
+      """ruby
       describe "stubbed explicit arguments" do
         it "works on stubs" do
           object = Object.new
@@ -32,7 +32,7 @@ Feature: explicit arguments
 
   Scenario: explicit arguments with multiple arities
     Given a file named "stub_multiple_explicit_args_spec.rb" with:
-      """
+      """ruby
       describe "stubbed multiple explicit arguments" do
         it "works on stubs" do
           object = Object.new

data/features/argument_matchers/general_matchers.feature

@@ -7,7 +7,7 @@ Feature: General matchers
 
   Scenario: anything argument matcher
     Given a file named "stub_anything_args_spec.rb" with:
-      """
+      """ruby
       describe "stubbed anything() args spec" do
         it "works" do
           object = Object.new
@@ -25,7 +25,7 @@ Feature: General matchers
 
   Scenario: any_args argument matcher
     Given a file named "stub_any_args_spec.rb" with:
-      """
+      """ruby
       describe "stubbed any_args() args spec" do
         it "works" do
           object = Object.new
@@ -44,7 +44,7 @@ Feature: General matchers
 
   Scenario: no_args argument matcher
     Given a file named "stub_no_args_spec.rb" with:
-      """
+      """ruby
       describe "stubbed no_args() args spec" do
         it "works for no args" do
           object = Object.new
@@ -65,7 +65,7 @@ Feature: General matchers
 
   Scenario: no_args argument matcher for expectations
     Given a file named "stub_no_args_expectations_spec.rb" with:
-      """
+      """ruby
       describe "stubbed no_args() args spec for expectations" do
         it "works for no args" do
           object = Object.new

data/features/argument_matchers/type_matchers.feature

@@ -6,7 +6,7 @@ Feature: stub with argument constraints
   
   Scenario: an_instance_of argument matcher
     Given a file named "stub_an_instance_of_args_spec.rb" with:
-      """
+      """ruby
       describe "stubbed an_instance_of() args spec" do
         it "works" do
           object = Object.new

data/features/message_expectations/README.md

@@ -22,6 +22,10 @@ block contents are evaluated lazily when the `obj` receives the
       # and set a return value
     end
 
+### Using the original implementation
+
+    obj.should_receive(:message).and_call_original
+
 ### Raising/Throwing
 
     obj.should_receive(:message).and_raise("this error")

data/features/message_expectations/any_instance.feature

@@ -7,7 +7,7 @@ Feature: expect a message on any instance of a class
 
   Scenario: expect a message on any instance of a class
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "any_instance.should_receive" do
         it "verifies that one instance of the class receives the message" do
           Object.any_instance.should_receive(:foo).and_return(:return_value)

data/features/message_expectations/call_original.feature

@@ -0,0 +1,24 @@
+Feature: Calling the original method
+
+  You can use `and_call_original` on the fluent interface
+  to "pass through" the received message to the original method.
+
+  Scenario: expect a message
+    Given a file named "call_original_spec.rb" with:
+      """ruby
+      class Addition
+        def self.two_plus_two
+          4
+        end
+      end
+
+      describe "and_call_original" do
+        it "delegates the message to the original implementation" do
+          Addition.should_receive(:two_plus_two).and_call_original
+          Addition.two_plus_two.should eq(4)
+        end
+      end
+      """
+    When I run `rspec call_original_spec.rb`
+    Then the examples should all pass
+

data/features/message_expectations/expect_message.feature

@@ -5,7 +5,7 @@ Feature: expect a message
 
   Scenario: expect a message
     Given a file named "spec/account_spec.rb" with:
-      """
+      """ruby
       require "account"
 
       describe Account do
@@ -23,7 +23,7 @@ Feature: expect a message
       end
       """
     And a file named "lib/account.rb" with:
-      """
+      """ruby
       class Account
         attr_accessor :logger
 
@@ -37,7 +37,7 @@ Feature: expect a message
 
   Scenario: expect a message with an argument
     Given a file named "spec/account_spec.rb" with:
-      """
+      """ruby
       require "account"
 
       describe Account do
@@ -55,7 +55,7 @@ Feature: expect a message
       end
       """
     And a file named "lib/account.rb" with:
-      """
+      """ruby
       class Account
         attr_accessor :logger
 
@@ -69,7 +69,7 @@ Feature: expect a message
 
   Scenario: provide a return value
     Given a file named "message_expectation_spec.rb" with:
-      """
+      """ruby
       describe "a message expectation" do
         context "with a return value" do
           context "specified in a block" do

data/features/message_expectations/receive_counts.feature

@@ -2,7 +2,7 @@ Feature: receive counts
 
   Scenario: expect a message once
     Given a file named "spec/account_spec.rb" with:
-      """
+      """ruby
       class Account
         attr_accessor :logger
 
@@ -30,7 +30,7 @@ Feature: receive counts
 
   Scenario: expect a message twice
     Given a file named "spec/account_spec.rb" with:
-      """
+      """ruby
       class Account
         attr_accessor :logger
 
@@ -59,7 +59,7 @@ Feature: receive counts
 
   Scenario: expect a message 3 times
     Given a file named "spec/account_spec.rb" with:
-      """
+      """ruby
       class Account
         attr_accessor :logger
 
@@ -89,7 +89,7 @@ Feature: receive counts
 
   Scenario: expect a message at least (:once)
     Given a file named "spec/account_spec.rb" with:
-      """
+      """ruby
       class Account
         attr_accessor :logger
 
@@ -118,7 +118,7 @@ Feature: receive counts
 
   Scenario: expect a message at least (n) times
     Given a file named "spec/account_spec.rb" with:
-      """
+      """ruby
       class Account
         attr_accessor :logger
 
@@ -151,7 +151,7 @@ Feature: receive counts
 
   Scenario: expect a message at most (:once)
     Given a file named "spec/account_spec.rb" with:
-      """
+      """ruby
       class Account
         attr_accessor :logger
 
@@ -181,7 +181,7 @@ Feature: receive counts
 
   Scenario: expect a message at most (n) times
     Given a file named "spec/account_spec.rb" with:
-      """
+      """ruby
       class Account
         attr_accessor :logger
 

data/features/message_expectations/warn_when_expectation_is_set_on_nil.feature

@@ -2,7 +2,7 @@ Feature: warn when expectation is set on nil
 
   Scenario: nil instance variable
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       RSpec.configure {|c| c.mock_with :rspec}
       describe "something" do
         it "does something" do
@@ -16,7 +16,7 @@ Feature: warn when expectation is set on nil
 
   Scenario: allow
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       RSpec.configure {|c| c.mock_with :rspec}
       describe "something" do
         it "does something" do
@@ -31,7 +31,7 @@ Feature: warn when expectation is set on nil
 
   Scenario: allow in one example, but not on another
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       RSpec.configure {|c| c.mock_with :rspec}
       describe "something" do
         it "does something (foo)" do

data/features/method_stubs/any_instance.feature

@@ -8,7 +8,7 @@ Feature: stub on any instance of a class
 
   Scenario: any_instance stub with a single return value
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "any_instance.stub" do
         it "returns the specified value on any instance of the class" do
           Object.any_instance.stub(:foo).and_return(:return_value)
@@ -23,7 +23,7 @@ Feature: stub on any instance of a class
     
   Scenario: any_instance stub with a hash
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "any_instance.stub" do
         context "with a hash" do
           it "returns the hash values on any instance of the class" do
@@ -41,7 +41,7 @@ Feature: stub on any instance of a class
     
   Scenario: any_instance stub with specific arguments matchers
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "any_instance.stub" do
         context "with arguments" do
           it "returns the stubbed value when arguments match" do
@@ -60,7 +60,7 @@ Feature: stub on any instance of a class
   
   Scenario: any_instance unstub
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "any_instance.unstub" do
         it "unstubs a stubbed method" do
           class Object
@@ -81,7 +81,7 @@ Feature: stub on any instance of a class
   
   Scenario: any_instance unstub
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "any_instance.unstub" do
         context "with both an expectation and a stub already set" do
           it "only removes the stub" do
@@ -104,7 +104,7 @@ Feature: stub on any instance of a class
     
   Scenario: stub a chain of methods an any instance
     Given a file named "stub_chain_spec.rb" with:
-      """
+      """ruby
       describe "stubbing a chain of methods" do
         context "given symbols representing methods" do
           it "returns the correct value" do
@@ -130,4 +130,3 @@ Feature: stub on any instance of a class
       """
     When I run `rspec stub_chain_spec.rb`
     Then the examples should all pass
-    

data/features/method_stubs/as_null_object.feature

@@ -8,7 +8,7 @@ Feature: as_null_object
 
   Scenario: double acting as_null_object 
     Given a file named "as_null_object_spec.rb" with:
-      """
+      """ruby
       describe "a double with as_null_object called" do
         let(:null_object) { double('null object').as_null_object }
 

data/features/method_stubs/simple_return_value.feature

@@ -6,7 +6,7 @@ Feature: stub with a simple return value
 
   Scenario: stub with no return value
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "a stub with no return value specified" do
         let(:collaborator) { double("collaborator") }
 
@@ -21,7 +21,7 @@ Feature: stub with a simple return value
 
   Scenario: stubs with return values
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "a stub with a return value" do
         context "specified in a block" do
           it "returns the specified value" do

data/features/method_stubs/stub_chain.feature

@@ -21,7 +21,7 @@ Feature: stub a chain of methods
 
   Scenario: stub a chain of methods
     Given a file named "stub_chain_spec.rb" with:
-      """
+      """ruby
       describe "stubbing a chain of methods" do
         subject { Object.new }
 

data/features/method_stubs/stub_implementation.feature

@@ -5,7 +5,7 @@ Feature: stub with substitute implementation
   
   Scenario: stub implementation
     Given a file named "stub_implementation_spec.rb" with:
-      """
+      """ruby
       describe "a stubbed implementation" do
         it "works" do
           object = Object.new

data/features/method_stubs/to_ary.feature

@@ -14,7 +14,7 @@ Feature: double handling to_ary
 
   Scenario: double receiving to_ary
     Given a file named "example.rb" with:
-      """
+      """ruby
       describe "#to_ary" do
         shared_examples "to_ary" do
           it "raises a NoMethodError" do

data/features/{stubbing_constants → mutating_constants}/README.md

@@ -1,4 +1,6 @@
-## Stubbing Constants
+## Mutating Constants
+
+### Stubbing
 
 Support is provided for stubbing constants. Like with method stubs, the
 stubbed constants will be restored to their original state when an
@@ -60,3 +62,21 @@ CardDeck::SUITS # => [:Spades, :Diamonds, :Clubs, :Hearts]
 CardDeck::NUM_CARDS # => raises uninitialized constant error
 ```
 
+### Hiding
+
+Support is also provided for hiding constants. Hiding a constant temporarily
+removes it; it is restored to its original value after the test completes.
+
+```ruby
+FOO = 42
+hide_const("FOO")
+FOO => NameError: uninitialized constant FOO
+```
+
+Like stubbed constants, names must be fully qualified.
+
+Hiding constants that are already undefined has no effect.
+
+```ruby
+hide_const("NO_OP")
+```