govuk_design_system_formbuilder 2.0.0 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f87c2ecd9fbd0615a3061159d7e87b42254115db22f59c260a6e4209f7ff742d
-  data.tar.gz: a167bde412b2158d9ed303af32e730d5ae27876b1ac4ee80d675b9bc81d15126
+  metadata.gz: 2b243fcaf512a7b1edd2455a06cb36368db533c9aa76661fc907d8725a916ecc
+  data.tar.gz: 2ac392952f097e0730dc1d10b4b159d273a17335682ddcf8c8a5d589c7d0e53f
 SHA512:
-  metadata.gz: 4d184b3fa9ed93c35ea9ef15a72bf79f3520632fd3f501d93cc089a2e4b4e73fb73c2078083a9e0785f812802f2b406c972b568033148c9875bf1c4906ee9122
-  data.tar.gz: 3462d38207e9220b41bc3bc899d5218bc9ef982e609e2c96f58abbe0d8d20d9e9bd515b1be4566f77b37a4b543e0929a02fd9fa18bb0001815067aa0e6b07ea9
+  metadata.gz: b4ff3afdcc29348497365e6e04f4a2848c9db92e57fe6db4098a011d5cefd00e3f0a6e38240e7eb4b5776b79a29f36f64785bbfdeb0181b9efed8d5c46813359
+  data.tar.gz: 28c9f927dbfbe0b7176184ececf28c6de7ad229613728f7e57d5aed9d5f93c2d49d2d81ff474bad47a809a85dd847a4658d0af9695cdfa5a10a9705272ed926c

data/lib/govuk_design_system_formbuilder.rb

@@ -21,7 +21,7 @@ module GOVUKDesignSystemFormBuilder
   #   Can be either +xl+, +l+, +m+ or +s+.
   #
   # * +:default_legend_tag+ controls the default tag that legends are
-  #   wrapped in. Defaults to +h1+.
+  #   wrapped in. Defaults to +nil+.
   #
   # * +:default_submit_button_text+ sets the value assigned to +govuk_submit+,
   #   defaults to 'Continue'.
@@ -47,7 +47,7 @@ module GOVUKDesignSystemFormBuilder
     brand: 'govuk',
 
     default_legend_size: 'm',
-    default_legend_tag: 'h1',
+    default_legend_tag: nil,
     default_caption_size: 'm',
     default_submit_button_text: 'Continue',
     default_radio_divider_text: 'or',

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -459,7 +459,7 @@ module GOVUKDesignSystemFormBuilder
     # @param classes [Array,String] Classes to add to the radio button container.
     # @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+
+    # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+.
     # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @option legend kwargs [Hash] additional arguments are applied as attributes on the +legend+ element
     # @param caption [Hash] configures or sets the caption content which is inserted above the legend
@@ -538,7 +538,7 @@ module GOVUKDesignSystemFormBuilder
     # @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+
+    # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+.
     # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @option legend kwargs [Hash] additional arguments are applied as attributes on the +legend+ element
     # @param caption [Hash] configures or sets the caption content which is inserted above the legend
@@ -635,7 +635,7 @@ module GOVUKDesignSystemFormBuilder
     # @param legend [NilClass,Hash,Proc] options for configuring the legend. Legend will be omitted if +nil+.
     # @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+
+    # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+.
     # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @param caption [Hash] configures or sets the caption content which is inserted above the legend
     # @option caption text [String] the caption text
@@ -713,7 +713,7 @@ module GOVUKDesignSystemFormBuilder
     # @param legend [NilClass,Hash,Proc] options for configuring the legend. Legend will be omitted if +nil+.
     # @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+
+    # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+.
     # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @option legend kwargs [Hash] additional arguments are applied as attributes on the +legend+ element
     # @param caption [Hash] configures or sets the caption content which is inserted above the legend
@@ -816,6 +816,8 @@ module GOVUKDesignSystemFormBuilder
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @note Only the first additional button or link (passed in via a block) will be given the
     #   correct left margin, subsequent buttons will need to be manually accounted for
