cocina_display 2.1.0 → 2.2.0

data/lib/cocina_display/subjects/subject_value.rb

@@ -1,177 +1,46 @@
 module CocinaDisplay
   module Subjects
-    # A descriptive value that can be part of a Subject.
-    class SubjectValue
-      attr_reader :cocina
-
-      # The type of the subject value, like "person", "title", or "time".
-      # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#subject-part-types-for-structured-value
-      attr_accessor :type
-
-      # Create SubjectValues from Cocina structured data.
-      # Pre-coordinated string values will be split into multiple SubjectValues.
-      # @param cocina [Hash] The Cocina structured data for the subject.
-      # @param type [String, nil] The type, coming from the parent Subject.
-      # @return [Array<SubjectValue>]
-      def self.from_cocina(cocina, type:)
-        split_pre_coordinated_values(cocina, type: type).map do |value|
-          SUBJECT_VALUE_TYPES.fetch(type, SubjectValue).new(value).tap do |obj|
-            obj.type ||= type
-          end
-        end
-      end
-
-      # Split a pre-coordinated subject value joined with "--" into multiple values.
-      # Ignores the "--" string for coordinate subject types, which use it differently.
-      # @param cocina [Hash] The Cocina structured data for the subject.
-      # @return [Array<Hash>] An array of Cocina hashes, one for each split value
-      def self.split_pre_coordinated_values(cocina, type:)
-        if cocina["value"].is_a?(String) && cocina["value"].include?("--") && !type&.include?("coordinates")
-          cocina["value"].split("--").map { |v| cocina.merge("value" => v.strip) }
-        else
-          [cocina]
-        end
-      end
-
-      # All subject value types that should not be further destructured.
+    # A subject in Cocina structured data in a single language/script.
+    class SubjectValue < Parallel::ParallelValue
+      # Array of display strings for each part of the subject.
+      # Used for search, where each value should be indexed separately.
       # @return [Array<String>]
-      def self.atomic_types
-        SUBJECT_VALUE_TYPES.keys - ["place"]
-      end
-
-      # Initialize a SubjectValue object with Cocina structured data.
-      # @param cocina [Hash] The Cocina structured data for the subject value.
-      def initialize(cocina)
-        @cocina = cocina
-        @type = cocina["type"]
+      def values
+        subject_parts.map(&:to_s).compact_blank
       end
 
-      # The display string for the subject value.
-      # Subclasses should override this method to provide specific formatting.
+      # The value to use for display.
+      # Genre values are capitalized; other subject values are not.
       # @return [String]
       def to_s
-        cocina["value"]
+        (type == "genre") ? flat_value&.upcase_first : flat_value
       end
-    end
-
-    # A subject value representing a named entity.
-    class NameSubjectValue < SubjectValue
-      attr_reader :name
-
-      # Initialize a NameSubjectValue object with Cocina structured data.
-      # @param cocina [Hash] The Cocina structured data for the subject.
-      def initialize(cocina)
-        super
-        @name = Contributors::Name.new(cocina)
-      end
-
-      # Use the contributor name formatting rules for display.
-      # @return [String] The formatted name string, including life dates
-      # @see CocinaDisplay::Contributor::Name#to_s
-      def to_s
-        name.to_s(with_date: true)
-      end
-    end
-
-    # A subject value representing an entity with a title.
-    class TitleSubjectValue < SubjectValue
-      attr_reader :title
 
-      # Initialize a TitleSubjectValue object with Cocina structured data.
-      # @param cocina [Hash] The Cocina structured data for the subject.
-      def initialize(cocina)
-        super
-        @title = Title.new(cocina)
-      end
-
-      # Construct a title string to use for display.
-      # @see CocinaDisplay::Title#to_s
-      # @return [String, nil]
-      def to_s
-        title.to_s
-      end
-    end
-
-    # A subject value representing a date and/or time.
-    class TemporalSubjectValue < SubjectValue
-      attr_reader :date
-
-      def initialize(cocina)
-        super
-        @date = Dates::Date.from_cocina(cocina)
-      end
-
-      # @return [String] The formatted date/time string for display
-      def to_s
-        date.to_s
-      end
-    end
-
-    # A subject value representing a named place.
-    class PlaceSubjectValue < SubjectValue
-      # A URI identifying the place, if available.
-      # @return [String, nil]
-      def uri
-        cocina["uri"]
-      end
-
-      # True if the place has a geonames.org URI.
-      # @return [Boolean]
-      def geonames?
-        uri&.include?("sws.geonames.org")
-      end
-
-      # Unique identifier for the place in geonames.org.
-      # @return [String, nil]
-      def geonames_id
-        uri&.split("/")&.last if geonames?
+      # A string representation of the entire subject, concatenated for display.
+      # @return [String]
+      def flat_value
+        Utils.compact_and_join(values, delimiter: delimiter)
       end
-    end
-
-    # A subject value containing geographic coordinates, like a point or box.
-    class CoordinatesSubjectValue < SubjectValue
-      attr_reader :coordinates
 
-      def initialize(cocina)
-        super
-        @coordinates = Geospatial::Coordinates.from_cocina(cocina)
+      # Delimiter used to join the individual parts of the subject for display.
+      # @return [String]
+      def delimiter
+        " > "
       end
 
-      # The normalized DMS string for the coordinates.
-      # Falls back to the raw value if parsing fails.
-      # @return [String, nil]
-      def to_s
-        coordinates&.to_s || super
+      # Individual SubjectParts composing this subject.
+      # Can be multiple if the Cocina featured structuredValues.
+      # All SubjectParts inherit the type of their parent Subject.
+      # @return [Array<SubjectPart>]
+      def subject_parts
+        @subject_parts ||= if SubjectPart.atomic_types.include?(type)
+          SubjectPart.from_cocina(cocina, type: type)
+        else
+          Utils.flatten_nested_values(cocina, atomic_types: SubjectPart.atomic_types).flat_map do |value|
+            SubjectPart.from_cocina(value, type: value["type"] || type)
+          end
+        end
       end
     end
   end
 end
-
-# Map Cocina subject types to specific SubjectValue classes for rendering.
-# @see SubjectValue#type
-SUBJECT_VALUE_TYPES = {
-  "person" => CocinaDisplay::Subjects::NameSubjectValue,
-  "family" => CocinaDisplay::Subjects::NameSubjectValue,
-  "organization" => CocinaDisplay::Subjects::NameSubjectValue,
-  "conference" => CocinaDisplay::Subjects::NameSubjectValue,
-  "event" => CocinaDisplay::Subjects::NameSubjectValue,
-  "name" => CocinaDisplay::Subjects::NameSubjectValue,
-  "title" => CocinaDisplay::Subjects::TitleSubjectValue,
-  "time" => CocinaDisplay::Subjects::TemporalSubjectValue,
-  "area" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "city" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "city section" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "continent" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "country" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "county" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "coverage" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "extraterrestrial area" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "island" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "place" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "region" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "state" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "territory" => CocinaDisplay::Subjects::PlaceSubjectValue,
-  "point coordinates" => CocinaDisplay::Subjects::CoordinatesSubjectValue,
-  "map coordinates" => CocinaDisplay::Subjects::CoordinatesSubjectValue,
-  "bounding box coordinates" => CocinaDisplay::Subjects::CoordinatesSubjectValue
-}.freeze

data/lib/cocina_display/titles/title.rb

@@ -0,0 +1,49 @@
+module CocinaDisplay
+  module Titles
+    # A Title represented by one or more {TitleValue}s in various languages/scripts.
+    class Title < Parallel::Parallel
+      # Part data for digital serials, coming from elsewhere in the Cocina.
+      attr_reader :part_label, :part_numbers
+
+      # Common display methods reference the main title value. For parallel
+      # values, see #translated_value and #transliterated_value.
+      delegate :short_title, :full_title, :display_title, :sort_title, to: :main_value
+
+      # Create a new Title object.
+      # @param cocina [Hash]
+      # @param part_label [String, nil] part label for digital serials
+      # @param part_numbers [Array<String>] part numbers for related resources
+      def initialize(cocina, part_label: nil, part_numbers: nil)
+        super(cocina)
+        @part_label = part_label
+        @part_numbers = part_numbers
+      end
+
+      # Label used when displaying the title.
+      # @return [String]
+      def label
+        display_label || type_label
+      end
+
+      # The string representation of the title, for display.
+      # @return [String, nil]
+      def to_s
+        display_title
+      end
+
+      private
+
+      # Type-specific label for the title, falling back to a generic "Title".
+      # @return [String]
+      def type_label
+        I18n.t(type&.parameterize&.underscore, scope: "cocina_display.field_label.title", default: :title)
+      end
+
+      # The class to use for parallel values.
+      # @return [Class]
+      def parallel_value_class
+        TitleValue
+      end
+    end
+  end
+end

data/lib/cocina_display/titles/title_value.rb

@@ -0,0 +1,181 @@
+module CocinaDisplay
+  module Titles
+    # A Title associated with an item in a single language.
+    class TitleValue < Parallel::ParallelValue
+      # Part types for structured titles.
+      # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#title-part-types-for-structured-value
+      PART_TYPES = ["main title", "nonsorting characters", "part name", "part number", "subtitle"].freeze
+
+      # Inherit part data from the parent title.
+      delegate :part_label, :part_numbers, to: :parent, allow_nil: true
+
+      # Custom label used when displaying the title, if any.
+      # @return [String, nil]
+      def label
+        display_label || type_label
+      end
+
+      # The string representation of the title, for display.
+      # @see #display_title
+      # @return [String, nil]
+      def to_s
+        display_title
+      end
+
+      # The short form of the title, without subtitle, part name, etc.
+      # @note This corresponds to the "short title" in MODS XML, or MARC 245$a only.
+      # @return [String, nil]
+      # @example "M. de Courville"
+      def short_title
+        short_title_str.presence || cocina["value"]
+      end
+
+      # The long form of the title, including subtitle, part name, etc.
+      # @note This corresponds to the entire MARC 245 field.
+      # @return [String, nil]
+      # @example "M. de Courville : [estampe]"
+      def full_title
+        full_title_str.presence || cocina["value"]
+      end
+
+      # The long form of the title, without trailing punctuation.
+      # @note This corresponds to the entire MARC 245 field.
+      # @return [String, nil]
+      def display_title
+        display_title_str.presence || cocina["value"]
+      end
+
+      # A string value for sorting by title.
+      # Ignores punctuation, leading/trailing spaces, and non-sorting characters.
+      # If no title is present, returns a high Unicode value so it sorts last.
+      # @return [String]
+      def sort_title
+        return "\u{10FFFF}" unless full_title
+
+        full_title[nonsorting_chars_str.length..]
+          .unicode_normalize(:nfd) # Prevent accents being stripped
+          .gsub(/[[:punct:]]*/, "")
+          .gsub(/\W{2,}/, " ")  # Collapse whitespace after removing punctuation
+          .strip
+      end
+
+      private
+
+      # Generate the short title by joining main title and nonsorting characters.
+      # @return [String, nil]
+      def short_title_str
+        nonsorting_chars_str + main_title_str # pre-formatted padding
+      end
+
+      # Generate the full title by joining all title components with punctuation.
+      # @return [String, nil]
+      def full_title_str
+        title_str = main_subtitle_str
+        title_str = Utils.compact_and_join([main_subtitle_str, parts_str], delimiter: ". ") unless main_subtitle_str.end_with?(parts_str)
+        title_str = nonsorting_chars_str + title_str # pre-formatted padding
+        title_str = Utils.compact_and_join([names_str, title_str], delimiter: ". ") if names_str.present?
+        title_str += "." unless title_str&.match?(/[[:punct:]]\z/)
+        title_str.presence
+      end
+
+      # Generate the display title by stripping trailing punctuation from the full title.
+      # @return [String, nil]
+      def display_title_str
+        full_title_str&.sub(/[.,;:\/\\]+\z/, "")
+      end
+
+      # The main title and subtitle, joined together with a colon.
+      # @return [String, nil]
+      def main_subtitle_str
+        Utils.compact_and_join([main_title_str, subtitle_str], delimiter: " : ")
+      end
+
+      # All nonsorting characters joined together with padding applied.
+      # Handles languages that do not separate nonsorting characters with spaces.
+      # @return [String, nil]
+      def nonsorting_chars_str
+        pad_nonsorting(Utils.compact_and_join(Array(title_components["nonsorting characters"])))
+      end
+
+      # The main title component(s), joined together.
+      # @return [String, nil]
+      def main_title_str
+        Utils.compact_and_join(Array(title_components["main title"]))
+      end
+
+      # The subtitle components, joined together.
+      # @return [String, nil]
+      def subtitle_str
+        Utils.compact_and_join(Array(title_components["subtitle"]))
+      end
+
+      # The part name, number, and label components, joined together with commas.
+      # @return [String, nil]
+      def parts_str
+        Utils.compact_and_join(
+          Array(title_components["part number"] || part_numbers) +
+          Array(title_components["part name"]) +
+          [part_label],
+          delimiter: ", "
+        )
+      end
+
+      # The associated names, joined together with periods.
+      # @note Only present for uniform titles.
+      # @return [String, nil]
+      def names_str
+        Utils.compact_and_join(names, delimiter: ". ")
+      end
+
+      # Destructured title components, organized by type.
+      # Unstructured titles and components with no type are grouped under "main title".
+      # @return [Hash<String, Array<String>>]
+      # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#title-part-types-for-structured-value
+      def title_components
+        Utils.flatten_nested_values(cocina).each_with_object({}) do |node, hash|
+          type = PART_TYPES.find { |t| t == node["type"] } || "main title"
+          hash[type] ||= []
+          hash[type] << node["value"]
+        end.compact_blank
+      end
+
+      # Uniform titles can have associated person names.
+      # @return [String, nil]
+      def names
+        Janeway.enum_for("$.note[?(@.type=='associated name')]", cocina).map do |name|
+          Contributors::Name.new(name).to_s(with_date: true)
+        end
+      end
+
+      # Number of nonsorting characters to ignore at the start of the title.
+      # @return [Integer, nil]
+      def nonsorting_char_count
+        Janeway.enum_for("$.note[?(@.type=='nonsorting character count')].value", cocina).first&.to_i
+      end
+
+      # Add or remove padding from nonsorting portion of the title.
+      # @param value [String]
+      # @return [String]
+      def pad_nonsorting(value)
+        case value.strip
+        when /.*-$/, /.*'$/, "ה"  # Arabic, French, Hebrew prefixes use no padding
+          value.strip
+        when ""  # No nonsorting characters; return empty string
+          ""
+        else  # Pad to nonsorting char count if set, otherwise add a single space
+          if nonsorting_char_count.present?
+            value.ljust(nonsorting_char_count, " ")
+          else
+            value + " "
+          end
+        end
+      end
+
+      # Type-specific label for the title, falling back to a generic "Title".
+      # @return [String]
+      def type_label
+        I18n.t(type&.parameterize&.underscore, scope: "cocina_display.field_label.title", default: :title)
+      end
+    end
+  end
+end

data/lib/cocina_display/version.rb

@@ -2,5 +2,5 @@
 
 # :nodoc:
 module CocinaDisplay
-  VERSION = "2.1.0" # :nodoc:
+  VERSION = "2.2.0" # :nodoc:
 end

data/script/deep_compact.rb

@@ -4,6 +4,8 @@
 # blank values to create a more compact representation and write to stdout.
 
 require "json"
+require "active_support"
+require "active_support/core_ext"
 
 require_relative "../lib/cocina_display/utils"
 

data/script/find_records.rb

@@ -28,7 +28,7 @@ RELEASE_TARGET = "Searchworks"
 
 # Modify this expression to match the JSON path you want to search, or just
 # modify the `examine_record` method directly.
-PATH_EXPR = "$..[?length(@.groupedValue) > 0]"
+PATH_EXPR = "$..[? @.type == 'parallel' ]"
 
 # Modify this method as needed to change what you're looking for in each record.
 # It takes a CocinaRecord object and should return an array of [path, result] pairs.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cocina_display
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Nick Budak
 bindir: exe
 cert_chain: []
-date: 2026-03-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: janeway-jsonpath
@@ -261,6 +261,7 @@ files:
 - lib/cocina_display/contributors/affiliation.rb
 - lib/cocina_display/contributors/contributor.rb
 - lib/cocina_display/contributors/name.rb
+- lib/cocina_display/contributors/name_value.rb
 - lib/cocina_display/contributors/role.rb
 - lib/cocina_display/dates/date.rb
 - lib/cocina_display/dates/date_range.rb
@@ -278,15 +279,21 @@ files:
 - lib/cocina_display/geospatial.rb
 - lib/cocina_display/identifier.rb
 - lib/cocina_display/json_backed_record.rb
-- lib/cocina_display/language.rb
+- lib/cocina_display/languages/language.rb
+- lib/cocina_display/languages/script.rb
 - lib/cocina_display/license.rb
-- lib/cocina_display/note.rb
+- lib/cocina_display/notes/note.rb
+- lib/cocina_display/notes/note_value.rb
+- lib/cocina_display/parallel/parallel.rb
+- lib/cocina_display/parallel/parallel_value.rb
 - lib/cocina_display/related_resource.rb
 - lib/cocina_display/structural/file.rb
 - lib/cocina_display/structural/file_set.rb
 - lib/cocina_display/subjects/subject.rb
+- lib/cocina_display/subjects/subject_part.rb
 - lib/cocina_display/subjects/subject_value.rb
-- lib/cocina_display/title.rb
+- lib/cocina_display/titles/title.rb
+- lib/cocina_display/titles/title_value.rb
 - lib/cocina_display/utils.rb
 - lib/cocina_display/version.rb
 - script/deep_compact.rb
@@ -312,7 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.7
 specification_version: 4
 summary: Helpers for rendering Cocina metadata
 test_files: []

data/lib/cocina_display/language.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module CocinaDisplay
-  # A language associated with part or all of a Cocina object.
-  class Language
-    SEARCHWORKS_LANGUAGES_FILE_PATH = CocinaDisplay.root / "config" / "searchworks_languages.yml"
-
-    attr_reader :cocina
-
-    # A hash of language codes to language names recognized by Searchworks.
-    # @return [Hash{String => String}]
-    def self.searchworks_languages
-      @searchworks_languages ||= YAML.safe_load_file(SEARCHWORKS_LANGUAGES_FILE_PATH)
-    end
-
-    # Create a Language object from Cocina structured data.
-    # @param cocina [Hash]
-    def initialize(cocina)
-      @cocina = cocina
-    end
-
-    # The language name for display.
-    # @return [String, nil]
-    def to_s
-      cocina["value"] || decoded_value
-    end
-
-    # The language code, e.g. an ISO 639 code like "eng" or "spa".
-    # @return [String, nil]
-    def code
-      cocina["code"]
-    end
-
-    # Decoded name of the language based on the code, if present.
-    # @return [String, nil]
-    def decoded_value
-      Language.searchworks_languages[code] if searchworks_language?
-    end
-
-    # Display label for this field.
-    # @return [String]
-    def label
-      cocina["displayLabel"].presence || I18n.t("cocina_display.field_label.language")
-    end
-
-    # True if the language is recognized by Searchworks.
-    # @see CocinaDisplay::Language.searchworks_languages
-    # @return [Boolean]
-    def searchworks_language?
-      Language.searchworks_languages.value?(cocina["value"]) || Language.searchworks_languages.key?(code)
-    end
-  end
-end