remi-add_hook 0.1.0

data/README.rdoc

@@ -0,0 +1 @@
+see Object#add_hook

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = 'add_hook'
+    s.summary     = 'Easily add callbacks to any method'
+    s.email       = 'remi@remitaylor.com'
+    s.homepage    = 'http://github.com/remi/add_hook'
+    s.description = 'Easily add callbacks to any method'
+    s.authors     = %w( remi )
+    s.files       = FileList['[A-Z]*', '{lib,spec,bin,examples}/**/*'] 
+    # s.add_dependency 'person-gemname'
+    # s.executables << 'script'
+    # s.rubyforge_project = 'gemname'
+    # s.extra_rdoc_files = %w( README.rdoc )
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+# require 'hanna'
+# require 'darkfish-rdoc'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'add_hook'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  # rdoc.options += ["--template=#{`allison --path`}"]  # sudo gem install allison
+  # rdoc.options += %w( -f darkfish )                   # sudo gem install darkfish-rdoc
+  # rdoc.options += %w( -T hanna )                      # sudo gem install mislav-hanna
+  rdoc.options += %w( -m README.rdoc ) # the initial page displayed
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Confirm that gemspec is $SAFE'
+task :safe do
+  require 'yaml'
+  require 'rubygems/specification'
+  data = File.read('add_hook.gemspec')
+  spec = nil
+  if data !~ %r{!ruby/object:Gem::Specification}
+    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+  else
+    spec = YAML.load(data)
+  end
+  spec.validate
+  puts spec
+  puts "OK"
+end
+
+task :default => :spec

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 1

data/lib/add_hook.rb

@@ -0,0 +1,68 @@
+class Object
+
+  # Add as a callback to an instance method
+  #
+  # ==== Usage
+  #
+  #  >> x = [1, 2]
+  #  => [1, 2]
+  #  >> x.add_hook(:<<){|the_array, *args| puts "called #{ the_array.inspect } << #{ args.inspect }" }
+  #  => nil
+  #  >> x << 'foo'
+  #  called [1, 2] << ["foo"]
+  #  => [1, 2, "foo"]
+  #
+  # ==== Parameters
+  # method_name<~to_s>::
+  #   The name of the method to add a hook to
+  #
+  # &block::
+  #   A block to run everytime the method gets called.
+  #   The block is passed multiple arguments. 
+  #   The first argument is self, the instance that the method is being called on. 
+  #   The rest of the arguments are the arguments that were passed to the method.
+  #
+  def add_hook method_name, &block
+
+    # protect against infinite looping
+    return if method_name.to_s == 'add_hook'
+
+    # if we haven't hooked into any methods on this instance yet 
+    # then we need to add a way to persist our hooked methods and callbacks
+    unless self.respond_to? :hooked_methods
+
+      # add some things to this particular object
+      class << self
+        attr_accessor :hooked_methods, :hooked_method_hooks
+      end
+
+      # initalize attributes
+      self.hooked_methods      ||= { }
+      self.hooked_method_hooks ||= { }
+
+    end
+
+    # for now, assume this is an *instance method* that we're hooking
+    method     = self.class.instance_method(method_name.to_s)
+    method_key = method_name.to_s + Time.now.to_s
+
+    if method
+
+      self.hooked_methods[ method_key ]      = method # store the original method
+      self.hooked_method_hooks[ method_key ] = block  # store the block to call
+
+      # using eval because define_method can't create
+      # a method that accepts a block
+      eval %{
+        def self.#{ method_name } *args #, &block
+          self.hooked_method_hooks[#{ method_key.inspect }].call(self, *args)
+          self.hooked_methods[#{ method_key.inspect }].bind(self).call(*args) # add block
+        end
+      }
+
+    else
+      raise "Cannot find method #{ method_name.inspect } to add hook to"
+    end
+  end
+    
+end

data/spec/add_hook_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../lib/add_hook'
+
+def main_method first_arg, second_arg, *splat_of_args
+end
+
+describe Object, '#add_hook' do
+
+  it 'should be able to add a hook to an object in the main scope' do
+    times_called = 0
+    
+    main_method 1, 2, 3, 4, 5
+    times_called.should == 0
+
+    add_hook(:main_method) do |obj, *args|
+      # puts "called main_method on #{ obj } with args: #{ args.inspect }"
+      times_called += 1
+    end
+
+    times_called.should == 0
+    main_method 1, 2, 3, 4, 5
+    times_called.should == 1
+  end
+
+  it 'should be able to add a hook to objects' do
+    object = []
+    times_called = 0
+
+    object << 'x'
+    times_called.should == 0
+
+    object.add_hook(:<<){|obj, *args| times_called += 1 }
+
+    object << 'x'
+    times_called.should == 1
+
+    object << 'x'
+    times_called.should == 2
+
+    # should not effect other arrays
+    object = []
+    object << 'x'
+    times_called.should == 2 # should still be 2
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--format specdoc
+--loadby mtime

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: remi-add_hook
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- remi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-06 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Easily add callbacks to any method
+email: remi@remitaylor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- VERSION.yml
+- README.rdoc
+- lib/add_hook.rb
+- spec/add_hook_spec.rb
+- spec/spec.opts
+has_rdoc: true
+homepage: http://github.com/remi/add_hook
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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.2.0
+signing_key: 
+specification_version: 2
+summary: Easily add callbacks to any method
+test_files: []
+