rspec-mocks 2.3.0 → 2.4.0

data/History.markdown

@@ -1,8 +1,15 @@
 ## rspec-mocks release history (incomplete)
 
+### 2.4.0 / 2011-01-02
+
+[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.3.0...v2.4.0)
+
+No functional changes in this release, which was made to align with the
+rspec-core-2.4.0 release.
+
 ### 2.3.0 / 2010-12-12
 
-[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.2.1...v2.3.0)
+[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.2.0...v2.3.0)
 
 * Bug fixes 
   * Fix our Marshal extension so that it does not interfere with objects that

data/Rakefile

@@ -61,10 +61,10 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-desc "Push cukes to relishapp using the relish-client-gem"
+desc "Push docs/cukes to relishapp using the relish-client-gem"
 task :relish, :version do |t, args|
   raise "rake relish[VERSION]" unless args[:version]
-  sh "relish push --organization rspec --project rspec-mocks -v #{args[:version]}"
+  sh "relish push rspec/rspec-mocks:#{args[:version]}"
 end
 
 task :default => [:spec, :cucumber]

data/features/.nav

@@ -0,0 +1,11 @@
+- method_stubs:
+  - simple_return_value.feature
+  - stub_implementation.feature
+  - stub_chain.feature
+- message_expectations:
+  - expect_message.feature
+  - block_local_expectations.feature.pending
+  - warn_when_expectation_is_set_on_nil.feature
+- outside_rspec:
+  - configuration.feature
+  - standalone.feature

data/features/README.markdown

@@ -1,6 +1,6 @@
 rspec-mocks is used to create dynamic "doubles", which stand in for real
-objects in examples. You can set message expectations on them (i.e. mock
-methods), and/or stub return values for arbitrary messages:
+objects in examples. You can stub return values and/or set message
+expectations:
 
     describe Account do
       context "when closed" do
@@ -16,9 +16,6 @@ methods), and/or stub return values for arbitrary messages:
       end
     end
 
-Message expectations like the one in the example above are verified at
-the end of each example.
-
 ## Issues
 
 The documentation for rspec-mocks is a work in progress. We'll be adding

data/features/message_expectations/README.md

@@ -0,0 +1,59 @@
+We're working on improving these docs. In the mean time, here's a cheat sheet
+to cover the basics.
+
+    # create a double
+    obj = double()
+
+    # expect a message
+    obj.should_receive(:message)
+
+    # specify a return value
+    obj.should_receive(:message) { 'this is the value to return' }
+
+### Argument constraints
+   
+#### Explicit arguments
+
+    obj.should_receive(:message).with('an argument')
+    obj.should_receive(:message).with('more_than', 'one_argument')
+
+#### Argument matchers
+
+    obj.should_receive(:message).with(anything())
+    obj.should_receive(:message).with(an_instance_of(Money))
+    obj.should_receive(:message).with(hash_including(:a => 'b'))
+
+#### Regular expressions
+
+    obj.should_receive(:message).with(/abc/)
+
+### Counts 
+
+    obj.should_receive(:message).once
+    obj.should_receive(:message).twice
+    obj.should_receive(:message).exactly(3).times
+
+    obj.should_receive(:message).at_least(:once)
+    obj.should_receive(:message).at_least(:twice)
+    obj.should_receive(:message).at_least(n).times
+
+    obj.should_receive(:message).at_most(:once)
+    obj.should_receive(:message).at_most(:twice)
+    obj.should_receive(:message).at_most(n).times
+
+### Raising/Throwing
+
+    obj.should_receive(:message) { raise "this error" }
+    obj.should_receive(:message) { throw :this_symbol }
+
+### Ordering
+
+    obj.should_receive(:one).ordered
+    obj.should_receive(:two).ordered
+
+### Arbitrary handling
+
+    obj.should_receive(:message) do |arg1, arg2|
+      # set expectations about the args in this block
+      # and set a return value
+    end

data/features/message_expectations/expect_message.feature

@@ -1,4 +1,4 @@
-Feature: Expect a message
+Feature: expect a message
 
   Use should_receive() to set an expectation that a receiver should receive a
   message before the example is completed.

data/features/message_expectations/warn_when_expectation_is_set_on_nil.feature

@@ -1,4 +1,4 @@
-Feature: Warn when expectation is set on nil
+Feature: warn when expectation is set on nil
 
   Scenario: nil instance variable
     Given a file named "example_spec.rb" with:

data/features/method_stubs/README.md

@@ -0,0 +1,40 @@
+We're working on improving these docs. In the mean time, here's a cheat sheet
+to cover the basics.
+
+    # create a double
+    obj = double()
+
+    # stub a method
+    obj.stub(:message) # returns obj
+
+    # specify a return value
+    obj.stub(:message) { 'this is the value to return' }
+
+### Argument constraints
+   
+#### Explicit arguments
+
+    obj.stub(:message).with('an argument')
+    obj.stub(:message).with('more_than', 'one_argument')
+
+#### Argument matchers
+
+    obj.stub(:message).with(anything())
+    obj.stub(:message).with(an_instance_of(Money))
+    obj.stub(:message).with(hash_including(:a => 'b'))
+
+#### Regular expressions
+
+    obj.stub(:message).with(/abc/)
+
+### Raising/Throwing
+
+    obj.stub(:message) { raise "this error" }
+    obj.stub(:message) { throw :this_symbol }
+
+### Arbitrary handling
+
+    obj.stub(:message) do |arg1, arg2|
+      # set expectations about the args in this block
+      # and set a return value
+    end

