govuk_design_system_formbuilder 5.13.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85b31999d082502993e2c44a3f7ff65a835282d5f4dbeefe87a43c2325a0283
-  data.tar.gz: b93488509128aead2962edf6245b136ddd7f4c05acf5db3879c3f3de6db6a637
+  metadata.gz: e5cdce7fa87b070e4c8335c43ee6a23e8ad7ca61933f1ad0a3a80339c3e1959a
+  data.tar.gz: b3446d561dc3a96c23d6140ad0f966edd39517891eac18e1a3c41d894c8b48c5
 SHA512:
-  metadata.gz: 4b59d25e6ebcf63efd277478885281a177fc7bd58bfdd3eb735a0d05b5e30942280fd8d54c9c1af085191c23bd7098d212cbfce99d18d7c1ce374893fa3e1aed
-  data.tar.gz: 85878e2904f6917b222549385b58c4d6476bfa9c8a26ace9115fa8b2f61bc84820f8512ee175cebf60ce4a2d9b5584788deac4216db9562b2325f2c829f4fe81
+  metadata.gz: d74467eeac3d4b1001452df29de4d3a6e92159346f820b7d70b06ea74a34e175748891abebdc0867245fbaafffae30bef8d36c8637104f46ce11d82ac832790d
+  data.tar.gz: c4752085f758ddf51b544c9a6b59425fdcccfc5ea316560ccafedb18a40f002bd3f228da78d8df379e3cc588266ad3fa871f84aa56b3f9c4123e31f73c2e8cba

data/README.md

@@ -1,12 +1,12 @@
 # GOV.UK Form Builder for Ruby on Rails
 
