mods_display 1.0.0.alpha4 → 1.1.0

data/lib/mods_display/fields/name.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Name < Field
     include ModsDisplay::RelatorCodes
     def fields
       return_fields = @values.map do |value|
-        person = if value.displayForm.length > 0
-                   ModsDisplay::Name::Person.new(name: value.displayForm.text)
+        person = if value.displayForm.length.positive?
+                   ModsDisplay::Name::Person.new(name: element_text(value.displayForm))
                  elsif !name_parts(value).empty?
                    ModsDisplay::Name::Person.new(name: name_parts(value))
                  end
@@ -40,11 +42,25 @@ 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?
-      element.role.roleTerm.collect do |role|
-        relator_codes[role.text.downcase] || role.text.capitalize || default_label
+
+      element.role.collect do |role|
+        codes, text = role.roleTerm.partition { |term| term['type'] == 'code' }
+
+        # prefer mappable role term codes
+        label = codes.map { |term| relator_codes[term.text.downcase] }.first
+
+        # but fall back to given text
+        label ||= text.map { |term| format_role(term) }.first
+
+        # or just the default
+        label || default_label
       end.uniq
     end
 
+    def format_role(element)
+      element_text(element).capitalize.sub(/[.,:;]+$/, '')
+    end
+
     def role?(element)
       element.respond_to?(:role) && !element.role.empty?
     end
@@ -55,10 +71,9 @@ module ModsDisplay
     end
 
     def name_parts(element)
-      output = ''
-      output << [unqualified_name_parts(element),
-                 qualified_name_parts(element, 'family'),
-                 qualified_name_parts(element, 'given')].flatten.compact.join(', ')
+      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 = ', '
@@ -66,15 +81,13 @@ module ModsDisplay
         output = [output, terms.join(', ')].flatten.compact.join(term_delimiter)
       end
       dates = qualified_name_parts(element, 'date')
-      unless dates.empty?
-        output = [output, qualified_name_parts(element, 'date')].flatten.compact.join(', ')
-      end
+      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|
-        part.text unless part.attributes['type']
+        element_text(part) unless part.attributes['type']
       end.compact
     end
 
@@ -82,7 +95,7 @@ module ModsDisplay
       element.namePart.map do |part|
         if part.attributes['type'].respond_to?(:value) &&
            part.attributes['type'].value == type
-          part.text
+          element_text(part)
         end
       end.compact
     end
@@ -90,7 +103,7 @@ module ModsDisplay
     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
+        %w[I X C L V].include? char
       end
     end
 
@@ -98,15 +111,17 @@ module ModsDisplay
       roles = element.role.map do |role|
         role.roleTerm.find do |term|
           term.attributes['type'].respond_to?(:value) &&
-          term.attributes['type'].value == 'text'
+            term.attributes['type'].value == 'text'
         end
       end.compact
-      roles = element.role.map do |role|
-        role.roleTerm.find do |term|
-          !term.attributes['type'].respond_to?(:value)
-        end
-      end.compact if roles.empty?
-      roles.map { |t| t.text.strip }
+      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)
@@ -130,7 +145,7 @@ module ModsDisplay
     # Normalize label headings by filtering out some punctuation and ending in :
     def normalize_labels(label_order, results)
       label_order.uniq.map do |k|
-        label = k.tr('.', '').tr(':', '').strip + ':'
+        label = "#{k.tr('.', '').tr(':', '').strip}:"
         if label != k
           results[label] = results[k]
           results.delete(k)
@@ -152,8 +167,9 @@ module ModsDisplay
 
     class Person
       attr_accessor :name
+
       def initialize(data)
-        @name =  data[:name]
+        @name = data[:name]
       end
 
       def to_s

data/lib/mods_display/fields/nested_related_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   ##
   # This class will hopefully take over for related item support more broadly.
@@ -21,7 +23,12 @@ module ModsDisplay
     def to_html(view_context = ApplicationController.renderer)
       helpers = view_context.respond_to?(:simple_format) ? view_context : ApplicationController.new.view_context
 
-      component = ModsDisplay::ListFieldComponent.with_collection(fields, value_transformer: ->(value) { helpers.link_urls_and_email(value.to_s) }, list_html_attributes: { class: 'mods_display_nested_related_items' }, list_item_html_attributes: { class: 'mods_display_nested_related_item open' })
+      component = ModsDisplay::ListFieldComponent.with_collection(
+        fields,
+        value_transformer: ->(value) { helpers.link_urls_and_email(value.to_s) },
+        list_html_attributes: { class: 'mods_display_nested_related_items' },
+        list_item_html_attributes: { class: 'mods_display_nested_related_item open' }
+      )
 
       view_context.render component, layout: false
     end
@@ -29,7 +36,15 @@ module ModsDisplay
     private
 
     def related_item_mods_object(value)
-      mods = ::Stanford::Mods::Record.new.tap { |r| r.from_str("<mods>#{value.children.to_xml}</mods>", false) }
+      mods = ::Stanford::Mods::Record.new.tap do |r|
+        # dup'ing the value adds the appropriate namespaces, but...
+        munged_node = value.dup.tap do |x|
+          # ... the mods gem also expects the root of the document to have the root tag <mods>
+          x.name = 'mods'
+        end
+
+        r.from_nk_node(munged_node)
+      end
       related_item = ModsDisplay::HTML.new(mods)
 
       ModsDisplay::Values.new(
@@ -42,6 +57,7 @@ module ModsDisplay
       body = related_item.body
 
       return if body == '<dl></dl>'
+
       body
     end
 

data/lib/mods_display/fields/note.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Note < Field
     def fields
       return_fields = note_fields.map do |value|
-        ModsDisplay::Values.new(label: displayLabel(value) || note_label(value), values: [value.text])
+        ModsDisplay::Values.new(label: displayLabel(value) || note_label(value), values: [element_text(value)])
       end
       collapse_fields(return_fields)
     end
@@ -25,20 +27,20 @@ module ModsDisplay
       if element.attributes['type'].respond_to?(:value)
         return note_labels[element.attributes['type'].value] || "#{element.attributes['type'].value.capitalize}:"
       end
+
       I18n.t('mods_display.note')
     end
 
     def note_labels
       { 'statement of responsibility' => I18n.t('mods_display.statement_of_responsibility'),
         'date/sequential designation' => I18n.t('mods_display.date_sequential_designation'),
-        'publications'                => I18n.t('mods_display.publications'),
-        'references'                  => I18n.t('mods_display.references'),
-        'bibliography'                => I18n.t('mods_display.bibliography'),
-        'preferred citation'          => I18n.t('mods_display.preferred_citation'),
-        'biographical/historical'     => I18n.t('mods_display.biographical_historical'),
+        'publications' => I18n.t('mods_display.publications'),
+        'references' => I18n.t('mods_display.references'),
+        'bibliography' => I18n.t('mods_display.bibliography'),
+        'preferred citation' => I18n.t('mods_display.preferred_citation'),
+        'biographical/historical' => I18n.t('mods_display.biographical_historical'),
         'creation/production credits' => I18n.t('mods_display.creation_production_credits'),
-        'citation/reference'          => I18n.t('mods_display.citation_reference')
-       }
+        'citation/reference' => I18n.t('mods_display.citation_reference') }
     end
   end
 end

data/lib/mods_display/fields/related_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class RelatedItem < Field
     include ModsDisplay::RelatedItemConcerns
@@ -6,14 +8,12 @@ module ModsDisplay
       return_fields = @values.map do |value|
         next if related_item_is_a_collection?(value)
         next if render_nested_related_item?(value)
-        case
-        when related_item_is_a_location?(value)
-          process_location value
-        when related_item_is_a_reference?(value)
-          process_reference value
-        else
-          process_related_item(value)
-        end
+
+        text = related_item_value(value)
+
+        next if text.nil? || text.empty?
+
+        ModsDisplay::Values.new(label: related_item_label(value), values: [text])
       end.compact
       collapse_fields(return_fields)
     end
