stubborn 0.2.0 → 0.3.0

data/README.rdoc

@@ -63,13 +63,16 @@ You can control which methods to check with the options :except and :only. Both
   Stubborn.should_be_stubbed(Api.new, :except => :safe_method)
   Stubborn.should_be_stubbed(Api.new, :only => [:slow_method, :external_service])
 
+You can also filter on instance methods. All you need to do is using the :instance_methods key to scope your :only or :except methods like this:
+
+  Stubborn.should_be_stubbed(User, :instance_methods => {:only => :save})
+
 == Installation
 
-  sudo gem install stubborn -s http://gemcutter.org
+  sudo gem install stubborn
 
 == To Do
 
-* Filters so that you can choose which methods to include or exclude
 * Give stub suggestions for more test frameworks. It currently shows only rspec syntax
 
 == Collaborate

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/stubborn.rb

@@ -1,70 +1,21 @@
-require 'suggesters/rspec_suggester'
-require 'missed_stub_exception'
+require 'stubborn/suggesters/rspec_suggester'
+require 'stubborn/proxy_for_instance'
+require 'stubborn/proxy_for_module'
 
 module Stubborn
   def self.should_be_stubbed(object, options = {})
-    if object.is_a?(Class)
-      ProxyForClass.new(object, options)
+    if object.is_a?(Module)
+      ProxyForModule.new(object, options)
     else
       ProxyForInstance.new(object, options)
     end
   end
 
-  class ProxyForInstance
-    instance_methods.each do |sym|
-      undef_method(sym) unless sym.to_s =~ /__/ || sym.to_s == "send"
-    end
-
-    def initialize(proxy_target, options = {})
-      @proxy_target = proxy_target
-
-      options[:except] = [options[:except]].flatten.compact.map{|m| m.to_s}
-      options[:only] = [options[:only]].flatten.compact.map{|m| m.to_s}
-      options = {:class => proxy_target.class}.merge(options)
-      @label = options[:label]
-      @class = options[:class]
-      @methods_to_skip = ["respond_to?", "is_a?", "kind_of?", "equal?", "eql?", "==", "==="] + options[:except]
-      @only_methods = options[:only]
-    end
-
-    def class
-      @class
-    end
-
-    def method_missing(method_name, *args, &block)
-      were_we_already_processing_a_missed_stub = Thread.current["inside_missed_stub"]
-      Thread.current["inside_missed_stub"] = true
-      result = @proxy_target.send(method_name, *args, &block)
-      return result if !@only_methods.include?(method_name.to_s) && !@only_methods.empty? || @methods_to_skip.include?(method_name.to_s) || were_we_already_processing_a_missed_stub
-      raise MissedStubException.new(@label || @proxy_target, method_name, args, result, Suggesters::RSpecSuggester)
-    ensure
-      Thread.current["inside_missed_stub"] = false unless were_we_already_processing_a_missed_stub
-    end
+  def self.suggester=(suggester)
+    @suggester = suggester
   end
 
-  class ProxyForClass < ProxyForInstance
-    def initialize(proxy_target, options = {})
-      super
-      redefine_const(proxy_target, self) unless proxy_target.name.strip.empty?
-    end
-
-    def name
-      @proxy_target.name
-    end
-
-    def new(*args, &block)
-      new_instance = @proxy_target.new(*args, &block)
-      ProxyForInstance.new(new_instance, :class => self)
-    end
-
-  private
-    def redefine_const(const, value)
-      const_parts = const.name.split('::')
-      const_name = const_parts.pop
-      parent_const = const_parts.inject(Object){|a, c| a.const_get(c) }
-
-      parent_const.__send__(:remove_const, const_name) if parent_const.const_defined?(const_name)
-      parent_const.const_set(const_name, value)
-    end
+  def self.suggester
+    @suggester ||= Suggesters::RSpecSuggester
   end
 end

data/lib/stubborn/missed_stub_exception.rb

@@ -0,0 +1,11 @@
+module Stubborn
+  class MissedStubException < RuntimeError
+    def initialize(object_or_label, method_name, args, result, suggester)
+      @suggestions = suggester.suggestions(object_or_label, method_name, args, result)
+    end
+
+    def message
+      "You've missed adding a stub. Consider this suggestion#{@suggestions.size > 1 ? "s" : ""}:\n#{@suggestions.join("\n")}"
+    end
+  end
+end

data/lib/stubborn/proxy_for_instance.rb

@@ -0,0 +1,46 @@
+require 'stubborn/missed_stub_exception'
+
+module Stubborn
+  class ProxyForInstance
+    instance_methods.each do |sym|
+      undef_method(sym) unless sym.to_s =~ /__/ || sym.to_s == "send"
+    end
+
+    def initialize(proxy_target, options = {})
+      @proxy_target = proxy_target
+
+      options[:except] = [options[:except]].flatten.compact.map{|m| m.to_s}
+      options[:only] = [options[:only]].flatten.compact.map{|m| m.to_s}
+      options = {:class => proxy_target.class}.merge(options)
+      @label = options[:label]
+      @class = options[:class]
+      @methods_to_skip = ["respond_to?", "is_a?", "kind_of?", "equal?", "eql?", "==", "==="] + options[:except]
+      @only_methods = options[:only]
+      @instance_methods = options[:instance_methods]
+    end
+
+    def class
+      @class
+    end
+
+    def method_missing(method_name, *args, &block)
+      were_we_already_processing_a_missed_stub = Thread.current["inside_missed_stub"]
+      Thread.current["inside_missed_stub"] = true
+      result = begin
+                 @proxy_target.send(method_name, *args, &block)
+               rescue => e
+                 e
+               end
+
+      return result if !@only_methods.include?(method_name.to_s) && !@only_methods.empty? || @methods_to_skip.include?(method_name.to_s) || were_we_already_processing_a_missed_stub
+      raise_missed_stub_exception(method_name, args, result)
+    ensure
+      Thread.current["inside_missed_stub"] = false unless were_we_already_processing_a_missed_stub
+    end
+
+    private
+    def raise_missed_stub_exception(method_name, args, result)
+      raise MissedStubException.new(@label || @proxy_target, method_name, args, result, Stubborn.suggester)
+    end
+  end
+end

data/lib/stubborn/proxy_for_module.rb

@@ -0,0 +1,35 @@
+module Stubborn
+  class ProxyForModule < ProxyForInstance
+    def initialize(proxy_target, options = {})
+      super
+      redefine_const(proxy_target, self) unless proxy_target.name.strip.empty?
+    end
+
+    def name
+      @proxy_target.name
+    end
+
+    def new(*args, &block)
+      new_instance = @proxy_target.new(*args, &block)
+      raise_missed_stub_exception("new", args, new_instance) if @only_methods.include?("new") && !@methods_to_skip.include?("new")
+      options = {:class => self}
+
+      if @instance_methods
+        options[:only] = @instance_methods[:only]
+        options[:except] = @instance_methods[:except]
+      end
+
+      ProxyForInstance.new(new_instance, options)
+    end
+
+  private
+    def redefine_const(const, value)
+      const_parts = const.name.split('::')
+      const_name = const_parts.pop
+      parent_const = const_parts.inject(Object){|a, c| a.const_get(c) }
+
+      parent_const.__send__(:remove_const, const_name) if parent_const.const_defined?(const_name)
+      parent_const.const_set(const_name, value)
+    end
+  end
+end

data/lib/stubborn/suggesters/rspec_suggester.rb

@@ -0,0 +1,38 @@
+module Stubborn
+  module Suggesters
+    module RSpecSuggester
+      def self.suggestions(object_or_label, method_name, args, result_object)
+        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_object)
+
+        with = args.strip.empty? ? nil : ".with(#{args})"
+
+        return_method = if result_object.is_a?(Exception)
+                          ".and_raise(#{result_object.class})"
+                        elsif result_object.nil?
+                          nil
+                        else
+                          ".and_return(#{result})"
+                        end
+
+        suggestions = []
+        suggestions << "#{object_label}.stub!(:#{method_name})#{with}#{return_method}"
+        suggestions << "#{object_label}.stub!(:#{method_name})#{return_method}"
+        suggestions.uniq
+      end
+
+    private
+      def self.friendly_name(object)
+        return "\"#{object}\"" if object.respond_to?(:to_str)
+        return object.inspect if object.respond_to?(:to_int) || object.is_a?(Hash) || object.nil? || object == true || object == false
+
+        if object.is_a?(Class)
+          object.name
+        else
+          "#{object.class.name.downcase.gsub(/\W+/, '_')}_instance"
+        end
+      end
+    end
+  end
+end

data/stubborn.gemspec

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{stubborn}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Cadenas"]
-  s.date = %q{2009-10-05}
+  s.date = %q{2010-02-17}
   s.email = %q{dcadenas@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -19,9 +22,11 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
-     "lib/missed_stub_exception.rb",
      "lib/stubborn.rb",
-     "lib/suggesters/rspec_suggester.rb",
+     "lib/stubborn/missed_stub_exception.rb",
+     "lib/stubborn/proxy_for_instance.rb",
+     "lib/stubborn/proxy_for_module.rb",
+     "lib/stubborn/suggesters/rspec_suggester.rb",
      "stubborn.gemspec",
      "test/stubborn_method_filtering_test.rb",
      "test/stubborn_test.rb",
@@ -32,7 +37,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{stubborn}
-  s.rubygems_version = %q{1.3.3}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{A gem to help you find your missing stubs}
   s.test_files = [
     "test/stubborn_method_filtering_test.rb",
@@ -51,3 +56,4 @@ Gem::Specification.new do |s|
   else
   end
 end
+

data/test/stubborn_method_filtering_test.rb

@@ -1,8 +1,10 @@
 require 'test_helper'
 
-module FilteringTest; end
+module FilteringTest
+  class Error < StandardError; end
+end
 
-def reset_FilteringTest_api_class
+def reset_filtering_test_api_class
   name = "Api"
   FilteringTest.send(:remove_const, name) if FilteringTest.const_defined?(name)
   klass =  Class.new do
@@ -14,6 +16,10 @@ def reset_FilteringTest_api_class
       "instance_method_2 called"
     end
 
+    def instance_method_3
+      raise FilteringTest::Error
+    end
+
     def self.class_method_1
       "class_method_1 called"
     end
@@ -27,51 +33,98 @@ end
 
 Expectations do
   expect "instance_method_1 called" do
-    reset_FilteringTest_api_class
-    api = FilteringTest::Api.new   
+    reset_filtering_test_api_class
+    api = FilteringTest::Api.new
     api = Stubborn.should_be_stubbed(api, :except => [:instance_method_1, :instance_method_2])
     api.instance_method_1
   end
 
   expect "instance_method_2 called" do
-    reset_FilteringTest_api_class
-    api = FilteringTest::Api.new   
+    reset_filtering_test_api_class
+    api = FilteringTest::Api.new
     api = Stubborn.should_be_stubbed(api, :except => [:instance_method_1, :instance_method_2])
     api.instance_method_2
   end
 
   expect Stubborn::MissedStubException do
-    reset_FilteringTest_api_class
-    api = FilteringTest::Api.new   
+    reset_filtering_test_api_class
+    api = FilteringTest::Api.new
     api = Stubborn.should_be_stubbed(api, :except => :instance_method_1)
     api.instance_method_2
   end
 
   expect "instance_method_2 called" do
-    reset_FilteringTest_api_class
-    api = FilteringTest::Api.new   
+    reset_filtering_test_api_class
+    api = FilteringTest::Api.new
     api = Stubborn.should_be_stubbed(api, :only => :instance_method_1)
     api.instance_method_2
   end
 
   expect Stubborn::MissedStubException do
-    reset_FilteringTest_api_class
-    api = FilteringTest::Api.new   
+    reset_filtering_test_api_class
+    api = FilteringTest::Api.new
     api = Stubborn.should_be_stubbed(api, :only => :instance_method_1)
     api.instance_method_1
   end
 
   expect Stubborn::MissedStubException do
-    reset_FilteringTest_api_class
-    api = FilteringTest::Api.new   
+    reset_filtering_test_api_class
+    api = FilteringTest::Api.new
     api = Stubborn.should_be_stubbed(api, :only => [:instance_method_1, :instance_method_2])
     api.instance_method_1
   end
 
   expect Stubborn::MissedStubException do
-    reset_FilteringTest_api_class
-    api = FilteringTest::Api.new   
+    reset_filtering_test_api_class
+    api = FilteringTest::Api.new
     api = Stubborn.should_be_stubbed(api, :only => [:instance_method_1, :instance_method_2])
     api.instance_method_2
   end
+
+  expect Stubborn::MissedStubException do
+    reset_filtering_test_api_class
+    Stubborn.should_be_stubbed(FilteringTest::Api, :only => :new)
+    FilteringTest::Api.new
+  end
+
+  expect Stubborn::MissedStubException do
+    reset_filtering_test_api_class
+    Stubborn.should_be_stubbed(FilteringTest::Api, :instance_methods => {:only => :instance_method_1})
+    api = FilteringTest::Api.new
+    api.instance_method_1
+  end
+
+  expect "instance_method_2 called" do
+    reset_filtering_test_api_class
+    Stubborn.should_be_stubbed(FilteringTest::Api, :instance_methods => {:only => :instance_method_1})
+    api = FilteringTest::Api.new
+    api.instance_method_2
+  end
+
+  expect Stubborn::MissedStubException do
+    reset_filtering_test_api_class
+    Stubborn.should_be_stubbed(FilteringTest::Api, :instance_methods => {:except => :instance_method_1})
+    api = FilteringTest::Api.new
+    api.instance_method_2
+  end
+
+  expect "instance_method_1 called" do
+    reset_filtering_test_api_class
+    Stubborn.should_be_stubbed(FilteringTest::Api, :instance_methods => {:except => :instance_method_1})
+    api = FilteringTest::Api.new
+    api.instance_method_1
+  end
+
+  expect Stubborn::MissedStubException do
+    reset_filtering_test_api_class
+    Stubborn.should_be_stubbed(FilteringTest::Api)
+    api = FilteringTest::Api.new
+    api.instance_method_1
+  end
+
+  expect Stubborn::MissedStubException do
+    reset_filtering_test_api_class
+    api = Stubborn.should_be_stubbed(FilteringTest::Api.new)
+    api.instance_method_3
+  end
 end

data/test/test_helper.rb

@@ -4,7 +4,3 @@ require 'expectations'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'stubborn'
-
-class Test::Unit::TestCase
-end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stubborn
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel Cadenas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-05 00:00:00 -02:00
+date: 2010-02-17 00:00:00 -02:00
 default_executable: 
 dependencies: []
 
@@ -29,9 +29,11 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- lib/missed_stub_exception.rb
 - lib/stubborn.rb
-- lib/suggesters/rspec_suggester.rb
+- lib/stubborn/missed_stub_exception.rb
+- lib/stubborn/proxy_for_instance.rb
+- lib/stubborn/proxy_for_module.rb
+- lib/stubborn/suggesters/rspec_suggester.rb
 - stubborn.gemspec
 - test/stubborn_method_filtering_test.rb
 - test/stubborn_test.rb
@@ -61,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: stubborn
-rubygems_version: 1.3.3
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A gem to help you find your missing stubs

data/lib/missed_stub_exception.rb

@@ -1,27 +0,0 @@
-module Stubborn
-  class MissedStubException < RuntimeError
-    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)
-
-      @suggestions = suggester.suggestions(object_label, method_name, args, result)
-    end
-
-    def message
-      "You've missed adding a stub. Consider this suggestion#{@suggestions.size > 1 ? "s" : ""}:\n#{@suggestions.join("\n")}"
-    end
-    
-  private
-    def friendly_name(object)
-      return "\"#{object}\"" if object.respond_to?(:to_str)
-      return object.inspect if object.respond_to?(:to_int) || object.is_a?(Hash) || object.nil? || object == true || object == false
-
-      if object.is_a?(Class)
-        object.name
-      else
-        "#{object.class.name.downcase.gsub(/\W+/, '_')}_instance"
-      end
-    end
-  end
-end

data/lib/suggesters/rspec_suggester.rb

@@ -1,14 +0,0 @@
-module Stubborn
-  module Suggesters
-    module RSpecSuggester
-      def self.suggestions(object_label, method_name, args, result)
-        with = args.strip.empty? ? nil : ".with(#{args})"
-        and_return = result == "nil" ? nil : ".and_return(#{result})"
-        suggestions = []
-        suggestions << "#{object_label}.stub!(:#{method_name})#{with}#{and_return}"
-        suggestions << "#{object_label}.stub!(:#{method_name})#{and_return}"
-        suggestions.uniq
-      end
-    end
-  end
-end