hooks 0.1.4 → 0.2.0

data/CHANGES.textile

@@ -1,3 +1,8 @@
+h2. 0.2.0
+
+h3. Changes
+  * Callback blocks are now executed on the instance using @instance_exec@. If you need to access the class (former context) use @self.class@.
+
 h2. 0.1.4
 
 h3. Bugfixes

data/Gemfile

@@ -1 +1,3 @@
+source :rubygems
+
 gemspec

data/README.rdoc

@@ -5,54 +5,79 @@
 
 == Introduction
 
-_Hooks_ lets you define hooks declaratively in your ruby class. You can add callbacks to your hook, which will be 
-run as soon as _you_ run the hook!
+_Hooks_ lets you define hooks declaratively in your ruby class. You can add callbacks to your hook, which will be run as soon as _you_ run the hook!
 
 It's almost like ActiveSupport::Callbacks but 76,6% less complex. Instead, it is not more than 60 lines of code, one method compilation, no +method_missing+ and no magic.
 
+Also, you may pass additional arguments to your callbacks when invoking a hook.
 
 == Example
 
 Let's take... a cat.
+  
+  require 'hooks'
 
   class Cat
     include Hooks
-    
+
     define_hook :after_dinner
 
 Now you can add callbacks to your hook declaratively in your class.
 
-    after_dinner do 
-      puts "Ice cream!"
+    after_dinner do
+      puts "Ice cream for #{self}!"
     end
-    
+
     after_dinner :have_a_desert   # => refers to Cat#have_a_desert
-    
-    
+
     def have_a_desert
       puts "Hell, yeah!"
     end
- 
-Running the callbacks happens on instances. It will run the block and #have_a_desert from above.
+
+This will run the block and <tt>#have_a_desert</tt> from above.
 
   cat.run_hook :after_dinner
-  # => Ice cream!
+  # => Ice cream for #<Cat:0x8df9d84>!
+       Hell, yeah!
+
+Callback blocks and methods will be executed with instance context. Note how +self+ in the block refers to the Cat instance.
+
+
+== Inheritance
+
+Hooks are inherited, here's a complete example to put it all together.
+  
+  class Garfield < Cat
+    
+    after_dinner :want_some_more
+
+    def want_some_more
+      puts "Is that all?"
+    end
+  end
+
+
+  Garfield.new.run_hook :after_dinner
+  # => Ice cream for #<Cat:0x8df9d84>!
        Hell, yeah!
+       Is that all?
+  
+Note how the callbacks are invoked in the order they were inherited.
 
 
-== Options
+== Options for Callbacks
 
-You're free to pass any number of arguments to #run_callback.
+You're free to pass any number of arguments to #run_callback, those will be passed to the callbacks.
 
   cat.run_hook :before_dinner, cat, Time.now
 
 The callbacks should be ready for receiving parameters.
-  
+
   before_dinner :wash_pawns
   before_dinner do |who, when|
     ...
   end
-  
+
   def wash_pawns(who, when)
 
 
@@ -64,13 +89,6 @@ Not sure why a cat should have ice cream for dinner. Beside that, I was tempted
   gem install hooks
 
 
-== Dependencies
-
-The current gem requires
-
-* active_support 2.3.x
-
-
 == Anybody using it?
 
 * Hooks is already used in [Apotomo:http://github.com/apotonick/apotomo], a hot widget framework for Rails. Look at +lib/apotomo/widget.rb+ for examples and into +lib/apotomo/tree_node.rb+ to learn how modules-driven code might benefit from hooks.
@@ -84,6 +102,6 @@ The current gem requires
 
 == License
 
-Copyright (c) 2010, Nick Sutterer 
+Copyright (c) 2010, Nick Sutterer
 
 Released under the MIT License.

data/hooks.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.add_development_dependency "shoulda"
+  s.add_development_dependency "rake"
 end

data/lib/hooks.rb

@@ -16,7 +16,7 @@ require "hooks/inheritable_attribute"
 #
 #   cat.run_hook :after_dinner
 module Hooks
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
   
   def self.included(base)
     base.extend InheritableAttribute
@@ -50,7 +50,7 @@ module Hooks
         if callback.kind_of? Symbol
           scope.send(callback, *args)
         else
-          callback.call(*args)
+          scope.instance_exec(*args, &callback)
         end 
       end
     end

data/test/hooks_test.rb

@@ -1,15 +1,18 @@
 require 'test_helper'
 
 class HooksTest < Test::Unit::TestCase
+  class TestClass
+    include Hooks
+    
+    def executed
+      @executed ||= [];
+    end
+  end
+  
+  
   context "Hooks.define_hook" do
     setup do
-      @klass = Class.new(Object) do
-        include Hooks
-        
-        def executed
-          @executed ||= [];
-        end
-      end
+      @klass = Class.new(TestClass)
       
       @mum = @klass.new
       @mum.class.define_hook :after_eight
@@ -72,6 +75,12 @@ class HooksTest < Test::Unit::TestCase
         
         assert_equal [2, 0], @mum.executed
       end
+
+      should "execute block callbacks in instance context" do
+        @mum.class.after_eight { executed << :c }
+        @mum.run_hook(:after_eight)
+        assert_equal [:c], @mum.executed
+      end
     end
     
     context "in class context" do
@@ -100,4 +109,33 @@ class HooksTest < Test::Unit::TestCase
       end
     end
   end
+  
+  context "Deriving" do
+    setup do
+      @klass = Class.new(TestClass)
+      
+      @mum = @klass.new
+      @mum.class.define_hook :after_eight
+    end
+    
+    should "inherit the hook" do
+      @klass.class_eval do
+        after_eight :take_shower
+        
+        def take_shower
+          executed << :take_shower
+        end
+      end
+      
+      @kid = Class.new(@klass) do
+        after_eight :have_dinner
+        
+        def have_dinner
+          executed << :have_dinner
+        end
+      end.new
+      
+      assert_equal [:take_shower, :have_dinner], @kid.run_hook(:after_eight)
+    end
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 +02:00
+date: 2011-10-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,6 +30,19 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: Declaratively define hooks, add callbacks and run them with the options you like.
 email: 
 - apotonick@gmail.com