cocina_display 1.1.3 → 1.2.1

data/lib/cocina_display/related_resource.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module CocinaDisplay
+  # A resource related to the record. See https://github.com/sul-dlss/cocina-models/blob/main/lib/cocina/models/related_resource.rb
+  # @note Related resources have no structural metadata.
+  class RelatedResource < JsonBackedRecord
+    include CocinaDisplay::Concerns::Accesses
+    include CocinaDisplay::Concerns::Events
+    include CocinaDisplay::Concerns::Contributors
+    include CocinaDisplay::Concerns::Identifiers
+    include CocinaDisplay::Concerns::Notes
+    include CocinaDisplay::Concerns::Titles
+    include CocinaDisplay::Concerns::UrlHelpers
+    include CocinaDisplay::Concerns::Subjects
+    include CocinaDisplay::Concerns::Forms
+    include CocinaDisplay::Concerns::Languages
+    include CocinaDisplay::Concerns::Geospatial
+
+    # Description of the relation to the source record.
+    # @return [String]
+    # @example "is part of"
+    # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#relatedresource-types
+    attr_reader :type
+
+    # Restructure the hash so that everything is under "description" key, since
+    # it's all descriptive metadata. This makes most CocinaRecord methods work.
+    def initialize(cocina_doc)
+      @type = cocina_doc["type"]
+      super({"description" => cocina_doc.except("type")})
+    end
+
+    # Label used to group the related resource for display.
+    # @return [String]
+    def label
+      cocina_doc.dig("description", "displayLabel").presence || type_label
+    end
+
+    # String representation of the related resource.
+    # @return [String, nil]
+    def to_s
+      main_title || url
+    end
+
+    # URL to the related resource for link construction.
+    # If there are multiple URLs, uses the first.
+    # @return [String, nil]
+    def url
+      urls.first&.to_s || purl_url
+    end
+
+    # Is this a related resource with a URL?
+    # @return [Boolean]
+    def url?
+      url.present?
+    end
+
+    # Nested display data for the related resource.
+    # Combines titles, contributors, notes, and access information.
+    # @note Used for extended display of citations, e.g. on hp566jq8781.
+    # @return [Array<DisplayData>]
+    def display_data
+      title_display_data + contributor_display_data + general_note_display_data + preferred_citation_display_data + access_display_data
+    end
+
+    private
+
+    # Key used for i18n lookup of the label, based on the type.
+    # Falls back to a generic label for any unknown types.
+    # @return [String]
+    def type_label
+      I18n.t(type&.parameterize&.underscore, default: :related_to, scope: "cocina_display.field_label.related_resource")
+    end
+  end
+end

data/lib/cocina_display/subjects/subject.rb

@@ -1,6 +1,3 @@
-require_relative "../utils"
-require_relative "subject_value"
-
 module CocinaDisplay
   module Subjects
     # Base class for subjects in Cocina structured data.
@@ -27,23 +24,49 @@ module CocinaDisplay
         subject_values.map(&:to_s).compact_blank
       end
 
-      # A string representation of the entire subject, concatenated for display.
+      # The value to use for display.
+      # Genre values are capitalized; other subject values are not.
       # @return [String]
       def to_s
+        (type == "genre") ? display_value&.upcase_first : display_value
+      end
+
+      # A string representation of the entire subject, concatenated for display.
+      # @return [String]
+      def display_value
         Utils.compact_and_join(display_values, delimiter: " > ")
       end
 
+      # Label used to render the subject for display.
+      # Uses a displayLabel if available, otherwise looks up via type.
+      # @return [String]
+      def label
+        cocina["displayLabel"].presence || type_label
+      end
+
       # Individual values composing this subject.
       # Can be multiple if the Cocina featured nested data.
-      # If no type was specified on a value, uses the top-level subject type.
+      # All SubjectValues inherit the type of their parent Subject.
       # @return [Array<SubjectValue>]
       def subject_values
-        @subject_values ||= Utils.flatten_nested_values(cocina, atomic_types: SubjectValue.atomic_types).map do |value|
-          subject_value = SubjectValue.from_cocina(value)
-          subject_value.type ||= type
-          subject_value
+        @subject_values ||= (Array(cocina["parallelValue"]).presence || [cocina]).flat_map do |node|
+          if SubjectValue.atomic_types.include?(type)
+            SubjectValue.from_cocina(node, type: type)
+          else
+            Utils.flatten_nested_values(node, atomic_types: SubjectValue.atomic_types).flat_map do |value|
+              SubjectValue.from_cocina(value, type: value["type"] || type)
+            end
+          end
         end
       end
+
+      private
+
+      # Type-specific label for this subject.
+      # @return [String]
+      def type_label
+        I18n.t(type&.parameterize&.underscore, default: :subject, scope: "cocina_display.field_label.subject")
+      end
     end
   end
 end

data/lib/cocina_display/subjects/subject_value.rb

@@ -1,11 +1,3 @@
-require "geo/coord"
-
-require_relative "subject"
-require_relative "../contributors/name"
-require_relative "../title_builder"
-require_relative "../dates/date"
-require_relative "../geospatial"
-
 module CocinaDisplay
   module Subjects
     # A descriptive value that can be part of a Subject.
@@ -16,11 +8,29 @@ module CocinaDisplay
       # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#subject-part-types-for-structured-value
       attr_accessor :type
 
-      # Create a SubjectValue from Cocina structured data.
+      # 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.
-      # @return [SubjectValue]
-      def self.from_cocina(cocina)
-        SUBJECT_VALUE_TYPES.fetch(cocina["type"], SubjectValue).new(cocina)
+      # @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.
@@ -65,12 +75,20 @@ module CocinaDisplay
 
     # 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::TitleBuilder.build
-      # @note Unclear how often structured title subjects occur "in the wild".
-      # @return [String]
+      # @see CocinaDisplay::Title#to_s
+      # @return [String, nil]
       def to_s
-        TitleBuilder.build([cocina])
+        title.to_s
       end
     end
 

data/lib/cocina_display/title.rb

@@ -0,0 +1,221 @@
+module CocinaDisplay
+  # A group of related {TitleValue}s associated with an item.
+  class Title
+    # The underlying Cocina hash.
+    attr_reader :cocina
+
+    # Type of the title, e.g. "uniform", "alternative", etc.
+    # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#title-types
+    # @return [String, nil]
+    attr_accessor :type
+
+    # Status of the title, e.g. "primary".
+    # @return [String, nil]
+    attr_accessor :status
+
+    # 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)
+      @cocina = cocina
+      @part_label = part_label
+      @part_numbers = part_numbers
+      @type = cocina["type"].presence
+      @status = cocina["status"].presence
+    end
+
+    # Label used when displaying the title.
+    # @return [String]
+    def label
+      cocina["displayLabel"].presence || type_label
+    end
+
+    # Does this title have a type?
+    # @return [Boolean]
+    def type?
+      type.present?
+    end
+
+    # Is this marked as a primary title?
+    # @return [Boolean]
+    def primary?
+      status == "primary"
+    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, with added punctuation between parts if not present.
+    # @note This corresponds to the entire MARC 245 field.
+    # @return [String, nil]
+    # @example "M. de Courville : [estampe]"
+    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
+
+      sort_title_str
+        .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 with spaces.
+    # @return [String, nil]
+    def short_title_str
+      Utils.compact_and_join([nonsorting_chars_str, main_title_str])
+    end
+
+    # Generate the full title by joining all title components with spaces.
+    # @return [String, nil]
+    def full_title_str
+      nonsorting_chars_str + sort_title_str
+    end
+
+    # All of the sorting parts of the title joined together with spaces.
+    # @return [String]
+    def sort_title_str
+      Utils.compact_and_join([main_title_str, subtitle_str, parts_str])
+    end
+
+    # Generate the display title by joining all components with punctuation:
+    # - Join main title and subtitle with " : "
+    # - Join part name/number/label with ", "
+    # - Join part string with preceding title with ". "
+    # - Prepend preformatted nonsorting characters
+    # - Prepend associated names with ". "
+    # @return [String, nil]
+    def display_title_str
+      title_str = Utils.compact_and_join([main_title_str, subtitle_str], delimiter: " : ")
+      title_str = Utils.compact_and_join([title_str, parts_str(delimiter: ", ")], delimiter: ". ")
+      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.presence
+    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.
+    # Default delimiter is a space, but can be overridden.
+    # @return [String, nil]
+    def parts_str(delimiter: " ")
+      Utils.compact_and_join(
+        Array(title_components["part number"] || @part_numbers) +
+        Array(title_components["part name"]) +
+        [@part_label],
+        delimiter: 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 = case node["type"]
+        when "uniform", "alternative", "abbreviated", "translated", "transliterated", "parallel", "supplied", nil
+          "main title"
+        else
+          node["type"]
+        end
+        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
+
+    # 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
+
+    private
+
+    # 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
+  end
+end

data/lib/cocina_display/utils.rb

@@ -21,7 +21,7 @@ module CocinaDisplay
       end.delete_suffix(delimiter)
     end
 
-    # Recursively flatten structured, parallel, and grouped values in Cocina metadata.
+    # Recursively flatten structured, and grouped values in Cocina metadata.
     # Returns a list of hashes representing the "leaf" nodes with +value+ key.
     # @return [Array<Hash>] List of node hashes with "value" present
     # @param cocina [Hash] The Cocina structured data to flatten
@@ -35,8 +35,8 @@ module CocinaDisplay
     #  cocina = { "structuredValue" => [{"value" => "foo"},  {"value" => "bar"}] }
     #  Utils.flatten_nested_values(cocina)
     #  #=> [{"value" => "foo"}, {"value" => "bar"}]
-    # @example parallel structured and simple values
-    #  cocina = { "parallelValue" => [{"value" => "foo" }, { "structuredValue" => [{"value" => "bar"},  {"value" => "baz"}] }] }
+    # @example nested structured and simple values
+    #  cocina = { "structuredValue" => [{"value" => "foo" }, { "structuredValue" => [{"value" => "bar"},  {"value" => "baz"}] }] }
     #  Utils.flatten_nested_values(cocina)
     #  #=> [{"value" => "foo"}, {"value" => "foo"}, {"value" => "baz"}]
     def self.flatten_nested_values(cocina, output = [], atomic_types: [])
@@ -44,7 +44,7 @@ module CocinaDisplay
       return [cocina] if atomic_types.include?(cocina["type"])
       return cocina.flat_map { |node| flatten_nested_values(node, output, atomic_types: atomic_types) } if cocina.is_a?(Array)
 
-      nested_values = Array(cocina["structuredValue"]) + Array(cocina["parallelValue"]) + Array(cocina["groupedValue"])
+      nested_values = Array(cocina["structuredValue"]) + Array(cocina["groupedValue"])
       return output unless nested_values.any?
 
       nested_values.flat_map { |node| flatten_nested_values(node, output, atomic_types: atomic_types) }

data/lib/cocina_display/version.rb

@@ -2,5 +2,5 @@
 
 # :nodoc:
 module CocinaDisplay
-  VERSION = "1.1.3" # :nodoc:
+  VERSION = "1.2.1" # :nodoc:
 end

data/lib/cocina_display.rb

@@ -1,4 +1,34 @@
 # frozen_string_literal: true
 
-require_relative "cocina_display/version"
-require_relative "cocina_display/cocina_record"
+# require_relative "cocina_display/version"
+
+require "janeway"
+require "json"
+require "net/http"
+require "active_support"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/hash/conversions"
+require "geo/coord"
+require "edtf"
+require "i18n"
+require "i18n/backend/fallbacks"
+I18n::Backend::Simple.include I18n::Backend::Fallbacks
+I18n.load_path += Dir["#{File.expand_path("..", __dir__)}/config/locales/*.yml"]
+I18n.backend.load_translations
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.new
+loader.tag = File.basename(__FILE__, ".rb")
+loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
+loader.push_dir(File.dirname(__FILE__))
+loader.setup
+
+module CocinaDisplay
+  # set to an object with a #notify method. This is called if an error is encountered.
+  mattr_accessor :notifier
+
+  # @return [Pathname] Returns the root path of this gem
+  def self.root
+    @root ||= Pathname.new(File.expand_path("..", __dir__))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina_display
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.1
 platform: ruby
 authors:
 - Nick Budak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-20 00:00:00.000000000 Z
+date: 2025-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: janeway-jsonpath
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: iso639
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: geo_coord
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,36 +224,56 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- config/i18n-tasks.yml
+- config/licenses.yml
+- config/locales/en.yml
+- config/marc_countries.yml
+- config/marc_relators.yml
+- config/searchworks_languages.yml
 - lib/cocina_display.rb
 - lib/cocina_display/cocina_record.rb
-- lib/cocina_display/concerns/access.rb
+- lib/cocina_display/concerns.rb
+- lib/cocina_display/concerns/accesses.rb
 - lib/cocina_display/concerns/contributors.rb
 - lib/cocina_display/concerns/events.rb
 - lib/cocina_display/concerns/forms.rb
 - lib/cocina_display/concerns/geospatial.rb
 - lib/cocina_display/concerns/identifiers.rb
 - lib/cocina_display/concerns/languages.rb
+- lib/cocina_display/concerns/notes.rb
+- lib/cocina_display/concerns/related_resources.rb
 - lib/cocina_display/concerns/structural.rb
 - lib/cocina_display/concerns/subjects.rb
 - lib/cocina_display/concerns/titles.rb
+- lib/cocina_display/concerns/url_helpers.rb
 - lib/cocina_display/contributors/contributor.rb
 - lib/cocina_display/contributors/name.rb
 - lib/cocina_display/contributors/role.rb
 - lib/cocina_display/dates/date.rb
 - lib/cocina_display/dates/date_range.rb
+- lib/cocina_display/description/access.rb
+- lib/cocina_display/description/access_contact.rb
+- lib/cocina_display/description/url.rb
+- lib/cocina_display/display_data.rb
 - lib/cocina_display/events/event.rb
 - lib/cocina_display/events/imprint.rb
 - lib/cocina_display/events/location.rb
+- lib/cocina_display/events/note.rb
+- lib/cocina_display/forms/form.rb
+- lib/cocina_display/forms/genre.rb
+- lib/cocina_display/forms/resource_type.rb
 - 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/license.rb
+- lib/cocina_display/note.rb
+- lib/cocina_display/related_resource.rb
 - lib/cocina_display/subjects/subject.rb
 - lib/cocina_display/subjects/subject_value.rb
-- lib/cocina_display/title_builder.rb
+- lib/cocina_display/title.rb
 - lib/cocina_display/utils.rb
 - lib/cocina_display/version.rb
-- lib/cocina_display/vocabularies/marc_country_codes.rb
-- lib/cocina_display/vocabularies/marc_relator_codes.rb
-- lib/cocina_display/vocabularies/searchworks_languages.rb
 - script/deep_compact.rb
 - script/find_records.rb
 - sig/cocina_display.rbs