rspec-mocks 2.13.1 → 2.14.0.rc1

data/Changelog.md

@@ -1,10 +1,51 @@
-### 2.13.1 / 2013-04-06
-[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.13.0...v2.13.1)
+### 2.14.0.rc1 / 2013-05-27
+[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.13.0...v2.14.0.rc1)
+
+Enhancements:
+
+* Refactor internals so that the mock proxy methods and state are held
+  outside of the mocked object rather than inside it. This paves the way
+  for future syntax enhancements and removes the need for some hacky
+  work arounds for `any_instance` dup'ing and `YAML` serialization,
+  among other things. Note that the code now relies upon `__id__`
+  returning a unique, consistent value for any object you want to
+  mock or stub (Myron Marston).
+* Add support for test spies. This allows you to verify a message
+  was received afterwards using the `have_received` matcher.
+  Note that you must first stub the method or use a null double.
+  (Joe Ferris and Joël Quenneville)
+* Make `at_least` and `at_most` style receive expectations print that they were
+  expecting at least or at most some number of calls, rather than just the
+  number of calls given in the expectation (Sam Phippen)
+* Make `with` style receive expectations print the args they were expecting, and
+  the args that they got (Sam Phippen)
+* Fix some warnings seen under ruby 2.0.0p0 (Sam Phippen).
+* Add a new `:expect` syntax for message expectations
+  (Myron Marston and Sam Phippen).
 
 Bug fixes
 
