govuk_design_system_formbuilder 0.7.9 → 0.7.10

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -0,0 +1,40 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class File < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, **extra_args)
+        super(builder, object_name, attribute_name)
+
+        @label      = label
+        @hint_text  = hint_text
+        @extra_args = extra_args
+      end
+
+      def html
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
+          @builder.safe_join(
+            [
+              label_element.html,
+              hint_element.html,
+              error_element.html,
+              @builder.file_field(
+                @attribute_name,
+                id: field_id(link_errors: true),
+                class: file_classes,
+                aria: { describedby: described_by(hint_element.hint_id, error_element.error_id) },
+                **@extra_args
+              )
+            ]
+          )
+        end
+      end
+
+    private
+
+      def file_classes
+        %w(govuk-file-upload).tap do |c|
+          c.push('govuk-file-upload--error') if has_errors?
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -11,7 +11,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        return nil unless @hint_text.present?
+        return nil if @hint_text.blank?
 
         @builder.tag.span(@hint_text, class: hint_classes, id: hint_id)
       end

data/lib/govuk_design_system_formbuilder/elements/input.rb

@@ -12,10 +12,6 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text)
-        label_element = Elements::Label.new(@builder, @object_name, @attribute_name, @label)
-        error_element = Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
-
         Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
           @builder.safe_join(
             [
@@ -25,13 +21,9 @@ module GOVUKDesignSystemFormBuilder
               @builder.send(
                 @builder_method,
                 @attribute_name,
+                id: field_id(link_errors: true),
                 class: input_classes,
-                aria: {
-                  describedby: [
-                    hint_element.hint_id,
-                    error_element.error_id
-                  ].compact.join(' ').presence
-                },
+                aria: { describedby: described_by(hint_element.hint_id, error_element.error_id) },
                 **@extra_args
               )
             ]
@@ -49,7 +41,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def width_classes
-        return unless @width.present?
+        return if @width.blank?
 
         case @width
           # fixed (character) widths
@@ -68,7 +60,7 @@ module GOVUKDesignSystemFormBuilder
         when 'one-third'      then 'govuk-!-width-one-third'
         when 'one-quarter'    then 'govuk-!-width-one-quarter'
 
-        else fail "invalid width #{@width}"
+        else fail(ArgumentError, "invalid width '#{@width}'")
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -1,29 +1,39 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Label < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, radio: false, checkbox: false)
+      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, radio: false, checkbox: false, tag: nil)
         super(builder, object_name, attribute_name)
 
         @text           = label_text(text)
-        @value          = value # used by attribute_descriptor
+        @value          = value # used by field_id
         @size_class     = label_size_class(size)
         @radio_class    = radio_class(radio)
         @checkbox_class = checkbox_class(checkbox)
+        @tag            = tag
       end
 
       def html
-        return nil unless @text.present?
+        return nil if @text.blank?
 
+        if @tag.present?
+          @builder.content_tag(@tag, class: 'govuk-label-wrapper') { build_label }
+        else
+          build_label
+        end
+      end
+
+    private
+
+      def build_label
         @builder.label(
           @attribute_name,
           @text,
           value: @value,
+          for: field_id,
           class: %w(govuk-label).push(@size_class, @weight_class, @radio_class, @checkbox_class).compact
         )
       end
 
-    private
-
       def label_text(option_text)
         [option_text, @value, @attribute_name.capitalize].compact.first
       end
@@ -44,7 +54,7 @@ module GOVUKDesignSystemFormBuilder
         when 's'       then "govuk-label--s"
         when nil       then nil
         else
-          fail "size must be either 'xl', 'l', 'm', 's' or nil"
+          fail "invalid size '#{size}', must be xl, l, m, s or nil"
         end
       end
     end

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

@@ -0,0 +1,55 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    module Radios
+      class Collection < GOVUKDesignSystemFormBuilder::Base
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint_text:, legend:, inline:, small:, &block)
+          super(builder, object_name, attribute_name)
+
+          @collection    = collection
+          @value_method  = value_method
+          @text_method   = text_method
+          @hint_method   = hint_method
+          @inline        = inline
+          @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::Radios.new(@builder, inline: @inline, small: @small).html do
+                    @builder.safe_join(build_collection)
+                  end
+                ]
+              )
+            end
+          end
+        end
+
+      private
+
+        def build_collection
+          @collection.map.with_index do |item, i|
+            Elements::Radios::CollectionRadioButton.new(
+              @builder,
+              @object_name,
+              @attribute_name,
+              item,
+              value_method: @value_method,
+              text_method: @text_method,
+              hint_method: @hint_method,
+              link_errors: has_errors? && i.zero?
+            ).html
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    module Radios
+      class CollectionRadioButton < Base
+        # @param link_errors [Boolean] used to control the id generated for radio buttons. The
+        #   error summary requires that the id of the first radio is linked-to from the corresponding
+        #   error message. As when the summary is built what happens later in the form is unknown, we
+        #   need to control this to ensure the link is generated correctly
+        def initialize(builder, object_name, attribute_name, item, value_method:, text_method:, hint_method:, link_errors: false)
+          super(builder, object_name, attribute_name)
+          @item        = item
+          @value       = item.send(value_method)
+          @text        = item.send(text_method)
+          @hint_text   = item.send(hint_method) if hint_method.present?
+          @link_errors = link_errors
+        end
+
+        def html
+          @builder.content_tag('div', class: 'govuk-radios__item') do
+            @builder.safe_join(
+              [
+                @builder.radio_button(
+                  @attribute_name,
+                  @value,
+                  id: field_id(link_errors: @link_errors),
+                  aria: { describedby: hint_id },
+                  class: %w(govuk-radios__input)
+                ),
+                label_element.html,
+                hint_element.html
+              ]
+            )
+          end
+        end
+
+      private
+
+        def hint_element
+          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, @value, radio: true)
+        end
+
+        def label_element
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, text: @text, value: @value, radio: true)
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/radios/{fieldset_radio.rb → fieldset_radio_button.rb}

@@ -1,13 +1,14 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
-      class FieldsetRadio < Base
-        def initialize(builder, object_name, attribute_name, value, label:, hint_text:, &block)
+      class FieldsetRadioButton < Base
+        def initialize(builder, object_name, attribute_name, value, label:, hint_text:, link_errors:, &block)
           super(builder, object_name, attribute_name)
 
-          @value     = value
-          @label     = label
-          @hint_text = hint_text
+          @value       = value
+          @label       = label
+          @hint_text   = hint_text
+          @link_errors = has_errors? && link_errors
 
           if block_given?
             @conditional_content = wrap_conditional(block)
@@ -20,8 +21,8 @@ module GOVUKDesignSystemFormBuilder
             @builder.safe_join(
               [
                 input,
-                Elements::Label.new(@builder, @object_name, @attribute_name, radio: true, value: @value, **@label).html,
-                Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, radio: true).html,
+                label_element.html,
+                hint_element.html,
                 @conditional_content
               ]
             )
@@ -30,11 +31,19 @@ module GOVUKDesignSystemFormBuilder
 
       private
 
+        def label_element
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, radio: true, value: @value, **@label)
+        end
+
+        def hint_element
+          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, radio: true)
+        end
+
         def input
           @builder.radio_button(
             @attribute_name,
             @value,
-            id: attribute_descriptor,
+            id: field_id(link_errors: @link_errors),
             aria: { describedby: hint_id },
             data: { 'aria-controls' => @conditional_id },
             class: %w(govuk-radios__input)

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -0,0 +1,51 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Select < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint_text:, label:, &block)
+        super(builder, object_name, attribute_name)
+
+        @collection    = collection
+        @value_method  = value_method
+        @text_method   = text_method
+        @options       = options
+        @html_options  = html_options
+        @label         = label
+        @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
+          @builder.safe_join([
+            label_element.html,
+            hint_element.html,
+            error_element.html,
+            @block_content,
+            @builder.collection_select(
+              @attribute_name,
+              @collection,
+              @value_method,
+              @text_method,
+              @options,
+              build_html_options(hint_element, error_element)
+            )
+          ])
+        end
+      end
+
+    private
+
+      def build_html_options(hint_element, error_element)
+        @html_options.deep_merge(
+          id: field_id(link_errors: true),
+          class: select_classes,
+          aria: { describedby: described_by(hint_element.hint_id, error_element.error_id) }
+        )
+      end
+
+      def select_classes
+        %w(govuk-select)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -16,7 +16,12 @@ module GOVUKDesignSystemFormBuilder
       def html
         @builder.content_tag('div', class: %w(govuk-form-group)) do
           @builder.safe_join([
-            @builder.submit(@text, class: submit_button_classes(@block_content.present?), **extra_args),
+            @builder.submit(@text, class: %w(govuk-button).push(
+              warning_class,
+              secondary_class,
+              padding_class(@block_content.present?)
+            ),
+            **extra_args),
             @block_content
           ])
         end
@@ -24,22 +29,25 @@ module GOVUKDesignSystemFormBuilder
 
     private
 
-      def submit_button_classes(content_present)
-        %w(govuk-button).tap do |classes|
-          classes.push('govuk-button--warning') if @warning
-          classes.push('govuk-button--secondary') if @secondary
+      def warning_class
+        'govuk-button--warning' if @warning
+      end
 
-          # NOTE only this input will receive a right margin, block
-          # contents must be addressed individually
-          classes.push('govuk-!-margin-right-1') if content_present
-        end
+      def secondary_class
+        'govuk-button--secondary' if @secondary
+      end
+
+      def padding_class(content_present)
+        'govuk-!-margin-right-1' if content_present
       end
 
       def extra_args
-        {}.tap do |ea|
-          ea[:data] = { 'prevent-double-click' => @prevent_double_click } if @prevent_double_click
-          ea[:formnovalidate] = !@validate
-        end
+        {
+          formnovalidate: !@validate,
+          data: {
+            'prevent-double-click' => @prevent_double_click
+          }.select { |_k, v| v.present? }
+        }
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/text_area.rb

@@ -13,24 +13,20 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text)
-        label_element = Elements::Label.new(@builder, @object_name, @attribute_name, @label)
-        error_element = Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
-
         Containers::CharacterCount.new(@builder, max_words: @max_words, max_chars: @max_chars, threshold: @threshold).html do
           Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
             @builder.safe_join(
               [
-                label_element.html,
-                hint_element.html,
-                error_element.html,
+                [label_element, hint_element, error_element].map(&:html),
                 @builder.text_area(
                   @attribute_name,
+                  id: field_id(link_errors: true),
                   class: govuk_textarea_classes,
+                  aria: { describedby: described_by(hint_element.hint_id, error_element.error_id) },
                   **@extra_args.merge(rows: @rows)
                 ),
                 character_count_info
-              ]
+              ].flatten.compact
             )
           end
         end

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '0.7.9'.freeze
+  VERSION = '0.7.10'.freeze
 end