hook_me_up 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/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hook_me_up.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chen Fisher
+
+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,118 @@
+
+# HookMeUp
+
+This gem lets you create hook methods for any method of any class.  
+You can create a `:before` and `:after` hooks for any method you like.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hook_me_up'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hook_me_up
+
+## Usage
+
+1. Include HookMeUp in your class
+2. call `hook_me_up` with a method name or array of methods and specify `:before` hook, `:after` hook or both.
+
+NOTE: `hook_me_up` call **must** come after your method definitions
+
+
+	class SomeClass
+		include HookMeUp
+
+		def some_method
+		end
+
+		def some_other_method
+		end
+
+		def before_hook
+		end
+
+		def after_hook
+		end
+
+		hook_me_up [:some_method, :some_other_method], :before => :before_hook, :after => :after_hook
+	end
+
+
+###You can pass lambda to the hooks instead of methods
+
+	hook_me_up :some_method, :before => lambda{ |sender, *args| sender.do_something(args) },
+			:after => lambda{ |sender, *args, result| sender.do_something_else(result) }
+
+## Arguments
+
+### When called with method names
+The `:before` hook is passed with an optional `*args`, which are the arguments passed to the original method:  
+
+	def before(*args)
+	end
+
+The `:after` hook is passed with optional two arguments:  
+
+	def after(*args, result)
+	end
+
+Where `result` is the result of the original method
+
+### When called with lamdba
+There is an additional, mandatory, argument: **sender**, which is the class instance of the original method:
+
+	hook_me_up :some_method, :before => lambda{ |sender, *args| ... },
+		:after => lambda{ |sender, @args, result| ... }
+
+
+## Examples (Controller)
+The following two examples show how to use `hook_me_up` in a controller,
+which actually does the same as `before_filter`; this is just for the sake of demonstration and can be done with models, 'regular' classes and so on...
+
+
+### With lambda
+	class HomeController < ApplicationController
+		include HookMeUp
+
+		def index
+			render :text => "hello there #{params[:name]}"
+		end
+
+		hook_me_up :index, 
+			:before => lambda{ |controller, *args| controller.params[:name] = controller.current_user.name }
+	end
+
+
+### With method name
+	class HomeController < ApplicationController
+		include HookMeUp
+
+		def index
+			render :text => "hello there #{params[:name]}"
+		end
+
+		hook_me_up :index, 
+			:before => :do_this_before
+
+		private
+
+			def do_this_before
+				params[:name] = current_user.name
+			end
+	end
+
+
+## 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,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/hook_me_up.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hook_me_up/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hook_me_up"
+  gem.version       = HookMeUp::VERSION
+  gem.authors       = ["Chen Fisher"]
+  gem.email         = ["chen.fisher@gmail.com"]
+  gem.description   = %q{Lets you hook any method class with :before and :after hooks}
+  gem.summary       = %q{This gem lets you hook and method in any class with a before and after hooks}
+  gem.homepage      = ""
+
+  gem.add_development_dependency "rspec"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/hook_me_up/version.rb

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

data/lib/hook_me_up.rb

@@ -0,0 +1,45 @@
+require "hook_me_up/version"
+
+module HookMeUp
+	module ClassMethods
+		def hook_me_up(*args)
+			hooks = args.last.is_a?(::Hash) ? args.pop : {}
+
+			args.each do |method|
+				original_method = self.instance_method(method)
+
+				self.send(:define_method, method) do |*a|
+					if hooks[:before]
+						if hooks[:before].is_a? Proc
+							hooks[:before].call(self, *a)
+						else
+							self.send(hooks[:before], *a)
+						end
+					end
+					
+					result = original_method.bind(self).call(*a)
+
+
+					if hooks[:after]
+						if hooks[:after].is_a? Proc
+							hooks[:after].call(self, *a, result)
+						else
+							self.send(hooks[:after], *a, result)
+						end
+					end
+
+					result
+				end
+			end
+		end
+	end
+	
+	module InstanceMethods
+		
+	end
+	
+	def self.included(receiver)
+		receiver.extend         ClassMethods
+		receiver.send :include, InstanceMethods
+	end
+end

data/spec/hook_me_up/sample_class.rb

@@ -0,0 +1,9 @@
+class	SampleClass
+	def method_one(value)
+		value
+	end
+
+	def method_two
+		'method_two'
+	end
+end

data/spec/hook_me_up_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'hook_me_up/sample_class'
+
+describe HookMeUp do
+	before(:each) do
+		@sample = SampleClass.new
+	end
+
+	it "hooks a before and after methods" do
+		class << @sample
+			include HookMeUp
+
+			hook_me_up :method_one, :before => :before_hook, 
+				:after => :after_hook
+
+			def before_hook(*args)
+			end
+
+			def after_hook(*args, result)
+			end
+		end
+
+		@sample.should_receive(:before_hook).with('args')
+		@sample.should_receive(:after_hook).with('args', 'args')
+
+		@sample.method_one('args').should eq 'args'
+	end
+
+	it "can receive a block as a before or after hooks" do
+		class << @sample
+			include HookMeUp
+
+			attr_accessor :before, :after
+
+			hook_me_up :method_one, :before => lambda{ |sender, *args| sender.before = true }, 
+				:after => lambda{ |sender, *args, result| sender.after = true }
+		end
+
+		@sample.method_one('args').should eq 'args'
+
+		@sample.before.should eq true
+		@sample.after.should eq true
+	end
+
+
+	it "can receive multiple methods to hook" do
+		class << @sample
+			include HookMeUp
+
+			attr_accessor :before, :after
+
+			hook_me_up :method_one, :method_two, :before => :before_hook, :after => :after_hook
+
+			def before_hook(*args)
+			end
+
+			def after_hook(*args, result)
+			end
+		end
+
+		@sample.should_receive(:before_hook).exactly(2)
+		@sample.should_receive(:after_hook).exactly(2)
+
+		@sample.method_one('args').should eq 'args'
+		@sample.method_two.should eq 'method_two'
+	end
+
+	it "should not call before or after if not defined" do
+		class << @sample
+			include HookMeUp
+
+			hook_me_up :method_one, :before => :before_hook
+
+			def before_hook(*args)
+			end
+
+			def after_hook(*args, result)
+			end
+		end
+
+		@sample.should_receive(:before_hook).with('args')
+		@sample.should_not_receive(:after_hook)
+
+		@sample.method_one('args').should eq 'args'
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'hook_me_up'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: hook_me_up
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chen Fisher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Lets you hook any method class with :before and :after hooks
+email:
+- chen.fisher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hook_me_up.gemspec
+- lib/hook_me_up.rb
+- lib/hook_me_up/version.rb
+- spec/hook_me_up/sample_class.rb
+- spec/hook_me_up_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem lets you hook and method in any class with a before and after hooks
+test_files:
+- spec/hook_me_up/sample_class.rb
+- spec/hook_me_up_spec.rb
+- spec/spec_helper.rb