mods_display 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd385f9d4aea6c14524378831877c327c6fdfd2664356e148b457af9c26a5623
-  data.tar.gz: b66857f71c766dc6edb03b8783d1d63486e94c63c8e9a71a0474f6b5a11d44cc
+  metadata.gz: 4152dce7ec61d92e04a5cddf9c5c152c414eeb725c05b975be1ec66eeadc2fa7
+  data.tar.gz: '087502061c3666fe0b4eec7c00a2a93e9532610cb4b35d7de6555a3dd7d2a8c8'
 SHA512:
-  metadata.gz: 6b4760e8eee0c1eef22badaf5087b4095c4c88766c3b128bbaa1e841e2b1aa34294ced0be7199875b6aa57cdf1b3385dd5c11d624f4ce818afcc7fa4f1da25ab
-  data.tar.gz: 93c93c4249b55816c9716b1c632d0b4c5b5a2874365e33139fbbf6cd9421f01d3aa9800d347c72ae7837bcf98ef763650e8151a3cab547cecb287a72ff7a9ace
+  metadata.gz: 1843e6a4f59a79c0f54f757e9c99820af6235681eea8a2c494bb40a6291db2f0408b6af26a6b8541bd91348cd1572c87329e510c12713df2afe9e72aea1a6baa
+  data.tar.gz: b4f433ae7fe636d51b92222cf64e8cbabdadcdc3aca05333165d9f0699957a59f94a4d254efad3e43e908f2b8991d12d7e70a652cdd10b15e639a7317b98d889

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -1,6 +1,15 @@
 # ModsDisplay
 
-A gem for displaying MODS Metadata in a configurable way.
+A gem for displaying MODS Metadata in a configurable way.  
+
+This gem is used to centralize the display logic of MODS metadata by creating html fragments such as
+
+```
+   <dt>Publisher</dt>
+   <dd>Diagon Alley Publications</dd>
+```
+
+which can be styled in consuming apps such as SearchWorks or Exhibits.
 
 ## Demo
 
@@ -20,23 +29,6 @@ Or install it yourself as:
 
     $ gem install mods_display
 
-## Release/Upgrade Notes
-
-#### v0.5.0
-There are three major changes in this version.
-
-1. RelatedItem nodes with a type of `constituent` or `host` are now treated separately and will render the full MODS display of any nested metadata.  If accessing the `ModsDisplay::Values` directly through their accessors (e.g. custom grouping), this new metadata is available under `.nested_related_items`.
-    * _**Note:** You may want to style and add some javascript toggling behavior (see exhibits for an example)._
-2. Name nodes are now grouped/labeled by their role.  If you were iterating over the names and splitting them out by their labels, that will need to change.
-3. Table of contents/Summaries are now split on `--` and rendered as an unordered list.
-    * _**Note:** You may want to style this list._
-
-#### v0.3.0
-
-Labels now have internationalization support.  We have added colons to the english labels due to certain languages' punctuation rules requiring different spacing between the label and colon.
-
-Given that fact, you will want to update any pre 0.3.0 code that searches for elements by label in a way that would fail with the presence of a colon.
-
 ## Contributing
 
 1. Fork it

data/app/components/mods_display/row_field_component.html.erb

@@ -0,0 +1,11 @@
+<% values.each do |value| %>
+  <tr>
+    <% if label %>
+      <%= tag.th label, **label_html_attributes %>
+    <% end %>
+
+    <%= tag.td **value_html_attributes do %>
+      <%= value %>
+    <% end %>
+  </tr>
+<% end %>

data/app/components/mods_display/row_field_component.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class RowFieldComponent < ViewComponent::Base
+    with_collection_parameter :field
+
+    def initialize(field:, delimiter: nil, label_html_attributes: {}, value_html_attributes: {}, value_transformer: nil)
+      super
+
+      @field = field
+      @delimiter = delimiter
+      @value_transformer = value_transformer
+      @label_html_attributes = label_html_attributes
+      @value_html_attributes = value_html_attributes
+    end
+
+    attr_reader :field, :delimiter, :label_html_attributes, :value_html_attributes
+
+    def render?
+      field.values.any?(&:present?)
+    end
+
+    def format_value(value)
+      if @value_transformer
+        @value_transformer.call(value)
+      else
+        helpers.format_mods_html(value, field: field)
+      end
+    end
+
+    def values
+      if delimiter
+        [safe_join(field.values.select(&:present?).map { |value| format_value(value) }, delimiter)]
+      else
+        field.values.select(&:present?).map { |value| format_value(value) }
+      end
+    end
+
+    def label
+      field.label&.sub(/:$/, '')
+    end
+  end
+end

