cocina-models 0.101.0 → 0.103.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2198f8b258a6cae8fe0a3569eb5e36a400964d9ea0d05c6ec7bb19a761071e42
-  data.tar.gz: 31b0657ba52c6f143b7cbceadb585f8710ff8f8d24410101a2daa22a7ad5ce56
+  metadata.gz: 25d2a47837021c38ac5a6f722e53e17fc78c9f07b09efa10d5d2df18a6aa714f
+  data.tar.gz: f52008be424354db1c55160c79ae4511c368b3bcd501a61d86d3ff23f572e57a
 SHA512:
-  metadata.gz: 532777c074a4edcd3116bc6df43bf189b554e8b10bd63531940e9bf2019262989ae925a02582b2a51dac96dcb5f275edd686728d11f28ec33a2e8d95350d095c
-  data.tar.gz: aa06744ae066e38d1f4c1cc8094c0bd39ef789008971ff51c0d0eb0315333cf65117a1f539b241fd91c82313d3299b4a73bd286f1d89f9f0b388b98f31aaa829
+  metadata.gz: bc39f2cd59a93a142503c575469ca20362a17c8a308169140f7f851dcc1099e2b758a8cef019ab52338d8f9ad25a2408c5a5a42d1c024655abc240e15a85f32b
+  data.tar.gz: fc2eb7c64bc4055a957c4ffc6de5a9d3106154eb12171fd214127bf6c8047cbc1e02e3a1ed3b7d33580052b148389174a96e5d7400b60c285dd8c1964c08e909

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocina-models (0.101.0)
+    cocina-models (0.103.0)
       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/lib/cocina/models/builders/title_builder.rb

@@ -8,26 +8,28 @@ module Cocina
       # TitleBuilder selects the prefered title from the cocina object for solr indexing
       class TitleBuilder # rubocop:disable Metrics/ClassLength
         extend Deprecation
-        # @param [[Array<Cocina::Models::Title,Cocina::Models::DescriptiveValue>] titles the titles to consider
+        # @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
         # @param [Symbol] strategy ":first" is the strategy for selection when primary or display
         #   title are missing
         # @param [Boolean] add_punctuation determines if the title should be formmated with punctuation
         # @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)
-        def self.build(titles, strategy: :first, add_punctuation: true)
+        def self.build(titles, catalog_links: [], strategy: :first, add_punctuation: true)
+          part_label = catalog_links.find { |link| link.catalog == 'folio' }&.partLabel
           if titles.respond_to?(:description)
             Deprecation.warn(self,
                              "Calling TitleBuilder.build with a #{titles.class} is deprecated. " \
                              'It must be called with an array of titles')
             titles = titles.description.title
           end
-          new(strategy: strategy, add_punctuation: add_punctuation).build(titles)
+          new(strategy: strategy, add_punctuation: add_punctuation, part_label: part_label).build(titles)
         end
 
         # the "main title" is the title withOUT subtitle, part name, etc.  We want to index it separately so
         #   we can boost matches on it in search results (boost matching this string higher than matching full title string)
         #   e.g. "The Hobbit" (main_title) vs "The Hobbit, or, There and Back Again (full_title)
-        # @param [[Array<Cocina::Models::Title,Cocina::Models::DescriptiveValue>] titles the titles to consider
+        # @param [Array<Cocina::Models::Title,Cocina::Models::DescriptiveValue>] titles the titles to consider
         # @return [Array<String>] the main title value(s) for Solr - array due to possible parallelValue
         def self.main_title(titles)
           new(strategy: :first, add_punctuation: false).main_title(titles)
@@ -35,15 +37,17 @@ 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::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
         #   we can boost matches on it in search results (boost matching these strings lower than other titles present)
-        # @param [[Array<Cocina::Models::Title,Cocina::Models::DescriptiveValue>] titles the titles to consider
+        # @param [Array<Cocina::Models::Title,Cocina::Models::DescriptiveValue>] titles the titles to consider
         # @return [Array<String>] the values for Solr
         def self.additional_titles(titles)
           [new(strategy: :all, add_punctuation: false).build(titles)].flatten - full_title(titles)
@@ -57,13 +61,15 @@ module Cocina
         #   of primary, untyped, first occurrence.  When false, return an array containing all the parallel values.
         #   Why? Think of e.g. title displayed in blacklight search results vs boosting values for ranking of search
         #   results
-        def initialize(strategy:, add_punctuation:, only_one_parallel_value: true)
+        # @param part_label [String] the partLabel to add for digital serials display
+        def initialize(strategy:, add_punctuation:, only_one_parallel_value: true, part_label: nil)
           @strategy = strategy
           @add_punctuation = add_punctuation
           @only_one_parallel_value = only_one_parallel_value
+          @part_label = part_label
         end
 
-        # @param [[Array<Cocina::Models::Title>] cocina_titles the titles to consider
+        # @param [Array<Cocina::Models::Title>] cocina_titles the titles to consider
         # @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)
         #
@@ -71,9 +77,10 @@ module Cocina
         def build(cocina_titles)
           cocina_title = primary_title(cocina_titles) || untyped_title(cocina_titles)
           cocina_title = other_title(cocina_titles) if cocina_title.blank?
-
           if strategy == :first
-            extract_title(cocina_title)
+            result = extract_title(cocina_title)
+            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
@@ -97,7 +104,13 @@ module Cocina
 
         private
 
-        attr_reader :strategy
+        attr_reader :strategy, :part_label
+
+        def add_part_label(title)
+          # when a digital serial
+          title = title.sub(/[ .,]*$/, '').to_s
+          add_punctuation? ? "#{title}, #{part_label}" : "#{title} #{part_label}"
+        end
 
         def extract_title(cocina_title)
           title_values = if cocina_title.value
@@ -234,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,9 +169,21 @@ 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)
                 title_value = title_value_for(title_part, title_type, title)
                 xml.public_send(title_type, title_value) if title_part.note.blank?

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.101.0'
+    VERSION = '0.103.0'
   end
 end

metadata

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