Module: AbstractController::Callbacks::ClassMethods

Defined in:
lib/abstract_controller/callbacks.rb

Instance Method Summary collapse

Instance Method Details

#_insert_callbacks(callbacks, block = nil) ⇒ Object

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


71
72
73
74
75
76
77
78
# File 'lib/abstract_controller/callbacks.rb', line 71

def _insert_callbacks(callbacks, block = nil)
  options = callbacks.last.is_a?(Hash) ? callbacks.pop : {}
  _normalize_callback_options(options)
  callbacks.push(block) if block
  callbacks.each do |callback|
    yield callback, options
  end
end

#_normalize_callback_option(options, from, to) ⇒ Object

:nodoc:


36
37
38
39
40
41
# File 'lib/abstract_controller/callbacks.rb', line 36

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

#_normalize_callback_options(options) ⇒ Object

If :only or :except are used, convert the options into the :unless and :if options of ActiveSupport::Callbacks. The basic idea is that :only => :index gets converted to :if => proc {|c| c.action_name == “index” }.

Options

  • only - The callback should be run only for this action

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


31
32
33
34
# File 'lib/abstract_controller/callbacks.rb', line 31

def _normalize_callback_options(options)
  _normalize_callback_option(options, :only, :if)
  _normalize_callback_option(options, :except, :unless)
end

#skip_action_callback(*names) ⇒ Object Also known as: skip_filter

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

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_filter


51
52
53
54
55
# File 'lib/abstract_controller/callbacks.rb', line 51

def skip_action_callback(*names)
  skip_before_action(*names)
  skip_after_action(*names)
  skip_around_action(*names)
end