verified_double 0.1.1 → 0.2.0

data/CHANGELOG.markdown

@@ -1,3 +1,15 @@
+0.2.0 - 2013-06-30
+------------------
+
+* [#4] Add stack frames and relish app link to output.
+* [#12] RecordingDouble#class should be the class of the object being doubled.
+* [#16] Fix handling of doubles passed as method signature values.
+
+Known issues:
+
+* Stack frames sometimes point to verified_double gem instead of where the mock was recorded.
+
+
 0.1.1 - 2013-06-26
 ------------------
 

data/README.md

@@ -2,34 +2,45 @@
 
 [![Build Status](https://travis-ci.org/gsmendoza/verified_double.png)](https://travis-ci.org/gsmendoza/verified_double)
 
-VerifiedDouble verifies mocks made in the test suite by checking if there are tests against them.
+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.
 
 For example, let's say I mocked the created_at method of a model like this:
 
     item = VerifiedDouble.of_instance(Item)
     item.should_receive(:created_at).and_return(Time.now)
 
-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:
+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.
 
     it "tests something", verifies_contract: 'Item#created_at()=>Time' do
       #...
     end
 
-If this test does not exist, the gem will complain that the mock is not
-verified.
+If this test does not exist, the gem will complain that the mock is not verified.
 
-More information at https://www.relishapp.com/gsmendoza/verified-double.
+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.
 
-References
-----------
+You can learn more about using the gem at https://www.relishapp.com/gsmendoza/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
+Actively tested against
+-----------------------
+
+* Ruby 1.9.3
+* RSpec 2.13
+
+
+Alternatives
+------------
+
+[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!
+
+Caveats
+-------
+
+VerifiedDouble is still in its infancy, but I hope it's usable for the most common cases.
+
+* If you check the RelishApp doc, the gem only supports a subset of rspec-mock's API. Please post an issue at http://github.com/gsmendoza/verified_double if you need support for any particular rspec-mock API.
+
+* 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.
 
 Special thanks
 --------------

data/features/CHANGELOG.markdown

@@ -1,3 +1,15 @@
+0.2.0 - 2013-06-30
+------------------
+
+* [#4] Add stack frames and relish app link to output.
+* [#12] RecordingDouble#class should be the class of the object being doubled.
+* [#16] Fix handling of doubles passed as method signature values.
+
+Known issues:
+
+* Stack frames sometimes point to verified_double gem instead of where the mock was recorded.
+
+
 0.1.1 - 2013-06-26
 ------------------
 

data/features/readme.md

@@ -2,34 +2,45 @@
 
 [![Build Status](https://travis-ci.org/gsmendoza/verified_double.png)](https://travis-ci.org/gsmendoza/verified_double)
 
-VerifiedDouble verifies mocks made in the test suite by checking if there are tests against them.
+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.
 
 For example, let's say I mocked the created_at method of a model like this:
 
     item = VerifiedDouble.of_instance(Item)
     item.should_receive(:created_at).and_return(Time.now)
 
-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:
+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.
 
     it "tests something", verifies_contract: 'Item#created_at()=>Time' do
       #...
     end
 
-If this test does not exist, the gem will complain that the mock is not
-verified.
+If this test does not exist, the gem will complain that the mock is not verified.
 
-More information at https://www.relishapp.com/gsmendoza/verified-double.
+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.
 
-References
-----------
+You can learn more about using the gem at https://www.relishapp.com/gsmendoza/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
+Actively tested against
+-----------------------
+
+* Ruby 1.9.3
+* RSpec 2.13
+
+
+Alternatives
+------------
+
+[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!
+
+Caveats
+-------
+
+VerifiedDouble is still in its infancy, but I hope it's usable for the most common cases.
+
+* If you check the RelishApp doc, the gem only supports a subset of rspec-mock's API. Please post an issue at http://github.com/gsmendoza/verified_double if you need support for any particular rspec-mock API.
+
+* 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.
 
 Special thanks
 --------------

data/features/verified_mocks.feature

@@ -93,7 +93,8 @@ Feature: 01. Verified mocks
     Then I should be informed that the mock is unverified:
       """
       The following mocks are not verified:
-      Collaborator#some_method(SomeInput)=>SomeOutput
+
+      1. Collaborator#some_method(SomeInput)=>SomeOutput
       """
 
   Scenario: Verified class doubles
@@ -147,5 +148,6 @@ Feature: 01. Verified mocks
     Then I should be informed that the mock is unverified:
       """
       The following mocks are not verified:
-      Collaborator.some_method(SomeInput)=>SomeOutput
+
+      1. Collaborator.some_method(SomeInput)=>SomeOutput
       """

data/lib/verified_double.rb

@@ -1,13 +1,22 @@
+require 'active_support/core_ext/string'
 require 'rspec/mocks'
 
 require 'verified_double/boolean'
 require 'verified_double/matchers'
 require 'verified_double/method_signature'
-require 'verified_double/method_signature_value'
+require 'verified_double/method_signature/value'
+require 'verified_double/method_signature/instance_value'
+require 'verified_double/method_signature/boolean_value'
+require 'verified_double/method_signature/class_value'
+require 'verified_double/method_signature/instance_double_value'
+require 'verified_double/method_signature/recording_double_class_value'
+require 'verified_double/method_signature/rspec_double_value'
 require 'verified_double/method_signatures_report'
 require 'verified_double/parse_method_signature'
+require 'verified_double/recorded_method_signature'
 require 'verified_double/recording_double'
 require 'verified_double/relays_to_internal_double_returning_self'
+require 'verified_double/stack_frame'
 
 module VerifiedDouble
   extend RSpec::Mocks::ExampleMethods

data/lib/verified_double/matchers.rb

@@ -12,7 +12,7 @@ module VerifiedDouble
 
         raise CannotHandleMultipleReturnValues if method_signature.return_values.size > 1
 
-        value = method_signature.return_values.first.as_instance
+        value = method_signature.return_values.first.content_as_instance
         actual.send "#{method_signature.method}=", value
         actual.send(method_signature.method) == value
       end
@@ -26,7 +26,7 @@ module VerifiedDouble
 
         raise CannotHandleMultipleReturnValues if method_signature.return_values.size > 1
 
-        actual.send(method_signature.method).is_a?(method_signature.return_values.first.value)
+        actual.send(method_signature.method).is_a?(method_signature.return_values.first.content)
       end
     end
 

data/lib/verified_double/method_signature.rb

@@ -8,14 +8,14 @@ module VerifiedDouble
       end
     end
 
-    def accepts?(other)
+    def belongs_to?(other)
       self.class_name == other.class_name &&
       self.method_operator == other.method_operator &&
       self.method == other.method &&
       self.args.size == other.args.size &&
-      (0 ... args.size).all?{|i| self.args[i].accepts?(other.args[i]) } &&
+      (0 ... args.size).all?{|i| self.args[i].belongs_to?(other.args[i]) } &&
       self.return_values.size == other.return_values.size &&
-      (0 ... return_values.size).all?{|i| self.return_values[i].accepts?(other.return_values[i]) }
+      (0 ... return_values.size).all?{|i| self.return_values[i].belongs_to?(other.return_values[i]) }
     end
 
     def args
@@ -42,8 +42,8 @@ module VerifiedDouble
     end
 
     def to_s
-      args_string = args.map(&:value).map{|v| v || 'nil'}.join(', ')
-      return_values_string = return_values.map(&:value).map{|v| v || 'nil'}.join(', ')
+      args_string = args.map(&:content).map{|v| v || 'nil'}.join(', ')
+      return_values_string = return_values.map(&:content).map{|v| v || 'nil'}.join(', ')
       return_values_string = nil if return_values_string.empty?
 
       result = [

data/lib/verified_double/method_signature/boolean_value.rb

@@ -0,0 +1,9 @@
+module VerifiedDouble
+  class MethodSignature
+    class BooleanValue < InstanceValue
+      def content_class
+        VerifiedDouble::Boolean
+      end
+    end
+  end
+end

data/lib/verified_double/method_signature/class_value.rb

@@ -0,0 +1,17 @@
+module VerifiedDouble
+  class MethodSignature
+    class ClassValue < Value
+      def belongs_to?(other)
+        self.content == other.content
+      end
+
+      def content_as_instance
+        begin
+          content.new
+        rescue NoMethodError
+          Object.new
+        end
+      end
+    end
+  end
+end

data/lib/verified_double/method_signature/instance_double_value.rb

@@ -0,0 +1,9 @@
+module VerifiedDouble
+  class MethodSignature
+    class InstanceDoubleValue < InstanceValue
+      def content_as_instance
+        Value.from(content_class).content_as_instance
+      end
+    end
+  end
+end

data/lib/verified_double/method_signature/instance_value.rb

@@ -0,0 +1,17 @@
+module VerifiedDouble
+  class MethodSignature
+    class InstanceValue < Value
+      def belongs_to?(other)
+        if other.is_a?(MethodSignature::InstanceValue)
+          self.content == other.content
+        else
+          self.content_class.ancestors.include?(other.content)
+        end
+      end
+
+      def content_as_instance
+        self.content
+      end
+    end
+  end
+end

data/lib/verified_double/method_signature/recording_double_class_value.rb

@@ -0,0 +1,9 @@
+module VerifiedDouble
+  class MethodSignature
+    class RecordingDoubleClassValue < ClassValue
+      def belongs_to?(other)
+        Value.from(content.doubled_class).belongs_to?(other)
+      end
+    end
+  end
+end

data/lib/verified_double/method_signature/rspec_double_value.rb

@@ -0,0 +1,9 @@
+module VerifiedDouble
+  class MethodSignature
+    class RspecDoubleValue <  InstanceDoubleValue
+      def content_class
+        content.instance_variable_get('@name').constantize
+      end
+    end
+  end
+end

data/lib/verified_double/method_signature/value.rb

@@ -0,0 +1,37 @@
+module VerifiedDouble
+  class MethodSignature
+    class Value
+      attr_reader :content
+
+      def self.from(content)
+        if content == true || content == false
+          BooleanValue.new(content)
+        elsif content.is_a?(RSpec::Mocks::Mock)
+          RspecDoubleValue.new(content)
+        elsif content.respond_to?(:doubled_class)
+          if content.class_double?
+            RecordingDoubleClassValue.new(content)
+          else
+            InstanceDoubleValue.new(content)
+          end
+        elsif content.is_a?(Module)
+          ClassValue.new(content)
+        else
+          InstanceValue.new(content)
+        end
+      end
+
+      def initialize(content)
+        @content = content
+      end
+
+      def content_class
+        content.class
+      end
+
+      def recommended_value
+        MethodSignature::Value.from(self.content_class)
+      end
+    end
+  end
+end

data/lib/verified_double/method_signatures_report.rb

@@ -14,7 +14,7 @@ module VerifiedDouble
     def identify_unverified_signatures
       @unverified_signatures = @registered_signatures.select{|registered_signature|
        @verified_signatures.all?{|verified_signature|
-        ! registered_signature.accepts?(verified_signature) } }
+        ! registered_signature.belongs_to?(verified_signature) } }
       self
     end
 
@@ -25,8 +25,15 @@ module VerifiedDouble
 
     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")
+        output = [nil, "The following mocks are not verified:" ] +
+          @unverified_signatures
+            .map(&:recommended_verified_signature)
+            .map(&:to_s)
+            .sort
+            .each_with_index
+            .map{|string, i| "#{i+1}. #{string}" } +
+          ["For more info, check out https://www.relishapp.com/gsmendoza/verified-double."]
+        puts output.join("\n\n")
       end
       self
     end

data/lib/verified_double/parse_method_signature.rb

@@ -9,7 +9,7 @@ module VerifiedDouble
     def args
       results = string.scan(/\((.*)\)/)[0]
       if results
-        results[0].split(',').map{|arg| MethodSignatureValue.new(eval(arg)) }
+        results[0].split(',').map{|arg| MethodSignature::Value.from(eval(arg)) }
       else
         []
       end
@@ -40,7 +40,7 @@ module VerifiedDouble
       results = string.scan(/=>(.*)/)[0]
       if results
         results[0].split(',').map{|return_value|
-          MethodSignatureValue.new(eval(return_value)) }
+          MethodSignature::Value.from(eval(return_value)) }
       else
         []
       end

data/lib/verified_double/recorded_method_signature.rb

@@ -0,0 +1,9 @@
+module VerifiedDouble
+  class RecordedMethodSignature < MethodSignature
+    attr_accessor :stack_frame
+
+    def to_s
+      "#{super}\n  # #{stack_frame}"
+    end
+  end
+end

data/lib/verified_double/recording_double.rb

@@ -21,11 +21,15 @@ module VerifiedDouble
     end
 
     def and_return(return_value)
-      self.method_signatures.last.return_values = [MethodSignatureValue.new(return_value)]
+      self.method_signatures.last.return_values = [MethodSignature::Value.from(return_value)]
       @double_call.and_return(return_value)
       self
     end
 
+    def class
+      class_double? ? Class : doubled_class
+    end
+
     def class_double?
       ! double.is_a?(RSpec::Mocks::Mock)
     end
@@ -34,6 +38,10 @@ module VerifiedDouble
       __getobj__
     end
 
+    def doubled_class
+      class_name.constantize
+    end
+
     def inspect
       to_s
     end
@@ -64,7 +72,7 @@ module VerifiedDouble
 
     def with(*args)
       self.method_signatures.last.args =
-        args.map{|arg| MethodSignatureValue.new(arg) }
+        args.map{|arg| MethodSignature::Value.from(arg) }
       @double_call.with(*args)
       self
     end
@@ -72,10 +80,11 @@ module VerifiedDouble
     private
 
     def add_method_signature(method)
-      method_signature = MethodSignature.new(
+      method_signature = RecordedMethodSignature.new(
         class_name: class_name,
         method_operator: method_operator,
-        method: method.to_s)
+        method: method.to_s,
+        stack_frame: StackFrame.new(caller(2)[0]))
 
       self.method_signatures << method_signature
     end