Module: Filters::ClassMethods

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



75
76
77
78
79
80
81
82
 
# File 'lib/filters.rb', line 75

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_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



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/filters.rb', line 39

def _normalize_callback_options(options)
  if only = options[:only]
    only = Array(only).map {|o| "action_name == '#{o}'"}.join(" || ")
    options[:if] = Array(options[:if]) << only
  end
  if except = options[:except]
    except = Array(except).map {|e| "action_name == '#{e}'"}.join(" || ")
    options[:unless] = Array(options[:unless]) << except
  end
end

#skip_filter(*names) ⇒ Object

Skip before, after, and around filters 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_filter



57
58
59
60
61
 
# File 'lib/filters.rb', line 57

def skip_filter(*names)
  skip_before_filter(*names)
  skip_after_filter(*names)
  skip_around_filter(*names)
end