mynyml-swap 0.1.1 → 0.2

data/README

@@ -4,27 +4,29 @@ Swap allows dynamically replacing and restoring methods.
 Useful as a stubbing device, as it allows unstubbing as well.
 
 ==== Examples
-  # We can use ruby2ruby to inspect changes
-  require 'ruby2ruby'
+
+  require 'swap'
 
   class User
-    attr_accessor :name
+    extend Swappable
+
+    attr_writer :name
+    def name
+      @name
+    end
   end
+
   user = User.new
   user.name = 'martin'
-  puts user.name #=> 'martin'
-
-  puts Ruby2Ruby.translate(User, :name)
+  user.name #=> 'martin'
 
   User.swap!(:name) { @name.reverse }
-  puts user.name #=> 'nitram'
-
-  puts Ruby2Ruby.translate(User, :name)
+  user.name #=> 'nitram'
 
   User.unswap!(:name)
-  puts user.name #=> 'martin'
+  user.name #=> 'martin'
 
-  puts Ruby2Ruby.translate(User, :name)
+Calling #unswap! without argument will restore all swapped methods.
 
+See also examples/simple.rb
 
-Calling #unswap! without argument will restore all swapped methods.

data/Rakefile

@@ -1,49 +1,25 @@
-require 'rake/gempackagetask'
-require 'pathname'
-require 'yaml'
-
-def gem
-  RUBY_1_9 ? 'gem19' : 'gem'
-end
-
-def all_except(paths)
-  Dir['**/*'] - paths.map {|path| path.strip.gsub(/^\//,'').gsub(/\/$/,'') }
-end
-
-spec = Gem::Specification.new do |s|
-  s.name            = 'swap'
-  s.version         = '0.1.1'
-  s.summary         = "Ruby lib that allows dynamically replacing and restoring methods."
-  s.description     = "Ruby lib that allows dynamically replacing and restoring methods. Organic stubbing/unstubbing."
-  s.author          = "Martin Aumont"
-  s.email           = 'mynyml@gmail.com'
-  s.homepage        = ''
-  s.has_rdoc        = true
-  s.require_path    = "lib"
-  s.files           = Dir['**/*']
+require 'rake/rdoctask'
+begin
+  require 'yard'
+rescue LoadError, RuntimeError
 end
 
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
+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
-
-
-desc "Remove package products"
-task :clean => :clobber_package
-
-desc "Update the gemspec for GitHub's gem server"
-task :gemspec do
-  Pathname("#{spec.name}.gemspec").open('w') {|f| f << YAML.dump(spec) }
-end
-
-desc "Install gem"
-task :install => [:clobber, :package] do
-  sh "#{SUDO} #{gem} install pkg/#{spec.full_name}.gem"
-end
-
-desc "Uninstall gem"
-task :uninstall => :clean do
-  sh "#{SUDO} #{gem} uninstall -v #{spec.version} -x #{spec.name}"
-end
-
-

data/examples/simple.rb

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

data/lib/swap.rb

@@ -1,4 +1,13 @@
-class Class
+
+# Swappable mixin.
+#
+# ===== Examples
+#
+#   Class User
+#     extend Swappable
+#   end
+#
+module Swappable
 
   # Swaps a method for another
   #
@@ -15,10 +24,11 @@ class Class
   # 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))
+  #
+  #   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
@@ -49,18 +59,19 @@ class Class
   # 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'
+  #   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'
+  #   User.unswap!(:name)
+  #   puts user.name #=> 'martin'
   #
   def unswap!(name=nil)
     if name

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

@@ -1,64 +1,26 @@
---- !ruby/object:Gem::Specification 
-name: swap
-version: !ruby/object:Gem::Version 
-  version: 0.1.1
-platform: ruby
-authors: 
-- Martin Aumont
-autorequire: 
-bindir: bin
-cert_chain: []
-
-date: 2009-03-18 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: Ruby lib that allows dynamically replacing and restoring methods. Organic stubbing/unstubbing.
-email: mynyml@gmail.com
-executables: []
-
-extensions: []
-
-extra_rdoc_files: []
-
-files: 
-- lib
-- lib/swap.rb
-- examples
-- examples/simple.rb
-- LICENSE
-- README
-- Rakefile
-- test
-- test/test_swap.rb
-- test/test_helper.rb
-- swap.gemspec
-- TODO
-has_rdoc: true
-homepage: ""
-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: Ruby lib that allows dynamically replacing and restoring methods.
-test_files: []
-
+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

@@ -1,10 +1,16 @@
+require 'pathname'
 require 'test/unit'
-require 'rubygems'
+
 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

@@ -1,12 +1,10 @@
-require 'pathname'
-root  =  Pathname(__FILE__).dirname.parent
-require root.join('test/test_helper')
-require root.join('lib/swap')
+require 'test/test_helper'
 
 class SwapTest < Test::Unit::TestCase
   context "Swap" do
     before do
       class ::Kitty
+        extend Swappable
         def say() 'ohaie' end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mynyml-swap
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: "0.2"
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-17 21:00:00 -07:00
+date: 2009-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Ruby lib that allows dynamically replacing and restoring methods. Organic stubbing/unstubbing.
+description: Organically replace/restore, stub/unstub methods.
 email: mynyml@gmail.com
 executables: []
 
@@ -22,20 +22,19 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib
-- lib/swap.rb
-- examples
-- examples/simple.rb
 - LICENSE
 - README
+- TODO
 - Rakefile
-- test
-- test/test_swap.rb
+- lib/swap.rb
 - test/test_helper.rb
+- test/test_swap.rb
+- examples/simple.rb
+- specs.watchr
 - swap.gemspec
-- TODO
 has_rdoc: true
-homepage: ""
+homepage: http://mynyml.com
+licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -56,9 +55,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
-summary: Ruby lib that allows dynamically replacing and restoring methods.
-test_files: []
-
+summary: Organically replace/restore, stub/unstub methods
+test_files: 
+- test/test_swap.rb