edge badge
Namespace
Methods
#
A
B
P
S
Instance Public methods
_insert_callbacks(callbacks, block = nil)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 88
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
_normalize_callback_options(options)

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

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

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 132
      
append_after_action(names, block)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 153
      
append_around_action(names, block)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 181
      
append_before_action(names, block)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 125
      
around_action(names, block)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 160
      
before_action(names, block)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 104
      
prepend_after_action(names, block)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 139
      
prepend_around_action(names, block)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 167
      
prepend_before_action(names, block)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 111
      
skip_action_callback(*names)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 65
def skip_action_callback(*names)
  skip_before_action(*names)
  skip_after_action(*names)
  skip_around_action(*names)
end
skip_after_action(names)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 146
      
skip_around_action(names)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 174
      
skip_before_action(names)

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

# File actionpack/lib/abstract_controller/callbacks.rb, line 118
      
skip_filter(*names)
# File actionpack/lib/abstract_controller/callbacks.rb, line 71
def skip_filter(*names)
  ActiveSupport::Deprecation.warn("#{callback}_filter is deprecated and will removed in Rails 5.1. Use #{callback}_action instead.")
  skip_action_callback(*names)
end