aspect4r 0.7.1 → 0.8.0

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "aspect4r"
     gem.summary = %Q{Aspect Oriented Programming for ruby}
-    gem.description = %Q{AOP for ruby - use before_method, after_method and around_method to trim your fat methods and reduce code duplication}
+    gem.description = %Q{AOP for ruby - use before, after and around to trim your fat methods and reduce code duplication}
     gem.email = "gcao99@gmail.com"
     gem.homepage = "http://github.com/gcao/aspect4r"
     gem.authors = ["Guoliang Cao"]

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.8.0

data/aspect4r.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{aspect4r}
-  s.version = "0.7.1"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Guoliang Cao"]
-  s.date = %q{2010-06-08}
-  s.description = %q{AOP for ruby - use before_method, after_method and around_method to trim your fat methods and reduce code duplication}
+  s.date = %q{2010-06-10}
+  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 = [
     "LICENSE",
@@ -44,6 +44,11 @@ Gem::Specification.new do |s|
      "lib/aspect4r/model/advices_for_method.rb",
      "lib/aspect4r/model/aspect_data.rb",
      "lib/aspect4r/return_this.rb",
+     "spec/aspect4r/advice_group_spec.rb",
+     "spec/aspect4r/advice_on_class_method_spec.rb",
+     "spec/aspect4r/advice_spec.rb",
+     "spec/aspect4r/advice_test_spec.rb",
+     "spec/aspect4r/advices_for_method_spec.rb",
      "spec/aspect4r/after_spec.rb",
      "spec/aspect4r/around_spec.rb",
      "spec/aspect4r/before_spec.rb",
@@ -69,7 +74,12 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Aspect Oriented Programming for ruby}
   s.test_files = [
-    "spec/aspect4r/after_spec.rb",
+    "spec/aspect4r/advice_group_spec.rb",
+     "spec/aspect4r/advice_on_class_method_spec.rb",
+     "spec/aspect4r/advice_spec.rb",
+     "spec/aspect4r/advice_test_spec.rb",
+     "spec/aspect4r/advices_for_method_spec.rb",
+     "spec/aspect4r/after_spec.rb",
      "spec/aspect4r/around_spec.rb",
      "spec/aspect4r/before_spec.rb",
      "spec/aspect4r/class_inheritance_spec.rb",

data/lib/aspect4r/base.rb

@@ -25,7 +25,16 @@ module Aspect4r
 
     module ClassMethods
       def a4r_data
-        @a4r_data ||= Aspect4r::Model::AspectData.new
+        @a4r_data ||= Aspect4r::Model::AspectData.new(self)
+      end
+      
+      def a4r_group
+        a4r_data.change_group
+        
+        if block_given?
+          yield
+          a4r_data.change_group
+        end
       end
     end
   end

data/lib/aspect4r/extensions/class_extension.rb

@@ -4,12 +4,7 @@ class Class
     
     return if @a4r_data.nil? or @a4r_data.empty?
 
-    a4r_data = Aspect4r::Model::AspectData.new
-    
-    # @a4r_data.each do |key, value|
-    #   a4r_data[key] = (value.clone rescue value)
-    # end
-    
+    a4r_data = Aspect4r::Model::AspectData.new(child)
     a4r_data.methods_with_advices.merge(@a4r_data.methods_with_advices)
     
     child.instance_variable_set('@a4r_data', a4r_data)

data/lib/aspect4r/extensions/module_extension.rb

@@ -1,6 +1,6 @@
 class Module
   def included_with_a4r(base)
-    included_without_a4r(child) if respond_to?(:included_without_a4r)
+    included_without_a4r(base)
     
     return if @a4r_data.nil? or @a4r_data.empty?
   
@@ -14,12 +14,12 @@ class Module
   alias included             included_with_a4r
   
   def method_added_with_a4r(method)
-    method_added_without_a4r(child) if respond_to?(:method_added_without_a4r)
+    method_added_without_a4r(method)
     
     return if method.to_s =~ /a4r/
 
     # save unbound method and create new method
-    if not Aspect4r::Helper.creating_method? and @a4r_data and method_advices = @a4r_data[method]
+    if @a4r_data and method_advices = @a4r_data[method] and not Aspect4r::Helper.creating_method?
       method_advices.wrapped_method = instance_method(method)
       Aspect4r::Helper.create_method self, method
     end
@@ -27,4 +27,22 @@ class Module
   
   alias method_added_without_a4r method_added
   alias method_added             method_added_with_a4r
+
+  def singleton_method_added_with_a4r(method)
+    singleton_method_added_without_a4r(method)
+    
+    return if method.to_s =~ /a4r/
+
+    # save unbound method and create new method
+    eigen_class = Aspect4r::Helper.eigen_class(self)
+    my_advices  = eigen_class.instance_variable_get(:@a4r_data)
+    
+    if my_advices and method_advices = my_advices[method] and not Aspect4r::Helper.creating_method?
+      method_advices.wrapped_method = eigen_class.instance_method(method)
+      Aspect4r::Helper.create_method eigen_class, method
+    end
+  end
+  
+  alias singleton_method_added_without_a4r singleton_method_added
+  alias singleton_method_added             singleton_method_added_with_a4r
 end

data/lib/aspect4r/helper.rb

@@ -13,10 +13,18 @@ module Aspect4r
       @creating_method
     end
     
+    def self.eigen_class klass_or_module
+      klass_or_module.module_eval do
+        class << self
+          self
+        end
+      end
+    end
+    
     # Store original method in aspect data and refer to it whenever recreating method
     def self.process_advice meta_data, klass_or_module, *methods, &block
       methods.flatten!
-      
+
       options = meta_data.default_options.clone
       options.merge!(methods.pop) if methods.last.is_a? Hash
       options.merge!(meta_data.mandatory_options)
@@ -33,8 +41,9 @@ module Aspect4r
         method = method.to_sym
         klass_or_module.a4r_data.methods_with_advices << method
         
-        aspect = klass_or_module.a4r_data[method] ||= Aspect4r::Model::AdvicesForMethod.new(method)
-        aspect.add Aspect4r::Model::Advice.new(meta_data.advice_type, with_method, options)
+        a4r_data = klass_or_module.a4r_data
+        aspect   = a4r_data[method] ||= Aspect4r::Model::AdvicesForMethod.new(method)
+        aspect.add Aspect4r::Model::Advice.new(meta_data.advice_type, with_method, a4r_data.group, options)
         
         if not aspect.wrapped_method and klass_or_module.instance_methods.include?(method.to_s)
           aspect.wrapped_method = klass_or_module.instance_method(method)
@@ -57,16 +66,16 @@ module Aspect4r
       end
       
       grouped_advices = []
-      inner_most = true
+      group           = nil
+      inner_most      = true
 
-      aspect.advices.each do |advice|
-        if advice.around? and not grouped_advices.empty?
+      aspect.each do |advice|
+        if ((group and group != advice.group) or advice.around?) and not grouped_advices.empty?
           # wrap up advices before current advice
           create_method_for_before_after_advices klass, method, grouped_advices, inner_most
           
-          inner_most = false
-          
           grouped_advices = []
+          inner_most      = false
         end
         
         # handle current advice
@@ -76,6 +85,8 @@ module Aspect4r
         else
           grouped_advices << advice
         end
+        
+        group = advice.group
       end
       
       # create wrap method for before/after advices which are not wrapped inside around advice.
@@ -160,7 +171,7 @@ module Aspect4r
     CODE
     
     def self.create_method_for_before_after_advices klass, method, advices, inner_most
-      before_advices = advices.select {|advice| advice.before? }
+      before_advices = advices.select {|advice| advice.before? or advice.before_filter? }
       after_advices  = advices.select {|advice| advice.after?  }
       
       code = METHOD_TEMPLATE.result(binding)

data/lib/aspect4r/model/advice.rb

@@ -5,24 +5,38 @@ module Aspect4r
       AFTER  = 2
       AROUND = 3
     
+      attr :group
       attr_accessor :type, :with_method, :options
     
-      def initialize type, with_method, options = {}
+      def initialize type, with_method, group, options = {}
         @type        = type
         @with_method = with_method
+        @group       = group
         @options     = options
       end
     
       def name
         options[:name] || with_method
       end
-    
-      %w(before after around).each do |aspect|
-        class_eval <<-CODE
-          def #{aspect}? 
-            type == #{aspect.upcase}
-          end
-        CODE
+      
+      def before?
+        type == BEFORE and not options[:skip_if_false]
+      end
+      
+      def before_filter?
+        type == BEFORE and options[:skip_if_false]
+      end
+      
+      def after?
+        type == AFTER
+      end
+      
+      def around?
+        type == AROUND
+      end
+      
+      def invoke obj, *args
+        obj.send with_method, *args
       end
     end
   end

data/lib/aspect4r/model/advices_for_method.rb

@@ -1,6 +1,6 @@
 module Aspect4r
   module Model
-    class AdvicesForMethod
+    class AdvicesForMethod < Array
       attr_reader :method
       attr_accessor :wrapped_method
     
@@ -8,37 +8,18 @@ module Aspect4r
         @method = method
       end
     
-      def advices
-        @advices ||= []
-      end
-    
       def add new_advice
-        advices << new_advice unless include?(new_advice)
-      end
-    
-      def empty?
-        @advices.nil? or @advices.empty?
+        self << new_advice unless include?(new_advice)
       end
-    
-      def include? new_advice
-        advices.detect { |advice| advice.name == new_advice.name }
-      end
-    
-      def merge! another
-        unless another.nil? or another.empty?
-          another.advices.each do |advice|
-            advices.push advice unless include?(advice)
-          end
-        end
 
-        self
+      def include? new_advice
+        detect { |advice| advice.name == new_advice.name }
       end
-    
-      def clone
-        o = self.class.new(method)
-        o.advices.push *advices unless empty?
-
-        o
+      
+      def [] index
+        return super unless index.is_a? String or index.is_a? Symbol
+        
+        detect {|advice| advice.name.to_sym == index.to_sym }
       end
     end
   end

data/lib/aspect4r/model/aspect_data.rb

@@ -3,12 +3,20 @@ require 'set'
 module Aspect4r
   module Model
     class AspectData < Hash
-      def initialize *args
-        super
+      def initialize klass_or_module
+        @klass_or_module = klass_or_module
       end
-    
-      def advices
-        @advices ||= {}
+      
+      def group_index
+        @group_index ||= 0
+      end
+            
+      def group
+        "#{@klass_or_module.hash}:#{group_index}"
+      end
+      
+      def change_group
+        @group_index = group_index + 1
       end
       
       def methods_with_advices

data/lib/aspect4r.rb

@@ -1,6 +1,7 @@
 require 'aspect4r/before'
 require 'aspect4r/after'
 require 'aspect4r/around'
+require 'aspect4r/classic'
 
 module Aspect4r
   def self.included(base)

data/spec/aspect4r/advice_group_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Group of advices" do
+  it "should work" do
+    klass = Class.new do
+      include Aspect4r
+
+      attr :value
+      
+      def initialize
+        @value = []
+      end
+      
+      def test
+        @value << "test"
+      end
+
+      a4r_group do
+        before :test do
+          @value << "before(group1)"
+        end
+      end
+      
+      a4r_group do
+        before :test do
+          @value << "before(group2)"
+        end
+      end
+    end
+    
+    o = klass.new
+    o.test
+    
+    o.value.should == %w(before(group2) before(group1) test)
+  end
+end

data/spec/aspect4r/advice_on_class_method_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Advices on singleton method (also known as class method)" do
+  it "class method" do
+    class AdvicesOnClassMethod
+      class << self
+        include Aspect4r
+        
+        def value
+          @value ||= []
+        end
+        
+        around :test do |proxy|
+          value << "around(before)"
+          a4r_invoke proxy
+          value << "around(after)"
+        end
+        
+        before :test do
+          value << "before"
+        end
+        
+        after :test do
+          value << "after"
+        end
+        
+        def test
+          value << "test"
+        end
+      end
+    end
+    
+    AdvicesOnClassMethod.test
+    AdvicesOnClassMethod.value.should == %w(before around(before) test around(after) after)
+  end
+
+  it "module singleton method" do
+    module AdvicesOnModuleSingletonMethod
+      class << self
+        include Aspect4r
+        
+        def value
+          @value ||= []
+        end
+        
+        around :test do |proxy|
+          value << "around(before)"
+          a4r_invoke proxy
+          value << "around(after)"
+        end
+        
+        before :test do
+          value << "before"
+        end
+        
+        after :test do
+          value << "after"
+        end
+        
+        def test
+          value << "test"
+        end
+      end
+    end
+    
+    AdvicesOnModuleSingletonMethod.test
+    AdvicesOnModuleSingletonMethod.value.should == %w(before around(before) test around(after) after)
+  end
+end

data/spec/aspect4r/advice_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Aspect4r::Model::Advice do
+  it "before? returns true for before advice" do
+    advice = Aspect4r::Model::Advice.new Aspect4r::Model::Advice::BEFORE, :advice_method, :group
+    advice.before?.should be_true
+  end
+  
+  it "before_filter? returns false for before_filter advice" do
+    advice = Aspect4r::Model::Advice.new Aspect4r::Model::Advice::BEFORE, :advice_method, :group
+    advice.before_filter?.should be_false
+  end
+  
+  it "before? returns false for before advice" do
+    advice = Aspect4r::Model::Advice.new Aspect4r::Model::Advice::BEFORE, :advice_method, :group, :skip_if_false => true
+    advice.before?.should be_false
+  end
+  
+  it "before_filter? returns true for before_filter advice" do
+    advice = Aspect4r::Model::Advice.new Aspect4r::Model::Advice::BEFORE, :advice_method, :group, :skip_if_false => true
+    advice.before_filter?.should be_true
+  end
+  
+  it "invoke before advice" do
+    advice = Aspect4r::Model::Advice.new Aspect4r::Model::Advice::BEFORE, :advice_method, :group
+    
+    o = Object.new
+    o.class.send :define_method, :advice_method do |*args|
+      do_something *args
+    end
+    
+    o.expects(:do_something).with(1)
+    
+    advice.invoke(o, 1)
+  end
+  
+  it "invoke after advice" do
+    advice = Aspect4r::Model::Advice.new Aspect4r::Model::Advice::AFTER, :advice_method, :group
+    
+    o = Object.new
+    o.class.send :define_method, :advice_method do |result, *args|
+      do_something result, *args
+    end
+    
+    o.expects(:do_something).with(1)
+    
+    advice.invoke(o, 1)
+  end
+  
+  it "invoke around advice" do
+    advice = Aspect4r::Model::Advice.new Aspect4r::Model::Advice::AROUND, :advice_method, :group
+    
+    o = Object.new
+    o.class.send :define_method, :advice_method do |proxy, *args|
+      a4r_invoke proxy, *args
+    end
+    
+    o.expects(:a4r_invoke).with(:proxy, 1)
+    
+    advice.invoke(o, :proxy, 1)
+  end
+end

data/spec/aspect4r/advice_test_spec.rb

@@ -0,0 +1,102 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Test Advices" do
+  before do
+    @klass = Class.new do
+      include Aspect4r
+      
+      attr :value
+      
+      def initialize
+        @value = []
+      end
+      
+      around :test do |proxy, input|
+        @value << "around(before)"
+        a4r_invoke proxy, input
+        @value << "around(after)"
+      end
+      
+      before :test, :name => 'before_advice' do |input|
+        @value << 'before'
+      end
+      
+      before_filter :test do |input|
+        @value << 'before_filter'
+        input >= 0
+      end
+      
+      after :test do |result, input|
+        @value << "after"
+        result * 100
+      end
+      
+      def test input
+        @value << "test"
+      end
+    end
+  end
+  
+  it "number of advices" do
+    @klass.a4r_data[:test].size.should == 4
+  end
+
+  it "around advice" do
+    advice = @klass.a4r_data[:test][0]
+    advice.around?.should be_true
+
+    o = @klass.new
+    o.expects(:a4r_invoke).with(:proxy, 1)
+     
+    advice.invoke(o, :proxy, 1)
+
+    o.value.should == %w(around(before) around(after))
+  end
+  
+  it "before advice" do
+    advice = @klass.a4r_data[:test][1]
+    advice.before?.should be_true
+
+    o = @klass.new
+    advice.invoke(o, 1)
+
+    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.before_filter?.should be_true
+
+    o = @klass.new
+    advice.invoke(o, 1).should be_true
+
+    o.value.should == %w(before_filter)
+  end
+  
+  it "before_filter advice returns false if input is negative" do
+    advice = @klass.a4r_data[:test][2]
+
+    o = @klass.new
+    advice.invoke(o, -1).should be_false
+  end
+  
+  it "after advice" do
+    advice = @klass.a4r_data[:test][3]
+    advice.after?.should be_true
+
+    o = @klass.new
+    advice.invoke(o, 1, 1).should == 100
+
+    o.value.should == %w(after)
+  end
+end

data/spec/aspect4r/advices_for_method_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Aspect4r::Model::AdvicesForMethod do
+  it "should be able to get advice by name" do
+    advices = Aspect4r::Model::AdvicesForMethod.new(:test)
+    advice1 = Aspect4r::Model::Advice.new Aspect4r::Model::Advice::BEFORE, :advice_method, :group, :name => :advice1
+    advices.add advice1
+    advices[:advice1].should == advice1
+  end
+  
+  it "should be able to get advice by name String" do
+    advices = Aspect4r::Model::AdvicesForMethod.new(:test)
+    advice1 = Aspect4r::Model::Advice.new Aspect4r::Model::Advice::BEFORE, :advice_method, :group, :name => :advice1
+    advices.add advice1
+    advices['advice1'].should == advice1
+  end
+end

data/spec/aspect4r/classic_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-require 'aspect4r/classic'
+require 'aspect4r'
 
 describe Aspect4r::Classic do
   it "should work" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: aspect4r
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 1
-  version: 0.7.1
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Guoliang Cao
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-08 00:00:00 -04:00
+date: 2010-06-10 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
-description: AOP for ruby - use before_method, after_method and around_method to trim your fat methods and reduce code duplication
+description: AOP for ruby - use before, after and around to trim your fat methods and reduce code duplication
 email: gcao99@gmail.com
 executables: []
 
@@ -71,6 +71,11 @@ files:
 - lib/aspect4r/model/advices_for_method.rb
 - lib/aspect4r/model/aspect_data.rb
 - lib/aspect4r/return_this.rb
+- spec/aspect4r/advice_group_spec.rb
+- spec/aspect4r/advice_on_class_method_spec.rb
+- spec/aspect4r/advice_spec.rb
+- spec/aspect4r/advice_test_spec.rb
+- spec/aspect4r/advices_for_method_spec.rb
 - spec/aspect4r/after_spec.rb
 - spec/aspect4r/around_spec.rb
 - spec/aspect4r/before_spec.rb
@@ -124,6 +129,11 @@ signing_key:
 specification_version: 3
 summary: Aspect Oriented Programming for ruby
 test_files: 
+- spec/aspect4r/advice_group_spec.rb
+- spec/aspect4r/advice_on_class_method_spec.rb
+- spec/aspect4r/advice_spec.rb
+- spec/aspect4r/advice_test_spec.rb
+- spec/aspect4r/advices_for_method_spec.rb
 - spec/aspect4r/after_spec.rb
 - spec/aspect4r/around_spec.rb
 - spec/aspect4r/before_spec.rb