0
@@ -1,5 +1,18 @@
0
 module Mack # :nodoc:
0
   module Utils # :nodoc:
0
+    # Include this module into any class, or module, and it's methods can become hookable.
0
+    # This allows for the ability to do really nice AOP programming.
0
+    # 
0
+    # Example:
0
+    #   class User
0
+    #     def say_full_name
0
+    #       puts "mark"
0
+    #     end
0
+    #   end
0
+    #   User.before(:say_full_name) do
0
+    #     puts "hello"
0
+    #   end
0
+    #   User.new.say_full_name # => "hello" "mark"
0
     module Hookable
0
       
0
       def self.included(klass)
0
@@ -20,21 +33,25 @@ module Mack # :nodoc:
0
         klass.extend self
0
       end
0
 
0
+      # Used to prefix an instance method with the assigned block
0
       def before(name, &block)
0
         hookable_class.hooks_for(:before, name.to_sym) << block
0
         build_hook_instance_method(name)
0
       end
0
       
0
+      # Used to suffix an instance method with the assigned block
0
       def after(name, &block)
0
         hookable_class.hooks_for(:after, name.to_sym) << block
0
         build_hook_instance_method(name)
0
       end
0
       
0
+      # Used to prefix a class method with the assigned block
0
       def before_class_method(name, &block)
0
         hookable_class.hooks_for(:before_class_method, name.to_sym) << block
0
         build_hook_class_method(name)
0
       end
0
       
0
+      # Used to suffix a class method with the assigned block
0
       def after_class_method(name, &block)
0
         hookable_class.hooks_for(:after_class_method, name.to_sym) << block
0
         build_hook_class_method(name)