cocina-models 0.34.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 258bc916aaaff62a84cd0bd264f8957e3c916310134ef3372cfdd3eca4c1ff4e
-  data.tar.gz: c26a6cc519230a25d19b218ddcec52fa552ea7780f647b6d449aee223be35eef
+  metadata.gz: 2c956bcb234bb19ae05ab24d3b64efd2827bf23ab0d7953c5dc8405532f2391f
+  data.tar.gz: 3fa549a561323f9cb19a595159e3c7eafd100be257920240dc2dde6800766af7
 SHA512:
-  metadata.gz: cd057f437502f2e54f6b2c689b6aef4c808ac4912c91d87755abfeb13c24100ef3380f262e7ec27f42592ecbd59b16d68669c878a31c55fc2402f069c5142f1e
-  data.tar.gz: 5a27ebb9108e9838117b02ec015bb025120d82e3f90749b12d23b523f3eea4efe865b6e405f649574f10f88ee0a70811334c339e9d522f5f1186b72f59df9240
+  metadata.gz: 03ba5b89ddf4fdbaa9a3167004771b9bcacf92409800735e1816e3db132bc3d4199fe62218f48053d7cd2bf5faeb53d2c542b16ee1b420bf5fec154f8a444da9
+  data.tar.gz: b2fbbd2b9b1477bcdead8c3c8a186ae96c577e3b8431f7c23d92fa44b97d320f3e3f415121e26231f88f2ee594c0e3949eed5f65865e88fed24d52c7f1952cda

data/.rubocop.yml

@@ -4,6 +4,9 @@ inherit_from: .rubocop_todo.yml
 require:
   - rubocop-rspec
 
+AllCops:
+  TargetRubyVersion: 2.5
+
 Layout/LineLength:
   Max: 114
   Exclude:
@@ -80,4 +83,63 @@ Style/RedundantRegexpEscape:
 
 Style/SlicingWithRange:
   Enabled: true
-  
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true

data/README.md

@@ -32,6 +32,17 @@ The generator is tested via its output when run against `openapi.yml`, viz., the
 
 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`.
 
+## Releasing
+
+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.
+
+
 ## Using this gem
 
 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`.

data/cocina-models.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.5'
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'dry-struct', '~> 1.0'

data/docs/maps/DRO.json

@@ -81,6 +81,10 @@
           "description": "The human readable copyright statement that applies to the DRO.",
           "type": "string"
         },
+        "controlledDigitalLending": {
+          "description": "If the object is available for controlled digital lending.",
+          "type": "boolean"
+        },
         "download": {
           "description": "Download level for the DRO metadata.",
           "type": "string",
@@ -294,8 +298,11 @@
           }
         },
         "isMemberOf": {
-          "description": "Collection that this DRO is a member of",
-          "type": "string"
+          "description": "Collections that this DRO is a member of",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         },
         "isTargetOf": {
           "description": "An Annotation instance that applies to the DRO.",

data/lib/cocina/generator/datatype.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Generator
+    # Class for generating from an openapi schema
+    class Datatype < SchemaBase
+      def generate
+        <<~RUBY
+          # frozen_string_literal: true
+
+          module Cocina
+            module Models
+              #{name} = Types::String.constrained(
+                format: /#{schema_doc.pattern}/i
+              )
+            end
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/cocina/generator/generator.rb

@@ -17,10 +17,13 @@ module Cocina
       def generate
         clean_output
 
-        schemas.each_key do |schema_name|
+        # 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
@@ -53,9 +56,14 @@ module Cocina
 
       def schema_for(schema_name)
         schema_doc = schemas[schema_name]
-        return nil if schema_doc.nil? || schema_doc.type != 'object'
+        return nil if schema_doc.nil?
 
-        Schema.new(schema_doc)
+        case schema_doc.type
+        when 'object'
+          Schema.new(schema_doc)
+        when 'string'
+          Datatype.new(schema_doc)
+        end
       end
 
       def generate_for(schema)

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_access.rb

@@ -4,6 +4,8 @@ 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)
+      # Available for controlled digital lending.
+      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.meta(omittable: true)

data/lib/cocina/models/dro_structural.rb

@@ -5,8 +5,7 @@ module Cocina
     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)
+      attribute :isMemberOf, Types::Strict::Array.of(Druid).meta(omittable: true)
       # Agreement that covers the deposit of the DRO into SDR.
       attribute :hasAgreement, Types::Strict::String.meta(omittable: true)
     end

data/lib/cocina/models/druid.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    Druid = Types::String.constrained(
+      format: /^druid:[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$/i
+    )
+  end
+end

data/lib/cocina/models/event.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     class Event < Struct
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      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)
       attribute :date, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)

data/lib/cocina/models/file.rb

@@ -24,7 +24,7 @@ module Cocina
       # 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(:access, FileAccess.default { FileAccess.new })
       attribute(:administrative, FileAdministrative.default { FileAdministrative.new })
       attribute :presentation, Presentation.optional.meta(omittable: true)
     end

data/lib/cocina/models/file_access.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class FileAccess < Struct
+      # Access level
+      attribute :access, Types::Strict::String.default('dark').enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
+      # Available for controlled digital lending.
+      attribute :controlledDigitalLending, Types::Strict::Bool.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/identification.rb

@@ -3,6 +3,8 @@
 module Cocina
   module Models
     class Identification < Struct
+      # Unique identifier in some other system. This is because a large proportion of what is deposited in SDR, historically and currently, are representations of objects that are also represented in other systems. For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
+
       # example: sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026
       attribute :sourceId, Types::Strict::String.meta(omittable: true)
       attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)