rspec-spy 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,28 @@
-# Rspec::Spy
+# RSpec::Spy
 
-TODO: Write a gem description
+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,
+which is effectively executed before everything else. Here's a simple example:
+
+``` ruby
+describe "Example" do
+  let(:collaborator) { stub.as_null_object }
+
+  before do
+    collaborator.message
+  end
+
+  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
+```
 
 ## Installation
 
@@ -18,7 +40,54 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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:
+
+``` ruby
+# Require should_receive and should_not_receive to be inside spy blocks
+# Use should_receive! and should_not_receive! outside spy blocks
+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.
+
+``` ruby
+spy do
+  it "should receive message" do
+    collaborator.should_receive :message
+  end
+end
+
+# Shorthand:
+spy.it "should receive message" do
+  collaborator.should_receive :message
+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.
+* 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.
+
+## Alternatives
+
+* [matahari](https://github.com/mortice/matahari)
+* [bourne](https://github.com/thoughtbot/bourne)
+* [rspec-spies](https://github.com/technicalpickles/rspec-spies)
 
 ## Contributing
 

data/lib/rspec-spy.rb

@@ -1,88 +1,11 @@
-require 'rspec-spy/version'
-
-require 'rspec/matchers'
-require 'rspec/mocks'
-
-RSpec::Mocks::Methods.class_eval do
-  def should_receive_with_spy_check(*args, &block)
-    should_receive!(*args, &block)
-  end
-
-  alias_method :should_receive!, :should_receive
-  alias_method :should_receive, :should_receive_with_spy_check
-
-  def should_not_receive_with_spy_check(*args, &block)
-    should_not_receive!(*args, &block)
+require 'rspec/spy/version'
+require 'rspec/spy'
+require 'rspec/spy/mock_methods'
+require 'rspec/spy/example_group_methods'
+
+RSpec.configure do |config|
+  config.before(:each) do |example|
+    example.spy_setup if example.respond_to? :spy_setup
   end
-
-  alias_method :should_not_receive!, :should_not_receive
-  alias_method :should_not_receive, :should_not_receive_with_spy_check
 end
 
-require 'rspec/core/hooks'
-module RSpec
-  module Spy
-    def self.included(mod)
-      mod.extend ExampleGroupMethods
-    end
-
-    class SpyProxy
-      def initialize(example_group)
-        @example_group = example_group
-      end
-
-      def example_method(method, description, *args, &block)
-        @example_group.context do
-          let(:__spy__, &block)
-
-          send(method, description, *args) do
-          end
-        end
-      end
-
-      [
-        :example,
-        :it,
-        :specify,
-        :focused,
-        :focus,
-        :pending,
-        :xexample,
-        :xit,
-        :xspecify
-      ].each do |name|
-        module_eval(<<-END_RUBY, __FILE__, __LINE__)
-          def #{name}(desc=nil, *args, &block)
-            example_method(:#{name}, desc, *args, &block)
-          end
-        END_RUBY
-      end
-    end
-
-    module ExampleGroupMethods
-      def spy(&block)
-        setup_spy_hook
-
-        proxy = SpyProxy.new(self)
-        proxy.instance_eval(&block)
-      end
-
-      private
-      def setup_spy_hook
-        return if @spy_hook_setup
-
-        let(:__spy__) {}
-        hook = RSpec::Core::Hooks::BeforeHook.new({}) do
-          __spy__
-        end
-
-        hooks[:before][:each].unshift hook
-        @spy_hook_setup = true
-      end
-    end
-  end
-end
-
-RSpec::Core::ExampleGroup.class_eval do
-  include RSpec::Spy
-end

data/lib/rspec/core/spy_proxy.rb

@@ -0,0 +1,43 @@
+# By putting this in lib/rspec/core it gets removed from the example file/line
+# search so it can find a matching line from the backtrace
+module RSpec
+  module Core
+    class SpyProxy
+      def initialize(example_group)
+        @example_group = example_group
+      end
+
+      def example_method(method, description, *args, &block)
+        @example_group.context do
+          let(:spy_setup) do
+            RSpec::Spy.in_spy_setup = true
+            instance_eval &block
+            RSpec::Spy.in_spy_setup = false
+          end
+
+          send(method, description, *args) do
+          end
+        end
+      end
+
+      [
+        :example,
+        :it,
+        :specify,
+        :focused,
+        :focus,
+        :pending,
+        :xexample,
+        :xit,
+        :xspecify
+      ].each do |name|
+        module_eval(<<-END_RUBY, __FILE__, __LINE__)
+          def #{name}(desc=nil, *args, &block)
+            example_method(:#{name}, desc, *args, &block)
+          end
+        END_RUBY
+      end
+    end
+  end
+end
+

data/lib/rspec/spy.rb

@@ -0,0 +1,16 @@
+module RSpec
+  module Spy
+    class << self
+      attr_accessor :in_spy_setup
+      attr_accessor :strict_mode
+      alias_method :in_spy_setup?, :in_spy_setup
+      alias_method :strict_mode?, :strict_mode
+
+      def ok_to_spy?
+        return true unless strict_mode?
+        in_spy_setup?
+      end
+    end
+  end
+end
+

data/lib/rspec/spy/example_group_methods.rb

@@ -0,0 +1,20 @@
+require 'rspec/core/spy_proxy'
+
+module RSpec
+  module Spy
+    module ExampleGroupMethods
+      def spy(&block)
+        proxy = RSpec::Core::SpyProxy.new(self)
+
+        if block
+          proxy.instance_eval(&block)
+        else
+          proxy
+        end
+      end
+    end
+  end
+end
+
+RSpec::Core::ExampleGroup.extend RSpec::Spy::ExampleGroupMethods
+

data/lib/rspec/spy/mock_methods.rb

@@ -0,0 +1,27 @@
+require 'rspec/mocks'
+
+RSpec::Mocks::Methods.class_eval do
+  def should_receive_with_spy_check(message, opts={}, &block)
+    spy_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)
+    __mock_proxy.add_negative_message_expectation(caller(1)[0], message.to_sym, &block)
+  end
+
+  alias_method :should_receive!, :should_receive
+  alias_method :should_receive, :should_receive_with_spy_check
+
+  alias_method :should_not_receive!, :should_not_receive
+  alias_method :should_not_receive, :should_not_receive_with_spy_check
+
+  private
+
+  def spy_check(method)
+    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
+end
+

data/lib/{rspec-spy → rspec/spy}/version.rb

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

data/rspec-spy.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/rspec-spy/version', __FILE__)
+require File.expand_path('../lib/rspec/spy/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Aaron Jensen"]

data/spec/rspec_spy_spec.rb

@@ -7,6 +7,8 @@ class Subject
   end
 end
 
+RSpec::Spy.strict_mode = true
+
 describe RSpec::Spy do
   let(:collaborator) { stub.as_null_object }
 
@@ -28,6 +30,20 @@ describe RSpec::Spy do
     end
   end
 
+  spy do
+    specify "should work with specify" do
+      collaborator.should_receive :message
+    end
+  end
+end
+
+describe RSpec::Spy do
+  let(:collaborator) { stub.as_null_object }
+
+  before do
+    Subject.new.go(collaborator)
+  end
+
   context do
     spy do
       it "should work in nested contexts" do
@@ -35,10 +51,38 @@ describe RSpec::Spy do
       end
     end
   end
+end
 
-  spy do
-    specify "should work with specify" do
-      collaborator.should_receive :message
-    end
+describe RSpec::Spy, "the old way" do
+  let(:collaborator) { stub.as_null_object }
+
+  before do
+    collaborator.should_receive! :message
+    collaborator.should_not_receive! :message2
+    Subject.new.go(collaborator)
+  end
+
+  it "should still work" do
+  end
+end
+
+describe RSpec::Spy, "should_receive outside of spy block" do
+  let(:collaborator) { stub.as_null_object }
+
+  it "should warn" do
+    lambda { collaborator.should_receive :message }.should raise_error
+    lambda { collaborator.should_not_receive :message }.should raise_error
+  end
+end
+
+describe RSpec::Spy, "shorthand" do
+  let(:collaborator) { stub.as_null_object }
+
+  before do
+    Subject.new.go(collaborator)
+  end
+
+  spy.it "should work in nested contexts" do
+    collaborator.should_receive :message
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-spy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70108880012800 !ruby/object:Gem::Requirement
+  requirement: &70351465973020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70108880012800
+  version_requirements: *70351465973020
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
-  requirement: &70108880012300 !ruby/object:Gem::Requirement
+  requirement: &70351465972520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70108880012300
+  version_requirements: *70351465972520
 description: Enables AAA testing for rspec-mock
 email:
 - aaronjensen@gmail.com
@@ -48,7 +48,11 @@ files:
 - README.md
 - Rakefile
 - lib/rspec-spy.rb
-- lib/rspec-spy/version.rb
+- lib/rspec/core/spy_proxy.rb
+- lib/rspec/spy.rb
+- lib/rspec/spy/example_group_methods.rb
+- lib/rspec/spy/mock_methods.rb
+- lib/rspec/spy/version.rb
 - rspec-spy.gemspec
 - spec/rspec_spy_spec.rb
 - spec/spec_helper.rb
@@ -75,7 +79,7 @@ rubyforge_project:
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: rspec-spy-0.0.1
+summary: rspec-spy-0.0.2
 test_files:
 - spec/rspec_spy_spec.rb
 - spec/spec_helper.rb