cocina-models 0.31.1 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56996d980d118dcf4b8d40ceff5ec6fbff8b24abb997c4b9e0197bb528b8d079
-  data.tar.gz: fbd4dc60749aa56fb60334efb0841a707e676a86117129c0f792bbe7cb8e6efe
+  metadata.gz: 9ea38c51d33daf4bd30982c2a326f4f8df2b02885f531d48f93f5cd95836eb4e
+  data.tar.gz: 8964732d746a81b264bc159db52b1a9ea91f5c6455cb12634e1d937d74ba13db
 SHA512:
-  metadata.gz: 2d329215bcbe26594b87741cd14eeb17d6d3059812ac9049782c8f5c571cb1243abdb46ce16f0c664704b834fbdf3984f37813aa0fc339b98fa58bf79ff35e96
-  data.tar.gz: 16a11f6ee008decd17ffee1bd3329e3c8b9d67ed6350d536a9f1526ecce6d28ccddba4ceff688b2e24163b93c8859e4798e050106a747b8fef2574c9f62df140
+  metadata.gz: 4e9842002155019798495d31b30a1476b4b34d3984a9c66a1105729fb535d566a0c833ad670b01e649de21d2bc05d2831e82feabd59a87c10fabbaffec29e9bd
+  data.tar.gz: 1e80bffa4f64a9641840b3dfb92d3deb4441b7a0a8cdd9fa78666893d6d12f144884146bec39d153d55672c5747d699179adeaa2d7411a6d9549396eb8a0f22c

data/.github/pull_request_template.md

@@ -2,4 +2,11 @@
 
 
 
-## Was the documentation (README, wiki) updated?
+## How was this change tested?
+
+
+
+## Which documentation and/or configurations were updated?
+
+
+

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_from: .rubocop_todo.yml
 require:
   - rubocop-rspec
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 114
   Exclude:
     - lib/cocina/models/*
@@ -26,7 +26,58 @@ RSpec/ExampleLength:
     - spec/cocina/models/description_spec.rb
     - spec/cocina/models/dro_shared_examples.rb
 
-
 Style/Documentation:
   Exclude:
     - lib/cocina/models/*
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+  

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.com/sul-dlss/cocina-models.svg?branch=master)](https://travis-ci.com/sul-dlss/cocina-models)
+[![CircleCI](https://circleci.com/gh/sul-dlss/cocina-models.svg?style=svg)](https://circleci.com/gh/sul-dlss/cocina-models)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/472273351516ac01dce1/test_coverage)](https://codeclimate.com/github/sul-dlss/cocina-models/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/472273351516ac01dce1/maintainability)](https://codeclimate.com/github/sul-dlss/cocina-models/maintainability)
 [![Gem Version](https://badge.fury.io/rb/cocina-models.svg)](https://badge.fury.io/rb/cocina-models)
@@ -26,20 +26,14 @@ exe/generator generate
 exe/generator generate_schema DRO
 ```
 
-## Generate Documentation
+## Testing
 
-```
-gem install prmd
-cd docs
+The generator is tested via its output when run against `openapi.yml`, viz., the Cocina model classes. Thus, `generate` should be run after any changes to `openapi.yml`.
 
-# Combine into a single schema
-prmd combine --meta meta.json  maps/ > schema.json
+Beyond what is necessary to test the generator, the Cocina model classes are not tested, i.e., they are assumed to be as specified in `openapi.yml`.
 
-# Check it’s all good
-prmd verify schema.json
+## Using this gem
 
-# Build docs
-prmd doc schema.json > schema.md
-```
+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`.
 
-Then check in the resulting changes to `docs/schema.json` and `docs/schema.md`
+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.

data/cocina-models.gemspec

@@ -33,9 +33,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'committee'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.74.0'
+  spec.add_development_dependency 'rubocop', '~> 0.87'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov', '~> 0.17.0'
 end

data/docs/index.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>API documentation</title>
+
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <redoc spec-url='https://raw.githubusercontent.com/sul-dlss/cocina-models/master/openapi.yml'></redoc>
+    <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+  </body>
+</html>

data/docs/maps/DRO.json

@@ -84,7 +84,7 @@
         "download": {
           "description": "Download level for the DRO metadata.",
           "type": "string",
-          "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
+          "enum": ["world", "stanford", "location-based", "none"]
         },
         "embargo": {
           "description": "Embargo metadata",

data/lib/cocina/generator/generator.rb

@@ -17,10 +17,13 @@ module Cocina
       def generate
         clean_output
 
+        # rubocop:disable Style/HashEachMethods
+        # This is not a Hash
         schemas.keys.each do |schema_name|
           schema = schema_for(schema_name)
           generate_for(schema) if schema
         end
+        # rubocop:enable Style/HashEachMethods
 
         generate_vocab
       end

data/lib/cocina/generator/schema_value.rb

@@ -4,11 +4,11 @@ module Cocina
   module Generator
     # Class for generating from an openapi value
     class SchemaValue < SchemaBase
-      # rubocop:disable Metrics/LineLength
+      # rubocop:disable Layout/LineLength
       def generate
         "#{description}#{example}attribute :#{name.camelize(:lower)}, Types::#{dry_datatype(schema_doc)}#{default}#{enum}#{omittable}"
       end
-      # rubocop:enable Metrics/LineLength
+      # rubocop:enable Layout/LineLength
 
       private
 

data/lib/cocina/models.rb

@@ -14,7 +14,6 @@ require 'thor'
 
 # Help Zeitwerk find some of our classes
 class CocinaModelsInflector < Zeitwerk::Inflector
-  # rubocop:disable Metrics/CyclomaticComplexity
   # rubocop:disable Metrics/MethodLength
   def camelize(basename, _abspath)
     case basename
@@ -34,7 +33,7 @@ class CocinaModelsInflector < Zeitwerk::Inflector
       super
     end
   end
-  # rubocop:enable Metrics/CyclomaticComplexity
+
   # rubocop:enable Metrics/MethodLength
 end
 

data/lib/cocina/models/access.rb

@@ -5,6 +5,10 @@ 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
   end
 end

data/lib/cocina/models/admin_policy_administrative.rb

@@ -5,7 +5,7 @@ module Cocina
     class AdminPolicyAdministrative < Struct
       attribute :defaultObjectRights, Types::Strict::String.default('<?xml version="1.0" encoding="UTF-8"?><rightsMetadata><access type="discover"><machine><world/></machine></access><access type="read"><machine><world/></machine></access><use><human type="useAndReproduction"/><human type="creativeCommons"/><machine type="creativeCommons" uri=""/><human type="openDataCommons"/><machine type="openDataCommons" uri=""/></use><copyright><human/></copyright></rightsMetadata>').meta(omittable: true)
       attribute :registrationWorkflow, Types::Strict::String.meta(omittable: true)
-      attribute :hasAdminPolicy, Types::Strict::String.meta(omittable: true)
+      attribute :hasAdminPolicy, Types::Strict::String
     end
   end
 end

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.meta(omittable: true)
+      attribute :hasAdminPolicy, Types::Strict::String
       attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true)
       # Administrative or Internal project this resource is a part of
       # example: Google Books

data/lib/cocina/models/contributor.rb

@@ -6,9 +6,11 @@ module Cocina
       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.
+      # 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)
     end
   end
 end

data/lib/cocina/models/description.rb

@@ -7,12 +7,14 @@ module Cocina
       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 :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 :subject, 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 :access, DescriptiveAccessMetadata.optional.meta(omittable: true)
+      attribute :relatedResource, Types::Strict::Array.of(RelatedResource).meta(omittable: true)
       attribute :marcEncodedData, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :adminMetadata, DescriptiveAdminMetadata.optional.meta(omittable: true)
 

data/lib/cocina/models/descriptive_access_metadata.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveAccessMetadata < Struct
+      attribute :url, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :physicalLocation, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :accessContact, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :digitalRepository, 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_admin_metadata.rb

@@ -5,8 +5,10 @@ module Cocina
     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 :language, Types::Strict::Array.of(Language).meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :standard, Standard.optional.meta(omittable: true)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/descriptive_basic_value.rb

@@ -3,19 +3,26 @@
 module Cocina
   module Models
     class DescriptiveBasicValue < Struct
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # 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.
+      # Status of the descriptive element value 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 :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 :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/descriptive_parallel_value.rb

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

data/lib/cocina/models/descriptive_structured_value.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     class DescriptiveStructuredValue < Struct
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/descriptive_value.rb

@@ -3,20 +3,26 @@
 module Cocina
   module Models
     class DescriptiveValue < Struct
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # 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.
+      # Status of the descriptive element value 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 :standard, Standard.optional.meta(omittable: true)
+      attribute :encoding, Standard.optional.meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).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 :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
     end
   end

data/lib/cocina/models/descriptive_value_required.rb

@@ -3,20 +3,26 @@
 module Cocina
   module Models
     class DescriptiveValueRequired < Struct
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # 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.
+      # Status of the descriptive element value 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 :standard, Standard.optional.meta(omittable: true)
+      attribute :encoding, Standard.optional.meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).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 :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
     end
   end

data/lib/cocina/models/dro.rb

@@ -31,7 +31,7 @@ module Cocina
       # 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(:administrative, Administrative.default { Administrative.new })
       attribute :description, Description.optional.meta(omittable: true)
       attribute :identification, Identification.optional.meta(omittable: true)
       attribute :structural, DROStructural.optional.meta(omittable: true)

data/lib/cocina/models/dro_access.rb

@@ -7,10 +7,16 @@ module Cocina
       # 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)
-      attribute :embargo, Embargo.optional.meta(omittable: true)
     end
   end
 end