aspect4r 0.7.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test/output

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Guoliang Cao
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/NOTES.rdoc

@@ -0,0 +1,42 @@
+== TEST TODO
+
+Class inheritance
+
+Module inclusion
+
+Mix aspects in body and in module
+
+Mix aspects from multiple modules
+
+Mix aspects in body and inherited
+
+Mix aspects in body, inherited and in module
+
+== optimization idea
+
+On create method, define method as a place holder which will generate the real method on first execution
+
+== Inheritance / inclusion
+
+Automatically group aspects by the class/module that creates them
+Before aspects defined in base class run immediately before wrapped method
+After aspects run immediagely after
+Around aspects wrap around wrapped method
+
+Before aspects defined in module that are included at the beginning run before aspects from base class and after those in current class
+After aspects in module run after aspects from base class and before those in current class
+Around aspects in module wrap around wrapped method + before/after aspects in base class
+
+Before aspects defined in module that are included later run before all aspects already defined so far
+After aspects in module run after all aspects
+Around aspects in module wrap around wrapped method + before/after aspects
+
+== Clean up
+
+Reduce duplication in before/after/around.rb
+
+Include Aspect4r::Base in target module/class when a module with advices is included.
+
+Add included_with_a4r(for module) and inherited_with_a4r(for class) when Aspect4r::Base is included
+
+Rename class AspectForMethod, Definition etc.

data/README.rdoc

@@ -0,0 +1,70 @@
+= aspect4r
+
+Aspect Oriented Programming support for Ruby
+
+== Feature
+
+* 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
+
+== Usage
+
+  class A
+    include Aspect4r
+    
+    around :test do |proxy_method, value|
+      a4r_invoke proxy_method, value
+    end
+
+    before :test do |value|
+      puts "entering test(#{value})"
+    end
+
+    before  :test, :do_something
+    
+    before_filter :test do |value|
+      value >= 0
+    end
+
+    after :test do |result, value|
+      puts "test(#{value}) returned #{result}"
+      result
+    end
+
+    after :test, :do_something_else
+    
+    def test value
+      ...
+    end
+
+    def do_something value
+      ...
+    end
+    
+    def do_something_else result, value
+      ...
+    end
+
+  end
+  
+== How does it work?
+
+== TODO
+
+See github issues tab http://github.com/gcao/aspect4r/issues
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Guoliang Cao. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  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.email = "gcao99@gmail.com"
+    gem.homepage = "http://github.com/gcao/aspect4r"
+    gem.authors = ["Guoliang Cao"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "aspect4r #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.7.1

data/aspect4r.gemspec

@@ -0,0 +1,108 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{aspect4r}
+  s.version = "0.7.1"
+
+  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.email = %q{gcao99@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "NOTES.rdoc",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "aspect4r.gemspec",
+     "examples/after_example.rb",
+     "examples/around_example.rb",
+     "examples/before_example.rb",
+     "examples/combined_example.rb",
+     "lib/aspect4r.rb",
+     "lib/aspect4r/after.rb",
+     "lib/aspect4r/around.rb",
+     "lib/aspect4r/base.rb",
+     "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",
+     "lib/aspect4r/model/advice_metadata.rb",
+     "lib/aspect4r/model/advices_for_method.rb",
+     "lib/aspect4r/model/aspect_data.rb",
+     "lib/aspect4r/return_this.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/inheritance_inclusion_combined_spec.rb",
+     "spec/aspect4r/module_inclusion_spec.rb",
+     "spec/aspect4r/super_in_method_spec.rb",
+     "spec/aspect4r_spec.rb",
+     "spec/spec.opts",
+     "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"
+  ]
+  s.homepage = %q{http://github.com/gcao/aspect4r}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  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/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/inheritance_inclusion_combined_spec.rb",
+     "spec/aspect4r/module_inclusion_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",
+     "examples/after_example.rb",
+     "examples/around_example.rb",
+     "examples/before_example.rb",
+     "examples/combined_example.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/examples/after_example.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'aspect4r'
+
+class A
+  include Aspect4r
+  
+  def test value
+    puts 'test'
+    value
+  end
+  
+  after :test, :result_arg => false do |value|
+    puts 'after test'
+  end
+  
+  after :test do |result, value|
+    puts 'after test 2'
+    result * 100
+  end
+end
+
+puts "Example 1:"
+puts A.new.test(1)
+# ==== Output ====
+# test
+# after test
+# after test 2
+# 100
+

data/examples/around_example.rb

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

data/examples/before_example.rb

@@ -0,0 +1,62 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'aspect4r'
+
+class A
+  include Aspect4r
+  
+  def test value
+    puts 'test'
+  end
+  
+  before :test do |value|
+    puts 'before test'
+  end
+  
+  before_filter :test do |value|
+    puts 'check before test'
+    value >= 0
+  end
+end
+
+puts "Example 1:"
+A.new.test 1
+# ==== Output ====
+# before test
+# check before test
+# test
+
+puts "\nExample 2:"
+A.new.test -1
+# ==== Output ====
+# before test
+# check before test
+
+
+module M
+  include Aspect4r
+  
+  before :test do |value|
+    puts 'before test'
+  end
+  
+  before_filter :test do |value|
+    puts 'check before test'
+    value >= 0
+  end
+end
+
+class B
+  def test value
+    puts 'test'
+  end
+  
+  include M
+end
+
+puts "\nExample 3:"
+B.new.test 1
+# ==== Output ====
+# before test
+# check before test
+# test

data/examples/combined_example.rb

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

data/lib/aspect4r/after.rb

@@ -0,0 +1,29 @@
+require 'aspect4r/base'
+
+module Aspect4r
+  module After
+    def self.included(base)
+      base.send(:include, Base::InstanceMethods)
+      base.extend(Base::ClassMethods, ClassMethods)
+    end
+
+    module ClassMethods
+      def after *methods, &block
+        Aspect4r::Helper.process_advice Aspect4r::Model::AdviceMetadata::AFTER, self, methods, &block
+      end
+    end
+    
+    module Classic
+      def self.included(base)
+        base.send(:include, Base::InstanceMethods)
+        base.extend(Base::ClassMethods, ClassMethods)
+      end
+
+      module ClassMethods
+        def a4r_after *methods, &block
+          Aspect4r::Helper.process_advice Aspect4r::Model::AdviceMetadata::AFTER, self, methods, &block
+        end
+      end
+    end
+  end
+end

data/lib/aspect4r/around.rb

@@ -0,0 +1,29 @@
+require 'aspect4r/base'
+
+module Aspect4r
+  module Around
+    def self.included(base)
+      base.send(:include, Base::InstanceMethods)
+      base.extend(Base::ClassMethods, ClassMethods)
+    end
+
+    module ClassMethods
+      def around *methods, &block
+        Aspect4r::Helper.process_advice Aspect4r::Model::AdviceMetadata::AROUND, self, methods, &block
+      end
+    end
+    
+    module Classic
+      def self.included(base)
+        base.send(:include, Base::InstanceMethods)
+        base.extend(Base::ClassMethods, ClassMethods)
+      end
+
+      module ClassMethods
+        def a4r_around *methods, &block
+          Aspect4r::Helper.process_advice Aspect4r::Model::AdviceMetadata::AROUND, self, methods, &block
+        end
+      end
+    end
+  end
+end

data/lib/aspect4r/base.rb

@@ -0,0 +1,32 @@
+require 'aspect4r/errors'
+require 'aspect4r/model/advice'
+require 'aspect4r/model/advices_for_method'
+require 'aspect4r/model/aspect_data'
+require 'aspect4r/model/advice_metadata'
+require 'aspect4r/return_this'
+
+require 'aspect4r/helper'
+
+require 'aspect4r/extensions/class_extension'
+require 'aspect4r/extensions/module_extension'
+
+module Aspect4r
+  module Base
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.extend(ClassMethods)
+    end
+
+    module InstanceMethods
+      def a4r_invoke proxy, *args
+        proxy.bind(self).call *args
+      end
+    end
+
+    module ClassMethods
+      def a4r_data
+        @a4r_data ||= Aspect4r::Model::AspectData.new
+      end
+    end
+  end
+end

data/lib/aspect4r/before.rb

@@ -0,0 +1,37 @@
+require 'aspect4r/base'
+
+module Aspect4r
+  module Before
+    def self.included(base)
+      base.send(:include, Base::InstanceMethods)
+      base.extend(Base::ClassMethods, ClassMethods)
+    end
+
+    module ClassMethods
+      def before *methods, &block
+        Aspect4r::Helper.process_advice Aspect4r::Model::AdviceMetadata::BEFORE, self, methods, &block
+      end
+    
+      def before_filter *methods, &block
+        Aspect4r::Helper.process_advice Aspect4r::Model::AdviceMetadata::BEFORE_FILTER, self, methods, &block
+      end
+    end
+    
+    module Classic
+      def self.included(base)
+        base.send(:include, Base::InstanceMethods)
+        base.extend(Base::ClassMethods, ClassMethods)
+      end
+    
+      module ClassMethods
+        def a4r_before *methods, &block
+          Aspect4r::Helper.process_advice Aspect4r::Model::AdviceMetadata::BEFORE, self, methods, &block
+        end
+    
+        def a4r_before_filter *methods, &block
+          Aspect4r::Helper.process_advice Aspect4r::Model::AdviceMetadata::BEFORE_FILTER, self, methods, &block
+        end
+      end
+    end
+  end
+end

data/lib/aspect4r/classic.rb

@@ -0,0 +1,12 @@
+require 'aspect4r/before'
+require 'aspect4r/after'
+require 'aspect4r/around'
+
+module Aspect4r
+  module Classic
+    def self.included(base)
+      base.send(:include, Base::InstanceMethods)
+      base.extend Base::ClassMethods, Before::Classic::ClassMethods, After::Classic::ClassMethods, Around::Classic::ClassMethods
+    end
+  end
+end

data/lib/aspect4r/errors.rb

@@ -0,0 +1,5 @@
+module Aspect4r
+  class Error < StandardError
+    
+  end
+end

data/lib/aspect4r/extensions/class_extension.rb

@@ -0,0 +1,20 @@
+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
+    
+    # @a4r_data.each do |key, value|
+    #   a4r_data[key] = (value.clone rescue value)
+    # end
+    
+    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

data/lib/aspect4r/extensions/module_extension.rb

@@ -0,0 +1,30 @@
+class Module
+  def included_with_a4r(base)
+    included_without_a4r(child) if respond_to?(:included_without_a4r)
+    
+    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(child) if respond_to?(:method_added_without_a4r)
+    
+    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]
+      method_advices.wrapped_method = instance_method(method)
+      Aspect4r::Helper.create_method self, method
+    end
+  end
+  
+  alias method_added_without_a4r method_added
+  alias method_added             method_added_with_a4r
+end