Class: ActiveAdmin::BatchAction

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/active_admin/batch_actions/resource_extension.rb

Constant Summary collapse

DEFAULT_CONFIRM_MESSAGE =
proc { I18n.t 'active_admin.batch_actions.default_confirmation' }

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sym, title, options = {}, &block) ⇒ BatchAction

Create a Batch Action

Examples:

BatchAction.new :flag

> Will create an action that appears in the action list popover

BatchAction.new(:flag) { |selection| redirect_to collection_path, notice: "#{selection.length} users flagged" }

> Will create an action that uses a block to process the request (which receives one paramater of the selected objects)

BatchAction.new("Perform Long Operation on") { |selection| }

> You can create batch actions with a title instead of a Symbol

BatchAction.new(:flag, if: proc{ can? :flag, AdminUser }) { |selection| }

> You can provide an `:if` proc to choose when the batch action should be displayed

BatchAction.new :flag, confirm: true

> You can pass `true` to `:confirm` to use the default confirm message.

BatchAction.new(:flag, confirm: "Are you sure?") { |selection| }

> You can pass a custom confirmation message through `:confirm`

BatchAction.new(:flag, form: {foo: :text, bar: :checkbox}) { |selection, inputs| }

> You can pass a hash of options to `:form` that will be rendered as form input fields for the user to fill out.


114
115
116
117
118
119
120
121
# File 'lib/active_admin/batch_actions/resource_extension.rb', line 114

def initialize(sym, title, options = {}, &block)
  @sym = sym
  @title = title
  @options = options
  @block = block
  @confirm = options[:confirm]
  @block ||= proc {}
end

Instance Attribute Details

#blockObject (readonly)

Returns the value of attribute block


85
86
87
# File 'lib/active_admin/batch_actions/resource_extension.rb', line 85

def block
  @block
end

#symObject (readonly)

Returns the value of attribute sym


85
86
87
# File 'lib/active_admin/batch_actions/resource_extension.rb', line 85

def sym
  @sym
end

#titleObject (readonly)

Returns the value of attribute title


85
86
87
# File 'lib/active_admin/batch_actions/resource_extension.rb', line 85

def title
  @title
end

Instance Method Details

#<=>(other) ⇒ Object

sort operator


149
150
151
# File 'lib/active_admin/batch_actions/resource_extension.rb', line 149

def <=>(other)
  self.priority <=> other.priority
end

#confirmObject


123
124
125
126
127
128
129
130
131
# File 'lib/active_admin/batch_actions/resource_extension.rb', line 123

def confirm
  if @confirm == true
    DEFAULT_CONFIRM_MESSAGE
  elsif !@confirm && @options[:form]
    DEFAULT_CONFIRM_MESSAGE
  else
    @confirm
  end
end

#display_if_blockObject

Returns the display if block. If the block was not explicitly defined a default block always returning true will be returned.


139
140
141
# File 'lib/active_admin/batch_actions/resource_extension.rb', line 139

def display_if_block
  @options[:if] || proc { true }
end

#inputsObject


133
134
135
# File 'lib/active_admin/batch_actions/resource_extension.rb', line 133

def inputs
  @options[:form]
end

#priorityObject

Used for sorting


144
145
146
# File 'lib/active_admin/batch_actions/resource_extension.rb', line 144

def priority
  @options[:priority] || 10
end