Class: Decidim::FormBuilder
- Inherits:
-
FoundationRailsHelper::FormBuilder
- Object
- FoundationRailsHelper::FormBuilder
- Decidim::FormBuilder
- Includes:
- ActionView::Context, Map::Autocomplete::FormBuilder, TranslatableAttributes
- Defined in:
- lib/decidim/form_builder.rb
Overview
This custom FormBuilder adds fields needed to deal with translatable fields, following the conventions set on ‘Decidim::TranslatableAttributes`.
Direct Known Subclasses
Instance Method Summary collapse
-
#areas_select(name, collection, options = {}, html_options = {}) ⇒ Object
Public: Generates a select field for areas.
-
#categories_select(name, collection, options = {}, html_options = {}) ⇒ Object
Public: Generates a select field with the categories.
-
#check_box(attribute, options = {}, checked_value = "1", unchecked_value = "0") ⇒ Object
Public: Override so checkboxes are rendered before the label.
-
#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.
-
#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.
-
#create_language_selector(locales, tabs_id, name) ⇒ Object
rubocop:enable Metrics/ParameterLists.
-
#data_picker(attribute, options = {}, prompt_params = {}) ⇒ Object
Public: Generates a picker field for selection (either simple or multiselect).
-
#date_field(attribute, options = {}) ⇒ Object
Public: Override so the date fields are rendered using foundation datepicker library.
-
#datetime_field(attribute, options = {}) ⇒ Object
Public: Generates a timepicker field using foundation datepicker library.
-
#editor(name, options = {}) ⇒ Object
Public: generates a hidden field and a container for WYSIWYG editor.
- #form_field_for(attribute, options = {}) ⇒ Object
-
#hashtaggable_text_field(type, name, locale, options = {}) ⇒ Object
Public: Generates a field for hashtaggable type.
-
#label_for(attribute) ⇒ Object
Public: Returns the translated name for the given attribute.
-
#resources_select(name, collection, options = {}) ⇒ Object
Public: Generates a select field for resource types.
-
#scopes_picker(attribute, options = {}) ⇒ Object
Public: Generates a picker field for scope selection.
-
#social_field(type, name, handlers, options = {}) ⇒ Object
Public: Generates an form field for each social.
-
#text_area(attribute, options = {}) ⇒ Object
Discard the pattern attribute which is not allowed for textarea elements.
-
#translated(type, name, options = {}) ⇒ Object
Public: Generates an form field for each locale.
- #translated_one_locale(type, name, locale, options = {}) ⇒ Object
-
#upload(attribute, options = {}) ⇒ Object
Public: Generates a file upload field and sets the form as multipart.
-
#upload_help(attribute, options = {}) ⇒ Object
rubocop:enable Metrics/CyclomaticComplexity rubocop:enable Metrics/PerceivedComplexity.
Methods included from Map::Autocomplete::FormBuilder
Methods included from TranslatableAttributes
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's areas, we sort the selectable options alphabetically.
Returns a String.
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/decidim/form_builder.rb', line 238 def areas_select(name, collection, = {}, = {}) 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.( assemblies, selected: [:selected] ) else @template.option_groups_from_collection_for_select( collection, :areas, :translated_name, :id, :translated_name, selected: [:selected] ) end select(name, selectables, , ) end |
#categories_select(name, collection, options = {}, html_options = {}) ⇒ Object
Public: Generates a select field with the categories. Only leaf categories can be set as selected.
name - The name of the field (usually category_id) collection - A collection of categories. options - An optional Hash with options:
-
prompt - An optional String with the text to display as prompt.
-
disable_parents - A Boolean to disable parent categories. Defaults to ‘true`.
html_options - HTML options for the select
Returns a String.
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/decidim/form_builder.rb', line 212 def categories_select(name, collection, = {}, = {}) = { disable_parents: true }.merge() disable_parents = [:disable_parents] selected = object.send(name) selected = selected.first if selected.is_a?(Array) && selected.length > 1 categories = categories_for_select(collection) disabled = if disable_parents disabled_categories_for(collection) else [] end select(name, @template.(categories, selected: selected, disabled: disabled), , ) end |
#check_box(attribute, options = {}, checked_value = "1", unchecked_value = "0") ⇒ Object
Public: Override so checkboxes are rendered before the label.
351 352 353 354 355 356 357 |
# File 'lib/decidim/form_builder.rb', line 351 def check_box(attribute, = {}, checked_value = "1", unchecked_value = "0") custom_label(attribute, [:label], [:label_options], field_before_label: true) do .delete(:label) .delete(:label_options) @template.check_box(@object_name, attribute, (), checked_value, unchecked_value) end + error_and_help_text(attribute, ) 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
27 28 29 |
# File 'lib/decidim/form_builder.rb', line 27 def collection_check_boxes(attribute, collection, value_attribute, text_attribute, = {}, = {}) super + error_and_help_text(attribute, ) 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
44 45 46 |
# File 'lib/decidim/form_builder.rb', line 44 def (attribute, collection, value_attribute, text_attribute, = {}, = {}) super + error_and_help_text(attribute, ) end |
#create_language_selector(locales, tabs_id, name) ⇒ Object
rubocop:enable Metrics/ParameterLists
49 50 51 52 53 54 55 |
# File 'lib/decidim/form_builder.rb', line 49 def create_language_selector(locales, tabs_id, name) if Decidim.available_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.
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
# File 'lib/decidim/form_builder.rb', line 332 def data_picker(attribute, = {}, prompt_params = {}) = { id: "#{@object_name}_#{attribute}", class: "picker-#{[:multiple] ? "multiple" : "single"}", name: [:name] || "#{@object_name}[#{attribute}]" } [:class] += " is-invalid-input" if error?(attribute) [:class] += " picker-autosort" if [:autosort] items = object.send(attribute).collect { |item| [item, yield(item)] } template = "" template += label(attribute, label_for(attribute) + required_for_attribute(attribute)) unless [:label] == false template += @template.render("decidim/widgets/data_picker", picker_options: , prompt_params: prompt_params, items: items) template += error_and_help_text(attribute, ) template.html_safe end |
#date_field(attribute, options = {}) ⇒ Object
Public: Override so the date fields are rendered using foundation datepicker library
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/decidim/form_builder.rb', line 361 def date_field(attribute, = {}) value = object.send(attribute) data = { datepicker: "" } data[:startdate] = I18n.l(value, format: :decidim_short) if value.present? && value.is_a?(Date) datepicker_format = ruby_format_to_datepicker(I18n.t("date.formats.decidim_short")) data[:"date-format"] = datepicker_format template = text_field( attribute, .merge(data: data) ) help_text = I18n.t("decidim.datepicker.help_text", datepicker_format: datepicker_format) template += error_and_help_text(attribute, .merge(help_text: help_text)) template.html_safe end |
#datetime_field(attribute, options = {}) ⇒ Object
Public: Generates a timepicker field using foundation datepicker library
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/decidim/form_builder.rb', line 379 def datetime_field(attribute, = {}) value = object.send(attribute) data = { datepicker: "", timepicker: "" } data[:startdate] = I18n.l(value, format: :decidim_short) if value.present? && value.is_a?(ActiveSupport::TimeWithZone) datepicker_format = ruby_format_to_datepicker(I18n.t("time.formats.decidim_short")) data[:"date-format"] = datepicker_format template = text_field( attribute, .merge(data: data) ) help_text = I18n.t("decidim.datepicker.help_text", datepicker_format: datepicker_format) template += content_tag(:span, help_text, class: "help-text") template.html_safe 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)
:disabled - Whether the editor should be disabled
Renders a container with both hidden field and editor container
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/decidim/form_builder.rb', line 179 def editor(name, = {}) [:disabled] ||= false = .delete(:toolbar) || "basic" lines = .delete(:lines) || 10 label_text = [:label].to_s label_text = label_for(name) if label_text.blank? .delete(:required) hashtaggable = .delete(:hashtaggable) = extract_validations(name, ).merge() content_tag(:div, class: "editor #{"hashtags__container" if hashtaggable}") do template = "" template += label(name, label_text + required_for_attribute(name)) if .fetch(:label, true) template += hidden_field(name, ) template += content_tag(:div, nil, class: "editor-container #{"js-hashtags" if hashtaggable}", data: { toolbar: , disabled: [:disabled] }, style: "height: #{lines}rem") template += error_for(name, ) if error?(name) template.html_safe end end |
#form_field_for(attribute, options = {}) ⇒ Object
495 496 497 498 499 500 501 |
# File 'lib/decidim/form_builder.rb', line 495 def form_field_for(attribute, = {}) if attribute == :body text_area(attribute, .merge(rows: 10)) else text_field(attribute, ) end end |
#hashtaggable_text_field(type, name, locale, options = {}) ⇒ Object
Public: Generates a field for hashtaggable type. type - The form field’s type, like ‘text_area` or `text_input` 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.
114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/decidim/form_builder.rb', line 114 def hashtaggable_text_field(type, name, locale, = {}) [:hashtaggable] = true if type.to_sym == :editor content_tag(:div, class: "hashtags__container") do if [:value] send(type, name_with_locale(name, locale), .merge(label: [:label], value: [:value][locale])) else send(type, name_with_locale(name, locale), .merge(label: [:label])) end 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.
487 488 489 490 491 492 493 |
# File 'lib/decidim/form_builder.rb', line 487 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 |
#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.
269 270 271 272 273 274 275 276 |
# File 'lib/decidim/form_builder.rb', line 269 def resources_select(name, collection, = {}) resources = collection .map { |r| [I18n.t(r.split("::").last.underscore, scope: "decidim.components.component_order_selector.order"), r] } .sort select(name, @template.(resources, selected: [:selected]), ) end |
#scopes_picker(attribute, options = {}) ⇒ Object
Public: Generates a picker field for scope selection.
attribute - The name of the field (usually scope_id) options - An optional Hash with options:
-
multiple - Multiple mode, to allow multiple scopes selection.
-
label - Show label?
-
checkboxes_on_top - Show checked picker values on top (default) or below the picker prompt (only for multiple pickers)
-
namespace - prepend a custom name to the html element’s DOM id.
Also it should receive a block that returns a Hash with :url and :text for each selected scope (and for null scope for prompt)
Returns a String.
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/decidim/form_builder.rb', line 290 def scopes_picker(attribute, = {}) id = if self..has_key?(:namespace) "#{self.[:namespace]}_#{sanitize_for_dom_selector(@object_name)}" else "#{sanitize_for_dom_selector(@object_name)}_#{attribute}" end = { id: id, class: "picker-#{[:multiple] ? "multiple" : "single"}", name: "#{@object_name}[#{attribute}]" } [:class] += " is-invalid-input" if error?(attribute) prompt_params = yield(nil) scopes = selected_scopes(attribute).map { |scope| [scope, yield(scope)] } template = "" template += "<label>#{label_for(attribute) + required_for_attribute(attribute)}</label>" unless [:label] == false template += @template.render("decidim/scopes/scopes_picker_input", picker_options: , prompt_params: prompt_params, scopes: scopes, values_on_top: ![:multiple] || [:checkboxes_on_top]) template += error_and_help_text(attribute, ) template.html_safe end |
#social_field(type, name, handlers, options = {}) ⇒ Object
Public: Generates an form field for each social.
type - The form field’s type, like ‘text_area` or `text_input` 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.
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 160 161 162 163 164 165 166 |
# File 'lib/decidim/form_builder.rb', line 134 def (type, name, handlers, = {}) tabs_id = sanitize_tabs_selector([:tabs_id] || "#{object_name}-#{name}-tabs") label_tabs = content_tag(:div, class: "label--tabs") do field_label = label_i18n(name, [:label] || label_for(name)) tabs_panels = "".html_safe if [: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) do send(type, "#{handler}_handler", .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.
504 505 506 507 508 509 510 511 512 513 514 |
# File 'lib/decidim/form_builder.rb', line 504 def text_area(attribute, = {}) field(attribute, ) do |opts| opts.delete(:pattern) @template.send( :text_area, @object_name, attribute, (opts) ) end end |
#translated(type, name, options = {}) ⇒ Object
Public: Generates an form field for each locale.
type - The form field’s type, like ‘text_area` or `text_input` name - The name of the field options - The set of options to send to the field
Renders form fields for each locale.
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 |
# File 'lib/decidim/form_builder.rb', line 64 def translated(type, name, = {}) return translated_one_locale(type, name, locales.first, .merge(label: ([:label] || label_for(name)))) if locales.count == 1 tabs_id = sanitize_tabs_selector([:tabs_id] || "#{object_name}-#{name}-tabs") label_tabs = content_tag(:div, class: "label--tabs") do field_label = label_i18n(name, [:label] || label_for(name)) language_selector = "".html_safe language_selector = create_language_selector(locales, tabs_id, name) if [:label] != false safe_join [field_label, language_selector] end hashtaggable = .delete(:hashtaggable) 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) do if hashtaggable hashtaggable_text_field(type, name, locale, .merge(label: false)) elsif type.to_sym == :editor send(type, name_with_locale(name, locale), .merge(label: false, hashtaggable: hashtaggable)) else send(type, name_with_locale(name, locale), .merge(label: false)) end end end end safe_join [label_tabs, tabs_content] end |
#translated_one_locale(type, name, locale, options = {}) ⇒ Object
97 98 99 100 101 102 103 104 105 |
# File 'lib/decidim/form_builder.rb', line 97 def translated_one_locale(type, name, locale, = {}) return hashtaggable_text_field(type, name, locale, ) if .delete(:hashtaggable) send( type, "#{name}_#{locale.to_s.gsub("-", "__")}", .merge(label: [: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 checkbox to delete the file. This checkbox can be hidden if ‘options` is passed as `false`.
attribute - The String name of the attribute to buidl the field. options - A Hash with options to build the field.
* optional: Whether the file can be optional or not.
rubocop:disable Metrics/CyclomaticComplexity rubocop:disable Metrics/PerceivedComplexity
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/decidim/form_builder.rb', line 405 def upload(attribute, = {}) self.multipart = true [:optional] = [:optional].nil? ? true : [:optional] label_text = [:label] || label_for(attribute) alt_text = label_text file = object.send attribute template = "" template += label(attribute, label_text + required_for_attribute(attribute)) template += upload_help(attribute, ) template += @template.file_field @object_name, attribute template += extension_allowlist_help([:extension_allowlist]) if [:extension_allowlist].present? template += image_dimensions_help([:dimensions_info]) if [:dimensions_info].present? if file_is_image?(file) template += if file.present? @template.content_tag :label, I18n.t("current_image", scope: "decidim.forms") else @template.content_tag :label, I18n.t("default_image", scope: "decidim.forms") end template += @template.link_to @template.image_tag(file.url, alt: alt_text), file.url, target: "_blank", rel: "noopener" elsif file_is_present?(file) template += @template.label_tag I18n.t("current_file", scope: "decidim.forms") template += @template.link_to file.file.filename, file.url, target: "_blank", rel: "noopener" end if file_is_present?(file) && [:optional] template += content_tag :div, class: "field" do safe_join([ @template.check_box(@object_name, "remove_#{attribute}"), label("remove_#{attribute}", I18n.t("remove_this_file", scope: "decidim.forms")) ]) end end if object.errors[attribute].any? template += content_tag :p, class: "is-invalid-label" do safe_join object.errors[attribute], "<br/>".html_safe end end template.html_safe end |
#upload_help(attribute, options = {}) ⇒ Object
rubocop:enable Metrics/CyclomaticComplexity rubocop:enable Metrics/PerceivedComplexity
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 |
# File 'lib/decidim/form_builder.rb', line 452 def upload_help(attribute, = {}) humanizer = FileValidatorHumanizer.new(object, attribute) help_scope = begin if [:help_i18n_scope].present? [:help_i18n_scope] elsif humanizer.uploader.is_a?(Decidim::ImageUploader) "decidim.forms.file_help.image" else "decidim.forms.file_help.file" end end = begin if [:help_i18n_messages].present? Array([:help_i18n_messages]) else %w(message_1 message_2) end end content_tag(:div, class: "help-text") do inner = "<p>#{I18n.t("explanation", scope: help_scope)}</p>".html_safe inner + content_tag(:ul) do = .each.map { |msg| I18n.t(msg, scope: help_scope) } += humanizer. .map { |msg| content_tag(:li, msg) }.join("\n").html_safe end.html_safe end end |