aspector 0.5.0

data/.document

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

data/.irbrc

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'aspector'

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,3 @@
+rvm_gemset_create_on_use_flag=1
+
+rvm use 1.8.7@aspector

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "mocha", "~> 0.10.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "reek", "~> 1.2.8"
+  gem "roodi", "~> 2.1.0"
+
+  gem "guard", "~> 0.8.4"
+  gem "guard-bundler", "~> 0.1.3"
+  gem "guard-rspec", "~> 0.5.2"
+  gem "guard-shell", "~> 0.1.1"
+  gem 'rb-fsevent', "~> 0.4.3.1"
+  gem 'growl', "~> 1.0.3"
+
+  gem 'awesome_print'
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    awesome_print (0.4.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    growl (1.0.3)
+    guard (0.8.8)
+      thor (~> 0.14.6)
+    guard-bundler (0.1.3)
+      bundler (>= 1.0.0)
+      guard (>= 0.2.2)
+    guard-rspec (0.5.2)
+      guard (>= 0.8.4)
+    guard-shell (0.1.1)
+      guard (>= 0.2.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    metaclass (0.0.1)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    rake (0.9.2.2)
+    rb-fsevent (0.4.3.1)
+    rcov (0.9.11)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby2ruby (1.3.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.7)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.0.0)
+  growl (~> 1.0.3)
+  guard (~> 0.8.4)
+  guard-bundler (~> 0.1.3)
+  guard-rspec (~> 0.5.2)
+  guard-shell (~> 0.1.1)
+  jeweler (~> 1.6.4)
+  mocha (~> 0.10.0)
+  rb-fsevent (~> 0.4.3.1)
+  rcov
+  reek (~> 1.2.8)
+  roodi (~> 2.1.0)
+  rspec (~> 2.3.0)

data/Guardfile

@@ -0,0 +1,13 @@
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+#guard 'shell' do
+#  watch(%r{^(lib|spec)/.+\.rb$}) { `rspec spec` }
+#end
+
+guard 'rspec', :notification => false do
+  watch(%r{^(lib|spec)/.+\.rb$}) { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 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/README.rdoc

@@ -0,0 +1,66 @@
+= aspector
+
+aspector = ASPECT Oriented Ruby programming
+
+== Highlights
+
+* Encapsulate logic as aspects and apply to multiple targets easily
+* Support before/before_filter/after/around advices
+* Work anywhere - inside/outside the target class, before/after methods are created
+* Small codebase, intuitive API
+
+== Installation
+
+gem install aspector
+
+== Examples
+
+  require 'aspector'
+
+  class A
+    def test
+      puts 'test'
+    end
+  end
+
+  ##############################
+
+  TestAspect = Aspector do
+    target "
+      def do_this
+        puts 'do_this'
+      end
+    "
+
+    before :test, :do_this
+    before :test do
+      puts 'do_that'
+    end
+  end
+
+  TestAspect.apply(A)
+
+  ##############################
+
+  A.new.test
+
+  # Expected output:
+  # do_this
+  # do_that
+  # test
+
+== Contributing to aspector
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Guoliang Cao. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "aspector"
+  gem.homepage = "http://github.com/gcao/aspector"
+  gem.license = "MIT"
+  gem.summary = %Q{Aspect Oriented Ruby Programming}
+  gem.description = %Q{}
+  gem.email = "gcao99@gmail.com"
+  gem.authors = ["Guoliang Cao"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "aspector #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/examples/around_example.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'aspector'
+
+class A
+  def test
+    puts 'test'
+  end
+end
+
+##############################
+
+aspector(A) do
+  target "
+    def do_this &block
+      puts 'before'
+      block.call
+      puts 'after'
+    end
+  "
+
+  around :test, :do_this
+  around :test do |&block|
+    puts 'before(block)'
+    block.call
+    puts 'after(block)'
+  end
+end
+
+##############################
+
+A.new.test
+
+# Expected output:
+# before(block)
+# before
+# test
+# after
+# after(block)

data/examples/aspector_apply_example.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'aspector'
+
+class A
+  def test
+    puts 'test'
+  end
+end
+
+##############################
+
+TestAspect = Aspector do
+  target "
+    def do_this
+      puts 'do_this'
+    end
+  "
+
+  before :test, :do_this
+  before :test do
+    puts 'do_that'
+  end
+end
+
+TestAspect.apply(A)
+
+##############################
+
+A.new.test
+
+# Expected output:
+# do_this
+# do_that
+# test

data/examples/aspector_example.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'aspector'
+
+class A
+  def test
+    puts 'test'
+  end
+end
+
+##############################
+
+aspector(A) do
+  target "
+    def do_this
+      puts 'do_this'
+    end
+  "
+
+  before :test, :do_this
+  before :test do
+    puts 'do_that'
+  end
+end
+
+##############################
+
+A.new.test
+
+# Expected output:
+# do_this
+# do_that
+# test

data/lib/aspector/advice.rb

@@ -0,0 +1,76 @@
+module Aspector
+  class Advice
+
+    BEFORE = 1
+    AFTER  = 2
+    AROUND = 3
+
+    attr_reader :type, :method_matcher, :options, :advice_block
+
+    def initialize parent, type, method_matcher, with_method, options = {}, &block
+      @parent         = parent
+      @type           = type
+      @method_matcher = method_matcher
+      @with_method    = with_method
+      @options        = options
+      @advice_block   = block.to_proc if block_given?
+    end
+
+    def with_method
+      @with_method ||= "aspect_#{@parent.hash}_#{@parent.advices.index(self)}"
+    end
+
+    def match? method, context = nil
+      return if method == with_method
+      return unless @method_matcher.match?(method, context)
+
+      return true unless @options[:except]
+
+      @except ||= MethodMatcher.new([@options[:except]].flatten)
+
+      not @except.match?(method)
+    end
+
+    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, &block
+      obj.send with_method, *args, &block
+    end
+
+    def type_name
+      case @type
+      when BEFORE then @options[:skip_if_false] ? "BEFORE_FILTER" : "BEFORE"
+      when AFTER  then "AFTER"
+      when AROUND then "AROUND"
+      else "UNKNOWN?!"
+      end
+    end
+
+    def to_s
+      s = type_name
+      s << " [" << @method_matcher.to_s << "] DO "
+      s << @with_method.to_s
+      s << " WITH OPTIONS "
+      @options.each do |key, value|
+        next if key == :skip_if_false
+        s << key.to_s << ":" << value.to_s << " "
+      end
+      s
+    end
+
+  end
+end

data/lib/aspector/advice_metadata.rb

@@ -0,0 +1,17 @@
+module Aspector
+  class AdviceMetadata
+    attr_reader :advice_type, :default_options, :mandatory_options
+
+    def initialize advice_type, default_options, mandatory_options
+      @advice_type       = advice_type
+      @default_options   = default_options   || {}
+      @mandatory_options = mandatory_options || {}
+    end
+
+    BEFORE        = new Aspector::Advice::BEFORE, nil, :skip_if_false => false
+    BEFORE_FILTER = new Aspector::Advice::BEFORE, nil, :skip_if_false => true
+    AFTER         = new Aspector::Advice::AFTER,  { :result_arg => true }, nil
+    AROUND        = new Aspector::Advice::AROUND, nil, nil
+  end
+end
+

data/lib/aspector/aspect.rb

@@ -0,0 +1,75 @@
+require 'erb'
+
+module Aspector
+  class Aspect
+
+    attr_reader :advices, :options, :deferred_logics
+
+    def initialize options = {}, &block
+      @options = options
+      @advices = []
+      instance_eval &block
+    end
+
+    def apply target, options = {}
+      aspect_instance = AspectInstance.new(target, self, options)
+      aspect_instance.apply
+    end
+
+    def before *methods, &block
+      @advices << create_advice(Aspector::AdviceMetadata::BEFORE, self, methods, &block)
+    end
+
+    def before_filter *methods, &block
+      @advices << create_advice(Aspector::AdviceMetadata::BEFORE_FILTER, self, methods, &block)
+    end
+
+    def after *methods, &block
+      @advices << create_advice(Aspector::AdviceMetadata::AFTER, self, methods, &block)
+    end
+
+    def around *methods, &block
+      @advices << create_advice(Aspector::AdviceMetadata::AROUND, self, methods, &block)
+    end
+
+    def target code
+      logic = DeferredLogic.new(code)
+      @deferred_logics ||= []
+      @deferred_logics << logic
+      logic
+    end
+
+    def to_hash
+      {
+        "type" => self.class.name,
+        "options" => @options,
+        "advices" => @advices.map {|advice| advice.to_s }
+      }
+    end
+
+    private
+
+    def create_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)
+
+      # Convert symbols to strings to avoid inconsistencies
+      methods.size.times do |i|
+        methods[i] = methods[i].to_s if methods[i].is_a? Symbol
+      end
+
+      with_method = methods.pop unless block_given?
+
+      Aspector::Advice.new(self,
+                           meta_data.advice_type,
+                           Aspector::MethodMatcher.new(*methods),
+                           with_method,
+                           options,
+                           &block)
+    end
+  end
+end
+