cocina-models 0.84.5 → 0.85.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f88398655e31aa97ffb0ac963a0400dd2864535dd10819d53b57efecfeb6359f
-  data.tar.gz: 89e6074e7ba0c38db6db81e00263f84fc579fa039615d1f6be1b52ec32daff4b
+  metadata.gz: f3e8bdc15327c32a4d90a32780285048b947d799816e30ce9c47feb328f7deaf
+  data.tar.gz: d3a3b4e03410cad650555b2a085dd85e429029465d0ddf5e950a2c9231e27d73
 SHA512:
-  metadata.gz: 88d62e72d63ac8f5760f7ada91f7052c15ae0572f49c96ff601f4bc8f76db481015e48b910840cb862fe3bad80e91932172d6b7fe1e45bb62112dcf3613089be
-  data.tar.gz: c3164b24d4184f9fe10a3d4b2a0bbf58881fc63bf7237f46a01065a70f4b9d1315d8ea982c1dde2bbec4c8bff327b15c857c666596575da3ce6e8bc58bcb8648
+  metadata.gz: 18af72ea7b0ff5ce24800694b2a29d519d975c05e99d6124660fce6a78f66f274513914ee7763ef05d60bb1beac194aa6d77db610879f829b827dfccf88ef0cd
+  data.tar.gz: cb1837cdb6f1b78640ef91c8efae91e0dbe9d872525bf87beb9a5b345e59fff3156f6c7d9fdb98e9e713964cfc98094ae373c897fffb2e4469faf6bde37e8a6b

data/.rubocop.yml

@@ -6,8 +6,7 @@ require:
   - rubocop-rake
 
 AllCops:
-  # dor-services-app is stuck at ruby 2 until we get off Fedora3
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 # ----- Layout ------
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocina-models (0.84.5)
+    cocina-models (0.85.0)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -32,13 +32,13 @@ GEM
       json_schema (~> 0.14, >= 0.14.3)
       openapi_parser (>= 0.11.1, < 1.0)
       rack (>= 1.5)
-    commonmarker (0.23.5)
+    commonmarker (0.23.6)
     concurrent-ruby (1.1.10)
     deprecation (1.1.0)
       activesupport
     diff-lcs (1.5.0)
     docile (1.4.0)
-    dry-container (0.10.1)
+    dry-container (0.11.0)
       concurrent-ruby (~> 1.0)
     dry-core (0.8.1)
       concurrent-ruby (~> 1.0)
@@ -100,7 +100,7 @@ GEM
     rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
+    rspec-support (3.11.1)
     rspec_junit_formatter (0.5.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     rss (0.2.9)
@@ -119,7 +119,7 @@ GEM
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.13.1)
+    rubocop-rspec (2.13.2)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
@@ -135,7 +135,7 @@ GEM
     thor (1.2.1)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.3.0)
     zeitwerk (2.6.0)
 
 PLATFORMS

data/README.md

@@ -136,24 +136,34 @@ which pushes the gem to rubygems.org.  Next write up the release notes: https://
 
 ### Step 2: Update client gems coupled to the models
 
-**NOTE**: You can skip this step if the new release is a patch-level bump only.
+**NOTE**: You may skip this step if the new release is a patch-level bump only, as the client gems are pinned to a minor release of cocina-models.  However, a PR to update Gemfile.lock with the new cocina-models version is welcome ... and not a blocker.
 
-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.
+If this is a minor or major cocina-models version change, release new 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 use the new cocina-models version because applications such as [Argo](https://github.com/sul-dlss/argo) depend on both of these gems using the same models.
 
-### Step 3: Update service API specifications and gems
+### Step 3: Update services directly coupled to the models
 
-**NOTE**: You can skip this first half of the step if there have not been any changes to the `cocina-models` OpenAPI spec since the prior release.
-
-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:
+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/)
 
-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.
+**NOTE**: You can skip step 3A if there have not been any changes to the `cocina-models` OpenAPI spec since the prior release.
+
+#### Step 3A: Update API specifications
+
+The cocina-models gem is used in applications that have an API specification that accepts Cocina models. Make sure that the `openapi.yml` for these applications include the `openapi.yml` schema changes made in cocina-models.
+
+This can be accomplished by copying and pasting the cocina-models schemas to the openapi.yml of the associated project. By convention, these schemas are listed first in the `openapi.yml` of the associated projects, followed by the application-specific schemas.
+
+#### Step 3B: Bump gems and create the PRs
+
+If step 3A was needed, use the same 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.
+
+With or without step 3A, perform `bundle update` for cocina-models, sdr-client, and dor-services-client gems in the listed services and then make PRs for those repos.
 
