govuk_design_system_formbuilder 3.3.0 → 4.0.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aea46724787c5953367b445c27575127974c204c200d67c292060300f6dd495
-  data.tar.gz: 0e970ab6cd0d33c1ebff78eff8d18d84ff6a220b1ee4380e1bc0d8807eeddade
+  metadata.gz: d47c45ad2ca56f3942aea3cd0f7d6e2f06a89ebfde5b94254ae56477dac2b611
+  data.tar.gz: 7f8ed5d840ab7b3f5c338ef7ad764b2f5eac7d6e1f35e0918521b385425b9a47
 SHA512:
-  metadata.gz: 4b26f916111db6591a3d5aeefc6f0459783c357b08a864dc019f509b65d3b39582669618b2ae8e5cc95ffa57e79cf2386f4305f5c32aaef091d5fbda229a2ada
-  data.tar.gz: e595c1ee43f34d60a16b0115bf3a96d2b700132f94e7d8996dfdb843e68ef0c33f85df322086724e15fcfc0f4a3737a885fd8f299e6fe45c02598281ba705d39
+  metadata.gz: 33328d0ac48cea098b5ae01024341b08733b4aef090d673b800e240295bcdc5902f686a000ad482be4bfcb439a7c98d07fda68e97d7951f72ad54aca5d05b9e8
+  data.tar.gz: 0276bb87a3cd4a20f26152ba72aa1b439cb05726a56c9770f65d2b1cbc417b5820cf5d02d580954faa3766aaac36029d21395688c13e394e6e6ed49775b1c546

data/README.md

