action_callback 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ec0f61de4d5635712366cbce4c96cca8501f67cb
4
+ data.tar.gz: 3438f5627ff92cd7d8aa337ae8d7179b0df54ecd
5
+ SHA512:
6
+ metadata.gz: 93f777fe24f0dd70cf9e7f57b444b27413fa35d27873f9b287711fc1f889595707424cbcc22d2da1ba3a62680b09b0797f89d7dc01bbb720fffdf338748eeb83
7
+ data.tar.gz: c1b6141eec6b59a7103e14ebee999ba8ba3c2b97ecc34364384a8ecff4ef46bcb5400531e2eb9ed30b2547cfc5db69197964974059e692aa02717270a8f03ebe
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.gem
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.1.2
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at edmund.xz.lee@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in callback_action.gemspec
4
+ gemspec
5
+
6
+ gem 'minitest-reporters', group: :test
7
+ gem 'minitest-debugger', group: :test
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Edmund Li
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,96 @@
1
+ [![Build Status](https://travis-ci.org/EdmundLeex/action_callback.svg?branch=master)](https://travis-ci.org/EdmundLeex/action_callback)
2
+
3
+ # CallbackAction
4
+
5
+ This gem gives you ability to add callbacks like `before_action` / `before_fitler` etc to your class.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'callback_action'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install callback_action
22
+
23
+ ## Usage
24
+
25
+ If you are using plain ruby:
26
+
27
+ ```ruby
28
+ class Foobar
29
+ extend ActionCallback
30
+
31
+ before_action :foobar, on: [:foo, :bar]
32
+
33
+ def foo
34
+ # ...
35
+ end
36
+
37
+ def bar
38
+ # ...
39
+ end
40
+
41
+ def foobar
42
+ # ...
43
+ end
44
+ end
45
+ ```
46
+
47
+ If you are using Rails, you can save the `extend ActionCallback` line in active record models
48
+ (but you will still need that when you are defining a plain ruby class):
49
+
50
+ ```ruby
51
+ class Foobar < ActiveRecord::Base
52
+ before_action :foobar, on: [:foo, :bar]
53
+
54
+ def foo
55
+ # ...
56
+ end
57
+
58
+ def bar
59
+ # ...
60
+ end
61
+
62
+ def foobar
63
+ # ...
64
+ end
65
+ end
66
+ ```
67
+
68
+ ### Available callbacks
69
+
70
+ Currently, you can use `before_action`, `after_action` to define callbacks.
71
+
72
+ #### `before_action` / `before_filter`
73
+
74
+ This will give you a before callback.
75
+
76
+ ```ruby
77
+ before_action :before_callback, on: [:methods_that_will_invoke_before_callbacks]
78
+ ```
79
+
80
+ #### `after_action` / `after_action`
81
+
82
+ This will give you a after callback.
83
+
84
+ ```ruby
85
+ after_action :after_callback, on: [:methods_that_will_invoke_after_callbacks]
86
+ ```
87
+
88
+ ## Contributing
89
+
90
+ 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.
91
+
92
+
93
+ ## License
94
+
95
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
96
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'action_callback/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "action_callback"
8
+ spec.version = ActionCallback::VERSION
9
+ spec.authors = ["Edmund Li"]
10
+ spec.email = ["edmund.xz.lee@gmail.com"]
11
+
12
+ spec.summary = 'Add callback to your ruby class'
13
+ # spec.description = %q{TODO: Write a longer description or delete this line.}
14
+ spec.homepage = "https://github.com/EdmundLeex/action_callback"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.12"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "minitest", "~> 5.0"
25
+ end
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "callback_action"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,52 @@
1
+ module Callback
2
+ # The chain should have each method that has callback as key
3
+ # and each callback points to a hash with :before, :after as key
4
+ # each of those keys points to an array of callbacks
5
+ # {
6
+ # method: {
7
+ # before: [...],
8
+ # after: [...]
9
+ # }
10
+ # }
11
+ class Chain
12
+ CALLBACK_HOOK = [:before, :after].freeze
13
+
14
+ def initialize
15
+ CALLBACK_HOOK.each do |cb_hook|
16
+ instance_variable_set("@_#{cb_hook}_chain", new_chain)
17
+ end
18
+ end
19
+
20
+ def append_callback(callback_hook, mth, callback)
21
+ chain = get_chain(callback_hook)
22
+ chain[mth] << callback
23
+ end
24
+
25
+ CALLBACK_HOOK.each do |cb_hook|
26
+ define_method("#{cb_hook}_chain_of") do |mth_name|
27
+ get_callbacks(cb_hook, mth_name)
28
+ end
29
+ end
30
+
31
+ private
32
+
33
+ def get_callbacks(callback_hook, mth)
34
+ chain = get_chain(callback_hook)
35
+ chain[mth].dup
36
+ end
37
+
38
+ def get_chain(callback_hook)
39
+ instance_variable_get("@_#{callback_hook}_chain")
40
+ end
41
+
42
+ def new_chain
43
+ Hash.new { |h, k| h[k] = [] }
44
+ end
45
+ end
46
+
47
+ class << self
48
+ def get_callbacks(mth)
49
+ @_callback_chain.get_callbacks[mth]
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,33 @@
1
+ module ActionCallback
2
+ private
3
+
4
+ def initialize_callback_chain(mod)
5
+ mod.instance_variable_set('@_callback_chain', Callback::Chain.new)
6
+
7
+ mod.define_singleton_method(:_callback_chain) do
8
+ instance_variable_get('@_callback_chain')
9
+ end
10
+ end
11
+
12
+ def define_callback(callback_hook)
13
+ define_method("#{callback_hook}_action") do |callback, method_scope|
14
+ method_scope[:on].each do |mth_name|
15
+ @_callback_chain.append_callback(callback_hook, mth_name, callback)
16
+
17
+ undef_method(mth_name) if method_defined?(mth_name)
18
+
19
+ class_eval <<-RUBY
20
+ module ActionWithCallbacks
21
+ define_method(:#{mth_name}) do |*args, &block|
22
+ self.class._callback_chain.before_chain_of(:#{mth_name}).each { |cb| send(cb) }
23
+ super(*args, &block)
24
+ self.class._callback_chain.after_chain_of(:#{mth_name}).each { |cb| send(cb) }
25
+ end
26
+ end
27
+ RUBY
28
+
29
+ prepend self::ActionWithCallbacks
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,7 @@
1
+ module ActionCallback
2
+ VERSION = "0.1.0"
3
+
4
+ def self.version
5
+ VERSION
6
+ end
7
+ end
@@ -0,0 +1,17 @@
1
+ require "action_callback/version"
2
+ require "action_callback/define_callback"
3
+ require "action_callback/callback"
4
+
5
+ module ActionCallback
6
+ include Callback
7
+ extend self
8
+
9
+ def ActionCallback.extended(mod)
10
+ initialize_callback_chain(mod)
11
+
12
+ [:before, :after].each do |callback|
13
+ define_callback(callback)
14
+ alias_method :"#{callback}_filter", :"#{callback}_action"
15
+ end
16
+ end
17
+ end
metadata ADDED
@@ -0,0 +1,100 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: action_callback
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Edmund Li
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-01-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ description:
56
+ email:
57
+ - edmund.xz.lee@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".travis.yml"
64
+ - CODE_OF_CONDUCT.md
65
+ - Gemfile
66
+ - LICENSE.txt
67
+ - README.md
68
+ - Rakefile
69
+ - action_callback.gemspec
70
+ - bin/console
71
+ - bin/setup
72
+ - lib/action_callback.rb
73
+ - lib/action_callback/callback.rb
74
+ - lib/action_callback/define_callback.rb
75
+ - lib/action_callback/version.rb
76
+ homepage: https://github.com/EdmundLeex/action_callback
77
+ licenses:
78
+ - MIT
79
+ metadata: {}
80
+ post_install_message:
81
+ rdoc_options: []
82
+ require_paths:
83
+ - lib
84
+ required_ruby_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ required_rubygems_version: !ruby/object:Gem::Requirement
90
+ requirements:
91
+ - - ">="
92
+ - !ruby/object:Gem::Version
93
+ version: '0'
94
+ requirements: []
95
+ rubyforge_project:
96
+ rubygems_version: 2.2.2
97
+ signing_key:
98
+ specification_version: 4
99
+ summary: Add callback to your ruby class
100
+ test_files: []