govuk_design_system_formbuilder 0.9.8 → 2.0.0

data/lib/govuk_design_system_formbuilder/containers/character_count.rb

@@ -14,17 +14,18 @@ module GOVUKDesignSystemFormBuilder
       def html
         return yield unless limit?
 
-        content_tag(
-          'div',
-          class: 'govuk-character-count',
-          data: { module: 'govuk-character-count' }.merge(**limit, **threshold).compact
-        ) do
-          yield
-        end
+        tag.div(**options) { yield }
       end
 
     private
 
+      def options
+        {
+          class: %(#{brand}-character-count),
+          data: { module: %(#{brand}-character-count) }.merge(**limit, **threshold).compact
+        }
+      end
+
       def limit
         if @max_words
           { maxwords: @max_words }

data/lib/govuk_design_system_formbuilder/containers/check_boxes.rb

@@ -1,23 +1,35 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class CheckBoxes < Base
-      def initialize(builder, small:)
+      def initialize(builder, small:, classes: nil)
         @builder = builder
         @small   = small
+        @classes = classes
       end
 
       def html
-        content_tag('div', class: check_boxes_classes, data: { module: 'govuk-checkboxes' }) do
-          yield
-        end
+        tag.div(**options) { yield }
       end
 
     private
 
-      def check_boxes_classes
-        %w(govuk-checkboxes).tap do |c|
-          c.push('govuk-checkboxes--small') if @small
-        end
+      def options
+        {
+          class: classes,
+          data: { module: %(#{brand}-checkboxes) }
+        }
+      end
+
+      def classes
+        [%(#{brand}-checkboxes), small_class, custom_classes].flatten.compact
+      end
+
+      def small_class
+        %(#{brand}-checkboxes--small) if @small
+      end
+
+      def custom_classes
+        Array.wrap(@classes)
       end
     end
   end

data/lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb

@@ -1,30 +1,55 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class CheckBoxesFieldset < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, hint_text:, legend:, small:, &block)
+    class CheckBoxesFieldset < Base
+      include Traits::Error
+      include Traits::Hint
+
+      def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, small:, classes:, form_group:, multiple:, &block)
         super(builder, object_name, attribute_name, &block)
 
         @legend        = legend
-        @hint_text     = hint_text
+        @caption       = caption
+        @hint          = hint
         @small         = small
+        @classes       = classes
+        @form_group    = form_group
+        @multiple      = multiple
         @block_content = capture { block.call }
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          Containers::Fieldset.new(@builder, legend: @legend, described_by: [error_element.error_id, hint_element.hint_id]).html do
-            safe_join(
-              [
-                hint_element.html,
-                error_element.html,
-                Containers::CheckBoxes.new(@builder, small: @small).html do
-                  @block_content
-                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([hint_element, error_element, hidden_field, checkboxes])
           end
         end
       end
+
+    private
+
+      def hidden_field
+        return unless @multiple
+
+        @builder.hidden_field(@attribute_name, value: "", name: hidden_field_name)
+      end
+
+      def hidden_field_name
+        format("%<object_name>s[%<attribute_name>s][]", object_name: @object_name, attribute_name: @attribute_name)
+      end
+
+      def fieldset_options
+        {
+          legend: @legend,
+          caption: @caption,
+          described_by: [error_element.error_id, hint_element.hint_id]
+        }
+      end
+
+      def checkboxes
+        Containers::CheckBoxes.new(@builder, small: @small, classes: @classes).html do
+          @block_content
+        end
+      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -1,44 +1,40 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class Fieldset < GOVUKDesignSystemFormBuilder::Base
-      LEGEND_DEFAULTS = { text: nil, tag: 'h1', size: 'm' }.freeze
-      LEGEND_SIZES = %w(xl l m s).freeze
-
-      def initialize(builder, legend: {}, described_by: nil)
-        @builder = builder
-        @legend = LEGEND_DEFAULTS.merge(legend)
-        @described_by = described_by(described_by)
+    class Fieldset < Base
+      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
       end
 
       def html
-        content_tag('fieldset', class: fieldset_classes, aria: { describedby: @described_by }) do
-          safe_join([build_legend, yield])
+        tag.fieldset(**options) do
+          safe_join([legend_element, (@block_content || yield)])
         end
       end
 
     private
 
-      def build_legend
-        if @legend.dig(:text).present?
-          content_tag('legend', class: legend_classes) do
-            tag.send(@legend.dig(:tag), @legend.dig(:text), class: legend_heading_classes)
-          end
-        end
+      def options
+        {
+          class: classes,
+          aria: { describedby: @described_by }
+        }
       end
 
-      def fieldset_classes
-        %w(govuk-fieldset)
+      def classes
+        %(#{brand}-fieldset)
       end
 
-      def legend_classes
-        size = @legend.dig(:size)
-        fail "invalid size '#{size}', must be #{LEGEND_SIZES.join(', ')}" unless size.in?(LEGEND_SIZES)
-
-        ["govuk-fieldset__legend", "govuk-fieldset__legend--#{size}"]
+      def legend_element
+        @legend_element ||= Elements::Legend.new(@builder, @object_name, @attribute_name, **legend_options)
       end
 
-      def legend_heading_classes
-        %(govuk-fieldset__heading)
+      def legend_options
+        { legend: @legend, caption: @caption }
       end
     end
   end

data/lib/govuk_design_system_formbuilder/containers/form_group.rb

@@ -1,22 +1,33 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class FormGroup < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name)
+    class FormGroup < Base
+      def initialize(builder, object_name, attribute_name, classes: nil, **kwargs)
         super(builder, object_name, attribute_name)
+
+        @classes         = classes
+        @html_attributes = kwargs
       end
 
       def html
-        content_tag('div', class: form_group_classes) do
-          yield
-        end
+        tag.div(class: classes, **@html_attributes) { yield }
       end
 
     private
 
-      def form_group_classes
-        %w(govuk-form-group).tap do |classes|
-          classes.push('govuk-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

@@ -1,31 +1,45 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class RadioButtonsFieldset < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, hint_text:, legend:, inline:, small:, &block)
+    class RadioButtonsFieldset < Base
+      include Traits::Hint
+      include Traits::Error
+
+      def initialize(builder, object_name, attribute_name, hint:, legend:, caption:, inline:, small:, classes:, form_group:, &block)
         super(builder, object_name, attribute_name)
 
         @inline        = inline
         @small         = small
         @legend        = legend
-        @hint_text     = hint_text
+        @caption       = caption
+        @hint          = hint
+        @classes       = classes
+        @form_group    = form_group
         @block_content = capture { block.call }
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          Containers::Fieldset.new(@builder, legend: @legend, 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).html do
-                  @block_content
-                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([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,25 +1,42 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class Radios < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, inline:, small:)
+    class Radios < Base
+      include Traits::Hint
+
+      def initialize(builder, inline:, small:, classes:)
         @builder = builder
         @inline  = inline
         @small   = small
+        @classes = classes
       end
 
       def html
-        content_tag('div', class: radios_classes, data: { module: 'govuk-radios' }) do
-          yield
-        end
+        tag.div(**options) { yield }
       end
 
     private
 
-      def radios_classes
-        %w(govuk-radios).tap do |c|
-          c.push('govuk-radios--inline') if @inline
-          c.push('govuk-radios--small')  if @small
-        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

@@ -1,21 +1,20 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class Supplemental < GOVUKDesignSystemFormBuilder::Base
+    class Supplemental < Base
       def initialize(builder, object_name, attribute_name, content)
-        @builder        = builder
-        @object_name    = object_name
-        @attribute_name = attribute_name
-        @content        = content
+        super(builder, object_name, attribute_name)
+
+        @content = content
       end
 
       def html
-        return nil unless @content.present?
+        return nil if @content.blank?
 
-        content_tag('div', id: supplemental_id) do
-          @content
-        end
+        tag.div(id: supplemental_id) { @content }
       end
 
+    private
+
       def supplemental_id
         build_id('supplemental')
       end

data/lib/govuk_design_system_formbuilder/elements/caption.rb

@@ -0,0 +1,41 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Caption < Base
+      include Traits::Localisation
+
+      def initialize(builder, object_name, attribute_name, text: nil, size: nil, **kwargs)
+        super(builder, object_name, attribute_name)
+
+        @text            = text(text)
+        @size_class      = size_class(size)
+        @html_attributes = kwargs
+      end
+
+      def html
+        return nil unless active?
+
+        tag.span(@text, class: @size_class, **@html_attributes)
+      end
+
+    private
+
+      def active?
+        @text.present?
+      end
+
+      def text(override)
+        override || localised_text(:caption)
+      end
+
+      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)
+        else
+          fail ArgumentError, "invalid size '#{size}', must be xl, l or m"
+        end
+      end
+    end
+  end
+end

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

@@ -1,38 +1,50 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class Collection < GOVUKDesignSystemFormBuilder::Base
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method: nil, hint_text:, legend:, small:, &block)
+      class Collection < Base
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Supplemental
+
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method: nil, hint:, legend:, caption:, small:, classes:, form_group:, &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
-          @hint_text     = hint_text
+          @collection   = collection
+          @value_method = value_method
+          @text_method  = text_method
+          @hint_method  = hint_method
+          @small        = small
+          @legend       = legend
+          @caption      = caption
+          @hint         = hint
+          @classes      = classes
+          @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,
-                  Containers::CheckBoxes.new(@builder, small: @small).html do
-                    build_collection
-                  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, 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
         #
@@ -41,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

@@ -1,40 +1,50 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class CollectionCheckBox < GOVUKDesignSystemFormBuilder::Base
+      class CollectionCheckBox < Base
+        include Traits::CollectionItem
+        include Traits::Hint
+
         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 = @item.send(hint_method) if hint_method.present?
+
+          @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: 'govuk-checkboxes__item') do
-            safe_join(
-              [
-                @checkbox.check_box(
-                  id: field_id(link_errors: @link_errors),
-                  class: "govuk-checkboxes__input",
-                  aria: { describedby: hint_id }
-                ),
-                label_element.html,
-                hint_element.html
-              ]
-            )
+          tag.div(class: %(#{brand}-checkboxes__item)) do
+            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
 
         def hint_element
-          @hint_element ||= Hint.new(@builder, @object_name, @attribute_name, @hint_text, value: @value)
+          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
+        end
+
+        def hint_options
+          { value: @value, checkbox: true }
         end
       end
     end