after_do-logging 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 127b1d540e43144825a3dfff1977b1c5dd25e866
+  data.tar.gz: 7d00f828f88e4e97be6042a08a535cb567dee51a
+SHA512:
+  metadata.gz: e5722d78d4b5a1c17c6ddcc543196519ffcc635d619229b2628f47194ad30204cedca402ca85237335772dc058f128f4b6bdc40d7c6bba9e437ce6b957066614
+  data.tar.gz: 12056a9b8b3dac271c557e02c103eba3c2d1c55b56747956be1358953f0b144392d7cfddca611c8d61000b1f9cb108cf775a3af0b52107397d8fc4c6b50d469b

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,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Documentation:
+  Enabled: false
+
+ClassAndModuleChildren:
+  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-logging.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rafael da Silva Almeida
+
+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,39 @@
+# AfterDo::Logging
+
+After do aspect for logging method start and finish
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'after_do-logging'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install after_do-logging
+
+## Usage
+
+Configure your aspect to use AfterDo::Logging.
+
+### Set your logger
+
+```ruby
+AfterDo::Logging.logger = logger
+```
+
+PS: Is advisable to use [after-do-loader][after_do-loader] to load your aspects.
+
+## Contributing
+
+1. Fork it ( https://github.com/stupied4ever/after_do-logging/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
+
+[after-do-loader]: https://github.com/rranelli/after_do-loader

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/after_do-logging.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'after_do/logging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'after_do-logging'
+  spec.version       = AfterDo::Logging::VERSION
+  spec.authors       = ['Rafael da Silva', 'Renan Ranelli']
+  spec.email         = ['rubygems@rafaelalmeida.net', 'renanranelli@gmail.com']
+  spec.summary       = 'After do aspect for logging method start and finish.'
+  spec.description   = 'After do aspect for logging method start and finish.'
+  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.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'git-hooks', '~> 0.2'
+end

data/lib/after_do/logging/aspect.rb

@@ -0,0 +1,40 @@
+module AfterDo
+  module Logging
+    class Aspect
+      def initialize(target_class, logger = AfterDo::Logging.logger)
+        @target_class = target_class
+        @logger = logger
+      end
+
+      def log_start(target_method)
+        target_class.before target_method do |*args, _|
+          start_time = Time.now
+          method = "#{target_class}##{target_method}"
+
+          log_step(method, start_time, args)
+        end
+      end
+
+      def log_finish(target_method)
+        target_class.after target_method do |*args, _|
+          finish_time = Time.now
+          method = "#{target_class}##{target_method}"
+
+          log_step(method, finish_time, args)
+        end
+      end
+
+      protected
+
+      attr_reader :target_class, :logger
+
+      private
+
+      def log_step(method, time, args)
+        arg_text = args.map(&:inspect).join(', ')
+        msg = "Finished: Method=#{method} Time=#{time} Args='#{arg_text}'"
+        logger.info(msg)
+      end
+    end
+  end
+end

data/lib/after_do/logging/version.rb

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

data/lib/after_do/logging.rb

@@ -0,0 +1,14 @@
+require 'after_do'
+require 'logger'
+require_relative 'logging/version'
+require_relative 'logging/aspect'
+
+module AfterDo
+  module Logging
+    @logger = Logger.new(STDOUT)
+
+    class << self
+      attr_accessor :logger
+    end
+  end
+end

data/spec/after_do/logging/aspect_spec.rb

@@ -0,0 +1,43 @@
+module AfterDo::Logging
+  describe Aspect do
+    subject(:aspect) { described_class.new(klass, logger) }
+
+    let(:klass) { Class.new.extend(AfterDo) }
+    let(:method) { :inspect }
+    let(:logger) { double(:logger, info: nil) }
+
+    describe '#log_start' do
+      subject(:log_start) { aspect.log_start(method) }
+
+      it 'applies the advice before target method invocation' do
+        expect(klass).to receive(:before).with(method)
+
+        log_start
+      end
+
+      it 'calls logger when instance invokes advised method' do
+        expect(logger).to receive(:info)
+
+        log_start
+        klass.new.inspect
+      end
+    end
+
+    describe '#log_finish' do
+      subject(:log_finish) { aspect.log_finish(method) }
+
+      it 'applies the advice after target method invocation' do
+        expect(klass).to receive(:after).with(method)
+
+        log_finish
+      end
+
+      it 'calls logger when instance invokes advised method' do
+        expect(logger).to receive(:info)
+
+        log_finish
+        klass.new.inspect
+      end
+    end
+  end
+end

data/spec/after_do/logging_spec.rb

@@ -0,0 +1,21 @@
+module AfterDo::Logging
+  describe AfterDo::Logging do
+    describe '.logger' do
+      subject(:logger) { described_class.logger }
+
+      it { is_expected.to be_a(Logger) }
+    end
+
+    describe '.logger=(value)' do
+      subject(:update_logger) { described_class.logger = new_logger }
+
+      let(:new_logger) { double(:new_logger) }
+
+      it do
+        expect { update_logger }.to change {
+          AfterDo::Logging.logger
+        }.to(new_logger)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'git-hooks'
+
+GitHooks.validate_hooks!
+
+require_relative '../lib/after_do/logging'

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: after_do-logging
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rafael da Silva
+- Renan Ranelli
+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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: 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'
+description: After do aspect for logging method start and finish.
+email:
+- rubygems@rafaelalmeida.net
+- renanranelli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".git_hooks.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- after_do-logging.gemspec
+- lib/after_do/logging.rb
+- lib/after_do/logging/aspect.rb
+- lib/after_do/logging/version.rb
+- spec/after_do/logging/aspect_spec.rb
+- spec/after_do/logging_spec.rb
+- 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: After do aspect for logging method start and finish.
+test_files:
+- spec/after_do/logging/aspect_spec.rb
+- spec/after_do/logging_spec.rb
+- spec/spec_helper.rb
+has_rdoc: