cocina-models 0.40.1 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1a41a02c7e3c3d58b65f4b94e4afdbc885795920eee91fa83f87374a207c0c1
-  data.tar.gz: 3c70761dd272739012387d78df18c69d114ab5a152d79283131f8d727112dcb9
+  metadata.gz: 29038502bea77b7be8adc58a0af9e73573a3da0d614c1d8c413a63ca80ffed72
+  data.tar.gz: b4e750e2124c23cbf11203a672a20f59f838cd8eb9a57fd592a00a26ef9b169e
 SHA512:
-  metadata.gz: e7f56d6aa41f0d13d2dcf17a2aef82354b566025caf04ffff84b2857fabfcc8c703c16f3aae00cf43c4654922f7b9240ededef6366ed9b111b2b4690f5a11fd2
-  data.tar.gz: b452f06a8f0525035a0699e74345b8bd1fb7f96d5b3f9cfbd996f1f65bd99b82d7ffbd9fa71cd2a5c32e60ef8731df159833b2bae98070ddf9f40803316b3caf
+  metadata.gz: fc11509d28f0f9a6b174ec4943fbf51c6eb98a42dd2fe578082aa5fcf3b30a9291f293791ac3a69f2835bb7982a9c578190a4650be1af8585cf52f28c9236a65
+  data.tar.gz: 1dbd66908e5aaa6ac7cc38a9ea9b72062e537daa1c5d54844f8a86c75884b83a51e3cc9ad307dcebc2199276b092eede8dbc96a87578b28fcf328456617bd4d6

data/.rubocop.yml

@@ -143,3 +143,34 @@ Style/SingleArgumentDig:
 
 Style/StringConcatenation:
   Enabled: true
+
+Layout/BeginEndAlignment: # (new in 0.91)
+  Enabled: true
+Lint/ConstantDefinitionInBlock: # (new in 0.91)
+  Enabled: true
+Lint/DuplicateRequire: # (new in 0.90)
+  Enabled: true
+Lint/EmptyFile: # (new in 0.90)
+  Enabled: true
+Lint/HashCompareByIdentity: # (new in 0.93)
+  Enabled: true
+Lint/IdentityComparison: # (new in 0.91)
+  Enabled: true
+Lint/RedundantSafeNavigation: # (new in 0.93)
+  Enabled: true
+Lint/TrailingCommaInAttributeDeclaration: # (new in 0.90)
+  Enabled: true
+Lint/UselessMethodDefinition: # (new in 0.90)
+  Enabled: true
+Lint/UselessTimes: # (new in 0.91)
+  Enabled: true
+Style/ClassEqualityComparison: # (new in 0.93)
+  Enabled: true
+Style/CombinableLoops: # (new in 0.90)
+  Enabled: true
+Style/KeywordParametersOrder: # (new in 0.90)
+  Enabled: true
+Style/RedundantSelfAssignment: # (new in 0.90)
+  Enabled: true
+Style/SoleNestedConditional: # (new in 0.89)
+  Enabled: true

data/lib/cocina/generator/generator.rb

@@ -45,7 +45,7 @@ module Cocina
         FileUtils.rm_f(filepath)
 
         create_file filepath, vocab.generate
-        run("rubocop -a #{filepath}")
+        run("rubocop -a #{filepath} > /dev/null")
       end
 
       private
@@ -71,7 +71,7 @@ module Cocina
         FileUtils.rm_f(filepath)
 
         create_file filepath, schema.generate
-        run("rubocop -a #{filepath}")
+        run("rubocop -a #{filepath} > /dev/null")
       end
 
       def clean_output

data/lib/cocina/models/access.rb

@@ -5,8 +5,6 @@ module Cocina
     class Access < Struct
       # Access level
       attribute :access, Types::Strict::String.default('dark').enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
-      # Download access level for a file
-      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.
       attribute :readLocation, Types::Strict::String.enum('spec', 'music', 'ars', 'art', 'hoover', 'm&m').meta(omittable: true)
     end

data/lib/cocina/models/description.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     class Description < Struct
-      attribute :title, Types::Strict::Array.of(DescriptiveValueRequired).default([].freeze)
+      attribute :title, Types::Strict::Array.of(Title).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)

data/lib/cocina/models/descriptive_basic_value.rb

