cocina-models 0.128.0 → 0.130.0

data/lib/cocina/models/validators/composite_structural_validator.rb

@@ -18,7 +18,7 @@ module Cocina
         def initialize(clazz, attributes, validators: VALIDATORS)
           @clazz = clazz
           @attributes = attributes
-          @validators = validators.map { |v| v.new(attributes) }
+          @validators = meets_preconditions? ? validators.map { |v| v.new(attributes) } : []
         end
 
         def validate

data/lib/cocina/models/validators/description_form_source_code_visitor_validator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates form.source.code values against form_source_codes.yml.
+      class DescriptionFormSourceCodeVisitorValidator < BaseDescriptionVisitorValidator
+        def validate!
+          return if error_paths.empty?
+
+          raise ValidationError, "Unrecognized form source codes in description: #{error_paths.join(', ')}"
+        end
+
+        def visit_hash(hash:, path:)
+          return unless form_entry_path?(path)
+
+          source_code = hash.dig(:source, :code)
+          return unless source_code
+
+          error_paths << "#{path_to_s(path)}.source.code (#{source_code})" unless valid_codes.include?(source_code.downcase)
+        end
+
+        private
+
+        def error_paths
+          @error_paths ||= []
+        end
+
+        def form_entry_path?(path)
+          path.length >= 2 && path[-1].is_a?(Integer) && path[-2].to_s == 'form'
+        end
+
+        # rubocop:disable Style/ClassVars
+        def valid_codes
+          @@valid_codes ||= YAML.load_file(::File.expand_path('../../../../form_source_codes.yml', __dir__)).to_set(&:downcase)
+        end
+        # rubocop:enable Style/ClassVars
+      end
+    end
+  end
+end

data/lib/cocina/models/validators/description_types_visitor_validator.rb

@@ -41,7 +41,7 @@ module Cocina
         # Some part of the path are ignored for the purpose of matching.
         def clean_path(path)
           new_path = path.reject do |part|
-            part.is_a?(Integer) || %i[parallelValue parallelEvent].include?(part.to_sym)
+            part.is_a?(Integer) || %i[parallelValue].include?(part.to_sym)
           end.map(&:to_sym)
           # This needs to happen after parallelValue is removed
           # to handle structuredValue > parallelValue > structuredValue

data/lib/cocina/models/validators/json_schema_validator.rb

@@ -25,6 +25,11 @@ module Cocina
 
         # @see #validate
         def self.validate(...)
+          # Skip when nested inside another Validatable's construction: the enclosing object's own
+          # schema check already covers this, so re-evaluating it here would be
+          # redundant. See Validatable#new.
+          return if Thread.current[:cocina_construction_depth].to_i.positive?
+
           new(...).validate
         end
 
@@ -67,7 +72,7 @@ module Cocina
           evaluation = self.class.validator_for(method_name).evaluate(attributes.as_json)
           return if evaluation.valid?
 
-          raise ValidationError, "When validating #{method_name}: " + filtered_error_messages(evaluation).join(', ')
+          raise ValidationError, "When validating #{method_name}: " + filtered_error_messages(evaluation).join('; ')
         end
 
         private
@@ -90,7 +95,7 @@ module Cocina
           denoised.flat_map { |d| format_detail(d) }.uniq
         end
 
-        # Removes two categories of cascade noise produced by `unevaluatedProperties: false`:
+        #  Removes three categories of cascade noise from errors:
         #
         #   1. falseSchema errors — every `unevaluatedProperties: false` on a sub-path emits
         #      a "False schema does not allow …" entry for each matched value.  These are
@@ -100,8 +105,28 @@ module Cocina
         #      is a known model attribute — these arise because allOf/$ref composition means
         #      the validator can't prove top-level properties were "evaluated", even though
         #      they are valid model fields.
+        #
+        #   3. anyOf branch noise — when each branch requires a different property, all failing
+        #      branches emit a separate "required" error at the same path. Collapse into one
+        #      "needs to include at least one of: …" message.
         def denoise(details)
-          details.reject { |d| false_schema_noise?(d) || root_unevaluated_noise?(d) }
+          filtered = details.reject { |detail| false_schema_noise?(detail) || root_unevaluated_noise?(detail) }
+          collapse_anyof_required(filtered)
+        end
+
+        def collapse_anyof_required(details)
+          # instanceLocation is the input data that failed. Group errors for each failing data location.
+          details.group_by { |detail| detail[:instanceLocation] }.flat_map do |loc, group|
+            # splits errors into "required" anyOf errors and others (minItems, unevaluatedProperties)
+            required, others = group.partition { |detail| detail[:errors].keys == ['required'] }
+            next group if required.size <= 1
+
+            # Extract property name from "required" messages such as, '"url" is a required property'
+            props = required.filter_map { |detail| detail[:errors]['required'][/"([^"]+)"/, 1] }.uniq
+            # Put the data path at the start of the message; blank instanceLocation so format_detail won't also append it
+            msg = "#{loc} needs to include at least one of the following: #{props.join(', ')}"
+            others + [required.first.merge(instanceLocation: '', errors: { 'required' => msg })]
+          end
         end
 
         def false_schema_noise?(detail)