-* Allow a block implementation to be used in combination with
-  `and_yield`, `and_raise`, `and_return` or `and_throw` (Myron Marston).
+* Fix `any_instance` so that a frozen object can be `dup`'d when methods
+  have been stubbed on that type using `any_instance` (Jon Rowe).
+* Fix `and_call_original` so that it properly raises an `ArgumentError`
+  when the wrong number of args are passed (Jon Rowe).
+* Fix `double` on 1.9.2 so you can wrap them in an Array
+  using `Array(my_double)` (Jon Rowe).
+* Fix `stub_const` and `hide_const` to handle constants that redefine `send`
+  (Sam Phippen).
+* Fix `Marshal.dump` extension so that it correctly handles nil.
+  (Luke Imhoff, Jon Rowe)
+* Fix isolation of `allow_message_expectations_on_nil` (Jon Rowe)
+* Use inspect to format actual arguments on expectations in failure messages (#280, Ben Langfeld)
+
+Deprecations
+
+* Deprecate `stub` and `mock` as aliases for `double`. `double` is the
+  best term for creating a test double, and it reduces confusion to
+  have only one term (Michi Huber).
+* Deprecate `stub!` and `unstub!` in favor of `stub` and `unstub`
+  (Jon Rowe).
+* Deprecate `at_least(0).times` and `any_number_of_times` (Michi Huber).
 
 ### 2.13.0 / 2013-02-23
 [full changelog](http://github.com/rspec/rspec-mocks/compare/v2.12.2...v2.13.0)

data/README.md

@@ -50,7 +50,7 @@ This is particularly nice when providing a list of test doubles to a method
 that iterates through them:
 
 ```ruby
-order.calculate_total_price(stub(:price => 1.99),stub(:price => 2.99))
+order.calculate_total_price(double(:price => 1.99),double(:price => 2.99))
 ```
 
 ## Consecutive return values

data/features/argument_matchers/README.md

@@ -15,7 +15,7 @@ Argument matchers can be used:
 
     #create a double
     obj = double()
-      
+
     #expect a message with given args
     obj.should_receive(:message).with('an argument')
 
@@ -24,4 +24,4 @@ If more control is needed, one can use a block
     obj.should_receive(:message) do |arg1,  arg2|
       # set expectations about the args in this block
       # and optionally set a return value
-    end
+    end

data/features/argument_matchers/explicit.feature

@@ -46,7 +46,7 @@ Feature: explicit arguments
           object.foo(:this).should eq("got this")
           object.foo(:this, :that).should eq("got this and that")
         end
-        
+
         it "works on mocks" do
           object = double('foo')
           object.should_receive(:foo).with(:this, :that)
@@ -56,5 +56,4 @@ Feature: explicit arguments
       end
       """
     When I run `rspec stub_multiple_explicit_args_spec.rb`
-    Then the output should contain "2 examples, 0 failures"
-
+    Then the output should contain "2 examples, 0 failures"

data/features/argument_matchers/general_matchers.feature

@@ -1,6 +1,6 @@
 Feature: General matchers
 
-  The `anything`,  `any_args`,  and `no_args` matchers can be used to require the method 
+  The `anything`,  `any_args`,  and `no_args` matchers can be used to require the method
   to have arguments (or not) without constraining the details of the argument, such as its
   type,  pattern or value. The `anything` matcher only reflects a single argument, while
   the `any_args` matcher matches any arity.
@@ -82,4 +82,4 @@ Feature: General matchers
       end
       """
     When I run `rspec stub_no_args_expectations_spec.rb`
-    Then the output should contain "2 examples, 1 failure"
+    Then the output should contain "2 examples, 1 failure"

data/features/argument_matchers/type_matchers.feature

@@ -1,9 +1,9 @@
 Feature: stub with argument constraints
 
   You can further specify the behavior by constraining the type,
-  format and/or number of arguments with the `#with()` method 
+  format and/or number of arguments with the `#with()` method
   chained off of `#stub()`
-  
+
   Scenario: an_instance_of argument matcher
     Given a file named "stub_an_instance_of_args_spec.rb" with:
       """ruby
@@ -23,5 +23,4 @@ Feature: stub with argument constraints
       end
       """
     When I run `rspec stub_an_instance_of_args_spec.rb`
-    Then the output should contain "1 example, 0 failures"
-
+    Then the output should contain "1 example, 0 failures"

data/features/message_expectations/README.md

@@ -37,7 +37,7 @@ You can also use the block format:
     obj.should_receive(:message) { throw :this_symbol }
 
 ### Argument constraints
-   
+
 #### Explicit arguments
 
     obj.should_receive(:message).with('an argument')
@@ -53,7 +53,7 @@ You can also use the block format:
 
     obj.should_receive(:message).with(/abc/)
 
-### Counts 
+### Counts
 
     obj.should_receive(:message).once
     obj.should_receive(:message).twice

data/features/message_expectations/any_instance.feature

@@ -2,7 +2,7 @@ Feature: expect a message on any instance of a class
 
   Use `any_instance.should_receive` to set an expectation that one (and only
   one) instance of a class receives a message before the example is completed.
-  
+
   The spec will fail if no instance receives a message.
 
   Scenario: expect a message on any instance of a class
@@ -18,4 +18,4 @@ Feature: expect a message on any instance of a class
       end
       """
     When I run `rspec example_spec.rb`
-    Then the examples should all pass
+    Then the examples should all pass

data/features/message_expectations/block_local_expectations.feature.pending

@@ -32,9 +32,9 @@ Feature: block local expectations
       """
     When I run `rspec spec/account_spec.rb`
     Then the output should contain "1 example, 0 failures"
-    
+
   Scenario: failing example
-    
+
     Given a file named "spec/account_spec.rb" with:
       """
       require 'account'
@@ -52,4 +52,4 @@ Feature: block local expectations
       """
 
     When I run `rspec spec/account_spec.rb`
-    Then the output should contain "1 example, 1 failure"
+    Then the output should contain "1 example, 1 failure"

data/features/message_expectations/expect_message_using_expect.feature

@@ -0,0 +1,103 @@
+Feature: expect message using `expect`
+
+  Use `expect(object).to receive(:message)` to set an expectation that
+  `object` should receive the message `:message` before the example is
+  completed.
+
+  Scenario: expect a message
+    Given a file named "spec/account_spec.rb" with:
+      """ruby
+      require "account"
+
+      describe Account do
+        context "when closed" do
+          it "logs an account closed message" do
+            logger = double("logger")
+            account = Account.new logger
+
+            expect(logger).to receive(:account_closed)
+
+            account.close
+          end
+        end
+      end
+      """
+    And a file named "lib/account.rb" with:
+      """ruby
+      Account = Struct.new(:logger) do
+        def close
+          logger.account_closed
+        end
+      end
+      """
+    When I run `rspec spec/account_spec.rb`
+    Then the output should contain "1 example, 0 failures"
+
+  Scenario: expect a message with an argument
+    Given a file named "spec/account_spec.rb" with:
+      """ruby
+      require "account"
+
+      describe Account do
+        context "when closed" do
+          it "logs an account closed message" do
+            logger = double("logger")
+            account = Account.new logger
+
+            expect(logger).to receive(:account_closed).with(account)
+
+            account.close
+          end
+        end
+      end
+      """
+    And a file named "lib/account.rb" with:
+      """ruby
+      Account = Struct.new(:logger) do
+        def close
+          logger.account_closed(self)
+        end
+      end
+      """
+    When I run `rspec spec/account_spec.rb`
+    Then the output should contain "1 example, 0 failures"
+
+  Scenario: provide a return value
+    Given a file named "spec/message_expectation_spec.rb" with:
+      """ruby
+
+      describe "a message expectation with a return value" do
+        context "specified in a block" do
+          it "returns the specified value" do
+            object = double("object")
+            expect(object).to receive(:message) { :return_value }
+            object.message.should eq(:return_value)
+          end
+        end
+
+        context "specified with and_return" do
+          it "returns the specified value" do
+            object = double("object")
+            expect(object).to receive(:message).and_return(:return_value)
+            object.message.should eq(:return_value)
+          end
+        end
+      end
+      """
+    When I run `rspec spec/message_expectation_spec.rb`
+    Then the output should contain "2 examples, 0 failures"
+
+  Scenario: expect a specific number of calls
+    Given a file named "spec/message_count_spec.rb" with:
+      """ruby
+      describe "a message expectation with a count" do
+        it "passes if the expected number of calls happen" do
+          string = "hi"
+          expect(string).to receive(:length).exactly(3).times
+
+          3.times { string.length }
+        end
+      end
+      """
+    When I run `rspec spec/message_count_spec.rb`
+    Then the output should contain "1 example, 0 failures"

data/features/message_expectations/expect_message_using_should_receive.feature

@@ -0,0 +1,118 @@
+Feature: expect message using `should_receive`
+
+  Use `object.should_receive(:message)` to set an expectation that
+  `object` should receive the message `:message` before the example is
+  completed.
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      RSpec.configure do |config|
+        config.mock_with :rspec do |mocks|
+          mocks.syntax = :should
+        end
+      end
+      """
+
+  Scenario: expect a message
+    Given a file named "spec/account_spec.rb" with:
+      """ruby
+      require "account"
+      require "spec_helper"
+
+      describe Account do
+        context "when closed" do
+          it "logs an account closed message" do
+            logger = double("logger")
+            account = Account.new logger
+
+            logger.should_receive(:account_closed)
+
+            account.close
+          end
+        end
+      end
+      """
+    And a file named "lib/account.rb" with:
+      """ruby
+      Account = Struct.new(:logger) do
+        def close
+          logger.account_closed
+        end
+      end
+      """
+    When I run `rspec spec/account_spec.rb`
+    Then the output should contain "1 example, 0 failures"
+
+  Scenario: expect a message with an argument
+    Given a file named "spec/account_spec.rb" with:
+      """ruby
+      require "account"
+      require "spec_helper"
+
+      describe Account do
+        context "when closed" do
+          it "logs an account closed message" do
+            logger = double("logger")
+            account = Account.new logger
+
+            logger.should_receive(:account_closed).with(account)
+
+            account.close
+          end
+        end
+      end
+      """
+    And a file named "lib/account.rb" with:
+      """ruby
+      Account = Struct.new(:logger) do
+        def close
+          logger.account_closed(self)
+        end
+      end
+      """
+    When I run `rspec spec/account_spec.rb`
+    Then the output should contain "1 example, 0 failures"
+
+  Scenario: provide a return value
+    Given a file named "spec/message_expectation_spec.rb" with:
+      """ruby
+      require "spec_helper"
+
+      describe "a message expectation with a return value" do
+        context "specified in a block" do
+          it "returns the specified value" do
+            object = double("object")
+            object.should_receive(:message) { :return_value }
+            object.message.should eq(:return_value)
+          end
+        end
+
+        context "specified with and_return" do
+          it "returns the specified value" do
+            object = double("object")
+            object.should_receive(:message).and_return(:return_value)
+            object.message.should eq(:return_value)
+          end
+        end
+      end
+      """
+    When I run `rspec spec/message_expectation_spec.rb`
+    Then the output should contain "2 examples, 0 failures"
+
+  Scenario: expect a specific number of calls
+    Given a file named "spec/message_count_spec.rb" with:
+      """ruby
+      require "spec_helper"
+
+      describe "a message expectation with a count" do
+        it "passes if the expected number of calls happen" do
+          string = "hi"
+          string.should_receive(:length).exactly(3).times
+
+          3.times { string.length }
+        end
+      end
+      """
+    When I run `rspec spec/message_count_spec.rb`
+    Then the output should contain "1 example, 0 failures"

data/features/message_expectations/receive_counts.feature

@@ -176,7 +176,7 @@ Feature: receive counts
       end
       """
     When I run `rspec spec/account_spec.rb`
-    Then the output should contain "expected: 1 time"
+    Then the output should contain "expected: at most 1 time"
      And the output should contain "received: 2 times"
 
   Scenario: expect a message at most (n) times

data/features/method_stubs/README.md

@@ -30,7 +30,7 @@ You can also use the block format:
     obj.stub(:message) { throw :this_symbol }
 
 ### Argument constraints
-   
+
 #### Explicit arguments
 
     obj.stub(:message).with('an argument') { ... }

data/features/method_stubs/any_instance.feature

@@ -20,7 +20,7 @@ Feature: stub on any instance of a class
       """
     When I run `rspec example_spec.rb`
     Then the examples should all pass
-    
+
   Scenario: any_instance stub with a hash
     Given a file named "example_spec.rb" with:
       """ruby
@@ -37,8 +37,8 @@ Feature: stub on any instance of a class
       end
       """
     When I run `rspec example_spec.rb`
-    Then the examples should all pass  
-    
+    Then the examples should all pass
+
   Scenario: any_instance stub with specific arguments matchers
     Given a file named "example_spec.rb" with:
       """ruby
@@ -47,7 +47,7 @@ Feature: stub on any instance of a class
           it "returns the stubbed value when arguments match" do
             Object.any_instance.stub(:foo).with(:param_one, :param_two).and_return(:result_one)
             Object.any_instance.stub(:foo).with(:param_three, :param_four).and_return(:result_two)
-          
+
             o = Object.new
             o.foo(:param_one, :param_two).should eq(:result_one)
             o.foo(:param_three, :param_four).should eq(:result_two)
@@ -57,7 +57,7 @@ Feature: stub on any instance of a class
       """
     When I run `rspec example_spec.rb`
     Then the examples should all pass
-  
+
   Scenario: any_instance unstub
     Given a file named "example_spec.rb" with:
       """ruby
@@ -68,7 +68,7 @@ Feature: stub on any instance of a class
               :foo
             end
           end
-          
+
           Object.any_instance.stub(:foo)
           Object.any_instance.unstub(:foo)
 
@@ -77,8 +77,8 @@ Feature: stub on any instance of a class
       end
       """
     When I run `rspec example_spec.rb`
-    Then the examples should all pass  
-  
+    Then the examples should all pass
+
   Scenario: any_instance unstub
     Given a file named "example_spec.rb" with:
       """ruby
@@ -93,7 +93,7 @@ Feature: stub on any instance of a class
             Object.any_instance.should_receive(:foo).and_return(:bar)
             Object.any_instance.stub(:foo)
             Object.any_instance.unstub(:foo)
-            
+
             Object.new.foo.should eq(:bar)
           end
         end
@@ -101,7 +101,7 @@ Feature: stub on any instance of a class
       """
     When I run `rspec example_spec.rb`
     Then the examples should all pass
-    
+
   Scenario: stub a chain of methods an any instance
     Given a file named "stub_chain_spec.rb" with:
       """ruby
@@ -129,4 +129,4 @@ Feature: stub on any instance of a class
       end
       """
     When I run `rspec stub_chain_spec.rb`
-    Then the examples should all pass
+    Then the examples should all pass