govuk_design_system_formbuilder 0.9.8 → 2.0.0

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

@@ -1,15 +1,22 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class FieldsetCheckBox < GOVUKDesignSystemFormBuilder::Base
-        def initialize(builder, object_name, attribute_name, value, label:, hint_text:, link_errors:, multiple:, &block)
+      class FieldsetCheckBox < Base
+        using PrefixableArray
+
+        include Traits::Label
+        include Traits::Hint
+        include Traits::Conditional
+
+        def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, &block)
           super(builder, object_name, attribute_name)
 
-          @value       = value
-          @label       = label
-          @hint_text   = hint_text
-          @multiple    = multiple
-          @link_errors = link_errors
+          @value           = value
+          @unchecked_value = unchecked_value
+          @label           = label
+          @hint            = hint
+          @multiple        = multiple
+          @link_errors     = link_errors
 
           if block_given?
             @conditional_content = wrap_conditional(block)
@@ -18,53 +25,53 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          safe_join(
-            [
-              content_tag('div', class: 'govuk-checkboxes__item') do
-                safe_join(
-                  [
-                    input,
-                    label_element.html,
-                    hint_element.html,
-                  ]
-                )
-              end,
-              @conditional_content
-            ]
-          )
+          safe_join([item, @conditional_content])
         end
 
       private
 
-        def input
-          @builder.check_box(
-            @attribute_name,
-            {
-              id: field_id(link_errors: @link_errors),
-              class: check_box_classes,
-              multiple: @multiple,
-              aria: { describedby: hint_id },
-              data: { 'aria-controls' => @conditional_id }
-            },
-            @value,
-            false
-          )
+        def item
+          tag.div(class: %(#{brand}-checkboxes__item)) do
+            safe_join([check_box, label_element, hint_element])
+          end
+        end
+
+        def check_box
+          @builder.check_box(@attribute_name, options, @value, @unchecked_value)
+        end
+
+        def options
+          {
+            id: field_id(link_errors: @link_errors),
+            class: classes,
+            multiple: @multiple,
+            aria: { describedby: hint_id },
+            data: { 'aria-controls' => @conditional_id }
+          }
+        end
+
+        def classes
+          %w(checkboxes__input).prefix(brand)
         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, **label_content, **label_options)
+        end
+
+        def label_options
+          { checkbox: true, value: @value, link_errors: @link_errors }
         end
 
         def hint_element
-          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, @value, checkbox: true)
+          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
         end
 
-        def conditional_classes
-          %w(govuk-checkboxes__conditional govuk-checkboxes__conditional--hidden)
+        def hint_options
+          { checkbox: true }
         end
 
-        def check_box_classes
-          %w(govuk-checkboxes__input)
+        def conditional_classes
+          %w(checkboxes__conditional checkboxes__conditional--hidden).prefix(brand)
         end
       end
     end

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

@@ -1,7 +1,11 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class Label < GOVUKDesignSystemFormBuilder::Base
+      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,36 +1,45 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class Date < GOVUKDesignSystemFormBuilder::Base
+    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:, date_of_birth: false, omit_day:, form_group:, &block)
         super(builder, object_name, attribute_name, &block)
 
         @legend        = legend
-        @hint_text     = hint_text
+        @caption       = caption
+        @hint          = hint
         @date_of_birth = date_of_birth
         @omit_day      = omit_day
+        @form_group    = form_group
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          Containers::Fieldset.new(@builder, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
-            safe_join(
-              [
-                hint_element.html,
-                error_element.html,
-                supplemental_content.html,
-                content_tag('div', class: 'govuk-date-input') do
-                  safe_join([day, month, year])
-                end
-              ]
-            )
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
+            safe_join([supplemental_content, hint_element, error_element, date])
           end
         end
       end
 
     private
 
+      def fieldset_options
+        { legend: @legend, caption: @caption, described_by: [error_id, hint_id, supplemental_id] }
+      end
+
+      def date
+        tag.div(class: %(#{brand}-date-input)) do
+          safe_join([day, month, year])
+        end
+      end
+
       def omit_day?
         @omit_day
       end
@@ -38,61 +47,59 @@ module GOVUKDesignSystemFormBuilder
       def day
         return nil if omit_day?
 
-        date_input_item(:day, link_errors: true)
+        date_part(:day, width: 2, link_errors: true)
       end
 
       def month
-        date_input_item(:month, link_errors: omit_day?)
+        date_part(:month, width: 2, link_errors: omit_day?)
       end
 
       def year
-        date_input_item(:year, width: 4)
+        date_part(:year, width: 4)
       end
 
-      def date_input_item(segment, width: 2, link_errors: false)
+      def date_part(segment, width:, 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
-            safe_join(
-              [
-                tag.label(
-                  segment.capitalize,
-                  class: date_input_label_classes,
-                  for: date_attribute_id(segment, link_errors)
-                ),
-
-                tag.input(
-                  id: date_attribute_id(segment, link_errors),
-                  class: date_input_classes(width),
-                  name: date_attribute_name(segment),
-                  type: 'text',
-                  pattern: '[0-9]*',
-                  inputmode: 'numeric',
-                  value: value,
-                  autocomplete: date_of_birth_autocomplete_value(segment)
-                )
-              ]
-            )
+        tag.div(class: %(#{brand}-date-input__item)) do
+          tag.div(class: %(#{brand}-form-group)) do
+            safe_join([label(segment, link_errors), input(segment, link_errors, width, value)])
           end
         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?
-        end
+      def label(segment, link_errors)
+        tag.label(
+          segment.capitalize,
+          class: label_classes,
+          for: id(segment, link_errors)
+        )
+      end
+
+      def input(segment, link_errors, width, value)
+        tag.input(
+          id: id(segment, link_errors),
+          class: classes(width),
+          name: name(segment),
+          type: 'text',
+          pattern: '[0-9]*',
+          inputmode: 'numeric',
+          value: value,
+          autocomplete: date_of_birth_autocomplete_value(segment)
+        )
       end
 
-      def date_input_label_classes
-        %w(govuk-label govuk-date-input__label)
+      def 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
 
       # 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 id(segment, link_errors)
         if has_errors? && link_errors
           field_id(link_errors: link_errors)
         else
@@ -100,12 +107,13 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
-      def date_attribute_name(segment)
-        "%<object_name>s[%<attribute_name>s(%<segment>s)]" % {
+      def name(segment)
+        format(
+          "%<object_name>s[%<input_name>s(%<segment>s)]",
           object_name: @object_name,
-          attribute_name: @attribute_name,
+          input_name: @attribute_name,
           segment: SEGMENTS.fetch(segment)
-        }
+        )
       end
 
       def date_of_birth_autocomplete_value(segment)
@@ -113,6 +121,10 @@ module GOVUKDesignSystemFormBuilder
 
         { day: 'bday-day', month: 'bday-month', year: 'bday-year' }.fetch(segment)
       end
+
+      def label_classes
+        %w(label date-input__label).prefix(brand)
+      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -1,6 +1,10 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class ErrorMessage < GOVUKDesignSystemFormBuilder::Base
+    class ErrorMessage < Base
+      using PrefixableArray
+
+      include Traits::Error
+
       def initialize(builder, object_name, attribute_name)
         super(builder, object_name, attribute_name)
       end
@@ -8,16 +12,17 @@ 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
-            ]
-          )
+        tag.span(class: %(#{brand}-error-message), id: error_id) do
+          safe_join([hidden_prefix, message])
         end
       end
 
+    private
+
+      def hidden_prefix
+        tag.span('Error: ', class: %(#{brand}-visually-hidden))
+      end
+
       def message
         @builder.object.errors.messages[@attribute_name]&.first
       end

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -1,6 +1,8 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class ErrorSummary < GOVUKDesignSystemFormBuilder::Base
+    class ErrorSummary < Base
+      include Traits::Error
+
       def initialize(builder, object_name, title)
         @builder = builder
         @object_name = object_name
@@ -10,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
-            ]
-          )
+        tag.div(class: summary_class, **summary_options) do
+          safe_join([title, 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 title
+        tag.h2(@title, id: summary_title_id, class: summary_class('title'))
+      end
+
+      def summary
+        tag.div(class: summary_class('body')) do
+          tag.ul(class: [%(#{brand}-list), summary_class('list')]) do
+            safe_join(list)
+          end
+        end
+      end
+
+      def list
+        @builder.object.errors.messages.map do |attribute, messages|
+          list_item(attribute, messages.first)
         end
       end
 
+      def 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)
         if part
-          'govuk-error-summary'.concat('__', part)
+          %(#{brand}-error-summary).concat('__', part)
         else
-          'govuk-error-summary'
+          %(#{brand}-error-summary)
         end
       end
 
@@ -58,7 +57,7 @@ module GOVUKDesignSystemFormBuilder
         build_id('field-error', attribute_name: attribute)
       end
 
-      def error_summary_title_id
+      def summary_title_id
         'error-summary-title'
       end
 
@@ -66,15 +65,15 @@ module GOVUKDesignSystemFormBuilder
         @builder.object.errors.any?
       end
 
-      def error_summary_attributes
+      def summary_options
         {
           tabindex: -1,
           role: 'alert',
           data: {
-            module: 'govuk-error-summary'
+            module: %(#{brand}-error-summary)
           },
           aria: {
-            labelledby: error_summary_title_id
+            labelledby: summary_title_id
           }
         }
       end

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -1,39 +1,46 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class File < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, **extra_args, &block)
+    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:, label:, caption:, form_group:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @label      = label
-        @hint_text  = hint_text
-        @extra_args = extra_args
+        @label           = label
+        @caption         = caption
+        @hint            = hint
+        @html_attributes = kwargs
+        @form_group      = form_group
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          safe_join(
-            [
-              label_element.html,
-              hint_element.html,
-              error_element.html,
-              supplemental_content.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
-              )
-            ]
-          )
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
+          safe_join([label_element, supplemental_content, hint_element, error_element, file])
         end
       end
 
     private
 
-      def file_classes
-        %w(govuk-file-upload).tap do |c|
-          c.push('govuk-file-upload--error') if has_errors?
+      def file
+        @builder.file_field(@attribute_name, **options, **@html_attributes)
+      end
+
+      def options
+        {
+          id: field_id(link_errors: true),
+          class: classes,
+          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+        }
+      end
+
+      def classes
+        %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,33 +1,69 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class Hint < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, text, value = nil, radio: false, checkbox: false)
+    class Hint < Base
+      using PrefixableArray
+
+      include Traits::Localisation
+
+      def initialize(builder, object_name, attribute_name, value: nil, text: nil, content: nil, radio: false, checkbox: false, **kwargs)
         super(builder, object_name, attribute_name)
 
-        @value          = value
-        @hint_text      = text
-        @radio_class    = radio_class(radio)
-        @checkbox_class = checkbox_class(checkbox)
+        @value           = value
+        @radio           = radio
+        @checkbox        = checkbox
+        @html_attributes = kwargs
+
+        if content
+          @raw = capture { content.call }
+        else
+          @text = retrieve_text(text)
+        end
+      end
+
+      def active?
+        [@text, @raw].any?(&:present?)
       end
 
       def html
-        return nil if @hint_text.blank?
+        return nil unless active?
+
+        content_tag(hint_tag, **hint_options, **@html_attributes) { hint_body }
+      end
+
+      def hint_id
+        return nil unless active?
 
-        tag.span(@hint_text, class: hint_classes, id: hint_id)
+        build_id('hint')
       end
 
     private
 
-      def hint_classes
-        %w(govuk-hint).push(@radio_class, @checkbox_class).compact
+      def hint_options
+        { class: classes, id: hint_id }
+      end
+
+      def hint_tag
+        @raw.presence ? 'div' : 'span'
+      end
+
+      def hint_body
+        @raw || @text
+      end
+
+      def retrieve_text(supplied)
+        supplied.presence || localised_text(:hint)
+      end
+
+      def classes
+        %w(hint).prefix(brand).push(radio_class, checkbox_class).compact
       end
 
-      def radio_class(radio)
-        radio ? 'govuk-radios__hint' : nil
+      def radio_class
+        @radio ? %(#{brand}-radios__hint) : nil
       end
 
-      def checkbox_class(checkbox)
-        checkbox ? 'govuk-checkboxes__hint' : nil
+      def checkbox_class
+        @checkbox ? %(#{brand}-checkboxes__hint) : nil
       end
     end
   end

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

@@ -2,6 +2,14 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Email < Base
+        include Traits::Input
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Label
+        include Traits::Supplemental
+
+      private
+
         def builder_method
           :email_field
         end

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

@@ -2,6 +2,12 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Number < Base
+        include Traits::Input
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Label
+        include Traits::Supplemental
+
         def builder_method
           :number_field
         end

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

@@ -0,0 +1,17 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    module Inputs
+      class Password < Base
+        include Traits::Input
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Label
+        include Traits::Supplemental
+
+        def builder_method
+          :password_field
+        end
+      end
+    end
+  end
+end