govuk_design_system_formbuilder 2.5.3 → 2.6.0b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dde3d10e811cb75c61423193a1f19acd4c3f55c9abc7cbc0a72cee8aab40fde
-  data.tar.gz: f7e7eb253f038b1a392ee0c111c36a336649b2bfdaeb1c83a4e71018eaab2936
+  metadata.gz: 434236656800572e0d71e47fe88ae20e5f50c6822f3cf344204f08a934032cb9
+  data.tar.gz: 4746012c475f169cf556fed6512ef89aa0187e95f351addc38b14da835db6137
 SHA512:
-  metadata.gz: 8aeed919d9f6e25e6d2b70ebc16206ba7f41e72b86fe8ea20888ac6870bc81255f9ebb8c9ee7a3d6cebe0f067e0a5c13d3fbef5a46c3cfff9432a09c6967074b
-  data.tar.gz: 16d556b230c3241c7f28c208a11eaf8bfa11634178dc52d8aa7f19c654271304acc6d3f1f916138a1fef66f1fa8c305fe48c2c6fe4e6ac41459b1777442059f7
+  metadata.gz: 6dae8d1bc5dec93e9088aa68f78df41fd06bd9a9815ee65919b14c7fcb96aeb27400390f83e122e540392b2254378c03d2e7455316f9e09d3c4694652e801ce1
+  data.tar.gz: 3f3a3a53125291c4822e2b557c3c6f0ed053e4127bf0b7561b5bc82ca5a1a14b601d01b591bf4dd6901979f3b0b55a018c52ecf74e769ef602ddaef05ea454d4

data/README.md

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

@@ -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

@@ -15,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
@@ -51,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/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/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '2.5.3'.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.3
+  version: 2.6.0b1
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -28,62 +28,44 @@ dependencies:
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.3.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.0'
   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.1'
+        version: '6.0'
 - !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.1'
+        version: '6.0'
   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.1'
+        version: '6.0'
 - !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.1'
+        version: '6.0'
   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.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
@@ -313,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
@@ -348,6 +331,7 @@ 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
@@ -381,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: