cocina_display 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68f245cc22043da571e4a9abf0f0fedd613fc19035c4a50369b95400c76573b5
-  data.tar.gz: 86de10bbfcabc44d23d9b3df480eb6b3f0d28b358c9f4fece1ece089cf5cca20
+  metadata.gz: e2b164eda474dc396b74c8b911fe50bbba7c2dbbce17b29c24923db4f25ff8a5
+  data.tar.gz: c782186b53a4dcb7f53b11a3d552dcf5f892f4435fc46fb4bcddd65ad444d9be
 SHA512:
-  metadata.gz: 9ea9ac44480ac83533704c06705f0f6f078ac4065b27756cea527f4110ab99b3bafcfcf525097368005e89534bed78a8bb17a81cb96dc1c48c479a5052b877f6
-  data.tar.gz: 3600cc57ec5e162cb39e2547fa09c9dc7aadc87742146649a0c9d3427ad6c8a2eede1357103af6d4cab531e51d93136a69f075de0995c86daaf471fac2ff08c7
+  metadata.gz: efed0c780617aaeadb7187391c74691bcacddcb24cb2850e14918ab755acfaef273c8e3277a9c4674b2b41201a72ffe91a79a0065daa07ad469e2178ea17fd92
+  data.tar.gz: 28933bab6be3f6cd2fed4155d5b4a73bf9f9d9301e5edc679018f6428d90f88ca14ab8a6614d1c07e53f1723644b0871786fb075b664bb7e2fb73dba96d21588

data/lib/cocina_display/cocina_record.rb

@@ -16,6 +16,7 @@ require_relative "concerns/subjects"
 require_relative "concerns/forms"
 require_relative "concerns/languages"
 require_relative "concerns/geospatial"
+require_relative "concerns/structural"
 require_relative "utils"
 
 module CocinaDisplay
@@ -30,6 +31,7 @@ module CocinaDisplay
     include CocinaDisplay::Concerns::Forms
     include CocinaDisplay::Concerns::Languages
     include CocinaDisplay::Concerns::Geospatial
+    include CocinaDisplay::Concerns::Structural
 
     # Fetch a public Cocina document from PURL and create a CocinaRecord.
     # @note This is intended to be used in development or testing only.
@@ -88,12 +90,13 @@ module CocinaDisplay
     end
 
     # SDR content type of the object.
-    # @return [String]
+    # @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"].split("/").last
+      cocina_doc["type"]&.split("/")&.last
     end
 
     # Primary processing label for the object.
@@ -109,16 +112,27 @@ module CocinaDisplay
       content_type == "collection"
     end
 
-    # Traverse nested FileSets and return an enumerator over their files.
-    # Each file is a +Hash+.
-    # @return [Enumerator] Enumerator over file hashes
-    # @example
-    #  record.files.each do |file|
-    #   puts file["filename"] #=> "image1.jpg"
-    #   puts file["size"] #=> 123456
-    #  end
-    def files
-      path("$.structural.contains.*.structural.contains[*]")
+    # Resources related to the object.
+    # @return [Array<CocinaDisplay::RelatedResource>]
+    def related_resources
+      @related_resources ||= path("$.description.relatedResource[*]").map { |res| RelatedResource.new(res) }
+    end
+  end
+
+  # A resource related to the record; behaves like a CocinaRecord.
+  # @note Related resources have no structural metadata.
+  class RelatedResource < CocinaRecord
+    # Description of the relation to the source record.
+    # @return [String]
+    # @example "is part of"
+    # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#relatedresource-types
+    attr_reader :type
+
+    # Restructure the hash so that everything is under "description" key, since
+    # it's all descriptive metadata. This makes most CocinaRecord methods work.
+    def initialize(cocina_doc)
+      @type = cocina_doc["type"]
+      @cocina_doc = {"description" => cocina_doc.except("type")}
     end
   end
 end

data/lib/cocina_display/concerns/access.rb

@@ -7,30 +7,7 @@ module CocinaDisplay
       # @example
       #  record.purl_url #=> "https://purl.stanford.edu/bx658jh7339"
       def purl_url
-        cocina_doc.dig("description", "purl") || "https://purl.stanford.edu/#{bare_druid}"
-      end
-
-      # 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]
-      # @example
-      #   record.purl_base_url #=> "https://purl.stanford.edu"
-      def purl_base_url
-        URI(purl_url).origin
-      end
-
-      # The URL to the stacks environment this object is shelved in.
-      # Corresponds to the PURL environment.
-      # @see purl_base_url
-      # @return [String]
-      # @example
-      #  record.stacks_base_url #=> "https://stacks.stanford.edu"
-      def stacks_base_url
-        if purl_base_url == "https://sul-purl-stage.stanford.edu"
-          "https://sul-stacks-stage.stanford.edu"
-        else
-          "https://stacks.stanford.edu"
-        end
+        cocina_doc.dig("description", "purl") || ("https://purl.stanford.edu/#{bare_druid}" if bare_druid)
       end
 
       # The oEmbed URL for the object, optionally with additional parameters.
@@ -41,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?
+        return if collection? || purl_url.blank?
 
         params[:url] ||= purl_url
         "#{purl_base_url}/embed.json?#{params.to_query}"
@@ -53,7 +30,7 @@ module CocinaDisplay
       # @example
       #   record.download_url #=> "https://stacks.stanford.edu/object/bx658jh7339"
       def download_url
-        "#{stacks_base_url}/object/#{bare_druid}"
+        "#{stacks_base_url}/object/#{bare_druid}" if bare_druid.present?
       end
 
       # The IIIF manifest URL for the object.
@@ -64,7 +41,32 @@ module CocinaDisplay
       #  record.iiif_manifest_url #=> "https://purl.stanford.edu/bx658jh7339/iiif3/manifest"
       def iiif_manifest_url(version: 3)
         iiif_path = (version == 3) ? "iiif3" : "iiif"
-        "#{purl_url}/#{iiif_path}/manifest"
+        "#{purl_url}/#{iiif_path}/manifest" if purl_url.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]
+      # @example
+      #   record.purl_base_url #=> "https://purl.stanford.edu"
+      def purl_base_url
+        URI(purl_url).origin if purl_url.present?
+      end
+
+      # The URL to the stacks environment this object is shelved in.
+      # Corresponds to the PURL environment.
+      # @see purl_base_url
+      # @return [String]
+      # @example
+      #  record.stacks_base_url #=> "https://stacks.stanford.edu"
+      def stacks_base_url
+        if purl_base_url == "https://sul-purl-stage.stanford.edu"
+          "https://sul-stacks-stage.stanford.edu"
+        elsif purl_base_url.present?
+          "https://stacks.stanford.edu"
+        end
       end
     end
   end

data/lib/cocina_display/concerns/identifiers.rb

@@ -3,19 +3,22 @@ module CocinaDisplay
     # Methods for extracting and formatting identifiers from Cocina records.
     module Identifiers
       # The DRUID for the object, with the +druid:+ prefix.
-      # @return [String]
+      # @note A {RelatedResource} may not have a DRUID.
+      # @return [String, nil]
       # @example
       #   record.druid #=> "druid:bb099mt5053"
       def druid
-        cocina_doc["externalIdentifier"]
+        cocina_doc["externalIdentifier"] ||
+          cocina_doc.dig("description", "purl")&.split("/")&.last
       end
 
       # The DRUID for the object, without the +druid:+ prefix.
-      # @return [String]
+      # @note A {RelatedResource} may not have a DRUID.
+      # @return [String, nil]
       # @example
       #   record.bare_druid #=> "bb099mt5053"
       def bare_druid
-        druid.delete_prefix("druid:")
+        druid&.delete_prefix("druid:")
       end
 
       # The DOI for the object, if there is one – just the identifier part.
@@ -59,7 +62,7 @@ module CocinaDisplay
       # @note This doesn't imply the object is available in Searchworks at this ID.
       # @see folio_hrid
       # @see bare_druid
-      # @return [String]
+      # @return [String, nil]
       def searchworks_id
         folio_hrid || bare_druid
       end

data/lib/cocina_display/concerns/structural.rb

@@ -0,0 +1,41 @@
+require "active_support/number_helper/number_to_human_size_converter"
+
+module CocinaDisplay
+  module Concerns
+    # Methods for inspecting structural metadata (e.g. file hierarchy)
+    module Structural
+      # Structured data for all individual files in the object.
+      # Traverses nested FileSet structure to return a flattened array.
+      # @return [Array<Hash>]
+      # @example
+      #  record.files.each do |file|
+      #   puts file["filename"] #=> "image1.jpg"
+      #   puts file["size"] #=> 123456
+      #  end
+      def files
+        @files ||= path("$.structural.contains.*.structural.contains.*").search
+      end
+
+      # All unique MIME types of files in this object.
+      # @return [Array<String>]
+      # @example ["image/jpeg", "application/pdf"]
+      def file_mime_types
+        files.pluck("hasMimeType").uniq
+      end
+
+      # Human-readable string representation of {total_file_size_int}.
+      # @return [String]
+      # @example "2.5 MB"
+      def total_file_size_str
+        ActiveSupport::NumberHelper.number_to_human_size(total_file_size_int)
+      end
+
+      # Summed size of all files in bytes.
+      # @return [Integer]
+      # @example 2621440
+      def total_file_size_int
+        files.pluck("size").sum
+      end
+    end
+  end
+end

