Class: Avo::Fields::TagsField

Inherits:
BaseField show all
Defined in:
lib/avo/fields/tags_field.rb

Defined Under Namespace

Classes: EditComponent, IndexComponent, ShowComponent, TagComponent

Instance Attribute Summary collapse

Attributes inherited from BaseField

#action, #as_avatar, #autocomplete, #block, #computable, #computed, #computed_value, #default, #for_attribute, #for_presentation_only, #format_using, #help, #id, #null_values, #nullable, #panel_name, #readonly, #record, #required, #sortable, #stacked, #summarizable, #user

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 inherited from BaseField

#apply_update_using, #assign_value, #custom?, #custom_name?, #database_id, #default_name, #execute_block, #form_field_label, #has_attribute?, #has_own_panel?, #hidden_in_reflection?, #meta, #name, #options_for_filter, #placeholder, #plural_name, #record_errors, #resolve_attribute, #table_header_label, #to_permitted_param, #translated_name, #translated_plural_name, #translation_key, #type, #updatable, #value, #visible_in_reflection?

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) ⇒ TagsField

Returns a new instance of TagsField.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/avo/fields/tags_field.rb', line 11

def initialize(id, **args, &block)
  super(id, **args, &block)

  add_boolean_prop args, :close_on_select
  add_boolean_prop args, :enforce_suggestions
  add_string_prop args, :acts_as_taggable_on
  add_array_prop args, :disallowed
  add_array_prop args, :delimiters, [","]
  add_array_prop args, :suggestions
  add_string_prop args, :suggestions_max_items
  add_string_prop args, :mode, nil
  add_string_prop args, :fetch_values_from

  @format_using ||= args[:fetch_labels]

  unless Rails.env.production?
    if args[:fetch_labels].present?
      puts "[Avo DEPRECATION WARNING]: The `fetch_labels` field configuration option is no longer supported and will be removed in future versions. Please discontinue its use and solely utilize the `format_using` instead."
    end
  end
end

Instance Attribute Details

#acts_as_taggable_on ⇒ Object (readonly)

Returns the value of attribute acts_as_taggable_on.



4
5
6
 
# File 'lib/avo/fields/tags_field.rb', line 4

def acts_as_taggable_on
  @acts_as_taggable_on
end

#close_on_select ⇒ Object (readonly)

Returns the value of attribute close_on_select.



5
6
7
 
# File 'lib/avo/fields/tags_field.rb', line 5

def close_on_select
  @close_on_select
end

#delimiters ⇒ Object (readonly)

Returns the value of attribute delimiters.



6
7
8
 
# File 'lib/avo/fields/tags_field.rb', line 6

def delimiters
  @delimiters
end

#enforce_suggestions ⇒ Object (readonly)

Returns the value of attribute enforce_suggestions.



7
8
9
 
# File 'lib/avo/fields/tags_field.rb', line 7

def enforce_suggestions
  @enforce_suggestions
end

#mode ⇒ Object (readonly)

Returns the value of attribute mode.



8
9
10
 
# File 'lib/avo/fields/tags_field.rb', line 8

def mode
  @mode
end

#suggestions_max_items ⇒ Object (readonly)

Returns the value of attribute suggestions_max_items.



9
10
11
 
# File 'lib/avo/fields/tags_field.rb', line 9

def suggestions_max_items
  @suggestions_max_items
end

Instance Method Details

#acts_as_taggable_on_values ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/avo/fields/tags_field.rb', line 41

def acts_as_taggable_on_values
  # When record is DB persistent the values are fetched from the DB
  # Else the array values are fetched from the record using the tag_list_on helper
  # values_array examples: ["1", "2"]
  #                        ["example suggestion","example tag"]
  if record.persisted?
    value.map { |item| item.name }
  else
    record.tag_list_on(acts_as_taggable_on)
  end
end

#disallowed ⇒ Object 



83
84
85
 
# File 'lib/avo/fields/tags_field.rb', line 83

def disallowed
  Avo::ExecutionContext.new(target: @disallowed, record: record).handle
end

#fetch_values_from ⇒ Object 



87
88
89
 
# File 'lib/avo/fields/tags_field.rb', line 87

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

#field_value ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/avo/fields/tags_field.rb', line 33

def field_value
  @field_value ||= if acts_as_taggable_on.present?
    acts_as_taggable_on_values.map { |value| {value:} }.as_json
  else
    value || []
  end
end

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



67
68
69
70
71
 
# File 'lib/avo/fields/tags_field.rb', line 67

def fill_acts_as_taggable(record, key, value, params)
  record.send(act_as_taggable_attribute(key), value)

  record
end

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



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/avo/fields/tags_field.rb', line 53

def fill_field(record, key, value, params)
  return fill_acts_as_taggable(record, key, value, params) if acts_as_taggable_on.present?

  value = if value.is_a?(String)
    value.split(delimiters[0])
  else
    value
  end

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

  record
end

#suggestions ⇒ Object 



79
80
81
 
# File 'lib/avo/fields/tags_field.rb', line 79

def suggestions
  @fetched_suggestions ||= Avo::ExecutionContext.new(target: @suggestions, record: record).handle
end

#whitelist_items ⇒ Object 



73
74
75
76
77
 
# File 'lib/avo/fields/tags_field.rb', line 73

def whitelist_items
  return suggestions.to_json if enforce_suggestions

  (suggestions + field_value).to_json
end