cocina-models 0.124.0 → 0.126.0

data/lib/cocina/models/related_resource.rb

@@ -28,7 +28,7 @@ module Cocina
       # Additional information relevant to a related resource.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # Identifiers and URIs associated with the related resource.
-      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveIdentifier).default([].freeze)
       # Property model for indicating the encoding, standard, or syntax to which a value
       # conforms (e.g. RDA).
       attribute? :standard, Standard.optional

data/lib/cocina/models/request_description.rb

@@ -23,7 +23,7 @@ module Cocina
       # Additional information relevant to a resource.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # Identifiers and URIs associated with the resource.
-      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveIdentifier).default([].freeze)
       # Terms associated with the intellectual content of the resource.
       attribute :subject, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # Information about how to access digital and physical versions of the object.

data/lib/cocina/models/title.rb

@@ -25,7 +25,7 @@ module Cocina
       # conforms (e.g. RDA).
       attribute? :encoding, Standard.optional
       # Identifiers and URIs associated with the descriptive element.
-      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveIdentifier).default([].freeze)
       # Property model for indicating the vocabulary, authority, or other origin for a term,
       # code, or identifier.
       attribute? :source, Source.optional

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

@@ -9,12 +9,18 @@ module Cocina
           DescriptionTypesVisitorValidator,
           DescriptionIdentifierSourceCodeVisitorValidator,
           DescriptionRoleSourceCodeVisitorValidator,
+          DescriptionNameSourceCodeVisitorValidator,
           DescriptionFormResourceTypeVisitorValidator,
+          DescriptionLanguageCodeVisitorValidator,
+          DescriptionSubjectSourceCodeVisitorValidator,
           DescriptionValuesVisitorValidator,
           DescriptionDateTimeVisitorValidator,
           DescriptionEventDateVisitorValidator,
           DescriptionSubjectTemporalEncodingVisitorValidator,