data/features/{stubs → method_stubs}/simple_return_value.feature

@@ -1,6 +1,6 @@
-Feature: Stub with simple return value
+Feature: stub with a simple return value
 
-  Use the stub() method on a test double or a real object to tell the object to
+  Use the `stub` method on a test double or a real object to tell the object to
   return a value (or values) in response to a given message. If the message is
   never received, nothing happens.
 

data/features/{stubs → method_stubs}/stub_chain.feature

@@ -1,23 +1,23 @@
-Feature: Stub a chain of methods
+Feature: stub a chain of methods
 
-  The stub_chain method lets you to stub a chain of methods in one statement.
+  The `stub_chain` method lets you to stub a chain of methods in one statement.
   Method chains are considered a design smell, but it's not really the method
   chain that is the problem - it's the dependency chain represented by a chain
   of messages to different objects:
 
-    foo.get_bar.get_baz
+      foo.get_bar.get_baz
 
-  This is a Law of Demeter violation if get_bar() returns an object other than
-  foo, and get_baz() returns yet another object.
+  This is a Law of Demeter violation if `get_bar` returns an object other than
+  `foo`, and `get_baz` returns yet another object.
 
   Fluent interfaces look similar from a caller's perspective, but don't
   represent a dependency chain (the caller depends only on the object it is
   calling). Consider this common example from Ruby on Rails:
 
-    Article.recent.by(current_user)
+      Article.recent.by(current_user)
 
-  The recent() and by() methods return the same object, so this is not
-  a Law of Demeter violation.
+  The `recent` and `by` methods return the same object, so this is not a Law of
+  Demeter violation.
 
   Scenario: stub a chain of methods
     Given a file named "stub_chain_spec.rb" with:

data/features/{stubs → method_stubs}/stub_implementation.feature

@@ -1,4 +1,4 @@
-Feature: Stub with substitute implementation
+Feature: stub with substitute implementation
 
   You can stub an implementation of a method (a.k.a. fake) by passing a block
   to the stub() method.

data/features/outside_rspec/configuration.feature

@@ -1,4 +1,4 @@
-Feature: Configure any test framework to use rspec-mocks
+Feature: configure any test framework to use rspec-mocks
 
   Test frameworks that want to use rspec-mocks can use
   RSpec::Mocks::setup(self) to hook into rspec-mocks. Doing so adds the

data/features/outside_rspec/standalone.feature

@@ -4,7 +4,7 @@ Feature: standalone
   outside the RSpec environment. This is especially useful for
   exploring rspec-mocks in irb.
 
-  Scenario: stub outside rspec
+  Scenario: method stub outside rspec
     Given a file named "example.rb" with:
       """
       require "rspec/mocks/standalone"

data/lib/rspec/mocks/version.rb

@@ -1,7 +1,7 @@
 module RSpec # :nodoc:
   module Mocks # :nodoc:
     module Version # :nodoc:
-      STRING = '2.3.0'
+      STRING = '2.4.0'
     end
   end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-mocks
 version: !ruby/object:Gem::Version 
-  hash: 3
   prerelease: false
   segments: 
   - 2
-  - 3
+  - 4
   - 0
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors: 
 - David Chelimsky
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-12 00:00:00 -06:00
+date: 2011-01-02 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -41,15 +40,18 @@ files:
 - Upgrade.markdown
 - autotest/discover.rb
 - cucumber.yml
+- features/.nav
 - features/README.markdown
+- features/message_expectations/README.md
 - features/message_expectations/block_local_expectations.feature.pending
 - features/message_expectations/expect_message.feature
 - features/message_expectations/warn_when_expectation_is_set_on_nil.feature
+- features/method_stubs/README.md
+- features/method_stubs/simple_return_value.feature
+- features/method_stubs/stub_chain.feature
+- features/method_stubs/stub_implementation.feature
 - features/outside_rspec/configuration.feature
 - features/outside_rspec/standalone.feature
-- features/stubs/simple_return_value.feature
-- features/stubs/stub_chain.feature
-- features/stubs/stub_implementation.feature
 - features/support/env.rb
 - lib/rspec/mocks.rb
 - lib/rspec/mocks/argument_expectation.rb
@@ -130,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 1914883193122525774
       segments: 
       - 0
       version: "0"
@@ -139,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 1914883193122525774
       segments: 
       - 0
       version: "0"
@@ -149,17 +151,19 @@ rubyforge_project: rspec
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: rspec-mocks-2.3.0
+summary: rspec-mocks-2.4.0
 test_files: 
 - features/README.markdown
+- features/message_expectations/README.md
 - features/message_expectations/block_local_expectations.feature.pending
 - features/message_expectations/expect_message.feature
 - features/message_expectations/warn_when_expectation_is_set_on_nil.feature
+- features/method_stubs/README.md
+- features/method_stubs/simple_return_value.feature
+- features/method_stubs/stub_chain.feature
+- features/method_stubs/stub_implementation.feature
 - features/outside_rspec/configuration.feature
 - features/outside_rspec/standalone.feature
-- features/stubs/simple_return_value.feature
-- features/stubs/stub_chain.feature
-- features/stubs/stub_implementation.feature
 - features/support/env.rb
 - spec/rspec/mocks/and_yield_spec.rb
 - spec/rspec/mocks/any_number_of_times_spec.rb