module AbstractController::Callbacks::ClassMethods

Public Instance Methods

_insert_callbacks(callbacks, block = nil) { |callback, options| ... } Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 90
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

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

callbacks - An array of callbacks, with an optional options hash as the last parameter.
block - A proc that should be added to the callbacks.

Block Parameters

name - The callback to be added.
options - A hash of options to be used when adding the callback.

_normalize_callback_options(options) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 44
def _normalize_callback_options(options)
  _normalize_callback_option(options, :only, :if)
  _normalize_callback_option(options, :except, :unless)
end

If :only or :except are used, convert the options into the :if and :unless options of ActiveSupport::Callbacks.

The basic idea is that :only => :index gets converted to :if => proc {|c| c.action_name == "index" }.

Note that :only has priority over :if in case they are used together.

only: :index, if: -> { true } # the :if option will be ignored.

Note that :if has priority over :except in case they are used together.

except: :index, if: -> { true } # the :except option will be ignored.

Options

only - The callback should be run only for this action.
except - The callback should be run for all actions except this action.

after_action(names, block) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 134

Append a callback after actions. See #_insert_callbacks for parameter details.

append_after_action(names, block) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 155

Append a callback after actions. See #_insert_callbacks for parameter details.

append_around_action(names, block) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 183

Append a callback around actions. See #_insert_callbacks for parameter details.

append_before_action(names, block) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 127

Append a callback before actions. See #_insert_callbacks for parameter details.

around_action(names, block) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 162

Append a callback around actions. See #_insert_callbacks for parameter details.

before_action(names, block) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 106

Append a callback before actions. See #_insert_callbacks for parameter details.

prepend_after_action(names, block) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 141

Prepend a callback after actions. See #_insert_callbacks for parameter details.

prepend_around_action(names, block) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 169

Prepend a callback around actions. See #_insert_callbacks for parameter details.

prepend_before_action(names, block) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 113

Prepend a callback before actions. See #_insert_callbacks for parameter details.

skip_action_callback(*names) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 64
def skip_action_callback(*names)
  ActiveSupport::Deprecation.warn('`skip_action_callback` is deprecated and will be removed in Rails 5.1. 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

Skip before, after, and around action callbacks matching any of the names.

Parameters

names - 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.

skip_after_action(names) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 148

Skip a callback after actions. See #_insert_callbacks for parameter details.

skip_around_action(names) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 176

Skip a callback around actions. See #_insert_callbacks for parameter details.

skip_before_action(names) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 120

Skip a callback before actions. See #_insert_callbacks for parameter details.

skip_filter(*names) Show source

# File actionpack/lib/abstract_controller/callbacks.rb, line 71
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_before_action(*names, raise: false)
  skip_after_action(*names, raise: false)
  skip_around_action(*names, raise: false)
end