govuk_design_system_formbuilder 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98eb37a7c0dc6926abc94003671567e1d6d9ff64026d92dbd2bbeb62e132b5ac
-  data.tar.gz: 3bdd6d81f7c94f28e39841088d056c8eb7615dab89cd750e589d516f71faae0a
+  metadata.gz: 6307ddd694fd135e13d060b9cb742464e8c5579da4d1026dfffaffedb26c8c39
+  data.tar.gz: 7238c7b22b04727d86393822df54284c97a74197b2d887b2bf7f89e27fadfa2a
 SHA512:
-  metadata.gz: eae5b13528432a2c01a85aba212b74ecfcdb5740ecbe43bf6548749ebc1ab98b7a37281f7bea6b4e85964d73076e19a1a05326011d2edd71f1599075e6545e2b
-  data.tar.gz: c24c784e74e4ae48fdafcca7bf3ba3b5e5f3e22a371f0b5e16bd6fc364f1cb3d386be4bff9ea03de0ce3d5857676eca58001b09284a625d9fcd2dc6ef728a9e5
+  metadata.gz: 63a462903bafafb449b2e6ec8d17e269360fc62fa75fd8f5ffda238a8529f23a6725080de31884c681bb8ce106f806d4e728b88e22a5e89dff96919a90addfc9
+  data.tar.gz: 5f78fdecbd0e4c67b3a9b6ea26854dfd1658a1cbd4da59b01527947ccb4ba89dc1444b39b1ffb03090820142a15fafd25ca2e444a1715259d7216a8a6e84f300

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.11.0-brightgreen)](https://design-system.service.gov.uk)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.12.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.3.6%20%E2%95%B1%206.1.3.1-E16D6D)](https://weblog.rubyonrails.org/releases/)
 

data/lib/govuk_design_system_formbuilder.rb

@@ -1,7 +1,7 @@
 require 'deep_merge/rails_compat'
 require 'active_support/configurable'
 
-[%w(traits *.rb), %w(*.rb), %w(elements ** *.rb), %w(containers ** *.rb)]
+[%w(refinements *.rb), %w(traits *.rb), %w(*.rb), %w(elements ** *.rb), %w(containers ** *.rb)]
   .flat_map { |matcher| Dir.glob(File.join(__dir__, 'govuk_design_system_formbuilder', *matcher)) }
   .each { |file| require file }
 

data/lib/govuk_design_system_formbuilder/base.rb

@@ -1,12 +1,4 @@
 module GOVUKDesignSystemFormBuilder
-  module PrefixableArray
-    refine Array do
-      def prefix(text, delimiter: '-')
-        map { |item| text + delimiter + item }
-      end
-    end
-  end
-
   class Base
     delegate :content_tag, :safe_join, :tag, :link_to, :capture, to: :@builder
     delegate :config, to: GOVUKDesignSystemFormBuilder

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

@@ -2,13 +2,10 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
       class FieldsetCheckBox < Base
-        using PrefixableArray
-
         include Traits::Label
         include Traits::Hint
-        include Traits::FieldsetItem
-        include Traits::Conditional
         include Traits::HTMLAttributes
+        include Traits::FieldsetItem
 
         def initialize(builder, object_name, attribute_name, value, unchecked_value, label:, hint:, link_errors:, multiple:, **kwargs, &block)
           super(builder, object_name, attribute_name)
@@ -21,49 +18,22 @@ module GOVUKDesignSystemFormBuilder
           @link_errors     = link_errors
           @html_attributes = kwargs
 
-          if block_given?
-            @conditional_content = wrap_conditional(block)
-            @conditional_id      = conditional_id
-          end
-        end
-
-        def html
-          safe_join([item, @conditional_content])
+          conditional_content(&block)
         end
 
       private
 
-        def item
-          tag.div(class: %(#{brand}-checkboxes__item)) do
-            safe_join([check_box, label_element, hint_element])
-          end
+        def input_type
+          :checkboxes
         end
 
-        def check_box
+        def input
           @builder.check_box(@attribute_name, attributes(@html_attributes), @value, @unchecked_value)
         end
 
-        def options
-          {
-            id: field_id(link_errors: @link_errors),
-            class: classes,
-            multiple: @multiple,
-            aria: { describedby: [hint_id] },
-            data: { 'aria-controls' => @conditional_id }
-          }
-        end
-
-        def classes
-          %w(checkboxes__input).prefix(brand)
-        end
-
         def fieldset_options
           { checkbox: true }
         end
-
-        def conditional_classes
-          %w(checkboxes__conditional checkboxes__conditional--hidden).prefix(brand)
-        end
       end
     end
   end

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

@@ -2,13 +2,10 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
       class FieldsetRadioButton < Base
-        using PrefixableArray
-
         include Traits::Label
         include Traits::Hint
-        include Traits::FieldsetItem
-        include Traits::Conditional
         include Traits::HTMLAttributes
+        include Traits::FieldsetItem
 
         def initialize(builder, object_name, attribute_name, value, label:, hint:, link_errors:, **kwargs, &block)
           super(builder, object_name, attribute_name)
@@ -19,43 +16,21 @@ module GOVUKDesignSystemFormBuilder
           @link_errors     = has_errors? && link_errors
           @html_attributes = kwargs
 
-          if block_given?
-            @conditional_content = wrap_conditional(block)
-            @conditional_id      = conditional_id
-          end
-        end
-
-        def html
-          safe_join([radio, @conditional_content])
+          conditional_content(&block)
         end
 
       private
 
-        def radio
-          tag.div(class: %(#{brand}-radios__item)) do
-            safe_join([input, label_element, hint_element])
-          end
-        end
-
-        def fieldset_options
-          { radio: true }
+        def input_type
+          :radios
         end
 
         def input
           @builder.radio_button(@attribute_name, @value, **attributes(@html_attributes))
         end
 
-        def options
-          {
-            id: field_id(link_errors: @link_errors),
-            aria: { describedby: [hint_id] },
-            data: { 'aria-controls' => @conditional_id },
-            class: %w(radios__input).prefix(brand)
-          }
-        end
-
-        def conditional_classes
-          %w(radios__conditional radios__conditional--hidden).prefix(brand)
+        def fieldset_options
+          { radio: true }
         end
       end
     end

data/lib/govuk_design_system_formbuilder/refinements/prefixable_array.rb

@@ -0,0 +1,9 @@
+module GOVUKDesignSystemFormBuilder
+  module PrefixableArray
+    refine Array do
+      def prefix(text, delimiter: '-')
+        map { |item| [text, item].join(delimiter.to_s) }
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/fieldset_item.rb

@@ -1,8 +1,38 @@
 module GOVUKDesignSystemFormBuilder
   module Traits
     module FieldsetItem
+      using PrefixableArray
+
+      def html
+        safe_join([item, @conditional])
+      end
+
     private
 
+      def class_prefix
+        %(#{brand}-#{input_type})
+      end
+
+      def item
+        tag.div(class: %(#{class_prefix}__item)) do
+          safe_join([input, label_element, hint_element])
+        end
+      end
+
+      def options
+        {
+          id: field_id(link_errors: @link_errors),
+          class: classes,
+          multiple: @multiple,
+          aria: { describedby: [hint_id] },
+          data: { 'aria-controls' => @conditional_id }
+        }
+      end
+
+      def classes
+        [%(#{class_prefix}__input)]
+      end
+
       def label_element
         @label_element ||= if @label.nil?
                              Elements::Null.new
@@ -26,6 +56,27 @@ module GOVUKDesignSystemFormBuilder
       def hint_options
         { value: @value }.merge(fieldset_options)
       end
+
+      def conditional_id
+        build_id('conditional')
+      end
+
+      def conditional_content(&block)
+        if (conditional_block_content = block_given? && block.call.presence)
+          @conditional    = conditional_container(conditional_block_content)
+          @conditional_id = conditional_id
+        end
+      end
+
+      def conditional_container(content)
+        tag.div(class: conditional_classes, id: conditional_id) do
+          capture { content }
+        end
+      end
+
+      def conditional_classes
+        %w(__conditional __conditional--hidden).prefix(class_prefix, delimiter: nil)
+      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/traits/html_attributes.rb

@@ -6,16 +6,11 @@ module GOVUKDesignSystemFormBuilder
       #   present
       # * joins the arrays into strings to maintain Rails 6.0.3 compatibility
       class Attributes
-        # Don't try to deep merge these fields, when we remove duplicates
-        # whilst merging the resulting values later, repeating words are lost
-        SKIP = [
-          %i(id),
-          %i(value),
-          %i(title),
-          %i(alt),
-          %i(href),
-          %i(aria label)
-        ].freeze
+        # Rather than attempt to combine these attributes, just overwrite the
+        # form internally-generated values with those that are passed in. This
+        # prevents the merge/unique value logic from affecting the content
+        # (i.e. by remvoving duplicated words).
+        UNMERGEABLE = [%i(id), %i(value), %i(title), %i(alt), %i(href), %i(aria label)].freeze
 
         def initialize(defaults, custom)
           @merged = defaults.deeper_merge(deep_split_values(custom))
@@ -33,19 +28,17 @@ module GOVUKDesignSystemFormBuilder
                           when Hash
                             deep_split_values(value, key)
                           when String
-                            split_list_values(key, value, parent)
+                            split_mergeable(key, value, parent)
                           else
                             value
                           end
           end
         end
 
-        def split_list_values(key, value, parent = nil)
-          if [parent, key].compact.in?(SKIP)
-            value
-          else
-            value.split
-          end
+        def split_mergeable(key, value, parent = nil)
+          return value if [parent, key].compact.in?(UNMERGEABLE)
+
+          value.split
         end
 
         def deep_join_values(hash)

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.5.1'.freeze
+  VERSION = '2.5.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -28,58 +28,76 @@ dependencies:
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.pre.1
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.pre.1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -274,14 +292,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.2
+        version: 0.21.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.2
+        version: 0.21.1
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -330,9 +348,9 @@ files:
 - lib/govuk_design_system_formbuilder/elements/select.rb
 - lib/govuk_design_system_formbuilder/elements/submit.rb
 - lib/govuk_design_system_formbuilder/elements/text_area.rb
+- lib/govuk_design_system_formbuilder/refinements/prefixable_array.rb
 - lib/govuk_design_system_formbuilder/traits/caption.rb
 - 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

data/lib/govuk_design_system_formbuilder/traits/conditional.rb

@@ -1,17 +0,0 @@
-module GOVUKDesignSystemFormBuilder
-  module Traits
-    module Conditional
-    private
-
-      def conditional_id
-        build_id('conditional')
-      end
-
-      def wrap_conditional(block)
-        tag.div(class: conditional_classes, id: conditional_id) do
-          capture { block.call }
-        end
-      end
-    end
-  end
-end