cocina-models 0.91.4 → 0.93.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36a4c39bf28e6e40d3adccaccf0c89cd14b24c3807c8bde9ac6ee58fcb1b42e
-  data.tar.gz: 4898c15f9fbe3c6b1b3d3fb33edbe93b4fea5d2c1ca96edd25b91b9166967b29
+  metadata.gz: 9cf74f9126fce8106b3bfd5964c11731c460546a4f457da9ba7f35f895243c7a
+  data.tar.gz: 58467364ec8a96eac4f6d335dce400c0086833830f5704e263bae7365741d473
 SHA512:
-  metadata.gz: 790a2ec388b08ace732d85d27b6544343f658b037791bff63d69527c3baa036073785ff52d4a67a5d483b7bda6da075068f3589db612130df9c15d76b29b7946
-  data.tar.gz: 9b73c7b24751999006863cb8c181f715ff7ff844b83db3d74b5f94a2297860b2a18b4fc31f41fb2ff5af8654d6e7ef1c6701299142b1b232f8d96b55dcd8f2c4
+  metadata.gz: e2106344f663362d1609f5e40daf001c43f976abbbe7ae8a43c52295b2a2e280952c7d6d01b6f6b4cbdf124a07c26372bdfc17f9a903cce666edc39ba3b3db35
+  data.tar.gz: 5675d10901a099d8869baed51c4bdb82608305053d0e830130c28577644daddf73a650410cb20425e4e27ff4dfc60188f0e2cb0b77954c49bd3f00980ee56cf1

data/.rubocop.yml

@@ -116,6 +116,9 @@ Naming/PredicateName:
 
 # ----- RSpec ------
 
+RSpec/NestedGroups:
+  Max: 5
+
 RSpec/BeEq: # new in 2.9.0
   Enabled: true
 

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2023-06-20 05:46:00 UTC using RuboCop version 1.52.1.
+# on 2023-11-01 19:51:40 UTC using RuboCop version 1.57.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -57,18 +57,11 @@ Metrics/ParameterLists:
 RSpec/DescribeClass:
   Enabled: false
 
-# Offense count: 87
+# Offense count: 224
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 103
 
-# Offense count: 10
-# Configuration parameters: Max, AllowedGroups.
-RSpec/NestedGroups:
-  Exclude:
-    - 'spec/cocina/models/mapping/normalizers/mods/origin_info_normalizer_spec.rb'
-    - 'spec/cocina/models/validators/date_time_validator_spec.rb'
-
 # Offense count: 19
 RSpec/PendingWithoutReason:
   Exclude:
@@ -99,7 +92,7 @@ Style/MultilineBlockChain:
     - 'lib/cocina/models/mapping/to_mods/form.rb'
     - 'lib/cocina/models/mapping/to_mods/subject.rb'
 
-# Offense count: 239
+# Offense count: 249
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    cocina-models (0.91.4)
+    cocina-models (0.93.0)
       activesupport
       deprecation
       dry-struct (~> 1.0)
       dry-types (~> 1.1)
       edtf
       equivalent-xml
+      i18n
       jsonpath
       nokogiri
       openapi3_parser
@@ -79,7 +80,7 @@ GEM
     jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
-    mini_portile2 (2.8.4)
+    mini_portile2 (2.8.5)
     minitest (5.20.0)
     multi_json (1.15.0)
     mutex_m (0.1.2)
@@ -96,10 +97,10 @@ 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.0.6)
+    rake (13.1.0)
     regexp_parser (2.8.2)
     rexml (3.2.6)
     rspec (3.12.0)
@@ -119,8 +120,7 @@ GEM
       rspec-core (>= 2, < 4, != 2.12.0)
     rss (0.3.0)
       rexml
-    rubocop (1.57.1)
-      base64 (~> 0.1.1)
+    rubocop (1.57.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -131,7 +131,7 @@ GEM
       rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
@@ -139,8 +139,8 @@ GEM
       rubocop (~> 1.33)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.24.1)
-      rubocop (~> 1.33)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
@@ -155,7 +155,7 @@ GEM
       attr_extras (>= 6.2.4)
       diff-lcs
       patience_diff
-    thor (1.2.2)
+    thor (1.3.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)

data/cocina-models.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dry-types', '~> 1.1'
   spec.add_dependency 'edtf' # used for date/time validation
   spec.add_dependency 'equivalent-xml' # for diffing MODS
+  spec.add_dependency 'i18n' # for validating BCP 47 language tags, according to RFC 4646
   spec.add_dependency 'jsonpath' # used for date/time validation
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'openapi3_parser' # Parsing openapi doc

data/docs/description_types.md

@@ -363,6 +363,8 @@ _Path: identifier.type_
   * document number
   * DOI
   * druid
+  * FOLIO
+    * FOLIO HRID for the source record of the metadata.
   * GTIN-14 ID
   * Handle
   * inventory number

data/lib/cocina/models/file.rb

@@ -22,8 +22,10 @@ module Cocina
       attribute :version, Types::Strict::Integer
       # 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, 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,8 +13,11 @@ module Cocina
       attribute? :size, Types::Strict::Integer
       attribute :version, Types::Strict::Integer
       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, 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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates that a languageTag is valid according to RFC 4646, if one is present
+      class LanguageTagValidator
+        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, 'Some files have invalid language tags according to RFC 4646: ' \
+                                 "#{invalid_filenames_with_language_tags.join(', ')}"
+        end
+
+        private
+
+        attr_reader :clazz, :attributes
+
+        def meets_preconditions?
+          dro?
+        end
+
+        def dro?
+          (clazz::TYPES & DRO::TYPES).any?
+        rescue NameError
+          false
+        end
+
+        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?
+
+              fileset[:structural][:contains].each do |file|
+                files << file
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -15,7 +15,8 @@ module Cocina
           # See also spec/cocina/models/validatable_spec.rb:59
           # DescriptionTypesValidator,
           DescriptionValuesValidator,
-          DateTimeValidator
+          DateTimeValidator,
+          LanguageTagValidator
         ].freeze
 
         def self.validate(clazz, attributes)

data/lib/cocina/models/version.rb

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

data/openapi.yml

@@ -1044,9 +1044,10 @@ components:
         hasMimeType:
           description: MIME Type of the File.
           type: string
+        languageTag:
+          $ref: '#/components/schemas/LanguageTag'
         use:
-          description: Use for the File.
-          type: string
+          $ref: '#/components/schemas/FileUse'
         hasMessageDigests:
           type: array
           items:
@@ -1141,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
@@ -1269,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
@@ -1775,10 +1784,12 @@ components:
           type: integer
         hasMimeType:
           type: string
+        languageTag:
+          $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.91.4
+  version: 0.93.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jsonpath
   requirement: !ruby/object:Gem::Requirement
@@ -415,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
@@ -516,6 +532,7 @@ files:
 - lib/cocina/models/validators/date_time_validator.rb
 - lib/cocina/models/validators/description_types_validator.rb
 - lib/cocina/models/validators/description_values_validator.rb
+- lib/cocina/models/validators/language_tag_validator.rb
 - lib/cocina/models/validators/open_api_validator.rb
 - lib/cocina/models/validators/purl_validator.rb
 - lib/cocina/models/validators/validator.rb
@@ -545,7 +562,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Data models for the SDR