@@ -21,27 +21,32 @@ module ModsDisplay
     private
 
     def delimiter
-      '<br />'
+      '<br />'.html_safe
     end
 
-    def process_location(item)
-      ModsDisplay::Values.new(label: related_item_label(item), values: [item.location.text.strip])
-    end
+    def related_item_value(item)
+      if related_item_is_a_location?(item)
+        element_text(item.location)
+      elsif related_item_is_a_reference?(item)
+        reference_title(item)
+      elsif item.titleInfo.any?
+        title = element_text(item.titleInfo)
+        location = nil
+        location = element_text(item.location.url) if item.location.length.positive? &&
+                                                      item.location.url.length.positive?
 
-    def process_reference(item)
-      ModsDisplay::Values.new(label: related_item_label(item), values: [reference_title(item)])
-    end
+        return if title.empty?
 
-    def process_related_item(item)
-      return unless item.titleInfo.length > 0
-      title = item.titleInfo.text.strip
-      return_text = title
-      location = nil
-      location = item.location.url.text if item.location.length > 0 &&
-                                           item.location.url.length > 0
-      return_text = "<a href='#{location}'>#{title}</a>" if location && !title.empty?
+        if location
+          "<a href='#{location}'>#{title}</a>".html_safe
+        else
+          title
+        end
+      elsif item.note.any?
+        citation = item.note.find { |note| note['type'] == 'preferred citation' }
 
-      ModsDisplay::Values.new(label: related_item_label(item), values: [return_text]) unless return_text.empty?
+        element_text(citation) if citation
+      end
     end
 
     def reference_title(item)
@@ -54,8 +59,8 @@ module ModsDisplay
     def related_item_is_a_location?(item)
       !related_item_is_a_collection?(item) &&
         !related_item_is_a_reference?(item) &&
-        item.location.length > 0 &&
-        item.titleInfo.length < 1
+        item.location.length.positive? &&
+        item.titleInfo.empty?
     end
 
     def related_item_is_a_reference?(item)
@@ -66,7 +71,7 @@ module ModsDisplay
 
     def related_item_label(item)
       if displayLabel(item)
-        return displayLabel(item)
+        displayLabel(item)
       else
         case
         when related_item_is_a_location?(item)

data/lib/mods_display/fields/resource_type.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class ResourceType < Field
     def fields
       return_fields = @values.map do |value|
-        ModsDisplay::Values.new(label: displayLabel(value) || label, values: [value.text.strip])
+        ModsDisplay::Values.new(label: displayLabel(value) || label, values: [element_text(value)])
       end
       collapse_fields(return_fields)
     end

data/lib/mods_display/fields/sub_title.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class SubTitle < ModsDisplay::Title
     def initialize(values)

data/lib/mods_display/fields/subject.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Subject < Field
     def fields
@@ -7,23 +9,19 @@ module ModsDisplay
         label = displayLabel(value) || I18n.t('mods_display.subject')
         return_text = []
         selected_subjects(value).each do |child|
-          if self.respond_to?(:"process_#{child.name}")
+          if respond_to?(:"process_#{child.name}")
             method_send = send(:"process_#{child.name}", child)
             return_text << method_send unless method_send.to_s.empty?
+          elsif element_text(child).include?('--')
+            return_text << element_text(child).split('--').map(&:strip)
           else
-            if child.text.include?('--')
-              return_text << child.text.split('--').map(&:strip)
-            else
-              return_text << child.text unless child.text.empty?
-            end
+            return_text << element_text(child) unless element_text(child).empty?
           end
         end
         return_values << return_text.flatten unless return_text.empty?
-        unless return_values.empty?
-          return_fields << ModsDisplay::Values.new(label: label, values: return_values)
-        end
+        return_fields << ModsDisplay::Values.new(label: label, values: return_values) unless return_values.empty?
       end
-      collapse_subjects return_fields
+      collapse_fields return_fields
     end
 
     # Would really like to clean this up, but it works and is tested for now.
@@ -44,7 +42,7 @@ module ModsDisplay
     def process_name(element)
       name = ModsDisplay::Name.new([element]).fields.first
 
-      name.values.first if name
+      name&.values&.first
     end
 
     private
@@ -56,54 +54,23 @@ module ModsDisplay
     def values_from_subjects(element)
       return_values = []
       selected_subjects(element).each do |child|
-        if child.text.include?('--')
-          return_values << child.text.split('--').map(&:strip)
-        else
-          return_values << child.text.strip
-        end
+        return_values << if element_text(child).include?('--')
+                           element_text(child).split('--').map(&:strip)
+                         else
+                           element_text(child)
+                         end
       end
       return_values
     end
 
     def selected_subjects(element = @value)
-      element.children.select do |child|
-        !omit_elements.include?(child.name.to_sym)
+      element.children.reject do |child|
+        omit_elements.include?(child.name.to_sym)
       end
     end
 
     def omit_elements
-      [:cartographics, :geographicCode, :text]
-    end
-
-    # Providing subject specific collapsing method so we can
-    # collapse the labels w/o flattening all the subject fields.
-    def collapse_subjects(display_fields)
-      return_values = []
-      current_label = nil
-      prev_label = nil
-      buffer = []
-      display_fields.each_with_index do |field, index|
-        current_label = field.label
-        current_values = field.values
-        if display_fields.length == 1
-          return_values << ModsDisplay::Values.new(label: current_label, values: current_values)
-        elsif index == (display_fields.length - 1)
-          # need to deal w/ when we have a last element but we have separate labels in the buffer.
-          if current_label != prev_label
-            return_values << ModsDisplay::Values.new(label: prev_label, values: [buffer.flatten(1)])
-            return_values << ModsDisplay::Values.new(label: current_label, values: current_values)
-          else
-            buffer.concat(current_values)
-            return_values << ModsDisplay::Values.new(label: current_label, values: buffer.flatten(0))
-          end
-        elsif prev_label && (current_label != prev_label)
-          return_values << ModsDisplay::Values.new(label: prev_label, values: buffer.flatten(0))
-          buffer = []
-        end
-        buffer.concat(current_values)
-        prev_label = current_label
-      end
-      return_values
+      %i[cartographics geographicCode text]
     end
   end
 end

data/lib/mods_display/fields/title.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Title < Field
     def fields
       return_values = []
-      if @values
-        @values.each do |value|
-          return_values << ModsDisplay::Values.new(
-            label: displayLabel(value) || title_label(value),
-            values: [assemble_title(value)]
-          )
-        end
+      @values&.each do |value|
+        return_values << ModsDisplay::Values.new(
+          label: displayLabel(value) || title_label(value),
+          values: [assemble_title(value)]
+        )
       end
       collapse_fields(return_values)
     end
@@ -16,33 +16,32 @@ module ModsDisplay
     private
 
     def delimiter
-      '<br />'
+      '<br />'.html_safe
     end
 
     def assemble_title(element)
-      return displayForm(element) if displayForm(element)
-
       title = ''
       previous_element = nil
 
       element.children.select { |value| title_parts.include? value.name }.each do |value|
-        str = value.text.strip
+        str = element_text(value)
         next if str.empty?
 
-        delimiter = case
-        when title.empty?, title.end_with?(' ')
-          nil
-        when title.end_with?('.', ',', ':', ';')
-          ' '
-        when value.name == 'subTitle'
-          ' : '
-        when value.name == 'partName' && previous_element.name == 'partNumber'
-          ', '
-        when value.name == 'partNumber', value.name == 'partName'
-          '. '
-        else
-          ' '
-        end
+        delimiter = if title.empty? || title.end_with?(' ')
+                      nil
+                    elsif previous_element&.name == 'nonSort' && title.end_with?('-', '\'')
+                      nil
+                    elsif title.end_with?('.', ',', ':', ';')
+                      ' '
+                    elsif value.name == 'subTitle'
+                      ' : '
+                    elsif value.name == 'partName' && previous_element.name == 'partNumber'
+                      ', '
+                    elsif value.name == 'partNumber' || value.name == 'partName'
+                      '. '
+                    else
+                      ' '
+                    end
 
         title += delimiter if delimiter
         title += str
@@ -50,7 +49,18 @@ module ModsDisplay
         previous_element = value
       end
 
-      title
+      if element['type'] == 'uniform' && element['nameTitleGroup'].present?
+        [uniform_title_name_part(element), title].compact.join('. ')
+      else
+        title
+      end
+    end
+
+    def uniform_title_name_part(element)
+      names = element.xpath("//m:name[@nameTitleGroup=\"#{element['nameTitleGroup']}\"]", **Mods::Record::NS_HASH)
+      names = element.xpath("//name[@nameTitleGroup=\"#{element['nameTitleGroup']}\"]") if names.empty?
+
+      ModsDisplay::Name.new(names).fields.first&.values&.first&.to_s
     end
 
     def title_parts
@@ -62,14 +72,15 @@ module ModsDisplay
          title_labels.key?(element.attributes['type'].value)
         return title_labels[element.attributes['type'].value]
       end
+
       I18n.t('mods_display.title')
     end
 
     def title_labels
       { 'abbreviated' => I18n.t('mods_display.abbreviated_title'),
-        'translated'  => I18n.t('mods_display.translated_title'),
+        'translated' => I18n.t('mods_display.translated_title'),
         'alternative' => I18n.t('mods_display.alternative_title'),
-        'uniform'     => I18n.t('mods_display.uniform_title') }
+        'uniform' => I18n.t('mods_display.uniform_title') }
     end
   end
 end

data/lib/mods_display/fields/values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Values
     attr_accessor :label, :values

data/lib/mods_display/html.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class HTML
     MODS_DISPLAY_FIELD_MAPPING = {
@@ -33,9 +35,8 @@ module ModsDisplay
     end
 
     def title
-      unless mods_field(:title).fields.empty?
-        return mods_field(:title).fields.first.values
-      end
+      return mods_field(:title).fields.first.values unless mods_field(:title).fields.empty?
+
       ''
     end
 

data/lib/mods_display/related_item_concerns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   module RelatedItemConcerns
     private
@@ -16,12 +18,12 @@ module ModsDisplay
 
     def related_item_is_a_constituent?(item)
       item.attributes['type'].respond_to?(:value) &&
-      item.attributes['type'].value == 'constituent'
+        item.attributes['type'].value == 'constituent'
     end
 
     def related_item_is_host?(item)
       item.attributes['type'].respond_to?(:value) &&
-      item.attributes['type'].value == 'host'
+        item.attributes['type'].value == 'host'
     end
   end
 end

data/lib/mods_display/relator_codes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   module RelatorCodes
     def relator_codes

data/lib/mods_display/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
-  VERSION = '1.0.0.alpha4'
+  VERSION = '1.1.0'
 end

data/lib/mods_display.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mods_display/version'
 require 'mods_display/html'
 require 'mods_display/country_codes'
@@ -34,14 +36,14 @@ require 'stanford-mods'
 
 require 'i18n'
 require 'i18n/backend/fallbacks'
-I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
-I18n.load_path += Dir["#{File.expand_path('../..', __FILE__)}/config/locales/*.yml"]
+I18n::Backend::Simple.include I18n::Backend::Fallbacks
+I18n.load_path += Dir["#{File.expand_path('..', __dir__)}/config/locales/*.yml"]
 I18n.backend.load_translations
 
 begin
   require 'rails'
 rescue LoadError
-  #do nothing
+  # do nothing
 end
 
 require 'mods_display/engine' if defined?(Rails)

data/mods_display.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
   gem.executables = gem.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'stanford-mods', '~> 2.1'
+  gem.add_dependency 'stanford-mods', '>= 3.0.0.alpha1', '< 4'
   gem.add_dependency 'i18n'
   gem.add_dependency 'view_component'