govuk_design_system_formbuilder 2.3.0b1 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 641fbc9fbd19bc333cd0872da36c9286c7f956cdfe41ef5b9b234dbe264bc03a
-  data.tar.gz: 30a0000fa3868e7f7f6bf67347a025cf8f85e5e02a77bff4026d343088c3fb3f
+  metadata.gz: 98eb37a7c0dc6926abc94003671567e1d6d9ff64026d92dbd2bbeb62e132b5ac
+  data.tar.gz: 3bdd6d81f7c94f28e39841088d056c8eb7615dab89cd750e589d516f71faae0a
 SHA512:
-  metadata.gz: 53d6df89df5401b05190709bbad01273d0a2491484792d82307a1ffd6a054ef9de69f8d7d5ab7ae028c677603628bf203439959e70c8e2776504172c41fc2939
-  data.tar.gz: 5fa7f1475a37d063bab13dc27e4238ca6a7429abbe805b51436a6d3a1310c98df7defe60ad51ff376968d4ae8de8f828611daf79fc75a4602a6dbfeef3ae47f7
+  metadata.gz: eae5b13528432a2c01a85aba212b74ecfcdb5740ecbe43bf6548749ebc1ab98b7a37281f7bea6b4e85964d73076e19a1a05326011d2edd71f1599075e6545e2b
+  data.tar.gz: c24c784e74e4ae48fdafcca7bf3ba3b5e5f3e22a371f0b5e16bd6fc364f1cb3d386be4bff9ea03de0ce3d5857676eca58001b09284a625d9fcd2dc6ef728a9e5

data/README.md

@@ -8,8 +8,8 @@
 [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=DFE-Digital/govuk_design_system_formbuilder)](https://dependabot.com)
 [![GitHub license](https://img.shields.io/github/license/DFE-Digital/govuk_design_system_formbuilder)](https://github.com/DFE-Digital/govuk_design_system_formbuilder/blob/master/LICENSE)
 [![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.11.0-brightgreen)](https://design-system.service.gov.uk)
-[![Rails](https://img.shields.io/badge/Ruby-2.6.6%20%E2%95%B1%202.7.2%20%E2%95%B1%203.0.0-E16D6D)](https://www.ruby-lang.org/en/downloads/)
-[![Ruby](https://img.shields.io/badge/Rails-6.0.3%20%E2%95%B1%206.1.0-E16D6D)](https://weblog.rubyonrails.org/releases/)
+[![Rails](https://img.shields.io/badge/Ruby-2.6.7%20%E2%95%B1%202.7.3%20%E2%95%B1%203.0.1-E16D6D)](https://www.ruby-lang.org/en/downloads/)
+[![Ruby](https://img.shields.io/badge/Rails-6.0.3.6%20%E2%95%B1%206.1.3.1-E16D6D)](https://weblog.rubyonrails.org/releases/)
 
 This library provides an easy-to-use form builder for the [GOV.UK Design System](https://design-system.service.gov.uk/).
 

data/lib/govuk_design_system_formbuilder.rb

@@ -49,6 +49,9 @@ module GOVUKDesignSystemFormBuilder
   # * +:localisation_schema_legend+, +:localisation_schema_hint+ and
   #   +:localisation_schema_label+ each override the schema root for their
   #   particular context, allowing them to be independently customised.
+  #
+  # * +:enable_logger+ controls whether or not the library will emit log
+  #   messages via Rails.logger.warn, defaults to +true+
   # ===
   DEFAULTS = {
     brand: 'govuk',
@@ -67,7 +70,9 @@ module GOVUKDesignSystemFormBuilder
     localisation_schema_label: nil,
     localisation_schema_hint: nil,
     localisation_schema_legend: nil,
-    localisation_schema_caption: nil
+    localisation_schema_caption: nil,
+
+    enable_logger: true
   }.freeze
 
   DEFAULTS.each_key { |k| config_accessor(k) { DEFAULTS[k] } }

data/lib/govuk_design_system_formbuilder/base.rb

@@ -25,6 +25,15 @@ module GOVUKDesignSystemFormBuilder
 
   private
 
+    # returns the attributes bound to the object that are
+    # required to build all contained elements
+    #
+    # @return [GOVUKDesignSystemFormBuilder::FormBuilder, Symbol, Symbol] an array containing the
+    #   builder, object name and attribute name
+    def bound
+      [@builder, @object_name, @attribute_name]
+    end
+
     def brand(override = nil)
       override || config.brand
     end
@@ -57,7 +66,7 @@ module GOVUKDesignSystemFormBuilder
     end
 
     def described_by(*ids)
-      ids.flatten.compact.join(' ').presence
+      ids.flatten.compact
     end
 
     # Builds the values used for HTML id attributes throughout the builder
@@ -87,5 +96,11 @@ module GOVUKDesignSystemFormBuilder
         .parameterize
         .tr(replace, delimiter)
     end
+
+    def warn(message)
+      return unless config.enable_logger
+
+      Rails.logger.warn(message)
+    end
   end
 end

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -381,13 +381,13 @@ module GOVUKDesignSystemFormBuilder
     #   supplied the hint will be wrapped in a +div+ instead of a +span+
     # @option hint text [String] the hint text
     # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
+    # @param label [Hash,Proc] configures or sets the associated label content
     # @option label text [String] the label text
     # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
     # @option label hidden [Boolean] control the visability of the label. Hidden labels will stil be read by screenreaders
     # @option label kwargs [Hash] additional arguments are applied as attributes on the +label+ element
     # @param options [Hash] Options hash passed through to Rails' +collection_select+ helper
-    # @param html_options [Hash] HTML Options hash passed through to Rails' +collection_select+ helper
     # @param form_group [Hash] configures the form group
     # @option form_group classes [Array,String] sets the form group's classes
     # @option form_group kwargs [Hash] additional attributes added to the form group
@@ -413,7 +413,7 @@ module GOVUKDesignSystemFormBuilder
     #     label: -> { tag.h3("Which team did you represent?") }
     #
     def govuk_collection_select(attribute_name, collection, value_method, text_method, options: {}, hint: {}, label: {}, caption: {}, form_group: {}, **kwargs, &block)
-      Elements::Select.new(
+      Elements::CollectionSelect.new(
         self,
         object_name,
         attribute_name,
@@ -430,6 +430,42 @@ module GOVUKDesignSystemFormBuilder
       ).html
     end
 
+    # Generates a +select+ element containing an +option+ for every choice provided
+    #
+    # @param attribute_name [Symbol] The name of the attribute
+    # @param choices [Array,Hash] The +option+ values, usually provided via
+    #   the +options_for_select+ or +grouped_options_for_select+ helpers.
+    # @param options [Hash] Options hash passed through to Rails' +select+ helper
+    # @param hint [Hash,Proc] The content of the hint. No hint will be added if 'text' is left +nil+. When a +Proc+ is
+    #   supplied the hint will be wrapped in a +div+ instead of a +span+
+    # @option hint text [String] the hint text
+    # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
+    # @param label [Hash,Proc] configures or sets the associated label content
+    # @option label text [String] the label text
+    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
+    # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
+    # @option label hidden [Boolean] control the visability of the label. Hidden labels will stil be read by screenreaders
+    # @option label kwargs [Hash] additional arguments are applied as attributes on the +label+ element
+    # @param form_group [Hash] configures the form group
+    # @option form_group classes [Array,String] sets the form group's classes
+    # @option form_group kwargs [Hash] additional attributes added to the form group
+    # @param block [Block] build the contents of the select element manually for exact control
+    # @see https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select Rails select (called by govuk_collection_select)
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @example A select box with custom data attributes
+    #
+    #   @colours = [
+    #     ["PapayaWhip", "pw",  { data: { hex: "#ffefd5" } }],
+    #     ["Chocolate", "choc", { data: { hex: "#d2691e" } }],
+    #   ]
+    #
+    #   = f.govuk_select :hat_colour, options_for_select(@colours)
+    #
+    def govuk_select(attribute_name, choices = nil, options: {}, label: {}, hint: {}, form_group: {}, caption: {}, **kwargs, &block)
+      Elements::Select.new(self, object_name, attribute_name, choices, options: options, label: label, hint: hint, form_group: form_group, caption: caption, **kwargs, &block).html
+    end
+
     # Generates a radio button for each item in the supplied collection
     #
     # @note Unlike the Rails +#collection_radio_buttons+ helper, this version can also insert
@@ -843,6 +879,7 @@ module GOVUKDesignSystemFormBuilder
     # @note When using this input be aware that Rails's multiparam time and date handling falls foul
     #   of {https://bugs.ruby-lang.org/issues/5988 this} bug, so incorrect dates like +2019-09-31+ will
     #   be 'rounded' up to +2019-10-01+.
+    # @note When using this input values will be retrieved from the attribute if it is a Date object or a multiparam date hash
     # @param attribute_name [Symbol] The name of the attribute
     # @param hint [Hash,Proc] The content of the hint. No hint will be added if 'text' is left +nil+. When a +Proc+ is
     #   supplied the hint will be wrapped in a +div+ instead of a +span+

data/lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb

@@ -18,8 +18,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([hint_element, error_element, hidden_field, checkboxes])
           end
         end

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -24,7 +24,7 @@ module GOVUKDesignSystemFormBuilder
       def options
         {
           class: classes,
-          aria: { describedby: @described_by }
+          aria: { describedby: [@described_by] }
         }
       end
 
@@ -36,7 +36,7 @@ module GOVUKDesignSystemFormBuilder
         @legend_element ||= if @legend.nil?
                               Elements::Null.new
                             else
-                              Elements::Legend.new(@builder, @object_name, @attribute_name, **legend_options)
+                              Elements::Legend.new(*bound, **legend_options)
                             end
       end
 

data/lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb

@@ -18,8 +18,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([hint_element, error_element, radios])
           end
         end

data/lib/govuk_design_system_formbuilder/containers/supplemental.rb

@@ -8,7 +8,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        return nil if @content.blank?
+        return if @content.blank?
 
         tag.div(id: supplemental_id) { @content }
       end

data/lib/govuk_design_system_formbuilder/elements/caption.rb

@@ -3,7 +3,7 @@ module GOVUKDesignSystemFormBuilder
     class Caption < Base
       include Traits::Localisation
 
-      def initialize(builder, object_name, attribute_name, text: nil, size: nil, **kwargs)
+      def initialize(builder, object_name, attribute_name, text: nil, size: config.default_caption_size, **kwargs)
         super(builder, object_name, attribute_name)
 
         @text            = text(text)
@@ -12,7 +12,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        return nil unless active?
+        return unless active?
 
         tag.span(@text, class: @size_class, **@html_attributes)
       end
@@ -28,7 +28,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def size_class(size)
-        case size || config.default_caption_size
+        case size
         when 'xl' then %(#{brand}-caption-xl)
         when 'l'  then %(#{brand}-caption-l)
         when 'm'  then %(#{brand}-caption-m)

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

@@ -23,8 +23,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([supplemental_content, hint_element, error_element, check_boxes])
             end
           end

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

@@ -36,11 +36,11 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def label_element
-          @label_element ||= Label.new(@builder, @object_name, @attribute_name, @checkbox, value: @value, link_errors: @link_errors)
+          @label_element ||= Label.new(*bound, @checkbox, value: @value, link_errors: @link_errors)
         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_options

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

@@ -48,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,6 +8,7 @@ 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, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
@@ -23,8 +24,8 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group, **@html_attributes).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
@@ -47,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
@@ -61,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,
@@ -125,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

@@ -13,7 +13,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        return nil unless object_has_errors?
+        return unless object_has_errors?
 
         tag.div(**attributes(@html_attributes)) do
           safe_join([title, summary])

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -20,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

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/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

@@ -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

@@ -48,7 +48,7 @@ module GOVUKDesignSystemFormBuilder
         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)
           }

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -4,56 +4,43 @@ module GOVUKDesignSystemFormBuilder
       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)
+      def initialize(builder, object_name, attribute_name, choices, options:, form_group:, label:, hint:, caption:, **kwargs, &block)
+        # assign the block to an variable rather than passing to super so
+        # we can send it through to #select
+        super(builder, object_name, attribute_name)
+        @block           = block
 
-        @collection      = collection
-        @value_method    = value_method
-        @text_method     = text_method
-        @options         = options
+        @form_group      = form_group
+        @hint            = hint
         @label           = label
         @caption         = caption
-        @hint            = hint
-        @form_group      = form_group
+        @choices         = choices
+        @options         = options
         @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)
-          Rails.logger.warn("GOVUKDesignSystemFormBuilder: html_options has been deprecated, use keyword arguments instead")
-        end
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
-          safe_join([label_element, supplemental_content, hint_element, error_element, select])
+        Containers::FormGroup.new(*bound, **@form_group).html do
+          safe_join([label_element, hint_element, error_element, select])
         end
       end
 
     private
 
       def select
-        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, **attributes(@html_attributes))
+        @builder.select(@attribute_name, @choices, @options, attributes(@html_attributes), &@block)
       end
 
       def options
         {
           id: field_id(link_errors: true),
           class: classes,
-          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+          aria: { describedby: described_by(hint_id, error_id) }
         }
       end
-
-      def classes
-        [%(#{brand}-select), error_class].flatten.compact
-      end
-
-      def error_class
-        %(#{brand}-select--error) if has_errors?
-      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -21,19 +21,19 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        @block_content.present? ? button_group : buttons
+        @block_content.present? ? button_group : submit
       end
 
     private
 
-      def buttons
-        safe_join([submit, @block_content])
-      end
-
       def button_group
         Containers::ButtonGroup.new(@builder, buttons).html
       end
 
+      def buttons
+        safe_join([submit, @block_content])
+      end
+
       def submit
         @builder.submit(@text, **attributes(@html_attributes))
       end

data/lib/govuk_design_system_formbuilder/elements/text_area.rb

@@ -25,7 +25,7 @@ module GOVUKDesignSystemFormBuilder
 
       def html
         Containers::CharacterCount.new(@builder, **character_count_options).html do
-          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, text_area, limit_description])
           end
         end
@@ -78,7 +78,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def limit_description
-        return nil unless limit?
+        return unless limit?
 
         tag.span(id: limit_id, class: limit_description_classes, aria: { live: 'polite' }) do
           "You can enter up to #{limit_quantity} #{limit_type}"
@@ -90,7 +90,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def limit_description_id
-        return nil unless limit?
+        return unless limit?
 
         limit_id
       end

data/lib/govuk_design_system_formbuilder/traits/caption.rb

@@ -7,7 +7,7 @@ module GOVUKDesignSystemFormBuilder
         @caption_element ||= if @caption.nil?
                                Elements::Null.new
                              else
-                               Elements::Caption.new(@builder, @object_name, @attribute_name, **@caption)
+                               Elements::Caption.new(*bound, **@caption)
                              end
       end
     end

data/lib/govuk_design_system_formbuilder/traits/error.rb

@@ -2,7 +2,7 @@ module GOVUKDesignSystemFormBuilder
   module Traits
     module Error
       def error_id
-        return nil unless has_errors?
+        return unless has_errors?
 
         build_id('error')
       end
@@ -10,7 +10,7 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def error_element
-        @error_element ||= Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
+        @error_element ||= Elements::ErrorMessage.new(*bound)
       end
     end
   end

data/lib/govuk_design_system_formbuilder/traits/fieldset_item.rb

@@ -7,7 +7,7 @@ module GOVUKDesignSystemFormBuilder
         @label_element ||= if @label.nil?
                              Elements::Null.new
                            else
-                             Elements::Label.new(@builder, @object_name, @attribute_name, **label_content, **label_options)
+                             Elements::Label.new(*bound, **label_content, **label_options)
                            end
       end
 
@@ -19,7 +19,7 @@ module GOVUKDesignSystemFormBuilder
         @hint_element ||= if @hint.nil?
                             Elements::Null.new
                           else
-                            Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
+                            Elements::Hint.new(*bound, **hint_options, **hint_content)
                           end
       end
 

data/lib/govuk_design_system_formbuilder/traits/hint.rb

@@ -2,7 +2,7 @@ module GOVUKDesignSystemFormBuilder
   module Traits
     module Hint
       def hint_id
-        return nil unless hint_element.active?
+        return unless hint_element.active?
 
         build_id('hint')
       end
@@ -13,7 +13,7 @@ module GOVUKDesignSystemFormBuilder
         @hint_element ||= if @hint.nil?
                             Elements::Null.new
                           else
-                            Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_content)
+                            Elements::Hint.new(*bound, **hint_content)
                           end
       end
 

data/lib/govuk_design_system_formbuilder/traits/html_attributes.rb

@@ -1,8 +1,69 @@
 module GOVUKDesignSystemFormBuilder
   module Traits
     module HTMLAttributes
+      # Attributes eases working with default and custom attributes by:
+      # * deeply merging them so both the default (required) attributes are
+      #   present
+      # * joins the arrays into strings to maintain Rails 6.0.3 compatibility
+      class Attributes
+        # Don't try to deep merge these fields, when we remove duplicates
+        # whilst merging the resulting values later, repeating words are lost
+        SKIP = [
+          %i(id),
+          %i(value),
+          %i(title),
+          %i(alt),
+          %i(href),
+          %i(aria label)
+        ].freeze
+
+        def initialize(defaults, custom)
+          @merged = defaults.deeper_merge(deep_split_values(custom))
+        end
+
+        def to_h
+          deep_join_values(@merged)
+        end
+
+      private
+
+        def deep_split_values(hash, parent = nil)
+          hash.each.with_object({}) do |(key, value), result|
+            result[key] = case value
+                          when Hash
+                            deep_split_values(value, key)
+                          when String
+                            split_list_values(key, value, parent)
+                          else
+                            value
+                          end
+          end
+        end
+
+        def split_list_values(key, value, parent = nil)
+          if [parent, key].compact.in?(SKIP)
+            value
+          else
+            value.split
+          end
+        end
+
+        def deep_join_values(hash)
+          hash.each.with_object({}) do |(key, value), result|
+            result[key] = case value
+                          when Hash
+                            deep_join_values(value)
+                          when Array
+                            value.uniq.join(' ').presence
+                          else
+                            value
+                          end
+          end
+        end
+      end
+
       def attributes(html_attributes = {})
-        options.deeper_merge(html_attributes)
+        Attributes.new(options, html_attributes).to_h
       end
     end
   end

data/lib/govuk_design_system_formbuilder/traits/input.rb

@@ -15,7 +15,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, content])
         end
       end
@@ -31,7 +31,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def affixed_input
-        content_tag('div', class: %(#{brand}-input__wrapper)) do
+        tag.div(class: %(#{brand}-input__wrapper)) do
           safe_join([prefix, input, suffix])
         end
       end
@@ -86,13 +86,13 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def prefix
-        return nil if @prefix_text.blank?
+        return if @prefix_text.blank?
 
         tag.span(@prefix_text, class: %(#{brand}-input__prefix), **affix_options)
       end
 
       def suffix
-        return nil if @suffix_text.blank?
+        return if @suffix_text.blank?
 
         tag.span(@suffix_text, class: %(#{brand}-input__suffix), **affix_options)
       end

data/lib/govuk_design_system_formbuilder/traits/label.rb

@@ -7,7 +7,7 @@ module GOVUKDesignSystemFormBuilder
         @label_element ||= if @label.nil?
                              Elements::Null.new
                            else
-                             Elements::Label.new(@builder, @object_name, @attribute_name, caption: @caption, **label_content)
+                             Elements::Label.new(*bound, caption: @caption, **label_content)
                            end
       end
 

data/lib/govuk_design_system_formbuilder/traits/select.rb

@@ -0,0 +1,15 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Select
+    private
+
+      def classes
+        [%(#{brand}-select), error_class].flatten.compact
+      end
+
+      def error_class
+        %(#{brand}-select--error) if has_errors?
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/supplemental.rb

@@ -2,7 +2,7 @@ module GOVUKDesignSystemFormBuilder
   module Traits
     module Supplemental
       def supplemental_id
-        return nil if @block_content.blank?
+        return if @block_content.blank?
 
         build_id('supplemental')
       end
@@ -10,7 +10,7 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def supplemental_content
-        @supplemental_content ||= Containers::Supplemental.new(@builder, @object_name, @attribute_name, @block_content)
+        @supplemental_content ||= Containers::Supplemental.new(*bound, @block_content)
       end
     end
   end

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.3.0b1'.freeze
+  VERSION = '2.5.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.3.0b1
+  version: 2.5.1
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -255,19 +255,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.1.0
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: slim_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.2
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -295,6 +309,7 @@ files:
 - lib/govuk_design_system_formbuilder/elements/check_boxes/collection_check_box.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/fieldset_check_box.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/label.rb
+- lib/govuk_design_system_formbuilder/elements/collection_select.rb
 - lib/govuk_design_system_formbuilder/elements/date.rb
 - lib/govuk_design_system_formbuilder/elements/error_message.rb
 - lib/govuk_design_system_formbuilder/elements/error_summary.rb
@@ -325,6 +340,7 @@ files:
 - lib/govuk_design_system_formbuilder/traits/input.rb
 - lib/govuk_design_system_formbuilder/traits/label.rb
 - lib/govuk_design_system_formbuilder/traits/localisation.rb
+- lib/govuk_design_system_formbuilder/traits/select.rb
 - lib/govuk_design_system_formbuilder/traits/supplemental.rb
 - lib/govuk_design_system_formbuilder/version.rb
 homepage: https://govuk-form-builder.netlify.app
@@ -347,11 +363,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: GOV.UK-compliant Rails form builder