Class: Decidim::FormBuilder

Inherits:
LegacyFormBuilder show all
Includes:
ActionView::Context, Map::Autocomplete::FormBuilder, TooltipHelper, TranslatableAttributes
Defined in:
decidim-core/lib/decidim/form_builder.rb

Overview

This custom FormBuilder adds fields needed to deal with translatable fields, following the conventions set on ‘Decidim::TranslatableAttributes`.

Instance Method Summary collapse

Methods included from TooltipHelper

#with_tooltip

Methods included from Map::Autocomplete::FormBuilder

#geocoding_field

Methods included from TranslatableAttributes

#attachment?, #default_locale?

Methods inherited from LegacyFormBuilder

#autocomplete, #collection_select, #date_select, #datetime_select, #error_for, #label, #radio_button, #select, #submit, #time_zone_select

Instance Method Details

#areas_select(name, collection, options = {}, html_options = {}) ⇒ Object

Public: Generates a select field for areas.

name - The name of the field (usually area_id) collection - A collection of areas or area_types.

If it is areas, we sort the selectable options alphabetically.

Returns a String.



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 221

def areas_select(name, collection, options = {}, html_options = {})
  selectables = if collection.first.is_a?(Decidim::Area)
                  assemblies = collection
                               .map { |a| [a.name[I18n.locale.to_s], a.id] }
                               .sort_by { |arr| arr[0] }

                  @template.options_for_select(
                    assemblies,
                    selected: options[:selected]
                  )
                else
                  @template.option_groups_from_collection_for_select(
                    collection,
                    :areas,
                    :translated_name,
                    :id,
                    :translated_name,
                    selected: options[:selected]
                  )
                end

  select(name, selectables, options, html_options)
end

#attachment(attribute, options = {}) ⇒ Object

Public: Generates a file upload field for Decidim::Attachment type of attachment. It is similar to upload method, but it changes some options so that attachment can have title and different upload validations.

attribute - The String name of the attribute to build the field. options - A Hash with options to build the field. See upload method for more detailed information.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 309

def attachment(attribute, options = {})
  object_attachment = object.respond_to?(:attachment) && object.attachment.present?
  record = object_attachment ? object.attachment : object
  options = {
    titled: options[:multiple],
    resource_class: "Decidim::Attachment",
    show_current: false,
    max_file_size: max_file_size(record, :file),
    label: I18n.t("decidim.forms.upload.labels.add_attachment"),
    button_edit_label: I18n.t("decidim.forms.upload.labels.edit_image"),
    extension_allowlist: Decidim.organization_settings(record).upload_allowed_file_extensions
  }.merge(options)

  # Upload help uses extension allowlist from the options so we need to call this AFTER setting the defaults.
  options[:help] = upload_help(record, attribute, options) if options[:help].blank?

  upload(attribute, options)
end

#check_box(attribute, options = {}, checked_value = "1", unchecked_value = "0") ⇒ Object

Public: Override so checkboxes are rendered before the label.



294
295
296
297
298
299
300
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 294

def check_box(attribute, options = {}, checked_value = "1", unchecked_value = "0")
  custom_label(attribute, options[:label], options[:label_options], field_before_label: true) do
    options.delete(:label)
    options.delete(:label_options)
    super(attribute, options.except(:help_text), checked_value, unchecked_value)
  end + error_and_help_text(attribute, options)
end

#choose_button_label(attribute) ⇒ Object 



380
381
382
383
384
385
386
387
388
389
390
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 380

def choose_button_label(attribute)
  @choose_button_label ||= begin
    if resource_class(attribute).attached_config[attribute].uploader <= Decidim::ImageUploader
      I18n.t("decidim.forms.upload.labels.add_image")
    else
      I18n.t("decidim.forms.upload.labels.add_file")
    end
  rescue NoMethodError
    I18n.t("decidim.forms.upload.labels.add_file")
  end
end

#collection_check_boxes(attribute, collection, value_attribute, text_attribute, options = {}, html_options = {}) ⇒ Object

Public: generates a check boxes input from a collection and adds help text and errors.

attribute - the name of the field collection - the collection from which we will render the check boxes value_attribute - a Symbol or a Proc defining how to find the value

attribute

text_attribute - a Symbol or a Proc defining how to find the text

attribute

options - a Hash with options html_options - a Hash with options

Renders a collection of check boxes. rubocop:disable Metrics/ParameterLists



26
27
28
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 26

def collection_check_boxes(attribute, collection, value_attribute, text_attribute, options = {}, html_options = {})
  error_and_help_text(attribute, options) + super
end

#collection_radio_buttons(attribute, collection, value_attribute, text_attribute, options = {}, html_options = {}) ⇒ Object

Public: generates a radio buttons input from a collection and adds help text and errors.

attribute - the name of the field collection - the collection from which we will render the radio buttons value_attribute - a Symbol or a Proc defining how to find the value attribute text_attribute - a Symbol or a Proc defining how to find the text attribute options - a Hash with options html_options - a Hash with options

Renders a collection of radio buttons. rubocop:disable Metrics/ParameterLists



43
44
45
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 43

def collection_radio_buttons(attribute, collection, value_attribute, text_attribute, options = {}, html_options = {})
  error_and_help_text(attribute, options) + super
end

#create_language_selector(locales, tabs_id, name) ⇒ Object

rubocop:enable Metrics/ParameterLists



48
49
50
51
52
53
54
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 48

def create_language_selector(locales, tabs_id, name)
  if locales.count > 4
    language_selector_select(locales, tabs_id, name)
  else
    language_tabs(locales, tabs_id, name)
  end
end

#data_picker(attribute, options = {}, prompt_params = {}) ⇒ Object

Public: Generates a picker field for selection (either simple or multiselect).

attribute - The name of the object’s attribute. options - A Hash with options:

  • multiple: Multiple mode, to allow selection of multiple items.

  • label: Show label?

  • name: (optional) The name attribute of the input elements.

prompt_params - Hash with options:

  • url: The url where the ajax endpoint that will fill the content of the selector popup (the prompt).

  • text: Text in the button to open the Data Picker selector.

Also it should receive a block that returns a Hash with :url and :text for each selected scope

Returns an html String.



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 275

def data_picker(attribute, options = {}, prompt_params = {})
  picker_options = {
    id: "#{@object_name}_#{attribute}",
    class: "picker-#{options[:multiple] ? "multiple" : "single"}",
    name: options[:name] || "#{@object_name}[#{attribute}]"
  }
  picker_options[:class] += " is-invalid-input" if error?(attribute)
  picker_options[:class] += " picker-autosort" if options[:autosort]

  items = object.send(attribute).collect { |item| [item, yield(item)] }

  template = ""
  template += label(attribute, label_for(attribute) + required_for_attribute(attribute)) unless options[:label] == false
  template += error_and_help_text(attribute, options)
  template += @template.render("decidim/widgets/data_picker", picker_options:, prompt_params:, items:)
  template.html_safe
end

#datetime_field(attribute, opts = {}) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 89

def datetime_field(attribute, opts = {})
  label = label_for(attribute)
  opts.reverse_merge!(
    data: {
      "date-label": I18n.t("datetime.widget.label.date", label:),
      "time-label": I18n.t("datetime.widget.label.time", label:),
      "button-date-label": I18n.t("datetime.widget.picker.date_button", label:),
      "button-time-label": I18n.t("datetime.widget.picker.time_button", label:)
    }
  )

  super
end

#editor(name, options = {}) ⇒ Object

Public: generates a hidden field and a container for WYSIWYG editor

name - The name of the field options - The set of options to send to the field

:label - The Boolean value to create or not the input label (optional) (default: true)
:toolbar - The String value to configure WYSIWYG toolbar. It should be 'basic' or
           or 'full' (optional) (default: 'basic')
:lines - The Integer to indicate how many lines should editor have (optional) (default: 10)
:help_text - The help text to display
:disabled - Whether the editor should be disabled

Renders a container with both hidden field and editor container



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 173

def editor(name, options = {})
  options[:disabled] ||= false
  toolbar = options.delete(:toolbar) || "basic"
  lines = options.delete(:lines) || 10
  label_text = options[:label].to_s
  label_text = label_for(name) if label_text.blank?
  options.delete(:required)
  help_text = options.delete(:help_text)
  editor_image = Decidim::EditorImage.new
  editor_options = editor_options(editor_image, options)
  hidden_options = extract_validations(name, options).merge(options)

  @template.append_stylesheet_pack_tag "decidim_editor"
  @template.append_javascript_pack_tag "decidim_editor", defer: false

  content_tag(
    :div,
    class: "editor",
    id: "#{sanitize_for_dom_selector(@object_name)}_#{sanitize_for_dom_selector(name)}"
  ) do
    template = ""
    template += label(name, label_text + required_for_attribute(name), for: nil) if options.fetch(:label, true)
    template += hidden_field(name, hidden_options.merge(id: nil))
    template += content_tag(:span, help_text, class: "help-text") if help_text
    template += content_tag(
      :div,
      nil,
      class: editor_options[:editor].delete("class").join(" "),
      data: {
        controller: :editor,
        toolbar:,
        disabled: options[:disabled],
        options: editor_options[:editor]
      }
    ) { content_tag(:div, nil, class: "editor-input", style: "height: #{lines}rem") }
    template += error_for(name, options) if error?(name)
    template += editor_upload(editor_image, editor_options[:upload])
    template.html_safe
  end
end

#form_field_for(attribute, options = {}) ⇒ Object 



426
427
428
429
430
431
432
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 426

def form_field_for(attribute, options = {})
  if attribute == :body
    text_area(attribute, options.merge(rows: 10))
  else
    text_field(attribute, options)
  end
end

#label_for(attribute) ⇒ Object

Public: Returns the translated name for the given attribute.

attribute - The String name of the attribute to return the name.



418
419
420
421
422
423
424
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 418

def label_for(attribute)
  if object.class.respond_to?(:human_attribute_name)
    object.class.human_attribute_name(attribute)
  else
    attribute.to_s.humanize
  end
end

#max_file_size(record, attribute) ⇒ Object 



376
377
378
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 376

def max_file_size(record, attribute)
  Decidim::FileValidatorHumanizer.new(record, attribute).max_file_size
end

#password_field(attribute, options = {}) ⇒ Object 



103
104
105
106
107
108
109
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 103

def password_field(attribute, options = {})
  field attribute, options do |opts|
    opts[:autocomplete] ||= :off
    opts[:class] ||= "input-group-field"
    super(attribute, opts)
  end
end

#resources_select(name, collection, options = {}) ⇒ Object

Public: Generates a select field for resource types.

name - The name of the field (usually resource_type) collection - A collection of resource types.

The options are sorted alphabetically.

Returns a String.



252
253
254
255
256
257
258
259
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 252

def resources_select(name, collection, options = {})
  resources =
    collection
    .map { |r| [I18n.t(r.split("::").last.underscore, scope: "decidim.components.component_order_selector.order"), r] }
    .sort

  select(name, @template.options_for_select(resources, selected: options[:selected]), options)
end

#social_field(type, name, handlers, options = {}) ⇒ Object

Public: Generates a form field for each social.

type - The form field’s type, like ‘text_area` or `text_field` name - The name of the field handlers - The social handlers to be created options - The set of options to send to the field