+    # @note This helper always renders an +<input type='submit'>+ tag, HTML content is not supported inside. You
+    #   can place +<button>+ tags inside the form to have the same effect
     # @see https://design-system.service.gov.uk/components/button/#stop-users-from-accidentally-sending-information-more-than-once
     #   GOV.UK double click prevention
     #
@@ -840,7 +842,7 @@ module GOVUKDesignSystemFormBuilder
     # @param legend [NilClass,Hash,Proc] options for configuring the legend. Legend will be omitted if +nil+.
     # @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+
+    # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+.
     # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @option legend kwargs [Hash] additional arguments are applied as attributes on the +legend+ element
     # @param caption [Hash] configures or sets the caption content which is inserted above the legend
@@ -878,13 +880,18 @@ module GOVUKDesignSystemFormBuilder
     # part of the form that contains the error
     #
     # @param title [String] the error summary heading
+    # @param link_base_errors_to [Symbol,String] set the field that errors on +:base+ are linked
+    #   to, as there won't be a field representing the object base.
+    #
+    # @note Only the first error in the +#errors+ array for each attribute will
+    #   be included.
     #
     # @example An error summary with a custom title
     #   = f.govuk_error_summary 'Uh-oh, spaghettios'
     #
     # @see https://design-system.service.gov.uk/components/error-summary/ GOV.UK error summary
-    def govuk_error_summary(title = config.default_error_summary_title)
-      Elements::ErrorSummary.new(self, object_name, title).html
+    def govuk_error_summary(title = config.default_error_summary_title, link_base_errors_to: nil)
+      Elements::ErrorSummary.new(self, object_name, title, link_base_errors_to: link_base_errors_to).html
     end
 
     # Generates a fieldset containing the contents of the block
@@ -893,7 +900,7 @@ module GOVUKDesignSystemFormBuilder
     # @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+
+    # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+.
     # @option legend hidden [Boolean] control the visibility of the legend. Hidden legends will still be read by screenreaders
     # @option legend kwargs [Hash] additional arguments are applied as attributes on the +legend+ element
     # @param caption [Hash] configures or sets the caption content which is inserted above the label
@@ -902,13 +909,13 @@ module GOVUKDesignSystemFormBuilder
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
     #
     # @example A fieldset containing address fields
-    #   = f.govuk_fieldset legend: { text: 'Address' }
+    #   = f.govuk_fieldset legend: { text: 'Address' } do
     #     = f.govuk_text_field :street
     #     = f.govuk_text_field :town
     #     = f.govuk_text_field :city
     #
     # @example A fieldset with the legend as a proc
-    #   = f.govuk_fieldset legend: -> { tag.h3('Skills') }
+    #   = f.govuk_fieldset legend: -> { tag.h3('Skills') } do
     #     = f.govuk_text_area :physical
     #     = f.govuk_text_area :mental
     #

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -30,11 +30,22 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def legend_element
-        @legend_element ||= Elements::Legend.new(@builder, @object_name, @attribute_name, **legend_options)
+        @legend_element ||= if @legend.nil?
+                              Elements::Null.new
+                            else
+                              Elements::Legend.new(@builder, @object_name, @attribute_name, **legend_options)
+                            end
       end
 
       def legend_options
-        { legend: @legend, caption: @caption }
+        case @legend
+        when Hash
+          @legend.merge(caption: @caption)
+        when Proc
+          { content: @legend }
+        else
+          fail(ArgumentError, %(legend must be a Proc or Hash))
+        end
       end
     end
   end

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

@@ -6,6 +6,7 @@ module GOVUKDesignSystemFormBuilder
 
         include Traits::Label
         include Traits::Hint
+        include Traits::FieldsetItem
         include Traits::Conditional
 
         def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, &block)
@@ -54,19 +55,7 @@ module GOVUKDesignSystemFormBuilder
           %w(checkboxes__input).prefix(brand)
         end
 
-        def label_element
-          @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
-          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
-        end
-
-        def hint_options
+        def fieldset_options
           { checkbox: true }
         end
 

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -3,10 +3,11 @@ module GOVUKDesignSystemFormBuilder
     class ErrorSummary < Base
       include Traits::Error
 
-      def initialize(builder, object_name, title)
-        @builder = builder
-        @object_name = object_name
-        @title = title
+      def initialize(builder, object_name, title, link_base_errors_to:)
+        @builder             = builder
+        @object_name         = object_name
+        @title               = title
+        @link_base_errors_to = link_base_errors_to
       end
 
       def html
@@ -54,7 +55,11 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def field_id(attribute)
-        build_id('field-error', attribute_name: attribute)
+        if attribute.eql?(:base) && @link_base_errors_to.present?
+          build_id('field', attribute_name: @link_base_errors_to)
+        else
+          build_id('field-error', attribute_name: attribute)
+        end
       end
 
       def summary_title_id

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -25,7 +25,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        return nil unless active?
+        return unless active?
 
         content_tag(hint_tag, **hint_options, **@html_attributes) { hint_body }
       end

data/lib/govuk_design_system_formbuilder/elements/legend.rb

@@ -4,46 +4,45 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Caption
       include Traits::Localisation
 
-      def initialize(builder, object_name, attribute_name, legend:, caption:, **kwargs)
+      def initialize(builder, object_name, attribute_name, text: nil, size: config.default_legend_size, hidden: false, tag: config.default_legend_tag, caption: nil, content: nil, **kwargs)
         super(builder, object_name, attribute_name)
 
-        @html_attributes = kwargs
-
-        case legend
-        when NilClass
-          @active = false
-        when Proc
-          @raw = capture { legend.call }
-        when Hash
-          defaults.merge(legend).tap do |l|
-            @text    = retrieve_text(l.dig(:text))
-            @hidden  = l.dig(:hidden)
-            @tag     = l.dig(:tag)
-            @size    = l.dig(:size)
-            @caption = caption
-          end
+        if content
+          @content = capture { content.call }
         else
-          fail(ArgumentError, %(legend must be a Proc or Hash))
+          @text            = retrieve_text(text)
+          @tag             = tag
+          @size_class      = size_class(size)
+          @tag             = tag
+          @caption         = caption
+          @hidden          = hidden
+          @html_attributes = kwargs
         end
       end
 
       def html
-        @raw || content
+        @content || legend
       end
 
     private
 
       def active?
-        [@text, @raw].any?(&:present?)
+        [@text, @content].any?(&:present?)
+      end
+
+      def legend
+        return unless active?
+
+        tag.legend(legend_content, class: classes, **@html_attributes)
       end
 
-      def content
-        return nil unless active?
+      def legend_content
+        caption_and_text = safe_join([caption_element, @text])
 
-        tag.legend(class: classes, **@html_attributes) do
-          content_tag(@tag, class: heading_classes) do
-            safe_join([caption_element, @text])
-          end
+        if @tag.present?
+          content_tag(@tag, class: heading_classes) { caption_and_text }
+        else
+          caption_and_text
         end
       end
 
@@ -52,17 +51,14 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def classes
-        [%(#{brand}-fieldset__legend), size_class, visually_hidden_class].compact
+        [%(#{brand}-fieldset__legend), @size_class, visually_hidden_class].compact
       end
 
-      def size_class
-        case @size
-        when 'xl' then %(#{brand}-fieldset__legend--xl)
-        when 'l'  then %(#{brand}-fieldset__legend--l)
-        when 'm'  then %(#{brand}-fieldset__legend--m)
-        when 's'  then %(#{brand}-fieldset__legend--s)
+      def size_class(size)
+        if size.in?(%w(xl l m s))
+          %(#{brand}-fieldset__legend--#{size})
         else
-          fail "invalid size '#{@size}', must be xl, l, m or s"
+          fail "invalid size '#{size}', must be xl, l, m or s"
         end
       end
 
@@ -73,15 +69,6 @@ module GOVUKDesignSystemFormBuilder
       def heading_classes
         %(#{brand}-fieldset__heading)
       end
-
-      def defaults
-        {
-          hidden: false,
-          text: nil,
-          tag:  config.default_legend_tag,
-          size: config.default_legend_size
-        }
-      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/elements/null.rb

@@ -0,0 +1,19 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Null < Base
+      def initialize; end
+
+      def html
+        nil
+      end
+
+      def active?
+        false
+      end
+
+      def hint_id
+        nil
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ module GOVUKDesignSystemFormBuilder
 
         include Traits::Label
         include Traits::Hint
+        include Traits::FieldsetItem
         include Traits::Conditional
 
         def initialize(builder, object_name, attribute_name, value, label:, hint:, link_errors:, &block)
@@ -34,26 +35,10 @@ module GOVUKDesignSystemFormBuilder
           end
         end
 
-        def radio_options
+        def fieldset_options
           { radio: true }
         end
 
-        def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **label_content, **label_options)
-        end
-
-        def label_options
-          { value: @value, link_errors: @link_errors }.merge(radio_options)
-        end
-
-        def hint_element
-          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
-        end
-
-        def hint_options
-          { value: @value }.merge(radio_options)
-        end
-
         def input
           @builder.radio_button(@attribute_name, @value, **options)
         end

data/lib/govuk_design_system_formbuilder/traits/caption.rb

@@ -4,11 +4,11 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def caption_element
-        @caption_element ||= Elements::Caption.new(@builder, @object_name, @attribute_name, **caption_options)
-      end
-
-      def caption_options
-        @caption
+        @caption_element ||= if @caption.nil?
+                               Elements::Null.new
+                             else
+                               Elements::Caption.new(@builder, @object_name, @attribute_name, **@caption)
+                             end
       end
     end
   end

data/lib/govuk_design_system_formbuilder/traits/fieldset_item.rb

@@ -0,0 +1,31 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module FieldsetItem
+    private
+
+      def label_element
+        @label_element ||= if @label.nil?
+                             Elements::Null.new
+                           else
+                             Elements::Label.new(@builder, @object_name, @attribute_name, **label_content, **label_options)
+                           end
+      end
+
+      def label_options
+        { value: @value, link_errors: @link_errors }.merge(fieldset_options)
+      end
+
+      def hint_element
+        @hint_element ||= if @hint.nil?
+                            Elements::Null.new
+                          else
+                            Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
+                          end
+      end
+
+      def hint_options
+        { value: @value }.merge(fieldset_options)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/hint.rb

@@ -10,13 +10,15 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def hint_element
-        @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_content)
+        @hint_element ||= if @hint.nil?
+                            Elements::Null.new
+                          else
+                            Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_content)
+                          end
       end
 
       def hint_content
         case @hint
-        when NilClass
-          {}
         when Hash
           @hint
         when Proc

data/lib/govuk_design_system_formbuilder/traits/label.rb

@@ -4,7 +4,11 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def label_element
-        @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, caption: @caption, **label_content)
+        @label_element ||= if @label.nil?
+                             Elements::Null.new
+                           else
+                             Elements::Label.new(@builder, @object_name, @attribute_name, caption: @caption, **label_content)
+                           end
       end
 
       def label_content

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.4
 platform: ruby
 authors:
 - Peter Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-27 00:00:00.000000000 Z
+date: 2020-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.17.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.17.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -176,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.22.0
+        version: 3.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.22.0
+        version: 3.24.0
 - !ruby/object:Gem::Dependency
   name: rubypants
   requirement: !ruby/object:Gem::Requirement
@@ -278,6 +278,7 @@ files:
 - lib/govuk_design_system_formbuilder/elements/inputs/url.rb
 - lib/govuk_design_system_formbuilder/elements/label.rb
 - lib/govuk_design_system_formbuilder/elements/legend.rb
+- lib/govuk_design_system_formbuilder/elements/null.rb
 - lib/govuk_design_system_formbuilder/elements/radios/collection.rb
 - lib/govuk_design_system_formbuilder/elements/radios/collection_radio_button.rb
 - lib/govuk_design_system_formbuilder/elements/radios/fieldset_radio_button.rb
@@ -288,6 +289,7 @@ files:
 - lib/govuk_design_system_formbuilder/traits/collection_item.rb
 - lib/govuk_design_system_formbuilder/traits/conditional.rb
 - lib/govuk_design_system_formbuilder/traits/error.rb
+- lib/govuk_design_system_formbuilder/traits/fieldset_item.rb
 - lib/govuk_design_system_formbuilder/traits/hint.rb
 - lib/govuk_design_system_formbuilder/traits/input.rb
 - lib/govuk_design_system_formbuilder/traits/label.rb