cocina_display 1.12.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2310483e28449dd22935fae9e5e19097c69d133cf0e393f45a5a2d9f6b0d2182
-  data.tar.gz: e63dd927ad075874c6f8b1b5ba5344be97d6bb659ebde892f7fd05220f874c7e
+  metadata.gz: f3f339ed91ca38de77fe91e83e50ba0dbdae117c810b831ed7597181b949dab7
+  data.tar.gz: 10e954dc692155b1c2ea3e219840431b4bae188b09399060973bc873b5dc9d63
 SHA512:
-  metadata.gz: c9e72b785cdef2be3ff32d5b2ae06863a0385d9c48f70c888c9296bf8ecee6b1762cd155b8eb1ca2cbed2ada8ec6867ee7b7675de37be24c3ca823a3fbc6924b
-  data.tar.gz: 0bfde5b69633b904e244be9728d225672a80392702878972a981c2c857201cf1a3940256b4c015bc6a97bd04abb0b2241bf2e8c3284ddd29d35565aec09249fc
+  metadata.gz: 04f6b7138b9079fb12f9455e5363fce77743f19e0ae30aa01a2d13a567182d184475304316bfa81d720970cbab77ac7d8854f29e62bbcf15df43cf95593898eb
+  data.tar.gz: 791231009d1e945f959bae16095d022306052bf0a8a02fe76f3d722343e79434469fd1bf5e32309a638afda378a8070e7f8dd259adce155106c307808a1602c4

data/config/locales/en.yml

@@ -16,6 +16,8 @@ en:
           default: Imprint note
           edition: Edition
           issuance: Issuance
+          frequency: Frequency
+          copyright_statement: Copyright statement
       form:
         digital_origin: Digital origin
         extent: Extent
@@ -66,7 +68,7 @@ en:
         point_coordinates: Map data
         subject: Subject
         topic: Subject
-      use_and_reproduction: Use and reproduction statement
+      use_and_reproduction: Use and reproduction
       related_resource:
         described_by: Described by
         describes: Describes

data/lib/cocina_display/concerns/contributors.rb

@@ -61,18 +61,19 @@ module CocinaDisplay
       end
 
       # A hash mapping role names to the names of contributors with that role.
+      # Contributors with no role are grouped under a nil key.
       # @param with_date [Boolean] Include life dates, if present
-      # @return [Hash<String, Array<String>>]
+      # @return [Hash<[String,NilClass], Array<String>>]
       def contributor_names_by_role(with_date: false)
-        contributors_by_role(with_date: with_date)
+        contributors_by_role
           .transform_values { |contributor_list| contributor_list.flat_map { |contributor| contributor.display_names(with_date: with_date) }.compact_blank }
           .compact_blank
       end
 
-      # A hash mapping role names to the names of contributors with that role.
-      # @param with_date [Boolean] Include life dates, if present
+      # A hash mapping role names to the Contributor objects with that role.
+      # Contributors with no role are grouped under a nil key.
       # @return [Hash<[String,NilClass], Array<Contributor>>]
-      def contributors_by_role(with_date: false)
+      def contributors_by_role
         @contributors_by_role ||= contributors.each_with_object({}) do |contributor, hash|
           if contributor.roles.empty?
             hash[nil] ||= []
@@ -86,12 +87,11 @@ module CocinaDisplay
         end
       end
 
-      # DisplayData for Contributors, one per role (excluding publisher).
+      # DisplayData for Contributors, one per role.
       # Contributors with no role are grouped under a default heading.
-      # @note For displaying publisher information, use {publication_display_data}.
       # @return [Array<DisplayData>]
       def contributor_display_data
-        contributors_by_role.except("publisher").map do |role, contributors|
+        contributors_by_role.map do |role, contributors|
           label = I18n.t(role, scope: "cocina_display.contributor.role",
             default: role&.capitalize || I18n.t("default", scope: "cocina_display.contributor.role"))
           DisplayData.new(label: label, objects: contributors)

data/lib/cocina_display/concerns/events.rb

@@ -50,15 +50,56 @@ module CocinaDisplay
       # Prefers dates marked as primary and those with a declared encoding.
       # @param ignore_qualified [Boolean] Reject qualified dates (e.g. approximate)
       # @return [String, nil]
-      # @example Year range
-      #  CocinaRecord.fetch('bb099mt5053').pub_year_str #=> "1932 - 2012"
+      # @example Year with month and day, 2024-08-21 (vc109xd3118)
+      #   "2024"
+      # @example Approximate year range, [ca. 1932 - 2012] (bb099mt5053)
+      #   "1932 - 2012"
+      # @example BCE year range, [ca. 3500 BCE] - 3101 BCE (yv690gn5376)
+      #   "3500 BCE - 3101 BCE"
+      # @example Unencoded string, 'about 933'
+      #   "933 CE"
+      # @example Not parsable, 'invalid-date'
+      #   nil
       def pub_year_str(ignore_qualified: false)
         date = pub_date(ignore_qualified: ignore_qualified)
-        return unless date
+        return unless date&.parsed_date?
 
         date.decoded_value(allowed_precisions: [:year, :decade, :century])
       end
 
+      # String for sorting lexicographically by publication date.
+      # Considers publication, creation, and capture dates in that order.
+      # Prefers dates marked as primary and those with a declared encoding.
+      # @note BCE dates have special handling; see Date#sort_key for details.
+      # @param ignore_qualified [Boolean] Reject qualified dates (e.g. approximate)
+      # @return [String, nil]
+      # @example Year with month and day, 2024-08-21 (vc109xd3118)
+      #   "20240821"
+      # @example Approximate year range, [ca. 1932 - 2012] (bb099mt5053)
+      #   "1932000020120000"
+      # @example BCE year range, [ca. 3500 BCE] - 3101 BCE (yv690gn5376)
+      #   "-564990000-568980000"
+      def pub_date_sort_str(ignore_qualified: false)
+        pub_date(ignore_qualified: ignore_qualified)&.sort_key
+      end
+
+      # String for displaying the publication date.
+      # Considers publication, creation, and capture dates in that order.
+      # Prefers dates marked as primary and those with a declared encoding.
+      # If not encoded, returns the original string value from the Cocina.
+      # @return [String, nil]
+      # @example w3cdtf encoded year with month and day (vc109xd3118)
+      #   "August 21, 2024"
+      # @example w3cdtf encoded approximate year range (bb099mt5053)
+      #   "[ca. 1932 - 2012]"
+      # @example Unencoded string, 'about 933'
+      #   "about 933"
+      # @example Not parsable, 'invalid-date'
+      #   "invalid-date"
+      def pub_date_str
+        pub_date&.to_s
+      end
+
       # String for displaying the imprint statement(s).
       # @return [String, nil]
       # @see CocinaDisplay::Imprint#to_s
@@ -108,13 +149,7 @@ module CocinaDisplay
       # Prefers events where the date was not encoded, if any.
       # @return [Array<CocinaDisplay::Imprint>] The list of Imprint objects
       def imprint_events
-        imprints = events.filter do |event|
-          event.has_any_type?("publication", "creation", "capture", "copyright")
-        end.map do |event|
-          CocinaDisplay::Events::Imprint.new(event.cocina)
-        end
-
-        imprints.reject(&:date_encoding?).presence || imprints
+        events.filter(&:imprint?)
       end
 
       # All dates associated with the object via an event.
@@ -123,23 +158,16 @@ module CocinaDisplay
         @event_dates ||= events.flat_map(&:dates)
       end
 
-      # DisplayData for all notes associated with events.
-      # @return [Array<CocinaDisplay::DisplayData>]
-      def event_note_display_data
-        CocinaDisplay::DisplayData.from_objects(events.flat_map(&:notes))
-      end
-
-      # DisplayData for all dates associated with events.
+      # DisplayData for all events associated with the object.
       # @return [Array<CocinaDisplay::DisplayData>]
-      def event_date_display_data
-        CocinaDisplay::DisplayData.from_objects(event_dates)
+      def event_display_data
+        CocinaDisplay::DisplayData.from_objects(events)
       end
 
-      # DisplayData for publisher and publication place.
+      # DisplayData for issuance, copyright, and other notes associated with events.
       # @return [Array<CocinaDisplay::DisplayData>]
-      def publication_display_data
-        CocinaDisplay::DisplayData.from_strings(publication_places, label: "Place") +
-          CocinaDisplay::DisplayData.from_strings(publisher_names, label: "Publisher")
+      def event_note_display_data
+        CocinaDisplay::DisplayData.from_objects(events.flat_map(&:notes))
       end
 
       # The earliest preferred publication date as a CocinaDisplay::Dates::Date object.

data/lib/cocina_display/dates/date.rb

@@ -9,6 +9,8 @@ module CocinaDisplay
   module Dates
     # A date to be converted to a Date object.
     class Date
+      include Comparable
+
       # List of values that we shouldn't even attempt to parse.
       UNPARSABLE_VALUES = ["0000-00-00", "9999", "uuuu", "[uuuu]"].freeze
 
@@ -110,6 +112,8 @@ module CocinaDisplay
       end
 
       # Compare this date to another {Date} or {DateRange} using its {sort_key}.
+      # @note Also supports `date1.between?(date2, date3)` via {Comparable}.
+      # @return [Integer, nil]
       def <=>(other)
         sort_key <=> other.sort_key if other.is_a?(Date) || other.is_a?(DateRange)
       end
@@ -121,9 +125,14 @@ module CocinaDisplay
       end
 
       # The string representation of the date for display.
+      # Uses the raw value if the date was not encoded or couldn't be parsed.
       # @return [String]
       def to_s
-        qualified_value
+        if !parsed_date? || (!encoding? && value !~ /^-?\d+$/ && value !~ /^[\dXxu?-]{4}$/)
+          value.strip
+        else
+          qualified_value
+        end
       end
 
       # Label used to group the date for display.
@@ -300,9 +309,6 @@ module CocinaDisplay
       #   Defaults to [:day, :month, :year, :decade, :century, :unknown].
       # @return [String]
       def decoded_value(allowed_precisions: [:day, :month, :year, :decade, :century, :unknown])
-        if !parsed_date? || (!encoding? && value !~ /^-?\d+$/ && value !~ /^[\dXxu?-]{4}$/)
-          return value.strip
-        end
         if date.is_a?(EDTF::Interval)
           range = [
             Date.format_date(date.min, date.min.precision, allowed_precisions),
@@ -377,7 +383,7 @@ module CocinaDisplay
           when :unknown
             "Unknown"
           when :day
-            date.strftime("%B %e, %Y")
+            date.strftime("%B %-d, %Y")
           when :month
             date.strftime("%B %Y")
           when :year

data/lib/cocina_display/dates/date_range.rb

@@ -40,11 +40,11 @@ module CocinaDisplay
         @type = cocina["type"]
       end
 
-      # The values of the start and stop dates as an array.
+      # The joined values of the start and stop dates.
       # @see CocinaDisplay::Date#value
-      # @return [Array<String>]
+      # @return [String]
       def value
-        [start&.value, stop&.value].compact
+        [start&.value, stop&.value].compact.uniq.join(" - ").strip
       end
 
       # Key used to sort this date range. Respects BCE/CE ordering and precision.
@@ -52,7 +52,7 @@ module CocinaDisplay
       # @see CocinaDisplay::Date#sort_key
       # @return [String]
       def sort_key
-        [start&.sort_key, stop&.sort_key].compact.join(" - ")
+        [start&.sort_key, stop&.sort_key].compact.join
       end
 
       # Base values of start/end as single string. Used for comparison/deduping.
@@ -133,7 +133,7 @@ module CocinaDisplay
             "[#{decoded_value}]"
           end
         else
-          "#{start&.qualified_value} - #{stop&.qualified_value}"
+          [start&.qualified_value, stop&.qualified_value].uniq.join(" - ").strip
         end
       end
 

data/lib/cocina_display/events/event.rb

@@ -2,6 +2,8 @@ module CocinaDisplay
   module Events
     # An event associated with an object, like publication.
     class Event
+      include Comparable
+
       attr_reader :cocina
 
       # Initialize the event with Cocina event data.
@@ -10,6 +12,26 @@ module CocinaDisplay
         @cocina = cocina
       end
 
+      # Compare this {Event} to another {Event} using their {Date}s.
+      # @note Also supports `event1.between?(event2, event3)` via {Comparable}.
+      # @return [Integer, nil]
+      def <=>(other)
+        [unique_dates_for_display] <=> [other.unique_dates_for_display] if other.is_a?(Event)
+      end
+
+      # The display label for the event.
+      # Uses "Imprint" if the event is likely to represent an imprint statement.
+      # If the event consists solely of a date, uses the date's label.
+      # Capitalizes the event's type, or its first date's type if untyped.
+      # @return [String]
+      def label
+        return cocina["displayLabel"] if cocina["displayLabel"].present?
+        return "Imprint" if imprint?
+        return dates.map(&:label).first if date_only?
+
+        type&.capitalize || date_types.first&.capitalize || "Event"
+      end
+
       # The declared type of the event, like "publication" or "creation".
       # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#event-types
       # @note This can differ from the contained date types.
@@ -30,7 +52,7 @@ module CocinaDisplay
       # @param match_type [String] The type to check against
       # @return [Boolean]
       def has_type?(match_type)
-        [type, *date_types].compact.include?(match_type)
+        types.include?(match_type)
       end
 
       # True if the event or its dates have any of the provided types.
@@ -54,6 +76,13 @@ module CocinaDisplay
         end
       end
 
+      # True if this event is likely to represent an imprint.
+      # @note Unencoded dates or no dates often indicate an imprint statement.
+      # @return [Boolean]
+      def imprint?
+        (has_type?("publication") || types.empty?) && (dates.none?(&:encoding?) || dates.none?)
+      end
+
       # All contributors associated with this event.
       # @return [Array<CocinaDisplay::Contributor>]
       def contributors
@@ -77,6 +106,97 @@ module CocinaDisplay
           CocinaDisplay::Events::Note.new(note)
         end
       end
+
+      # String representation of the event using edition, dates, locations, and contributors.
+      # Format is inspired by typical imprint statements for books.
+      # @return [String]
+      # @example "2nd ed. - New York : John Doe, 1999"
+      def to_s
+        place_contrib = Utils.compact_and_join([place_str, contributor_str], delimiter: " : ")
+        note_place_contrib = Utils.compact_and_join([edition_note_str, place_contrib], delimiter: " - ")
+        Utils.compact_and_join([note_place_contrib, date_str, copyright_note_str], delimiter: ", ")
+      end
+
+      # Filter dates for uniqueness using base value according to predefined rules.
+      # 1. For a group of dates with the same base value, choose a single one
+      # 2. Prefer unencoded dates over encoded ones when choosing a single date
+      # 3. Remove date ranges that duplicate any unencoded non-range dates
+      # @return [Array<CocinaDisplay::Dates::Date>]
+      # @see CocinaDisplay::Dates::Date#base_value
+      # @see https://consul.stanford.edu/display/chimera/MODS+display+rules#MODSdisplayrules-3b.%3CoriginInfo%3E
+      def unique_dates_for_display
+        # Choose a single date for each group with the same base value
+        deduped_dates = dates.group_by(&:base_value).map do |base_value, group|
+          if (unencoded = group.reject(&:encoding?)).any?
+            unencoded.first
+          else
+            group.first
+          end
+        end
+
+        # Remove any ranges that duplicate part of an unencoded non-range date
+        ranges, singles = deduped_dates.partition { |date| date.is_a?(CocinaDisplay::Dates::DateRange) }
+        unencoded_singles_dates = singles.reject(&:encoding?).flat_map(&:to_a)
+        ranges.reject! { |date_range| unencoded_singles_dates.any? { |date| date_range.as_range.include?(date) } }
+
+        (singles + ranges).sort
+      end
+
+      # Filter locations to display according to predefined rules.
+      # 1. Prefer unencoded locations (plain value) over encoded ones
+      # 2. If no unencoded locations but there are MARC country codes, decode them
+      # 3. Keep only unique locations after decoding
+      def locations_for_display
+        unencoded_locs, encoded_locs = locations.partition { |loc| loc.unencoded_value? }
+        locs_for_display = unencoded_locs.presence || encoded_locs
+        locs_for_display.map(&:to_s).compact_blank.uniq
+      end
+
+      # Union of event's type and its date types.
+      # Used for imprint detection and display decisions.
+      # @return [Array<String>]
+      def types
+        [type, *date_types].compact
+      end
+
+      private
+
+      # Does this event include no rendered information other than its date?
+      # @note If true, the label will be "[type] date" instead of just "[type]".
+      # @return [Boolean]
+      def date_only?
+        to_s == date_str
+      end
+
+      # The date portion of the imprint statement, comprising all unique dates.
+      # @return [String]
+      def date_str
+        Utils.compact_and_join(unique_dates_for_display.map(&:to_s), delimiter: "; ")
+      end
+
+      # Edition notes associated with the event as a single string.
+      # @return [String]
+      def edition_note_str
+        Utils.compact_and_join(notes.filter { |note| note.type == "edition" }.map(&:to_s), delimiter: ", ")
+      end
+
+      # Copyright notes associated with the event as a single string.
+      # @return [String]
+      def copyright_note_str
+        Utils.compact_and_join(notes.filter { |note| note.type == "copyright statement" }.map(&:to_s), delimiter: ", ")
+      end
+
+      # All contributors associated with the event as a single string.
+      # @return [String]
+      def contributor_str
+        Utils.compact_and_join(contributors.map(&:display_name), delimiter: " : ")
+      end
+
+      # The place of publication, combining all location values.
+      # @return [String]
+      def place_str
+        Utils.compact_and_join(locations_for_display, delimiter: " : ")
+      end
     end
   end
 end

data/lib/cocina_display/events/note.rb

@@ -10,9 +10,21 @@ module CocinaDisplay
         @cocina = cocina
       end
 
-      # The value of the note.
+      # Contents of the note.
+      # @note Issuance and frequency notes are lowercased for consistency.
       # @return [String, nil]
       def to_s
+        case type
+        when "issuance", "frequency"
+          value&.downcase
+        else
+          value
+        end
+      end
+
+      # The contents of the note.
+      # @return [String, nil]
+      def value
         cocina["value"].presence
       end
 

data/lib/cocina_display/identifier.rb

@@ -33,7 +33,7 @@ module CocinaDisplay
     # Prefers the URI representation where present.
     # @return [String, nil]
     def value
-      cocina["uri"].presence || cocina["value"].presence
+      cocina["uri"] || cocina["value"]
     end
 
     # The "identifying" part of the identifier.
@@ -42,7 +42,18 @@ module CocinaDisplay
     #   10.1234/doi
     # @return [String, nil]
     def identifier
-      URI(value).path.delete_prefix("/") if value
+      # the uri property is a valid uri, but the value isn't necessarily a valid uri
+      uri = if cocina["uri"]
+        URI(cocina["uri"])
+      elsif cocina["value"]
+        begin
+          URI(cocina["value"])
+        rescue URI::InvalidURIError
+          nil
+        end
+      end
+
+      uri&.path&.delete_prefix("/")
     end
 
     # The identifier as a URI, if available.

data/lib/cocina_display/related_resource.rb

@@ -55,11 +55,15 @@ module CocinaDisplay
     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 + identifier_display_data
+      title_display_data +
+        contributor_display_data +
+        event_display_data +
+        general_note_display_data +
+        preferred_citation_display_data +
+        access_display_data +
+        identifier_display_data
     end
 
     private

data/lib/cocina_display/subjects/subject_value.rb

@@ -103,7 +103,7 @@ module CocinaDisplay
 
       # @return [String] The formatted date/time string for display
       def to_s
-        date.qualified_value
+        date.to_s
       end
     end
 

data/lib/cocina_display/version.rb

@@ -2,5 +2,5 @@
 
 # :nodoc:
 module CocinaDisplay
-  VERSION = "1.12.2" # :nodoc:
+  VERSION = "2.0.0" # :nodoc:
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cocina_display
 version: !ruby/object:Gem::Version
-  version: 1.12.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Nick Budak
 bindir: exe
 cert_chain: []
-date: 2026-03-06 00:00:00.000000000 Z
+date: 2026-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: janeway-jsonpath
@@ -269,7 +269,6 @@ files:
 - 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

data/lib/cocina_display/events/imprint.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-module CocinaDisplay
-  module Events
-    # Wrapper for Cocina events used to generate an imprint statement for display.
-    class Imprint < Event
-      # The entire imprint statement formatted as a string for display.
-      # @return [String]
-      def to_s
-        place_pub = Utils.compact_and_join([place_str, publisher_str], delimiter: " : ")
-        edition_place_pub = Utils.compact_and_join([edition_str, place_pub], delimiter: " - ")
-        Utils.compact_and_join([edition_place_pub, date_str], delimiter: ", ")
-      end
-
-      # Were any of the dates encoded?
-      # Used to detect which event(s) most likely represent the actual imprint(s).
-      def date_encoding?
-        dates.any?(&:encoding?)
-      end
-
-      private
-
-      # The date portion of the imprint statement, comprising all unique dates.
-      # @return [String]
-      def date_str
-        Utils.compact_and_join(unique_dates_for_display.map(&:qualified_value), delimiter: "; ")
-      end
-
-      # The editions portion of the imprint statement, combining all edition notes.
-      # @return [String]
-      def edition_str
-        Utils.compact_and_join(Janeway.enum_for("$.note[?@.type == 'edition'].value", cocina))
-      end
-
-      # The place of publication, combining all location values.
-      # @return [String]
-      def place_str
-        Utils.compact_and_join(locations_for_display, delimiter: " : ")
-      end
-
-      # The publisher information, combining all name values for publishers.
-      # @return [String]
-      def publisher_str
-        Utils.compact_and_join(publishers.map(&:display_name), delimiter: " : ")
-      end
-
-      # All publishers associated with this imprint.
-      # @return [Array<CocinaDisplay::Contributor>]
-      # @see CocinaDisplay::Contributor#publisher?
-      def publishers
-        contributors.filter(&:publisher?)
-      end
-
-      # Filter dates for uniqueness using base value according to predefined rules.
-      # 1. For a group of dates with the same base value, choose a single one
-      # 2. Prefer unencoded dates over encoded ones when choosing a single date
-      # 3. Remove date ranges that duplicate any unencoded non-range dates
-      # @return [Array<CocinaDisplay::Dates::Date>]
-      # @see CocinaDisplay::Dates::Date#base_value
-      # @see https://consul.stanford.edu/display/chimera/MODS+display+rules#MODSdisplayrules-3b.%3CoriginInfo%3E
-      def unique_dates_for_display
-        # Choose a single date for each group with the same base value
-        deduped_dates = dates.group_by(&:base_value).map do |base_value, group|
-          if (unencoded = group.reject(&:encoding?)).any?
-            unencoded.first
-          else
-            group.first
-          end
-        end
-
-        # Remove any ranges that duplicate part of an unencoded non-range date
-        ranges, singles = deduped_dates.partition { |date| date.is_a?(CocinaDisplay::Dates::DateRange) }
-        unencoded_singles_dates = singles.reject(&:encoding?).flat_map(&:to_a)
-        ranges.reject! { |date_range| unencoded_singles_dates.any? { |date| date_range.as_range.include?(date) } }
-
-        (singles + ranges).sort
-      end
-
-      # Filter locations to display according to predefined rules.
-      # 1. Prefer unencoded locations (plain value) over encoded ones
-      # 2. If no unencoded locations but there are MARC country codes, decode them
-      # 3. Keep only unique locations after decoding
-      def locations_for_display
-        unencoded_locs, encoded_locs = locations.partition { |loc| loc.unencoded_value? }
-        locs_for_display = unencoded_locs.presence || encoded_locs
-        locs_for_display.map(&:to_s).compact_blank.uniq
-      end
-    end
-  end
-end