Renders form fields for each locale.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 127

def social_field(type, name, handlers, options = {})
  tabs_id = sanitize_tabs_selector(options[:tabs_id] || "#{object_name}-#{name}-tabs")

  label_tabs = content_tag(:div, class: "label--tabs") do
    field_label = label_i18n(name, options[:label] || label_for(name), required: options[:required])

    tabs_panels = "".html_safe
    if options[:label] != false
      tabs_panels = content_tag(:ul, class: "tabs tabs--lang", id: tabs_id, data: { tabs: true }) do
        handlers.each_with_index.inject("".html_safe) do |string, (handler, index)|
          string + content_tag(:li, class: tab_element_class_for("title", index)) do
            title = I18n.t(".#{handler}", scope: "activemodel.attributes.#{object_name}")
            tab_content_id = sanitize_tabs_selector "#{tabs_id}-#{name}-panel-#{index}"
            content_tag(:a, title, href: "##{tab_content_id}")
          end
        end
      end
    end

    safe_join [field_label, tabs_panels]
  end

  tabs_content = content_tag(:div, class: "tabs-content", data: { tabs_content: tabs_id }) do
    handlers.each_with_index.inject("".html_safe) do |string, (handler, index)|
      tab_content_id = sanitize_tabs_selector "#{tabs_id}-#{name}-panel-#{index}"
      string + content_tag(:div, class: tab_element_class_for("panel", index), id: tab_content_id, "aria-hidden": tab_attr_aria_hidden_for(index)) do
        send(type, "#{handler}_handler", options.merge(label: false))
      end
    end
  end

  safe_join [label_tabs, tabs_content]
