govuk_design_system_formbuilder 1.1.11 → 1.2.1

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

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
       class Label < Base
+        using PrefixableArray
+
         include Traits::Localisation
 
         def initialize(builder, object_name, attribute_name, checkbox, value:, link_errors: true)
@@ -21,7 +23,7 @@ module GOVUKDesignSystemFormBuilder
       private
 
         def label_classes
-          %w(govuk-label govuk-checkboxes__label)
+          %w(label checkboxes__label).prefix(brand)
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -1,16 +1,19 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Date < Base
+      using PrefixableArray
+
       include Traits::Error
       include Traits::Hint
       include Traits::Supplemental
 
       SEGMENTS = { day: '3i', month: '2i', year: '1i' }.freeze
 
-      def initialize(builder, object_name, attribute_name, legend:, hint_text:, date_of_birth: false, omit_day:, &block)
+      def initialize(builder, object_name, attribute_name, legend:, caption:, hint_text:, date_of_birth: false, omit_day:, &block)
         super(builder, object_name, attribute_name, &block)
 
         @legend        = legend
+        @caption       = caption
         @hint_text     = hint_text
         @date_of_birth = date_of_birth
         @omit_day      = omit_day
@@ -18,23 +21,20 @@ module GOVUKDesignSystemFormBuilder
 
       def html
         Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
-            safe_join(
-              [
-                supplemental_content.html,
-                hint_element.html,
-                error_element.html,
-                content_tag('div', class: 'govuk-date-input') do
-                  safe_join([day, month, year])
-                end
-              ]
-            )
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, caption: @caption, described_by: [error_id, hint_id, supplemental_id]).html do
+            safe_join([supplemental_content, hint_element, error_element, date])
           end
         end
       end
 
     private
 
+      def date
+        content_tag('div', class: %(#{brand}-date-input)) do
+          safe_join([day, month, year])
+        end
+      end
+
       def omit_day?
         @omit_day
       end
@@ -42,34 +42,34 @@ module GOVUKDesignSystemFormBuilder
       def day
         return nil if omit_day?
 
-        date_input_item(:day, link_errors: true)
+        date_part_input(:day, link_errors: true)
       end
 
       def month
-        date_input_item(:month, link_errors: omit_day?)
+        date_part_input(:month, link_errors: omit_day?)
       end
 
       def year
-        date_input_item(:year, width: 4)
+        date_part_input(:year, width: 4)
       end
 
-      def date_input_item(segment, width: 2, link_errors: false)
+      def date_part_input(segment, width: 2, link_errors: false)
         value = @builder.object.try(@attribute_name).try(segment)
 
-        content_tag('div', class: %w(govuk-date-input__item)) do
-          content_tag('div', class: %w(govuk-form-group)) do
+        content_tag('div', class: %w(date-input__item).prefix(brand)) do
+          content_tag('div', class: %w(form-group).prefix(brand)) do
             safe_join(
               [
                 tag.label(
                   segment.capitalize,
-                  class: date_input_label_classes,
-                  for: date_attribute_id(segment, link_errors)
+                  class: date_part_label_classes,
+                  for: date_part_attribute_id(segment, link_errors)
                 ),
 
                 tag.input(
-                  id: date_attribute_id(segment, link_errors),
-                  class: date_input_classes(width),
-                  name: date_attribute_name(segment),
+                  id: date_part_attribute_id(segment, link_errors),
+                  class: date_part_input_classes(width),
+                  name: date_part_attribute_name(segment),
                   type: 'text',
                   pattern: '[0-9]*',
                   inputmode: 'numeric',
@@ -82,21 +82,21 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
-      def date_input_classes(width)
-        %w(govuk-input govuk-date-input__input).tap do |classes|
-          classes.push("govuk-input--width-#{width}")
-          classes.push("govuk-input--error") if has_errors?
+      def date_part_input_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
       end
 
-      def date_input_label_classes
-        %w(govuk-label govuk-date-input__label)
+      def date_part_label_classes
+        %w(label date-input__label).prefix(brand)
       end
 
       # if the field has errors we want the govuk_error_summary to
       # be able to link to the day field. Otherwise, generate IDs
       # in the normal fashion
-      def date_attribute_id(segment, link_errors)
+      def date_part_attribute_id(segment, link_errors)
         if has_errors? && link_errors
           field_id(link_errors: link_errors)
         else
@@ -104,7 +104,7 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
-      def date_attribute_name(segment)
+      def date_part_attribute_name(segment)
         format(
           "%<object_name>s[%<attribute_name>s(%<segment>s)]",
           object_name: @object_name,

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -1,6 +1,8 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class ErrorMessage < Base
+      using PrefixableArray
+
       include Traits::Error
 
       def initialize(builder, object_name, attribute_name)
@@ -10,17 +12,18 @@ module GOVUKDesignSystemFormBuilder
       def html
         return nil unless has_errors?
 
-        content_tag('span', class: 'govuk-error-message', id: error_id) do
-          safe_join(
-            [
-              tag.span('Error: ', class: 'govuk-visually-hidden'),
-              message
-            ]
-          )
+        content_tag('span', class: %(#{brand}-error-message), id: error_id) do
+          safe_join([error_prefix, error_message])
         end
       end
 
-      def message
+    private
+
+      def error_prefix
+        tag.span('Error: ', class: %(#{brand}-visually-hidden))
+      end
+
+      def error_message
         @builder.object.errors.messages[@attribute_name]&.first
       end
     end

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -12,47 +12,44 @@ module GOVUKDesignSystemFormBuilder
       def html
         return nil unless object_has_errors?
 
-        content_tag('div', class: summary_class, **error_summary_attributes) do
-          safe_join(
-            [
-              tag.h2(@title, id: error_summary_title_id, class: summary_class('title')),
-              content_tag('div', class: summary_class('body')) do
-                content_tag('ul', class: ['govuk-list', summary_class('list')]) do
-                  safe_join(
-                    @builder.object.errors.messages.map do |attribute, messages|
-                      error_list_item(attribute, messages.first)
-                    end
-                  )
-                end
-              end
-            ]
-          )
+        content_tag('div', class: error_summary_class, **error_summary_options) do
+          safe_join([error_title, error_summary])
         end
       end
 
     private
 
-      def error_list_item(attribute, message)
-        content_tag('li') do
-          link_to(
-            message,
-            same_page_link(field_id(attribute)),
-            data: {
-              turbolinks: false
-            }
-          )
+      def error_title
+        tag.h2(@title, id: error_summary_title_id, class: error_summary_class('title'))
+      end
+
+      def error_summary
+        content_tag('div', class: error_summary_class('body')) do
+          content_tag('ul', class: [%(#{brand}-list), error_summary_class('list')]) do
+            safe_join(error_list)
+          end
         end
       end
 
+      def error_list
+        @builder.object.errors.messages.map do |attribute, messages|
+          error_list_item(attribute, messages.first)
+        end
+      end
+
+      def error_list_item(attribute, message)
+        tag.li(link_to(message, same_page_link(field_id(attribute)), data: { turbolinks: false }))
+      end
+
       def same_page_link(target)
         '#'.concat(target)
       end
 
-      def summary_class(part = nil)
+      def error_summary_class(part = nil)
         if part
-          'govuk-error-summary'.concat('__', part)
+          %(#{brand}-error-summary).concat('__', part)
         else
-          'govuk-error-summary'
+          %(#{brand}-error-summary)
         end
       end
 
@@ -68,12 +65,12 @@ module GOVUKDesignSystemFormBuilder
         @builder.object.errors.any?
       end
 
-      def error_summary_attributes
+      def error_summary_options
         {
           tabindex: -1,
           role: 'alert',
           data: {
-            module: 'govuk-error-summary'
+            module: %(#{brand}-error-summary)
           },
           aria: {
             labelledby: error_summary_title_id

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -1,44 +1,45 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class File < Base
+      using PrefixableArray
+
       include Traits::Error
       include Traits::Hint
       include Traits::Label
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, **extra_args, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @label      = label
-        @hint_text  = hint_text
-        @extra_args = extra_args
+        @label         = label
+        @caption       = caption
+        @hint_text     = hint_text
+        @extra_options = kwargs
       end
 
       def html
         Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          safe_join(
-            [
-              label_element.html,
-              supplemental_content.html,
-              hint_element.html,
-              error_element.html,
-              @builder.file_field(
-                @attribute_name,
-                id: field_id(link_errors: true),
-                class: file_classes,
-                aria: { describedby: described_by(hint_id, error_id, supplemental_id) },
-                **@extra_args
-              )
-            ]
-          )
+          safe_join([label_element, supplemental_content, hint_element, error_element, file])
         end
       end
 
     private
 
+      def file
+        @builder.file_field(@attribute_name, **file_options, **@extra_options)
+      end
+
+      def file_options
+        {
+          id: field_id(link_errors: true),
+          class: file_classes,
+          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+        }
+      end
+
       def file_classes
-        %w(govuk-file-upload).tap do |c|
-          c.push('govuk-file-upload--error') if has_errors?
+        %w(file-upload).prefix(brand).tap do |c|
+          c.push(%(#{brand}-file-upload--error)) if has_errors?
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -1,6 +1,8 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Hint < Base
+      using PrefixableArray
+
       include Traits::Hint
       include Traits::Localisation
 
@@ -22,22 +24,19 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def hint_text(supplied)
-        [
-          supplied.presence,
-          localised_text(:hint)
-        ].compact.first
+        [supplied.presence, localised_text(:hint)].compact.first
       end
 
       def hint_classes
-        %w(govuk-hint).push(@radio_class, @checkbox_class).compact
+        %w(hint).prefix(brand).push(@radio_class, @checkbox_class).compact
       end
 
       def radio_class(radio)
-        radio ? 'govuk-radios__hint' : nil
+        radio ? %(#{brand}-radios__hint) : nil
       end
 
       def checkbox_class(checkbox)
-        checkbox ? 'govuk-checkboxes__hint' : nil
+        checkbox ? %(#{brand}-checkboxes__hint) : nil
       end
     end
   end

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

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Email < Base
+        using PrefixableArray
+
         include Traits::Input
         include Traits::Error
         include Traits::Hint

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

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Number < Base
+        using PrefixableArray
+
         include Traits::Input
         include Traits::Error
         include Traits::Hint

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

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Password < Base
+        using PrefixableArray
+
         include Traits::Input
         include Traits::Error
         include Traits::Hint

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

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Phone < Base
+        using PrefixableArray
+
         include Traits::Input
         include Traits::Error
         include Traits::Hint

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

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Text < Base
+        using PrefixableArray
+
         include Traits::Input
         include Traits::Error
         include Traits::Hint

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

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class URL < Base
+        using PrefixableArray
+
         include Traits::Input
         include Traits::Error
         include Traits::Hint

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -1,40 +1,45 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Label < Base
+      using PrefixableArray
+
+      include Traits::Caption
       include Traits::Localisation
 
-      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, hidden: false, radio: false, checkbox: false, tag: nil, link_errors: true)
+      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, hidden: false, radio: false, checkbox: false, tag: nil, link_errors: true, content: nil, caption: nil)
         super(builder, object_name, attribute_name)
 
-        @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)
-        @tag            = tag
-        @link_errors    = link_errors
+        # content is passed in directly via a proc and overrides
+        # the other display options
+        if content
+          @content = content.call
+        else
+          @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)
+          @tag            = tag
+          @link_errors    = link_errors
+          @caption        = caption
+        end
       end
 
       def html
-        return nil if @text.blank?
+        return nil if [@content, @text].all?(&:blank?)
 
         if @tag.present?
-          content_tag(@tag, class: 'govuk-label-wrapper') { build_label }
+          content_tag(@tag, class: %(#{brand}-label-wrapper)) { label }
         else
-          build_label
+          label
         end
       end
 
     private
 
-      def build_label
-        @builder.label(
-          @attribute_name,
-          value: @value,
-          for: field_id(link_errors: @link_errors),
-          class: %w(govuk-label).push(@size_class, @weight_class, @radio_class, @checkbox_class).compact
-        ) do
-          @text
+      def label
+        @builder.label(@attribute_name, label_options) do
+          @content || safe_join([caption_element.html, @text])
         end
       end
 
@@ -42,26 +47,34 @@ module GOVUKDesignSystemFormBuilder
         text = [option_text, localised_text(:label), @attribute_name.capitalize].compact.first.to_s
 
         if hidden
-          tag.span(text, class: %w(govuk-visually-hidden))
+          tag.span(text, class: %w(visually-hidden).prefix(brand))
         else
           text
         end
       end
 
+      def label_options
+        {
+          value: @value,
+          for: field_id(link_errors: @link_errors),
+          class: %w(label).prefix(brand).push(@size_class, @weight_class, @radio_class, @checkbox_class).compact
+        }
+      end
+
       def radio_class(radio)
-        radio ? 'govuk-radios__label' : nil
+        radio ? %(#{brand}-radios__label) : nil
       end
 
       def checkbox_class(checkbox)
-        checkbox ? 'govuk-checkboxes__label' : nil
+        checkbox ? %(#{brand}-checkboxes__label) : nil
       end
 
       def label_size_class(size)
         case size
-        when 'xl'      then "govuk-label--xl"
-        when 'l'       then "govuk-label--l"
-        when 'm'       then "govuk-label--m"
-        when 's'       then "govuk-label--s"
+        when 'xl'      then %(#{brand}-label--xl)
+        when 'l'       then %(#{brand}-label--l)
+        when 'm'       then %(#{brand}-label--m)
+        when 's'       then %(#{brand}-label--s)
         when nil       then nil
         else
           fail "invalid size '#{size}', must be xl, l, m, s or nil"