govuk_design_system_formbuilder 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56faf8610c088256377104bf569648d400a885f14ac4473004f6e274e369bcf0
-  data.tar.gz: d33bc39a755f8241b61dc94bef11b51734786e781a0f2e046b27438996161aa2
+  metadata.gz: bad17ea5b7fd24f59da43ac8e0348d27c07589bce648172278c7041e95c4a702
+  data.tar.gz: e8dee08e15dfe0dc4a34de248ef8a2991e789a74ea3452324bbcad81e0ec6612
 SHA512:
-  metadata.gz: cb539b28abcd66fedd8bfb67ae7341e3394503eea648c5fd7c88a453163cac93b31ff5c21d91971f36348bb2f194becc5346382f995d464c148865a6c17ab57c
-  data.tar.gz: 4dc4ad392b0889678d009e4b0c4e502c8dad962b9a6ded83b079e319efd0e7760c78151bfe964d3d825328eef9760324a124ea7800593f2be0e454f5836722d5
+  metadata.gz: ea8519f8c72d431fa56feae8d98e21ff90117c58dcd1e91385ed41a4863299cd74b15f959dd4e4118e3281bccd8a048625013dcdc2dd00fa1d873479d5294f57
+  data.tar.gz: 969f85302cc4c1e898664c04bf1d435d69ed0408fa0bf03890160803c0b6574eabeafc16418cfe8df353e718ff062f6600272d6bccbd596be4fe248c5295dfc5

data/README.md

@@ -8,8 +8,8 @@
 [![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)
-[![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/)
+[![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/)
 
 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

@@ -49,6 +49,9 @@ module GOVUKDesignSystemFormBuilder
   # * +:localisation_schema_legend+, +:localisation_schema_hint+ and
   #   +:localisation_schema_label+ each override the schema root for their
   #   particular context, allowing them to be independently customised.
+  #
+  # * +:enable_logger+ controls whether or not the library will emit log
+  #   messages via Rails.logger.warn, defaults to +true+
   # ===
   DEFAULTS = {
     brand: 'govuk',
@@ -67,7 +70,9 @@ module GOVUKDesignSystemFormBuilder
     localisation_schema_label: nil,
     localisation_schema_hint: nil,
     localisation_schema_legend: nil,
-    localisation_schema_caption: nil
+    localisation_schema_caption: nil,
+
+    enable_logger: true
   }.freeze
 
   DEFAULTS.each_key { |k| config_accessor(k) { DEFAULTS[k] } }

data/lib/govuk_design_system_formbuilder/base.rb

@@ -66,7 +66,7 @@ module GOVUKDesignSystemFormBuilder
     end
 
     def described_by(*ids)
-      ids.flatten.compact.join(' ').presence
+      ids.flatten.compact
     end
 
     # Builds the values used for HTML id attributes throughout the builder
@@ -96,5 +96,11 @@ module GOVUKDesignSystemFormBuilder
         .parameterize
         .tr(replace, delimiter)
     end
+
+    def warn(message)
+      return unless config.enable_logger
+
+      Rails.logger.warn(message)
+    end
   end
 end

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -381,6 +381,7 @@ module GOVUKDesignSystemFormBuilder
     #   supplied the hint will be wrapped in a +div+ instead of a +span+
     # @option hint text [String] the hint text
     # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
+    # @param label [Hash,Proc] configures or sets the associated label content
     # @option label text [String] the label text
     # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
     # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
@@ -412,7 +413,7 @@ module GOVUKDesignSystemFormBuilder
     #     label: -> { tag.h3("Which team did you represent?") }
     #
     def govuk_collection_select(attribute_name, collection, value_method, text_method, options: {}, hint: {}, label: {}, caption: {}, form_group: {}, **kwargs, &block)
-      Elements::Select.new(
+      Elements::CollectionSelect.new(
         self,
         object_name,
         attribute_name,
@@ -429,6 +430,42 @@ module GOVUKDesignSystemFormBuilder
       ).html
     end
 
+    # Generates a +select+ element containing an +option+ for every choice provided
+    #
+    # @param attribute_name [Symbol] The name of the attribute
+    # @param choices [Array,Hash] The +option+ values, usually provided via
+    #   the +options_for_select+ or +grouped_options_for_select+ helpers.
+    # @param options [Hash] Options hash passed through to Rails' +select+ helper
+    # @param hint [Hash,Proc] The content of the hint. No hint will be added if 'text' is left +nil+. When a +Proc+ is
+    #   supplied the hint will be wrapped in a +div+ instead of a +span+
+    # @option hint text [String] the hint text
+    # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
+    # @param label [Hash,Proc] configures or sets the associated label content
+    # @option label text [String] the label text
+    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
+    # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
+    # @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 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 block [Block] build the contents of the select element manually for exact control
+    # @see https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select Rails select (called by govuk_collection_select)
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @example A select box with custom data attributes
+    #
+    #   @colours = [
+    #     ["PapayaWhip", "pw",  { data: { hex: "#ffefd5" } }],
+    #     ["Chocolate", "choc", { data: { hex: "#d2691e" } }],
+    #   ]
+    #
+    #   = f.govuk_select :hat_colour, options_for_select(@colours)
+    #
+    def govuk_select(attribute_name, choices = nil, options: {}, label: {}, hint: {}, form_group: {}, caption: {}, **kwargs, &block)
+      Elements::Select.new(self, object_name, attribute_name, choices, options: options, label: label, hint: hint, form_group: form_group, caption: caption, **kwargs, &block).html
+    end
+
     # Generates a radio button for each item in the supplied collection
     #
     # @note Unlike the Rails +#collection_radio_buttons+ helper, this version can also insert

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -24,7 +24,7 @@ module GOVUKDesignSystemFormBuilder
       def options
         {
           class: classes,
-          aria: { describedby: @described_by }
+          aria: { describedby: [@described_by] }
         }
       end
 

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

@@ -48,7 +48,7 @@ module GOVUKDesignSystemFormBuilder
             id: field_id(link_errors: @link_errors),
             class: classes,
             multiple: @multiple,
-            aria: { describedby: hint_id },
+            aria: { describedby: [hint_id] },
             data: { 'aria-controls' => @conditional_id }
           }
         end

data/lib/govuk_design_system_formbuilder/elements/collection_select.rb

@@ -0,0 +1,52 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class CollectionSelect < Base
+      include Traits::Error
+      include Traits::Label
+      include Traits::Hint
+      include Traits::Supplemental
+      include Traits::HTMLAttributes
+      include Traits::Select
+
+      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint:, label:, caption:, form_group:, options: {}, **kwargs, &block)
+        super(builder, object_name, attribute_name, &block)
+
+        @collection      = collection
+        @value_method    = value_method
+        @text_method     = text_method
+        @options         = options
+        @label           = label
+        @caption         = caption
+        @hint            = hint
+        @form_group      = form_group
+        @html_attributes = kwargs
+
+        # FIXME remove this soon, worth informing people who miss the release notes that the
+        #       args have changed though.
+        if :html_options.in?(kwargs.keys)
+          warn("GOVUKDesignSystemFormBuilder: html_options has been deprecated, use keyword arguments instead")
+        end
+      end
+
+      def html
+        Containers::FormGroup.new(*bound, **@form_group).html do
+          safe_join([label_element, supplemental_content, hint_element, error_element, collection_select])
+        end
+      end
+
+    private
+
+      def options
+        {
+          id: field_id(link_errors: true),
+          class: classes,
+          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+        }
+      end
+
+      def collection_select
+        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, **attributes(@html_attributes))
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -72,7 +72,19 @@ module GOVUKDesignSystemFormBuilder
       def value(segment)
         attribute = @builder.object.try(@attribute_name)
 
-        attribute.try(segment) || attribute.try(:[], MULTIPARAMETER_KEY[segment])
+        return unless attribute
+
+        if attribute.respond_to?(segment)
+          attribute.send(segment)
+        elsif attribute.respond_to?(:fetch)
+          attribute.fetch(MULTIPARAMETER_KEY[segment]) do
+            warn("No key '#{segment}' found in MULTIPARAMETER_KEY hash. Expected to find #{MULTIPARAMETER_KEY.values}")
+
+            nil
+          end
+        else
+          fail(ArgumentError, "invalid Date-like object: must be a Date, Time, DateTime or Hash in MULTIPARAMETER_KEY format")
+        end
       end
 
       def label(segment, link_errors)

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

@@ -48,7 +48,7 @@ module GOVUKDesignSystemFormBuilder
         def options
           {
             id: field_id(link_errors: @link_errors),
-            aria: { describedby: hint_id },
+            aria: { describedby: [hint_id] },
             data: { 'aria-controls' => @conditional_id },
             class: %w(radios__input).prefix(brand)
           }

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -4,56 +4,43 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
       include Traits::Label
       include Traits::Hint
-      include Traits::Supplemental
       include Traits::HTMLAttributes
+      include Traits::Select
 
-      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint:, label:, caption:, form_group:, options: {}, **kwargs, &block)
-        super(builder, object_name, attribute_name, &block)
+      def initialize(builder, object_name, attribute_name, choices, options:, form_group:, label:, hint:, caption:, **kwargs, &block)
+        # assign the block to an variable rather than passing to super so
+        # we can send it through to #select
+        super(builder, object_name, attribute_name)
+        @block           = block
 
-        @collection      = collection
-        @value_method    = value_method
-        @text_method     = text_method
-        @options         = options
+        @form_group      = form_group
+        @hint            = hint
         @label           = label
         @caption         = caption
-        @hint            = hint
-        @form_group      = form_group
+        @choices         = choices
+        @options         = options
         @html_attributes = kwargs
-
-        # FIXME remove this soon, worth informing people who miss the release notes that the
-        #       args have changed though.
-        if :html_options.in?(kwargs.keys)
-          Rails.logger.warn("GOVUKDesignSystemFormBuilder: html_options has been deprecated, use keyword arguments instead")
-        end
       end
 
       def html
         Containers::FormGroup.new(*bound, **@form_group).html do
-          safe_join([label_element, supplemental_content, hint_element, error_element, select])
+          safe_join([label_element, hint_element, error_element, select])
         end
       end
 
     private
 
       def select
-        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, **attributes(@html_attributes))
+        @builder.select(@attribute_name, @choices, @options, attributes(@html_attributes), &@block)
       end
 
       def options
         {
           id: field_id(link_errors: true),
           class: classes,
-          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+          aria: { describedby: described_by(hint_id, error_id) }
         }
       end
-
-      def classes
-        [%(#{brand}-select), error_class].flatten.compact
-      end
-
-      def error_class
-        %(#{brand}-select--error) if has_errors?
-      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/traits/html_attributes.rb

@@ -1,8 +1,50 @@
 module GOVUKDesignSystemFormBuilder
   module Traits
     module HTMLAttributes
+      # Attributes eases working with default and custom attributes by
+      # * deeply merging them so both the default (required) attributes are
+      #   present
+      # * joins the arrays into strings to maintain Rails 6.0.3 compatibility
+      class Attributes
+        def initialize(defaults, custom)
+          @merged = defaults.deeper_merge(deep_split_values(custom))
+        end
+
+        def to_h
+          deep_join_values(@merged)
+        end
+
+      private
+
+        def deep_split_values(hash)
+          hash.each.with_object({}) do |(key, value), result|
+            result[key] = case value
+                          when Hash
+                            deep_split_values(value)
+                          when String
+                            value.split
+                          else
+                            value
+                          end
+          end
+        end
+
+        def deep_join_values(hash)
+          hash.each.with_object({}) do |(key, value), result|
+            result[key] = case value
+                          when Hash
+                            deep_join_values(value)
+                          when Array
+                            value.uniq.join(' ').presence
+                          else
+                            value
+                          end
+          end
+        end
+      end
+
       def attributes(html_attributes = {})
-        options.deeper_merge(html_attributes)
+        Attributes.new(options, html_attributes).to_h
       end
     end
   end

data/lib/govuk_design_system_formbuilder/traits/select.rb

@@ -0,0 +1,15 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Select
+    private
+
+      def classes
+        [%(#{brand}-select), error_class].flatten.compact
+      end
+
+      def error_class
+        %(#{brand}-select--error) if has_errors?
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.4.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -255,19 +255,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.1.0
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 1.7.0
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -295,6 +295,7 @@ files:
 - lib/govuk_design_system_formbuilder/elements/check_boxes/collection_check_box.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/fieldset_check_box.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/label.rb
+- lib/govuk_design_system_formbuilder/elements/collection_select.rb
 - lib/govuk_design_system_formbuilder/elements/date.rb
 - lib/govuk_design_system_formbuilder/elements/error_message.rb
 - lib/govuk_design_system_formbuilder/elements/error_summary.rb
@@ -325,6 +326,7 @@ files:
 - lib/govuk_design_system_formbuilder/traits/input.rb
 - lib/govuk_design_system_formbuilder/traits/label.rb
 - lib/govuk_design_system_formbuilder/traits/localisation.rb
+- lib/govuk_design_system_formbuilder/traits/select.rb
 - lib/govuk_design_system_formbuilder/traits/supplemental.rb
 - lib/govuk_design_system_formbuilder/version.rb
 homepage: https://govuk-form-builder.netlify.app
@@ -351,7 +353,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: GOV.UK-compliant Rails form builder