data/app/helpers/mods_display/record_helper.rb

@@ -17,6 +17,14 @@ module ModsDisplay
       render component.new(field: field, delimiter: delimiter, value_transformer: block)
     end
 
+    def mods_record_definition_field(field, delimiter: nil, label_html_attributes: {}, &block)
+      render ModsDisplay::FieldComponent.new(field: field, delimiter: delimiter, label_html_attributes: label_html_attributes, value_transformer: block)
+    end
+
+    def mods_record_row_field(field, delimiter: ', ', &block)
+      render ModsDisplay::RowFieldComponent.new(field: field, delimiter: delimiter, value_transformer: block)
+    end
+
     # this returns a role's label and the display names for ModsDisplay:Name:Person
     def mods_name_field(field)
       mods_record_field(field) do |name|
@@ -41,12 +49,24 @@ module ModsDisplay
       end
     end
 
+    def mods_subject_row_field(field, delimiter: nil, &block)
+      mods_record_row_field(field, delimiter: delimiter) do |subject_line|
+        safe_join(link_mods_subjects(subject_line, &block), ' > ')
+      end
+    end
+
     def mods_genre_field(field, &block)
       mods_record_field(field) do |genre_line|
         link_to_mods_subject(genre_line, &block)
       end
     end
 
+    def mods_genre_row_field(field, delimiter: nil, &block)
+      mods_record_row_field(field, delimiter: delimiter) do |genre_line|
+        link_to_mods_subject(genre_line, &block)
+      end
+    end
+
     # @private
     def link_mods_genres(genre, &block)
       link_buffer = []

data/config/locales/en.yml

@@ -17,11 +17,14 @@ en:
     creation_production_credits: "Creation/Production credits:"
     date_captured: "Date captured:"
     date_created: "Date created:"
+    date_issued: "Publication date:"
     date_modified: "Date modified:"
+    date_other: "Other date:"
     date_sequential_designation: "Date/Sequential designation:"
     date_valid: "Date valid:"
     digital_origin: "Digital origin:"
     doi: "DOI:"
+    edition: "Edition:"
     extent: "Extent:"
     form: "Form:"
     frequency: "Frequency:"

data/lib/mods_display/fields/access_condition.rb

@@ -51,10 +51,10 @@ module ModsDisplay
     }.freeze
 
     def fields
-      return_fields = @values.map do |value|
+      return_fields = @stanford_mods_elements.map do |stanford_mods_element|
         ModsDisplay::Values.new(
-          label: displayLabel(value) || access_label(value),
-          values: [process_access_statement(value)],
+          label: displayLabel(stanford_mods_element) || access_label(stanford_mods_element),
+          values: [process_access_statement(stanford_mods_element)],
           field: self
         )
       end
@@ -85,7 +85,7 @@ module ModsDisplay
     def license_statement(element)
       element_text = element_text(element)
       legacy_matches = element_text.match(/^(?<code>.*) (?<type>.*):(?<description>.*)$/)
-      return legacy_license_statement(element, legacy_matches) if legacy_matches
+      return legacy_license_statement(legacy_matches) if legacy_matches
 
       matches = element_text.match(/^This work is licensed under a (.+?)\.$/)
       return linked_licensed_statement(element, matches) if matches && element['xlink:href'].present?
@@ -97,7 +97,7 @@ module ModsDisplay
       "This work is licensed under a <a href='#{element['xlink:href']}'>#{matches[1]}</a>."
     end
 
-    def legacy_license_statement(_element, matches)
+    def legacy_license_statement(matches)
       code = matches[:code].downcase
       type = matches[:type].downcase
       description = license_description(code, type) || matches[:description]

data/lib/mods_display/fields/cartographics.rb

@@ -3,22 +3,20 @@
 module ModsDisplay
   class Cartographics < Field
     def fields
-      return nil if @values.nil?
+      return nil if @stanford_mods_elements.nil?
 
       return_fields = []
-      @values.each do |value|
-        next unless value.respond_to?(:cartographics)
+      @stanford_mods_elements.each do |subject_element|
+        next unless subject_element.respond_to?(:cartographics)
 
-        value.cartographics.each do |field|
+        subject_element.cartographics.each do |field|
           scale = field.scale.empty? ? 'Scale not given' : element_text(field.scale)
           projection = field.projection.empty? ? nil : element_text(field.projection)
           coordinates = field.coordinates.empty? ? nil : element_text(field.coordinates)
-          post_scale = if [projection,
-                           coordinates].compact.length.positive?
-                         [projection, coordinates].compact.join(' ')
-                       end
+          post_scale = [projection, coordinates].compact.join(' ') if [projection, coordinates].compact.length.positive?
+
           return_fields << ModsDisplay::Values.new(
-            label: (displayLabel(field) || label || I18n.t('mods_display.map_data')),
+            label: displayLabel(field) || label || I18n.t('mods_display.map_data'),
             values: [[scale, post_scale].compact.join(' ; ')]
           )
         end

data/lib/mods_display/fields/collection.rb

@@ -5,18 +5,18 @@ module ModsDisplay
   #  Collection class to parse collection data out of Mods relatedItem fields
   ###
   class Collection < Field
-    def collection_label(value)
-      displayLabel(value) || I18n.t('mods_display.collection')
+    def collection_label(related_item_element)
+      displayLabel(related_item_element) || I18n.t('mods_display.collection')
     end
 
     def fields
       return_fields = []
-      @values.each do |value|
-        next unless related_item_is_a_collection?(value)
+      @stanford_mods_elements.each do |related_item_element|
+        next unless related_item_is_a_collection?(related_item_element)
 
         return_fields << ModsDisplay::Values.new(
-          label: collection_label(value),
-          values: [element_text(value.titleInfo)]
+          label: collection_label(related_item_element),
+          values: [element_text(related_item_element.titleInfo)]
         )
       end
       collapse_fields(return_fields)
@@ -24,17 +24,17 @@ module ModsDisplay
 
     private
 
-    def related_item_is_a_collection?(value)
-      value.respond_to?(:titleInfo) && resource_type_is_collection?(value)
+    def related_item_is_a_collection?(related_item_element)
+      related_item_element.respond_to?(:titleInfo) && resource_type_is_collection?(related_item_element)
     end
 
-    def resource_type_is_collection?(value)
-      return false unless value.respond_to?(:typeOfResource)
-      return false unless value.typeOfResource.attributes.length.positive?
+    def resource_type_is_collection?(related_item_element)
+      return false unless related_item_element.respond_to?(:typeOfResource)
+      return false unless related_item_element.typeOfResource.attributes.length.positive?
 
-      value.typeOfResource.attributes.length.positive? &&
-        value.typeOfResource.attributes.first.key?('collection') &&
-        value.typeOfResource.attributes.first['collection'].value == 'yes'
+      related_item_element.typeOfResource.attributes.length.positive? &&
+        related_item_element.typeOfResource.attributes.first.key?('collection') &&
+        related_item_element.typeOfResource.attributes.first['collection'].value == 'yes'
     end
   end
 end

data/lib/mods_display/fields/contact.rb

@@ -3,10 +3,10 @@
 module ModsDisplay
   class Contact < Field
     def fields
-      return_fields = contact_fields.map do |value|
+      return_fields = contact_elements.map do |contact_element|
         ModsDisplay::Values.new(
-          label: displayLabel(value) || I18n.t('mods_display.contact'),
-          values: [element_text(value)]
+          label: displayLabel(contact_element) || I18n.t('mods_display.contact'),
+          values: [element_text(contact_element)]
         )
       end
       collapse_fields(return_fields)
@@ -14,10 +14,10 @@ module ModsDisplay
 
     private
 
-    def contact_fields
-      @values.select do |value|
-        value.attributes['type'].respond_to?(:value) &&
-          value.attributes['type'].value.downcase == 'contact'
+    def contact_elements
+      @stanford_mods_elements.select do |note_element|
+        note_element.attributes['type'].respond_to?(:value) &&
+          note_element.attributes['type'].value.downcase == 'contact'
       end
     end
   end

data/lib/mods_display/fields/contents.rb

@@ -4,7 +4,11 @@ module ModsDisplay
   class Contents < Field
     def to_html(view_context = ApplicationController.renderer)
       f = fields.map do |field|
-        ModsDisplay::Values.new(label: field.label, values: [field.values.join("\n\n")], field: self)
+        ModsDisplay::Values.new(
+          label: field.label,
+          values: [field.values.join("\n\n")],
+          field: self
+        )
       end
 
       helpers = view_context.respond_to?(:simple_format) ? view_context : ApplicationController.new.view_context

data/lib/mods_display/fields/copyright_date.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class CopyrightDate < Field
+    def fields
+      date_fields(:copyrightDate)
+    end
+  end
+end

data/lib/mods_display/fields/date_captured.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class DateCaptured < Field
+    def fields
+      date_fields(:dateCaptured)
+    end
+  end
+end

data/lib/mods_display/fields/date_created.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class DateCreated < Field
+    def fields
+      date_fields(:dateCreated)
+    end
+  end
+end

data/lib/mods_display/fields/date_issued.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class DateIssued < Field
+    def fields
+      date_fields(:dateIssued)
+    end
+  end
+end

data/lib/mods_display/fields/date_modified.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class DateModified < Field
+    def fields
+      date_fields(:dateModified)
+    end
+  end
+end

data/lib/mods_display/fields/date_other.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class DateOther < Field
+    def fields
+      date_fields(:dateOther)
+    end
+
+    private
+
+    # this is called from the Field.select_best_date method
+    # @param date [Stanford::Mods::Imprint::Date]
+    def qualified_value_with_type(date)
+      type = type_attribute_value(date)
+      type ? "#{date.qualified_value} (#{type})" : date.qualified_value
+    end
+
+    def type_attribute_value(date)
+      if date.is_a?(Stanford::Mods::Imprint::DateRange)
+        date.start.value.type || date.stop.value.type
+      else
+        date.value.type
+      end
+    end
+  end
+end

data/lib/mods_display/fields/date_valid.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class DateValid < Field
+    def fields
+      date_fields(:dateValid)
+    end
+  end
+end

data/lib/mods_display/fields/description.rb

@@ -3,8 +3,11 @@
 module ModsDisplay
   class Description < Field
     def fields
-      return_fields = description_fields.map do |value|
-        ModsDisplay::Values.new(label: description_label(value), values: [element_text(value)])
+      return_fields = description_fields.map do |element|
+        ModsDisplay::Values.new(
+          label: description_label(element),
+          values: [element_text(element)]
+        )
       end
       collapse_fields(return_fields)
     end
@@ -16,7 +19,7 @@ module ModsDisplay
     private
 
     def description_fields
-      @values.children.select do |child|
+      @stanford_mods_elements.children.select do |child|
         labels.keys.include?(child.name.to_sym)
       end
     end

data/lib/mods_display/fields/edition.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class Edition < Field
+    def fields
+      return_fields = @stanford_mods_elements.map do |origin_info_element|
+        edition_value = Stanford::Mods::Imprint.new(origin_info_element).edition_vals_str
+        next unless edition_value.present?
+
+        # remove trailing spaces (thanks MARC, for catalog card formatting!)
+        edition_value.gsub!(%r{ */$}, '')
+
+        ModsDisplay::Values.new(
+          label: I18n.t('mods_display.edition'),
+          values: [edition_value],
+          field: self
+        )
+      end.compact
+      collapse_fields(return_fields)
+    end
+  end
+end

data/lib/mods_display/fields/extent.rb

@@ -3,20 +3,20 @@
 module ModsDisplay
   class Extent < Field
     def fields
-      return [] unless extent_fields.present?
+      return [] unless extent_elements.present?
 
       [
         ModsDisplay::Values.new(
           label: I18n.t('mods_display.extent'),
-          values: extent_fields.map { |x| element_text(x) }
+          values: extent_elements.map { |x| element_text(x) }
         )
       ]
     end
 
     private
 
-    def extent_fields
-      @values.map(&:extent).flatten
+    def extent_elements
+      @stanford_mods_elements.map(&:extent).flatten
     end
   end
 end

data/lib/mods_display/fields/field.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
 module ModsDisplay
+  # superclass for processing stanford-mods elements into ModsDisplay::Values retrieved by the fields method
+  #   by consuming applications.
   class Field
-    def initialize(values)
-      @values = values
+    # @stanford_mods_elements is an array of Nokogiri::XML::Element-ish objects from stanford-mods
+    # per ModsDisplay::HTML::MODS_DISPLAY_FIELD_MAPPING
+    def initialize(stanford_mods_elements)
+      @stanford_mods_elements = stanford_mods_elements
     end
 
     def fields
-      return_fields = @values.map do |value|
+      return_fields = @stanford_mods_elements.map do |stanford_mods_element|
         ModsDisplay::Values.new(
-          label: displayLabel(value) || label,
-          values: [element_text(value)],
+          label: displayLabel(stanford_mods_element) || label,
+          values: [element_text(stanford_mods_element)],
           field: self
         )
       end
@@ -18,9 +22,9 @@ module ModsDisplay
     end
 
     def label
-      return nil if @values.nil?
+      return nil if @stanford_mods_elements.nil?
 
-      displayLabel(@values.first)
+      displayLabel(@stanford_mods_elements.first)
     end
 
     def to_html(view_context = ApplicationController.renderer)
