aquarium 0.4.3 → 0.4.4

data/examples/method_tracing_example.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
-# Example demonstrating "around" advice that traces calls to all methods in
-# classes Foo and Bar
+# Example demonstrating "around" advice that traces calls to all 
+# methods in classes Foo and Bar.
 
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'aquarium'
@@ -38,13 +38,16 @@ bar1.do_something_else :b3, :b4
 
 include Aquarium::Aspects
 
-Aspect.new :around, :calls_to => :all_methods, :for_types => [Aquarium::Foo, Aquarium::Bar],
-    :method_options => :exclude_ancestor_methods do |execution_point, obj, *args|
+# "jp" is the "join point", a.k.a. the current execution point.
+Aspect.new :around, :calls_to => :all_methods, 
+    :for_types => [Aquarium::Foo, Aquarium::Bar],
+    :method_options => :exclude_ancestor_methods do |jp, obj, *args|
   begin
-    p "Entering: #{execution_point.target_type.name}##{execution_point.method_name}: args = #{args.inspect}"
-    execution_point.proceed
+    names = "#{jp.target_type.name}##{jp.method_name}"
+    p "Entering: #{names}: args = #{args.inspect}"
+    jp.proceed
   ensure
-    p "Leaving:  #{execution_point.target_type.name}##{execution_point.method_name}: args = #{args.inspect}"
+    p "Leaving:  #{names}: args = #{args.inspect}"
   end
 end
 
@@ -55,15 +58,17 @@ foo2.do_it :b5, :b6
 bar1 = Aquarium::Bar.new :a7, :a8
 bar1.do_something_else :b7, :b8
 
-# The "begin/ensure/end" idiom shown causes the advice to return the correct value; the result
-# of the "proceed", rather than the value returned by "p"!
-Aspect.new :around, :invocations_of => :initialize, :for_types => [Aquarium::Foo, Aquarium::Bar],  
-    :restricting_methods_to => :private_methods do |execution_point, obj, *args|
+# The "begin/ensure/end" idiom shown causes the advice to return the correct
+# value; the result of the "proceed", rather than the value returned by "p"!
+Aspect.new :around, :invocations_of => :initialize, 
+    :for_types => [Aquarium::Foo, Aquarium::Bar],  
+    :restricting_methods_to => :private_methods do |jp, obj, *args|
   begin
-    p "Entering: #{execution_point.target_type.name}##{execution_point.method_name}: args = #{args.inspect}"
-    execution_point.proceed
+    names = "#{jp.target_type.name}##{jp.method_name}"
+    p "Entering: #{names}: args = #{args.inspect}"
+    jp.proceed
   ensure
-    p "Leaving:  #{execution_point.target_type.name}##{execution_point.method_name}: args = #{args.inspect}"
+    p "Leaving:  #{names}: args = #{args.inspect}"
   end
 end
 
@@ -72,5 +77,4 @@ foo2 = Aquarium::Foo.new :a9, :a10
 foo2.do_it :b9, :b10
 
 bar1 = Aquarium::Bar.new :a11, :a12
-bar1.do_something_else :b11, :b12
-
+bar1.do_something_else :b11, :b12

data/examples/reusable_aspect_hack_example.rb

@@ -17,11 +17,13 @@ module Aquarium
   module Reusables
     module TraceMethods
       def self.append_features mod
-        Aquarium::Aspects::Aspect.new :around, 
-            :type => mod, :methods => :all, :method_options => [:exclude_ancestor_methods] do |jp, object, *args|
-          p "Entering: "+jp.target_type.name+"#"+jp.method_name.to_s+": args = "+args.inspect
+        Aquarium::Aspects::Aspect.new :around, :type => mod, 
+            :methods => :all, 
+            :method_options => [:exclude_ancestor_methods] do |jp, object, *args|
+          names = "#{jp.target_type.name}##{jp.method_name}"
+          p "Entering: #{names}: args = #{args.inspect}"
           jp.proceed
-          p "Leaving:  "+jp.target_type.name+"#"+jp.method_name.to_s+": args = "+args.inspect
+          p "Leaving:  #{names}: args = #{args.inspect}"
         end
       end
     end    
@@ -32,7 +34,8 @@ class NotTraced1
   def doit; p "NotTraced1#doit"; end
 end
 p "You will be warned that no join points in NotTraced2 were matched."