@@ -120,12 +145,32 @@ module Cocina
           unexpected.all? { |prop| known_root_properties.include?(prop) }
         end
 
+        # Formats error details hash into more user-friendly messages
+        # A detail can carry multiple errors (one per JSON Schema keyword), so this returns an array.
+        # minItems errors get a dedicated formatter; everything else uses the generic one.
         def format_detail(detail)
           loc = detail[:instanceLocation]
-          detail[:errors].map do |_keyword, message|
-            loc.empty? ? message : "#{message} at #{loc}"
+          detail[:errors].map do |keyword, message|
+            keyword == 'minItems' ? format_min_items(message, loc) : format_generic(message, loc)
           end
         end
+
+        # Rewrites messages regarding minItems validation
+        # "[] has less than 1 item at /event/0/date " is rewritten to "/event/0/date is empty but should have at least 1 item"
+        # Arrays with items but fewer than the minimum will be rewritten to "/event/0/date should have at least 2 items"
+        def format_min_items(message, loc)
+          # extract minimum number of items from message
+          min = message[/less than (\d+)/, 1] || '1'
+          # pluralize "item" when appropriate
+          items = min == '1' ? 'item' : 'items'
+          # determine if the message is about an empty array or an non-empty array without enough items
+          prefix = message.start_with?('[]') ? "#{loc} is empty but" : loc.to_s
+          "#{prefix} should have at least #{min} #{items}"
+        end
+
+        def format_generic(message, loc)
+          loc.empty? ? message : "#{message} at #{loc}"
+        end
       end
     end
   end

data/lib/cocina/models/validators/validator.rb

@@ -16,12 +16,22 @@ module Cocina
         ].freeze
 
         def self.validate(clazz, attributes, validators: VALIDATORS)
-          # This gets rid of nested model objects.
-          attributes_hash = attributes.to_h.deep_transform_values do |value|
+          hash = attributes_hash(attributes)
+          validators.each { |validator| validator.validate(clazz, hash) }
+        end
+
+        # @return [Hash] attributes with any embedded Cocina model instances flattened to hashes
+        def self.attributes_hash(attributes)
+          # Dry::Struct#to_h is already fully recursive (Dry::Struct::Hashify flattens nested
+          # structs all the way down), so a Cocina model instance's #to_h has no embedded
+          # Cocina model instances left to flatten and the deep walk below would be a no-op.
+          return attributes.to_h.with_indifferent_access if attributes.class.name.starts_with?('Cocina::Models')
+
+          attributes.to_h.deep_transform_values do |value|
             value.class.name.starts_with?('Cocina::Models') ? value.to_h : value
           end.with_indifferent_access
-          validators.each { |validator| validator.validate(clazz, attributes_hash) }
         end
+        private_class_method :attributes_hash
 
         def self.deep_transform_values(object, ...)
           case object

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.128.0'
+    VERSION = '0.130.0'
   end
 end

data/schema.json

@@ -1270,70 +1270,6 @@
         }
       }
     },
-    "DescriptiveParallelEvent": {
-      "description": "Value model for multiple representations of information about the same event (e.g. in different languages).",
-      "type": "object",
-      "allOf": [
-        {
-          "$ref": "#/$defs/DescriptiveStructuredValue"
-        },
-        {
-          "type": "object",
-          "properties": {
-            "type": {
-              "description": "Description of the event (creation, publication, etc.).",
-              "type": "string"
-            },
-            "displayLabel": {
-              "description": "The preferred display label to use for the event in access systems.",
-              "type": [
-                "string",
-                "null"
-              ]
-            },
-            "date": {
-              "description": "Dates associated with the event.",
-              "type": "array",
-              "items": {
-                "$ref": "#/$defs/DescriptiveValue"
-              }
-            },
-            "contributor": {
-              "description": "Contributors associated with the event.",
-              "type": "array",
-              "items": {
-                "$ref": "#/$defs/Contributor"
-              }
-            },
-            "location": {
-              "description": "Locations associated with the event.",
-              "type": "array",
-              "items": {
-                "$ref": "#/$defs/DescriptiveValue"
-              }
-            },
-            "identifier": {
-              "description": "Identifiers and URIs associated with the event.",
-              "type": "array",
-              "items": {
-                "$ref": "#/$defs/DescriptiveIdentifier"
-              }
-            },
-            "note": {
-              "description": "Other information about the event.",
-              "type": "array",
-              "items": {
-                "$ref": "#/$defs/DescriptiveValue"
-              }
-            },
-            "valueLanguage": {
-              "$ref": "#/$defs/DescriptiveValueLanguage"
-            }
-          }
-        }
-      ],
-      "unevaluatedProperties": false
-    },
     "DescriptiveParallelValue": {
       "description": "Value model for multiple representations of the same information (e.g. in different languages).",
       "type": "object",
@@ -1529,13 +1465,6 @@
             },
             "valueLanguage": {
               "$ref": "#/$defs/DescriptiveValueLanguage"
-            },
-            "parallelEvent": {
-              "description": "For multiple representations of information about the same event (e.g. in different languages)",
-              "type": "array",
-              "items": {
-                "$ref": "#/$defs/DescriptiveParallelEvent"
-              }
             }
           }
         }
@@ -1589,14 +1518,6 @@
               "minItems": 1
             }
           }
-        },
-        {
-          "required": ["parallelEvent"],
-          "properties": {
-            "parallelEvent": {
-              "minItems": 1
-            }
-          }
         }
       ]
     },
@@ -2546,9 +2467,21 @@
       "required": [
         "cocinaVersion",
         "administrative",
+        "description",
         "type",
         "version"
       ],
+      "allOf": [
+        {
+          "properties": {
+            "description": {
+              "required": [
+                "title"
+              ]
+            }
+          }
+        }
+      ],
       "unevaluatedProperties": false
     },
     "RequestAdministrative": {
@@ -2616,6 +2549,47 @@
         "type",
         "version"
       ],
+      "anyOf": [
+        {
+          "required": [
+            "description"
+          ],
+          "properties": {
+            "description": {
+              "required": [
+                "title"
+              ]
+            }
+          }
+        },
+        {
+          "required": [
+            "identification"
+          ],
+          "properties": {
+            "identification": {
+              "required": [
+                "catalogLinks"
+              ],
+              "properties": {
+                "catalogLinks": {
+                  "contains": {
+                    "type": "object",
+                    "required": [
+                      "refresh"
+                    ],
+                    "properties": {
+                      "refresh": {
+                        "const": true
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      ],
       "unevaluatedProperties": false
     },
     "RequestDRO": {
@@ -2682,6 +2656,47 @@
         "type",
         "version"
       ],
+      "anyOf": [
+        {
+          "required": [
+            "description"
+          ],
+          "properties": {
+            "description": {
+              "required": [
+                "title"
+              ]
+            }
+          }
+        },
+        {
+          "required": [
+            "identification"
+          ],
+          "properties": {
+            "identification": {
+              "required": [
+                "catalogLinks"
+              ],
+              "properties": {
+                "catalogLinks": {
+                  "contains": {
+                    "type": "object",
+                    "required": [
+                      "refresh"
+                    ],
+                    "properties": {
+                      "refresh": {
+                        "const": true
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      ],
       "unevaluatedProperties": false
     },
     "RequestDROStructural": {
@@ -2803,9 +2818,6 @@
           "type": "string"
         }
       },
-      "required": [
-        "title"
-      ],
       "unevaluatedProperties": false
     },
     "RequestFile": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.128.0
+  version: 0.130.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -326,6 +326,7 @@ files:
 - docs/cocina-base.jsonld
 - docs/description_types.md
 - exe/generator
+- form_source_codes.yml
 - identifier_source_codes.yml
 - iso15924_codes.yml
 - language_uri_iso639_2_codes.yml
@@ -381,7 +382,6 @@ files:
 - lib/cocina/models/descriptive_geographic_metadata.rb
 - lib/cocina/models/descriptive_grouped_value.rb
 - lib/cocina/models/descriptive_identifier.rb
-- lib/cocina/models/descriptive_parallel_event.rb
 - lib/cocina/models/descriptive_parallel_value.rb
 - lib/cocina/models/descriptive_structured_value.rb
 - lib/cocina/models/descriptive_value.rb
@@ -485,6 +485,7 @@ files:
 - lib/cocina/models/validators/description_date_time_visitor_validator.rb
 - lib/cocina/models/validators/description_event_date_visitor_validator.rb
 - lib/cocina/models/validators/description_form_resource_type_visitor_validator.rb
+- lib/cocina/models/validators/description_form_source_code_visitor_validator.rb
 - lib/cocina/models/validators/description_identifier_source_code_visitor_validator.rb
 - lib/cocina/models/validators/description_language_code_visitor_validator.rb
 - lib/cocina/models/validators/description_language_uri_visitor_validator.rb

data/lib/cocina/models/descriptive_parallel_event.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Cocina
-  module Models
-    # Value model for multiple representations of information about the same event (e.g.
-    # in different languages).
-    class DescriptiveParallelEvent < Struct
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # Description of the event (creation, publication, etc.).
-      attribute? :type, Types::Strict::String
-      # The preferred display label to use for the event in access systems.
-      attribute? :displayLabel, Types::Strict::String.optional
-      # Dates associated with the event.
-      attribute :date, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # Contributors associated with the event.
-      attribute :contributor, Types::Strict::Array.of(Contributor).default([].freeze)
-      # Locations associated with the event.
-      attribute :location, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # Identifiers and URIs associated with the event.
-      attribute :identifier, Types::Strict::Array.of(DescriptiveIdentifier).default([].freeze)
-      # Other information about the event.
-      attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # Language of the descriptive element value
-      attribute? :valueLanguage, DescriptiveValueLanguage.optional
-    end
-  end
-end