@@ -17,6 +17,7 @@ module Cocina
       attribute :uri, Types::Strict::String.meta(omittable: true)
       attribute :standard, Standard.optional.meta(omittable: true)
       attribute :encoding, Standard.optional.meta(omittable: true)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
       # The preferred display label to use for the descriptive element in access systems.
       attribute :displayLabel, Types::Strict::String.meta(omittable: true)

data/lib/cocina/models/descriptive_value.rb

@@ -17,6 +17,7 @@ module Cocina
       attribute :uri, Types::Strict::String.meta(omittable: true)
       attribute :standard, Standard.optional.meta(omittable: true)
       attribute :encoding, Standard.optional.meta(omittable: true)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
       # The preferred display label to use for the descriptive element in access systems.
       attribute :displayLabel, Types::Strict::String.meta(omittable: true)

data/lib/cocina/models/descriptive_value_language.rb

@@ -10,6 +10,8 @@ module Cocina
       # String describing the standard or encoding.
       attribute :value, Types::Strict::String.meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # The version of the standard or encoding.
+      attribute :version, Types::Strict::String.meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
       attribute :valueScript, Standard.optional.meta(omittable: true)
     end

data/lib/cocina/models/event.rb

@@ -6,9 +6,12 @@ module Cocina
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # Description of the event (creation, publication, etc.).
       attribute :type, Types::Strict::String.meta(omittable: true)
+      # The preferred display label to use for the event in access systems.
+      attribute :displayLabel, 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 :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
     end
   end

data/lib/cocina/models/language.rb

@@ -3,29 +3,27 @@
 module Cocina
   module Models
     class Language < Struct
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
-      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
-      # String or integer value of the descriptive element.
-      attribute :value, Types::Nominal::Any.meta(omittable: true)
-      # Type of value provided by the descriptive element.
-      attribute :type, Types::Strict::String.meta(omittable: true)
-      # Status of the descriptive element value relative to other instances of the element.
-      attribute :status, Types::Strict::String.meta(omittable: true)
+      attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).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, Standard.optional.meta(omittable: true)
-      attribute :encoding, Standard.optional.meta(omittable: true)
-      attribute :source, Source.optional.meta(omittable: true)
       # The preferred display label to use for the descriptive element in access systems.
       attribute :displayLabel, Types::Strict::String.meta(omittable: true)
-      # A term providing information about the circumstances of the statement (e.g., approximate dates).
-      attribute :qualifier, Types::Strict::String.meta(omittable: true)
+      attribute :encoding, Standard.optional.meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
-      attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
-      attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # present for mapping to additional schemas in the future and for consistency but not otherwise used
+      attribute :qualifier, Types::Strict::String.meta(omittable: true)
       attribute :script, DescriptiveValue.optional.meta(omittable: true)
+      attribute :source, Source.optional.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.enum('primary').meta(omittable: true)
+      attribute :standard, Standard.optional.meta(omittable: true)
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # URI value of the descriptive element.
+      attribute :uri, Types::Strict::String.meta(omittable: true)
+      # Value of the descriptive element.
+      attribute :value, Types::Strict::String.meta(omittable: true)
+      attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/related_resource.rb

@@ -5,6 +5,10 @@ module Cocina
     class RelatedResource < Struct
       # The relationship of the related resource to the described resource.
       attribute :type, Types::Strict::String.meta(omittable: true)
+      # Status of the related resource relative to other related resources.
+      attribute :status, Types::Strict::String.meta(omittable: true)
+      # The preferred display label to use for the related resource in access systems.
+      attribute :displayLabel, Types::Strict::String.meta(omittable: true)
       attribute :title, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :contributor, Types::Strict::Array.of(Contributor).meta(omittable: true)
       attribute :event, Types::Strict::Array.of(Event).meta(omittable: true)
@@ -12,10 +16,13 @@ module Cocina
       attribute :language, Types::Strict::Array.of(Language).meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :standard, Standard.optional.meta(omittable: true)
       attribute :subject, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # Stanford persistent URL associated with the related resource.
       attribute :purl, Types::Strict::String.meta(omittable: true)
       attribute :access, DescriptiveAccessMetadata.optional.meta(omittable: true)
+      # The version of the related resource.
+      attribute :version, Types::Strict::String.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/source.rb

@@ -10,6 +10,8 @@ module Cocina
       # String describing the value source.
       attribute :value, Types::Strict::String.meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # The version of the value source.
+      attribute :version, Types::Strict::String.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/standard.rb

@@ -10,6 +10,8 @@ module Cocina
       # String describing the standard or encoding.
       attribute :value, Types::Strict::String.meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # The version of the standard or encoding.