-[![Tests](https://github.com/x-govuk/govuk-form-builder/workflows/Tests/badge.svg)](https://github.com/x-govuk/govuk-form-builder/actions)
+[![Tests](https://github.com/x-govuk/govuk-form-builder/actions/workflows/tests.yml/badge.svg)](https://github.com/x-govuk/govuk-form-builder/actions/workflows/tests.yml)
 [![Gem version](https://badge.fury.io/rb/govuk_design_system_formbuilder.svg)](https://badge.fury.io/rb/govuk_design_system_formbuilder)
 [![Gem](https://img.shields.io/gem/dt/govuk_design_system_formbuilder?logo=rubygems)](https://rubygems.org/gems/govuk_design_system_formbuilder)
-[![GitHub license](https://img.shields.io/github/license/x-govuk/govuk-form-builder)](https://github.com/x-govuk/govuk-form-builder/blob/main/LICENSE)
-[![GOV.UK Design System version](https://img.shields.io/badge/GOV.UK%20Design%20System-5.13.0-brightgreen)](https://design-system.service.gov.uk)
-[![Rails](https://img.shields.io/badge/Rails-7.1.5%20%E2%95%B1%207.2.2%20%E2%95%B1%208.0.1-E16D6D)](https://weblog.rubyonrails.org/releases/)
-[![Ruby](https://img.shields.io/badge/Ruby-3.2.6%20%20%E2%95%B1%203.3.6%20%20%E2%95%B1%203.4.1-E16D6D)](https://www.ruby-lang.org/en/downloads/)
+![GitHub license](https://img.shields.io/github/license/x-govuk/govuk-form-builder)
+[![GOV.UK Design System version](https://img.shields.io/badge/GOV.UK%20Design%20System-6.0.0-brightgreen)](https://design-system.service.gov.uk)
+[![Rails](https://img.shields.io/badge/Rails-7.2.3%20%E2%95%B1%208.0.1%20%E2%95%B1%208.1.2-E16D6D)](https://weblog.rubyonrails.org/releases/)
+[![Ruby](https://img.shields.io/badge/Ruby-3.2.10%20%20%E2%95%B1%203.4.8%20%20%E2%95%B1%204.0.1-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/).
 

data/lib/govuk_design_system_formbuilder/base.rb

@@ -80,7 +80,7 @@ module GOVUKDesignSystemFormBuilder
       [
         @object_name,
         attribute,
-        value,
+        format_value(value),
         id_type
       ]
         .compact
@@ -89,6 +89,15 @@ module GOVUKDesignSystemFormBuilder
         .tr(replace, delimiter)
     end
 
+    def format_value(value)
+      case value
+      when Integer, Float
+        (value.negative?) ? "minus-#{value.abs}" : value
+      else
+        value
+      end
+    end
+
     def warn(message)
       return unless config.enable_logger
 

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -43,6 +43,8 @@ module GOVUKDesignSystemFormBuilder
     # @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+
+    # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -66,8 +68,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_text_field :callsign,
     #     label: -> { tag.h3('Call-sign') }
     #
-    def govuk_text_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, **kwargs, &block)
-      Elements::Inputs::Text.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, **kwargs, &block).html
+    def govuk_text_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, before_input: nil, after_input: nil, **kwargs, &block)
+      Elements::Inputs::Text.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, before_input:, after_input:, **kwargs, &block).html
     end
 
     # Generates a input of type +tel+
@@ -96,6 +98,8 @@ module GOVUKDesignSystemFormBuilder
     # @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+
+    # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -120,8 +124,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_phone_field :work_number,
     #     label: -> { tag.h3('Work number') }
     #
-    def govuk_phone_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, **kwargs, &block)
-      Elements::Inputs::Phone.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, **kwargs, &block).html
+    def govuk_phone_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, before_input: nil, after_input: nil, **kwargs, &block)
+      Elements::Inputs::Phone.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, before_input:, after_input:, **kwargs, &block).html
     end
 
     # Generates a input of type +email+
@@ -150,6 +154,8 @@ module GOVUKDesignSystemFormBuilder
     # @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+
+    # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -172,8 +178,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_email_field :personal_email,
     #     label: -> { tag.h3('Personal email address') }
     #
-    def govuk_email_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, **kwargs, &block)
-      Elements::Inputs::Email.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, **kwargs, &block).html
+    def govuk_email_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, before_input: nil, after_input: nil, **kwargs, &block)
+      Elements::Inputs::Email.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, before_input:, after_input:, **kwargs, &block).html
     end
 
     # Generates a input of type +url+
@@ -202,6 +208,8 @@ module GOVUKDesignSystemFormBuilder
     # @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+
+    # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -224,8 +232,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_url_field :work_website,
     #     label: -> { tag.h3("Enter your company's website") }
     #
-    def govuk_url_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, **kwargs, &block)
-      Elements::Inputs::URL.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, **kwargs, &block).html
+    def govuk_url_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, before_input: nil, after_input: nil, **kwargs, &block)
+      Elements::Inputs::URL.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, before_input:, after_input:, **kwargs, &block).html
     end
 
     # Generates a input of type +number+
@@ -254,6 +262,8 @@ module GOVUKDesignSystemFormBuilder
     # @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+
+    # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -279,8 +289,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_url_field :personal_best_over_100m,
     #     label: -> { tag.h3("How many seconds does it take you to run 100m?") }
     #
-    def govuk_number_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, **kwargs, &block)
-      Elements::Inputs::Number.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, **kwargs, &block).html
+    def govuk_number_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false, form_group: {}, prefix_text: nil, suffix_text: nil, before_input: nil, after_input: nil, **kwargs, &block)
+      Elements::Inputs::Number.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, before_input:, after_input:, **kwargs, &block).html
     end
 
     # Generates a password input
@@ -422,6 +432,8 @@ module GOVUKDesignSystemFormBuilder
     # @param options [Hash] Options hash passed through to Rails' +collection_select+ helper
     # @param form_group [Hash] configures the form group
     # @option form_group kwargs [Hash] additional attributes added to the form group
+    # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
     # @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)
     # @return [ActiveSupport::SafeBuffer] HTML output
@@ -443,7 +455,7 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_collection_select(:team, @teams, :id, :name) do
     #     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)
+    def govuk_collection_select(attribute_name, collection, value_method, text_method, options: {}, hint: {}, label: {}, caption: {}, form_group: {}, before_input: nil, after_input: nil, **kwargs, &block)
       Elements::CollectionSelect.new(
         self,
         object_name,
@@ -456,6 +468,8 @@ module GOVUKDesignSystemFormBuilder
         caption:,
         options:,
         form_group:,
+        before_input:,
+        after_input:,
         **kwargs,
         &block
       ).html
@@ -479,6 +493,8 @@ module GOVUKDesignSystemFormBuilder
     # @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 kwargs [Hash] additional attributes added to the form group
+    # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
     # @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
@@ -492,8 +508,8 @@ module GOVUKDesignSystemFormBuilder
     #
     #   = 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:, label:, hint:, form_group:, caption:, **kwargs, &block).html
+    def govuk_select(attribute_name, choices = nil, options: {}, label: {}, hint: {}, form_group: {}, caption: {}, before_input: nil, after_input: nil, **kwargs, &block)
+      Elements::Select.new(self, object_name, attribute_name, choices, options:, label:, hint:, form_group:, caption:, before_input:, after_input:, **kwargs, &block).html
     end
 
     # Generates a radio button for each item in the supplied collection
@@ -943,6 +959,8 @@ module GOVUKDesignSystemFormBuilder
     # @param form_group [Hash] configures the form group
     # @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 before_inputs [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_inputs [String,Proc] the content injected after the input. No content will be added if left +nil+
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input group
     # @param date_of_birth [Boolean] if +true+ {https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete#Values birth date auto completion attributes}
     #   will be added to the inputs
@@ -957,13 +975,63 @@ module GOVUKDesignSystemFormBuilder
     #     hint: { text: 'Leave this field blank if you don't know exactly' } do
     #
     #       p.govuk-inset-text
-    #         | If you don't fill this in you won't be eligable for a refund
+    #         | If you don't fill this in you won't be eligible for a refund
     #
     # @example A date input with legend supplied as a proc
     #  = f.govuk_date_field :finishes_on,
     #    legend: -> { tag.h3('Which category do you belong to?') }
-    def govuk_date_field(attribute_name, hint: {}, legend: {}, caption: {}, date_of_birth: false, omit_day: false, maxlength_enabled: false, segments: config.default_date_segments, segment_names: config.default_date_segment_names, form_group: {}, **kwargs, &block)
-      Elements::Date.new(self, object_name, attribute_name, hint:, legend:, caption:, date_of_birth:, omit_day:, maxlength_enabled:, segments:, segment_names:, form_group:, **kwargs, &block).html
+    def govuk_date_field(attribute_name, hint: {}, legend: {}, caption: {}, date_of_birth: false, omit_day: false, maxlength_enabled: false, segments: config.default_date_segments, segment_names: config.default_date_segment_names, before_inputs: nil, after_inputs: nil, form_group: {}, **kwargs, &block)
+      Elements::Date.new(self, object_name, attribute_name, hint:, legend:, caption:, date_of_birth:, omit_day:, maxlength_enabled:, segments:, segment_names:, form_group:, before_inputs:, after_inputs:, **kwargs, &block).html
+    end
+
+    # Generates three inputs for the +hour+, +minute+ and +second+ components of a time
+    #
+    # @note When using this input values will be retrieved from the attribute if it is a Time 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+
+    # @option hint text [String] the hint text
+    # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
+    # @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+
+    # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+.
+    # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
+    # @option legend kwargs [Hash] additional arguments are applied as attributes on the +legend+ element
+    # @param caption [Hash] configures or sets the caption content which is inserted above the legend
+    # @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 omit_second [Boolean] do not render a second input, only capture hour and minute
+    # @param maxlength_enabled [Boolean] adds maxlength attribute to hour, minute and second inputs (2)
+    # @param segments [Hash] allows Rails' multiparameter attributes to be overridden on a field-by-field basis. Hash must
+    #   contain +hour:+, +minute:+ and +second:+ keys. Defaults to the default value set in the +default_time_segments+ setting in {GOVUKDesignSystemFormBuilder.DEFAULTS}
+    # @param segment_names [Hash] allows the day, month and year labels to be overridden. Hash must
+    #   contain +hour:+, +minute:+ and +second:+ keys. Defaults to the default value set in the +default_time_segment_names+ setting in {GOVUKDesignSystemFormBuilder.DEFAULTS}
+    # @param form_group [Hash] configures the form group
+    # @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 before_inputs [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_inputs [String,Proc] the content injected after the input. No content will be added if left +nil+
+    # @param block [Block] arbitrary HTML that will be rendered between the hint and the input group
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @see https://github.com/alphagov/govuk-frontend/issues/1449 GOV.UK date input element attributes, using text instead of number
+    # @see https://design-system.service.gov.uk/styles/typography/#headings-with-captions Headings with captions
+    #
+    # @example A regular time input with a legend, hint and injected content
+    #   = f.govuk_time_field :starts_at,
+    #     legend: { 'When does your event start?' },
+    #     hint: { text: 'Leave this field blank if you don't know exactly' } do
+    #
+    #       p.govuk-inset-text
+    #         | If you don't fill this, the event will be all day
+    #
+    # @example A time input with legend supplied as a proc
+    #  = f.govuk_time_field :finishes_at,
+    #    legend: -> { tag.h3('When does the event finish?') }
+    def govuk_time_field(attribute_name, hint: {}, legend: {}, caption: {}, omit_second: false, maxlength_enabled: false, segments: config.default_time_segments, segment_names: config.default_time_segment_names, before_inputs: nil, after_inputs: nil, form_group: {}, **kwargs, &block)
+      Elements::Time.new(self, object_name, attribute_name, hint:, legend:, caption:, omit_second:, maxlength_enabled:, segments:, segment_names:, form_group:, before_inputs:, after_inputs:, **kwargs, &block).html
     end
 
     # Generates a summary of errors in the form, each linking to the corresponding
@@ -1049,6 +1117,8 @@ module GOVUKDesignSystemFormBuilder
     # @param form_group [Hash] configures the form group
     # @option form_group kwargs [Hash] additional attributes added to the form group
     # @param javascript [Boolean] Configures whether to add HTML for the javascript-enhanced version of the component
+    # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+    # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
     #
     # @example A photo upload field with file type specifier and injected content
@@ -1067,8 +1137,8 @@ module GOVUKDesignSystemFormBuilder
     # @note Remember to set +multipart: true+ when creating a form with file
     #   uploads, {https://guides.rubyonrails.org/form_helpers.html#uploading-files see
     #   the Rails documentation} for more information
-    def govuk_file_field(attribute_name, label: {}, caption: {}, hint: {}, form_group: {}, javascript: false, **kwargs, &block)
-      Elements::File.new(self, object_name, attribute_name, label:, caption:, hint:, form_group:, javascript:, **kwargs, &block).html
+    def govuk_file_field(attribute_name, label: {}, caption: {}, hint: {}, form_group: {}, javascript: false, before_input: nil, after_input: nil, **kwargs, &block)
+      Elements::File.new(self, object_name, attribute_name, label:, caption:, hint:, form_group:, javascript:, before_input:, after_input:, **kwargs, &block).html
     end
   end
 end

data/lib/govuk_design_system_formbuilder/containers/supplemental.rb

@@ -10,15 +10,7 @@ module GOVUKDesignSystemFormBuilder
       def html
         return if @content.blank?
 
-        warn("Supplemental content is deprecated and support will soon be removed. See https://github.com/x-govuk/govuk-form-builder/issues/445")
-
-        tag.div(id: supplemental_id) { @content }
-      end
-
-    private
-
-      def supplemental_id
-        build_id('supplemental')
+        tag.div { @content }
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/collection_select.rb

@@ -7,8 +7,9 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Supplemental
       include Traits::HTMLAttributes
       include Traits::Select
+      include Traits::ContentBeforeAndAfter
 
-      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint:, label:, caption:, form_group:, options: {}, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint:, label:, caption:, form_group:, before_input:, after_input:, options: {}, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
         @collection      = collection
@@ -20,6 +21,8 @@ module GOVUKDesignSystemFormBuilder
         @hint            = hint
         @form_group      = form_group
         @html_attributes = kwargs
+        @before_input    = before_input
+        @after_input     = after_input
 
         # FIXME remove this soon, worth informing people who miss the release notes that the
         #       args have changed though.
@@ -30,7 +33,7 @@ module GOVUKDesignSystemFormBuilder
 
       def html
         Containers::FormGroup.new(*bound, **@form_group).html do
-          safe_join([label_element, supplemental_content, hint_element, error_element, collection_select])
+          safe_join([label_element, supplemental_content, hint_element, error_element, before_input_content, collection_select, after_input_content])
         end
       end
 

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -8,10 +8,12 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Supplemental
       include Traits::HTMLClasses
       include Traits::Localisation
+      include Traits::DateInput
+      include Traits::ContentBeforeAndAfter
 
       MULTIPARAMETER_KEY = { day: 3, month: 2, year: 1 }.freeze
 
-      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, omit_day:, maxlength_enabled:, segments:, form_group:, segment_names:, date_of_birth: false, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, omit_day:, maxlength_enabled:, segments:, form_group:, segment_names:, before_inputs:, after_inputs:, date_of_birth: false, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
         @legend            = legend
@@ -24,36 +26,24 @@ module GOVUKDesignSystemFormBuilder
         @segment_names     = segment_names
         @form_group        = form_group
         @html_attributes   = kwargs
-      end
-
-      def html
-        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
+        @before_input      = before_inputs
+        @after_input       = after_inputs
       end
 
     private
 
-      def fieldset_options
-        { legend: @legend, caption: @caption, described_by: [error_id, hint_id, supplemental_id] }
+      def parts
+        [day, month, year]
       end
 
-      def date
-        tag.div(class: %(#{brand}-date-input)) do
-          safe_join([day, month, year])
-        end
+      def fieldset_options
+        { legend: @legend, caption: @caption, described_by: [error_id, hint_id] }
       end
 
       def omit_day?
         @omit_day
       end
 
-      def maxlength_enabled?
-        @maxlength_enabled
-      end
-
       def day
         if omit_day?
           return tag.input(
@@ -75,95 +65,11 @@ module GOVUKDesignSystemFormBuilder
         date_part(:year, width: 4)
       end
 
-      def date_part(segment, width:, link_errors: false)
-        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(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_label_text(segment),
-          class: label_classes,
-          for: id(segment, link_errors)
-        )
-      end
-
-      def segment_label_text(segment)
-        localised_text(:label, segment) || @segment_names.fetch(segment)
-      end
-
-      def input(segment, link_errors, width, value)
-        tag.input(
-          id: id(segment, link_errors),
-          class: classes(width),
-          name: name(segment),
-          type: 'text',
-          inputmode: 'numeric',
-          value:,
-          autocomplete: date_of_birth_autocomplete_value(segment),
-          maxlength: (width if maxlength_enabled?),
-        )
-      end
-
-      def classes(width)
-        build_classes(
-          %(input),
-          %(date-input__input),
-          %(input--width-#{width}),
-          %(input--error) => has_errors?,
-        ).prefix(brand)
-      end
-
-      # if the field has errors we want the govuk_error_summary to
-      # be able to link to the day field. Otherwise, generate IDs
-      # in the normal fashion
-      def id(segment, link_errors)
-        if has_errors? && link_errors
-          field_id(link_errors:)
-        else
-          [@object_name, @attribute_name, @segments.fetch(segment)].join("_")
-        end
-      end
-
-      def name(segment)
-        format(
-          "%<object_name>s[%<input_name>s(%<segment>s)]",
-          object_name: @object_name,
-          input_name: @attribute_name,
-          segment: @segments.fetch(segment)
-        )
-      end
-
-      def date_of_birth_autocomplete_value(segment)
+      def autocomplete_value(segment)
         return unless @date_of_birth
 
         { day: 'bday-day', month: 'bday-month', year: 'bday-year' }.fetch(segment)
       end
-
-      def label_classes
-        build_classes(%(label), %(date-input__label)).prefix(brand)
-      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -9,8 +9,9 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Supplemental
       include Traits::HTMLAttributes
       include Traits::HTMLClasses
+      include Traits::ContentBeforeAndAfter
 
-      def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, javascript:, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, javascript:, before_input:, after_input:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
         @label           = label
@@ -19,11 +20,13 @@ module GOVUKDesignSystemFormBuilder
         @html_attributes = kwargs
         @form_group      = form_group
         @javascript      = javascript
+        @before_input    = before_input
+        @after_input     = after_input
       end
 
       def html
         Containers::FormGroup.new(*bound, **@form_group).html do
-          safe_join([label_element, supplemental_content, hint_element, error_element, file_html])
+          safe_join([label_element, supplemental_content, hint_element, error_element, before_input_content, file_html, after_input_content])
         end
       end
 

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

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

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

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

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

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

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

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

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

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

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -6,8 +6,9 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
       include Traits::HTMLAttributes
       include Traits::Select
+      include Traits::ContentBeforeAndAfter
 
-      def initialize(builder, object_name, attribute_name, choices, options:, form_group:, label:, hint:, caption:, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, choices, options:, form_group:, label:, hint:, caption:, before_input:, after_input:, **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)
@@ -20,11 +21,13 @@ module GOVUKDesignSystemFormBuilder
         @choices         = choices
         @options         = options
         @html_attributes = kwargs
+        @before_input    = before_input
+        @after_input     = after_input
       end
 
       def html
         Containers::FormGroup.new(*bound, **@form_group).html do
-          safe_join([label_element, hint_element, error_element, select])
+          safe_join([label_element, hint_element, error_element, before_input_content, select, after_input_content])
         end
       end
 

data/lib/govuk_design_system_formbuilder/elements/time.rb

@@ -0,0 +1,66 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Time < Base
+      using PrefixableArray
+
+      include Traits::Error
+      include Traits::Hint
+      include Traits::Supplemental
+      include Traits::HTMLClasses
+      include Traits::Localisation
+      include Traits::DateInput
+      include Traits::ContentBeforeAndAfter
+
+      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, omit_second:, maxlength_enabled:, segments:, form_group:, before_inputs:, after_inputs:, segment_names:, **kwargs, &block)
+        super(builder, object_name, attribute_name, &block)
+
+        @legend            = legend
+        @caption           = caption
+        @hint              = hint
+        @omit_second       = omit_second
+        @maxlength_enabled = maxlength_enabled
+        @segments          = segments
+        @segment_names     = segment_names
+        @form_group        = form_group
+        @html_attributes   = kwargs
+        @before_input      = before_inputs
+        @after_input       = after_inputs
+      end
+
+    private
+
+      def parts
+        [hour, minute, second]
+      end
+
+      def omit_second?
+        @omit_second
+      end
+
+      def hour
+        date_part(:hour, width: 2, link_errors: true)
+      end
+
+      def minute
+        date_part(:minute, width: 2)
+      end
+
+      def second
+        if omit_second?
+          return tag.input(
+            id: id(:second, false),
+            name: name(:second),
+            type: 'hidden',
+            value: value(:second) || 0,
+          )
+        end
+
+        date_part(:second, width: 2)
+      end
+
+      def autocomplete_value(_segment)
+        nil
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/content_before_and_after.rb

@@ -0,0 +1,24 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module ContentBeforeAndAfter
+      def before_input_content
+        build_content(@before_input)
+      end
+
+      def after_input_content
+        build_content(@after_input)
+      end
+
+    private
+
+      def build_content(content)
+        case content
+        when String
+          content
+        when Proc
+          content.call
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/date_input.rb

@@ -0,0 +1,118 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module DateInput
+      using PrefixableArray
+
+      MULTIPARAMETER_KEY = { year: 1, month: 2, day: 3, hour: 4, minute: 5, second: 6 }.freeze
+      SEGMENT_METHOD = { year: :year, month: :month, day: :day, hour: :hour, minute: :min, second: :sec }.freeze
+
+      def html
+        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_input])
+          end
+        end
+      end
+
+    private
+
+      def date_input
+        tag.div(class: %(#{brand}-date-input)) do
+          safe_join([before_input_content, *parts, after_input_content])
+        end
+      end
+
+      def maxlength_enabled?
+        @maxlength_enabled
+      end
+
+      def fieldset_options
+        { legend: @legend, caption: @caption, described_by: [error_id, hint_id, supplemental_id] }
+      end
+
+      def segment_label_text(segment)
+        localised_text(:label, segment) || @segment_names.fetch(segment)
+      end
+
+      def classes(width)
+        build_classes(
+          %(input),
+          %(date-input__input),
+          %(input--width-#{width}),
+          %(input--error) => has_errors?,
+        ).prefix(brand)
+      end
+
+      def date_part(segment, width:, link_errors: false)
+        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(segment))])
+          end
+        end
+      end
+
+      def value(segment)
+        attribute = @builder.object.try(@attribute_name)
+
+        return unless attribute
+
+        if 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
+        elsif attribute.respond_to?(SEGMENT_METHOD[segment])
+          attribute.send(SEGMENT_METHOD.fetch(segment))
+        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_label_text(segment),
+          class: label_classes,
+          for: id(segment, link_errors)
+        )
+      end
+
+      def input(segment, link_errors, width, value)
+        tag.input(
+          id: id(segment, link_errors),
+          class: classes(width),
+          name: name(segment),
+          type: 'text',
+          inputmode: 'numeric',
+          value:,
+          autocomplete: autocomplete_value(segment),
+          maxlength: (width if maxlength_enabled?),
+        )
+      end
+
+      # if the field has errors we want the govuk_error_summary to
+      # be able to link to the hour field. Otherwise, generate IDs
+      # in the normal fashion
+      def id(segment, link_errors)
+        if has_errors? && link_errors
+          field_id(link_errors:)
+        else
+          [@object_name, @attribute_name, @segments.fetch(segment)].join("_")
+        end
+      end
+
+      def name(segment)
+        format(
+          "%<object_name>s[%<input_name>s(%<segment>s)]",
+          object_name: @object_name,
+          input_name: @attribute_name,
+          segment: @segments.fetch(segment)
+        )
+      end
+
+      def label_classes
+        build_classes(%(label), %(date-input__label)).prefix(brand)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/input.rb

@@ -1,7 +1,7 @@
 module GOVUKDesignSystemFormBuilder
   module Traits
     module Input
-      def initialize(builder, object_name, attribute_name, hint:, label:, caption:, prefix_text:, suffix_text:, width:, extra_letter_spacing:, form_group:, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, hint:, label:, caption:, prefix_text:, suffix_text:, width:, extra_letter_spacing:, form_group:, before_input:, after_input:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
         @width                = width
@@ -13,6 +13,8 @@ module GOVUKDesignSystemFormBuilder
         @html_attributes      = kwargs
         @form_group           = form_group
         @extra_letter_spacing = extra_letter_spacing
+        @before_input         = before_input
+        @after_input          = after_input
       end
 
       def html
@@ -24,16 +26,20 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def content
-        if affixed?
-          affixed_input
-        else
-          input
-        end
+        safe_join([
+          before_input_content,
+          if affixed?
+            affixed_input
+          else
+            input
+          end,
+          after_input_content
+        ])
       end
 
       def affixed_input
         tag.div(class: %(#{brand}-input__wrapper)) do
-          safe_join([prefix, input, suffix])
+          safe_join([prefix, input, suffix].compact)
         end
       end
 

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '5.13.0'.freeze
+  VERSION = '6.0.0'.freeze
 end

data/lib/govuk_design_system_formbuilder.rb

@@ -1,4 +1,4 @@
-require 'active_support/configurable'
+require 'active_support/ordered_options'
 require 'html_attributes_utils'
 
 [%w(presenters *.rb), %w(refinements *.rb), %w(traits *.rb), %w(*.rb), %w(elements ** *.rb), %w(containers ** *.rb)]
@@ -6,7 +6,16 @@ require 'html_attributes_utils'
   .each { |file| require file }
 
 module GOVUKDesignSystemFormBuilder
-  include ActiveSupport::Configurable
+  class << self
+    class_attribute :config,
+                    instance_predicate: false,
+                    default: ActiveSupport::OrderedOptions.new
+
+    def inherited(klass) # :nodoc:
+      klass.config = ActiveSupport::InheritableOptions.new(config)
+      super
+    end
+  end
 
   # @!group Defaults
 
@@ -102,6 +111,8 @@ module GOVUKDesignSystemFormBuilder
     default_submit_button_text: 'Continue',
     default_date_segments: { day: '3i', month: '2i', year: '1i' },
     default_date_segment_names: { day: 'Day', month: 'Month', year: 'Year' },
+    default_time_segments: { hour: '4i', minute: '5i', second: '6i' },
+    default_time_segment_names: { hour: 'Hour', minute: 'Minute', second: 'Second' },
     default_radio_divider_text: 'or',
     default_check_box_divider_text: 'or',
     default_error_message_prefix: 'Error',
@@ -133,7 +144,20 @@ module GOVUKDesignSystemFormBuilder
     enable_nested_localisation: true,
   }.freeze
 
-  DEFAULTS.each_key { |k| config_accessor(k) { DEFAULTS[k] } }
+  DEFAULTS.each do |key, value|
+    reader = "def #{key}; config.#{key}; end"
+    reader_line = __LINE__
+    writer = "def #{key}=(value); config.#{key} = value; end"
+    writer_line = __LINE__
+
+    singleton_class.class_eval reader, __FILE__, reader_line
+    singleton_class.class_eval writer, __FILE__, writer_line
+
+    class_eval reader, __FILE__, reader_line
+    class_eval writer, __FILE__, writer_line
+
+    send("#{key}=", value)
+  end
   # @!endgroup
 
   class << self
@@ -146,7 +170,7 @@ module GOVUKDesignSystemFormBuilder
     #     conf.default_error_summary_title = 'OMG'
     #   end
     def configure
-      yield(config)
+      yield config
     end
 
     # Resets each of the configurable values to its default

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 5.13.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Peter Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-30 00:00:00.000000000 Z
+date: 2026-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-attributes-utils
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.20
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.20
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -170,28 +170,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.13.0
+        version: 4.14.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.13.0
+        version: 4.14.6
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.6.1
+        version: 4.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.6.1
+        version: 4.7.0
 - !ruby/object:Gem::Dependency
   name: rubypants
   requirement: !ruby/object:Gem::Requirement
@@ -337,11 +337,14 @@ files:
 - lib/govuk_design_system_formbuilder/elements/select.rb
 - lib/govuk_design_system_formbuilder/elements/submit.rb
 - lib/govuk_design_system_formbuilder/elements/text_area.rb
+- lib/govuk_design_system_formbuilder/elements/time.rb
 - lib/govuk_design_system_formbuilder/presenters/error_summary.rb
 - lib/govuk_design_system_formbuilder/proxy.rb
 - lib/govuk_design_system_formbuilder/refinements/prefixable_array.rb
 - lib/govuk_design_system_formbuilder/traits/caption.rb
 - lib/govuk_design_system_formbuilder/traits/collection_item.rb
+- lib/govuk_design_system_formbuilder/traits/content_before_and_after.rb
+- lib/govuk_design_system_formbuilder/traits/date_input.rb
 - lib/govuk_design_system_formbuilder/traits/error.rb
 - lib/govuk_design_system_formbuilder/traits/fieldset_item.rb
 - lib/govuk_design_system_formbuilder/traits/hint.rb
@@ -378,7 +381,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: GOV.UK Form Builder for Ryby on Rails