cocina-models 0.29.0 → 0.33.0

data/lib/cocina/models/catalog_link.rb

@@ -2,9 +2,12 @@
 
 module Cocina
   module Models
-    # Metadata for a catalog link
     class CatalogLink < Struct
+      # Catalog that is the source of the linked record.
+      # example: symphony
       attribute :catalog, Types::Strict::String
+      # Record identifier that is unique within the context of the linked record's catalog.
+      # example: 11403803
       attribute :catalogRecordId, Types::Strict::String
     end
   end

data/lib/cocina/models/collection.rb

@@ -2,43 +2,33 @@
 
 module Cocina
   module Models
-    # A digital repository collection.
-    # See http://sul-dlss.github.io/cocina-models/maps/Collection.json
     class Collection < Struct
       include Checkable
 
-      TYPES = [
-        Vocab.collection,
-        Vocab.curated_collection,
-        Vocab.exhibit,
-        Vocab.series,
-        Vocab.user_collection
-      ].freeze
+      TYPES = ['http://cocina.sul.stanford.edu/models/collection.jsonld',
+               'http://cocina.sul.stanford.edu/models/curated-collection.jsonld',
+               'http://cocina.sul.stanford.edu/models/user-collection.jsonld',
+               'http://cocina.sul.stanford.edu/models/exhibit.jsonld',
+               'http://cocina.sul.stanford.edu/models/series.jsonld'].freeze
 
-      # Subschema for access concerns
-      class Access < Struct
-        attribute :access, Types::String.default('dark')
-                                        .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
-      end
-
-      # Subschema for administrative concerns
-      class Administrative < Struct
-        attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).default([].freeze)
-        # TODO: Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
-        # but I think it's actually required for every Collection
-        attribute :hasAdminPolicy, Types::Strict::String.optional.default(nil)
-      end
-
-      # Identification sub-schema for the Collection
-      class Identification < Struct
-        attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
-      end
+      # The content type of the Collection. Selected from an established set of values.
+      # example: item
+      attribute :type, Types::Strict::String.enum(*Collection::TYPES)
+      # example: druid:bc123df4567
+      attribute :externalIdentifier, Types::Strict::String
+      # Primary processing label (can be same as title) for a Collection.
+      attribute :label, Types::Strict::String
+      # Version for the Collection within SDR.
+      attribute :version, Types::Strict::Integer
+      attribute(:access, Access.default { Access.new })
+      attribute :administrative, Administrative.optional.meta(omittable: true)
+      attribute :description, Description.optional.meta(omittable: true)
+      attribute :identification, CollectionIdentification.optional.meta(omittable: true)
 
-      class Structural < Struct
+      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
+        Validator.validate(self, attributes.with_indifferent_access) if validate && name
+        super(attributes, safe, &block)
       end
-
-      include CollectionAttributes
-      attribute :externalIdentifier, Types::Strict::String
     end
   end
 end

data/lib/cocina/models/collection_identification.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class CollectionIdentification < Struct
+      attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/contributor.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Contributor < Struct
+      attribute :name, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # Entity type of the contributor (person, organization, etc.).
+      attribute :type, Types::Strict::String.meta(omittable: true)
+      # Status of the contributor relative to other parallel contributors.
+      attribute :status, Types::Strict::String.meta(omittable: true)
+      attribute :role, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/description.rb

@@ -2,15 +2,24 @@
 
 module Cocina
   module Models
-    # Descriptive metadata.  See http://sul-dlss.github.io/cocina-models/maps/Description.json
     class Description < Struct
-      # Title element.  See http://sul-dlss.github.io/cocina-models/maps/Title.json
-      class Title < Struct
-        attribute :primary, Types::Strict::Bool
-        attribute :titleFull, Types::Strict::String
-      end
+      attribute :title, Types::Strict::Array.of(DescriptiveValueRequired).default([].freeze)
+      attribute :contributor, Types::Strict::Array.of(Contributor).meta(omittable: true)
+      attribute :event, Types::Strict::Array.of(Event).meta(omittable: true)
+      attribute :form, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :language, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # Stanford persistent URL associated with the resource.
+      attribute :purl, Types::Strict::String.meta(omittable: true)
+      attribute :url, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :marcEncodedData, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :adminMetadata, DescriptiveAdminMetadata.optional.meta(omittable: true)
 
-      attribute :title, Types::Strict::Array.of(Title)
+      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
+        Validator.validate(self, attributes.with_indifferent_access) if validate && name
+        super(attributes, safe, &block)
+      end
     end
   end
 end

data/lib/cocina/models/descriptive_admin_metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveAdminMetadata < Struct
+      attribute :contributor, Types::Strict::Array.of(Contributor).meta(omittable: true)
+      attribute :event, Types::Strict::Array.of(Event).meta(omittable: true)
+      attribute :language, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/descriptive_basic_value.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveBasicValue < Struct
+      # String value of the descriptive element.
+      attribute :value, Types::Strict::String.meta(omittable: true)
+      # Type of value provided by the descriptive element.
+      attribute :type, Types::Strict::String.meta(omittable: true)
+      # Status of the descriptive element relative to other instances of the element.
+      attribute :status, Types::Strict::String.meta(omittable: true)
+      # Code value of the descriptive element.
+      attribute :code, Types::Strict::String.meta(omittable: true)
+      # URI value of the descriptive element.
+      attribute :uri, Types::Strict::String.meta(omittable: true)
+      attribute :standard, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :encoding, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :source, Source.optional.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/descriptive_structured_value.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveStructuredValue < Struct
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/descriptive_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveValue < Struct
+      # String value of the descriptive element.
+      attribute :value, Types::Strict::String.meta(omittable: true)
+      # Type of value provided by the descriptive element.
+      attribute :type, Types::Strict::String.meta(omittable: true)
+      # Status of the descriptive element relative to other instances of the element.
+      attribute :status, Types::Strict::String.meta(omittable: true)
+      # Code value of the descriptive element.
+      attribute :code, Types::Strict::String.meta(omittable: true)
+      # URI value of the descriptive element.
+      attribute :uri, Types::Strict::String.meta(omittable: true)
+      attribute :standard, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :encoding, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :source, Source.optional.meta(omittable: true)
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/descriptive_value_required.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveValueRequired < Struct
+      # String value of the descriptive element.
+      attribute :value, Types::Strict::String.meta(omittable: true)
+      # Type of value provided by the descriptive element.
+      attribute :type, Types::Strict::String.meta(omittable: true)
+      # Status of the descriptive element relative to other instances of the element.
+      attribute :status, Types::Strict::String.meta(omittable: true)
+      # Code value of the descriptive element.
+      attribute :code, Types::Strict::String.meta(omittable: true)
+      # URI value of the descriptive element.
+      attribute :uri, Types::Strict::String.meta(omittable: true)
+      attribute :standard, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :encoding, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :source, Source.optional.meta(omittable: true)
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/dro.rb

@@ -2,80 +2,44 @@
 
 module Cocina
   module Models
-    # A digital repository object.
-    # See http://sul-dlss.github.io/cocina-models/maps/DRO.json
     class DRO < Struct
       include Checkable
 
-      TYPES = [
-        Vocab.object,
-        Vocab.three_dimensional,
-        Vocab.agreement,
-        Vocab.book,
-        Vocab.document,
-        Vocab.geo,
-        Vocab.image,
-        Vocab.page,
-        Vocab.photograph,
-        Vocab.manuscript,
-        Vocab.map,
-        Vocab.media,
-        Vocab.track,
-        Vocab.webarchive_binary,
-        Vocab.webarchive_seed
-      ].freeze
-
-      # Subschema for access concerns
-      class Access < Struct
-        # Subschema for embargo concerns
-        class Embargo < Struct
-          attribute :releaseDate, Types::Params::DateTime
-          attribute :access, Types::String.default('dark')
-                                          .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
-          attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
-        end
-
-        attribute :access, Types::String.default('dark')
-                                        .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
-        attribute :copyright, Types::Strict::String.meta(omittable: true)
-        attribute :embargo, Embargo.optional.meta(omittable: true)
-        attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
-      end
-
-      # Subschema for administrative concerns
-      class Administrative < Struct
-        # TODO: Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
-        # but I think it's actually required for every DRO
-        attribute :hasAdminPolicy, Types::Strict::String.optional.default(nil)
-        attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true).default([].freeze)
-        attribute :partOfProject, Types::Strict::String.meta(omittable: true)
-      end
-
-      # Identification sub-schema for the DRO
-      class Identification < Struct
-        attribute :sourceId, Types::Strict::String.meta(omittable: true)
-        attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
-      end
-
-      # Geographic sub-schema for the DRO
-      class Geographic < Struct
-        attribute :iso19139, Types::Strict::String
-      end
-
-      # Structural sub-schema for the DRO (uses FileSet, unlike RequestDRO which uses RequestFileSet)
-      class Structural < Struct
-        attribute :contains, Types::Strict::Array.of(FileSet).meta(omittable: true)
-        attribute :hasAgreement, Types::Strict::String.meta(omittable: true)
-        attribute :isMemberOf, Types::Strict::String.meta(omittable: true)
-        attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).meta(omittable: true)
-      end
-
-      include DroAttributes
+      TYPES = ['http://cocina.sul.stanford.edu/models/object.jsonld',
+               'http://cocina.sul.stanford.edu/models/3d.jsonld',
+               'http://cocina.sul.stanford.edu/models/agreement.jsonld',
+               'http://cocina.sul.stanford.edu/models/book.jsonld',
+               'http://cocina.sul.stanford.edu/models/document.jsonld',
+               'http://cocina.sul.stanford.edu/models/geo.jsonld',
+               'http://cocina.sul.stanford.edu/models/image.jsonld',
+               'http://cocina.sul.stanford.edu/models/page.jsonld',
+               'http://cocina.sul.stanford.edu/models/photograph.jsonld',
+               'http://cocina.sul.stanford.edu/models/manuscript.jsonld',
+               'http://cocina.sul.stanford.edu/models/map.jsonld',
+               'http://cocina.sul.stanford.edu/models/media.jsonld',
+               'http://cocina.sul.stanford.edu/models/track.jsonld',
+               'http://cocina.sul.stanford.edu/models/webarchive-binary.jsonld',
+               'http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld'].freeze
+
+      # The content type of the DRO. Selected from an established set of values.
+      # example: item
+      attribute :type, Types::Strict::String.enum(*DRO::TYPES)
+      # example: druid:bc123df4567
       attribute :externalIdentifier, Types::Strict::String
-      attribute(:structural, Structural.default { Structural.new })
-
-      def image?
-        type == Vocab.image
+      # Primary processing label (can be same as title) for a DRO.
+      attribute :label, Types::Strict::String
+      # Version for the DRO within SDR.
+      attribute :version, Types::Strict::Integer
+      attribute(:access, DROAccess.default { DROAccess.new })
+      attribute :administrative, Administrative.optional.meta(omittable: true)
+      attribute :description, Description.optional.meta(omittable: true)
+      attribute :identification, Identification.optional.meta(omittable: true)
+      attribute :structural, DROStructural.optional.meta(omittable: true)
+      attribute :geographic, Geographic.optional.meta(omittable: true)
+
+      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
+        Validator.validate(self, attributes.with_indifferent_access) if validate && name
+        super(attributes, safe, &block)
       end
     end
   end

data/lib/cocina/models/dro_access.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DROAccess < Struct
+      attribute :access, Types::Strict::String.default('dark').enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
+      # The human readable copyright statement that applies
+      # example: Copyright World Trade Organization
+      attribute :copyright, Types::Strict::String.meta(omittable: true)
+      attribute :embargo, Embargo.optional.meta(omittable: true)
+      # Download access level. This is used in the transition from Fedora as a way to set a default download level at registration that is copied down to all the files.
+
+      attribute :download, Types::Strict::String.default('none').enum('world', 'stanford', 'location-based', 'none').meta(omittable: true)
+      # If access is "location-based", which location should have access. This is used in the transition from Fedora as a way to set a default readLocation at registration that is copied down to all the files.
+
+      attribute :readLocation, Types::Strict::String.enum('spec', 'music', 'ars', 'art', 'hoover', 'm&m').meta(omittable: true)
+      # The human readable use and reproduction statement that applies
+      # example: Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Public Services Librarian of the Dept. of Special Collections (http://library.stanford.edu/spc).
+      attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/dro_structural.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DROStructural < Struct
+      attribute :contains, Types::Strict::Array.of(FileSet).meta(omittable: true)
+      attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).meta(omittable: true)
+      # example: druid:bc123df4567
+      attribute :isMemberOf, Types::Strict::String.meta(omittable: true)
+      # Agreement that covers the deposit of the DRO into SDR.
+      attribute :hasAgreement, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/embargo.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Embargo < Struct
+      # Date when the Collection is released from an embargo.
+      # example: 2029-06-22T07:00:00.000+00:00
+      attribute :releaseDate, Types::Params::DateTime
+      # Access level that applies when embargo expires.
+      attribute :access, Types::Strict::String.enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
+      # The human readable use and reproduction statement that applies when the embargo expires.
+      # example: These materials are in the public domain.
+      attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Event < Struct
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      # Description of the event (creation, publication, etc.).
+      attribute :type, Types::Strict::String.meta(omittable: true)
+      attribute :date, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :contributor, Types::Strict::Array.of(Contributor).meta(omittable: true)
+      attribute :location, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/file.rb

@@ -2,47 +2,31 @@
 
 module Cocina
   module Models
-    # Metadata for a file.
-    # See http://sul-dlss.github.io/cocina-models/maps/File.json
     class File < Struct
       include Checkable
 
-      TYPES = [
-        Vocab.file
-      ].freeze
+      TYPES = ['http://cocina.sul.stanford.edu/models/file.jsonld'].freeze
 
-      # Represents access controls on the file
-      class Access < Struct
-        attribute :access, Types::String.default('dark')
-                                        .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
-      end
-
-      # Represents the administration of the file
-      class Administrative < Struct
-        attribute :sdrPreserve, Types::Strict::Bool.optional.default(true)
-        attribute :shelve, Types::Strict::Bool.optional.default(false)
-      end
-
-      # Represents a digest (checksum) value for a file
-      class Fixity < Struct
-        attribute :type, Types::String.enum('md5', 'sha1')
-        attribute :digest, Types::Strict::String
-      end
-
-      class Identification < Struct
-      end
-
-      # Represents some technical aspect of the file
-      class Presentation < Struct
-        attribute :height, Types::Strict::Integer.optional.default(nil)
-        attribute :width, Types::Strict::Integer.optional.default(nil)
-      end
-
-      class Structural < Struct
-      end
-
-      include FileAttributes
+      # The content type of the File.
+      attribute :type, Types::Strict::String.enum(*File::TYPES)
+      # Identifier for the resource within the SDR architecture but outside of the repository. UUID. Constant across resource versions. What clients will use calling the repository.
       attribute :externalIdentifier, Types::Strict::String
+      # Primary processing label (can be same as title) for a File.
+      attribute :label, Types::Strict::String
+      # Filename for a file. Can be same as label.
+      attribute :filename, Types::Strict::String
+      # Size of the File (binary) in bytes.
+      attribute :size, Types::Strict::Integer.meta(omittable: true)
+      # Version for the File within SDR.
+      attribute :version, Types::Strict::Integer
+      # MIME Type of the File.
+      attribute :hasMimeType, Types::Strict::String.meta(omittable: true)
+      # Use for the File.
+      attribute :use, Types::Strict::String.meta(omittable: true)
+      attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([].freeze)
+      attribute(:access, Access.default { Access.new })
+      attribute(:administrative, FileAdministrative.default { FileAdministrative.new })
+      attribute :presentation, Presentation.optional.meta(omittable: true)
     end
   end
 end