govuk_design_system_formbuilder 2.1.2 → 2.1.7b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fe5519859df526162a3594076aef6a37c0275990026f62fa1455b9918cea36c
-  data.tar.gz: 31ead896758013f7586eb0d4e98e533c6a2bb3da9470e5cd573db2d845755dc9
+  metadata.gz: 4e5e35ed528afbcc521f2ed397a640304289c5f6ae461aa751505a7385e6accd
+  data.tar.gz: 3931158ee0d6bc41043b994a086267e9fe6f4c57b5c46af72654f15c53e30a64
 SHA512:
-  metadata.gz: 05d32a227069f1adc8c64ba76e22d025629a419df6b714e369595342be29c8c5ac6547f39921fc62a78141dc6eda7d449c9c9335a01313661bb93602b2803203
-  data.tar.gz: cadc9b2ca35ffc8ac68cdb7a8c9f4bd4551e5ac8d8de5b2508f03a313069d60b89cb40a65a6e83cbd5a5b7eb834257ef0984d7901fa811e3ec23184a0cff998c
+  metadata.gz: e0dc849509abe135123504ae391255ad1a3cdf0578a1d11087bacccb411821b992b73c08324a5192f2ac1f7c47c6305c2071c9c7ad08ea667c31723c1b303ebb
+  data.tar.gz: 644b0092e9f5338e7f76a268f55272cc557733c474d91f5dc51f44051cdf0d6e4e4b492baa7d539f0c9788dd677d56c840787dcb37bfd882c1e53999877ecbdb

data/README.md

@@ -1,13 +1,13 @@
 # GOV.UK Design System Form Builder for Rails
 
