govuk_design_system_formbuilder 1.2.9 → 2.0.0

data/lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb

@@ -4,28 +4,39 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
       include Traits::Hint
 
-      def initialize(builder, object_name, attribute_name, hint_text:, legend:, caption:, small:, classes:, form_group_classes:, &block)
+      def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, small:, classes:, form_group:, multiple:, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @legend             = legend
-        @caption            = caption
-        @hint_text          = hint_text
-        @small              = small
-        @classes            = classes
-        @form_group_classes = form_group_classes
-        @block_content      = capture { block.call }
+        @legend        = legend
+        @caption       = caption
+        @hint          = hint
+        @small         = small
+        @classes       = classes
+        @form_group    = form_group
+        @multiple      = multiple
+        @block_content = capture { block.call }
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
           Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
-            safe_join([hint_element, error_element, checkboxes])
+            safe_join([hint_element, error_element, hidden_field, checkboxes])
           end
         end
       end
 
     private
 
+      def hidden_field
+        return unless @multiple
+
+        @builder.hidden_field(@attribute_name, value: "", name: hidden_field_name)
+      end
+
+      def hidden_field_name
+        format("%<object_name>s[%<attribute_name>s][]", object_name: @object_name, attribute_name: @attribute_name)
+      end
+
       def fieldset_options
         {
           legend: @legend,

data/lib/govuk_design_system_formbuilder/containers/form_group.rb

@@ -1,14 +1,15 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class FormGroup < Base
-      def initialize(builder, object_name, attribute_name, classes: nil)
+      def initialize(builder, object_name, attribute_name, classes: nil, **kwargs)
         super(builder, object_name, attribute_name)
 
-        @classes = classes
+        @classes         = classes
+        @html_attributes = kwargs
       end
 
       def html
-        tag.div(class: classes) { yield }
+        tag.div(class: classes, **@html_attributes) { yield }
       end
 
     private

data/lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb

@@ -4,21 +4,21 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
       include Traits::Error
 
-      def initialize(builder, object_name, attribute_name, hint_text:, legend:, caption:, inline:, small:, classes:, form_group_classes:, &block)
+      def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, inline:, small:, classes:, form_group:, &block)
         super(builder, object_name, attribute_name)
 
-        @inline             = inline
-        @small              = small
-        @legend             = legend
-        @caption            = caption
-        @hint_text          = hint_text
-        @classes            = classes
-        @form_group_classes = form_group_classes
-        @block_content      = capture { block.call }
+        @inline        = inline
+        @small         = small
+        @legend        = legend
+        @caption       = caption
+        @hint          = hint
+        @classes       = classes
+        @form_group    = form_group
+        @block_content = capture { block.call }
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
           Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
             safe_join([hint_element, error_element, radios])
           end

data/lib/govuk_design_system_formbuilder/elements/caption.rb

@@ -3,21 +3,26 @@ module GOVUKDesignSystemFormBuilder
     class Caption < Base
       include Traits::Localisation
 
-      def initialize(builder, object_name, attribute_name, text:, size: nil)
+      def initialize(builder, object_name, attribute_name, text: nil, size: nil, **kwargs)
         super(builder, object_name, attribute_name)
 
-        @text       = text(text)
-        @size_class = size_class(size)
+        @text            = text(text)
+        @size_class      = size_class(size)
+        @html_attributes = kwargs
       end
 
       def html
-        return nil if @text.blank?
+        return nil unless active?
 
-        tag.span(@text, class: @size_class)
+        tag.span(@text, class: @size_class, **@html_attributes)
       end
 
     private
 
+      def active?
+        @text.present?
+      end
+
       def text(override)
         override || localised_text(:caption)
       end

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

@@ -6,23 +6,23 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Supplemental
 
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method: nil, hint_text:, legend:, caption:, small:, classes:, form_group_classes:, &block)
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method: nil, hint:, legend:, caption:, small:, classes:, form_group:, &block)
           super(builder, object_name, attribute_name, &block)
 
-          @collection         = collection
-          @value_method       = value_method
-          @text_method        = text_method
-          @hint_method        = hint_method
-          @small              = small
-          @legend             = legend
-          @caption            = caption
-          @hint_text          = hint_text
-          @classes            = classes
-          @form_group_classes = form_group_classes
+          @collection   = collection
+          @value_method = value_method
+          @text_method  = text_method
+          @hint_method  = hint_method
+          @small        = small
+          @legend       = legend
+          @caption      = caption
+          @hint         = hint
+          @classes      = classes
+          @form_group   = form_group
         end
 
         def html
-          Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
+          Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
             Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
               safe_join([supplemental_content, hint_element, error_element, check_boxes])
             end

data/lib/govuk_design_system_formbuilder/elements/check_boxes/collection_check_box.rb

@@ -11,7 +11,7 @@ module GOVUKDesignSystemFormBuilder
           @checkbox    = checkbox
           @item        = checkbox.object
           @value       = checkbox.value
-          @hint_text   = retrieve(@item, hint_method)
+          @hint        = { text: retrieve(@item, hint_method) }
           @link_errors = link_errors
         end
 
@@ -40,7 +40,11 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def hint_element
-          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, @value, checkbox: true)
+          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
+        end
+
+        def hint_options
+          { value: @value, checkbox: true }
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/check_boxes/fieldset_check_box.rb

@@ -8,13 +8,13 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Conditional
 
-        def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint_text:, link_errors:, multiple:, &block)
+        def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, &block)
           super(builder, object_name, attribute_name)
 
           @value           = value
           @unchecked_value = unchecked_value
           @label           = label
-          @hint_text       = hint_text
+          @hint            = hint
           @multiple        = multiple
           @link_errors     = link_errors
 
@@ -63,7 +63,11 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def hint_element
-          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, @value, checkbox: true)
+          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
+        end
+
+        def hint_options
+          { checkbox: true }
         end
 
         def conditional_classes

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -9,19 +9,19 @@ 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:, form_group_classes:, &block)
+      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, date_of_birth: false, omit_day:, form_group:, &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
-        @form_group_classes = form_group_classes
+        @legend        = legend
+        @caption       = caption
+        @hint          = hint
+        @date_of_birth = date_of_birth
+        @omit_day      = omit_day
+        @form_group    = form_group
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
           Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
             safe_join([supplemental_content, hint_element, error_element, date])
           end

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -8,18 +8,18 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Label
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, form_group_classes:, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @label              = label
-        @caption            = caption
-        @hint_text          = hint_text
-        @extra_options      = kwargs
-        @form_group_classes = form_group_classes
+        @label           = label
+        @caption         = caption
+        @hint            = hint
+        @html_attributes = kwargs
+        @form_group      = form_group
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
           safe_join([label_element, supplemental_content, hint_element, error_element, file])
         end
       end
@@ -27,7 +27,7 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def file
-        @builder.file_field(@attribute_name, **options, **@extra_options)
+        @builder.file_field(@attribute_name, **options, **@html_attributes)
       end
 
       def options

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -3,26 +3,53 @@ module GOVUKDesignSystemFormBuilder
     class Hint < Base
       using PrefixableArray
 
-      include Traits::Hint
       include Traits::Localisation
 
-      def initialize(builder, object_name, attribute_name, text, value = nil, radio: false, checkbox: false)
+      def initialize(builder, object_name, attribute_name, value: nil, text: nil, content: nil, radio: false, checkbox: false, **kwargs)
         super(builder, object_name, attribute_name)
 
-        @value     = value
-        @hint_text = retrieve_text(text)
-        @radio     = radio
-        @checkbox  = checkbox
+        @value           = value
+        @radio           = radio
+        @checkbox        = checkbox
+        @html_attributes = kwargs
+
+        if content
+          @raw = capture { content.call }
+        else
+          @text = retrieve_text(text)
+        end
+      end
+
+      def active?
+        [@text, @raw].any?(&:present?)
       end
 
       def html
-        return nil if @hint_text.blank?
+        return nil unless active?
+
+        content_tag(hint_tag, **hint_options, **@html_attributes) { hint_body }
+      end
+
+      def hint_id
+        return nil unless active?
 
-        tag.span(@hint_text, class: classes, id: hint_id)
+        build_id('hint')
       end
 
     private
 
+      def hint_options
+        { class: classes, id: hint_id }
+      end
+
+      def hint_tag
+        @raw.presence ? 'div' : 'span'
+      end
+
+      def hint_body
+        @raw || @text
+      end
+
       def retrieve_text(supplied)
         supplied.presence || localised_text(:hint)
       end

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -6,27 +6,29 @@ module GOVUKDesignSystemFormBuilder
       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, content: nil, caption: nil)
+      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, **kwargs)
         super(builder, object_name, attribute_name)
 
+        @value           = value # used by field_id
+        @tag             = tag
+        @radio           = radio
+        @checkbox        = checkbox
+        @link_errors     = link_errors
+        @html_attributes = kwargs
+
         # content is passed in directly via a proc and overrides
         # the other display options
         if content
           @content = capture { content.call }
         else
-          @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
+          @text       = retrieve_text(text, hidden)
+          @size_class = size_class(size)
+          @caption    = caption
         end
       end
 
       def html
-        return nil if [@content, @text].all?(&:blank?)
+        return nil unless active?
 
         if @tag.present?
           content_tag(@tag, class: %(#{brand}-label-wrapper)) { label }
@@ -35,10 +37,14 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
+      def active?
+        [@content, @text].any?(&:present?)
+      end
+
     private
 
       def label
-        @builder.label(@attribute_name, **options) do
+        @builder.label(@attribute_name, **options, **@html_attributes) do
           @content || safe_join([caption, @text])
         end
       end

data/lib/govuk_design_system_formbuilder/elements/legend.rb

@@ -4,15 +4,19 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Caption
       include Traits::Localisation
 
-      def initialize(builder, object_name, attribute_name, legend:, caption:)
+      def initialize(builder, object_name, attribute_name, legend:, caption:, **kwargs)
         super(builder, object_name, attribute_name)
 
+        @html_attributes = kwargs
+
         case legend
+        when NilClass
+          @active = false
         when Proc
           @raw = capture { legend.call }
         when Hash
           defaults.merge(legend).tap do |l|
-            @text    = text(l.dig(:text))
+            @text    = retrieve_text(l.dig(:text))
             @hidden  = l.dig(:hidden)
             @tag     = l.dig(:tag)
             @size    = l.dig(:size)
@@ -29,18 +33,22 @@ module GOVUKDesignSystemFormBuilder
 
     private
 
+      def active?
+        [@text, @raw].any?(&:present?)
+      end
+
       def content
-        if @text.present?
-          tag.legend(class: classes) do
-            content_tag(@tag, class: heading_classes) do
-              safe_join([caption_element, @text])
-            end
+        return nil unless active?
+
+        tag.legend(class: classes, **@html_attributes) do
+          content_tag(@tag, class: heading_classes) do
+            safe_join([caption_element, @text])
           end
         end
       end
 
-      def text(supplied_text)
-        supplied_text || localised_text(:legend)
+      def retrieve_text(supplied_text)
+        [supplied_text, localised_text(:legend), @attribute_name&.capitalize].compact.first
       end
 
       def classes