cocina-models 0.71.0 → 0.72.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5058bc2927b8788ad9c04142decbfcc7cf42b7daa3b84665d64dd00b432d8ff4
-  data.tar.gz: 524263003bc679432b5c120690775de4ebc14ef5fa6158337e0beff9c2bfb332
+  metadata.gz: b5516cbeff2267e688f6a09b34e4a0c715a1aea91ddae03d10060bed3d364c5a
+  data.tar.gz: f47bd2a4ca35c95d3566883707d39a2480c0b7e18ee28bc49042aa90b24e104c
 SHA512:
-  metadata.gz: b84f98459177c74cc822a8dee105412c7023c3fda2e953e1f760c482ae3a2967f610207bb53cd33c510e2b0c861834b4cf1998459b70035ac9b22aa55c83b910
-  data.tar.gz: '018baa839ef5774c3969f91acb9545fb04ddf3be652ae3f3fafbc6458ddd7ec1d7c4ae5d5d33a9a8eab36476519cd310a33b61da34e4f934bef35ef490dc83fd'
+  metadata.gz: 262cdfa4049c7325751645a578b2129f0f5cc4737198b82bea5728a6d693398bf2ab589dea2ae912de2de09e6abd1e3a581b84828f3ebf85ed64ba4c3a71dc25
+  data.tar.gz: 977677a8f5de44340117f3d2fb6ba8553e21c3c61c1770b18d44652008de6e26a6ada747de9546e993a0e4231e2263ad531d97491c5467d8aa8e18f2a303f340

data/lib/cocina/generator/generator.rb

@@ -78,7 +78,6 @@ module Cocina
         'rights_description_builder.rb',
         'title_builder.rb',
         'validatable.rb',
-        'validator.rb',
         'version.rb',
         'vocabulary.rb'
       ].freeze

data/lib/cocina/models/catalog_link.rb

@@ -5,7 +5,9 @@ module Cocina
     class CatalogLink < Struct
       # Catalog that is the source of the linked record.
       # example: symphony
-      attribute :catalog, Types::Strict::String
+      attribute :catalog, Types::Strict::String.enum('symphony', 'previous symphony')
+      # 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.
+      attribute :refresh, Types::Strict::Bool.default(false)
       # Record identifier that is unique within the context of the linked record's catalog.
       # example: 11403803
       attribute :catalogRecordId, Types::Strict::String

data/lib/cocina/models/title_builder.rb

@@ -46,8 +46,7 @@ module Cocina
         result = if cocina_title.value
                    cocina_title.value
                  elsif cocina_title.structuredValue.present?
-                   title_from_structured_values(cocina_title.structuredValue,
-                                                non_sorting_char_count(cocina_title))
+                   title_from_structured_values(cocina_title)
                  elsif cocina_title.parallelValue.present?
                    return build(cocina_title.parallelValue)
                  end
@@ -104,20 +103,17 @@ module Cocina
       # rubocop:disable Metrics/PerceivedComplexity
       # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/AbcSize
-      # @param [Array<Cocina::Models::StructuredValue>] structured_values - the pieces of a structuredValue
-      # @param [Integer] the length of the non_sorting_characters
+      # @param [Cocina::Models::Title] title with structured values
       # @return [String] the title value from combining the pieces of the structured_values by type and order
       #   with desired punctuation per specs
-      def title_from_structured_values(structured_values, non_sorting_char_count)
+      def title_from_structured_values(title)
         structured_title = ''
         part_name_number = ''
         # combine pieces of the cocina structuredValue into a single title
-        structured_values.each do |structured_value|
+        title.structuredValue.each do |structured_value|
           # There can be a structuredValue inside a structuredValue.  For example,
           #   a uniform title where both the name and the title have internal StructuredValue
-          if structured_value.structuredValue.present?
-            return title_from_structured_values(structured_value.structuredValue, non_sorting_char_count)
-          end
+          return title_from_structured_values(structured_value) if structured_value.structuredValue.present?
 
           value = structured_value.value&.strip
           next unless value
@@ -125,8 +121,7 @@ module Cocina
           # additional types:  name, uniform ...
           case structured_value.type&.downcase
           when 'nonsorting characters'
-            non_sorting_size = [non_sorting_char_count - (value&.size || 0), 0].max
-            non_sort_value = "#{value}#{' ' * non_sorting_size}"
+            non_sort_value = "#{value}#{non_sorting_padding(title, value)}"
             structured_title = if structured_title.present?
                                  "#{structured_title}#{non_sort_value}"
                                else
@@ -134,7 +129,7 @@ module Cocina
                                end
           when 'part name', 'part number'
             if part_name_number.blank?
-              part_name_number = part_name_number(structured_values)
+              part_name_number = part_name_number(title.structuredValue)
               structured_title = if !add_punctuation?
                                    [structured_title, part_name_number].join(' ')
                                  elsif structured_title.present?
@@ -168,11 +163,16 @@ module Cocina
         title.sub(%r{[ .,;:/\\]+$}, '')
       end
 
-      def non_sorting_char_count(title)
+      def non_sorting_padding(title, non_sorting_value)
         non_sort_note = title.note&.find { |note| note.type&.downcase == 'nonsorting character count' }
-        return 0 unless non_sort_note
-
-        non_sort_note.value.to_i
+        if non_sort_note
+          padding_count = [non_sort_note.value.to_i - non_sorting_value.length, 0].max
+          ' ' * padding_count
+        elsif ['\'', '-'].include?(non_sorting_value.last)
+          ''
+        else
+          ' '
+        end
       end
 
       # combine part name and part number:

data/lib/cocina/models/validatable.rb

@@ -8,7 +8,7 @@ module Cocina
 
       class_methods do
         def new(attributes = default_attributes, safe = false, validate = true, &block)
-          Validator.validate(self, attributes.with_indifferent_access) if validate && name
+          Validators::Validator.validate(self, attributes.with_indifferent_access) if validate
           super(attributes, safe, &block)
         end
       end
@@ -16,7 +16,7 @@ module Cocina
       def new(*args)
         validate = args.first.delete(:validate) if args.present?
         new_model = super(*args)
-        Validator.validate(new_model.class, new_model.to_h) if (validate || validate.nil?) && self.class.name
+        Validators::Validator.validate(new_model.class, new_model.to_h) if validate || validate.nil?
         new_model
       end
     end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates that only a single CatalogLink has refresh set to true
+      class CatalogLinksValidator
+        MAX_REFRESH_CATALOG_LINKS = 1
+
+        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 refresh_catalog_links.length <= MAX_REFRESH_CATALOG_LINKS
+
+          raise ValidationError, "Multiple catalog links have 'refresh' property set to true " \
+                                 "(only one allowed) #{refresh_catalog_links}"
+        end
+
+        private
+
+        attr_reader :clazz, :attributes
+
+        def meets_preconditions?
+          (dro? || collection?) && Array(attributes.dig(:identification, :catalogLinks)).any?
+        end
+
+        def refresh_catalog_links
+          attributes.dig(:identification, :catalogLinks).select { |catalog_link| catalog_link[:refresh] }
+        end
+
+        def dro?
+          (clazz::TYPES & DRO::TYPES).any?
+        rescue NameError
+          false
+        end
+
+        def collection?
+          (clazz::TYPES & Collection::TYPES).any?
+        rescue NameError
+          false
+        end
+      end
+    end
+  end
+end

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/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,16 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Perform validation against all other Validators
+      class Validator
+        VALIDATORS = [OpenApiValidator, DarkValidator, CatalogLinksValidator].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.72.0'
   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

@@ -369,18 +369,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.71.0
+  version: 0.72.0
 platform: ruby
 authors:
 - Justin Coyne
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2022-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -384,7 +384,10 @@ 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/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
@@ -395,7 +398,7 @@ homepage: https://github.com/sul-dlss/cocina-models
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -411,7 +414,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.32
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Data models for the SDR
 test_files: []

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