cocina-models 0.86.0 → 0.87.1

data/lib/cocina/models/admin_policy.rb

@@ -11,10 +11,10 @@ module Cocina
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
-      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
+      attribute :cocinaVersion, CocinaVersion.default(VERSION)
       attribute :type, Types::Strict::String.enum(*AdminPolicy::TYPES)
       # example: druid:bc123df4567
-      attribute :externalIdentifier, Types::Strict::String
+      attribute :externalIdentifier, Druid
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer
       attribute(:administrative, AdminPolicyAdministrative.default { AdminPolicyAdministrative.new })

data/lib/cocina/models/admin_policy_administrative.rb

@@ -11,9 +11,9 @@ module Cocina
       attribute? :disseminationWorkflow, Types::Strict::String
       attribute :collectionsForRegistration, Types::Strict::Array.of(Types::Strict::String).default([].freeze)
       # example: druid:bc123df4567
-      attribute :hasAdminPolicy, Types::Strict::String
+      attribute :hasAdminPolicy, Druid
       # example: druid:bc123df4567
-      attribute :hasAgreement, Types::Strict::String
+      attribute :hasAgreement, Druid
       attribute :roles, Types::Strict::Array.of(AccessRole).default([].freeze)
     end
   end

data/lib/cocina/models/admin_policy_with_metadata.rb

@@ -12,10 +12,10 @@ module Cocina
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
-      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
+      attribute :cocinaVersion, CocinaVersion.default(VERSION)
       attribute :type, Types::Strict::String.enum(*AdminPolicyWithMetadata::TYPES)
       # example: druid:bc123df4567
-      attribute :externalIdentifier, Types::Strict::String
+      attribute :externalIdentifier, Druid
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer
       attribute(:administrative, AdminPolicyAdministrative.default { AdminPolicyAdministrative.new })

data/lib/cocina/models/administrative.rb

@@ -4,7 +4,7 @@ module Cocina
   module Models
     class Administrative < Struct
       # example: druid:bc123df4567
-      attribute :hasAdminPolicy, Types::Strict::String
+      attribute :hasAdminPolicy, Druid
       attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).default([].freeze)
     end
   end

data/lib/cocina/models/barcode.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    Barcode = BusinessBarcode | LaneMedicalBarcode | CatkeyBarcode | StandardBarcode
+  end
+end

data/lib/cocina/models/business_barcode.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     BusinessBarcode = Types::String.constrained(
-      format: /^2050[0-9]{7}$/i
+      format: /^2050[0-9]{7}$/
     )
   end
 end

data/lib/cocina/models/catalog_link.rb

@@ -2,15 +2,6 @@
 
 module Cocina
   module Models
-    class CatalogLink < Struct
-      # Catalog that is the source of the linked record.
-      # example: symphony
-      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
-    end
+    CatalogLink = FolioCatalogLink | SymphonyCatalogLink
   end
 end

data/lib/cocina/models/catkey_barcode.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     CatkeyBarcode = Types::String.constrained(
-      format: /^[0-9]+-[0-9]+$/i
+      format: /^[0-9]+-[0-9]+$/
     )
   end
 end

data/lib/cocina/models/cocina_version.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     CocinaVersion = Types::String.constrained(
-      format: /^\d+\.\d+\.\d+$/i
+      format: /^\d+\.\d+\.\d+$/
     )
   end
 end

data/lib/cocina/models/collection.rb

@@ -16,11 +16,11 @@ module Cocina
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
-      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
+      attribute :cocinaVersion, CocinaVersion.default(VERSION)
       # The content type of the Collection. Selected from an established set of values.
       attribute :type, Types::Strict::String.enum(*Collection::TYPES)
       # example: druid:bc123df4567
-      attribute :externalIdentifier, Types::Strict::String
+      attribute :externalIdentifier, Druid
       # Primary processing label (can be same as title) for a Collection.
       attribute :label, Types::Strict::String
       # Version for the Collection within SDR.

data/lib/cocina/models/collection_identification.rb

@@ -7,7 +7,7 @@ module Cocina
       # Unique identifier in some other system. This is because a large proportion of what is deposited in SDR, historically and currently, are representations of objects that are also represented in other systems. For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
 
       # example: sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026
-      attribute? :sourceId, Types::Strict::String
+      attribute? :sourceId, SourceId.optional
     end
   end
 end

data/lib/cocina/models/collection_with_metadata.rb

@@ -16,11 +16,11 @@ module Cocina
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
-      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
+      attribute :cocinaVersion, CocinaVersion.default(VERSION)
       # The content type of the Collection. Selected from an established set of values.
       attribute :type, Types::Strict::String.enum(*CollectionWithMetadata::TYPES)
       # example: druid:bc123df4567
-      attribute :externalIdentifier, Types::Strict::String
+      attribute :externalIdentifier, Druid
       # Primary processing label (can be same as title) for a Collection.
       attribute :label, Types::Strict::String
       # Version for the Collection within SDR.

data/lib/cocina/models/created_in_folio_identifier.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    CreatedInFolioIdentifier = Types::String.constrained(
+      format: /^in\d+$/
+    )
+  end
+end

data/lib/cocina/models/description.rb

@@ -20,8 +20,8 @@ module Cocina
       attribute? :adminMetadata, DescriptiveAdminMetadata.optional
       # URL or other pointer to the location of the resource description.
       attribute? :valueAt, Types::Strict::String
-      # Stanford persistent URL associated with the related resource. Note this is http, not https.
-      attribute :purl, Types::Strict::String
+      # Stanford persistent URL associated with the related resource.
+      attribute :purl, Purl
     end
   end
 end

data/lib/cocina/models/doi.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    DOI = DoiPattern | DoiExceptions
+  end
+end

data/lib/cocina/models/doi_exceptions.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     DoiExceptions = Types::String.constrained(
-      format: %r{^10\.(25740/([vV][aA]90-[cC][tT]15|[sS][yY][xX][aA]-[mM]256|12[qQ][fF]-5243|65[jJ]8-6114)|25936/629[tT]-[bB][xX]79)$}i
+      format: %r{^10\.(25740/([vV][aA]90-[cC][tT]15|[sS][yY][xX][aA]-[mM]256|12[qQ][fF]-5243|65[jJ]8-6114)|25936/629[tT]-[bB][xX]79)$}
     )
   end
 end

data/lib/cocina/models/doi_pattern.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     DoiPattern = Types::String.constrained(
-      format: %r{^10\.(25740|80343)/[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$}i
+      format: %r{^10\.(25740|80343)/[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$}
     )
   end
 end

data/lib/cocina/models/dro.rb

@@ -26,11 +26,11 @@ module Cocina
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
-      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
+      attribute :cocinaVersion, CocinaVersion.default(VERSION)
       # The content type of the DRO. Selected from an established set of values.
       attribute :type, Types::Strict::String.enum(*DRO::TYPES)
       # example: druid:bc123df4567
-      attribute :externalIdentifier, Types::Strict::String
+      attribute :externalIdentifier, Druid
       # Primary processing label (can be same as title) for a DRO.
       attribute :label, Types::Strict::String
       # Version for the DRO within SDR.

data/lib/cocina/models/dro_with_metadata.rb

@@ -26,11 +26,11 @@ module Cocina
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
-      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
+      attribute :cocinaVersion, CocinaVersion.default(VERSION)
       # The content type of the DRO. Selected from an established set of values.
       attribute :type, Types::Strict::String.enum(*DROWithMetadata::TYPES)
       # example: druid:bc123df4567
-      attribute :externalIdentifier, Types::Strict::String
+      attribute :externalIdentifier, Druid
       # Primary processing label (can be same as title) for a DRO.
       attribute :label, Types::Strict::String
       # Version for the DRO within SDR.

data/lib/cocina/models/druid.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     Druid = Types::String.constrained(
-      format: /^druid:[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$/i
+      format: /^druid:[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$/
     )
   end
 end

data/lib/cocina/models/folio_catalog_link.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # A linkage between an object and a Folio catalog record
+    class FolioCatalogLink < Struct
+      # Catalog that is the source of the linked record.
+      # example: folio
+      attribute :catalog, Types::Strict::String.enum('folio', 'previous folio')
+      # 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.
+      attribute :catalogRecordId, MigratedFromSymphonyIdentifier | MigratedFromVoyagerIdentifier | CreatedInFolioIdentifier
+    end
+  end
+end

data/lib/cocina/models/identification.rb

@@ -4,14 +4,14 @@ module Cocina
   module Models
     class Identification < Struct
       # A barcode
-      attribute? :barcode, Types::Nominal::Any
+      attribute? :barcode, Barcode.optional
       attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).default([].freeze)
       # Digital Object Identifier (https://www.doi.org)
-      attribute? :doi, Types::Nominal::Any
+      attribute? :doi, DOI.optional
       # Unique identifier in some other system. This is because a large proportion of what is deposited in SDR, historically and currently, are representations of objects that are also represented in other systems. For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
 
       # example: sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026
-      attribute :sourceId, Types::Strict::String
+      attribute :sourceId, SourceId
     end
   end
 end

data/lib/cocina/models/lane_medical_barcode.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     LaneMedicalBarcode = Types::String.constrained(
-      format: /^245[0-9]{8}$/i
+      format: /^245[0-9]{8}$/
     )
   end
 end

data/lib/cocina/models/mapping/from_mods/identifier.rb

@@ -42,7 +42,7 @@ module Cocina
           def identifiers
             (resource_element.xpath('mods:identifier', mods: Description::DESC_METADATA_NS) +
               resource_element.xpath('mods:recordIdentifier',
-                                     mods: Description::DESC_METADATA_NS)).reject { |identifier_node| identifier_node.text.blank? && identifier_node.attributes.size.zero? }
+                                     mods: Description::DESC_METADATA_NS)).reject { |identifier_node| identifier_node.text.blank? && identifier_node.attributes.empty? }
           end
         end
       end

data/lib/cocina/models/mapping/from_mods/identifier_builder.rb

@@ -31,7 +31,7 @@ module Cocina
           end
 
           def build
-            return if identifier_element.text.blank? && identifier_element.attributes.size.zero?
+            return if identifier_element.text.blank? && identifier_element.attributes.empty?
 
             {
               displayLabel: identifier_element['displayLabel']

data/lib/cocina/models/mapping/normalizers/mods_normalizer.rb

@@ -105,9 +105,9 @@ module Cocina
             return unless start_node
 
             # remove node if there are no element children, there is no text value and there are no attributes
-            if start_node.elements.size.zero? &&
+            if start_node.elements.empty? &&
                start_node.text.blank? &&
-               start_node.attributes.size.zero? &&
+               start_node.attributes.empty? &&
                start_node.name != 'etal'
               parent = start_node.parent
               start_node.remove

data/lib/cocina/models/migrated_from_symphony_identifier.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    MigratedFromSymphonyIdentifier = Types::String.constrained(
+      format: /^a\d+$/
+    )
+  end
+end

data/lib/cocina/models/migrated_from_voyager_identifier.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    MigratedFromVoyagerIdentifier = Types::String.constrained(
+      format: /^L\d+$/
+    )
+  end
+end

data/lib/cocina/models/purl.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     Purl = Types::String.constrained(
-      format: %r{^https://}i
+      format: %r{^https://}
     )
   end
 end

data/lib/cocina/models/related_resource.rb

@@ -19,8 +19,8 @@ module Cocina
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute? :standard, Standard.optional
       attribute :subject, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # Stanford persistent URL associated with the related resource. Note this is http, not https.
-      attribute? :purl, Types::Strict::String
+      # Stanford persistent URL associated with the related resource.
+      attribute? :purl, Purl.optional
       attribute? :access, DescriptiveAccessMetadata.optional
       attribute :relatedResource, Types::Strict::Array.of(RelatedResource).default([].freeze)
       attribute? :adminMetadata, DescriptiveAdminMetadata.optional

data/lib/cocina/models/request_admin_policy.rb

@@ -12,7 +12,7 @@ module Cocina
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
-      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
+      attribute :cocinaVersion, CocinaVersion.default(VERSION)
       attribute :type, Types::Strict::String.enum(*RequestAdminPolicy::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer.default(1).enum(1)

data/lib/cocina/models/request_administrative.rb

@@ -4,7 +4,7 @@ module Cocina
   module Models
     class RequestAdministrative < Struct
       # example: druid:bc123df4567
-      attribute :hasAdminPolicy, Types::Strict::String
+      attribute :hasAdminPolicy, Druid
       attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).default([].freeze)
       # Internal project this resource is a part of. This governs routing of messages about this object.
       # example: Google Books

data/lib/cocina/models/request_collection.rb

@@ -16,7 +16,7 @@ module Cocina
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
-      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
+      attribute :cocinaVersion, CocinaVersion.default(VERSION)
       attribute :type, Types::Strict::String.enum(*RequestCollection::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer.default(1).enum(1)

data/lib/cocina/models/request_dro.rb

@@ -26,7 +26,7 @@ module Cocina
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
-      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
+      attribute :cocinaVersion, CocinaVersion.default(VERSION)
       attribute :type, Types::Strict::String.enum(*RequestDRO::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer.default(1).enum(1)

data/lib/cocina/models/request_identification.rb

@@ -5,12 +5,12 @@ module Cocina
     # Same as a Identification, but requires a sourceId and doesn't permit a DOI.
     class RequestIdentification < Struct
       # A barcode
-      attribute? :barcode, Types::Nominal::Any
+      attribute? :barcode, Barcode.optional
       attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).default([].freeze)
       # Unique identifier in some other system. This is because a large proportion of what is deposited in SDR, historically and currently, are representations of objects that are also represented in other systems. For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
 
       # example: sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026
-      attribute :sourceId, Types::Strict::String
+      attribute :sourceId, SourceId
     end
   end
 end

data/lib/cocina/models/source_id.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     SourceId = Types::String.constrained(
-      format: /^.+:.+$/i
+      format: /^.+:.+$/
     )
   end
 end

data/lib/cocina/models/standard_barcode.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     StandardBarcode = Types::String.constrained(
-      format: /^36105[0-9]{9}$/i
+      format: /^36105[0-9]{9}$/
     )
   end
 end

data/lib/cocina/models/symphony_catalog_link.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # A linkage between an object and a Symphony catalog record
+    class SymphonyCatalogLink < Struct
+      # Catalog that is the source of the linked record.
+      # example: symphony
+      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.constrained(format: /^\d+$/)
+    end
+  end
+end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.86.0'
+    VERSION = '0.87.1'
   end
 end

data/lib/cocina/models.rb

@@ -148,9 +148,13 @@ module Cocina
     end
 
     def self.type_for(dyn)
-      dyn.with_indifferent_access.fetch('type')
-    rescue KeyError
-      raise ValidationError, 'Type field not found'
+      # Intentionally checking both string- and symbol-type keys in the hash via `#[]`
+      #  instead of `#with_indifferent_access` (and/or `#fetch`) in order to be more memory-efficient
+      object_type = dyn[:type] || dyn['type']
+
+      raise(ValidationError, 'Type field not found') unless object_type
+
+      object_type
     end
     private_class_method :type_for