cocina-models 0.101.1 → 0.103.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 020bb1af47ff01f6e95a8d126cabaae16a19a1cd92ae8bdade1e18f97f519af6
-  data.tar.gz: e05e3b0a0a6122a1297fe3d12e3b9737b618ed03ae246d8b4b24e0740254ad9a
+  metadata.gz: 439375f55b48b22cc891dde1fb31519f9b08a42b9128894cf04f643a5644a027
+  data.tar.gz: 7f7a68b92f272e867d6243485d4ed68c1741128c6e93785a1879b811ca0ece63
 SHA512:
-  metadata.gz: fd8a640dfe907eaebfc3f0b6b72f044b8b149718601d8845b315d529f861634fc0ce194f684236802e2799378a5a01920d8facf7f3669a95ac9e6d1ede066ce5
-  data.tar.gz: eb7d1fc6c14ebadb308e7c7b53f00640d20de07ca337523e33cc77e7b039b00d737fa94079282e29254c8f46b6dffb654ae5c3c5dbfb7fe5cc7cabc592e1fa93
+  metadata.gz: e23f7d1949ee04c1dba3bea6b64620f0ad816bde8ee02666e8af6b3c3057c86d326f586f696572e8cf0f3ba01c191444cd7501f81a8eede6fcaa45682b69fdfb
+  data.tar.gz: 1b215531fa86e0f049f7c38bd8819c3ae47f849d66b7217da376761e09131f1c23e60b448ae404c66ee6024f6b4f570966a07398719360739182c99e5a2649d1

data/.rubocop.yml

@@ -512,3 +512,12 @@ Style/ItAssignment: # new in 1.70
   Enabled: true
 Style/RedundantFormat: # new in 1.72
   Enabled: true
+
+Style/ComparableBetween: # new in 1.74
+  Enabled: true
+Style/HashFetchChain: # new in 1.75
+  Enabled: true
+Style/ItBlockParameter: # new in 1.75
+  Enabled: true
+RSpec/IncludeExamples: # new in 3.6
+  Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocina-models (0.101.1)
+    cocina-models (0.103.1)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -43,7 +43,7 @@ GEM
       openapi_parser (~> 1.0)
       rack (>= 1.5)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.0)
+    connection_pool (2.5.2)
     deprecation (1.1.0)
       activesupport
     diff-lcs (1.6.1)
@@ -78,7 +78,7 @@ GEM
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.10.2)
+    json (2.11.3)
     json_schema (0.21.0)
     jsonpath (1.1.5)
       multi_json
@@ -88,12 +88,12 @@ GEM
     mini_portile2 (2.8.8)
     minitest (5.25.5)
     multi_json (1.15.0)
-    nokogiri (1.18.7)
+    nokogiri (1.18.8)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     openapi_parser (1.0.0)
     optimist (3.2.1)
-    parallel (1.26.3)
+    parallel (1.27.0)
     parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
@@ -120,7 +120,7 @@ GEM
     rspec-support (3.13.2)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.75.2)
+    rubocop (1.75.3)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -137,7 +137,7 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.5.0)
+    rubocop-rspec (3.6.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)

data/README.md

@@ -123,23 +123,28 @@ A patch change is a change that (1) does not affect the data model; (2) does not
 
 A patch change can be released as part of regular dependency updates or selectively released for individual applications.
 
-## Releasing major or minor change
-
-NOTE: If dependency updates are about to be released, you have the option of shortening the process and stopping after Step 3. This is because Steps 4 onwards will be taken care of by the regular dependency updates process (basically the updating of cocina-models, dor-services-client and sdr-client as needed in the rest of the associated apps).  You still do need to manually bump some gems and the pinned version of cocina-models in a couple apps and get those PRs approved and merged, as described in Steps 1-3 below.
-
-IMPORTANT: If you do opt to skip steps 4 onward, you should NOT merge the cocina-models bump dor-services-app and sdr-api PRs you created in step 3 until you are ready to finish the dependency updates process.  You can have them reviewed and approved, but if you merge, you will greatly increase the risk of issues if the main branch of DSA or sdr-api are deployed after steps 1-3 are complete but before the rest of the apps are updated to use the new cocina-models via regular dependency updates. The fix for this is to either roll-back DSA and sdr-api to the previous release tag, or proceed forwards with step 4-5.
+## Releasing a major or minor change
 
 Before you release a major or minor change, think about if this release will include new validations.  Even if your change didn't make any changes that would affect validation, there may be other unreleased changes since the previous version of the gem was cut and released.  Best practice is to scan back through the commit history until you get to the last version bump and see if there any significant changes that may affect validation.
 
 If unsure, ask the team or ask for help to just run the validation report anyway (as described above).
 
