action_callback 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec0f61de4d5635712366cbce4c96cca8501f67cb
+  data.tar.gz: 3438f5627ff92cd7d8aa337ae8d7179b0df54ecd
+SHA512:
+  metadata.gz: 93f777fe24f0dd70cf9e7f57b444b27413fa35d27873f9b287711fc1f889595707424cbcc22d2da1ba3a62680b09b0797f89d7dc01bbb720fffdf338748eeb83
+  data.tar.gz: c1b6141eec6b59a7103e14ebee999ba8ba3c2b97ecc34364384a8ecff4ef46bcb5400531e2eb9ed30b2547cfc5db69197964974059e692aa02717270a8f03ebe

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at edmund.xz.lee@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in callback_action.gemspec
+gemspec
+
+gem 'minitest-reporters', group: :test
+gem 'minitest-debugger', group: :test

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Edmund Li
+
+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,96 @@
+[![Build Status](https://travis-ci.org/EdmundLeex/action_callback.svg?branch=master)](https://travis-ci.org/EdmundLeex/action_callback)
+
+# CallbackAction
+
+This gem gives you ability to add callbacks like `before_action` / `before_fitler` etc to your class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'callback_action'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install callback_action
+
+## Usage
+
+If you are using plain ruby:
+
+```ruby
+class Foobar
+  extend ActionCallback
+
+  before_action :foobar, on: [:foo, :bar]
+  
+  def foo
+    # ...
+  end
+
+  def bar
+    # ...
+  end
+
+  def foobar
+    # ...
+  end
+end
+```
+
+If you are using Rails, you can save the `extend ActionCallback` line in active record models
+(but you will still need that when you are defining a plain ruby class):
+
+```ruby
+class Foobar < ActiveRecord::Base
+  before_action :foobar, on: [:foo, :bar]
+  
+  def foo
+    # ...
+  end
+
+  def bar
+    # ...
+  end
+
+  def foobar
+    # ...
+  end
+end
+```
+
+### Available callbacks
+
+Currently, you can use `before_action`, `after_action` to define callbacks.
+
+#### `before_action` / `before_filter`
+
+This will give you a before callback.
+
+```ruby
+before_action :before_callback, on: [:methods_that_will_invoke_before_callbacks]
+```
+
+#### `after_action` / `after_action`
+
+This will give you a after callback.
+
+```ruby
+after_action :after_callback, on: [:methods_that_will_invoke_after_callbacks]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/edmundleex/callback_action. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/action_callback.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_callback/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_callback"
+  spec.version       = ActionCallback::VERSION
+  spec.authors       = ["Edmund Li"]
+  spec.email         = ["edmund.xz.lee@gmail.com"]
+
+  spec.summary       = 'Add callback to your ruby class'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/EdmundLeex/action_callback"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "callback_action"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/action_callback/callback.rb

@@ -0,0 +1,52 @@
+module Callback
+  # The chain should have each method that has callback as key
+  # and each callback points to a hash with :before, :after as key
+  # each of those keys points to an array of callbacks
+  # {
+  #   method: {
+  #     before: [...],
+  #     after:  [...]
+  #   }
+  # }
+  class Chain
+    CALLBACK_HOOK = [:before, :after].freeze
+
+    def initialize
+      CALLBACK_HOOK.each do |cb_hook|
+        instance_variable_set("@_#{cb_hook}_chain", new_chain)
+      end
+    end
+
+    def append_callback(callback_hook, mth, callback)
+      chain = get_chain(callback_hook)
+      chain[mth] << callback
+    end
+
+    CALLBACK_HOOK.each do |cb_hook|
+      define_method("#{cb_hook}_chain_of") do |mth_name|
+        get_callbacks(cb_hook, mth_name)
+      end
+    end
+
+    private
+
+    def get_callbacks(callback_hook, mth)
+      chain = get_chain(callback_hook)
+      chain[mth].dup
+    end
+
+    def get_chain(callback_hook)
+      instance_variable_get("@_#{callback_hook}_chain")
+    end
+
+    def new_chain
+      Hash.new { |h, k| h[k] = [] }
+    end
+  end
+
+  class << self
+    def get_callbacks(mth)
+      @_callback_chain.get_callbacks[mth]
+    end
+  end
+end

data/lib/action_callback/define_callback.rb

@@ -0,0 +1,33 @@
+module ActionCallback
+  private
+
+  def initialize_callback_chain(mod)
+    mod.instance_variable_set('@_callback_chain', Callback::Chain.new)
+
+    mod.define_singleton_method(:_callback_chain) do
+      instance_variable_get('@_callback_chain')
+    end
+  end
+
+  def define_callback(callback_hook)
+    define_method("#{callback_hook}_action") do |callback, method_scope|
+      method_scope[:on].each do |mth_name|
+        @_callback_chain.append_callback(callback_hook, mth_name, callback)
+
+        undef_method(mth_name) if method_defined?(mth_name)
+
+        class_eval <<-RUBY
+          module ActionWithCallbacks
+            define_method(:#{mth_name}) do |*args, &block|
+              self.class._callback_chain.before_chain_of(:#{mth_name}).each { |cb| send(cb) }
+              super(*args, &block)
+              self.class._callback_chain.after_chain_of(:#{mth_name}).each { |cb| send(cb) }
+            end
+          end
+        RUBY
+
+        prepend self::ActionWithCallbacks
+      end
+    end
+  end
+end

data/lib/action_callback/version.rb

@@ -0,0 +1,7 @@
+module ActionCallback
+  VERSION = "0.1.0"
+
+  def self.version
+    VERSION
+  end
+end

data/lib/action_callback.rb

@@ -0,0 +1,17 @@
+require "action_callback/version"
+require "action_callback/define_callback"
+require "action_callback/callback"
+
+module ActionCallback
+  include Callback
+  extend self
+
+  def ActionCallback.extended(mod)
+    initialize_callback_chain(mod)
+
+    [:before, :after].each do |callback|
+      define_callback(callback)
+      alias_method :"#{callback}_filter", :"#{callback}_action"
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: action_callback
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edmund Li
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- edmund.xz.lee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_callback.gemspec
+- bin/console
+- bin/setup
+- lib/action_callback.rb
+- lib/action_callback/callback.rb
+- lib/action_callback/define_callback.rb
+- lib/action_callback/version.rb
+homepage: https://github.com/EdmundLeex/action_callback
+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 callback to your ruby class
+test_files: []