after_do-loader 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc03471141f4bf6a67f011746a49f8bc5c938f81
-  data.tar.gz: 7934725beb90a64261ae6ec595c8384a230014d1
+  metadata.gz: 8886a319c67b5a858d2f29df695a1de315542452
+  data.tar.gz: 4e860cf562ecb03f436ba361d146a86235bc0d66
 SHA512:
-  metadata.gz: 70edc0bd393849c1cbe7e2a03f235c5f24aad4808334ed14d87fd4f890c16f4f3543b7e1efabce1763dbe1284c25b2526862d7d6530875637f5ad03a1f656a25
-  data.tar.gz: 442c50496680bdf0c58f5f339e11f8535ce5cd16c9c88a188957e61031d946ca2189d2df5f9d0ed02680f52d4906b8d012da12393a3355e4328d32be56abb5dc
+  metadata.gz: 9ca6f8c29186ef6c7705d515d1a7e23dc87be195ff9ae37cb26ccf0db5cc36bb062d44bb5056a511730dc81b4e9c9c1de6423bcc408778d2d5dd6c3c0838181f
+  data.tar.gz: f6015716c4c9481f06f0e638a82334c5d17d0a80b12e1b83dbeabcf234286ffd6989aa7deed5a74680d5fc0bdaf9a831459cecafdd11338d0e49d1d871e0b632

data/README.md

@@ -26,7 +26,7 @@ In order to use this gem, you need to add a `aspects.yml` file to your
 application. This file must define the classes that will implement the callbacks
 used by `after_do`'s methods.
 
-Example:
+### Example:
 
 Suppose I want to log every method call to `AdvisedClass#initialize`, before and
 after it's invocation. What will be logged is defined in the

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/after_do-loader.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ['Renan Ranelli', 'Rafael Almeida']
   spec.email = ['renanranelli@gmail.com', 'rubygems@rafaelalmeida.net']
   spec.summary = 'Apply after_do methods dynamically based on a config file.'
-  spec.description = 'Apply after_do methods dynamically based on a config file.'
+  spec.description = 'Apply after_do methods dynamically based on a config file'
   spec.homepage = ''
   spec.license = 'MIT'
 

data/lib/after_do/loader.rb

@@ -3,10 +3,18 @@ require 'recursive_open_struct'
 
 require_relative 'loader/version'
 
-require_relative 'loader/aspect_loader'
+require_relative 'loader/aspect_applier'
 require_relative 'loader/config'
+require_relative 'loader/errors'
 
 module AfterDo
   module Loader
+    def self.load(config_path)
+      config = Config.new(config_path)
+
+      config.aspects.each do |aspect|
+        AspectApplier.new(aspect).apply
+      end
+    end
   end
 end

data/lib/after_do/loader/aspect_applier.rb

@@ -0,0 +1,35 @@
+module AfterDo
+  module Loader
+    class AspectApplier
+      def initialize(aspect)
+        @aspect = aspect
+      end
+
+      def apply
+        aspect.advices.each do |advice|
+          advice.targets.each do |target|
+            target.klass.extend(AfterDo)
+
+            methods = target.target_methods
+
+            apply_aspect_to_target(aspect.klass, advice, target.klass, methods)
+          end
+        end
+      rescue
+        raise Errors::CannotApplyAspect
+      end
+
+      protected
+
+      attr_reader :aspect
+
+      def apply_aspect_to_target(aspect_klass, advice, target, methods)
+        methods.each do |method|
+          advice.names.each do |advice_name|
+            aspect_klass.new(target).send(advice_name, method)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/after_do/loader/config.rb

@@ -17,6 +17,8 @@ module AfterDo
         config = constantize_classes!(config_hash)
 
         RecursiveOpenStruct.new(config, recurse_over_arrays: true)
+      rescue
+        raise Errors::InvalidConfig
       end
 
       def constantize_classes!(config_hash)

data/lib/after_do/loader/errors.rb

@@ -0,0 +1,9 @@
+require_relative 'errors/invalid_config'
+require_relative 'errors/cannot_apply_aspect'
+
+module AfterDo
+  module Loader
+    module Errors
+    end
+  end
+end

data/lib/after_do/loader/errors/cannot_apply_aspect.rb

@@ -0,0 +1,11 @@
+module AfterDo
+  module Loader
+    module Errors
+      class CannotApplyAspect < StandardError
+        def initialize
+          super('Cannot apply aspect. Check your config file.')
+        end
+      end
+    end
+  end
+end

data/lib/after_do/loader/errors/invalid_config.rb

@@ -0,0 +1,11 @@
+module AfterDo
+  module Loader
+    module Errors
+      class InvalidConfig < StandardError
+        def initialize
+          super('Invalid config error')
+        end
+      end
+    end
+  end
+end

data/lib/after_do/loader/version.rb

@@ -1,5 +1,5 @@
 module AfterDo
   module Loader
-    VERSION = '0.0.1'
+    VERSION = '0.1'
   end
 end

data/spec/after_do/loader/aspect_applier_spec.rb

@@ -0,0 +1,55 @@
+module AfterDo
+  module Loader
+    class AdvisedClass; end
+    class CoolAspect; end
+
+    describe AspectApplier do
+      subject(:applier) { described_class.new(aspect_config) }
+
+      let(:aspect_config) { config.aspects.first }
+      let(:config) do
+        Config.new(fixture_path('aspect_config.yml'))
+      end
+
+      let(:aspect_instance) { CoolAspect.new }
+      let(:aspect_class) { CoolAspect }
+      let(:target_class) { AdvisedClass }
+
+      describe '#apply' do
+        subject(:apply) { applier.apply }
+
+        before do
+          allow(aspect_class).to receive(:new).and_return(aspect_instance)
+          allow(aspect_instance).to receive(:add_callback)
+        end
+
+        it 'extends the target class with the AfterDo library' do
+          expect(target_class).to receive(:extend).with(AfterDo)
+
+          apply
+        end
+
+        it 'creates an Aspect object of the correct class' do
+          expect(aspect_class).to receive(:new).with(target_class)
+
+          apply
+        end
+
+        it 'applies the right advice to the target class' do
+          expect(aspect_instance).to receive(:add_callback).with('initialize')
+          expect(aspect_instance).to receive(:add_callback).with('merge')
+
+          apply
+        end
+
+        context 'when applying goes wrong' do
+          before do
+            allow(aspect_config).to receive(:advices).and_raise(StandardError)
+          end
+
+          it { expect { apply }.to raise_error(Errors::CannotApplyAspect) }
+        end
+      end
+    end
+  end
+end

data/spec/after_do/loader/config_spec.rb

@@ -1,36 +1,47 @@
-module AfterDo::Loader
-  class AdvisedClass; end
-  class CoolAspect; end
+module AfterDo
+  module Loader
+    class AdvisedClass; end
+    class CoolAspect; end
 
-  describe Config do
-    subject(:config) { Config.new(fixture_path('aspect_config.yml')) }
+    describe Config do
+      subject(:config) { Config.new(config_path) }
 