-#### Step 3b: Bump gems
+#### Step 3C: Merge 'em
 
-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.
+Get the directly coupled services PRs merged before the deploy in step 5.
 
 ### Step 4: Update other dependent applications
 
@@ -161,19 +171,19 @@ Once the above listed steps have been completed, all applications that use cocin
 
 There are scripts to help with updating other dependent applications:
 
-#### Step 4A: Create the PRs
+#### Step 4A: Create the Cocina Level 2 PRs
 
 There is a Jenkins CI job that you can run manually to create all the PRs you need. Head to https://sul-ci-prod.stanford.edu/job/SUL-DLSS/job/access-update-scripts/job/cocina-level2-updates/ and then click `Build Now`. Click the new build that is created and then `Console Output` to watch the build. Once it has completed, you can proceed with the next step.
 
 If for some reason the above method does not work, the sul-dlss/access-update-scripts repo has a script for this: `cocina_level2_prs.rb`. You will need a github access token with scopes of "read:org" and "repo" (see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to run it, as noted in the comments at the top of that script.
 
-#### Step 4B: Merge the PRs
+#### Step 4B: Merge the Cocina Level 2 PRs
 
 [sul-dlss/access-update-scripts](https://github.com/sul-dlss/access-update-scripts) has a switch in the `merge-all.rb` script for this, as noted in the comments at the top of that script. (`REPOS_PATH=infrastructure GH_ACCESS_TOKEN=abc123 COCINA_LEVEL2= ./merge-all.rb`)
 
 ### Step 5: Deploy all affected applications together
 
-[sul-dlss/sdr-deploy](https://github.com/sul-dlss/sdr-deploy) has a flag in the deploy script to limit deploys to cocina dependent applications.  Refer to instructions in the [sdr-deploy/README](https://github.com/sul-dlss/sdr-deploy/blob/main/README.md#only-deploy-repos-related-to-cocina-models-update).
+[sul-dlss/sdr-deploy](https://github.com/sul-dlss/sdr-deploy) has a flag (-c) in the deploy script to limit deploys to cocina dependent applications.  Refer to instructions in the [sdr-deploy/README](https://github.com/sul-dlss/sdr-deploy/blob/main/README.md#only-deploy-repos-related-to-cocina-models-update).
 
 Note that running the integration tests is currently the best way we have to check for unintended effects and/or bugs when rolling out cocina-models changes.
 

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.7'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'deprecation'

data/lib/cocina/models/contributor.rb

@@ -14,7 +14,6 @@ module Cocina
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # URL or other pointer to the location of the contributor information.
       attribute? :valueAt, Types::Strict::String
-      attribute :parallelContributor, Types::Strict::Array.of(DescriptiveParallelContributor).default([].freeze)
     end
   end
 end

data/lib/cocina/models/description.rb

@@ -20,7 +20,7 @@ module Cocina
       attribute? :adminMetadata, DescriptiveAdminMetadata.optional
       # URL or other pointer to the location of the resource description.
       attribute? :valueAt, Types::Strict::String
-      # Stanford persistent URL associated with the related resource. Note this is http, not https.
+      # Stanford persistent URL associated with the related resource.
       attribute :purl, Types::Strict::String
     end
   end

data/lib/cocina/models/mapping/to_mods/geographic.rb

@@ -6,9 +6,9 @@ module Cocina
       module ToMods
         # Maps geo extension from cocina to MODS
         class Geographic # rubocop:disable Metrics/ClassLength
-          TYPE_REGEX = /^type$/.freeze
-          MEDIA_REGEX = /^media type$/.freeze
-          DATA_FORMAT_REGEX = /^data format$/.freeze
+          TYPE_REGEX = /^type$/
+          MEDIA_REGEX = /^media type$/
+          DATA_FORMAT_REGEX = /^data format$/
 
           ABOUT_URI_PREFIX = 'http://purl.stanford.edu/'
 

data/lib/cocina/models/mapping/to_mods/subject.rb

@@ -12,7 +12,7 @@ module Cocina
             'genre' => :genre,
             'occupation' => :occupation
           }.freeze
-          DEORDINAL_REGEX = /(?<=[0-9])(?:st|nd|rd|th)/.freeze
+          DEORDINAL_REGEX = /(?<=[0-9])(?:st|nd|rd|th)/
 
           # @params [Nokogiri::XML::Builder] xml
           # @params [Array<Cocina::Models::DescriptiveValue>] subjects

data/lib/cocina/models/related_resource.rb

@@ -19,7 +19,7 @@ module Cocina
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute? :standard, Standard.optional
       attribute :subject, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # Stanford persistent URL associated with the related resource. Note this is http, not https.
+      # Stanford persistent URL associated with the related resource.
       attribute? :purl, Types::Strict::String
       attribute? :access, DescriptiveAccessMetadata.optional
       attribute :relatedResource, Types::Strict::Array.of(RelatedResource).default([].freeze)

data/lib/cocina/models/validators/description_types_validator.rb

@@ -71,7 +71,7 @@ module Cocina
         # Some part of the path are ignored for the purpose of matching.
         def clean_path(path)
           new_path = path.reject do |part|
-            part.is_a?(Integer) || %i[parallelValue parallelContributor parallelEvent].include?(part)
+            part.is_a?(Integer) || %i[parallelValue parallelEvent].include?(part)
           end
           # This needs to happen after parallelValue is removed
           # to handle structuredValue > parallelValue > structuredValue

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.84.5'
+    VERSION = '0.85.0'
   end
 end

data/openapi.yml

@@ -549,11 +549,6 @@ components:
         valueAt:
           description: URL or other pointer to the location of the contributor information.
           type: string
-        parallelContributor:
-          description: For multiple representations of information about the same contributor (e.g. in different languages).
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveParallelContributor"
     ControlledDigitalLendingAccess:
       type: object
       properties:
@@ -777,44 +772,6 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
-    DescriptiveParallelContributor:
-      description: Value model for multiple representations of information about the same contributor (e.g. in different languages).
-      deprecated: true
-      type: object
-      additionalProperties: false
-      properties:
-        name:
-          description: Names associated with a contributor.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        type:
-          description: Entity type of the contributor (person, organization, etc.). See https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md for valid types.
-          type: string
-        status:
-          description: Status of the contributor relative to other parallel contributors (e.g. the primary author among a group of contributors).
-          type: string
-        role:
-          description: Relationships of the contributor to the resource or to an event in its history.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        identifier:
-          description: Identifiers and URIs associated with the contributor entity.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        note:
-          description: Other information associated with the contributor.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        valueAt:
-          description: URL or other pointer to the location of the contributor information.
-          type: string
-        valueLanguage:
-          # description: Language of the descriptive element value
-          $ref: "#/components/schemas/DescriptiveValueLanguage"
     DescriptiveParallelEvent:
       description: Value model for multiple representations of information about the same event (e.g. in different languages).
       type: object
@@ -1459,7 +1416,7 @@ components:
           description: Width in pixels
           type: integer
     Purl:
-      description: Stanford persistent URL associated with the related resource. Note this is http, not https.
+      description: Stanford persistent URL associated with the related resource.
       type: string
       format: uri
       # Canonical URI is https

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.84.5
+  version: 0.85.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-14 00:00:00.000000000 Z
+date: 2022-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -392,7 +392,6 @@ files:
 - lib/cocina/models/descriptive_basic_value.rb
 - lib/cocina/models/descriptive_geographic_metadata.rb
 - lib/cocina/models/descriptive_grouped_value.rb
-- lib/cocina/models/descriptive_parallel_contributor.rb
 - lib/cocina/models/descriptive_parallel_event.rb
 - lib/cocina/models/descriptive_parallel_value.rb
 - lib/cocina/models/descriptive_structured_value.rb
@@ -531,7 +530,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/cocina/models/descriptive_parallel_contributor.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Cocina
-  module Models
-    # DEPRECATED
-    # Value model for multiple representations of information about the same contributor (e.g. in different languages).
-    class DescriptiveParallelContributor < Struct
-      attribute :name, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # Entity type of the contributor (person, organization, etc.). See https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md for valid types.
-      attribute? :type, Types::Strict::String
-      # Status of the contributor relative to other parallel contributors (e.g. the primary author among a group of contributors).
-      attribute? :status, Types::Strict::String
-      attribute :role, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # URL or other pointer to the location of the contributor information.
-      attribute? :valueAt, Types::Strict::String
-      attribute? :valueLanguage, DescriptiveValueLanguage.optional
-    end
-  end
-end