govuk_design_system_formbuilder 1.1.10 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20300d83e65da38b6ae0b3a20a6e4e1bbdd9d04a9911ecf29829417abe5ba6f
-  data.tar.gz: a62f856b0804bc22eacfabcf7c31166651cee64d2dee82d8454b92a693a4b553
+  metadata.gz: d9fcd048d44600ed48957b2c4d18d67a9d705878f897bc8206576f3a7ffebe37
+  data.tar.gz: 2958f99bb9a5d74432da272a4a7bae6563ec5c898626fcfe276e9385b0e860dc
 SHA512:
-  metadata.gz: 586414dba6e14f1f4d8f16638b6634c1aedbadf600e4fbaf2ea67fd7bcae93cca3046a247187d08df5a609ceec318526f0effa4183fe8f903288f76926535e0a
-  data.tar.gz: 323c190132caefde2e449f6b8f9088fdd13a58a520c166a17c43b35d53bc13c613c770b4fea82efc470ad5c90fdcf0e976226bc61811430ff1e301f5d8e1a66c
+  metadata.gz: 42f2696075a68ee286b0e8f45980247aabbbb5da7c64e57f90ef06858efce3ee2d80c551753aaa50c454567bdb1abbe1947a1c864639a7e5453f67c0799dd3f5
+  data.tar.gz: 7354580f9774a3b35e163c64e2531da89be06a1e1a8f6b535fcb38e215350953c20b5339ff9bf9cd6e8ac40dd25a2d505eacd51c0fc47d2baa5c384445c51ef3

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -24,6 +24,14 @@ module GOVUKDesignSystemFormBuilder
     #     hint_text: 'It says it on your birth certificate',
     #     required: true,
     #     placeholder: 'Ralph Wiggum'
+    #
+    # @example A text field with injected content
+    #   = f.govuk_text_field :pseudonym,
+    #     label: { text: 'Pseudonym' } do
+    #
+    #     p.govuk-inset-text
+    #       | Ensure your stage name is unique
+    #
     def govuk_text_field(attribute_name, hint_text: nil, label: {}, width: nil, **args, &block)
       Elements::Inputs::Text.new(self, object_name, attribute_name, hint_text: hint_text, label: label, width: width, **args, &block).html
     end
@@ -51,6 +59,14 @@ module GOVUKDesignSystemFormBuilder
     #     hint_text: 'Include the dialling code',
     #     required: true,
     #     placeholder: '0123 456 789'
+    #
+    # @example A phone field with injected content
+    #   = f.govuk_phone_field :fax_number,
+    #     label: { text: 'Fax number' } do
+    #
+    #     p.govuk-inset-text
+    #       | Yes, fax machines are still a thing
+    #
     def govuk_phone_field(attribute_name, hint_text: nil, label: {}, width: nil, **args, &block)
       Elements::Inputs::Phone.new(self, object_name, attribute_name, hint_text: hint_text, label: label, width: width, **args, &block).html
     end
@@ -76,6 +92,14 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_email_field :email_address,
     #     label: { text: 'Enter your email address' },
     #     placeholder: 'ralph.wiggum@springfield.edu'
+    #
+    # @example A email field with injected content
+    #   = f.govuk_phone_field :email_address,
+    #     label: { text: 'Email address' } do
+    #
+    #     p.govuk-inset-text
+    #       | Use your work address
+    #
     def govuk_email_field(attribute_name, hint_text: nil, label: {}, width: nil, **args, &block)
       Elements::Inputs::Email.new(self, object_name, attribute_name, hint_text: hint_text, label: label, width: width, **args, &block).html
     end
@@ -100,6 +124,14 @@ module GOVUKDesignSystemFormBuilder
     # @example A password field
     #   = f.govuk_password_field :password,
     #     label: { text: 'Enter your password' }
+    #
+    # @example A password field with injected content
+    #   = f.govuk_password_field :password,
+    #     label: { text: 'Password' } do
+    #
+    #     p.govuk-inset-text
+    #       | Ensure your password is at least 16 characters long
+    #
     def govuk_password_field(attribute_name, hint_text: nil, label: {}, width: nil, **args, &block)
       Elements::Inputs::Password.new(self, object_name, attribute_name, hint_text: hint_text, label: label, width: width, **args, &block).html
     end
@@ -125,6 +157,14 @@ module GOVUKDesignSystemFormBuilder
     #     label: { text: 'Enter your favourite website' },
     #     placeholder: 'https://www.gov.uk',
     #     autocomplete: 'url'
+    #
+    # @example A url field with injected content
+    #   = f.govuk_url_field :personal_website,
+    #     label: { text: 'Enter your website' } do
+    #
+    #       p.govuk-inset-text
+    #         | This will be visible on your profile
+    #
     def govuk_url_field(attribute_name, hint_text: nil, label: {}, width: nil, **args, &block)
       Elements::Inputs::URL.new(self, object_name, attribute_name, hint_text: hint_text, label: label, width: width, **args, &block).html
     end
@@ -152,6 +192,15 @@ module GOVUKDesignSystemFormBuilder
     #     min: 80,
     #     max: 150,
     #     step: 5
+    #
+    # @example A number field with injected content
+    #   = f.govuk_number_field :height_in_cm,
+    #     label: { text: 'Height in centimetres' } do
+    #
+    #       p.govuk-inset-text
+    #         | If you haven't measured your height in the last 6 months
+    #           do it now
+    #
     def govuk_number_field(attribute_name, hint_text: nil, label: {}, width: nil, **args, &block)
       Elements::Inputs::Number.new(self, object_name, attribute_name, hint_text: hint_text, label: label, width: width, **args, &block).html
     end
@@ -183,6 +232,14 @@ module GOVUKDesignSystemFormBuilder
     #     label: { text: 'Tell us about your work history' },
     #     rows: 8,
     #     max_words: 300
+    #
+    # @example A text area with injected content
+    #   = f.govuk_number_field :description,
+    #     label: { text: 'Where did the incident take place?' } do
+    #
+    #     p.govuk-inset-text
+    #       | If you don't know exactly leave this section blank
+    #
     def govuk_text_area(attribute_name, hint_text: nil, label: {}, max_words: nil, max_chars: nil, rows: 5, threshold: nil, **args, &block)
       Elements::TextArea.new(self, object_name, attribute_name, hint_text: hint_text, label: label, max_words: max_words, max_chars: max_chars, rows: rows, threshold: threshold, **args, &block).html
     end
@@ -200,6 +257,22 @@ module GOVUKDesignSystemFormBuilder
     # @option label hidden [Boolean] control the visability of the label. Hidden labels will stil be read by screenreaders
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
     # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @example A select box with hint
