Class: Avo::BaseAction
Instance Attribute Summary collapse
#items_holder
Class Method Summary
collapse
Instance Method Summary
collapse
#get_stimulus_controllers
#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) ⇒ BaseAction
Returns a new instance of BaseAction.
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
# File 'lib/avo/base_action.rb', line 105
def initialize(record: nil, resource: nil, user: nil, view: nil, arguments: {}, icon: :play)
@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
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
fields
@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
#arguments ⇒ Object
Returns the value of attribute arguments.
22
23
24
|
# File 'lib/avo/base_action.rb', line 22
def arguments
@arguments
end
|
#icon ⇒ Object
Returns the value of attribute icon.
23
24
25
|
# File 'lib/avo/base_action.rb', line 23
def icon
@icon
end
|
#record ⇒ Object
Returns the value of attribute record.
19
20
21
|
# File 'lib/avo/base_action.rb', line 19
def record
@record
end
|
#resource ⇒ Object
Returns the value of attribute resource.
20
21
22
|
# File 'lib/avo/base_action.rb', line 20
def resource
@resource
end
|
#response ⇒ Object
Returns the value of attribute response.
18
19
20
|
# File 'lib/avo/base_action.rb', line 18
def response
@response
end
|
#user ⇒ Object
Returns the value of attribute user.
21
22
23
|
# File 'lib/avo/base_action.rb', line 21
def user
@user
end
|
#view ⇒ Object
Returns the value of attribute view.
17
18
19
|
# File 'lib/avo/base_action.rb', line 17
def view
@view
end
|
Class Method Details
.decode_arguments(arguments) ⇒ Object
81
82
83
84
85
86
87
88
|
# File 'lib/avo/base_action.rb', line 81
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.
72
73
74
75
76
77
78
79
|
# File 'lib/avo/base_action.rb', line 72
def encode_arguments(arguments)
return if arguments.blank?
Base64.encode64 Avo::Services::EncryptionService.encrypt(
message: arguments,
purpose: :action_arguments
)
end
|
39
40
41
42
43
44
|
# File 'lib/avo/base_action.rb', line 39
def form_data_attributes
{
turbo: turbo,
turbo_frame: :_top
}.compact
end
|
.link_arguments(resource:, arguments: {}, **args) ⇒ Object
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# File 'lib/avo/base_action.rb', line 50
def link_arguments(resource:, arguments: {}, **args)
path = 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
data = {
turbo_frame: Avo::ACTIONS_TURBO_FRAME_ID,
}
[path, data]
end
|
.to_param ⇒ Object
46
47
48
|
# File 'lib/avo/base_action.rb', line 46
def to_param
to_s
end
|
Instance Method Details
#action_name ⇒ Object
91
92
93
94
95
96
97
98
99
100
101
102
103
|
# File 'lib/avo/base_action.rb', line 91
def action_name
if name.present?
return Avo::ExecutionContext.new(
target: name,
resource: @resource,
record: @record,
view: @view,
arguments: @arguments
).handle
end
self.class.to_s.demodulize.underscore.humanize(keep_id_suffix: true)
end
|
#authorized? ⇒ Boolean
282
283
284
285
286
287
288
289
290
|
# File 'lib/avo/base_action.rb', line 282
def authorized?
Avo::ExecutionContext.new(
target: authorize,
action: self,
resource: @resource,
view: @view,
arguments: arguments
).handle
end
|
#close_modal ⇒ Object
235
236
237
238
239
|
# File 'lib/avo/base_action.rb', line 235
def close_modal
response[:type] = :close_modal
self
end
|
#current_user ⇒ Object
27
28
29
|
# File 'lib/avo/base_action.rb', line 27
def current_user
Avo::Current.user
end
|
#download(path, filename) ⇒ Object
274
275
276
277
278
279
280
|
# File 'lib/avo/base_action.rb', line 274
def download(path, filename)
response[:type] = :download
response[:path] = path
response[:filename] = filename
self
end
|
#error(text) ⇒ Object
211
212
213
214
215
|
# File 'lib/avo/base_action.rb', line 211
def error(text)
add_message text, :error
self
end
|
#fields ⇒ Object
133
134
|
# File 'lib/avo/base_action.rb', line 133
def fields
end
|
#get_message ⇒ Object
136
137
138
139
140
141
142
143
144
|
# File 'lib/avo/base_action.rb', line 136
def get_message
Avo::ExecutionContext.new(
target: self.class.message,
resource: @resource,
record: @record,
view: @view,
arguments: @arguments
).handle
end
|
#handle_action(**args) ⇒ Object
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
# File 'lib/avo/base_action.rb', line 146
def handle_action(**args)
processed_fields = if args[:fields].present?
action_fields = get_field_definitions.map do |field|
field.hydrate(resource: @resource)
[field.id, field]
end.to_h
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
|
217
218
219
220
221
|
# File 'lib/avo/base_action.rb', line 217
def inform(text)
add_message text, :info
self
end
|
#keep_modal_open ⇒ Object
229
230
231
232
233
|
# File 'lib/avo/base_action.rb', line 229
def keep_modal_open
response[:type] = :keep_modal_open
self
end
|
#navigate_to_action(action, **kwargs) ⇒ Object
266
267
268
269
270
271
272
|
# File 'lib/avo/base_action.rb', line 266
def navigate_to_action(action, **kwargs)
response[:type] = :navigate_to_action
response[:action] = action
response[:navigate_to_action_args] = kwargs
self
end
|
#redirect_to(path = nil, **args, &block) ⇒ Object
248
249
250
251
252
253
254
255
256
257
258
|
# File 'lib/avo/base_action.rb', line 248
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
260
261
262
263
264
|
# File 'lib/avo/base_action.rb', line 260
def reload
response[:type] = :reload
self
end
|
#silent ⇒ Object
Add a placeholder silent message from when a user wants to do a redirect action or something similar
242
243
244
245
246
|
# File 'lib/avo/base_action.rb', line 242
def silent
add_message nil, :silent
self
end
|
#succeed(text) ⇒ Object
205
206
207
208
209
|
# File 'lib/avo/base_action.rb', line 205
def succeed(text)
add_message text, :success
self
end
|
#visible_in_view(parent_resource: nil) ⇒ Object
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
# File 'lib/avo/base_action.rb', line 183
def visible_in_view(parent_resource: nil)
return false unless authorized?
if visible.blank?
return false if view.new?
return true
end
Avo::ExecutionContext.new(
target: visible,
params: params,
parent_resource: parent_resource,
resource: @resource,
view: @view,
arguments: arguments
).handle
end
|
#warn(text) ⇒ Object
223
224
225
226
227
|
# File 'lib/avo/base_action.rb', line 223
def warn(text)
add_message text, :warning
self
end
|