cocina-models 0.92.0 → 0.93.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fb90197036280ad978dc4e59b548fcb954d7b602799294cfdde8bd3ef2a1568
-  data.tar.gz: fd7c2c49522772f866dc04d629296c537f88d88dd8943ce4b74bb77460be31d9
+  metadata.gz: 9cf74f9126fce8106b3bfd5964c11731c460546a4f457da9ba7f35f895243c7a
+  data.tar.gz: 58467364ec8a96eac4f6d335dce400c0086833830f5704e263bae7365741d473
 SHA512:
-  metadata.gz: 84a09b86f9f922ba9b8c433760fe3613035d72cba102f5a93dc9e7ec07a4d7bfdef5f449375fa4792eb0b8045f3324f23360183b0f9b5aa8ea21082336681b22
-  data.tar.gz: 93b59a61650aae4c19cab66d84a216f66f65a289444e58fc48fdbd9088d33dd083fe9c57f57971574dae13a0b21ab4453ee48f8bad14f408ee3149534eb2aa99
+  metadata.gz: e2106344f663362d1609f5e40daf001c43f976abbbe7ae8a43c52295b2a2e280952c7d6d01b6f6b4cbdf124a07c26372bdfc17f9a903cce666edc39ba3b3db35
+  data.tar.gz: 5675d10901a099d8869baed51c4bdb82608305053d0e830130c28577644daddf73a650410cb20425e4e27ff4dfc60188f0e2cb0b77954c49bd3f00980ee56cf1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocina-models (0.92.0)
+    cocina-models (0.93.0)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -97,7 +97,7 @@ GEM
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
-    racc (1.7.1)
+    racc (1.7.3)
     rack (3.0.8)
     rainbow (3.1.1)
     rake (13.1.0)

data/lib/cocina/models/file.rb

@@ -23,9 +23,9 @@ module Cocina
       # MIME Type of the File.
       attribute? :hasMimeType, Types::Strict::String
       # BCP 47 language tag: https://www.rfc-editor.org/rfc/rfc4646.txt -- other applications (like media players) expect language codes of this format, see e.g. https://videojs.com/guides/text-tracks/#srclang
-      attribute? :languageTag, Types::Strict::String
+      attribute? :languageTag, LanguageTag.optional
       # Use for the File.
-      attribute? :use, Types::Strict::String
+      attribute? :use, FileUse.optional
       attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([].freeze)
       attribute(:access, FileAccess.default { FileAccess.new })
       attribute(:administrative, FileAdministrative.default { FileAdministrative.new })

data/lib/cocina/models/file_use.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    FileUse = Types::String
+  end
+end

data/lib/cocina/models/language_tag.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    LanguageTag = Types::String
+  end
+end

data/lib/cocina/models/request_file.rb

@@ -13,9 +13,11 @@ module Cocina
       attribute? :size, Types::Strict::Integer
       attribute :version, Types::Strict::Integer
       attribute? :hasMimeType, Types::Strict::String
-      attribute? :languageTag, Types::Strict::String
+      # BCP 47 language tag: https://www.rfc-editor.org/rfc/rfc4646.txt -- other applications (like media players) expect language codes of this format, see e.g. https://videojs.com/guides/text-tracks/#srclang
+      attribute? :languageTag, LanguageTag.optional
       attribute? :externalIdentifier, Types::Strict::String
-      attribute? :use, Types::Strict::String
+      # Use for the File.
+      attribute? :use, FileUse.optional
       attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([].freeze)
       attribute(:access, FileAccess.default { FileAccess.new })
       attribute(:administrative, FileAdministrative.default { FileAdministrative.new })

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

@@ -39,12 +39,7 @@ module Cocina
         end
 
         def invalid_files
-          @invalid_files ||=
-            [].tap do |invalid_files|
-              files.each do |file|
-                invalid_files << file if invalid?(file)
-              end
-            end
+          @invalid_files ||= files.select { |file| invalid?(file) }
         end
 
         def invalid_filenames

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

@@ -12,7 +12,8 @@ module Cocina
         def initialize(clazz, attributes)
           @clazz = clazz
           @attributes = attributes
-          @error_paths = []
+          @error_paths_multiple = []
+          @error_paths_blank = []
         end
 
         def validate
@@ -20,21 +21,21 @@ module Cocina
 
           validate_obj(attributes, [])
 
-          return if error_paths.empty?
-
-          raise ValidationError, "Multiple value, groupedValue, structuredValue, and parallelValue in description: #{error_paths.join(', ')}"
+          raise ValidationError, "Multiple value, groupedValue, structuredValue, and parallelValue in description: #{error_paths_multiple.join(', ')}" unless error_paths_multiple.empty?
+          raise ValidationError, "Blank value in description: #{error_paths_blank.join(', ')}" unless error_paths_blank.empty?
         end
 
         private
 
-        attr_reader :clazz, :attributes, :error_paths
+        attr_reader :clazz, :attributes, :error_paths_blank, :error_paths_multiple
 
         def meets_preconditions?
           [Cocina::Models::Description, Cocina::Models::RequestDescription].include?(clazz)
         end
 
         def validate_hash(hash, path)
-          validate_values(hash, path)
+          validate_values_for_blanks(hash, path)
+          validate_values_for_multiples(hash, path)
           hash.each do |key, obj|
             validate_obj(obj, path + [key])
           end
@@ -51,10 +52,16 @@ module Cocina
           validate_array(obj, path) if obj.is_a?(Array)
         end
 
-        def validate_values(hash, path)
+        def validate_values_for_blanks(hash, path)
+          return unless hash[:value] && hash[:value].is_a?(String) && /\A\s+\z/.match?(hash[:value]) # rubocop:disable Style/SafeNavigation
+
+          error_paths_blank << path_to_s(path)
+        end
+
+        def validate_values_for_multiples(hash, path)
           return unless hash.count { |key, value| %i[value groupedValue structuredValue parallelValue].include?(key) && value.present? } > 1
 
-          error_paths << path_to_s(path)
+          error_paths_multiple << path_to_s(path)
         end
 
         def path_to_s(path)

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

@@ -17,10 +17,10 @@ module Cocina
         def validate
           return unless meets_preconditions?
 
-          return if valid_language_tag?
+          return if invalid_files.empty?
 
-          raise ValidationError, 'The provided language tag is not valid according to RFC 4646: ' \
-                                 "#{attributes[:languageTag]}"
+          raise ValidationError, 'Some files have invalid language tags according to RFC 4646: ' \
+                                 "#{invalid_filenames_with_language_tags.join(', ')}"
         end
 
         private
@@ -28,19 +28,45 @@ module Cocina
         attr_reader :clazz, :attributes
 
         def meets_preconditions?
-          file? && attributes[:languageTag].present?
+          dro?
         end
 
-        def file?
-          (clazz::TYPES & File::TYPES).any?
+        def dro?
+          (clazz::TYPES & DRO::TYPES).any?
         rescue NameError
           false
         end
 
-        def valid_language_tag?
-          parsed_tag = I18n::Locale::Tag::Rfc4646.tag(attributes[:languageTag])
+        def valid_language_tag?(file)
+          # I18n::Locale::Tag::Rfc4646.tag will return an instance of I18n::Locale::Tag::Rfc4646 (with fields like language, script,
+          # region) for strings that can be parsed according to RFC 4646, and nil for strings that do not conform to the spec.
+          I18n::Locale::Tag::Rfc4646.tag(file[:languageTag]).present?
+        end
+
+        def invalid_files
+          @invalid_files ||= language_tag_files.reject { |file| valid_language_tag?(file) }
+        end
+
+        def invalid_filenames_with_language_tags
+          invalid_files.map { |invalid_file| "#{invalid_file[:filename] || invalid_file[:label]} (#{invalid_file[:languageTag]})" }
+        end
+
+        def language_tag_files
+          files.select { |file| file[:languageTag].present? }
+        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?
 
-          parsed_tag.present? && parsed_tag.is_a?(I18n::Locale::Tag::Rfc4646)
+              fileset[:structural][:contains].each do |file|
+                files << file
+              end
+            end
+          end
         end
       end
     end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.92.0'
+    VERSION = '0.93.0'
   end
 end

data/openapi.yml

@@ -1045,11 +1045,9 @@ components:
           description: MIME Type of the File.
           type: string
         languageTag:
-          description: "BCP 47 language tag: https://www.rfc-editor.org/rfc/rfc4646.txt -- other applications (like media players) expect language codes of this format, see e.g. https://videojs.com/guides/text-tracks/#srclang"
-          type: string
+          $ref: '#/components/schemas/LanguageTag'
         use:
-          description: Use for the File.
-          type: string
+          $ref: '#/components/schemas/FileUse'
         hasMessageDigests:
           type: array
           items:
@@ -1144,6 +1142,10 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/File'
+    FileUse:
+      description: Use for the File.
+      type: string
+      nullable: true
     FolioCatalogLink:
       description: A linkage between an object and a Folio catalog record
       type: object
@@ -1272,6 +1274,10 @@ components:
         valueLanguage:
           # description: present for mapping to additional schemas in the future and for consistency but not otherwise used
           $ref: "#/components/schemas/DescriptiveValueLanguage"
+    LanguageTag:
+      description: "BCP 47 language tag: https://www.rfc-editor.org/rfc/rfc4646.txt -- other applications (like media players) expect language codes of this format, see e.g. https://videojs.com/guides/text-tracks/#srclang"
+      type: string
+      nullable: true
     License:
       description: The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
       type: string
@@ -1779,11 +1785,11 @@ components:
         hasMimeType:
           type: string
         languageTag:
-          type: string
+          $ref: '#/components/schemas/LanguageTag'
         externalIdentifier:
           type: string
         use:
-          type: string
+          $ref: '#/components/schemas/FileUse'
         hasMessageDigests:
           type: array
           items:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.92.0
+  version: 0.93.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -429,11 +429,13 @@ files:
 - lib/cocina/models/file_set.rb
 - lib/cocina/models/file_set_structural.rb
 - lib/cocina/models/file_set_type.rb
+- lib/cocina/models/file_use.rb
 - lib/cocina/models/folio_catalog_link.rb
 - lib/cocina/models/geographic.rb
 - lib/cocina/models/identification.rb
 - lib/cocina/models/lane_medical_barcode.rb
 - lib/cocina/models/language.rb
+- lib/cocina/models/language_tag.rb
 - lib/cocina/models/license.rb
 - lib/cocina/models/location_based_access.rb
 - lib/cocina/models/location_based_download_access.rb