embed_callbacks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30084b7f7b4e7428eab54df0b76aa442b48ed867e0f422d8f84495afbb5f8c3f
+  data.tar.gz: 9961711ce671a6056ec9d18dc5d3ba4920588c7f46392abb56437799b7ed6ed6
+SHA512:
+  metadata.gz: e1bc18923a237a94070a290a62eb70adbb119b4790baaa4c2bf3bb7fd18170c3ac069e71660b5ba8873b7d97e34b08647ee2e567ca32e8eee04efb27ffc95bef
+  data.tar.gz: c1267dafece5ce7a0f8e38c709bdf5c6c3ced181f3636c7661f3032b1a2912c10b10d1319f29a5bf786d96a0e0b132cba4416d21c8d5f075561a40bd546c0c84

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [ '2.7.x', '2.6.x', '2.5.x' ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Install dependencies
+      run: |
+        gem install bundler --no-document
+        bundle install
+
+    - name: Run test
+      run: bundle exec rspec spec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - "2.5.7"
+  - "2.6.5"
+  - "2.7.0"
+before_install: gem install bundler -v 2.1.4
+script: "bundle exec rake spec"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hotoolong.hogehoge+github@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in embed_callbacks.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'codecov', :require => false, :group => :test

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    embed_callbacks (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codecov (0.2.6)
+      colorize
+      json
+      simplecov
+    colorize (0.8.1)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    json (2.3.1)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codecov
+  embed_callbacks!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 hotoolong
+
+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,206 @@
+# EmbedCallbacks
+
+[![Build Status](https://travis-ci.org/hotoolong/embed_callbacks.svg?branch=main)](https://travis-ci.org/hotoolong/embed_callbacks)
+[![codecov](https://codecov.io/gh/hotoolong/embed_callbacks/branch/main/graph/badge.svg)](https://codecov.io/gh/hotoolong/embed_callbacks)
+
+This gem makes it easy to create callbacks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_callbacker', github: 'hotoolong/embed_callbacks'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install specific_install
+    $ gem specific_install git@github.com:hotoolong/embed_callbacks.git main 
+
+## Usage
+
+embed_callback provides the following callbacks.
+
+- `before` is called the operation before the specified method.
+- `after` is called processing after the specified method.
+- `around` is called processing before and after the specified method.
+- `rescue` is called if the specified method produces an error.
+- `ensure` is always called if the given method completes.
+
+It also lets you decide whether or not to run the process according to the conditions.
+The conditions can be if and unless.
+
+### before example
+
+```ruby
+require 'embed_callbacks'
+
+class Sample
+  include EmbedCallbacks
+  set_callback :target, :before, :before_callback
+
+  def target
+    puts 'target'
+  end
+
+  def before_callback
+    puts 'before_callback'
+  end
+
+end
+sample = Sample.new
+sample.target
+#=> before_callback
+#=> target
+```
+
+### after example
+
+```ruby
+require 'embed_callbacks'
+
+class Sample
+  include EmbedCallbacks
+  set_callback :target, :after, :after_callback
+
+  def target
+    puts 'target'
+  end
+
+  def after_callback
+    puts 'after_callback'
+  end
+
+end
+sample = Sample.new
+sample.target
+#=> target
+#=> after_callback
+```
+
+### around example
+
+```ruby
+require 'embed_callbacks'
+
+class Sample
+  include EmbedCallbacks
+  set_callback :target, :around, :around_callback
+
+  def target
+    puts 'target'
+  end
+
+  def around_callback
+    puts 'around_callback'
+  end
+
+end
+sample = Sample.new
+sample.target
+#=> around_callback
+#=> target
+#=> around_callback
+```
+### rescue example
+
+```ruby
+require 'embed_callbacks'
+
+class Sample
+  include EmbedCallbacks
+  set_callback :target, :rescue, :rescue_callback
+
+  def target
+    raise 'target'
+  end
+
+  def rescue_callback
+    puts 'rescue_callback'
+  end
+
+end
+sample = Sample.new
+sample.target
+
+#=> rescue_callback
+#=> RuntimeError (target)
+```
+
+### ensure example
+
+```ruby
+require 'embed_callbacks'
+
+class Sample
+  include EmbedCallbacks
+  set_callback :target, :ensure, :ensure_callback
+
+  def target
+    puts 'target'
+  end
+
+  def ensure_callback
+    puts 'ensure_callback'
+  end
+
+end
+sample = Sample.new
+sample.target
+#=> target
+#=> ensure_callback
+```
+
+### condition example
+
+```ruby
+require 'embed_callbacks'
+
+class Sample
+  include EmbedCallbacks
+  attr_accessor :check_flag
+
+  set_callback :target, :before, :before_callback, if: ->(record) { record.check_flag }
+
+  def target
+    puts 'target'
+  end
+
+  def before_callback
+    puts 'before_callback'
+  end
+
+end
+sample = Sample.new
+sample.check_flag = false
+sample.target
+#=> target
+sample.check_flag = true
+sample.target
+#=> before_callback
+#=> target
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hotoolong/embed_callbacks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hotoolong/embed_callbacks/blob/main/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EmbedCallbacks project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hotoolong/embed_callbacks/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "embed_callbacks"
+
+# 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(__FILE__)

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/embed_callbacks.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/embed_callbacks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "embed_callbacks"
+  spec.version       = EmbedCallbacks::VERSION
+  spec.authors       = ["hotoolong"]
+  spec.email         = ["hotoolong.hogehoge+github@gmail.com"]
+
+  spec.summary       = %q{Create a method callback.}
+  spec.description   = %q{Whenever you want to add a callback, you can easily incorporate the process.\n }
+  spec.homepage      = "https://github.com/hotoolong/embed_callbacks"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codecov', '>= 0.2.0'
+end

data/lib/embed_callbacks.rb

@@ -0,0 +1,68 @@
+require "embed_callbacks/version"
+
+module EmbedCallbacks
+  def self.included(base)
+    base.extend(PrependMethods)
+  end
+
+  module PrependMethods
+    def set_callback(target_method_name, behavior_sym, callback_function_name, **options)
+      behavior = Behavior.new(behavior_sym)
+      m = Module.new
+      m.define_method(target_method_name) do |*params|
+        condition = Condition.new(options).call(self)
+        begin
+          method(callback_function_name).call if condition && behavior.before?
+          return_value = super(*params)
+          method(callback_function_name).call if condition && behavior.after?
+          return_value
+        rescue => e
+          method(callback_function_name).call if condition && behavior.rescue?
+          raise e
+        ensure
+          method(callback_function_name).call if condition && behavior.ensure?
+        end
+      end
+      prepend m
+    end
+  end
+
+  class Condition
+    def initialize(options)
+      @if = options[:if]
+      @unless = options[:unless]
+      raise ArgumentError, "Don't use if and unless at the same time." if @if && @unless
+    end
+
+    def call(record)
+      return @if.call(record) if @if 
+      return !@unless&.call(record) if @unless
+      true
+    end
+  end
+
+  class Behavior
+    KINDS = %i(before after around rescue ensure)
+
+    def initialize(behavior)
+      @behavior = behavior
+      raise ArgumentError, 'The behavior should be set in the before after around rescue' unless KINDS.include?(behavior)
+    end
+
+    def before?
+      %i(before around).include?(@behavior)
+    end
+
+    def after?
+      %i(after around).include?(@behavior)
+    end
+
+    def rescue?
+      :rescue == @behavior
+    end
+
+    def ensure?
+      :ensure == @behavior
+    end
+  end
+end

data/lib/embed_callbacks/version.rb

@@ -0,0 +1,3 @@
+module EmbedCallbacks
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: embed_callbacks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hotoolong
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: 'Whenever you want to add a callback, you can easily incorporate the
+  process.\n '
+email:
+- hotoolong.hogehoge+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- embed_callbacks.gemspec
+- lib/embed_callbacks.rb
+- lib/embed_callbacks/version.rb
+homepage: https://github.com/hotoolong/embed_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: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Create a method callback.
+test_files: []