govuk_design_system_formbuilder 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08308443752eddad69642235b4098b788ed5c5eb701b6f97d344171b9654a135'
-  data.tar.gz: 0f3b209aee144ea52d46798b14a29ea1a85b9acf545413d0219efeff03b92e8e
+  metadata.gz: 710ba81f8f737d55dd18626c24a9353862d9b53886127a064e5dc10ddf6fd750
+  data.tar.gz: e82e7198bf059a97d9b0cb9ce0659133b8082dfac2e71c7c37fc4ff3ff1e38fa
 SHA512:
-  metadata.gz: 425224ce7905d2dd33d2123698c6f35f68e2ac640743326f811ab7b45241134f640bc054b7b75a3813edd2be558b794119437d8d4917adbe03f5cc42e38a74b9
-  data.tar.gz: 22d147336200ed390422201ece082289db29d6ee637aad76157195c9401fbbe52cfe6c9c9a80cd357f41543d133009a248a207547b0debaae46503503d26fe93
+  metadata.gz: cd1fee6e4db64215afaa4ceb8083138ee01f11407137cf5885bf8823e0e86cf34ef27e7178118e2a10fe82eef82ce22163d7cef6e1f8f953e5356dde0de1fe96
+  data.tar.gz: c5b20b72db3dd9598fe20e3c42527b715cca82d936bd53a9255b7033fff6620fd631e74f3072d5092852b838be89ebb4dd3b04d567c711a17d6a909e52a0eed3

data/README.md

@@ -7,7 +7,7 @@
 [![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.12.0-brightgreen)](https://design-system.service.gov.uk)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.13.0-brightgreen)](https://design-system.service.gov.uk)
 [![Rails](https://img.shields.io/badge/Ruby-2.6.7%20%E2%95%B1%202.7.3%20%E2%95%B1%203.0.1-E16D6D)](https://www.ruby-lang.org/en/downloads/)
 [![Ruby](https://img.shields.io/badge/Rails-6.0.4%20%E2%95%B1%206.1.3.2-E16D6D)](https://weblog.rubyonrails.org/releases/)
 

data/lib/govuk_design_system_formbuilder.rb

@@ -27,6 +27,12 @@ module GOVUKDesignSystemFormBuilder
   # * +:default_submit_button_text+ sets the value assigned to +govuk_submit+,
   #   defaults to 'Continue'.
   #
+  # * +:default_radio_divider_text+ sets the text automatically added to the
+  #   radio button divider, defaults to 'or'
+  #
+  # * +:default_check_box_divider_text+ sets the text automatically added to the
+  #   checkbox divider, defaults to 'or'
+  #
   # * +:default_submit_button_text+ sets the text used to divide the last radio
   #   button in radio button fieldsets. As per the GOV.UK Design System spec,
   #   it defaults to 'or'.
@@ -65,6 +71,7 @@ module GOVUKDesignSystemFormBuilder
     default_caption_size: 'm',
     default_submit_button_text: 'Continue',
     default_radio_divider_text: 'or',
+    default_check_box_divider_text: 'or',
     default_error_summary_title: 'There is a problem',
     default_error_summary_error_order_method: nil,
     default_collection_check_boxes_include_hidden: true,

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -813,6 +813,8 @@ module GOVUKDesignSystemFormBuilder
     # @option label hidden [Boolean] control the visability of the label. Hidden labels will stil be read by screenreaders
     # @option label kwargs [Hash] additional arguments are applied as attributes on the +label+ element
     # @param multiple [Boolean] controls whether the check box is part of a collection or represents a single attribute
+    # @param exclusive [Boolean] sets the checkbox so that when checked none of its siblings can be too. Usually
+    #   used for the 'None of these apply to me' option found beneath a {#govuk_check_box_divider}.
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ element
     # @param block [Block] any HTML passed in will form the contents of the fieldset
     # @return [ActiveSupport::SafeBuffer] HTML output
@@ -825,7 +827,7 @@ module GOVUKDesignSystemFormBuilder
     #     label: { text: 'Do you agree with our terms and conditions?' },
     #     hint: { text: 'You will not be able to proceed unless you do' }
     #
-    def govuk_check_box(attribute_name, value, unchecked_value = false, hint: {}, label: {}, link_errors: false, multiple: true, **kwargs, &block)
+    def govuk_check_box(attribute_name, value, unchecked_value = false, hint: {}, label: {}, link_errors: false, multiple: true, exclusive: false, **kwargs, &block)
       Elements::CheckBoxes::FieldsetCheckBox.new(
         self,
         object_name,
@@ -836,11 +838,24 @@ module GOVUKDesignSystemFormBuilder
         label: label,
         link_errors: link_errors,
         multiple: multiple,
+        exclusive: exclusive,
         **kwargs,
         &block
       ).html
     end
 
+    # Inserts a text divider into a list of check boxes
+    #
+    # @param text [String] The divider text
+    # @note This should only be used from within a {#govuk_check_boxes_fieldset}
+    # @see https://design-system.service.gov.uk/components/checkboxes/#add-an-option-for-none- GOV.UK check boxes with a text divider
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    # @example A custom divider
+    #   = govuk_check_box_divider 'On the other hand'
+    def govuk_check_box_divider(text = config.default_check_box_divider_text)
+      tag.div(text, class: %w(govuk-checkboxes__divider))
+    end
+
     # Generates a submit button, green by default
     #
     # @param text [String,Proc] the button text. When a +Proc+ is provided its contents will be rendered within the button element

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

@@ -7,7 +7,7 @@ module GOVUKDesignSystemFormBuilder
         include Traits::HTMLAttributes
         include Traits::FieldsetItem
 
-        def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, **kwargs, &block)
+        def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, exclusive:, **kwargs, &block)
           super(builder, object_name, attribute_name)
 
           @value           = value
@@ -17,6 +17,7 @@ module GOVUKDesignSystemFormBuilder
           @multiple        = multiple
           @link_errors     = link_errors
           @html_attributes = kwargs
+          @exclusive       = exclusive
 
           conditional_content(&block)
         end
@@ -28,12 +29,18 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def input
-          @builder.check_box(@attribute_name, attributes(@html_attributes), @value, @unchecked_value)
+          @builder.check_box(@attribute_name, attributes(@html_attributes.deep_merge(exclusive_options)), @value, @unchecked_value)
         end
 
         def fieldset_options
           { checkbox: true }
         end
+
+        def exclusive_options
+          return {} unless @exclusive
+
+          { data: { behaviour: 'exclusive' } }
+        end
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/inputs/number.rb

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :number_field
         end

data/lib/govuk_design_system_formbuilder/elements/inputs/password.rb

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :password_field
         end

data/lib/govuk_design_system_formbuilder/elements/inputs/phone.rb

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :phone_field
         end

data/lib/govuk_design_system_formbuilder/elements/inputs/text.rb

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :text_field
         end

data/lib/govuk_design_system_formbuilder/elements/inputs/url.rb

@@ -9,6 +9,8 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Supplemental
         include Traits::HTMLAttributes
 
+      private
+
         def builder_method
           :url_field
         end

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.7.0'.freeze
+  VERSION = '2.7.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge