after_do-loader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc03471141f4bf6a67f011746a49f8bc5c938f81
+  data.tar.gz: 7934725beb90a64261ae6ec595c8384a230014d1
+SHA512:
+  metadata.gz: 70edc0bd393849c1cbe7e2a03f235c5f24aad4808334ed14d87fd4f890c16f4f3543b7e1efabce1763dbe1284c25b2526862d7d6530875637f5ad03a1f656a25
+  data.tar.gz: 442c50496680bdf0c58f5f339e11f8535ce5cd16c9c88a188957e61031d946ca2189d2df5f9d0ed02680f52d4906b8d012da12393a3355e4328d32be56abb5dc

data/.git_hooks.yml

@@ -0,0 +1,7 @@
+---
+pre_commits:
+- GitHooks::PreCommit::TrailingWhitespace
+- GitHooks::PreCommit::PreventDebugger
+- GitHooks::PreCommit::PreventMaster
+- GitHooks::PreCommit::Rubocop
+- GitHooks::PreCommit::Rspec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Documentation:
+  Enabled: false
+
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/Rakefile'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in after_do-loader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 renan-ranelli
+
+MIT License
+
+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.md

@@ -0,0 +1,94 @@
+# AfterDo::Loader
+
+`after_do-loader` is a gem that allows you to apply `after_do`'s callbacks
+dynamically using a `config` file. With this, you do need to add anything to
+your source code, much like aspect oriented programming does.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'after_do-loader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install after_do-loader
+
+## Usage
+
+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:
+
+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
+`LoggingAspect#log_start` and `LoggingAspect#log_finish` methods.
+
+The `aspects.yml` file must look like this:
+
+```yaml
+aspects:
+  - name: Logging
+    klass: LoggingAspect
+    description: This aspects provides basic method logging
+    advices:
+      - names: [log_start, log_finish]
+        targets:
+          - klass: AdvisedClass
+            target_methods:
+              - initialize
+              - merge
+```
+
+And the `LoggingAspect` class will be something like this:
+
+```ruby
+class LoggingAspect
+  def initialize(target_class)
+    @target_class = target_class
+  end
+
+  def log_start(target_method)
+    target_class.before target_method do |*args, advised_class_instance|
+      init_time = Time.now
+      arg_text = args.map(&:inspect).join(', ')
+      method = "#{target_class}##{target_method}"
+
+      msg = "Started: Method=#{method} Time=#{init_time} Args='#{arg_text}'"
+      Rails.logger.info(msg)
+    end
+  end
+
+  def log_finish(target_method)
+    target_class.after target_method do |*args, advised_class_instance|
+      init_time = Time.now
+      arg_text = args.map(&:inspect).join(', ')
+      method = "#{target_class}##{target_method}"
+
+      msg = "Finished: Method=#{method} Time=#{init_time} Args='#{arg_text}'"
+
+      Rails.logger.info(msg)
+    end
+  end
+
+  private
+
+  attr_reader :target_class
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/rranelli/after_do-loader/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/after_do-loader.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'after_do/loader/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'after_do-loader'
+  spec.version = AfterDo::Loader::VERSION
+  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.homepage = ''
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'after_do', '~> 0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'recursive-open-struct'
+  spec.add_development_dependency 'git-hooks', '~> 0.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-doc'
+  spec.add_development_dependency 'method_source'
+end

data/lib/after_do/loader/aspect_loader.rb

@@ -0,0 +1,42 @@
+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/lib/after_do/loader/config.rb

@@ -0,0 +1,37 @@
+require 'delegate'
+
+module AfterDo
+  module Loader
+    class Config < SimpleDelegator
+      def initialize(config_path)
+        @config_path = config_path
+        super(parse_config)
+      end
+
+      protected
+
+      attr_reader :config_path
+
+      def parse_config
+        config_hash = YAML.load_file(config_path)
+        config = constantize_classes!(config_hash)
+
+        RecursiveOpenStruct.new(config, recurse_over_arrays: true)
+      end
+
+      def constantize_classes!(config_hash)
+        config_hash['aspects'].each do |aspect|
+          aspect['klass'] = AfterDo.const_get(aspect['klass'])
+
+          aspect['advices'].each do |advice|
+            advice['targets'].each do |target|
+              target['klass'] = AfterDo.const_get(target['klass'])
+            end
+          end
+        end
+
+        config_hash
+      end
+    end
+  end
+end

data/lib/after_do/loader/version.rb

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

data/lib/after_do/loader.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+require 'recursive_open_struct'
+
+require_relative 'loader/version'
+
+require_relative 'loader/aspect_loader'
+require_relative 'loader/config'
+
+module AfterDo
+  module Loader
+  end
+end

data/spec/after_do/loader/aspect_loader_spec.rb

@@ -0,0 +1,44 @@
+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

data/spec/after_do/loader/config_spec.rb

@@ -0,0 +1,36 @@
+module AfterDo::Loader
+  class AdvisedClass; end
+  class CoolAspect; end
+
+  describe Config do
+    subject(:config) { Config.new(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) }
+  end
+end

data/spec/fixtures/aspect_config.yml

@@ -0,0 +1,11 @@
+aspects:
+  - name: CoolAspect
+    klass: AfterDo::Loader::CoolAspect
+    description: This aspect adds after_do callbacks to its target classes
+    advices:
+      - names: [add_callback]
+        targets:
+          - klass: AfterDo::Loader::AdvisedClass
+            target_methods:
+              - initialize
+              - merge

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'git-hooks'
+GitHooks.validate_hooks!
+
+require_relative '../lib/after_do/loader'
+
+def fixture_path(filename)
+  return '' if filename == ''
+  File.join(File.absolute_path(File.dirname(__FILE__)), 'fixtures', filename)
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: after_do-loader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Renan Ranelli
+- Rafael Almeida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: after_do
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Apply after_do methods dynamically based on a config file.
+email:
+- renanranelli@gmail.com
+- rubygems@rafaelalmeida.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".git_hooks.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- after_do-loader.gemspec
+- lib/after_do/loader.rb
+- lib/after_do/loader/aspect_loader.rb
+- lib/after_do/loader/config.rb
+- lib/after_do/loader/version.rb
+- spec/after_do/loader/aspect_loader_spec.rb
+- spec/after_do/loader/config_spec.rb
+- spec/fixtures/aspect_config.yml
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+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/config_spec.rb
+- spec/fixtures/aspect_config.yml
+- spec/spec_helper.rb