govuk_design_system_formbuilder 2.6.0b1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 434236656800572e0d71e47fe88ae20e5f50c6822f3cf344204f08a934032cb9
-  data.tar.gz: 4746012c475f169cf556fed6512ef89aa0187e95f351addc38b14da835db6137
+  metadata.gz: dd0f0c49f266a8cb411ebed4833b6284cc8cc4b6acd8ce3bf87d705feb40062b
+  data.tar.gz: b2659204e304dd40ed2254d06f43acdd4b5b5f13fc48d180741645d004c15719
 SHA512:
-  metadata.gz: 6dae8d1bc5dec93e9088aa68f78df41fd06bd9a9815ee65919b14c7fcb96aeb27400390f83e122e540392b2254378c03d2e7455316f9e09d3c4694652e801ce1
-  data.tar.gz: 3f3a3a53125291c4822e2b557c3c6f0ed053e4127bf0b7561b5bc82ca5a1a14b601d01b591bf4dd6901979f3b0b55a018c52ecf74e769ef602ddaef05ea454d4
+  metadata.gz: 962d77c5cc9b3501f0b8efab08a9f7c930d3aed9b28e96e06bd4e9851fd00586eb557a43150f6b911c7ad5044d0cc4e0bc08027697faf223aa70ce0765558898
+  data.tar.gz: 8af398e7d5673dd8b8b5f25810d88afb281a297f409c5883d567fd13a9f0347cbe644c2f32f6e69b1ec8a0e261ad81abf723e444d6186bdfb7f9901431f70c10

data/lib/govuk_design_system_formbuilder.rb

@@ -41,6 +41,10 @@ module GOVUKDesignSystemFormBuilder
   # * +:default_collection_radio_buttons_include_hidden+ controls whether or not
   #   a hidden field is added when rendering a collection of radio buttons
   #
+  # * +:default_error_summary_error_order_method+ is the method that the library
+  #   will check for on the bound object to see whether or not to try ordering the
+  #   error messages
+  #
   # * +:localisation_schema_fallback+ sets the prefix elements for the array
   #   used to build the localisation string. The final two elements are always
   #   are the object name and attribute name. The _special_ value +__context__+,
@@ -62,6 +66,7 @@ module GOVUKDesignSystemFormBuilder
     default_submit_button_text: 'Continue',
     default_radio_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,
     default_collection_radio_buttons_include_hidden: true,
     default_submit_validate: false,

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -930,7 +930,11 @@ module GOVUKDesignSystemFormBuilder
     # @param title [String] the error summary heading
     # @param link_base_errors_to [Symbol,String] set the field that errors on +:base+ are linked
     #   to, as there won't be a field representing the object base.
+    # @param order [Array<Symbol>] the attribute order in which error messages are displayed. Ordered
+    #   attributes will appear first and unordered ones will be last, sorted in the default manner (in
+    #   which they were defined on the model).
     # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the error summary +div+ element
+    # @param block [Block] arbitrary HTML that will be rendered between title and error message list
     #
     # @note Only the first error in the +#errors+ array for each attribute will
     #   be included.
@@ -939,8 +943,8 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_error_summary 'Uh-oh, spaghettios'
     #
     # @see https://design-system.service.gov.uk/components/error-summary/ GOV.UK error summary
-    def govuk_error_summary(title = config.default_error_summary_title, link_base_errors_to: nil, **kwargs)
-      Elements::ErrorSummary.new(self, object_name, title, link_base_errors_to: link_base_errors_to, **kwargs).html
+    def govuk_error_summary(title = config.default_error_summary_title, link_base_errors_to: nil, order: nil, **kwargs, &block)
+      Elements::ErrorSummary.new(self, object_name, title, link_base_errors_to: link_base_errors_to, order: order, **kwargs, &block).html
     end
 
     # Generates a fieldset containing the contents of the block

data/lib/govuk_design_system_formbuilder/builder_helper.rb

@@ -42,10 +42,10 @@ module GOVUKDesignSystemFormBuilder
     #   = 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)
+    def govuk_error_summary(object, object_name = nil, *args, **kwargs, &block)
       (object_name = retrieve_object_name(object)) if object_name.nil?
 
-      proxy_builder(object, object_name, self, {}).govuk_error_summary(*args, **kwargs)
+      proxy_builder(object, object_name, self, {}).govuk_error_summary(*args, **kwargs, &block)
     end
 
   private

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -4,12 +4,13 @@ module GOVUKDesignSystemFormBuilder
       include Traits::Error
       include Traits::HTMLAttributes
 
-      def initialize(builder, object_name, title, link_base_errors_to:, **kwargs)
-        super(builder, object_name, nil)
+      def initialize(builder, object_name, title, link_base_errors_to:, order:, **kwargs, &block)
+        super(builder, object_name, nil, &block)
 
         @title               = title
         @link_base_errors_to = link_base_errors_to
         @html_attributes     = kwargs
+        @order               = order
       end
 
       def html
@@ -27,17 +28,43 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def summary
-        tag.div(class: summary_class('body')) do
-          tag.ul(class: [%(#{brand}-list), summary_class('list')]) do
-            safe_join(list)
-          end
-        end
+        tag.div(class: summary_class('body')) { safe_join([@block_content, list]) }
       end
 
       def list
-        @builder.object.errors.messages.map do |attribute, messages|
-          list_item(attribute, messages.first)
+        tag.ul(class: [%(#{brand}-list), summary_class('list')]) do
+          safe_join(error_messages.map { |attribute, messages| list_item(attribute, messages.first) })
+        end
+      end
+
+      def error_messages
+        messages = @builder.object.errors.messages
+
+        if reorder_errors?
+          return messages.sort_by.with_index(1) do |(attr, _val), i|
+            error_order.index(attr) || (i + messages.size)
+          end
         end
+
+        @builder.object.errors.messages
+      end
+
+      def reorder_errors?
+        object = @builder.object
+
+        @order || (error_order_method &&
+                   object.respond_to?(error_order_method) &&
+                   object.send(error_order_method).present?)
+      end
+
+      def error_order
+        @order || @builder.object.send(config.default_error_summary_error_order_method)
+      end
+
+      # this method will be called on the bound object to see if custom error ordering
+      # has been enabled
+      def error_order_method
+        config.default_error_summary_error_order_method
       end
 
       def list_item(attribute, message)

data/lib/govuk_design_system_formbuilder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 2.6.0b1
+  version: 2.6.0
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -365,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: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: