RubyGems - aspector - Versions diffs - 0.13.1 → 0.14.0 - Mend

aspector 0.13.1 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (102) hide show

checksums.yaml +7 -0
data/.gitignore +14 -0
data/.rubocop.yml +26 -0
data/.ruby-gemset +1 -0
data/.ruby-version +1 -0
data/.travis.yml +8 -11
data/Changelog.md +59 -0
data/Gemfile +9 -14
data/Gemfile.lock +84 -50
data/README.md +118 -0
data/Rakefile +6 -22
data/aspector.gemspec +15 -127
data/benchmarks/after_benchmark.rb +28 -0
data/benchmarks/around_advice_benchmark.rb +35 -0
data/benchmarks/around_benchmark.rb +32 -0
data/benchmarks/before_benchmark.rb +28 -0
data/benchmarks/benchmark_helper.rb +17 -0
data/benchmarks/combined_benchmark.rb +36 -0
data/benchmarks/method_invocation_benchmark.rb +30 -0
data/benchmarks/raw_benchmark.rb +39 -0
data/examples/activerecord_hooks.rb +10 -15
data/examples/around_example.rb +20 -31
data/examples/aspector_apply_example.rb +10 -17
data/examples/aspector_example.rb +7 -16
data/examples/cache_aspect.rb +20 -30
data/examples/design_by_contract.rb +20 -44
data/examples/exception_handler.rb +12 -20
data/examples/exception_handler2.rb +16 -24
data/examples/implicit_method_option_test.rb +8 -16
data/examples/interception_options_example.rb +71 -0
data/examples/logging_aspect.rb +16 -24
data/examples/process_aspector.rb +13 -0
data/examples/retry_aspect.rb +20 -20
data/lib/aspector.rb +17 -15
data/lib/aspector/advice.rb +44 -57
data/lib/aspector/advice_metadata.rb +10 -11
data/lib/aspector/aspect_instances.rb +2 -3
data/lib/aspector/base.rb +6 -368
data/lib/aspector/base_class_methods.rb +24 -55
data/lib/aspector/deferred_logic.rb +3 -4
data/lib/aspector/deferred_option.rb +5 -10
data/lib/aspector/interception.rb +356 -0
data/lib/aspector/logger.rb +18 -45
data/lib/aspector/logging.rb +10 -29
data/lib/aspector/method_matcher.rb +5 -6
data/lib/aspector/object_extension.rb +4 -12
data/lib/aspector/version.rb +3 -0
data/spec/examples_spec.rb +59 -0
data/spec/functionals/aspect_for_multiple_targets_spec.rb +54 -0
data/spec/functionals/aspect_interception_options_accessing_spec.rb +112 -0
data/spec/functionals/aspect_on_a_class_spec.rb +159 -0
data/spec/functionals/aspect_on_an_instance_spec.rb +66 -0
data/spec/functionals/aspector_spec.rb +138 -0
data/spec/functionals/aspects_combined_spec.rb +37 -0
data/spec/functionals/aspects_execution_order_spec.rb +61 -0
data/spec/functionals/aspects_on_private_methods_spec.rb +82 -0
data/spec/spec_helper.rb +20 -21
data/spec/support/class_builder.rb +44 -0
data/spec/units/advice_spec.rb +49 -0
data/spec/units/advices/after_spec.rb +328 -0
data/spec/units/advices/around_spec.rb +336 -0
data/spec/units/advices/before_filter_spec.rb +287 -0
data/spec/units/advices/before_spec.rb +237 -0
data/spec/units/advices/raw_spec.rb +67 -0
data/spec/units/base_class_methods_spec.rb +262 -0
data/spec/units/base_spec.rb +133 -0
data/spec/units/deferred_logic_spec.rb +35 -0
data/spec/units/logger_spec.rb +20 -0
data/spec/units/logging_spec.rb +85 -0
data/spec/units/method_matcher_spec.rb +95 -0
data/spec/units/object_extension_spec.rb +11 -0
data/spec/units/special_chars_spec.rb +128 -0
metadata +98 -246
data/.document +0 -5
data/.rvmrc +0 -8
data/README.rdoc +0 -80
data/VERSION +0 -1
data/performance-tests/after_test.rb +0 -25
data/performance-tests/around_advice_benchmark.rb +0 -66
data/performance-tests/around_test.rb +0 -27
data/performance-tests/before_test.rb +0 -25
data/performance-tests/combined_test.rb +0 -33
data/performance-tests/method_invocation_test.rb +0 -25
data/performance-tests/raw_test.rb +0 -37
data/performance-tests/test_helper.rb +0 -9
data/run_all_examples.sh +0 -12
data/spec/functional/advices_on_private_methods_spec.rb +0 -21
data/spec/functional/aspect_on_eigen_class_spec.rb +0 -72
data/spec/functional/aspect_on_object_spec.rb +0 -20
data/spec/functional/aspector_spec.rb +0 -140
data/spec/functional/aspects_combined_spec.rb +0 -48
data/spec/functional/execution_order_spec.rb +0 -42
data/spec/unit/advice_spec.rb +0 -4
data/spec/unit/after_spec.rb +0 -88
data/spec/unit/around_spec.rb +0 -76
data/spec/unit/base_class_methods_spec.rb +0 -28
data/spec/unit/base_spec.rb +0 -112
data/spec/unit/before_spec.rb +0 -125
data/spec/unit/deferred_logic_spec.rb +0 -23
data/spec/unit/method_matcher_spec.rb +0 -43
data/spec/unit/raw_spec.rb +0 -53
data/spec/unit/special_chars_spec.rb +0 -122

data/spec/units/advices/before_filter_spec.rb ADDED

@@ -0,0 +1,287 @@
+require 'spec_helper'
+RSpec.describe 'Before filter advices' do
+  subject { klass.new }
+  context 'standard cases' do
+    before do
+      aspector(klass) do
+        before_filter :exec, :before_exec
+      end
+    end
+    context 'when code returns false' do
+      let(:klass) do
+        ClassBuilder.build do
+          def before_exec
+            values << 'before_exec'
+            false
+          end
+        end
+      end
+      it 'should execute before_exec' do
+        expect(subject)
+          .to receive(:before_exec)
+          .once
+        subject.exec
+      end
+      it 'should not execute original code' do
+        subject.exec
+        expect(subject.values).to eq %w( before_exec )
+      end
+    end
+    context 'when code returns nil' do
+      let(:klass) do
+        ClassBuilder.build do
+          def before_exec
+            values << 'before_exec'
+            nil
+          end
+        end
+      end
+      it 'should execute before_exec' do
+        expect(subject)
+          .to receive(:before_exec)
+          .once
+        subject.exec
+      end
+      it 'should not execute original code' do
+        subject.exec
+        expect(subject.values).to eq %w( before_exec )
+      end
+    end
+    context 'when code doesnt return false or nil' do
+      let(:klass) do
+        ClassBuilder.build do
+          def before_exec
+            values << 'before_exec'
+          end
+        end
+      end
+      it 'should execute before_exec' do
+        expect(subject)
+          .to receive(:before_exec)
+          .once
+        subject.exec
+      end
+      it 'should work' do
+        subject.exec
+        expect(subject.values).to eq %w( before_exec exec-result )
+      end
+    end
+  end
+  context 'logic in string' do
+    let(:klass) { ClassBuilder.build }
+    before do
+      aspector(klass) do
+        before_filter :exec, <<-CODE
+          values << 'before-exec'
+        CODE
+      end
+    end
+    it 'should work' do
+      subject.exec
+      expect(subject.values).to eq %w( before-exec exec-result )
+    end
+  end
+  context 'logic in block' do
+    let(:klass) { ClassBuilder.build }
+    before do
+      aspector(klass) do
+        before_filter :exec do
+          values << 'before-exec'
+        end
+      end
+    end
+    it 'should work' do
+      subject.exec
+      expect(subject.values).to eq %w( before-exec exec-result )
+    end
+  end
+  context 'when we want to use method that is defined after aspector binding' do
+    let(:klass) do
+      ClassBuilder.build do
+        aspector do
+          before_filter :exec, :before_exec
+        end
+        def before_exec
+          values << 'before-exec'
+        end
+      end
+    end
+    it 'should be able to use it' do
+      subject.exec
+      expect(subject.values).to eq %w( before-exec exec-result )
+    end
+  end
+  context 'method with method_arg' do
+    let(:klass) do
+      ClassBuilder.build do
+        def before_exec(method)
+          values << "before_exec(#{method})"
+        end
+      end
+    end
+    before do
+      aspector(klass) do
+        before_filter :exec, :before_exec, method_arg: true
+      end
+    end
+    it 'should execute before_exec with method args' do
+      expect(subject)
+        .to receive(:before_exec)
+        .with('exec')
+        .once
+      subject.exec
+    end
+    it 'should work' do
+      subject.exec
+      expect(subject.values).to eq %w( before_exec(exec) exec-result )
+    end
+  end
+  describe 'implicit method option' do
+    context 'when we want to bind to a single method' do
+      let(:klass) do
+        ClassBuilder.build do
+          def before_method
+            values << 'before-method'
+          end
+        end
+      end
+      before do
+        aspector klass, method: %i( exec ) do
+          before_filter :before_method
+        end
+      end
+      it 'should work' do
+        subject.exec
+        expect(subject.values).to eq %w( before-method exec-result )
+      end
+    end
+    context 'when we want to bind to multiple methods' do
+      let(:klass) do
+        ClassBuilder.build do
+          def before_method
+            values << 'before-method'
+          end
+          def exec_new
+            values << 'exec-new'
+          end
+        end
+      end
+      before do
+        aspector klass, methods: %i( exec exec_new ) do
+          before_filter :before_method
+        end
+      end
+      it 'should work for method 1' do
+        subject.exec
+        expect(subject.values).to eq %w( before-method exec-result )
+      end
+      it 'should work for method 2' do
+        subject.exec_new
+        expect(subject.values).to eq %w( before-method exec-new )
+      end
+    end
+  end
+  context 'disabling aspect' do
+    let(:klass) do
+      ClassBuilder.build do
+        def before_exec
+          values << 'before-exec'
+        end
+      end
+    end
+    let(:aspect) do
+      aspector(klass) do
+        before_filter :exec, :before_exec
+      end
+    end
+    before do
+      aspect.disable
+    end
+    context 'when we define an aspect and we disable it' do
+      it 'should not work' do
+        subject.exec
+        expect(subject.values).to eq %w( exec-result )
+      end
+    end
+    context 'and we enable it back' do
+      it 'should not work' do
+        subject.exec
+        expect(subject.values).to eq %w( exec-result )
+        aspect.enable
+        subject.exec
+        expect(subject.values).to eq %w( exec-result before-exec exec-result )
+      end
+    end
+  end
+  context 'all methods except' do
+    let(:klass) do
+      ClassBuilder.build do
+        def before_exec
+          values << 'before-exec'
+        end
+        def except_exec
+          values << 'except-exec'
+        end
+      end
+    end
+    before do
+      aspector(klass) do
+        before_filter(/^ex.*/, :before_exec, except: :except_exec)
+      end
+    end
+    it 'should work with exec' do
+      subject.exec
+      expect(subject.values).to eq %w( before-exec exec-result )
+    end
+    it 'should not work with except_exec' do
+      subject.except_exec
+      expect(subject.values).to eq %w( except-exec )
+    end
+  end
+end

