verified_double 0.4.3 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5009534213dea01c257cd3ae51146bc3b851074
+  data.tar.gz: 2fdb0e7501414b89f06ea63c886736b615a47604
+SHA512:
+  metadata.gz: 415c67746889f7cb267f8f792ec33c6dffd106b361c6bf72ecfca91a7f9625e2f8813c3ef0c9d5314ba1500dbf393f12bab591ae651641c0017ad662b867673f
+  data.tar.gz: 56740f7d553a0ee07f42dce4f6b7bc2844228046d5640c207421585a8f0effe8401f717b20358241822c20c7b3b781cb2a7484e79a919ccdeceaac621687d9af

data/.rubocop.yml

@@ -0,0 +1,67 @@
+# Refer to https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# for the default rubocop configuration.
+
+AllCops:
+  Excludes:
+    - db/schema.rb
+    - db/fixtures/development/cooking_methods.rb
+    - db/fixtures/development/food_categories.rb
+    - db/fixtures/development/kitcategories.rb
+    - db/fixtures/development/kitsubcats.rb
+    - db/fixtures/development/main_ingredients.rb
+    - db/fixtures/development/recipe_categories.rb
+    - db/fixtures/development/special_occasions.rb
+    - db/fixtures/development/states.rb
+  Includes:
+    - '*.rake'
+    - Capfile
+    - Gemfile
+    - Guardfile
+
+AlignHash:
+  Enabled: false
+
+AlignParameters:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+EmptyLines:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+FavorUnlessOverNegatedIf:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+LineLength:
+  Max: 89
+
+MethodLength:
+  Max: 30
+
+MethodCalledOnDoEndBlock:
+  Enabled: true
+
+RedundantReturn:
+  AllowMultipleReturnValues: true
+
+RedundantSelf:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false

data/CHANGELOG.markdown