+      attribute :version, Types::Strict::String.meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
     end
   end

data/lib/cocina/models/{descriptive_value_required.rb → title.rb}

@@ -2,7 +2,7 @@
 
 module Cocina
   module Models
-    class DescriptiveValueRequired < Struct
+    class Title < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # String or integer value of the descriptive element.
@@ -17,6 +17,7 @@ module Cocina
       attribute :uri, Types::Strict::String.meta(omittable: true)
       attribute :standard, Standard.optional.meta(omittable: true)
       attribute :encoding, Standard.optional.meta(omittable: true)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
       # The preferred display label to use for the descriptive element in access systems.
       attribute :displayLabel, Types::Strict::String.meta(omittable: true)

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.40.1'
+    VERSION = '0.41.0'
   end
 end

data/openapi.yml

@@ -108,15 +108,6 @@ components:
             - 'citation-only'
             - 'dark'
           default: 'dark'
-        download:
-          description: Download access level for a file
-          type: string
-          enum:
-            - 'world'
-            - 'stanford'
-            - 'location-based'
-            - 'none'
-          default: 'none'
         readLocation:
           description: If access is "location-based", which location should have access.
           type: string
@@ -270,6 +261,7 @@ components:
           description: Status of the contributor relative to other parallel contributors
             (e.g. the primary author among a group of contributors).
           type: string
+          # type: integer
         role:
           description: Relationships of the contributor to the resource or to an event
             in its history.
@@ -295,7 +287,7 @@ components:
           type: array
           minItems: 1
           items:
-            $ref: "#/components/schemas/DescriptiveValueRequired"
+            $ref: "#/components/schemas/Title"
         contributor:
           description: Agents contributing in some way to the creation and history of the
             resource.
@@ -309,7 +301,7 @@ components:
             $ref: "#/components/schemas/Event"
         form:
           description: Characteristics of the resource's physical, digital, and intellectual
-            form and genre.
+            form and genre, and of its process of creation.
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
@@ -433,7 +425,10 @@ components:
               description: String or integer value of the descriptive element.
               oneOf:
               - type: string
-              - type: integer
+              # Title note (nonsorting character count) was supposed to be able to accept an integer value,
+              # but this triggered a bug in committee:
+              # https://github.com/interagent/committee/issues/286
+              # - type: integer
             type:
               description: Type of value provided by the descriptive element.
               type: string
@@ -441,6 +436,7 @@ components:
               description: Status of the descriptive element value relative to other instances
                 of the element.
               type: string
+              # type: integer (uncomment when issue #154 is resolved)
             code:
               description: Code value of the descriptive element.
               type: string
@@ -454,6 +450,11 @@ components:
             encoding:
               # description: Encoding schema, standard, or syntax to which the value conforms.
               $ref: "#/components/schemas/Standard"
+            identifier:
+              description: Identifiers and URIs associated with the descriptive element.
+              type: array
+              items:
+                  $ref: "#/components/schemas/DescriptiveValue"
             source:
               $ref: "#/components/schemas/Source"
             displayLabel:
@@ -506,7 +507,7 @@ components:
               $ref: '#/components/schemas/Standard'
               # description: An alphabet or other notation used to represent a
               #   language or other symbolic system of the descriptive element value.
-    DescriptiveValueRequired:
+    Title:
       type: object
       additionalProperties: false
       allOf:
@@ -691,6 +692,9 @@ components:
             type:
               description: Description of the event (creation, publication, etc.).
               type: string
+            displayLabel:
+              description: The preferred display label to use for the event in access systems.
+              type: string
             date:
               description: Dates associated with the event.
               type: array
@@ -706,6 +710,11 @@ components:
               type: array
               items:
                 $ref: "#/components/schemas/DescriptiveValue"
+            identifier:
+              description: Identifiers and URIs associated with the event.
+              type: array
+              items:
+                $ref: "#/components/schemas/DescriptiveValue"
             note:
               description: Other information about the event.
               type: array
@@ -871,17 +880,63 @@ components:
         or part of a resource or its descriptive metadata.
       type: object
       additionalProperties: false
