govuk_design_system_formbuilder 2.1.9 → 2.5.0

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

@@ -8,8 +8,9 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::FieldsetItem
         include Traits::Conditional
+        include Traits::HTMLAttributes
 
-        def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, &block)
+        def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, **kwargs, &block)
           super(builder, object_name, attribute_name)
 
           @value           = value
@@ -18,6 +19,7 @@ module GOVUKDesignSystemFormBuilder
           @hint            = hint
           @multiple        = multiple
           @link_errors     = link_errors
+          @html_attributes = kwargs
 
           if block_given?
             @conditional_content = wrap_conditional(block)
@@ -38,7 +40,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def check_box
-          @builder.check_box(@attribute_name, options, @value, @unchecked_value)
+          @builder.check_box(@attribute_name, attributes(@html_attributes), @value, @unchecked_value)
         end
 
         def options
@@ -46,7 +48,7 @@ module GOVUKDesignSystemFormBuilder
             id: field_id(link_errors: @link_errors),
             class: classes,
             multiple: @multiple,
-            aria: { describedby: hint_id },
+            aria: { describedby: [hint_id] },
             data: { 'aria-controls' => @conditional_id }
           }
         end

data/lib/govuk_design_system_formbuilder/elements/collection_select.rb

@@ -0,0 +1,52 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class CollectionSelect < Base
+      include Traits::Error
+      include Traits::Label
+      include Traits::Hint
+      include Traits::Supplemental
+      include Traits::HTMLAttributes
+      include Traits::Select
+
+      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint:, label:, caption:, form_group:, options: {}, **kwargs, &block)
+        super(builder, object_name, attribute_name, &block)
+
+        @collection      = collection
+        @value_method    = value_method
+        @text_method     = text_method
+        @options         = options
+        @label           = label
+        @caption         = caption
+        @hint            = hint
+        @form_group      = form_group
+        @html_attributes = kwargs
+
+        # FIXME remove this soon, worth informing people who miss the release notes that the
+        #       args have changed though.
+        if :html_options.in?(kwargs.keys)
+          warn("GOVUKDesignSystemFormBuilder: html_options has been deprecated, use keyword arguments instead")
+        end
+      end
+
+      def html
+        Containers::FormGroup.new(*bound, **@form_group).html do
+          safe_join([label_element, supplemental_content, hint_element, error_element, collection_select])
+        end
+      end
+
+    private
+
+      def options
+        {
+          id: field_id(link_errors: true),
+          class: classes,
+          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+        }
+      end
+
+      def collection_select
+        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, **attributes(@html_attributes))
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -8,22 +8,24 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Supplemental
 
       SEGMENTS = { day: '3i', month: '2i', year: '1i' }.freeze
+      MULTIPARAMETER_KEY = { day: 3, month: 2, year: 1 }.freeze
 
-      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, omit_day:, form_group:, wildcards:, date_of_birth: false, &block)
+      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, omit_day:, form_group:, wildcards:, date_of_birth: false, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @legend        = legend
-        @caption       = caption
-        @hint          = hint
-        @date_of_birth = date_of_birth
-        @omit_day      = omit_day
-        @form_group    = form_group
-        @wildcards     = wildcards
+        @legend          = legend
+        @caption         = caption
+        @hint            = hint
+        @date_of_birth   = date_of_birth
+        @omit_day        = omit_day
+        @form_group      = form_group
+        @wildcards       = wildcards
+        @html_attributes = kwargs
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
-          Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
+        Containers::FormGroup.new(*bound, **@form_group, **@html_attributes).html do
+          Containers::Fieldset.new(*bound, **fieldset_options).html do
             safe_join([supplemental_content, hint_element, error_element, date])
           end
         end
@@ -46,7 +48,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def day
-        return nil if omit_day?
+        return if omit_day?
 
         date_part(:day, width: 2, link_errors: true)
       end
