cocina_display 2.1.0 → 2.2.0

data/lib/cocina_display/note.rb

@@ -1,142 +0,0 @@
-module CocinaDisplay
-  # A note associated with a cocina record
-  class Note
-    ABSTRACT_TYPES = ["summary", "abstract", "scope and content"].freeze
-    ABSTRACT_DISPLAY_LABEL_REGEX = /Abstract|Summary|Scope and content/i
-    PREFERRED_CITATION_TYPES = ["preferred citation"].freeze
-    PREFERRED_CITATION_DISPLAY_LABEL_REGEX = /Preferred citation/i
-    TOC_TYPES = ["table of contents"].freeze
-    TOC_DISPLAY_LABEL_REGEX = /Table of contents/i
-
-    attr_reader :cocina
-
-    # Initialize a Note from Cocina structured data.
-    # @param cocina [Hash]
-    def initialize(cocina)
-      @cocina = cocina
-    end
-
-    # The value to use for display.
-    # @return [String, nil]
-    def to_s
-      flat_value
-    end
-
-    # Delimiter used to join multiple values for display.
-    # @return [String, nil]
-    def delimiter
-      " -- " if table_of_contents?
-    end
-
-    # Does this note use a delimiter?
-    # @return [Boolean]
-    def delimited?
-      delimiter.present?
-    end
-
-    # Single concatenated string value for the note.
-    # @return [String, nil]
-    def flat_value
-      Utils.compact_and_join(values, delimiter: delimiter || "").presence
-    end
-
-    # The raw values from the Cocina data, flattened if nested.
-    # Strips excess whitespace and the delimiter if present.
-    # Splits on the delimiter if it was already included in the values(s).
-    # @return [Array<String>]
-    def values
-      Utils.flatten_nested_values(cocina).pluck("value")
-        .map { |value| cleaned_value(value) }
-        .flat_map { |value| delimited? ? value.split(delimiter.strip) : [value] }
-        .compact_blank
-    end
-
-    # The raw values from the Cocina data as a hash with type as key.
-    # Strips excess whitespace and the delimiter if present.
-    # Splits on the delimiter if it was already included in the values(s).
-    # @return [Hash{String => Array<String>}]
-    def values_by_type
-      Utils.flatten_nested_values(cocina).each_with_object({}) do |node, hash|
-        value = cleaned_value(node["value"])
-        (delimited? ? value.split(delimiter.strip) : [value]).each do |part|
-          type = node["type"]
-          hash[type] ||= []
-          hash[type] << part
-        end
-      end
-    end
-
-    # The type of the note, e.g. "abstract".
-    # @return [String, nil]
-    def type
-      cocina["type"].presence
-    end
-
-    # The display label set in Cocina
-    # @return [String, nil]
-    def display_label
-      cocina["displayLabel"].presence
-    end
-
-    # Label used to render the note for display.
-    # Uses a displayLabel if available, otherwise tries to look up via type.
-    # Falls back to a default label derived from the type or a generic note label if
-    # no type is set.
-    # @return [String]
-    def label
-      display_label ||
-        I18n.t(type&.parameterize&.underscore, default: default_label, scope: "cocina_display.field_label.note")
-    end
-
-    # Check if the note is an abstract
-    # @return [Boolean]
-    def abstract?
-      display_label&.match?(ABSTRACT_DISPLAY_LABEL_REGEX) ||
-        ABSTRACT_TYPES.include?(type)
-    end
-
-    # Check if the note is a general note (not a table of contents, abstract, preferred citation, or part)
-    # @return [Boolean]
-    def general_note?
-      !table_of_contents? && !abstract? && !preferred_citation? && !part?
-    end
-
-    # Check if the note is a preferred citation
-    # @return [Boolean]
-    def preferred_citation?
-      display_label&.match?(PREFERRED_CITATION_DISPLAY_LABEL_REGEX) ||
-        PREFERRED_CITATION_TYPES.include?(type)
-    end
-
-    # Check if the note is a table of contents
-    # @return [Boolean]
-    def table_of_contents?
-      display_label&.match?(TOC_DISPLAY_LABEL_REGEX) ||
-        TOC_TYPES.include?(type)
-    end
-
-    # Check if the note is a part note
-    # @note These are combined with the title and not displayed separately.
-    # @return [Boolean]
-    def part?
-      type == "part"
-    end
-
-    private
-
-    def default_label
-      type&.capitalize || I18n.t("cocina_display.field_label.note.note")
-    end
-
-    # Remove the delimiter from the ends of the value and strip whitespace.
-    # @param value [String]
-    # @return [String]
-    def cleaned_value(value)
-      return value.strip unless delimited?
-
-      value.gsub(/\s*#{Regexp.escape(delimiter.strip)}\s*$/, " ")
-        .gsub(/^\s*#{Regexp.escape(delimiter.strip)}\s*/, " ")
-        .strip
-    end
-  end
-end

data/lib/cocina_display/title.rb

@@ -1,213 +0,0 @@
-module CocinaDisplay
-  # A group of related {TitleValue}s associated with an item.
-  class Title
-    # The underlying Cocina hash.
-    attr_reader :cocina
-
-    # Type of the title, e.g. "uniform", "alternative", etc.
-    # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#title-types
-    # @return [String, nil]
-    attr_accessor :type
-
-    # Status of the title, e.g. "primary".
-    # @return [String, nil]
-    attr_accessor :status
-
-    # Create a new Title object.
-    # @param cocina [Hash]
-    # @param part_label [String, nil] part label for digital serials
-    # @param part_numbers [Array<String>] part numbers for related resources
-    def initialize(cocina, part_label: nil, part_numbers: nil)
-      @cocina = cocina
-      @part_label = part_label
-      @part_numbers = part_numbers
-      @type = cocina["type"].presence
-      @status = cocina["status"].presence
-    end
-
-    # Label used when displaying the title.
-    # @return [String]
-    def label
-      cocina["displayLabel"].presence || type_label
-    end
-
-    # Does this title have a type?
-    # @return [Boolean]
-    def type?
-      type.present?
-    end
-
-    # Is this marked as a primary title?
-    # @return [Boolean]
-    def primary?
-      status == "primary"
-    end
-
-    # The string representation of the title, for display.
-    # @see #display_title
-    # @return [String, nil]
-    def to_s
-      display_title
-    end
-
-    # The short form of the title, without subtitle, part name, etc.
-    # @note This corresponds to the "short title" in MODS XML, or MARC 245$a only.
-    # @return [String, nil]
-    # @example "M. de Courville"
-    def short_title
-      short_title_str.presence || cocina["value"]
-    end
-
-    # 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]"
-    def full_title
-      full_title_str.presence || cocina["value"]
-    end
-
-    # The long form of the title, without trailing punctuation.
-    # @note This corresponds to the entire MARC 245 field.
-    # @return [String, nil]
-    def display_title
-      display_title_str.presence || cocina["value"]
-    end
-
-    # A string value for sorting by title.
-    # Ignores punctuation, leading/trailing spaces, and non-sorting characters.
-    # If no title is present, returns a high Unicode value so it sorts last.
-    # @return [String]
-    def sort_title
-      return "\u{10FFFF}" unless full_title
-
-      full_title[nonsorting_chars_str.length..]
-        .unicode_normalize(:nfd) # Prevent accents being stripped
-        .gsub(/[[:punct:]]*/, "")
-        .gsub(/\W{2,}/, " ")  # Collapse whitespace after removing punctuation
-        .strip
-    end
-
-    private
-
-    # Generate the short title by joining main title and nonsorting characters.
-    # @return [String, nil]
-    def short_title_str
-      nonsorting_chars_str + main_title_str # pre-formatted padding
-    end
-
-    # Generate the full title by joining all title components with punctuation.
-    # @return [String, nil]
-    def full_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
-
-    # 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
-
-    # The main title and subtitle, joined together with a colon.
-    # @return [String, nil]
-    def main_subtitle_str
-      Utils.compact_and_join([main_title_str, subtitle_str], delimiter: " : ")
-    end
-
-    # All nonsorting characters joined together with padding applied.
-    # Handles languages that do not separate nonsorting characters with spaces.
-    # @return [String, nil]
-    def nonsorting_chars_str
-      pad_nonsorting(Utils.compact_and_join(Array(title_components["nonsorting characters"])))
-    end
-
-    # The main title component(s), joined together.
-    # @return [String, nil]
-    def main_title_str
-      Utils.compact_and_join(Array(title_components["main title"]))
-    end
-
-    # The subtitle components, joined together.
-    # @return [String, nil]
-    def subtitle_str
-      Utils.compact_and_join(Array(title_components["subtitle"]))
-    end
-
-    # The part name, number, and label components, joined together with commas.
-    # @return [String, nil]
-    def parts_str
-      Utils.compact_and_join(
-        Array(title_components["part number"] || @part_numbers) +
-        Array(title_components["part name"]) +
-        [@part_label],
-        delimiter: ", "
-      )
-    end
-
-    # The associated names, joined together with periods.
-    # @note Only present for uniform titles.
-    # @return [String, nil]
-    def names_str
-      Utils.compact_and_join(names, delimiter: ". ")
-    end
-
-    # Destructured title components, organized by type.
-    # Unstructured titles and components with no type are grouped under "main title".
-    # @return [Hash<String, Array<String>>]
-    # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#title-part-types-for-structured-value
-    def title_components
-      Utils.flatten_nested_values(cocina).each_with_object({}) do |node, hash|
-        type = case node["type"]
-        when "uniform", "alternative", "abbreviated", "translated", "transliterated", "parallel", "supplied", nil
-          "main title"
-        else
-          node["type"]
-        end
-        hash[type] ||= []
-        hash[type] << node["value"]
-      end.compact_blank
-    end
-
-    # Uniform titles can have associated person names.
-    # @return [String, nil]
-    def names
-      Janeway.enum_for("$.note[?(@.type=='associated name')]", cocina).map do |name|
-        Contributors::Name.new(name).to_s(with_date: true)
-      end
-    end
-
-    # Number of nonsorting characters to ignore at the start of the title.
-    # @return [Integer, nil]
-    def nonsorting_char_count
-      Janeway.enum_for("$.note[?(@.type=='nonsorting character count')].value", cocina).first&.to_i
-    end
-
-    # Type-specific label for the title, falling back to a generic "Title".
-    # @return [String]
-    def type_label
-      I18n.t(type&.parameterize&.underscore, scope: "cocina_display.field_label.title", default: :title)
-    end
-
-    # Add or remove padding from nonsorting portion of the title.
-    # @param value [String]
-    # @return [String]
-    def pad_nonsorting(value)
-      case value.strip
-      when /.*-$/, /.*'$/, "ה"  # Arabic, French, Hebrew prefixes use no padding
-        value.strip
-      when ""  # No nonsorting characters; return empty string
-        ""
-      else  # Pad to nonsorting char count if set, otherwise add a single space
-        if nonsorting_char_count.present?
-          value.ljust(nonsorting_char_count, " ")
-        else
-          value + " "
-        end
-      end
-    end
-  end
-end