cocina_display 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e86f2100a204e574eaf48f86dccf3b9bdc4985285e72e05292f9dd722d9d87e9
-  data.tar.gz: 5730dd6764fa87f39dc6d00dc66c8ea72f10685c7e3aef0b92864c16b1186cb6
+  metadata.gz: 575cbfb8b11f3cf71950bfb5234ada4a916a5e55d21116422de84361854f0713
+  data.tar.gz: 4e06ee33d664822bdb6a3057ad8c40539f1f8363350f4648a463c7be0cb533ad
 SHA512:
-  metadata.gz: fcfa03dd80c3673045803c11c1d7fa3f9c5284f75806c7c76b5ccb52cb765631670696fe3777a2a5cfbcd90b209ba5e898a618a92d9ecf0186670fdddb09cb6e
-  data.tar.gz: acbcb5d312ac4755cfff3a74119b68e316d929da0d0d91f397afdd51480f3a90332166f2ccc052e53c2d675d749f62a12f814513b58413611475e36d732c5041
+  metadata.gz: 76ecb30d8a60bbb42bab880b0c3c5288d8daa7504cc044fb06c157e1b5e2fe21fd3e56668c3479d291f1e683eab4d719c11b2ac5d185b6e98a062e917f5ea74a
+  data.tar.gz: ce4c61a927f9bc034aeebcd9cfc0cb56c8cd1b3c4ee13f7d8d0fcd0cc83290e8d2d1fe31ead879bdb4b1d0090ee60164158ba24d9c8eeb4a7499dfd315b9cf07

data/lib/cocina_display/cocina_record.rb

@@ -14,6 +14,7 @@ require_relative "concerns/titles"
 require_relative "concerns/access"
 require_relative "concerns/subjects"
 require_relative "concerns/forms"
+require_relative "concerns/languages"
 require_relative "utils"
 
 module CocinaDisplay
@@ -26,6 +27,7 @@ module CocinaDisplay
     include CocinaDisplay::Concerns::Access
     include CocinaDisplay::Concerns::Subjects
     include CocinaDisplay::Concerns::Forms
+    include CocinaDisplay::Concerns::Languages
 
     # Fetch a public Cocina document from PURL and create a CocinaRecord.
     # @note This is intended to be used in development or testing only.

data/lib/cocina_display/concerns/contributors.rb

@@ -79,9 +79,13 @@ module CocinaDisplay
       end
 
       # All contributors for the object, including authors, editors, etc.
+      # Checks both description.contributor and description.event.contributor.
       # @return [Array<Contributor>]
       def contributors
-        @contributors ||= path("$.description.contributor.*").map { |c| Contributor.new(c) }
+        @contributors ||= Enumerator::Chain.new(
+          path("$.description.contributor.*"),
+          path("$.description.event.*.contributor.*")
+        ).map { |c| Contributor.new(c) }
       end
 
       # All contributors with a "publisher" role.

data/lib/cocina_display/concerns/languages.rb

@@ -0,0 +1,20 @@
+require_relative "../language"
+
+module CocinaDisplay
+  module Concerns
+    # Methods for extracting language information from a Cocina object.
+    module Languages
+      # Languages objects associated with the object.
+      # @return [Array<CocinaDisplay::Language>]
+      def languages
+        @languages ||= path("$.description.language.*").map { |lang| CocinaDisplay::Language.new(lang) }
+      end
+
+      # Names of languages associated with the object, if recognized by Searchworks.
+      # @return [Array<String>]
+      def searchworks_language_names
+        languages.filter_map { |lang| lang.display_str if lang.searchworks_language? }.compact_blank.uniq
+      end
+    end
+  end
+end

data/lib/cocina_display/concerns/subjects.rb

@@ -1,45 +1,46 @@
-require_relative "../subject"
+require_relative "../subjects/subject"
+require_relative "../subjects/subject_value"
 
 module CocinaDisplay
   module Concerns
     # Methods for extracting and formatting subject information.
     module Subjects
-      # All unique subjects that are topics, formatted as strings for display.
+      # All unique subject values that are topics.
       # @return [Array<String>]
       def subject_topics
-        subjects.filter { |s| s.type == "topic" }.map(&:display_str).uniq
+        subject_values.filter { |s| s.type == "topic" }.map(&:display_str).uniq
       end
 
-      # All unique subjects that are genres, formatted as strings for display.
+      # All unique subject values that are genres.
       # @return [Array<String>]
       def subject_genres
-        subjects.filter { |s| s.type == "genre" }.map(&:display_str).uniq
+        subject_values.filter { |s| s.type == "genre" }.map(&:display_str).uniq
       end
 
-      # All unique subjects that are titles, formatted as strings for display.
+      # All unique subject values that are titles.
       # @return [Array<String>]
       def subject_titles
-        subjects.filter { |s| s.type == "title" }.map(&:display_str).uniq
+        subject_values.filter { |s| s.type == "title" }.map(&:display_str).uniq
       end
 
-      # All unique subjects that are date/time info, formatted as strings for display.
+      # All unique subject values that are date/time info.
       # @return [Array<String>]
       def subject_temporal
-        subjects.filter { |s| s.type == "time" }.map(&:display_str).uniq
+        subject_values.filter { |s| s.type == "time" }.map(&:display_str).uniq
       end
 
-      # All unique subjects that are occupations, formatted as strings for display.
+      # All unique subject values that are occupations.
       # @return [Array<String>]
       def subject_occupations
-        subjects.filter { |s| s.type == "occupation" }.map(&:display_str).uniq
+        subject_values.filter { |s| s.type == "occupation" }.map(&:display_str).uniq
       end
 
-      # All unique subjects that are names of entities, formatted as strings for display.
+      # All unique subject values that are names of entities.
       # @note Multiple types are handled: person, family, organization, conference, etc.
-      # @see CocinaDisplay::NameSubject
+      # @see CocinaDisplay::NameSubjectValue
       # @return [Array<String>]
       def subject_names
-        subjects.filter { |s| s.is_a? NameSubject }.map(&:display_str).uniq
+        subject_values.filter { |s| s.is_a? CocinaDisplay::Subjects::NameSubjectValue }.map(&:display_str).uniq
       end
 
       # Combination of all subject values for searching.
@@ -75,6 +76,13 @@ module CocinaDisplay
         subject_temporal + subject_genres
       end
 
+      # Combination of all subjects with nested values concatenated for display.
+      # @see Subject#display_str
+      # @return [Array<String>]
+      def subject_all_display
+        subjects.map(&:display_str).uniq
+      end
+
       private
 
       # All subjects, accessible as Subject objects.
@@ -84,7 +92,13 @@ module CocinaDisplay
         @subjects ||= Enumerator::Chain.new(
           path("$.description.subject[*]"),
           path("$.description.geographic.*.subject[*]")
-        ).map { |s| Subject.from_cocina(s) }
+        ).map { |s| CocinaDisplay::Subjects::Subject.new(s) }
+      end
+
+      # All subject values, flattened from all subjects.
+      # @return [Array<SubjectValue>]
+      def subject_values
+        @subject_values ||= subjects.flat_map(&:subject_values)
       end
     end
   end

data/lib/cocina_display/contributor.rb

@@ -5,7 +5,7 @@ require "active_support/core_ext/object/blank"
 require "active_support/core_ext/array/conversions"
 
 require_relative "utils"
-require_relative "marc_relator_codes"
+require_relative "vocabularies/marc_relator_codes"
 
 module CocinaDisplay
   # A contributor to a work, such as an author or publisher.
@@ -129,10 +129,10 @@ module CocinaDisplay
 
       private
 
-      # The full name as a string, combining all name components.
+      # The full name as a string, combining all name components and terms of address.
       # @return [String]
       def full_name_str
-        Utils.compact_and_join(name_components, delimiter: ", ")
+        Utils.compact_and_join(name_components.push(terms_of_address_str), delimiter: ", ")
       end
 
       # Flattened form of any names explicitly marked as "display name".
@@ -146,7 +146,7 @@ module CocinaDisplay
       # Otherwise, fall back to any names explicitly marked as "name" or untyped.
       # @return [Array<String>]
       def name_components
-        [surname_str, forename_ordinal_str, terms_of_address_str].compact_blank.presence || Array(name_values["name"])
+        [surname_str, forename_ordinal_str].compact_blank.presence || Array(name_values["name"])
       end
 
       # Flatten all forenames and ordinals into a single string.
@@ -201,7 +201,7 @@ module CocinaDisplay
       # Translates the MARC relator code if no value was present.
       # @return [String, nil]
       def display_str
-        cocina["value"] || (MARC_RELATOR[code] if marc_relator?)
+        cocina["value"] || (Vocabularies::MARC_RELATOR[code] if marc_relator?)
       end
 
       # A code associated with the role, e.g. a MARC relator code.

data/lib/cocina_display/dates/date_range.rb

@@ -63,7 +63,18 @@ module CocinaDisplay
         start&.encoding || stop&.encoding || super
       end
 
-      # Is either date in the range qualified in any way?
+      # The qualifier for the entire range.
+      # If both qualifiers match, uses that qualifier. If both are empty, falls
+      # back to the top level qualifier, if any.
+      # @see CocinaDisplay::Date#qualifier
+      # @return [String, nil]
+      def qualifier
+        if start&.qualifier == stop&.qualifier
+          start&.qualifier || stop&.qualifier || super
+        end
+      end
+
+      # Is either date in the range, or the range itself, qualified?
       # @see CocinaDisplay::Date#qualified?
       # @return [Boolean]
       def qualified?
@@ -105,14 +116,15 @@ module CocinaDisplay
       # @see CocinaDisplay::Date#qualified_value
       # @return [String]
       def qualified_value
-        if start&.qualifier == stop&.qualifier
-          qualifier = start&.qualifier || stop&.qualifier
-          date = decoded_value
-          return "[ca. #{date}]" if qualifier == "approximate"
-          return "[#{date}?]" if qualifier == "questionable"
-          return "[#{date}]" if qualifier == "inferred"
-
-          date
+        if qualifier
+          case qualifier
+          when "approximate"
+            "[ca. #{decoded_value}]"
+          when "questionable"
+            "[#{decoded_value}?]"
+          when "inferred"
+            "[#{decoded_value}]"
+          end
         else
           "#{start&.qualified_value} - #{stop&.qualified_value}"
         end

data/lib/cocina_display/events/imprint.rb

@@ -7,7 +7,6 @@ require "active_support/core_ext/object/blank"
 
 require_relative "event"
 require_relative "../utils"
-require_relative "../marc_country_codes"
 require_relative "../dates/date"
 require_relative "../dates/date_range"
 

data/lib/cocina_display/events/location.rb

@@ -1,4 +1,4 @@
-require_relative "../marc_country_codes"
+require_relative "../vocabularies/marc_country_codes"
 
 module CocinaDisplay
   module Events
@@ -36,7 +36,7 @@ module CocinaDisplay
       # Decoded country name if the location is encoded with a MARC country code.
       # @return [String, nil]
       def decoded_country
-        MARC_COUNTRY[code] if marc_country? && valid_country_code?
+        Vocabularies::MARC_COUNTRY[code] if marc_country? && valid_country_code?
       end
 
       # Is this a decodable country code?

data/lib/cocina_display/language.rb

@@ -0,0 +1,47 @@
+require "iso639"
+require_relative "vocabularies/searchworks_languages"
+
+module CocinaDisplay
+  # A language associated with part or all of a Cocina object.
+  class Language
+    attr_reader :cocina
+
+    # Create a Language object from Cocina structured data.
+    # @param cocina [Hash]
+    def initialize(cocina)
+      @cocina = cocina
+    end
+
+    # The language name for display.
+    # @return [String, nil]
+    def display_str
+      cocina["value"] || decoded_value
+    end
+
+    # The language code, e.g. an ISO 639 code like "eng" or "spa".
+    # @return [String, nil]
+    def code
+      cocina["code"]
+    end
+
+    # Decoded name of the language based on the code, if present.
+    # @return [String, nil]
+    def decoded_value
+      Vocabularies::SEARCHWORKS_LANGUAGES[code] || (Iso639[code] if iso_639?)
+    end
+
+    # True if the language is recognized by Searchworks.
+    # @see CocinaDisplay::Vocabularies::SEARCHWORKS_LANGUAGES
+    # @return [Boolean]
+    def searchworks_language?
+      Vocabularies::SEARCHWORKS_LANGUAGES.value?(display_str)
+    end
+
+    # True if the language has a code sourced from the ISO 639 vocabulary.
+    # @see https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
+    # @return [Boolean]
+    def iso_639?
+      cocina.dig("source", "code")&.start_with? "iso639"
+    end
+  end
+end