-          DescriptionLocationSourceCodeVisitorValidator
+          DescriptionLocationSourceCodeVisitorValidator,
+          DescriptionTitleSourceCodeVisitorValidator,
+          DescriptionLanguageUriVisitorValidator,
+          DescriptionScriptVisitorValidator
         ].freeze
 
         def self.validate(clazz, attributes)

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'cocina_display'
+
+module Cocina
+  module Models
+    module Validators
+      # Validates language.code values against searchworks_languages from cocina_display gem plus mul, und, zxx.
+      class DescriptionLanguageCodeVisitorValidator < BaseDescriptionVisitorValidator
+        EXTRA_VALID_CODES = %w[mul und zxx].freeze
+
+        def validate!
+          return if error_paths.empty?
+
+          raise ValidationError, "Unrecognized language codes in description: #{error_paths.join(', ')}"
+        end
+
+        def visit_hash(hash:, path:)
+          return unless language_path?(path)
+
+          code = hash[:code]
+          return unless code
+
+          error_paths << "#{path_to_s(path)}.code (#{code})" unless valid_codes.include?(code)
+        end
+
+        private
+
+        def error_paths
+          @error_paths ||= []
+        end
+
+        def language_path?(path)
+          path.length >= 2 && path[-1].is_a?(Integer) && path[-2].to_s == 'language'
+        end
+
+        # rubocop:disable Style/ClassVars
+        def valid_codes
+          @@valid_codes ||= begin
+            gem_codes = CocinaDisplay::Languages::Language.searchworks_languages.keys.to_set
+            gem_codes.merge(EXTRA_VALID_CODES)
+          end
+        end
+        # rubocop:enable Style/ClassVars
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates language.uri and valueLanguage.uri against LC ISO 639-2, LC MARC languages,
+      # and 5 approved ISO 639-3 URIs. Both http and https are acceptable.
+      class DescriptionLanguageUriVisitorValidator < BaseDescriptionVisitorValidator
+        ISO639_3_CODES = %w[ase dnt quc skr trw tta].freeze
+
+        def visit_hash(hash:, path:)
+          return unless language_or_value_language_path?(path)
+
+          uri = hash[:uri]
+          return unless uri
+
+          error_paths << "#{path_to_s(path)}.uri (#{uri})" unless valid_uri?(uri)
+        end
+
+        def validate!
+          return if error_paths.empty?
+
+          raise ValidationError, "Invalid language URIs in description: #{error_paths.join(', ')}"
+        end
+
+        private
+
+        def error_paths
+          @error_paths ||= []
+        end
+
+        def language_or_value_language_path?(path)
+          language_path?(path) || value_language_path?(path)
+        end
+
+        def language_path?(path)
+          path.length >= 2 && path[-1].is_a?(Integer) && path[-2].to_s == 'language'
+        end
+
+        def value_language_path?(path)
+          path.length >= 1 && path[-1].to_s == 'valueLanguage'
+        end
+
+        def valid_uri?(uri)
+          normalized = uri.sub(%r{\Ahttps?://}, '')
+          valid_iso639_2_uri?(normalized) || valid_iso639_3_uri?(normalized) || valid_languages_uri?(normalized)
+        end
+
+        def valid_iso639_2_uri?(normalized)
+          match = normalized.match(%r{\Aid\.loc\.gov/vocabulary/iso639-2/(.+)\z})
+          return false unless match
+
+          valid_iso639_2_codes.include?(match[1].downcase)
+        end
+
+        def valid_iso639_3_uri?(normalized)
+          match = normalized.match(%r{\Aid\.loc\.gov/vocabulary/iso639-3/(.+)\z})
+          return false unless match
+
+          ISO639_3_CODES.include?(match[1].downcase)
+        end
+
+        def valid_languages_uri?(normalized)
+          match = normalized.match(%r{\Aid\.loc\.gov/vocabulary/languages/(.+)\z})
+          return false unless match
+
+          valid_languages_codes.include?(match[1].downcase)
+        end
+
+        # rubocop:disable Style/ClassVars
+        def valid_iso639_2_codes
+          @@valid_iso639_2_codes ||= YAML.load_file(
+            ::File.expand_path('../../../../language_uri_iso639_2_codes.yml', __dir__)
+          ).to_set(&:downcase)
+        end
+
+        def valid_languages_codes
+          @@valid_languages_codes ||= YAML.load_file(
+            ::File.expand_path('../../../../language_uri_languages_codes.yml', __dir__)
+          ).to_set(&:downcase)
+        end
+        # rubocop:enable Style/ClassVars
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates language.script and valueLanguage.valueScript:
+      #   - source.code, when present, must be 'iso15924' (case-insensitive)
+      #   - code must be a recognized ISO 15924 script code (when source.code is 'iso15924')
+      class DescriptionScriptVisitorValidator < BaseDescriptionVisitorValidator
+        def validate!
+          raise ValidationError, "Unrecognized script source codes in description: #{source_error_paths.join(', ')}" if source_error_paths.any?
+          raise ValidationError, "Unrecognized script codes in description: #{error_paths.join(', ')}" if error_paths.any?
+        end
+
+        def visit_hash(hash:, path:)
+          if language_path?(path)
+            validate_script(hash, path, :script)
+          elsif value_language_path?(path)
+            validate_script(hash, path, :valueScript)
+          end
+        end
+
+        private
+
+        def error_paths
+          @error_paths ||= []
+        end
+
+        def source_error_paths
+          @source_error_paths ||= []
+        end
+
+        # Matches entries in a language array (e.g., [:language, 0] or [:adminMetadata, :language, 0]).
+        # Since language is an array of objects, the last element is the integer index
+        # and the second-to-last is the key 'language'.
+        def language_path?(path)
+          path.length >= 2 && path[-1].is_a?(Integer) && path[-2].to_s == 'language'
+        end
+
+        # Matches single valueLanguage objects (e.g., [:title, 0, :valueLanguage]).
+        # Since valueLanguage is a single object rather than an array, the path ends
+        # directly with 'valueLanguage'.
+        def value_language_path?(path)
+          path.present? && path[-1].to_s == 'valueLanguage'
+        end
+
+        def validate_script(hash, path, key)
+          script = hash[key]
+          return unless script
+
+          source_code = script.dig(:source, :code)
+          return unless source_code
+
+          unless source_code.downcase == 'iso15924'
+            source_error_paths << "#{path_to_s(path)}.#{key}.source.code (#{source_code})"
+            return
+          end
+
+          code = script[:code]
+          return unless code
+          return if valid_script_codes.include?(code.downcase)
+
+          error_paths << "#{path_to_s(path)}.#{key}.code (#{code})"
+        end
+
+        # rubocop:disable Style/ClassVars
+        def valid_script_codes
+          @@valid_script_codes ||= YAML.load_file(::File.expand_path('../../../../iso15924_codes.yml', __dir__)).to_set
+        end
+        # rubocop:enable Style/ClassVars
+      end
+    end
+  end
+end

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

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

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

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

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.124.0'
+    VERSION = '0.126.0'
   end
 end