stubborn 0.1.2 → 0.1.3

data/README.rdoc

@@ -2,11 +2,15 @@
 
 A Ruby gem that helps you find missing stubs in your tests.
 
-Say you have this classes:
+== Usage
+
+Let's explain through an example. Say you have this classes:
 
   class Api
     def slow_method(a, b, c)
       ...
+      #this is slow or dangerous, so you want to stub it in your tests
+      ...
     end
   end
 
@@ -18,33 +22,47 @@ Say you have this classes:
     end
   end
    
-And you have this somewhere in your test_helper/spec_helper:
+And you've forgot to stub your api class in many tests of your huge test suite:
+
+  it "should do something useful" do
+    MyClassThatUsesApi.new.useful_method.should be_useful
+  end
+
+Then you could use stubborn to help you find and prevent those misses just by adding this somewhere in your test_helper/spec_helper:
 
   require 'rubygems'
   require 'stubborn'
 
   Stubborn.should_be_stubbed(Api)
-
-Then if you forget about stubbing the api class in some of your tests like this:
-
-  it "should do something useful" do
-    MyClassThatUsesApi.new.useful_method.should be_useful
-  end
   
-You will know that you missed it because the test will fail with an exception including all information you need to construct the correct stub:
+Now each test with a missing stub will fail throwing an exception that includes all information you need to construct the correct stub:
 
   You've missed adding a stub. Consider this suggestions:
   api_instance.stub!(:slow_method).with(123, AClass, "hi").and_return(another_class_instance)
   api_instance.stub!(:slow_method).and_return(another_class_instance)
 
+You have some control on the output by using the :label option so you can better match the way you usually call the methods from your test:
+
+  Stubborn.should_be_stubbed(Api, :label => "GreatClass.singleton")
+
+Which produces this output:
+
+  You've missed adding a stub. Consider this suggestions:
+  GreatClass.singleton.stub!(:slow_method).with(123, AClass, "hi").and_return(another_class_instance)
+  GreatClass.singleton.stub!(:slow_method).and_return(another_class_instance)
+
+So all class methods of the Api class and all its instances will raise this special exception while running the tests. If you prefer you can use it on a single instance like this:
+
+  Stubborn.should_be_stubbed(Api.new)
+
 == Installation
 
-  sudo gem install stubborn
+  sudo gem install stubborn -s http://gemcutter.org
 
 == To Do
 
 * Filters so that you can choose which methods to include or exclude
-* Stub suggestions for more test frameworks. It currently show only rspec syntax
+* Give stub suggestions for more test frameworks. It currently shows only rspec syntax
 
 == Collaborate
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/missed_stub_exception.rb

@@ -1,7 +1,7 @@
 module Stubborn
   class MissedStubException < RuntimeError
-    def initialize(object, method_name, args, result, suggester)
-      object_label = friendly_name(object)
+    def initialize(object_or_label, method_name, args, result, suggester)
+      object_label = object_or_label.respond_to?(:to_str) ? object_or_label : friendly_name(object_or_label)
       args = args.map{|a| friendly_name(a)}.join(", ")
       result = friendly_name(result)
 
@@ -15,7 +15,7 @@ module Stubborn
   private
     def friendly_name(object)
       return "\"#{object}\"" if object.respond_to?(:to_str)
-      return object.inspect if object.respond_to?(:to_int)
+      return object.inspect if object.respond_to?(:to_int) || object.is_a?(Hash)
 
       if object.is_a?(Class)
         object.name

data/lib/stubborn.rb

@@ -9,11 +9,11 @@ require 'suggesters/rspec_suggester'
 require 'missed_stub_exception'
 
 module Stubborn
-  def self.should_be_stubbed(object)
+  def self.should_be_stubbed(object, options = {})
     if object.is_a?(Class)
-      ProxyForClass.new(object)
+      ProxyForClass.new(object, options)
     else
-      ProxyForInstance.new(object)
+      ProxyForInstance.new(object, options)
     end
   end
 
@@ -21,10 +21,12 @@ module Stubborn
     attr_accessor :proxy_target
     proxy_to :proxy_target, :blank_slate => true
 
-    def initialize(proxy_target, klass = proxy_target.class)
+    def initialize(proxy_target, options = {})
+      options = {:class => proxy_target.class}.merge(options)
+      @label = options[:label]
       @proxy_target = proxy_target
