govuk_design_system_formbuilder 1.2.0b1 → 1.2.2

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -13,16 +13,17 @@ 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([error_prefix, error_message])
         end
       end
 
-      def message
+    private
+
+      def error_prefix
+        tag.span('Error: ', class: %(#{brand}-visually-hidden))
+      end
+
+      def error_message
         @builder.object.errors.messages[@attribute_name]&.first
       end
     end

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -12,43 +12,40 @@ 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: error_summary_class, **error_summary_options) do
+          safe_join([error_title, error_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 error_title
+        tag.h2(@title, id: error_summary_title_id, class: error_summary_class('title'))
+      end
+
+      def error_summary
+        content_tag('div', class: error_summary_class('body')) do
+          content_tag('ul', class: [%(#{brand}-list), error_summary_class('list')]) do
+            safe_join(error_list)
+          end
         end
       end
 
+      def error_list
+        @builder.object.errors.messages.map do |attribute, messages|
+          error_list_item(attribute, messages.first)
+        end
+      end
+
+      def error_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
 
-      def summary_class(part = nil)
+      def error_summary_class(part = nil)
         if part
           %(#{brand}-error-summary).concat('__', part)
         else
@@ -68,7 +65,7 @@ module GOVUKDesignSystemFormBuilder
         @builder.object.errors.any?
       end
 
-      def error_summary_attributes
+      def error_summary_options
         {
           tabindex: -1,
           role: 'alert',

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -8,36 +8,35 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Label
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, **extra_args, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @label      = label
-        @hint_text  = hint_text
-        @extra_args = extra_args
+        @label         = label
+        @caption       = caption
+        @hint_text     = hint_text
+        @extra_options = kwargs
       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
-              )
-            ]
-          )
+          safe_join([label_element, supplemental_content, hint_element, error_element, file])
         end
       end
 
     private
 
+      def file
+        @builder.file_field(@attribute_name, **file_options, **@extra_options)
+      end
+
+      def file_options
+        {
+          id: field_id(link_errors: true),
+          class: file_classes,
+          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+        }
+      end
+
       def file_classes
         %w(file-upload).prefix(brand).tap do |c|
           c.push(%(#{brand}-file-upload--error)) if has_errors?

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -24,10 +24,7 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def hint_text(supplied)
-        [
-          supplied.presence,
-          localised_text(:hint)
-        ].compact.first
+        [supplied.presence, localised_text(:hint)].compact.first
       end
 
       def hint_classes

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -3,40 +3,43 @@ module GOVUKDesignSystemFormBuilder
     class Label < Base
       using PrefixableArray
 
+      include Traits::Caption
       include Traits::Localisation
 
-      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, hidden: false, radio: false, checkbox: false, tag: nil, link_errors: true)
+      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, hidden: false, radio: false, checkbox: false, tag: nil, link_errors: true, content: nil, caption: nil)
         super(builder, object_name, attribute_name)
 
-        @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
+        # content is passed in directly via a proc and overrides
+        # the other display options
+        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
+        end
       end
 
       def html
-        return nil if @text.blank?
+        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
-          @text
+      def label
+        @builder.label(@attribute_name, label_options) do
+          @content || safe_join([caption_element.html, @text])
         end
       end
 
@@ -50,6 +53,14 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
+      def label_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 radio_class(radio)
         radio ? %(#{brand}-radios__label) : nil
       end

data/lib/govuk_design_system_formbuilder/elements/radios/collection.rb

@@ -6,7 +6,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Supplemental
 
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint_text:, legend:, inline:, small:, bold_labels:, classes:, &block)
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint_text:, legend:, caption:, inline:, small:, bold_labels:, classes:, &block)
           super(builder, object_name, attribute_name, &block)
 
           @collection    = collection
@@ -16,6 +16,7 @@ module GOVUKDesignSystemFormBuilder
           @inline        = inline
           @small         = small
           @legend        = legend
+          @caption       = caption
           @hint_text     = hint_text
           @classes       = classes
           @bold_labels   = hint_method.present? || bold_labels
@@ -23,38 +24,39 @@ module GOVUKDesignSystemFormBuilder
 
         def html
           Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-            Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
-              safe_join(
-                [
-                  supplemental_content.html,
-                  hint_element.html,
-                  error_element.html,
-                  Containers::Radios.new(@builder, inline: @inline, small: @small, classes: @classes).html do
-                    safe_join(build_collection)
-                  end
-                ]
-              )
+            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, hint_element, error_element, radios])
             end
           end
         end
 
       private
 
-        def build_collection
+        def radios
+          Containers::Radios.new(@builder, inline: @inline, small: @small, classes: @classes).html do
+            safe_join(collection)
+          end
+        end
+
+        def collection
           @collection.map.with_index do |item, i|
-            Elements::Radios::CollectionRadioButton.new(
-              @builder,
-              @object_name,
-              @attribute_name,
-              item,
-              value_method: @value_method,
-              text_method: @text_method,
-              hint_method: @hint_method,
-              link_errors: has_errors? && i.zero?,
-              bold_labels: @bold_labels
-            ).html
+            Elements::Radios::CollectionRadioButton.new(@builder, @object_name, @attribute_name, item, **collection_options(i)).html
           end
         end
+
+        def collection_options(index)
+          {
+            value_method: @value_method,
+            text_method: @text_method,
+            hint_method: @hint_method,
+            link_errors: link_errors?(index),
+            bold_labels: @bold_labels
+          }
+        end
+
+        def link_errors?(index)
+          has_errors? && index.zero?
+        end
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/radios/collection_radio_button.rb

@@ -24,24 +24,24 @@ module GOVUKDesignSystemFormBuilder
 
         def html
           content_tag('div', class: %(#{brand}-radios__item)) do
-            safe_join(
-              [
-                @builder.radio_button(
-                  @attribute_name,
-                  @value,
-                  id: field_id(link_errors: @link_errors),
-                  aria: { describedby: hint_id },
-                  class: %w(radios__input).prefix(brand)
-                ),
-                label_element.html,
-                hint_element.html
-              ]
-            )
+            safe_join([radio, label_element, hint_element])
           end
         end
 
       private
 
+        def radio
+          @builder.radio_button(@attribute_name, @value, **radio_options)
+        end
+
+        def radio_options
+          {
+            id: field_id(link_errors: @link_errors),
+            aria: { describedby: hint_id },
+            class: %w(radios__input).prefix(brand)
+          }
+        end
+
         def hint_element
           @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, @value, radio: true)
         end

data/lib/govuk_design_system_formbuilder/elements/radios/fieldset_radio_button.rb

@@ -4,6 +4,7 @@ module GOVUKDesignSystemFormBuilder
       class FieldsetRadioButton < Base
         using PrefixableArray
 
+        include Traits::Label
         include Traits::Hint
         include Traits::Conditional
 
@@ -22,26 +23,19 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          safe_join(
-            [
-              content_tag('div', class: %(#{brand}-radios__item)) do
-                safe_join(
-                  [
-                    input,
-                    label_element.html,
-                    hint_element.html,
-                  ]
-                )
-              end,
-              @conditional_content
-            ]
-          )
+          safe_join([radio, @conditional_content])
         end
 
       private
 
+        def radio
+          content_tag('div', class: %(#{brand}-radios__item)) do
+            safe_join([input, label_element, hint_element])
+          end
+        end
+
         def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, radio: true, value: @value, **@label, link_errors: @link_errors)
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, radio: true, value: @value, link_errors: @link_errors, **label_options)
         end
 
         def hint_element
@@ -49,14 +43,16 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def input
-          @builder.radio_button(
-            @attribute_name,
-            @value,
+          @builder.radio_button(@attribute_name, @value, input_options)
+        end
+
+        def input_options
+          {
             id: field_id(link_errors: @link_errors),
             aria: { describedby: hint_id },
             data: { 'aria-controls' => @conditional_id },
             class: %w(radios__input).prefix(brand)
-          )
+          }
         end
 
         def conditional_classes

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -8,7 +8,7 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint_text:, label:, &block)
+      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint_text:, label:, caption:, &block)
         super(builder, object_name, attribute_name, &block)
 
         @collection    = collection
@@ -17,33 +17,23 @@ module GOVUKDesignSystemFormBuilder
         @options       = options
         @html_options  = html_options
         @label         = label
+        @caption       = caption
         @hint_text     = hint_text
       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.collection_select(
-                @attribute_name,
-                @collection,
-                @value_method,
-                @text_method,
-                @options,
-                build_html_options
-              )
-            ]
-          )
+          safe_join([label_element, supplemental_content, hint_element, error_element, select])
         end
       end
 
     private
 
-      def build_html_options
+      def select
+        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, select_options)
+      end
+
+      def select_options
         @html_options.deep_merge(
           id: field_id(link_errors: true),
           class: select_classes,