govuk_design_system_formbuilder 1.1.10 → 1.2.0

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,10 +12,10 @@ module GOVUKDesignSystemFormBuilder
       def html
         return nil unless has_errors?
 
-        content_tag('span', class: 'govuk-error-message', id: error_id) do
+        content_tag('span', class: %(#{brand}-error-message), id: error_id) do
           safe_join(
             [
-              tag.span('Error: ', class: 'govuk-visually-hidden'),
+              tag.span('Error: ', class: %(#{brand}-visually-hidden)),
               message
             ]
           )

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -17,7 +17,7 @@ module GOVUKDesignSystemFormBuilder
             [
               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
+                content_tag('ul', class: [%(#{brand}-list), summary_class('list')]) do
                   safe_join(
                     @builder.object.errors.messages.map do |attribute, messages|
                       error_list_item(attribute, messages.first)
@@ -50,9 +50,9 @@ module GOVUKDesignSystemFormBuilder
 
       def 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
 
@@ -73,7 +73,7 @@ module GOVUKDesignSystemFormBuilder
           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,15 +1,18 @@
 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:, **extra_args, &block)
         super(builder, object_name, attribute_name, &block)
 
         @label      = label
+        @caption    = caption
         @hint_text  = hint_text
         @extra_args = extra_args
       end
@@ -37,8 +40,8 @@ module GOVUKDesignSystemFormBuilder
     private
 
       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
 
@@ -29,15 +31,15 @@ module GOVUKDesignSystemFormBuilder
       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,25 +1,35 @@
 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)
 
-        @text           = label_text(text, hidden)
-        @value          = value # used by field_id
-        @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)) { build_label }
         else
           build_label
         end
@@ -32,36 +42,36 @@ module GOVUKDesignSystemFormBuilder
           @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
+          class: %w(label).prefix(brand).push(@size_class, @weight_class, @radio_class, @checkbox_class).compact
         ) do
-          @text
+          @content || safe_join([caption_element.html, @text])
         end
       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))
+          tag.span(text, class: %w(visually-hidden).prefix(brand))
         else
           text
         end
       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"

data/lib/govuk_design_system_formbuilder/elements/radios/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:, hint_text:, legend:, inline:, small:, bold_labels:, classes:, &block)
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint_text:, legend:, caption:, inline:, small:, bold_labels:, classes:, &block)
           super(builder, object_name, attribute_name, &block)
 
           @collection    = collection
@@ -16,6 +16,7 @@ module GOVUKDesignSystemFormBuilder
           @inline        = inline
           @small         = small
           @legend        = legend
+          @caption       = caption
           @hint_text     = hint_text
           @classes       = classes
           @bold_labels   = hint_method.present? || bold_labels
@@ -23,7 +24,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_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/radios/collection_radio_button.rb

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
       class CollectionRadioButton < Base
+        using PrefixableArray
+
         include Traits::Hint
         include Traits::CollectionItem
 
@@ -21,7 +23,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          content_tag('div', class: 'govuk-radios__item') do
+          content_tag('div', class: %(#{brand}-radios__item)) do
             safe_join(
               [
                 @builder.radio_button(
@@ -29,7 +31,7 @@ module GOVUKDesignSystemFormBuilder
                   @value,
                   id: field_id(link_errors: @link_errors),
                   aria: { describedby: hint_id },
-                  class: %w(govuk-radios__input)
+                  class: %w(radios__input).prefix(brand)
                 ),
                 label_element.html,
                 hint_element.html

data/lib/govuk_design_system_formbuilder/elements/radios/fieldset_radio_button.rb

@@ -2,6 +2,9 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
       class FieldsetRadioButton < Base
+        using PrefixableArray
+
+        include Traits::Label
         include Traits::Hint
         include Traits::Conditional
 
@@ -22,7 +25,7 @@ module GOVUKDesignSystemFormBuilder
         def html
           safe_join(
             [
-              content_tag('div', class: 'govuk-radios__item') do
+              content_tag('div', class: %(#{brand}-radios__item)) do
                 safe_join(
                   [
                     input,
@@ -39,7 +42,7 @@ module GOVUKDesignSystemFormBuilder
       private
 
         def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, radio: true, value: @value, **@label, link_errors: @link_errors)
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, radio: true, value: @value, link_errors: @link_errors, **label_args)
         end
 
         def hint_element
@@ -53,12 +56,12 @@ module GOVUKDesignSystemFormBuilder
             id: field_id(link_errors: @link_errors),
             aria: { describedby: hint_id },
             data: { 'aria-controls' => @conditional_id },
-            class: %w(govuk-radios__input)
+            class: %w(radios__input).prefix(brand)
           )
         end
 
         def conditional_classes
-          %w(govuk-radios__conditional govuk-radios__conditional--hidden)
+          %w(radios__conditional radios__conditional--hidden).prefix(brand)
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -1,12 +1,14 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Select < Base
+      using PrefixableArray
+
       include Traits::Error
       include Traits::Label
       include Traits::Hint
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint_text:, label:, &block)
+      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint_text:, label:, caption:, &block)
         super(builder, object_name, attribute_name, &block)
 
         @collection    = collection
@@ -15,6 +17,7 @@ module GOVUKDesignSystemFormBuilder
         @options       = options
         @html_options  = html_options
         @label         = label
+        @caption       = caption
         @hint_text     = hint_text
       end
 
@@ -50,8 +53,8 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def select_classes
-        %w(govuk-select).tap do |classes|
-          classes.push('govuk-select--error') if has_errors?
+        %w(select).prefix(brand).tap do |classes|
+          classes.push(%(#{brand}-select--error)) if has_errors?
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -1,7 +1,9 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Submit < Base
-      def initialize(builder, text, warning:, secondary:, prevent_double_click:, validate:, &block)
+      using PrefixableArray
+
+      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 +11,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
@@ -18,9 +21,10 @@ module GOVUKDesignSystemFormBuilder
           [
             @builder.submit(
               @text,
-              class: %w(govuk-button).push(
+              class: %w(button).prefix(brand).push(
                 warning_class,
                 secondary_class,
+                @classes,
                 padding_class(@block_content.present?)
               ).compact,
               **extra_args
@@ -33,23 +37,22 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def warning_class
-        'govuk-button--warning' if @warning
+        %(#{brand}-button--warning) if @warning
       end
 
       def secondary_class
-        'govuk-button--secondary' if @secondary
+        %(#{brand}-button--secondary) if @secondary
       end
 
       def padding_class(content_present)
-        'govuk-!-margin-right-1' if content_present
+        %(#{brand}-!-margin-right-1) if content_present
       end
 
       def extra_args
         {
           formnovalidate: !@validate,
           data: {
-            module: 'govuk-button',
-            'prevent-double-click' => @prevent_double_click
+            module: %(#{brand}-button), 'prevent-double-click' => @prevent_double_click
           }.select { |_k, v| v.present? }
         }
       end