swap 0.2

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+
+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,32 @@
+==== Summary
+
+Swap allows dynamically replacing and restoring methods.
+Useful as a stubbing device, as it allows unstubbing as well.
+
+==== Examples
+
+  require 'swap'
+
+  class User
+    extend Swappable
+
+    attr_writer :name
+    def name
+      @name
+    end
+  end
+
+  user = User.new
+  user.name = 'martin'
+  user.name #=> 'martin'
+
+  User.swap!(:name) { @name.reverse }
+  user.name #=> 'nitram'
+
+  User.unswap!(:name)
+  user.name #=> 'martin'
+
+Calling #unswap! without argument will restore all swapped methods.
+
+See also examples/simple.rb
+

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake/rdoctask'
+begin
+  require 'yard'
+rescue LoadError, RuntimeError
+end
+
+desc "Generate rdoc documentation."
+Rake::RDocTask.new(:rdoc => 'rdoc', :clobber_rdoc => 'rdoc:clean', :rerdoc => 'rdoc:force') { |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "Swap"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.main = 'README'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('TODO')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+if defined? YARD
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = %w( lib/**/*.rb )
+    t.options = %w( -o doc/yard --readme README --files LICENSE,TODO )
+  end
+end

data/examples/simple.rb

@@ -0,0 +1,47 @@
+# Run me with:
+#
+#   ruby -rubygems examples/simple.rb
+#
+
+require 'swap'
+
+# and let's spy on the source
+require 'parse_tree_extensions'
+require 'ruby2ruby'
+
+class User
+  extend Swappable
+  attr_writer :name
+  def name
+    @name
+  end
+end
+
+user = User.new
+user.name = 'martin'
+puts user.name
+#=> 'martin'
+
+puts user.method(:name).to_ruby
+#=> def name
+#=>   @name
+#=> end
+
+User.swap!(:name) { @name.reverse }
+puts user.name
+#=> 'nitram'
+
+puts user.method(:name).to_ruby
+#=> def name
+#=>   @name.reverse
+#=> end
+
+User.unswap!(:name)
+puts user.name
+#=> 'martin'
+
+puts user.method(:name).to_ruby
+#=> def name
+#=>   @name
+#=> end
+

data/lib/swap.rb

@@ -0,0 +1,87 @@
+
+# Swappable mixin.
+#
+# ===== Examples
+#
+#   Class User
+#     extend Swappable
+#   end
+#
+module Swappable
+
+  # Swaps a method for another
+  #
+  # ==== Arguments
+  # name<Symbol>::
+  #   Name of original method to swap
+  # code<String|Proc|UnboundMethod>::
+  #   New code for method
+  #
+  # ==== Block
+  # Alternative way to pass method code
+  #
+  # ==== Returns
+  # self
+  #
+  # ==== Examples
+  #
+  #   User.swap!(:name, "@name.reverse")
+  #   User.swap!(:name, lambda { @name.reverse })
+  #   User.swap!(:name) { @name.reverse }
+  #   User.swap!(:name, User.instance_method(:first_name))
+  #
+  def swap!(name, code=nil, &block)
+    name = name.to_sym
+    meth = self.instance_method(name.to_sym)
+    @swapped_methods ||= {}
+    @swapped_methods[name] = meth
+    if block_given?
+      self.class_eval { define_method(name, &block) }
+    else
+      case code
+      when String
+        self.class_eval(%|def #{name}() #{code}; end|)
+      when Proc, UnboundMethod
+        self.class_eval { define_method(name, code) }
+      end
+    end
+    self
+  end
+
+  # Restores a swapped method
+  #
+  # ==== Arguments
+  # name<String>::
+  #   Name of method to restore. If nil, all swapped methods for this class
+  #   will be restored.
+  #
+  # ==== Returns
+  # self
+  #
+  # ==== Examples
+  #
+  #   class User
+  #     attr_accessor :name
+  #   end
+  #   user = User.new
+  #   user.name = 'martin'
+  #   puts user.name #=> 'martin'
+  #
+  #   User.swap!(:name) { @name.reverse }
+  #   puts user.name #=> 'nitram'
+  #
+  #   User.unswap!(:name)
+  #   puts user.name #=> 'martin'
+  #
+  def unswap!(name=nil)
+    if name
+      name = name.to_sym
+      self.class_eval { define_method(name, @swapped_methods[name]) }
+    else
+      @swapped_methods.each do |name, code|
+        self.class_eval { define_method(name, code) }
+      end
+    end
+    self
+  end
+end

data/specs.watchr

@@ -0,0 +1,24 @@
+# Run me with:
+#
+#   $ watchr specs.watchr
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch( '^test/test_swap\.rb'   )  { system "ruby -rubygems test/test_swap.rb"  }
+watch( '^lib/swap\.rb'         )  { system "ruby -rubygems test/test_swap.rb"  }
+watch( '^test/test_helper\.rb' )  { system "ruby -rubygems test/test_swap.rb"  }
+watch( '^examples/simple\.rb'  )  { system "ruby -rubygems examples/simple.rb"; puts '-'*30  }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  system "ruby -rubygems test/test_swap.rb" 
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }
+

data/swap.gemspec

@@ -0,0 +1,26 @@
+spec = Gem::Specification.new do |s|
+  s.name            = 'swap'
+  s.version         = '0.2'
+  s.summary         = "Organically replace/restore, stub/unstub methods"
+  s.description     = "Organically replace/restore, stub/unstub methods."
+  s.author          = "Martin Aumont"
+  s.email           = 'mynyml@gmail.com'
+  s.homepage        = 'http://mynyml.com'
+  s.has_rdoc        = true
+  s.require_path    = "lib"
+  s.files           = %w[
+    LICENSE
+    README
+    TODO
+    Rakefile
+    lib/swap.rb
+    test/test_helper.rb
+    test/test_swap.rb
+    examples/simple.rb
+    specs.watchr
+    swap.gemspec
+  ]
+  s.test_files      = %w[
+    test/test_swap.rb
+  ]
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'pathname'
+require 'test/unit'
+
+require 'context'
+require 'matchy'
+begin
+  require 'redgreen'
+  require 'ruby-debug'
+  require 'quietbacktrace'
+rescue LoadError, RuntimeError
+  # pass
+end
+
+$:.unshift Pathname(__FILE__).dirname.parent + 'lib'
+
+require 'swap'

data/test/test_swap.rb

@@ -0,0 +1,57 @@
+require 'test/test_helper'
+
+class SwapTest < Test::Unit::TestCase
+  context "Swap" do
+    before do
+      class ::Kitty
+        extend Swappable
+        def say() 'ohaie' end
+      end
+    end
+    after do
+      Object.class_eval { remove_const(:Kitty) }
+      defined?(::Kitty).should be(nil)
+    end
+    context "replacing instance method" do
+      test "accepts string" do
+        Kitty.swap!(:say, %( 'kthxbai'.reverse ))
+        Kitty.new.say.should be('kthxbai'.reverse)
+      end
+      test "accepts block" do
+        Kitty.swap!(:say) { 'kthxbai' }
+        Kitty.new.say.should be('kthxbai')
+      end
+      test "accepts proc" do
+        Kitty.swap!(:say, lambda { 'kthxbai' })
+        Kitty.new.say.should be('kthxbai')
+      end
+      test "accepts unbound method" do
+        class ::Kitty
+          def bai() 'kthxbai' end
+        end
+        Kitty.swap!(:say, Kitty.instance_method(:bai))
+        Kitty.new.say.should be('kthxbai')
+      end
+    end
+    context "reseting original methods" do
+      test "restores single method" do
+        Kitty.swap!(:say) { 'kthxbai' }
+        Kitty.new.say.should be('kthxbai')
+        Kitty.unswap!(:say)
+        Kitty.new.say.should be('ohaie')
+      end
+      test "restores all methods" do
+        class ::Kitty
+          def bai() 'kthxbai' end
+        end
+        Kitty.swap!(:say) { 'o.0'  }
+        Kitty.swap!(:bai) { 'zZzz' }
+        Kitty.new.say.should be('o.0' )
+        Kitty.new.bai.should be('zZzz')
+        Kitty.unswap!
+        Kitty.new.say.should be('ohaie')
+        Kitty.new.bai.should be('kthxbai')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: swap
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-23 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Organically replace/restore, stub/unstub methods.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- TODO
+- Rakefile
+- lib/swap.rb
+- test/test_helper.rb
+- test/test_swap.rb
+- examples/simple.rb
+- specs.watchr
+- swap.gemspec
+has_rdoc: true
+homepage: http://mynyml.com
+licenses: []
+
+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.5
+signing_key: 
+specification_version: 3
+summary: Organically replace/restore, stub/unstub methods
+test_files: 
+- test/test_swap.rb