govuk_design_system_formbuilder 0.7.9 → 0.7.10

data/lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb

@@ -0,0 +1,28 @@
+module GOVUKDesignSystemFormBuilder
+  module Containers
+    class CheckBoxesFieldset < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name, hint_text:, legend:, small:, &block)
+        super(builder, object_name, attribute_name)
+
+        @legend        = legend
+        @hint_text     = hint_text
+        @small         = small
+        @block_content = @builder.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
+            @builder.safe_join([
+              hint_element.html,
+              error_element.html,
+              Containers::CheckBoxes.new(@builder, small: @small).html do
+                @block_content
+              end
+            ])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -7,7 +7,7 @@ module GOVUKDesignSystemFormBuilder
       def initialize(builder, legend: {}, described_by: nil)
         @builder = builder
         @legend = LEGEND_DEFAULTS.merge(legend)
-        @described_by = descriptors(described_by)
+        @described_by = described_by(described_by)
       end
 
       def html
@@ -35,20 +35,14 @@ module GOVUKDesignSystemFormBuilder
 
       def legend_classes
         size = @legend.dig(:size)
-        fail "invalid size #{size}, must be #{LEGEND_SIZES.join(', ')}" unless size.in?(LEGEND_SIZES)
+        fail "invalid size '#{size}', must be #{LEGEND_SIZES.join(', ')}" unless size.in?(LEGEND_SIZES)
 
-        "govuk-fieldset__legend govuk-fieldset__legend--#{size}"
+        ["govuk-fieldset__legend", "govuk-fieldset__legend--#{size}"]
       end
 
       def legend_heading_classes
         %(govuk-fieldset__heading)
       end
-
-      def descriptors(described_by)
-        return nil unless described_by.present?
-
-        described_by.compact.join(' ').presence
-      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb

@@ -0,0 +1,29 @@
+module GOVUKDesignSystemFormBuilder
+  module Containers
+    class RadioButtonsFieldset < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name, hint_text:, legend:, inline:, small:, &block)
+        super(builder, object_name, attribute_name)
+
+        @inline        = inline
+        @small         = small
+        @legend        = legend
+        @hint_text     = hint_text
+        @block_content = @builder.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
+            @builder.safe_join([
+              hint_element.html,
+              error_element.html,
+              Containers::Radios.new(@builder, inline: @inline, small: @small).html do
+                @block_content
+              end
+            ])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+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)
+          super(builder, object_name, attribute_name)
+
+          @collection    = collection
+          @value_method  = value_method
+          @text_method   = text_method
+          @hint_method   = hint_method
+          @small         = small
+          @legend        = legend
+          @hint_text     = hint_text
+          @block_content = @builder.capture { block.call } if block_given?
+        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
+              @builder.safe_join(
+                [
+                  hint_element.html,
+                  error_element.html,
+                  @block_content,
+                  Containers::CheckBoxes.new(@builder, small: @small).html do
+                    build_collection
+                  end
+                ]
+              )
+            end
+          end
+        end
+
+      private
+
+        # Builds a collection of check {Elements::CheckBoxes::CheckBox}
+        # @return [ActiveSupport::SafeBuffer] HTML output
+        #
+        # @note The GOV.UK design system requires that error summary links should
+        #   link to the first checkbox directly. As we don't know if a collection will
+        #   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
+          link_errors = has_errors?
+
+          @builder.collection_check_boxes(@attribute_name, @collection, @value_method, @text_method) do |check_box|
+            Elements::CheckBoxes::CollectionCheckBox.new(
+              @builder,
+              @object_name,
+              @attribute_name,
+              check_box,
+              @hint_method,
+              link_errors: link_errors
+            ).html.tap { link_errors = false }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,26 +2,40 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
       class CollectionCheckBox < GOVUKDesignSystemFormBuilder::Base
-        def initialize(builder, attribute, checkbox, hint_method = nil)
-          @builder   = builder
-          @attribute = attribute
+        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?
+          @link_errors = link_errors
         end
 
         def html
