cocina-models 0.41.0 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29038502bea77b7be8adc58a0af9e73573a3da0d614c1d8c413a63ca80ffed72
-  data.tar.gz: b4e750e2124c23cbf11203a672a20f59f838cd8eb9a57fd592a00a26ef9b169e
+  metadata.gz: 5009424cf5bd827da8766eb5e0ecee739931123bad8f233342280908b4dac436
+  data.tar.gz: '084f2ed351b54e1c792df48116bb55e51fd3e9d27921167aa80f1768b595f9ac'
 SHA512:
-  metadata.gz: fc11509d28f0f9a6b174ec4943fbf51c6eb98a42dd2fe578082aa5fcf3b30a9291f293791ac3a69f2835bb7982a9c578190a4650be1af8585cf52f28c9236a65
-  data.tar.gz: 1dbd66908e5aaa6ac7cc38a9ea9b72062e537daa1c5d54844f8a86c75884b83a51e3cc9ad307dcebc2199276b092eede8dbc96a87578b28fcf328456617bd4d6
+  metadata.gz: 3097db674f1c8da72a88296cda09ca06fc8c1dc1cfecdfa5fcd0d94e4585f017433e77a3f8e38495371dfb4c3c1dec6955f5380de3e7e81b9318abe16a326972
+  data.tar.gz: 571a4ca0471f75fe22d7f943f9c79f9db19a324f0aeef402d237aa8d5c00899ba4ff1407efe465b2470c3d9c382084058cb69d4093b3233470105fad2a1b530c

data/.github/pull_request_template.md

@@ -1,3 +1,5 @@
+**NOTE:  Changes to openapi.yml require updating openapi.yml for sdr-api and dor-services-app and generating models - see README.**
+
 ## Why was this change made?
 
 
@@ -7,6 +9,3 @@
 
 
 ## Which documentation and/or configurations were updated?
-
-
-

data/.rubocop.yml

@@ -7,170 +7,148 @@ require:
 AllCops:
   TargetRubyVersion: 2.5
 
+# ----- Layout ------
+
 Layout/LineLength:
   Max: 114
   Exclude:
     - lib/cocina/models/*
 
-Metrics/BlockLength:
-  Exclude:
-    - cocina-models.gemspec
-    - spec/cocina/**/*
-
-Metrics/MethodLength:
-  Max: 14
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Max: 18
-  Exclude:
-    - spec/cocina/models/description_spec.rb
-    - spec/cocina/models/dro_shared_examples.rb
-
-Style/Documentation:
-  Exclude:
-    - lib/cocina/models/*
-
+Layout/BeginEndAlignment: # (new in 0.91)
+  Enabled: true
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
-
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
+# ----- Lint ------
 
-Lint/MixedRegexpCaptureTypes:
+Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: true
-
-Lint/RaiseException:
+Lint/ConstantDefinitionInBlock: # (new in 0.91)
   Enabled: true
-
-Lint/StructNewOverride:
+Lint/DeprecatedOpenSSLConstant:
   Enabled: true
-
-Style/AccessorGrouping:
+Lint/DuplicateElsifCondition:
   Enabled: true
-
-Style/BisectedAttrAccessor:
+Lint/DuplicateRequire: # (new in 0.90)
   Enabled: true
-
-Style/ExponentialNotation:
+Lint/DuplicateRescueException:
   Enabled: true
-
-Style/HashEachMethods:
+Lint/EmptyConditionalBody:
   Enabled: true
-
-Style/HashTransformKeys:
+Lint/EmptyFile: # (new in 0.90)
   Enabled: true
-
-Style/HashTransformValues:
+Lint/FloatComparison:
   Enabled: true
-
-Style/RedundantAssignment:
+Lint/HashCompareByIdentity: # (new in 0.93)
   Enabled: true
-
-Style/RedundantFetchBlock:
+Lint/IdentityComparison: # (new in 0.91)
   Enabled: true
-
-Style/RedundantRegexpCharacterClass:
+Lint/MissingSuper:
   Enabled: true
-
-Style/RedundantRegexpEscape:
+Lint/MixedRegexpCaptureTypes:
   Enabled: true
-
-Style/SlicingWithRange:
+Lint/OutOfRangeRegexpRef:
   Enabled: true
-
-Lint/BinaryOperatorWithIdenticalOperands:
+Lint/RaiseException:
   Enabled: true
-
-Lint/DuplicateElsifCondition:
+Lint/RedundantSafeNavigation: # (new in 0.93)
   Enabled: true
-
-Lint/DuplicateRescueException:
+Lint/SelfAssignment:
   Enabled: true
-
-Lint/EmptyConditionalBody:
+Lint/StructNewOverride:
   Enabled: true
-
-Lint/FloatComparison:
+Lint/TopLevelReturnWithArgument:
   Enabled: true
-
-Lint/MissingSuper:
+Lint/TrailingCommaInAttributeDeclaration: # (new in 0.90)
   Enabled: true
-
-Lint/OutOfRangeRegexpRef:
+Lint/UnreachableLoop:
   Enabled: true
-
-Lint/SelfAssignment:
+Lint/UselessMethodDefinition: # (new in 0.90)
   Enabled: true
-
-Lint/TopLevelReturnWithArgument:
+Lint/UselessTimes: # (new in 0.91)
   Enabled: true
 
-Lint/UnreachableLoop:
-  Enabled: true
+# ----- Metrics ------
 
-Style/ArrayCoercion:
-  Enabled: true
+Metrics/BlockLength:
+  Exclude:
+    - cocina-models.gemspec
+    - spec/cocina/**/*
 
