aop 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 265bbfbbde5fedca853374f381977f960186c174
-  data.tar.gz: 5ba07e066d01dfb9647f8294f29b1508604fe2ea
+  metadata.gz: ab47f56fd5a02a5de555ceb2ace3ffeed0300db0
+  data.tar.gz: 8657d57606125d660e8cbbd544054ddfb7988381
 SHA512:
-  metadata.gz: 4e762bcad98bbbf72d5f867d22bb20e1add43d02a66e0f63f1da21c1804b335b539bee2eea2c2956c0a7900153931285052a4ee21413bc78e620575c0caefb79
-  data.tar.gz: aa177e07c23669b04a02ac5de5e4ca9bedb2dacc7e92dd8124419b63fd5d5924fa0d236fee9dc01471ec32c8a3454e20cb19f59eb1c9e3b8c77cf1cb969092df
+  metadata.gz: fcfc3efd8608afcc4890a712d7b57468ef795b22e4dae6405827105ab95a8c84c1f4c62f0f2c50855a1cbd5508504b263e7d0ca203b571db1661783730e5e06e
+  data.tar.gz: 77bef4440f0080fda36afd8399c5cdebf9502b0aebe9db42c31353e36d051cf7c1b1d7f6bbd704d1143584ea4e749483bb5dd8469fe015e251c4603d9c1e1935

data/Gemfile

@@ -5,4 +5,9 @@ gemspec
 
 group :test do
   gem 'rspec'
+end
+
+group :development do
+  gem "method_profiler"
+  gem "ruby-prof"
 end

data/README.md

@@ -86,6 +86,26 @@ module Analytics
 end
 ```
 
+### Handling missed pointcuts
+
+When pointcut is gone, for example when method or class gets renamed, it is a potential bug, because some code will not be run. This library tackles this problem by failing hard when pointcut can not be found.
+
+Example:
+
+```ruby
+Aop["Admin#sign_in:after"].advice do |target, *args, &blk|
+  # .. do something ..
+end
+```
+
+Then somebody renames `Admin#sign_in` to `Admin#logout`, and when you run the code you will get:
+
+```
+Aop::PointcutNotFound: Unable to find pointcut Admin#sign_in
+    Reason: #<NameError: undefined method `sign_in' for class `Admin'>
+    .. backtrace ..
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/waterlink/aop/fork )

data/benchmarks/before.rb

@@ -0,0 +1,56 @@
+require "aop"
+require "benchmark"
+require "method_profiler"
+
+class Example
+  def normal_add(a, b)
+    a + b
+  end
+
+  def heavy_add(a, b)
+    a + b
+  end
+end
+
+Aop["Example#heavy_add:before"].advice do |example, a, b|
+  # do nothing
+  nil
+end
+
+def benchmark
+  example = Example.new
+
+  Benchmark.bm 30 do |x|
+    x.report 'normal add' do
+      1000000.times do
+        example.normal_add(rand(1000), rand(1000))
+      end
+    end
+
+    x.report 'add with :before' do
+      1000000.times do
+        example.heavy_add(rand(1000), rand(1000))
+      end
+    end
+  end
+end
+
+def profile
+  example = Example.new
+
+  observers = []
+  observers << MethodProfiler.observe(Example)
+  observers << MethodProfiler.observe(Aop)
+  observers << MethodProfiler.observe(Aop::Pointcut)
+  observers << MethodProfiler.observe(Aop::Pointcut::MethodReference)
+  observers << MethodProfiler.observe(Aop::Pointcut::MethodReference::Singleton)
+
+  10000.times do
+    example.heavy_add(rand(1000), rand(1000))
+  end
+
+  observers.each { |o| puts o.report }
+end
+
+benchmark
+profile

data/lib/aop/pointcut.rb

@@ -5,13 +5,32 @@ module Aop
     Pointcut.new(pointcut_spec)
   end
 
