aspect4r 0.8.1 → 0.8.2

data/README.rdoc

@@ -11,6 +11,8 @@ Aspect Oriented Programming support for Ruby
 
 == Usage
 
+API documentation: http://gcao.posterous.com/aspect4r-usage-and-public-api
+
   class A
     include Aspect4r
     
@@ -51,9 +53,11 @@ Aspect Oriented Programming support for Ruby
   
 == How does it work?
 
+Execution model: http://gcao.posterous.com/aspect4r-documentation-advice-execution-model
+
 == TODO
 
-See github issues tab http://github.com/gcao/aspect4r/issues
+See github issues http://github.com/gcao/aspect4r/issues
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.8.1
+0.8.2

data/aspect4r.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{aspect4r}
-  s.version = "0.8.1"
+  s.version = "0.8.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Guoliang Cao"]
-  s.date = %q{2010-06-11}
+  s.date = %q{2010-07-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 = [
@@ -25,10 +25,12 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "aspect4r.gemspec",
+     "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",
      "lib/aspect4r.rb",
      "lib/aspect4r/after.rb",
      "lib/aspect4r/around.rb",
@@ -36,7 +38,6 @@ Gem::Specification.new do |s|
      "lib/aspect4r/before.rb",
      "lib/aspect4r/classic.rb",
      "lib/aspect4r/errors.rb",
-     "lib/aspect4r/extensions/class_extension.rb",
      "lib/aspect4r/extensions/module_extension.rb",
      "lib/aspect4r/helper.rb",
      "lib/aspect4r/model/advice.rb",
@@ -55,8 +56,11 @@ Gem::Specification.new do |s|
      "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/module_inclusion_spec.rb",
+     "spec/aspect4r/singleton_method_added_spec.rb",
      "spec/aspect4r/super_in_method_spec.rb",
      "spec/aspect4r_spec.rb",
      "spec/spec.opts",
@@ -85,8 +89,11 @@ Gem::Specification.new do |s|
      "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/module_inclusion_spec.rb",
+     "spec/aspect4r/singleton_method_added_spec.rb",
      "spec/aspect4r/super_in_method_spec.rb",
      "spec/aspect4r_spec.rb",
      "spec/spec_helper.rb",
@@ -96,11 +103,12 @@ Gem::Specification.new do |s|
      "test/combined_test.rb",
      "test/method_invocation_test.rb",
      "test/test_helper.rb",
+     "examples/advices_on_class_method_example.rb",
      "examples/after_example.rb",
      "examples/around_example.rb",
      "examples/before_example.rb",
      "examples/combined_example.rb",
-     "examples/method_to_advices_example.rb"
+     "examples/test_advices_example.rb"
   ]
 
   if s.respond_to? :specification_version then

data/examples/advices_on_class_method_example.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'aspect4r'
+
+class A
+  class << self
+    include Aspect4r
+    
+    around :test do |proxy, input|
+      puts 'around test (before)'
+      result = a4r_invoke proxy, input
+      puts 'around test (after)'
+      result
+    end
+    
+    before :test do |input|
+      puts 'before test'
+    end
+    
+    after :test do |result, input|
+      puts 'after test'
+      result
+    end
+    
+    def test input
+      puts 'test'
+      input
+    end
+  end
+end
+
+puts "Example 1:"
+puts A.test(1)
+# ==== Output ====
+# before test
+# around test (before)
+# test
+# around test (after)
+# after test
+# 1

data/examples/test_advices_example.rb

@@ -0,0 +1,121 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+require 'aspect4r'
+
+# ======================= Class to be tested =================================
+class Klass
+  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
+
+# =============================== Tests start here ===========================
+describe Klass do
+  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
+  
+  it "test method without advices" do
+    Klass.a4r_disable_advices_temporarily :test do
+      o = Klass.new
+      o.test 1
+      
+      o.value.should == %w(test)
+    end
+  end
+end

data/lib/aspect4r/base.rb

@@ -7,7 +7,6 @@ require 'aspect4r/return_this'
 
 require 'aspect4r/helper'
 
-require 'aspect4r/extensions/class_extension'
 require 'aspect4r/extensions/module_extension'
 
 module Aspect4r
@@ -15,6 +14,7 @@ module Aspect4r
     def self.included(base)
       base.send(:include, InstanceMethods)
       base.extend(ClassMethods)
+      base.instance_variable_set('@a4r_data', Aspect4r::Model::AspectData.new(base))
     end
 
     module InstanceMethods
@@ -28,11 +28,11 @@ module Aspect4r
         @a4r_data ||= Aspect4r::Model::AspectData.new(self)
       end
       
-      def a4r_group
+      def a4r_group &block
         a4r_data.change_group
         
         if block_given?
-          yield
+          instance_eval &block
           a4r_data.change_group
         end
       end

data/lib/aspect4r/extensions/module_extension.rb

@@ -1,18 +1,4 @@
 class Module
-  def included_with_a4r(base)
-    included_without_a4r(base)
-    
-    return if @a4r_data.nil? or @a4r_data.empty?
-  
-    base.send(:include, Aspect4r)
-    
-    existing_aspects = base.a4r_data
-    existing_aspects.methods_with_advices.merge(@a4r_data.methods_with_advices)    
-  end
-  
-  alias included_without_a4r included
-  alias included             included_with_a4r
-  
   def method_added_with_a4r(method)
     method_added_without_a4r(method)
     
@@ -34,7 +20,12 @@ class Module
     return if method.to_s =~ /a4r/
 
     # save unbound method and create new method
-    eigen_class = Aspect4r::Helper.eigen_class(self)
+    eigen_class = instance_eval do
+      class << self
+        self
+      end
+    end
+
     my_advices  = eigen_class.instance_variable_get(:@a4r_data)
     
     if my_advices and method_advices = my_advices[method] and not Aspect4r::Helper.creating_method?

data/lib/aspect4r/helper.rb

@@ -20,14 +20,6 @@ module Aspect4r
       @creating_method = false
     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!
@@ -49,7 +41,6 @@ module Aspect4r
       
       methods.each do |method|
         method = method.to_sym
-        klass_or_module.a4r_data.methods_with_advices << method
         
         aspect = a4r_data[method] ||= Aspect4r::Model::AdvicesForMethod.new(method)
         aspect.add advice
@@ -76,58 +67,22 @@ module Aspect4r
 
       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
+          create_method_with_advices klass, method, grouped_advices, inner_most
           
           grouped_advices = []
           inner_most      = false
         end
         
-        # handle current advice
-        if advice.around?
-          create_method_for_around_advice klass, method, advice, inner_most
-          inner_most = false
-        else
-          grouped_advices << advice
-        end
-        
-        group = advice.group
+        grouped_advices << advice
+        group           = advice.group
       end
       
       # create wrap method for before/after advices which are not wrapped inside around advice.
-      unless grouped_advices.empty?
-        create_method_for_before_after_advices klass, method, grouped_advices, inner_most unless grouped_advices.empty?
-      end
+      create_method_with_advices klass, method, grouped_advices, inner_most unless grouped_advices.empty?
     ensure
       @creating_method = nil
     end
     
-    # method
-    # advice
-    WRAP_METHOD_TEMPLATE = ERB.new <<-CODE, nil, '<>'
-<% if inner_most %>
-      wrapped_method = a4r_data[:<%= method %>].wrapped_method
-<% else %>
-      wrapped_method = instance_method(:<%= method %>)
-<% end %>
-
-      define_method :<%= method %> do |*args|
-<% if advice.options[:method_name_arg] %>
-        result = <%= advice.with_method %> '<%= method %>', wrapped_method, *args
-<% else %>
-        result = <%= advice.with_method %> wrapped_method, *args
-<% end %>
-        
-        result
-      end
-    CODE
-    
-    def self.create_method_for_around_advice klass, method, advice, inner_most
-      code = WRAP_METHOD_TEMPLATE.result(binding)
-      # puts code
-      klass.class_eval code, __FILE__
-    end
-    
     # method
     # before_advices
     # after_advices
@@ -155,8 +110,17 @@ module Aspect4r
 <% end %>
 <% end %>
 
-        # Call wrapped method
+<% if around_advice %>
+        # around advice
+<%   if around_advice.options[:method_name_arg] %>
+        result = <%= around_advice.with_method %> '<%= method %>', wrapped_method, *args
+<%   else %>
+        result = <%= around_advice.with_method %> wrapped_method, *args
+<%   end %>
+<% else %>
+        # Invoke wrapped method
         result = wrapped_method.bind(self).call *args
+<% end %>
 
         # After advices
 <% after_advices.each do |definition| %>
@@ -175,9 +139,10 @@ module Aspect4r
       end
     CODE
     
-    def self.create_method_for_before_after_advices klass, method, advices, inner_most
+    def self.create_method_with_advices klass, method, advices, inner_most
       before_advices = advices.select {|advice| advice.before? or advice.before_filter? }
       after_advices  = advices.select {|advice| advice.after?  }
+      around_advice  = advices.first if advices.first.around?
       
       code = METHOD_TEMPLATE.result(binding)
       # puts code

data/lib/aspect4r/model/aspect_data.rb

@@ -18,10 +18,6 @@ module Aspect4r
       def change_group
         @group_index = group_index + 1
       end
-      
-      def methods_with_advices
-        @methods_with_advices ||= Set.new
-      end
     end
   end
 end

data/spec/aspect4r/advice_group_spec.rb

@@ -14,6 +14,10 @@ describe "Group of advices" do
       def test
         @value << "test"
       end
+      
+      before :test do
+        @value << "before"
+      end
 
       a4r_group do
         before :test do
@@ -31,6 +35,6 @@ describe "Group of advices" do
     o = klass.new
     o.test
     
-    o.value.should == %w(before(group2) before(group1) test)
+    o.value.should == %w(before(group2) before(group1) before test)
   end
 end

data/spec/aspect4r/include_advices_from_module_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Aspect4r do
+  it "Mix advices from module" do
+    module AdvicesMod
+      include Aspect4r
+      
+      def before_test
+        @value << "before(module)"
+      end
+      
+      def self.included(base)
+        super
+
+        base.send :include, Aspect4r
+        base.before :test, :before_test
+      end
+    end
+    
+    klass = Class.new do
+      include Aspect4r
+      
+      attr :value
+      
+      def initialize
+        @value = []
+      end
+      
+      before :test do
+        @value << 'before'
+      end
+      
+      def test
+        @value << 'test'
+      end
+      
+      include AdvicesMod
+    end
+    
+    o = klass.new
+    o.test
+    
+    o.value.should == %w(before before(module) test)
+  end
+  
+  it "Mix advice group from module" do
+    module AdvicesMod1
+      include Aspect4r
+      
+      def before_test
+        @value << "before(module)"
+      end
+      
+      def self.included(base)
+        super
+        
+        base.send :include, Aspect4r
+        base.a4r_group do
+          before :test, :before_test
+        end
+      end
+    end
+    
+    klass = Class.new do
+      include Aspect4r
+      
+      attr :value
+      
+      def initialize
+        @value = []
+      end
+      
+      before :test do
+        @value << 'before'
+      end
+      
+      def test
+        @value << 'test'
+      end
+      
+      include AdvicesMod1
+    end
+    
+    o = klass.new
+    o.test
+    
+    o.value.should == %w(before(module) before test)
+  end
+end

data/spec/aspect4r/method_added_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "method_added" do
+  it "should work if target method is defined after method_added and method_added calls super" do
+    klass = Class.new do
+      include Aspect4r
+      
+      attr :value
+      
+      def initialize
+        @value = []
+      end
+  
+      around :test do |proxy|
+        @value << "around1"
+        a4r_invoke proxy
+        @value << "around2"
+      end   
+      
+      before :test do
+        @value << "before"
+      end
+  
+      after :test do |result|
+        @value << "after"
+      end
+      
+      def self.method_added(method)
+        super
+      end
+      
+      def test
+        @value << "test"
+      end
+    end
+    
+    o = klass.new
+    o.test
+    
+    o.value.should == %w(before around1 test around2 after)
+  end
+end

data/spec/aspect4r/singleton_method_added_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "singleton_method_added" do
+  it "should work if target method is defined after singleton_method_added and singleton_method_added calls super" do
+    class AdvicesOnClassMethod1
+      def self.singleton_method_added(method)
+        super
+      end
+      
+      class << self
+        include Aspect4r
+        
+        def value
+          @value ||= []
+        end
+  
+        around :test do |proxy|
+          value << "around1"
+          a4r_invoke proxy
+          value << "around2"
+        end   
+      
+        before :test do
+          value << "before"
+        end
+  
+        after :test do |result|
+          value << "after"
+        end
+      
+        def test
+          value << "test"
+        end
+      end
+    end
+    
+    AdvicesOnClassMethod1.test
+    AdvicesOnClassMethod1.value.should == %w(before around1 test around2 after)
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: aspect4r
 version: !ruby/object:Gem::Version 
-  hash: 61
+  hash: 59
   prerelease: false
   segments: 
   - 0
   - 8
-  - 1
-  version: 0.8.1
+  - 2
+  version: 0.8.2
 platform: ruby
 authors: 
 - Guoliang Cao
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-11 00:00:00 -04:00
+date: 2010-07-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,10 +52,12 @@ files:
 - Rakefile
 - VERSION
 - aspect4r.gemspec
+- 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
 - lib/aspect4r.rb
 - lib/aspect4r/after.rb
 - lib/aspect4r/around.rb
@@ -63,7 +65,6 @@ files:
 - lib/aspect4r/before.rb
 - lib/aspect4r/classic.rb
 - lib/aspect4r/errors.rb
-- lib/aspect4r/extensions/class_extension.rb
 - lib/aspect4r/extensions/module_extension.rb
 - lib/aspect4r/helper.rb
 - lib/aspect4r/model/advice.rb
@@ -82,8 +83,11 @@ files:
 - 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/module_inclusion_spec.rb
+- spec/aspect4r/singleton_method_added_spec.rb
 - spec/aspect4r/super_in_method_spec.rb
 - spec/aspect4r_spec.rb
 - spec/spec.opts
@@ -94,7 +98,6 @@ files:
 - test/combined_test.rb
 - test/method_invocation_test.rb
 - test/test_helper.rb
-- examples/method_to_advices_example.rb
 has_rdoc: true
 homepage: http://github.com/gcao/aspect4r
 licenses: []
@@ -141,8 +144,11 @@ test_files:
 - 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/module_inclusion_spec.rb
+- spec/aspect4r/singleton_method_added_spec.rb
 - spec/aspect4r/super_in_method_spec.rb
 - spec/aspect4r_spec.rb
 - spec/spec_helper.rb
@@ -152,8 +158,9 @@ test_files:
 - test/combined_test.rb
 - test/method_invocation_test.rb
 - test/test_helper.rb
+- examples/advices_on_class_method_example.rb
 - examples/after_example.rb
 - examples/around_example.rb
 - examples/before_example.rb
 - examples/combined_example.rb
-- examples/method_to_advices_example.rb
+- examples/test_advices_example.rb

data/lib/aspect4r/extensions/class_extension.rb

@@ -1,15 +0,0 @@
-class Class 
-  def inherited_with_a4r(child)
-    inherited_without_a4r(child) if respond_to?(:inherited_without_a4r, true)
-    
-    return if @a4r_data.nil? or @a4r_data.empty?
-
-    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)
-  end
-
-  alias inherited_without_a4r inherited
-  alias inherited             inherited_with_a4r
-end