Module: AbstractController::Callbacks::ClassMethods

Defined in:
actionpack/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.


90
91
92
93
94
95
96
97
# 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

#_normalize_callback_option(options, from, to) ⇒ Object

:nodoc:


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

def _normalize_callback_option(options, from, to) # :nodoc:
  if from = options[from]
    _from = Array(from).map(&:to_s).to_set
    from = proc {|c| _from.include? c.action_name }
    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 :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.


44
45
46
47
# 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

#skip_action_callback(*names) ⇒ Object

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.


64
65
66
67
68
69
# 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_filter(*names) ⇒ Object


71
72
73
74
75
76
# 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