d2876141d0
At present, if you skip a callback that hasn't been defined, activesupport callbacks silently does nothing. However, it's easy to mistype the name of a callback and mistakenly think that it's being skipped, when it is not. This problem even exists in the current test suite. CallbacksTest::SkipCallbacksTest#test_skip_person attempts to skip callbacks that were never set up. This PR changes `skip_callback` to raise an `ArgumentError` if the specified callback cannot be found.
229 lines
8.5 KiB
Ruby
229 lines
8.5 KiB
Ruby
module AbstractController
|
|
module Callbacks
|
|
extend ActiveSupport::Concern
|
|
|
|
# Uses ActiveSupport::Callbacks as the base functionality. For
|
|
# more details on the whole callback system, read the documentation
|
|
# for ActiveSupport::Callbacks.
|
|
include ActiveSupport::Callbacks
|
|
|
|
included do
|
|
define_callbacks :process_action,
|
|
terminator: ->(controller, result_lambda) { result_lambda.call if result_lambda.is_a?(Proc); controller.response_body },
|
|
skip_after_callbacks_if_terminated: true
|
|
end
|
|
|
|
# Override AbstractController::Base's process_action to run the
|
|
# process_action callbacks around the normal behavior.
|
|
def process_action(*args)
|
|
run_callbacks(:process_action) do
|
|
super
|
|
end
|
|
end
|
|
|
|
module ClassMethods
|
|
# If +:only+ or +:except+ are used, convert the options into the
|
|
# +:if+ and +:unless+ options of ActiveSupport::Callbacks.
|
|
#
|
|
# The basic idea is that <tt>:only => :index</tt> gets converted to
|
|
# <tt>:if => proc {|c| c.action_name == "index" }</tt>.
|
|
#
|
|
# Note that <tt>:only</tt> has priority over <tt>:if</tt> in case they
|
|
# are used together.
|
|
#
|
|
# only: :index, if: -> { true } # the :if option will be ignored.
|
|
#
|
|
# Note that <tt>:if</tt> has priority over <tt>:except</tt> in case they
|
|
# are used together.
|
|
#
|
|
# except: :index, if: -> { true } # the :except option will be ignored.
|
|
#
|
|
# ==== Options
|
|
# * <tt>only</tt> - The callback should be run only for this action
|
|
# * <tt>except</tt> - The callback should be run for all actions except this action
|
|
def _normalize_callback_options(options)
|
|
_normalize_callback_option(options, :only, :if)
|
|
_normalize_callback_option(options, :except, :unless)
|
|
end
|
|
|
|
def _normalize_callback_option(options, from, to) # :nodoc:
|
|
if from = options[from]
|
|
from = Array(from).map {|o| "action_name == '#{o}'"}.join(" || ")
|
|
options[to] = Array(options[to]).unshift(from)
|
|
end
|
|
end
|
|
|
|
# Skip before, after, and around action callbacks matching any of the names.
|
|
#
|
|
# ==== Parameters
|
|
# * <tt>names</tt> - A list of valid names that could be used for
|
|
# callbacks. Note that skipping uses Ruby equality, so it's
|
|
# impossible to skip a callback defined using an anonymous proc
|
|
# using #skip_action_callback
|
|
def skip_action_callback(*names)
|
|
ActiveSupport::Deprecation.warn('`skip_action_callback` is deprecated and will be removed in the next major version of Rails. Please use skip_before_action, skip_after_action or skip_around_action instead.')
|
|
skip_before_action(*names, raise: false)
|
|
skip_after_action(*names, raise: false)
|
|
skip_around_action(*names, raise: false)
|
|
end
|
|
|
|
def skip_filter(*names)
|
|
ActiveSupport::Deprecation.warn("`skip_filter` is deprecated and will be removed in Rails 5.1. Use skip_before_action, skip_after_action or skip_around_action instead.")
|
|
skip_action_callback(*names)
|
|
end
|
|
|
|
# Take callback names and an optional callback proc, normalize them,
|
|
# then call the block with each callback. This allows us to abstract
|
|
# the normalization across several methods that use it.
|
|
#
|
|
# ==== Parameters
|
|
# * <tt>callbacks</tt> - An array of callbacks, with an optional
|
|
# options hash as the last parameter.
|
|
# * <tt>block</tt> - A proc that should be added to the callbacks.
|
|
#
|
|
# ==== Block Parameters
|
|
# * <tt>name</tt> - The callback to be added
|
|
# * <tt>options</tt> - A hash of options to be used when adding the callback
|
|
def _insert_callbacks(callbacks, block = nil)
|
|
options = callbacks.extract_options!
|
|
_normalize_callback_options(options)
|
|
callbacks.push(block) if block
|
|
callbacks.each do |callback|
|
|
yield callback, options
|
|
end
|
|
end
|
|
|
|
##
|
|
# :method: before_action
|
|
#
|
|
# :call-seq: before_action(names, block)
|
|
#
|
|
# Append a callback before actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: prepend_before_action
|
|
#
|
|
# :call-seq: prepend_before_action(names, block)
|
|
#
|
|
# Prepend a callback before actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: skip_before_action
|
|
#
|
|
# :call-seq: skip_before_action(names)
|
|
#
|
|
# Skip a callback before actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: append_before_action
|
|
#
|
|
# :call-seq: append_before_action(names, block)
|
|
#
|
|
# Append a callback before actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: after_action
|
|
#
|
|
# :call-seq: after_action(names, block)
|
|
#
|
|
# Append a callback after actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: prepend_after_action
|
|
#
|
|
# :call-seq: prepend_after_action(names, block)
|
|
#
|
|
# Prepend a callback after actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: skip_after_action
|
|
#
|
|
# :call-seq: skip_after_action(names)
|
|
#
|
|
# Skip a callback after actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: append_after_action
|
|
#
|
|
# :call-seq: append_after_action(names, block)
|
|
#
|
|
# Append a callback after actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: around_action
|
|
#
|
|
# :call-seq: around_action(names, block)
|
|
#
|
|
# Append a callback around actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: prepend_around_action
|
|
#
|
|
# :call-seq: prepend_around_action(names, block)
|
|
#
|
|
# Prepend a callback around actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: skip_around_action
|
|
#
|
|
# :call-seq: skip_around_action(names)
|
|
#
|
|
# Skip a callback around actions. See _insert_callbacks for parameter details.
|
|
|
|
##
|
|
# :method: append_around_action
|
|
#
|
|
# :call-seq: append_around_action(names, block)
|
|
#
|
|
# Append a callback around actions. See _insert_callbacks for parameter details.
|
|
|
|
# set up before_action, prepend_before_action, skip_before_action, etc.
|
|
# for each of before, after, and around.
|
|
[:before, :after, :around].each do |callback|
|
|
define_method "#{callback}_action" do |*names, &blk|
|
|
_insert_callbacks(names, blk) do |name, options|
|
|
set_callback(:process_action, callback, name, options)
|
|
end
|
|
end
|
|
|
|
define_method "#{callback}_filter" do |*names, &blk|
|
|
ActiveSupport::Deprecation.warn("#{callback}_filter is deprecated and will be removed in Rails 5.1. Use #{callback}_action instead.")
|
|
send("#{callback}_action", *names, &blk)
|
|
end
|
|
|
|
define_method "prepend_#{callback}_action" do |*names, &blk|
|
|
_insert_callbacks(names, blk) do |name, options|
|
|
set_callback(:process_action, callback, name, options.merge(:prepend => true))
|
|
end
|
|
end
|
|
|
|
define_method "prepend_#{callback}_filter" do |*names, &blk|
|
|
ActiveSupport::Deprecation.warn("prepend_#{callback}_filter is deprecated and will be removed in Rails 5.1. Use prepend_#{callback}_action instead.")
|
|
send("prepend_#{callback}_action", *names, &blk)
|
|
end
|
|
|
|
# Skip a before, after or around callback. See _insert_callbacks
|
|
# for details on the allowed parameters.
|
|
define_method "skip_#{callback}_action" do |*names|
|
|
_insert_callbacks(names) do |name, options|
|
|
skip_callback(:process_action, callback, name, options)
|
|
end
|
|
end
|
|
|
|
define_method "skip_#{callback}_filter" do |*names, &blk|
|
|
ActiveSupport::Deprecation.warn("skip_#{callback}_filter is deprecated and will be removed in Rails 5.1. Use skip_#{callback}_action instead.")
|
|
send("skip_#{callback}_action", *names, &blk)
|
|
end
|
|
|
|
# *_action is the same as append_*_action
|
|
alias_method :"append_#{callback}_action", :"#{callback}_action"
|
|
|
|
define_method "append_#{callback}_filter" do |*names, &blk|
|
|
ActiveSupport::Deprecation.warn("append_#{callback}_filter is deprecated and will be removed in Rails 5.1. Use append_#{callback}_action instead.")
|
|
send("append_#{callback}_action", *names, &blk)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|