rspec-spy 0.0.2 → 0.0.3

data/README.md

@@ -1,7 +1,7 @@
 # RSpec::Spy
 
 This gem allows you to write mock expectations in an AAA (Arrange-Act-Assert) fashion
-with RSpec::Mocks. It does this by allowing you to declare examples within a spy block,
+with RSpec::Mocks. It does this by allowing you to declare examples within a `spy` block,
 which is effectively executed before everything else. Here's a simple example:
 
 ``` ruby
@@ -38,16 +38,14 @@ Or install it yourself as:
 
     $ gem install rspec-spy
 
-## Usage
-
 Add to your spec_helper.rb:
 
 ``` ruby
 require 'rspec-spy'
 ```
 
-If you want to be warned when using should_receive outside of spy blocks (recommended)
-add this to your spec_helper.rb:
+If you want to be warned when using `should_receive` outside of `spy` blocks (recommended)
+add this to your `spec_helper.rb`:
 
 ``` ruby
 # Require should_receive and should_not_receive to be inside spy blocks
@@ -55,9 +53,11 @@ add this to your spec_helper.rb:
 RSpec::Spy.strict_mode = true
 ```
 
-Now just put your spy expectations within spy blocks in your specs. You should be able to
-use all of the functionality from rspec-mocks that you're used to, including spying on
-class methods.
+## Usage
+
+Just put your spy expectations within `spy` blocks in your specs instead of in `before` blocks.
+You should be able to use all of the functionality from rspec-mocks that you're
+used to, including spying on class methods.
 
 ``` ruby
 spy do
@@ -75,19 +75,66 @@ end
 ## Warnings
 
 * This is a hack, you'll want to make sure everyone on your team is aware of the behavior
-and these warnings. You may not actually even want to use this.
-* You should probably avoid instance vars, it gets confusing because you cannot set them
-in before blocks and use them in spy blocks. Remember, spy blocks actually happen before
-before blocks.
+and these warnings.
+* You should probably avoid instance vars and stick to `let`, it gets confusing because you cannot set them
+in `before` blocks and use them in `spy` blocks. Remember, `spy` blocks actually happen before
+`before` blocks. Example (see the example at the beginning of the readme for the right way):
+
+``` ruby
+describe "what not to do" do
+  before do
+    @collaborator = stub.as_null_object
+    @collaborator.message
+  end
+
+  # These will fail because @collaborator is nil because this happens
+  # before the above before block
+  spy do
+    it "should receive a message" do
+      @collaborator.should_receive :message
+    end
+
+    it "should not receive other_message" do
+      @collaborator.should_not_receive :other_message
+    end
+  end
+end
+```
 * If your tests depend on the method you are spying on returning something then you'll
-need to use `and_return` in your spy block and if you have normal examples you'll also
-need to stub it. Yes, this is annoying, but that's how rspec-mocks works.
+need to use `and_return` in your `spy` block and if you have normal examples you'll also
+need to `stub` it. Yes, this is annoying, but that's how rspec-mocks works and it's one 
+of the many reasons you shoudln't mock when the return value matters (just `stub`). Example:
+
+``` ruby
+describe "stubbing and mocking at the same time" do
+  let(:collaborator) { stub.as_null_object }
+  before do
+    collaborator.stub(:message) { 5 }
+    @result = collaborator.message
+
+    # This will fail unless you use and_return
+    @result.should == 5
+  end
+
+  it "should return 5" do
+    # This will fail unless you stub in before
+    @result.should == 5
+  end
+
+  spy do
+    it "should receive a message" do
+      collaborator.should_receive(:message).and_return(5)
+    end
+  end
+end
+```
 
 ## Alternatives
 
 * [matahari](https://github.com/mortice/matahari)
 * [bourne](https://github.com/thoughtbot/bourne)
 * [rspec-spies](https://github.com/technicalpickles/rspec-spies)
+* [gimme](https://github.com/searls/gimme)
 
 ## Contributing
 

data/lib/rspec/spy/mock_methods.rb

@@ -3,11 +3,13 @@ require 'rspec/mocks'
 RSpec::Mocks::Methods.class_eval do
   def should_receive_with_spy_check(message, opts={}, &block)
     spy_check(:should_receive)
+    nil_check(:should_receive)
     __mock_proxy.add_message_expectation(opts[:expected_from] || caller(1)[0], message.to_sym, opts, &block)
   end
 
   def should_not_receive_with_spy_check(message, &block)
     spy_check(:should_not_receive)
+    nil_check(:should_not_receive)
     __mock_proxy.add_negative_message_expectation(caller(1)[0], message.to_sym, &block)
   end
 
@@ -23,5 +25,11 @@ RSpec::Mocks::Methods.class_eval do
     return if RSpec::Spy.ok_to_spy?
     raise "#{method} should not be used outside of a spy block. Please put it in a spy block or use #{method}!."
   end
+
+  def nil_check(method)
+    return if RSpec::Mocks::Proxy.allow_message_expectations_on_nil?
+    return unless nil?
+    raise "You set an expectation on nil, maybe you're using an @instance_var? If you want to do this, use allow_message_expectations_on_nil."
+  end
 end
 

data/lib/rspec/spy/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Spy
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/rspec_spy_spec.rb

@@ -86,3 +86,16 @@ describe RSpec::Spy, "shorthand" do
     collaborator.should_receive :message
   end
 end
+
+describe RSpec::Spy, "nil warning" do
+  spy.it "should warn me if I try to should_receive on nil" do
+    lambda { @unknown.should_receive :message }.should raise_error
+    lambda { @unknown.should_not_receive :message }.should raise_error
+  end
+
+  spy.it "should not warn me if I allow message expectations on nil" do
+    RSpec::Mocks::Proxy.allow_message_expectations_on_nil
+    lambda { @unknown.should_not_receive :message }.should_not raise_error
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-spy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70351465973020 !ruby/object:Gem::Requirement
+  requirement: &70355483304080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70351465973020
+  version_requirements: *70355483304080
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
-  requirement: &70351465972520 !ruby/object:Gem::Requirement
+  requirement: &70355483303580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70351465972520
+  version_requirements: *70355483303580
 description: Enables AAA testing for rspec-mock
 email:
 - aaronjensen@gmail.com
@@ -79,7 +79,7 @@ rubyforge_project:
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: rspec-spy-0.0.2
+summary: rspec-spy-0.0.3
 test_files:
 - spec/rspec_spy_spec.rb
 - spec/spec_helper.rb