govuk_design_system_formbuilder 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f2848edaf133e49c126c228e0b552edd9399000cfb2a9612bc740830d642d4b
-  data.tar.gz: f718bf6f976aed2ad04a2d689f4ac33f4dc491984afe8beeba4be259e9c2c57c
+  metadata.gz: 0c0051ba0d0eb5f3afcf87055e171bb1d0e930c9c063297a35e231537428ad84
+  data.tar.gz: 28dbcd6291008fe3010aebd3dd79276f452ca030b7f6fc1208646f33510de99d
 SHA512:
-  metadata.gz: ab016ebaa81ab6bf2fcd1fe536e880c1f3b919bfaf78849b335ba93a619efd4e7556170a7b840b6cfe27342262b1bbebee888e0b5539a937746c23b28b52766d
-  data.tar.gz: aed2b87567e77185bb01cc40f810381369dbc74701ce295355135c887d296f88c7091b1008c5d75845a5adc6ab84a288f6e3e1fb2f4fec22efe4c0acd4dbebd8
+  metadata.gz: c1278d6f46dadbd4574a5551f7b4f758aa907e486d95ed1aca627e9ec4a785c7770edb5bb09bc0a941ec1ea8433888be6e2cc00e33e14ffb589f11a94e65b66c
+  data.tar.gz: e19a3b4357bcf82918a1f4354f927bbc265e2ec86759844fa7cc56fae4231e4a4f1c0c5106f0c5d1b59146bd2e4e716257de16c1a443ecf2df8dc4ee3f158f44

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/x-govuk/govuk-form-builder/test_coverage)
 [![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.0.0-brightgreen)](https://design-system.service.gov.uk)
-[![Rails](https://img.shields.io/badge/Rails-6.1.7%20%E2%95%B1%207.0.6-E16D6D)](https://weblog.rubyonrails.org/releases/)
-[![Ruby](https://img.shields.io/badge/Ruby-3.0.6%20%20%E2%95%B1%203.1.4%20%20%E2%95%B1%203.2.2-E16D6D)](https://www.ruby-lang.org/en/downloads/)
+[![GOV.UK Design System version](https://img.shields.io/badge/GOV.UK%20Design%20System-5.1.0-brightgreen)](https://design-system.service.gov.uk)
+[![Rails](https://img.shields.io/badge/Rails-6.1.7%20%E2%95%B1%207.1.3-E16D6D)](https://weblog.rubyonrails.org/releases/)
+[![Ruby](https://img.shields.io/badge/Ruby-3.1.4%20%20%E2%95%B1%203.2.3%20%20%E2%95%B1%203.3.0-E16D6D)](https://www.ruby-lang.org/en/downloads/)
 
 This library provides an easy-to-use form builder for the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
@@ -120,7 +120,7 @@ here are a few from the <abbr title="Department for Education">DfE</abbr>, <abbr
 
 * [Apply for teacher training](https://www.github.com/x-govuk/apply-for-teacher-training)
 * [Teaching Vacancies](https://www.github.com/x-govuk/teaching-vacancies)
-* [Get a teacher training adviser](https://www.github.com/x-govuk/get-teacher-training-adviser-service/)
+* [Manage children's vaccinations](https://github.com/nhsuk/manage-childrens-vaccinations)
 * [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)

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -53,7 +53,7 @@ module GOVUKDesignSystemFormBuilder
     #     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: hint, label: label, caption: caption, width: width, extra_letter_spacing: extra_letter_spacing, form_group: form_group, prefix_text: prefix_text, suffix_text: suffix_text, **kwargs, &block).html
+      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
     end
 
     # Generates a input of type +tel+
@@ -107,7 +107,7 @@ module GOVUKDesignSystemFormBuilder
     #     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: hint, label: label, caption: caption, width: width, extra_letter_spacing: extra_letter_spacing, form_group: form_group, prefix_text: prefix_text, suffix_text: suffix_text, **kwargs, &block).html
+      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
     end
 
     # Generates a input of type +email+
@@ -159,7 +159,7 @@ module GOVUKDesignSystemFormBuilder
     #     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: hint, label: label, caption: caption, width: width, extra_letter_spacing: extra_letter_spacing, form_group: form_group, prefix_text: prefix_text, suffix_text: suffix_text, **kwargs, &block).html
+      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
     end
 
     # Generates a input of type +password+
@@ -210,7 +210,7 @@ module GOVUKDesignSystemFormBuilder
     #     label: -> { tag.h3('What is your secret pass code?') }
     #
     def govuk_password_field(attribute_name, hint: {}, label: {}, width: nil, extra_letter_spacing: false, form_group: {}, caption: {}, prefix_text: nil, suffix_text: nil, **kwargs, &block)
-      Elements::Inputs::Password.new(self, object_name, attribute_name, hint: hint, label: label, caption: caption, width: width, extra_letter_spacing: extra_letter_spacing, form_group: form_group, prefix_text: prefix_text, suffix_text: suffix_text, **kwargs, &block).html
+      Elements::Inputs::Password.new(self, object_name, attribute_name, hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:, suffix_text:, **kwargs, &block).html
     end
 
     # Generates a input of type +url+
@@ -262,7 +262,7 @@ module GOVUKDesignSystemFormBuilder
     #     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: hint, label: label, caption: caption, width: width, extra_letter_spacing: extra_letter_spacing, form_group: form_group, prefix_text: prefix_text, suffix_text: suffix_text, **kwargs, &block).html
+      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
     end
 
     # Generates a input of type +number+
@@ -317,7 +317,7 @@ module GOVUKDesignSystemFormBuilder
     #     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: hint, label: label, caption: caption, width: width, extra_letter_spacing: extra_letter_spacing, form_group: form_group, prefix_text: prefix_text, suffix_text: suffix_text, **kwargs, &block).html
+      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
     end
 
     # Generates a +textarea+ element with a label, optional hint. Also offers
@@ -373,7 +373,7 @@ module GOVUKDesignSystemFormBuilder
     #     label: -> { tag.h3("How do you set it up?") }
     #
     def govuk_text_area(attribute_name, hint: {}, label: {}, caption: {}, max_words: nil, max_chars: nil, rows: 5, threshold: nil, form_group: {}, **kwargs, &block)
-      Elements::TextArea.new(self, object_name, attribute_name, hint: hint, label: label, caption: caption, max_words: max_words, max_chars: max_chars, rows: rows, threshold: threshold, form_group: form_group, **kwargs, &block).html
+      Elements::TextArea.new(self, object_name, attribute_name, hint:, label:, caption:, max_words:, max_chars:, rows:, threshold:, form_group:, **kwargs, &block).html
     end
 
     # Generates a +select+ element containing +option+ for each member in the provided collection
@@ -422,13 +422,13 @@ module GOVUKDesignSystemFormBuilder
         object_name,
         attribute_name,
         collection,
-        value_method: value_method,
-        text_method: text_method,
-        hint: hint,
-        label: label,
-        caption: caption,
-        options: options,
-        form_group: form_group,
+        value_method:,
+        text_method:,
+        hint:,
+        label:,
+        caption:,
+        options:,
+        form_group:,
         **kwargs,
         &block
       ).html
@@ -466,7 +466,7 @@ 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: options, label: label, hint: hint, form_group: form_group, caption: caption, **kwargs, &block).html
+      Elements::Select.new(self, object_name, attribute_name, choices, options:, label:, hint:, form_group:, caption:, **kwargs, &block).html
     end
 
     # Generates a radio button for each item in the supplied collection
@@ -546,17 +546,17 @@ module GOVUKDesignSystemFormBuilder
         object_name,
         attribute_name,
         collection,
-        value_method: value_method,
-        text_method: text_method,
-        hint_method: hint_method,
-        hint: hint,
-        legend: legend,
-        caption: caption,
-        inline: inline,
-        small: small,
-        bold_labels: bold_labels,
-        form_group: form_group,
-        include_hidden: include_hidden,
+        value_method:,
+        text_method:,
+        hint_method:,
+        hint:,
+        legend:,
+        caption:,
+        inline:,
+        small:,
+        bold_labels:,
+        form_group:,
+        include_hidden:,
         **kwargs,
         &block
       ).html
@@ -611,7 +611,7 @@ module GOVUKDesignSystemFormBuilder
     #      = f.govuk_radio_button :burger_id, :cheese, label: { text: 'Cheeseburger' }
     #
     def govuk_radio_buttons_fieldset(attribute_name, hint: {}, legend: {}, caption: {}, inline: false, small: false, form_group: {}, **kwargs, &block)
-      Containers::RadioButtonsFieldset.new(self, object_name, attribute_name, hint: hint, legend: legend, caption: caption, inline: inline, small: small, form_group: form_group, **kwargs, &block).html
+      Containers::RadioButtonsFieldset.new(self, object_name, attribute_name, hint:, legend:, caption:, inline:, small:, form_group:, **kwargs, &block).html
     end
 
     # Generates a radio button
@@ -643,7 +643,7 @@ module GOVUKDesignSystemFormBuilder
     #    = f.govuk_radio_button :favourite_colour, :red, label: { text: 'Red' }
     #
     def govuk_radio_button(attribute_name, value, hint: {}, label: {}, link_errors: false, **kwargs, &block)
-      Elements::Radios::FieldsetRadioButton.new(self, object_name, attribute_name, value, hint: hint, label: label, link_errors: link_errors, **kwargs, &block).html
+      Elements::Radios::FieldsetRadioButton.new(self, object_name, attribute_name, value, hint:, label:, link_errors:, **kwargs, &block).html
     end
 
     # Inserts a text divider into a list of radio buttons
@@ -725,15 +725,15 @@ module GOVUKDesignSystemFormBuilder
         object_name,
         attribute_name,
         collection,
-        value_method: value_method,
-        text_method: text_method,
-        hint_method: hint_method,
-        hint: hint,
-        legend: legend,
-        caption: caption,
-        small: small,
-        form_group: form_group,
-        include_hidden: include_hidden,
+        value_method:,
+        text_method:,
+        hint_method:,
+        hint:,
+        legend:,
+        caption:,
+        small:,
+        form_group:,
+        include_hidden:,
         **kwargs,
         &block
       ).html
@@ -782,12 +782,12 @@ module GOVUKDesignSystemFormBuilder
         self,
         object_name,
         attribute_name,
-        hint: hint,
-        legend: legend,
-        caption: caption,
-        small: small,
-        form_group: form_group,
-        multiple: multiple,
+        hint:,
+        legend:,
+        caption:,
+        small:,
+        form_group:,
+        multiple:,
         **kwargs,
         &block
       ).html
@@ -830,11 +830,11 @@ module GOVUKDesignSystemFormBuilder
         attribute_name,
         value,
         unchecked_value,
-        hint: hint,
-        label: label,
-        link_errors: link_errors,
-        multiple: multiple,
-        exclusive: exclusive,
+        hint:,
+        label:,
+        link_errors:,
+        multiple:,
+        exclusive:,
         **kwargs,
         &block
       ).html
@@ -883,7 +883,7 @@ module GOVUKDesignSystemFormBuilder
     #     = link_to 'Cancel', some_other_path, class: 'govuk-button__secondary'
     #
     def govuk_submit(text = config.default_submit_button_text, warning: false, secondary: false, inverse: false, prevent_double_click: true, validate: config.default_submit_validate, disabled: false, **kwargs, &block)
-      Elements::Submit.new(self, text, warning: warning, secondary: secondary, inverse: inverse, prevent_double_click: prevent_double_click, validate: validate, disabled: disabled, **kwargs, &block).html
+      Elements::Submit.new(self, text, warning:, secondary:, inverse:, prevent_double_click:, validate:, disabled:, **kwargs, &block).html
     end
 
     # Generates three inputs for the +day+, +month+ and +year+ components of a date
@@ -932,7 +932,7 @@ module GOVUKDesignSystemFormBuilder
     #  = 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, form_group: {}, **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, **kwargs, &block).html
+      Elements::Date.new(self, object_name, attribute_name, hint:, legend:, caption:, date_of_birth:, omit_day:, maxlength_enabled:, form_group:, **kwargs, &block).html
     end
 
     # Generates a summary of errors in the form, each linking to the corresponding
@@ -962,7 +962,7 @@ module GOVUKDesignSystemFormBuilder
     #
     # @see https://design-system.service.gov.uk/components/error-summary/ GOV.UK error summary
     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
+      Elements::ErrorSummary.new(self, object_name, title, link_base_errors_to:, order:, presenter:, **kwargs, &block).html
     end
 
     # Generates a fieldset containing the contents of the block
@@ -995,7 +995,7 @@ module GOVUKDesignSystemFormBuilder
     # @see https://design-system.service.gov.uk/styles/typography/#headings-with-captions Headings with captions
     # @return [ActiveSupport::SafeBuffer] HTML output
     def govuk_fieldset(legend: { text: 'Fieldset heading' }, caption: {}, described_by: nil, **kwargs, &block)
-      Containers::Fieldset.new(self, legend: legend, caption: caption, described_by: described_by, **kwargs, &block).html
+      Containers::Fieldset.new(self, legend:, caption:, described_by:, **kwargs, &block).html
     end
 
     # Generates an input of type +file+
@@ -1036,7 +1036,7 @@ module GOVUKDesignSystemFormBuilder
     #   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: {}, **kwargs, &block)
-      Elements::File.new(self, object_name, attribute_name, label: label, caption: caption, hint: hint, form_group: form_group, **kwargs, &block).html
+      Elements::File.new(self, object_name, attribute_name, label:, caption:, hint:, form_group:, **kwargs, &block).html
     end
   end
 end

data/lib/govuk_design_system_formbuilder/builder_helper.rb

@@ -26,7 +26,7 @@ module GOVUKDesignSystemFormBuilder
     def govuk_field_id(object, attribute_name, object_name = nil, value: nil, link_errors: true)
       (object_name = retrieve_object_name(object)) if object_name.nil?
 
-      proxy_base(object, object_name, attribute_name, value: value).field_id(link_errors: link_errors)
+      proxy_base(object, object_name, attribute_name, value:).field_id(link_errors:)
     end
 
     # Renders an error summary
@@ -51,7 +51,7 @@ module GOVUKDesignSystemFormBuilder
   private
 
     def proxy_base(object, object_name, attribute_name, value: nil)
-      GOVUKDesignSystemFormBuilder::Proxy.new(object, object_name, attribute_name, value: value)
+      GOVUKDesignSystemFormBuilder::Proxy.new(object, object_name, attribute_name, value:)
     end
 
     def proxy_builder(object, object_name, template, options)

data/lib/govuk_design_system_formbuilder/containers/supplemental.rb

@@ -10,6 +10,8 @@ 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
 

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

@@ -64,7 +64,7 @@ module GOVUKDesignSystemFormBuilder
               @attribute_name,
               check_box,
               @hint_method,
-              link_errors: link_errors
+              link_errors:
             ).html.tap { link_errors = false }
           end
         end

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -114,7 +114,7 @@ module GOVUKDesignSystemFormBuilder
           name: name(segment),
           type: 'text',
           inputmode: 'numeric',
-          value: value,
+          value:,
           autocomplete: date_of_birth_autocomplete_value(segment),
           maxlength: (width if maxlength_enabled?),
         )
@@ -134,7 +134,7 @@ module GOVUKDesignSystemFormBuilder
       # in the normal fashion
       def id(segment, link_errors)
         if has_errors? && link_errors
-          field_id(link_errors: link_errors)
+          field_id(link_errors:)
         else
           [@object_name, @attribute_name, SEGMENTS.fetch(segment)].join("_")
         end

data/lib/govuk_design_system_formbuilder/traits/localisation.rb

@@ -3,7 +3,7 @@ module GOVUKDesignSystemFormBuilder
     module Localisation
       # starts with an letter that is followed by other word characters or
       # spaces, zero or more times
-      BASE_NAME_REGEXP = %r{[[:alpha:]](?:[\w\s]*)}.freeze
+      BASE_NAME_REGEXP = %r{[[:alpha:]](?:[\w\s]*)}
 
     private
 

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '5.0.0'.freeze
+  VERSION = '5.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-attributes-utils
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.12.0
+        version: 4.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.12.0
+        version: 4.14.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -260,14 +260,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.26.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.26.0
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -282,6 +282,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
 description: This library provides view components for the GOV.UK Design System. It
   makes creating services more familiar for Ruby on Rails developers.
 email: