hooked 0.2.0 → 0.3.0

data/README.md

@@ -9,42 +9,46 @@ Getting Started
 By including `Hooked` into a class you basically say "everything can attach code
 to instance methods of this class".
 
-    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
-    
+``` 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
+```
+
 This will output:
 
-    FUUU!
-    Oooh...
-    No milk?!
-    Mmmh...
-    FUUU!
+```
+FUUU!
+Oooh...
+No milk?!
+Mmmh...
+FUUU!
+```
 
 Execution Model
 ---------------
@@ -61,7 +65,9 @@ Possible Use Cases
 
 You can use the `Hook` class to programmatically build graphs of aspects. 
 
-    # code
+``` ruby
+# code
+```
 
 TODO
 
@@ -76,8 +82,6 @@ Specs pass on MRI 1.9.2, others have not been tested yet.
 To do & Ideas
 -------------
 
-* Let before, after, around and Hook.new also take a block
-* Use insertion order as execution order if no aspect has dependencies
 * Visualization of hook flow
 * Make backtraces more readable
 

data/lib/hooked.rb

@@ -1,14 +1,15 @@
 require "hooked/aspect"
 require "hooked/graph"
 require "hooked/hook"
+require "hooked/version"
 
 module Hooked
   attr_reader :hooked
   
   [:before, :after, :around].each do |type|
-    define_method type do |pointcut, *args|
+    define_method type do |pointcut, *args, &block|
       hook! pointcut
-      hooked[pointcut].add_aspect type, *args
+      hooked[pointcut].add_aspect type, *args, &block
     end
   end
   

data/lib/hooked/aspect.rb

@@ -3,9 +3,13 @@ module Hooked
     attr_reader :type, :advice, :dependencies
     attr_accessor :pointcut
 
-    def initialize(type, advice, dependencies = {})
+    def initialize(type, advice = nil, dependencies = {}, &block)
+      if (advice && block) || (!advice && !block)
+        raise ArgumentError, "Pass either an advice argument or a block"
+      end
+
       [:before, :after].each {|d| dependencies[d] ||= [] }
-      @type, @advice, @dependencies = type, advice, dependencies
+      @type, @advice, @dependencies = type, (advice || block), dependencies
     end
 
     def call(*args, &block)

data/lib/hooked/graph.rb

@@ -2,7 +2,7 @@ require "tsort"
 
 module Hooked
   class Graph
-    class Node < Struct.new(:children, :aspect); end
+    class Node < Struct.new(:children, :node); end
     
     class CircularDependencyError < TSort::Cyclic; end
 
@@ -24,25 +24,35 @@ module Hooked
     end
     
     def sort
-      @nodes = input.inject({}) do |nodes, node|
-        children = node.dependencies[:after].map {|d| d.object_id }
-        nodes[node.advice.object_id] = Node.new(children, node); nodes
+      do_sort = input.any? do |n|
+        !n.dependencies[:before].empty? || !n.dependencies[:after].empty?
       end
-      @nodes.each do |name, node|
-        node.aspect.dependencies[:before].each do |dep|
-          dep_name = dep.object_id
-          next unless @nodes[dep_name]
-          @nodes[dep_name].children << name
+
+      if do_sort
+        @nodes = input.inject({}) do |nodes, node|
+          children = node.dependencies[:after].map {|d| d.object_id }
+          nodes[node.advice.object_id] = Node.new(children, node); nodes
         end
+        
+        @nodes.each do |name, node|
+          node.node.dependencies[:before].each do |dep|
+            dep_name = dep.object_id
+            next unless @nodes[dep_name]
+            @nodes[dep_name].children << name
+          end
+        end
+        
+        strongly_connected_components.each do |name|
+          next unless Array === name && name.length > 1
+          raise CircularDependencyError, "Sorting failed: #{name.map {|n|
+            @nodes[n].node.advice.inspect }.join ', '}"
+        end
+        
+        @output = tsort.map {|name| @nodes[name].node }
+      else
+        @output = input.reverse
       end
       
-      strongly_connected_components.each do |name|
-        next unless Array === name && name.length > 1
-        raise CircularDependencyError,
-          "Sorting failed: #{name.map {|n| @nodes[n].aspect.advice.inspect }.join ', '}"
-      end
-      
-      @output = tsort.map {|name| @nodes[name].aspect }
       @changed = false
     end
     

data/lib/hooked/hook.rb

@@ -2,12 +2,16 @@ module Hooked
   class Hook
     attr_reader :pointcut, :graph
     
-    def initialize(pointcut)
-      @pointcut, @graph = pointcut, Graph.new
+    def initialize(pointcut = nil, &block)
+      if (pointcut && block) || (!pointcut && !block)
+        raise ArgumentError, "Pass either an argument or a block"
+      end
+
+      @pointcut, @graph = (pointcut || block), Graph.new
     end
     
-    def add_aspect(*args)
-      graph << Aspect.new(*args)
+    def add_aspect(*args, &block)
+      graph << Aspect.new(*args, &block)
     end
     
     def call(*args, &block)

data/lib/hooked/version.rb

@@ -1,3 +1,3 @@
 module Hooked
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/aspect_spec.rb

@@ -13,10 +13,27 @@ describe Hooked::Aspect do
     end
     
     it "sets default dependency lists" do
-      obj = Hooked::Aspect.new nil, nil
+      obj = Hooked::Aspect.new nil, stub("advice")
       obj.dependencies[:before].should == []
       obj.dependencies[:after].should == []
     end
+    
+    it "can take a block instead of the advice argument" do
+      block = double "block", :to_proc => proc {}
+      obj = Hooked::Aspect.new nil, &block
+      
+      obj.advice.should == block.to_proc
+    end
+    
+    it "fails if both a block and the advice argument were passed" do
+      proc do
+        Hooked::Aspect.new nil, stub("advice") do; end
+      end.should raise_error(ArgumentError)
+    end
+   
+    it "fails if neither a block nor the advice argument were passed" do
+      proc { Hooked::Aspect.new nil }.should raise_error(ArgumentError)
+    end
   end
   
   describe "#call" do
@@ -98,22 +115,22 @@ describe Hooked::Aspect do
   
   describe "#before?" do
     it "returns true if #type == :before" do
-      Hooked::Aspect.new(:before, nil).before?.should be_true
-      Hooked::Aspect.new(:foo, nil).before?.should_not be_true
+      Hooked::Aspect.new(:before, stub("advice")).before?.should be_true
+      Hooked::Aspect.new(:foo, stub("advice")).before?.should_not be_true
     end
   end
   
   describe "#after?" do
     it "returns true if #type == :after" do
-      Hooked::Aspect.new(:after, nil).after?.should be_true
-      Hooked::Aspect.new(:foo, nil).after?.should_not be_true
+      Hooked::Aspect.new(:after, stub("advice")).after?.should be_true
+      Hooked::Aspect.new(:foo, stub("advice")).after?.should_not be_true
     end
   end
   
   describe "#around?" do
     it "returns true if #type == :around" do
-      Hooked::Aspect.new(:around, nil).around?.should be_true
-      Hooked::Aspect.new(:foo, nil).around?.should_not be_true
+      Hooked::Aspect.new(:around, stub("advice")).around?.should be_true
+      Hooked::Aspect.new(:foo, stub("advice")).around?.should_not be_true
     end
   end
 end

data/spec/graph_spec.rb

@@ -9,7 +9,7 @@ describe Hooked::Graph do
   
   describe "#<<" do
     before :each do
-      @aspect, @graph = Hooked::Aspect.new(nil, nil), Hooked::Graph.new
+      @aspect, @graph = Hooked::Aspect.new(nil, stub("advice")), Hooked::Graph.new
       @graph << @aspect
     end
     
@@ -47,7 +47,7 @@ describe Hooked::Graph do
     end
     
     it "detects circular dependencies" do
-      advices = (0..3).map {|i| mock "advice##{i}", :inspect => "advice##{i}" }
+      advices = (0..2).map {|i| mock "advice##{i}", :inspect => "advice##{i}" }
       aspects = [
         Hooked::Aspect.new(nil, advices[0], :before => [advices[1]]),
         Hooked::Aspect.new(nil, advices[1], :before => [advices[2]]),
@@ -62,5 +62,22 @@ describe Hooked::Graph do
         error.message =~ /failed: advice#0, advice#2, advice#1/
       }
     end
+    
+    it "only reverses the input if no node has dependencies" do
+      advices = (0..2).map {|i| mock "advice##{i}", :inspect => "advice##{i}" }
+      aspects = [
+        Hooked::Aspect.new(nil, advices[0]),
+        Hooked::Aspect.new(nil, advices[1]),
+        Hooked::Aspect.new(nil, advices[2])
+      ]
+      
+      
+      graph = Hooked::Graph.new
+      aspects.each {|a| graph << a }
+      
+      graph.should_not_receive :tsort
+      graph.sort
+      graph.output.should == [aspects[2], aspects[1], aspects[0]]
+    end
   end
 end

data/spec/hook_spec.rb

@@ -10,6 +10,23 @@ describe Hooked::Hook do
       obj.pointcut.should == pointcut
       obj.graph.should == graph
     end
+    
+    it "can take a block instead of the pointcut argument" do
+      block = double "block", :to_proc => proc {}
+      obj = Hooked::Hook.new &block
+      
+      obj.pointcut.should == block.to_proc
+    end
+    
+    it "fails if both a block and the pointcut argument were passed" do
+      proc do
+        Hooked::Hook.new stub("pointcut") do; end
+      end.should raise_error(ArgumentError)
+    end
+   
+    it "fails if neither a block nor the pointcut argument were passed" do
+      proc { Hooked::Hook.new }.should raise_error(ArgumentError)
+    end
   end
   
   describe "#add_aspect" do

metadata

@@ -2,7 +2,7 @@
 name: hooked
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Lars Gierth
@@ -64,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 208393711
+      hash: 365797709
       segments: 
       - 0
       version: "0"
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 208393711
+      hash: 365797709
       segments: 
       - 0
       version: "0"