govuk_design_system_formbuilder 1.2.0 → 1.2.5

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -1,80 +1,40 @@
 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: {}, caption: {}, described_by: nil, &block)
         super(builder, object_name, attribute_name, &block)
 
+        @legend         = legend
+        @caption        = caption
         @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([legend_content, (@block_content || yield)])
+        content_tag('fieldset', **options) do
+          safe_join([legend_element, (@block_content || yield)])
         end
       end
 
     private
 
-      def legend_content
-        @legend_raw || build_legend
-      end
-
-      def build_legend
-        if legend_text.present?
-          content_tag('legend', class: legend_classes) do
-            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_options.dig(:text), localised_text(:legend)].compact.first
+      def options
+        {
+          class: classes,
+          aria: { describedby: @described_by }
+        }
       end
 
-      def fieldset_classes
-        %w(fieldset).prefix(brand)
+      def classes
+        %(#{brand}-fieldset)
       end
 
-      def legend_classes
-        size = @legend_options.dig(:size)
-        fail "invalid size '#{size}', must be #{LEGEND_SIZES.join(', ')}" unless size.in?(LEGEND_SIZES)
-
-        [%(fieldset__legend), %(fieldset__legend--#{size})].prefix(brand).tap do |classes|
-          classes.push(%(#{brand}-visually-hidden)) if @legend_options.dig(:hidden)
-        end
+      def legend_element
+        @legend_element ||= Elements::Legend.new(@builder, @object_name, @attribute_name, **legend_options)
       end
 
-      def legend_heading_classes
-        %w(fieldset__heading).prefix(brand)
-      end
-
-      def legend_defaults
-        {
-          hidden: false,
-          text: nil,
-          tag:  config.default_legend_tag,
-          size: config.default_legend_size
-        }
+      def legend_options
+        { legend: @legend, caption: @caption }
       end
     end
   end

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,33 +4,42 @@ 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::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,
-                error_element.html,
-                Containers::Radios.new(@builder, inline: @inline, small: @small, classes: @classes).html do
-                  @block_content
-                end
-              ]
-            )
+        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
         end
       end
+
+    private
+
+      def fieldset_options
+        {
+          legend: @legend,
+          caption: @caption,
+          described_by: [error_element.error_id, hint_element.hint_id]
+        }
+      end
+
+      def radios
+        Containers::Radios.new(@builder, inline: @inline, small: @small, classes: @classes).html do
+          @block_content
+        end
+      end
     end
   end
 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,19 +11,32 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        content_tag('div', class: radios_classes, data: { module: %(#{brand}-radios) }) do
-          yield
-        end
+        content_tag('div', **options) { yield }
       end
 
     private
 
-      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 options
+        {
+          class: classes,
+          data: { module: %(#{brand}-radios) }
+        }
+      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

@@ -10,11 +10,11 @@ module GOVUKDesignSystemFormBuilder
       def html
         return nil if @content.blank?
 
-        content_tag('div', id: supplemental_id) do
-          @content
-        end
+        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

@@ -3,11 +3,11 @@ module GOVUKDesignSystemFormBuilder
     class Caption < Base
       include Traits::Localisation
 
-      def initialize(builder, object_name, attribute_name, text:, size: 'm')
+      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,12 +16,14 @@ 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)
-        case size
+      def size_class(size)
+        case size || config.default_caption_size
         when 'xl' then %(#{brand}-caption-xl)
         when 'l'  then %(#{brand}-caption-l)
         when 'm'  then %(#{brand}-caption-m)

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

@@ -6,39 +6,45 @@ 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::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,
-                  Containers::CheckBoxes.new(@builder, small: @small, classes: @classes).html do
-                    build_collection
-                  end
-                ]
-              )
+          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
           end
         end
 
       private
 
+        def fieldset_options
+          {
+            legend: @legend,
+            caption: @caption,
+            described_by: [error_id, hint_id, supplemental_id]
+          }
+        end
+
+        def check_boxes
+          Containers::CheckBoxes.new(@builder, small: @small, classes: @classes).html do
+            collection
+          end
+        end
+
         # Builds a collection of check {Elements::CheckBoxes::CheckBox}
         # @return [ActiveSupport::SafeBuffer] HTML output
         #
@@ -47,7 +53,7 @@ module GOVUKDesignSystemFormBuilder
         #   be rendered when it happens we need to work on the chance that it might, so
         #   the +link_errors+ variable is set to +true+ if this attribute has errors and
         #   always set back to +false+ after the first checkbox has been rendered
-        def build_collection
+        def collection
           link_errors = has_errors?
 
           @builder.collection_check_boxes(@attribute_name, @collection, @value_method, @text_method) do |check_box|

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

@@ -10,31 +10,33 @@ module GOVUKDesignSystemFormBuilder
         def initialize(builder, object_name, attribute_name, checkbox, hint_method = nil, link_errors: false)
           super(builder, object_name, attribute_name)
 
-          @checkbox  = checkbox
-          @item      = checkbox.object
-          @value     = checkbox.value
-          @hint_text = retrieve(@item, hint_method)
+          @checkbox    = checkbox
+          @item        = checkbox.object
+          @value       = checkbox.value
+          @hint_text   = retrieve(@item, hint_method)
           @link_errors = link_errors
         end
 
         def html
           content_tag('div', class: %(#{brand}-checkboxes__item)) do
-            safe_join(
-              [
-                @checkbox.check_box(
-                  id: field_id(link_errors: @link_errors),
-                  class: %(#{brand}-checkboxes__input),
-                  aria: { describedby: hint_id }
-                ),
-                label_element.html,
-                hint_element.html
-              ]
-            )
+            safe_join([check_box, label_element, hint_element])
           end
         end
 
       private
 
+        def check_box
+          @checkbox.check_box(**options)
+        end
+
+        def options
+          {
+            id: field_id(link_errors: @link_errors),
+            class: %(#{brand}-checkboxes__input),
+            aria: { describedby: hint_id }
+          }
+        end
+
         def label_element
           @label_element ||= Label.new(@builder, @object_name, @attribute_name, @checkbox, value: @value, link_errors: @link_errors)
         end

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

@@ -24,41 +24,41 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          safe_join(
-            [
-              content_tag('div', class: %(#{brand}-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
+          content_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, false)
+        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, link_errors: @link_errors, **label_args)
+          @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
@@ -68,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