end

#text_area(attribute, options = {}) ⇒ Object

Discard the pattern attribute which is not allowed for textarea elements.



435
436
437
438
439
440
441
442
443
444
445
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 435

def text_area(attribute, options = {})
  field(attribute, options) do |opts|
    opts.delete(:pattern)
    @template.send(
      :text_area,
      @object_name,
      attribute,
      objectify_options(opts)
    )
  end
end

#translated(type, name, options = {}) ⇒ Object

Public: Generates a form field for each locale.

type - The form field’s type, like ‘text_area` or `text_field` name - The name of the field options - The set of options to send to the field

Renders form fields for each locale.



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
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 63

def translated(type, name, options = {})
  return translated_one_locale(type, name, locales.first, options.merge(label: options[:label] || label_for(name))) if locales.count == 1

  tabs_id = sanitize_tabs_selector(options[:tabs_id] || "#{object_name}-#{name}-tabs")

  label_tabs = content_tag(:div, class: "label--tabs") do
    field_label = label_i18n(name, options[:label] || label_for(name), required: options[:required])

    language_selector = "".html_safe
    language_selector = create_language_selector(locales, tabs_id, name) if options[:label] != false

    safe_join [field_label, language_selector]
  end

  tabs_content = content_tag(:div, class: "tabs-content", data: { tabs_content: tabs_id }) do
    locales.each_with_index.inject("".html_safe) do |string, (locale, index)|
      tab_content_id = "#{tabs_id}-#{name}-panel-#{index}"
      string + content_tag(:div, class: tab_element_class_for("panel", index), id: tab_content_id, "aria-hidden": tab_attr_aria_hidden_for(index)) do
        send(type, name_with_locale(name, locale), options.merge(label: false))
      end
    end
  end

  safe_join [label_tabs, tabs_content]
end

#translated_one_locale(type, name, locale, options = {}) ⇒ Object 



111
112
113
114
115
116
117
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 111

def translated_one_locale(type, name, locale, options = {})
  send(
    type,
    "#{name}_#{locale.to_s.gsub("-", "__")}",
    options.merge(label: options[:label] || label_for(name))
  )
end

#upload(attribute, options = {}) ⇒ Object

Public: Generates a file upload field and sets the form as multipart. If the file is an image it displays the default image if present or the current one. By default it also generates a button to replace the file.

attribute - The String name of the attribute to build the field. options - A Hash with options to build the field.

* max_file_size: Maximum size for the file (If you really want to change max
   file size you should probably change it in validator).
* resource_name: Name of the resource (e.g. user)
* resource_class: Attribute's resource class (e.g. Decidim::User)
* resource_class: Class of the resource (e.g. user)
* required: Whether the file is required or not (false by default).
* titled: Whether the file can have title or not.
* show_current: Whether the current file is displayed next to the button.
* help: Array of help messages which are displayed inside of the upload modal.
* dimensions_info: Hash about resize dimensions (e.g. {:medium=>{:processor=>:resize_to_fit, :dimensions=>[600, 160]}})
   produces 'Resized to fit 600 x 160 px.'
* extension_allowlist: Array of allowed file extensions (e.g. %w(jpeg jpg png))
* label: Label for the attribute
* button_label: Label for the button
* button_edit_label: Button label when file is already selected.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 349

def upload(attribute, options = {})
  self.multipart = true
  max_file_size = options[:max_file_size] || max_file_size(object, attribute)
  button_label = options[:button_label] || choose_button_label(attribute)
  help_messages = options[:help] || upload_help(object, attribute, options)

  options = {
    attribute:,
    resource_name: @object_name,
    resource_class: options[:resource_class]&.to_s || resource_class(attribute),
    required: false,
    titled: false,
    show_current: true,
    max_file_size:,
    help: help_messages,
    label: label_for(attribute),
    button_label:,
    button_edit_label: I18n.t("decidim.forms.upload.labels.replace")
  }.merge(options)

  ::Decidim::ViewModel.cell(
    "decidim/upload_modal",
    self,
    options
  ).call
end

#upload_help(record, attribute, options = {}) ⇒ Object 



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'decidim-core/lib/decidim/form_builder.rb', line 392

def upload_help(record, attribute, options = {})
  humanizer = FileValidatorHumanizer.new(record, attribute)

  help_scope = if options[:help_i18n_scope].present?
                 options[:help_i18n_scope]
               elsif humanizer.uploader.is_a?(Decidim::ImageUploader)
                 "decidim.forms.file_help.image"
               else
                 "decidim.forms.file_help.file"
               end

  help_messages = if options[:help_i18n_messages].present?
                    Array(options[:help_i18n_messages])
                  else
                    %w(message_1 message_2)
                  end

  help_messages = help_messages.each.map { |msg| I18n.t(msg, scope: help_scope) } + humanizer.messages
  help_messages += extension_allowlist_help(options[:extension_allowlist]) if options[:extension_allowlist]
  help_messages += image_dimensions_help(options[:dimensions_info]) if options[:dimensions_info]
  help_messages
end