govuk_design_system_formbuilder 0.7.8 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 565cc7ff4c3fb10dc379619a8e38f1f752e3b91c519211755445c6bf35460d33
-  data.tar.gz: ed70e2d57585104bc397a61ab41ef784cad77f43629b913aee8c8c9bd0c48e1e
+  metadata.gz: 4a58527f914ed7e0cef5f178663fd7969e4fd2cc0b6fa631f0c6e370aac3430e
+  data.tar.gz: 93c8461e3a90d144f477a1fa79b8082c8679d34aa0a2473f89ea693a01836c8a
 SHA512:
-  metadata.gz: '08b4fea1733ea6f2fdfc21c20cf440329853c9f7fc417b22fd57581cfb810b55a4c5598061a2188315efb9360e365fb1002bfd9da6c9e8c3540e2c90decf611c'
-  data.tar.gz: 8f4edf90bb37402b2d26ac0a47e8983227ccde0130a5cd23b0f19faa620a9b1ab6eed8b6f7f5231604797e402ac74f36008cd0e2c3c9e26de47014757ddbd4b8
+  metadata.gz: ffdbdd1aae03e6514927a6daeecc215e70b3bfd653491860b4ce148359689ae00d90cb35aa529b53016a64c89d8e84fe0678335b47055dad7089b930304f6ac6
+  data.tar.gz: ce348d7c0a8cc1aee7dda9297b64a3389e6d7d136ba422f54e155d7e14786634b591de980744f68f04d1c20971026dffd94c16931aab24fbcb87e7fa96174987

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -8,8 +8,7 @@ module GOVUKDesignSystemFormBuilder
     #   or +one-quarter+, +one-third+, +one-half+, +two-thirds+ or +full+ width of the container
     # @param [Hash] label configures the associated label
     # @option label text [String] the label text
-    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
-    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @option args [Hash] args additional arguments are applied as attributes to +input+ element
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -32,8 +31,7 @@ module GOVUKDesignSystemFormBuilder
     #   or +one-quarter+, +one-third+, +one-half+, +two-thirds+ or +full+ width of the container
     # @param [Hash] label configures the associated label
     # @option label text [String] the label text
-    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
-    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @option args [Hash] args additional arguments are applied as attributes to +input+ element
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -57,8 +55,7 @@ module GOVUKDesignSystemFormBuilder
     #   or +one-quarter+, +one-third+, +one-half+, +two-thirds+ or +full+ width of the container
     # @param [Hash] label configures the associated label
     # @option label text [String] the label text
-    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
-    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @option args [Hash] args additional arguments are applied as attributes to +input+ element
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -80,8 +77,7 @@ module GOVUKDesignSystemFormBuilder
     #   or +one-quarter+, +one-third+, +one-half+, +two-thirds+ or +full+ width of the container
     # @param [Hash] label configures the associated label
     # @option label text [String] the label text
-    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
-    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @option args [Hash] args additional arguments are applied as attributes to +input+ element
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -103,8 +99,7 @@ module GOVUKDesignSystemFormBuilder
     #   or +one-quarter+, +one-third+, +one-half+, +two-thirds+ or +full+ width of the container
     # @param [Hash] label configures the associated label
     # @option label text [String] the label text
-    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
-    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @option args [Hash] args additional arguments are applied as attributes to the +input+ element
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
@@ -128,8 +123,7 @@ module GOVUKDesignSystemFormBuilder
     # @param hint_text [String] The content of the hint. No hint will be injected if left +nil+
     # @param [Hash] label configures the associated label
     # @option label text [String] the label text
-    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
-    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @param max_words [Integer] adds the GOV.UK max word count
     # @param max_chars [Integer] adds the GOV.UK max characters count
     # @param threshold [Integer] only show the +max_words+ and +max_chars+ warnings once a threshold (percentage) is reached
@@ -157,8 +151,7 @@ module GOVUKDesignSystemFormBuilder
     # @param text_method [Symbol] The method called against each member of the collection to provide the text
     # @param hint_text [String] The content of the hint. No hint will be injected if left +nil+
     # @option label text [String] the label text
-    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
-    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @return [ActiveSupport::SafeBuffer] HTML output
     def govuk_collection_select(attribute_name, collection, value_method, text_method, options: {}, html_options: { class: 'govuk-select' }, hint_text: nil, label: {})
       label_element = Elements::Label.new(self, object_name, attribute_name, label)
@@ -205,6 +198,7 @@ module GOVUKDesignSystemFormBuilder
     # @param hint_text [String] The content of the fieldset hint. No hint will be injected if left +nil+
     # @param legend [Hash] options for configuring the hash
     # @param inline [Boolean] controls whether the radio buttons are displayed inline or not
+    # @param small [Boolean] controls whether small radio buttons are used instead of regular-sized ones
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+, defaults to +h1+
@@ -225,7 +219,7 @@ module GOVUKDesignSystemFormBuilder
     #    legend: { text: 'Pick your favourite colour', size: 'm' },
     #    hint_text: 'If you cannot find the exact match choose something close',
     #    inline: false
-    def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method, hint_method = nil, hint_text: nil, legend: { text: nil, size: 'm' }, inline: false)
+    def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method, hint_method = nil, hint_text: nil, legend: { text: nil, size: 'm' }, inline: false, small: false)
       hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint_text)
       error_element = Elements::ErrorMessage.new(self, object_name, attribute_name)
 
@@ -237,7 +231,7 @@ module GOVUKDesignSystemFormBuilder
               error_element.html,
 
               (yield if block_given?),
-              Containers::Radios.new(self, inline: inline).html do
+              Containers::Radios.new(self, inline: inline, small: small).html do
                 safe_join(
                   collection.map do |item|
                     Elements::Radios::CollectionRadio.new(self, object_name, attribute_name, item, value_method, text_method, hint_method).html
@@ -258,6 +252,7 @@ module GOVUKDesignSystemFormBuilder
     # @param hint_text [String] The content of the fieldset hint. No hint will be injected if left +nil+
     # @param legend [Hash] options for configuring the hash
     # @param inline [Boolean] controls whether the radio buttons are displayed inline or not
+    # @param small [Boolean] controls whether small radio buttons are used instead of regular-sized ones
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+
@@ -272,7 +267,7 @@ module GOVUKDesignSystemFormBuilder
     #    = f.govuk_radio_divider
     #    = f.govuk_radio_button :favourite_colour, :yellow, label: { text: 'Yellow' }
     #
-    def govuk_radio_buttons_fieldset(attribute_name, inline: false, hint_text: nil, legend: {})
+    def govuk_radio_buttons_fieldset(attribute_name, hint_text: nil, legend: {}, inline: false, small: false)
       hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint_text)
       error_element = Elements::ErrorMessage.new(self, object_name, attribute_name)
 
@@ -281,7 +276,7 @@ module GOVUKDesignSystemFormBuilder
           safe_join([
             hint_element.html,
             error_element.html,
-            Containers::Radios.new(self, inline: inline).html do
+            Containers::Radios.new(self, inline: inline, small: small).html do
               yield
             end
           ])
@@ -331,6 +326,7 @@ module GOVUKDesignSystemFormBuilder
     # @param text_method [Symbol] The method called against each member of the collection to provide the text
     # @param hint_method [Symbol] The method called against each member of the collection to provide the hint text
     # @param hint_text [String] The content of the fieldset hint. No hint will be injected if left +nil+
+    # @param small [Boolean] controls whether small check boxes are used instead of regular-sized ones
     # @param legend [Hash] options for configuring the hash
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
@@ -353,7 +349,7 @@ module GOVUKDesignSystemFormBuilder
     #    legend: { text: 'What do you want in your sandwich?', size: 'm' },
     #    hint_text: "If it isn't listed here, tough luck",
     #    inline: false
-    def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil, hint_text: nil, legend: {}, &block)
+    def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil, hint_text: nil, legend: {}, small: false, &block)
       hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint_text)
       error_element = Elements::ErrorMessage.new(self, object_name, attribute_name)
 
@@ -364,8 +360,10 @@ module GOVUKDesignSystemFormBuilder
               hint_element.html,
               error_element.html,
               (block.call if block_given?),
-              collection_check_boxes(attribute_name, collection, value_method, text_method) do |check_box|
-                Elements::CheckBoxes::CollectionCheckBox.new(self, attribute_name, check_box, hint_method).html
+              Containers::CheckBoxes.new(self, small: small).html do
+                collection_check_boxes(attribute_name, collection, value_method, text_method) do |check_box|
+                  Elements::CheckBoxes::CollectionCheckBox.new(self, attribute_name, check_box, hint_method).html
+                end
               end
             ]
           )
@@ -382,6 +380,9 @@ module GOVUKDesignSystemFormBuilder
     #   should probably be supported too
     # @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 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'
@@ -448,6 +449,7 @@ module GOVUKDesignSystemFormBuilder
     # Generates a fieldset containing the contents of the block
     #
     # @param legend [Hash] options for configuring the hash
