cocina_display 1.1.3 → 1.2.0

data/lib/cocina_display/concerns/forms.rb

@@ -6,18 +6,24 @@ module CocinaDisplay
     module Forms
       # Resource types of the object, expressed in SearchWorks controlled vocabulary.
       # @return [Array<String>]
-      def resource_types
+      def searchworks_resource_types
         mapped_values = resource_type_values.flat_map { |resource_type| searchworks_resource_type(resource_type) }
         mapped_values << "Dataset" if dataset?
         mapped_values.uniq
       end
 
+      # Resource types of the object, expressed in SearchWorks controlled vocabulary.
+      # @return [Array<String>]
+      def mods_resource_types
+        all_resource_types.select { |type| type.mods? }.map(&:to_s)
+      end
+
       # Physical or digital forms of the object.
       # @return [Array<String>]
       # @example GIS dataset (nz187ct8959)
       #   record.forms #=> ["map", "optical disc", "electronic resource"]
       def forms
-        path("$.description.form..[?@.type == 'form'].value").uniq
+        form_forms.map(&:to_s).compact_blank.uniq
       end
 
       # Extent of the object, such as "1 audiotape" or "1 map".
@@ -25,7 +31,7 @@ module CocinaDisplay
       # @example Oral history interview (sw705fr7011)
       #   record.extents #=> ["1 audiotape", "1 transcript"]
       def extents
-        path("$.description.form..[?@.type == 'extent'].value").uniq
+        extent_forms.map(&:to_s).compact_blank.uniq
       end
 
       # Genres of the object, capitalized for display.
@@ -33,7 +39,7 @@ module CocinaDisplay
       # @example GIS dataset (nz187ct8959)
       #   record.genres #=> ["Cartographic dataset", "Geospatial data", "Geographic information systems data"]
       def genres
-        path("$.description.form..[?@.type == 'genre'].value").map(&:upcase_first).uniq
+        genre_forms.map(&:to_s).compact_blank.uniq
       end
 
       # Genres of the object, with additional values added for search/faceting.
@@ -47,6 +53,34 @@ module CocinaDisplay
         end.uniq
       end
 
+      # All form-related data to be rendered for display.
+      # Includes form, extent, resource type, etc. (but not self-deposit resource types).
+      # @return [Array<DisplayData>]
+      def form_display_data
+        CocinaDisplay::DisplayData.from_objects(all_forms - genre_forms - map_forms - media_forms - self_deposit_resource_types)
+      end
+
+      # All genre-related data to be rendered for display.
+      # Includes both form genres, subject genres, and self-deposit resource types.
+      # @return [Array<DisplayData>]
+      def genre_display_data
+        CocinaDisplay::DisplayData.from_objects(genre_forms + genre_subjects + self_deposit_resource_types)
+      end
+
+      # All map-related data to be rendered for display.
+      # Includes map scale, projection info, and geographic coordinate subjects.
+      # @return [Array<DisplayData>]
+      def map_display_data
+        CocinaDisplay::DisplayData.from_objects(map_forms + coordinate_subjects)
+      end
+
+      # All form notes to be rendered for display.
+      # @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"))
+      end
+
       # Is the object a periodical or serial?
       # @return [Boolean]
       def periodical?
@@ -73,6 +107,46 @@ module CocinaDisplay
 
       private
 
+      # Collapses all nested form values into an array of {Form} objects.
+      # Preserves resource type without flattening, since it can be structured.
+      # @return [Array<Form>]
+      def all_forms
+        @all_forms ||= path("$.description.form.*")
+          .flat_map { |form| Utils.flatten_nested_values(form, atomic_types: ["resource type"]) }
+          .map { |form| CocinaDisplay::Forms::Form.from_cocina(form) }
+      end
+
+      # {Form} objects with type "form".
+      # @return [Array<Form>]
+      def form_forms
+        all_forms.filter { |form| form.type == "form" }
+      end
+
+      # {Form} objects with type "genre".
+      # @return [Array<Form>]
+      def genre_forms
+        all_forms.filter { |form| form.type == "genre" }
+      end
+
+      # {Form} objects with type "extent".
+      # @return [Array<Form>]
+      def extent_forms
+        all_forms.filter { |form| form.type == "extent" }
+      end
+
+      # {Form} objects with types related to map data.
+      # @return [Array<Form>]
+      def map_forms
+        all_forms.filter { |form| ["map scale", "map projection"].include?(form.type) }
+      end
+
+      # {Form} objects with types that are media-related.
+      # @note These are excluded from the general form display data.
+      # @return [Array<Form>]
+      def media_forms
+        all_forms.filter { |form| ["reformatting quality", "media type"].include?(form.type) }
+      end
+
       # Map a resource type to SearchWorks format value(s).
       # @param resource_type [String] The resource type to map.
       # @return [Array<String>]
