govuk_design_system_formbuilder 1.2.4 → 1.2.5

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -8,17 +8,18 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Label
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, form_group_classes:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @label         = label
-        @caption       = caption
-        @hint_text     = hint_text
-        @extra_options = kwargs
+        @label              = label
+        @caption            = caption
+        @hint_text          = hint_text
+        @extra_options      = kwargs
+        @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
           safe_join([label_element, supplemental_content, hint_element, error_element, file])
         end
       end
@@ -26,18 +27,18 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def file
-        @builder.file_field(@attribute_name, **file_options, **@extra_options)
+        @builder.file_field(@attribute_name, **options, **@extra_options)
       end
 
-      def file_options
+      def options
         {
           id: field_id(link_errors: true),
-          class: file_classes,
+          class: classes,
           aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
         }
       end
 
-      def file_classes
+      def classes
         %w(file-upload).prefix(brand).tap do |c|
           c.push(%(#{brand}-file-upload--error)) if has_errors?
         end

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -10,7 +10,7 @@ module GOVUKDesignSystemFormBuilder
         super(builder, object_name, attribute_name)
 
         @value     = value
-        @hint_text = hint_text(text)
+        @hint_text = retrieve_text(text)
         @radio     = radio
         @checkbox  = checkbox
       end
@@ -18,16 +18,16 @@ module GOVUKDesignSystemFormBuilder
       def html
         return nil if @hint_text.blank?
 
-        tag.span(@hint_text, class: hint_classes, id: hint_id)
+        tag.span(@hint_text, class: classes, id: hint_id)
       end
 
     private
 
-      def hint_text(supplied)
+      def retrieve_text(supplied)
         supplied.presence || localised_text(:hint)
       end
 
-      def hint_classes
+      def classes
         %w(hint).prefix(brand).push(radio_class, checkbox_class).compact
       end
 

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

@@ -10,6 +10,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Label
         include Traits::Supplemental
 
+      private
+
         def builder_method
           :email_field
         end

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -15,8 +15,8 @@ module GOVUKDesignSystemFormBuilder
           @content = content.call
         else
           @value       = value # used by field_id
-          @text        = label_text(text, hidden)
-          @size_class  = label_size_class(size)
+          @text        = retrieve_text(text, hidden)
+          @size_class  = size_class(size)
           @radio       = radio
           @checkbox    = checkbox
           @tag         = tag
@@ -38,12 +38,12 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def label
-        @builder.label(@attribute_name, **label_options) do
+        @builder.label(@attribute_name, **options) do
           @content || safe_join([caption, @text])
         end
       end
 
-      def label_text(option_text, hidden)
+      def retrieve_text(option_text, hidden)
         text = [option_text, localised_text(:label), @attribute_name.capitalize].compact.first.to_s
 
         if hidden
@@ -53,7 +53,7 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
-      def label_options
+      def options
         {
           value: @value,
           for: field_id(link_errors: @link_errors),
@@ -77,13 +77,13 @@ module GOVUKDesignSystemFormBuilder
         %(#{brand}-checkboxes__label)
       end
 
-      def label_size_class(size)
+      def size_class(size)
         case size
-        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
+        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"
         end

data/lib/govuk_design_system_formbuilder/elements/legend.rb

@@ -0,0 +1,79 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Legend < Base
+      include Traits::Caption
+      include Traits::Localisation
+
+      def initialize(builder, object_name, attribute_name, legend:, caption:)
+        super(builder, object_name, attribute_name)
+
+        case legend
+        when Proc
+          @raw = legend.call
+        when Hash
+          defaults.merge(legend).tap do |l|
+            @text    = text(l.dig(:text))
+            @hidden  = l.dig(:hidden)
+            @tag     = l.dig(:tag)
+            @size    = l.dig(:size)
+            @caption = caption
+          end
+        else
+          fail(ArgumentError, %(legend must be a Proc or Hash))
+        end
+      end
+
+      def html
+        @raw || content
+      end
+
+    private
+
+      def content
+        if @text.present?
+          content_tag('legend', class: classes) do
+            content_tag(@tag, class: heading_classes) do
+              safe_join([caption_element, @text])
+            end
+          end
+        end
+      end
+
+      def text(supplied_text)
+        supplied_text || localised_text(:legend)
+      end
+
+      def classes
+        [%(#{brand}-fieldset__legend), size_class, visually_hidden_class].compact
+      end
+
+      def size_class
+        case @size
+        when 'xl' then %(#{brand}-fieldset__legend--xl)
+        when 'l'  then %(#{brand}-fieldset__legend--l)
+        when 'm'  then %(#{brand}-fieldset__legend--m)
+        when 's'  then %(#{brand}-fieldset__legend--s)
+        else
+          fail "invalid size '#{@size}', must be xl, l, m or s"
+        end
+      end
+
+      def visually_hidden_class
+        %(#{brand}-visually-hidden) if @hidden
+      end
+
+      def heading_classes
+        %(#{brand}-fieldset__heading)
+      end
+
+      def defaults
+        {
+          hidden: false,
+          text: nil,
+          tag:  config.default_legend_tag,
+          size: config.default_legend_size
+        }
+      end
+    end
+  end
+end

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

@@ -6,24 +6,25 @@ 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:, caption:, 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:, 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
-          @inline        = inline
-          @small         = small
-          @legend        = legend
-          @caption       = caption
-          @hint_text     = hint_text
-          @classes       = classes
-          @bold_labels   = hint_method.present? || bold_labels
+          @collection         = collection
+          @value_method       = value_method
+          @text_method        = text_method
+          @hint_method        = hint_method
+          @inline             = inline
+          @small              = small
+          @legend             = legend
+          @caption            = caption
+          @hint_text          = hint_text
+          @classes            = classes
+          @form_group_classes = form_group_classes
+          @bold_labels        = hint_method.present? || bold_labels
         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, radios])
             end

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

@@ -31,10 +31,10 @@ module GOVUKDesignSystemFormBuilder
       private
 
         def radio
-          @builder.radio_button(@attribute_name, @value, **radio_options)
+          @builder.radio_button(@attribute_name, @value, **options)
         end
 
-        def radio_options
+        def options
           {
             id: field_id(link_errors: @link_errors),
             aria: { describedby: hint_id },

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

@@ -47,10 +47,10 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def input
-          @builder.radio_button(@attribute_name, @value, **input_options)
+          @builder.radio_button(@attribute_name, @value, **options)
         end
 
-        def input_options
+        def options
           {
             id: field_id(link_errors: @link_errors),
             aria: { describedby: hint_id },

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -6,21 +6,22 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint_text:, label:, caption:, &block)
+      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint_text:, label:, caption:, form_group_classes:, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @collection    = collection
-        @value_method  = value_method
-        @text_method   = text_method
-        @options       = options
-        @html_options  = html_options
-        @label         = label
-        @caption       = caption
-        @hint_text     = hint_text
+        @collection         = collection
+        @value_method       = value_method
+        @text_method        = text_method
+        @options            = options
+        @html_options       = html_options
+        @label              = label
+        @caption            = caption
+        @hint_text          = hint_text
+        @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
           safe_join([label_element, supplemental_content, hint_element, error_element, select])
         end
       end
@@ -28,26 +29,26 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def select
-        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, **select_options)
+        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, **options)
       end
 
-      def select_options
+      def options
         @html_options.deep_merge(
           id: field_id(link_errors: true),
-          class: select_classes,
+          class: classes,
           aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
         )
       end
 
-      def select_classes
-        [%(#{brand}-select), select_error_class, select_custom_classes].flatten.compact
+      def classes
+        [%(#{brand}-select), error_class, custom_classes].flatten.compact
       end
 
-      def select_error_class
+      def error_class
         %(#{brand}-select--error) if has_errors?
       end
 
-      def select_custom_classes
+      def custom_classes
         @html_options.dig(:class)
       end
     end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -24,17 +24,18 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def submit
-        @builder.submit(@text, class: submit_classes, **submit_options)
+        @builder.submit(@text, class: classes, **options)
       end
 
-      def submit_classes
+      def classes
         %w(button)
           .prefix(brand)
-          .push(warning_class, secondary_class, disabled_class, padding_class, @classes)
+          .push(warning_class, secondary_class, disabled_class, padding_class, custom_classes)
+          .flatten
           .compact
       end
 
-      def submit_options
+      def options
         {
           formnovalidate: !@validate,
           disabled: @disabled,
@@ -60,6 +61,10 @@ module GOVUKDesignSystemFormBuilder
       def disabled_class
         %(#{brand}-button--disabled) if @disabled
       end
+
+      def custom_classes
+        Array.wrap(@classes)
+      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/elements/text_area.rb

@@ -8,7 +8,7 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Label
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, rows:, max_words:, max_chars:, threshold:, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, rows:, max_words:, max_chars:, threshold:, form_group_classes:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
         @label           = label
@@ -18,12 +18,13 @@ module GOVUKDesignSystemFormBuilder
         @max_chars       = max_chars
         @threshold       = threshold
         @rows            = rows
+        @form_group_classes = form_group_classes
         @html_attributes = kwargs
       end
 
       def html
         Containers::CharacterCount.new(@builder, **character_count_options).html do
-          Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
+          Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).html do
             safe_join([label_element, supplemental_content, hint_element, error_element, text_area, limit_description])
           end
         end
@@ -36,20 +37,20 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def text_area
-        @builder.text_area(@attribute_name, **text_area_options, **@html_attributes)
+        @builder.text_area(@attribute_name, **options, **@html_attributes)
       end
 
-      def text_area_classes
+      def classes
         %w(textarea).prefix(brand).tap do |classes|
           classes.push(%(#{brand}-textarea--error)) if has_errors?
           classes.push(%(#{brand}-js-character-count)) if limit?
         end
       end
 
-      def text_area_options
+      def options
         {
           id: field_id(link_errors: true),
-          class: text_area_classes,
+          class: classes,
           rows: @rows,
           aria: { describedby: described_by(hint_id, error_id, supplemental_id, limit_description_id) },
         }

data/lib/govuk_design_system_formbuilder/traits/input.rb

@@ -1,18 +1,19 @@
 module GOVUKDesignSystemFormBuilder
   module Traits
     module Input
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, width:, **kwargs, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, width:, form_group_classes:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @width           = width
-        @label           = label
-        @caption         = caption
-        @hint_text       = hint_text
-        @html_attributes = kwargs
+        @width              = width
+        @label              = label
+        @caption            = caption
+        @hint_text          = hint_text
+        @html_attributes    = kwargs
+        @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
           safe_join([label_element, supplemental_content, hint_element, error_element, input])
         end
       end