mods_display 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db5aacb765a91a03b8fe5fbb6c41b52ab0cb2f94467808f5e896f9b95c5b72ad
-  data.tar.gz: b0572788c7868f49d98340668a28e71dde9cd41f676927436ce2ec9d09f24f83
+  metadata.gz: cd385f9d4aea6c14524378831877c327c6fdfd2664356e148b457af9c26a5623
+  data.tar.gz: b66857f71c766dc6edb03b8783d1d63486e94c63c8e9a71a0474f6b5a11d44cc
 SHA512:
-  metadata.gz: 283a91d3efc90f2cdac50c2adae6133e758084ed454bbc9c79000567d9f83696e15369089290609c709e2c38b4e9e02a19d264297ff48e529aaf232bfd02f773
-  data.tar.gz: a22877a514a7379219856dc941dfca980eb23aa7c8b0d2e8f12a8d023300dee4655ca1ef7e87e3ec36fe980c524eb07af848425d8b920b5d41324ae995871751
+  metadata.gz: 6b4760e8eee0c1eef22badaf5087b4095c4c88766c3b128bbaa1e841e2b1aa34294ced0be7199875b6aa57cdf1b3385dd5c11d624f4ce818afcc7fa4f1da25ab
+  data.tar.gz: 93c93c4249b55816c9716b1c632d0b4c5b5a2874365e33139fbbf6cd9421f01d3aa9800d347c72ae7837bcf98ef763650e8151a3cab547cecb287a72ff7a9ace

data/.rubocop.yml

@@ -29,4 +29,10 @@ RSpec/MultipleExpectations:
   Enabled: false
 
 RSpec/ExampleLength:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/VariableName:
   Enabled: false

data/lib/mods_display/fields/imprint.rb

@@ -64,12 +64,12 @@ module ModsDisplay
                        element.place.respond_to?(:placeTerm)
 
       if unencoded_place_terms?(element)
-        element.place.placeTerm.select do |term|
+        element.xpath('mods:place/mods:placeTerm', mods: MODS_NS).select do |term|
           !term.attributes['type'].respond_to?(:value) ||
             term.attributes['type'].value == 'text'
         end.compact
       else
-        element.place.placeTerm.map do |term|
+        element.xpath('mods:place/mods:placeTerm', mods: MODS_NS).map do |term|
           next unless term.attributes['type'].respond_to?(:value) &&
                       term.attributes['type'].value == 'code' &&
                       term.attributes['authority'].respond_to?(:value) &&
@@ -84,7 +84,7 @@ module ModsDisplay
     end
 
     def unencoded_place_terms?(element)
-      element.place.placeTerm.any? do |term|
+      element.xpath('mods:place/mods:placeTerm', mods: MODS_NS).any? do |term|
         !term.attributes['type'].respond_to?(:value) ||
           term.attributes['type'].value == 'text'
       end

data/lib/mods_display/fields/name.rb

@@ -8,12 +8,8 @@ module ModsDisplay
     #  { role1 label => [ ModsDisplay:Name:Person,  ModsDisplay:Name:Person, ...], role2 label => [ ModsDisplay:Name:Person,  ModsDisplay:Name:Person, ...] }
     def fields
       return_fields = @values.map do |value|
-        name_identifiers = value.element_children.select { |child| child.name == 'nameIdentifier' }
-        person = if value.displayForm.length.positive?
-                   ModsDisplay::Name::Person.new(name: element_text(value.displayForm), name_identifiers: name_identifiers)
-                 elsif !name_parts(value).empty?
-                   ModsDisplay::Name::Person.new(name: name_parts(value), name_identifiers: name_identifiers)
-                 end
+        name_parts = ModsDisplay::NameFormatter.format(value)
+        person = name_parts ? ModsDisplay::Name::Person.new(name: name_parts, name_identifiers: value.xpath('mods:nameIdentifier', mods: MODS_NS)) : nil
         # The person may have multiple roles, so we have to divide them up into an array
         role_labels(value).collect do |role_label|
           ModsDisplay::Values.new(label: displayLabel(value) || role_label, values: [person]) if person
@@ -50,10 +46,10 @@ module ModsDisplay
 
     def role_labels(element)
       default_label = I18n.t('mods_display.associated_with')
-      return [default_label] unless element.role.present? && element.role.roleTerm.present?
+      return [default_label] unless element.xpath('mods:role/mods:roleTerm', mods: MODS_NS).present?
 
-      element.role.collect do |role|
-        codes, text = role.roleTerm.partition { |term| term['type'] == 'code' }
+      element.xpath('mods:role', mods: MODS_NS).collect do |role|
+        codes, text = role.xpath('mods:roleTerm', mods: MODS_NS).partition { |term| term['type'] == 'code' }
 
         # prefer mappable role term codes
         label = codes.map { |term| relator_codes[term.text.downcase] }.first
@@ -70,76 +66,6 @@ module ModsDisplay
       element_text(element).capitalize.sub(/[.,:;]+$/, '')
     end
 
-    def role?(element)
-      element.respond_to?(:role) && !element.role.empty?
-    end
-
-    def primary?(element)
-      element.attributes['usage'].respond_to?(:value) &&
-        element.attributes['usage'].value == 'primary'
-    end
-
-    def name_parts(element)
-      output = [unqualified_name_parts(element),
-                qualified_name_parts(element, 'family'),
-                qualified_name_parts(element, 'given')].flatten.compact.join(', ')
-      terms = qualified_name_parts(element, 'termsOfAddress')
-      unless terms.empty?
-        term_delimiter = ', '
-        term_delimiter = ' ' if name_part_begins_with_roman_numeral?(terms.first)
-        output = [output, terms.join(', ')].flatten.compact.join(term_delimiter)
-      end
-      dates = qualified_name_parts(element, 'date')
-      output = [output, qualified_name_parts(element, 'date')].flatten.compact.join(', ') unless dates.empty?
-      output
-    end
-
-    def unqualified_name_parts(element)
-      element.namePart.map do |part|
-        element_text(part) unless part.attributes['type']
-      end.compact
-    end
-
-    def qualified_name_parts(element, type)
-      element.namePart.map do |part|
-        if part.attributes['type'].respond_to?(:value) &&
-           part.attributes['type'].value == type
-          element_text(part)
-        end
-      end.compact
-    end
-
-    def name_part_begins_with_roman_numeral?(part)
-      first_part = part.split(/\s|,/).first.strip
-      first_part.chars.all? do |char|
-        %w[I X C L V].include? char
-      end
-    end
-
-    def unencoded_role_term(element)
-      roles = element.role.map do |role|
-        role.roleTerm.find do |term|
-          term.attributes['type'].respond_to?(:value) &&
-            term.attributes['type'].value == 'text'
-        end
-      end.compact
-      if roles.empty?
-        roles = element.role.map do |role|
-          role.roleTerm.find do |term|
-            !term.attributes['type'].respond_to?(:value)
-          end
-        end.compact
-      end
-      roles.map { |t| element_text(t) }
-    end
-
-    def unencoded_role_term?(element)
-      element.role.roleTerm.any? do |term|
-        !term.attributes['type'].respond_to?(:value) ||
-          term.attributes['type'].value == 'text'
-      end
-    end
-
     # Consolidate all names under label headings
     def consolidate_under_labels(fields)
       results = {}
@@ -194,7 +120,7 @@ module ModsDisplay
 
       def orcid_identifier(name_identifiers)
         orcid = name_identifiers.select do |name_identifier|
-          name_identifier.attribute('type')&.value == 'orcid'
+          name_identifier.get_attribute('type') == 'orcid'
         end
         orcid.first&.text
       end

data/lib/mods_display/fields/nested_related_item.rb

@@ -10,8 +10,8 @@ module ModsDisplay
 
     def fields
       @fields ||= begin
-        return_fields = @values.map do |value|
-          next if related_item_is_a_collection?(value)
+        return_fields = RelatedItemValue.for_values(@values).map do |value|
+          next if value.collection?
           next unless render_nested_related_item?(value)
 
           related_item_mods_object(value)
@@ -63,7 +63,7 @@ module ModsDisplay
 
     def related_item_label(item)
       return displayLabel(item) if displayLabel(item)
-      return I18n.t('mods_display.constituent') if related_item_is_a_constituent?(item)
+      return I18n.t('mods_display.constituent') if item.constituent?
 
       I18n.t('mods_display.host')
     end

data/lib/mods_display/fields/related_item.rb

@@ -5,8 +5,8 @@ module ModsDisplay
     include ModsDisplay::RelatedItemConcerns
 
     def fields
-      return_fields = @values.map do |value|
-        next if related_item_is_a_collection?(value)
+      return_fields = RelatedItemValue.for_values(@values).map do |value|
+        next if value.collection?
         next if render_nested_related_item?(value)
 
         text = related_item_value(value)
@@ -25,15 +25,14 @@ module ModsDisplay
     end
 
     def related_item_value(item)
-      if related_item_is_a_location?(item)
-        element_text(item.location)
-      elsif related_item_is_a_reference?(item)
+      if item.location?
+        element_text(item.location_nodeset)
+      elsif item.reference?
         reference_title(item)
-      elsif item.titleInfo.any?
-        title = element_text(item.titleInfo)
+      elsif item.titleInfo_nodeset.any?
+        title = element_text(item.titleInfo_nodeset)
         location = nil
-        location = element_text(item.location.url) if item.location.length.positive? &&
-                                                      item.location.url.length.positive?
+        location = element_text(item.location_url_nodeset) if item.location_url_nodeset.length.positive?
 
         return if title.empty?
 
@@ -42,31 +41,18 @@ module ModsDisplay
         else
           title
         end
-      elsif item.note.any?
-        citation = item.note.find { |note| note['type'] == 'preferred citation' }
+      elsif item.note_nodeset.any?
+        citation = item.note_nodeset.find { |note| note['type'] == 'preferred citation' }
 
         element_text(citation) if citation
       end
     end
 
     def reference_title(item)
-      [item.titleInfo,
+      [item.titleInfo_nodeset,
        item.originInfo.dateOther,
        item.part.detail.number,
-       item.note].flatten.compact.map!(&:text).map!(&:strip).join(' ')
-    end
-
-    def related_item_is_a_location?(item)
-      !related_item_is_a_collection?(item) &&
-        !related_item_is_a_reference?(item) &&
-        item.location.length.positive? &&
-        item.titleInfo.empty?
-    end
-
-    def related_item_is_a_reference?(item)
-      !related_item_is_a_collection?(item) &&
-        item.attributes['type'].respond_to?(:value) &&
-        item.attributes['type'].value == 'isReferencedBy'
+       item.note_nodeset].flatten.compact.map!(&:text).map!(&:strip).join(' ')
     end
 
     def related_item_label(item)
@@ -74,9 +60,9 @@ module ModsDisplay
         displayLabel(item)
       else
         case
-        when related_item_is_a_location?(item)
+        when item.location?
           return I18n.t('mods_display.location')
-        when related_item_is_a_reference?(item)
+        when item.reference?
           return I18n.t('mods_display.referenced_by')
         end
         I18n.t('mods_display.related_item')

data/lib/mods_display/name_formatter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class NameFormatter
+    def self.format(element)
+      new(element).format
+    end
+
+    def initialize(element)
+      @element = element
+    end
+
+    def format
+      return element_text(display_form_nodeset) if display_form_nodeset.present?
+      return name_parts if name_parts.present?
+
+      nil
+    end
+
+    private
+
+    attr_reader :element
+
+    def name_parts
+      @name_parts ||= begin
+        output = [unqualified_name_parts(name_part_nodeset),
+                  qualified_name_parts(name_part_nodeset, 'family'),
+                  qualified_name_parts(name_part_nodeset, 'given')].flatten.compact.join(', ')
+        terms = qualified_name_parts(name_part_nodeset, 'termsOfAddress')
+        unless terms.empty?
+          term_delimiter = ', '
+          term_delimiter = ' ' if name_part_begins_with_roman_numeral?(terms.first)
+          output = [output, terms.join(', ')].flatten.compact.join(term_delimiter)
+        end
+        dates = qualified_name_parts(name_part_nodeset, 'date')
+        output = [output, dates].flatten.compact.join(', ') unless dates.empty?
+        output
+      end
+    end
+
+    def unqualified_name_parts(name_part_nodeset)
+      name_part_nodeset.map do |part|
+        element_text(part) unless part.attributes['type']
+      end.compact
+    end
+
+    def qualified_name_parts(name_part_nodeset, type)
+      name_part_nodeset.map do |part|
+        element_text(part) if part.get_attribute('type') == type
+      end.compact
+    end
+
+    def name_part_begins_with_roman_numeral?(part)
+      first_part = part.split(/\s|,/).first.strip
+      first_part.chars.all? do |char|
+        %w[I X C L V].include? char
+      end
+    end
+
+    def element_text(element)
+      element.text.strip
+    end
+
+    def name_part_nodeset
+      @name_part_nodeset ||= element.xpath('mods:namePart', mods: MODS_NS)
+    end
+
+    def display_form_nodeset
+      @display_form_nodeset ||= element.xpath('mods:displayForm', mods: MODS_NS)
+    end
+  end
+end

data/lib/mods_display/related_item_concerns.rb

@@ -5,25 +5,60 @@ module ModsDisplay
     private
 
     def render_nested_related_item?(item)
-      related_item_is_a_constituent?(item) || related_item_is_host?(item)
+      item.constituent? || item.host?
     end
 
-    def related_item_is_a_collection?(item)
-      item.respond_to?(:titleInfo) &&
-        item.respond_to?(:typeOfResource) &&
-        !item.typeOfResource.attributes.empty? &&
-        item.typeOfResource.attributes.first.key?('collection') &&
-        item.typeOfResource.attributes.first['collection'].value == 'yes'
-    end
+    class RelatedItemValue < SimpleDelegator
+      def collection?
+        @collection ||= typeOfResource_nodeset.first&.get_attribute('collection') == 'yes'
+      end
 
-    def related_item_is_a_constituent?(item)
-      item.attributes['type'].respond_to?(:value) &&
-        item.attributes['type'].value == 'constituent'
-    end
+      def constituent?
+        @constituent ||= type_attribute == 'constituent'
+      end
+
+      def host?
+        @host ||= type_attribute == 'host'
+      end
+
+      def location?
+        @location ||= !collection? &&
+                      !reference? &&
+                      location_nodeset.length.positive? &&
+                      titleInfo_nodeset.empty?
+      end
+
+      def reference?
+        @reference ||= !collection? && type_attribute == 'isReferencedBy'
+      end
+
+      def typeOfResource_nodeset
+        @typeOfResource_nodeset ||= xpath('mods:typeOfResource', mods: MODS_NS)
+      end
+
+      def location_nodeset
+        @location_nodeset ||= xpath('mods:location', mods: MODS_NS)
+      end
+
+      def location_url_nodeset
+        @location_url_nodeset ||= xpath('mods:location/mods:url', mods: MODS_NS)
+      end
+
+      def titleInfo_nodeset
+        @titleInfo_nodeset ||= xpath('mods:titleInfo', mods: MODS_NS)
+      end
+
+      def note_nodeset
+        @note_nodeset ||= xpath('mods:note', mods: MODS_NS)
+      end
+
+      def type_attribute
+        @type_attribute ||= get_attribute('type')
+      end
 
-    def related_item_is_host?(item)
-      item.attributes['type'].respond_to?(:value) &&
-        item.attributes['type'].value == 'host'
+      def self.for_values(values)
+        values.map { |value| new(value) }
+      end
     end
   end
 end

data/lib/mods_display/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModsDisplay
-  VERSION = '1.3.4'
+  VERSION = '1.4.0'
 end

data/lib/mods_display.rb

@@ -5,6 +5,7 @@ require 'mods_display/html'
 require 'mods_display/country_codes'
 require 'mods_display/relator_codes'
 require 'mods_display/related_item_concerns'
+require 'mods_display/name_formatter'
 require 'mods_display/fields/field'
 require 'mods_display/fields/abstract'
 require 'mods_display/fields/access_condition'
@@ -40,6 +41,8 @@ I18n::Backend::Simple.include I18n::Backend::Fallbacks
 I18n.load_path += Dir["#{File.expand_path('..', __dir__)}/config/locales/*.yml"]
 I18n.backend.load_translations
 
+MODS_NS = 'http://www.loc.gov/mods/v3'
+
 begin
   require 'rails'
 rescue LoadError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Jessie Keck
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2023-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stanford-mods
@@ -223,6 +223,7 @@ files:
 - lib/mods_display/fields/title.rb
 - lib/mods_display/fields/values.rb
 - lib/mods_display/html.rb
+- lib/mods_display/name_formatter.rb
 - lib/mods_display/related_item_concerns.rb
 - lib/mods_display/relator_codes.rb
 - lib/mods_display/version.rb
@@ -245,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: The MODS Display gem allows implementers to configure a customized display