cocina-models 0.71.0 → 0.73.1

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates that shelve and publish file attributes are set to false for dark DRO objects.
+      class DarkValidator
+        def self.validate(clazz, attributes)
+          new(clazz, attributes).validate
+        end
+
+        def initialize(clazz, attributes)
+          @clazz = clazz
+          @attributes = attributes
+        end
+
+        def validate
+          return unless meets_preconditions?
+
+          return if invalid_files.empty?
+
+          raise ValidationError, 'Not all files have dark access and/or are unshelved ' \
+                                 "when object access is dark: #{invalid_filenames}"
+        end
+
+        private
+
+        attr_reader :clazz, :attributes
+
+        def meets_preconditions?
+          dro? && attributes.dig(:access, :view) == 'dark'
+        end
+
+        def dro?
+          (clazz::TYPES & DRO::TYPES).any?
+        rescue NameError
+          false
+        end
+
+        def invalid_files
+          @invalid_files ||=
+            [].tap do |invalid_files|
+              files.each do |file|
+                invalid_files << file if invalid?(file)
+              end
+            end
+        end
+
+        def invalid_filenames
+          invalid_files.map { |invalid_file| invalid_file[:filename] || invalid_file[:label] }
+        end
+
+        def invalid?(file)
+          # Ignore if a WARC
+          return false if file[:hasMimeType] == 'application/warc'
+
+          return true if file.dig(:administrative, :shelve)
+          return true if file.dig(:access, :view) != 'dark'
+
+          false
+        end
+
+        def files
+          [].tap do |files|
+            next if attributes.dig(:structural, :contains).nil?
+
+            attributes[:structural][:contains].each do |fileset|
+              next if fileset.dig(:structural, :contains).nil?
+
+              fileset[:structural][:contains].each do |file|
+                files << file
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates types for description against description_types.yml.
+      class DescriptionTypesValidator
+        def self.validate(clazz, attributes)
+          new(clazz, attributes).validate
+        end
+
+        def initialize(clazz, attributes)
+          @clazz = clazz
+          @attributes = attributes
+          @error_paths = []
+        end
+
+        def validate
+          return unless meets_preconditions?
+
+          validate_obj(attributes, [])
+
+          return if error_paths.empty?
+
+          raise ValidationError, "Unrecognized types in description: #{error_paths.join(', ')}"
+        end
+
+        private
+
+        attr_reader :clazz, :attributes, :error_paths
+
+        def meets_preconditions?
+          attributes.key?(:description) || [Cocina::Models::Description,
+                                            Cocina::Models::RequestDescription].include?(clazz)
+        end
+
+        def validate_hash(hash, path)
+          hash.each do |key, obj|
+            if key == :type
+              validate_type(obj, path)
+            else
+              validate_obj(obj, path + [key])
+            end
+          end
+        end
+
+        def validate_array(array, path)
+          array.each_with_index do |obj, index|
+            validate_obj(obj, path + [index])
+          end
+        end
+
+        def validate_obj(obj, path)
+          validate_hash(obj, path) if obj.is_a?(Hash)
+          validate_array(obj, path) if obj.is_a?(Array)
+        end
+
+        def validate_type(type, path)
+          valid_types.each do |type_signature, types|
+            next unless match?(path, type_signature)
+            break if types.include?(type.downcase)
+
+            error_paths << path_to_s(path)
+            break
+          end
+        end
+
+        def match?(path, type_signature)
+          clean_path(path).last(type_signature.length) == type_signature
+        end
+
+        # 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 parallelContributor parallelEvent].include?(part)
+          end
+          # This needs to happen after parallelValue is removed
+          # to handle structuredValue > parallelValue > structuredValue
+          new_path.reject.with_index do |part, index|
+            part == :structuredValue && new_path[index - 1] == :structuredValue
+          end
+        end
+
+        # rubocop:disable Style/ClassVars
+        def valid_types
+          # Class var to minimize loading from disk.
+          @@valid_types ||= begin
+            types = types_yaml.map do |type_signature_str, type_objs|
+              type_signature = type_signature_str.split('.').map(&:to_sym)
+              types = type_objs.map { |type_obj| type_obj['value'].downcase }
+              [type_signature, types]
+            end
+            # Sorting so that longer signatures match first.
+            types.sort { |a, b| b.first.length <=> a.first.length }
+          end
+        end
+        # rubocop:enable Style/ClassVars
+
+        def types_yaml
+          YAML.load_file(::File.expand_path('../../../../description_types.yml', __dir__))
+        end
+
+        def path_to_s(path)
+          # This matches the format used by descriptive spreadsheets
+          path_str = ''
+          path.each_with_index do |part, index|
+            if part.is_a?(Integer)
+              path_str += (part + 1).to_s
+            else
+              path_str += '.' if index.positive?
+              path_str += part.to_s
+            end
+          end
+          path_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Perform validation against openapi
+      class OpenApiValidator
+        def self.validate(clazz, attributes)
+          return unless clazz.name
+
+          method_name = clazz.name.split('::').last
+          request_operation = root.request_operation(:post, "/validate/#{method_name}")
+
+          # JSON.parse forces serialization of objects like DateTime.
+          json_attributes = JSON.parse(attributes.to_json)
+          # Inject cocinaVersion if needed and not present.
+          if operation_has_cocina_version?(request_operation) && !json_attributes.include?('cocinaVersion')
+            json_attributes['cocinaVersion'] = Cocina::Models::VERSION
+          end
+
+          request_operation.validate_request_body('application/json', json_attributes)
+        rescue OpenAPIParser::OpenAPIError => e
+          raise ValidationError, e.message
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/CyclomaticComplexity
+        def self.operation_has_cocina_version?(request_operation)
+          schema = request_operation.operation_object.request_body.content['application/json'].schema
+          all_of_properties = Array(schema.all_of&.flat_map { |all_of| all_of.properties&.keys }).compact
+          one_of_properties = Array(schema.one_of&.flat_map { |one_of| one_of.properties&.keys }).compact
+          properties = Array(schema.properties&.keys)
+          (properties + all_of_properties + one_of_properties).include?('cocinaVersion')
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/CyclomaticComplexity
+        private_class_method :operation_has_cocina_version?
+
+        # rubocop:disable Style/ClassVars
+        def self.root
+          @@root ||= OpenAPIParser.parse(YAML.load_file(openapi_path), strict_reference_validation: true)
+        end
+        # rubocop:enable Style/ClassVars
+        private_class_method :root
+
+        def self.openapi_path
+          ::File.expand_path('../../../../openapi.yml', __dir__)
+        end
+        private_class_method :openapi_path
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Perform validation against all other Validators
+      class Validator
+        VALIDATORS = [
+          OpenApiValidator,
+          DarkValidator,
+          CatalogLinksValidator,
+          DescriptionTypesValidator
+        ].freeze
+
+        def self.validate(clazz, attributes)
+          VALIDATORS.each { |validator| validator.validate(clazz, attributes) }
+        end
+      end
+    end
+  end
+end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.71.0'
+    VERSION = '0.73.1'
   end
 end

data/lib/cocina/models/vocabulary.rb

@@ -25,6 +25,15 @@ module Cocina
       def self.properties
         @properties ||= {}
       end
+
+      ##
+      # Returns the URI for the term `property` in this vocabulary.
+      #
+      # @param  [#to_sym] property
+      # @return [String]
+      def self.[](property)
+        properties[property.to_sym]
+      end
     end
   end
 end

data/openapi.yml

@@ -161,11 +161,8 @@ components:
           description: Name of role
           type: string
           enum:
-            - 'dor-apo-creator'
             - 'dor-apo-depositor'
             - 'dor-apo-manager'
-            - 'dor-apo-metadata'
-            - 'dor-apo-reviewer'
             - 'dor-apo-viewer'
             - 'sdr-administrator'
             - 'sdr-viewer'
@@ -369,18 +366,28 @@ components:
     CatalogLink:
       type: object
       additionalProperties: false
-      required:
-        - catalog
-        - catalogRecordId
       properties:
         catalog:
           description: Catalog that is the source of the linked record.
           type: string
+          enum:
+            - symphony
+            - previous symphony
           example: symphony
+        refresh:
+          description: Only one of the catkeys should be designated for refreshing.
+            This means that this key is the one used to pull metadata from the catalog
+            if there is more than one key present.
+          type: boolean
+          default: false
         catalogRecordId:
           description: Record identifier that is unique within the context of the linked record's catalog.
           type: string
           example: '11403803'
+      required:
+        - catalog
+        - catalogRecordId
+        - refresh
     CatkeyBarcode:
       description: The barcode associated with a DRO object based on catkey, prefixed with 36105
       type: string
@@ -516,7 +523,7 @@ components:
           items:
             $ref: "#/components/schemas/DescriptiveValue"
         type:
-          description: Entity type of the contributor (person, organization, etc.).
+          description: Entity type of the contributor (person, organization, etc.). See https://sul-dlss.github.io/cocina-models/description_types.html for valid types.
           type: string
         status:
           description: Status of the contributor relative to other parallel contributors
@@ -705,7 +712,7 @@ components:
               # https://github.com/interagent/committee/issues/286
               # - type: integer
             type:
-              description: Type of value provided by the descriptive element.
+              description: Type of value provided by the descriptive element. See https://sul-dlss.github.io/cocina-models/description_types.html for valid types.
               type: string
             status:
               description: Status of the descriptive element value relative to other instances
@@ -781,7 +788,7 @@ components:
           items:
             $ref: "#/components/schemas/DescriptiveValue"
         type:
-          description: Entity type of the contributor (person, organization, etc.).
+          description: Entity type of the contributor (person, organization, etc.). See https://sul-dlss.github.io/cocina-models/description_types.html for valid types.
           type: string
         status:
           description: Status of the contributor relative to other parallel contributors (e.g. the primary author among a group of contributors).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.71.0
+  version: 0.73.1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -274,7 +274,10 @@ files:
 - bin/console
 - bin/setup
 - cocina-models.gemspec
+- description_types.yml
+- docs/_config.yml
 - docs/cocina-base.jsonld
+- docs/description_types.md
 - docs/index.html
 - docs/maps/Agent.json
 - docs/maps/Collection.json
@@ -384,7 +387,11 @@ files:
 - lib/cocina/models/title.rb
 - lib/cocina/models/title_builder.rb
 - lib/cocina/models/validatable.rb
-- lib/cocina/models/validator.rb
+- lib/cocina/models/validators/catalog_links_validator.rb
+- lib/cocina/models/validators/dark_validator.rb
+- lib/cocina/models/validators/description_types_validator.rb
+- lib/cocina/models/validators/open_api_validator.rb
+- lib/cocina/models/validators/validator.rb
 - lib/cocina/models/version.rb
 - lib/cocina/models/vocabulary.rb
 - lib/cocina/models/world_access.rb
@@ -410,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.9
 signing_key:
 specification_version: 4
 summary: Data models for the SDR

data/lib/cocina/models/validator.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Cocina
-  module Models
-    # Perform validation against openapi
-    class Validator
-      def self.validate(clazz, attributes)
-        method_name = clazz.name.split('::').last
-        request_operation = root.request_operation(:post, "/validate/#{method_name}")
-
-        # JSON.parse forces serialization of objects like DateTime.
-        json_attributes = JSON.parse(attributes.to_json)
-        # Inject cocinaVersion if needed and not present.
-        if operation_has_cocina_version?(request_operation) && !json_attributes.include?('cocinaVersion')
-          json_attributes['cocinaVersion'] = Cocina::Models::VERSION
-        end
-
-        request_operation.validate_request_body('application/json', json_attributes)
-      rescue OpenAPIParser::OpenAPIError => e
-        raise ValidationError, e.message
-      end
-
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/CyclomaticComplexity
-      def self.operation_has_cocina_version?(request_operation)
-        schema = request_operation.operation_object.request_body.content['application/json'].schema
-        all_of_properties = Array(schema.all_of&.flat_map { |all_of| all_of.properties&.keys }).compact
-        one_of_properties = Array(schema.one_of&.flat_map { |one_of| one_of.properties&.keys }).compact
-        properties = Array(schema.properties&.keys)
-        (properties + all_of_properties + one_of_properties).include?('cocinaVersion')
-      end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/CyclomaticComplexity
-      private_class_method :operation_has_cocina_version?
-
-      # rubocop:disable Style/ClassVars
-      def self.root
-        @@root ||= OpenAPIParser.parse(YAML.load_file(openapi_path), strict_reference_validation: true)
-      end
-      # rubocop:enable Style/ClassVars
-      private_class_method :root
-
-      def self.openapi_path
-        ::File.expand_path('../../../openapi.yml', __dir__)
-      end
-      private_class_method :openapi_path
-    end
-  end
-end