govuk_design_system_formbuilder 1.2.0b4 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33e103d8be5763415d474e06b5ec369e41faa78736769dfdc361da38cfdc0b35
-  data.tar.gz: 46bb0c7084d3bc259715dc7e3ea94ffc53f3cc2347ad922657ee6f5182f404b5
+  metadata.gz: 5d0ec456d05c0f92a86c39b688f0ac2a498160f473002f2fb4004567f4b17496
+  data.tar.gz: 0aa054ef3feb33eaf5b402aaea08ab2942e9b9be6708f04de41c1255e455dc86
 SHA512:
-  metadata.gz: e6ad6b1bc1d47c5c5510e112a480fff9680d1dc8e64605524a2e63b67a72d1881227614970e61653d37782bff41f7ae1ca052ef67fbb3653ace5e24550e1afdd
-  data.tar.gz: 92f7169ebf567010c3114946b50677869ef5616e8f96c3542ea11739ea63e3516a1dba70d6fb8b2bfcffeaa2c86a8e5f039f51a0db2e8ac312e2d1185f215d82
+  metadata.gz: 8a79e3ac6187857d917f7eb253abfbb414b8ed44a3a4488a29f82052ca234daeba9f1926a0df12697544fa266420ebe8eba8ab26840fe8d371b713d82c2df312
+  data.tar.gz: 1334ddb5eb6a36dfbcd5b8f91b50548ecfac38481682e683aec5071d2f91b7577f3cadd532c8dd8c1b1c5dba34fa837479ef55d5f63669b15756159e5b9fb5aa

data/lib/govuk_design_system_formbuilder.rb

@@ -14,6 +14,9 @@ module GOVUKDesignSystemFormBuilder
   # * +:brand+ sets the value used to prefix all classes, used to allow the
   #   builder to be branded for alternative (similar) design systems.
   #
+  # * +:default_caption_size+ controls the default size of caption text.
+  #   Can be either +xl+, +l+ or +m+.
+  #
   # * +:default_legend_size+ controls the default size of legend text.
   #   Can be either +xl+, +l+, +m+ or +s+.
   #
@@ -45,6 +48,7 @@ module GOVUKDesignSystemFormBuilder
 
     default_legend_size: 'm',
     default_legend_tag: 'h1',
+    default_caption_size: 'm',
     default_submit_button_text: 'Continue',
     default_radio_divider_text: 'or',
     default_error_summary_title: 'There is a problem',

data/lib/govuk_design_system_formbuilder/base.rb

@@ -18,6 +18,11 @@ module GOVUKDesignSystemFormBuilder
       @block_content  = capture { block.call } if block_given?
     end
 
+    # objects that implement #to_s can be passed directly into #safe_join
+    def to_s
+      html || ''
+    end
+
   private
 
     def brand(override = nil)

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -312,7 +312,10 @@ module GOVUKDesignSystemFormBuilder
     # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
     # @option label hidden [Boolean] control the visability of the label. Hidden labels will stil be read by screenreaders
+    # @param options [Hash] Options hash passed through to Rails' +collection_select+ helper
+    # @param html_options [Hash] HTML Options hash passed through to Rails' +collection_select+ helper
     # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
+    # @see https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_select Rails collection_select (called by govuk_collection_select)
     # @return [ActiveSupport::SafeBuffer] HTML output
     #
     # @example A select box with hint
@@ -677,14 +680,13 @@ module GOVUKDesignSystemFormBuilder
     # @param text [String] the button text
     # @param warning [Boolean] makes the button red ({https://design-system.service.gov.uk/components/button/#warning-buttons warning}) when true
     # @param secondary [Boolean] makes the button grey ({https://design-system.service.gov.uk/components/button/#secondary-buttons secondary}) when true
-    # @todo The GOV.UK design system also supports {https://design-system.service.gov.uk/components/button/#disabled-buttons disabled buttons}, they
-    #   should probably be supported too
     # @param classes [String] Classes to add to the submit button
     # @param prevent_double_click [Boolean] adds JavaScript to safeguard the
     #   form from being submitted more than once
     # @param validate [Boolean] adds the formnovalidate to the submit button when true, this disables all
     #   client-side validation provided by the browser. This is to provide a more consistent and accessible user
     #   experience
+    # @param disabled [Boolean] makes the button disabled when true
     # @param block [Block] Any supplied HTML will be inserted immediately after
     #   the submit button. It is intended for other buttons directly related to
     #   the form's operation, such as 'Cancel' or 'Safe draft'
@@ -699,8 +701,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_submit "Proceed", prevent_double_click: true do
     #     = link_to 'Cancel', some_other_path, class: 'govuk-button__secondary'
     #
-    def govuk_submit(text = config.default_submit_button_text, warning: false, secondary: false, classes: nil, prevent_double_click: true, validate: false, &block)
-      Elements::Submit.new(self, text, warning: warning, secondary: secondary, classes: classes, prevent_double_click: prevent_double_click, validate: validate, &block).html
+    def govuk_submit(text = config.default_submit_button_text, warning: false, secondary: false, classes: nil, prevent_double_click: true, validate: false, disabled: false, &block)
+      Elements::Submit.new(self, text, warning: warning, secondary: secondary, classes: classes, prevent_double_click: prevent_double_click, validate: validate, disabled: disabled, &block).html
     end
 
     # Generates three inputs for the +day+, +month+ and +year+ components of a date

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: %(#{brand}-character-count),
-          data: { module: %(#{brand}-character-count) }.merge(**limit, **threshold).compact
-        ) do
-          yield
-        end
+        content_tag('div', **character_count_options) { yield }
       end
 
     private
 
+      def character_count_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

@@ -10,13 +10,20 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        content_tag('div', class: check_boxes_classes, data: { module: %(#{brand}-checkboxes) }) do
+        content_tag('div', **check_boxes_options) do
           yield
         end
       end
 
     private
 
+      def check_boxes_options
+        {
+          class: check_boxes_classes,
+          data: { module: %(#{brand}-checkboxes) }
+        }
+      end
+
       def check_boxes_classes
         %w(checkboxes).prefix(brand).tap do |c|
           c.push(%(#{brand}-checkboxes--small)) if @small

data/lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb

@@ -17,19 +17,27 @@ module GOVUKDesignSystemFormBuilder
 
       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::CheckBoxes.new(@builder, small: @small, classes: @classes).html do
-                  @block_content
-                end
-              ]
-            )
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
+            safe_join([hint_element, error_element, checkboxes])
           end
         end
       end
+
+    private
+
+      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

@@ -26,40 +26,50 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        content_tag('fieldset', class: fieldset_classes, aria: { describedby: @described_by }) do
-          safe_join([legend_content, (@block_content || yield)])
+        content_tag('fieldset', **fieldset_options) do
+          safe_join([legend, (@block_content || yield)])
         end
       end
 
     private
 
-      def legend_content
-        @legend_raw || build_legend
+      def fieldset_options
+        {
+          class: fieldset_classes,
+          aria: { describedby: @described_by }
+        }
+      end
+
+      def fieldset_classes
+        %w(fieldset).prefix(brand)
       end
 
-      def build_legend
+      def legend
+        @legend_raw || legend_content
+      end
+
+      def legend_content
         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])
+              safe_join([caption_element, legend_text])
             end
           end
         end
       end
 
       def legend_text
-        [@legend_options.dig(:text), localised_text(:legend)].compact.first
+        @legend_options.dig(:text) || localised_text(:legend)
       end
 
-      def fieldset_classes
-        %w(fieldset).prefix(brand)
+      def legend_size
+        @legend_options.dig(:size).tap do |size|
+          fail "invalid size '#{size}', must be #{LEGEND_SIZES.join(', ')}" unless size.in?(LEGEND_SIZES)
+        end
       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|
+        [%(fieldset__legend), %(fieldset__legend--#{legend_size})].prefix(brand).tap do |classes|
           classes.push(%(#{brand}-visually-hidden)) if @legend_options.dig(:hidden)
         end
       end

data/lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb

@@ -18,19 +18,27 @@ module GOVUKDesignSystemFormBuilder
 
       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::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

@@ -13,13 +13,20 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        content_tag('div', class: radios_classes, data: { module: %(#{brand}-radios) }) do
+        content_tag('div', **radios_options) do
           yield
         end
       end
 
     private
 
+      def radios_options
+        {
+          class: radios_classes,
+          data: { module: %(#{brand}-radios) }
+        }
+      end
+
       def radios_classes
         %w(radios).prefix(brand).tap do |c|
           c.push(%(#{brand}-radios--inline)) if @inline

data/lib/govuk_design_system_formbuilder/containers/supplemental.rb

@@ -10,9 +10,7 @@ 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
 
       def supplemental_id

data/lib/govuk_design_system_formbuilder/elements/caption.rb

@@ -3,7 +3,7 @@ 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)
@@ -21,7 +21,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def caption_size_class(size)
-        case 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

@@ -22,23 +22,28 @@ module GOVUKDesignSystemFormBuilder
 
         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::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 +52,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(**check_box_options)
+        end
+
+        def check_box_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,37 @@ 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([check_box, @conditional_content])
         end
 
       private
 
+        def check_box
+          content_tag('div', class: %(#{brand}-checkboxes__item)) do
+            safe_join([input, label_element, hint_element])
+          end
+        end
+
         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
-          )
+          @builder.check_box(@attribute_name, input_options, @value, false)
+        end
+
+        def input_options
+          {
+            id: field_id(link_errors: @link_errors),
+            class: check_box_classes,
+            multiple: @multiple,
+            aria: { describedby: hint_id },
+            data: { 'aria-controls' => @conditional_id }
+          }
         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