govuk_design_system_formbuilder 2.1.7b1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e5e35ed528afbcc521f2ed397a640304289c5f6ae461aa751505a7385e6accd
-  data.tar.gz: 3931158ee0d6bc41043b994a086267e9fe6f4c57b5c46af72654f15c53e30a64
+  metadata.gz: 4be57c3d159d67c07fc56632dd6c212bb834c5272d6eb1697f17e269fabf185a
+  data.tar.gz: 8a9e652ad341513e78883fc5c68c3e704cb59cd3228bb7e5574c12f53735af72
 SHA512:
-  metadata.gz: e0dc849509abe135123504ae391255ad1a3cdf0578a1d11087bacccb411821b992b73c08324a5192f2ac1f7c47c6305c2071c9c7ad08ea667c31723c1b303ebb
-  data.tar.gz: 644b0092e9f5338e7f76a268f55272cc557733c474d91f5dc51f44051cdf0d6e4e4b492baa7d539f0c9788dd677d56c840787dcb37bfd882c1e53999877ecbdb
+  metadata.gz: 0b99bc098db98b484a0544cd69430bc9c34c00f4f93782d0879b222339b16d0c08c44bf95760a6b617f87b467f1a1381b9bbf35619333ba5f713dc2aa96415f1
+  data.tar.gz: 64532cd5b33f6e1e78f5ba1a21a48ce2713018b7d8b00bbd32a7018436ebec11a2561024113930ddeb6d7059f359074ed0cfee0fe23219eba20d634c6c12784e

data/README.md

@@ -1,13 +1,15 @@
 # GOV.UK Design System Form Builder for Rails
 
