cocina-models 0.93.0 → 0.93.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cf74f9126fce8106b3bfd5964c11731c460546a4f457da9ba7f35f895243c7a
-  data.tar.gz: 58467364ec8a96eac4f6d335dce400c0086833830f5704e263bae7365741d473
+  metadata.gz: 8cd049152e51891b2ab7fc1bd63fff3f95f8914f9939122ffb6990667f17ad98
+  data.tar.gz: 59645a00ccb0d8b21ae4830563f037dba0655a85d4f1b268ba21da66e6406d43
 SHA512:
-  metadata.gz: e2106344f663362d1609f5e40daf001c43f976abbbe7ae8a43c52295b2a2e280952c7d6d01b6f6b4cbdf124a07c26372bdfc17f9a903cce666edc39ba3b3db35
-  data.tar.gz: 5675d10901a099d8869baed51c4bdb82608305053d0e830130c28577644daddf73a650410cb20425e4e27ff4dfc60188f0e2cb0b77954c49bd3f00980ee56cf1
+  metadata.gz: df8635b1b7318cd957f2071aac2e46cce144119d5c497d166d2e0152db0269fdccd611ea72872e80217a9e1e07ed354393add1e440cc580f86e8493953684767
+  data.tar.gz: f12b79669c54e657aa0956412227a18f7445ba4940d4a6a5d27f9d6d9a79fe72aa408df096114e636ff8bd99d76bdfeb99f017efef989f12a27ef891bb4a9033

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocina-models (0.93.0)
+    cocina-models (0.93.1)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -21,7 +21,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.1)
+    activesupport (7.1.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -33,8 +33,8 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     attr_extras (7.1.0)
-    base64 (0.1.1)
-    bigdecimal (3.1.4)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
     byebug (11.1.3)
     committee (5.0.0)
       json_schema (~> 0.14, >= 0.14.3)
@@ -47,7 +47,7 @@ GEM
       activesupport
     diff-lcs (1.5.0)
     docile (1.4.0)
-    drb (2.1.1)
+    drb (2.2.0)
       ruby2_keywords
     dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
@@ -75,7 +75,7 @@ GEM
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.6.3)
+    json (2.7.1)
     json_schema (0.21.0)
     jsonpath (1.1.5)
       multi_json
@@ -83,15 +83,15 @@ GEM
     mini_portile2 (2.8.5)
     minitest (5.20.0)
     multi_json (1.15.0)
-    mutex_m (0.1.2)
-    nokogiri (1.15.4)
+    mutex_m (0.2.0)
+    nokogiri (1.16.0)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     openapi3_parser (0.9.2)
       commonmarker (~> 0.17)
     openapi_parser (1.0.0)
     optimist (3.1.0)
-    parallel (1.23.0)
+    parallel (1.24.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
@@ -101,7 +101,7 @@ GEM
     rack (3.0.8)
     rainbow (3.1.1)
     rake (13.1.0)
-    regexp_parser (2.8.2)
+    regexp_parser (2.8.3)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -120,7 +120,7 @@ GEM
       rspec-core (>= 2, < 4, != 2.12.0)
     rss (0.3.0)
       rexml
-    rubocop (1.57.2)
+    rubocop (1.59.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -128,7 +128,7 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)

data/README.md

@@ -12,6 +12,8 @@ The data model is expressed in an OpenAPI specification that lives in this codeb
 
 Note that the data model encodes properties as camelCase, which the team believes to be consistent with other HTTP APIs and the original design of the Cocina data model. While using camelCase in Ruby code may look and feel wrong, we did explore automagic conversion between camelCase in the model and snake_case in the Ruby context. We ultimately concluded that we have enough representations of the data model in enough codebases to reasonably worry about data inconsistency problems, none of which we need in our work on SDR.
 
+For more about the model for description see https://consul.stanford.edu/display/DIGMETADATA/Digital+Object+Metadata+Documentation#DigitalObjectMetadataDocumentation-Cocinamodel
+
 ## Configuration
 
 Set the PURL url base:

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

@@ -6,8 +6,7 @@ module Cocina
   module Models
     module Builders
       # TitleBuilder selects the prefered title from the cocina object for solr indexing
-      # rubocop:disable Metrics/ClassLength
-      class TitleBuilder
+      class TitleBuilder # rubocop:disable Metrics/ClassLength
         extend Deprecation
         # @param [[Array<Cocina::Models::Title,Cocina::Models::DescriptiveValue>] titles the titles to consider
         # @param [Symbol] strategy ":first" is the strategy for selection when primary or display
@@ -24,24 +23,57 @@ module Cocina
           new(strategy: strategy, add_punctuation: add_punctuation).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
+        # @return [String] the main title value for Solr
+        def self.main_title(titles)
+          new(strategy: :first, add_punctuation: false).main_title(titles)
+        end
+
+        # 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
+        # @return [String] the title value for Solr
+        def self.full_title(titles)
+          new(strategy: :first, add_punctuation: false).build(titles)
+        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
+        # @return [Array<String>] the values for Solr
+        def self.additional_titles(titles)
+          new(strategy: :all, add_punctuation: false).build(titles) - [full_title(titles)]
+        end
+
         def initialize(strategy:, add_punctuation:)
           @strategy = strategy
           @add_punctuation = add_punctuation
         end
 
-        # @param [[Array<Cocina::Models::Title>] titles the titles to consider
+        # @param [[Array<Cocina::Models::Title>] cocina_titles the titles to consider
         # @return [String] the title value for Solr
-        def build(titles)
-          cocina_title = primary_title(titles) || untyped_title(titles)
-          cocina_title = other_title(titles) if cocina_title.blank?
+        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)
           else
-            cocina_title.map { |one| extract_title(one) }
+            cocina_titles.map { |ctitle| extract_title(ctitle) }.flatten
           end
         end
 
+        def main_title(titles)
+          cocina_title = primary_title(titles) || untyped_title(titles)
+          cocina_title = other_title(titles) if cocina_title.blank?
+
+          cocina_title = cocina_title.first if cocina_title.is_a?(Array)
+          extract_main_title(cocina_title)
+        end
+
         private
 
         attr_reader :strategy
@@ -57,6 +89,16 @@ module Cocina
           remove_trailing_punctuation(result.strip) if result.present?
         end
 
+        def extract_main_title(cocina_title)
+          if cocina_title.value
+            cocina_title.value # covers both title and main title types
+          elsif cocina_title.structuredValue.present?
+            main_title_from_structured_values(cocina_title)
+          elsif cocina_title.parallelValue.present?
+            main_title(cocina_title.parallelValue)
+          end
+        end
+
         def add_punctuation?
           @add_punctuation
         end
@@ -93,7 +135,8 @@ module Cocina
           end
         end
 
-        # This handles 'main title', 'uniform' or 'translated'
+        # This is called when there is no primary title and no untyped title
+        # @return [Cocina::Models::Title, Array<Cocina::Models::Title>] first title or all titles
         def other_title(titles)
           if strategy == :first
             titles.first
@@ -102,17 +145,19 @@ module Cocina
           end
         end
 
-        # rubocop:disable Metrics/BlockLength
-        # rubocop:disable Metrics/CyclomaticComplexity
-        # rubocop:disable Metrics/PerceivedComplexity
-        # rubocop:disable Metrics/MethodLength
         # @param [Cocina::Models::Title] title with structured values
         # @return [String] the title value from combining the pieces of the structured_values by type and order
         #   with desired punctuation per specs
+        #
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/PerceivedComplexity
         def title_from_structured_values(title)
-          structured_title = ''
+          # parse out the parts
+          main_title = ''
+          subtitle = ''
+          non_sort_value = ''
           part_name_number = ''
-          # combine pieces of the cocina structuredValue into a single title
           title.structuredValue.each do |structured_value|
             # There can be a structuredValue inside a structuredValue.  For example,
             #   a uniform title where both the name and the title have internal StructuredValue
@@ -125,42 +170,88 @@ module Cocina
             case structured_value.type&.downcase
             when 'nonsorting characters'
               non_sort_value = "#{value}#{non_sorting_padding(title, value)}"
-              structured_title = if structured_title.present?
-                                   "#{structured_title}#{non_sort_value}"
-                                 else
-                                   non_sort_value
-                                 end
             when 'part name', 'part number'
-              if part_name_number.blank?
-                part_name_number = part_name_number(title.structuredValue)
-                structured_title = if !add_punctuation?
-                                     [structured_title, part_name_number].join(' ')
-                                   elsif structured_title.present?
-                                     "#{structured_title.sub(/[ .,]*$/, '')}. #{part_name_number}. "
-                                   else
-                                     "#{part_name_number}. "
-                                   end
-              end
+              part_name_number = part_name_number(title.structuredValue) if part_name_number.blank?
             when 'main title', 'title'
-              structured_title = "#{structured_title}#{value}"
+              main_title = value
             when 'subtitle'
-              # subtitle is preceded by space colon space, unless it is at the beginning of the title string
-              structured_title = if !add_punctuation?
-                                   [structured_title, value].join(' ')
-                                 elsif structured_title.present?
-                                   "#{structured_title.sub(/[. :]+$/, '')} : #{value.sub(/^:/, '').strip}"
-                                 else
-                                   structured_title = value.sub(/^:/, '').strip
-                                 end
+              # combine multiple subtitles into a single string
+              subtitle = if !add_punctuation?
+                           if subtitle.present?
+                             [subtitle, value].join(' ')
+                           else
+                             value
+                           end
+                         elsif subtitle.present?
+                           # subtitle is preceded by space colon space, unless it is at the beginning of the title string
+                           "#{subtitle.sub(/[. :]+$/, '')} : #{value.sub(/^:/, '').strip}"
+                         else
+                           value.sub(/^:/, '').strip
+                         end
             end
           end
-          structured_title
+
+          # combine the parts into a single title string
+          if add_punctuation?
+            combine_with_punctuation(non_sort_value: non_sort_value, main_title: main_title, subtitle: subtitle,
+                                     part_name_number: part_name_number)
+          else
+            ["#{non_sort_value}#{main_title}", subtitle, part_name_number].select(&:presence).join(' ')
+          end
         end
-        # rubocop:enable Metrics/MethodLength
-        # rubocop:enable Metrics/BlockLength
         # rubocop:enable Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/MethodLength
         # rubocop:enable Metrics/PerceivedComplexity
 
+        # main_title is title.structuredValue.value with type 'main title' (or just title.value)
+        # @param [Cocina::Models::Title] title with structured values
+        # @return [String] the main title value
+        def main_title_from_structured_values(cocina_title) # rubocop:disable Metrics/MethodLength
+          result = ''
+          # combine pieces of the cocina structuredValue into a single title
+          cocina_title.structuredValue.each do |structured_value|
+            # There can be a structuredValue inside a structuredValue.  For example,
+            #   a uniform title where both the name and the title have internal StructuredValue
+            return main_title_from_structured_values(structured_value) if structured_value.structuredValue.present?
+
+            value = structured_value.value&.strip
+            next unless value
+
+            case structured_value.type&.downcase
+            when 'nonsorting characters'
+              non_sort_value = "#{value}#{non_sorting_padding(cocina_title, value)}"
+              result = "#{non_sort_value}#{result}" # non-sorting characters are at the beginning of the title
+            when 'main title'
+              result = "#{result}#{value}"
+            when 'title'
+              result = value
+            end
+          end
+          result
+        end
+
+        # Thank MARC and catalog cards for this mess. We need to add punctuation.
+        # rubocop:disable Metrics/MethodLength
+        def combine_with_punctuation(non_sort_value:, main_title:, subtitle:, part_name_number:)
+          result = "#{non_sort_value}#{main_title}"
+          if subtitle.present?
+            result = if result.present?
+                       "#{result.sub(/[. :]+$/, '')} : #{subtitle.sub(/^:/, '').strip}"
+                     else
+                       result = subtitle
+                     end
+          end
+          if part_name_number.present?
+            result = if result.present?
+                       "#{result.sub(/[ .,]*$/, '')}. #{part_name_number}."
+                     else
+                       "#{part_name_number}."
+                     end
+          end
+          result
+        end
+        # rubocop:enable Metrics/MethodLength
+
         def remove_trailing_punctuation(title)
           title.sub(%r{[ .,;:/\\]+$}, '')
         end
