govuk_design_system_formbuilder 2.5.0 → 2.6.0b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bad17ea5b7fd24f59da43ac8e0348d27c07589bce648172278c7041e95c4a702
-  data.tar.gz: e8dee08e15dfe0dc4a34de248ef8a2991e789a74ea3452324bbcad81e0ec6612
+  metadata.gz: 434236656800572e0d71e47fe88ae20e5f50c6822f3cf344204f08a934032cb9
+  data.tar.gz: 4746012c475f169cf556fed6512ef89aa0187e95f351addc38b14da835db6137
 SHA512:
-  metadata.gz: ea8519f8c72d431fa56feae8d98e21ff90117c58dcd1e91385ed41a4863299cd74b15f959dd4e4118e3281bccd8a048625013dcdc2dd00fa1d873479d5294f57
-  data.tar.gz: 969f85302cc4c1e898664c04bf1d435d69ed0408fa0bf03890160803c0b6574eabeafc16418cfe8df353e718ff062f6600272d6bccbd596be4fe248c5295dfc5
+  metadata.gz: 6dae8d1bc5dec93e9088aa68f78df41fd06bd9a9815ee65919b14c7fcb96aeb27400390f83e122e540392b2254378c03d2e7455316f9e09d3c4694652e801ce1
+  data.tar.gz: 3f3a3a53125291c4822e2b557c3c6f0ed053e4127bf0b7561b5bc82ca5a1a14b601d01b591bf4dd6901979f3b0b55a018c52ecf74e769ef602ddaef05ea454d4

data/README.md

@@ -7,9 +7,9 @@
 [![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/)
+[![Ruby](https://img.shields.io/badge/Rails-6.0.3.7%20%E2%95%B1%206.1.3.2-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

@@ -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 }
 
@@ -108,6 +108,8 @@ module GOVUKDesignSystemFormBuilder
     include GOVUKDesignSystemFormBuilder::Builder
   end
 
+  class FormBuilderProxy < FormBuilder; end
+
   # Disable Rails' div.field_with_error wrapper
   ActionView::Base.field_error_proc = ->(html_tag, _instance) { html_tag }
 end

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
@@ -23,21 +15,6 @@ module GOVUKDesignSystemFormBuilder
       html || ''
     end
 
-  private
-
-    # returns the attributes bound to the object that are
-    # required to build all contained elements
-    #
-    # @return [GOVUKDesignSystemFormBuilder::FormBuilder, Symbol, Symbol] an array containing the
-    #   builder, object name and attribute name
-    def bound
-      [@builder, @object_name, @attribute_name]
-    end
-
-    def brand(override = nil)
-      override || config.brand
-    end
-
     # returns the id value used for the input
     #
     # @note field_id is overridden so that the error summary can link to the
@@ -59,6 +36,21 @@ module GOVUKDesignSystemFormBuilder
       end
     end
 
+  private
+
+    # returns the attributes bound to the object that are
+    # required to build all contained elements
+    #
+    # @return [GOVUKDesignSystemFormBuilder::FormBuilder, Symbol, Symbol] an array containing the
+    #   builder, object name and attribute name
+    def bound
+      [@builder, @object_name, @attribute_name]
+    end
+
+    def brand(override = nil)
+      override || config.brand
+    end
+
     def has_errors?
       @builder.object.respond_to?(:errors) &&
         @builder.object.errors.any? &&

data/lib/govuk_design_system_formbuilder/builder_helper.rb

@@ -0,0 +1,65 @@
+module GOVUKDesignSystemFormBuilder
+  # NOTE: this is currently considered experimental, it's likely to change based on feedback.
+  #
+  # BuilderHelper contains methods that expose the form builder's functionality
+  # externally. The objectives are to allow:
+  #
+  # * rendering the error summary outside of the form
+  #
+  # * setting the id of custom form elements (rich text editors, date pickers,
+  #   sliders, etc) using the formbuilder's internal logic, allowing them to be
+  #   linked from the error summary
+  module BuilderHelper
+    # Returns the form builder generated id for an object's attribute, allowing
+    # users to force their custom element ids to match those that'll be generated
+    # by the error summary.
+    # @param object [ActiveRecord::Base,ActiveModel::Model,Object] the object that we want to
+    #   generate an id for
+    # @param object_name [Symbol] the object's name, the singular version of the object's class
+    #   name, e.g., +Person+ is +:person+.
+    # @param attribute_name [Symbol] the attribute we're generating an id for
+    # @param value [Object] the value of the attribute. Only necessary for fields with
+    #   multiple form elements like radio buttons and checkboxes
+    # @param link_errors [Boolean] toggles whether or not to override the field id with the
+    #   error id when there are errors on the +object+. Only relevant for radio buttons
+    #   and check boxes.
+    def govuk_field_id(object, attribute_name, object_name = nil, value: nil, link_errors: true)
+      (object_name = retrieve_object_name(object)) if object_name.nil?
+
+      proxy_base(object, object_name, attribute_name, value: value).field_id(link_errors: link_errors)
+    end
+
+    # Renders an error summary
+    # @param object [ActiveRecord::Base,ActiveModel::Model,Object] the object we'll be rendering
+    #   the errors for
+    # @param object_name [Symbol] the object's name, the singular version of the object's class
+    #   name, e.g., +Person+ is +:person+. If none is supplied we'll try to infer it from
+    #   the object, so it'll probably be necessary for regular Ruby objects
+    # @option args [Array] options passed through to the builder's +#govuk_error_summary+
+    # @option kwargs [Hash] keyword options passed through to the builder's +#govuk_error_summary+
+    #
+    # @example
+    #   = govuk_error_summary(@registration)
+    #
+    # @see https://design-system.service.gov.uk/components/error-summary/ GOV.UK error summary
+    def govuk_error_summary(object, object_name = nil, *args, **kwargs)
+      (object_name = retrieve_object_name(object)) if object_name.nil?
+
+      proxy_builder(object, object_name, self, {}).govuk_error_summary(*args, **kwargs)
+    end
+
+  private
+
+    def proxy_base(object, object_name, attribute_name, value: nil)
+      GOVUKDesignSystemFormBuilder::Proxy.new(object, object_name, attribute_name, value: value)
+    end
+
+    def proxy_builder(object, object_name, template, options)
+      GOVUKDesignSystemFormBuilder::FormBuilderProxy.new(object_name, object, template, options)
+    end
+
+    def retrieve_object_name(object)
+      object.to_model.model_name.singular
+    end
+  end
+end

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/proxy.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+
+module GOVUKDesignSystemFormBuilder
+  class Proxy < GOVUKDesignSystemFormBuilder::Base
+    NullBuilder = Struct.new(:object)
+
+    def initialize(object, object_name, attribute_name, value: nil)
+      super(NullBuilder.new(object), object_name, attribute_name)
+
+      @value = value
+    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? && (capture { 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
+          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

@@ -1,11 +1,17 @@
 module GOVUKDesignSystemFormBuilder
   module Traits
     module HTMLAttributes
-      # Attributes eases working with default and custom attributes by
+      # 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
+        # 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))
         end
@@ -16,19 +22,25 @@ module GOVUKDesignSystemFormBuilder
 
       private
 
-        def deep_split_values(hash)
+        def deep_split_values(hash, parent = nil)
           hash.each.with_object({}) do |(key, value), result|
             result[key] = case value
                           when Hash
-                            deep_split_values(value)
+                            deep_split_values(value, key)
                           when String
-                            value.split
+                            split_mergeable(key, value, parent)
                           else
                             value
                           end
           end
         end
 
+        def split_mergeable(key, value, parent = nil)
+          return value if [parent, key].compact.in?(UNMERGEABLE)
+
+          value.split
+        end
+
         def deep_join_values(hash)
           hash.each.with_object({}) do |(key, value), result|
             result[key] = case value

data/lib/govuk_design_system_formbuilder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0b1
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -70,16 +70,16 @@ dependencies:
   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
@@ -268,6 +268,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: slim_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.1
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -281,6 +295,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/builder_helper.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
@@ -316,9 +331,10 @@ 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/proxy.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
@@ -349,9 +365,9 @@ 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.6
 signing_key: 

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