verified_double 0.0.2 → 0.1.0

data/features/step_definitions/verified_double_steps.rb

@@ -2,6 +2,10 @@ Given /^the following classes:$/ do |string|
   write_file 'lib/main.rb', string
 end
 
+Given /^the test suite includes VerifiedDouble to verify doubles with accessor methods:$/ do |string|
+  write_file 'spec/spec_helper.rb', string
+end
+
 Given /^the test suite has an after\(:suite\) callback asking VerifiedDouble to report unverified doubles:$/ do |string|
   write_file 'spec/spec_helper.rb', string
 end
@@ -10,6 +14,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 stub an object:$/ do |string|
+  write_file 'spec/main_spec.rb', string
+end
+
 Given /^a test that uses VerifiedDouble to mock a class:$/ do |string|
   write_file 'spec/main_spec.rb', string
 end
@@ -18,6 +26,10 @@ Given /^the test suite has a contract test for the mock:$/ do |string|
   write_file 'spec/contract_test_for_main_spec.rb', string
 end
 
+Given /^the test suite has a contract test for the stub:$/ do |string|
+  write_file 'spec/contract_test_for_main_spec.rb', string
+end
+
 Given /^the test suite does not have a contract test for the mock$/ do
   # do nothing
 end
@@ -35,3 +47,8 @@ Then /^I should not see any output saying the mock is unverified$/ do
   assert_no_partial_output("The following mocks are not verified", all_output)
   assert_success('pass')
 end
+
+Then /^I should not see any output saying the stub is unverified$/ do
+  assert_no_partial_output("The following mocks are not verified", all_output)
+  assert_success('pass')
+end

data/features/{verified_double.feature → verified_mocks.feature}

@@ -1,4 +1,4 @@
-Feature: Verified double
+Feature: 01. Verified mocks
   As a developer
   I want to be informed if the mocks I use are verified by contract tests
 
@@ -10,8 +10,8 @@ Feature: Verified double
           collaborator.some_method(input)
         end
 
-        def self.do_something(collaborator, input)
-          collaborator.some_method(input)
+        def self.do_something(input)
+          Collaborator.some_method(input)
         end
       end
 
@@ -32,13 +32,12 @@ Feature: Verified double
 
     And the test suite has an after(:suite) callback asking VerifiedDouble to report unverified doubles:
       """
-      require 'pry'
       require 'verified_double'
       require 'main'
 
       RSpec.configure do |config|
         config.after :suite do
-          VerifiedDouble::ReportUnverifiedSignatures.new(VerifiedDouble.registry, self).execute
+          VerifiedDouble.report_unverified_signatures(self)
         end
       end
       """
@@ -108,7 +107,7 @@ Feature: Verified double
 
         it "tests something" do
           class_double.should_receive(:some_method).with(input).and_return(output)
-          ObjectUnderTest.new.do_something(class_double, input)
+          ObjectUnderTest.do_something(input)
         end
       end
       """

data/features/verified_stubs.feature

@@ -0,0 +1,94 @@
+Feature: 02. Verified stubs
+  As a developer
+  I want to be informed if the stubs I use are verified by contract tests
+
+  Background:
+    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 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: Stubbed doubles
+    Given a test that uses VerifiedDouble to stub 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.stub(:some_method).with(input).and_return(output)
+          ObjectUnderTest.new.do_something(instance_double, input)
+        end
+      end
+      """
+
+    And the test suite has a contract test for the stub:
+      """
+      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 stub is unverified
+
+  Scenario: Stubbed doubles using hash syntax
+    Given a test that uses VerifiedDouble to stub an object:
+      """
+      require 'spec_helper'
+      describe ObjectUnderTest do
+        let(:input) { SomeInput.new }
+        let(:output) { SomeOutput.new }
+        let(:instance_double) { VerifiedDouble.of_instance('Collaborator', some_method: output) }
+
+        it "tests something" do
+          ObjectUnderTest.new.do_something(instance_double, input)
+        end
+      end
+      """
+
+    And the test suite has a contract test for the stub:
+      """
+      require 'spec_helper'
+
+      describe 'Collaborator' do
+        it "tests something", verifies_contract: 'Collaborator#some_method=>SomeOutput' do
+          # do nothing
+        end
+      end
+      """
+
+    When I run the test suite
+    Then I should not see any output saying the stub is unverified

data/lib/verified_double.rb

@@ -1,25 +1,26 @@
-require 'rspec/fire'
+require 'rspec/mocks'
 
 require 'verified_double/boolean'
-require 'verified_double/get_registered_signatures'
-require 'verified_double/get_unverified_signatures'
-require 'verified_double/get_verified_signatures'
+require 'verified_double/matchers'
 require 'verified_double/method_signature'
 require 'verified_double/method_signature_value'
-require 'verified_double/output_unverified_signatures'
+require 'verified_double/method_signatures_report'
 require 'verified_double/parse_method_signature'
 require 'verified_double/recording_double'
-require 'verified_double/report_unverified_signatures'
+require 'verified_double/relays_to_internal_double_returning_self'
 
 module VerifiedDouble
-  def self.of_class(class_name)
-    RecordingDouble.new(RSpec::Fire::FireClassDoubleBuilder.build(class_name).as_replaced_constant).tap do |double|
+  extend RSpec::Mocks::ExampleMethods
+
+  def self.of_class(class_name, method_stubs = {})
+    class_double = stub_const(class_name, Class.new, transfer_nested_constants: true)
+    RecordingDouble.new(class_double, class_name, method_stubs).tap do |double|
       registry << double
     end
   end
 
-  def self.of_instance(class_name)
-    RecordingDouble.new(RSpec::Fire::FireObjectDouble.new(class_name)).tap do |double|
+  def self.of_instance(class_name, method_stubs = {})
+    RecordingDouble.new(double(class_name), class_name, method_stubs).tap do |double|
       registry << double
     end
   end
@@ -27,5 +28,19 @@ module VerifiedDouble
   def self.registry
     @registry ||= []
   end
+
+  def self.report_unverified_signatures(nested_example_group)
+    MethodSignaturesReport.new
+      .set_registered_signatures
+      .set_verified_signatures_from_tags(nested_example_group)
+      .set_verified_signatures_from_matchers
+      .merge_verified_signatures
+      .identify_unverified_signatures
+      .output_unverified_signatures
+  end
+
+  def self.verified_signatures_from_matchers
+    @verified_signatures_from_matchers ||= []
+  end
 end
 

data/lib/verified_double/matchers.rb

@@ -0,0 +1,35 @@
+require 'rspec/expectations'
+
+module VerifiedDouble
+  module Matchers
+    extend RSpec::Matchers::DSL
+
+    matcher :verify_accessor_contract do |expected|
+      match do |actual|
+        method_signature = ParseMethodSignature.new(expected).execute
+
+        VerifiedDouble.verified_signatures_from_matchers << method_signature
+
+        raise CannotHandleMultipleReturnValues if method_signature.return_values.size > 1
+
+        value = method_signature.return_values.first.as_instance
+        actual.send "#{method_signature.method}=", value
+        actual.send(method_signature.method) == value
+      end
+    end
+
+    matcher :verify_reader_contract do |expected|
+      match do |actual|
+        method_signature = ParseMethodSignature.new(expected).execute
+
+        VerifiedDouble.verified_signatures_from_matchers << method_signature
+
+        raise CannotHandleMultipleReturnValues if method_signature.return_values.size > 1
+
+        actual.send(method_signature.method).is_a?(method_signature.return_values.first.value)
+      end
+    end
+
+    class CannotHandleMultipleReturnValues < Exception; end
+  end
+end

data/lib/verified_double/method_signature_value.rb

@@ -14,8 +14,22 @@ module VerifiedDouble
       end
     end
 
+    def as_instance
+      if self.value.is_a?(Class)
+        begin
+          value.new
+        rescue NoMethodError
+          Object.new
+        end
+      else
+        self.value
+      end
+    end
+
     def modified_class
-      if value == true or value == false
+      if value.is_a?(VerifiedDouble::RecordingDouble)
+        value.class_name.constantize
+      elsif value == true or value == false
         VerifiedDouble::Boolean
       else
         value.class

data/lib/verified_double/method_signatures_report.rb

@@ -0,0 +1,55 @@
+module VerifiedDouble
+  class MethodSignaturesReport
+    attr_accessor :registered_signatures,  :unverified_signatures, :verified_signatures,
+      :verified_signatures_from_tags,:verified_signatures_from_matchers
+
+    def initialize
+      @registered_signatures = []
+      @unverified_signatures = []
+      @verified_signatures = []
+      @verified_signatures_from_tags = []
+      @verified_signatures_from_matchers = []
+    end
+
+    def identify_unverified_signatures
+      @unverified_signatures = @registered_signatures.select{|registered_signature|
+       @verified_signatures.all?{|verified_signature|
+        ! registered_signature.accepts?(verified_signature) } }
+      self
+    end
+
+    def merge_verified_signatures
+      @verified_signatures = @verified_signatures_from_tags + @verified_signatures_from_matchers
+      self
+    end
+
+    def output_unverified_signatures
+      if @unverified_signatures.any?
+        output = ["The following mocks are not verified:" ] + @unverified_signatures.map(&:recommended_verified_signature).map(&:to_s).sort
+        puts output.join("\n")
+      end
+      self
+    end
+
+    def set_registered_signatures
+      @registered_signatures = VerifiedDouble.registry.map(&:method_signatures).flatten.uniq
+      self
+    end
+
+    def set_verified_signatures_from_matchers
+      @verified_signatures_from_matchers = VerifiedDouble.verified_signatures_from_matchers
+      self
+    end
+
+    def set_verified_signatures_from_tags(nested_example_group)
+      @verified_signatures_from_tags = nested_example_group
+        .class
+        .descendant_filtered_examples
+        .map{|example| example.metadata[:verifies_contract] }
+        .compact
+        .uniq
+        .map{|method_signature_string| ParseMethodSignature.new(method_signature_string).execute }
+      self
+    end
+  end
+end

data/lib/verified_double/recording_double.rb

@@ -1,10 +1,23 @@
 require 'delegate'
+require 'verified_double/relays_to_internal_double_returning_self'
 
 module VerifiedDouble
   class RecordingDouble < ::SimpleDelegator
-    def initialize(double)
+    extend VerifiedDouble::RelaysToInternalDoubleReturningSelf
+
+    relays_to_internal_double_returning_self :any_number_of_times, :and_raise,
+      :and_throw, :at_least, :at_most, :exactly, :once, :twice
+
+    attr_reader :class_name
+
+    def initialize(double, class_name, method_stubs={})
       @double = double
+      @class_name = class_name
+
       super(@double)
+      method_stubs.each do |method, output|
+        self.stub(method).and_return(output)
+      end
     end
 
     def and_return(return_value)
@@ -14,11 +27,7 @@ module VerifiedDouble
     end
 
     def class_double?
-      ! double.is_a?(RSpec::Fire::FireObjectDouble)
-    end
-
-    def class_name
-      double.instance_variable_get('@name')
+      ! double.is_a?(RSpec::Mocks::Mock)
     end
 
     def double
@@ -38,13 +47,14 @@ module VerifiedDouble
     end
 
     def should_receive(method)
-      method_signature = MethodSignature.new(
-        class_name: class_name,
-        method_operator: method_operator,
-        method: method.to_s)
+      add_method_signature method
+      @double_call = double.should_receive(method)
+      self
+    end
 
-      self.method_signatures << method_signature
-      @double_call = super(method)
+    def stub(method)
+      add_method_signature method
+      @double_call = double.stub(method)
       self
     end
 
@@ -58,5 +68,16 @@ module VerifiedDouble
       @double_call.with(*args)
       self
     end
+
+    private
+
+    def add_method_signature(method)
+      method_signature = MethodSignature.new(
+        class_name: class_name,
+        method_operator: method_operator,
+        method: method.to_s)
+
+      self.method_signatures << method_signature
+    end
   end
 end

data/lib/verified_double/relays_to_internal_double_returning_self.rb

@@ -0,0 +1,12 @@
+module VerifiedDouble
+  module RelaysToInternalDoubleReturningSelf
+    def relays_to_internal_double_returning_self(*methods)
+      methods.each do |method|
+        define_method method do |*args|
+          @double_call.send(method, *args)
+          self
+        end
+      end
+    end
+  end
+end

data/lib/verified_double/version.rb

@@ -1,3 +1,3 @@
 module VerifiedDouble
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@ require 'verified_double'
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.include(RSpec::Fire)
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
@@ -17,8 +16,8 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
-end
 
-RSpec::Fire.configure do |config|
-  config.verify_constant_names = true
+  config.after :suite do
+    VerifiedDouble.report_unverified_signatures(self)
+  end
 end