-p "This happens because the include statement and hence the aspect evaluation happen BEFORE any methods are defined!"
+p "This happens because the include statement and hence the aspect evaluation"
+p " happen BEFORE any methods are defined!"
 class NotTraced2
   include Aquarium::Reusables::TraceMethods
   def doit; p "NotTraced2#doit"; end

data/lib/aquarium/aspects/exclusion_handler.rb

@@ -42,9 +42,9 @@ module Aquarium
         unless @specification[:exclude_types_calculated].nil?
           return true if @specification[:exclude_types_calculated].find do |t|
             case t
-            when String: type_or_object.name.eql?(t)
-            when Symbol: type_or_object.name.eql?(t.to_s)
-            when Regexp: type_or_object.name =~ t
+            when String then type_or_object.name.eql?(t)
+            when Symbol then type_or_object.name.eql?(t.to_s)
+            when Regexp then type_or_object.name =~ t
             else type_or_object == t
             end
           end

data/lib/aquarium/version.rb

@@ -9,7 +9,7 @@ module Aquarium
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 4
-      TINY   = 3
+      TINY   = 4
       RELEASE_CANDIDATE = nil
       
       # RANDOM_TOKEN: 0.598704893979657

data/rake_tasks/verify_rcov.rake

@@ -3,5 +3,5 @@ require 'spec/rake/verify_rcov'
 
 RCov::VerifyTask.new(:verify_rcov => :spec) do |t|
   t.threshold = 100.0 # Make sure you have rcov 0.7 or higher!
-  t.index_html = '../doc/output/coverage/index.html'
+  t.index_html = '../doc/aquarium/out/coverage/index.html'
 end

data/spec/aquarium/aspects/concurrent_aspects_spec.rb

@@ -116,84 +116,84 @@ describe "concurrent advice", :shared => true do
 end
 
 describe "Using two :before advices" do
-  setup do
+  before :each do
     @advice_kinds = [:before, :before]
   end
   it_should_behave_like "concurrent advice"
 end
   
 describe "Using two :after advices" do
-  setup do
+  before :each do
     @advice_kinds = [:after, :after]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using two :after_returning advices" do
-  setup do
+  before :each do
     @advice_kinds = [:after_returning, :after_returning]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using two :after_raising advices" do
-  setup do
+  before :each do
     @advice_kinds = [:after_raising, :after_raising]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using two :around advices" do
-  setup do
+  before :each do
     @advice_kinds = [:around, :around]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using :before advice and :after advice" do
-  setup do
+  before :each do
     @advice_kinds = [:before, :after]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using :before advice and :after_returning advice" do
-  setup do
+  before :each do
     @advice_kinds = [:before, :after_returning]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using :before advice and :after_raising advice" do
-  setup do
+  before :each do
     @advice_kinds = [:before, :after_raising]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using :before advice and :around advice" do
-  setup do
+  before :each do
     @advice_kinds = [:before, :around]
   end
   it_should_behave_like "concurrent advice"
 end
   
 describe "Using :after advice and :after_returning advice" do
-  setup do
+  before :each do
     @advice_kinds = [:after, :after_returning]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using :after advice and :after_raising advice" do
-  setup do
+  before :each do
     @advice_kinds = [:after, :after_raising]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using :after advice and :around advice" do
-  setup do
+  before :each do
     @advice_kinds = [:after, :around]
   end
   it_should_behave_like "concurrent advice"
@@ -201,70 +201,70 @@ end
 
 
 describe "Using :after_returning advice and :after_raising advice" do
-  setup do
+  before :each do
     @advice_kinds = [:after_returning, :after_raising]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using :after_returning advice and :around advice" do
-  setup do
+  before :each do
     @advice_kinds = [:after_returning, :around]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using :after_raising advice and :around advice" do
-  setup do
+  before :each do
     @advice_kinds = [:after_raising, :around]
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using three :before advices" do
-  setup do
+  before :each do
     3.times {|i| @advice_kinds[i] = :before}
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using three :before advices" do
-  setup do
+  before :each do
     3.times {|i| @advice_kinds[i] = :before}
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using three :after advices" do
-  setup do
+  before :each do
     3.times {|i| @advice_kinds[i] = :after}
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using three :after_returning advices" do
-  setup do
+  before :each do
     3.times {|i| @advice_kinds[i] = :after_returning}
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using three :after_raising advices" do
-  setup do
+  before :each do
     3.times {|i| @advice_kinds[i] = :after_raising}
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using three :around advices" do
-  setup do
+  before :each do
     3.times {|i| @advice_kinds[i] = :around}
   end
   it_should_behave_like "concurrent advice"
 end
 
 describe "Using two :before advices and one :after advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :before}
     @advice_kinds[2] = :after
   end
