cocina_display 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f613a3974d14946081f09d45797c2be75475c2b37fedf4ebe51a9c7eef2de10
-  data.tar.gz: 6dc64d8348e652ac4bea87a904519029ed580cc498c6e584d2a196a079293141
+  metadata.gz: 46cfe681a820ad5986d0503157b5add9a8cb089af31e3afaba0ed2964d33bda6
+  data.tar.gz: b60af2ecc9cfdc031e57ae98cb1093aa3b111a5c14dda40b71814e07a9f2d941
 SHA512:
-  metadata.gz: 56874880d8a3fff624afb2306aeffab7792b59f678901a5f8632bd77beca3eeaab388053ddcc3790d6f1c5dfe687ee6588cd83eafe5cc143893eb8d551ed617f
-  data.tar.gz: d39907bb6d250a06ab01b5127fc98223ac6225e2e346ea9eaadaa91874ff20b807e2ded45453e5ed10cfb9515eba4b3da11ab5fb8ee7b42718ac670ab4cde95f
+  metadata.gz: 2c010edefb699c21c82a3c426befcb16e4fa0e72aeeda6e77c2ed8eba9fa1aa6e365e889fda6f94f6d118a3bde2a968e4ece610f918995721c14a1fc6fc5b723
+  data.tar.gz: fa61cbcd25787c2ec552fff17f5282e425ff5b46d03f0b60476c017faab41f7f059bd7630e54c2fc753a6330cf87a41c12bda20fbd3bd602e567264cfa6b133b

data/README.md

@@ -40,7 +40,7 @@ There is also a helper method to fetch the Cocina JSON for a given DRUID over HT
 The `CocinaRecord` class provides some methods to access common fields, as well as an underlying hash representation parsed from the JSON.
 
 ```ruby
-> record.main_title
+> record.short_title
 => "Bugatti Type 51A. Road & Track Salon January 1957"
 > record.content_type
 => "image"

data/lib/cocina_display/cocina_record.rb

@@ -51,17 +51,17 @@ module CocinaDisplay
     end
 
     # SDR content type of the object.
-    # @note {RelatedResource}s may not have a content type.
     # @return [String, nil]
     # @see https://github.com/sul-dlss/cocina-models/blob/main/openapi.yml#L532-L546
     # @example
     #  record.content_type #=> "image"
     def content_type
-      cocina_doc["type"].delete_prefix("https://cocina.sul.stanford.edu/models/")
+      cocina_doc["type"]&.delete_prefix("https://cocina.sul.stanford.edu/models/")
     end
 
     # Primary processing label for the object.
-    # @note This may or may not be the same as the title.
+    # @note For public Cocina fetched via PURL, this is generated at publish time from the title. It will have the same value as #display_title.
+    # @see https://github.com/sul-dlss/cocina_display/issues/205#issuecomment-3781393715
     # @return [String, nil]
     def label
       cocina_doc["label"]

data/lib/cocina_display/concerns/contributors.rb

@@ -27,6 +27,12 @@ module CocinaDisplay
         publisher_contributors.flat_map(&:display_names).compact
       end
 
+      # All names of authors, formatted for display.
+      # @return [Array<String>]
+      def author_names
+        author_contributors.flat_map(&:display_names).compact
+      end
+
       # All names of contributors who are people, formatted for display.
       # @param with_date [Boolean] Include life dates, if present
       # @return [Array<String>]
@@ -102,13 +108,18 @@ module CocinaDisplay
       end
 
       # All contributors for the object, including authors, editors, etc.
-      # Checks both description.contributor and description.event.contributor.
+      # @note Does not include contributors attached to events.
       # @return [Array<Contributor>]
       def contributors
-        @contributors ||= Enumerator::Chain.new(
-          path("$.description.contributor.*"),
-          path("$.description.event.*.contributor.*")
-        ).map { |c| CocinaDisplay::Contributors::Contributor.new(c) }
+        @contributors ||= path("$.description.contributor.*")
+          .map { |c| CocinaDisplay::Contributors::Contributor.new(c) }
+      end
+
+      # All contributors with an "author" role.
+      # @return [Array<Contributor>]
+      # @see Contributor#author?
+      def author_contributors
+        contributors.filter(&:author?)
       end
 
       # All contributors with a "publisher" role.
@@ -129,7 +140,8 @@ module CocinaDisplay
         contributors.find(&:primary?).presence || contributors.find { |c| !c.role? }.presence || contributors.first
       end
 
-      # All contributors except the main one.
+      # Contributors other than the main contributor.
+      # Also excludes the contributor (usually publisher) coming from an imprint event.
       # @return [Array<Contributor>]
       def additional_contributors
         return [] if contributors.empty? || contributors.one?

data/lib/cocina_display/concerns/events.rb

@@ -63,8 +63,8 @@ module CocinaDisplay
       # String for displaying the imprint statement(s).
       # @return [String, nil]
       # @see CocinaDisplay::Imprint#to_s
-      # @example
-      #   CocinaRecord.fetch('bt553vr2845').imprint_str #=> "New York : Meridian Book, 1993, c1967"
+      # @example bt553vr2845
+      # "New York : Meridian Book, 1993, c1967"
       def imprint_str
         imprint_events.map(&:to_s).compact_blank.join("; ")
       end
@@ -73,7 +73,14 @@ module CocinaDisplay
       # Considers locations for all publication, creation, and capture events.
       # @return [Array<String>]
       def publication_places
-        publication_events.flat_map { |event| event.locations.map(&:to_s) }
+        publication_events.flat_map { |event| event.locations.map(&:to_s) }.compact_blank.uniq
+      end
+
+      # List of countries of publication as strings.
+      # Considers locations for all publication, creation, and capture events.
+      # @return [Array<String>]
+      def publication_countries
+        publication_events.flat_map { |event| event.locations.map(&:country_name) }.compact_blank.uniq
       end
 
       # All root level events associated with the object.

data/lib/cocina_display/concerns/forms.rb

@@ -75,10 +75,16 @@ module CocinaDisplay
       end
 
       # All form notes to be rendered for display.
+      # Checks both description.form.note and description.geographic.form.note.
       # @return [Array<DisplayData>]
       def form_note_display_data
-        CocinaDisplay::DisplayData.from_cocina(path("$.description.form[*].note[*]"),
-          label: I18n.t("cocina_display.field_label.form.note"))
+        CocinaDisplay::DisplayData.from_cocina(
+          Enumerator::Chain.new(
+            path("$.description.form.*.note.*"),
+            path("$.description.geographic.*.form.*.note.*")
+          ),
+          label: I18n.t("cocina_display.field_label.form.note")
+        )
       end
 
       # Is the object a periodical or serial?
@@ -106,10 +112,14 @@ module CocinaDisplay
       end
 
       # Collapses all nested form values into an array of {Form} objects.
+      # Checks both description.form and description.geographic.form.
       # Preserves resource type without flattening, since it can be structured.
       # @return [Array<Form>]
       def all_forms
-        @all_forms ||= path("$.description.form.*")
+        @all_forms ||= Enumerator::Chain.new(
+          path("$.description.form.*"),
+          path("$.description.geographic.*.form.*")
+        )
           .flat_map { |form| Utils.flatten_nested_values(form, atomic_types: ["resource type"]) }
           .map { |form| CocinaDisplay::Forms::Form.from_cocina(form) }
       end

data/lib/cocina_display/concerns/structural.rb

@@ -36,6 +36,25 @@ module CocinaDisplay
       def total_file_size_int
         files.pluck("size").sum
       end
+
+      # DRUIDs of collections this object is a member of.
+      # @return [Array<String>]
+      # @example ["sj775xm6965"]
+      def containing_collections
+        path("$.structural.isMemberOf.*").map { |druid| druid.delete_prefix("druid:") }
+      end
+
+      def virtual_object?
+        return false if path("$.structural.contains.*").any?
+
+        path("$.structural.hasMemberOrders.*.members.*").any?
+      end
+
+      def virtual_object_members
+        return [] unless virtual_object?
+
+        path("$.structural.hasMemberOrders.*.members.*").map { |druid| druid.delete_prefix("druid:") }
+      end
     end
   end
 end

data/lib/cocina_display/concerns/titles.rb

@@ -2,11 +2,11 @@ module CocinaDisplay
   module Concerns
     # Methods for finding and formatting titles.
     module Titles
-      # The main title for the object, without subtitle, part name, etc.
+      # The short title for the object, without subtitle, part name, etc.
       # If there are multiple primary titles, uses the first.
-      # @see CocinaDisplay::Title#main_title
+      # @see CocinaDisplay::Title#short_title
       # @return [String, nil]
-      def main_title
+      def short_title
         primary_title&.short_title
       end
 

data/lib/cocina_display/concerns/url_helpers.rb

@@ -3,7 +3,7 @@ module CocinaDisplay
     # Methods that generate URLs to access an object.
     module UrlHelpers
       # The PURL URL for this object.
-      # @return [String]
+      # @return [String, nil]
       # @example
       #  record.purl_url #=> "https://purl.stanford.edu/bx658jh7339"
       def purl_url
@@ -13,8 +13,7 @@ module CocinaDisplay
       # The oEmbed URL for the object, optionally with additional parameters.
       # Corresponds to the PURL environment.
       # @param params [Hash] Additional parameters to include in the oEmbed URL.
-      # @return [String]
-      # @return [nil] if the object is a collection.
+      # @return [String, nil]
       # @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: {})
@@ -26,17 +25,18 @@ module CocinaDisplay
 
       # The download URL to get the entire object as a .zip file.
       # Stacks generates the .zip for the object on request.
-      # @return [String]
+      # @note Collections and related resources do not have a download URL.
+      # @return [String, nil]
       # @example
       #   record.download_url #=> "https://stacks.stanford.edu/object/bx658jh7339"
       def download_url
-        "#{stacks_base_url}/object/#{bare_druid}" if bare_druid.present?
+        "#{stacks_base_url}/object/#{bare_druid}" if is_a?(CocinaDisplay::CocinaRecord) && bare_druid.present? && !collection?
       end
 
       # The IIIF manifest URL for the object.
       # PURL generates the IIIF manifest.
       # @param version [Integer] The IIIF presentation spec version to use (3 or 2).
-      # @return [String]
+      # @return [String, nil]
       # @example
       #  record.iiif_manifest_url #=> "https://purl.stanford.edu/bx658jh7339/iiif3/manifest"
       def iiif_manifest_url(version: 3)
@@ -44,11 +44,22 @@ module CocinaDisplay
         "#{purl_url}/#{iiif_path}/manifest" if purl_url.present?
       end
 
+      # The Searchworks URL for this object.
+      # Uses the catkey (FOLIO HRID) if present, otherwise uses the druid.
+      # @note This does not guarantee that the object is actually in Searchworks.
+      # @return [String, nil]
+      # @example
+      #  record.searchworks_url #=> "https://searchworks.stanford.edu/view/bx658jh7339"
+      def searchworks_url
+        return "#{searchworks_base_url}/view/#{folio_hrid}" if folio_hrid.present?
+        "#{searchworks_base_url}/view/#{bare_druid}" if bare_druid.present?
+      end
+
       private
 
       # The URL to the PURL environment this object is from.
       # @note Objects accessed via UAT will still have a production PURL base URL.
-      # @return [String]
+      # @return [String, nil]
       # @example
       #   record.purl_base_url #=> "https://purl.stanford.edu"
       def purl_base_url
@@ -58,7 +69,7 @@ module CocinaDisplay
       # The URL to the stacks environment this object is shelved in.
       # Corresponds to the PURL environment.
       # @see purl_base_url
-      # @return [String]
+      # @return [String, nil]
       # @example
       #  record.stacks_base_url #=> "https://stacks.stanford.edu"
       def stacks_base_url
@@ -68,6 +79,20 @@ module CocinaDisplay
           "https://stacks.stanford.edu"
         end
       end
+
+      # The URL to the Searchworks environment this object could be found in.
+      # Corresponds to the PURL environment.
+      # @see purl_base_url
+      # @return [String, nil]
+      # @example
+      #  record.searchworks_base_url #=> "https://searchworks.stanford.edu"
+      def searchworks_base_url
+        if purl_base_url == "https://sul-purl-stage.stanford.edu"
+          "https://searchworks-stage.stanford.edu"
+        elsif purl_base_url.present?
+          "https://searchworks.stanford.edu"
+        end
+      end
     end
   end
 end

data/lib/cocina_display/contributors/contributor.rb

@@ -72,6 +72,13 @@ module CocinaDisplay
         roles.any?
       end
 
+      # String representation of the contributor's role(s).
+      # @return [String, nil]
+      # @example "author, editor, publisher"
+      def display_role
+        roles.map(&:to_s).join(", ") if role?
+      end
+
       # The primary display name for the contributor as a string.
       # @param with_date [Boolean] Include life dates, if present
       # @return [String, nil]

data/lib/cocina_display/events/location.rb

@@ -22,7 +22,7 @@ module CocinaDisplay
       # Decodes a MARC country code if present and no value was present.
       # @return [String, nil]
       def to_s
-        cocina["value"] || decoded_country
+        cocina["value"] || country_name
       end
 
       # Is there an unencoded value (name) for this location?
@@ -31,6 +31,12 @@ module CocinaDisplay
         cocina["value"].present?
       end
 
+      # Decoded country name if the location is encoded with a MARC country code.
+      # @return [String, nil]
+      def country_name
+        Location.marc_countries[code] if marc_country? && valid_country_code?
+      end
+
       private
 
       # A code, like a MARC country code, representing the location.
@@ -39,12 +45,6 @@ module CocinaDisplay
         cocina["code"]
       end
 
-      # Decoded country name if the location is encoded with a MARC country code.
-      # @return [String, nil]
-      def decoded_country
-        Location.marc_countries[code] if marc_country? && valid_country_code?
-      end
-
       # Is this a decodable country code?
       # Excludes blank values and "xx" (unknown) and "vp" (various places).
       # @return [Boolean]

data/lib/cocina_display/json_backed_record.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 module CocinaDisplay
+  # Superclass for metadata records backed by a Cocina JSON document.
   class JsonBackedRecord
     # The parsed Cocina document.
     # @return [Hash]
     attr_reader :cocina_doc
 
-    # Initialize a CocinaRecord with a Cocina document hash.
+    # Initialize a record with a Cocina document hash.
     # @param cocina_doc [Hash]
     def initialize(cocina_doc)
       @cocina_doc = cocina_doc
@@ -23,5 +24,22 @@ module CocinaDisplay
     def path(path_expression)
       Janeway.enum_for(path_expression, cocina_doc)
     end
+
+    # Flattened, normalized aggregation of all node texts in the Cocina document.
+    # @note Used for 'all search' fields in indexing.
+    # @return [String]
+    def text
+      node_texts.compact.join(" ").gsub(/\s+/, " ").strip
+    end
+
+    private
+
+    # Array of all node values/codes except those under "source" keys.
+    # Used to build flattened text representation.
+    # @note Source values are omitted because they usually indicate ontologies/vocabularies.
+    # @return [Array<String>]
+    def node_texts
+      path("$..['code', 'value']").map { |node, _p, _i, path| node unless path.to_s.include?("['source']") }
+    end
   end
 end

data/lib/cocina_display/title.rb

@@ -61,15 +61,14 @@ module CocinaDisplay
     # 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]"
+    # @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.
+    # The long form of the title, without trailing punctuation.
     # @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
@@ -81,7 +80,7 @@ module CocinaDisplay
     def sort_title
       return "\u{10FFFF}" unless full_title
 
-      sort_title_str
+      full_title[nonsorting_chars_str.length..]
         .unicode_normalize(:nfd) # Prevent accents being stripped
         .gsub(/[[:punct:]]*/, "")
         .gsub(/\W{2,}/, " ")  # Collapse whitespace after removing punctuation
@@ -90,37 +89,33 @@ module CocinaDisplay
 
     private
 
-    # Generate the short title by joining main title and nonsorting characters with spaces.
+    # Generate the short title by joining main title and nonsorting characters.
     # @return [String, nil]
     def short_title_str
-      Utils.compact_and_join([nonsorting_chars_str, main_title_str])
+      nonsorting_chars_str + main_title_str # pre-formatted padding
     end
 
-    # Generate the full title by joining all title components with spaces.
+    # Generate the full title by joining all title components with punctuation.
     # @return [String, nil]
     def full_title_str
-      nonsorting_chars_str + sort_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
 
-    # 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])
+    # 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
 
-    # 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 ". "
+    # The main title and subtitle, joined together with a colon.
     # @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
+    def main_subtitle_str
+      Utils.compact_and_join([main_title_str, subtitle_str], delimiter: " : ")
     end
 
     # All nonsorting characters joined together with padding applied.
@@ -142,15 +137,14 @@ module CocinaDisplay
       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.
+    # The part name, number, and label components, joined together with commas.
     # @return [String, nil]
-    def parts_str(delimiter: " ")
+    def parts_str
       Utils.compact_and_join(
         Array(title_components["part number"] || @part_numbers) +
         Array(title_components["part name"]) +
         [@part_label],
-        delimiter: delimiter
+        delimiter: ", "
       )
     end
 
@@ -198,8 +192,6 @@ module CocinaDisplay
       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]

data/lib/cocina_display/version.rb

@@ -2,5 +2,5 @@
 
 # :nodoc:
 module CocinaDisplay
-  VERSION = "1.5.0" # :nodoc:
+  VERSION = "1.7.0" # :nodoc:
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cocina_display
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Nick Budak
 bindir: exe
 cert_chain: []
-date: 2025-12-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: janeway-jsonpath
@@ -296,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Helpers for rendering Cocina metadata
 test_files: []