govuk_design_system_formbuilder 2.7.4 → 3.0.0b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e957bab838013fdafade2624efb663ab4f40befc05313a3f676e1db7db50ee5
-  data.tar.gz: f9eaf97153026e3f14c24158013276315a4464a0fd5216b7ce80d36b3c5eda02
+  metadata.gz: dda2170c816461a782998af3761d21a3a1df198f8483804c387dc42faa0f2ca4
+  data.tar.gz: f15f26e8c97bad9302d84ea230ccd172db5c99ba389cfd1cd0a857559cff89d9
 SHA512:
-  metadata.gz: 27a67e5dfa2a13da2abc4769f539b618fe091f0840b51132e5fac32b5f90285dbdddcf4b6516e562b83fc7b3d0036fdd62dd70c0609204e015172aa14e6fb3d4
-  data.tar.gz: b9fb370f1e5e3eaeb08fec860a48f03a4ab3b6c38613a90c7cb3d12e906298d26187b268c3a7befacafe1d36a5ab6452a2eac8b598c6d379e559f7ccb31fb101
+  metadata.gz: 429c7e4280bac9f2c17d77ceaf4c05a6b28b02b4484d6e30ed1a92f8fa1132812bf6ca8496ca55be970cb3580d8d65de0f855d256815387c27a2bec5f0b95099
+  data.tar.gz: b98b0f23eec603db89c4506547da28d5f32cceb584eb26783c5ea774511028981157776f0567b6a3efa4c488c8dd558496f6c0dc6c4a4fdcbd17edfcb5eca20c

data/README.md

