verified_double 0.0.2 → 0.1.0

data/CHANGELOG.markdown

@@ -1,3 +1,11 @@
+0.1.0 - 2013-06-24
+------------------
+
+* [#3] Pass Scenario: Verifying mocks for accessors.
+* [#3] Pass Scenario: Verifying mocks for readers
+* [#5] Remove rspec-fire dependency.
+* [#5] Use VerifiedDouble to mock and stub doubles in own tests.
+
 0.0.2 - 2013-06-22
 ------------------
 

data/README.md

@@ -1,65 +1,37 @@
 # VerifiedDouble
 
-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.
+[![Build Status](https://travis-ci.org/gsmendoza/verified_double.png)](https://travis-ci.org/gsmendoza/verified_double)
 
-For example, let's say I mocked the save method of a model like so:
+VerifiedDouble verifies mocks made in the test suite by checking if there are tests against them.
+
+For example, let's say I mocked the created_at method of a model like this:
 
     item = VerifiedDouble.of_instance(Item)
-    item.should_receive(:save).and_return(true)
+    item.should_receive(:created_at).and_return(Time.now)
 
-Calling `VerifiedDouble.of_instance` would record the :save interaction on
-item. When running the tests, the gem would look for a test that
-confirms if you can indeed call #save on Item. The test should also
-ensure that the method indeed returns a boolean value. Since this is hard
-to automate, the gem would just look for a test with the tag saying it
-verifies that contract:
+The item double records its :created_at call. When
+running the tests, the gem looks for a test that confirms if you can
+indeed call #created_at on Item. The test should also ensure that the method
+returns a Time object. Since this is hard to automate, the gem just looks
+for a test with a tag saying it verifies that contract:
 
-    it "tests something", verifies_contract: 'Item#save => Boolean' do
+    it "tests something", verifies_contract: 'Item#created_at()=>Time' do
       #...
     end
 
-If this test does not exist, the gem would complain that the mock is not
+If this test does not exist, the gem will complain that the mock is not
 verified.
 
-This is an implementation of [contract tests](http://www.infoq.com/presentations/integration-tests-scam).
-Notes about the presentation [here](http://www.beletsky.net/2010/10/agileee-2010-j-b-rainsberger-integrated.html).
-
-There's already a gem that implements contract tests
-([bogus](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/contract-tests)).
-However, I think there's room for an alternative because:
-
-1. It's not clear from the Bogus [documentation](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/contract-tests/contract-tests-with-mocks)
-whether the gem verifies actual arguments/return values or just the types of those
-values. While the argument/return types are enough in most cases, sometimes
-the actual argument/return values are important. For example, if I mock
-Item.where(conditions), the actual conditions are important in
-verifying the validity of the where call.
-
-2. [By design](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/fakes/faking-existing-classes#fakes-have-null-object-semantics),
-a Bogus fake would return itself to all its methods. I prefer rspec-mock's
-approach of raising an error if a method is not declared as part of the
-double, since this raises errors earlier than later.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'verified_double'
-
-And then execute:
-
-    $ bundle
+More information at https://www.relishapp.com/gsmendoza/verified-double.
 
-Or install it yourself as:
+References
+----------
 
-    $ gem install verified_double
+1. http://www.confreaks.com/videos/2452-railsconf2013-the-magic-tricks-of-testing
+2. https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/contract-tests
+3. http://www.infoq.com/presentations/integration-tests-scam
 
-## Contributing
+Special thanks
+--------------
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+To @anathematic and [Inner Core Designs](http://icdesign.com.au) for sponsoring this gem :)

data/features/CHANGELOG.markdown

@@ -1,3 +1,11 @@
+0.1.0 - 2013-06-24
+------------------
+
+* [#3] Pass Scenario: Verifying mocks for accessors.
+* [#3] Pass Scenario: Verifying mocks for readers
+* [#5] Remove rspec-fire dependency.
+* [#5] Use VerifiedDouble to mock and stub doubles in own tests.
+
 0.0.2 - 2013-06-22
 ------------------
 

data/features/accessor_method_contracts.feature

@@ -0,0 +1,107 @@
+Feature: 05. Accessor method contracts
+  As a developer
+  I want it to easy to verify contracts for accessor methods
+
+  Background:
+    Given the following classes:
+      """
+      class ObjectUnderTest
+        def do_something(collaborator)
+          collaborator.value
+        end
+      end
+
+      class Collaborator
+        attr_accessor :value
+      end
+
+      class SomeValue
+      end
+      """
+
+    And the test suite includes VerifiedDouble to verify doubles with accessor methods:
+      """
+      require 'verified_double'
+      require 'main'
+
+      RSpec.configure do |config|
+        config.include VerifiedDouble::Matchers
+
+        config.after :suite do
+          VerifiedDouble.report_unverified_signatures(self)
+        end
+      end
+      """
+
+  Scenario: Verifying mocks for accessors
+    Given a test that uses VerifiedDouble to stub an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:value) { SomeValue.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator', value: value) }
+
+        it "tests something" do
+          ObjectUnderTest.new.do_something(instance_double)
+        end
+      end
+      """
+
+    And the test suite has a contract test for the stub:
+      """
+      require 'spec_helper'
+
+      describe Collaborator do
+        it { should verify_accessor_contract('Collaborator#value=>SomeValue') }
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified
+
+  Scenario: Verifying mocks for readers
+    Given the following classes:
+      """
+      class ObjectUnderTest
+        def do_something(collaborator)
+          collaborator.value
+        end
+      end
+
+      class Collaborator
+        attr_reader :value
+
+        def initialize(value)
+          @value = value
+        end
+      end
+
+      class SomeValue
+      end
+      """
+
+    And a test that uses VerifiedDouble to stub an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:value) { SomeValue.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator', value: value) }
+
+        it "tests something" do
+          ObjectUnderTest.new.do_something(instance_double)
+        end
+      end
+      """
+
+    And the test suite has a contract test for the stub:
+      """
+      require 'spec_helper'
+
+      describe Collaborator do
+        subject { described_class.new(SomeValue.new) }
+        it { should verify_reader_contract('Collaborator#value=>SomeValue') }
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified

data/features/customizing_arguments_and_return_values.feature

@@ -1,4 +1,4 @@
-Feature: Customizing arguments and return values
+Feature: 04. Customizing arguments and return values
   As a developer
   I want the ability to make contract arguments and return values more or less specific
 
@@ -24,7 +24,7 @@ Feature: Customizing arguments and return values
 
       RSpec.configure do |config|
         config.after :suite do
-          VerifiedDouble::ReportUnverifiedSignatures.new(VerifiedDouble.registry, self).execute
+          VerifiedDouble.report_unverified_signatures(self)
         end
       end
       """

data/features/readme.md

@@ -1,65 +1,37 @@
 # VerifiedDouble
 
-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.
+[![Build Status](https://travis-ci.org/gsmendoza/verified_double.png)](https://travis-ci.org/gsmendoza/verified_double)
 
-For example, let's say I mocked the save method of a model like so:
+VerifiedDouble verifies mocks made in the test suite by checking if there are tests against them.
+
+For example, let's say I mocked the created_at method of a model like this:
 
     item = VerifiedDouble.of_instance(Item)
-    item.should_receive(:save).and_return(true)
+    item.should_receive(:created_at).and_return(Time.now)
 
-Calling `VerifiedDouble.of_instance` would record the :save interaction on
-item. When running the tests, the gem would look for a test that
-confirms if you can indeed call #save on Item. The test should also
-ensure that the method indeed returns a boolean value. Since this is hard
-to automate, the gem would just look for a test with the tag saying it
-verifies that contract:
+The item double records its :created_at call. When
+running the tests, the gem looks for a test that confirms if you can
+indeed call #created_at on Item. The test should also ensure that the method
+returns a Time object. Since this is hard to automate, the gem just looks
+for a test with a tag saying it verifies that contract:
 
-    it "tests something", verifies_contract: 'Item#save => Boolean' do
+    it "tests something", verifies_contract: 'Item#created_at()=>Time' do
       #...
     end
 
-If this test does not exist, the gem would complain that the mock is not
+If this test does not exist, the gem will complain that the mock is not
 verified.
 
-This is an implementation of [contract tests](http://www.infoq.com/presentations/integration-tests-scam).
-Notes about the presentation [here](http://www.beletsky.net/2010/10/agileee-2010-j-b-rainsberger-integrated.html).
-
-There's already a gem that implements contract tests
-([bogus](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/contract-tests)).
-However, I think there's room for an alternative because:
-
-1. It's not clear from the Bogus [documentation](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/contract-tests/contract-tests-with-mocks)
-whether the gem verifies actual arguments/return values or just the types of those
-values. While the argument/return types are enough in most cases, sometimes
-the actual argument/return values are important. For example, if I mock
-Item.where(conditions), the actual conditions are important in
-verifying the validity of the where call.
-
-2. [By design](https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/fakes/faking-existing-classes#fakes-have-null-object-semantics),
-a Bogus fake would return itself to all its methods. I prefer rspec-mock's
-approach of raising an error if a method is not declared as part of the
-double, since this raises errors earlier than later.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'verified_double'
-
-And then execute:
-
-    $ bundle
+More information at https://www.relishapp.com/gsmendoza/verified-double.
 
-Or install it yourself as:
+References
+----------
 
-    $ gem install verified_double
+1. http://www.confreaks.com/videos/2452-railsconf2013-the-magic-tricks-of-testing
+2. https://www.relishapp.com/bogus/bogus/v/0-0-3/docs/contract-tests
+3. http://www.infoq.com/presentations/integration-tests-scam
 
-## Contributing
+Special thanks
+--------------
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+To @anathematic and [Inner Core Designs](http://icdesign.com.au) for sponsoring this gem :)

data/features/rspec_mock_compatibility.feature

@@ -0,0 +1,230 @@
+Feature: 03. Rspec Mock compatibility
+  As a developer
+  I want VerifiedDouble to work with Rspec Mock API
+
+  Background:
+    Given the following classes:
+      """
+      class ObjectUnderTest
+        def do_something(collaborator, input)
+          collaborator.some_method(input)
+        end
+
+        def do_something_twice(collaborator, input)
+          collaborator.some_method(input)
+          collaborator.some_method(input)
+        end
+      end
+
+      class Collaborator
+        def some_method(input)
+        end
+      end
+
+      class SomeError < Exception
+      end
+
+      class SomeInput
+      end
+
+      class SomeOutput
+      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
+      """
+
+    And the test suite has an after(:suite) callback asking VerifiedDouble to report unverified doubles:
+      """
+      require 'verified_double'
+      require 'main'
+
+      RSpec.configure do |config|
+        config.after :suite do
+          VerifiedDouble.report_unverified_signatures(self)
+        end
+      end
+      """
+
+  Scenario: once
+    Given a test that uses VerifiedDouble to mock an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator') }
+
+        it "tests something" do
+          instance_double.should_receive(:some_method).with(input).once.and_return(output)
+          ObjectUnderTest.new.do_something(instance_double, input)
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified
+
+  Scenario: twice
+    Given a test that uses VerifiedDouble to mock an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator') }
+
+        it "tests something" do
+          instance_double.should_receive(:some_method).with(input).twice.and_return(output)
+          ObjectUnderTest.new.do_something_twice(instance_double, input)
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified
+
+  Scenario: exactly
+    Given a test that uses VerifiedDouble to mock an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator') }
+
+        it "tests something" do
+          instance_double.should_receive(:some_method).with(input).exactly(1).and_return(output)
+          ObjectUnderTest.new.do_something(instance_double, input)
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified
+
+  Scenario: at_least
+    Given a test that uses VerifiedDouble to mock an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator') }
+
+        it "tests something" do
+          instance_double.should_receive(:some_method).with(input).at_least(:once).and_return(output)
+          ObjectUnderTest.new.do_something(instance_double, input)
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified
+
+  Scenario: at_most
+    Given a test that uses VerifiedDouble to mock an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator') }
+
+        it "tests something" do
+          instance_double.should_receive(:some_method).with(input).at_most(:once).and_return(output)
+          ObjectUnderTest.new.do_something(instance_double, input)
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified
+
+  Scenario: any_number_of_times
+    Given a test that uses VerifiedDouble to mock an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator') }
+
+        it "tests something" do
+          instance_double.should_receive(:some_method).with(input).any_number_of_times.and_return(output)
+          ObjectUnderTest.new.do_something(instance_double, input)
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified
+
+  Scenario: and_raise
+    Given a test that uses VerifiedDouble to mock an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:error) { SomeError.new }
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator') }
+
+        it "tests something" do
+          instance_double.should_receive(:some_method).with(input).and_raise(error)
+          expect { ObjectUnderTest.new.do_something(instance_double, input) }.to raise_error(error)
+        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)' do
+          # do nothing
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified
+  Scenario: and_throw
+    Given a test that uses VerifiedDouble to mock an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:error_symbol) { :error_symbol }
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator') }
+
+        it "tests something" do
+          instance_double.should_receive(:some_method).with(input).and_throw(error_symbol)
+          expect { ObjectUnderTest.new.do_something(instance_double, input) }.to throw_symbol(error_symbol)
+        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)' do
+          # do nothing
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified