cocina-models 0.53.0 → 0.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 328b1cc6267ee00ff250c1a255e1639cd99ee687e31ef1eb3644bae1b2b32435
-  data.tar.gz: 0131a0371050510c23a902c5e5dc14c848bb828b00bc3408bd74757c258d4642
+  metadata.gz: fbed8aec9255570088565182862681d94908cb165e5f6be489ad103052a5f708
+  data.tar.gz: 526b172620cbe31ea3ca59871d0ed0a816bec3c01726214fd3634bf54ec24eba
 SHA512:
-  metadata.gz: 98649a23bc16e020e6b8fff14d2ecd86978843ddd113aaafb6857f0dd525c735dc46522a71a3747bc3ac56018578dd1514777ffa8bfb7fcfd965f8fcd8b51f16
-  data.tar.gz: 40508d78201cc8438abea8f5dfcdd04a013df6874bc788d31eb380fd135476defe3643eda79c908c5fdaac6102b0e079c2d779cab976e6262479d6e30bfc4068
+  metadata.gz: 6a555879230729f246d468589fb3e5ec261cebc36ae17d1282b663ef1b0ff0a5bd4afc9e9ee9688978da98bf20e7f709f989a6b46934a103ad0fabe40ee2353a
+  data.tar.gz: 332f3a59c67779ccb81340a352baa9894e9c3c76cbf5ff2bed383b501c5ff9ec7fb6e1d80aa3610b9a3ee289448a6b93e59e50345bd97b7f9279acf684191db3

data/README.md

@@ -66,3 +66,12 @@ Once the above listed gems are updated all the following services that use cocin
 If you are using this gem in an application that has an API that accepts Cocina models (e.g., SDR API, Dor-Services-App), make sure that the `openapi.yml` for the application includes the schemas that match the schemas in this `openapi.yml`.
 
 This can be accomplished by cutting and pasting these schemas. By convention, these schemas are listed first in the `openapi.yml` of the associated projects, followed by the application-specific schemas.
+
+### Usage conventions
+
+The following are the recommended naming conventions for code using Cocina models:
+
+* cocina_item: Cocina::Models::DRO instance
+* cocina_admin_policy: Cocina::Models::AdminPolicy instance
+* cocina_collection: Cocina::Models::Collection instance
+* cocina_object: Cocina::Models::DRO or Cocina::Models::AdminPolicy or Cocina::Models::Collection instance

data/lib/cocina/generator/generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 module Cocina
   module Generator
     # Class for generating Cocina models from openapi.

data/lib/cocina/generator/vocab.rb

@@ -33,23 +33,40 @@ module Cocina
 
       attr_reader :schemas
 
-      # rubocop:disable Style/MultilineBlockChain
+      BASE = 'http://cocina.sul.stanford.edu/models/'
+
       def vocabs
-        schemas.values.map do |schema|
-          type_property = schema.properties['type']
-          type_property.nil? ? [] : type_property.enum.to_a
-        end
-               .flatten
-               .uniq
-               .sort
-               .filter { |vocab| vocab.start_with?('http://cocina.sul.stanford.edu/models') }
+        type_properties = schemas.values.map { |schema| schema.properties['type'] }.compact
+        type_properties.map(&:enum).flat_map(&:to_a)
+                       .filter { |vocab| vocab.start_with?(BASE) }
+                       .uniq
+                       .sort
       end
-      # rubocop:enable Style/MultilineBlockChain
 
       def vocab_methods
-        # Note special handling of 3d
-        vocabs.map do |vocab|
-          name = vocab[38, vocab.size - 45].gsub('-', '_').gsub('3d', 'three_dimensional')
+        names = vocabs.each_with_object({}) do |vocab, object|
+          # Note special handling of 3d
+          namespaced = vocab.delete_prefix(BASE).delete_suffix('.jsonld')
+                            .gsub('-', '_').gsub('3d', 'three_dimensional')
+          namespace, name = namespaced.include?('/') ? namespaced.split('/') : [:root, namespaced]
+          object[namespace] ||= {}
+          object[namespace][name] = vocab
+        end
+        draw_namespaced_methods(names)
+      end
+
+      def draw_namespaced_methods(names)
+        names.flat_map do |namespace, methods|
+          [].tap do |items|
+            items << "class #{namespace.capitalize}" unless namespace == :root
+            items << draw_ruby_methods(methods)
+            items << 'end' unless namespace == :root
+          end
+        end.join("\n")
+      end
+
+      def draw_ruby_methods(methods)
+        methods.map do |name, vocab|
           <<~RUBY
             def self.#{name}
               "#{vocab}"

data/lib/cocina/models/access_role.rb

@@ -4,7 +4,7 @@ module Cocina
   module Models
     class AccessRole < Struct
       # Name of role
-      attribute :name, Types::Strict::String.enum('sdr-administrator', 'sdr-viewer', 'dor-apo-manager', 'hydrus-collection-creator', 'hydrus-collection-manager', 'hydrus-collection-depositor', 'hydrus-collection-item-depositor', 'hydrus-collection-reviewer', 'hydrus-collection-viewer')
+      attribute :name, Types::Strict::String.enum('dor-apo-creator', 'dor-apo-depositor', 'dor-apo-manager', 'dor-apo-metadata', 'dor-apo-reviewer', 'dor-apo-viewer', 'sdr-administrator', 'sdr-viewer', 'hydrus-collection-creator', 'hydrus-collection-manager', 'hydrus-collection-depositor', 'hydrus-collection-item-depositor', 'hydrus-collection-reviewer', 'hydrus-collection-viewer')
       attribute :members, Types::Strict::Array.of(AccessRoleMember).default([].freeze)
     end
   end

data/lib/cocina/models/contributor.rb

@@ -13,6 +13,7 @@ module Cocina
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # URL or other pointer to the location of the contributor information.
       attribute :valueAt, Types::Strict::String.meta(omittable: true)
+      attribute :parallelContributor, Types::Strict::Array.of(DescriptiveParallelContributor).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/descriptive_parallel_contributor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveParallelContributor < 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 (e.g. the primary author among a group of contributors).
+      attribute :status, Types::Strict::String.meta(omittable: true)
+      attribute :role, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # URL or other pointer to the location of the contributor information.
+      attribute :valueAt, Types::Strict::String.meta(omittable: true)
+      attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/file_administrative.rb

@@ -3,6 +3,7 @@
 module Cocina
   module Models
     class FileAdministrative < Struct
+      attribute :publish, Types::Strict::Bool.default(false)
       attribute :sdrPreserve, Types::Strict::Bool.default(true)
       attribute :shelve, Types::Strict::Bool.default(false)
     end

data/lib/cocina/models/file_set.rb

@@ -5,7 +5,22 @@ module Cocina
     class FileSet < Struct
       include Checkable
 
-      TYPES = ['http://cocina.sul.stanford.edu/models/fileset.jsonld'].freeze
+      TYPES = ['http://cocina.sul.stanford.edu/models/resources/audio.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/attachment.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/document.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/file.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/image.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/main-augmented.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/main-original.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/media.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/object.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/page.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/permissions.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/preview.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/supplement.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/3d.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/thumb.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/video.jsonld'].freeze
 
       # The content type of the Fileset.
       attribute :type, Types::Strict::String.enum(*FileSet::TYPES)

data/lib/cocina/models/request_file_set.rb

@@ -5,7 +5,22 @@ module Cocina
     class RequestFileSet < Struct
       include Checkable
 
-      TYPES = ['http://cocina.sul.stanford.edu/models/fileset.jsonld'].freeze
+      TYPES = ['http://cocina.sul.stanford.edu/models/resources/audio.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/attachment.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/document.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/file.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/image.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/main-augmented.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/main-original.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/media.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/object.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/page.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/permissions.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/preview.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/supplement.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/3d.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/thumb.jsonld',
+               'http://cocina.sul.stanford.edu/models/resources/video.jsonld'].freeze
 
       attribute :type, Types::Strict::String.enum(*RequestFileSet::TYPES)
       attribute :label, Types::Strict::String

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.53.0'
+    VERSION = '0.55.0'
   end
 end

data/lib/cocina/models/vocab.rb

@@ -40,10 +40,6 @@ module Cocina
         'http://cocina.sul.stanford.edu/models/file.jsonld'
       end
 
-      def self.fileset
-        'http://cocina.sul.stanford.edu/models/fileset.jsonld'
-      end
-
       def self.geo
         'http://cocina.sul.stanford.edu/models/geo.jsonld'
       end
@@ -95,6 +91,72 @@ module Cocina
       def self.webarchive_seed
         'http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld'
       end
+
+      class Resources
+        def self.three_dimensional
+          'http://cocina.sul.stanford.edu/models/resources/3d.jsonld'
+        end
+
+        def self.attachment
+          'http://cocina.sul.stanford.edu/models/resources/attachment.jsonld'
+        end
+
+        def self.audio
+          'http://cocina.sul.stanford.edu/models/resources/audio.jsonld'
+        end
+
+        def self.document
+          'http://cocina.sul.stanford.edu/models/resources/document.jsonld'
+        end
+
+        def self.file
+          'http://cocina.sul.stanford.edu/models/resources/file.jsonld'
+        end
+
+        def self.image
+          'http://cocina.sul.stanford.edu/models/resources/image.jsonld'
+        end
+
+        def self.main_augmented
+          'http://cocina.sul.stanford.edu/models/resources/main-augmented.jsonld'
+        end
+
+        def self.main_original
+          'http://cocina.sul.stanford.edu/models/resources/main-original.jsonld'
+        end
+
+        def self.media
+          'http://cocina.sul.stanford.edu/models/resources/media.jsonld'
+        end
+
+        def self.object
+          'http://cocina.sul.stanford.edu/models/resources/object.jsonld'
+        end
+
+        def self.page
+          'http://cocina.sul.stanford.edu/models/resources/page.jsonld'
+        end
+
+        def self.permissions
+          'http://cocina.sul.stanford.edu/models/resources/permissions.jsonld'
+        end
+
+        def self.preview
+          'http://cocina.sul.stanford.edu/models/resources/preview.jsonld'
+        end
+
+        def self.supplement
+          'http://cocina.sul.stanford.edu/models/resources/supplement.jsonld'
+        end
+
+        def self.thumb
+          'http://cocina.sul.stanford.edu/models/resources/thumb.jsonld'
+        end
+
+        def self.video
+          'http://cocina.sul.stanford.edu/models/resources/video.jsonld'
+        end
+      end
     end
   end
 end

data/openapi.yml

@@ -127,9 +127,14 @@ components:
           description: Name of role
           type: string
           enum:
+            - 'dor-apo-creator'
+            - 'dor-apo-depositor'
+            - 'dor-apo-manager'
+            - 'dor-apo-metadata'
+            - 'dor-apo-reviewer'
+            - 'dor-apo-viewer'
             - 'sdr-administrator'
             - 'sdr-viewer'
-            - 'dor-apo-manager'
             - 'hydrus-collection-creator'
             - 'hydrus-collection-manager'
             - 'hydrus-collection-depositor'
@@ -342,6 +347,11 @@ components:
         valueAt:
           description: URL or other pointer to the location of the contributor information.
           type: string
+        parallelContributor:
+          description: For multiple representations of information about the same contributor (e.g. in different languages).
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveParallelContributor"
     Description:
       type: object
       additionalProperties: false
@@ -576,6 +586,43 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
+    DescriptiveParallelContributor:
+      description: Value model for multiple representations of information about the same contributor (e.g. in different languages).
+      type: object
+      additionalProperties: false
+      properties:
+        name:
+          description: Names associated with a contributor.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        type:
+          description: Entity type of the contributor (person, organization, etc.).
+          type: string
+        status:
+          description: Status of the contributor relative to other parallel contributors (e.g. the primary author among a group of contributors).
+          type: string
+        role:
+          description: Relationships of the contributor to the resource or to an event in its history.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        identifier:
+          description: Identifiers and URIs associated with the contributor entity.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        note:
+          description: Other information associated with the contributor.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        valueAt:
+          description: URL or other pointer to the location of the contributor information.
+          type: string
+        valueLanguage:
+          # description: Language of the descriptive element value
+          $ref: "#/components/schemas/DescriptiveValueLanguage"
     DescriptiveParallelEvent:
       description: Value model for multiple representations of information about the same event (e.g. in different languages).
       type: object
@@ -954,6 +1001,9 @@ components:
       type: object
       additionalProperties: false
       properties:
+        publish:
+          type: boolean
+          default: false
         sdrPreserve:
           type: boolean
           default: true
@@ -961,6 +1011,7 @@ components:
           type: boolean
           default: false
       required:
+        - publish
         - sdrPreserve
         - shelve
     FileSet:
@@ -972,7 +1023,22 @@ components:
           description: The content type of the Fileset.
           type: string
           enum:
-            - 'http://cocina.sul.stanford.edu/models/fileset.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/audio.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/attachment.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/document.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/file.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/image.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/main-augmented.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/main-original.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/media.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/object.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/page.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/permissions.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/preview.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/supplement.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/3d.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/thumb.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/video.jsonld'
         externalIdentifier:
           type: string
         label:
@@ -1389,7 +1455,22 @@ components:
         type:
           type: string
           enum:
-            - 'http://cocina.sul.stanford.edu/models/fileset.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/audio.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/attachment.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/document.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/file.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/image.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/main-augmented.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/main-original.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/media.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/object.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/page.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/permissions.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/preview.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/supplement.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/3d.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/thumb.jsonld'
+            - 'http://cocina.sul.stanford.edu/models/resources/video.jsonld'
         label:
           type: string
         version:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.53.0
+  version: 0.55.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -271,6 +271,7 @@ files:
 - lib/cocina/models/descriptive_basic_value.rb
 - lib/cocina/models/descriptive_geographic_metadata.rb
 - lib/cocina/models/descriptive_grouped_value.rb
+- lib/cocina/models/descriptive_parallel_contributor.rb
 - lib/cocina/models/descriptive_parallel_event.rb
 - lib/cocina/models/descriptive_parallel_value.rb
 - lib/cocina/models/descriptive_structured_value.rb
@@ -329,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Data models for the SDR