@@ -6,9 +6,9 @@
 [![Gem](https://img.shields.io/gem/dt/govuk_design_system_formbuilder?logo=rubygems)](https://rubygems.org/gems/govuk_design_system_formbuilder)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/110136fb22341d3ba646/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk-formbuilder/test_coverage)
 [![GitHub license](https://img.shields.io/github/license/DFE-Digital/govuk_design_system_formbuilder)](https://github.com/DFE-Digital/govuk-formbuilder/blob/master/LICENSE)
-[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.13.1-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/)
+[![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.1.4.4%20%E2%95%B1%207.0.0-E16D6D)](https://weblog.rubyonrails.org/releases/)
+[![Ruby](https://img.shields.io/badge/Ruby-2.7.5%20%20%E2%95%B1%203.0.3-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/).
 
@@ -56,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 🔧
 

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -912,6 +912,7 @@ module GOVUKDesignSystemFormBuilder
     # @option caption size [String] the size of the caption, can be +xl+, +l+ or +m+. Defaults to +m+
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
     # @param omit_day [Boolean] do not render a day input, only capture month and year
+    # @param maxlength_enabled [Boolean] adds maxlength attribute to day, month and year inputs (2, 2, and 4, respectively)
     # @param wildcards [Boolean] add an 'X' to the day and month patterns so users can add approximate dates
     # @param form_group [Hash] configures the form group
     # @option form_group classes [Array,String] sets the form group's classes
@@ -936,8 +937,8 @@ module GOVUKDesignSystemFormBuilder
     # @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, form_group: {}, wildcards: false, **kwargs, &block)
-      Elements::Date.new(self, object_name, attribute_name, hint: hint, legend: legend, caption: caption, date_of_birth: date_of_birth, omit_day: omit_day, form_group: form_group, wildcards: wildcards, **kwargs, &block).html
+    def govuk_date_field(attribute_name, hint: {}, legend: {}, caption: {}, date_of_birth: false, omit_day: false, maxlength_enabled: false, form_group: {}, wildcards: false, **kwargs, &block)
+      Elements::Date.new(self, object_name, attribute_name, hint: hint, legend: legend, caption: caption, date_of_birth: date_of_birth, omit_day: omit_day, maxlength_enabled: maxlength_enabled, form_group: form_group, wildcards: wildcards, **kwargs, &block).html
     end
 
     # Generates a summary of errors in the form, each linking to the corresponding

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -6,21 +6,23 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
       include Traits::Hint
       include Traits::Supplemental
+      include Traits::HTMLClasses
 
       SEGMENTS = { day: '3i', month: '2i', year: '1i' }.freeze
       MULTIPARAMETER_KEY = { day: 3, month: 2, year: 1 }.freeze
 
-      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, omit_day:, form_group:, wildcards:, date_of_birth: false, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, omit_day:, maxlength_enabled:, form_group:, wildcards:, date_of_birth: false, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @legend          = legend
-        @caption         = caption
-        @hint            = hint
-        @date_of_birth   = date_of_birth
-        @omit_day        = omit_day
-        @form_group      = form_group
-        @wildcards       = wildcards
-        @html_attributes = kwargs
+        @legend            = legend
+        @caption           = caption
+        @hint              = hint
+        @date_of_birth     = date_of_birth
+        @omit_day          = omit_day
+        @maxlength_enabled = maxlength_enabled
+        @form_group        = form_group
+        @wildcards         = wildcards
+        @html_attributes   = kwargs
       end
 
       def html
@@ -47,6 +49,10 @@ module GOVUKDesignSystemFormBuilder
         @omit_day
       end
 
+      def maxlength_enabled?
+        @maxlength_enabled
+      end
+
       def day
         return if omit_day?
 
@@ -104,7 +110,8 @@ module GOVUKDesignSystemFormBuilder
           pattern: pattern(segment),
           inputmode: 'numeric',
           value: value,
-          autocomplete: date_of_birth_autocomplete_value(segment)
+          autocomplete: date_of_birth_autocomplete_value(segment),
+          maxlength: (width if maxlength_enabled?),
         )
       end
 
@@ -115,10 +122,12 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def classes(width)
-        %w(input date-input__input).prefix(brand).tap do |classes|
-          classes.push(%(#{brand}-input--width-#{width}))
-          classes.push(%(#{brand}-input--error)) if has_errors?
-        end
+        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
@@ -148,7 +157,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def label_classes
-        %w(label date-input__label).prefix(brand)
+        build_classes(%(label), %(date-input__label)).prefix(brand)
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -8,7 +8,7 @@ module GOVUKDesignSystemFormBuilder
       def html
         return unless has_errors?
 
-        tag.span(class: %(#{brand}-error-message), id: error_id) do
+        tag.p(class: %(#{brand}-error-message), id: error_id) do
           safe_join([hidden_prefix, message])
         end
       end
@@ -20,7 +20,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def message
-        @builder.object.errors.messages[@attribute_name]&.first
+        set_message_safety(@builder.object.errors.messages[@attribute_name]&.first)
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -80,8 +80,10 @@ 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)
+        target = url || same_page_link(field_id(attribute))
+
+        tag.li(link_to(set_message_safety(message), target, **link_options))
       end
 
       def same_page_link(target)
@@ -125,10 +127,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/file.rb

@@ -8,6 +8,7 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Label
       include Traits::Supplemental
       include Traits::HTMLAttributes
+      include Traits::HTMLClasses
 
       def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
@@ -40,9 +41,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def classes
-        %w(file-upload).prefix(brand).tap do |c|
-          c.push(%(#{brand}-file-upload--error)) if has_errors?
-        end
+        build_classes(%(file-upload), %(file-upload--error) => has_errors?).prefix(brand)
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -27,7 +27,7 @@ module GOVUKDesignSystemFormBuilder
       def html
         return unless active?
 
-        content_tag(hint_tag, **hint_options, **@html_attributes) { hint_body }
+        tag.div(**hint_options, **@html_attributes) { hint_body }
       end
 
       def hint_id
@@ -42,10 +42,6 @@ module GOVUKDesignSystemFormBuilder
         { class: classes, id: hint_id }
       end
 
-      def hint_tag
-        @raw.presence ? 'div' : 'span'
-      end
-
       def hint_body
         @raw || @text
       end

data/lib/govuk_design_system_formbuilder/elements/text_area.rb

@@ -8,6 +8,7 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Label
       include Traits::Supplemental
       include Traits::HTMLAttributes
+      include Traits::HTMLClasses
 
       def initialize(builder, object_name, attribute_name, hint:, label:, caption:, rows:, max_words:, max_chars:, threshold:, form_group:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
@@ -42,10 +43,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def classes
-        %w(textarea).prefix(brand).tap do |classes|
-          classes.push(%(#{brand}-textarea--error))    if has_errors?
-          classes.push(%(#{brand}-js-character-count)) if limit?
-        end
+        build_classes(%(textarea), %(textarea--error) => has_errors?, %(js-character-count) => limit?).prefix(brand)
       end
 
       def options
@@ -86,7 +84,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def limit_description_classes
-        %w(hint character-count__message).prefix(brand)
+        build_classes(%(hint), %(character-count__message)).prefix(brand)
       end
 
       def limit_description_id

data/lib/govuk_design_system_formbuilder/presenters/error_summary.rb

@@ -19,9 +19,13 @@ module Presenters
     # 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

data/lib/govuk_design_system_formbuilder/traits/error.rb

@@ -12,6 +12,10 @@ module GOVUKDesignSystemFormBuilder
       def error_element
         @error_element ||= Elements::ErrorMessage.new(*bound)
       end
+
+      def set_message_safety(message)
+        config.trust_error_messages ? message.html_safe : message
+      end
     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

@@ -6,11 +6,17 @@ module GOVUKDesignSystemFormBuilder
       #   present
       # * 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/traits/html_classes.rb

@@ -0,0 +1,36 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module HTMLClasses
+      # combine all the classes in *args with any keys from **kwargs
+      # where the value is true. Roughly based on the behaviour from
+      # Rails' class_names, but recreated here as that returns a string
+      # where we want an array.
+      def build_classes(*args, **kwargs)
+        # FIXME: we need to handle the arguments differently for Ruby 2.6.x because
+        #        Ruby 2.7.0 brought the separation of positional and keyword
+        #        arguments.
+        #
+        #        This can be removed once support for 2.6.x is dropped.
+        #
+        #        https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
+        return ruby_2_6_build_classes_fallback(*args) if RUBY_VERSION < "2.7.0"
+
+        (args + kwargs.map { |k, v| k if v }).compact
+      end
+
+    private
+
+      def ruby_2_6_build_classes_fallback(*args)
+        [].tap do |classes|
+          args.each do |arg|
+            if arg.is_a?(Hash)
+              arg.each { |k, v| classes.append(k) if v }
+            else
+              classes.append(arg)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.7.4'.freeze
+  VERSION = '3.0.0b1'.freeze
 end

data/lib/govuk_design_system_formbuilder.rb

@@ -54,6 +54,12 @@ module GOVUKDesignSystemFormBuilder
   #   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__+,
@@ -65,6 +71,10 @@ module GOVUKDesignSystemFormBuilder
   #
   # * +:enable_logger+ controls whether or not the library will emit log
   #   messages via Rails.logger.warn, defaults to +true+
+  #
+  # * +:trust_error_messages+ call html_safe on error messages before they're
+  #   rendered. This allows formatting markup to be used to change the display
+  #   of the error message. Defaults to +false+
   # ===
   DEFAULTS = {
     brand: 'govuk',
@@ -78,6 +88,7 @@ module GOVUKDesignSystemFormBuilder
     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,
@@ -88,7 +99,8 @@ module GOVUKDesignSystemFormBuilder
     localisation_schema_legend: nil,
     localisation_schema_caption: nil,
 
-    enable_logger: true
+    enable_logger: true,
+    trust_error_messages: false,
   }.freeze
 
   DEFAULTS.each_key { |k| config_accessor(k) { DEFAULTS[k] } }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.7.4
+  version: 3.0.0b1
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-12-21 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.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -162,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: nanoc
   requirement: !ruby/object:Gem::Requirement
@@ -340,6 +340,7 @@ files:
 - lib/govuk_design_system_formbuilder/traits/fieldset_item.rb
 - lib/govuk_design_system_formbuilder/traits/hint.rb
 - lib/govuk_design_system_formbuilder/traits/html_attributes.rb
+- lib/govuk_design_system_formbuilder/traits/html_classes.rb
 - lib/govuk_design_system_formbuilder/traits/input.rb
 - lib/govuk_design_system_formbuilder/traits/label.rb
 - lib/govuk_design_system_formbuilder/traits/localisation.rb
@@ -350,12 +351,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
-  github_repo: git@github.com:DFE-Digital/govuk_design_system_formbuilder.git
+  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:
@@ -367,9 +368,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key: