govuk_design_system_formbuilder 2.6.0 → 2.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0f0c49f266a8cb411ebed4833b6284cc8cc4b6acd8ce3bf87d705feb40062b
-  data.tar.gz: b2659204e304dd40ed2254d06f43acdd4b5b5f13fc48d180741645d004c15719
+  metadata.gz: 8dde478d08a40d1cc871b7f0b2db7180db591ec384d4d7cc160ce9523605d8f2
+  data.tar.gz: f406bfbc2ac3b5eb5a5ce5c6cade4138459323a6a9fe9e8cbe23dcf33edcd9cb
 SHA512:
-  metadata.gz: 962d77c5cc9b3501f0b8efab08a9f7c930d3aed9b28e96e06bd4e9851fd00586eb557a43150f6b911c7ad5044d0cc4e0bc08027697faf223aa70ce0765558898
-  data.tar.gz: 8af398e7d5673dd8b8b5f25810d88afb281a297f409c5883d567fd13a9f0347cbe644c2f32f6e69b1ec8a0e261ad81abf723e444d6186bdfb7f9901431f70c10
+  metadata.gz: 112918eb62e62548f16a27cb8e3a33e353d4be9543819f366f88671e628faff90a4ec28fb49a4a76d0d8ed0136569db090a36091c1cf6e1e3e0f360e770939c4
+  data.tar.gz: ae6d8df17006b0a5d77eb6bd21d8402f53eca1087c34071c39534ca8e9753e33a6ca555f242eadf2a83e6eeaa4cbc92689e19458351851ba408cf4b419b656e3

data/README.md

@@ -1,15 +1,14 @@
 # GOV.UK Design System Form Builder for Rails
 
-[![Tests](https://github.com/DFE-Digital/govuk_design_system_formbuilder/workflows/Tests/badge.svg)](https://github.com/DFE-Digital/govuk_design_system_formbuilder/actions)
-[![Maintainability](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/maintainability)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/maintainability)
+[![Tests](https://github.com/DFE-Digital/govuk-formbuilder/workflows/Tests/badge.svg)](https://github.com/DFE-Digital/govuk-formbuilder/actions)
+[![Maintainability](https://api.codeclimate.com/v1/badges/110136fb22341d3ba646/maintainability)](https://codeclimate.com/github/DFE-Digital/govuk-formbuilder/maintainability)
 [![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)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/test_coverage)
-[![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.12.0-brightgreen)](https://design-system.service.gov.uk)
-[![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.7%20%E2%95%B1%206.1.3.2-E16D6D)](https://weblog.rubyonrails.org/releases/)
+[![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/master/LICENSE)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.13.0-brightgreen)](https://design-system.service.gov.uk)
+[![Rails](https://img.shields.io/badge/Ruby-2.6.8%20%E2%95%B1%202.7.4%20%E2%95%B1%203.0.2-E16D6D)](https://www.ruby-lang.org/en/downloads/)
+[![Ruby](https://img.shields.io/badge/Rails-6.0.4%20%E2%95%B1%206.1.3.2-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/).
 
@@ -129,6 +128,21 @@ To help keep the logs clean and tidy, please configure git to use your full name
 git config --global user.name "Julius Hibbert"
 ```
 
+## Services using this library
+
+Approximately [40 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>.
+
+ * [Apply for teacher training](https://www.github.com/DFE-Digital/apply-for-teacher-training)
+ * [Teaching Vacancies](https://www.github.com/DFE-Digital/teaching-vacancies)
+ * [Get a teacher training adviser](https://www.github.com/DFE-Digital/get-teacher-training-adviser-service/)
+ * [Claim for crown court defence](https://www.github.com/ministryofjustice/Claim-for-Crown-Court-Defence)
+ * [Appeal to the tax tribunal](https://www.github.com/ministryofjustice/tax-tribunals-datacapture)
+ * [Apply to court about child arrangements](https://www.github.com/ministryofjustice/c100-application)
+ * [Trade Tariff duty calculator](https://www.github.com/trade-tariff/trade-tariff-duty-calculator)
+ * [Report your official development assistance](https://www.github.com/UKGovernmentBEIS/beis-report-official-development-assistance)
+
 ## Thanks 👩🏽‍⚖️
 
 This project was inspired by [Ministry of Justice's GovukElementsFormBuilder](https://github.com/ministryofjustice/govuk_elements_form_builder),

data/lib/govuk_design_system_formbuilder/base.rb

@@ -57,7 +57,7 @@ module GOVUKDesignSystemFormBuilder
         @builder.object.errors.messages[@attribute_name].present?
     end
 
-    def described_by(*ids)
+    def combine_references(*ids)
       ids.flatten.compact
     end
 

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -813,6 +813,8 @@ 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 multiple [Boolean] controls whether the check box is part of a collection or represents a single attribute
+    # @param exclusive [Boolean] sets the checkbox so that when checked none of its siblings can be too. Usually
+    #   used for the 'None of these apply to me' option found beneath a {#govuk_check_box_divider}.
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ element
     # @param block [Block] any HTML passed in will form the contents of the fieldset
     # @return [ActiveSupport::SafeBuffer] HTML output
@@ -825,7 +827,7 @@ module GOVUKDesignSystemFormBuilder
     #     label: { text: 'Do you agree with our terms and conditions?' },
     #     hint: { text: 'You will not be able to proceed unless you do' }
     #
-    def govuk_check_box(attribute_name, value, unchecked_value = false, hint: {}, label: {}, link_errors: false, multiple: true, **kwargs, &block)
+    def govuk_check_box(attribute_name, value, unchecked_value = false, hint: {}, label: {}, link_errors: false, multiple: true, exclusive: false, **kwargs, &block)
       Elements::CheckBoxes::FieldsetCheckBox.new(
         self,
         object_name,
@@ -836,14 +838,27 @@ module GOVUKDesignSystemFormBuilder
         label: label,
         link_errors: link_errors,
         multiple: multiple,
+        exclusive: exclusive,
         **kwargs,
         &block
       ).html
     end
 
+    # Inserts a text divider into a list of check boxes
+    #
+    # @param text [String] The divider text
+    # @note This should only be used from within a {#govuk_check_boxes_fieldset}
+    # @see https://design-system.service.gov.uk/components/checkboxes/#add-an-option-for-none- GOV.UK check boxes with a text divider
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    # @example A custom divider
+    #   = govuk_check_box_divider 'On the other hand'
+    def govuk_check_box_divider(text = config.default_check_box_divider_text)
+      tag.div(text, class: %w(govuk-checkboxes__divider))
+    end
+
     # Generates a submit button, green by default
     #
-    # @param text [String] the button text
+    # @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
@@ -853,7 +868,7 @@ module GOVUKDesignSystemFormBuilder
     #   client-side validation provided by the browser. This is to provide a more consistent and accessible user
     #   experience
     # @param disabled [Boolean] makes the button disabled when true
-    # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ element
+    # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +button+ element
     # @param block [Block] When content is passed in via a block the submit element and the block content will
     #   be wrapped in a +<div class="govuk-button-group">+ which will space the buttons and links within
     #   evenly.
@@ -861,8 +876,9 @@ module GOVUKDesignSystemFormBuilder
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @note Only the first additional button or link (passed in via a block) will be given the
     #   correct left margin, subsequent buttons will need to be manually accounted for
-    # @note This helper always renders an +<input type='submit'>+ tag, HTML content is not supported inside. You
-    #   can place +<button>+ tags inside the form to have the same effect
+    # @note This helper always renders an +<button type='submit'>+ tag. Previous versions of this gem rendered
+    #   a +`<input type='submit'>' tag instead, but there is a {https://github.com/alphagov/govuk_elements/issues/545 longstanding bug}
+    #   with this approach where the top few pixels don't initiate a submission when clicked.
     # @see https://design-system.service.gov.uk/components/button/#stop-users-from-accidentally-sending-information-more-than-once
     #   GOV.UK double click prevention
     #
@@ -935,6 +951,13 @@ module GOVUKDesignSystemFormBuilder
     #   which they were defined on the model).
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the error summary +div+ element
     # @param block [Block] arbitrary HTML that will be rendered between title and error message list
+    # @param presenter [Class,Object] the class or object that is responsible for formatting a list of error
+    #   messages that will be rendered in the summary.
+    #
+    #   * When a class is specified it will be instantiated with the object's errors in the +object.errors.messages+ format.
+    #   * When an object is specified it will be used as-is.
+    #
+    #   The object must implement +#formatted_error_messages+, see {Presenters::ErrorSummaryPresenter} for more details.
     #
     # @note Only the first error in the +#errors+ array for each attribute will
     #   be included.
@@ -943,8 +966,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_error_summary 'Uh-oh, spaghettios'
     #
     # @see https://design-system.service.gov.uk/components/error-summary/ GOV.UK error summary
-    def govuk_error_summary(title = config.default_error_summary_title, link_base_errors_to: nil, order: nil, **kwargs, &block)
-      Elements::ErrorSummary.new(self, object_name, title, link_base_errors_to: link_base_errors_to, order: order, **kwargs, &block).html
+    def govuk_error_summary(title = config.default_error_summary_title, presenter: config.default_error_summary_presenter, link_base_errors_to: nil, order: nil, **kwargs, &block)
+      Elements::ErrorSummary.new(self, object_name, title, link_base_errors_to: link_base_errors_to, order: order, presenter: presenter, **kwargs, &block).html
     end
 
     # Generates a fieldset containing the contents of the block

data/lib/govuk_design_system_formbuilder/containers/check_boxes.rb

@@ -22,7 +22,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def classes
-        [%(#{brand}-checkboxes), small_class, custom_classes].flatten.compact
+        combine_references(%(#{brand}-checkboxes), small_class, custom_classes)
       end
 
       def small_class

data/lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb

@@ -5,6 +5,8 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
 
       def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, small:, classes:, form_group:, multiple:, &block)
+        fail LocalJumpError, 'no block given' unless block_given?
+
         super(builder, object_name, attribute_name, &block)
 
         @legend        = legend
@@ -14,7 +16,6 @@ module GOVUKDesignSystemFormBuilder
         @classes       = classes
         @form_group    = form_group
         @multiple      = multiple
-        @block_content = capture { block.call }
       end
 
       def html

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -8,7 +8,7 @@ module GOVUKDesignSystemFormBuilder
 
         @legend          = legend
         @caption         = caption
-        @described_by    = described_by(described_by)
+        @described_by    = combine_references(described_by)
         @attribute_name  = attribute_name
         @html_attributes = kwargs
       end

data/lib/govuk_design_system_formbuilder/containers/form_group.rb

@@ -15,7 +15,7 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def classes
-        [form_group_class, error_class, custom_classes].flatten.compact
+        combine_references(form_group_class, error_class, custom_classes)
       end
 
       def form_group_class

data/lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb

@@ -5,7 +5,9 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
 
       def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, inline:, small:, classes:, form_group:, &block)
-        super(builder, object_name, attribute_name)
+        fail LocalJumpError, 'no block given' unless block_given?
+
+        super(builder, object_name, attribute_name, &block)
 
         @inline        = inline
         @small         = small
@@ -14,7 +16,6 @@ module GOVUKDesignSystemFormBuilder
         @hint          = hint
         @classes       = classes
         @form_group    = form_group
-        @block_content = capture { block.call }
       end
 
       def html

data/lib/govuk_design_system_formbuilder/containers/radios.rb

@@ -25,7 +25,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def classes
-        [%(#{brand}-radios), inline_class, small_class, custom_classes].flatten.compact
+        combine_references(%(#{brand}-radios), inline_class, small_class, custom_classes)
       end
 
       def inline_class

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

@@ -7,8 +7,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::HTMLAttributes
         include Traits::FieldsetItem
 
-        def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, **kwargs, &block)
-          super(builder, object_name, attribute_name)
+        def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, exclusive:, **kwargs, &block)
+          super(builder, object_name, attribute_name, &block)
 
           @value           = value
           @unchecked_value = unchecked_value
@@ -17,8 +17,9 @@ module GOVUKDesignSystemFormBuilder
           @multiple        = multiple
           @link_errors     = link_errors
           @html_attributes = kwargs
+          @exclusive       = exclusive
 
-          conditional_content(&block)
+          conditional_content(@block_content)
         end
 
       private
@@ -28,12 +29,18 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def input
-          @builder.check_box(@attribute_name, attributes(@html_attributes), @value, @unchecked_value)
+          @builder.check_box(@attribute_name, attributes(@html_attributes.deep_merge(exclusive_options)), @value, @unchecked_value)
         end
 
         def fieldset_options
           { checkbox: true }
         end
+
+        def exclusive_options
+          return {} unless @exclusive
+
+          { data: { behaviour: 'exclusive' } }
+        end
       end
     end
   end

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

@@ -16,7 +16,7 @@ module GOVUKDesignSystemFormBuilder
 
         def html
           @checkbox.label(for: field_id(link_errors: @link_errors), class: label_classes) do
-            [localised_text(:label), @checkbox.text, @value].compact.first.to_s
+            label_content.to_s
           end
         end
 
@@ -25,6 +25,10 @@ module GOVUKDesignSystemFormBuilder
         def label_classes
           %w(label checkboxes__label).prefix(brand)
         end
+
+        def label_content
+          [localised_text(:label), @checkbox.text, @value].find(&:presence)
+        end
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/collection_select.rb

@@ -40,7 +40,7 @@ module GOVUKDesignSystemFormBuilder
         {
           id: field_id(link_errors: true),
           class: classes,
-          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+          aria: { describedby: combine_references(hint_id, error_id, supplemental_id) }
         }
       end
 

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -4,13 +4,14 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
       include Traits::HTMLAttributes
 
-      def initialize(builder, object_name, title, link_base_errors_to:, order:, **kwargs, &block)
+      def initialize(builder, object_name, title, link_base_errors_to:, order:, presenter:, **kwargs, &block)
         super(builder, object_name, nil, &block)
 
         @title               = title
         @link_base_errors_to = link_base_errors_to
         @html_attributes     = kwargs
         @order               = order
+        @presenter           = presenter
       end
 
       def html
@@ -33,7 +34,17 @@ module GOVUKDesignSystemFormBuilder
 
       def list
         tag.ul(class: [%(#{brand}-list), summary_class('list')]) do
-          safe_join(error_messages.map { |attribute, messages| list_item(attribute, messages.first) })
+          safe_join(presenter.formatted_error_messages.map { |args| list_item(*args) })
+        end
+      end
+
+      # If the provided @presenter is a class, instantiate it with the sorted
+      # error_messages from our object. Otherwise (if it's any other object),
+      # treat it like a presenter
+      def presenter
+        (@presenter.is_a?(Class) ? @presenter.new(error_messages) : @presenter).tap do |p|
+          fail(ArgumentError, "error summary presenter doesn't implement #formatted_error_messages") unless
+            p.respond_to?(:formatted_error_messages)
         end
       end
 
@@ -41,8 +52,10 @@ module GOVUKDesignSystemFormBuilder
         messages = @builder.object.errors.messages
 
         if reorder_errors?
-          return messages.sort_by.with_index(1) do |(attr, _val), i|
-            error_order.index(attr) || (i + messages.size)
+          adjustment = error_order.size + messages.size
+
+          return messages.sort_by.with_index do |(attr, _val), i|
+            error_order.index(attr) || (i + adjustment)
           end
         end
 

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -35,7 +35,7 @@ module GOVUKDesignSystemFormBuilder
         {
           id: field_id(link_errors: true),
           class: classes,
-          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+          aria: { describedby: combine_references(hint_id, error_id, supplemental_id) }
         }
       end
 

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

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :number_field
         end

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

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :password_field
         end

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

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :phone_field
         end

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

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :text_field
         end

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

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :url_field
         end

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -50,7 +50,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def retrieve_text(option_text, hidden)
-        text = [option_text, localised_text(:label), @attribute_name.capitalize].compact.first
+        text = [option_text, localised_text(:label), @attribute_name.capitalize].find(&:presence)
 
         if hidden
           tag.span(text, class: %(#{brand}-visually-hidden))

data/lib/govuk_design_system_formbuilder/elements/legend.rb

@@ -45,7 +45,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def retrieve_text(supplied_text)
-        [supplied_text, localised_text(:legend), @attribute_name&.capitalize].compact.first
+        [supplied_text, localised_text(:legend), @attribute_name&.capitalize].find(&:presence)
       end
 
       def classes

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

@@ -8,7 +8,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::FieldsetItem
 
         def initialize(builder, object_name, attribute_name, value, label:, hint:, link_errors:, **kwargs, &block)
-          super(builder, object_name, attribute_name)
+          super(builder, object_name, attribute_name, &block)
 
           @value           = value
           @label           = label
@@ -16,7 +16,7 @@ module GOVUKDesignSystemFormBuilder
           @link_errors     = has_errors? && link_errors
           @html_attributes = kwargs
 
-          conditional_content(&block)
+          conditional_content(@block_content)
         end
 
       private

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -38,7 +38,7 @@ module GOVUKDesignSystemFormBuilder
         {
           id: field_id(link_errors: true),
           class: classes,
-          aria: { describedby: described_by(hint_id, error_id) }
+          aria: { describedby: combine_references(hint_id, error_id) }
         }
       end
     end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -9,7 +9,7 @@ module GOVUKDesignSystemFormBuilder
 
         fail ArgumentError, 'buttons can be warning or secondary' if warning && secondary
 
-        @text                 = text
+        @text                 = build_text(text)
         @prevent_double_click = prevent_double_click
         @warning              = warning
         @secondary            = secondary
@@ -26,6 +26,17 @@ module GOVUKDesignSystemFormBuilder
 
     private
 
+      def build_text(text)
+        case text
+        when String
+          text
+        when Proc
+          capture { text.call }
+        else
+          fail(ArgumentError, %(text must be a String or Proc))
+        end
+      end
+
       def button_group
         Containers::ButtonGroup.new(@builder, buttons).html
       end
@@ -35,11 +46,12 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def submit
-        @builder.submit(@text, **attributes(@html_attributes))
+        @builder.tag.button(@text, **attributes(@html_attributes))
       end
 
       def options
         {
+          type: 'submit',
           formnovalidate: !@validate,
           disabled: @disabled,
           class: classes,

data/lib/govuk_design_system_formbuilder/elements/text_area.rb

@@ -53,7 +53,7 @@ module GOVUKDesignSystemFormBuilder
           id: field_id(link_errors: true),
           class: classes,
           rows: @rows,
-          aria: { describedby: described_by(hint_id, error_id, supplemental_id, limit_description_id) },
+          aria: { describedby: combine_references(hint_id, error_id, supplemental_id, limit_description_id) },
         }
       end
 

data/lib/govuk_design_system_formbuilder/presenters/error_summary.rb

@@ -0,0 +1,29 @@
+module Presenters
+  # This is the default presenter for {GOVUKDesignSystemFormBuilder::Elements::ErrorSummary} and is
+  # intended to be easily replaceable should you have specific requirements that aren't met here.
+  #
+  # The basic behaviour is to always show the first error message. In Rails, error message order is
+  # determined by the order in which the validations run, but if you need to do any other transformation
+  # or concatenation, this is the place to do it.
+  class ErrorSummaryPresenter
+    # @param [Hash] error_messages the error message hash in a format that matches Rails'
+    #   `object.errors.messages`, so the format should be:
+    #
+    # @example Input format:
+    #   ErrorSummaryPresenter.new({ attribute_one: ["first error", "second error"], attribute_two: ["third error"] })
+    def initialize(error_messages)
+      @error_messages = error_messages
+    end
+
+    # Converts +@error_messages+ into an array of argument arrays that will be
+    # passed into {GOVUKDesignSystemFormBuilder::Elements::ErrorSummary#list_item}.
+    #
+    # @return [Array<Array(Symbol, String)>] array of attribute and message arrays
+    #
+    # @example Output format given the input above:
+    #   [[:attribute_one, "first error"], [:attribute_two, "third error"]]
+    def formatted_error_messages
+      @error_messages.map { |attribute, messages| [attribute, messages.first] }
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/fieldset_item.rb

@@ -4,7 +4,7 @@ module GOVUKDesignSystemFormBuilder
       using PrefixableArray
 
       def html
-        safe_join([item, @conditional])
+        safe_join([item, @conditional_content])
       end
 
     private
@@ -61,9 +61,9 @@ module GOVUKDesignSystemFormBuilder
         build_id('conditional')
       end
 
-      def conditional_content(&block)
-        if (conditional_block_content = block_given? && (capture { block.call }).presence)
-          @conditional    = conditional_container(conditional_block_content)
+      def conditional_content(block_content)
+        if block_content.present?
+          @conditional_content = conditional_container(block_content)
           @conditional_id = conditional_id
         end
       end

data/lib/govuk_design_system_formbuilder/traits/html_attributes.rb

@@ -4,7 +4,7 @@ module GOVUKDesignSystemFormBuilder
       # 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
+      # * joins the arrays into strings to maintain Rails 6.0.* compatibility
       class Attributes
         # Rather than attempt to combine these attributes, just overwrite the
         # form internally-generated values with those that are passed in. This

data/lib/govuk_design_system_formbuilder/traits/input.rb

@@ -48,7 +48,7 @@ module GOVUKDesignSystemFormBuilder
         {
           id: field_id(link_errors: true),
           class: classes,
-          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+          aria: { describedby: combine_references(hint_id, error_id, supplemental_id) }
         }
       end
 

data/lib/govuk_design_system_formbuilder/traits/select.rb

@@ -4,7 +4,7 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def classes
-        [%(#{brand}-select), error_class].flatten.compact
+        combine_references(%(#{brand}-select), error_class)
       end
 
       def error_class

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.6.0'.freeze
+  VERSION = '2.7.3'.freeze
 end

data/lib/govuk_design_system_formbuilder.rb

@@ -1,7 +1,7 @@
 require 'deep_merge/rails_compat'
 require 'active_support/configurable'
 
-[%w(refinements *.rb), %w(traits *.rb), %w(*.rb), %w(elements ** *.rb), %w(containers ** *.rb)]
+[%w(presenters *.rb), %w(refinements *.rb), %w(traits *.rb), %w(*.rb), %w(elements ** *.rb), %w(containers ** *.rb)]
   .flat_map { |matcher| Dir.glob(File.join(__dir__, 'govuk_design_system_formbuilder', *matcher)) }
   .each { |file| require file }
 
@@ -27,20 +27,29 @@ module GOVUKDesignSystemFormBuilder
   # * +:default_submit_button_text+ sets the value assigned to +govuk_submit+,
   #   defaults to 'Continue'.
   #
+  # * +:default_radio_divider_text+ sets the text automatically added to the
+  #   radio button divider, defaults to 'or'
+  #
+  # * +:default_check_box_divider_text+ sets the text automatically added to the
+  #   checkbox divider, defaults to 'or'
+  #
   # * +:default_submit_button_text+ sets the text used to divide the last radio
   #   button in radio button fieldsets. As per the GOV.UK Design System spec,
   #   it defaults to 'or'.
   #
-  # * +:default_error_summary_title+ sets the text used in error summary
-  #   blocks. As per the GOV.UK Design System spec, it defaults to
-  #   'There is a problem'.
-  #
   # * +:default_collection_check_boxes_include_hidden+ controls whether or not
   #   a hidden field is added when rendering a collection of check boxes
   #
   # * +:default_collection_radio_buttons_include_hidden+ controls whether or not
   #   a hidden field is added when rendering a collection of radio buttons
   #
+  # * +:default_error_summary_title+ sets the text used in error summary
+  #   blocks. As per the GOV.UK Design System spec, it defaults to
+  #   'There is a problem'.
+  #
+  # * +:default_error_summary_presenter+ the class that's instantiated when
+  #   rendering an error summary and formats the messages for each attribute
+  #
   # * +:default_error_summary_error_order_method+ is the method that the library
   #   will check for on the bound object to see whether or not to try ordering the
   #   error messages
@@ -65,7 +74,9 @@ module GOVUKDesignSystemFormBuilder
     default_caption_size: 'm',
     default_submit_button_text: 'Continue',
     default_radio_divider_text: 'or',
+    default_check_box_divider_text: 'or',
     default_error_summary_title: 'There is a problem',
+    default_error_summary_presenter: Presenters::ErrorSummaryPresenter,
     default_error_summary_error_order_method: nil,
     default_collection_check_boxes_include_hidden: true,
     default_collection_radio_buttons_include_hidden: true,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.3
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -274,14 +274,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.22.0
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -331,6 +331,7 @@ 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/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