aspect4r 0.9.1 → 0.10.0

data/README.rdoc

@@ -7,31 +7,29 @@ Aspect Oriented Programming support for Ruby
 * extract common logic from multiple methods into before, after, around advices
 * before_filter as method filters (work like before_filters in web application)
 * advices can be customized (e.g. to take an optional method name argument)
-* work as a supporting piece for more complex AOP tasks
+* well-tested and optimized
 
 == Usage
 
-API documentation: http://gcao.posterous.com/aspect4r-usage-and-public-api
+API documentation: https://github.com/gcao/aspect4r/wiki/Api
 
   class A
     include Aspect4r
     
-    around :test do |proxy_method, value|
-      a4r_invoke proxy_method, value
-    end
-
-    before :test do |value|
-      puts "entering test(#{value})"
+    around /test/ do |*args, &block|
+      ...
+      block.call *args
+      ...
     end
 
     before :test, :do_something
     
-    before_filter :test do |value|
-      value >= 0
+    before_filter :test do |*args|
+      authorized?
     end
 
-    after :test do |result, value|
-      puts "test(#{value}) returned #{result}"
+    after :test do |result, *args|
+      puts "test(#{*args}) returned #{result}"
       result
     end
 
@@ -59,28 +57,6 @@ Execution model: http://gcao.posterous.com/aspect4r-documentation-advice-executi
 
 See github issues http://github.com/gcao/aspect4r/issues
 
-Support regular expression on methods to be advised. When such an advice is defined, methods defined before it 
-will not be processed, only new methods are.
-
-Advices are stored in an array. Whenever a method is created, the whole array is checked to find the advices that
-are applicable to it. Those applicable advices are used to construct the new method. This provides a lot 
-flexibilities but can be a performance burden. 
-
-One way to improve performance is to use array to store advices that use regular expression. Advices specific to 
-methods are stored in hash. (Do this only when performance is proved to be a problem in real world scenarios)
-
-Advice name: each advice can take a :name option. If no name is given, the advice method name is used as the advice
-name. If advice logic is in a block and :name is not set, the advice will not have a name. Multiple advices can 
-have same name.
-What use can this bring? skip advice for specific methods. debugging purpose. testing purpose.
-
-Inherit advices: add option :inherit to all advices. Advices whose :inherit options are set to true will be copied to 
-child modules/classes. By default :inherit is set to false.
-This adds a lot complexity and might not be a good idea.
-This can be achieved by putting advices in ModuleX.included or ClassY.inherited
-
-a4r_remove_advices: will remove advices with given names. If no name is given, all advices are removed.
-
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.9.1
+0.10.0

data/aspect4r.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{aspect4r}
-  s.version = "0.9.1"
+  s.version = "0.10.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Guoliang Cao"]
-  s.date = %q{2011-05-02}
+  s.date = %q{2011-09-01}
   s.description = %q{AOP for ruby - use before, after and around to trim your fat methods and reduce code duplication}
   s.email = %q{gcao99@gmail.com}
   s.extra_rdoc_files = [
@@ -75,41 +75,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.4.2}
   s.summary = %q{Aspect Oriented Programming for ruby}
-  s.test_files = [
-    "examples/advices_on_class_method_example.rb",
-    "examples/after_example.rb",
-    "examples/around_example.rb",
-    "examples/before_example.rb",
-    "examples/combined_example.rb",
-    "examples/test_advices_example.rb",
-    "spec/aspect4r/advice_on_class_method_spec.rb",
-    "spec/aspect4r/advice_scope_spec.rb",
-    "spec/aspect4r/advice_test_spec.rb",
-    "spec/aspect4r/after_spec.rb",
-    "spec/aspect4r/around_spec.rb",
-    "spec/aspect4r/before_spec.rb",
-    "spec/aspect4r/class_inheritance_spec.rb",
-    "spec/aspect4r/classic_spec.rb",
-    "spec/aspect4r/helper_spec.rb",
-    "spec/aspect4r/include_advices_from_module_spec.rb",
-    "spec/aspect4r/inheritance_inclusion_combined_spec.rb",
-    "spec/aspect4r/method_added_spec.rb",
-    "spec/aspect4r/model/advice_group_spec.rb",
-    "spec/aspect4r/model/advice_spec.rb",
-    "spec/aspect4r/model/method_matcher_spec.rb",
-    "spec/aspect4r/module_inclusion_spec.rb",
-    "spec/aspect4r/regexp_methods_spec.rb",
-    "spec/aspect4r/singleton_method_added_spec.rb",
-    "spec/aspect4r/super_in_method_spec.rb",
-    "spec/aspect4r_spec.rb",
-    "spec/spec_helper.rb",
-    "test/after_test.rb",
-    "test/around_test.rb",
-    "test/before_test.rb",
-    "test/combined_test.rb",
-    "test/method_invocation_test.rb",
-    "test/test_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/examples/advices_on_class_method_example.rb

@@ -3,9 +3,9 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'aspect4r'
 
 class A
-  class << self
-    include Aspect4r
-    
+  include Aspect4r
+
+  class << self    
     around :test do |input, &block|
       puts 'around test (before)'
       result = block.call input

data/examples/around_example.rb

@@ -5,17 +5,17 @@ require 'aspect4r'
 class A
   include Aspect4r
   
-  def test value
-    puts 'test'
-    value
-  end
-  
   around :test do |value, &block|
     puts 'before test'
     result = block.call value
     puts 'after test'
     result
   end
+  
+  def test value
+    puts 'test'
+    value
+  end
 end
 
 puts "Example 1:"

data/examples/before_example.rb

@@ -5,10 +5,6 @@ require 'aspect4r'
 class A
   include Aspect4r
   
-  def test value
-    puts 'test'
-  end
-  
   before :test do |value|
     puts 'before test'
   end
@@ -17,6 +13,10 @@ class A
     puts 'check before test'
     value >= 0
   end
+  
+  def test value
+    puts 'test'
+  end
 end
 
 puts "Example 1:"

data/examples/combined_example.rb

@@ -5,11 +5,6 @@ require 'aspect4r'
 class A
   include Aspect4r
   
-  def test value
-    puts 'test'
-    value
-  end
-  
   around :test do |value, &block|
     puts 'around test 1'
     result = block.call value
@@ -25,6 +20,11 @@ class A
     puts 'after test'
     result
   end
+  
+  def test value
+    puts 'test'
+    value
+  end
 end
 
 puts "Example 1:"

data/examples/test_advices_example.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems'
+require 'mocha'
 require 'spec'
 require 'spec/autorun'
 
@@ -48,22 +49,22 @@ end
 # =============================== Tests start here ===========================
 describe Klass do
   it "number of advices" do
-    Klass.a4r_data[:test].size.should == 4
+    Klass.a4r_data.advices_for_method(:test).size.should == 4
   end
   
   it "around advice" do
-    advice = Klass.a4r_data[:test][0]
+    advice = Klass.a4r_data.advices_for_method(:test)[0]
     advice.around?.should be_true
 
     o = Klass.new
 
-    advice.invoke(o, :proxy, 1)
+    advice.invoke(o, 1) {}
 
     o.value.should == %w(around(before) around(after))
   end
   
   it "before advice" do
-    advice = Klass.a4r_data[:test][1]
+    advice = Klass.a4r_data.advices_for_method(:test)[1]
     advice.before?.should be_true
 
     o = Klass.new
@@ -71,19 +72,9 @@ describe Klass do
 
     o.value.should == %w(before)
   end
-  
-  it "before advice retrieved by name" do
-    advice = Klass.a4r_data[:test][:before_advice]
-    advice.before?.should be_true
-
-    o = Klass.new
-    advice.invoke(o, 1)
 
-    o.value.should == %w(before)
-  end
-  
   it "before_filter advice returns true if input is not negative" do
-    advice = Klass.a4r_data[:test][2]
+    advice = Klass.a4r_data.advices_for_method(:test)[2]
     advice.before_filter?.should be_true
 
     o = Klass.new
@@ -93,14 +84,14 @@ describe Klass do
   end
   
   it "before_filter advice returns false if input is negative" do
-    advice = Klass.a4r_data[:test][2]
+    advice = Klass.a4r_data.advices_for_method(:test)[2]
 
     o = Klass.new
     advice.invoke(o, -1).should be_false
   end
   
   it "after advice" do
-    advice = Klass.a4r_data[:test][3]
+    advice = Klass.a4r_data.advices_for_method(:test)[3]
     advice.after?.should be_true
 
     o = Klass.new

data/lib/aspect4r/base.rb

@@ -78,7 +78,7 @@ module Aspect4r
       ensure
         methods.each do |method|
           method_with_advices = "#{method}_with_advices"
-          next unless instance_methods.include?(method_with_advices)
+          next unless instance_methods.detect {|method| method.to_s == method_with_advices }
 
           send :alias_method, method, method_with_advices
           self.send :remove_method, method_with_advices

data/lib/aspect4r/helper.rb

@@ -4,8 +4,8 @@ module Aspect4r
   module Helper
     def self.find_available_method_name klass, method_name_prefix
       0.upto(10000) do |i|
-        m = "#{method_name_prefix}#{i}_#{klass.hash}"
-        return m unless klass.private_instance_methods(false).include?(m)
+        m = "#{method_name_prefix}#{i}_#{klass.hash.abs}"
+        return m unless klass.private_instance_methods(false).detect {|method| method.to_s == m }
       end
     end
     
@@ -54,11 +54,11 @@ module Aspect4r
         
         wrapped_method = a4r_data.wrapped_methods[method]
         
-        if not wrapped_method and klass_or_module.instance_methods.include?(method)
+        if not wrapped_method and klass_or_module.instance_methods.detect {|m| m.to_s == method }
           wrapped_method = klass_or_module.instance_method(method)
           a4r_data.wrapped_methods[method] = wrapped_method
         end
-        
+
         create_method klass_or_module, method if wrapped_method
       end
     end

data/spec/aspect4r/advice_on_class_method_spec.rb

@@ -21,7 +21,7 @@ describe "Advices on singleton method (also known as class method)" do
           value << "before"
         end
         
-        after :test do
+        after :test do |result|
           value << "after"
         end
         
@@ -38,9 +38,9 @@ describe "Advices on singleton method (also known as class method)" do
   it "module singleton method" do
     module AdvicesOnModuleSingletonMethod
       include Aspect4r
-
+  
       class << self
- 
+   
         def value
           @value ||= []
         end
@@ -55,7 +55,7 @@ describe "Advices on singleton method (also known as class method)" do
           value << "before"
         end
         
-        after :test do
+        after :test do |result|
           value << "after"
         end
         

data/spec/aspect4r/before_spec.rb

@@ -86,7 +86,7 @@ describe Aspect4r::Before do
     
     o = @klass.new
     o.test('something')
-
+  
     o.value.should == 'something'
   end
   
@@ -101,7 +101,7 @@ describe Aspect4r::Before do
     
     o = @klass.new
     o.test('something')
-
+  
     s.should == 'test'
   end
   
@@ -110,7 +110,7 @@ describe Aspect4r::Before do
       def do_something value
         Aspect4r::ReturnThis.new('do_something')
       end
-
+  
       before :test, :do_something
     end
     
@@ -122,7 +122,7 @@ describe Aspect4r::Before do
   
   it "should skip original method if before_filter advice returned false" do
     @klass.class_eval do
-      before_filter :test do
+      before_filter :test do |value|
         false
       end
     end
@@ -135,7 +135,7 @@ describe Aspect4r::Before do
   
   it "should not skip original method if before_filter did not return false or nil" do
     @klass.class_eval do
-      before_filter :test do
+      before_filter :test do |value|
         true
       end
     end

data/spec/aspect4r_spec.rb

@@ -126,7 +126,7 @@ describe "Aspect4r execution order" do
         @value << "after1"
       end
       
-      after :test do
+      after :test do |result|
         @value << "after2"
       end
     end
@@ -232,7 +232,7 @@ describe "Aspect4r chaining (add advice to advice method)" do
         @value << "before(do_something)"
       end
       
-      after :do_something do
+      after :do_something do |result|
         @value << "after(do_something)"
       end
       
@@ -242,11 +242,11 @@ describe "Aspect4r chaining (add advice to advice method)" do
       
       after :test, :process_result
       
-      before :process_result do
+      before :process_result do |result|
         @value << "before(process_result)"
       end
       
-      after :process_result do
+      after :process_result do |result, *args|
         @value << "after(process_result)"
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: aspect4r
 version: !ruby/object:Gem::Version 
-  hash: 57
+  hash: 55
   prerelease: 
   segments: 
   - 0
-  - 9
-  - 1
-  version: 0.9.1
+  - 10
+  - 0
+  version: 0.10.0
 platform: ruby
 authors: 
 - Guoliang Cao
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 -04:00
+date: 2011-09-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -131,37 +131,5 @@ rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Aspect Oriented Programming for ruby
-test_files: 
-- examples/advices_on_class_method_example.rb
-- examples/after_example.rb
-- examples/around_example.rb
-- examples/before_example.rb
-- examples/combined_example.rb
-- examples/test_advices_example.rb
-- spec/aspect4r/advice_on_class_method_spec.rb
-- spec/aspect4r/advice_scope_spec.rb
-- spec/aspect4r/advice_test_spec.rb
-- spec/aspect4r/after_spec.rb
-- spec/aspect4r/around_spec.rb
-- spec/aspect4r/before_spec.rb
-- spec/aspect4r/class_inheritance_spec.rb
-- spec/aspect4r/classic_spec.rb
-- spec/aspect4r/helper_spec.rb
-- spec/aspect4r/include_advices_from_module_spec.rb
-- spec/aspect4r/inheritance_inclusion_combined_spec.rb
-- spec/aspect4r/method_added_spec.rb
-- spec/aspect4r/model/advice_group_spec.rb
-- spec/aspect4r/model/advice_spec.rb
-- spec/aspect4r/model/method_matcher_spec.rb
-- spec/aspect4r/module_inclusion_spec.rb
-- spec/aspect4r/regexp_methods_spec.rb
-- spec/aspect4r/singleton_method_added_spec.rb
-- spec/aspect4r/super_in_method_spec.rb
-- spec/aspect4r_spec.rb
-- spec/spec_helper.rb
-- test/after_test.rb
-- test/around_test.rb
-- test/before_test.rb
-- test/combined_test.rb
-- test/method_invocation_test.rb
-- test/test_helper.rb
+test_files: []
+