@@ -205,7 +296,6 @@ module Cocina
           end
         end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/cocina/models/mapping/from_mods/contributor.rb

@@ -37,7 +37,7 @@ module Cocina
           def build
             grouped_altrepgroup_name_nodes, other_name_nodes = AltRepGroup.split(nodes: deduped_name_nodes)
             check_altrepgroup_type_inconsistency(grouped_altrepgroup_name_nodes)
-            contributors = grouped_altrepgroup_name_nodes.map { |name_nodes| build_name_nodes(name_nodes) } + \
+            contributors = grouped_altrepgroup_name_nodes.map { |name_nodes| build_name_nodes(name_nodes) } +
                            other_name_nodes.map { |name_node| build_name_nodes([name_node]) }
             contrib_level_type_and_status(contributors)
             adjust_primary(contributors.compact).presence
@@ -110,7 +110,7 @@ module Cocina
                                         end
             end
 
-            result.each { |_k, role_nodes| role_nodes.uniq! { |role_node| name_node_comparitor(role_node) } }
+            result.each_value { |role_nodes| role_nodes.uniq! { |role_node| name_node_comparitor(role_node) } }
           end
 
           def check_altrepgroup_type_inconsistency(grouped_altrepgroup_name_nodes)

data/lib/cocina/models/mapping/from_mods/title_builder.rb

@@ -95,7 +95,7 @@ module Cocina
               node.text.size + add
             end
             [{
-              value: count.to_s,  # cast to String until cocina-models 0.40.0 is used. See https://github.com/sul-dlss/cocina-models/pull/146
+              value: count.to_s, # cast to String until cocina-models 0.40.0 is used. See https://github.com/sul-dlss/cocina-models/pull/146
               type: 'nonsorting character count'
             }]
           end

data/lib/cocina/models/mapping/normalizers/mods/name_normalizer.rb

@@ -174,7 +174,7 @@ module Cocina
                                             [role_node]
                                           end
               end
-              result.each { |_k, role_nodes| role_nodes.uniq! { |role_node| name_node_comparitor(role_node) } }
+              result.each_value { |role_nodes| role_nodes.uniq! { |role_node| name_node_comparitor(role_node) } }
             end
 
             def normalize_type

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.93.0'
+    VERSION = '0.93.1'
   end
 end

data/lib/cocina/rspec/factories.rb

@@ -38,7 +38,7 @@ module Cocina
 
         build_type = type.to_s.delete_suffix(WITH_METADATA_SUFFIX)
 
-        fixture = public_send("build_#{build_type}".to_sym, attributes)
+        fixture = public_send("build_#{build_type}".to_sym, attributes) # rubocop:disable Lint/SymbolConversion
         return fixture unless type.end_with?(WITH_METADATA_SUFFIX)
 
         Cocina::Models.with_metadata(fixture, 'abc123')

data/openapi.yml

@@ -330,6 +330,7 @@ components:
       pattern: '^[0-9]+-[0-9]+$'
       example: '6772719-1001'
     CitationOnlyAccess:
+      description: A type of access for an object wherein users can see the metadata and a list of files, but the files will not have view or download access
       type: object
       properties:
         view:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.93.0
+  version: 0.93.1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -562,7 +562,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Data models for the SDR