-      allOf:
-        - $ref: '#/components/schemas/DescriptiveValue'
-        - type: object
-          # additionalProperties breaks the validator, presumably because it can't
-          # conform to other schemas (allOf) and not have additionalProperties
-          # additionalProperties: false
-          properties:
-            script:
-              $ref: '#/components/schemas/DescriptiveValue'
-              # description: An alphabet or other notation used to represent a
-              #   language or other symbolic system associated with the resource.
+      properties:
+        appliesTo:
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveBasicValue"
+        code:
+          description: Code value of the descriptive element.
+          type: string
+        displayLabel:
+          description: The preferred display label to use for the descriptive element in access systems.
+          type: string
+        encoding:
+          # description: present for mapping to additional schemas in the future and for consistency but not otherwise used
+          $ref: "#/components/schemas/Standard"
+        note:
+          description: present for mapping to additional schemas in the future and for consistency but not otherwise used
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        parallelValue:
+          description: present for mapping to additional schemas in the future and for consistency but not otherwise used
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        qualifier:
+          type: string
+          description: present for mapping to additional schemas in the future and for consistency but not otherwise used
+        script:
+          $ref: '#/components/schemas/DescriptiveValue'
+          # description: An alphabet or other notation used to represent a
+          #   language or other symbolic system associated with the resource.
+        source:
+          $ref: "#/components/schemas/Source"
+        status:
+          description: Status of the contributor relative to other parallel contributors
+            (e.g. the primary author among a group of contributors).
+          type: string
+          enum:
+            - primary
+        standard:
+          # description: present for mapping to additional schemas in the future and for consistency but not otherwise used
+          $ref: "#/components/schemas/Standard"
+        structuredValue:
+          description: present for mapping to additional schemas in the future and for consistency but not otherwise used
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        uri:
+          description: URI value of the descriptive element.
+          type: string
+          format: uri
+        value:
+          description: Value of the descriptive element.
+          type: string
+        valueLanguage:
+          # description: present for mapping to additional schemas in the future and for consistency but not otherwise used
+          $ref: "#/components/schemas/DescriptiveValueLanguage"
     MessageDigest:
       description: The output of the message digest algorithm.
       type: object
@@ -918,6 +973,13 @@ components:
         type:
           description: The relationship of the related resource to the described resource.
           type: string
+        status:
+          description: Status of the related resource relative to other related resources.
+          type: string
+          # type: integer
+        displayLabel:
+          description: The preferred display label to use for the related resource in access systems.
+          type: string
         title:
           description: Titles of the related resource.
           type: array
@@ -936,7 +998,7 @@ components:
             $ref: "#/components/schemas/Event"
         form:
           description: Characteristics of the related resource's physical, digital, and intellectual
-            form and genre.
+            form and genre, and of its process of creation.
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
@@ -956,6 +1018,9 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
+        standard:
+          # description: Descriptive or content standards to which the value conforms.
+          $ref: "#/components/schemas/Standard"
         subject:
           description: Terms associated with the intellectual content of the related resource.
           type: array
@@ -967,6 +1032,9 @@ components:
           format: uri
         access:
           $ref: "#/components/schemas/DescriptiveAccessMetadata"
+        version:
+          description: The version of the related resource.
+          type: string
     ReleaseTag:
       description: A tag that indicates the item or collection should be released.
       type: object
@@ -1234,6 +1302,9 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
+        version:
+          description: The version of the value source.
+          type: string
     SourceId:
       type: string
       pattern: '^.+:.+$'
@@ -1247,7 +1318,7 @@ components:
       example: 'sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026'
     Standard:
       description: Property model for indicating the encoding, standard, or syntax
-        to which a value conforms.
+        to which a value conforms (e.g. RDA).
       type: object
       additionalProperties: false
       properties:
@@ -1266,5 +1337,8 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
+        version:
+          description: The version of the standard or encoding.
+          type: string
         source:
           $ref: "#/components/schemas/Source"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.40.1
+  version: 0.41.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -271,7 +271,6 @@ files:
 - lib/cocina/models/descriptive_structured_value.rb
 - lib/cocina/models/descriptive_value.rb
 - lib/cocina/models/descriptive_value_language.rb
-- lib/cocina/models/descriptive_value_required.rb
 - lib/cocina/models/dro.rb
 - lib/cocina/models/dro_access.rb
 - lib/cocina/models/dro_structural.rb
@@ -302,6 +301,7 @@ files:
 - lib/cocina/models/source.rb
 - lib/cocina/models/source_id.rb
 - lib/cocina/models/standard.rb
+- lib/cocina/models/title.rb
 - lib/cocina/models/validator.rb
 - lib/cocina/models/version.rb
 - lib/cocina/models/vocab.rb
@@ -324,7 +324,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Data models for the SDR