method_hooks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a61c8959ce0b2aceec159ca529e2f3fde6b6e5ee
+  data.tar.gz: f6e790a079d9244183e69012fa720b88d4771e18
+SHA512:
+  metadata.gz: 1ba49d70657b76e9e9ec0e90f322376e786784127fc21f147c75edcc53805258f9ebad9c1c05d76aea0d8cfbfe81ee11fa71be2f21b63e2e8873ad41b6245584
+  data.tar.gz: 1f43024320816a1de2139da56491110a692ce42bcd14333351fc1f8b0ab057b94f1603521c4492237053af6cb041c241c97a5527b296f32dc5cefa9815bfccf4

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Frank Bonetti
+
+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,76 @@
+# MethodHooks
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'method_hooks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install method_hooks
+
+## Usage
+
+```
+class Model
+  extend Callbacks
+
+  before :save do
+    puts 'before'
+  end
+
+  around :save do |method|
+    puts 'before_around'
+    method.call
+    puts 'after_around'
+  end
+
+  after :save, :foo do
+    puts 'after'
+  end
+
+  def save
+    puts 'save'
+  end
+
+  def foo
+    puts 'foo'
+  end
+
+end
+
+model = Model.new
+model.save
+model.foo
+
+=begin
+
+Outputs the following:
+
+before
+before_around
+save
+after_around
+after
+foo
+after
+
+=end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/method_hooks/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/Rakefile

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

data/examples/model.rb

@@ -0,0 +1,44 @@
+class Model
+  extend Callbacks
+
+  before :save do
+    puts 'before'
+  end
+
+  around :save do |method|
+    puts 'before_around'
+    method.call
+    puts 'after_around'
+  end
+
+  after :save, :foo do
+    puts 'after'
+  end
+
+  def save
+    puts 'save'
+  end
+
+  def foo
+    puts 'foo'
+  end
+
+end
+
+model = Model.new
+model.save
+model.foo
+
+=begin
+
+Outputs the following:
+
+before
+before_around
+save
+after_around
+after
+foo
+after
+
+=end

data/lib/method_hooks/version.rb

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

data/lib/method_hooks.rb

@@ -0,0 +1,97 @@
+require "method_hooks/version"
+
+module MethodHooks
+  @new_method = true
+
+  def self.extended(base)
+    base.send :include, InstanceMethods
+  end
+
+  private
+
+  def method_added(method_name)
+    return if @new_method == false || [:call_before_callbacks, :call_around_callbacks, :call_after_callbacks].include?(method_name)
+
+    method = instance_method(method_name)
+    undef_method(method_name)
+
+    @new_method = false
+
+    define_method(method_name) do |*args, &block|
+      call_before_callbacks(method_name)
+      return_value = call_around_callbacks(method_name) { method.bind(self).call(*args, &block) }
+      call_after_callbacks(method_name)
+
+      return_value
+    end
+
+    @new_method = true
+  end
+
+  def before_callbacks
+    @before_callbacks ||= Hash.new { |hash, key| hash[key] = Array.new }
+  end
+
+  def around_callbacks
+    @around_callbacks ||= Hash.new { |hash, key| hash[key] = Array.new }
+  end
+
+  def after_callbacks
+    @after_callbacks ||= Hash.new { |hash, key| hash[key] = Array.new }
+  end
+
+  def before(*method_names, &block)
+    method_names.each do |method_name|
+      before_callbacks[method_name] << block
+    end
+  end
+
+  def around(*method_names, &block)
+    method_names.each do |method_name|
+      around_callbacks[method_name] << block
+    end
+  end
+
+  def after(*method_names, &block)
+    method_names.each do |method_name|
+      after_callbacks[method_name] << block
+    end
+  end
+
+  module InstanceMethods
+
+    private
+
+    def call_before_callbacks(method_name)
+      callbacks = self.class.send(:before_callbacks)[method_name]
+      callbacks.each do |callback|
+        instance_eval(&callback)
+      end
+    end
+
+    def call_around_callbacks(method_name, &block)
+      callbacks = self.class.send(:around_callbacks)[method_name]
+      return_value = nil
+
+      method = -> { return_value = block.call }
+
+      if callbacks.empty?
+        method.call
+      else
+        callbacks.each do |callback|
+          instance_exec(method, &callback)
+        end
+      end
+
+      return_value
+    end
+
+    def call_after_callbacks(method_name)
+      callbacks = self.class.send(:after_callbacks)[method_name]
+      callbacks.each do |callback|
+        instance_eval(&callback)
+      end
+    end
+
+  end
+end

data/method_hooks.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'method_hooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "method_hooks"
+  spec.version       = MethodHooks::VERSION
+  spec.authors       = ["Frank Bonetti"]
+  spec.email         = ["frank.r.bonetti@gmail.com"]
+  spec.summary       = %q{Rails-style method hooks for plain old Ruby objects}
+  spec.description   = %q{Rails-style method hooks for plain old Ruby objects}
+  spec.homepage      = "https://github.com/fbonetti/method_hooks"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/lib/method_hooks_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'pry'
+
+describe MethodHooks do
+
+  before do
+    Object.send(:remove_const, :Base) if Object.const_defined?(:Base)
+
+    class Base
+      extend MethodHooks
+
+      attr_reader :events
+
+      def initialize
+        @events = []
+      end
+
+      def save
+        @events << 'save'
+      end
+    end
+  end
+
+  describe '::before' do
+
+    it 'should call the before block' do
+      Base.instance_eval do
+        before(:save) { @events << 'before' }
+      end
+
+      base = Base.new
+      base.save
+
+      expect(base.events).to eq(['before', 'save'])
+    end
+
+    it 'should allow multiple before hooks on the same method' do
+      Base.instance_eval do
+        before(:save) { @events << 'first before' }
+        before(:save) { @events << 'second before' }
+      end
+
+      base = Base.new
+      base.save
+
+      expect(base.events).to eq(['first before', 'second before', 'save'])
+    end
+
+  end
+
+  describe '::around' do
+
+    it 'should call the around block' do
+      Base.instance_eval do
+        around(:save) do |method|
+          @events << 'before_around'
+          method.call
+          @events << 'after_around'
+        end
+      end
+
+      base = Base.new
+      base.save
+
+      expect(base.events).to eq(['before_around', 'save', 'after_around'])
+    end
+
+  end
+
+  describe '::after' do
+
+    it 'should call the after block' do
+      Base.instance_eval do
+        after(:save) { @events << 'after' }
+      end
+
+      base = Base.new
+      base.save
+
+      expect(base.events).to eq(['save', 'after'])
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+require 'method_hooks'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: method_hooks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Frank Bonetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-07 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+description: Rails-style method hooks for plain old Ruby objects
+email:
+- frank.r.bonetti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/model.rb
+- lib/method_hooks.rb
+- lib/method_hooks/version.rb
+- method_hooks.gemspec
+- spec/lib/method_hooks_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fbonetti/method_hooks
+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.14
+signing_key: 
+specification_version: 4
+summary: Rails-style method hooks for plain old Ruby objects
+test_files:
+- spec/lib/method_hooks_spec.rb
+- spec/spec_helper.rb