cocina-models 0.58.1 → 0.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f791f4fb5f53b913b495bcae9bd9918b924f43652e27125c624ffb12ba67e6a
-  data.tar.gz: f6d42499c81c75870ba3859ddb0241a2ecc4df420677a2d371c775ba3f72efd4
+  metadata.gz: 83f1515b4aa8389d471458c9c58f499fddbfe0f2cbf01b4be56c70f50ec77cd3
+  data.tar.gz: 0a6de21eadb30b5efb2512cb2786ec290815314181c054d9012a29518d2f4021
 SHA512:
-  metadata.gz: ef6a8fcbb2550b49fbcb5fbd09a2d3fafce8f345773387fd12520b654e5e0f810aa805a51aeda04ccf4766eac0108cb4c59467a3d1ff86b9dbf5e337450da5aa
-  data.tar.gz: 5a7282e082a864bc3e3c223593a01c3c42243f458ba2debc2d4aa72478d945af9e350877aec68073590bf30e0c4080cf882b0f255d190dd901b46f950accb93a
+  metadata.gz: ab9f26de5fb14d9e036034acec1c056cf5a067d426d0547e93cd05d5573b53617c97afa77c00417adbd270278edcf1edbcc40bb3db56512cf702a568fca6a808
+  data.tar.gz: 8c368c49dd7581348a98898229c7bae57eab65fc31f0bdcced427d31e65294594b57ce76b36a2489cc263720d992bee4c1b0201e503e0ba8680e9848de4d9dcc

data/.rubocop.yml

@@ -79,6 +79,8 @@ Metrics/BlockLength:
 
 Metrics/MethodLength:
   Max: 14
+  Exclude:
+    - 'spec/cocina/models/file_access_spec.rb'
 
 # ----- RSpec ------
 

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-09-08 19:05:09 UTC using RuboCop version 0.89.1.
+# on 2021-04-16 17:25:55 UTC using RuboCop version 0.93.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,15 +8,15 @@
 
 # Offense count: 1
 # Configuration parameters: AllowedMethods.
-# AllowedMethods: present?, blank?, presence, try, try!
+# AllowedMethods: present?, blank?, presence, try, try!, in?
 Lint/SafeNavigationChain:
   Exclude:
     - 'lib/cocina/generator/schema_base.rb'
 
 # Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 8
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
 
 # Offense count: 1
 # Configuration parameters: MinBodyLength.

data/README.md

@@ -8,7 +8,7 @@
 
 This is a Ruby implementation of the SDR data model (named "COCINA"). The data being modeled includes digital repository objects.
 
