object_callbacks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 141083ea54befed6f748fbf30271568b5f1e739d
+  data.tar.gz: 7ba93510faeb5aee04922674b22f97fc35f17c3d
+SHA512:
+  metadata.gz: 2c00d96843bd513c295cce0491323f16c805ea423f915a2b233ce297dfe87544c32dd9338fa98eed4a288c6b005de04f39e6adf44b1f33b190bf1524c05e2c6e
+  data.tar.gz: 44769f575bfceb961b917b6d4658d83008ce8ffe461970c532ae24fb10496bab06191be9a17d1718c7abb26622644a89a9a279557a24e9de6aefbe4a97756d0b

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'pry'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Raza Ali
+
+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,73 @@
+# ObjectCallbacks
+
+I need something similar to BeforeFilters [**https://github.com/IDme/before_filters**] but more than that.
+
+This library allow you to bind before_call and after_call to a Ruby class method, similar to ActiveRecord's callbacks.
+
+Similar to ActiveRecord, if you need to termiate execution in before_call just return false.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'object_callbacks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install object_callbacks
+
+## Usage
+
+```ruby
+class MyClass
+  extend ObjectCallbacks
+
+  before_call :sit_down
+  before_call :drink_one_glass,    only: [:sleep]
+  after_call  :drink_four_glasses, only: [:wake_up]
+
+  def sleep
+    puts 'Go to sleep'
+  end
+
+  def wake_up
+    puts 'Get up now'
+  end
+
+  private
+
+  def drink_one_glass
+    puts 'Drink one glass'
+  end
+
+  def drink_four_glasses
+    puts 'Drink four glasses'
+  end
+
+  def sit_down
+    puts 'Please sit down'
+  end
+end
+
+my_class = MyClass.new
+
+my_class.sleep
+=> Please sit down
+=> Drink one glass
+=> Go to sleep
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/raza/object_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 a new Pull Request

data/Rakefile

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

data/examples/basic_callback.rb

@@ -0,0 +1,41 @@
+require 'object_callbacks'
+
+class MyClass
+  extend ObjectCallbacks
+
+  before_call :before_callback_1, only: [:action1]
+  before_call :before_callback_2, only: [:action1]
+  before_call :before_callback_3, only: [:action1]
+  after_call  :after_call_1, only: [:action1]
+
+  def action1
+    puts 'action1 called'
+  end
+
+  def action2
+    puts 'action2 called'
+  end
+
+  private
+
+  def before_callback_1
+    puts 'before_callback_1 called'
+  end
+
+  def before_callback_2
+    puts 'before_callback_2 called with termination'
+    # false
+  end
+
+  def before_callback_3
+    puts 'before_callback_3 called'
+  end
+
+  def after_call_1
+    puts 'after_call_1 called'
+  end
+end
+
+my_class = MyClass.new
+my_class.action1
+my_class.action2

data/lib/object_callbacks/version.rb

@@ -0,0 +1,3 @@
+module ObjectCallbacks
+  VERSION = "0.0.1"
+end

data/lib/object_callbacks.rb

@@ -0,0 +1,85 @@
+require "object_callbacks/version"
+
+module ObjectCallbacks
+  def method_added(action_name)
+    if actions.include?(action_name) || before_calls.key?(action_name) || after_calls.key?(action_name)
+      return
+    end
+
+    apply_callback_actions(action_name)
+  end
+
+  def before_call(action_name, options = {})
+    before_calls[action_name] = options
+  end
+
+  def after_call(action_name, options = {})
+    after_calls[action_name] = options
+  end
+
+  private
+
+  def before_calls
+    @before_calls ||= {}
+  end
+
+  def after_calls
+    @after_calls ||= {}
+  end
+
+  def actions
+    @actions ||= []
+  end
+
+  def apply_callback_actions(action_name)
+    actions << action_name
+
+    original_method = instance_method(action_name)
+
+    define_method(action_name) do |*args, &block|
+      val = self.class.send(:execute_before_calls, action_name, self)
+      return false if val == false
+      result = original_method.bind(self).call(*args, &block)
+      self.class.send(:execute_after_calls, action_name, self)
+
+      result
+    end
+  end
+
+  def execute_before_calls(action_name, instance)
+    callbacks_for_method(action_name, :before).each do |before_call_method|
+      val = instance.send(before_call_method)
+      return false if val == false
+    end
+  end
+
+  def execute_after_calls(action_name, instance)
+    callbacks_for_method(action_name, :after).each do |after_call_method|
+      instance.send(after_call_method)
+    end
+  end
+
+  def callbacks_for_method(action_name, callback_type)
+    callbacks = send("#{callback_type}_calls")
+
+    callbacks_for_all(callbacks) +
+      only_callbacks(callbacks, action_name) +
+      except_callbacks(callbacks, action_name)
+  end
+
+  def callbacks_for_all(callbacks)
+    callbacks.select { |_key, value| value.empty? }.keys
+  end
+
+  def only_callbacks(callbacks, action_name)
+    callbacks.select do |_key, value|
+      !value[:only].nil? && value[:only].include?(action_name)
+    end.keys
+  end
+
+  def except_callbacks(callbacks, action_name)
+    callbacks.select do |_key, value|
+      !value[:except].nil? && !value[:except].include?(action_name)
+    end.keys
+  end
+end

data/object_callbacks.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'object_callbacks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "object_callbacks"
+  spec.version       = ObjectCallbacks::VERSION
+  spec.authors       = ["Raza Ali"]
+  spec.email         = ["tauraz@gmail.com"]
+  spec.summary       = 'Ruby object method callbacks'
+  spec.description   = 'Callbacks to execute before or after object method call'
+  spec.homepage      = "https://github.com/raza/object_callbacks"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0") + Dir['lib/**/*.rb']
+  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"
+  spec.add_development_dependency "rspec", "~> 2.9"
+end

data/spec/before_call_spec.rb

@@ -0,0 +1,52 @@
+require 'object_callbacks'
+require 'pry'
+
+class MyClass
+  extend ObjectCallbacks
+
+  before_call :sit_down
+  before_call :drink_one_glass,    only: [:sleep]
+  after_call  :drink_four_glasses, only: [:wake_up]
+
+  def sleep
+    'Go to sleep'
+  end
+
+  def wake_up
+    'Get up now'
+  end
+
+  private
+
+  def drink_one_glass
+    'Drink one glass'
+  end
+
+  def drink_four_glasses
+    'Drink four glasses'
+  end
+
+  def sit_down
+    'Please sit down'
+  end
+end
+
+describe ObjectCallbacks do
+  subject { MyClass.new }
+  describe '#sleep' do
+    it 'calls sit_down' do
+      subject.should_receive(:sit_down)
+      subject.sleep
+    end
+
+    it 'drinks one glass' do
+      subject.should_receive(:drink_one_glass)
+      subject.sleep
+    end
+
+    it 'should not drink four glasses' do
+      subject.should_not_receive(:drink_four_glasses)
+      subject.sleep
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: object_callbacks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Raza Ali
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Callbacks to execute before or after object method call
+email:
+- tauraz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/basic_callback.rb
+- lib/object_callbacks.rb
+- lib/object_callbacks/version.rb
+- object_callbacks.gemspec
+- spec/before_call_spec.rb
+homepage: https://github.com/raza/object_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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby object method callbacks
+test_files:
+- spec/before_call_spec.rb