data/lib/cocina_display/subjects/subject.rb

@@ -0,0 +1,63 @@
+require_relative "../utils"
+require_relative "subject_value"
+
+module CocinaDisplay
+  module Subjects
+    # Base class for subjects in Cocina structured data.
+    class Subject
+      attr_reader :cocina
+
+      # Initialize a Subject object with Cocina structured data.
+      # @param cocina [Hash] The Cocina structured data for the subject.
+      def initialize(cocina)
+        @cocina = cocina
+      end
+
+      # The top-level type of the subject.
+      # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#subject-types
+      # @return [String, nil]
+      def type
+        cocina["type"]
+      end
+
+      # Array of display strings for each value in the subject.
+      # Used for search, where each value should be indexed separately.
+      # @return [Array<String>]
+      def display_values
+        subject_values.map(&:display_str).compact_blank
+      end
+
+      # A string representation of the entire subject, formatted for display.
+      # Concatenates the values with an appropriate delimiter.
+      # @return [String]
+      def display_str
+        Utils.compact_and_join(display_values, delimiter: delimiter)
+      end
+
+      # Individual values composing this subject.
+      # Can be multiple if the Cocina featured nested data.
+      # If no type was specified on a value, uses the top-level subject type.
+      # @return [Array<SubjectValue>]
+      def subject_values
+        @subject_values ||= Utils.flatten_nested_values(cocina, atomic_types: SubjectValue.atomic_types).map do |value|
+          subject_value = SubjectValue.from_cocina(value)
+          subject_value.type ||= type
+          subject_value
+        end
+      end
+
+      private
+
+      # Delimiter to use for joining structured subject values.
+      # LCSH uses a comma (the default); catalog headings use " > ".
+      # @return [String]
+      def delimiter
+        if cocina["displayLabel"]&.downcase == "catalog heading"
+          " > "
+        else
+          ", "
+        end
+      end
+    end
+  end
+end

data/lib/cocina_display/subjects/subject_value.rb

@@ -0,0 +1,104 @@
+require_relative "subject"
+require_relative "../contributor"
+require_relative "../title_builder"
+require_relative "../dates/date"
+
+module CocinaDisplay
+  module Subjects
+    # A descriptive value that can be part of a Subject.
+    class SubjectValue
+      attr_reader :cocina
+
+      # The type of the subject value, like "person", "title", or "time".
+      # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#subject-part-types-for-structured-value
+      attr_accessor :type
+
+      # Create a SubjectValue from Cocina structured data.
+      # @param cocina [Hash] The Cocina structured data for the subject.
+      # @return [SubjectValue]
+      def self.from_cocina(cocina)
+        SUBJECT_VALUE_TYPES.fetch(cocina["type"], SubjectValue).new(cocina)
+      end
+
+      # All subject value types that should not be further destructured.
+      # @return [Array<String>]
+      def self.atomic_types
+        SUBJECT_VALUE_TYPES.keys
+      end
+
+      # Initialize a SubjectValue object with Cocina structured data.
+      # @param cocina [Hash] The Cocina structured data for the subject value.
+      def initialize(cocina)
+        @cocina = cocina
+        @type = cocina["type"]
+      end
+
+      # The display string for the subject value.
+      # Subclasses should override this method to provide specific formatting.
+      # @return [String]
+      def display_str
+        cocina["value"]
+      end
+    end
+
+    # A subject value representing a named entity.
+    class NameSubjectValue < SubjectValue
+      attr_reader :name
+
+      # Initialize a NameSubjectValue object with Cocina structured data.
+      # @param cocina [Hash] The Cocina structured data for the subject.
+      def initialize(cocina)
+        super
+        @name = Contributor::Name.new(cocina)
+      end
+
+      # Use the contributor name formatting rules for display.
+      # @return [String] The formatted name string, including life dates
+      # @see CocinaDisplay::Contributor::Name#display_str
+      def display_str
+        @name.display_str(with_date: true)
+      end
+    end
+
+    # A subject value representing an entity with a title.
+    class TitleSubjectValue < SubjectValue
+      # Construct a title string to use for display.
+      # @see CocinaDisplay::TitleBuilder.build
+      # @note Unclear how often structured title subjects occur "in the wild".
+      # @return [String]
+      def display_str
+        TitleBuilder.build([cocina])
+      end
+    end
+
+    # A subject value representing a date and/or time.
+    class TemporalSubjectValue < SubjectValue
+      attr_reader :date
+
+      def initialize(cocina)
+        super
+        @date = Dates::Date.from_cocina(cocina)
+      end
+
+      # @return [String] The formatted date/time string for display
+      def display_str
+        @date.qualified_value
+      end
+    end
+  end
+end
+
+# Map Cocina subject types to specific SubjectValue classes for rendering.
+# @see SubjectValue#type
+SUBJECT_VALUE_TYPES = {
+  "person" => CocinaDisplay::Subjects::NameSubjectValue,
+  "family" => CocinaDisplay::Subjects::NameSubjectValue,
+  "organization" => CocinaDisplay::Subjects::NameSubjectValue,
+  "conference" => CocinaDisplay::Subjects::NameSubjectValue,
+  "event" => CocinaDisplay::Subjects::NameSubjectValue,
+  "name" => CocinaDisplay::Subjects::NameSubjectValue,
+  "title" => CocinaDisplay::Subjects::TitleSubjectValue,
+  "time" => CocinaDisplay::Subjects::TemporalSubjectValue
+  # TODO: special handling for geospatial subjects
+  # "map coordinates", "bounding box coordinates", "point coordinates"
+}.freeze

data/lib/cocina_display/utils.rb

@@ -24,6 +24,7 @@ module CocinaDisplay
     # @return [Array<Hash>] List of node hashes with "value" present
     # @param cocina [Hash] The Cocina structured data to flatten
     # @param output [Array] Used for recursion, should be empty on first call
+    # @param atomic_types [Array<String>] Types considered atomic; will not be flattened
     # @example simple value
     #  cocina = { "value" => "John Doe", "type" => "name" }
     #  Utils.flatten_nested_values(cocina)
@@ -36,14 +37,15 @@ module CocinaDisplay
     #  cocina = { "parallelValue" => [{"value" => "foo" }, { "structuredValue" => [{"value" => "bar"},  {"value" => "baz"}] }] }
     #  Utils.flatten_nested_values(cocina)
     #  #=> [{"value" => "foo"}, {"value" => "foo"}, {"value" => "baz"}]
-    def self.flatten_nested_values(cocina, output = [])
+    def self.flatten_nested_values(cocina, output = [], atomic_types: [])
       return [cocina] if cocina["value"].present?
-      return cocina.flat_map { |node| flatten_nested_values(node, output) } if cocina.is_a?(Array)
+      return [cocina] if atomic_types.include?(cocina["type"])
+      return cocina.flat_map { |node| flatten_nested_values(node, output, atomic_types: atomic_types) } if cocina.is_a?(Array)
 
       nested_values = Array(cocina["structuredValue"]) + Array(cocina["parallelValue"]) + Array(cocina["groupedValue"])
       return output unless nested_values.any?
 
-      nested_values.flat_map { |node| flatten_nested_values(node, output) }
+      nested_values.flat_map { |node| flatten_nested_values(node, output, atomic_types: atomic_types) }
     end
 
     # Recursively remove empty values from a hash, including nested hashes and arrays.

data/lib/cocina_display/version.rb

@@ -2,5 +2,5 @@
 
 # :nodoc:
 module CocinaDisplay
-  VERSION = "0.6.0" # :nodoc:
+  VERSION = "0.7.0" # :nodoc:
 end