method_callbacks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbf0e679bd6e803446afce6df859949314259077
+  data.tar.gz: f1c885539200a66a3b71eb2a875f46d07bac3fce
+SHA512:
+  metadata.gz: 7e2609566689254861eb16ceef74c4a71e6025253b420f99e68866edd36555ede6dfd93557fcdb9e696be01926064d5245bc542d1ed0dc53bc184fd8fdaf3b18
+  data.tar.gz: cffb1bb69568ab5d172d8861351688cafcc66eb9fd30da97ea9e0f02dca0c7df2bbe386abb4745649f755983ac169d42cb2fdbb9f2c94bc750eae5f1872ea22c

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/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - showactive@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'rspec' do
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Morgan Showman
+
+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,98 @@
+# MethodCallbacks
+
+Add after, around, and before callbacks to your methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'method_callbacks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install method_callbacks
+
+## Usage
+
+```rb
+require "method_callbacks"
+
+class ExampleCallbacks
+  include MethodCallbacks
+
+  after_method :action, :farewell, :unload
+  after_method :action do
+    puts "Executing block callback after action and everything else!"
+  end
+
+  before_method :action do
+    puts "Executing block callback before action and everything else!"
+  end
+  before_method :action, :intro
+  before_method :action, :greet
+
+  around_method :action, :outer_around, :inner_around
+
+  def outer_around
+    puts "Executing pre outer_around!"
+    return_value = yield
+    puts "Executin post outer_around!"
+    return_value
+  end
+
+  def inner_around
+    puts "Executing pre inner_around!"
+    return_value = yield
+    puts "Executing post inner_around!"
+    return_value
+  end
+
+  def action
+    puts "Executing action, the method with all teh callbacks!"
+
+    "My return value!"
+  end
+
+  def greet
+    puts "Executing greet before action but after intro!"
+  end
+
+  def intro
+    puts "Executing intro before action and greet!"
+  end
+
+  def farewell
+    puts "Executing farewell after action but before unload!"
+  end
+
+  def unload
+    puts "Executing unload after action and farewell!"
+  end
+end
+
+> ExampleCallbacks.new.action
+Executing block callback before action and everything else!
+Executing intro before action and greet!
+Executing greet before action but after intro!
+Executing pre outer_around!
+Executing pre inner_around!
+Executing action, the method with all teh callbacks!
+Executing post inner_around!
+Executin post outer_around!
+Executing farewell after action but before unload!
+Executing unload after action and farewell!
+Executing block callback after action and everything else!
+ => "My return value!"
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/MorganShowman/method_callbacks/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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task default: :spec

data/lib/method_callbacks/definer.rb

@@ -0,0 +1,25 @@
+require "forwardable"
+
+module MethodCallbacks
+  class Definer
+    extend Forwardable
+
+    attr_reader :method
+
+    def_delegators :method, :callbacks, :name
+
+    def initialize(method)
+      @method = method
+    end
+
+    def define(type, callbacks)
+      callbacks.each do |callback|
+        callbacks(type) << callback if !callbacks(type).include?(callback)
+      end
+    end
+
+    def define_with_block(type, &block)
+      callbacks(type) << block if !callbacks(type).include?(block)
+    end
+  end
+end

data/lib/method_callbacks/executor.rb

@@ -0,0 +1,31 @@
+module MethodCallbacks
+  class Executor
+    attr_reader :method, :type, :object
+
+    def initialize(method, type, object)
+      @method = method
+      @type = type
+      @object = object
+    end
+
+    def execute
+      return execute_callbacks if !block_given?
+
+      callbacks.empty? ? yield : execute_around_callbacks(&Proc.new)
+    end
+
+    private
+
+    def callbacks
+      method.callbacks(type)
+    end
+
+    def execute_around_callbacks
+      callbacks.reverse.reduce(Proc.new) { |block, callback_name| Proc.new { object.send(callback_name, &block) } }.call
+    end
+
+    def execute_callbacks
+      callbacks.each { |callback_name| callback_name.is_a?(Proc) ? object.instance_eval(&callback_name) : object.send(callback_name) }
+    end
+  end
+end

data/lib/method_callbacks/finder.rb

@@ -0,0 +1,32 @@
+require "method_callbacks/method"
+
+module MethodCallbacks
+  class Finder
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def find
+      @_find ||= {}
+      @_find[name] ||= methods.select { |callback| callback == self }.first
+    end
+
+    def find_or_new
+      find || new
+    end
+
+    private
+
+    def new
+      method = Method.new(name)
+      methods << method
+      method
+    end
+
+    def methods
+      @_methods ||= []
+    end
+  end
+end

data/lib/method_callbacks/locker.rb

@@ -0,0 +1,21 @@
+module MethodCallbacks
+  class Locker
+    attr_accessor :state
+
+    def initialize
+      self.state = :unlocked
+    end
+
+    def lock!
+      self.state = :locked
+    end
+
+    def locked?
+      state == :locked
+    end
+
+    def unlock!
+      self.state = :unlocked
+    end
+  end
+end

data/lib/method_callbacks/method.rb

@@ -0,0 +1,46 @@
+require "forwardable"
+require "method_callbacks/definer"
+require "method_callbacks/executor"
+require "method_callbacks/locker"
+
+module MethodCallbacks
+  class Method
+    extend Forwardable
+
+    attr_reader :name
+
+    def_delegators :definer, :define, :define_with_block
+    def_delegators :locker, :lock!, :locked?, :unlock!
+
+    def initialize(name)
+      @name = name
+    end
+
+    def ==(other)
+      self.name == other.name
+    end
+
+    def callbacks(type)
+      @_callbacks ||= {}
+      @_callbacks[type] ||= []
+    end
+
+    def execute(type, object)
+      block_given? ? executor(type, object).execute(&Proc.new) : executor(type, object).execute
+    end
+
+    private
+
+    def executor(type, object)
+      Executor.new(self, type, object)
+    end
+
+    def definer
+      @_definer ||= Definer.new(self)
+    end
+
+    def locker
+      @_method_lock ||= Locker.new
+    end
+  end
+end

data/lib/method_callbacks/version.rb

@@ -0,0 +1,3 @@
+module MethodCallbacks
+  VERSION = "1.0.0"
+end

data/lib/method_callbacks.rb

@@ -0,0 +1,72 @@
+require "method_callbacks/finder"
+require "method_callbacks/version"
+
+module MethodCallbacks
+  ALIAS_PREFIX = "__method_callback_alias_to_original"
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def after_method(method_name, *callback_names)
+      define(method_name, :after, callback_names)
+      define_with_block(method_name, :after, &Proc.new) if block_given?
+    end
+
+    def around_method(method_name, *callback_names)
+      define(method_name, :around, callback_names)
+    end
+
+    def before_method(method_name, *callback_names)
+      define(method_name, :before, callback_names)
+      define_with_block(method_name, :before, &Proc.new) if block_given?
+    end
+
+    private
+
+    def define(method_name, type, callback_names)
+      find_or_new(method_name).define(type, callback_names)
+    end
+
+    def define_with_block(method_name, type)
+      find_or_new(method_name).define_with_block(type, &Proc.new)
+    end
+
+    def find(method_name)
+      finder(method_name).find
+    end
+
+    def finder(method_name)
+      @_finder ||= {}
+      @_finder[method_name] ||= MethodCallbacks::Finder.new(method_name)
+    end
+
+    def find_or_new(method_name)
+      finder(method_name).find_or_new
+    end
+
+    def method_added(method_name)
+      redefine_method(find(method_name))
+
+      super
+    end
+
+    def redefine_method(method)
+      return if !method || method.locked?
+
+      method.lock! && alias_method("#{ALIAS_PREFIX}_#{method.name}", method.name)
+
+      define_method(method.name) do
+        method.execute(:before, self)
+        return_value = method.execute(:around, self) do
+          send("#{ALIAS_PREFIX}_#{method.name}")
+        end
+        method.execute(:after, self)
+        return_value
+      end
+
+      method.unlock!
+    end
+  end
+end

data/method_callbacks.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'method_callbacks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "method_callbacks"
+  spec.version       = MethodCallbacks::VERSION
+  spec.authors       = ["Morgan Showman"]
+  spec.email         = ["morganshowman@gmail.com"]
+  spec.summary       = %q{Add method callbacks to your classes}
+  spec.description   = %q{Add after, around, and before callbacks to methods in your classes}
+  spec.homepage      = "https://github.com/MorganShowman/method_callbacks"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+end

data/spec/method_callbacks_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+describe MethodCallbacks do
+  let(:test_callbacks) { TestCallbacks.new }
+
+  it "should execute all the callbacks on action" do
+    expect(test_callbacks).to receive(:puts).with("Executing block").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing intro").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing greet").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing pre outer_around").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing pre inner_around").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing action").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing post inner_around").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing post outer_around").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing farewell").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing unload").ordered
+    expect(test_callbacks).to receive(:puts).with("Executing block").ordered
+
+    test_callbacks.action
+  end
+end
+
+class TestCallbacks
+  include MethodCallbacks
+
+  after_method :action, :farewell, :unload
+  after_method :action do
+    puts "Executing block"
+  end
+
+  before_method :action do
+    puts "Executing block"
+  end
+  before_method :action, :intro
+  before_method :action, :greet
+
+  around_method :action, :outer_around, :inner_around
+
+  def outer_around
+    puts "Executing pre outer_around"
+    return_value = yield
+    puts "Executing post outer_around"
+    return_value
+  end
+
+  def inner_around
+    puts "Executing pre inner_around"
+    return_value = yield
+    puts "Executing post inner_around"
+    return_value
+  end
+
+  def action
+    puts "Executing action"
+
+    "Return value"
+  end
+
+  def greet
+    puts "Executing greet"
+  end
+
+  def intro
+    puts "Executing intro"
+  end
+
+  def farewell
+    puts "Executing farewell"
+  end
+
+  def unload
+    puts "Executing unload"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "method_callbacks"

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: method_callbacks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Morgan Showman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  prerelease: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+description: Add after, around, and before callbacks to methods in your classes
+email:
+- morganshowman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/method_callbacks.rb
+- lib/method_callbacks/definer.rb
+- lib/method_callbacks/executor.rb
+- lib/method_callbacks/finder.rb
+- lib/method_callbacks/locker.rb
+- lib/method_callbacks/method.rb
+- lib/method_callbacks/version.rb
+- method_callbacks.gemspec
+- spec/method_callbacks_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/MorganShowman/method_callbacks
+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: Add method callbacks to your classes
+test_files:
+- spec/method_callbacks_spec.rb
+- spec/spec_helper.rb