Module: Critic::Callbacks::ClassMethods

Defined in:
lib/critic/callbacks.rb

Overview

Adds callback management functions to Policy

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



92
93
94
95
96
97
98
99
 
# File 'lib/critic/callbacks.rb', line 92

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:



59
60
61
62
63
64
65
 
# File 'lib/critic/callbacks.rb', line 59

def _normalize_callback_option(options, from, to) # :nodoc:
  from = options[from]
  return unless from

  from = Array(from).map { |o| "authorization.action.to_s == '#{o}'" }
  options[to] = Array(options[to]).unshift(from).join(' || ')
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



54
55
56
57
 
# File 'lib/critic/callbacks.rb', line 54

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

#after_authorize(*names, &blk) ⇒ Object 



28
29
30
31
32
 
# File 'lib/critic/callbacks.rb', line 28

def after_authorize(*names, &blk)
  _insert_callbacks(names, blk) do |name, options|
    set_callback(:authorize, :after, name, options)
  end
end

#around_authorize(*names, &blk) ⇒ Object 



34
35
36
37
38
 
# File 'lib/critic/callbacks.rb', line 34

def around_authorize(*names, &blk)
  _insert_callbacks(names, blk) do |name, options|
    set_callback(:authorize, :around, name, options)
  end
end

#before_authorize(*names, &blk) ⇒ Object 



22
23
24
25
26
 
# File 'lib/critic/callbacks.rb', line 22

def before_authorize(*names, &blk)
  _insert_callbacks(names, blk) do |name, options|
    set_callback(:authorize, :before, name, options)
  end
end

#skip_authorize(*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



74
75
76
77
78
 
# File 'lib/critic/callbacks.rb', line 74

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

#skip_before_authorize(*names, &blk) ⇒ Object 



40
41
42
43
44
 
# File 'lib/critic/callbacks.rb', line 40

def skip_before_authorize(*names, &blk)
  _insert_callbacks(names, blk) do |name, options|
    skip_callback(:authorize, :before, name, options)
  end
end