hooked 0.3.2 → 0.3.3

data/README.md

@@ -7,72 +7,103 @@ Getting Started
 ---------------
 
 By including `Hooked` into a class you basically say "everything can attach code
-to instance methods of this class".
-
-``` ruby
-require "hooked"
-
-class Foo
-  include Hooked
-  
-  def breakfast
-    puts "No milk?!"
-  end
-end
-
-class BetterFoo
-  def shower
-    puts "Oooh..."
-  end
-  
-  def fuuu(inner)
-    puts "FUUU!"
-    inner.call
-    puts "FUUU!"
-  end
-end
-
-foo, better_foo = Foo.new, BetterFoo.new
-foo.before :breakfast, better_foo.method(:shower)
-foo.after :breakfast, proc { puts "Mmmh..." }
-foo.around :breakfast, better_foo.method(:fuuu)
-
-foo.breakfast
-```
+to methods of this class' objects".
+
+    require "hooked"
+    
+    class Foo
+      include Hooked
+      
+      def breakfast
+        puts "No milk?!"
+      end
+    end
+    
+    class BetterFoo
+      def shower
+        puts "Oooh..."
+      end
+      
+      def fuuu(inner)
+        puts "FUUU!"
+        inner.call
+        puts "FUUU!"
+      end
+    end
+    
+    Foo.extend Hooked
+    Foo.before :new do
+      puts "Creating object..."
+    end
+    
+    foo, better_foo = Foo.new, BetterFoo.new
+
+    foo.before :breakfast, better_foo.method(:shower)
+    foo.after :breakfast do
+      puts "Mmmh..."
+    end
+    foo.around :breakfast, better_foo.method(:fuuu), :before => better_foo.method(:shower)
+    
+    foo.breakfast
 
 This will output:
 
-```
-FUUU!
-Oooh...
-No milk?!
-Mmmh...
-FUUU!
-```
+    Creating object...
+    Oooh...
+    FUUU!
+    No milk?!
+    FUUU!
+    Mmmh...
+
+You can also aspectify instance methods of classes in order to avoid the need of
+aspectifying the respective methods of each new object.
+
+    class Foo
+      include Hooked
+      
+      def breakfast; end
+    end
+    
+    Foo.instance_after :breakfast do
+      puts "ZOMG hooked!1"
+    end
+    
+    Foo.new.breakfast
+
+This will not affect objects that have been created before including Hooked.
 
 Execution Model
 ---------------
 
-TOOD
+Hooked converts a method's aspects into a Directed Acyclic Graph, flattens it
+using TSort and finally forms a Chain of Responsibility with the original method
+at its end. As you can see in the below ASCII art, the aspect type (before,
+after, around) doesn't determine sorting order. Instead it determines if the
+aspect executes its code on the way into or out of the chain.
 
-Dependencies / Execution Order of Aspects
------------------------------------------
+    -->-| #1 before |-->-|           |-->-| #3 before |-->-|          |-->-|                 |
+        |           |    | #2 around |    |           |    |          |    | original method |
+    -<--|           |-<--|           |-<--|           |-<--| #4 after |-<--|                 |
 
-TODO
+Before / After / Around
+-----------------------
+
+    TODO
+
+Execution Order of Aspects
+--------------------------
+
+    TODO
 
 Possible Use Cases
 ------------------
 
 You can use the `Hook` class to programmatically build graphs of aspects. 
 
-``` ruby
-# code
-```
+    TODO
 
-TODO
-
-Dependencies
-------------
+Dependencies / Compatibility
+----------------------------
 
 * stdlib's [TSort](http://rubydoc.info/stdlib/tsort/1.9.2/frames)
 * [RSpec](http://relishapp.com/rspec) for development

data/lib/hooked/aspect.rb

@@ -26,6 +26,8 @@ module Hooked
       end
       
       advice.call result if after?
+      
+      result
     end
     
     def before?

data/lib/hooked/version.rb

@@ -1,3 +1,3 @@
 module Hooked
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: hooked
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 2
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Lars Gierth
@@ -15,22 +10,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 +02:00
-default_executable: 
+date: 2011-05-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
   name: rspec
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
+  type: :development
+  prerelease: false
   version_requirements: *id001
 description: Hooked lets you transparently aspectify your methods and blocks.
 email: 
@@ -58,7 +49,6 @@ files:
 - spec/hook_spec.rb
 - spec/hooked_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/hooked
 licenses: []
 
@@ -72,7 +62,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 312125903
       segments: 
       - 0
       version: "0"
@@ -81,14 +71,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 312125903
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: Aspect Orientation Made Simple