@@ -113,21 +187,34 @@ module CocinaDisplay
         values.compact_blank
       end
 
+      # All resource types forms, as {ResourceType}s.
+      # @return [Array<ResourceType>]
+      def all_resource_types
+        all_forms.filter { |form| form.is_a?(CocinaDisplay::Forms::ResourceType) }
+      end
+
+      # {ResourceType} objects that are Stanford self-deposit resource types.
+      # @return [Array<ResourceType>]
+      def self_deposit_resource_types
+        all_resource_types.filter { |resource_type| resource_type.stanford_self_deposit? }
+      end
+
+      # Display values of all resource types.
+      # @return [Array<String>]
+      def resource_type_values
+        all_resource_types.map(&:to_s).uniq
+      end
+
       # Issuance terms for a work, drawn from the event notes.
       # @return [Array<String>]
       def issuance_terms
-        path("$.description.event.*.note[?@.type == 'issuance'].value").map(&:downcase).uniq
+        events.flat_map(&:notes).filter { |note| note.type == "issuance" }.map { |note| note.to_s.downcase }.uniq
       end
 
       # Frequency terms for a periodical, drawn from the event notes.
       # @return [Array<String>]
       def frequency
-        path("$.description.event.*.note[?@.type == 'frequency'].value").map(&:downcase).uniq
-      end
-
-      # Values of the resource type form field prior to mapping.
-      def resource_type_values
-        path("$.description.form..[?@.type == 'resource type'].value").uniq
+        events.flat_map(&:notes).filter { |note| note.type == "frequency" }.map { |note| note.to_s.downcase }.uniq
       end
     end
   end

data/lib/cocina_display/concerns/geospatial.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../subjects/subject_value"
-
 module CocinaDisplay
   module Concerns
     # Methods for extracting geospatial metadata, such as coordinates.
@@ -10,7 +8,7 @@ module CocinaDisplay
       # @return [Array<String>]
       # @example ["34°03′08″N 118°14′37″W"]
       def coordinates
-        coordinate_subjects.map(&:to_s).compact.uniq
+        coordinate_subject_values.map(&:to_s).compact.uniq
       end
 
       # All valid coordinate data formatted for indexing into a Solr RPT field.
@@ -49,15 +47,21 @@ module CocinaDisplay
 
       private
 
+      # {Subject} objects with types that could contain coordinate information.
+      # @return [Array<Subject>]
+      def coordinate_subjects
+        all_subjects.filter { |subject| subject.type&.include? "coordinates" }
+      end
+
       # Parsed coordinate values from the coordinate subject values.
       # @return [Array<Geospatial::Coordinates>]
       def coordinate_objects
-        coordinate_subjects.filter_map(&:coordinates)
+        coordinate_subject_values.filter_map(&:coordinates)
       end
 
       # All subject values that could contain parsed coordinates.
       # @return [Array<Subjects::CoordinatesSubjectValue>]
-      def coordinate_subjects
+      def coordinate_subject_values
         subject_values.filter { |s| s.is_a? CocinaDisplay::Subjects::CoordinatesSubjectValue }
       end
     end

data/lib/cocina_display/concerns/identifiers.rb

@@ -26,11 +26,10 @@ module CocinaDisplay
       # @example
       #   record.doi #=> "10.25740/ppax-bf07"
       def doi
-        doi_id = path("$.identification.doi").first ||
-          path("$.description.identifier[?match(@.type, 'doi|DOI')].value").first ||
-          path("$.description.identifier[?search(@.uri, 'doi.org')].uri").first
+        doi_id = path("$.identification.doi").first
+        return URI(doi_id).path.delete_prefix("/") if doi_id.present?
 
-        URI(doi_id).path.delete_prefix("/") if doi_id.present?
+        identifiers.find(&:doi?)&.identifier
       end
 
       # The DOI as a URL, if there is one. Any valid DOI should resolve via doi.org.
@@ -66,6 +65,18 @@ module CocinaDisplay
       def searchworks_id
         folio_hrid || bare_druid
       end
+
+      # Identifier objects extracted from the Cocina descriptive metadata.
+      # @return [Array<Identifier>]
+      def identifiers
+        @identifiers ||= path("$.description.identifier[*]").map { |id| Identifier.new(id) }
+      end
+
+      # Labelled display data for identifiers.
+      # @return [Array<DisplayData>]
+      def identifier_display_data
+        CocinaDisplay::DisplayData.from_objects(identifiers)
+      end
     end
   end
 end

data/lib/cocina_display/concerns/languages.rb

@@ -1,5 +1,3 @@
-require_relative "../language"
-
 module CocinaDisplay
   module Concerns
     # Methods for extracting language information from a Cocina object.
@@ -15,6 +13,12 @@ module CocinaDisplay
       def searchworks_language_names
         languages.filter_map { |lang| lang.to_s if lang.searchworks_language? }.compact_blank.uniq
       end
+
+      # Language information for display.
+      # @return [Array<CocinaDisplay::DisplayData>]
+      def language_display_data
+        CocinaDisplay::DisplayData.from_objects(languages)
+      end
     end
   end
 end

data/lib/cocina_display/concerns/notes.rb

@@ -0,0 +1,36 @@
+module CocinaDisplay
+  module Concerns
+    # Methods for extracting note information from Cocina.
+    module Notes
+      # Note objects associated with the cocina record.
+      # @return [Array<CocinaDisplay::Note>]
+      def notes
+        @notes ||= path("$.description.note.*").map { |note| CocinaDisplay::Note.new(note) }
+      end
+
+      # Abstract metadata for display.
+      # @return [Array<CocinaDisplay::DisplayData>]
+      def abstract_display_data
+        CocinaDisplay::DisplayData.from_objects(notes.select(&:abstract?))
+      end
+
+      # General note metadata for display.
+      # @return [Array<CocinaDisplay::DisplayData>]
+      def general_note_display_data
+        CocinaDisplay::DisplayData.from_objects(notes.select(&:general_note?))
+      end
+
+      # Preferred citation metadata for display.
+      # @return [Array<CocinaDisplay::DisplayData>]
+      def preferred_citation_display_data
+        CocinaDisplay::DisplayData.from_objects(notes.select(&:preferred_citation?))
+      end
+
+      # Table of contents metadata for display.
+      # @return [Array<CocinaDisplay::DisplayData>]
+      def table_of_contents_display_data
+        CocinaDisplay::DisplayData.from_objects(notes.select(&:table_of_contents?))
+      end
+    end
+  end
+end

data/lib/cocina_display/concerns/related_resources.rb

@@ -0,0 +1,20 @@
+module CocinaDisplay
+  module Concerns
+    # Methods for extracting and formatting related resources from Cocina records.
+    module RelatedResources
+      # Resources related to the object.
+      # @return [Array<CocinaDisplay::RelatedResource>]
+      def related_resources
+        @related_resources ||= path("$.description.relatedResource[*]").map { |res| RelatedResource.new(res) }
+      end
+
+      # Display data for related resources.
+      # @note Related resources also have their own nested display data.
+      # @see CocinaDisplay::RelatedResource#display_data
+      # @return [Array<DisplayData>]
+      def related_resource_display_data
+        DisplayData.from_objects(related_resources)
+      end
+    end
+  end
+end

data/lib/cocina_display/concerns/subjects.rb

@@ -1,6 +1,3 @@
-require_relative "../subjects/subject"
-require_relative "../subjects/subject_value"
-
 module CocinaDisplay
   module Concerns
     # Methods for extracting and formatting subject information.
@@ -87,25 +84,45 @@ module CocinaDisplay
       # @see Subject#to_s
       # @return [Array<String>]
       def subject_all_display
-        subjects.map(&:to_s).uniq
+        all_subjects.map(&:to_s).uniq
+      end
+
+      # Subject data to be rendered for display.
+      # Uses the concatenated form for structured subject values.
+      # @see Subject#to_s
+      # @return [Array<DisplayData>]
+      def subject_display_data
+        CocinaDisplay::DisplayData.from_objects(all_subjects - classification_subjects - genre_subjects - coordinate_subjects)
       end
 
       private
 
-      # All subjects, accessible as Subject objects.
+      # All subjects, accessible as {Subject} objects.
       # Checks both description.subject and description.geographic.subject.
       # @return [Array<Subject>]
-      def subjects
-        @subjects ||= Enumerator::Chain.new(
+      def all_subjects
+        @all_subjects ||= Enumerator::Chain.new(
           path("$.description.subject[*]"),
           path("$.description.geographic.*.subject[*]")
         ).map { |s| CocinaDisplay::Subjects::Subject.new(s) }
       end
 
+      # {Subject} objects with type "genre".
+      # @return [Array<Subject>]
+      def genre_subjects
+        all_subjects.filter { |subject| subject.type == "genre" }
+      end
+
+      # {Subject} objects with type "classification".
+      # @return [Array<Subject>]
+      def classification_subjects
+        all_subjects.filter { |subject| subject.type == "classification" }
+      end
+
       # All subject values, flattened from all subjects.
       # @return [Array<SubjectValue>]
       def subject_values
-        @subject_values ||= subjects.flat_map(&:subject_values)
+        @subject_values ||= all_subjects.flat_map(&:subject_values)
       end
 
       # All subject values that are named places.

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.