@@ -6,9 +6,9 @@
 [![Gem](https://img.shields.io/gem/dt/govuk_design_system_formbuilder?logo=rubygems)](https://rubygems.org/gems/govuk_design_system_formbuilder)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/110136fb22341d3ba646/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk-formbuilder/test_coverage)
 [![GitHub license](https://img.shields.io/github/license/DFE-Digital/govuk_design_system_formbuilder)](https://github.com/DFE-Digital/govuk-formbuilder/blob/main/LICENSE)
-[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-4.4.0-brightgreen)](https://design-system.service.gov.uk)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-4.5.0-brightgreen)](https://design-system.service.gov.uk)
 [![Rails](https://img.shields.io/badge/Rails-6.1.7%20%E2%95%B1%207.0.4-E16D6D)](https://weblog.rubyonrails.org/releases/)
-[![Ruby](https://img.shields.io/badge/Ruby-2.7.6%20%20%E2%95%B1%203.0.4%20%20%E2%95%B1%203.1.2-E16D6D)](https://www.ruby-lang.org/en/downloads/)
+[![Ruby](https://img.shields.io/badge/Ruby-3.0.5%20%20%E2%95%B1%203.1.3%20%20%E2%95%B1%203.2.0-E16D6D)](https://www.ruby-lang.org/en/downloads/)
 
 This library provides an easy-to-use form builder for the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
@@ -130,7 +130,7 @@ git config --global user.name "Julius Hibbert"
 
 ## Services using this library
 
-Approximately [70 services use this library](https://github.com/DFE-Digital/govuk-formbuilder/network/dependents),
+Approximately [100 services use this library](https://github.com/DFE-Digital/govuk-formbuilder/network/dependents),
 here are a few from the <abbr title="Department for Education">DfE</abbr>, <abbr title="Ministry of Justice">MoJ</abbr>, and
 <abbr title="Department for Business, Energy & Industrial Strategy">BEIS</abbr>.
 

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -24,7 +24,6 @@ module GOVUKDesignSystemFormBuilder
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ 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 prefix_text [String] the text placed before the input. No prefix will be added if left +nil+
     # @param suffix_text [String] the text placed after the input. No suffix will be added if left +nil+
@@ -76,7 +75,6 @@ module GOVUKDesignSystemFormBuilder
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ 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 prefix_text [String] the text placed before the input. No prefix will be added if left +nil+
     # @param suffix_text [String] the text placed after the input. No suffix will be added if left +nil+
@@ -129,7 +127,6 @@ module GOVUKDesignSystemFormBuilder
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ 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 prefix_text [String] the text placed before the input. No prefix will be added if left +nil+
     # @param suffix_text [String] the text placed after the input. No suffix will be added if left +nil+
@@ -180,7 +177,6 @@ module GOVUKDesignSystemFormBuilder
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ 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 prefix_text [String] the text placed before the input. No prefix will be added if left +nil+
     # @param suffix_text [String] the text placed after the input. No suffix will be added if left +nil+
@@ -230,7 +226,6 @@ module GOVUKDesignSystemFormBuilder
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ 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 prefix_text [String] the text placed before the input. No prefix will be added if left +nil+
     # @param suffix_text [String] the text placed after the input. No suffix will be added if left +nil+
@@ -281,7 +276,6 @@ module GOVUKDesignSystemFormBuilder
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ 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 prefix_text [String] the text placed before the input. No prefix will be added if left +nil+
     # @param suffix_text [String] the text placed after the input. No suffix will be added if left +nil+
@@ -339,7 +333,6 @@ module GOVUKDesignSystemFormBuilder
     # @param rows [Integer] sets the initial number of rows
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +textarea+ 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
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +textarea+ element
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
@@ -389,7 +382,6 @@ module GOVUKDesignSystemFormBuilder
     # @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 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] arbitrary HTML that will be rendered between the hint and the input
     # @see https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_select Rails collection_select (called by govuk_collection_select)
@@ -447,7 +439,6 @@ module GOVUKDesignSystemFormBuilder
     # @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)
@@ -494,7 +485,6 @@ module GOVUKDesignSystemFormBuilder
     # @param small [Boolean] controls whether small radio buttons are used instead of regular-sized ones
     # @param bold_labels [Boolean] controls whether the radio button labels are bold
     # @param include_hidden [Boolean] controls whether a hidden field is inserted to allow for empty submissions
-    # @param classes [Array,String] Classes to add to the radio button container.
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+.
@@ -538,7 +528,7 @@ module GOVUKDesignSystemFormBuilder
     #    :name,
     #    legend: -> { tag.h3('Which category do you belong to?') }
     #
-    def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method = nil, hint_method = nil, hint: {}, legend: {}, caption: {}, inline: false, small: false, bold_labels: nil, classes: nil, include_hidden: config.default_collection_radio_buttons_include_hidden, form_group: {}, &block)
+    def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method = nil, hint_method = nil, hint: {}, legend: {}, caption: {}, inline: false, small: false, bold_labels: nil, include_hidden: config.default_collection_radio_buttons_include_hidden, form_group: {}, **kwargs, &block)
       Elements::Radios::Collection.new(
         self,
         object_name,
@@ -553,9 +543,9 @@ module GOVUKDesignSystemFormBuilder
         inline: inline,
         small: small,
         bold_labels: bold_labels,
-        classes: classes,
         form_group: form_group,
         include_hidden: include_hidden,
+        **kwargs,
         &block
       ).html
     end
@@ -585,10 +575,8 @@ module GOVUKDesignSystemFormBuilder
     # @option caption size [String] the size of the caption, can be +xl+, +l+ or +m+. Defaults to +m+
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ 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] a block of HTML that will be used to populate the fieldset
-    # @param classes [Array,String] Classes to add to the radio button container.
     # @see https://design-system.service.gov.uk/components/radios/ GOV.UK Radios
     # @see https://design-system.service.gov.uk/styles/typography/#headings-with-captions Headings with captions
     # @return [ActiveSupport::SafeBuffer] HTML output
@@ -610,8 +598,8 @@ module GOVUKDesignSystemFormBuilder
     #      = f.govuk_radio_button :burger_id, :regular, label: { text: 'Hamburger' }, link_errors: true
     #      = f.govuk_radio_button :burger_id, :cheese, label: { text: 'Cheeseburger' }
     #
-    def govuk_radio_buttons_fieldset(attribute_name, hint: {}, legend: {}, caption: {}, inline: false, small: false, classes: nil, form_group: {}, &block)
-      Containers::RadioButtonsFieldset.new(self, object_name, attribute_name, hint: hint, legend: legend, caption: caption, inline: inline, small: small, classes: classes, form_group: form_group, &block).html
+    def govuk_radio_buttons_fieldset(attribute_name, hint: {}, legend: {}, caption: {}, inline: false, small: false, form_group: {}, **kwargs, &block)
+      Containers::RadioButtonsFieldset.new(self, object_name, attribute_name, hint: hint, legend: legend, caption: caption, inline: inline, small: small, form_group: form_group, **kwargs, &block).html
     end
 
     # Generates a radio button
@@ -671,7 +659,6 @@ module GOVUKDesignSystemFormBuilder
     # @option hint text [String] the hint text
     # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
     # @param small [Boolean] controls whether small check boxes are used instead of regular-sized ones
-    # @param classes [Array,String] Classes to add to the checkbox container.
     # @param legend [NilClass,Hash,Proc] options for configuring the legend. Legend will be omitted if +nil+.
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
@@ -682,7 +669,6 @@ module GOVUKDesignSystemFormBuilder
     # @option caption size [String] the size of the caption, can be +xl+, +l+ or +m+. Defaults to +m+
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ 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 include_hidden [Boolean] controls whether a hidden field is inserted to allow for empty submissions
     # @param block [Block] any HTML passed in will be injected into the fieldset, after the hint and before the checkboxes
@@ -703,7 +689,7 @@ module GOVUKDesignSystemFormBuilder
     #    legend: { text: 'What do you want in your sandwich?', size: 'm' },
     #    hint: { text: "If it isn't listed here, tough luck" },
     #    inline: false,
-    #    classes: 'app-overflow-scroll',
+    #    class: 'app-overflow-scroll',
     #
     # @example A collection of check boxes for types of bread
     #  = f.govuk_collection_check_boxes :bread,
@@ -721,7 +707,7 @@ module GOVUKDesignSystemFormBuilder
     #    :name,
     #    legend: -> { tag.h3('What kind of sandwich do you want?') }
     #
-    def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil, hint: {}, legend: {}, caption: {}, small: false, classes: nil, form_group: {}, include_hidden: config.default_collection_check_boxes_include_hidden, &block)
+    def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil, hint: {}, legend: {}, caption: {}, small: false, form_group: {}, include_hidden: config.default_collection_check_boxes_include_hidden, **kwargs, &block)
       Elements::CheckBoxes::Collection.new(
         self,
         object_name,
@@ -734,9 +720,9 @@ module GOVUKDesignSystemFormBuilder
         legend: legend,
         caption: caption,
         small: small,
-        classes: classes,
         form_group: form_group,
         include_hidden: include_hidden,
+        **kwargs,
         &block
       ).html
     end
@@ -762,11 +748,9 @@ module GOVUKDesignSystemFormBuilder
     # @option caption text [String] the caption text
     # @option caption size [String] the size of the caption, can be +xl+, +l+ or +m+. Defaults to +m+
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
-    # @param classes [Array,String] Classes to add to the checkbox container.
     # @param form_group [Hash] configures the form group
     # @param multiple [Boolean] when true adds a +[]+ suffix the +name+ of the automatically-generated hidden field
     #   (ie. <code>project[invoice_attributes][]</code>). When false, no +[]+ suffix is added (ie. <code>project[accepted]</code>)
-    # @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] a block of HTML that will be used to populate the fieldset
     # @return [ActiveSupport::SafeBuffer] HTML output
@@ -781,7 +765,7 @@ module GOVUKDesignSystemFormBuilder
     #    = f.govuk_check_box :desired_filling, :lemonade, label: { text: 'Lemonade' }, link_errors: true
     #    = f.govuk_check_box :desired_filling, :fizzy_orange, label: { text: 'Fizzy orange' }
     #
-    def govuk_check_boxes_fieldset(attribute_name, legend: {}, caption: {}, hint: {}, small: false, classes: nil, form_group: {}, multiple: true, &block)
+    def govuk_check_boxes_fieldset(attribute_name, legend: {}, caption: {}, hint: {}, small: false, form_group: {}, multiple: true, **kwargs, &block)
       Containers::CheckBoxesFieldset.new(
         self,
         object_name,
@@ -790,9 +774,9 @@ module GOVUKDesignSystemFormBuilder
         legend: legend,
         caption: caption,
         small: small,
-        classes: classes,
         form_group: form_group,
         multiple: multiple,
+        **kwargs,
         &block
       ).html
     end
@@ -861,7 +845,6 @@ module GOVUKDesignSystemFormBuilder
     # @param text [String,Proc] the button text. When a +Proc+ is provided its contents will be rendered within the button element
     # @param warning [Boolean] makes the button red ({https://design-system.service.gov.uk/components/button/#warning-buttons warning}) when true
     # @param secondary [Boolean] makes the button grey ({https://design-system.service.gov.uk/components/button/#secondary-buttons secondary}) when true
-    # @param classes [Array,String] Classes to add to the submit button
     # @param prevent_double_click [Boolean] adds JavaScript to safeguard the
     #   form from being submitted more than once
     # @param validate [Boolean] adds the formnovalidate to the submit button when true, this disables all
@@ -886,8 +869,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_submit "Proceed", prevent_double_click: true do
     #     = link_to 'Cancel', some_other_path, class: 'govuk-button__secondary'
     #
-    def govuk_submit(text = config.default_submit_button_text, warning: false, secondary: false, classes: nil, prevent_double_click: true, validate: config.default_submit_validate, disabled: false, **kwargs, &block)
-      Elements::Submit.new(self, text, warning: warning, secondary: secondary, classes: classes, prevent_double_click: prevent_double_click, validate: validate, disabled: disabled, **kwargs, &block).html
+    def govuk_submit(text = config.default_submit_button_text, warning: false, secondary: false, prevent_double_click: true, validate: config.default_submit_validate, disabled: false, **kwargs, &block)
+      Elements::Submit.new(self, text, warning: warning, secondary: secondary, prevent_double_click: prevent_double_click, validate: validate, disabled: disabled, **kwargs, &block).html
     end
 
     # Generates three inputs for the +day+, +month+ and +year+ components of a date
@@ -914,7 +897,6 @@ module GOVUKDesignSystemFormBuilder
     # @param omit_day [Boolean] do not render a day input, only capture month and year
     # @param maxlength_enabled [Boolean] adds maxlength attribute to day, month and year inputs (2, 2, and 4, respectively)
     # @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
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ element
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input group
@@ -1021,7 +1003,6 @@ module GOVUKDesignSystemFormBuilder
     # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ 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] arbitrary HTML that will be rendered between the hint and the input
     #

data/lib/govuk_design_system_formbuilder/containers/check_boxes.rb

@@ -1,15 +1,18 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class CheckBoxes < Base
-      def initialize(builder, small:, classes: nil)
+      include Traits::HTMLClasses
+      include Traits::HTMLAttributes
+
+      def initialize(builder, small:, **kwargs)
         super(builder, nil, nil)
 
-        @small   = small
-        @classes = classes
+        @small = small
+        @html_attributes = kwargs
       end
 
       def html(&block)
-        tag.div(**options, &block)
+        tag.div(**attributes(@html_attributes), &block)
       end
 
     private
@@ -22,15 +25,10 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def classes
-        combine_references(%(#{brand}-checkboxes), small_class, custom_classes)
-      end
-
-      def small_class
-        %(#{brand}-checkboxes--small) if @small
-      end
-
-      def custom_classes
-        Array.wrap(@classes)
+        build_classes(
+          %(#{brand}-checkboxes),
+          %(#{brand}-checkboxes--small) => @small,
+        )
       end
     end
   end

data/lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb

@@ -4,18 +4,18 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
       include Traits::Hint
 
-      def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, small:, classes:, form_group:, multiple:, &block)
+      def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, small:, form_group:, multiple:, **kwargs, &block)
         fail LocalJumpError, 'no block given' unless block_given?
 
         super(builder, object_name, attribute_name, &block)
 
-        @legend        = legend
-        @caption       = caption
-        @hint          = hint
-        @small         = small
-        @classes       = classes
-        @form_group    = form_group
-        @multiple      = multiple
+        @legend          = legend
+        @caption         = caption
+        @hint            = hint
+        @small           = small
+        @form_group      = form_group
+        @multiple        = multiple
+        @html_attributes = kwargs
       end
 
       def html
@@ -47,7 +47,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def checkboxes
-        Containers::CheckBoxes.new(@builder, small: @small, classes: @classes).html do
+        Containers::CheckBoxes.new(@builder, small: @small, **@html_attributes).html do
           @block_content
         end
       end

data/lib/govuk_design_system_formbuilder/containers/form_group.rb

@@ -1,33 +1,28 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class FormGroup < Base
-      def initialize(builder, object_name, attribute_name, classes: nil, **kwargs)
+      include Traits::HTMLAttributes
+      include Traits::HTMLClasses
+
+      def initialize(builder, object_name, attribute_name, **kwargs)
         super(builder, object_name, attribute_name)
 
-        @classes         = classes
         @html_attributes = kwargs
       end
 
       def html(&block)
-        tag.div(class: classes, **@html_attributes, &block)
+        tag.div(**attributes(@html_attributes), &block)
       end
 
     private
 
-      def classes
-        combine_references(form_group_class, error_class, custom_classes)
-      end
-
-      def form_group_class
-        %(#{brand}-form-group)
-      end
-
-      def error_class
-        %(#{brand}-form-group--error) if has_errors?
-      end
-
-      def custom_classes
-        Array.wrap(@classes)
+      def options
+        {
+          class: build_classes(
+            %(#{brand}-form-group),
+            %(#{brand}-form-group--error) => has_errors?
+          )
+        }
       end
     end
   end

data/lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb

@@ -4,18 +4,18 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
       include Traits::Error
 
-      def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, inline:, small:, classes:, form_group:, &block)
+      def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, inline:, small:, form_group:, **kwargs, &block)
         fail LocalJumpError, 'no block given' unless block_given?
 
         super(builder, object_name, attribute_name, &block)
 
-        @inline        = inline
-        @small         = small
-        @legend        = legend
-        @caption       = caption
-        @hint          = hint
-        @classes       = classes
-        @form_group    = form_group
+        @inline          = inline
+        @small           = small
+        @legend          = legend
+        @caption         = caption
+        @hint            = hint
+        @form_group      = form_group
+        @html_attributes = kwargs
       end
 
       def html
@@ -37,7 +37,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def radios
-        Containers::Radios.new(@builder, inline: @inline, small: @small, classes: @classes).html do
+        Containers::Radios.new(@builder, inline: @inline, small: @small, **@html_attributes).html do
           @block_content
         end
       end

data/lib/govuk_design_system_formbuilder/containers/radios.rb

@@ -2,17 +2,19 @@ module GOVUKDesignSystemFormBuilder
   module Containers
     class Radios < Base
       include Traits::Hint
+      include Traits::HTMLAttributes
+      include Traits::HTMLClasses
 
-      def initialize(builder, inline:, small:, classes:)
+      def initialize(builder, inline:, small:, **kwargs)
         super(builder, nil, nil)
 
-        @inline  = inline
-        @small   = small
-        @classes = classes
+        @inline          = inline
+        @small           = small
+        @html_attributes = kwargs
       end
 
       def html(&block)
-        tag.div(**options, &block)
+        tag.div(**attributes(@html_attributes), &block)
       end
 
     private
@@ -25,19 +27,11 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def classes
-        combine_references(%(#{brand}-radios), inline_class, small_class, custom_classes)
-      end
-
-      def inline_class
-        %(#{brand}-radios--inline) if @inline
-      end
-
-      def small_class
-        %(#{brand}-radios--small)  if @small
-      end
-
-      def custom_classes
-        Array.wrap(@classes)
+        build_classes(
+          %(#{brand}-radios),
+          %(#{brand}-radios--inline) => @inline,
+          %(#{brand}-radios--small) => @small,
+        )
       end
     end
   end

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

@@ -6,20 +6,20 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Supplemental
 
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint:, legend:, caption:, small:, classes:, form_group:, include_hidden:, hint_method: nil, &block)
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint:, legend:, caption:, small:, form_group:, include_hidden:, hint_method: nil, **kwargs, &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           = hint
-          @classes        = classes
-          @form_group     = form_group
-          @include_hidden = include_hidden
+          @collection      = collection
+          @value_method    = value_method
+          @text_method     = text_method
+          @hint_method     = hint_method
+          @small           = small
+          @legend          = legend
+          @caption         = caption
+          @hint            = hint
+          @form_group      = form_group
+          @include_hidden  = include_hidden
+          @html_attributes = kwargs
         end
 
         def html
@@ -41,7 +41,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def check_boxes
-          Containers::CheckBoxes.new(@builder, small: @small, classes: @classes).html do
+          Containers::CheckBoxes.new(@builder, small: @small, **@html_attributes).html do
             collection
           end
         end

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

@@ -6,22 +6,22 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Supplemental
 
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint:, legend:, caption:, inline:, small:, bold_labels:, classes:, form_group:, include_hidden:, &block)
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint:, legend:, caption:, inline:, small:, bold_labels:, form_group:, include_hidden:, **kwargs, &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           = hint
-          @classes        = classes
-          @form_group     = form_group
-          @include_hidden = include_hidden
-          @bold_labels    = (bold_labels.nil? && auto_bold_labels?) || 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            = hint
+          @form_group      = form_group
+          @include_hidden  = include_hidden
+          @bold_labels     = (bold_labels.nil? && auto_bold_labels?) || bold_labels
+          @html_attributes = kwargs
         end
 
         def html
@@ -48,7 +48,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def radios
-          Containers::Radios.new(@builder, inline: @inline, small: @small, classes: @classes).html do
+          Containers::Radios.new(@builder, inline: @inline, small: @small, **@html_attributes).html do
             safe_join(collection)
           end
         end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -2,9 +2,10 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     class Submit < Base
       using PrefixableArray
+      include Traits::HTMLClasses
       include Traits::HTMLAttributes
 
-      def initialize(builder, text, warning:, secondary:, classes:, prevent_double_click:, validate:, disabled:, **kwargs, &block)
+      def initialize(builder, text, warning:, secondary:, prevent_double_click:, validate:, disabled:, **kwargs, &block)
         super(builder, nil, nil)
 
         fail ArgumentError, 'buttons can be warning or secondary' if warning && secondary
@@ -13,7 +14,6 @@ module GOVUKDesignSystemFormBuilder
         @prevent_double_click = prevent_double_click
         @warning              = warning
         @secondary            = secondary
-        @classes              = classes
         @validate             = validate
         @disabled             = disabled
         @html_attributes      = kwargs
@@ -56,34 +56,19 @@ module GOVUKDesignSystemFormBuilder
           disabled: @disabled,
           class: classes,
           data: {
-            module: %(#{brand}-button),
-            'prevent-double-click': @prevent_double_click
+            'module' => %(#{brand}-button),
+            'prevent-double-click' => @prevent_double_click
           }.select { |_k, v| v.present? }
         }
       end
 
       def classes
-        %w(button)
-          .prefix(brand)
-          .push(warning_class, secondary_class, disabled_class, custom_classes)
-          .flatten
-          .compact
-      end
-
-      def warning_class
-        %(#{brand}-button--warning) if @warning
-      end
-
-      def secondary_class
-        %(#{brand}-button--secondary) if @secondary
-      end
-
-      def disabled_class
-        %(#{brand}-button--disabled) if @disabled
-      end
-
-      def custom_classes
-        Array.wrap(@classes)
+        build_classes(
+          "button",
+          "button--warning" => @warning,
+          "button--secondary" => @secondary,
+          "button--disabled" => @disabled,
+        ).prefix(brand)
       end
     end
   end

data/lib/govuk_design_system_formbuilder/traits/localisation.rb

@@ -1,6 +1,10 @@
 module GOVUKDesignSystemFormBuilder
   module Traits
     module Localisation
+      # starts with an letter that is followed by other word characters or
+      # spaces, zero or more times
+      BASE_NAME_REGEXP = %r{[[:alpha:]](?:[\w\s]*)}.freeze
+
     private
 
       def localised_text(context)
@@ -25,10 +29,16 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def schema_path
+        base_object_name = if config.enable_nested_localisation
+                             @object_name.to_s.scan(BASE_NAME_REGEXP).join(".")
+                           else
+                             @object_name
+                           end
+
         if @value.present?
-          [@object_name, "#{@attribute_name}_options", @value]
+          [base_object_name, "#{@attribute_name}_options", @value]
         else
-          [@object_name, @attribute_name]
+          [base_object_name, @attribute_name]
         end
       end
 

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '3.3.0'.freeze
+  VERSION = '4.0.0rc1'.freeze
 end

data/lib/govuk_design_system_formbuilder.rb

@@ -80,6 +80,10 @@ module GOVUKDesignSystemFormBuilder
   # * +:trust_error_messages+ call html_safe on error messages before they're
   #   rendered. This allows formatting markup to be used to change the display
   #   of the error message. Defaults to +false+
+  #
+  # * +:enable_nested_localisation+ scan the object name before building the
+  #   localisation schema path to see if it's nested or not. The old behaviour
+  #   can be restored by setting this option to +false+. Defaults to +true+
   # ===
   DEFAULTS = {
     brand: 'govuk',
@@ -107,6 +111,10 @@ module GOVUKDesignSystemFormBuilder
 
     enable_logger: true,
     trust_error_messages: false,
+
+    # temporarily allow the new nested localisation functionality to be
+    # disabled
+    enable_nested_localisation: true,
   }.freeze
 
   DEFAULTS.each_key { |k| config_accessor(k) { DEFAULTS[k] } }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0rc1
 platform: ruby
 authors:
 - Peter Yates
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-attributes-utils
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: 4.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: 4.10.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -182,28 +176,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: 4.12.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: 4.12.15
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: rubypants
   requirement: !ruby/object:Gem::Requirement
@@ -280,14 +274,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.1
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -362,7 +356,7 @@ metadata:
   homepage_uri: https://govuk-form-builder.netlify.app
   source_code_uri: https://github.com/DFE-Digital/govuk-formbuilder
   github_repo: https://github.com/DFE-Digital/govuk-formbuilder
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -373,12 +367,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: GOV.UK-compliant Rails form builder
 test_files: []