Class: Avo::Fields::KeyValueField

Inherits:
BaseField
  • Object
show all
Defined in:
lib/avo/fields/key_value_field.rb

Defined Under Namespace

Classes: EditComponent, ShowComponent

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

#assign_value, #custom?, #custom_name?, #database_id, #default_name, #execute_block, #form_field_label, #has_attribute?, #has_own_panel?, #hidden_in_reflection?, #name, #options_for_filter, #placeholder, #plural_name, #record_errors, #resolve_attribute, #table_header_label, #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) ⇒ KeyValueField

Returns a new instance of KeyValueField.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/avo/fields/key_value_field.rb', line 9

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

  hide_on :index

  @key_label = args[:key_label] if args[:key_label].present?
  @value_label = args[:value_label] if args[:value_label].present?
  @action_text = args[:action_text] if args[:action_text].present? # This should be add_row_label
  @delete_text = args[:delete_text] if args[:delete_text].present?

  if args[:disabled] == true
    @disable_editing_keys = true
    @disable_editing_values = true
    @disable_adding_rows = true
    @disable_deleting_rows = true
  else
    @disable_editing_keys = args[:disable_editing_keys].present? ? args[:disable_editing_keys] : false
    @disable_editing_values = args[:disable_editing_values].present? ? args[:disable_editing_values] : false
    # disabling editing keys also disables adding rows (doesn't take into account the value of disable_adding_rows)
    @disable_adding_rows = if args[:disable_editing_keys].present? && args[:disable_editing_keys] == true
      true
    elsif args[:disable_adding_rows].present?
      args[:disable_adding_rows]
    else
      false
    end
    @disable_deleting_rows = args[:disable_deleting_rows].present? ? args[:disable_deleting_rows] : false
  end
end

Instance Attribute Details

#disable_adding_rows ⇒ Object (readonly)

Returns the value of attribute disable_adding_rows.



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

def disable_adding_rows
  @disable_adding_rows
end

#disable_editing_keys ⇒ Object (readonly)

Returns the value of attribute disable_editing_keys.



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

def disable_editing_keys
  @disable_editing_keys
end

Instance Method Details

#action_text ⇒ Object 



51
52
53
54
55
 
# File 'lib/avo/fields/key_value_field.rb', line 51

def action_text
  return @action_text if @action_text.present?

  I18n.translate("avo.key_value_field.add_row")
end

#delete_text ⇒ Object 



57
58
59
60
61
 
# File 'lib/avo/fields/key_value_field.rb', line 57

def delete_text
  return @delete_text if @delete_text.present?

  I18n.translate("avo.key_value_field.delete_row")
end

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



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/avo/fields/key_value_field.rb', line 86

def fill_field(model, key, value, params)
  begin
    new_value = JSON.parse(value)
  rescue
    new_value = {}
  end

  model.send("#{key}=", new_value)

  model
end

#key_label ⇒ Object 



39
40
41
42
43
 
# File 'lib/avo/fields/key_value_field.rb', line 39

def key_label
  return @key_label if @key_label.present?

  I18n.translate("avo.key_value_field.key")
end

#options ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/avo/fields/key_value_field.rb', line 73

def options
  {
    key_label: key_label,
    value_label: value_label,
    action_text: action_text,
    delete_text: delete_text,
    disable_editing_keys: @disable_editing_keys,
    disable_editing_values: @disable_editing_values,
    disable_adding_rows: @disable_adding_rows,
    disable_deleting_rows: @disable_deleting_rows
  }
end

#parsed_value ⇒ Object 



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

def parsed_value
  value.to_json
rescue
  {}
end

#to_permitted_param ⇒ Object 



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

def to_permitted_param
  [:"#{id}", "#{id}": {}]
end

#value_label ⇒ Object 



45
46
47
48
49
 
# File 'lib/avo/fields/key_value_field.rb', line 45

def value_label
  return @value_label if @value_label.present?

  I18n.translate("avo.key_value_field.value")
end