Class: Avo::Fields::BaseField

Inherits:
Object
  • Object
show all
Extended by:
ActiveSupport::DescendantsTracker
Includes:
ActionView::Helpers::UrlHelper, Concerns::HasHelpers, Concerns::HasItemType, Concerns::IsResourceItem, Concerns::IsVisible, Concerns::VisibleInDifferentViews, Concerns::DomId, Concerns::HandlesFieldArgs, Concerns::HasDefault, Concerns::HasFieldName, Concerns::HasHTMLAttributes, Concerns::IsDisabled, Concerns::IsReadonly, Concerns::IsRequired, Concerns::UseViewComponents
Defined in:
lib/avo/fields/base_field.rb

Instance Attribute Summary collapse

Attributes included from Concerns::IsDisabled

#disabled

Attributes included from Concerns::HasHTMLAttributes

#html

Attributes included from Concerns::VisibleInDifferentViews

#show_on_edit, #show_on_index, #show_on_new, #show_on_preview, #show_on_show

Attributes included from Concerns::IsVisible

#visible

Attributes included from Concerns::IsResourceItem

#resource, #view

Instance Method Summary collapse

Methods included from Concerns::DomId

#model_name, #to_key

Methods included from Concerns::UseViewComponents

#component_for_view, #view_component_name, #view_component_namespace

Methods included from Concerns::IsRequired

#is_required?

Methods included from Concerns::IsDisabled

#is_disabled?

Methods included from Concerns::IsReadonly

#is_readonly?

Methods included from Concerns::HasHTMLAttributes

#get_html

Methods included from Concerns::HasDefault

#computed_default_value

Methods included from Concerns::HasHelpers

#helpers

Methods included from Concerns::VisibleInDifferentViews

#except_on, #hide_on, #initialize_views, #only_on, #post_initialize, #show_on, #show_on_create, #show_on_update, #visible_in_view?

Methods included from Concerns::IsVisible

#visible?

Methods included from Concerns::HasItemType

#is_card?, #is_collaboration?, #is_field?, #is_header?, #is_heading?, #is_panel?, #is_sidebar?, #is_tab?, #is_tab_group?, #is_tool?

Methods included from Concerns::IsResourceItem

#visible?

Methods included from Concerns::Hydration

#hydrate

Constructor Details

#initialize(id, **args, &block) ⇒ BaseField

Returns a new instance of BaseField.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/avo/fields/base_field.rb', line 69

def initialize(id, **args, &block)
  @id = id
  @name = args[:name]
  @translation_key = args[:translation_key]
  @block = block
  @required = args.dig(:required) # Value if :required present on args, nil otherwise
  @readonly = args[:readonly] || false
  @disabled = args[:disabled] || false
  @sortable = args[:sortable] || false
  @summarizable = args[:summarizable] || false
  @nullable = args[:nullable] || false
  @null_values = args[:null_values] || [nil, ""]
  @format_using = args[:format_using]
  @format_display_using = args[:format_display_using]

  @format_index_using = args[:format_index_using]
  @format_show_using = args[:format_show_using]
  @format_edit_using = args[:format_edit_using]
  @format_new_using = args[:format_new_using]
  @format_form_using = args[:format_form_using]
  @update_using = args[:update_using]
  @placeholder = args[:placeholder]
  @autocomplete = args[:autocomplete]
  @help = args[:help]
  @label_help = args[:label_help]
  @default = args[:default]
  @visible = args[:visible]
  @html = args[:html]
  @view = Avo::ViewInquirer.new(args[:view])
  @value = args[:value]
  @stacked = args[:stacked]
  @size = args[:size] || :md
  @for_presentation_only = args[:for_presentation_only] || false
  @resource = args[:resource]
  @action = args[:action]
  @components = args[:components] || {}
  @for_attribute = args[:for_attribute]
  @meta = args[:meta]
  @copyable = args[:copyable] || false
  @react_on = Array.wrap(args[:react_on]).map(&:to_s)
  @record = args[:record]

  @args = args

  @computable = true
  @computed = block.present?
  @computed_value = nil

  @width = args[:width] || 100

  if width_option.present? && width_option != 100
    @stacked = true
  end

  post_initialize if respond_to?(:post_initialize)
end

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



62
63
64
 
# File 'lib/avo/fields/base_field.rb', line 62

def action
  @action
end

#autocomplete ⇒ Object (readonly)

Returns the value of attribute autocomplete.



46
47
48
 
# File 'lib/avo/fields/base_field.rb', line 46

def autocomplete
  @autocomplete
end

#block ⇒ Object (readonly)

Returns the value of attribute block.



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

def block
  @block
end

#computable ⇒ Object (readonly)

Private options



55
56
57
 
# File 'lib/avo/fields/base_field.rb', line 55

def computable
  @computable
end

#computed ⇒ Object (readonly)

if block is present



56
57
58
 
# File 'lib/avo/fields/base_field.rb', line 56

def computed
  @computed
end

#computed_value ⇒ Object (readonly)

the value after computation



57
58
59
 
# File 'lib/avo/fields/base_field.rb', line 57

def computed_value
  @computed_value
end

#copyable ⇒ Object (readonly)

if allowed to be copyable



58
59
60
 
# File 'lib/avo/fields/base_field.rb', line 58

def copyable
  @copyable
end

#default ⇒ Object (readonly)

Returns the value of attribute default.



48
49
50
 
# File 'lib/avo/fields/base_field.rb', line 48

def default
  @default
end

#for_attribute ⇒ Object (readonly)

Returns the value of attribute for_attribute.



52
53
54
 
# File 'lib/avo/fields/base_field.rb', line 52

def for_attribute
  @for_attribute
end

#for_presentation_only ⇒ Object (readonly)

Returns the value of attribute for_presentation_only.



51
52
53
 
# File 'lib/avo/fields/base_field.rb', line 51

def for_presentation_only
  @for_presentation_only
end

#format_display_using ⇒ Object (readonly)

Returns the value of attribute format_display_using.



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

def format_display_using
  @format_display_using
end

#format_edit_using ⇒ Object (readonly)

Returns the value of attribute format_edit_using.



43
44
45
 
# File 'lib/avo/fields/base_field.rb', line 43

def format_edit_using
  @format_edit_using
end

#format_form_using ⇒ Object (readonly)

Returns the value of attribute format_form_using.



45
46
47
 
# File 'lib/avo/fields/base_field.rb', line 45

def format_form_using
  @format_form_using
end

#format_index_using ⇒ Object (readonly)

Returns the value of attribute format_index_using.



41
42
43
 
# File 'lib/avo/fields/base_field.rb', line 41

def format_index_using
  @format_index_using
end

#format_new_using ⇒ Object (readonly)

Returns the value of attribute format_new_using.



44
45
46
 
# File 'lib/avo/fields/base_field.rb', line 44

def format_new_using
  @format_new_using
end

#format_show_using ⇒ Object (readonly)

Returns the value of attribute format_show_using.



42
43
44
 
# File 'lib/avo/fields/base_field.rb', line 42

def format_show_using
  @format_show_using
end

#format_using ⇒ Object (readonly)

Returns the value of attribute format_using.



39
40
41
 
# File 'lib/avo/fields/base_field.rb', line 39

def format_using
  @format_using
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#label_help ⇒ Object (readonly)

Returns the value of attribute label_help.



47
48
49
 
# File 'lib/avo/fields/base_field.rb', line 47

def label_help
  @label_help
end

#null_values ⇒ Object (readonly)

Returns the value of attribute null_values.



38
39
40
 
# File 'lib/avo/fields/base_field.rb', line 38

def null_values
  @null_values
end

#nullable ⇒ Object (readonly)

Returns the value of attribute nullable.



37
38
39
 
# File 'lib/avo/fields/base_field.rb', line 37

def nullable
  @nullable
end

#panel_name ⇒ Object

Returns the value of attribute panel_name.



64
65
66
 
# File 'lib/avo/fields/base_field.rb', line 64

def panel_name
  @panel_name
end

#readonly ⇒ Object (readonly)

Returns the value of attribute readonly.



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

def readonly
  @readonly
end

#record ⇒ Object

Hydrated payload



61
62
63
 
# File 'lib/avo/fields/base_field.rb', line 61

def record
  @record
end

#required ⇒ Object (readonly)

Returns the value of attribute required.



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

def required
  @required
end

#size ⇒ Object (readonly)

Returns the value of attribute size.



50
51
52
 
# File 'lib/avo/fields/base_field.rb', line 50

def size
  @size
end

#sortable ⇒ Object (readonly)

Returns the value of attribute sortable.



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

def sortable
  @sortable
end

#stacked ⇒ Object (readonly)

Returns the value of attribute stacked.



49
50
51
 
# File 'lib/avo/fields/base_field.rb', line 49

def stacked
  @stacked
end

#summarizable ⇒ Object (readonly)

Returns the value of attribute summarizable.



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

def summarizable
  @summarizable
end

#user ⇒ Object

Returns the value of attribute user.



63
64
65
 
# File 'lib/avo/fields/base_field.rb', line 63

def user
  @user
end

#width ⇒ Object

Returns the value of attribute width.



65
66
67
 
# File 'lib/avo/fields/base_field.rb', line 65

def width
  @width
end

Instance Method Details

#apply_update_using(record, key, value, resource) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/avo/fields/base_field.rb', line 289

def apply_update_using(record, key, value, resource)
  return value if @update_using.nil?

  Avo::ExecutionContext.new(
    target: @update_using,
    record:,
    key:,
    value:,
    resource:,
    field: self,
    include: self.class.included_modules
  ).handle
end

#assign_value(record:, value:) ⇒ Object

Used by Avo to fill the record with the default value on :new and :edit views



357
358
359
360
361
362
363
 
# File 'lib/avo/fields/base_field.rb', line 357

def assign_value(record:, value:)
  id = (type == "belongs_to") ? foreign_key : database_id

  if record.send(id).nil?
    record.send(:"#{id}=", value)
  end
end

#attribute_id ⇒ Object 



243
 
# File 'lib/avo/fields/base_field.rb', line 243

def attribute_id = (@attribute_id ||= @for_attribute || @id)

#custom? ⇒ Boolean

Returns:

  • (Boolean) 


334
335
336
337
338
 
# File 'lib/avo/fields/base_field.rb', line 334

def custom?
  !method(:initialize).source_location.first.include?("lib/avo/field")
rescue
  true
end

#custom_name? ⇒ Boolean

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/avo/fields/base_field.rb', line 215

def custom_name?
  !@name.nil?
end

#database_id ⇒ Object

Try to see if the field has a different database ID than it's name



308
309
310
311
312
 
# File 'lib/avo/fields/base_field.rb', line 308

def database_id
  foreign_key
rescue
  id
end

#default_name ⇒ Object 



219
220
221
 
# File 'lib/avo/fields/base_field.rb', line 219

def default_name
  @id.to_s.humanize(keep_id_suffix: true)
end

#default_placeholder ⇒ Object 



239
240
241
 
# File 'lib/avo/fields/base_field.rb', line 239

def default_placeholder
  name
end

#execute_context(target, **extra_args) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/avo/fields/base_field.rb', line 267

def execute_context(target, **extra_args)
  Avo::ExecutionContext.new(
    target:,
    record: @record,
    resource: @resource,
    view: @view,
    field: self,
    include: self.class.included_modules,
    **extra_args
  ).handle
end

#fill_field(record, key, value, params) ⇒ Object

Fills the record with the received value on create and update actions.



280
281
282
283
284
285
286
287
 
# File 'lib/avo/fields/base_field.rb', line 280

def fill_field(record, key, value, params)
  key = @for_attribute.to_s if @for_attribute.present?
  return record unless has_attribute?(record, key)

  record.public_send(:"#{key}=", apply_update_using(record, key, value, resource))

  record
end

#form_field_label ⇒ Object 



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

def form_field_label
  id
end

#has_attribute?(record, attribute) ⇒ Boolean

Returns:

  • (Boolean) 


303
304
305
 
# File 'lib/avo/fields/base_field.rb', line 303

def has_attribute?(record, attribute)
  record.methods.include? attribute.to_sym
end

#has_own_panel? ⇒ Boolean

Returns:

  • (Boolean) 


314
315
316
 
# File 'lib/avo/fields/base_field.rb', line 314

def has_own_panel?
  false
end

#help ⇒ Object 



223
224
225
226
227
 
# File 'lib/avo/fields/base_field.rb', line 223

def help
  return @help unless @help.nil?

  translated_option(:help)
end

#hidden_in_reflection?(reflection = nil) ⇒ Boolean

Returns:

  • (Boolean) 


344
345
346
 
# File 'lib/avo/fields/base_field.rb', line 344

def hidden_in_reflection?(reflection = nil)
  !visible_in_reflection?(reflection)
end

#meta ⇒ Object 



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

def meta
  Avo::ExecutionContext.new(target: @meta, record: record, resource: @resource, view: @view).handle
end

#name ⇒ Object

Getting the name of the resource (user/users, post/posts) We'll first check to see if the user passed a name Secondly we'll try to find a translation key We'll fallback to humanizing the id



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/avo/fields/base_field.rb', line 175

def name
  if custom_name?
    Avo::ExecutionContext.new(target: @name).handle
  elsif name_override.present?
    name_override
  elsif name_from_translation?
    translated_name default: default_name
  else
    default_name
  end
end

#name_override ⇒ Object 



187
 
# File 'lib/avo/fields/base_field.rb', line 187

def name_override = nil

#options_for_filter ⇒ Object 



348
349
350
 
# File 'lib/avo/fields/base_field.rb', line 348

def options_for_filter
  options
end

#parent ⇒ Object 



373
374
375
 
# File 'lib/avo/fields/base_field.rb', line 373

def parent
  @parent ||= fetch_parent
end

#placeholder ⇒ Object 



229
230
231
232
233
234
235
236
237
 
# File 'lib/avo/fields/base_field.rb', line 229

def placeholder
  target = if !@placeholder.nil?
    @placeholder
  else
    translated_option(:placeholder).presence || default_placeholder
  end

  Avo::ExecutionContext.new(target: target, record: record, resource: @resource, view: @view).handle
end

#plural_name ⇒ Object 



197
198
199
200
201
202
203
204
205
 
# File 'lib/avo/fields/base_field.rb', line 197

def plural_name
  default = name.pluralize

  if translation_key
    translated_plural_name default: default
  else
    default
  end
end

#record_errors ⇒ Object 



326
327
328
 
# File 'lib/avo/fields/base_field.rb', line 326

def record_errors
  record.present? ? record.errors : {}
end

#resolve_attribute(value) ⇒ Object 



318
319
320
 
# File 'lib/avo/fields/base_field.rb', line 318

def resolve_attribute(value)
  value
end

#resource_scoped_translation_key ⇒ Object 



138
139
140
141
142
 
# File 'lib/avo/fields/base_field.rb', line 138

def resource_scoped_translation_key
  return if @resource.blank?

  "#{@resource.translation_key}.fields.#{@id}"
end

#sentence_name ⇒ Object

The name as it should read inside a sentence, e.g. "Attach payment method". A resolved translation is used verbatim; only the generated fallback is lowercased.



191
192
193
194
195
 
# File 'lib/avo/fields/base_field.rb', line 191

def sentence_name
  return name.humanize(capitalize: false) unless name_from_translation?

  translated_name(default: default_name.humanize(capitalize: false))
end

#shared_translation_key ⇒ Object 



134
135
136
 
# File 'lib/avo/fields/base_field.rb', line 134

def shared_translation_key
  "avo.field_translations.#{@id}"
end

#table_header_class ⇒ Object 



211
212
213
 
# File 'lib/avo/fields/base_field.rb', line 211

def table_header_class
  @table_header_class ||= ""
end

#table_header_label ⇒ Object 



207
208
209
 
# File 'lib/avo/fields/base_field.rb', line 207

def table_header_label
  @table_header_label ||= name
end

#to_permitted_param ⇒ Object 



322
323
324
 
# File 'lib/avo/fields/base_field.rb', line 322

def to_permitted_param
  id.to_sym
end

#translated_name(default:) ⇒ Object 



144
145
146
 
# File 'lib/avo/fields/base_field.rb', line 144

def translated_name(default:)
  translate_field_name(count: 1, default: default)
end

#translated_plural_name(default:) ⇒ Object 



148
149
150
 
# File 'lib/avo/fields/base_field.rb', line 148

def translated_plural_name(default:)
  translate_field_name(count: 2, default: default)
end

#translation_key ⇒ Object 



130
131
132
 
# File 'lib/avo/fields/base_field.rb', line 130

def translation_key
  @translation_key || resource_scoped_translation_key || shared_translation_key
end

#type ⇒ Object 



330
331
332
 
# File 'lib/avo/fields/base_field.rb', line 330

def type
  @type ||= self.class.name.demodulize.to_s.underscore.gsub("_field", "")
end

#updatable ⇒ Object 



352
353
354
 
# File 'lib/avo/fields/base_field.rb', line 352

def updatable
  !is_disabled? && visible?
end

#value(property = nil) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/avo/fields/base_field.rb', line 245

def value(property = nil)
  return @value if @value.present?

  property ||= attribute_id

  # Get record value
  final_value = @record.send(property) if is_model?(@record) && @record.respond_to?(property)

  # On new views and actions modals we need to prefill the fields with the default value if value is nil
  if final_value.nil? && should_fill_with_default_value? && @default.present?
    final_value = computed_default_value
  end

  # Run computable callback block if present
  if computable && @block.present?
    final_value = execute_context(@block)
  end

  # Format value based on available formatter
  format_value(final_value)
end

#visible_in_reflection?(reflection = nil) ⇒ Boolean

Returns:

  • (Boolean) 


340
341
342
 
# File 'lib/avo/fields/base_field.rb', line 340

def visible_in_reflection?(reflection = nil)
  true
end

#width_class ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/avo/fields/base_field.rb', line 152

def width_class
  case width_option
  when 25
    "w-1/4"
  when 33
    "w-1/3"
  when 50
    "w-1/2"
  when 66
    "w-2/3"
  when 75
    "w-3/4"
  when 100
    "w-full"
  else
    "w-full"
  end
end

#width_option ⇒ Object 



126
127
128
 
# File 'lib/avo/fields/base_field.rb', line 126

def width_option
  @width_option ||= execute_context(@width)
end