govuk_design_system_formbuilder 1.2.0 → 1.2.5

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -9,35 +9,37 @@ module GOVUKDesignSystemFormBuilder
 
       SEGMENTS = { day: '3i', month: '2i', year: '1i' }.freeze
 
-      def initialize(builder, object_name, attribute_name, legend:, caption:, hint_text:, date_of_birth: false, omit_day:, &block)
+      def initialize(builder, object_name, attribute_name, legend:, caption:, hint_text:, date_of_birth: false, omit_day:, form_group_classes:, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @legend        = legend
-        @caption       = caption
-        @hint_text     = hint_text
-        @date_of_birth = date_of_birth
-        @omit_day      = omit_day
+        @legend             = legend
+        @caption            = caption
+        @hint_text          = hint_text
+        @date_of_birth      = date_of_birth
+        @omit_day           = omit_day
+        @form_group_classes = form_group_classes
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, caption: @caption, described_by: [error_id, hint_id, supplemental_id]).html do
-            safe_join(
-              [
-                supplemental_content.html,
-                hint_element.html,
-                error_element.html,
-                content_tag('div', class: %(#{brand}-date-input)) do
-                  safe_join([day, month, year])
-                end
-              ]
-            )
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
+            safe_join([supplemental_content, hint_element, error_element, date])
           end
         end
       end
 
     private
 
+      def fieldset_options
+        { legend: @legend, caption: @caption, described_by: [error_id, hint_id, supplemental_id] }
+      end
+
+      def date
+        content_tag('div', class: %(#{brand}-date-input)) do
+          safe_join([day, month, year])
+        end
+      end
+
       def omit_day?
         @omit_day
       end
@@ -45,61 +47,59 @@ module GOVUKDesignSystemFormBuilder
       def day
         return nil if omit_day?
 
-        date_input_item(:day, link_errors: true)
+        date_part(:day, width: 2, link_errors: true)
       end
 
       def month
-        date_input_item(:month, link_errors: omit_day?)
+        date_part(:month, width: 2, link_errors: omit_day?)
       end
 
       def year
-        date_input_item(:year, width: 4)
+        date_part(:year, width: 4)
       end
 
-      def date_input_item(segment, width: 2, link_errors: false)
+      def date_part(segment, width:, link_errors: false)
         value = @builder.object.try(@attribute_name).try(segment)
 
         content_tag('div', class: %w(date-input__item).prefix(brand)) do
           content_tag('div', class: %w(form-group).prefix(brand)) do
-            safe_join(
-              [
-                tag.label(
-                  segment.capitalize,
-                  class: date_input_label_classes,
-                  for: date_attribute_id(segment, link_errors)
-                ),
-
-                tag.input(
-                  id: date_attribute_id(segment, link_errors),
-                  class: date_input_classes(width),
-                  name: date_attribute_name(segment),
-                  type: 'text',
-                  pattern: '[0-9]*',
-                  inputmode: 'numeric',
-                  value: value,
-                  autocomplete: date_of_birth_autocomplete_value(segment)
-                )
-              ]
-            )
+            safe_join([label(segment, link_errors), input(segment, link_errors, width, value)])
           end
         end
       end
 
-      def date_input_classes(width)
+      def label(segment, link_errors)
+        tag.label(
+          segment.capitalize,
+          class: label_classes,
+          for: id(segment, link_errors)
+        )
+      end
+
+      def input(segment, link_errors, width, value)
+        tag.input(
+          id: id(segment, link_errors),
+          class: classes(width),
+          name: name(segment),
+          type: 'text',
+          pattern: '[0-9]*',
+          inputmode: 'numeric',
+          value: value,
+          autocomplete: date_of_birth_autocomplete_value(segment)
+        )
+      end
+
+      def classes(width)
         %w(input date-input__input).prefix(brand).tap do |classes|
           classes.push(%(#{brand}-input--width-#{width}))
           classes.push(%(#{brand}-input--error)) if has_errors?
         end
       end
 
-      def date_input_label_classes
-        %w(label date-input__label).prefix(brand)
-      end
-
       # if the field has errors we want the govuk_error_summary to
       # be able to link to the day field. Otherwise, generate IDs
       # in the normal fashion
-      def date_attribute_id(segment, link_errors)
+      def id(segment, link_errors)
         if has_errors? && link_errors
           field_id(link_errors: link_errors)
         else
@@ -107,11 +107,11 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
-      def date_attribute_name(segment)
+      def name(segment)
         format(
-          "%<object_name>s[%<attribute_name>s(%<segment>s)]",
+          "%<object_name>s[%<input_name>s(%<segment>s)]",
           object_name: @object_name,
-          attribute_name: @attribute_name,
+          input_name: @attribute_name,
           segment: SEGMENTS.fetch(segment)
         )
       end
@@ -121,6 +121,10 @@ module GOVUKDesignSystemFormBuilder
 
         { day: 'bday-day', month: 'bday-month', year: 'bday-year' }.fetch(segment)
       end
+
+      def label_classes
+        %w(label date-input__label).prefix(brand)
+      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -13,15 +13,16 @@ module GOVUKDesignSystemFormBuilder
         return nil unless has_errors?
 
         content_tag('span', class: %(#{brand}-error-message), id: error_id) do
-          safe_join(
-            [
-              tag.span('Error: ', class: %(#{brand}-visually-hidden)),
-              message
-            ]
-          )
+          safe_join([prefix, message])
         end
       end
 
+    private
+
+      def prefix
+        tag.span('Error: ', class: %(#{brand}-visually-hidden))
+      end
+
       def message
         @builder.object.errors.messages[@attribute_name]&.first
       end

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -12,38 +12,35 @@ module GOVUKDesignSystemFormBuilder
       def html
         return nil unless object_has_errors?
 
-        content_tag('div', class: summary_class, **error_summary_attributes) do
-          safe_join(
-            [
-              tag.h2(@title, id: error_summary_title_id, class: summary_class('title')),
-              content_tag('div', class: summary_class('body')) do
-                content_tag('ul', class: [%(#{brand}-list), summary_class('list')]) do
-                  safe_join(
-                    @builder.object.errors.messages.map do |attribute, messages|
-                      error_list_item(attribute, messages.first)
-                    end
-                  )
-                end
-              end
-            ]
-          )
+        content_tag('div', class: summary_class, **summary_options) do
+          safe_join([title, summary])
         end
       end
 
     private
 
-      def error_list_item(attribute, message)
-        content_tag('li') do
-          link_to(
-            message,
-            same_page_link(field_id(attribute)),
-            data: {
-              turbolinks: false
-            }
-          )
+      def title
+        tag.h2(@title, id: summary_title_id, class: summary_class('title'))
+      end
+
+      def summary
+        content_tag('div', class: summary_class('body')) do
+          content_tag('ul', class: [%(#{brand}-list), summary_class('list')]) do
+            safe_join(list)
+          end
         end
       end
 
+      def list
+        @builder.object.errors.messages.map do |attribute, messages|
+          list_item(attribute, messages.first)
+        end
+      end
+
+      def list_item(attribute, message)
+        tag.li(link_to(message, same_page_link(field_id(attribute)), data: { turbolinks: false }))
+      end
+
       def same_page_link(target)
         '#'.concat(target)
       end
@@ -60,7 +57,7 @@ module GOVUKDesignSystemFormBuilder
         build_id('field-error', attribute_name: attribute)
       end
 
-      def error_summary_title_id
+      def summary_title_id
         'error-summary-title'
       end
 
@@ -68,7 +65,7 @@ module GOVUKDesignSystemFormBuilder
         @builder.object.errors.any?
       end
 
-      def error_summary_attributes
+      def summary_options
         {
           tabindex: -1,
           role: 'alert',
@@ -76,7 +73,7 @@ module GOVUKDesignSystemFormBuilder
             module: %(#{brand}-error-summary)
           },
           aria: {
-            labelledby: error_summary_title_id
+            labelledby: summary_title_id
           }
         }
       end

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -8,38 +8,37 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Label
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, **extra_args, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, form_group_classes:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @label      = label
-        @caption    = caption
-        @hint_text  = hint_text
-        @extra_args = extra_args
+        @label              = label
+        @caption            = caption
+        @hint_text          = hint_text
+        @extra_options      = kwargs
+        @form_group_classes = form_group_classes
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          safe_join(
-            [
-              label_element.html,
-              supplemental_content.html,
-              hint_element.html,
-              error_element.html,
-              @builder.file_field(
-                @attribute_name,
-                id: field_id(link_errors: true),
-                class: file_classes,
-                aria: { describedby: described_by(hint_id, error_id, supplemental_id) },
-                **@extra_args
-              )
-            ]
-          )
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
+          safe_join([label_element, supplemental_content, hint_element, error_element, file])
         end
       end
 
     private
 
-      def file_classes
+      def file
+        @builder.file_field(@attribute_name, **options, **@extra_options)
+      end
+
+      def options
+        {
+          id: field_id(link_errors: true),
+          class: classes,
+          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+        }
+      end
+
+      def classes
         %w(file-upload).prefix(brand).tap do |c|
           c.push(%(#{brand}-file-upload--error)) if has_errors?
         end

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -9,37 +9,34 @@ module GOVUKDesignSystemFormBuilder
       def initialize(builder, object_name, attribute_name, text, value = nil, radio: false, checkbox: false)
         super(builder, object_name, attribute_name)
 
-        @value          = value
-        @hint_text      = hint_text(text)
-        @radio_class    = radio_class(radio)
-        @checkbox_class = checkbox_class(checkbox)
+        @value     = value
+        @hint_text = retrieve_text(text)
+        @radio     = radio
+        @checkbox  = checkbox
       end
 
       def html
         return nil if @hint_text.blank?
 
-        tag.span(@hint_text, class: hint_classes, id: hint_id)
+        tag.span(@hint_text, class: classes, id: hint_id)
       end
 
     private
 
-      def hint_text(supplied)
-        [
-          supplied.presence,
-          localised_text(:hint)
-        ].compact.first
+      def retrieve_text(supplied)
+        supplied.presence || localised_text(:hint)
       end
 
-      def hint_classes
-        %w(hint).prefix(brand).push(@radio_class, @checkbox_class).compact
+      def classes
+        %w(hint).prefix(brand).push(radio_class, checkbox_class).compact
       end
 
-      def radio_class(radio)
-        radio ? %(#{brand}-radios__hint) : nil
+      def radio_class
+        @radio ? %(#{brand}-radios__hint) : nil
       end
 
-      def checkbox_class(checkbox)
-        checkbox ? %(#{brand}-checkboxes__hint) : nil
+      def checkbox_class
+        @checkbox ? %(#{brand}-checkboxes__hint) : nil
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/inputs/email.rb

@@ -10,6 +10,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Label
         include Traits::Supplemental
 
+      private
+
         def builder_method
           :email_field
         end

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -14,14 +14,14 @@ module GOVUKDesignSystemFormBuilder
         if content
           @content = content.call
         else
-          @value          = value # used by field_id
-          @text           = label_text(text, hidden)
-          @size_class     = label_size_class(size)
-          @radio_class    = radio_class(radio)
-          @checkbox_class = checkbox_class(checkbox)
-          @tag            = tag
-          @link_errors    = link_errors
-          @caption        = caption
+          @value       = value # used by field_id
+          @text        = retrieve_text(text, hidden)
+          @size_class  = size_class(size)
+          @radio       = radio
+          @checkbox    = checkbox
+          @tag         = tag
+          @link_errors = link_errors
+          @caption     = caption
         end
       end
 
@@ -29,26 +29,21 @@ module GOVUKDesignSystemFormBuilder
         return nil if [@content, @text].all?(&:blank?)
 
         if @tag.present?
-          content_tag(@tag, class: %(#{brand}-label-wrapper)) { build_label }
+          content_tag(@tag, class: %(#{brand}-label-wrapper)) { label }
         else
-          build_label
+          label
         end
       end
 
     private
 
-      def build_label
-        @builder.label(
-          @attribute_name,
-          value: @value,
-          for: field_id(link_errors: @link_errors),
-          class: %w(label).prefix(brand).push(@size_class, @weight_class, @radio_class, @checkbox_class).compact
-        ) do
-          @content || safe_join([caption_element.html, @text])
+      def label
+        @builder.label(@attribute_name, **options) do
+          @content || safe_join([caption, @text])
         end
       end
 
-      def label_text(option_text, hidden)
+      def retrieve_text(option_text, hidden)
         text = [option_text, localised_text(:label), @attribute_name.capitalize].compact.first.to_s
 
         if hidden
@@ -58,21 +53,37 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
-      def radio_class(radio)
-        radio ? %(#{brand}-radios__label) : nil
+      def options
+        {
+          value: @value,
+          for: field_id(link_errors: @link_errors),
+          class: %w(label).prefix(brand).push(@size_class, @weight_class, radio_class, checkbox_class).compact
+        }
+      end
+
+      def caption
+        caption_element.html unless [@radio, @checkbox].any?
       end
 
-      def checkbox_class(checkbox)
-        checkbox ? %(#{brand}-checkboxes__label) : nil
+      def radio_class
+        return nil unless @radio
+
+        %(#{brand}-radios__label)
+      end
+
+      def checkbox_class
+        return nil unless @checkbox
+
+        %(#{brand}-checkboxes__label)
       end
 
-      def label_size_class(size)
+      def size_class(size)
         case size
-        when 'xl'      then %(#{brand}-label--xl)
-        when 'l'       then %(#{brand}-label--l)
-        when 'm'       then %(#{brand}-label--m)
-        when 's'       then %(#{brand}-label--s)
-        when nil       then nil
+        when 'xl' then %(#{brand}-label--xl)
+        when 'l'  then %(#{brand}-label--l)
+        when 'm'  then %(#{brand}-label--m)
+        when 's'  then %(#{brand}-label--s)
+        when nil  then nil
         else
           fail "invalid size '#{size}', must be xl, l, m, s or nil"
         end