uberhook 0.0.3 → 0.0.4

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/mjio/uberhook.png)](http://travis-ci.org/mjio/uberhook)
 
-The Uberhook gem allows you to define `before` and `after` hooks for your classes and models.
+The Uberhook gem allows you to define `before` and `after` hooks for your Ruby classes.
 
 ## Installation
 
@@ -22,7 +22,7 @@ gem 'uberhook'
 require 'uberhook'
 
 class Car
-  include Uberhook::Abstract
+  extend Uberhook
 
   before :drive do
     p 'start engine'
@@ -45,42 +45,3 @@ beatle.drive
 #   drive
 #   turn radio on
 ```
-
-Use the `Uberhook::Base` module to define class hooks.
-
-``` ruby
-require 'uberhook'
-
-class Dance
-  include Uberhook::Base
-
-  instance_hook :after, :step_one do
-    p 'two!'
-  end
-
-  def step_one
-    p 'one!'
-  end
-
-  class_hook :before, :rock do
-    p 'prepare'
-  end
-
-  def self.rock
-    p 'and rock'
-  end
-end
-
-waltz = Dance.new
-waltz.step_one
-
-# Output:
-#   one!
-#   two!
-
-Dance.rock
-
-# Output:
-#   prepare
-#   and rock
-```

data/lib/uberhook.rb

@@ -1,3 +1,41 @@
-require 'uberhook/abstract'
-require 'uberhook/base'
 require 'uberhook/version'
+
+module Uberhook
+  [:before, :after].each do |type|
+    define_method(type) do |target, &callback|
+      install_hook(target, type, &callback)
+    end
+  end
+
+  def method_added(target)
+    define_hook(target) if hooks.has_key? target
+  end
+
+  private
+
+  def hooks
+    @hooks ||= Hash.new do |hash, target|
+      hash[target] = {before: [], after: [], defined: false}
+    end
+  end
+
+  def install_hook(target, type, &callback)
+    hooks[target][type] << callback
+    define_hook(target)
+  end
+
+  def define_hook(target)
+    return if hooks[target][:defined] || !instance_methods.include?(target)
+
+    hooks[target][:defined] = true
+    unbound_target_method = instance_method(target)
+    instance_hooks = hooks
+
+    define_method(target) do |*args, &block|
+      instance_hooks[target][:before].each { |callback| instance_eval(&callback) }
+      retval = unbound_target_method.bind(self).call(*args, &block)
+      instance_hooks[target][:after].each { |callback| instance_eval(&callback) }
+      retval
+    end
+  end
+end

data/lib/uberhook/version.rb

@@ -1,3 +1,3 @@
 module Uberhook
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'minitest/autorun'
-require 'mocha'
+require 'mocha/setup'
 
 require 'uberhook'

data/spec/uberhook_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Uberhook do
+  let :klass do
+    Class.new do
+      extend Uberhook
+
+      attr_accessor :array
+      def initialize; @array = []; end
+
+      def one
+        array << :one
+      end
+    end
+  end
+
+  let(:instance) { klass.new }
+
+  specify 'hooks can be applied to run before and after the target' do
+    klass.before(:one) { array << :before }
+    klass.after(:one) { array << :after }
+    instance.one
+    instance.array.must_equal [:before, :one, :after]
+  end
+
+  specify 'hooks can be defined before or after the target method' do
+    klass.class_eval do
+      before(:two) { array << :before_1 }
+      after(:two) { array << :after_1 }
+      define_method(:two) { array << :two }
+      before(:two) { array << :before_2 }
+      after(:two) { array << :after_2 }
+    end
+    instance.two
+    instance.array == [:before_1, :before_2, :two, :after_1, :after_2]
+  end
+
+  specify 'hooks can call ather methods' do
+    klass.class_eval do
+      before(:one) { zero }
+      after(:one) { two }
+      define_method(:zero) { array << :zero }
+      define_method(:two) { array << :two }
+    end
+    instance.one
+    instance.array == [:zero, :one, :two]
+  end
+
+  it 'keeps the return values' do
+    klass.class_eval do
+      def two(*args, &block); [args, block]; end
+      before(:two) { }
+      after(:two) { }
+    end
+    retval = klass.new.two(1, 2) { 5 }
+    retval[0].must_equal [1, 2]
+    retval[1].call.must_equal 5
+  end
+end

data/uberhook.gemspec

@@ -2,16 +2,16 @@ require File.expand_path('../lib/uberhook/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = 'uberhook'
+  gem.version       = Uberhook::VERSION
   gem.authors       = ['Martin Jagusch']
   gem.email         = ['_@mj.io']
-  gem.version       = Uberhook::VERSION
-  gem.description   = 'Allows you to define :before and :after hooks for your classes and models.'
-  gem.summary       = ':before and :after hooks'
+  gem.description   = 'Define :before and :after hooks for your Ruby classes.'
+  gem.summary       = "uberhook-#{Uberhook::VERSION}"
   gem.homepage      = 'https://github.com/mjio/uberhook'
 
-  gem.add_development_dependency 'rake', '~> 0.9.2.2'
-  gem.add_development_dependency 'mocha', '~> 0.12.3'
-  gem.add_development_dependency 'minitest', '~> 3.3.0'
+  gem.add_development_dependency 'rake', '~> 10.0.0'
+  gem.add_development_dependency 'mocha', '~> 0.13.0'
+  gem.add_development_dependency 'minitest', '~> 4.2.0'
 
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^spec/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uberhook
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 10.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 10.0.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.3
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.3
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,8 +58,8 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.0
-description: Allows you to define :before and :after hooks for your classes and models.
+        version: 4.2.0
+description: Define :before and :after hooks for your Ruby classes.
 email:
 - _@mj.io
 executables: []
@@ -73,12 +73,9 @@ files:
 - README.md
 - Rakefile
 - lib/uberhook.rb
-- lib/uberhook/abstract.rb
-- lib/uberhook/base.rb
 - lib/uberhook/version.rb
-- spec/abstract_spec.rb
-- spec/base_spec.rb
 - spec/spec_helper.rb
+- spec/uberhook_spec.rb
 - uberhook.gemspec
 homepage: https://github.com/mjio/uberhook
 licenses: []
@@ -103,8 +100,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ':before and :after hooks'
+summary: uberhook-0.0.4
 test_files:
-- spec/abstract_spec.rb
-- spec/base_spec.rb
 - spec/spec_helper.rb
+- spec/uberhook_spec.rb

data/lib/uberhook/abstract.rb

@@ -1,30 +0,0 @@
-module Uberhook
-  module Abstract
-    def self.included(base)
-      base.send :include, Uberhook::Base
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      # Define a before or after hook for a specific method.
-      #
-      # @example Define before hook.
-      #   before :foo do
-      #     p 'before callback'
-      #   end
-      #
-      # @example Define after hook.
-      #   after :foo do
-      #     p 'after callback'
-      #   end
-      #
-      # @param [ Symbol ] target The target method.
-      # @param [ Proc ] callback The callback block.
-      [:before, :after].each do |type|
-        define_method(type) do |target, &callback|
-          instance_hook(type, target, &callback)
-        end
-      end
-    end
-  end
-end

data/lib/uberhook/base.rb

@@ -1,112 +0,0 @@
-module Uberhook
-  module Base
-    def self.included(base)
-      base.extend ClassMethods
-      base.class_eval do
-        class << self
-          def method_added(name)
-            process_instance_method_added(name)
-          end
-
-          def singleton_method_added(name)
-            process_class_method_added(name)
-          end
-        end
-      end
-    end
-
-    module ClassMethods
-      def instance_hook(type, target, &callback)
-        instance_hooks[target][type] = callback
-
-        # Define instance hook if target is defined and
-        # hook is not defined yet
-        define_instance_hook(target) if
-          method_defined?(target) and
-          instance_hooks.has_key?(target) and
-          not instance_hooks[target].has_key?(:defined)
-      end
-
-      def class_hook(type, target, &callback)
-        class_hooks[target][type] = callback
-
-        # Define class hook if target is defined and
-        # hook is not defined yet
-        define_class_hook(target) if
-          respond_to?(target) and
-          class_hooks.has_key?(target) and
-          not class_hooks[target].has_key?(:defined)
-      end
-
-      private
-
-      def instance_hooks
-        @instance_hooks ||= Hash.new { |hash, key| hash[key] = {} }
-      end
-
-      def class_hooks
-        @class_hooks ||= Hash.new { |hash, key| hash[key] = {} }
-      end
-
-      def process_instance_method_added(name)
-        return unless instance_hooks.has_key?(name) and
-          not instance_hooks[name].has_key?(:defined)
-
-        define_instance_hook(name)
-      end
-
-      def process_class_method_added(name)
-        return unless class_hooks.has_key?(name) and
-          not class_hooks[name].has_key?(:defined)
-
-        define_class_hook(name)
-      end
-
-      def define_instance_hook(target)
-        instance_hooks[target][:defined] = true
-        original_target = "#{target}_without_callbacks"
-
-        alias_method original_target, target
-        private original_target
-
-        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-          def #{target}(*args, &block)
-            self.class.send(:run_instance_callback, :before, :#{target}, self)
-            retval = send(:#{original_target}, *args, &block)
-            self.class.send(:run_instance_callback, :after, :#{target}, self)
-            retval
-          end
-        RUBY_EVAL
-      end
-
-      def define_class_hook(target)
-        class_hooks[target][:defined] = true
-        original_target = "#{target}_without_callbacks"
-
-        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-          class << self
-            alias_method :#{original_target}, :#{target}
-            private :#{original_target}
-
-            def #{target}(*args, &block)
-              self.send(:run_class_callback, :before, :#{target}, self)
-              retval = send(:#{original_target}, *args, &block)
-              self.send(:run_class_callback, :after, :#{target}, self)
-              retval
-            end
-          end
-        RUBY_EVAL
-      end
-
-      def run_instance_callback(type, target, scope)
-        return unless instance_hooks[target].has_key?(type)
-        scope.instance_eval(&instance_hooks[target][type])
-      end
-
-      def run_class_callback(type, target, scope)
-        return unless class_hooks[target].has_key?(type)
-        scope.instance_eval(&class_hooks[target][type])
-      end
-    end
-  end
-end

data/spec/abstract_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-
-describe Uberhook::Abstract do
-  let(:klass) do
-    Class.new { include Uberhook::Abstract }
-  end
-
-  describe :before do
-    it 'should forward hook definition' do
-      klass.expects(:instance_hook).with(:before, :one).once
-      klass.class_eval { before :one }
-    end
-  end
-
-  describe :around do
-    it 'should forward hook definition'
-  end
-
-  describe :after do
-    it 'should forward hook definition' do
-      klass.expects(:instance_hook).with(:after, :one).once
-      klass.class_eval { after :one }
-    end
-  end
-end

data/spec/base_spec.rb

@@ -1,165 +0,0 @@
-require 'spec_helper'
-
-describe Uberhook::Base do
-  let(:klass) do
-    Class.new do
-      include Uberhook::Base
-
-      def one
-        @hook_calls << :one
-      end
-
-      def self.two
-        @hook_calls << :two
-      end
-    end
-  end
-
-  describe :instance_hook do
-    it 'should save a callback' do
-      klass.class_eval { instance_hook :before, :one }
-      hash = {:one => {:before => nil, :defined => true}}
-      klass.send(:instance_hooks).must_equal hash
-    end
-  end
-
-  it 'should forward a hook definition' do
-    klass.expects(:define_instance_hook).with(:one).once
-    klass.class_eval { instance_hook :before, :one }
-  end
-
-  it 'should not forward a unkown hook definition' do
-    klass.expects(:define_instance_hook).times(0)
-    klass.class_eval { instance_hook :before, :unkown }
-  end
-
-  it 'should excecute hooks' do
-    klass.class_eval do
-      attr_reader :hook_calls
-      def initialize
-        @hook_calls = []
-      end
-      instance_hook :before, :one do
-        @hook_calls << :before_one
-      end
-      instance_hook :after, :one do
-        @hook_calls << :after_one
-      end
-    end
-    inst = klass.new
-    inst.one
-    inst.hook_calls.must_equal [:before_one, :one, :after_one]
-  end
-
-  describe :class_hook do
-    it 'should save a callback' do
-      klass.class_eval { class_hook :before, :two }
-      hash = {:two => {:before => nil, :defined => true}}
-      klass.send(:class_hooks).must_equal hash
-    end
-
-    it 'should forward a hook definition' do
-      klass.expects(:define_class_hook).with(:two).once
-      klass.class_eval { class_hook :before, :two }
-    end
-
-    it 'should not forward a unkown hook definition' do
-      klass.expects(:define_class_hook).times(0)
-      klass.class_eval { class_hook :before, :unkown }
-    end
-
-    it 'should excecute hooks' do
-      klass.class_eval do
-        @hook_calls = []
-        class_hook :before, :two do
-          @hook_calls << :before_two
-        end
-        class_hook :after, :two do
-          @hook_calls << :after_two
-        end
-      end
-      hooks = [:before_two, :two, :after_two]
-      klass.two
-      klass.instance_variable_get(:@hook_calls).must_equal hooks
-    end
-  end
-
-  describe :process_instance_method_added do
-    it 'should excecute when methods get added' do
-      klass.expects(:process_instance_method_added).with(:three).once
-      klass.class_eval { def three; end }
-    end
-
-    it 'should continue when hooks get defined' do
-      klass.expects(:define_instance_hook).with(:three).once
-      klass.class_eval do
-        instance_hook :before, :three
-        def three; end
-      end
-    end
-
-    it 'should not continue without a hook' do
-      klass.expects(:define_instance_hook).times(0)
-      klass.class_eval { def three; end }
-    end
-  end
-
-  describe :process_class_method_added do
-    it 'should excecute when methods get added' do
-      skip 'Ignore methods like :singleton_method_added'
-      klass.expects(:process_class_method_added).with(:four).once
-      klass.class_eval { def self.four; end }
-    end
-
-    it 'should continue when hooks get defined' do
-      klass.expects(:define_class_hook).with(:four).once
-      klass.class_eval do
-        class_hook :before, :four
-        def self.four; end
-      end
-    end
-
-    it 'should not continue without a hook' do
-      klass.expects(:define_class_hook).times(0)
-      klass.class_eval { def self.four; end }
-    end
-  end
-
-  describe :define_instance_hook do
-    it 'should return the targets return value' do
-      klass.class_eval do
-        instance_hook :after, :three do
-          'after'
-        end
-        def three
-          'three'
-        end
-      end
-      klass.new.three.must_equal 'three'
-    end
-
-    it 'should make the original target method private' do
-      klass.class_eval { instance_hook :before, :one }
-      klass.new.private_methods.must_include :one_without_callbacks
-    end
-  end
-
-  describe :define_class_hook do
-    it 'should return the targets return value' do
-      klass.class_eval do
-        class_hook :after, :four do
-          'after'
-        end
-        def self.four
-          'four'
-        end
-      end
-      klass.four.must_equal 'four'
-    end
-
-    it 'should make the original target method private' do
-      klass.class_eval { class_hook :before, :two }
-      klass.private_methods.must_include :two_without_callbacks
-    end
-  end
-end