rails_callback_ex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5269dd2ef360d14adf8c32467cb98dd8003b30bd3340e80bed3eb9d32578286b
+  data.tar.gz: bd3271c354a8a8e31cb66e64a3b86b18ae20f9ac39603aa0bc42fde0b86f701f
+SHA512:
+  metadata.gz: 887cfdb740aff824619a0b892ef490bccaa7d0066063bb38a49d8fa7e3c3d3d1b7d7a7f53c6d4f457ce917b8c0d391a5e73080e357b2ee8afa2572475880ab35
+  data.tar.gz: '08dc9532cb2b7fbbb728a4197ec991356258be090078415dd07a5951c22eb94fa38b7790a65e0ab23015d71ac046cc39711b0df31cf72da88944b8e8de28deb3'

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.0', 3.1, 3.2]
+        gemfile: ['rails61', 'rails70', 'rails71']
+
+    name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}, ${{ matrix.database }}
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Prepare test
+      run: |
+        cd spec/dummy
+        BUNDLE_GEMFILE=../../${{ env.BUNDLE_GEMFILE }} RAILS_ENV=test bundle exec rake db:create db:migrate
+        cd ../..
+    - name: Run test
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+Gemfile.lock
+coverage/
+gemfiles/*.lock
+pkg/
+spec/dummy/db/schema*.rb
+spec/dummy/db/*.sqlite3*
+spec/dummy/log/*.log
+spec/dummy/tmp/*
+tmp/

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+* First release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Yoshikazu Kaneta
+
+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,116 @@
+# RailsCallbackEx
+
+Insert/delete callbacks for rails.
+
+## Dependencies
+
+* ruby 3.0+
+* rails 6.1+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_callback_ex'
+```
+
+Then execute:
+
+    $ bundle
+
+## Usage
+
+### Controller
+
+Example:
+
+```ruby
+class SamplesController < ActionController::Base
+  before_action :action1
+  before_action :action2
+
+  insert_before_action :new_action1, before: :action1
+  insert_before_action :new_action2, after: :action1
+end
+
+SamplesController.__callbacks[:process_action].map(&:filter) #=> [:new_action1, :action1, :new_action2, :action2]
+
+SamplesController.delete_before_action :new_action1
+
+SamplesController.__callbacks[:process_action].map(&:filter) #=> [:action1, :new_action2, :action2]
+```
+
+### Model
+
+Example:
+
+```ruby
+class Sample < ActiveRecord::Base
+  before_save :action1
+  before_save :action2
+
+  insert_before_save :new_action1, before: :action1
+  insert_before_save :new_action2, after: :action1
+end
+
+Sample.__callbacks[:save].map(&:filter) #=> [:new_action1, :action1, :new_action2, :action2]
+
+Sample.delete_before_save :new_action1
+
+Sample.__callbacks[:save].map(&:filter) #=> [:action1, :new_action2, :action2]
+```
+
+Supported callbacks are `validation`, `save`, `create`, `update` and `destroy`.
+
+### Job
+
+Example:
+
+```ruby
+class SampleJob < ActiveJob::Base
+  before_perform :action1
+  before_perform :action2
+
+  insert_before_perform :new_action1, before: :action1
+  insert_before_perform :new_action2, after: :action1
+end
+
+SampleJob.__callbacks[:perform].map(&:filter) #=> [:new_action1, :action1, :new_action2, :action2]
+
+SampleJob.delete_before_perform :new_action1
+
+SampleJob.__callbacks[:perform].map(&:filter) #=> [:action1, :new_action2, :action2]
+```
+
+Supported callbacks are `enqueue` and `perform`.
+
+### Mailer
+
+Example:
+
+```ruby
+class SampleMailer < ActionMailer::Base
+  before_deliver :action1
+  before_deliver :action2
+
+  insert_before_deliver :new_action1, before: :action1
+  insert_before_deliver :new_action2, after: :action1
+end
+
+SampleMailer.__callbacks[:deliver].map(&:filter) #=> [:new_action1, :action1, :new_action2, :action2]
+
+SampleMailer.delete_before_deliver :new_action1
+
+SampleMailer.__callbacks[:deliver].map(&:filter) #=> [:action1, :new_action2, :action2]
+```
+
+Supported callback is `deliver`. Note that `deliver` callbacks can be used on rails >= 7.1.
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/kanety/rails_callback_ex.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/gemfiles/rails61.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/rails70.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 7.0.1"
+
+gemspec path: "../"

data/gemfiles/rails71.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 7.1.0"
+
+gemspec path: "../"

data/lib/rails_callback_ex/controller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsCallbackEx
+  module Controller
+    extend ActiveSupport::Concern
+
+    class_methods do
+      [:before, :after, :around].each do |callback|
+        define_method "insert_#{callback}_action" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            insert_callback(:process_action, callback, name, options)
+          end
+        end
+
+        define_method "delete_#{callback}_action" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            delete_callback(:process_action, callback, name, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_callback_ex/job.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RailsCallbackEx
+  module Job
+    extend ActiveSupport::Concern
+
+    class_methods do
+      [:perform, :enqueue].each do |kind|
+        [:before, :after, :around].each do |callback|
+          define_method "insert_#{callback}_#{kind}" do |*filters, **options, &blk|
+            insert_callback(kind, callback, *filters, **options, &blk)
+          end
+
+          define_method "delete_#{callback}_#{kind}" do |*filters, **options, &blk|
+            delete_callback(kind, callback, *filters, **options, &blk)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_callback_ex/mailer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RailsCallbackEx
+  module Mailer
+    extend ActiveSupport::Concern
+
+    class_methods do
+      [:deliver].each do |kind|
+        [:before, :after, :around].each do |callback|
+          define_method "insert_#{callback}_#{kind}" do |*filters, **options, &blk|
+            insert_callback(kind, callback, *filters, **options, &blk)
+          end
+
+          define_method "delete_#{callback}_#{kind}" do |*filters, **options, &blk|
+            delete_callback(kind, callback, *filters, **options, &blk)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_callback_ex/model/callbacks.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RailsCallbackEx
+  module Model
+    module Callbacks
+      extend ActiveSupport::Concern
+
+      def define_insert_model_callbacks(*callbacks)
+        options = callbacks.extract_options!
+        options = {
+          skip_after_callbacks_if_terminated: true,
+          scope: [:kind, :name],
+          only: [:before, :around, :after]
+        }.merge!(options)
+
+        types = Array(options.delete(:only))
+
+        callbacks.each do |callback|
+          types.each do |type|
+            define_singleton_method("insert_#{type}_#{callback}") do |*args, **options, &block|
+              options.assert_valid_keys(:if, :unless, :prepend, :before, :after)
+              options[:prepend] = true if type == :after
+              insert_callback(:"#{callback}", type, *args, options, &block)
+            end
+          end
+        end
+      end
+
+      def define_delete_model_callbacks(*callbacks)
+        options = callbacks.extract_options!
+        options = {
+          scope: [:kind, :name],
+          only: [:before, :around, :after]
+        }.merge!(options)
+
+        types = Array(options.delete(:only))
+
+        callbacks.each do |callback|
+          types.each do |type|
+            define_singleton_method("delete_#{type}_#{callback}") do |*args, **options, &block|
+              options.assert_valid_keys(:if, :unless, :prepend)
+              delete_callback(:"#{callback}", type, *args, options, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_callback_ex/model/validations.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RailsCallbackEx
+  module Model
+    module Validations
+      extend ActiveSupport::Concern
+
+      included do
+        [:before, :after].each do |kind|
+          define_method "insert_#{kind}_validation" do |*args, &block|
+            options = args.extract_options!
+            set_options_for_callback(options)
+            options[:prepend] = true if kind == :after
+            insert_callback(:validation, kind, *args, options, &block)
+          end
+
+          define_method "delete_#{kind}_validation" do |*args, &block|
+            options = args.extract_options!
+            set_options_for_callback(options)
+            delete_callback(:validation, kind, *args, options, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_callback_ex/railtie.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RailsCallbackEx
+  class Railtie < Rails::Railtie
+    ActiveSupport.on_load :action_controller do
+      require_relative 'controller'
+      ActionController::Base.include RailsCallbackEx::Controller
+    end
+
+    ActiveSupport.on_load :active_record do
+      require_relative 'model/callbacks'
+      require_relative 'model/validations'
+      ActiveModel::Callbacks.include RailsCallbackEx::Model::Callbacks
+      ActiveModel::Validations::Callbacks::ClassMethods.include RailsCallbackEx::Model::Validations
+      require_relative 'record'
+      ActiveRecord::Base.include RailsCallbackEx::Record
+    end
+
+    ActiveSupport.on_load :active_job do
+      require_relative 'job'
+      ActiveJob::Base.include RailsCallbackEx::Job
+    end
+
+    ActiveSupport.on_load :action_mailer do
+      require_relative 'controller'
+      require_relative 'mailer'
+      ActionMailer::Base.include RailsCallbackEx::Controller
+      ActionMailer::Base.include RailsCallbackEx::Mailer if Rails::VERSION::STRING.to_f >= 7.1
+    end
+  end
+end

data/lib/rails_callback_ex/record.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RailsCallbackEx
+  module Record
+    extend ActiveSupport::Concern
+
+    included do
+      define_insert_model_callbacks :save, :create, :update, :destroy
+      define_delete_model_callbacks :save, :create, :update, :destroy
+    end
+  end
+end

data/lib/rails_callback_ex/support.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ActiveSupport
+  module Callbacks
+    module ClassMethods
+      def insert_callback(name, *filter_list, &block)
+        type, filters, options = normalize_callback_params(filter_list, block)
+
+        self_chain = get_callbacks name
+        mapped = filters.map do |filter|
+          Callback.build(self_chain, filter, type, options)
+        end
+
+        __update_callbacks(name) do |target, chain|
+          RailsCallbackEx::Support.insert(chain, type, mapped, options)
+          target.set_callbacks name, chain
+        end
+      end
+
+      def delete_callback(name, *filter_list, &block)
+        type, filters, options = normalize_callback_params(filter_list, block)
+
+        __update_callbacks(name) do |target, chain|
+          RailsCallbackEx::Support.delete(chain, type, filters, options)
+          target.set_callbacks name, chain
+        end
+      end
+    end
+  end
+end
+
+module RailsCallbackEx
+  module Support
+    class << self
+      def insert(chain, type, mapped, options)
+        unless (position = options[:before] || options[:after])
+          raise ArgumentError.new("Specify callback using :before or :after")
+        end
+
+        if (cb = chain.find { |c| c.matches?(type, position) }) && (index = chain.index(cb))
+          index += 1 if (options[:before] && options[:prepend]) || (options[:after] && !options[:prepend])
+          mapped.each { |c| chain.insert(index, c) }
+        else
+          raise ArgumentError.new("Couldn't find callback: #{position}")
+        end
+      end
+
+      def delete(chain, type, filters, options)
+        filters.each do |filter|
+          if (cb = chain.find { |c| c.matches?(type, filter) })
+            chain.delete(cb)
+          else
+            raise ArgumentError.new("Couldn't find callback: #{filter}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_callback_ex/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsCallbackEx
+  VERSION = '0.1.0'
+end

data/lib/rails_callback_ex.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+require_relative 'rails_callback_ex/version'
+require_relative 'rails_callback_ex/support'
+require_relative 'rails_callback_ex/railtie' if defined?(Rails)

data/rails_callback_ex.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_callback_ex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_callback_ex"
+  spec.version       = RailsCallbackEx::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  spec.email         = ["kaneta@sitebridge.co.jp"]
+  spec.summary       = %q{Insert/delete callbacks for rails.}
+  spec.description   = %q{Insert/delete callbacks for rails.}
+  spec.homepage      = "https://github.com/kanety/rails_callback_ex"
+
+  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_dependency "rails", ">= 6.1"
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rails_callback_ex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec-rails
+  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: 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'
+description: Insert/delete callbacks for rails.
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gemfiles/rails61.gemfile
+- gemfiles/rails70.gemfile
+- gemfiles/rails71.gemfile
+- lib/rails_callback_ex.rb
+- lib/rails_callback_ex/controller.rb
+- lib/rails_callback_ex/job.rb
+- lib/rails_callback_ex/mailer.rb
+- lib/rails_callback_ex/model/callbacks.rb
+- lib/rails_callback_ex/model/validations.rb
+- lib/rails_callback_ex/railtie.rb
+- lib/rails_callback_ex/record.rb
+- lib/rails_callback_ex/support.rb
+- lib/rails_callback_ex/version.rb
+- rails_callback_ex.gemspec
+homepage: https://github.com/kanety/rails_callback_ex
+licenses: []
+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: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Insert/delete callbacks for rails.
+test_files: []