govuk_design_system_formbuilder 1.1.10 → 1.2.0

data/lib/govuk_design_system_formbuilder/containers/character_count.rb

@@ -16,8 +16,8 @@ module GOVUKDesignSystemFormBuilder
 
         content_tag(
           'div',
-          class: 'govuk-character-count',
-          data: { module: 'govuk-character-count' }.merge(**limit, **threshold).compact
+          class: %(#{brand}-character-count),
+          data: { module: %(#{brand}-character-count) }.merge(**limit, **threshold).compact
         ) do
           yield
         end

data/lib/govuk_design_system_formbuilder/containers/check_boxes.rb

@@ -1,6 +1,8 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class CheckBoxes < Base
+      using PrefixableArray
+
       def initialize(builder, small:, classes: nil)
         @builder = builder
         @small   = small
@@ -8,7 +10,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        content_tag('div', class: check_boxes_classes, data: { module: 'govuk-checkboxes' }) do
+        content_tag('div', class: check_boxes_classes, data: { module: %(#{brand}-checkboxes) }) do
           yield
         end
       end
@@ -16,8 +18,8 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def check_boxes_classes
-        %w(govuk-checkboxes).tap do |c|
-          c.push('govuk-checkboxes--small') if @small
+        %w(checkboxes).prefix(brand).tap do |c|
+          c.push(%(#{brand}-checkboxes--small)) if @small
           c.push(@classes) if @classes
         end
       end

data/lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb

@@ -4,10 +4,11 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
       include Traits::Hint
 
-      def initialize(builder, object_name, attribute_name, hint_text:, legend:, small:, classes:, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, legend:, caption:, small:, classes:, &block)
         super(builder, object_name, attribute_name, &block)
 
         @legend        = legend
+        @caption       = caption
         @hint_text     = hint_text
         @small         = small
         @classes       = classes
@@ -16,7 +17,7 @@ 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_element.error_id, hint_element.hint_id]).html do
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, caption: @caption, described_by: [error_element.error_id, hint_element.hint_id]).html do
             safe_join(
               [
                 hint_element.html,

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -1,59 +1,80 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class Fieldset < Base
+      using PrefixableArray
+
+      include Traits::Caption
       include Traits::Localisation
 
       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: {}, caption: {}, described_by: nil, &block)
+        super(builder, object_name, attribute_name, &block)
 
-        @legend         = legend_defaults.merge(legend)
         @described_by   = described_by(described_by)
         @attribute_name = attribute_name
+
+        case legend
+        when Proc
+          @legend_raw = legend.call
+        when Hash
+          @legend_options = legend_defaults.merge(legend)
+          @caption        = caption
+        else
+          fail(ArgumentError, %(legend must be a Proc or Hash))
+        end
       end
 
       def html
         content_tag('fieldset', class: fieldset_classes, aria: { describedby: @described_by }) do
-          safe_join([build_legend, yield])
+          safe_join([legend_content, (@block_content || yield)])
         end
       end
 
     private
 
-      def legend_defaults
-        {
-          text: nil,
-          tag:  config.default_legend_tag,
-          size: config.default_legend_size
-        }
+      def legend_content
+        @legend_raw || build_legend
       end
 
       def build_legend
         if legend_text.present?
           content_tag('legend', class: legend_classes) do
-            tag.send(@legend.dig(:tag), legend_text, class: legend_heading_classes)
+            content_tag(@legend_options.dig(:tag), class: legend_heading_classes) do
+              safe_join([caption_element.html, legend_text])
+            end
           end
         end
       end
 
       def legend_text
-        [@legend.dig(:text), localised_text(:legend)].compact.first
+        [@legend_options.dig(:text), localised_text(:legend)].compact.first
       end
 
       def fieldset_classes
-        %w(govuk-fieldset)
+        %w(fieldset).prefix(brand)
       end
 
       def legend_classes
-        size = @legend.dig(:size)
+        size = @legend_options.dig(:size)
         fail "invalid size '#{size}', must be #{LEGEND_SIZES.join(', ')}" unless size.in?(LEGEND_SIZES)
 
-        ["govuk-fieldset__legend", "govuk-fieldset__legend--#{size}"]
+        [%(fieldset__legend), %(fieldset__legend--#{size})].prefix(brand).tap do |classes|
+          classes.push(%(#{brand}-visually-hidden)) if @legend_options.dig(:hidden)
+        end
       end
 
       def legend_heading_classes
-        %(govuk-fieldset__heading)
+        %w(fieldset__heading).prefix(brand)
+      end
+
+      def legend_defaults
+        {
+          hidden: false,
+          text: nil,
+          tag:  config.default_legend_tag,
+          size: config.default_legend_size
+        }
       end
     end
   end

data/lib/govuk_design_system_formbuilder/containers/form_group.rb

@@ -1,6 +1,8 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class FormGroup < Base
+      using PrefixableArray
+
       def initialize(builder, object_name, attribute_name)
         super(builder, object_name, attribute_name)
       end
@@ -14,8 +16,8 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def form_group_classes
-        %w(govuk-form-group).tap do |classes|
-          classes.push('govuk-form-group--error') if has_errors?
+        %w(form-group).prefix(brand).tap do |classes|
+          classes.push(%(#{brand}-form-group--error)) if has_errors?
         end
       end
     end

data/lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb

@@ -4,12 +4,13 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
       include Traits::Error
 
-      def initialize(builder, object_name, attribute_name, hint_text:, legend:, inline:, small:, classes:, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, legend:, caption:, inline:, small:, classes:, &block)
         super(builder, object_name, attribute_name)
 
         @inline        = inline
         @small         = small
         @legend        = legend
+        @caption       = caption
         @hint_text     = hint_text
         @classes       = classes
         @block_content = capture { block.call }
@@ -17,7 +18,7 @@ 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_element.error_id, hint_element.hint_id]).html do
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, caption: @caption, described_by: [error_element.error_id, hint_element.hint_id]).html do
             safe_join(
               [
                 hint_element.html,

data/lib/govuk_design_system_formbuilder/containers/radios.rb

@@ -1,6 +1,8 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class Radios < Base
+      using PrefixableArray
+
       include Traits::Hint
 
       def initialize(builder, inline:, small:, classes:)
@@ -11,7 +13,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        content_tag('div', class: radios_classes, data: { module: 'govuk-radios' }) do
+        content_tag('div', class: radios_classes, data: { module: %(#{brand}-radios) }) do
           yield
         end
       end
@@ -19,10 +21,10 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def radios_classes
-        %w(govuk-radios).tap do |c|
-          c.push('govuk-radios--inline') if @inline
-          c.push('govuk-radios--small')  if @small
-          c.push(@classes)               if @classes
+        %w(radios).prefix(brand).tap do |c|
+          c.push(%(#{brand}-radios--inline)) if @inline
+          c.push(%(#{brand}-radios--small))  if @small
+          c.push(@classes)                   if @classes
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/caption.rb

@@ -0,0 +1,34 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Caption < Base
+      include Traits::Localisation
+
+      def initialize(builder, object_name, attribute_name, text:, size: 'm')
+        super(builder, object_name, attribute_name)
+
+        @text       = caption_text(text)
+        @size_class = caption_size_class(size)
+      end
+
+      def html
+        return nil if @text.blank?
+
+        tag.span(@text, class: @size_class)
+      end
+
+      def caption_text(override)
+        override || localised_text(:caption)
+      end
+
+      def caption_size_class(size)
+        case size
+        when 'xl' then %(#{brand}-caption-xl)
+        when 'l'  then %(#{brand}-caption-l)
+        when 'm'  then %(#{brand}-caption-m)
+        else
+          fail ArgumentError, "invalid size '#{size}', must be xl, l or m"
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Supplemental
 
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method: nil, hint_text:, legend:, small:, classes:, &block)
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method: nil, hint_text:, legend:, caption:, small:, classes:, &block)
           super(builder, object_name, attribute_name, &block)
 
           @collection    = collection
@@ -15,13 +15,14 @@ module GOVUKDesignSystemFormBuilder
           @hint_method   = hint_method
           @small         = small
           @legend        = legend
+          @caption       = caption
           @hint_text     = hint_text
           @classes       = classes
         end
 
         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
+            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.html,

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

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
       class CollectionCheckBox < Base
+        using PrefixableArray
+
         include Traits::CollectionItem
         include Traits::Hint
 
@@ -16,12 +18,12 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          content_tag('div', class: 'govuk-checkboxes__item') do
+          content_tag('div', class: %(#{brand}-checkboxes__item)) do
             safe_join(
               [
                 @checkbox.check_box(
                   id: field_id(link_errors: @link_errors),
-                  class: "govuk-checkboxes__input",
+                  class: %(#{brand}-checkboxes__input),
                   aria: { describedby: hint_id }
                 ),
                 label_element.html,
@@ -38,7 +40,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/fieldset_check_box.rb

@@ -2,6 +2,9 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
       class FieldsetCheckBox < Base
+        using PrefixableArray
+
+        include Traits::Label
         include Traits::Hint
         include Traits::Conditional
 
@@ -23,7 +26,7 @@ module GOVUKDesignSystemFormBuilder
         def html
           safe_join(
             [
-              content_tag('div', class: 'govuk-checkboxes__item') do
+              content_tag('div', class: %(#{brand}-checkboxes__item)) do
                 safe_join(
                   [
                     input,
@@ -55,7 +58,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, checkbox: true, value: @value, **@label, link_errors: @link_errors)
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, checkbox: true, value: @value, link_errors: @link_errors, **label_args)
         end
 
         def hint_element
@@ -63,11 +66,11 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def conditional_classes
-          %w(govuk-checkboxes__conditional govuk-checkboxes__conditional--hidden)
+          %w(checkboxes__conditional checkboxes__conditional--hidden).prefix(brand)
         end
 
         def check_box_classes
-          %w(govuk-checkboxes__input)
+          %w(checkboxes__input).prefix(brand)
         end
       end
     end

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

@@ -2,6 +2,10 @@ 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)
           super(builder, object_name, attribute_name)
 
@@ -11,13 +15,15 @@ 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
 
         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,13 +21,13 @@ 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
+          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.html,
                 hint_element.html,
                 error_element.html,
-                content_tag('div', class: 'govuk-date-input') do
+                content_tag('div', class: %(#{brand}-date-input)) do
                   safe_join([day, month, year])
                 end
               ]
@@ -56,8 +59,8 @@ module GOVUKDesignSystemFormBuilder
       def date_input_item(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(
@@ -83,14 +86,14 @@ module GOVUKDesignSystemFormBuilder
       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?
+        %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)
+        %w(label date-input__label).prefix(brand)
       end
 
       # if the field has errors we want the govuk_error_summary to
@@ -105,11 +108,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)