data/lib/cocina_display/contributors/contributor.rb

@@ -63,6 +63,12 @@ module CocinaDisplay
         roles.any?(&:publisher?)
       end
 
+      # Does this contributor have a role that indicates they are a funder?
+      # @return [Boolean]
+      def funder?
+        roles.any?(&:funder?)
+      end
+
       # Does this contributor have any roles defined?
       # @return [Boolean]
       def role?
@@ -77,6 +83,20 @@ module CocinaDisplay
         names.map { |name| name.to_s(with_date: with_date) }.first
       end
 
+      # The full forename for the contributor from the first available name.
+      # @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.
+      # @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]

data/lib/cocina_display/contributors/name.rb

@@ -37,8 +37,6 @@ module CocinaDisplay
         end
       end
 
-      private
-
       # The full name as a string, combining all name components and terms of address.
       # @return [String]
       def full_name_str
@@ -56,33 +54,35 @@ 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].compact_blank.presence || Array(name_values["name"])
+        [surname_str, forename_str].compact_blank.presence || Array(name_values["name"])
       end
 
-      # Flatten all forenames and ordinals into a single string.
+      # Flatten all terms of address into a comma-delimited string.
       # @return [String]
-      def forename_ordinal_str
-        Utils.compact_and_join(Array(name_values["forename"]) + Array(name_values["ordinal"]), delimiter: " ")
+      def terms_of_address_str
+        Utils.compact_and_join(Array(name_values["term of address"]), delimiter: ", ")
       end
 
-      # Flatten all terms of address into a single string.
+      # Flatten all forename values and ordinals into a whitespace-delimited string.
       # @return [String]
-      def terms_of_address_str
-        Utils.compact_and_join(Array(name_values["term of address"]), delimiter: ", ")
+      def forename_str
+        Utils.compact_and_join(Array(name_values["forename"]) + Array(name_values["ordinal"]), delimiter: " ")
       end
 
-      # Flatten all surnames into a single string.
+      # Flatten all surname values into a whitespace-delimited string.
       # @return [String]
       def surname_str
         Utils.compact_and_join(Array(name_values["surname"]), delimiter: " ")
       end
 
-      # Flatten all life and activity dates into a single string.
+      # Flatten all life and activity dates into a comma-delimited string.
       # @return [String]
       def dates_str
         Utils.compact_and_join(Array(name_values["life dates"]) + Array(name_values["activity dates"]), delimiter: ", ")
       end
 
+      private
+
       # A hash mapping destructured name types to their values.
       # Name values with no type are grouped under "name".
       # @return [Hash<String, Array<String>>]

data/lib/cocina_display/contributors/role.rb

@@ -30,7 +30,7 @@ module CocinaDisplay
       # Does this role indicate the contributor is an author?
       # @return [Boolean]
       def author?
-        to_s =~ /^(author|creator)/i
+        to_s =~ /^(author|creator|primary investigator)/i
       end
 
       # Does this role indicate the contributor is a publisher?
@@ -39,6 +39,12 @@ module CocinaDisplay
         to_s =~ /^publisher/i
       end
 
+      # Does this role indicate the contributor is a funder?
+      # @return [Boolean]
+      def funder?
+        to_s =~ /^funder/i
+      end
+
       private
 
       # Does this role have a MARC relator code?

data/lib/cocina_display/title_builder.rb

@@ -99,6 +99,8 @@ module CocinaDisplay
     # this may be useful for boosting and exact matching for search results
     # @return [Array<String>] the main title value(s) for Solr - can be array due to parallel titles
     def main_title(titles)
+      return [] if titles.empty?
+
       cocina_title = primary_title(titles) || untyped_title(titles)
       cocina_title = other_title(titles) if cocina_title.blank?
 

data/lib/cocina_display/version.rb

@@ -2,5 +2,5 @@
 
 # :nodoc:
 module CocinaDisplay
-  VERSION = "1.0.0" # :nodoc:
+  VERSION = "1.1.1" # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina_display
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Nick Budak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-08 00:00:00.000000000 Z
+date: 2025-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: janeway-jsonpath
@@ -219,6 +219,7 @@ files:
 - lib/cocina_display/concerns/geospatial.rb
 - lib/cocina_display/concerns/identifiers.rb
 - lib/cocina_display/concerns/languages.rb
+- lib/cocina_display/concerns/structural.rb
 - lib/cocina_display/concerns/subjects.rb
 - lib/cocina_display/concerns/titles.rb
 - lib/cocina_display/contributors/contributor.rb