govuk_design_system_formbuilder 1.2.1 → 1.2.6

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

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

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -12,32 +12,32 @@ module GOVUKDesignSystemFormBuilder
       def html
         return nil unless object_has_errors?
 
-        content_tag('div', class: error_summary_class, **error_summary_options) do
-          safe_join([error_title, error_summary])
+        content_tag('div', class: summary_class, **summary_options) do
+          safe_join([title, summary])
         end
       end
 
     private
 
-      def error_title
-        tag.h2(@title, id: error_summary_title_id, class: error_summary_class('title'))
+      def title
+        tag.h2(@title, id: summary_title_id, class: 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)
+      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 error_list
+      def list
         @builder.object.errors.messages.map do |attribute, messages|
-          error_list_item(attribute, messages.first)
+          list_item(attribute, messages.first)
         end
       end
 
-      def error_list_item(attribute, message)
+      def list_item(attribute, message)
         tag.li(link_to(message, same_page_link(field_id(attribute)), data: { turbolinks: false }))
       end
 
@@ -45,7 +45,7 @@ module GOVUKDesignSystemFormBuilder
         '#'.concat(target)
       end
 
-      def error_summary_class(part = nil)
+      def summary_class(part = nil)
         if part
           %(#{brand}-error-summary).concat('__', part)
         else
@@ -57,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
 
@@ -65,7 +65,7 @@ module GOVUKDesignSystemFormBuilder
         @builder.object.errors.any?
       end
 
-      def error_summary_options
+      def summary_options
         {
           tabindex: -1,
           role: 'alert',
@@ -73,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,17 +8,18 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Label
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, **kwargs, &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_options = kwargs
+        @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
+        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
@@ -26,18 +27,18 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def file
-        @builder.file_field(@attribute_name, **file_options, **@extra_options)
+        @builder.file_field(@attribute_name, **options, **@extra_options)
       end
 
-      def file_options
+      def options
         {
           id: field_id(link_errors: true),
-          class: file_classes,
+          class: classes,
           aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
         }
       end
 
-      def file_classes
+      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,34 +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
 
@@ -38,12 +38,12 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def label
-        @builder.label(@attribute_name, label_options) do
-          @content || safe_join([caption_element.html, @text])
+        @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
@@ -53,29 +53,37 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
-      def label_options
+      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
+          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
+      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

data/lib/govuk_design_system_formbuilder/elements/legend.rb

@@ -0,0 +1,79 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Legend < Base
+      include Traits::Caption
+      include Traits::Localisation
+
+      def initialize(builder, object_name, attribute_name, legend:, caption:)
+        super(builder, object_name, attribute_name)
+
+        case legend
+        when Proc
+          @raw = legend.call
+        when Hash
+          defaults.merge(legend).tap do |l|
+            @text    = text(l.dig(:text))
+            @hidden  = l.dig(:hidden)
+            @tag     = l.dig(:tag)
+            @size    = l.dig(:size)
+            @caption = caption
+          end
+        else
+          fail(ArgumentError, %(legend must be a Proc or Hash))
+        end
+      end
+
+      def html
+        @raw || content
+      end
+
+    private
+
+      def content
+        if @text.present?
+          content_tag('legend', class: classes) do
+            content_tag(@tag, class: heading_classes) do
+              safe_join([caption_element, @text])
+            end
+          end
+        end
+      end
+
+      def text(supplied_text)
+        supplied_text || localised_text(:legend)
+      end
+
+      def classes
+        [%(#{brand}-fieldset__legend), size_class, visually_hidden_class].compact
+      end
+
+      def size_class
+        case @size
+        when 'xl' then %(#{brand}-fieldset__legend--xl)
+        when 'l'  then %(#{brand}-fieldset__legend--l)
+        when 'm'  then %(#{brand}-fieldset__legend--m)
+        when 's'  then %(#{brand}-fieldset__legend--s)
+        else
+          fail "invalid size '#{@size}', must be xl, l, m or s"
+        end
+      end
+
+      def visually_hidden_class
+        %(#{brand}-visually-hidden) if @hidden
+      end
+
+      def heading_classes
+        %(#{brand}-fieldset__heading)
+      end
+
+      def defaults
+        {
+          hidden: false,
+          text: nil,
+          tag:  config.default_legend_tag,
+          size: config.default_legend_size
+        }
+      end
+    end
+  end
+end

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

@@ -6,25 +6,26 @@ 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:, caption:, 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:, form_group_classes:, &block)
           super(builder, object_name, attribute_name, &block)
 
-          @collection    = collection
-          @value_method  = value_method
-          @text_method   = text_method
-          @hint_method   = hint_method
-          @inline        = inline
-          @small         = small
-          @legend        = legend
-          @caption       = caption
-          @hint_text     = hint_text
-          @classes       = classes
-          @bold_labels   = hint_method.present? || bold_labels
+          @collection         = collection
+          @value_method       = value_method
+          @text_method        = text_method
+          @hint_method        = hint_method
+          @inline             = inline
+          @small              = small
+          @legend             = legend
+          @caption            = caption
+          @hint_text          = hint_text
+          @classes            = classes
+          @form_group_classes = form_group_classes
+          @bold_labels        = hint_method.present? || bold_labels
         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
+          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, radios])
             end
           end
@@ -32,6 +33,14 @@ module GOVUKDesignSystemFormBuilder
 
       private
 
+        def fieldset_options
+          {
+            legend: @legend,
+            caption: @caption,
+            described_by: [error_id, hint_id, supplemental_id]
+          }
+        end
+
         def radios
           Containers::Radios.new(@builder, inline: @inline, small: @small, classes: @classes).html do
             safe_join(collection)

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

@@ -31,10 +31,10 @@ module GOVUKDesignSystemFormBuilder
       private
 
         def radio
-          @builder.radio_button(@attribute_name, @value, **radio_options)
+          @builder.radio_button(@attribute_name, @value, **options)
         end
 
-        def radio_options
+        def options
           {
             id: field_id(link_errors: @link_errors),
             aria: { describedby: hint_id },
@@ -47,7 +47,17 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, text: @label_text, value: @value, radio: true, size: label_size, link_errors: @link_errors)
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **label_options)
+        end
+
+        def label_options
+          {
+            text: @label_text,
+            value: @value,
+            radio: true,
+            size: label_size,
+            link_errors: @link_errors
+          }
         end
 
         def label_size