-Validation is performed by openapi (using OpenAPIParser). Modeling is provided by dry-struct and dry-types. Together, these provide a way for consumers to validate objects against models and to manipulate thos objects.
+Validation is performed by openapi (using OpenAPIParser). Modeling is provided by dry-struct and dry-types. Together, these provide a way for consumers to validate objects against models and to manipulate those objects.
 
 This is a work in progress that will ultimately implement the full [COCINA data model](http://sul-dlss.github.io/cocina-models/). See also [architecture documentation](https://sul-dlss.github.io/taco-truck/COCINA.html#cocina-data-models--shapes).
 
@@ -34,44 +34,54 @@ Beyond what is necessary to test the generator, the Cocina model classes are not
 
 ## Releasing
 
+### Step 0: Share intent to change the models
+
+Send a note to `#dlss-infra-chg-mgmt` on Slack to let people know what is changing and when.
+
+### Step 1: Cut the release
+
 The release process is much like any other gem. First bump the version in `lib/cocina/models/version.rb`, and commit the result. Then run:
 ```
 bundle exec rake release
 ```
 which pushes the gem to rubygems.org.  Next write up the release notes: https://github.com/sul-dlss/cocina-models/releases .
 
-Finally, you must release versions of [sdr-client](https://github.com/sul-dlss/sdr-client) and [dor-services-client](https://github.com/sul-dlss/dor-services-client/) pinned to this version because [Argo](https://github.com/sul-dlss/argo) depends on both of those. When [dor-services-app](https://github.com/sul-dlss/dor-services-app) is updated to use the new models (via the auto-update script), the clients must be updated at the same time or there is risk of models produced by dor-services-app not being acceptable to the clients.
+### Step 2: Update client gems coupled to the models
 
-### Communicate
+Next, you should release versions of [sdr-client](https://github.com/sul-dlss/sdr-client) and [dor-services-client](https://github.com/sul-dlss/dor-services-client/) pinned to this version because applications such as [Argo](https://github.com/sul-dlss/argo) depend on both of these gems using the same models.
 
-Send a note to `#dlss-infra-chg-mgmt` on Slack to let people know what is changing and when.
+### Step 3: Update service API specifications and gems
+
+The cocina-models gem is used in applications that have an API specification that accepts Cocina models. Next, make sure that the `openapi.yml` for these applications include the `openapi.yml` schema changes made in cocina-models. This list of services is known to include:
+
+* [sul-dlss/sdr-api](https://github.com/sul-dlss/sdr-api)
+* [sul-dlss/dor-services-app](https://github.com/sul-dlss/dor-services-app/)
 
-### Dependent Services
+This can be accomplished by copying 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.
 
-Once the above listed gems are updated all the following services that use cocina-models should be updated and released at the same time:
+#### Step 3b: Bump gems
 
-* sul-dlss/sdr-api
-* sul-dlss/dor-services-app
-* sul-dlss/google-books
-* sul-dlss/common-accessioning
-* sul-dlss/argo
-* sul-dlss/pre-assembly
-* sul-dlss/hydrus
-* sul-dlss/happy-heron
-* sul-dlss/infrastructure-integration-test
-* sul-dlss/dor_indexing_app
+At the same, we have found it convenient to use these PRs to also bump the versions of cocina-models, sdr-client, and dor-services-client in these applications/services. Why? When [dor-services-app](https://github.com/sul-dlss/dor-services-app), for example, is updated to use the new models (via the auto-update script), these clients should be updated at the same time or there is risk of models produced by dor-services-app not being acceptable to the clients.
 
-## Using this gem
+### Step 4: Update other dependent applications
 
-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`.
+Once the above listed steps have been completed, all the following applications that use cocina-models should be updated and released at the same time:
 
-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.
+* [sul-dlss/dor_indexing_app](https://github.com/sul-dlss/dor_indexing_app/)
+* [sul-dlss/common-accessioning](https://github.com/sul-dlss/common-accessioning/)
+* [sul-dlss/google-books](https://github.com/sul-dlss/google-books/)
+* [sul-dlss/argo](https://github.com/sul-dlss/argo/)
+* [sul-dlss/pre-assembly](https://github.com/sul-dlss/pre-assembly/)
+* [sul-dlss/hydrus](https://github.com/sul-dlss/hydra_etd/)
+* [sul-dlss/hydrus](https://github.com/sul-dlss/hydrus/)
+* [sul-dlss/happy-heron](https://github.com/sul-dlss/happy-heron/)
+* [sul-dlss/infrastructure-integration-test](https://github.com/sul-dlss/infrastructure-integration-test/)
 
-### Usage conventions
+## 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
+* `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/schema.rb

@@ -5,7 +5,7 @@ module Cocina
     # Class for generating from an openapi schema
     class Schema < SchemaBase
       def schema_properties
-        @schema_properties ||= (properties + all_of_properties).uniq(&:key)
+        @schema_properties ||= (properties + all_of_properties + one_of_properties).uniq(&:key)
       end
 
       def generate
@@ -83,20 +83,48 @@ module Cocina
         all_of_properties_for(schema_doc)
       end
 
+      def one_of_properties
+        one_of_properties_for(schema_doc)
+      end
+
       def all_of_properties_for(doc)
         return [] if doc.all_of.nil?
 
         doc.all_of.map do |all_of_schema|
           # All of for this + recurse
-          schema_properties_for(all_of_schema) + all_of_properties_for(all_of_schema)
+          schema_properties_for(all_of_schema) +
+            all_of_properties_for(all_of_schema) +
+            one_of_properties_for(all_of_schema)
         end.flatten
       end
 
+      def one_of_properties_for(doc)
+        return [] if doc.one_of.nil?
+
+        # All properties must be objects.
+        unless doc.one_of.all? { |schema| schema.type == 'object' }
+          raise 'All properties for oneOf must be objects'
+        end
+
+        doc.one_of.flat_map do |one_of_doc|
+          one_of_doc.properties.map do |key, properties_doc|
+            property_class_for(properties_doc).new(properties_doc,
+                                                   key: key,
+                                                   # The property does less validation because may vary between
+                                                   # different oneOf schemas. Validation is still performed
+                                                   # by openAPI.
+                                                   relaxed: true,
+                                                   parent: self)
+          end
+        end
+      end
+
       def schema_properties_for(doc)
         doc.properties.map do |key, properties_doc|
           property_class_for(properties_doc).new(properties_doc,
                                                  key: key,
                                                  required: doc.requires?(key),
+                                                 nullable: properties_doc.nullable?,
                                                  parent: self)
         end
       end

data/lib/cocina/generator/schema_array.rb

@@ -9,7 +9,7 @@ module Cocina
       end
 
       def omittable
-        if required
+        if required && !relaxed
           '.default([].freeze)'
         else
           '.meta(omittable: true)'

data/lib/cocina/generator/schema_base.rb

@@ -4,13 +4,15 @@ module Cocina
   module Generator
     # Base class for generating from openapi
     class SchemaBase
-      attr_reader :schema_doc, :key, :required, :parent
+      attr_reader :schema_doc, :key, :required, :nullable, :parent, :relaxed
 
-      def initialize(schema_doc, key: nil, required: false, parent: nil)
+      def initialize(schema_doc, key: nil, required: false, nullable: false, parent: nil, relaxed: false)
         @schema_doc = schema_doc
         @key = key
         @required = required
+        @nullable = nullable
         @parent = parent
+        @relaxed = relaxed
       end
 
       def filename
@@ -24,17 +26,15 @@ module Cocina
       # Allows non-required values to not be provided. This allows smaller
       # requests as not every field needs to be present.
       def omittable
-        return '' if required
+        return '' if required && !relaxed
 
         '.meta(omittable: true)'
       end
 
-      # Allows non-required values to be set to nil. This is useful when doing
+      # Allows nillable values to be set to nil. This is useful when doing
       # an update and you want to clear out a value.
       def optional
-        return '' if required
-
-        '.optional'
+        nullable || relaxed ? '.optional' : ''
       end
 
       def quote(item)
@@ -55,6 +55,12 @@ module Cocina
         "# example: #{schema_doc.example}\n"
       end
 
+      def relaxed_comment
+        return '' unless relaxed
+
+        "# Validation of this property is relaxed. See the openapi for full validation.\n"
+      end
+
       def dry_datatype(doc)
         case doc.type
         when 'integer'
@@ -64,7 +70,7 @@ module Cocina
         when 'boolean'
           'Strict::Bool'
         else
-          if doc.one_of&.map(&:type).all? { |o| %w[integer string].include?(o) }
+          if any_datatype?(doc)
             'Nominal::Any'
           else
             raise "#{schema_doc.type} not supported"
@@ -72,6 +78,10 @@ module Cocina
         end
       end
 
+      def any_datatype?(doc)
+        relaxed || doc.one_of&.map(&:type).all? { |o| %w[integer string].include?(o) }
+      end
+
       def string_dry_datatype(doc)
         case doc.format
         when 'date-time'

data/lib/cocina/generator/schema_ref.rb

@@ -5,7 +5,7 @@ module Cocina
     # Class for generating from an openapi reference
     class SchemaRef < SchemaBase
       def generate
-        if required
+        if required && !relaxed
           "attribute(:#{name.camelize(:lower)}, #{schema_doc.name}.default { #{schema_doc.name}.new })"
         else
           "attribute :#{name.camelize(:lower)}, #{schema_doc.name}.optional.meta(omittable: true)"

data/lib/cocina/generator/schema_value.rb

@@ -7,14 +7,14 @@ module Cocina
       # rubocop:disable Layout/LineLength
       def generate
         # optional has to come before default or the default value that gets set will be nil.
-        "#{description}#{example}attribute :#{name.camelize(:lower)}, Types::#{dry_datatype(schema_doc)}#{optional}#{default}#{enum}#{omittable}"
+        "#{description}#{example}#{relaxed_comment}attribute :#{name.camelize(:lower)}, Types::#{dry_datatype(schema_doc)}#{optional}#{default}#{enum}#{omittable}"
       end
       # rubocop:enable Layout/LineLength
 
       private
 
       def enum
-        return '' unless schema_doc.enum
+        return '' if !schema_doc.enum || relaxed
 
         items = use_types? ? "*#{parent.name}::TYPES" : schema_doc.enum.map { |item| quote(item) }.join(', ')
 

data/lib/cocina/models/access.rb

@@ -3,18 +3,17 @@
 module Cocina
   module Models
     class Access < Struct
-      # Access level
-      attribute :access, Types::Strict::String.optional.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.optional.meta(omittable: true)
+      # Access level.
+      # Validation of this property is relaxed. See the openapi for full validation.
+      attribute :access, Types::Strict::String.optional.default('dark').meta(omittable: true)
+      # Download access level.
+      # Validation of this property is relaxed. See the openapi for full validation.
+      attribute :download, Types::Strict::String.optional.default('none').meta(omittable: true)
       # If access is "location-based", which location should have access.
-      attribute :readLocation, Types::Strict::String.optional.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.optional.meta(omittable: true)
-      # The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
-      attribute :license, Types::Strict::String.optional.meta(omittable: true)
+      # Validation of this property is relaxed. See the openapi for full validation.
+      attribute :readLocation, Types::Strict::String.optional.meta(omittable: true)
+      # Validation of this property is relaxed. See the openapi for full validation.
+      attribute :controlledDigitalLending, Types::Strict::Bool.optional.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/admin_policy.rb

@@ -7,7 +7,6 @@ module Cocina
 
       TYPES = ['http://cocina.sul.stanford.edu/models/admin_policy.jsonld'].freeze
 
-      # example: item
       attribute :type, Types::Strict::String.enum(*AdminPolicy::TYPES)
       # example: druid:bc123df4567
       attribute :externalIdentifier, Types::Strict::String

data/lib/cocina/models/admin_policy_administrative.rb

@@ -4,17 +4,17 @@ module Cocina
   module Models
     class AdminPolicyAdministrative < Struct
       # This is an XML expression of the default access (see defaultAccess)
-      attribute :defaultObjectRights, Types::Strict::String.optional.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 :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 :defaultAccess, AdminPolicyDefaultAccess.optional.meta(omittable: true)
       attribute :registrationWorkflow, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
       # An additional workflow to start for objects managed by this admin policy once the end-accession workflow step is complete
       # example: wasCrawlPreassemblyWF
-      attribute :disseminationWorkflow, Types::Strict::String.optional.meta(omittable: true)
+      attribute :disseminationWorkflow, Types::Strict::String.meta(omittable: true)
       attribute :collectionsForRegistration, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
       # example: druid:bc123df4567
       attribute :hasAdminPolicy, Types::Strict::String
       # example: druid:bc123df4567
-      attribute :referencesAgreement, Types::Strict::String.optional.meta(omittable: true)
+      attribute :referencesAgreement, Types::Strict::String.meta(omittable: true)
       attribute :roles, Types::Strict::Array.of(AccessRole).meta(omittable: true)
     end
   end

data/lib/cocina/models/admin_policy_default_access.rb

@@ -3,15 +3,15 @@
 module Cocina
   module Models
     class AdminPolicyDefaultAccess < Struct
-      attribute :access, Types::Strict::String.optional.enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
+      attribute :access, Types::Strict::String.enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
       # Available for controlled digital lending.
-      attribute :controlledDigitalLending, Types::Strict::Bool.optional.meta(omittable: true)
+      attribute :controlledDigitalLending, Types::Strict::Bool.meta(omittable: true)
       # The human readable copyright statement that applies
       # example: Copyright World Trade Organization
       attribute :copyright, Types::Strict::String.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.optional.enum('world', 'stanford', 'location-based', 'none').meta(omittable: true)
+      attribute :download, Types::Strict::String.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.optional.enum('spec', 'music', 'ars', 'art', 'hoover', 'm&m').meta(omittable: true)

data/lib/cocina/models/administrative.rb

@@ -8,7 +8,7 @@ module Cocina
       attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true)
       # Administrative or Internal project this resource is a part of
       # example: Google Books
-      attribute :partOfProject, Types::Strict::String.optional.meta(omittable: true)
+      attribute :partOfProject, Types::Strict::String.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/citation_only_access.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class CitationOnlyAccess < Struct
+      # Access level.
+      attribute :access, Types::Strict::String.enum('citation-only')
+      # Download access level.
+      attribute :download, Types::Strict::String.enum('none')
+      # If access is "location-based", which location should have access.
+      attribute :readLocation, Types::Strict::String.optional.enum('').meta(omittable: true)
+      attribute :controlledDigitalLending, Types::Strict::Bool.enum(false).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/collection.rb

@@ -12,7 +12,6 @@ module Cocina
                'http://cocina.sul.stanford.edu/models/series.jsonld'].freeze
 
       # 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
@@ -20,7 +19,7 @@ module Cocina
       attribute :label, Types::Strict::String
       # Version for the Collection within SDR.
       attribute :version, Types::Strict::Integer
-      attribute(:access, Access.default { Access.new })
+      attribute(:access, CollectionAccess.default { CollectionAccess.new })
       attribute :administrative, Administrative.optional.meta(omittable: true)
       attribute :description, Description.optional.meta(omittable: true)
       attribute :identification, CollectionIdentification.optional.meta(omittable: true)

data/lib/cocina/models/collection_access.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class CollectionAccess < Struct
+      # Access level
+      attribute :access, Types::Strict::String.default('dark').enum('world', 'dark').meta(omittable: true)
+      # The human readable copyright statement that applies
+      # example: Copyright World Trade Organization
+      attribute :copyright, Types::Strict::String.optional.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)
+      # The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
+      attribute :license, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end