@@ -60,15 +62,31 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def date_part(segment, width:, link_errors: false)
-        value = @builder.object.try(@attribute_name).try(segment)
-
         tag.div(class: %(#{brand}-date-input__item)) do
           tag.div(class: %(#{brand}-form-group)) do
-            safe_join([label(segment, link_errors), input(segment, link_errors, width, value)])
+            safe_join([label(segment, link_errors), input(segment, link_errors, width, value(segment))])
           end
         end
       end
 
+      def value(segment)
+        attribute = @builder.object.try(@attribute_name)
+
+        return unless attribute
+
+        if attribute.respond_to?(segment)
+          attribute.send(segment)
+        elsif attribute.respond_to?(:fetch)
+          attribute.fetch(MULTIPARAMETER_KEY[segment]) do
+            warn("No key '#{segment}' found in MULTIPARAMETER_KEY hash. Expected to find #{MULTIPARAMETER_KEY.values}")
+
+            nil
+          end
+        else
+          fail(ArgumentError, "invalid Date-like object: must be a Date, Time, DateTime or Hash in MULTIPARAMETER_KEY format")
+        end
+      end
+
       def label(segment, link_errors)
         tag.label(
           segment.capitalize,
@@ -124,7 +142,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def date_of_birth_autocomplete_value(segment)
-        return nil unless @date_of_birth
+        return unless @date_of_birth
 
         { day: 'bday-day', month: 'bday-month', year: 'bday-year' }.fetch(segment)
       end

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -6,7 +6,7 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
 
       def html
-        return nil unless has_errors?
+        return unless has_errors?
 
         tag.span(class: %(#{brand}-error-message), id: error_id) do
           safe_join([hidden_prefix, message])

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -2,18 +2,20 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     class ErrorSummary < Base
       include Traits::Error
+      include Traits::HTMLAttributes
 
-      def initialize(builder, object_name, title, link_base_errors_to:)
+      def initialize(builder, object_name, title, link_base_errors_to:, **kwargs)
         super(builder, object_name, nil)
 
         @title               = title
         @link_base_errors_to = link_base_errors_to
+        @html_attributes     = kwargs
       end
 
       def html
-        return nil unless object_has_errors?
+        return unless object_has_errors?
 
-        tag.div(class: summary_class, **summary_options) do
+        tag.div(**attributes(@html_attributes)) do
           safe_join([title, summary])
         end
       end
@@ -46,6 +48,10 @@ module GOVUKDesignSystemFormBuilder
         '#'.concat(target)
       end
 
+      def classes
+        Array.wrap(summary_class)
+      end
+
       def summary_class(part = nil)
         if part
           %(#{brand}-error-summary).concat('__', part)
@@ -70,8 +76,9 @@ module GOVUKDesignSystemFormBuilder
         @builder.object.errors.any?
       end
 
-      def summary_options
+      def options
         {
+          class: classes,
           tabindex: -1,
           role: 'alert',
           data: {

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -7,6 +7,7 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
       include Traits::Label
       include Traits::Supplemental
+      include Traits::HTMLAttributes
 
       def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
@@ -19,7 +20,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
+        Containers::FormGroup.new(*bound, **@form_group).html do
           safe_join([label_element, supplemental_content, hint_element, error_element, file])
         end
       end
@@ -27,7 +28,7 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def file
-        @builder.file_field(@attribute_name, **options, **@html_attributes)
+        @builder.file_field(@attribute_name, attributes(@html_attributes))
       end
 
       def options

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -31,7 +31,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def hint_id
-        return nil unless active?
+        return unless active?
 
         build_id('hint')
       end

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

@@ -7,6 +7,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Label
         include Traits::Supplemental
+        include Traits::HTMLAttributes
 
       private
 

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

@@ -7,6 +7,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Label
         include Traits::Supplemental
+        include Traits::HTMLAttributes
 
         def builder_method
           :number_field

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

@@ -7,6 +7,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Label
         include Traits::Supplemental
+        include Traits::HTMLAttributes
 
         def builder_method
           :password_field

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

@@ -7,6 +7,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Label
         include Traits::Supplemental
+        include Traits::HTMLAttributes
 
         def builder_method
           :phone_field

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

@@ -7,6 +7,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Label
         include Traits::Supplemental
+        include Traits::HTMLAttributes
 
         def builder_method
           :text_field

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

@@ -7,6 +7,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Label
         include Traits::Supplemental
+        include Traits::HTMLAttributes
 
         def builder_method
           :url_field

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -28,7 +28,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        return nil unless active?
+        return unless active?
 
         if @tag.present?
           content_tag(@tag, class: %(#{brand}-label-wrapper)) { label }
@@ -72,13 +72,13 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def radio_class
-        return nil unless @radio
+        return unless @radio
 
         %(#{brand}-radios__label)
       end
 
       def checkbox_class
-        return nil unless @checkbox
+        return unless @checkbox
 
         %(#{brand}-checkboxes__label)
       end

data/lib/govuk_design_system_formbuilder/elements/legend.rb

@@ -39,11 +39,9 @@ module GOVUKDesignSystemFormBuilder
       def legend_content
         caption_and_text = safe_join([caption_element, @text])
 
-        if @tag.present?
-          content_tag(@tag, class: heading_classes) { caption_and_text }
-        else
-          caption_and_text
-        end
+        return caption_and_text if @tag.blank?
+
+        content_tag(@tag, class: heading_classes) { caption_and_text }
       end
 
       def retrieve_text(supplied_text)

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

@@ -25,8 +25,8 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
-            Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
+          Containers::FormGroup.new(*bound, **@form_group).html do
+            Containers::Fieldset.new(*bound, **fieldset_options).html do
               safe_join([hidden_field, supplemental_content, hint_element, error_element, radios])
             end
           end
@@ -56,7 +56,7 @@ module GOVUKDesignSystemFormBuilder
 
         def collection
           @collection.map.with_index do |item, i|
-            Elements::Radios::CollectionRadioButton.new(@builder, @object_name, @attribute_name, item, **collection_options(i)).html
+            Elements::Radios::CollectionRadioButton.new(*bound, item, **collection_options(i)).html
           end
         end
 

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

@@ -9,7 +9,7 @@ module GOVUKDesignSystemFormBuilder
         #   error summary requires that the id of the first radio is linked-to from the corresponding
         #   error message. As when the summary is built what happens later in the form is unknown, we
         #   need to control this to ensure the link is generated correctly
-        def initialize(builder, object_name, attribute_name, item, value_method:, text_method:, hint_method:, link_errors: false, bold_labels:)
+        def initialize(builder, object_name, attribute_name, item, value_method:, text_method:, hint_method:, bold_labels:, link_errors: false)
           super(builder, object_name, attribute_name)
 
           @item        = item
@@ -41,7 +41,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def hint_element
-          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
+          @hint_element ||= Elements::Hint.new(*bound, **hint_options, **hint_content)
         end
 
         def hint_content
@@ -53,7 +53,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **label_options)
+          @label_element ||= Elements::Label.new(*bound, **label_options)
         end
 
         def label_options

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

@@ -8,14 +8,16 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::FieldsetItem
         include Traits::Conditional
+        include Traits::HTMLAttributes
 
-        def initialize(builder, object_name, attribute_name, value, label:, hint:, link_errors:, &block)
+        def initialize(builder, object_name, attribute_name, value, label:, hint:, link_errors:, **kwargs, &block)
           super(builder, object_name, attribute_name)
 
-          @value       = value
-          @label       = label
-          @hint        = hint
-          @link_errors = has_errors? && link_errors
+          @value           = value
+          @label           = label
+          @hint            = hint
+          @link_errors     = has_errors? && link_errors
+          @html_attributes = kwargs
 
           if block_given?
             @conditional_content = wrap_conditional(block)
@@ -40,13 +42,13 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def input
-          @builder.radio_button(@attribute_name, @value, **options)
+          @builder.radio_button(@attribute_name, @value, **attributes(@html_attributes))
         end
 
         def options
           {
             id: field_id(link_errors: @link_errors),
-            aria: { describedby: hint_id },
+            aria: { describedby: [hint_id] },
             data: { 'aria-controls' => @conditional_id },
             class: %w(radios__input).prefix(brand)
           }