@@ -272,7 +272,7 @@ describe "Using two :before advices and one :after advice" do
 end
 
 describe "Using two :before advices and one :after_returning advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :before}
     @advice_kinds[2] = :after_returning
   end
@@ -280,7 +280,7 @@ describe "Using two :before advices and one :after_returning advice" do
 end
 
 describe "Using two :before advices and one :after_raising advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :before}
     @advice_kinds[2] = :after_raising
   end
@@ -288,7 +288,7 @@ describe "Using two :before advices and one :after_raising advice" do
 end
 
 describe "Using two :before advices and one :around advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :before}
     @advice_kinds[2] = :around
   end
@@ -296,7 +296,7 @@ describe "Using two :before advices and one :around advice" do
 end
 
 describe "Using two :after advices and one :before advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after}
     @advice_kinds[2] = :before
   end
@@ -304,7 +304,7 @@ describe "Using two :after advices and one :before advice" do
 end
 
 describe "Using two :after advices and one :after_returning advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after}
     @advice_kinds[2] = :after_returning
   end
@@ -312,7 +312,7 @@ describe "Using two :after advices and one :after_returning advice" do
 end
 
 describe "Using two :after advices and one :after_raising advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after}
     @advice_kinds[2] = :after_raising
   end
@@ -320,7 +320,7 @@ describe "Using two :after advices and one :after_raising advice" do
 end
 
 describe "Using two :after advices and one :around advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after}
     @advice_kinds[2] = :around
   end
@@ -328,7 +328,7 @@ describe "Using two :after advices and one :around advice" do
 end
 
 describe "Using two :after_returning advices and one :before advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after_returning}
     @advice_kinds[2] = :before
   end
@@ -336,7 +336,7 @@ describe "Using two :after_returning advices and one :before advice" do
 end
 
 describe "Using two :after_returning advices and one :after advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after_returning}
     @advice_kinds[2] = :after
   end
@@ -344,7 +344,7 @@ describe "Using two :after_returning advices and one :after advice" do
 end
 
 describe "Using two :after_returning advices and one :after_raising advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after_returning}
     @advice_kinds[2] = :after_raising
   end
@@ -352,7 +352,7 @@ describe "Using two :after_returning advices and one :after_raising advice" do
 end
 
 describe "Using two :after_returning advices and one :around advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after_returning}
     @advice_kinds[2] = :around
   end
@@ -360,7 +360,7 @@ describe "Using two :after_returning advices and one :around advice" do
 end
 
 describe "Using two :after_raising advices and one :before advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after_raising}
     @advice_kinds[2] = :before
   end
@@ -368,7 +368,7 @@ describe "Using two :after_raising advices and one :before advice" do
 end
 
 describe "Using two :after_raising advices and one :after advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after_raising}
     @advice_kinds[2] = :after
   end
@@ -376,7 +376,7 @@ describe "Using two :after_raising advices and one :after advice" do
 end
 
 describe "Using two :after_raising advices and one :after_raising advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after_raising}
     @advice_kinds[2] = :after_raising
   end
@@ -384,7 +384,7 @@ describe "Using two :after_raising advices and one :after_raising advice" do
 end
 
 describe "Using two :after_raising advices and one :around advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :after_raising}
     @advice_kinds[2] = :around
   end
@@ -392,7 +392,7 @@ describe "Using two :after_raising advices and one :around advice" do
 end
 
 describe "Using two :around advices and one :before advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :around}
     @advice_kinds[2] = :before
   end
@@ -400,7 +400,7 @@ describe "Using two :around advices and one :before advice" do
 end
 
 describe "Using two :around advices and one :after advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :around}
     @advice_kinds[2] = :after
   end
@@ -408,7 +408,7 @@ describe "Using two :around advices and one :after advice" do
 end
 
 describe "Using two :around advices and one :after_returning advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :around}
     @advice_kinds[2] = :after_returning
   end
@@ -416,7 +416,7 @@ describe "Using two :around advices and one :after_returning advice" do
 end
 
 describe "Using two :around advices and one :after_raising advice" do
-  setup do
+  before :each do
     2.times {|i| @advice_kinds[i] = :around}
     @advice_kinds[2] = :after_raising
   end