-[![Build Status](https://travis-ci.com/DFE-Digital/govuk_design_system_formbuilder.svg?branch=master)](https://travis-ci.com/DFE-Digital/govuk_design_system_formbuilder)
+[![Tests](https://github.com/DFE-Digital/govuk_design_system_formbuilder/workflows/Testing/badge.svg)](https://github.com/DFE-Digital/govuk_design_system_formbuilder/actions)
 [![Maintainability](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/maintainability)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/maintainability)
 [![Gem Version](https://badge.fury.io/rb/govuk_design_system_formbuilder.svg)](https://badge.fury.io/rb/govuk_design_system_formbuilder)
 [![Gem](https://img.shields.io/gem/dt/govuk_design_system_formbuilder?logo=rubygems)](https://rubygems.org/gems/govuk_design_system_formbuilder)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/test_coverage)
 [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=DFE-Digital/govuk_design_system_formbuilder)](https://dependabot.com)
 [![GitHub license](https://img.shields.io/github/license/DFE-Digital/govuk_design_system_formbuilder)](https://github.com/DFE-Digital/govuk_design_system_formbuilder/blob/master/LICENSE)
-[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.9.1-brightgreen)](https://design-system.service.gov.uk)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.10.2-brightgreen)](https://design-system.service.gov.uk)
 
 This library provides an easy-to-use form builder for the [GOV.UK Design System](https://design-system.service.gov.uk/).
 

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -456,6 +456,7 @@ module GOVUKDesignSystemFormBuilder
     # @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
     # @param bold_labels [Boolean] controls whether the radio button labels are bold
+    # @param include_hidden [Boolean] controls whether a hidden field is inserted to allow for empty submissions
     # @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+
@@ -500,7 +501,7 @@ module GOVUKDesignSystemFormBuilder
     #    :name,
     #    legend: -> { tag.h3('Which category do you belong to?') }
     #
-    def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method = nil, hint_method = nil, hint: {}, legend: {}, caption: {}, inline: false, small: false, bold_labels: false, classes: nil, form_group: {}, &block)
+    def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method = nil, hint_method = nil, hint: {}, legend: {}, caption: {}, inline: false, small: false, bold_labels: false, classes: nil, include_hidden: false, form_group: {}, &block)
       Elements::Radios::Collection.new(
         self,
         object_name,
@@ -517,6 +518,7 @@ module GOVUKDesignSystemFormBuilder
         bold_labels: bold_labels,
         classes: classes,
         form_group: form_group,
+        include_hidden: include_hidden,
         &block
       ).html
     end
@@ -850,6 +852,7 @@ module GOVUKDesignSystemFormBuilder
     # @option caption size [String] the size of the caption, can be +xl+, +l+ or +m+. Defaults to +m+
     # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
     # @param omit_day [Boolean] do not render a day input, only capture month and year
+    # @param wildcards [Boolean] add an 'X' to the day and month patterns so users can add approximate dates
     # @param form_group [Hash] configures the form group
     # @option form_group classes [Array,String] sets the form group's classes
     # @option form_group kwargs [Hash] additional attributes added to the form group
@@ -872,8 +875,8 @@ module GOVUKDesignSystemFormBuilder
     # @example A date input with legend supplied as a proc
     #  = f.govuk_date_field :finishes_on,
     #    legend: -> { tag.h3('Which category do you belong to?') }
-    def govuk_date_field(attribute_name, hint: {}, legend: {}, caption: {}, date_of_birth: false, omit_day: false, form_group: {}, &block)
-      Elements::Date.new(self, object_name, attribute_name, hint: hint, legend: legend, caption: caption, date_of_birth: date_of_birth, omit_day: omit_day, form_group: form_group, &block).html
+    def govuk_date_field(attribute_name, hint: {}, legend: {}, caption: {}, date_of_birth: false, omit_day: false, form_group: {}, wildcards: false, &block)
+      Elements::Date.new(self, object_name, attribute_name, hint: hint, legend: legend, caption: caption, date_of_birth: date_of_birth, omit_day: omit_day, form_group: form_group, wildcards: wildcards, &block).html
     end
 
     # Generates a summary of errors in the form, each linking to the corresponding

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,20 +55,8 @@ 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
-          { value: @value, checkbox: true }
+        def fieldset_options
+          { checkbox: true }
         end
 
         def conditional_classes

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -9,7 +9,7 @@ module GOVUKDesignSystemFormBuilder
 
       SEGMENTS = { day: '3i', month: '2i', year: '1i' }.freeze
 
-      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, date_of_birth: false, omit_day:, form_group:, &block)
+      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, date_of_birth: false, omit_day:, form_group:, wildcards:, &block)
         super(builder, object_name, attribute_name, &block)
 
         @legend        = legend
@@ -18,6 +18,7 @@ module GOVUKDesignSystemFormBuilder
         @date_of_birth = date_of_birth
         @omit_day      = omit_day
         @form_group    = form_group
+        @wildcards     = wildcards
       end
 
       def html
@@ -82,13 +83,19 @@ module GOVUKDesignSystemFormBuilder
           class: classes(width),
           name: name(segment),
           type: 'text',
-          pattern: '[0-9]*',
+          pattern: pattern(segment),
           inputmode: 'numeric',
           value: value,
           autocomplete: date_of_birth_autocomplete_value(segment)
         )
       end
 
+      def pattern(segment)
+        return '[0-9X]*' if @wildcards && segment.in?(%i(day month))
+
+        '[0-9]*'
+      end
+
       def classes(width)
         %w(input date-input__input).prefix(brand).tap do |classes|
           classes.push(%(#{brand}-input--width-#{width}))

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,39 @@ 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
-          # do nothing
-        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 NilClass, 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 content
+      def legend
         return unless active?
 
-        tag.legend(legend_text, class: classes, **@html_attributes)
+        tag.legend(legend_content, class: classes, **@html_attributes)
       end
 
-      def legend_text
+      def legend_content
         caption_and_text = safe_join([caption_element, @text])
 
         if @tag.present?
@@ -58,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
 
@@ -79,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/collection.rb

@@ -6,27 +6,28 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Supplemental
 
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint:, legend:, caption:, inline:, small:, bold_labels:, classes:, form_group:, &block)
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint:, legend:, caption:, inline:, small:, bold_labels:, classes:, form_group:, include_hidden:, &block)
           super(builder, object_name, attribute_name, &block)
 
-          @collection   = collection
-          @value_method = value_method
-          @text_method  = text_method
-          @hint_method  = hint_method
-          @inline       = inline
-          @small        = small
-          @legend       = legend
-          @caption      = caption
-          @hint         = hint
-          @classes      = classes
-          @form_group   = form_group
-          @bold_labels  = hint_method.present? || bold_labels
+          @collection     = collection
+          @value_method   = value_method
+          @text_method    = text_method
+          @hint_method    = hint_method
+          @inline         = inline
+          @small          = small
+          @legend         = legend
+          @caption        = caption
+          @hint           = hint
+          @classes        = classes
+          @form_group     = form_group
+          @include_hidden = include_hidden
+          @bold_labels    = hint_method.present? || bold_labels
         end
 
         def html
           Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
             Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
-              safe_join([supplemental_content, hint_element, error_element, radios])
+              safe_join([hidden_field, supplemental_content, hint_element, error_element, radios])
             end
           end
         end
@@ -47,6 +48,12 @@ module GOVUKDesignSystemFormBuilder
           end
         end
 
+        def hidden_field
+          return unless @include_hidden
+
+          @builder.hidden_field(@attribute_name, value: "")
+        end
+
         def collection
           @collection.map.with_index do |item, i|
             Elements::Radios::CollectionRadioButton.new(@builder, @object_name, @attribute_name, item, **collection_options(i)).html

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.1.2'.freeze
+  VERSION = '2.1.7b1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.7b1
 platform: ruby
 authors:
 - Peter Yates
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2020-12-29 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.23.0
+        version: 3.25.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.23.0
+        version: 3.25.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
@@ -303,7 +305,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/govuk_design_system_formbuilder/GOVUKDesignSystemFormBuilder/Builder
   homepage_uri: https://govuk-form-builder.netlify.app
   source_code_uri: https://github.com/DFE-Digital/govuk_design_system_formbuilder
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -314,12 +316,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: GOV.UK-compliant Rails form builder
 test_files: []