metadata_presenter 3.3.2 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b4dbad514bcffef84647d078cffbf0780d9913b2432f2ae2f9b266105017766
-  data.tar.gz: a4e7481c08379633df45023fe4f3bce5296086a8328b3d3306afc3f11a36ad20
+  metadata.gz: cc84786b2ed09dc03a4df7af7d096346b18bce085b4c7e9cf40d15bb0778000a
+  data.tar.gz: 708f4c349746f9d80dfb405860dc7b37cd6773eef9cc86c931540848b5205b5b
 SHA512:
-  metadata.gz: a4caff0ac656b1356984b11588c402ead85557c3a3eff89219e6bf41ebc69fde21c61373827f28d90670a795bd61295f2d33d65cac919afaf27de92cfef17331
-  data.tar.gz: 2aa8c5a38417c2a2e0d65a7892bc9413526539364e080e002b16a2df88a33384127a74f46f6c6fe8ad507ec5777c861688ebcc9bbc5f0fe787627a85e93d31d8
+  metadata.gz: cc8b1eb03836a7a4e649e509e66018e0718ef90cedab16da9e11a9fab7412bc8a6c38f612e9c6c617641bc1a8483ea0dd21c14d53866c2d88449eeb491215cf0
+  data.tar.gz: 1feebdd5af39db1c9a116e5d6419bef27b6131e234fa1dfb9910952a0927fff6f87d25115c614b5a4e5597def786bdf0471e71097e03fcb6fb4ed677bfb0fa4d

data/app/validators/metadata_presenter/accept_validator.rb

@@ -1,18 +1,7 @@
 module MetadataPresenter
-  class AcceptValidator < UploadValidator
+  class AcceptValidator < BaseUploadValidator
     def error_name
       'accept'
     end
-
-    def error_message_hash
-      if component.type == 'multiupload'
-        {
-          control: page_answers.send(component.id)[component.id].last['original_filename'],
-          schema_key.to_sym => component.validation[schema_key]
-        }
-      else
-        super
-      end
-    end
   end
 end

data/app/validators/metadata_presenter/base_upload_validator.rb

@@ -0,0 +1,27 @@
+module MetadataPresenter
+  class BaseUploadValidator < BaseValidator
+    def invalid_answer?
+      user_answer.error_name == error_name
+    end
+
+    def user_answer
+      page_answers.uploaded_files.find do |uploaded_file|
+        component.id == uploaded_file.component.id
+      end
+    end
+
+    def error_message_hash
+      super.merge(control:)
+    end
+
+    private
+
+    def control
+      if component.type == 'multiupload'
+        page_answers.send(component.id)[component.id].last['original_filename']
+      else
+        page_answers.send(component.id)['original_filename']
+      end
+    end
+  end
+end

data/app/validators/metadata_presenter/catch_all_validator.rb

@@ -0,0 +1,24 @@
+module MetadataPresenter
+  class CatchAllValidator < BaseValidator
+    ERROR_NAME_PREFIX = 'error.'.freeze
+
+    # NOTE: generic errors in other components can be implemented
+    # by introducing new case branching if neccessary.
+    def invalid_answer?
+      case component.type
+      when 'upload', 'multiupload'
+        upload_user_answer&.error_name.to_s.start_with?(ERROR_NAME_PREFIX)
+      else
+        false
+      end
+    end
+
+    private
+
+    def upload_user_answer
+      page_answers.uploaded_files.find do |uploaded_file|
+        component.id == uploaded_file.component.id
+      end
+    end
+  end
+end

data/app/validators/metadata_presenter/date_validator.rb

@@ -1,13 +1,18 @@
 module MetadataPresenter
   class DateValidator < BaseValidator
     DATE_STRING_VALIDATIONS = %w[date_after date_before].freeze
+    YEAR_LOWER_BOUND = 1000
+    YEAR_UPPER_BOUND = 3000
 
     def invalid_answer?
-      Date.strptime(
-        "#{user_answer.year}-#{user_answer.month}-#{user_answer.day}",
-        '%Y-%m-%d'
+      date = Date.civil(
+        user_answer.year.to_i, user_answer.month.to_i, user_answer.day.to_i
       )
 
+      # additional validations that `#civil` will not raise as errors
+      return true if date.year < YEAR_LOWER_BOUND
+      return true if date.year > YEAR_UPPER_BOUND
+
       false
     rescue Date::Error
       true

data/app/validators/metadata_presenter/max_size_validator.rb

@@ -1,5 +1,5 @@
 module MetadataPresenter
-  class MaxSizeValidator < UploadValidator
+  class MaxSizeValidator < BaseUploadValidator
     def error_name
       'invalid.too-large'
     end

data/app/validators/metadata_presenter/multiupload_validator.rb

@@ -1,22 +1,9 @@
 module MetadataPresenter
-  class MultiuploadValidator < BaseValidator
+  class MultiuploadValidator < BaseUploadValidator
     def invalid_answer?
       user_answer.errors.any? { |error| error.attribute.to_s == error_name }
     end
 
-    def user_answer
-      page_answers.uploaded_files.find do |uploaded_file|
-        component.id == uploaded_file.component.id
-      end
-    end
-
-    def error_message_hash
-      {
-        control: page_answers.send(component.id)[component.id].last['original_filename'],
-        schema_key.to_sym => component.validation[schema_key]
-      }
-    end
-
     def error_name
       'invalid.multiupload'
     end

data/app/validators/metadata_presenter/validate_answers.rb

@@ -21,29 +21,24 @@ module MetadataPresenter
     def validators
       components.map { |component|
         component_validations(component).map do |key|
-          if key == 'max_files'
-            'MetadataPresenter::MaxFilesValidator'.constantize.new(
-              **{
-                page_answers:,
-                component:
-              }.merge(autocomplete_param(key))
-            )
-          else
-            "MetadataPresenter::#{key.classify}Validator".constantize.new(
-              **{
-                page_answers:,
-                component:
-              }.merge(autocomplete_param(key))
-            )
-          end
+          "MetadataPresenter::#{key.camelize}Validator".constantize.new(
+            **{
+              page_answers:,
+              component:
+            }.merge(autocomplete_param(key))
+          )
         end
-      }.compact.flatten
+      }.flatten.compact
     end
 
     def component_validations(component)
       return [] if component.validation.blank?
 
-      component.validation.select { |_, value| value.present? }.keys
+      component.validation.compact_blank.keys + additional_validators
+    end
+
+    def additional_validators
+      %w[catch_all].freeze
     end
 
     def autocomplete_param(key)

data/app/validators/metadata_presenter/virus_scan_validator.rb

@@ -1,5 +1,5 @@
 module MetadataPresenter
-  class VirusScanValidator < UploadValidator
+  class VirusScanValidator < BaseUploadValidator
     def error_name
       'invalid.virus'
     end

data/config/locales/en.yml

@@ -115,7 +115,7 @@ en:
           continue: 'Continue'
         progress:
           heading: '%{service_name}'
-          content_1: 'You have sucessfuly retrieved your saved information.'
+          content_1: 'You have successfully retrieved your saved information.'
           content_2: 'Here are the answers you have provided so far.'
           continue: 'Continue'
     footer:

data/default_metadata/string/error.catch_all.json

@@ -0,0 +1,6 @@
+{
+  "_id": "error.catch_all",
+  "_type": "string.error",
+  "description": "A generic validation error not handled by a more concrete validator",
+  "value": "We could not save your answer, please try again"
+}

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '3.3.2'.freeze
+  VERSION = '3.3.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.3.3
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -373,7 +373,9 @@ files:
 - app/validators/email_confirmation_validator.rb
 - app/validators/metadata_presenter/accept_validator.rb
 - app/validators/metadata_presenter/autocomplete_validator.rb
+- app/validators/metadata_presenter/base_upload_validator.rb
 - app/validators/metadata_presenter/base_validator.rb
+- app/validators/metadata_presenter/catch_all_validator.rb
 - app/validators/metadata_presenter/date_after_validator.rb
 - app/validators/metadata_presenter/date_before_validator.rb
 - app/validators/metadata_presenter/date_validator.rb
@@ -389,7 +391,6 @@ files:
 - app/validators/metadata_presenter/multiupload_validator.rb
 - app/validators/metadata_presenter/number_validator.rb
 - app/validators/metadata_presenter/required_validator.rb
-- app/validators/metadata_presenter/upload_validator.rb
 - app/validators/metadata_presenter/validate_answers.rb
 - app/validators/metadata_presenter/validate_schema.rb
 - app/validators/metadata_presenter/virus_scan_validator.rb
@@ -490,6 +491,7 @@ files:
 - default_metadata/service/base.json
 - default_metadata/string/error.accept.json
 - default_metadata/string/error.autocomplete.json
+- default_metadata/string/error.catch_all.json
 - default_metadata/string/error.date.json
 - default_metadata/string/error.date_after.json
 - default_metadata/string/error.date_before.json

data/app/validators/metadata_presenter/upload_validator.rb

@@ -1,20 +0,0 @@
-module MetadataPresenter
-  class UploadValidator < BaseValidator
-    def invalid_answer?
-      user_answer.error_name == error_name
-    end
-
-    def user_answer
-      page_answers.uploaded_files.find do |uploaded_file|
-        component.id == uploaded_file.component.id
-      end
-    end
-
-    def error_message_hash
-      {
-        control: page_answers.send(component.id)['original_filename'],
-        schema_key.to_sym => component.validation[schema_key]
-      }
-    end
-  end
-end