+  class PointcutNotFound < StandardError
+    attr_reader :original_error
+
+    def initialize(pointcut_spec, original_error)
+      super("Unable to find pointcut #{pointcut_spec}")
+      @original_error = original_error
+    end
+
+    def to_s
+      "#{super}\n\tReason: #{original_error.inspect}"
+    end
+  end
+
   class Pointcut
     def initialize(spec)
       @spec = spec
 
       @class_spec = spec.scan(/^[^#\.]+/).first || ""
       @class_names = @class_spec.split(",")
-      @classes = @class_names.map { |name| Object.const_get(name) }
+      @classes = @class_names.map do |name|
+        begin
+          Object.const_get(name)
+        rescue NameError => err
+          raise PointcutNotFound.new(spec, err)
+        end
+      end
 
       @method_spec = spec.scan(/[#\.][^,#\.:]+/)
       @methods = @method_spec.map { |m| MethodReference.from(m) }
@@ -92,6 +111,8 @@ module Aop
           alias_method(new_name, name)
           define_method(name, &with)
         end
+      rescue NameError => err
+        raise PointcutNotFound.new(method_spec(target), err)
       end
 
       def call(target, *args, &blk)
@@ -100,15 +121,31 @@ module Aop
 
       private
 
+      def method_spec(target)
+        "#{target_name(target)}#{method_notation}#{@name}"
+      end
+
+      def method_notation
+        "#"
+      end
+
       def alias_target(target)
         target
       end
 
+      def target_name(target)
+        target.name || target.inspect
+      end
+
       def alias_name
-        @_alias_name ||= "__aop_#{SecureRandom.hex(10)}"
+        @_alias_name ||= :"__aop_#{SecureRandom.hex(10)}"
       end
 
       class Singleton < self
+        def method_notation
+          "."
+        end
+
         def alias_target(target)
           class << target; self; end
         end

data/lib/aop/version.rb

@@ -1,3 +1,3 @@
 module Aop
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/spec/aop/advanced_spec.rb

@@ -30,6 +30,74 @@ RSpec.describe "Advanced advices" do
     end
   end
 
+  describe "missed pointcuts" do
+    describe "missed class" do
+      let(:advice) {
+        Aop["NonexistentKlass#helloworld,.greeting:before"].advice do |target, *args, &blk|
+          :do_something
+        end
+      }
+
+      it "fails with proper message" do
+        expect { advice }.to raise_error(
+          Aop::PointcutNotFound,
+          /Unable to find pointcut NonexistentKlass#helloworld,.greeting/
+        )
+      end
+
+      it "declares proper reason" do
+        expect { advice }.to raise_error(
+          Aop::PointcutNotFound,
+          /Reason: #<NameError: (Missing or |)uninitialized constant(:|) NonexistentKlass>/
+        )
+      end
+    end
+
+    describe "missed instance method" do
+      let(:advice) {
+        Aop["BankAccount.transfer,#greeting:before"].advice do |target, *args, &blk|
+          :do_something
+        end
+      }
+
+      it "fails with proper message" do
+        expect { advice }.to raise_error(
+          Aop::PointcutNotFound,
+          /Unable to find pointcut BankAccount#greeting/
+        )
+      end
+
+      it "declares proper reason" do
+        expect { advice }.to raise_error(
+          Aop::PointcutNotFound,
+          /Reason: #<NameError: undefined method [`']greeting' for class [`']BankAccount'>/
+        )
+      end
+    end
+
+    describe "missed class method" do
+      let(:advice) {
+        Aop["BankAccount#transfer,.greeting:before"].advice do |target, *args, &blk|
+          :do_something
+        end
+      }
+
+      it "fails with proper message" do
+        expect { advice }.to raise_error(
+          Aop::PointcutNotFound,
+          /Unable to find pointcut BankAccount.greeting/
+        )
+      end
+
+      it "declares proper reason" do
+        expect { advice }.to raise_error(
+          Aop::PointcutNotFound,
+          /Reason: #<NameError: (undefined method|Unable to find) [`']greeting' for (class|object) ([`']Class'|[`']#<Class:0x[0-9a-f]+>'|BankAccount)>/
+        )
+      end
+    end
+  end
+
   describe "multiple classes, methods and advices" do
     before do
       Aop["BankAccount,CashAccount#transfer,#withdraw,.transfer:before,:after"].advice do |*args, &blk|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Fedorov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,7 @@ files:
 - README.md
 - Rakefile
 - aop.gemspec
+- benchmarks/before.rb
 - lib/aop.rb
 - lib/aop/pointcut.rb
 - lib/aop/version.rb