moses-rspec-spies 3.0.0rc

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gem 'rspec', '~> 2.0'
+
+group :development do
+  gem 'rake'
+  gem 'jeweler'
+  gem 'rdoc'
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rdoc (3.6.1)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rake
+  rdoc
+  rspec (~> 2.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joshua Nichols
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,117 @@
+= rspec-spies
+
+Behold, the Test Spies pattern! http://xunitpatterns.com/Test%20Spy.html
+
+Some other mocking frameworks support this. In particular, rr, notamock, and jferris's fork of mocha. It'd be great to see support for it in rspec's mocking library as well.
+
+Why not just switch to another framework? Well, because migration is a huge hassle when you have a sizeable number of specs, in part to subtle varations in the framework. Even something like notamock that was meant to work with rspec out of the box... has its differences. Therefore, using the existing rspec mocking framework, with a small enhancements, is pretty idyllic.
+
+In general, I think it should work by doing your usual stub!, followed running the code under test, and then verifying with a matcher. The matcher should probably be in line with the syntax of mocking with should_receive. Here's a short example:
+
+
+    describe "index" do
+      before do
+        @post = stub_model(Post)
+        Post.stub!(:find).and_return(@post)
+        get :show, :id => @post.id
+      end
+    
+      it "should find post by id" do
+        Post.should have_received(:find).with(@post.id)
+      end
+    end
+
+To get started, you just need to:
+
+ * Run: gem install rspec-spies --source http://gemcutter.org
+ * Update spec_helper to include this line: require 'rspec-spies'
+   * Alternatively, you can add `-r rspec-spies` to your project's .rspec file
+
+
+== Before and after test spies
+
+If you think this simple case is redudant, consider this extended example without using test spies (note: these are using shoulda's rspec matchers):
+
+    describe "show"  do
+      before do
+        @post = stub_model(Post)
+        # always stub find, so most of the specifications will work
+        # alternatively, this could be in each 'it' block that doesn't have a should_receive
+        Post.stub!(:find).and_return(@post)
+      end
+    
+      it "should respond with success" do
+        get :show, :id => @post.id
+        
+        controller.should respond_with(:success)
+      end
+    
+      it "should render show template" do
+        get :show, :id => @post.id
+        controller.should render_template(:show)
+      end
+    
+      it "should find the post by id" do
+        Post.should_receive(:find).with(@post.id).and_return(@post) 
+        # note we have to specify the return value again
+        # also, this expectation is set BEFORE we actually do anything
+        get :show, :id => @post.id
+      end
+    
+      it "should assign post" do
+        get :show, :id
+    
+        controller.should assign_to(:post).with(@post)
+      end
+    
+    end
+
+The problems here:
+
+ * Running get in each it block. This is because we want to be able to use a mock expectation (ie @Post.should_receive) in one of the specifications. The should_receive could be in the setup instead of @stub!@, but if find is not called, it'll make all the specs fail, instead of just the one expecting it to be called.
+ * We're stubbing it once in the setup, and then mocking the same method in a later. This means we have to specify the return value both in the setup, so other specs work, and then again in the 'it' block with the mocking so that one will work.
+
+Contrast this with using test spies for this same situation:
+
+    describe "show" do
+      before do
+        @post = stub_model(Post)
+        Post.stub!(:find).and_return(@post)
+    
+        get :show, :id => @post.id
+      end
+    
+      it { should respond_with(:success) }
+    
+      it { should render_template(:show) }
+    
+      it { should assign_to(:post).with(@post) }
+    
+      it "should find the post by id" do
+        Post.should have_received(:find).with(@post.id)
+      end
+    end
+
+Note here that we only do a get once, and that we only have to specify the return value of @find once in the setup block.
+
+When I came on board the project I'm currently on (written by people who I want to think were pretty good at rspec), it was entirely in the style of the first example whenever mocking was used. This is a pretty simple case, but you could imagine it getting out of control if you are mocking more than just a single method. As a result, it took me a lot longer than it should have to fully understand what was going on, and it took longer to add more specs than it should have.
+
+After writing up the test spies, I've been rewriting the specs when I return to them to write them in the style of the second example, and it definitely feels a lot better.
+
+Lastly, I'd just want to make it clear that I'm not suggesting we stop using the first style. I just want the option of using test spies. The way this patch is written, I don't see it interfering with the existing style.
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Joshua Nichols. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :development)
+
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "moses-rspec-spies"
+  gem.summary = %Q{rspec has gone without test spies. no more!}
+  gem.version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  gem.description = %Q{test spies, for rspec (forked from technicalpickles/rspec-spies)}
+  gem.email = "moses@moseshohman.com"
+  gem.homepage = "http://github.com/moses/rspec-spies"
+  gem.authors = ["Joshua Nichols", "Moses Hohman"]
+  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+end
+Jeweler::GemcutterTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rspec-spies #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+3.0.0rc

data/lib/rspec-spies.rb

@@ -0,0 +1,50 @@
+require 'rspec/mocks/method_double'
+RSpec::Mocks::MethodDouble.class_eval do
+  # override defining stubs to record the message was called.
+  # there's only one line difference from upstream rspec, but can't change it without fully overriding
+  def define_proxy_method
+    method_name = @method_name
+    visibility_for_method = "#{visibility} :#{method_name}"
+    object_singleton_class.class_eval(<<-EOF, __FILE__, __LINE__)
+       def #{method_name}(*args, &block)
+         __mock_proxy.record_message_received :#{method_name}, *args, &block
+         __mock_proxy.message_received :#{method_name}, *args, &block
+       end
+    #{visibility_for_method}
+    EOF
+  end
+end
+
+require 'rspec/expectations'
+require 'rspec/matchers'
+RSpec::Matchers.define :have_received do |method_name, args, block|
+  match do |actual|
+    messages_received = actual.send(:__mock_proxy).instance_variable_get("@messages_received")
+    messages_received.any? do |message|
+      received_method_name, received_args, received_block = *message
+      result = (received_method_name == method_name)
+      result &&= RSpec::Mocks::ArgumentExpectation.new(@args || any_args).args_match?(received_args)
+      result &&= (received_block == block)
+    end
+  end
+
+  chain :with do |*args|
+    @args = args
+  end
+
+  failure_message_for_should do |actual|
+    "expected #{actual.inspect} to have received #{method_name.inspect}#{args_message}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected #{actual.inspect} to not have received #{method_name.inspect}#{args_message}, but did"
+  end
+
+  description do
+    "to have received #{method_name.inspect}#{args_message}"
+  end
+
+  def args_message
+    @args ? " with #{@args.inspect}" : ""
+  end
+end

data/moses-rspec-spies.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "moses-rspec-spies"
+  s.version = "3.0.0rc"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Nichols", "Moses Hohman"]
+  s.date = "2012-04-08"
+  s.description = "test spies, for rspec (forked from technicalpickles/rspec-spies)"
+  s.email = "moses@moseshohman.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rspec-spies.rb",
+    "moses-rspec-spies.gemspec",
+    "spec/rspec-spies_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/moses/rspec-spies"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "rspec has gone without test spies. no more!"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+  end
+end
+

data/spec/rspec-spies_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module Spec
+  module Matchers
+    describe "[object.should] have_received(method, *args)" do
+      before do
+        @object = String.new("HI!")
+      end
+
+      it "matches if method is called with correct args" do
+        @object.stub!(:slice)
+        @object.slice(5)
+
+        have_received(:slice).with(5).matches?(@object).should be_true
+      end
+
+      it "matches if doesn't specify args, even if method is called with args" do
+        @object.stub!(:slice)
+        @object.slice(5)
+
+        have_received(:slice).matches?(@object).should be_true
+      end
+
+      it "matches if specifies nil arg, if method is called with a nil arg" do
+        @object.stub!(:slice)
+        @object.slice(nil)
+
+        have_received(:slice).with(nil).matches?(@object).should be_true
+        have_received(:slice).matches?(@object).should be_true
+      end
+
+      it "does not match if method is called with incorrect args" do
+        @object.stub!(:slice)
+        @object.slice(3)
+
+        have_received(:slice).with(5).matches?(@object).should be_false
+      end
+
+      it "does not match if method is not called" do
+        @object.stub!(:slice)
+
+        have_received(:slice).with(5).matches?(@object).should be_false
+      end
+
+      it "correctly lists expects arguments for should" do
+        @object.stub!(:slice)
+
+        matcher  = have_received(:slice).with(5, 3)
+        messages = matcher.instance_variable_get("@messages")
+        message  = messages[:failure_message_for_should].call(@object)
+        message.should == "expected \"HI!\" to have received :slice with [5, 3]"
+      end
+
+      it "doesn't show nil for arguments in description" do
+        @object.stub!(:slice)
+
+        @object.slice(3)
+        matcher = have_received(:slice).with(3)
+        messages = matcher.instance_variable_get("@messages")
+        message = messages[:description].call(@object)
+        message.should_not include "nil"
+      end
+
+      it "correctly lists expects arguments for should_not" do
+        @object.stub!(:slice)
+
+        matcher  = have_received(:slice).with(1, 2)
+        messages = matcher.instance_variable_get("@messages")
+        message  = messages[:failure_message_for_should_not].call(@object)
+        message.should == "expected \"HI!\" to not have received :slice with [1, 2], but did"
+      end
+    end
+
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec'
+require 'rspec/autorun'
+
+require 'rspec-spies'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: moses-rspec-spies
+version: !ruby/object:Gem::Version 
+  prerelease: 5
+  version: 3.0.0rc
+platform: ruby
+authors: 
+- Joshua Nichols
+- Moses Hohman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: test spies, for rspec (forked from technicalpickles/rspec-spies)
+email: moses@moseshohman.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rspec-spies.rb
+- moses-rspec-spies.gemspec
+- spec/rspec-spies_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://github.com/moses/rspec-spies
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: rspec has gone without test spies. no more!
+test_files: []
+