+    # @param described_by [Array<String>] the ids of the elements that describe this fieldset, usually hints and errors
     # @option legend text [String] the fieldset legend's text content
     # @option legend size [String] the size of the fieldset legend font, can be +xl+, +l+, +m+ or +s+
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+
@@ -460,8 +462,8 @@ module GOVUKDesignSystemFormBuilder
     #
     # @see https://design-system.service.gov.uk/components/fieldset/ GOV.UK fieldset
     # @return [ActiveSupport::SafeBuffer] HTML output
-    def govuk_fieldset(legend: { text: 'Fieldset heading' }, &block)
-      Containers::Fieldset.new(self, legend: legend).html(&block)
+    def govuk_fieldset(legend: { text: 'Fieldset heading' }, described_by: nil, &block)
+      Containers::Fieldset.new(self, legend: legend, described_by: described_by).html(&block)
     end
   end
 end

data/lib/govuk_design_system_formbuilder/containers/check_boxes.rb

@@ -1,15 +1,24 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class CheckBoxes < Base
-      def initialize(builder)
+      def initialize(builder, small:)
         @builder = builder
+        @small   = small
       end
 
       def html
-        @builder.content_tag('div', class: 'govuk-checkboxes', data: { module: 'checkboxes' }) do
+        @builder.content_tag('div', class: check_boxes_classes, data: { module: 'checkboxes' }) do
           yield
         end
       end
+
+    private
+
+      def check_boxes_classes
+        %w(govuk-checkboxes).tap do |c|
+          c.push('govuk-checkboxes--small') if @small
+        end
+      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -2,8 +2,6 @@ module GOVUKDesignSystemFormBuilder
   module Containers
     class Fieldset < GOVUKDesignSystemFormBuilder::Base
       LEGEND_DEFAULTS = { text: nil, tag: 'h1', size: 'xl' }.freeze
-
-      # FIXME standardise sizes with labels
       LEGEND_SIZES = %w(xl l m s).freeze
 
       def initialize(builder, legend: {}, described_by: nil)
@@ -49,7 +47,7 @@ module GOVUKDesignSystemFormBuilder
       def descriptors(described_by)
         return nil unless described_by.present?
 
-        Array.wrap(described_by).reject(&:blank?).join(' ')
+        described_by.compact.join(' ').presence
       end
     end
   end

data/lib/govuk_design_system_formbuilder/containers/radios.rb

@@ -1,9 +1,10 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
     class Radios < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, inline:)
+      def initialize(builder, inline:, small:)
         @builder = builder
-        @inline = inline
+        @inline  = inline
+        @small   = small
       end
 
       def html
@@ -17,6 +18,7 @@ module GOVUKDesignSystemFormBuilder
       def radios_classes
         %w(govuk-radios).tap do |c|
           c.push('govuk-radios--inline') if @inline
+          c.push('govuk-radios--small')  if @small
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -1,13 +1,12 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Label < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: 'regular', weight: 'regular', radio: false, checkbox: false)
+      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, radio: false, checkbox: false)
         super(builder, object_name, attribute_name)
 
         @text           = label_text(text)
         @value          = value # used by attribute_descriptor
         @size_class     = label_size_class(size)
-        @weight_class   = label_weight_class(weight)
         @radio_class    = radio_class(radio)
         @checkbox_class = checkbox_class(checkbox)
       end
@@ -39,21 +38,13 @@ module GOVUKDesignSystemFormBuilder
 
       def label_size_class(size)
         case size
-        when 'large'   then "govuk-!-font-size-48"
-        when 'medium'  then "govuk-!-font-size-36"
-        when 'small'   then "govuk-!-font-size-27"
-        when 'regular' then nil
+        when 'xl'      then "govuk-label--xl"
+        when 'l'       then "govuk-label--l"
+        when 'm'       then "govuk-label--m"
+        when 's'       then "govuk-label--s"
+        when nil       then nil
         else
-          fail 'size must be either large, medium, small or regular'
-        end
-      end
-
-      def label_weight_class(weight)
-        case weight
-        when 'bold'    then "govuk-!-font-weight-bold"
-        when 'regular' then nil
-        else
-          fail 'weight must be bold or regular'
+          fail "size must be either 'xl', 'l', 'm', 's' or nil"
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -38,7 +38,7 @@ module GOVUKDesignSystemFormBuilder
       def extra_args
         {}.tap do |ea|
           ea[:data] = { 'prevent-double-click' => @prevent_double_click } if @prevent_double_click
-          ea[:novalidate] = !@validate
+          ea[:formnovalidate] = !@validate
         end
       end
     end

data/lib/govuk_design_system_formbuilder/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
 platform: ruby
 authors:
 - Peter Yates