-    let(:config_hash) do
-      {
-        'aspects' => [
-          {
-            'name' => 'CoolAspect',
-            'klass' => AfterDo::Loader::CoolAspect,
-            'description' => 'This aspect adds after_do callbacks to its target classes',
-            'advices' => [
-              {
-                'names' => %w(add_callback),
-                'targets' => [
-                  {
-                    'klass' => AfterDo::Loader::AdvisedClass,
-                    'target_methods' => %w(initialize merge)
-                  }
-                ]
-              }
-            ]
-          }
-        ]
-      }
-    end
-    let(:config_os) do
-      RecursiveOpenStruct.new(config_hash, recurse_over_arrays: true)
-    end
+      let(:config_path) { fixture_path('aspect_config.yml') }
+
+      let(:config_hash) do
+        {
+          'aspects' => [
+            {
+              'name' => 'CoolAspect',
+              'klass' => AfterDo::Loader::CoolAspect,
+              'description' => "This aspect adds after_do callbacks to its \
+target classes",
+              'advices' => [
+                {
+                  'names' => %w(add_callback),
+                  'targets' => [
+                    {
+                      'klass' => AfterDo::Loader::AdvisedClass,
+                      'target_methods' => %w(initialize merge)
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      end
+      let(:config_os) do
+        RecursiveOpenStruct.new(config_hash, recurse_over_arrays: true)
+      end
 
-    it { expect(config.aspects).to eq(config_os.aspects) }
+      it { expect(config.aspects).to eq(config_os.aspects) }
+
+      context 'when parsing goes wrong' do
+        let(:config_path) { fixture_path('bad_aspect_config.yml') }
+
+        it { expect { config }.to raise_error(Errors::InvalidConfig) }
+      end
+    end
   end
 end

data/spec/after_do/loader_spec.rb

@@ -0,0 +1,35 @@
+module AfterDo
+  module Loader
+    describe AfterDo::Loader do
+      subject(:loader) { described_class }
+
+      let(:config_path) { '/i/am/a/fake/path/' }
+      let(:config) { double(Config, aspects: [aspect]) }
+      let(:aspect) { double(:aspect) }
+
+      let(:applier) { instance_double(AspectApplier, apply: nil) }
+
+      describe '.load' do
+        subject(:load) { loader.load(config_path) }
+
+        before do
+          allow(Config).to receive(:new).and_return(config)
+          allow(AspectApplier).to receive(:new).and_return(applier)
+        end
+
+        it 'loads config with the right path' do
+          expect(Config).to receive(:new).with(config_path)
+
+          load
+        end
+
+        it 'applies stuff' do
+          expect(AspectApplier).to receive(:new).with(aspect)
+          expect(applier).to receive(:apply)
+
+          load
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: after_do-loader
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Renan Ranelli
@@ -137,7 +137,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Apply after_do methods dynamically based on a config file.
+description: Apply after_do methods dynamically based on a config file
 email:
 - renanranelli@gmail.com
 - rubygems@rafaelalmeida.net
@@ -152,13 +152,18 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
 - after_do-loader.gemspec
 - lib/after_do/loader.rb
-- lib/after_do/loader/aspect_loader.rb
+- lib/after_do/loader/aspect_applier.rb
 - lib/after_do/loader/config.rb
+- lib/after_do/loader/errors.rb
+- lib/after_do/loader/errors/cannot_apply_aspect.rb
+- lib/after_do/loader/errors/invalid_config.rb
 - lib/after_do/loader/version.rb
-- spec/after_do/loader/aspect_loader_spec.rb
+- spec/after_do/loader/aspect_applier_spec.rb
 - spec/after_do/loader/config_spec.rb
+- spec/after_do/loader_spec.rb
 - spec/fixtures/aspect_config.yml
 - spec/spec_helper.rb
 homepage: ''
@@ -186,7 +191,9 @@ signing_key:
 specification_version: 4
 summary: Apply after_do methods dynamically based on a config file.
 test_files:
-- spec/after_do/loader/aspect_loader_spec.rb
+- spec/after_do/loader/aspect_applier_spec.rb
 - spec/after_do/loader/config_spec.rb
+- spec/after_do/loader_spec.rb
 - spec/fixtures/aspect_config.yml
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/after_do/loader/aspect_loader.rb

@@ -1,42 +0,0 @@
-module AfterDo
-  module Loader
-    class AspectLoader
-      def initialize(config)
-        @config = config
-      end
-
-      def load
-        config.aspects.each do |aspect|
-          apply_advices(aspect.klass, aspect.advices)
-        end
-      rescue => e
-        raise e, "Could not apply advices. Check you .yml file\
- for ill formatting. \n" + e.message
-      end
-
-      protected
-
-      attr_reader :config
-
-      def apply_advices(aspect, advices)
-        advices.each do |advice|
-          advice.targets.each do |target|
-            target.klass.extend(AfterDo)
-
-            methods = target.target_methods
-
-            apply_aspect_to_target(aspect, advice, target.klass, methods)
-          end
-        end
-      end
-
-      def apply_aspect_to_target(aspect, advice, target, methods)
-        methods.each do |method|
-          advice.names.each do |advice_name|
-            aspect.new(target).send(advice_name, method)
-          end
-        end
-      end
-    end
-  end
-end

data/spec/after_do/loader/aspect_loader_spec.rb

@@ -1,44 +0,0 @@
-module AfterDo::Loader
-  class AdvisedClass; end
-  class CoolAspect; end
-
-  describe AspectLoader do
-    subject(:loader) { described_class.new(config) }
-
-    let(:config) do
-      Config.new(fixture_path('aspect_config.yml'))
-    end
-
-    let(:aspect) { CoolAspect.new }
-    let(:aspect_class) { CoolAspect }
-    let(:target_class) { AdvisedClass }
-
-    describe '#load' do
-      subject(:load) { loader.load }
-
-      before do
-        allow(aspect_class).to receive(:new).and_return(aspect)
-        allow(aspect).to receive(:add_callback)
-      end
-
-      it 'extends the target class with the AfterDo library' do
-        expect(target_class).to receive(:extend).with(AfterDo)
-
-        load
-      end
-
-      it 'creates an Aspect object of the correct class' do
-        expect(aspect_class).to receive(:new).with(target_class)
-
-        load
-      end
-
-      it 'applies the right advice to the target class' do
-        expect(aspect).to receive(:add_callback).with('initialize').once
-        expect(aspect).to receive(:add_callback).with('merge').once
-
-        load
-      end
-    end
-  end
-end