@@ -1,3 +1,11 @@
+0.5.0 - 2013-12-24
+------------------
+
+* [#27] Implement describe "contract" feature.
+
+* [#22] Add VerifiedDouble.any_instance_of(klass). Warning: only works with
+  should_receive. Doesn't work with expect/allow syntax.
+
 0.4.3 - 2013-10-22
 ------------------
 

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$}) { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/README.md

@@ -2,58 +2,169 @@
 
 [![Build Status](https://travis-ci.org/gsmendoza/verified_double.png)](https://travis-ci.org/gsmendoza/verified_double)
 
-VerifiedDouble is a gem for verifying rspec mocks. The gem works similar to [rspec-fire](https://github.com/xaviershay/rspec-fire). However, instead of checking if the doubled classes respond to the methods, the gem looks for tests confirming if those mocks are valid.
+VerifiedDouble is a gem for verifying rspec mocks. The gem works similar to [rspec-fire](https://github.com/xaviershay/rspec-fire). However, instead of checking if a doubled class responds to the methods, the gem looks for tests confirming the signatures of the mocks.
 
-For example, let's say I mocked the created_at method of a model like this:
+For example, if I mock the created_at method of a model like this:
 
-    item = VerifiedDouble.of_instance(Item)
-    expect(item).to receive(:created_at).and_return(Time.now)
+```ruby
+item = VerifiedDouble.of_instance(Item)
+expect(item).to receive(:created_at).and_return(Time.now)
+```
 
-When running the tests, the gem looks for a "contract test" tagged with the method's signature. This test should ensure that calling #created_at on Item will return a Time object.
+When I run the tests, the gem will look for a "contract test" tagged with the method's signature. This test should ensure that calling `#created_at` on Item will return a Time object.
 
-    it "tests something", verifies_contract: 'Item#created_at()=>Time' do
+```ruby
+describe Item do
+  describe '#created_at()=>Time', verifies_contract: true do
+    it "tests something" do
       #...
     end
+  end
+end
+```
 
 If this test does not exist, the gem will complain that the mock is not verified.
 
 I got the idea from http://www.infoq.com/presentations/integration-tests-scam, an old (2009) talk that still has some fresh insights on dealing with API changes in your mocked tests.
 
-Usage
------
+## Setup
 
 Require `verified_double/rspec_configuration` in your spec_helper.rb to integrate VerifiedDouble with rspec. If you want verified_double to be run only as needed, create a separate verified_spec_helper.rb:
 
-    # spec/verified_spec_helper.rb
-    require 'spec_helper'
-    require 'verified_double/rspec_configuration'
+```
+# spec/verified_spec_helper.rb
+require 'spec_helper'
+require 'verified_double/rspec_configuration'
+```
 
 And require it when running rspec:
 
     rspec -r ./spec/verified_spec_helper.rb
 
-You can learn more about using the gem at https://www.relishapp.com/gsmendoza/verified-double.
+## Usage
 
-Actively tested against
------------------------
+Let's look again at the example above:
 
-* Ruby 1.9.3
-* RSpec 2.14
+```ruby
+item = VerifiedDouble.of_instance(Item)
+expect(item).to receive(:created_at).and_return(Time.now)
+```
+
+When you run this test, you'll see a warning saying that there's no test verifying the mock `Item#created_at()=>Time`:
+
+```
+The following mocks are not verified:
+
+1. Item#created_at()=>Time
+...
+
+```
+
+You can then tag the test for `Item#created_at()=>Time` with the method signature:
+
+```ruby
+describe Item do
+  describe '#created_at()=>Time', verifies_contract: true do
+    it "tests something" do
+      #...
+    end
+  end
+end
+```
+
+Take note that:
+
+1. The described class must be a class, not a string.
+2. The described method must start with `#` if its an instance method and `.` if it's a class method.
+3. You need to add the add the `verifies_contract: true` tag to the test.
+
+If your testing style doesn't follow these conventions, you can tag the test with the whole method signature:
+
+```ruby
+describe 'Item' do
+  it "has a creation timestamp", verifies_contract: `Item#created_at()=>Time` do
+    #...
+  end
+end
+```
+
+Since VerifiedDouble relies on tags to link mocks and contracts together, you'll
+need to run the tests containing the contracts along with tests with the mocks in
+order to clear the VerifiedDouble warnings.
+
+## Booleans
+
+Since Ruby doesn't have Boolean class covering both `TrueClass` and `FalseClass`,
+VerifiedDouble supplies its own `VerifiedDouble::Boolean` class. Thus if your method
+accepts or returns a boolean value, you'll see `VerifiedDouble::Boolean` in its
+method signature e.g. `Student.late?()=>VerifiedDouble::Boolean`.
 
+## Helpers
 
-Alternatives
-------------
+Most of the time, you'll be mocking accessor methods. VerifiedDouble provides some
+helpers to make them easy to verify.
 
-[Bogus](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/) is the first gem to implement contract tests. It doesn't rely on rspec tags to verify contracts, so it's probably a lot smarter than VerifiedDouble :) However, I wasn't able to try it out on my own projects because of its own rr-like mock adapter. But do check it out!
+For reader methods, there's the `verify_reader_contract` matcher. The matcher checks
+if the method will return an object matching the class specified by the contract:
 
-Caveats
--------
+```ruby
+class Collaborator
+  attr_reader :value
+
+  def initialize(value)
+    @value = value
+  end
+end
+
+class SomeValue
+end
+
+describe Collaborator do
+  subject { described_class.new(SomeValue.new) }
+  it { should verify_reader_contract('Collaborator#value=>SomeValue') }
+end
+```
+
+For accessor methods, there's the `verify_accessor_contract` matcher. The matcher
+instantiates the return class and tries to pass and retrieve the value
+to the method:
+
+```ruby
+class Collaborator
+  attr_accessor :value
+end
+
+describe Collaborator do
+  it { should verify_accessor_contract('Collaborator#value=>SomeValue') }
+end
+```
+
+## Any Instance mocks
+
+Aside for instance and class doubles, VerifiedDouble also supports `any_instance` mocks:
+
+```
+VerifiedDouble.any_instance_of(Collaborator)
+  .should_receive(:some_method).with(input).and_return(output)
+```
+
+You'll need to use should_receive for `any_instance` mocks. I still have to figure
+out how to make it work with RSpec's `expect_any_instance_of` syntax :p
+
+## Complete documentation
+
+You can learn more about using the gem at https://www.relishapp.com/gsmendoza/verified-double.
+
+## Actively tested against
+
+* Ruby 2.0
+* RSpec 2.14
 
-* With 0.3.0, doubles created with VerifiedDouble.of_instance() and VerifiedDouble.of_class() are now VerifiedDouble-extended RSpec doubles. As a result, they should function like regular RSpec doubles. However, VerifiedDouble still doesn't have support for [RSpec mock argument matchers](https://github.com/rspec/rspec-mocks#argument-matchers). Please post an issue at http://github.com/gsmendoza/verified_double if you need support for any particular rspec-mock API.
+## Alternatives
 
-* The [method documentation](http://rubydoc.info/gems/verified_double) is pretty empty at this point :p I'm planning to use yard-spec to document the methods but that gem doesn't support rspec context blocks. I'll try to work on that soon.
+[Bogus](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/) is the first gem I know to implement contract tests. It doesn't rely on rspec tags to verify contracts, so it's probably a lot smarter than VerifiedDouble :) However, I wasn't able to try it out on my own projects because of its own rr-like mock adapter. But do check it out!
 
-Special thanks
---------------
+## Special thanks
 
-To [Thomas Sinclair](https://twitter.com/anathematic) of [Inner Core Designs](http://icdesign.com.au) for initially sponsoring this gem.
+* [Inner Core Designs](http://icdesign.com.au)
+* [Love With Food](https://lovewithfood.com)

data/features/CHANGELOG.markdown

@@ -1,3 +1,11 @@
+0.5.0 - 2013-12-24
+------------------
+
+* [#27] Implement describe "contract" feature.
+
+* [#22] Add VerifiedDouble.any_instance_of(klass). Warning: only works with
+  should_receive. Doesn't work with expect/allow syntax.
+
 0.4.3 - 2013-10-22
 ------------------
 

data/features/accessor_method_contracts.feature

@@ -1,4 +1,4 @@
-Feature: 05. Accessor method contracts
+Feature: 40. Accessor method contracts
   As a developer
   I want it to easy to verify contracts for accessor methods
 

data/features/any_instance.feature

@@ -0,0 +1,95 @@
+Feature: 60. Any instance
+
+  Background:
+    Given the following classes:
+      """
+      class ObjectUnderTest
+        def do_something(collaborator, input)
+          collaborator.some_method(input)
+        end
+
+        def self.do_something(input)
+          Collaborator.some_method(input)
+        end
+      end
+
+      class Collaborator
+        def self.some_method(input)
+        end
+
+        def some_method(input)
+        end
+      end
+
+      class SomeInput
+      end
+
+      class SomeOutput
+      end
+      """
+
+    And the test suite is configured to use VerifiedDouble:
+      """
+      require 'verified_double'
+      require 'verified_double/rspec_configuration'
+      require 'main'
+      """
+
+  Scenario: Verify any instance of a class
+
+    Given a test that uses VerifiedDouble to mock any instance of the class:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+
+        it "tests something" do
+          VerifiedDouble.any_instance_of(Collaborator)
+            .should_receive(:some_method).with(input).and_return(output)
+
+          ObjectUnderTest.new.do_something(Collaborator.new, input)
+        end
+      end
+      """
+
+    And the test suite has a contract test for the mock:
+      """
+      require 'spec_helper'
+
+      describe 'Collaborator' do
+        it "tests something",
+          verifies_contract: 'Collaborator#some_method(SomeInput)=>SomeOutput' do
+          # do nothing
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the mock is unverified
+
+  Scenario: Unverified any_instance mock
+    Given a test that uses VerifiedDouble to mock any instance of the class:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+
+        it "tests something" do
+          VerifiedDouble.any_instance_of(Collaborator)
+            .should_receive(:some_method).with(input).and_return(output)
+
+          ObjectUnderTest.new.do_something(Collaborator.new, input)
+        end
+      end
+      """
+
+    And the test suite does not have a contract test for the mock
+    When I run the test suite
+    Then I should be informed that the mock is unverified:
+      """
+      The following mocks are not verified:
+
+      1. Collaborator#some_method(SomeInput)=>SomeOutput
+      """

data/features/customizing_arguments_and_return_values.feature

@@ -1,4 +1,4 @@
-Feature: 04. Customizing arguments and return values
+Feature: 50. Customizing arguments and return values
   As a developer
   I want the ability to make contract arguments and return values more or less specific
 

data/features/describe_contract.feature

@@ -0,0 +1,67 @@
+Feature: 30. Describe contract
+  Scenario: Specify contact in describe string
+    Given the following classes:
+
+      """
+      class ObjectUnderTest
+        def do_something(collaborator, input)
+          collaborator.some_method(input)
+        end
+      end
+
+      class Collaborator
+        def some_method(input)
+        end
+      end
+
+      class SomeInput
+      end
+
+      class SomeOutput
+      end
+      """
+
+    And the test suite is configured to use VerifiedDouble:
+
+      """
+      require 'verified_double'
+      require 'verified_double/rspec_configuration'
+      require 'main'
+      """
+
+    And a test that uses VerifiedDouble to mock an object:
+
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:collaborator) { VerifiedDouble.of_instance('Collaborator') }
+
+        it "tests something" do
+          expect(collaborator)
+            .to receive(:some_method).with(input).and_return(output)
+
+          ObjectUnderTest.new.do_something(collaborator, input)
+        end
+      end
+      """
+
+    And the test suite has a contract test for the mock:
+
+      """
+      require 'spec_helper'
+
+      describe Collaborator do
+        context 'with some context' do
+          describe '#some_method(SomeInput)=>SomeOutput', verifies_contract: true do
+            it "tests something" do
+              # do nothing
+            end
+          end
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the mock is unverified

data/features/readme.md

@@ -2,58 +2,169 @@
 
 [![Build Status](https://travis-ci.org/gsmendoza/verified_double.png)](https://travis-ci.org/gsmendoza/verified_double)
 
-VerifiedDouble is a gem for verifying rspec mocks. The gem works similar to [rspec-fire](https://github.com/xaviershay/rspec-fire). However, instead of checking if the doubled classes respond to the methods, the gem looks for tests confirming if those mocks are valid.
+VerifiedDouble is a gem for verifying rspec mocks. The gem works similar to [rspec-fire](https://github.com/xaviershay/rspec-fire). However, instead of checking if a doubled class responds to the methods, the gem looks for tests confirming the signatures of the mocks.
 
-For example, let's say I mocked the created_at method of a model like this:
+For example, if I mock the created_at method of a model like this:
 
-    item = VerifiedDouble.of_instance(Item)
-    expect(item).to receive(:created_at).and_return(Time.now)
+```ruby
+item = VerifiedDouble.of_instance(Item)
+expect(item).to receive(:created_at).and_return(Time.now)
+```
 
-When running the tests, the gem looks for a "contract test" tagged with the method's signature. This test should ensure that calling #created_at on Item will return a Time object.
+When I run the tests, the gem will look for a "contract test" tagged with the method's signature. This test should ensure that calling `#created_at` on Item will return a Time object.
 
-    it "tests something", verifies_contract: 'Item#created_at()=>Time' do
+```ruby
+describe Item do
+  describe '#created_at()=>Time', verifies_contract: true do
+    it "tests something" do
       #...
     end
+  end
+end
+```
 
 If this test does not exist, the gem will complain that the mock is not verified.
 
 I got the idea from http://www.infoq.com/presentations/integration-tests-scam, an old (2009) talk that still has some fresh insights on dealing with API changes in your mocked tests.
 
-Usage
------
+## Setup
 
 Require `verified_double/rspec_configuration` in your spec_helper.rb to integrate VerifiedDouble with rspec. If you want verified_double to be run only as needed, create a separate verified_spec_helper.rb:
 
-    # spec/verified_spec_helper.rb
-    require 'spec_helper'
-    require 'verified_double/rspec_configuration'
+```
+# spec/verified_spec_helper.rb
+require 'spec_helper'
+require 'verified_double/rspec_configuration'
+```
 
 And require it when running rspec:
 
     rspec -r ./spec/verified_spec_helper.rb
 
-You can learn more about using the gem at https://www.relishapp.com/gsmendoza/verified-double.
+## Usage
 
-Actively tested against
------------------------
+Let's look again at the example above:
 
-* Ruby 1.9.3
-* RSpec 2.14
+```ruby
+item = VerifiedDouble.of_instance(Item)
+expect(item).to receive(:created_at).and_return(Time.now)
+```
+
+When you run this test, you'll see a warning saying that there's no test verifying the mock `Item#created_at()=>Time`:
+
+```
+The following mocks are not verified:
+
+1. Item#created_at()=>Time
+...
+
+```
+
+You can then tag the test for `Item#created_at()=>Time` with the method signature:
+
+```ruby
+describe Item do
+  describe '#created_at()=>Time', verifies_contract: true do
+    it "tests something" do
+      #...
+    end
+  end
+end
+```
+
+Take note that:
+
+1. The described class must be a class, not a string.
+2. The described method must start with `#` if its an instance method and `.` if it's a class method.
+3. You need to add the add the `verifies_contract: true` tag to the test.
+
+If your testing style doesn't follow these conventions, you can tag the test with the whole method signature:
+
+```ruby
+describe 'Item' do
+  it "has a creation timestamp", verifies_contract: `Item#created_at()=>Time` do
+    #...
+  end
+end
+```
+
+Since VerifiedDouble relies on tags to link mocks and contracts together, you'll
+need to run the tests containing the contracts along with tests with the mocks in
+order to clear the VerifiedDouble warnings.
+
+## Booleans
+
+Since Ruby doesn't have Boolean class covering both `TrueClass` and `FalseClass`,
+VerifiedDouble supplies its own `VerifiedDouble::Boolean` class. Thus if your method
+accepts or returns a boolean value, you'll see `VerifiedDouble::Boolean` in its
+method signature e.g. `Student.late?()=>VerifiedDouble::Boolean`.
 
+## Helpers
 
-Alternatives
-------------
+Most of the time, you'll be mocking accessor methods. VerifiedDouble provides some
+helpers to make them easy to verify.
 
-[Bogus](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/) is the first gem to implement contract tests. It doesn't rely on rspec tags to verify contracts, so it's probably a lot smarter than VerifiedDouble :) However, I wasn't able to try it out on my own projects because of its own rr-like mock adapter. But do check it out!
+For reader methods, there's the `verify_reader_contract` matcher. The matcher checks
+if the method will return an object matching the class specified by the contract:
 
-Caveats
--------
+```ruby
+class Collaborator
+  attr_reader :value
+
+  def initialize(value)
+    @value = value
+  end
+end
+
+class SomeValue
+end
+
+describe Collaborator do
+  subject { described_class.new(SomeValue.new) }
+  it { should verify_reader_contract('Collaborator#value=>SomeValue') }
+end
+```
+
+For accessor methods, there's the `verify_accessor_contract` matcher. The matcher
+instantiates the return class and tries to pass and retrieve the value
+to the method:
+
+```ruby
+class Collaborator
+  attr_accessor :value
+end
+
+describe Collaborator do
+  it { should verify_accessor_contract('Collaborator#value=>SomeValue') }
+end
+```
+
+## Any Instance mocks
+
+Aside for instance and class doubles, VerifiedDouble also supports `any_instance` mocks:
+
+```
+VerifiedDouble.any_instance_of(Collaborator)
+  .should_receive(:some_method).with(input).and_return(output)
+```
+
+You'll need to use should_receive for `any_instance` mocks. I still have to figure
+out how to make it work with RSpec's `expect_any_instance_of` syntax :p
+
+## Complete documentation
+
+You can learn more about using the gem at https://www.relishapp.com/gsmendoza/verified-double.
+
+## Actively tested against
+
+* Ruby 2.0
+* RSpec 2.14
 
-* With 0.3.0, doubles created with VerifiedDouble.of_instance() and VerifiedDouble.of_class() are now VerifiedDouble-extended RSpec doubles. As a result, they should function like regular RSpec doubles. However, VerifiedDouble still doesn't have support for [RSpec mock argument matchers](https://github.com/rspec/rspec-mocks#argument-matchers). Please post an issue at http://github.com/gsmendoza/verified_double if you need support for any particular rspec-mock API.
+## Alternatives
 
-* The [method documentation](http://rubydoc.info/gems/verified_double) is pretty empty at this point :p I'm planning to use yard-spec to document the methods but that gem doesn't support rspec context blocks. I'll try to work on that soon.
+[Bogus](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/) is the first gem I know to implement contract tests. It doesn't rely on rspec tags to verify contracts, so it's probably a lot smarter than VerifiedDouble :) However, I wasn't able to try it out on my own projects because of its own rr-like mock adapter. But do check it out!
 
-Special thanks
---------------
+## Special thanks
 
-To [Thomas Sinclair](https://twitter.com/anathematic) of [Inner Core Designs](http://icdesign.com.au) for initially sponsoring this gem.
+* [Inner Core Designs](http://icdesign.com.au)
+* [Love With Food](https://lovewithfood.com)

data/features/rspec_mock_compatibility.feature

@@ -1,4 +1,4 @@
-Feature: 03. Rspec Mock compatibility
+Feature: 70. Rspec Mock compatibility
   As a developer
   I want VerifiedDouble to work with Rspec Mock API
 

data/features/step_definitions/verified_double_steps.rb

@@ -6,6 +6,10 @@ Given /^a test that uses VerifiedDouble to mock an object:$/ do |string|
   write_file 'spec/main_spec.rb', string
 end
 
+Given(/^a test that uses VerifiedDouble to mock any instance of the class:$/) do |string|
+  write_file 'spec/main_spec.rb', string
+end
+
 Given /^a test that uses VerifiedDouble to stub an object:$/ do |string|
   write_file 'spec/main_spec.rb', string
 end

data/features/verified_mocks.feature

@@ -1,4 +1,4 @@
-Feature: 01. Verified mocks
+Feature: 10. Verified mocks
   As a developer
   I want to be informed if the mocks I use are verified by contract tests
 
@@ -206,3 +206,4 @@ Feature: 01. Verified mocks
 
       1. Collaborator.some_method(SomeInput)=>SomeOutput
       """
+

data/features/verified_stubs.feature

@@ -1,4 +1,4 @@
-Feature: 02. Verified stubs
+Feature: 20. Verified stubs
   As a developer
   I want to be informed if the stubs I use are verified by contract tests
 

data/lib/verified_double.rb

@@ -3,6 +3,7 @@ require 'rspec/mocks'
 
 require 'verified_double/boolean'
 require 'verified_double/can_record_interactions'
+require 'verified_double/example_metadata'
 require 'verified_double/is_a_class_double'
 require 'verified_double/is_an_instance_double'
 require 'verified_double/matchers'
@@ -23,6 +24,12 @@ require 'verified_double/stack_frame'
 module VerifiedDouble
   extend RSpec::Mocks::ExampleMethods
 
+  def self.any_instance_of(klass)
+    d = klass.any_instance
+    d.extend(VerifiedDouble::IsAnInstanceDouble)
+    VerifiedDouble.record(d)
+  end
+
   def self.of_class(class_value, options = {})
     options[:transfer_nested_constants] = true if options[:transfer_nested_constants].nil?
     d = stub_const(class_value.to_s, Class.new, options)

data/lib/verified_double/example_metadata.rb

@@ -0,0 +1,31 @@
+module VerifiedDouble
+  class ExampleMetadata < Struct.new(:metadata)
+    def described_class
+      if description.is_a?(Module)
+        description
+      elsif description.is_a?(String)
+        ExampleMetadata.new(metadata[:example_group]).described_class
+      else
+        raise
+      end
+    end
+
+    def description
+      metadata[:description_args][0]
+    end
+
+    def method_signature_string
+      if description =~ /^[\.\#]/
+        description
+      elsif description.nil?
+        raise
+      else
+        ExampleMetadata.new(metadata[:example_group]).method_signature_string
+      end
+    end
+
+    def verified_signature
+      "#{described_class}#{method_signature_string}"
+    end
+  end
+end

data/lib/verified_double/method_signatures_report.rb

@@ -49,13 +49,23 @@ module VerifiedDouble
     end
 
     def set_verified_signatures_from_tags(nested_example_group)
-      @verified_signatures_from_tags = nested_example_group
+      examples = nested_example_group
         .class
         .descendant_filtered_examples
-        .map{|example| example.metadata[:verifies_contract] }
+
+      verified_signatures = examples.map do |example|
+        if example.metadata[:verifies_contract] == true
+          ExampleMetadata.new(example.metadata).verified_signature
+        else
+          example.metadata[:verifies_contract]
+        end
+      end
+
+      @verified_signatures_from_tags = verified_signatures
         .compact
         .uniq
         .map{|method_signature_string| ParseMethodSignature.new(method_signature_string).execute }
+
       self
     end
   end

data/lib/verified_double/rspec_mocks_syntax_overrides.rb

@@ -11,7 +11,14 @@ module VerifiedDouble
 
     def expect(*args)
       if args[0].respond_to?(:can_record_interactions?)
-        VerifiedDouble.registry.current_double = args[0]
+        if args[0].is_a?(RSpec::Mocks::AnyInstance::Recorder)
+          raise "VerifiedDouble.any_instance_of doesn't support yet Rspec's " \
+            "expect/allow syntax. Please use should_receive."
+        else
+          VerifiedDouble.registry.current_double = args[0]
+        end
+
+
       else
         VerifiedDouble.registry.current_double = nil
       end

data/lib/verified_double/simple_double.rb

@@ -15,13 +15,29 @@ module VerifiedDouble
 
 
     def class_name
-      class_double? ? internal.name : internal.instance_variable_get('@name').to_s
+      if class_double?
+        internal.name
+      elsif instance_double?
+        internal.instance_variable_get('@name').to_s
+      elsif any_instance_double?
+        internal.instance_variable_get('@klass').to_s
+      else
+        raise
+      end
+    end
+
+    def any_instance_double?
+      !! internal.instance_variable_get('@klass')
     end
 
     def class_double?
       internal.respond_to?(:verified_class_double?)
     end
 
+    def instance_double?
+      !! internal.instance_variable_get('@name')
+    end
+
     def method_operator
       class_double? ? '.' : '#'
     end

data/lib/verified_double/version.rb

@@ -1,3 +1,3 @@
 module VerifiedDouble
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/spec/verified_double/example_metadata_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe VerifiedDouble::ExampleMetadata do
+  let(:klass) { Object }
+  let(:method_signature_string) { '#to_s()=>String' }
+  let(:metadata) do
+    {
+      description_args: ['is a string representing the object'],
+      example_group: {
+        description_args: [method_signature_string],
+
+        example_group: {
+          description_args: ['with some context'],
+
+          example_group: {
+            description_args: [klass]
+          }
+        }
+      }
+    }
+  end
+
+  subject { described_class.new(metadata) }
+
+  describe '#verified_signature' do
+    it 'is the class_name and method_signature_string' do
+      expect(subject.verified_signature).to eq("#{klass}#{method_signature_string}")
+    end
+  end
+
+  describe '#described_class' do
+    it "is the described class of the metadata's test source" do
+      expect(subject.described_class).to eq(klass)
+    end
+
+    context "where the described class is a string" do
+      let(:metadata) do
+        {
+          example_group: {
+            description_args: [klass.to_s]
+          }
+        }
+      end
+
+      it "should raise an error" do
+        expect(-> { subject.described_class }).to raise_error
+      end
+    end
+  end
+
+  describe '#method_signature_string' do
+    it "is the signature of the method being tested" do
+      expect(subject.method_signature_string).to eq(method_signature_string)
+    end
+
+    context "where there is no description arg that looks like a method signature" do
+      let(:metadata) do
+        {
+          example_group: {
+            description_args: [klass.to_s]
+          }
+        }
+      end
+
+      it "should raise an error" do
+        expect(-> { subject.method_signature_string }).to raise_error
+      end
+    end
+  end
+end
+

data/spec/verified_double/rspec_mocks_syntax_overrides_spec.rb

@@ -15,6 +15,15 @@ describe VerifiedDouble::RSpecMocksSyntaxOverrides do
       end
     end
 
+    context "where the double arg is an RSpec::Mocks::AnyInstance::Recorder" do
+      let(:a_double) { VerifiedDouble.of_instance('Object') }
+
+      it "should tell the user to use should_receive instead" do
+        expect(lambda { expect(VerifiedDouble.any_instance_of(Object)) })
+          .to raise_error
+      end
+    end
+
     context "where the double arg does not record VerifiedDouble interactions" do
       let(:a_double) { double('Object') }
 
@@ -76,4 +85,4 @@ describe VerifiedDouble::RSpecMocksSyntaxOverrides do
       end
     end
   end
-end
+end

data/verified_double.gemspec

@@ -22,5 +22,9 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "aruba"
   gem.add_development_dependency "cucumber"
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-cucumber"
+  gem.add_development_dependency "guard-rspec"
   gem.add_development_dependency "pry"
+  gem.add_development_dependency "rubocop"
 end

metadata

@@ -1,96 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: verified_double
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - George Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :runtime
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: activesupport
 - !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rspec
 - !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: aruba
 - !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: cucumber
 - !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: pry
 description: Contract tests for rspec
 email:
 - gsmendoza@gmail.com
@@ -99,15 +144,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
 - .travis.yml
 - CHANGELOG.markdown
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - features/CHANGELOG.markdown
 - features/accessor_method_contracts.feature
+- features/any_instance.feature
 - features/customizing_arguments_and_return_values.feature
+- features/describe_contract.feature
 - features/readme.md
 - features/rspec_mock_compatibility.feature
 - features/step_definitions/verified_double_steps.rb
@@ -117,6 +166,7 @@ files:
 - lib/verified_double.rb
 - lib/verified_double/boolean.rb
 - lib/verified_double/can_record_interactions.rb
+- lib/verified_double/example_metadata.rb
 - lib/verified_double/is_a_class_double.rb
 - lib/verified_double/is_an_instance_double.rb
 - lib/verified_double/matchers.rb
@@ -138,6 +188,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb
 - spec/verified_double/can_record_interactions_spec.rb
+- spec/verified_double/example_metadata_spec.rb
 - spec/verified_double/matchers_spec.rb
 - spec/verified_double/method_signature/boolean_value_spec.rb
 - spec/verified_double/method_signature/class_value_spec.rb
@@ -156,33 +207,34 @@ files:
 - verified_double.gemspec
 homepage: https://www.relishapp.com/gsmendoza/verified-double
 licenses: []
+metadata: {}
 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: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: VerifiedDouble would record any mock made in the test suite. It would then
   verify if the mock is valid by checking if there is a test against it.
 test_files:
 - features/CHANGELOG.markdown
 - features/accessor_method_contracts.feature
+- features/any_instance.feature
 - features/customizing_arguments_and_return_values.feature
+- features/describe_contract.feature
 - features/readme.md
 - features/rspec_mock_compatibility.feature
 - features/step_definitions/verified_double_steps.rb
@@ -192,6 +244,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb
 - spec/verified_double/can_record_interactions_spec.rb
+- spec/verified_double/example_metadata_spec.rb
 - spec/verified_double/matchers_spec.rb
 - spec/verified_double/method_signature/boolean_value_spec.rb
 - spec/verified_double/method_signature/class_value_spec.rb
@@ -207,4 +260,3 @@ test_files:
 - spec/verified_double/simple_double_spec.rb
 - spec/verified_double/stack_frame_spec.rb
 - spec/verified_double_spec.rb
-has_rdoc: