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::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::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_field?, #is_heading?, #is_main_panel?, #is_panel?, #is_row?, #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.



61
62
63
64
65
66
67
68
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
 
# File 'lib/avo/fields/base_field.rb', line 61

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] || nil
  @update_using = args[:update_using] || nil
  @placeholder = args[:placeholder]
  @autocomplete = args[:autocomplete] || nil
  @help = args[:help] || nil
  @default = args[:default] || nil
  @visible = args[:visible]
  @as_avatar = args[:as_avatar] || false
  @html = args[:html] || nil
  @view = Avo::ViewInquirer.new(args[:view]) || nil
  @value = args[:value] || nil
  @stacked = args[:stacked] || nil
  @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

  @args = args

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

  post_initialize if respond_to?(:post_initialize)
end

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



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

def action
  @action
end

#as_avatar ⇒ Object (readonly)

Returns the value of attribute as_avatar.



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

def as_avatar
  @as_avatar
end

#autocomplete ⇒ Object (readonly)

Returns the value of attribute autocomplete.



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

def autocomplete
  @autocomplete
end

#block ⇒ Object (readonly)

Returns the value of attribute block.



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

def block
  @block
end

#computable ⇒ Object (readonly)

Private options



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

def computable
  @computable
end

#computed ⇒ Object (readonly)

if block is present



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

def computed
  @computed
end

#computed_value ⇒ Object (readonly)

the value after computation



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

def computed_value
  @computed_value
end

#copyable ⇒ Object (readonly)

if allowed to be copyable



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

def copyable
  @copyable
end

#default ⇒ Object (readonly)

Returns the value of attribute default.



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

def default
  @default
end

#for_attribute ⇒ Object (readonly)

Returns the value of attribute for_attribute.



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

def for_attribute
  @for_attribute
end

#for_presentation_only ⇒ Object (readonly)

Returns the value of attribute for_presentation_only.



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

def for_presentation_only
  @for_presentation_only
end

#format_using ⇒ Object (readonly)

Returns the value of attribute format_using.



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

def format_using
  @format_using
end

#help ⇒ Object (readonly)

Returns the value of attribute help.



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

def help
  @help
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#null_values ⇒ Object (readonly)

Returns the value of attribute null_values.



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

def null_values
  @null_values
end

#nullable ⇒ Object (readonly)

Returns the value of attribute nullable.



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

def nullable
  @nullable
end

#panel_name ⇒ Object

Returns the value of attribute panel_name.



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

def panel_name
  @panel_name
end

#readonly ⇒ Object (readonly)

Returns the value of attribute readonly.



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

def readonly
  @readonly
end

#record ⇒ Object

Hydrated payload



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

def record
  @record
end

#required ⇒ Object (readonly)

Returns the value of attribute required.



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

def required
  @required
end

#sortable ⇒ Object (readonly)

Returns the value of attribute sortable.



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

def sortable
  @sortable
end

#stacked ⇒ Object (readonly)

Returns the value of attribute stacked.



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

def stacked
  @stacked
end

#summarizable ⇒ Object (readonly)

Returns the value of attribute summarizable.



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

def summarizable
  @summarizable
end

#user ⇒ Object

Returns the value of attribute user.



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

def user
  @user
end

Instance Method Details

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



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/avo/fields/base_field.rb', line 209

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



277
278
279
280
281
282
283
 
# File 'lib/avo/fields/base_field.rb', line 277

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

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

#custom? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#custom_name? ⇒ Boolean

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/avo/fields/base_field.rb', line 142

def custom_name?
  !@name.nil?
end

#database_id ⇒ Object

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



228
229
230
231
232
 
# File 'lib/avo/fields/base_field.rb', line 228

def database_id
  foreign_key
rescue
  id
end

#default_name ⇒ Object 



146
147
148
 
# File 'lib/avo/fields/base_field.rb', line 146

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

#execute_block ⇒ Object 



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/avo/fields/base_field.rb', line 188

def execute_block
  Avo::ExecutionContext.new(
    target: block,
    record: record,
    resource: resource,
    view: view,
    field: self,
    include: self.class.included_modules
  ).handle
end

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

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



200
201
202
203
204
205
206
207
 
# File 'lib/avo/fields/base_field.rb', line 200

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 



285
286
287
 
# File 'lib/avo/fields/base_field.rb', line 285

def form_field_label
  id
end

#has_attribute?(record, attribute) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#has_own_panel? ⇒ Boolean

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/avo/fields/base_field.rb', line 234

def has_own_panel?
  false
end

#hidden_in_reflection? ⇒ Boolean

Returns:

  • (Boolean) 


264
265
266
 
# File 'lib/avo/fields/base_field.rb', line 264

def hidden_in_reflection?
  !visible_in_reflection?
end

#meta ⇒ Object 



289
290
291
 
# File 'lib/avo/fields/base_field.rb', line 289

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



118
119
120
121
122
123
124
125
126
 
# File 'lib/avo/fields/base_field.rb', line 118

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

#options_for_filter ⇒ Object 



268
269
270
 
# File 'lib/avo/fields/base_field.rb', line 268

def options_for_filter
  options
end

#placeholder ⇒ Object 



150
151
152
 
# File 'lib/avo/fields/base_field.rb', line 150

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

#plural_name ⇒ Object 



128
129
130
131
132
133
134
135
136
 
# File 'lib/avo/fields/base_field.rb', line 128

def plural_name
  default = name.pluralize

  if translation_key
    translated_plural_name default: default
  else
    default
  end
end

#record_errors ⇒ Object 



246
247
248
 
# File 'lib/avo/fields/base_field.rb', line 246

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

#resolve_attribute(value) ⇒ Object 



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

def resolve_attribute(value)
  value
end

#table_header_label ⇒ Object 



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

def table_header_label
  @table_header_label ||= name
end

#to_permitted_param ⇒ Object 



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

def to_permitted_param
  id.to_sym
end

#translated_name(default:) ⇒ Object 



106
107
108
 
# File 'lib/avo/fields/base_field.rb', line 106

def translated_name(default:)
  t(translation_key, count: 1, default: default).humanize
end

#translated_plural_name(default:) ⇒ Object 



110
111
112
 
# File 'lib/avo/fields/base_field.rb', line 110

def translated_plural_name(default:)
  t(translation_key, count: 2, default: default).humanize
end

#translation_key ⇒ Object 



102
103
104
 
# File 'lib/avo/fields/base_field.rb', line 102

def translation_key
  @translation_key || "avo.field_translations.#{@id}"
end

#type ⇒ Object 



250
251
252
 
# File 'lib/avo/fields/base_field.rb', line 250

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

#updatable ⇒ Object 



272
273
274
 
# File 'lib/avo/fields/base_field.rb', line 272

def updatable
  !is_disabled? && visible?
end

#value(property = nil) ⇒ Object 



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
182
183
184
185
186
 
# File 'lib/avo/fields/base_field.rb', line 154

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

  property ||= @for_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_block
  end

  # Run the value through resolver if present
  if format_using.present?
    final_value = Avo::ExecutionContext.new(
      target: format_using,
      value: final_value,
      record: record,
      resource: resource,
      view: view,
      field: self,
      include: self.class.included_modules
    ).handle
  end

  final_value
end

#visible_in_reflection? ⇒ Boolean

Returns:

  • (Boolean) 


260
261
262
 
# File 'lib/avo/fields/base_field.rb', line 260

def visible_in_reflection?
  true
end