-[![Tests](https://github.com/DFE-Digital/govuk_design_system_formbuilder/workflows/Testing/badge.svg)](https://github.com/DFE-Digital/govuk_design_system_formbuilder/actions)
+[![Tests](https://github.com/DFE-Digital/govuk_design_system_formbuilder/workflows/Tests/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.10.2-brightgreen)](https://design-system.service.gov.uk)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.11.0-brightgreen)](https://design-system.service.gov.uk)
+[![Rails](https://img.shields.io/badge/Ruby-2.6.6%20%E2%95%B1%202.7.2%20%E2%95%B1%203.0.0-E16D6D)](https://www.ruby-lang.org/en/downloads/)
+[![Ruby](https://img.shields.io/badge/Rails-6.0.3%20%E2%95%B1%206.1.0-E16D6D)](https://weblog.rubyonrails.org/releases/)
 
 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.rb

@@ -34,6 +34,12 @@ module GOVUKDesignSystemFormBuilder
   #   blocks. As per the GOV.UK Design System spec, it defaults to
   #   'There is a problem'.
   #
+  # * +:default_collection_check_boxes_include_hidden+ controls whether or not
+  #   a hidden field is added when rendering a collection of check boxes
+  #
+  # * +:default_collection_radio_buttons_include_hidden+ controls whether or not
+  #   a hidden field is added when rendering a collection of radio buttons
+  #
   # * +:localisation_schema_fallback+ sets the prefix elements for the array
   #   used to build the localisation string. The final two elements are always
   #   are the object name and attribute name. The _special_ value +__context__+,
@@ -52,6 +58,9 @@ module GOVUKDesignSystemFormBuilder
     default_submit_button_text: 'Continue',
     default_radio_divider_text: 'or',
     default_error_summary_title: 'There is a problem',
+    default_collection_check_boxes_include_hidden: true,
+    default_collection_radio_buttons_include_hidden: true,
+    default_submit_validate: false,
 
     localisation_schema_fallback: %i(helpers __context__),
     localisation_schema_label: nil,

data/lib/govuk_design_system_formbuilder/base.rb

@@ -53,7 +53,7 @@ module GOVUKDesignSystemFormBuilder
     def has_errors?
       @builder.object.respond_to?(:errors) &&
         @builder.object.errors.any? &&
-        @builder.object.errors.messages.dig(@attribute_name).present?
+        @builder.object.errors.messages[@attribute_name].present?
     end
 
     def described_by(*ids)

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -501,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, include_hidden: false, 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: config.default_collection_radio_buttons_include_hidden, form_group: {}, &block)
       Elements::Radios::Collection.new(
         self,
         object_name,
@@ -646,6 +646,7 @@ module GOVUKDesignSystemFormBuilder
     # @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
+    # @param include_hidden [Boolean] controls whether a hidden field is inserted to allow for empty submissions
     # @param block [Block] any HTML passed in will be injected into the fieldset, after the hint and before the checkboxes
     # @return [ActiveSupport::SafeBuffer] HTML output
     #
@@ -682,7 +683,7 @@ module GOVUKDesignSystemFormBuilder
     #    :name,
     #    legend: -> { tag.h3('What kind of sandwich do you want?') }
     #
-    def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil, hint: {}, legend: {}, caption: {}, small: false, classes: nil, form_group: {}, &block)
+    def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil, hint: {}, legend: {}, caption: {}, small: false, classes: nil, form_group: {}, include_hidden: config.default_collection_check_boxes_include_hidden, &block)
       Elements::CheckBoxes::Collection.new(
         self,
         object_name,
@@ -697,6 +698,7 @@ module GOVUKDesignSystemFormBuilder
         small: small,
         classes: classes,
         form_group: form_group,
+        include_hidden: include_hidden,
         &block
       ).html
     end
@@ -811,9 +813,9 @@ module GOVUKDesignSystemFormBuilder
     #   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'
+    # @param block [Block] When content is passed in via a block the submit element and the block content will
+    #   be wrapped in a +<div class="govuk-button-group">+ which will space the buttons and links within
+    #   evenly.
     # @raise [ArgumentError] raised if both +warning+ and +secondary+ are true
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @note Only the first additional button or link (passed in via a block) will be given the
@@ -827,7 +829,7 @@ 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, disabled: false, &block)
+    def govuk_submit(text = config.default_submit_button_text, warning: false, secondary: false, classes: nil, prevent_double_click: true, validate: config.default_submit_validate, 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
 

data/lib/govuk_design_system_formbuilder/containers/button_group.rb

@@ -0,0 +1,15 @@
+module GOVUKDesignSystemFormBuilder
+  module Containers
+    class ButtonGroup < Base
+      def initialize(builder, buttons)
+        super(builder, nil, nil)
+
+        @buttons = buttons
+      end
+
+      def html
+        tag.div(@buttons, class: %(#{brand}-button-group))
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/containers/character_count.rb

@@ -2,7 +2,7 @@ module GOVUKDesignSystemFormBuilder
   module Containers
     class CharacterCount < Base
       def initialize(builder, max_words:, max_chars:, threshold:)
-        @builder = builder
+        super(builder, nil, nil)
 
         fail ArgumentError, 'limit can be words or chars' if max_words && max_chars
 
@@ -11,10 +11,10 @@ module GOVUKDesignSystemFormBuilder
         @threshold = threshold
       end
 
-      def html
+      def html(&block)
         return yield unless limit?
 
-        tag.div(**options) { yield }
+        tag.div(**options, &block)
       end
 
     private

data/lib/govuk_design_system_formbuilder/containers/check_boxes.rb

@@ -2,13 +2,14 @@ module GOVUKDesignSystemFormBuilder
   module Containers
     class CheckBoxes < Base
       def initialize(builder, small:, classes: nil)
-        @builder = builder
+        super(builder, nil, nil)
+
         @small   = small
         @classes = classes
       end
 
-      def html
-        tag.div(**options) { yield }
+      def html(&block)
+        tag.div(**options, &block)
       end
 
     private

data/lib/govuk_design_system_formbuilder/containers/form_group.rb

@@ -8,8 +8,8 @@ module GOVUKDesignSystemFormBuilder
         @html_attributes = kwargs
       end
 
-      def html
-        tag.div(class: classes, **@html_attributes) { yield }
+      def html(&block)
+        tag.div(class: classes, **@html_attributes, &block)
       end
 
     private

data/lib/govuk_design_system_formbuilder/containers/radios.rb

@@ -4,14 +4,15 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
 
       def initialize(builder, inline:, small:, classes:)
-        @builder = builder
+        super(builder, nil, nil)
+
         @inline  = inline
         @small   = small
         @classes = classes
       end
 
-      def html
-        tag.div(**options) { yield }
+      def html(&block)
+        tag.div(**options, &block)
       end
 
     private

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

@@ -6,19 +6,20 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Supplemental
 
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method: nil, hint:, legend:, caption:, small:, classes:, form_group:, &block)
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint:, legend:, caption:, small:, classes:, form_group:, include_hidden:, hint_method: nil, &block)
           super(builder, object_name, attribute_name, &block)
 
-          @collection   = collection
-          @value_method = value_method
-          @text_method  = text_method
-          @hint_method  = hint_method
-          @small        = small
-          @legend       = legend
-          @caption      = caption
-          @hint         = hint
-          @classes      = classes
-          @form_group   = form_group
+          @collection     = collection
+          @value_method   = value_method
+          @text_method    = text_method
+          @hint_method    = hint_method
+          @small          = small
+          @legend         = legend
+          @caption        = caption
+          @hint           = hint
+          @classes        = classes
+          @form_group     = form_group
+          @include_hidden = include_hidden
         end
 
         def html
@@ -56,7 +57,7 @@ module GOVUKDesignSystemFormBuilder
         def collection
           link_errors = has_errors?
 
-          @builder.collection_check_boxes(@attribute_name, @collection, @value_method, @text_method) do |check_box|
+          @builder.collection_check_boxes(@attribute_name, @collection, @value_method, @text_method, include_hidden: @include_hidden) do |check_box|
             Elements::CheckBoxes::CollectionCheckBox.new(
               @builder,
               @object_name,

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

@@ -16,7 +16,7 @@ module GOVUKDesignSystemFormBuilder
 
         def html
           @checkbox.label(for: field_id(link_errors: @link_errors), class: label_classes) do
-            [localised_text(:label), @checkbox.text, @value].compact.first
+            [localised_text(:label), @checkbox.text, @value].compact.first.to_s
           end
         end
 

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:, wildcards:, &block)
+      def initialize(builder, object_name, attribute_name, legend:, caption:, hint:, omit_day:, form_group:, wildcards:, date_of_birth: false, &block)
         super(builder, object_name, attribute_name, &block)
 
         @legend        = legend

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -5,10 +5,6 @@ module GOVUKDesignSystemFormBuilder
 
       include Traits::Error
 
-      def initialize(builder, object_name, attribute_name)
-        super(builder, object_name, attribute_name)
-      end
-
       def html
         return nil unless has_errors?
 

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -4,8 +4,8 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
 
       def initialize(builder, object_name, title, link_base_errors_to:)
-        @builder             = builder
-        @object_name         = object_name
+        super(builder, object_name, nil)
+
         @title               = title
         @link_base_errors_to = link_base_errors_to
       end

data/lib/govuk_design_system_formbuilder/elements/null.rb

@@ -1,7 +1,9 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Null < Base
-      def initialize; end
+      def initialize
+        super(nil, nil, nil)
+      end
 
       def html
         nil

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

@@ -9,7 +9,7 @@ module GOVUKDesignSystemFormBuilder
         #   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, bold_labels:)
+        def initialize(builder, object_name, attribute_name, item, value_method:, text_method:, hint_method:, bold_labels:, link_errors: false)
           super(builder, object_name, attribute_name)
 
           @item        = item

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -6,7 +6,7 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Hint
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint:, label:, caption:, form_group:, &block)
+      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint:, label:, caption:, form_group:, options: {}, html_options: {}, &block)
         super(builder, object_name, attribute_name, &block)
 
         @collection   = collection
@@ -49,7 +49,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def custom_classes
-        @html_options.dig(:class)
+        @html_options[:class]
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -4,9 +4,10 @@ module GOVUKDesignSystemFormBuilder
       using PrefixableArray
 
       def initialize(builder, text, warning:, secondary:, classes:, prevent_double_click:, validate:, disabled:, &block)
+        super(builder, nil, nil)
+
         fail ArgumentError, 'buttons can be warning or secondary' if warning && secondary
 
-        @builder              = builder
         @text                 = text
         @prevent_double_click = prevent_double_click
         @warning              = warning
@@ -18,11 +19,19 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        safe_join([submit, @block_content])
+        @block_content.present? ? button_group : buttons
       end
 
     private
 
+      def buttons
+        safe_join([submit, @block_content])
+      end
+
+      def button_group
+        Containers::ButtonGroup.new(@builder, buttons).html
+      end
+
       def submit
         @builder.submit(@text, class: classes, **options)
       end
@@ -30,7 +39,7 @@ module GOVUKDesignSystemFormBuilder
       def classes
         %w(button)
           .prefix(brand)
-          .push(warning_class, secondary_class, disabled_class, padding_class, custom_classes)
+          .push(warning_class, secondary_class, disabled_class, custom_classes)
           .flatten
           .compact
       end
@@ -54,10 +63,6 @@ module GOVUKDesignSystemFormBuilder
         %(#{brand}-button--secondary) if @secondary
       end
 
-      def padding_class
-        %(#{brand}-!-margin-right-1) if @block_content
-      end
-
       def disabled_class
         %(#{brand}-button--disabled) if @disabled
       end

data/lib/govuk_design_system_formbuilder/traits/collection_item.rb

@@ -8,7 +8,7 @@ module GOVUKDesignSystemFormBuilder
         when Symbol, String
           item.send(method)
         when Proc
-          capture { method.call(item) }
+          capture { method.call(item).to_s }
         end
       end
     end

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.1.7b1'.freeze
+  VERSION = '2.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.1.7b1
+  version: 2.2.0
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-03-09 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.2
+        version: 4.0.0.pre.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.17.2
+        version: 4.0.0.pre.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '0.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
   requirement: !ruby/object:Gem::Requirement
@@ -176,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.25.0
+        version: 3.26.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.25.0
+        version: 3.26.0
 - !ruby/object:Gem::Dependency
   name: rubypants
   requirement: !ruby/object:Gem::Requirement
@@ -240,6 +240,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -252,6 +266,7 @@ files:
 - lib/govuk_design_system_formbuilder.rb
 - lib/govuk_design_system_formbuilder/base.rb
 - lib/govuk_design_system_formbuilder/builder.rb
+- lib/govuk_design_system_formbuilder/containers/button_group.rb
 - lib/govuk_design_system_formbuilder/containers/character_count.rb
 - lib/govuk_design_system_formbuilder/containers/check_boxes.rb
 - lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb
@@ -316,9 +331,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: