govuk_design_system_formbuilder 2.7.2 → 2.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06a3aa374a6a6fa23d1fb52cdb7585fe50e067580328683b5dcbbcd8c6444aab
-  data.tar.gz: 15c814a5314cbf8aa97fd9e8d47c640062286d6a2239be89265015f6eafab172
+  metadata.gz: 16dd3a6e9641b3d0aa7e91ee6318bcd0f993d10c00105e1c977f54120eb966d9
+  data.tar.gz: 5aa914a964cac5770d3e1c002aa9e38a20b4bf21c612a9c78c5edfa503c8e98f
 SHA512:
-  metadata.gz: c4319d5fbd9168b1869aa94a1206f57c50f4e2d1a238a06da0bbcae0a55b82a020895ca1cfc59de86fdb9ee0248cbd283a3f5b22142946b9951a96906e870c9e
-  data.tar.gz: eec0ec045b248bd16cf671b4d289ea91429338693c541c74c30d92d481b2f2a833c490b064ed58bce7e95a49af03725faa6cb58b0222f0a5411153d1673d4a89
+  metadata.gz: 870971ada7f130cd54a13cff52f852d07e1581dd8ebf04f802ae93ca2103325fa2e283e9812170c282da4c5b1a056490799828f0f8d374a7b8d92a053bc6114e
+  data.tar.gz: 7e931f7fe3966909bdd2c4ff16ee3fe7d06e0c52925c03d36fb300a99d7105a842ee6f5aeac165b3824495efd7b3d189ac925378c4a10b7e57c37f8d4230eeb2

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.13.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.4%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.14.0-brightgreen)](https://design-system.service.gov.uk)
+[![Rails](https://img.shields.io/badge/Rails-6.0.4.1%20%E2%95%B1%206.1.4.1-E16D6D)](https://weblog.rubyonrails.org/releases/)
+[![Ruby](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/)
 
 This library provides an easy-to-use form builder for the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
@@ -57,7 +56,7 @@ To get up and running quickly and easily try kickstarting your project with a
 pre-configured template:
 
 * [DfE Boilerplate](https://github.com/DFE-Digital/govuk-rails-boilerplate)
-* [MoJ Rails Template](https://github.com/ministryofjustice/moj_rails_template)
+* [DEFRA Ruby Template](https://github.com/DEFRA/defra-ruby-template)
 
 ## Setup 🔧
 
@@ -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/builder.rb

@@ -471,9 +471,9 @@ module GOVUKDesignSystemFormBuilder
     # @note Unlike the Rails +#collection_radio_buttons+ helper, this version can also insert
     #   hints per item in the collection by supplying a +:hint_method+
     #
-    # @note +:bold_labels+, while false by default, is set to true when a
-    #   +:hint_method+ is provided. This is done to make the label stand out more
-    #   from the hint.
+    # @note +:bold_labels+, is +nil+ (falsy) by default. When a +:hint_method+
+    #       is provided it will become +true+ to make the label stand out more
+    #       from the hint. The choice can be overridden with +true+ or +false+.
     #
     # @param attribute_name [Symbol] The name of the attribute
     # @param collection [Enumerable<Object>] Options to be added to the +select+ element
@@ -538,7 +538,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: false, 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, classes: nil, include_hidden: config.default_collection_radio_buttons_include_hidden, form_group: {}, &block)
       Elements::Radios::Collection.new(
         self,
         object_name,
@@ -951,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.
@@ -959,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/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/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
 
@@ -69,8 +80,8 @@ module GOVUKDesignSystemFormBuilder
         config.default_error_summary_error_order_method
       end
 
-      def list_item(attribute, message)
-        tag.li(link_to(message, same_page_link(field_id(attribute)), data: { turbolinks: false }))
+      def list_item(attribute, message, url = nil)
+        tag.li(link_to(message, url || same_page_link(field_id(attribute)), **link_options))
       end
 
       def same_page_link(target)
@@ -114,10 +125,16 @@ module GOVUKDesignSystemFormBuilder
             module: %(#{brand}-error-summary)
           },
           aria: {
-            labelledby: summary_title_id
+            labelledby: [summary_title_id.presence]
           }
         }
       end
+
+      def link_options(turbo_prefix: config.default_error_summary_turbo_prefix)
+        return {} unless turbo_prefix
+
+        { data: { turbo_prefix => false } }
+      end
     end
   end
 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/collection.rb

@@ -21,7 +21,11 @@ module GOVUKDesignSystemFormBuilder
           @classes        = classes
           @form_group     = form_group
           @include_hidden = include_hidden
-          @bold_labels    = hint_method.present? || bold_labels
+          @bold_labels    = if bold_labels.nil?
+                              hint_method.present?
+                            else
+                              bold_labels
+                            end
         end
 
         def html

data/lib/govuk_design_system_formbuilder/presenters/error_summary.rb

@@ -0,0 +1,33 @@
+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
+    # @return [Array<Array(Symbol, String, String)>] array of attribute, message and URL arrays.
+    #
+    # @example Output format given the input above:
+    #   [[:attribute_one, "first error"], [:attribute_two, "third error"]]
+    #
+    # @example Output with hard-coded URLs
+    #   [[:attribute_one, "first error", "https://example.com/attribute-one"], [:attribute_two, "third error", "https://example.com/attribute-two"]]
+    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

@@ -24,7 +24,7 @@ module GOVUKDesignSystemFormBuilder
           id: field_id(link_errors: @link_errors),
           class: classes,
           multiple: @multiple,
-          aria: { describedby: [hint_id] },
+          aria: { describedby: [hint_id.presence] },
           data: { 'aria-controls' => @conditional_id }
         }
       end

data/lib/govuk_design_system_formbuilder/traits/html_attributes.rb

@@ -4,13 +4,19 @@ 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
-        # prevents the merge/unique value logic from affecting the content
-        # (i.e. by remvoving duplicated words).
-        UNMERGEABLE = [%i(id), %i(value), %i(title), %i(alt), %i(href), %i(aria label)].freeze
+        # Only try to combine and merge these attributes that contain a list of
+        # values separated by a space. All other values should be merged in a
+        # regular fashion (where the custom value overrides the default)
+        MERGEABLE = [
+          %i(class),
+          %i(aria controls),
+          %i(aria describedby),
+          %i(aria flowto),
+          %i(aria labelledby),
+          %i(aria owns),
+        ].freeze
 
         def initialize(defaults, custom)
           @merged = defaults.deeper_merge(deep_split_values(custom))
@@ -36,7 +42,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def split_mergeable(key, value, parent = nil)
-          return value if [parent, key].compact.in?(UNMERGEABLE)
+          return value.presence unless [parent, key].compact.in?(MERGEABLE)
 
           value.split
         end

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.7.2'.freeze
+  VERSION = '2.7.6'.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 }
 
@@ -37,20 +37,29 @@ module GOVUKDesignSystemFormBuilder
   #   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
   #
+  # * +:default_error_summary_turbo_prefix+ is used to disable turbo/turbolinks from
+  #   handling clicks on links in the error summary. When it's a string (eg,
+  #   turbo), that will result in links with the attribute 'data-turbo=false'.
+  #   When nil, no data attribute will be added. Defaults to 'turbolinks' for
+  #   compatibilitiy's sake; this will change to 'turbo' when Rails 7 is released
+  #
   # * +:localisation_schema_fallback+ sets the prefix elements for the array
   #   used to build the localisation string. The final two elements are always
   #   are the object name and attribute name. The _special_ value +__context__+,
@@ -73,7 +82,9 @@ module GOVUKDesignSystemFormBuilder
     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_error_summary_turbo_prefix: 'turbolinks',
     default_collection_check_boxes_include_hidden: true,
     default_collection_radio_buttons_include_hidden: true,
     default_submit_validate: false,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.7.6
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -72,14 +72,14 @@ dependencies:
     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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -349,11 +350,12 @@ homepage: https://govuk-form-builder.netlify.app
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/DFE-Digital/govuk_design_system_formbuilder/issues
-  changelog_uri: https://github.com/DFE-Digital/govuk_design_system_formbuilder/releases
+  bug_tracker_uri: https://github.com/DFE-Digital/govuk-formbuilder/issues
+  changelog_uri: https://github.com/DFE-Digital/govuk-formbuilder/releases
   documentation_uri: https://www.rubydoc.info/gems/govuk_design_system_formbuilder/GOVUKDesignSystemFormBuilder/Builder
   homepage_uri: https://govuk-form-builder.netlify.app
-  source_code_uri: https://github.com/DFE-Digital/govuk_design_system_formbuilder
+  source_code_uri: https://github.com/DFE-Digital/govuk-formbuilder
+  github_repo: https://github.com/DFE-Digital/govuk-formbuilder
 post_install_message: 
 rdoc_options: []
 require_paths: