1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/actionpack/lib/abstract_controller/callbacks.rb

115 lines
4.5 KiB
Ruby
Raw Normal View History

2009-02-27 18:11:02 -05:00
module AbstractController
module Callbacks
extend ActiveSupport::Concern
# Uses ActiveSupport::Callbacks as the base functionality. For
2009-06-08 19:14:38 -04:00
# more details on the whole callback system, read the documentation
# for ActiveSupport::Callbacks.
include ActiveSupport::Callbacks
included do
define_callbacks :process_action, :terminator => "response_body"
2009-02-27 22:25:45 -05:00
end
2009-06-08 19:14:38 -04:00
# Override AbstractController::Base's process_action to run the
# process_action callbacks around the normal behavior.
def process_action(method_name)
run_callbacks(:process_action, method_name) do
2009-02-27 22:25:45 -05:00
super
end
end
2009-02-27 22:25:45 -05:00
module ClassMethods
# If :only or :except are used, convert the options into the
2009-06-08 19:14:38 -04:00
# primitive form (:per_key) used by ActiveSupport::Callbacks.
# The basic idea is that :only => :index gets converted to
# :if => proc {|c| c.action_name == "index" }, but that the
# proc is only evaluated once per action for the lifetime of
# a Rails process.
#
# ==== 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
2009-02-27 22:25:45 -05:00
def _normalize_callback_options(options)
if only = options[:only]
only = Array(only).map {|o| "action_name == '#{o}'"}.join(" || ")
2009-02-27 22:25:45 -05:00
options[:per_key] = {:if => only}
end
if except = options[:except]
except = Array(except).map {|e| "action_name == '#{e}'"}.join(" || ")
2009-02-27 22:25:45 -05:00
options[:per_key] = {:unless => except}
end
end
2009-06-08 19:14:38 -04:00
# Skip before, after, and around filters matching any of the names
#
# ==== Parameters
# * <tt>names</tt> - A list of valid names that could be used for
2009-06-08 19:14:38 -04:00
# callbacks. Note that skipping uses Ruby equality, so it's
# impossible to skip a callback defined using an anonymous proc
# using #skip_filter
def skip_filter(*names, &blk)
2009-06-08 19:14:38 -04:00
skip_before_filter(*names)
skip_after_filter(*names)
skip_around_filter(*names)
end
2009-06-08 19:14:38 -04:00
# 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
2009-06-08 19:14:38 -04:00
# options hash as the last parameter.
# * <tt>block</tt> - A proc that should be added to the callbacks.
2009-06-08 19:14:38 -04:00
#
# ==== Block Parameters
# * <tt>name</tt> - The callback to be added
# * <tt>options</tt> - A hash of options to be used when adding the callback
2009-06-08 19:14:38 -04:00
def _insert_callbacks(callbacks, block)
options = callbacks.last.is_a?(Hash) ? callbacks.pop : {}
_normalize_callback_options(options)
2009-06-08 19:14:38 -04:00
callbacks.push(block) if block
callbacks.each do |callback|
yield callback, options
end
end
2009-06-08 19:14:38 -04:00
# set up before_filter, prepend_before_filter, skip_before_filter, etc.
# for each of before, after, and around.
2009-02-27 22:25:45 -05:00
[:before, :after, :around].each do |filter|
class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
2009-06-08 19:14:38 -04:00
# Append a before, after or around filter. See _insert_callbacks
# for details on the allowed parameters.
2010-11-11 11:07:06 -05:00
def #{filter}_filter(*names, &blk)
_insert_callbacks(names, blk) do |name, options|
options[:if] = (Array.wrap(options[:if]) << "!halted") if #{filter == :after}
set_callback(:process_action, :#{filter}, name, options)
end
end
2009-06-08 19:14:38 -04:00
# Prepend a before, after or around filter. See _insert_callbacks
# for details on the allowed parameters.
2010-11-11 11:07:06 -05:00
def prepend_#{filter}_filter(*names, &blk)
_insert_callbacks(names, blk) do |name, options|
options[:if] = (Array.wrap(options[:if]) << "!halted") if #{filter == :after}
set_callback(:process_action, :#{filter}, name, options.merge(:prepend => true))
end
end
2009-06-08 19:14:38 -04:00
# Skip a before, after or around filter. See _insert_callbacks
# for details on the allowed parameters.
2010-11-11 11:07:06 -05:00
def skip_#{filter}_filter(*names, &blk)
_insert_callbacks(names, blk) do |name, options|
skip_callback(:process_action, :#{filter}, name, options)
end
end
2009-06-08 19:14:38 -04:00
# *_filter is the same as append_*_filter
alias_method :append_#{filter}_filter, :#{filter}_filter
2009-02-27 22:25:45 -05:00
RUBY_EVAL
end
end
2009-02-27 18:11:02 -05:00
end
end