module AbstractController::Callbacks::ClassMethods

Public Instance Methods

_insert_callbacks(callbacks, block = nil) { |callback, options| ... } click to toggle source

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 lib/abstract_controller/callbacks.rb, line 91
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) click to toggle source

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 lib/abstract_controller/callbacks.rb, line 66
def _normalize_callback_options(options)
  _normalize_callback_option(options, :only, :if)
  _normalize_callback_option(options, :except, :unless)
end
after_action(names, block) click to toggle source

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

# File lib/abstract_controller/callbacks.rb, line 141
      
append_after_action(names, block) click to toggle source

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

# File lib/abstract_controller/callbacks.rb, line 162
      
append_around_action(names, block) click to toggle source

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

# File lib/abstract_controller/callbacks.rb, line 190
      
append_before_action(names, block) click to toggle source

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

If the callback renders or redirects, the action will not run. If there are additional callbacks scheduled to run after that callback, they are also cancelled.

# File lib/abstract_controller/callbacks.rb, line 130
      
around_action(names, block) click to toggle source

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

# File lib/abstract_controller/callbacks.rb, line 169
      
before_action(names, block) click to toggle source

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

If the callback renders or redirects, the action will not run. If there are additional callbacks scheduled to run after that callback, they are also cancelled.

# File lib/abstract_controller/callbacks.rb, line 101
      
prepend_after_action(names, block) click to toggle source

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

# File lib/abstract_controller/callbacks.rb, line 148
      
prepend_around_action(names, block) click to toggle source

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

# File lib/abstract_controller/callbacks.rb, line 176
      
prepend_before_action(names, block) click to toggle source

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

If the callback renders or redirects, the action will not run. If there are additional callbacks scheduled to run after that callback, they are also cancelled.

# File lib/abstract_controller/callbacks.rb, line 112
      
skip_after_action(names) click to toggle source

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

# File lib/abstract_controller/callbacks.rb, line 155
      
skip_around_action(names) click to toggle source

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

# File lib/abstract_controller/callbacks.rb, line 183
      
skip_before_action(names) click to toggle source

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

# File lib/abstract_controller/callbacks.rb, line 123