stubble 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Matthew Rudy Jacobs]
+
+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

@@ -0,0 +1,27 @@
+Stubble
+========
+
+Work towards a Ruby stubber that retains the original functionality under the hood.
+
+Example
+=======
+
+Add some stubble
+  Stubble.add_stubble!(Time)
+
+Tell it just to track a method
+  Time.track!(:now)
+
+We can then later assert against calls
+
+Or we can stub it
+
+  Time.stub!(:now, [Time.mktime(2010,12,17,10,40)])
+  
+After Time.now has been called once, the functionality will return to normal
+
+Or we can call
+
+  Time.unstub!(:now)
+
+Copyright (c) 2010 [Matthew Rudy Jacobs], released under the MIT license

data/Rakefile

@@ -0,0 +1,97 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test Stubble'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for Stubble.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Stubble'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+
+task :default => ["test"]
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "stubble"
+  s.version           = "0.1.0"
+  s.summary           = "(experimental) simple stubbing"
+  s.author            = "Matthew Rudy Jacobs"
+  s.email             = "MatthewRudyJacobs@gmail.com"
+  s.homepage          = "https://github.com/matthewrudy/stubble"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README)
+  s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(MIT-LICENSE Rakefile README) + Dir.glob("{test,lib}/**/*")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+
+  # If your tests use any gems, include them here
+  # s.add_development_dependency("mocha") # for example
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# If you don't want to generate the .gemspec file, just remove this line. Reasons
+# why you might want to generate a gemspec:
+#  - using bundler with a git source
+#  - building the gem without rake (i.e. gem build blah.gemspec)
+#  - maybe others?
+task :package => :gemspec
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/lib/stubble.rb

@@ -0,0 +1,93 @@
+require 'set'
+require 'active_support/core_ext/kernel/singleton_class'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/object/blank'
+
+module Stubble
+  
+  class Catcher
+    
+    def initialize()
+      @calls = {}
+      @stubs = {}
+      @tracking = Set.new
+    end
+    
+    def called!(method_name, args, block)
+      if @tracking.include?(method_name)
+        @calls[method_name]
+        @calls[method_name] << [args, !block.nil?]
+        if @stubs[method_name].present?
+          @stubs[method_name].shift
+        end
+      end
+    end
+    
+    def track!(method_name)
+      @calls[method_name] = []
+      @tracking << method_name
+    end
+    
+    def untrack!(method_name)
+      @tracking.delete(method_name)
+    end
+    
+    def stub!(method_name, values)
+      @stubs[method_name] = values
+    end
+    
+    def unstub!(method_name)
+      @stubs[method_name] = nil
+    end
+    
+    def [](method_name)
+      @calls[method_name]
+    end
+    
+  end
+  
+  def add_stubble!(object)
+    object.instance_eval do
+      @stubble = Stubble::Catcher.new
+    end
+    object.extend StubMethods
+    def object._stubble
+      @stubble
+    end
+  end
+  module_function :add_stubble!
+  
+  module StubMethods
+    
+    def track!(method_name)
+      self._stubble.track!(method_name)
+      unless methods.include?("#{method_name}_with_stubble")
+        class_eval <<-RUBY
+          def #{method_name}_with_stubble(*args, &block)
+            if stubbed_return = self._stubble.called!(#{method_name.inspect}, args, block)
+              stubbed_return
+            else
+              #{method_name}_without_stubble(*args, &block)
+            end
+          end
+          alias_method_chain #{method_name.inspect}, :stubble
+        RUBY
+      end
+    end
+    
+    def untrack!(method_name)
+      self._stubble.untrack!(method_name)
+    end
+    
+    def stub!(method_name, values)
+      track!(method_name)
+      self._stubble.stub!(method_name, values)
+    end
+    
+    def unstub!(method_name)
+      self._stubble.unstub!(method_name)
+    end
+    
+  end
+      
+end

data/test/stubble_test.rb

@@ -0,0 +1,139 @@
+require 'test_helper'
+require 'stubble'
+
+class StubbleTest < Test::Unit::TestCase
+  
+  extend ActiveSupport::Testing::Declarative
+  
+  class StubThis
+    
+    def initialize
+      @hits = 0
+    end
+    attr_reader :hits
+    
+    def some_method
+      @hits +=1
+    end
+    
+    def some_method_with_arguments(times, shout="boom")
+      shout * times
+    end
+    
+    def some_method_with_block
+      yield @hits+=1
+    end
+    
+  end
+  
+  test "stubble is added on an individual basis" do
+    one = StubThis.new
+    two = StubThis.new
+    
+    Stubble.add_stubble!(one)
+    assert one.respond_to?(:_stubble)
+    assert !two.respond_to?(:_stubble)
+  end
+  
+  test "track! - tracks, but doesnt affect the function" do
+    this = StubThis.new
+    assert_equal 1, this.some_method
+    
+    Stubble.add_stubble!(this)
+    this.track!(:some_method)
+    
+    assert_equal 2, this.some_method
+    assert_equal 3, this.some_method
+    
+    assert_equal [[[],false]]*2, this._stubble[:some_method]
+  end
+  
+  test "track! - tracks arguments" do
+    this = StubThis.new
+    assert_equal "boom", this.some_method_with_arguments(1)
+    
+    Stubble.add_stubble!(this)
+    this.track!(:some_method_with_arguments)
+    
+    assert_equal "boomboom", this.some_method_with_arguments(2)
+    assert_equal "purple",  this.some_method_with_arguments(1, "purple")
+    
+    assert_equal [[[2],false], [[1,"purple"],false]], this._stubble[:some_method_with_arguments]
+  end
+  
+  test "track! - tracks blocks" do
+    this = StubThis.new
+
+    this.some_method_with_block do |val|
+      assert_equal 1, val
+    end
+    
+    Stubble.add_stubble!(this)
+    this.track!(:some_method_with_block)
+    
+    this.some_method_with_block do |val|
+      assert_equal 2, val
+    end
+    this.some_method_with_block do |val|
+      assert_equal 3, val
+    end
+    
+    assert_equal [[[],true], [[],true]], this._stubble[:some_method_with_block]
+  end
+  
+  test "track! - can be called multiple times" do
+    this = StubThis.new
+    assert_equal 1, this.some_method
+    
+    Stubble.add_stubble!(this)
+    this.track!(:some_method)
+    this.track!(:some_method)
+    
+    assert_equal 2, this.some_method
+  end
+  
+  test "untrack! - undoes a track" do
+    this = StubThis.new
+    assert_equal 1, this.some_method
+    
+    Stubble.add_stubble!(this)
+    this.track!(:some_method)
+    
+    assert_equal 2, this.some_method
+    assert_equal 1, this._stubble[:some_method].length
+    
+    this.untrack!(:some_method)
+    
+    assert_equal 3, this.some_method
+    assert_equal 1, this._stubble[:some_method].length # no new
+  end
+  
+  test "stub! - defines the next values to be returned" do
+    this = StubThis.new
+    assert_equal 1, this.some_method
+    
+    Stubble.add_stubble!(this)
+    this.stub!(:some_method, [:a, :b, :c])
+    
+    assert_equal :a, this.some_method
+    assert_equal :b, this.some_method
+    assert_equal :c, this.some_method
+    
+    assert_equal 2, this.some_method
+  end
+  
+  test "unstub! - cancels a stub" do
+    this = StubThis.new
+    assert_equal 1, this.some_method
+    
+    Stubble.add_stubble!(this)
+    this.stub!(:some_method, [:a, :b, :c])
+    
+    assert_equal :a, this.some_method
+    
+    this.unstub!(:some_method)
+    
+    assert_equal 2, this.some_method
+    assert_equal 3, this.some_method
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support/testing/declarative'
+$: << File.expand_path(File.dirname(__FILE__)+"/../lib")
+
+class Test::Unit::TestCase
+  extend ActiveSupport::Testing::Declarative
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: stubble
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Rudy Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-17 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: MatthewRudyJacobs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- Rakefile
+- README
+- test/stubble_test.rb
+- test/test_helper.rb
+- lib/stubble.rb
+has_rdoc: true
+homepage: https://github.com/matthewrudy/stubble
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: (experimental) simple stubbing
+test_files: []
+