substituter 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in meta_programming.gemspec
+gemspec
+
+group :development do
+  gem 'guard-minitest'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+   watch(%r{^spec/(.*)_spec\.rb$})
+   watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+   watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 dvallance
+
+MIT License
+
+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.md

@@ -0,0 +1,76 @@
+# Substituter
+
+Substituter is designed to easily override an existing class instance method with a provided Proc. The existing method is renamed and a reference is kept to this original method so that the new Proc that is executed will be able to call the original method and has access to its parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'substituter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install substituter
+
+## Usage
+
+```ruby 
+my_proc = Proc.new{|original_method,*args|
+  "My proc info and original methods value = #{original_method.call(*args)}"
+}
+
+Substituter.sub String, :to_s, my_proc
+puts String.new("So Cool!")
+
+#returns "My proc info and original methods value = So Cool!" 
+
+#to restore the original method just clear the substitute
+Substituter.clear String, :to_s
+
+```
+
+## *args gottcha's
+
+Generally calling `original_method.call(*args)` will work unless args contains a Proc object, which it will if the orginal method is called with a proc parameter or a block.
+
+Note: an _implicit_ _block_ will be turned into a Proc object and appended to the args array.
+
+Proc objects must be passed with the _&_ operator prepended manually.
+
+```ruby
+# our sample class with a method to substitute
+class Sample
+  def taking_a_param_and_block(param)
+    block_given? yield(param) : param
+  end
+end
+
+# our proc we will substitute in for the original method
+my_proc = Proc.new{|original_method,*args|
+  #here we explicitly pass in the arguments, making sure to add '&' to the proc object
+  "My proc info and original methods value = #{original_method.call(args[0], &args[1])}"
+}
+
+Substituter.sub Sample, :taking_a_param_and_block, my_proc
+
+Sample.new.taking_a_param_and_block("Hello") do |param|
+  "#{param} World"
+end
+
+#returns "My proc info and original methods value = Hello World!" 
+
+#see the spec/substituter_spec.rb for examples
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/substituter.rb

@@ -0,0 +1,69 @@
+require "substituter/version"
+def Hijack(klass, method, &aproc)
+  Substituter.sub(klass, method, &aproc)
+end
+
+module Substituter
+
+  @handled_methods = {}
+  @stored_procs = {}
+  @method_rename_prefix = "substituted_"
+
+  class << self
+    attr_accessor :stored_procs
+
+    def clear(klass, method)
+      klass.class_eval %Q(
+        remove_method method
+        alias_method :#{method.to_s}, :#{prefix(method)}
+        remove_method :#{prefix(method)}
+      ), __FILE__, __LINE__
+      @handled_methods[klass.to_s].delete(method)
+    end
+
+    def get_proc klass, method
+      @stored_procs[klass.to_s + method.to_s]
+    end
+
+    def prefix(method)
+      @method_rename_prefix + method.to_s
+    end
+
+    def sub klass, method, &aproc
+      if substituted_methods(klass).include? method
+        raise StandardError, "Already substituted"
+      end 
+
+      klass.class_eval %Q(
+        include Substituter unless ancestors.select{|obj| obj.class == Module}.include?(Substituter)
+        alias_method :#{prefix(method)}, :#{method.to_s}
+        def #{method.to_s}(*args)
+          if block_given?
+            proc_caller(self.class, __method__, *(args << Proc.new))
+          else
+            proc_caller(self.class, __method__, *args) 
+          end
+        end
+      ), __FILE__, __LINE__
+      substituted_method klass, method, &aproc 
+    end
+
+    def substituted_method(klass, method, &aproc)
+      @handled_methods[klass.to_s] = [] unless @handled_methods[klass.to_s].is_a? Array
+      @handled_methods[klass.to_s] << method
+      Substituter.stored_procs[klass.to_s + method.to_s] = aproc
+    end
+
+    def substituted_methods(klass)
+      @handled_methods[klass.to_s].nil? ? [] : @handled_methods[klass.to_s]
+    end
+  end
+
+  #instance methods below
+
+  def proc_caller(klass, method, *args)
+    stored_proc = Substituter.get_proc(klass, method)
+    stored_proc.call(method("#{Substituter.prefix(method)}".to_sym), *args)
+  end
+
+end

data/lib/substituter/version.rb

@@ -0,0 +1,3 @@
+module Substituter
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require_relative '../lib/substituter'
+require 'minitest/spec'
+require 'minitest/autorun'

data/spec/substituter_spec.rb

@@ -0,0 +1,151 @@
+require_relative 'spec_helper'
+
+class SampleClass 
+
+  def one_param(str)
+    str 
+  end
+
+  def two_params(one, two)
+    return [one,two].join(",")
+  end
+
+  def param_and_splat(one, *values)
+    return "#{one.to_s},#{values.join(",")}"
+  end
+
+  def taking_a_proc(&block)
+    block.yield
+  end
+
+  def taking_a_param_and_proc(param, &block)
+    block_given? ? yield(param) : param
+  end
+
+  def taking_a_param_and_block(param)
+    block_given? ? yield(param) : param
+  end
+
+  def to_s
+    "from sample class"
+  end
+end
+
+describe Substituter do
+
+  it ".sub properly allows us to inject a proc to substitute a class instance method " do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(*args)}"
+    }
+    Substituter.sub(SampleClass, :one_param, &myproc)
+    SampleClass.new.one_param("Cool").must_equal "Proc knows original = Cool"
+    Substituter.clear SampleClass, :one_param
+  end
+
+  it ".sub will not allow you to substitute the same method twice" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(*args)}"
+    }
+    Substituter.sub SampleClass, :one_param, &myproc
+    lambda { Substituter.sub SampleClass, :one_param, &myproc }.must_raise(StandardError)
+    Substituter.clear SampleClass, :one_param
+  end
+
+  it ".sub handles two params properly" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(*args)}"
+    }
+    Substituter.sub SampleClass, :two_params, &myproc
+    SampleClass.new.two_params("one","two").must_equal "Proc knows original = one,two"
+    Substituter.clear SampleClass, :two_params
+  end
+  
+  it ".sub handles param and splat" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(*args)}"
+    }
+    Substituter.sub SampleClass, :param_and_splat, &myproc
+    SampleClass.new.param_and_splat(:something,"two","three").must_equal "Proc knows original = something,two,three"
+    Substituter.clear SampleClass, :param_and_splat
+  end
+
+  it ".sub handles taking a block" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(&args[0])}"
+    }
+    Substituter.sub SampleClass, :taking_a_proc, &myproc
+    SampleClass.new.taking_a_proc(&Proc.new{"block value"}).must_equal "Proc knows original = block value"
+    Substituter.clear SampleClass, :taking_a_proc
+  end
+
+  it ".sub handles a param and a proc" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(args[0], &args[1])}"
+    }
+    Substituter.sub SampleClass, :taking_a_param_and_proc, &myproc
+    SampleClass.new.taking_a_param_and_proc("my param"){|p| "block value and #{p}"}.must_equal "Proc knows original = block value and my param"
+    Substituter.clear SampleClass, :taking_a_param_and_proc
+  end
+
+  it ".sub handles a param and a block" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(args[0], &args[1])}"
+    }
+    Substituter.sub SampleClass, :taking_a_param_and_block, &myproc
+    SampleClass.new.taking_a_param_and_block("my param"){|p| "block value and #{p}"}.must_equal "Proc knows original = block value and my param"
+    Substituter.clear SampleClass, :taking_a_param_and_block
+  end
+
+  it ".sub String#to_s" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(*args)}"
+    }
+    Substituter.sub String, :to_s, &myproc
+    String.new("my string").to_s.must_equal "Proc knows original = my string"
+    Substituter.clear String, :to_s
+    String.new("my string").to_s.must_equal "my string"
+  end
+
+  it ".sub String#index" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(*args[0])}"
+    }
+    Substituter.sub String, :index, &myproc
+    String.new("my string").index("my").must_equal("Proc knows original = 0")
+    Substituter.clear String, :index
+  end
+
+  it ".sub String#gsub" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(*args)}"
+    }
+    Substituter.sub String, :gsub, &myproc
+    String.new("my string").gsub("my", "our").must_equal("Proc knows original = our string")
+    Substituter.clear String, :gsub
+  end
+
+  it ".sub Object.instance_of?" do
+    myproc = Proc.new { |original_method, *args|
+      "Proc knows original = #{original_method.call(*args)}"
+    }
+    Substituter.sub Object, :instance_of?, &myproc
+    Object.new().instance_of?(Array).must_equal("Proc knows original = false")
+    Substituter.clear Object, :instance_of?
+  end
+
+  it ".sub will properly handle the same method name put on different objects" do
+    string_proc = Proc.new { |original_method, *args|
+      "String proc with original #{original_method.call(*args)}"
+    }
+    sample_class_proc = Proc.new { |original_method, *args|
+      "Sample proc with original #{original_method.call(*args)}"
+    }
+    Substituter.sub String, :to_s, &string_proc
+    Substituter.sub SampleClass, :to_s, &sample_class_proc
+    SampleClass.new.to_s.must_equal("Sample proc with original from sample class")
+    String.new("test").to_s.must_equal("String proc with original test")
+    Substituter.clear String, :to_s
+    Substituter.clear SampleClass, :to_s
+  end
+
+end

data/substituter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'substituter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "substituter"
+  spec.version       = Substituter::VERSION
+  spec.authors       = ["David Vallance"]
+  spec.email         = ["davevallance@gmail.com"]
+  spec.description   = %q{Substitute an existing method with a Proc. The Proc will have access to the replaced method and its parameters.}
+  spec.summary       = %q{Substitute an existing method with a Proc.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: substituter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Vallance
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Substitute an existing method with a Proc. The Proc will have access
+  to the replaced method and its parameters.
+email:
+- davevallance@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/substituter.rb
+- lib/substituter/version.rb
+- spec/spec_helper.rb
+- spec/substituter_spec.rb
+- substituter.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 768294849277507384
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 768294849277507384
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Substitute an existing method with a Proc.
+test_files:
+- spec/spec_helper.rb
+- spec/substituter_spec.rb