stubborn 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Cadenas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,55 @@
+= stubborn
+
+A Ruby gem that helps you find missing stubs in your tests.
+
+Say you have this classes:
+
+  class Api
+    def slow_method(a, b, c)
+      ...
+    end
+  end
+
+  class MyClassThatUsesApi
+    def useful_method
+      ...
+      important_value = api.slow_method(important_parameter, something_else, another)
+      ...
+    end
+  end
+   
+And you have 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:
+
+  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)
+
+== Installation
+
+  sudo gem install stubborn
+
+== 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
+
+== Collaborate
+
+http://github.com/dcadenas/stubborn
+
+== Copyright
+
+Copyright (c) 2009 Daniel Cadenas. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stubborn"
+    gem.summary = %Q{A gem to help you find your missing stubs}
+    gem.email = "dcadenas@gmail.com"
+    gem.homepage = "http://github.com/dcadenas/stubborn"
+    gem.authors = ["Daniel Cadenas"]
+    gem.rubyforge_project = "stubborn"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stubborn #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/stubborn/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/missed_stub_exception.rb

@@ -0,0 +1,27 @@
+module Stubborn
+  class MissedStubException < RuntimeError
+    def initialize(object, method_name, args, result, suggester)
+      object_label = friendly_name(object)
+      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)
+
+      if object.is_a?(Class)
+        object.name
+      else
+        "#{object.class.name.downcase}_instance"
+      end
+    end
+  end
+end

data/lib/stubborn.rb

@@ -0,0 +1,62 @@
+begin
+  require 'proxen' 
+rescue LoadError
+  puts "You need to install the proxen gem: sudo gem install nakajima-proxen -s http://gems.github.com"
+  exit
+end
+
+require 'suggesters/rspec_suggester'
+require 'missed_stub_exception'
+
+module Stubborn
+  def self.should_be_stubbed(object)
+    if object.is_a?(Class)
+      ProxyForClass.new(object)
+    else
+      ProxyForInstance.new(object)
+    end
+  end
+
+  class ProxyForInstance
+    attr_accessor :proxy_target
+    proxy_to :proxy_target, :blank_slate => true
+
+    def initialize(proxy_target, klass = proxy_target.class)
+      @proxy_target = proxy_target
+      @klass = klass
+      @methods_to_skip = ["respond_to?", "is_a?"]
+    end
+
+    def class
+      @klass
+    end
+
+    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)
+    end
+  end
+
+  class ProxyForClass < ProxyForInstance
+    def initialize(proxy_target)
+      super
+      redefine_const(proxy_target.name, 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, self)
+    end
+
+  private
+    def redefine_const(name, value)
+      Object.__send__(:remove_const, name) if Object.const_defined?(name)
+      Object.const_set(name, value)
+    end
+  end
+end

data/lib/suggesters/rspec_suggester.rb

@@ -0,0 +1,14 @@
+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

data/stubborn.gemspec

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stubborn}
+  s.version = "0.1.2"
+  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}
+  s.email = %q{dcadenas@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/missed_stub_exception.rb",
+     "lib/stubborn.rb",
+     "lib/suggesters/rspec_suggester.rb",
+     "stubborn.gemspec",
+     "test/stubborn_method_filtering_test.rb",
+     "test/stubborn_test.rb",
+     "test/suggesters/rspec_suggester_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dcadenas/stubborn}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{stubborn}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{A gem to help you find your missing stubs}
+  s.test_files = [
+    "test/stubborn_method_filtering_test.rb",
+     "test/stubborn_test.rb",
+     "test/suggesters/rspec_suggester_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/stubborn_method_filtering_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+def reset_test_api_class
+  name = "TestApi"
+  Object.__send__(:remove_const, name) if Object.const_defined?(name)
+  klass =  Class.new do
+    def instance_method_1
+      "instance_method_1 called"
+    end
+
+    def instance_method_2
+      "instance_method_2 called"
+    end
+
+    def self.class_method_1
+      "class_method_1 called"
+    end
+
+    def self.class_method_2
+      "class_method_2 called"
+    end
+  end
+  Object.const_set(name, klass)
+end
+
+__END__
+PENDING
+
+Expectations do
+  expect "instance_method_1 called" do
+    api = TestApi.new   
+    Stubborn.should_be_stubbed(api, :except => :instance_method_1)
+    api.instance_method_1
+  end
+
+  expect Stubborn::MissedStubException do
+    api = TestApi.new   
+    Stubborn.should_be_stubbed(api, :except => :instance_method_1)
+    api.instance_method_2
+  end
+
+  expect "instance_method_2 called" do
+    api = TestApi.new   
+    Stubborn.should_be_stubbed(api, :only => :instance_method_1)
+    api.instance_method_2
+  end
+
+  expect Stubborn::MissedStubException do
+    api = TestApi.new   
+    Stubborn.should_be_stubbed(api, :only => :instance_method_1)
+    api.instance_method_1
+  end
+end

data/test/stubborn_test.rb

@@ -0,0 +1,105 @@
+require 'test_helper'
+
+def reset_test_api_class
+  name = "TestApi"
+  Object.__send__(:remove_const, name) if Object.const_defined?(name)
+  klass =  Class.new do
+    def plus_one(number)
+      number + 1
+    end
+
+    def self.plus_two(number)
+      number + 2
+    end
+  end
+  Object.const_set(name, klass)
+end
+
+Expectations do
+  expect 2 do
+    reset_test_api_class
+    TestApi.new.plus_one(1)
+  end
+
+  expect "TestApi" do
+    reset_test_api_class
+    api = TestApi.new
+    api = Stubborn.should_be_stubbed(api)
+    api.class.name
+  end
+
+  expect true do
+    reset_test_api_class
+    api = TestApi.new
+    api = Stubborn.should_be_stubbed(api)
+    api.respond_to?(:plus_one)
+  end
+
+  expect Stubborn::MissedStubException do
+    reset_test_api_class
+    api = TestApi.new
+    api = Stubborn.should_be_stubbed(api)
+    api.plus_one(1) 
+  end
+
+  expect 3 do
+    reset_test_api_class
+    api = TestApi.new
+    api = Stubborn.should_be_stubbed(api)
+    api.class.plus_two(1) 
+  end
+
+  expect "You've missed adding a stub. Consider this suggestions:\ntestapi_instance.stub!(:plus_one).with(0).and_return(1)\ntestapi_instance.stub!(:plus_one).and_return(1)" do
+    reset_test_api_class
+    api = TestApi.new
+    api = Stubborn.should_be_stubbed(api)
+    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)
+    api = TestApi.new
+    api.class.name
+  end
+
+  expect true do
+    reset_test_api_class
+    Stubborn.should_be_stubbed(TestApi)
+    api = TestApi.new
+    api.respond_to?(:plus_one)
+  end
+
+  expect Stubborn::MissedStubException do
+    reset_test_api_class
+    Stubborn.should_be_stubbed(TestApi)
+    api = TestApi.new
+    api.plus_one(1) 
+  end
+
+  expect Stubborn::MissedStubException do
+    reset_test_api_class
+    Stubborn.should_be_stubbed(TestApi)
+    api = TestApi.new
+    api.class.plus_two(1) 
+  end
+
+  expect "You've missed adding a stub. Consider this suggestions:\ntestapi_instance.stub!(:plus_one).with(0).and_return(1)\ntestapi_instance.stub!(:plus_one).and_return(1)" do
+    reset_test_api_class
+    Stubborn.should_be_stubbed(TestApi)
+    message = ""
+    api = TestApi.new
+    begin
+      api.plus_one(0)
+    rescue => e 
+      message = e.message
+    end
+  end
+end
+
+

data/test/suggesters/rspec_suggester_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class AClass; end
+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
+  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
+end
+

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+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

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: stubborn
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Daniel Cadenas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-02 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dcadenas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/missed_stub_exception.rb
+- lib/stubborn.rb
+- lib/suggesters/rspec_suggester.rb
+- stubborn.gemspec
+- test/stubborn_method_filtering_test.rb
+- test/stubborn_test.rb
+- test/suggesters/rspec_suggester_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/dcadenas/stubborn
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: stubborn
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: A gem to help you find your missing stubs
+test_files: 
+- test/stubborn_method_filtering_test.rb
+- test/stubborn_test.rb
+- test/suggesters/rspec_suggester_test.rb
+- test/test_helper.rb