after_do 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ef93b03d163368d4323b3b457a104fbcbf8dde4
+  data.tar.gz: c3efe779604f230849918900543f1a4a2d68d6f7
+SHA512:
+  metadata.gz: 384930d2ac61d25b48cd269db52679d8d0860ef0bfa5c13621c55ba26af30bb83b12aeb5f2ad0f58065d9c1d71dada4d5a784d876c09374e3ed6c17de75f8ec1
+  data.tar.gz: 2bf8dd100317b5a6ec541ddd514288eae869b4b0930d3fe6a28ef08bda302837e8c84e32f1722fd1021edec6c100de846a46cd4a53213d128e900a7fdf2c90ee

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+after_do

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p195

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tobias Pfeiffer
+
+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,67 @@
+# AfterDo [![Build Status](https://travis-ci.org/PragTob/after_do.png?branch=master)](https://travis-ci.org/PragTob/after_do)[![Code Climate](https://codeclimate.com/github/PragTob/after_do.png)](https://codeclimate.com/github/PragTob/after_do)
+
+AfterDo is simple gem, that allows you to execute a specified block after specified method of a class are called. If the class extends `AfterDo` you can simply do this by `MyClass.after :some_method do puts 'whatever you want?' end`
+
+This shall not be done to to alter behavior or something but rather to fight cross-cutting concerns such as logging. E.g. with logging you litter all your code wit logging statements - that concern is spread over many files. With AfterDo you could put all the logging in one file.
+
+AfterDo has no external runtime dependencies and the code is just a bit more than 60 lines (blank lines included).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'after_do'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install after_do
+
+## Usage
+
+With AfterDo you can do simple things like putting something out everything a method is called as in this example:
+
+```ruby
+class Dog
+  def bark
+    puts 'Woooof'
+  end
+
+  def eat
+    puts 'yummie!'
+  end
+end
+
+Dog.extend AfterDo
+Dog.after :bark do puts 'I just heard a dog bark!' end
+
+dog = Dog.new
+dog2 = Dog.new
+
+dog.bark
+dog.eat
+dog2.bark
+
+# Output is:
+# Woooof
+# I just heard a dog bark!
+# yummie!
+# Woooof
+# I just heard a dog bark!
+
+```
+
+## Is there a before method?
+
+No not yet, I didn't have a use case for it yet. If you have one please let me know, it is relatively easy to add.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/after_do.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'after_do/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "after_do"
+  spec.version       = AfterDo::VERSION
+  spec.authors       = ["Tobias Pfeiffer"]
+  spec.email         = ["pragtob@gmail.com"]
+  spec.description   = %q{after_do is a gem that let's you execute a block of your choice after a specific method was called on a class.}
+  spec.summary       = %q{after_do allows you to do simple after hooks on methods}
+  spec.homepage      = "https://github.com/PragTob/after_do"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/lib/after_do.rb

@@ -0,0 +1,62 @@
+module AfterDo
+  ALIAS_PREFIX = '__after_do_orig_'
+
+  def _after_do_callbacks
+    @_after_do_callbacks
+  end
+
+  def after(*methods, &block)
+    @_after_do_callbacks ||= Hash.new([])
+    methods.flatten! #in case someone used an Array
+    if methods.empty?
+      raise ArgumentError, 'after takes at least one method name!'
+    end
+    methods.each do |method|
+      if _after_do_method_already_renamed?(method)
+        _after_do_make_after_do_version_of_method(method)
+      end
+      @_after_do_callbacks[method] << block
+    end
+  end
+
+  def remove_all_callbacks
+    if @_after_do_callbacks
+      @_after_do_callbacks.keys.each do |key| @_after_do_callbacks[key] = [] end
+    end
+  end
+
+  private
+  def _after_do_make_after_do_version_of_method(method)
+    @_after_do_callbacks[method] = []
+    alias_name = _after_do_aliased_name method
+    _after_do_rename_old_method(method, alias_name)
+    _after_do_redefine_method_with_callback(method, alias_name)
+  end
+
+  def _after_do_aliased_name(symbol)
+    (ALIAS_PREFIX + symbol.to_s).to_sym
+  end
+
+  def _after_do_rename_old_method(old_name, new_name)
+    class_eval do
+      alias_method new_name, old_name
+      private new_name
+    end
+  end
+
+  def _after_do_redefine_method_with_callback(method, alias_name)
+    class_eval do
+      define_method method do |*args|
+        return_value = send(alias_name, *args)
+        self.class._after_do_callbacks[method].each do |block|
+          block.call *args, self
+        end
+        return_value
+      end
+    end
+  end
+
+  def _after_do_method_already_renamed?(method)
+    !private_method_defined? _after_do_aliased_name(method)
+  end
+end

data/lib/after_do/version.rb

@@ -0,0 +1,3 @@
+module AfterDo
+  VERSION = "0.1.0"
+end

data/samples/dog.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../../lib/after_do', __FILE__)
+
+class Dog
+  def bark
+    puts 'Woooof'
+  end
+
+  def eat
+    puts 'yummie!'
+  end
+end
+
+Dog.extend AfterDo
+Dog.after :bark do puts 'I just heard a dog bark!' end
+
+dog = Dog.new
+dog2 = Dog.new
+
+dog.bark
+dog.eat
+dog2.bark

data/spec/after_do_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+describe AfterDo do
+  let(:dummy_instance) {@dummy_class.new}
+  let(:mockie) {double}
+
+  before :each do
+    redefine_dummy_class
+  end
+
+  def redefine_dummy_class
+    @dummy_class = Class.new do
+      extend AfterDo
+      def zero
+        0
+      end
+
+      def one(param)
+        param
+      end
+
+      def two(param1, param2)
+        param2
+      end
+    end
+  end
+
+
+  it 'responds to after' do
+    @dummy_class.should respond_to :after
+  end
+
+  it 'calls a method on the injected mockie' do
+    mockie.should_receive :call_method
+    @dummy_class.after :zero do mockie.call_method end
+    dummy_instance.zero
+  end
+
+  it 'does not change the return value' do
+    before = dummy_instance.zero
+    @dummy_class.after :zero do 42 end
+    after = dummy_instance.zero
+    after.should eq before
+  end
+
+  it 'marks the copied method as private' do
+    @dummy_class.after :zero do end
+    copied_method_name = (AfterDo::ALIAS_PREFIX + 'zero').to_sym
+    dummy_instance.respond_to?(copied_method_name).should be_false
+  end
+
+  it 'can add multiple call backs' do
+    mockie.should_receive :call_method
+    mock2 = double
+    mock2.should_receive :call_another_method
+    mock3 = double
+    mock3.should_receive :bla
+    @dummy_class.after :zero do mockie.call_method end
+    @dummy_class.after :zero do mock2.call_another_method end
+    @dummy_class.after :zero do mock3.bla end
+    dummy_instance.zero
+  end
+
+  it 'can remove all callbacks' do
+    mockie.should_not_receive :call_method
+    @dummy_class.after :zero do mockie.call_method end
+    @dummy_class.remove_all_callbacks
+    dummy_instance.zero
+  end
+
+  describe 'with parameters' do
+
+    before :each do
+      mockie.should_receive :call_method
+    end
+
+    it 'can handle methods with a parameter' do
+      @dummy_class.after :one do mockie.call_method end
+      dummy_instance.one 5
+    end
+
+    it 'can handle methods with 2 parameters' do
+      @dummy_class.after :two do mockie.call_method end
+      dummy_instance.two 5, 8
+    end
+  end
+
+  describe 'with parameters for the given block' do
+    it 'can handle one block parameter' do
+      mockie.should_receive(:call_method).with(5)
+      @dummy_class.after :one do |i| mockie.call_method i end
+      dummy_instance.one 5
+    end
+
+    it 'can handle two block parameters' do
+      mockie.should_receive(:call_method).with(5, 8)
+      @dummy_class.after :two do |i, j| mockie.call_method i, j end
+      dummy_instance.two 5, 8
+    end
+  end
+
+  describe 'multiple methods' do
+    def call_all_3_methods
+      dummy_instance.zero
+      dummy_instance.one 4
+      dummy_instance.two 4, 5
+    end
+
+    it 'can take multiple method names as arguments' do
+      mockie.should_receive(:call_method).exactly(3).times
+      @dummy_class.after :zero, :one, :two do mockie.call_method end
+      call_all_3_methods
+    end
+
+    it 'can get the methods as an Array' do
+      mockie.should_receive(:call_method).exactly(3).times
+      @dummy_class.after [:zero, :one, :two] do mockie.call_method end
+      call_all_3_methods
+    end
+
+    it 'raises an error when no method is specified' do
+      expect do
+        @dummy_class.after do mockie.call_method end
+      end.to raise_error ArgumentError
+    end
+  end
+
+  describe 'it can get a hold of self, if needbe' do
+    it 'works for a method without arguments' do
+      mockie.should_receive(:call_method).with(dummy_instance)
+      @dummy_class.after :zero do |object| mockie.call_method(object) end
+      dummy_instance.zero
+    end
+
+    it 'works for a method with 2 arguments' do
+      mockie.should_receive(:call_method).with(1, 2, dummy_instance)
+      @dummy_class.after :two do |first, second, object|
+        mockie.call_method(first, second, object)
+      end
+      dummy_instance.two 1, 2
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  Coveralls::SimpleCov::Formatter,
+  SimpleCov::Formatter::HTMLFormatter
+]
+SimpleCov.start
+require 'after_do'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: after_do
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tobias Pfeiffer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
+  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: after_do is a gem that let's you execute a block of your choice after
+  a specific method was called on a class.
+email:
+- pragtob@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- after_do.gemspec
+- lib/after_do.rb
+- lib/after_do/version.rb
+- samples/dog.rb
+- spec/after_do_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PragTob/after_do
+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.0.3
+signing_key: 
+specification_version: 4
+summary: after_do allows you to do simple after hooks on methods
+test_files:
+- spec/after_do_spec.rb
+- spec/spec_helper.rb