+    #   = f.govuk_number_field :grade,
+    #     @grades,
+    #     :id,
+    #     :name,
+    #     hint_text: "If you took the test more than once enter your highest grade"
+    #
+    # @example A select box with injected content
+    #   = f.govuk_number_field :favourite_colour,
+    #     @colours,
+    #     :id,
+    #     :name do
+    #
+    #       p.govuk-inset-text
+    #         | Select the closest match
     def govuk_collection_select(attribute_name, collection, value_method, text_method, options: {}, html_options: {}, hint_text: nil, label: {}, &block)
       Elements::Select.new(
         self,
@@ -229,10 +302,12 @@ module GOVUKDesignSystemFormBuilder
     # @param collection [Enumerable<Object>] Options to be added to the +select+ element
     # @param value_method [Symbol, Proc] The method called against each member of the collection to provide the value.
     #   When a +Proc+ is provided it must take a single argument that is a single member of the collection
-    # @param text_method [Symbol, Proc] The method called against each member of the collection to provide the label text.
-    #   When a +Proc+ is provided it must take a single argument that is a single member of the collection
-    # @param hint_method [Symbol, Proc] The method called against each member of the collection to provide the hint text.
-    #   When a +Proc+ is provided it must take a single argument that is a single member of the collection
+    # @param text_method [Symbol, Proc, nil] The method called against each member of the collection to provide the label text.
+    #   When a +Proc+ is provided it must take a single argument that is a single member of the collection.
+    #   When a +nil+ value is provided the label text will be retrieved from the locale.
+    # @param hint_method [Symbol, Proc, nil] The method called against each member of the collection to provide the hint text.
+    #   When a +Proc+ is provided it must take a single argument that is a single member of the collection.
+    #   When a +nil+ value is provided the hint text will be retrieved from the locale. This is the default and param can be omitted.
     # @param hint_text [String] The content of the fieldset hint. No hint will be injected if left +nil+
     # @param legend [Hash] options for configuring the legend
     # @param inline [Boolean] controls whether the radio buttons are displayed inline or not
@@ -241,7 +316,8 @@ module GOVUKDesignSystemFormBuilder
     # @param classes [String] Classes to add to the radio button container.
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
-    # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+, defaults to +h1+
+    # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+
+    # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @return [ActiveSupport::SafeBuffer] HTML output
     #
     # @example A collection of radio buttons for favourite colours, labels capitalised via a proc
@@ -259,6 +335,15 @@ module GOVUKDesignSystemFormBuilder
     #    legend: { text: 'Pick your favourite colour', size: 'm' },
     #    hint_text: 'If you cannot find the exact match choose something close',
     #    inline: false
+    #
+    # @example A collection of radio buttons for grades with injected content
+    #  = f.govuk_collection_radio_buttons :favourite_colour,
+    #    @grades,
+    #    :id,
+    #    :name do
+    #
+    #      p.govuk-inset-text
+    #        | If you took the test more than once enter your highest grade
     def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method, hint_method = nil, hint_text: nil, legend: {}, inline: false, small: false, bold_labels: false, classes: nil, &block)
       Elements::Radios::Collection.new(
         self,
@@ -290,6 +375,7 @@ module GOVUKDesignSystemFormBuilder
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+
+    # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @param block [Block] a block of HTML that will be used to populate the fieldset
     # @param classes [String] Classes to add to the radio button container.
     # @see https://design-system.service.gov.uk/components/radios/ GOV.UK Radios
@@ -315,6 +401,7 @@ module GOVUKDesignSystemFormBuilder
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+
+    # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @see https://design-system.service.gov.uk/components/radios/ GOV.UK Radios
     # @param block [Block] Any supplied HTML will be wrapped in a conditional
     #   container and only revealed when the radio button is picked
@@ -325,7 +412,7 @@ module GOVUKDesignSystemFormBuilder
     # @example A collection of radio buttons for favourite colours with a divider
     #
     #  = f.govuk_collection_radio_buttons :favourite_colour, inline: false do
-    #    = f.govuk_radio_button :favourite_colour, :red, label: { text: 'Red' } do
+    #    = f.govuk_radio_button :favourite_colour, :red, label: { text: 'Red' }
     #
     def govuk_radio_button(attribute_name, value, hint_text: nil, label: {}, link_errors: false, &block)
       Elements::Radios::FieldsetRadioButton.new(self, object_name, attribute_name, value, hint_text: hint_text, label: label, link_errors: link_errors, &block).html
@@ -358,6 +445,7 @@ module GOVUKDesignSystemFormBuilder
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+
+    # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @param block [Block] any HTML passed in will be injected into the fieldset, after the hint and before the checkboxes
     # @return [ActiveSupport::SafeBuffer] HTML output
     #
@@ -377,6 +465,15 @@ module GOVUKDesignSystemFormBuilder
     #    hint_text: "If it isn't listed here, tough luck",
     #    inline: false,
     #    classes: 'app-overflow-scroll',
+    #
+    # @example A collection of check boxes for types of bread
+    #  = f.govuk_collection_radio_buttons :bread,
+    #    @variety,
+    #    :id,
+    #    :name do
+    #
+    #      p.govuk-inset-text
+    #        | Only Hearty Italian is available with the meal deal menu
     def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil, hint_text: nil, legend: {}, small: false, classes: nil, &block)
       Elements::CheckBoxes::Collection.new(
         self,
@@ -403,6 +500,7 @@ module GOVUKDesignSystemFormBuilder
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+
+    # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @param classes [String] Classes to add to the checkbox container.
     # @param block [Block] a block of HTML that will be used to populate the fieldset
     # @return [ActiveSupport::SafeBuffer] HTML output
@@ -469,6 +567,7 @@ module GOVUKDesignSystemFormBuilder
     # @param secondary [Boolean] makes the button grey ({https://design-system.service.gov.uk/components/button/#secondary-buttons secondary}) when true
     # @todo The GOV.UK design system also supports {https://design-system.service.gov.uk/components/button/#disabled-buttons disabled buttons}, they
     #   should probably be supported too
+    # @param classes [String] Classes to add to the submit button
     # @param prevent_double_click [Boolean] adds JavaScript to safeguard the
     #   form from being submitted more than once
     # @param validate [Boolean] adds the formnovalidate to the submit button when true, this disables all
@@ -488,8 +587,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_submit "Proceed", prevent_double_click: true do
     #     = link_to 'Cancel', some_other_path, class: 'govuk-button__secondary'
     #
-    def govuk_submit(text = config.default_submit_button_text, warning: false, secondary: false, prevent_double_click: true, validate: false, &block)
-      Elements::Submit.new(self, text, warning: warning, secondary: secondary, prevent_double_click: prevent_double_click, validate: validate, &block).html
+    def govuk_submit(text = config.default_submit_button_text, warning: false, secondary: false, classes: nil, prevent_double_click: true, validate: false, &block)
+      Elements::Submit.new(self, text, warning: warning, secondary: secondary, classes: classes, prevent_double_click: prevent_double_click, validate: validate, &block).html
     end
 
     # Generates three inputs for the +day+, +month+ and +year+ components of a date
@@ -503,6 +602,7 @@ module GOVUKDesignSystemFormBuilder
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+
+    # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @param omit_day [Boolean] do not render a day input, only capture month and year
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input group
     # @param date_of_birth [Boolean] if +true+ {https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete#Values birth date auto completion attributes}
@@ -511,10 +611,14 @@ module GOVUKDesignSystemFormBuilder
     #
     # @see https://github.com/alphagov/govuk-frontend/issues/1449 GOV.UK date input element attributes, using text instead of number
     #
-    # @example A regular date input with a legend and hint
+    # @example A regular date input with a legend, hint and injected content
     #   = f.govuk_date_field :starts_on,
     #     legend: { 'When does your event start?' },
-    #     hint_text: 'Leave this field blank if you don't know exactly' }
+    #     hint_text: 'Leave this field blank if you don't know exactly' } do
+    #
+    #       p.govuk-inset-text
+    #         | If you don't fill this in you won't be eligable for a refund
+    #
     def govuk_date_field(attribute_name, hint_text: nil, legend: {}, date_of_birth: false, omit_day: false, &block)
       Elements::Date.new(self, object_name, attribute_name, hint_text: hint_text, legend: legend, date_of_birth: date_of_birth, omit_day: omit_day, &block).html
     end
@@ -545,6 +649,7 @@ module GOVUKDesignSystemFormBuilder
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+
+    # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     #
     # @example A fieldset containing address fields
     #   = f.govuk_fieldset legend: { text: 'Address' }
@@ -555,7 +660,7 @@ module GOVUKDesignSystemFormBuilder
     # @see https://design-system.service.gov.uk/components/fieldset/ GOV.UK fieldset
     # @return [ActiveSupport::SafeBuffer] HTML output
     def govuk_fieldset(legend: { text: 'Fieldset heading' }, described_by: nil, &block)
-      Containers::Fieldset.new(self, legend: legend, described_by: described_by).html(&block)
+      Containers::Fieldset.new(self, legend: legend, described_by: described_by, &block).html
     end
 
     # Generates an input of type +file+
@@ -569,8 +674,11 @@ module GOVUKDesignSystemFormBuilder
     # @option args [Hash] args additional arguments are applied as attributes to +input+ element
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
     #
-    # @example A photo upload field with file type specifier
-    #   = f.govuk_file_field :photo, label: { text: 'Upload your photo' }, accept: 'image/*'
+    # @example A photo upload field with file type specifier and injected content
+    #   = f.govuk_file_field :photo, label: { text: 'Upload your photo' }, accept: 'image/*' do
+    #
+    #     p.govuk-inset-text
+    #       | Explicit images will result in account termination
     #
     # @see https://design-system.service.gov.uk/components/file-upload/ GOV.UK file upload
     # @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file MDN documentation for file upload

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -5,8 +5,8 @@ module GOVUKDesignSystemFormBuilder
 
       LEGEND_SIZES = %w(xl l m s).freeze
 
-      def initialize(builder, object_name = nil, attribute_name = nil, legend: {}, described_by: nil)
-        super(builder, object_name, attribute_name)
+      def initialize(builder, object_name = nil, attribute_name = nil, legend: {}, described_by: nil, &block)
+        super(builder, object_name, attribute_name, &block)
 
         @legend         = legend_defaults.merge(legend)
         @described_by   = described_by(described_by)
@@ -15,7 +15,7 @@ module GOVUKDesignSystemFormBuilder
 
       def html
         content_tag('fieldset', class: fieldset_classes, aria: { describedby: @described_by }) do
-          safe_join([build_legend, yield])
+          safe_join([build_legend, (@block_content || yield)])
         end
       end
 
@@ -23,6 +23,7 @@ module GOVUKDesignSystemFormBuilder
 
       def legend_defaults
         {
+          hidden: false,
           text: nil,
           tag:  config.default_legend_tag,
           size: config.default_legend_size
@@ -49,7 +50,10 @@ module GOVUKDesignSystemFormBuilder
         size = @legend.dig(:size)
         fail "invalid size '#{size}', must be #{LEGEND_SIZES.join(', ')}" unless size.in?(LEGEND_SIZES)
 
-        ["govuk-fieldset__legend", "govuk-fieldset__legend--#{size}"]
+        classes = %W(govuk-fieldset__legend govuk-fieldset__legend--#{size})
+        classes.push('govuk-visually-hidden') if @legend.dig(:hidden)
+
+        classes
       end
 
       def legend_heading_classes

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

@@ -38,7 +38,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def hint_element
-          @hint_element ||= Hint.new(@builder, @object_name, @attribute_name, @hint_text, value: @value)
+          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, @value, checkbox: true)
         end
       end
     end

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

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
       class Label < Base
+        include Traits::Localisation
+
         def initialize(builder, object_name, attribute_name, checkbox, value:, link_errors: true)
           super(builder, object_name, attribute_name)
 
@@ -11,7 +13,9 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          @checkbox.label(for: field_id(link_errors: @link_errors), class: label_classes)
+          @checkbox.label(for: field_id(link_errors: @link_errors), class: label_classes) do
+            [localised_text(:label), @checkbox.text, @value].compact.first
+          end
         end
 
       private

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -105,11 +105,12 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def date_attribute_name(segment)
-        "%<object_name>s[%<attribute_name>s(%<segment>s)]" % {
+        format(
+          "%<object_name>s[%<attribute_name>s(%<segment>s)]",
           object_name: @object_name,
           attribute_name: @attribute_name,
           segment: SEGMENTS.fetch(segment)
-        }
+        )
       end
 
       def date_of_birth_autocomplete_value(segment)

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -6,8 +6,8 @@ module GOVUKDesignSystemFormBuilder
       def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, hidden: false, radio: false, checkbox: false, tag: nil, link_errors: true)
         super(builder, object_name, attribute_name)
 
-        @text           = label_text(text, hidden)
         @value          = value # used by field_id
+        @text           = label_text(text, hidden)
         @size_class     = label_size_class(size)
         @radio_class    = radio_class(radio)
         @checkbox_class = checkbox_class(checkbox)
@@ -39,7 +39,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def label_text(option_text, hidden)
-        text = [option_text, @value, localised_text(:label), @attribute_name.capitalize].compact.first.to_s
+        text = [option_text, localised_text(:label), @attribute_name.capitalize].compact.first.to_s
 
         if hidden
           tag.span(text, class: %w(govuk-visually-hidden))

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -1,7 +1,7 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Submit < Base
-      def initialize(builder, text, warning:, secondary:, prevent_double_click:, validate:, &block)
+      def initialize(builder, text, warning:, secondary:, classes:, prevent_double_click:, validate:, &block)
         fail ArgumentError, 'buttons can be warning or secondary' if warning && secondary
 
         @builder              = builder
@@ -9,6 +9,7 @@ module GOVUKDesignSystemFormBuilder
         @prevent_double_click = prevent_double_click
         @warning              = warning
         @secondary            = secondary
+        @classes              = classes
         @validate             = validate
         @block_content        = capture { block.call } if block_given?
       end
@@ -21,6 +22,7 @@ module GOVUKDesignSystemFormBuilder
               class: %w(govuk-button).push(
                 warning_class,
                 secondary_class,
+                @classes,
                 padding_class(@block_content.present?)
               ).compact,
               **extra_args

data/lib/govuk_design_system_formbuilder/traits/input.rb

@@ -51,7 +51,6 @@ module GOVUKDesignSystemFormBuilder
         return if @width.blank?
 
         case @width
-        when nil then nil
 
           # fixed (character) widths
         when 20 then 'govuk-input--width-20'

data/lib/govuk_design_system_formbuilder/traits/localisation.rb

@@ -4,28 +4,34 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def localised_text(context)
-        key = localisation_key(context)
+        return unless @object_name.present? && @attribute_name.present?
 
-        # `I18n.exists?(nil)` returns true when `config.i18n.fallbacks` is
-        # enabled, so only proceed if the key is present too
-        return nil unless key.present? && I18n.exists?(key)
-
-        I18n.translate(key)
+        localise(context) || localise_html(context)
       end
 
-      def localisation_key(context)
-        return nil unless @object_name.present? && @attribute_name.present?
+      def localise(context)
+        I18n.translate(schema(context), default: nil)
+      end
 
-        schema(context)
+      def localise_html(context)
+        I18n.translate("#{schema(context)}_html", default: nil).try(:html_safe)
       end
 
       def schema(context)
         schema_root(context)
-          .push(@object_name, @attribute_name)
+          .push(*schema_path)
           .map { |e| e == :__context__ ? context : e }
           .join('.')
       end
 
+      def schema_path
+        if @value.present?
+          [@object_name, "#{@attribute_name}_options", @value]
+        else
+          [@object_name, @attribute_name]
+        end
+      end
+
       def schema_root(context)
         contextual_schema = case context
                             when :legend

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '1.1.10'.freeze
+  VERSION = '1.1.11'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.1.11
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2020-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -56,16 +56,16 @@ dependencies:
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -134,42 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: adsf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-- !ruby/object:Gem::Dependency
-  name: adsf-live
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
   requirement: !ruby/object:Gem::Requirement
@@ -204,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.18.0
 - !ruby/object:Gem::Dependency
   name: rubypants
   requirement: !ruby/object:Gem::Requirement
@@ -232,14 +204,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -291,7 +263,6 @@ files:
 - lib/govuk_design_system_formbuilder/elements/check_boxes/collection.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/collection_check_box.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/fieldset_check_box.rb
-- lib/govuk_design_system_formbuilder/elements/check_boxes/hint.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/label.rb
 - lib/govuk_design_system_formbuilder/elements/date.rb
 - lib/govuk_design_system_formbuilder/elements/error_message.rb

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

@@ -1,32 +0,0 @@
-module GOVUKDesignSystemFormBuilder
-  module Elements
-    module CheckBoxes
-      class Hint < Base
-        include Traits::Hint
-
-        def initialize(builder, object_name, attribute_name, hint_text, value:)
-          super(builder, object_name, attribute_name)
-
-          @value     = value
-          @hint_text = hint_text
-        end
-
-        def html
-          return nil if @hint_text.blank?
-
-          tag.span(@hint_text, class: hint_classes, id: id)
-        end
-
-        def id
-          hint_id
-        end
-
-      private
-
-        def hint_classes
-          %w(govuk-hint govuk-checkboxes__hint)
-        end
-      end
-    end
-  end
-end