govuk_design_system_formbuilder 1.2.4 → 1.2.5

data/lib/govuk_design_system_formbuilder/containers/form_group.rb

@@ -1,24 +1,32 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class FormGroup < Base
-      using PrefixableArray
-
-      def initialize(builder, object_name, attribute_name)
+      def initialize(builder, object_name, attribute_name, classes: nil)
         super(builder, object_name, attribute_name)
+
+        @classes = classes
       end
 
       def html
-        content_tag('div', class: form_group_classes) do
-          yield
-        end
+        content_tag('div', class: classes) { yield }
       end
 
     private
 
-      def form_group_classes
-        %w(form-group).prefix(brand).tap do |classes|
-          classes.push(%(#{brand}-form-group--error)) if has_errors?
-        end
+      def classes
+        [form_group_class, error_class, custom_classes].flatten.compact
+      end
+
+      def form_group_class
+        %(#{brand}-form-group)
+      end
+
+      def error_class
+        %(#{brand}-form-group--error) if has_errors?
+      end
+
+      def custom_classes
+        Array.wrap(@classes)
       end
     end
   end

data/lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb

@@ -4,20 +4,21 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
       include Traits::Error
 
-      def initialize(builder, object_name, attribute_name, hint_text:, legend:, caption:, inline:, small:, classes:, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, legend:, caption:, inline:, small:, classes:, form_group_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 }
+        @inline             = inline
+        @small              = small
+        @legend             = legend
+        @caption            = caption
+        @hint_text          = hint_text
+        @classes            = classes
+        @form_group_classes = form_group_classes
+        @block_content      = capture { block.call }
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
           Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
             safe_join([hint_element, error_element, radios])
           end

data/lib/govuk_design_system_formbuilder/containers/radios.rb

@@ -1,8 +1,6 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class Radios < Base
-      using PrefixableArray
-
       include Traits::Hint
 
       def initialize(builder, inline:, small:, classes:)
@@ -13,26 +11,32 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        content_tag('div', **radios_options) do
-          yield
-        end
+        content_tag('div', **options) { yield }
       end
 
     private
 
-      def radios_options
+      def options
         {
-          class: radios_classes,
+          class: classes,
           data: { module: %(#{brand}-radios) }
         }
       end
 
-      def radios_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
+      def classes
+        [%(#{brand}-radios), inline_class, small_class, custom_classes].flatten.compact
+      end
+
+      def inline_class
+        %(#{brand}-radios--inline) if @inline
+      end
+
+      def small_class
+        %(#{brand}-radios--small)  if @small
+      end
+
+      def custom_classes
+        Array.wrap(@classes)
       end
     end
   end

data/lib/govuk_design_system_formbuilder/containers/supplemental.rb

@@ -13,6 +13,8 @@ module GOVUKDesignSystemFormBuilder
         content_tag('div', id: supplemental_id) { @content }
       end
 
+    private
+
       def supplemental_id
         build_id('supplemental')
       end

data/lib/govuk_design_system_formbuilder/elements/caption.rb

@@ -6,8 +6,8 @@ module GOVUKDesignSystemFormBuilder
       def initialize(builder, object_name, attribute_name, text:, size: nil)
         super(builder, object_name, attribute_name)
 
-        @text       = caption_text(text)
-        @size_class = caption_size_class(size)
+        @text       = text(text)
+        @size_class = size_class(size)
       end
 
       def html
@@ -16,11 +16,13 @@ module GOVUKDesignSystemFormBuilder
         tag.span(@text, class: @size_class)
       end
 
-      def caption_text(override)
+    private
+
+      def text(override)
         override || localised_text(:caption)
       end
 
-      def caption_size_class(size)
+      def size_class(size)
         case size || config.default_caption_size
         when 'xl' then %(#{brand}-caption-xl)
         when 'l'  then %(#{brand}-caption-l)

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

@@ -6,22 +6,23 @@ 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:, caption:, small:, classes:, &block)
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method: nil, hint_text:, legend:, caption:, small:, classes:, form_group_classes:, &block)
           super(builder, object_name, attribute_name, &block)
 
-          @collection    = collection
-          @value_method  = value_method
-          @text_method   = text_method
-          @hint_method   = hint_method
-          @small         = small
-          @legend        = legend
-          @caption       = caption
-          @hint_text     = hint_text
-          @classes       = classes
+          @collection         = collection
+          @value_method       = value_method
+          @text_method        = text_method
+          @hint_method        = hint_method
+          @small              = small
+          @legend             = legend
+          @caption            = caption
+          @hint_text          = hint_text
+          @classes            = classes
+          @form_group_classes = form_group_classes
         end
 
         def html
-          Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
+          Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
             Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
               safe_join([supplemental_content, hint_element, error_element, check_boxes])
             end

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

@@ -26,10 +26,10 @@ module GOVUKDesignSystemFormBuilder
       private
 
         def check_box
-          @checkbox.check_box(**check_box_options)
+          @checkbox.check_box(**options)
         end
 
-        def check_box_options
+        def options
           {
             id: field_id(link_errors: @link_errors),
             class: %(#{brand}-checkboxes__input),

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

@@ -24,31 +24,35 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          safe_join([check_box, @conditional_content])
+          safe_join([item, @conditional_content])
         end
 
       private
 
-        def check_box
+        def item
           content_tag('div', class: %(#{brand}-checkboxes__item)) do
-            safe_join([input, label_element, hint_element])
+            safe_join([check_box, label_element, hint_element])
           end
         end
 
-        def input
-          @builder.check_box(@attribute_name, input_options, @value, false)
+        def check_box
+          @builder.check_box(@attribute_name, options, @value, false)
         end
 
-        def input_options
+        def options
           {
             id: field_id(link_errors: @link_errors),
-            class: check_box_classes,
+            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, **label_content, **label_options)
         end
@@ -64,10 +68,6 @@ module GOVUKDesignSystemFormBuilder
         def conditional_classes
           %w(checkboxes__conditional checkboxes__conditional--hidden).prefix(brand)
         end
-
-        def check_box_classes
-          %w(checkboxes__input).prefix(brand)
-        end
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -9,18 +9,19 @@ module GOVUKDesignSystemFormBuilder
 
       SEGMENTS = { day: '3i', month: '2i', year: '1i' }.freeze
 
-      def initialize(builder, object_name, attribute_name, legend:, caption:, 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:, form_group_classes:, &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
+        @legend             = legend
+        @caption            = caption
+        @hint_text          = hint_text
+        @date_of_birth      = date_of_birth
+        @omit_day           = omit_day
+        @form_group_classes = form_group_classes
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
           Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
             safe_join([supplemental_content, hint_element, error_element, date])
           end
@@ -71,15 +72,15 @@ module GOVUKDesignSystemFormBuilder
         tag.label(
           segment.capitalize,
           class: label_classes,
-          for: input_id(segment, link_errors)
+          for: id(segment, link_errors)
         )
       end
 
       def input(segment, link_errors, width, value)
         tag.input(
-          id: input_id(segment, link_errors),
-          class: input_classes(width),
-          name: input_name(segment),
+          id: id(segment, link_errors),
+          class: classes(width),
+          name: name(segment),
           type: 'text',
           pattern: '[0-9]*',
           inputmode: 'numeric',
@@ -88,21 +89,17 @@ module GOVUKDesignSystemFormBuilder
         )
       end
 
-      def input_classes(width)
+      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
 
-      def 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 input_id(segment, link_errors)
+      def id(segment, link_errors)
         if has_errors? && link_errors
           field_id(link_errors: link_errors)
         else
@@ -110,7 +107,7 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
-      def input_name(segment)
+      def name(segment)
         format(
           "%<object_name>s[%<input_name>s(%<segment>s)]",
           object_name: @object_name,
@@ -124,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

@@ -13,17 +13,17 @@ module GOVUKDesignSystemFormBuilder
         return nil unless has_errors?
 
         content_tag('span', class: %(#{brand}-error-message), id: error_id) do
-          safe_join([error_prefix, error_message])
+          safe_join([prefix, message])
         end
       end
 
     private
 
-      def error_prefix
+      def prefix
         tag.span('Error: ', class: %(#{brand}-visually-hidden))
       end
 
-      def error_message
+      def message
         @builder.object.errors.messages[@attribute_name]&.first
       end
     end

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

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