monkey_patcher 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Matt Aimonetti
+
+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.rdoc

@@ -0,0 +1,62 @@
+= monkey_patcher
+
+Dead simple - not so useful gem helping you keep track of your monkey patches.
+In other words, this gem lets you keep track of modifications made on some "base" code, classes/methods tempered with can be easily found and the modifying code can be spotted. 
+
+== Example:
+
+    require 'monkey_patcher'
+
+    # base code
+    class Foo
+      def bar; 'original Foo#bar'; end
+    end
+
+    # monkey patch #1
+    class Foo
+      include MonkeyPatcher
+      monkey_trace("Reopening Foo to add a couple methods necessary for the README",
+                    File.expand_path(__FILE__))
+  
+      def self.bar; 'class method bar'; end
+      def bar; 'modified Foo#bar'; end
+      def baz; 'added Foo#baz'; end
+    end
+
+    # monkey patch #2
+    class Foo
+      include MonkeyPatcher
+      monkey_trace("Just to show it works",
+                    File.expand_path(__FILE__))
+      def bar; 'patched another time'; end
+    end
+
+    puts "Foo was tempered" if Foo.monkey_patched?
+    puts Foo.patched_methods
+    puts Foo.patched_methods.first.desc
+
+=== Output:
+
+    Foo was tempered
+    Foo.bar - patched in /Users/mattetti/Desktop/test.rb - Reopening Foo to add a couple methods necessary for the README
+    bar - patched in /Users/mattetti/Desktop/test.rb - Reopening Foo to add a couple methods necessary for the README
+    baz - patched in /Users/mattetti/Desktop/test.rb - Reopening Foo to add a couple methods necessary for the README
+    bar - patched in /Users/mattetti/Desktop/test.rb - Just to show it works
+
+== Misc
+
+The description and origin of the patch are cached in the modified class, if the same class is reopened without defining a new description and origin, the previously settings will be used. So if you see a method monkey patched 5 times in the same file when you really only monkey patched once, that means that the file was modified in other 'untraced' places.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Matt Aimonetti. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "monkey_patcher"
+    gem.summary = %Q{Dead simple - not so useful gem helping you keep track of your monkey patches.}
+    gem.description = %Q{Keep track of where you monkey patch your code.}
+    gem.email = "mattaimonetti@gmail.com"
+    gem.homepage = "http://github.com/mattetti/monkey_patcher"
+    gem.authors = ["Matt Aimonetti"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "monkey_patcher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/monkey_patcher.rb

@@ -0,0 +1,54 @@
+class Object
+  def self.monkey_patched?
+    self.respond_to?(:patched_methods) && !patched_methods.empty?
+  end
+end
+
+module MonkeyPatcher
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  class AppendedMethodInfo
+    attr_accessor :name, :desc, :origin
+    def to_s
+      "#{name} - patched in #{origin || 'an untraced file'} - #{desc}"
+    end
+  end
+  
+  module ClassMethods
+    def monkey_trace(desc, file_path=nil)
+      @desc = desc
+      @current_monkey_patch_file = file_path
+    end
+    
+    def patched_methods
+      @patched_methods || []
+    end
+    
+    def method_added(method_name)
+      log_monkey_patch(method_name)
+      # call super in case someone else is hooking into the method addition
+      super
+    end
+    
+    def singleton_method_added(method_name)
+      log_monkey_patch(method_name, true)
+      # call super in case someone else is hooking into the method addition
+      super
+    end
+    
+    private
+    
+    def log_monkey_patch(method_name, klass_meth=false)
+      a_meth        = AppendedMethodInfo.new
+      a_meth.name   = klass_meth ? "#{name}.#{method_name}" : method_name
+      a_meth.origin = @current_monkey_patch_file
+      a_meth.desc   = @desc
+      
+      @patched_methods ||= []
+      @patched_methods << a_meth
+    end
+  end
+  
+end

data/monkey_patcher.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{monkey_patcher}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Aimonetti"]
+  s.date = %q{2010-06-06}
+  s.description = %q{Keep track of where you monkey patch your code.}
+  s.email = %q{mattaimonetti@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/monkey_patcher.rb",
+     "monkey_patcher.gemspec",
+     "test/example.rb",
+     "test/helper.rb",
+     "test/test_monkey_patcher.rb"
+  ]
+  s.homepage = %q{http://github.com/mattetti/monkey_patcher}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Dead simple - not so useful gem helping you keep track of your monkey patches.}
+  s.test_files = [
+    "test/example.rb",
+     "test/helper.rb",
+     "test/test_monkey_patcher.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/example.rb

@@ -0,0 +1,25 @@
+require_relative '../lib/monkey_patcher'
+
+class Foo
+  def bar; 'original Foo#bar'; end
+end
+
+class Foo
+  include MonkeyPatcher
+  monkey_trace("Reopening Foo to add a couple methods necessary for the README",
+                File.expand_path(__FILE__))
+  
+  def self.bar; 'class method bar'; end
+  def bar; 'modified Foo#bar'; end
+  def baz; 'added Foo#baz'; end
+end
+
+class Foo
+  include MonkeyPatcher
+  monkey_trace("Just to show it works",
+                File.expand_path(__FILE__))
+  def bar; 'patched another time'; end
+end
+
+puts "Foo was tempered" if Foo.monkey_patched?
+puts Foo.patched_methods

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'monkey_patcher'
+
+class Test::Unit::TestCase
+end

data/test/test_monkey_patcher.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMonkeyPatcher < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: monkey_patcher
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Aimonetti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-06 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Keep track of where you monkey patch your code.
+email: mattaimonetti@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/monkey_patcher.rb
+- monkey_patcher.gemspec
+- test/example.rb
+- test/helper.rb
+- test/test_monkey_patcher.rb
+has_rdoc: true
+homepage: http://github.com/mattetti/monkey_patcher
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Dead simple - not so useful gem helping you keep track of your monkey patches.
+test_files: 
+- test/example.rb
+- test/helper.rb
+- test/test_monkey_patcher.rb