-          hint = Hint.new(@builder, @attribute, @checkbox, @hint_text)
           @builder.content_tag('div', class: 'govuk-checkboxes__item') do
             @builder.safe_join(
               [
-                @checkbox.check_box(class: "govuk-checkboxes__input", aria: { describedby: hint.id }),
-                Label.new(@checkbox).html,
-                hint.html
+                @checkbox.check_box(
+                  id: field_id(link_errors: @link_errors),
+                  class: "govuk-checkboxes__input",
+                  aria: { describedby: hint_element.hint_id }
+                ),
+                label_element.html,
+                hint_element.html
               ]
             )
           end
         end
+
+      private
+
+        def label_element
+          @label_element ||= Label.new(@checkbox, @object_name, @attribute_name, value: @value)
+        end
+
+        def hint_element
+          @hint_element ||= Hint.new(@builder, @object_name, @attribute_name, @hint_text, value: @value)
+        end
       end
     end
   end

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

@@ -0,0 +1,75 @@
+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)
+          super(builder, object_name, attribute_name)
+
+          @value       = value
+          @label       = label
+          @hint_text   = hint_text
+          @multiple    = multiple
+          @link_errors = link_errors
+
+          if block_given?
+            @conditional_content = wrap_conditional(block)
+            @conditional_id      = conditional_id
+          end
+        end
+
+        def html
+          @builder.content_tag('div', class: 'govuk-checkboxes__item') do
+            @builder.safe_join([input, label, hint, @conditional_content])
+          end
+        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
+          )
+        end
+
+        def label
+          Elements::Label.new(
+            @builder,
+            @object_name,
+            @attribute_name,
+            value: @value,
+            checkbox: true,
+            **@label,
+          ).html
+        end
+
+        def hint
+          Elements::Hint.new(
+            @builder,
+            @object_name,
+            @attribute_name,
+            @hint_text,
+            @value,
+            checkbox: true
+          ).html
+        end
+
+        def conditional_classes
+          %w(govuk-checkboxes__conditional govuk-checkboxes__conditional--hidden)
+        end
+
+        def check_box_classes
+          %w(govuk-checkboxes__input)
+        end
+      end
+    end
+  end
+end

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

@@ -1,30 +1,22 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class Hint
-        def initialize(builder, attribute, checkbox, text)
-          @builder   = builder
-          @attribute = attribute
-          @checkbox  = checkbox
-          @text      = text
+      class Hint < GOVUKDesignSystemFormBuilder::Base
+        def initialize(builder, object_name, attribute_name, hint_text, value:)
+          super(builder, object_name, attribute_name)
+
+          @value     = value
+          @hint_text = hint_text
         end
 
         def html
-          return nil if @text.blank?
+          return nil if @hint_text.blank?
 
-          @builder.tag.span(@text, class: hint_classes, id: id)
+          @builder.tag.span(@hint_text, class: hint_classes, id: id)
         end
 
         def id
-          return nil if @text.blank?
-
-          [
-            @attribute,
-            @checkbox.object.id,
-            'hint'
-          ]
-            .join('-')
-            .parameterize
+          hint_id
         end
 
       private

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

@@ -1,13 +1,14 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class Label
-        def initialize(builder)
-          @builder = builder
+      class Label < GOVUKDesignSystemFormBuilder::Base
+        def initialize(builder, object_name, attribute_name, value:)
+          super(builder, object_name, attribute_name)
+          @value = value
         end
 
         def html
-          @builder.label(class: label_classes)
+          @builder.label(for: field_id, class: label_classes)
         end
 
       private

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -8,13 +8,10 @@ module GOVUKDesignSystemFormBuilder
         @legend = legend
         @hint_text = hint_text
         @date_of_birth = date_of_birth
-        @block_content = @builder.capture { block.call }.html_safe if block_given?
+        @block_content = @builder.capture { block.call } if block_given?
       end
 
       def html
-        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text)
-        error_element = Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
-
         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
             @builder.safe_join(
@@ -25,9 +22,9 @@ module GOVUKDesignSystemFormBuilder
                 @builder.content_tag('div', class: 'govuk-date-input') do
                   @builder.safe_join(
                     [
-                      date_input_group(:day),
-                      date_input_group(:month),
-                      date_input_group(:year, width: 4)
+                      date_input_item(:day, link_errors: true),
+                      date_input_item(:month),
+                      date_input_item(:year, width: 4)
                     ]
                   )
                 end
@@ -39,7 +36,7 @@ module GOVUKDesignSystemFormBuilder
 
     private
 
-      def date_input_group(segment, width: 2)
+      def date_input_item(segment, width: 2, link_errors: false)
         value = @builder.object.try(@attribute_name).try(segment)
 
         @builder.content_tag('div', class: %w(govuk-date-input__item)) do
@@ -49,13 +46,13 @@ module GOVUKDesignSystemFormBuilder
                 @builder.tag.label(
                   segment.capitalize,
                   class: date_input_label_classes,
-                  for: date_attribute_descriptor(segment)
+                  for: date_attribute_id(segment, link_errors)
                 ),
 
                 @builder.tag.input(
-                  id: date_attribute_descriptor(segment),
+                  id: date_attribute_id(segment, link_errors),
                   class: date_input_classes(width),
-                  name: date_attribute_identifier(segment),
+                  name: date_attribute_name(segment),
                   type: 'text',
                   pattern: '[0-9]*',
                   inputmode: 'numeric',
@@ -79,11 +76,18 @@ module GOVUKDesignSystemFormBuilder
         %w(govuk-label govuk-date-input__label)
       end
 
-      def date_attribute_descriptor(segment)
-        [@object_name, @attribute_name, SEGMENTS.fetch(segment)].join("_")
+      # 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)
+        if has_errors? && link_errors
+          field_id(link_errors: link_errors)
+        else
+          [@object_name, @attribute_name, SEGMENTS.fetch(segment)].join("_")
+        end
       end
 
-      def date_attribute_identifier(segment)
+      def date_attribute_name(segment)
         "%<object_name>s[%<attribute_name>s(%<segment>s)]" % {
           object_name: @object_name,
           attribute_name: @attribute_name,

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -9,10 +9,12 @@ module GOVUKDesignSystemFormBuilder
         return nil unless has_errors?
 
         @builder.content_tag('span', class: 'govuk-error-message', id: error_id) do
-          @builder.safe_join([
-            @builder.tag.span('Error: ', class: 'govuk-visually-hidden'),
-            message
-          ])
+          @builder.safe_join(
+            [
+              @builder.tag.span('Error: ', class: 'govuk-visually-hidden'),
+              message
+            ]
+          )
         end
       end
 

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -10,12 +10,12 @@ module GOVUKDesignSystemFormBuilder
       def html
         return nil unless object_has_errors?
 
-        @builder.content_tag('div', class: 'govuk-error-summary', **error_summary_attributes) do
+        @builder.content_tag('div', class: summary_class, **error_summary_attributes) do
           @builder.safe_join(
             [
-              @builder.tag.h2(@title, id: error_summary_title_id, class: 'govuk-error-summary__title'),
-              @builder.content_tag('div', class: 'govuk-error-summary__body') do
-                @builder.content_tag('ul', class: 'govuk-list govuk-error-summary__list') do
+              @builder.tag.h2(@title, id: error_summary_title_id, class: summary_class('title')),
+              @builder.content_tag('div', class: summary_class('body')) do
+                @builder.content_tag('ul', class: ['govuk-list', summary_class('list')]) do
                   @builder.safe_join(
                     @builder.object.errors.messages.map do |attribute, messages|
                       error_list_item(attribute, messages)
@@ -32,15 +32,30 @@ module GOVUKDesignSystemFormBuilder
 
       def error_list_item(attribute, messages)
         @builder.content_tag('li') do
-          @builder.tag.a(
+          @builder.link_to(
             messages.join(', '),
-            href: ['#', error_id(attribute)].join
+            same_page_link(field_id(attribute)),
+            data: {
+              turbolinks: false
+            }
           )
         end
       end
 
-      def error_id(attribute)
-        build_id('error', override_attribute_name: attribute)
+      def same_page_link(target)
+        '#'.concat(target)
+      end
+
+      def summary_class(part = nil)
+        if part
+          'govuk-error-summary'.concat('__', part)
+        else
+          'govuk-error-summary'
+        end
+      end
+
+      def field_id(attribute)
+        build_id('field-error', attribute_name: attribute)
       end
 
       def error_summary_title_id