aspector 0.13.1 → 0.14.0

data/aspector.gemspec

@@ -1,132 +1,20 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+require 'aspector/version'
 
 Gem::Specification.new do |s|
-  s.name = %q{aspector}
-  s.version = "0.13.1"
+  s.name = 'aspector'
+  s.version = Aspector::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Guoliang Cao"]
-  s.date = %q{2013-01-23}
-  s.description = %q{}
-  s.email = %q{gcao99@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    ".irbrc",
-    ".rspec",
-    ".rvmrc",
-    ".travis.yml",
-    "Gemfile",
-    "Gemfile.lock",
-    "Guardfile",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "aspector.gemspec",
-    "examples/activerecord_hooks.rb",
-    "examples/around_example.rb",
-    "examples/aspector_apply_example.rb",
-    "examples/aspector_example.rb",
-    "examples/cache_aspect.rb",
-    "examples/design_by_contract.rb",
-    "examples/exception_handler.rb",
-    "examples/exception_handler2.rb",
-    "examples/implicit_method_option_test.rb",
-    "examples/logging_aspect.rb",
-    "examples/retry_aspect.rb",
-    "lib/aspector.rb",
-    "lib/aspector/advice.rb",
-    "lib/aspector/advice_metadata.rb",
-    "lib/aspector/aspect_instances.rb",
-    "lib/aspector/base.rb",
-    "lib/aspector/base_class_methods.rb",
-    "lib/aspector/deferred_logic.rb",
-    "lib/aspector/deferred_option.rb",
-    "lib/aspector/logger.rb",
-    "lib/aspector/logging.rb",
-    "lib/aspector/method_matcher.rb",
-    "lib/aspector/module_extension.rb",
-    "lib/aspector/object_extension.rb",
-    "performance-tests/after_test.rb",
-    "performance-tests/around_advice_benchmark.rb",
-    "performance-tests/around_test.rb",
-    "performance-tests/before_test.rb",
-    "performance-tests/combined_test.rb",
-    "performance-tests/method_invocation_test.rb",
-    "performance-tests/raw_test.rb",
-    "performance-tests/test_helper.rb",
-    "run_all_examples.sh",
-    "spec/functional/advices_on_private_methods_spec.rb",
-    "spec/functional/aspect_on_eigen_class_spec.rb",
-    "spec/functional/aspect_on_object_spec.rb",
-    "spec/functional/aspector_spec.rb",
-    "spec/functional/aspects_combined_spec.rb",
-    "spec/functional/execution_order_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/unit/advice_spec.rb",
-    "spec/unit/after_spec.rb",
-    "spec/unit/around_spec.rb",
-    "spec/unit/base_class_methods_spec.rb",
-    "spec/unit/base_spec.rb",
-    "spec/unit/before_spec.rb",
-    "spec/unit/deferred_logic_spec.rb",
-    "spec/unit/method_matcher_spec.rb",
-    "spec/unit/raw_spec.rb",
-    "spec/unit/special_chars_spec.rb"
-  ]
-  s.homepage = %q{http://github.com/gcao/aspector}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Aspect Oriented Ruby Programming}
+  s.authors     = ['Guoliang Cao', 'Maciej Mensfeld']
+  s.date        = %w( 2015-07-07 )
+  s.email       = ['gcao99@gmail.com', 'maciej@mensfeld.pl']
+  s.summary     = %w( Aspect Oriented Ruby Programming library )
+  s.homepage    = 'http://github.com/gcao/aspector'
+  s.licenses    = %w( MIT )
+  s.description = %w()
+  s.rubygems_version = %w( 1.6.2 )
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_development_dependency(%q<ruby-prof>, [">= 0"])
-      s.add_development_dependency(%q<guard>, ["~> 0.8.4"])
-      s.add_development_dependency(%q<guard-bundler>, ["~> 0.1.3"])
-      s.add_development_dependency(%q<guard-rspec>, ["~> 0.5.2"])
-      s.add_development_dependency(%q<guard-shell>, ["~> 0.1.1"])
-      s.add_development_dependency(%q<rb-fsevent>, [">= 0"])
-      s.add_development_dependency(%q<growl>, ["~> 1.0.3"])
-      s.add_development_dependency(%q<awesome_print>, [">= 0"])
-      s.add_development_dependency(%q<pry>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<ruby-prof>, [">= 0"])
-      s.add_dependency(%q<guard>, ["~> 0.8.4"])
-      s.add_dependency(%q<guard-bundler>, ["~> 0.1.3"])
-      s.add_dependency(%q<guard-rspec>, ["~> 0.5.2"])
-      s.add_dependency(%q<guard-shell>, ["~> 0.1.1"])
-      s.add_dependency(%q<rb-fsevent>, [">= 0"])
-      s.add_dependency(%q<growl>, ["~> 1.0.3"])
-      s.add_dependency(%q<awesome_print>, [">= 0"])
-      s.add_dependency(%q<pry>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<ruby-prof>, [">= 0"])
-    s.add_dependency(%q<guard>, ["~> 0.8.4"])
-    s.add_dependency(%q<guard-bundler>, ["~> 0.1.3"])
-    s.add_dependency(%q<guard-rspec>, ["~> 0.5.2"])
-    s.add_dependency(%q<guard-shell>, ["~> 0.1.1"])
-    s.add_dependency(%q<rb-fsevent>, [">= 0"])
-    s.add_dependency(%q<growl>, ["~> 1.0.3"])
-    s.add_dependency(%q<awesome_print>, [">= 0"])
-    s.add_dependency(%q<pry>, [">= 0"])
-  end
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = %w( lib )
 end
-

data/benchmarks/after_benchmark.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/benchmark_helper')
+
+# Example class that we use with aspector
+class Klass
+  aspector do
+    after :test, :after_test
+  end
+
+  def test_no_aspect; end
+
+  def test; end
+
+  def after_test(_result); end
+end
+
+instance = Klass.new
+
+RubyProf.start
+ITERATIONS.times { instance.test_no_aspect }
+result = RubyProf.stop
+
+print_result(result, 'instance.test_no_aspect')
+
+RubyProf.start
+ITERATIONS.times { instance.test }
+result = RubyProf.stop
+
+print_result(result, 'instance.test')

data/benchmarks/around_advice_benchmark.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/benchmark_helper')
+
+# Class to which we will bind with aspect
+class Klass
+  def test(input)
+    input.upcase!
+  end
+end
+
+# Around aspect for benchmarking
+class AroundAspect < Aspector::Base
+  around :test do |proxy, *args, &block|
+    begin
+      proxy.call(*args, &block)
+    rescue
+      nil
+    end
+  end
+end
+
+AroundAspect.apply(Klass)
+
+instance = Klass.new
+
+RubyProf.start
+ITERATIONS.times { instance.test('good') }
+result = RubyProf.stop
+
+print_result(result, 'Around advice good')
+
+RubyProf.start
+ITERATIONS.times { instance.test(nil) }
+result = RubyProf.stop
+
+print_result(result, 'Around advice bad')

data/benchmarks/around_benchmark.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/benchmark_helper')
+
+# Class to which we will bind with aspect
+class Klass
+  aspector do
+    around :test, :around_test
+  end
+
+  def test_no_aspect; end
+
+  def test; end
+
+  def around_test(proxy, &block)
+    proxy.call(&block)
+  end
+end
+
+AroundAspect.apply(Klass)
+
+instance = Klass.new
+
+RubyProf.start
+ITERATIONS.times { instance.test('good') }
+result = RubyProf.stop
+
+print_result(result, 'Around good')
+
+RubyProf.start
+ITERATIONS.times { instance.test(nil) }
+result = RubyProf.stop
+
+print_result(result, 'Around bad')

data/benchmarks/before_benchmark.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/benchmark_helper')
+
+# Class to which we will bind with aspect
+class Klass
+  aspector do
+    before :test, :before_test
+  end
+
+  def test_no_aspect; end
+
+  def test; end
+
+  def before_test; end
+end
+
+instance = Klass.new
+
+RubyProf.start
+ITERATIONS.times { instance.test_no_aspect }
+result = RubyProf.stop
+
+print_result(result, 'instance.test_no_aspect')
+
+RubyProf.start
+ITERATIONS.times { instance.test }
+result = RubyProf.stop
+
+print_result(result, 'instance.test')

data/benchmarks/benchmark_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'ruby-prof'
+require 'aspector'
+
+# Will print results in the way we want
+def print_result(result, description)
+  printer = RubyProf::FlatPrinter.new(result)
+  print "#{'-' * 50} #{description}\n"
+  printer.print(STDOUT)
+end
+
+ITERATIONS = 20_000
+# We disable GC so it won't mess with our benchmarking
+# Don't do this in production
+GC.disable

data/benchmarks/combined_benchmark.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/benchmark_helper')
+
+# Class to which we will bind with aspect
+class Klass
+  aspector do
+    before :test, :before_test
+    after :test, :after_test
+    around :test, :around_test
+  end
+
+  def test_no_aspect; end
+
+  def test; end
+
+  def before_test; end
+
+  def after_test(_result); end
+
+  def around_test(proxy, &block)
+    proxy.call(&block)
+  end
+end
+
+instance = Klass.new
+
+RubyProf.start
+ITERATIONS.times { instance.test_no_aspect }
+result = RubyProf.stop
+
+print_result(result, 'instance.test_no_aspect')
+
+RubyProf.start
+ITERATIONS.times { instance.test }
+result = RubyProf.stop
+
+print_result(result, 'instance.test')

data/benchmarks/method_invocation_benchmark.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/benchmark_helper')
+
+# Class with method invokation
+class Klass
+  def do_something; end
+
+  def test
+    do_something
+  end
+
+  do_something_method = instance_method(:do_something)
+
+  define_method :test_with_method_object do
+    do_something_method.bind(self).call
+  end
+end
+
+instance = Klass.new
+
+RubyProf.start
+ITERATIONS.times { instance.test }
+result = RubyProf.stop
+
+print_result(result, 'instance.test')
+
+RubyProf.start
+ITERATIONS.times { instance.test_with_method_object }
+result = RubyProf.stop
+
+print_result(result, 'instance.test_with_method_object')

data/benchmarks/raw_benchmark.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/benchmark_helper')
+
+# Class to which we will bind with aspect
+class Klass
+  aspector do
+    raw :test do |method, _aspect|
+      # rubocop:disable Eval
+      eval <<-CODE
+      alias #{method}_without_aspect #{method}
+
+      define_method :#{method} do
+        return #{method}_without_aspect if aspect.disabled?
+        before_#{method}
+        #{method}_without_aspect
+      end
+      CODE
+    end
+  end
+
+  def test_no_aspect; end
+
+  def test; end
+
+  def before_test; end
+end
+
+instance = Klass.new
+
+RubyProf.start
+ITERATIONS.times { instance.test_no_aspect }
+result = RubyProf.stop
+
+print_result(result, 'instance.test_no_aspect')
+
+RubyProf.start
+ITERATIONS.times { instance.test }
+result = RubyProf.stop
+
+print_result(result, 'instance.test')

data/examples/activerecord_hooks.rb

@@ -1,4 +1,8 @@
-class A
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'aspector'
+
+# Class that fakes the ActiveRecord class
+class ARClass
   def initialize
   end
 
@@ -6,16 +10,9 @@ class A
   end
 end
 
-##############################
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
-require 'aspector'
-
+# Our ActiveRecord hooks aspect
 class ActiveRecordHooks < Aspector::Base
-  logger.level = Aspector::Logging::TRACE
-
-  default :private_methods => true
+  default private_methods: true
 
   before :initialize do
     puts "Before creating #{self.class.name} instance"
@@ -26,9 +23,7 @@ class ActiveRecordHooks < Aspector::Base
   end
 end
 
-##############################
-
-ActiveRecordHooks.apply(A)
+ActiveRecordHooks.apply(ARClass)
 
-a = A.new
-a.save
+ar = ARClass.new
+ar.save

data/examples/around_example.rb

@@ -1,44 +1,33 @@
-class A
-  def test
-    puts 'test 1'
-    yield
-    puts 'test 2'
-  end
-end
-
-##############################
-
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
 require 'aspector'
 
-aspector(A) do
+# Example class to which we will apply our aspects
+class ExampleClass
+  def test(arg)
+    puts "test(#{arg}) 1"
+    yield arg
+    puts "test(#{arg}) 2"
+  end
+end
+
+aspector(ExampleClass) do
   target do
-    def do_this proxy, &block
-      puts 'before'
-      proxy.call &block
-      puts 'after'
+    def do_this(proxy, arg, &block)
+      puts "do_this(#{arg}) 1"
+      proxy.call arg, &block
+      puts "do_this(#{arg}) 2"
     end
   end
 
   around :test, :do_this
 
-  around :test do |proxy, &block|
-    puts 'before(block)'
-    proxy.call &block
-    puts 'after(block)'
+  around :test, name: 'advice2' do |proxy, arg, &block|
+    puts "advice2(#{arg}) 1"
+    proxy.call arg, &block
+    puts "advice2(#{arg}) 2"
   end
 end
 
-##############################
-
-A.new.test do
-  puts 'in block'
+ExampleClass.new.test 'x' do |arg|
+  puts "block(#{arg})"
 end
-
-# Expected output:
-# before
-# before(block)
-# test
-# after(block)
-# after