-      @klass = klass
-      @methods_to_skip = ["respond_to?", "is_a?"]
+      @klass = options[:class]
+      @methods_to_skip = ["respond_to?", "is_a?", "kind_of?", "equal?", "eql?", "==", "==="]
     end
 
     def class
@@ -34,12 +36,12 @@ module Stubborn
     def method_missing(method_name, *args, &block)
       result = @proxy_target.send(method_name, *args, &block)
       return result if @methods_to_skip.include?(method_name.to_s)
-      raise MissedStubException.new(@proxy_target, method_name, args, result, Suggesters::RSpecSuggester)
+      raise MissedStubException.new(@label || @proxy_target, method_name, args, result, Suggesters::RSpecSuggester)
     end
   end
 
   class ProxyForClass < ProxyForInstance
-    def initialize(proxy_target)
+    def initialize(proxy_target, options = {})
       super
       redefine_const(proxy_target.name, self) unless proxy_target.name.strip.empty?
     end
@@ -50,7 +52,7 @@ module Stubborn
 
     def new(*args, &block)
       new_instance = @proxy_target.new(*args, &block)
-      ProxyForInstance.new(new_instance, self)
+      ProxyForInstance.new(new_instance, :class => self)
     end
 
   private

data/stubborn.gemspec

@@ -2,7 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stubborn}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
+
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Cadenas"]
   s.date = %q{2009-10-02}
@@ -11,7 +12,6 @@ Gem::Specification.new do |s|
     "LICENSE",
      "README.rdoc"
   ]
-
   s.files = [
     ".document",
      ".gitignore",

data/test/stubborn_test.rb

@@ -28,6 +28,24 @@ Expectations do
     api.class.name
   end
 
+  %w[is_a? kind_of?].each do |method|
+    expect true do
+      reset_test_api_class
+      api = TestApi.new
+      api = Stubborn.should_be_stubbed(api)
+      api.__send__(method, TestApi)
+    end
+  end
+
+  %w[equal? eql? == ===].each do |method|
+    expect true do
+      reset_test_api_class
+      api = TestApi.new
+      proxied_api = Stubborn.should_be_stubbed(api)
+      proxied_api.__send__(method, api)
+    end
+  end
+
   expect true do
     reset_test_api_class
     api = TestApi.new
@@ -61,6 +79,18 @@ Expectations do
     end
   end
 
+  expect "You've missed adding a stub. Consider this suggestions:\nApi.singleton.stub!(:plus_one).with(0).and_return(1)\nApi.singleton.stub!(:plus_one).and_return(1)" do
+    reset_test_api_class
+    api = TestApi.new
+    api = Stubborn.should_be_stubbed(api, :label => "Api.singleton")
+    message = ""
+    begin
+      api.plus_one(0)
+    rescue => e 
+      message = e.message
+    end
+  end
+
   expect "TestApi" do
     reset_test_api_class
     Stubborn.should_be_stubbed(TestApi)

data/test/suggesters/rspec_suggester_test.rb

@@ -6,12 +6,16 @@ class Api; end
 include Stubborn
 
 Expectations do
-  expect "You've missed adding a stub. Consider this suggestions:\napi_instance.stub!(:method).with(123, AClass, \"hi\").and_return(aclass_instance)\napi_instance.stub!(:method).and_return(aclass_instance)" do
-    MissedStubException.new(Api.new, :method, [123, AClass,"hi"], AClass.new, Suggesters::RSpecSuggester).message
+  expect "You've missed adding a stub. Consider this suggestions:\napi_instance.stub!(:method).with(123, AClass, \"hi\", {1=>2}).and_return(aclass_instance)\napi_instance.stub!(:method).and_return(aclass_instance)" do
+    MissedStubException.new(Api.new, :method, [123, AClass,"hi", {1 => 2}], AClass.new, Suggesters::RSpecSuggester).message
   end
 
   expect "You've missed adding a stub. Consider this suggestion:\napi_instance.stub!(:method).and_return(aclass_instance)" do
     MissedStubException.new(Api.new, :method, [], AClass.new, Suggesters::RSpecSuggester).message
   end
+
+  expect "You've missed adding a stub. Consider this suggestion:\nApi.singleton.stub!(:method).and_return(aclass_instance)" do
+    MissedStubException.new("Api.singleton", :method, [], AClass.new, Suggesters::RSpecSuggester).message
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stubborn
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Daniel Cadenas