@@ -50,12 +54,54 @@ module ModsDisplay
       display_fields.slice_when { |before, after| before.label != after.label }.map do |group|
         next group.first if group.length == 1
 
-        ModsDisplay::Values.new(label: group.first.label, values: group.map(&:values).flatten(1))
+        ModsDisplay::Values.new(
+          label: group.first.label,
+          values: group.map(&:values).flatten(1)
+        )
       end
     end
 
     def element_text(element)
       element.xpath('.//text()').to_html.strip
     end
+
+    # used for originInfo date fields, e.g. DateCreated, DateIssued ...
+    def date_fields(date_symbol)
+      return_fields = @stanford_mods_elements.map do |origin_info_element|
+        date_values = Stanford::Mods::Imprint.new(origin_info_element).dates([date_symbol])
+        next unless date_values.present?
+
+        ModsDisplay::Values.new(
+          label: I18n.t("mods_display.#{date_symbol.to_s.underscore}"),
+          values: select_best_date(date_values),
+          field: self
+        )
+      end.compact
+      collapse_fields(return_fields)
+    end
+
+    # used for originInfo dates, e.g. for Imprint, DateCreated, DateIssued, etc.
+    def select_best_date(dates)
+      # ensure dates are unique with respect to their base values
+      dates = dates.group_by(&:base_value).map do |_value, group|
+        group.first if group.one?
+
+        # if one of the duplicates wasn't encoded, use that one (see:
+        #   https://consul.stanford.edu/display/chimera/MODS+display+rules#MODSdisplayrules-3b.%3CoriginInfo%3E),
+        #   otherwise just randomly pick the last in the group
+        group.reject(&:encoding).first || group.last
+      end
+
+      # if any single dates are already part of a range, discard them
+      range_base_values = dates.select { |date| date.is_a?(Stanford::Mods::Imprint::DateRange) }
+                               .map(&:base_values).flatten
+      dates = dates.reject { |date| range_base_values.include?(date.base_value) }
+
+      # for DateOther field (but not for Imprint field), include the type attribute value in parens
+      return dates.map { |date| qualified_value_with_type(date) } if instance_of?(ModsDisplay::DateOther)
+
+      # output formatted dates with qualifiers, CE/BCE, etc.
+      dates.map(&:qualified_value)
+    end
   end
 end

data/lib/mods_display/fields/form.rb

@@ -3,20 +3,20 @@
 module ModsDisplay
   class Form < Field
     def fields
-      return [] unless form_fields.present?
+      return [] unless form_elements.present?
 
       [
         ModsDisplay::Values.new(
           label: I18n.t('mods_display.form'),
-          values: form_fields.map { |x| element_text(x) }.uniq { |x| x.downcase.gsub(/\s/, '').gsub(/[[:punct:]]/, '') }
+          values: form_elements.map { |x| element_text(x) }.uniq { |x| x.downcase.gsub(/\s/, '').gsub(/[[:punct:]]/, '') }
         )
       ]
     end
 
     private
 
-    def form_fields
-      @values.map(&:form).flatten
+    def form_elements
+      @stanford_mods_elements.map(&:form).flatten
     end
   end
 end

data/lib/mods_display/fields/frequency.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class Frequency < Field
+    def fields
+      return_fields = @stanford_mods_elements.map do |origin_info_element|
+        frequency_value = origin_info_element.frequency&.text&.strip
+        next unless frequency_value.present?
+
+        ModsDisplay::Values.new(
+          label: I18n.t('mods_display.frequency'),
+          values: [frequency_value],
+          field: self
+        )
+      end.compact
+      collapse_fields(return_fields)
+    end
+  end
+end

data/lib/mods_display/fields/genre.rb

@@ -3,8 +3,11 @@
 module ModsDisplay
   class Genre < Field
     def fields
-      return_fields = @values.map do |value|
-        ModsDisplay::Values.new(label: displayLabel(value) || label, values: [element_text(value).capitalize].flatten)
+      return_fields = @stanford_mods_elements.map do |genre_element|
+        ModsDisplay::Values.new(
+          label: displayLabel(genre_element) || label,
+          values: [element_text(genre_element).capitalize].flatten
+        )
       end
       collapse_fields(return_fields)
     end

data/lib/mods_display/fields/geo.rb

@@ -25,8 +25,8 @@ module ModsDisplay
     end
 
     def geo_extensions
-      @geo_values ||= @values.select do |value|
-        displayLabel(value) =~ /^geo:?$/
+      @geo_values ||= @stanford_mods_elements.select do |extension_element|
+        displayLabel(extension_element) =~ /^geo:?$/
       end
     end
   end