override 0.0.8

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Michel Martens
+
+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.markdown

@@ -0,0 +1,111 @@
+Override
+============
+
+The as-simple-as-possible-but-not-simpler stubbing library.
+
+Description
+-----------
+
+Override is the essence of the stubbing concept: it takes an object,
+a hash of methods/results, and proceeds to rewrite each method in the
+object. It can be used as a stubbing strategy in most cases, and I'd
+say that cases that don't fit this pattern have a very bad code smell,
+because are either dealing with internals or with side effects.
+
+Usage
+-----
+
+    require 'override'
+
+    include Override
+
+    user = User.spawn
+    override(user, :name => "Foobar", :email => "foobar@example.org")
+    override(User, :find => user)
+
+Or alternatively:
+
+    override(User, :find => override(User.spawn, :name => "Foobar, :email => "foobar@example.org"))
+
+You can also send lambdas that will become the body of the redefined method:
+
+    user = User.spawn :name => "Foobar"
+    override(User, :find => lambda { |id| raise ArgumentError unless id == 1; user })
+
+And then, in your tests:
+
+    assert_raise ArgumentError do
+      User.find(2)
+    end
+
+    assert_nothing_raised do
+      User.find(1)
+    end
+
+    assert_equal "Foobar", User.find(1).name
+
+In case you don't know what spawn means, check my library [Spawner](http://github.com/soveran/spawner).
+
+It is a common pattern to set expectations for method calls. You can do
+it with the `expect` function:
+
+    user = User.spawn :name => "Foobar"
+    expect(User, :find, :with => [:first, { :include => :friendships }], :return => user)
+
+And then:
+
+    assert_equal "Foobar", User.find(:first, :include => :friendships).name
+
+This kind of tests encourage a very fine grained development
+style. Testing side effects is possible with this and with many other
+libraries, but it's something that should be avoided as much as
+possible. Always keep in mind that a deterministic function is the
+easiest to test, so the less coupling there is in the system, the more
+reliable it becomes.
+
+Note that this way of setting expectations doesn't count the number
+of calls received by the redefined method. The RSpec equivalent of
+`User.should_receive(:find).with(:first, :include => :friendships)`
+triggers an exception if the method is not called. While it is a handy
+feature, it encourages coupling and testing internals, so my advice
+would be to use it scarcely and to try to refactor your code so it
+doesn't follow this testing anti-pattern. Check the tests for more
+examples.
+
+Installation
+------------
+
+    $ gem sources -a http://gems.github.com (you only have to do this once)
+    $ sudo gem install soveran-override
+
+Thanks
+------
+
+Thanks to Tim Goh for his advice of using a hash for rewriting multiple
+methods at once.
+
+License
+-------
+
+Copyright (c) 2009 Michel Martens
+
+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/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/clean'
+
+gem_spec_file = 'override.gemspec'
+
+gem_spec = eval(File.read(gem_spec_file)) rescue nil
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+  rm_f FileList['pkg/**/*.*']
+end if gem_spec
+
+desc "Generate the gemspec file."
+task :gemspec do
+  require 'erb'
+
+  File.open(gem_spec_file, 'w') do |f|
+    f.write ERB.new(File.read("#{gem_spec_file}.erb")).result(binding)
+  end
+end
+
+desc "Builds and installs the gem."
+task :install => :repackage do
+  `sudo gem install pkg/#{gem_spec.name}-#{gem_spec.version}.gem`
+end

data/lib/override.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "metaid"
+
+module Override
+  def override object, methods
+    methods.each do |method, result|
+      result.respond_to?(:to_proc) ?
+        object.meta_def(method, &result.to_proc) :
+        object.meta_def(method) { |*_| result }
+    end
+    object
+  end
+
+  def expect object, method, options
+    expectation = lambda do |*params|
+      raise ArgumentError unless params == options[:with]
+      options[:return]
+    end
+    override(object, method => expectation)
+  end
+end

data/test/all_test.rb

@@ -0,0 +1,241 @@
+require 'test/unit'
+require 'rubygems'
+require 'contest'
+
+require File.dirname(__FILE__) + "/../lib/override"
+
+class Foo
+  def bar
+    "Bar"
+  end
+
+  def baz
+    yield "Baz"
+  end
+
+  def qux a, b, c
+    "Qux"
+  end
+
+  def nom
+    Bar.foo(1, 2, 3)
+    true
+  end
+
+  def == other
+    bar == other.bar
+  end
+end
+
+class Bar
+  def self.foo(a, b, c)
+    "Bar/Foo"
+  end
+end
+
+class Callable
+  def to_proc
+    lambda do |name|
+      "Hello #{name}"
+    end
+  end
+end
+
+class TestOverride < Test::Unit::TestCase
+  include Override
+
+  context "dealing with arguments" do
+    setup do
+      @foo = Foo.new
+      override(@foo, :bar => "Hello")
+    end
+
+    should "work without arguments" do
+      assert_equal "Hello", @foo.bar
+    end
+
+    should "discard arguments" do
+      assert_equal "Hello", @foo.bar(1)
+    end
+  end
+
+  context "accepting different return values" do
+    setup do
+      @foo = Foo.new
+      @foo2 = Foo.new
+    end
+
+    should "work for string returns" do
+      override(@foo, :bar => "Hello")
+      assert_equal "Hello", @foo.bar
+    end
+
+    should "work for numeric returns" do
+      override(@foo, :bar => 23)
+      assert_equal 23, @foo.bar
+    end
+
+    should "work for object returns" do
+      override(@foo, :bar => @foo2)
+      assert_equal @foo2, @foo.bar
+    end
+  end
+
+  context "working with methods that acepted attributes or blocks" do
+    setup do
+      @foo = Foo.new
+    end
+
+    should "work for methods that used to receive blocks" do
+      override(@foo, :baz => "Hey!")
+      assert_equal "Hey!", @foo.baz { |x| x }
+    end
+
+    should "work for methods that used to receive arguments" do
+      override(@foo, :qux => "Yay!")
+      assert_equal "Yay!", @foo.qux(1, 2, 3)
+    end
+  end
+
+  context "rewriting multiple methods at once" do
+    should "override all the passed methods" do
+      override(@foo, :bar => 1, :baz => 2, :qux => 3)
+      assert_equal 1, @foo.bar
+      assert_equal 2, @foo.baz
+      assert_equal 3, @foo.qux
+    end
+  end
+
+  context "chaining successive calls" do
+    should "return the object and allow chained calls" do
+      assert_equal 1, override(@foo, :bar => 1).bar
+    end
+  end
+
+  context "dealing with a proc as the result value" do
+    should "uses the proc as the body of the method" do
+      override(@foo, :bar => lambda { |name| "Hello #{name}" })
+      assert_equal "Hello World", @foo.bar("World")
+    end
+  end
+
+  context "using assert raise with lambdas" do
+    setup do
+      class User
+        def name
+          "Michel"
+        end
+      end
+
+      user = User.new
+      override(@foo, :bar => lambda { |id| raise ArgumentError unless id == 1; user })
+    end
+
+    should "lambdas should be able to raise exceptions" do
+      assert_raise ArgumentError do
+        @foo.bar(2)
+      end
+
+      assert_nothing_raised do
+        @foo.bar(1)
+      end
+
+      assert_equal "Michel", @foo.bar(1).name
+    end
+  end
+
+  context "documenting a gotcha with lambdas" do
+    setup do
+      name = "Michel"
+      @name = "Michel"
+      override(@foo, :bar => lambda { name })
+      override(@foo, :baz => lambda { @name })
+    end
+
+    should "succeeds when the lambda returns a local variable" do
+      assert_equal "Michel", @foo.bar
+    end
+
+    should "fails when the lambda is supposed to return an instance variable" do
+      assert_equal nil, @foo.baz
+    end
+  end
+
+  context "using objects that respond to to_proc" do
+    setup do
+      override(@foo, :bar => Callable.new)
+    end
+
+    should "coerces the value into a proc" do
+      assert_equal "Hello World", @foo.bar("World")
+    end
+  end
+
+  context "supporting procs as return values" do
+    setup do
+      override(@foo, :bar => lambda { lambda { "Hey!" } })
+    end
+
+    should "returns a lambda if it's wraped inside a proc" do
+      assert_equal "Hey!", @foo.bar.call
+    end
+  end
+
+  context "setting expectations" do
+    setup do
+      expect(@foo, :bar, :with => ["Michel", 32], :return => true)
+    end
+
+    should "raises an error if expectations are not met" do
+      assert_raise ArgumentError do
+        @foo.bar "Michel", 31
+      end
+    end
+
+    should "succeeds if expectations are met" do
+      assert_nothing_raised do
+        @foo.bar "Michel", 32
+      end
+    end
+  end
+
+  context "setting expectations with hashes in the param list" do
+    setup do
+      expect(@foo, :bar, :with => ["Michel", { :include => :friendships, :select => "name" }], :return => true)
+    end
+
+    should "succeeds if expectations are met" do
+      assert_nothing_raised do
+        @foo.bar "Michel", { :select => "name", :include => :friendships, :select => "name" }
+      end
+    end
+  end
+
+  context "side effects" do
+    setup do
+      @foo = Foo.new
+      expect(Bar, :foo, :with => [1, 2, 3], :return => "Bar/Bar")
+    end
+
+    should "don't affect the interface" do
+      assert_equal true, @foo.nom
+    end
+
+    should "detect the method call as a side effect" do
+      override(Bar, :foo => lambda { |*_| raise ArgumentError })
+      assert_raise ArgumentError do
+        @foo.nom
+      end
+    end
+
+    should "don't affect the interfaces!" do
+      @foo = Foo.new
+      expect(Bar, :foo, :with => [1, 2, 3], :return => "Bar/Bar")
+      assert_equal true, @foo.nom
+      override(Bar, :foo => lambda { |*_| raise ArgumentError })
+      assert_raise ArgumentError do
+        @foo.nom
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: override
+version: !ruby/object:Gem::Version 
+  version: 0.0.8
+platform: ruby
+authors: 
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-13 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: metaid
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: 
+email: michel@soveran.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/override.rb
+- README.markdown
+- LICENSE
+- Rakefile
+- test/all_test.rb
+has_rdoc: false
+homepage: http://github.com/soveran/override
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: The as-simple-as-possible-but-not-simpler stubbing library.
+test_files: []
+