cocina_display 1.1.3 → 1.2.0

data/lib/cocina_display/title.rb

@@ -0,0 +1,194 @@
+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
+
+      full_title[nonsorting_char_count..]
+        .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
+      Utils.compact_and_join([nonsorting_chars_str, 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 nonsorting characters with specified padding
+    # - 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 = Utils.compact_and_join([nonsorting_chars_str, title_str]) if nonsorting_chars_str.present?
+      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.
+    # @return [String, nil]
+    def nonsorting_chars_str
+      Utils.compact_and_join(Array(title_components["nonsorting characters"])).ljust(nonsorting_char_count, " ")
+    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 || 0
+    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

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.0" # :nodoc:
 end

data/lib/cocina_display.rb

@@ -1,4 +1,32 @@
 # 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.inflector.inflect("searchworks_languages" => "SEARCHWORKS_LANGUAGES",
+  "marc_relator" => "MARC_RELATOR",
+  "marc_country" => "MARC_COUNTRY")
+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
+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.0
 platform: ruby
 authors:
 - Nick Budak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-20 00:00:00.000000000 Z
+date: 2025-09-23 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,35 +224,55 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- config/i18n-tasks.yml
+- config/licenses.yml
+- config/locales/en.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/marc_country.rb
+- lib/cocina_display/vocabularies/marc_relator.rb
 - lib/cocina_display/vocabularies/searchworks_languages.rb
 - script/deep_compact.rb
 - script/find_records.rb