data/spec/units/advices/before_spec.rb ADDED

@@ -0,0 +1,237 @@
+require 'spec_helper'
+RSpec.describe 'Before advices' do
+  subject { klass.new }
+  context 'standard case' do
+    let(:klass) do
+      ClassBuilder.build do
+        def before_exec
+          values << 'before_exec'
+        end
+      end
+    end
+    before do
+      aspector(klass) do
+        before :exec, :before_exec
+      end
+    end
+    it 'should execute before_exec' do
+      expect(subject)
+        .to receive(:before_exec)
+        .once
+      subject.exec
+    end
+    it 'should work' do
+      subject.exec
+      expect(subject.values).to eq %w( before_exec exec-result )
+    end
+  end
+  context 'logic in string' do
+    let(:klass) { ClassBuilder.build }
+    before do
+      aspector(klass) do
+        before :exec, <<-CODE
+          values << 'before-exec'
+        CODE
+      end
+    end
+    it 'should work' do
+      subject.exec
+      expect(subject.values).to eq %w( before-exec exec-result )
+    end
+  end
+  context 'logic in block' do
+    let(:klass) { ClassBuilder.build }
+    before do
+      aspector(klass) do
+        before :exec do
+          values << 'before-exec'
+        end
+      end
+    end
+    it 'should work' do
+      subject.exec
+      expect(subject.values).to eq %w( before-exec exec-result )
+    end
+  end
+  context 'when we want to use method that is defined after aspector binding' do
+    let(:klass) do
+      ClassBuilder.build do
+        aspector do
+          before :exec, :before_exec
+        end
+        def before_exec
+          values << 'before-exec'
+        end
+      end
+    end
+    it 'should be able to use it' do
+      subject.exec
+      expect(subject.values).to eq %w( before-exec exec-result )
+    end
+  end
+  context 'method with method_arg' do
+    let(:klass) do
+      ClassBuilder.build do
+        def before_exec(method)
+          values << "before_exec(#{method})"
+        end
+      end
+    end
+    before do
+      aspector(klass) do
+        before :exec, :before_exec, method_arg: true
+      end
+    end
+    it 'should execute before_exec with method args' do
+      expect(subject)
+        .to receive(:before_exec)
+        .with('exec')
+        .once
+      subject.exec
+    end
+    it 'should work' do
+      subject.exec
+      expect(subject.values).to eq %w( before_exec(exec) exec-result )
+    end
+  end
+  describe 'implicit method option' do
+    context 'when we want to bind to a single method' do
+      let(:klass) do
+        ClassBuilder.build do
+          def before_method
+            values << 'before-method'
+          end
+        end
+      end
+      before do
+        aspector klass, method: %i( exec ) do
+          before :before_method
+        end
+      end
+      it 'should work' do
+        subject.exec
+        expect(subject.values).to eq %w( before-method exec-result )
+      end
+    end
+    context 'when we want to bind to multiple methods' do
+      let(:klass) do
+        ClassBuilder.build do
+          def before_method
+            values << 'before-method'
+          end
+          def exec_new
+            values << 'exec-new'
+          end
+        end
+      end
+      before do
+        aspector klass, methods: %i( exec exec_new ) do
+          before :before_method
+        end
+      end
+      it 'should work for method 1' do
+        subject.exec
+        expect(subject.values).to eq %w( before-method exec-result )
+      end
+      it 'should work for method 2' do
+        subject.exec_new
+        expect(subject.values).to eq %w( before-method exec-new )
+      end
+    end
+  end
+  context 'disabling aspect' do
+    let(:klass) do
+      ClassBuilder.build do
+        def before_exec
+          values << 'before-exec'
+        end
+      end
+    end
+    let(:aspect) do
+      aspector(klass) do
+        before :exec, :before_exec
+      end
+    end
+    before do
+      aspect.disable
+    end
+    context 'when we define an aspect and we disable it' do
+      it 'should not work' do
+        subject.exec
+        expect(subject.values).to eq %w( exec-result )
+      end
+    end
+    context 'and we enable it back' do
+      it 'should not work' do
+        subject.exec
+        expect(subject.values).to eq %w( exec-result )
+        aspect.enable
+        subject.exec
+        expect(subject.values).to eq %w( exec-result before-exec exec-result )
+      end
+    end
+  end
+  context 'all methods except' do
+    let(:klass) do
+      ClassBuilder.build do
+        def before_exec
+          values << 'before-exec'
+        end
+        def except_exec
+          values << 'except-exec'
+        end
+      end
+    end
+    before do
+      aspector(klass) do
+        before(/^ex.*/, :before_exec, except: :except_exec)
+      end
+    end
+    it 'should work with exec' do
+      subject.exec
+      expect(subject.values).to eq %w( before-exec exec-result )
+    end
+    it 'should not work with except_exec' do
+      subject.except_exec
+      expect(subject.values).to eq %w( except-exec )
+    end
+  end
+end