Class: Avo::BaseAction

Inherits:
Object
  • Object
show all
Includes:
Concerns::HasActionStimulusControllers, Concerns::HasItems, Concerns::Hydration
Defined in:
lib/avo/base_action.rb

Direct Known Subclasses

Divider

Constant Summary collapse

DATA_ATTRIBUTES = 
{turbo_frame: Avo::MODAL_FRAME_ID}

Instance Attribute Summary collapse

Attributes included from Concerns::HasItems

#items_holder

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Concerns::Hydration

#hydrate

Methods included from Concerns::HasActionStimulusControllers

#get_stimulus_controllers

Methods included from Concerns::HasItems

#get_field, #get_field_definitions, #get_fields, #get_items, #get_preview_fields, #invalid_fields, #is_empty?, #items, #only_fields, #tab_groups, #visible_items

Constructor Details

#initialize(record: nil, resource: nil, user: nil, view: nil, arguments: {}, icon: :play, query: nil, index_query: nil) ⇒ BaseAction

Returns a new instance of BaseAction.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/avo/base_action.rb', line 118

def initialize(record: nil, resource: nil, user: nil, view: nil, arguments: {}, icon: :play, query: nil, index_query: nil)
  @record = record
  @resource = resource
  @user = user
  @view = Avo::ViewInquirer.new(view)
  @icon = icon
  @arguments = Avo::ExecutionContext.new(
    target: arguments,
    resource: resource,
    record: record
  ).handle.with_indifferent_access
  @query = query
  @index_query = index_query
  self.class.message ||= I18n.t("avo.are_you_sure_you_want_to_run_this_option")
  self.class.confirm_button_label ||= I18n.t("avo.run")
  self.class.cancel_button_label ||= I18n.t("avo.cancel")

  self.items_holder = Avo::Resources::Items::Holder.new

  @response ||= {}
  @response[:messages] = []

  if may_download_file.present?
    puts "[Avo->] WARNING! Since version 3.2.2 'may_download_file' is unecessary and deprecated on actions. Can be safely removed from #{self.class.name}"
  end
end

Instance Attribute Details

#appended_turbo_streams ⇒ Object (readonly)

Returns the value of attribute appended_turbo_streams.



34
35
36
 
# File 'lib/avo/base_action.rb', line 34

def appended_turbo_streams
  @appended_turbo_streams
end

#arguments ⇒ Object (readonly)

Returns the value of attribute arguments.



32
33
34
 
# File 'lib/avo/base_action.rb', line 32

def arguments
  @arguments
end

#icon ⇒ Object (readonly)

Returns the value of attribute icon.



33
34
35
 
# File 'lib/avo/base_action.rb', line 33

def icon
  @icon
end

#query ⇒ Object (readonly)

Returns the value of attribute query.



36
37
38
 
# File 'lib/avo/base_action.rb', line 36

def query
  @query
end

#record ⇒ Object

Returns the value of attribute record.



29
30
31
 
# File 'lib/avo/base_action.rb', line 29

def record
  @record
end

#records_to_reload ⇒ Object (readonly)

Returns the value of attribute records_to_reload.



35
36
37
 
# File 'lib/avo/base_action.rb', line 35

def records_to_reload
  @records_to_reload
end

#resource ⇒ Object

Returns the value of attribute resource.



30
31
32
 
# File 'lib/avo/base_action.rb', line 30

def resource
  @resource
end

#response ⇒ Object

Returns the value of attribute response.



28
29
30
 
# File 'lib/avo/base_action.rb', line 28

def response
  @response
end

#user ⇒ Object

Returns the value of attribute user.



31
32
33
 
# File 'lib/avo/base_action.rb', line 31

def user
  @user
end

#view ⇒ Object

Returns the value of attribute view.



27
28
29
 
# File 'lib/avo/base_action.rb', line 27

def view
  @view
end

Class Method Details

.decode_arguments(arguments) ⇒ Object 



93
94
95
96
97
98
99
100
 
# File 'lib/avo/base_action.rb', line 93

def decode_arguments(arguments)
  return if arguments.blank?

  Avo::Services::EncryptionService.decrypt(
    message: Base64.decode64(arguments),
    purpose: :action_arguments
  )
end

.encode_arguments(arguments) ⇒ Object

Encrypt the arguments so we can pass sensible data as a query param. EncryptionService can generate special characters that can break the URL. We use Base64 to encode the encrypted string so we can safely pass it as a query param and don’t break the URL.



84
85
86
87
88
89
90
91
 
# File 'lib/avo/base_action.rb', line 84

def encode_arguments(arguments)
  return if arguments.blank?

  Base64.encode64 Avo::Services::EncryptionService.encrypt(
    message: arguments,
    purpose: :action_arguments
  )
end

.form_data_attributes ⇒ Object 



53
54
55
56
57
58
 
# File 'lib/avo/base_action.rb', line 53

def form_data_attributes
  {
    turbo: turbo,
    turbo_frame: :_top
  }.compact
end

.link_arguments(resource:, arguments: {}, **args) ⇒ Object 



77
78
79
 
# File 'lib/avo/base_action.rb', line 77

def link_arguments(resource:, arguments: {}, **args)
  [path(resource:, arguments:, **args), DATA_ATTRIBUTES]
end

.path(resource:, arguments: {}, **args) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/avo/base_action.rb', line 64

def path(resource:, arguments: {}, **args)
  Avo::Services::URIService.parse(resource.record&.persisted? ? resource.record_path : resource.records_path)
    .append_paths("actions")
    .append_query(
      **{
        action_id: to_param,
        arguments: encode_arguments(arguments),
        **args
      }.compact
    )
    .to_s
end

.to_param ⇒ Object 



60
61
62
 
# File 'lib/avo/base_action.rb', line 60

def to_param
  to_s
end

Instance Method Details

#action_name ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/avo/base_action.rb', line 103

def action_name
  if name.present?
    return Avo::ExecutionContext.new(
      target: name,
      resource: @resource,
      record: @record,
      view: @view,
      arguments: @arguments,
      query: @query
    ).handle
  end

  self.class.to_s.demodulize.underscore.humanize(keep_id_suffix: true)
end

#append_to_response(turbo_stream) ⇒ Object 



361
362
363
 
# File 'lib/avo/base_action.rb', line 361

def append_to_response(turbo_stream)
  @appended_turbo_streams = turbo_stream
end

#authorized? ⇒ Boolean

Returns:

  • (Boolean) 


351
352
353
354
355
356
357
358
359
 
# File 'lib/avo/base_action.rb', line 351

def authorized?
  Avo::ExecutionContext.new(
    target: authorize,
    action: self,
    resource: @resource,
    view: @view,
    arguments: arguments
  ).handle
end

#cancel_button_label ⇒ Object 



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/avo/base_action.rb', line 160

def cancel_button_label
  Avo::ExecutionContext.new(
    target: self.class.cancel_button_label,
    resource: @resource,
    record: @record,
    view: @view,
    arguments: @arguments,
    query: @query
  ).handle
end

#close_modal ⇒ Object Also known as: do_nothing 



260
261
262
263
264
 
# File 'lib/avo/base_action.rb', line 260

def close_modal
  response[:type] = :close_modal

  self
end

#confirm_button_label ⇒ Object 



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/avo/base_action.rb', line 171

def confirm_button_label
  Avo::ExecutionContext.new(
    target: self.class.confirm_button_label,
    resource: @resource,
    record: @record,
    view: @view,
    arguments: @arguments,
    query: @query
  ).handle
end

#current_user ⇒ Object 



40
41
42
 
# File 'lib/avo/base_action.rb', line 40

def current_user
  Avo::Current.user
end

#disabled? ⇒ Boolean

Returns:

  • (Boolean) 


369
370
371
 
# File 'lib/avo/base_action.rb', line 369

def disabled?
  !enabled?
end

#download(path, filename) ⇒ Object 



343
344
345
346
347
348
349
 
# File 'lib/avo/base_action.rb', line 343

def download(path, filename)
  response[:type] = :download
  response[:path] = path
  response[:filename] = filename

  self
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


365
366
367
 
# File 'lib/avo/base_action.rb', line 365

def enabled?
  self.class.standalone || @record&.persisted?
end

#error(text) ⇒ Object 



236
237
238
239
240
 
# File 'lib/avo/base_action.rb', line 236

def error(text)
  add_message text, :error

  self
end

#fields ⇒ Object

Blank method



146
147
 
# File 'lib/avo/base_action.rb', line 146

def fields
end

#get_message ⇒ Object 



149
150
151
152
153
154
155
156
157
158
 
# File 'lib/avo/base_action.rb', line 149

def get_message
  Avo::ExecutionContext.new(
    target: self.class.message,
    resource: @resource,
    record: @record,
    view: @view,
    arguments: @arguments,
    query: @query
  ).handle
end

#handle_action(**args) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/avo/base_action.rb', line 182

def handle_action(**args)
  processed_fields = if args[:fields].present?
    # Fetching the field definitions and not the actual fields (get_fields) because they will break if the user uses a `visible` block and adds a condition using the `params` variable. The params are different in the show method and the handle method.
    action_fields = get_field_definitions.map do |field|
      field.hydrate(resource: @resource)

      [field.id, field]
    end.to_h

    # For some fields, like belongs_to, the id and database_id differ (user vs user_id).
    # That's why we need to fetch the database_id for when we process the action.
    action_fields_by_database_id = action_fields.map do |id, value|
      [value.database_id.to_sym, value]
    end.to_h

    args[:fields].to_unsafe_h.map do |name, value|
      field = action_fields_by_database_id[name.to_sym]

      next if field.blank?

      [name, field.resolve_attribute(value)]
    end.reject(&:blank?).to_h
  else
    {}
  end

  handle(
    fields: processed_fields.with_indifferent_access,
    current_user: args[:current_user],
    resource: args[:resource],
    records: args[:query],
    query: args[:query]
  )

  self
end

#inform(text) ⇒ Object 



242
243
244
245
246
 
# File 'lib/avo/base_action.rb', line 242

def inform(text)
  add_message text, :info

  self
end

#keep_modal_open ⇒ Object 



254
255
256
257
258
 
# File 'lib/avo/base_action.rb', line 254

def keep_modal_open
  response[:type] = :keep_modal_open

  self
end

#navigate_to_action(action, **kwargs) ⇒ Object 



335
336
337
338
339
340
341
 
# File 'lib/avo/base_action.rb', line 335

def navigate_to_action(action, **kwargs)
  response[:type] = :navigate_to_action
  response[:action] = action
  response[:navigate_to_action_args] = kwargs

  self
end

#no_confirmation? ⇒ Boolean

Returns:

  • (Boolean) 


373
374
375
376
377
378
379
380
381
 
# File 'lib/avo/base_action.rb', line 373

def no_confirmation?
  Avo::ExecutionContext.new(
    target: no_confirmation,
    action: self,
    resource: @resource,
    view: @view,
    arguments:
  ).handle
end

#redirect_to(path = nil, **args, &block) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/avo/base_action.rb', line 276

def redirect_to(path = nil, **args, &block)
  response[:type] = :redirect
  response[:redirect_args] = args
  response[:path] = if block.present?
    block
  else
    path
  end

  self
end

#reload ⇒ Object 



288
289
290
291
292
 
# File 'lib/avo/base_action.rb', line 288

def reload
  response[:type] = :reload

  self
end

#reload_record(records) ⇒ Object Also known as: reload_records 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/avo/base_action.rb', line 294

def reload_record(records)
  # Force close modal to avoid default redirect to
  # Redirect is 100% not wanted when using reload_record
  close_modal

  @records_to_reload = Array(records)

  append_to_response -> {
    table_row_components = []
    header_fields = []

    @action.records_to_reload.each do |record|
      resource = @resource.dup
      resource.hydrate(record:, view: :index)
      resource.detect_fields
      row_fields = resource.get_fields(only_root: true)
      header_fields.concat row_fields
      table_row_components << resource.resolve_component(Avo::Index::TableRowComponent).new(
        resource: resource,
        header_fields: row_fields.map(&:table_header_label),
        fields: row_fields
      )
    end

    header_fields.uniq!(&:table_header_label)

    header_fields_ids = header_fields.map(&:table_header_label)

    table_row_components.map.with_index do |table_row_component, index|
      table_row_component.header_fields = header_fields_ids
      turbo_stream.replace(
        "avo/index/table_row_component_#{@action.records_to_reload[index].to_param}",
        table_row_component
      )
    end
  }
end

#silent ⇒ Object

Add a placeholder silent message from when a user wants to do a redirect action or something similar



270
271
272
273
274
 
# File 'lib/avo/base_action.rb', line 270

def silent
  add_message nil, :silent

  self
end

#succeed(text) ⇒ Object 



230
231
232
233
234
 
# File 'lib/avo/base_action.rb', line 230

def succeed(text)
  add_message text, :success

  self
end

#visible_in_view(parent_resource: nil) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/avo/base_action.rb', line 219

def visible_in_view(parent_resource: nil)
  Avo::ExecutionContext.new(
    target: visible,
    params: params,
    parent_resource: parent_resource,
    resource: @resource,
    view: @view,
    arguments: arguments
  ).handle && authorized?
end

#warn(text) ⇒ Object 



248
249
250
251
252
 
# File 'lib/avo/base_action.rb', line 248

def warn(text)
  add_message text, :warning

  self
end