-Style/CaseLikeIf:
-  Enabled: true
+Metrics/MethodLength:
+  Max: 14
 
-Style/ExplicitBlockArgument:
-  Enabled: true
+# ----- RSpec ------
 
-Style/GlobalStdStream:
-  Enabled: true
+RSpec/ExampleLength:
+  Max: 18
+  Exclude:
+    - spec/cocina/models/description_spec.rb
+    - spec/cocina/models/dro_shared_examples.rb
 
-Style/HashAsLastArrayItem:
-  Enabled: true
+RSpec/MultipleExpectations:
+  Enabled: false
 
-Style/HashLikeCase:
+RSpec/StubbedMock: # (new in 1.44)
   Enabled: true
 
-Style/OptionalBooleanParameter:
-  Enabled: false
+# ----- Style ------
 
-Style/RedundantFileExtensionInRequire:
-  Enabled: true
+Style/Documentation:
+  Exclude:
+    - lib/cocina/models/*
 
-Style/SingleArgumentDig:
+Style/AccessorGrouping:
   Enabled: true
-
-Style/StringConcatenation:
+Style/ArrayCoercion:
   Enabled: true
-
-Layout/BeginEndAlignment: # (new in 0.91)
+Style/BisectedAttrAccessor:
   Enabled: true
-Lint/ConstantDefinitionInBlock: # (new in 0.91)
+Style/CaseLikeIf:
   Enabled: true
-Lint/DuplicateRequire: # (new in 0.90)
+Style/ClassEqualityComparison: # (new in 0.93)
   Enabled: true
-Lint/EmptyFile: # (new in 0.90)
+Style/CombinableLoops: # (new in 0.90)
   Enabled: true
-Lint/HashCompareByIdentity: # (new in 0.93)
+Style/ExplicitBlockArgument:
   Enabled: true
-Lint/IdentityComparison: # (new in 0.91)
+Style/ExponentialNotation:
   Enabled: true
-Lint/RedundantSafeNavigation: # (new in 0.93)
+Style/GlobalStdStream:
   Enabled: true
-Lint/TrailingCommaInAttributeDeclaration: # (new in 0.90)
+Style/HashAsLastArrayItem:
   Enabled: true
-Lint/UselessMethodDefinition: # (new in 0.90)
+Style/HashEachMethods:
   Enabled: true
-Lint/UselessTimes: # (new in 0.91)
+Style/HashLikeCase:
   Enabled: true
-Style/ClassEqualityComparison: # (new in 0.93)
+Style/HashTransformKeys:
   Enabled: true
-Style/CombinableLoops: # (new in 0.90)
+Style/HashTransformValues:
   Enabled: true
 Style/KeywordParametersOrder: # (new in 0.90)
   Enabled: true
+Style/OptionalBooleanParameter:
+  Enabled: false
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
 Style/RedundantSelfAssignment: # (new in 0.90)
   Enabled: true
+Style/SingleArgumentDig:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
 Style/SoleNestedConditional: # (new in 0.89)
   Enabled: true
+Style/StringConcatenation:
+  Enabled: true

data/README.md

@@ -2,7 +2,7 @@
 [![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)
-[![OpenAPI Validator](http://validator.swagger.io/validator?url=https://raw.githubusercontent.com/sul-dlss/cocina-models/master/openapi.yml)](http://validator.swagger.io/validator/debug?url=https://raw.githubusercontent.com/sul-dlss/cocina-models/master/openapi.yml)
+[![OpenAPI Validator](http://validator.swagger.io/validator?url=https://raw.githubusercontent.com/sul-dlss/cocina-models/main/openapi.yml)](http://validator.swagger.io/validator/debug?url=https://raw.githubusercontent.com/sul-dlss/cocina-models/main/openapi.yml)
 
 # Cocina::Models
 
@@ -42,6 +42,10 @@ which pushes the gem to rubygems.org.  Next write up the release notes: https://
 
 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.
 
+### Communicate
+
+Send a note to `#dlss-infra-chg-mgmt` on Slack to let people know what is changing and when.
+
 ### Dependent Services
 
 Once the above listed gems are updated all the following services that use cocina-models should be updated and released at the same time:
@@ -52,6 +56,9 @@ Once the above listed gems are updated all the following services that use cocin
 * sul-dlss/common-accessioning
 * sul-dlss/argo
 * sul-dlss/pre-assembly
+* sul-dlss/hydrus
+* sul-dlss/happy-heron
+* sul-dlss/infrastructure-integration-test
 
 ## Using this gem
 

data/cocina-models.gemspec

@@ -22,7 +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.required_ruby_version = '>= 2.5'
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'dry-struct', '~> 1.0'
@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'committee'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.87'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop', '~> 0.93'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.44'
   spec.add_development_dependency 'simplecov', '~> 0.17.0'
 end

data/docs/index.html

@@ -14,7 +14,7 @@
     </style>
   </head>
   <body>
-    <redoc spec-url='https://raw.githubusercontent.com/sul-dlss/cocina-models/master/openapi.yml'></redoc>
+    <redoc spec-url='https://raw.githubusercontent.com/sul-dlss/cocina-models/main/openapi.yml'></redoc>
     <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
   </body>
 </html>

data/lib/cocina/models/description.rb

@@ -7,6 +7,7 @@ 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 :geographic, Types::Strict::Array.of(DescriptiveGeographicMetadata).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)

data/lib/cocina/models/descriptive_access_metadata.rb

@@ -5,6 +5,7 @@ module Cocina
     class DescriptiveAccessMetadata < Struct
       attribute :url, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :physicalLocation, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :digitalLocation, 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)

data/lib/cocina/models/descriptive_admin_metadata.rb

@@ -7,7 +7,7 @@ module Cocina
       attribute :event, Types::Strict::Array.of(Event).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 :metadataStandard, Types::Strict::Array.of(Standard).meta(omittable: true)
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
     end
   end

data/lib/cocina/models/descriptive_geographic_metadata.rb

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

data/lib/cocina/models/language.rb

@@ -15,7 +15,7 @@ module Cocina
       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).
+      # Status of the language relative to other parallel language elements (e.g. the primary language)
       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)

data/lib/cocina/models/message_digest.rb

@@ -10,7 +10,7 @@ module Cocina
 
       # The algorithm that was used
       attribute :type, Types::Strict::String.enum(*MessageDigest::TYPES)
-      # The digest value Base64 encoded
+      # The digest value hexidecimal encoded
       attribute :digest, Types::Strict::String
     end
   end

data/lib/cocina/models/related_resource.rb

@@ -21,6 +21,8 @@ module Cocina
       # Stanford persistent URL associated with the related resource.
       attribute :purl, Types::Strict::String.meta(omittable: true)
       attribute :access, DescriptiveAccessMetadata.optional.meta(omittable: true)
+      attribute :relatedResource, Types::Strict::Array.of(RelatedResource).meta(omittable: true)
+      attribute :adminMetadata, DescriptiveAdminMetadata.optional.meta(omittable: true)
       # The version of the related resource.
       attribute :version, Types::Strict::String.meta(omittable: true)
     end

data/lib/cocina/models/version.rb

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

data/openapi.yml

@@ -261,7 +261,6 @@ 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.
@@ -305,6 +304,11 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
+        geographic:
+          description: Geographic description for items with coordinates or bounding boxes.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveGeographicMetadata"
         language:
           description: Languages, scripts, symbolic systems, and notations used in all or
             part of a resource.
@@ -361,6 +365,11 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
+        digitalLocation:
+          description: Location of a digital version of the resource, such as a file path for a born digital resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
         accessContact:
           description: The library, organization, or person responsible for access to the resource.
           type: array
@@ -402,9 +411,11 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
-        standard:
-          # description: Descriptive or content standard to which this resource description conforms.
-          $ref: "#/components/schemas/Standard"
+        metadataStandard:
+          description: Descriptive or content standard(s) to which this resource description conforms.
+          type: array
+          items:
+            $ref: "#/components/schemas/Standard"
         identifier:
           description: Identifiers associated with this resource description.
           type: array
@@ -436,7 +447,6 @@ 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
@@ -470,6 +480,20 @@ components:
                 $ref: "#/components/schemas/DescriptiveValue"
             valueLanguage:
               $ref: "#/components/schemas/DescriptiveValueLanguage"
+    DescriptiveGeographicMetadata:
+      description: Value model for mods geographic extension metadata
+      type: object
+      additionalProperties: false
+      properties:
+        form:
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        subject:
+          description: Terms associated with the intellectual content of the related resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
     DescriptiveParallelValue:
       description: Value model for multiple representations of the same information (e.g. in different languages).
       type: object
@@ -914,8 +938,7 @@ components:
         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).
+          description: Status of the language relative to other parallel language elements (e.g. the primary language)
           type: string
           enum:
             - primary
@@ -949,7 +972,7 @@ components:
             - md5
             - sha1
         digest:
-          description: The digest value Base64 encoded
+          description: The digest value hexidecimal encoded
           type: string
       required:
         - type
@@ -976,7 +999,6 @@ components:
         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
@@ -1032,6 +1054,13 @@ components:
           format: uri
         access:
           $ref: "#/components/schemas/DescriptiveAccessMetadata"
+        relatedResource:
+          description: Other resources associated with the related resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/RelatedResource"
+        adminMetadata:
+          $ref: "#/components/schemas/DescriptiveAdminMetadata"
         version:
           description: The version of the related resource.
           type: string

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.41.0
+  version: 0.45.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,28 +170,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.87'
+        version: '0.93'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.87'
+        version: '0.93'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.44'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.44'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +267,7 @@ files:
 - lib/cocina/models/descriptive_access_metadata.rb
 - lib/cocina/models/descriptive_admin_metadata.rb
 - lib/cocina/models/descriptive_basic_value.rb
+- lib/cocina/models/descriptive_geographic_metadata.rb
 - lib/cocina/models/descriptive_parallel_value.rb
 - lib/cocina/models/descriptive_structured_value.rb
 - lib/cocina/models/descriptive_value.rb
@@ -315,7 +316,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement