rspec-spy 0.0.3 → 0.1.0

data/README.md

@@ -1,8 +1,9 @@
 # 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,
-which is effectively executed before everything else. Here's a simple example:
+with RSpec::Mocks. It does this by allowing you to declare examples with `:spy => true`
+or `:spy` (if you use `config.treat_symbols_as_metadata_keys_with_true_values = true`)
+so that they are effectively executed before everything else. Here's a simple example:
 
 ``` ruby
 describe "Example" do
@@ -12,14 +13,12 @@ describe "Example" do
     collaborator.message
   end
 
-  spy do
-    it "should receive a message" do
-      collaborator.should_receive :message
-    end
+  it "should receive a message", :spy => true do
+    collaborator.should_receive :message
+  end
 
-    it "should not receive other_message" do
-      collaborator.should_not_receive :other_message
-    end
+  it "should not receive other_message", :spy => true do
+    collaborator.should_not_receive :other_message
   end
 end
 ```
@@ -55,19 +54,18 @@ RSpec::Spy.strict_mode = true
 
 ## Usage
 
-Just put your spy expectations within `spy` blocks in your specs instead of in `before` blocks.
+Just tag your examples with `:spy => true` or `:spy` (if you use
+`config.treat_symbols_as_metadata_keys_with_true_values = true`)
 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
+it "should receive message", :spy => true do
+  collaborator.should_receive :message
 end
 
-# Shorthand:
-spy.it "should receive message" do
+# with config.treat_symbols_as_metadata_keys_with_true_values = true
+it "should receive message", :spy do
   collaborator.should_receive :message
 end
 ```
@@ -89,14 +87,12 @@ describe "what not to do" do
 
   # 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
+  it "should receive a message", :spy => true do
+    @collaborator.should_receive :message
+  end
+
+  it "should not receive other_message", :spy => true do
+    @collaborator.should_not_receive :other_message
   end
 end
 ```
@@ -121,10 +117,8 @@ describe "stubbing and mocking at the same time" do
     @result.should == 5
   end
 
-  spy do
-    it "should receive a message" do
-      collaborator.should_receive(:message).and_return(5)
-    end
+  it "should receive a message", :spy => true do
+    collaborator.should_receive(:message).and_return(5)
   end
 end
 ```

data/lib/rspec/spy/version.rb

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

data/lib/rspec/spy.rb

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

data/lib/rspec-spy.rb

@@ -1,11 +1,19 @@
 require 'rspec/spy/version'
 require 'rspec/spy'
 require 'rspec/spy/mock_methods'
-require 'rspec/spy/example_group_methods'
+
+RSpec::Core::Example.class_eval do
+  def run_spy
+    RSpec::Spy.in_run_spy = true
+    @example_group_instance.instance_eval &@example_block
+    RSpec::Spy.in_run_spy = false
+    @example_block = proc {}
+  end
+end
 
 RSpec.configure do |config|
-  config.before(:each) do |example|
-    example.spy_setup if example.respond_to? :spy_setup
+  config.before(:each, :spy => true) do |example|
+    example.example.run_spy
   end
 end
 

data/rspec-spy.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'rspec', '~> 2.0'
   gem.add_dependency 'rspec-mocks', '~> 2.0'
+
+  gem.add_development_dependency 'pry'
 end

data/spec/rspec_spy_spec.rb

@@ -16,24 +16,20 @@ describe RSpec::Spy do
     Subject.new.go(collaborator)
   end
 
-  spy do
-    it "should work with should_receive" do
-      collaborator.should_receive :message
-    end
+  it "should work with should_receive", :spy do
+    collaborator.should_receive :message
+  end
 
-    it "should work with multiple in one spy block" do
-      collaborator.should_receive :message
-    end
+  it "should work with multiple in one spy block", :spy do
+    collaborator.should_receive :message
+  end
 
-    it "should work with not" do
-      collaborator.should_not_receive :other_message
-    end
+  it "should work with not", :spy do
+    collaborator.should_not_receive :other_message
   end
 
-  spy do
-    specify "should work with specify" do
-      collaborator.should_receive :message
-    end
+  specify "should work with specify", :spy do
+    collaborator.should_receive :message
   end
 end
 
@@ -45,10 +41,8 @@ describe RSpec::Spy do
   end
 
   context do
-    spy do
-      it "should work in nested contexts" do
-        collaborator.should_receive :message
-      end
+    it "should work in nested contexts", :spy do
+      collaborator.should_receive :message
     end
   end
 end
@@ -75,25 +69,27 @@ describe RSpec::Spy, "should_receive outside of spy block" do
   end
 end
 
-describe RSpec::Spy, "shorthand" do
+describe RSpec::Spy, "setting on context" 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
+  context "spies", :spy do
+    it "should work" do
+      collaborator.should_receive :message
+    end
   end
 end
 
 describe RSpec::Spy, "nil warning" do
-  spy.it "should warn me if I try to should_receive on nil" do
+  it "should warn me if I try to should_receive on nil", :spy 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
+  it "should not warn me if I allow message expectations on nil", :spy do
     RSpec::Mocks::Proxy.allow_message_expectations_on_nil
     lambda { @unknown.should_not_receive :message }.should_not raise_error
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-spy
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-03 00:00:00.000000000 Z
+date: 2012-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70355483304080 !ruby/object:Gem::Requirement
+  requirement: &70191611940020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70355483304080
+  version_requirements: *70191611940020
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
-  requirement: &70355483303580 !ruby/object:Gem::Requirement
+  requirement: &70191611939520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,18 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70355483303580
+  version_requirements: *70191611939520
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70191611939140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70191611939140
 description: Enables AAA testing for rspec-mock
 email:
 - aaronjensen@gmail.com
@@ -48,9 +59,7 @@ files:
 - README.md
 - Rakefile
 - lib/rspec-spy.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
@@ -79,7 +88,7 @@ rubyforge_project:
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: rspec-spy-0.0.3
+summary: rspec-spy-0.1.0
 test_files:
 - spec/rspec_spy_spec.rb
 - spec/spec_helper.rb

data/lib/rspec/core/spy_proxy.rb

@@ -1,43 +0,0 @@
-# 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/example_group_methods.rb

@@ -1,20 +0,0 @@
-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
-