+### Partial release process
+NOTE: If dependency updates are about to be released, you have the option of shortening the process and stopping after Step 3. This is because Steps 4 onwards will be taken care of by the regular dependency updates process (basically the updating of cocina-models, dor-services-client and sdr-client as needed in the rest of the associated apps).  You still do need to manually bump some gems and the pinned version of cocina-models in the directly coupled apps and get those PRs approved and merged, as described in Steps 1-3 below.
+
+IMPORTANT: If you do opt to skip steps 4 onward, you should NOT merge the dor-services-app and sdr-api PRs you created in step 3 until you are ready to finish the dependency updates process.  You can have them reviewed and approved, but if you merge, you will greatly increase the risk of issues if the main branch of DSA or sdr-api are deployed after steps 1-3 are complete but before the rest of the apps are updated to use the new cocina-models via regular dependency updates. The fix for this is to either roll back DSA and sdr-api to the previous release tag, or proceed forwards with step 4-5.
+
 ### 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`, then `bundle install` so that `Gemfile.lock` is updated, then commit and push those changes. Then run:
+The release process is much like any other gem. While on main:
+1. Bump the version in `lib/cocina/models/version.rb`
+2. `bundle install` so that `Gemfile.lock` is updated.
+3. Commit those changes. 
+4. Run:
 ```
 bundle exec rake release
 ```
@@ -147,7 +152,11 @@ which pushes the gem to rubygems.org.
 
 ### Step 2: Update client gems coupled to the models
 
-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) and [Dor-Services-App](https://github.com/sul-dlss/dor-services-app) depend on these gems using the same models.
+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/):
+1. Pin the new cocina-models version in the clients' `gemspec` files.
+2. Bump the version as described in each client's README release instructions.
+
+Applications such as [Argo](https://github.com/sul-dlss/argo) and [Dor-Services-App](https://github.com/sul-dlss/dor-services-app) depend on these gems using the same models.
 
 ### Step 3: Update services directly coupled to the models
 
@@ -156,27 +165,31 @@ 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/)
 
-**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.
+**NOTE**: You can skip step 3A 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. Make sure that the `openapi.yml` for these two applications includes 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.
+Copy and paste the cocina-models schemas to each project's `openapi.yml`. By convention, these schemas are listed first, 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.
+If you updated the `openapi.yml` in step 3A, use the same PR for step 3B. 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. You may first need to update how these gems are pinned in the `Gemfile` in order to bump them.  Note that dor-services-app only needs a bump to cocina-models gem and sdr-api only needs a bump to cocina-models and dor-services-client gems.
+1. Perform `bundle update --conservative cocina-models dor-services-client` in the  services above and make PRs for those repos if they don't already exist. You may first need to update how these gems are pinned in the `Gemfile` in order to bump them.
+2. Note that sdr-client is not currently used in these applications, but if it were, would also need to be bumped to the latest release. 
 
 #### Step 3C: Merge 'em
 
-Get the directly coupled services PRs merged before the deploy in step 5.
+Get the directly coupled services PRs merged before the deploy in step 5. 
+
+See the IMPORTANT note above about the timing of merging these PRs if you are waiting for dependency updates to make the updates to other dependent applications.
 
 ### Step 4: Update other dependent applications
 
-Once the above listed steps have been completed, all applications that use cocina-models should be updated and released at the same time.  "Cocina Level 2" describes this set of updates. The applications that use cocina-models are those in [this list](https://github.com/sul-dlss/access-update-scripts/blob/master/infrastructure/projects.yml) that are NOT marked with `cocina_level2: false`.
+All applications that use cocina-models should be updated and released at the same time.  "Cocina Level 2" describes this set of updates. The applications that use cocina-models are those in [this list](https://github.com/sul-dlss/access-update-scripts/blob/master/infrastructure/projects.yml) that are NOT marked with `cocina_level2: false`.
 
 There are scripts to help with updating other dependent applications:
 
@@ -192,14 +205,13 @@ If for some reason the above method does not work, the sul-dlss/access-update-sc
 ```
 REPOS_PATH=infrastructure GH_ACCESS_TOKEN=abc123 COCINA_LEVEL2= ./merge-all.rb
 ```
-### Step 5: Deploy all affected applications together
+### Step 5: Deploy and test
 
+#### Step 5A: Deploy to Stage or QA
 [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.
 
-#### Step 5A: Deploy to QA and/or Stage
-
 #### Step 5B: Run infrastructure_integration_tests
 
 It is safest to ensure _all_ the integration tests run cleanly.  However, patch releases of cocina-models may only warrant running individual tests that exercise the changes.

data/lib/cocina/models/builders/title_builder.rb

@@ -38,9 +38,11 @@ module Cocina
         # the "full title" is the title WITH subtitle, part name, etc.  We want to able able to index it separately so
         #   we can boost matches on it in search results (boost matching this string higher than other titles present)
         # @param [Array<Cocina::Models::Title,Cocina::Models::DescriptiveValue>] titles the titles to consider
+        # @param [Array<Cocina::Models::FolioCatalogLink>] catalog_links the folio catalog links to check for digital serials part labels
         # @return [Array<String>] the full title value(s) for Solr - array due to possible parallelValue
-        def self.full_title(titles)
-          [new(strategy: :first, add_punctuation: false, only_one_parallel_value: false).build(titles)].flatten.compact
+        def self.full_title(titles, catalog_links: [])
+          part_label = catalog_links.find { |link| link.catalog == 'folio' }&.partLabel
+          [new(strategy: :first, add_punctuation: false, only_one_parallel_value: false, part_label: part_label).build(titles)].flatten.compact
         end
 
         # "additional titles" are all title data except for full_title.  We want to able able to index it separately so
@@ -68,7 +70,6 @@ module Cocina
         end
 
         # @param [Array<Cocina::Models::Title>] cocina_titles the titles to consider
-        # @param [String, nil] part_label the partLabel to add to the title for digital serials
         # @return [String, Array] the title value for Solr - for :first strategy, a string; for :all strategy, an array
         #   (e.g. title displayed in blacklight search results vs boosting values for search result rankings)
         #
@@ -78,7 +79,8 @@ module Cocina
           cocina_title = other_title(cocina_titles) if cocina_title.blank?
           if strategy == :first
             result = extract_title(cocina_title)
-            add_part_label(result)
+            result = add_part_label(result) if part_label.present?
+            result
           else
             result = cocina_titles.map { |ctitle| extract_title(ctitle) }.flatten
             if only_one_parallel_value? && result.length == 1
@@ -106,8 +108,8 @@ module Cocina
 
         def add_part_label(title)
           # when a digital serial
-          title = "#{title.sub(/[ .,]*$/, '')}, #{part_label}" if part_label.present?
-          title
+          title = title.sub(/[ .,]*$/, '').to_s
+          add_punctuation? ? "#{title}, #{part_label}" : "#{title} #{part_label}"
         end
 
         def extract_title(cocina_title)
@@ -245,6 +247,8 @@ module Cocina
               padding = non_sorting_padding(cocina_title, value)
               result = add_non_sorting_value(result, value, padding)
             when 'part name', 'part number'
+              # even if there is a partLabel, use any existing structuredValue
+              # part name/number that remains for non-digital serials purposes
               if part_name_number.blank?
                 part_name_number = part_name_number(cocina_title.structuredValue)
                 result = if !add_punctuation?

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

@@ -11,30 +11,29 @@ module Cocina
           TAG_NAME = Cocina::Models::Mapping::FromMods::Title::TYPES.invert.merge('activity dates' => 'date').freeze
           NAME_TYPES = ['name', 'forename', 'surname', 'life dates', 'term of address'].freeze
 
+          def self.write(...)
+            new(...).write
+          end
+
           # @params [Nokogiri::XML::Builder] xml
           # @params [Array<Cocina::Models::Title>] titles
+          # @params [IdGenerator] id_generator
           # @params [Array<Cocina::Models::Contributor>] contributors
           # @params [Hash] additional_attrs for title
-          # @params [IdGenerator] id_generator
-          def self.write(xml:, titles:, id_generator:, contributors: [], additional_attrs: {})
-            new(xml: xml, titles: titles, contributors: contributors, additional_attrs: additional_attrs,
-                id_generator: id_generator).write
-          end
-
-          def initialize(xml:, titles:, additional_attrs:, contributors: [], id_generator: {})
+          # @params [Array<Cocina::Models::CatalogLink>] catalog_links a list of catalog
+          #   links which may contain part label and sort key information
+          def initialize(xml:, titles:, id_generator:, contributors: [], additional_attrs: {}, catalog_links: []) # rubocop:disable Metrics/ParameterLists
             @xml = xml
             @titles = titles
+            @id_generator = id_generator
             @contributors = contributors
-            @name_title_vals_index = {}
             @additional_attrs = additional_attrs
-            @id_generator = id_generator
+            @catalog_links = catalog_links
+            @name_title_vals_index = {}
           end
 
-          # rubocop:disable Metrics/AbcSize
-          # rubocop:disable Metrics/BlockLength
-          # rubocop:disable Metrics/CyclomaticComplexity
-          def write
-            titles.each do |title|
+          def write # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+            titles.each do |title| # rubocop:disable Metrics/BlockLength
               name_title_vals_index = name_title_vals_index_for(title)
 
               if title.valueAt
@@ -78,13 +77,10 @@ module Cocina
               end
             end
           end
-          # rubocop:enable Metrics/AbcSize
-          # rubocop:enable Metrics/BlockLength
-          # rubocop:enable Metrics/CyclomaticComplexity
 
           private
 
-          attr_reader :xml, :titles, :contributors, :name_title_vals_index, :id_generator, :additional_attrs
+          attr_reader :xml, :titles, :contributors, :name_title_vals_index, :id_generator, :additional_attrs, :catalog_links
 
           def write_xlink(title:)
             attrs = { 'xlink:href' => title.valueAt }
@@ -173,10 +169,24 @@ module Cocina
             title_info_attrs = title_info_attrs_for(title).merge(title_info_attrs)
             xml.titleInfo(with_uri_info(title, title_info_attrs)) do
               title_parts = flatten_structured_value(title)
-              title_parts_without_names = title_parts_without_names(title_parts)
+              write_title_parts!(title_parts: title_parts_without_names(title_parts), title: title)
+            end
+          end
 
-              title_parts_without_names.each do |title_part|
+          def write_title_parts!(title_parts:, title:)
+            # If title parts contain the main title and a part label has been
+            # recorded in a catalog link, short-circuit the usual title part
+            # parsing and pull the part label from the catalog link instead of
+            # from descriptive metadata
+            if (main_title = title_parts.find { |part| part.type == 'main title' }&.value) &&
+               (part_label = catalog_links.find { |link| link.catalog == 'folio' && link.partLabel.present? }&.partLabel)
+              xml.title(main_title)
+              xml.partNumber(part_label)
+            else
+              title_parts.each do |title_part|
                 title_type = tag_name_for(title_part)
+                raise "Unknown title type for: #{title_part.to_h}" unless title_type
+
                 title_value = title_value_for(title_part, title_type, title)
                 xml.public_send(title_type, title_value) if title_part.note.blank?
               end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.101.1'
+    VERSION = '0.103.1'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.101.1
+  version: 0.103.1
 platform: ruby
 authors:
 - Justin Coyne
 bindir: exe
 cert_chain: []
-date: 2025-04-18 00:00:00.000000000 Z
+date: 2025-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport