cocina_display 1.1.3 → 1.2.1

data/lib/cocina_display/concerns/titles.rb

@@ -1,48 +1,77 @@
-require_relative "../title_builder"
-
 module CocinaDisplay
   module Concerns
     # Methods for finding and formatting titles.
     module Titles
       # The main title for the object, without subtitle, part name, etc.
-      # If there are multiple titles, uses the first.
-      # @see CocinaDisplay::TitleBuilder#main_title
-      # @note This corresponds to the "short title" in MODS XML, or MARC 245$a only.
-      # @return [String]
+      # If there are multiple primary titles, uses the first.
+      # @see CocinaDisplay::Title#main_title
+      # @return [String, nil]
       def main_title
-        CocinaDisplay::TitleBuilder.main_title(cocina_titles).first
+        primary_title&.short_title
       end
 
       # The full title for the object, including subtitle, part name, etc.
-      # If there are multiple titles, uses the first.
-      # @see CocinaDisplay::TitleBuilder#full_title
-      # @note This corresponds to the entire MARC 245 field.
-      # @return [String]
+      # If there are multiple primary titles, uses the first.
+      # @see CocinaDisplay::Title#full_title
+      # @return [String, nil]
       def full_title
-        CocinaDisplay::TitleBuilder.full_title(cocina_titles, catalog_links: catalog_links).first
+        primary_title&.full_title
       end
 
       # The full title, joined together with additional punctuation.
-      # If there are multiple titles, uses the first.
-      # @see CocinaDisplay::TitleBuilder#build
-      # @return [String]
+      # If there are multiple primary titles, uses the first.
+      # @see CocinaDisplay::Title#display_title
+      # @return [String, nil]
       def display_title
-        CocinaDisplay::TitleBuilder.build(cocina_titles, catalog_links: catalog_links)
+        primary_title&.display_title
+      end
+
+      # A string value for sorting by title that sorts missing values last.
+      # If there are multiple primary titles, uses the first.
+      # @see CocinaDisplay::Title#sort_title
+      # @return [String]
+      def sort_title
+        primary_title&.sort_title || "\u{10FFFF}"
       end
 
-      # Any additional titles for the object excluding the main title.
+      # Any additional titles for the object excluding the primary title.
       # @return [Array<String>]
-      # @see CocinaDisplay::TitleBuilder#additional_titles
+      # @see CocinaDisplay::Title#display_title
       def additional_titles
-        CocinaDisplay::TitleBuilder.additional_titles(cocina_titles)
+        secondary_titles.map(&:display_title).compact_blank
       end
 
-      # A string value for sorting by title that sorts missing values last.
-      # Ignores punctuation, leading/trailing spaces, and non-sorting characters.
-      # @see CocinaDisplay::TitleBuilder#sort_title
-      # @return [String]
-      def sort_title
-        CocinaDisplay::TitleBuilder.sort_title(cocina_titles, catalog_links: catalog_links).first || "\u{10FFFF}"
+      # All {Title} objects, grouped by their label for display.
+      # @note All primary titles are included under "Title", not just the first.
+      # @return [Array<DisplayData>]
+      def title_display_data
+        DisplayData.from_objects(all_titles)
+      end
+
+      # The first title marked primary, or the first without a type.
+      # @return [Array<Title>]
+      def primary_title
+        all_titles.find { |title| title.primary? }.presence || all_titles.find { |title| !title.type? }
+      end
+
+      # All titles except the primary title.
+      # @return [Array<Title>]
+      def secondary_titles
+        all_titles - [primary_title]
+      end
+
+      # All {Title} objects built from the Cocina titles.
+      # Flattens parallel values into separate titles.
+      # @return [Array<Title>]
+      def all_titles
+        @all_titles ||= cocina_titles.flat_map do |cocina_title|
+          (Array(cocina_title["parallelValue"]).presence || [cocina_title]).map do |value|
+            Title.new(value, part_label: part_label, part_numbers: part_numbers).tap do |title|
+              title.type ||= cocina_title["type"]
+              title.status ||= cocina_title["status"]
+            end
+          end
+        end
       end
 
       private
@@ -59,6 +88,19 @@ module CocinaDisplay
       def catalog_links
         @catalog_links ||= Array(cocina_doc.dig("identification", "catalogLinks"))
       end
+
+      # Part label for digital serials display from FOLIO, if any.
+      # @return [String, nil]
+      def part_label
+        catalog_links.find { |link| link["catalog"] == "folio" }&.fetch("partLabel", nil)
+      end
+
+      # Part numbers from notes, if any.
+      # @note This is used for RelatedResource title display.
+      # @return [Array<String>]
+      def part_numbers
+        notes.filter(&:part?).flat_map { |note| note.values_by_type["number"] }.compact_blank
+      end
     end
   end
 end

data/lib/cocina_display/concerns/{access.rb → url_helpers.rb}

@@ -1,13 +1,13 @@
 module CocinaDisplay
   module Concerns
     # Methods that generate URLs to access an object.
-    module Access
+    module UrlHelpers
       # The PURL URL for this object.
       # @return [String]
       # @example
       #  record.purl_url #=> "https://purl.stanford.edu/bx658jh7339"
       def purl_url
-        cocina_doc.dig("description", "purl") || ("https://purl.stanford.edu/#{bare_druid}" if bare_druid)
+        cocina_doc.dig("description", "purl")
       end
 
       # The oEmbed URL for the object, optionally with additional parameters.
@@ -18,7 +18,7 @@ module CocinaDisplay
       # @example Generate an oEmbed URL for the viewer and hide the title
       #   record.oembed_url(hide_title: true) #=> "https://purl.stanford.edu/bx658jh7339/embed.json?hide_title=true"
       def oembed_url(params: {})
-        return if collection? || purl_url.blank?
+        return if (!is_a?(CocinaDisplay::RelatedResource) && collection?) || purl_url.blank?
 
         params[:url] ||= purl_url
         "#{purl_base_url}/embed.json?#{params.to_query}"

data/lib/cocina_display/concerns.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CocinaDisplay
+  module Concerns
+  end
+end

data/lib/cocina_display/contributors/contributor.rb

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support"
-require "active_support/core_ext/object/blank"
-require "active_support/core_ext/array/conversions"
-
-require_relative "../utils"
-require_relative "name"
-require_relative "role"
-
 module CocinaDisplay
   module Contributors
     # A contributor to a work, such as an author or publisher.
@@ -20,11 +12,22 @@ module CocinaDisplay
         @cocina = cocina
       end
 
-      # String representation of the contributor, including name and role.
-      # Used for debugging and logging.
-      # @return [String]
+      # String representation of the contributor, using display name with date.
+      # @return [String, nil]
       def to_s
-        Utils.compact_and_join([display_name, display_role], delimiter: ": ")
+        display_name(with_date: true)
+      end
+
+      # Support equality based on the underlying Cocina data.
+      # @param other [Object]
+      def ==(other)
+        other.is_a?(Contributor) && other.cocina == cocina
+      end
+
+      # Identifiers for the contributor.
+      # @return [Array<Identifier>]
+      def identifiers
+        Array(cocina["identifier"]).map { |id| Identifier.new(id) }
       end
 
       # Is this contributor a human?
@@ -75,39 +78,57 @@ module CocinaDisplay
         roles.any?
       end
 
-      # The display name for the contributor as a string.
-      # Uses the first name if multiple names are present.
+      # The primary display name for the contributor as a string.
       # @param with_date [Boolean] Include life dates, if present
-      # @return [String]
+      # @return [String, nil]
       def display_name(with_date: false)
-        names.map { |name| name.to_s(with_date: with_date) }.compact_blank.first
+        primary_name&.to_s(with_date: with_date)
       end
 
-      # The full forename for the contributor from the first available name.
+      # String renderings of all names for the contributor.
+      # @param with_date [Boolean] Include life dates, if present
+      # @return [Array<String>]
+      def display_names(with_date: false)
+        names.map { |name| name.to_s(with_date: with_date) }.compact_blank
+      end
+
+      # A single primary name for the contributor.
+      # Prefers a name of type "display" or one marked primary.
+      # @return [Contributor::Name, nil]
+      def primary_name
+        names.find { |name| name.type == "display" }.presence ||
+          names.find(&:primary?).presence ||
+          names.first
+      end
+
+      # The forename for the contributor, if structured name info is available.
       # @see Contributor::Name::forename_str
       # @return [String, nil]
       def forename
         names.map(&:forename_str).first.presence
       end
 
-      # The full surname for the contributor from the first available name.
+      # The surname for the contributor, if structured name info is available.
       # @see Contributor::Name::surname_str
       # @return [String, nil]
       def surname
         names.map(&:surname_str).first.presence
       end
 
-      # A string representation of the contributor's roles, formatted for display.
-      # If there are multiple roles, they are joined with commas.
-      # @return [String]
-      def display_role
-        roles.map(&:to_s).to_sentence
-      end
-
       # All names in the Cocina as Name objects.
+      # Flattens parallel values into separate Name objects.
       # @return [Array<Name>]
       def names
-        @names ||= Array(cocina["name"]).map { |name| Name.new(name) }
+        @names ||= Array(cocina["name"]).flat_map do |name|
+          (Array(name["parallelValue"]).presence || [name]).filter_map do |name_value|
+            unless name_value.blank?
+              Name.new(name_value).tap do |name_obj|
+                name_obj.type ||= name["type"]
+                name_obj.status ||= name["status"]
+              end
+            end
+          end
+        end
       end
 
       # All roles in the Cocina structured data.

data/lib/cocina_display/contributors/name.rb

@@ -1,24 +1,30 @@
 # frozen_string_literal: true
 
-require_relative "../utils"
-
 module CocinaDisplay
   module Contributors
     # A name associated with a contributor.
     class Name
+      # The underlying Cocina structured data for the name.
+      # @return [Hash]
       attr_reader :cocina
 
+      # The type of name, if any (e.g., "personal", "corporate", etc.).
+      # @return [String, nil]
+      attr_accessor :type
+
+      # The status of the name, if any (e.g., "primary").
+      # @return [String, nil]
+      attr_accessor :status
+
       # Initialize a Name object with Cocina structured data.
       # @param cocina [Hash] The Cocina structured data for the name.
       def initialize(cocina)
         @cocina = cocina
+        @type = cocina["type"]
+        @status = cocina["status"]
       end
 
       # The display string for the name, optionally including life dates.
-      # Uses these values in order, if present:
-      # 1. Unstructured value
-      # 2. Any structured/parallel values marked as "display"
-      # 3. Joined structured values, optionally with life dates
       # @param with_date [Boolean] Include life dates, if present
       # @return [String]
       # @example no dates
@@ -28,8 +34,6 @@ module CocinaDisplay
       def to_s(with_date: false)
         if cocina["value"].present?
           cocina["value"]
-        elsif display_name_str.present?
-          display_name_str
         elsif dates_str.present? && with_date
           Utils.compact_and_join([full_name_str, dates_str], delimiter: ", ")
         else
@@ -43,12 +47,6 @@ module CocinaDisplay
         Utils.compact_and_join(name_components.push(terms_of_address_str), delimiter: ", ")
       end
 
-      # Flattened form of any names explicitly marked as "display name".
-      # @return [String]
-      def display_name_str
-        Utils.compact_and_join(Array(name_values["display"]), delimiter: ", ")
-      end
-
       # List of all name components.
       # If any of forename, surname, or term of address are present, those are used.
       # Otherwise, fall back to any names explicitly marked as "name" or untyped.
@@ -81,6 +79,12 @@ module CocinaDisplay
         Utils.compact_and_join(Array(name_values["life dates"]) + Array(name_values["activity dates"]), delimiter: ", ")
       end
 
+      # Is this a primary name for the contributor?
+      # @return [Boolean]
+      def primary?
+        status == "primary"
+      end
+
       private
 
       # A hash mapping destructured name types to their values.

data/lib/cocina_display/contributors/role.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "../vocabularies/marc_relator_codes"
-
 module CocinaDisplay
   module Contributors
     # A role associated with a contributor.
     class Role
+      MARC_RELATORS_FILE_PATH = CocinaDisplay.root / "config" / "marc_relators.yml"
+
       attr_reader :cocina
 
+      # A hash mapping MARC relator codes to their names.
+      # @return [Hash{String => String}]
+      def self.marc_relators
+        @marc_relators ||= YAML.safe_load_file(MARC_RELATORS_FILE_PATH)
+      end
+
       # Initialize a Role object with Cocina structured data.
       # @param cocina [Hash] The Cocina structured data for the role.
       def initialize(cocina)
@@ -16,37 +22,49 @@ module CocinaDisplay
 
       # The name of the role.
       # Translates the MARC relator code if no value was present.
-      # @return [String, nil]
+      # @return [String, nil] A nil role is typically displayed in the UI as an "Associated with" relationship
       def to_s
-        cocina["value"] || (Vocabularies::MARC_RELATOR[code] if marc_relator?)
-      end
-
-      # A code associated with the role, e.g. a MARC relator code.
-      # @return [String, nil]
-      def code
-        cocina["code"]
+        cocina.fetch("value") { marc_value }
       end
 
       # Does this role indicate the contributor is an author?
       # @return [Boolean]
       def author?
-        to_s =~ /^(author|creator|primary investigator)/i
+        /^(author|creator|primary investigator)/i.match? to_s
       end
 
       # Does this role indicate the contributor is a publisher?
       # @return [Boolean]
       def publisher?
-        to_s =~ /^publisher/i
+        /^publisher/i.match? to_s
       end
 
       # Does this role indicate the contributor is a funder?
       # @return [Boolean]
       def funder?
-        to_s =~ /^funder/i
+        /^funder/i.match? to_s
       end
 
       private
 
+      # The name of the MARC relator role
+      # @raises [KeyError] if the role is not valid
+      # @return [String, nil]
+      def marc_value
+        return unless marc_relator?
+
+        Role.marc_relators.fetch(code)
+      rescue
+        CocinaDisplay.notifier&.notify("Invalid marc relator: #{code}")
+        nil
+      end
+
+      # A code associated with the role, e.g. a MARC relator code.
+      # @return [String, nil]
+      def code
+        cocina["code"]
+      end
+
       # Does this role have a MARC relator code?
       # @return [Boolean]
       def marc_relator?

data/lib/cocina_display/dates/date.rb

@@ -11,6 +11,10 @@ module CocinaDisplay
       # List of values that we shouldn't even attempt to parse.
       UNPARSABLE_VALUES = ["0000-00-00", "9999", "uuuu", "[uuuu]"].freeze
 
+      def self.notifier
+        CocinaDisplay.notifier
+      end
+
       # Construct a Date from parsed Cocina data.
       # @param cocina [Hash] Cocina date data
       # @return [CocinaDisplay::Date]
@@ -75,6 +79,11 @@ module CocinaDisplay
       # @param value [String] the date value to modify
       # @return [String]
       def self.normalize_to_edtf(value)
+        unless value
+          notifier&.notify("Invalid date value: #{value}")
+          return
+        end
+
         sanitized = value.gsub(/^[\[]+/, "").gsub(/[\.\]]+$/, "")
         sanitized = value.rjust(4, "0") if /^\d{3}$/.match?(value)
 
@@ -110,6 +119,18 @@ module CocinaDisplay
         cocina["value"]
       end
 
+      # The string representation of the date for display.
+      # @return [String]
+      def to_s
+        qualified_value
+      end
+
+      # Label used to group the date for display.
+      # @return [String]
+      def label
+        cocina["displayLabel"].presence || type_label
+      end
+
       # The qualifier for this date, if any, such as "approximate", "inferred", etc.
       # @return [String, nil]
       def qualifier
@@ -183,14 +204,18 @@ module CocinaDisplay
       # @return [Symbol] :year, :month, :day, :decade, :century, or :unknown
       def precision
         return :unknown unless date_range || date
-
         if date_range.is_a? EDTF::Century
-          :century
+          return :century
         elsif date_range.is_a? EDTF::Decade
-          :decade
-        elsif date.is_a? EDTF::Season
+          return :decade
+        end
+
+        case date
+        when EDTF::Season
           :month
-        elsif date.is_a? EDTF::Interval
+        when EDTF::Unknown
+          :unknown
+        when EDTF::Interval
           date.precision
         else
           case date.precision
@@ -265,11 +290,11 @@ module CocinaDisplay
 
       # Decoded version of the date with "BCE" or "CE". Strips leading zeroes.
       # @param allowed_precisions [Array<Symbol>] List of allowed precisions for the output.
-      #   Defaults to [:day, :month, :year, :decade, :century].
+      #   Defaults to [:day, :month, :year, :decade, :century, :unknown].
       # @param ignore_unparseable [Boolean] Return nil instead of the original value if it couldn't be parsed
       # @param display_original_value [Boolean] Return the original value if it was not encoded
       # @return [String]
-      def decoded_value(allowed_precisions: [:day, :month, :year, :decade, :century], ignore_unparseable: false, display_original_value: true)
+      def decoded_value(allowed_precisions: [:day, :month, :year, :decade, :century, :unknown], ignore_unparseable: false, display_original_value: true)
         return if ignore_unparseable && !parsed_date?
         return value.strip unless parsed_date?
 
@@ -340,12 +365,13 @@ module CocinaDisplay
         # @param date [Date] The date to format.
         # @param precision [Symbol] The precision to format the date at, e.g. :month
         # @param allowed_precisions [Array<Symbol>] List of allowed precisions for the output.
-        #   Options are [:day, :month, :year, :decade, :century].
+        #   Options are [:day, :month, :year, :decade, :century, :unknown].
         # @note allowed_precisions should be ordered by granularity, with most specific first.
         def format_date(date, precision, allowed_precisions)
           precision = allowed_precisions.first unless allowed_precisions.include?(precision)
-
           case precision
+          when :unknown
+            "Unknown"
           when :day
             date.strftime("%B %e, %Y")
           when :month
@@ -378,8 +404,6 @@ module CocinaDisplay
         return nil if date.nil?
 
         case date_range
-        when EDTF::Unknown
-          nil
         when EDTF::Epoch, EDTF::Interval, EDTF::Season
           date_range.min
         when EDTF::Set
@@ -400,8 +424,6 @@ module CocinaDisplay
         return nil if date.nil?
 
         case date_range
-        when EDTF::Unknown
-          nil
         when EDTF::Epoch, EDTF::Interval, EDTF::Season
           date_range.max
         when EDTF::Set
@@ -439,18 +461,37 @@ module CocinaDisplay
           [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31][month]
         end
       end
+
+      # Label for the date based on its type.
+      # @example "publication" becomes "Publication date"
+      # @return [String]
+      def type_label
+        I18n.t(
+          type || "untyped",
+          scope: "cocina_display.field_label.event.date",
+          type: type&.capitalize,
+          default: [:default]
+        )
+      end
     end
 
     # Strict ISO8601-encoded date parser.
     class Iso8601Format < Date
       def self.parse_date(value)
         ::Date.parse(normalize_to_edtf(value))
+      rescue ::Date::Error
+        notifier&.notify("Invalid date value \"#{value}\" for iso8601 encoding")
+        nil
       end
     end
 
     # Less strict W3CDTF-encoded date parser.
     class W3cdtfFormat < Date
       def self.normalize_to_edtf(value)
+        unless value
+          notifier&.notify("Invalid date value: #{value}")
+          return
+        end
         super.gsub("-00", "")
       end
     end
@@ -503,7 +544,7 @@ module CocinaDisplay
     # Base class for date formats that match using a regex.
     class ExtractorDateFormat < Date
       def self.supports?(value)
-        value.match self::REGEX
+        self::REGEX.match?(value)
       end
     end
 

data/lib/cocina_display/dates/date_range.rb

@@ -1,5 +1,3 @@
-require_relative "date"
-
 module CocinaDisplay
   module Dates
     # A date range parsed from Cocina structuredValues.

data/lib/cocina_display/description/access.rb

@@ -0,0 +1,41 @@
+module CocinaDisplay
+  module Description
+    # Access information for a Cocina object.
+    class Access
+      attr_reader :cocina
+
+      # Create an Access object from Cocina structured data.
+      # @param cocina [Hash]
+      def initialize(cocina)
+        @cocina = cocina
+      end
+
+      # String representation of the access metadata.
+      # @return [String, nil]
+      def to_s
+        cocina["value"].presence
+      end
+
+      # The type of the access metadata, e.g. "repository".
+      # @return [String, nil]
+      def type
+        cocina["type"].presence
+      end
+
+      # The display label for the access metadata.
+      # @return [String]
+      def label
+        cocina["displayLabel"].presence ||
+          I18n.t(type&.parameterize&.underscore, default: :access, scope: "cocina_display.field_label.access")
+      end
+
+      # Whether the access info is a contact email.
+      # Always false, see CocinaDisplay::Description::AccessContact
+      # for cases when this is true
+      # @return [Boolean]
+      def contact_email?
+        false
+      end
+    end
+  end
+end

data/lib/cocina_display/description/access_contact.rb

@@ -0,0 +1,11 @@
+module CocinaDisplay
+  module Description
+    class AccessContact < Access
+      # Whether the access contact info is a contact email.
+      # @return [Boolean]
+      def contact_email?
+        type == "email"
+      end
+    end
+  end
+end

data/lib/cocina_display/description/url.rb

@@ -0,0 +1,17 @@
+module CocinaDisplay
+  module Description
+    class Url < Access
+      # The display label for the URL access metadata.
+      # @return [String]
+      def label
+        I18n.t(:url, scope: "cocina_display.field_label.access")
+      end
+
+      # The link text for the URL access metadata.
+      # @return [String, nil]
+      def link_text
+        cocina["displayLabel"].presence
+      end
+    end
+  end
+end