mods_display 1.0.0.alpha5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee420c061ed577ae40b3acdf90215a8261ba96d63c53c96ed9d021ab3446fd31
-  data.tar.gz: cec3558b7a3886f25968aec482b1126e04f7f10132382cb787f5895666b37e62
+  metadata.gz: fca38dd10bf2fbf3ebe62b1162b82cd9c5f63c43fff47e8021ff8d0cfa2a3f62
+  data.tar.gz: 60f1b639ea711faf9d021534e429f8789f0bfe3d7a5be94aa9c73da765cf180b
 SHA512:
-  metadata.gz: 6b1a7cdb7e7f48cfd746e694577ceab478564d465416beab8cb9e307e70d0018fb06b17cf72a5be768ee7fbbf3e224b55c6bdbcada67779fb524633f750d8f08
-  data.tar.gz: 15002dc0bea304a8d933f89e0d99116b0804ddb5fd3f6f4ec104dd890406d596c3d5694d38ccb73707d4c3cb644fa29186f91e17a444635a0d2615930aac9825
+  metadata.gz: 6bf3145385c0d2e40b2cabe5db955a5ccb1abb3d63a6af3825c34da1e5d4cfef3d89020866dd6d3b2de71b1ed55516833c8a550cacab2899a7b496552f878878
+  data.tar.gz: abf9b36c1a4299c954c7851487404fa7b0f8a29cae6c48145cd9b37a0d032fffc46bd322f00cec3519df4b356bf676cbd7e085d7b8ff13fb2484a89e88114381

data/README.md

@@ -22,69 +22,6 @@ Or install it yourself as:
 
     $ gem install mods_display
 
-Include the `ModelExtension` into your model.
-
-    class MyClass
-      include ModsDisplay::ModelExtension
-    end
-
-Configure the source of the MODS XML in your model.  You can pass a string of XML to the mods_xml_source method, however it will also accept a block where you can call methods on self (so if the MODS XML string is held in MyClass#mods):
-
-    class MyClass
-      ....
-
-      mods_xml_source do |model|
-        model.mods
-      end
-
-    end
-
-Include the `ControllerExtension` into your rails controller (or another class if not using rails).
-
-    class MyController
-      include ModsDisplay::ControllerExtension
-    end
-
-Optionally configure the mods display gem (more on configuration later).
-
-    class MyController
-      ....
-      configure_mods_display do
-        ....
-      end
-    end
-
-## Usage
-
-Once installed, the class that included the `ControllerExtension` (`MyController`) will have the `render_mods_display` method available.  This method takes one argument which is an instance of the class that included the `ModelExtension` (`MyClass`).
-
-    render_mods_display(@model) # where @model.is_a?(MyClass)
-
-The basic render call will return the top-level ModsDisplay::HTML class object.  Any String method (e.g. #html_safe) you call on this top-level object will be sent down to the #to_html method which will return the HTML for all the metadata in the MODS document.
-
-    render_mods_display(@model).to_html
-
-You can abstract the main (first) title by calling #title on the top-level HTML method
-
-    render_mods_display(@model).title
-
-When getting JUST the main (first) title out of the metadata, it will be useful to get the rest of the metadata without the main title.  You can accomplish this by calling #body on the top-level HTML object.
-
-    render_mods_display(@model).body
-
-## Advanced Usage
-
-You can also access the array of ModsDisplay::Values objects for a given class directly by calling the name of the class. The class names are not always intuitive for public consumption so you may want to check the code the particular method to call.
-
-    render_mods_display(@model).abstract
-    => [#<ModsDisplay::Values @label="Abstract:", @values=["Hey. I'm an abstract."]>]
-
-Given that this semantics that we're concerned with here are more about titles and data construction rather than XML it may be required that you find something by the label. A common example of this is the imprint class.  The imprint class can return other publication data that is not the imprint statement.  You'll want to select (using your favorite enumerable method) the element in the array that is an imprint.
-
-    imprint = render_mods_display(@model).imprint.find do |data|
-      data.label == "Imprint:"
-    end.values
-
 ## Release/Upgrade Notes
 
 #### v0.5.0

data/app/components/mods_display/field_component.rb

@@ -22,7 +22,7 @@ module ModsDisplay
       if @value_transformer
         @value_transformer.call(value)
       else
-        helpers.link_urls_and_email(value)
+        helpers.format_mods_html(value, field: @field)
       end
     end
   end

data/app/helpers/mods_display/record_helper.rb

@@ -69,12 +69,19 @@ module ModsDisplay
       link
     end
 
-    # rubocop:disable Layout/LineLength
-    # @private, but used in PURL currently
-    def link_urls_and_email(val, tags: %w[a dl dd dt i b em strong br])
+    def format_mods_html(val, tags: %w[a dl dd dt i b em strong cite br], field: nil)
       val = val.gsub(%r{<[^/> ]+}) do |possible_tag|
         # Allow potentially valid HTML tags through to the sanitizer step, and HTML escape the rest
-        if tags.include? possible_tag[1..]
+        if tags.include?(possible_tag[1..])
+          possible_tag
+        else
+          "&lt;#{possible_tag[1..]}"
+        end
+      end
+
+      val = val.gsub(%r{</[^> ]+}) do |possible_tag|
+        # Allow potentially valid HTML tags through to the sanitizer step, and HTML escape the rest
+        if tags.include?(possible_tag[2..])
           possible_tag
         else
           "&lt;#{possible_tag[1..]}"
@@ -91,12 +98,31 @@ module ModsDisplay
           if match =~ email
             val.gsub!(match, "<a href='mailto:#{match}'>#{match}</a>")
           else
+            match = match.delete_suffix('&gt')
+
             val.gsub!(match, "<a href='#{match}'>#{match}</a>")
           end
         end
       end
 
-      sanitize val, tags: tags, attributes: %w[href]
+      formatted_val = sanitize val, tags: tags, attributes: %w[href]
+
+      # Martin Wong data has significant linebreaks in abstracts and notes that we want
+      # to preserve and display in HTML.
+      #
+      # See https://github.com/sul-dlss/mods_display/issues/78
+      simple_formatted_fields = [ModsDisplay::Abstract, ModsDisplay::Contents, ModsDisplay::Note]
+      if simple_formatted_fields.any? { |klass| field&.field.is_a? klass } && formatted_val.include?("\n")
+        simple_format(formatted_val, {}, sanitize: false)
+      else
+        formatted_val
+      end
+    end
+
+    # rubocop:disable Layout/LineLength
+    # @private, but used in PURL currently
+    def link_urls_and_email(val, tags: %w[a dl dd dt i b em strong cite br])
+      format_mods_html(val, tags: tags)
     end
     # rubocop:enable Layout/LineLength
   end

data/lib/mods_display/fields/access_condition.rb

@@ -73,18 +73,18 @@ module ModsDisplay
       when 'license'
         license_statement(element)
       else
-        element.text
+        element_text(element)
       end
     end
 
     def copyright_statement(element)
-      element.text.gsub(/\(c\) copyright/i, '©').gsub(/\(c\)/i, '©')
+      element_text(element).gsub(/\(c\) copyright/i, '©').gsub(/\(c\)/i, '©')
     end
 
     def license_statement(element)
-      matches = element.text.match(/^(?<code>.*) (?<type>.*):(?<description>.*)$/)
+      matches = element_text(element).match(/^(?<code>.*) (?<type>.*):(?<description>.*)$/)
 
-      return element.text unless matches
+      return element_text(element) unless matches
 
       code = matches[:code].downcase
       type = matches[:type].downcase

data/lib/mods_display/fields/cartographics.rb

@@ -10,9 +10,9 @@ module ModsDisplay
         next unless value.respond_to?(:cartographics)
 
         value.cartographics.each do |field|
-          scale = field.scale.empty? ? 'Scale not given' : field.scale.text
-          projection = field.projection.empty? ? nil : field.projection.text
-          coordinates = field.coordinates.empty? ? nil : field.coordinates.text
+          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(' ')

data/lib/mods_display/fields/collection.rb

@@ -16,7 +16,7 @@ module ModsDisplay
 
         return_fields << ModsDisplay::Values.new(
           label: collection_label(value),
-          values: [value.titleInfo.text.strip]
+          values: [element_text(value.titleInfo)]
         )
       end
       collapse_fields(return_fields)

data/lib/mods_display/fields/contact.rb

@@ -4,7 +4,10 @@ module ModsDisplay
   class Contact < Field
     def fields
       return_fields = contact_fields.map do |value|
-        ModsDisplay::Values.new(label: displayLabel(value) || I18n.t('mods_display.contact'), values: [value.text])
+        ModsDisplay::Values.new(
+          label: displayLabel(value) || I18n.t('mods_display.contact'),
+          values: [element_text(value)]
+        )
       end
       collapse_fields(return_fields)
     end

data/lib/mods_display/fields/contents.rb

@@ -4,7 +4,7 @@ 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")])
+        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/description.rb

@@ -4,7 +4,7 @@ module ModsDisplay
   class Description < Field
     def fields
       return_fields = description_fields.map do |value|
-        ModsDisplay::Values.new(label: description_label(value), values: [value.text])
+        ModsDisplay::Values.new(label: description_label(value), values: [element_text(value)])
       end
       collapse_fields(return_fields)
     end

data/lib/mods_display/fields/extent.rb

@@ -8,7 +8,7 @@ module ModsDisplay
       [
         ModsDisplay::Values.new(
           label: I18n.t('mods_display.extent'),
-          values: extent_fields.map(&:text)
+          values: extent_fields.map { |x| element_text(x) }
         )
       ]
     end

data/lib/mods_display/fields/field.rb

@@ -10,7 +10,8 @@ module ModsDisplay
       return_fields = @values.map do |value|
         ModsDisplay::Values.new(
           label: displayLabel(value) || label,
-          values: [value.text]
+          values: [element_text(value)],
+          field: self
         )
       end
       collapse_fields(return_fields)
@@ -52,5 +53,9 @@ module ModsDisplay
         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
   end
 end

data/lib/mods_display/fields/form.rb

@@ -8,7 +8,7 @@ module ModsDisplay
       [
         ModsDisplay::Values.new(
           label: I18n.t('mods_display.form'),
-          values: form_fields.map(&:text).uniq { |x| x.downcase.gsub(/\s/, '').gsub(/[[:punct:]]/, '') }
+          values: form_fields.map { |x| element_text(x) }.uniq { |x| x.downcase.gsub(/\s/, '').gsub(/[[:punct:]]/, '') }
         )
       ]
     end

data/lib/mods_display/fields/genre.rb

@@ -4,7 +4,7 @@ module ModsDisplay
   class Genre < Field
     def fields
       return_fields = @values.map do |value|
-        ModsDisplay::Values.new(label: displayLabel(value) || label, values: [value.text.strip.capitalize].flatten)
+        ModsDisplay::Values.new(label: displayLabel(value) || label, values: [element_text(value).capitalize].flatten)
       end
       collapse_fields(return_fields)
     end

data/lib/mods_display/fields/identifier.rb

@@ -4,7 +4,7 @@ module ModsDisplay
   class Identifier < Field
     def fields
       return_fields = @values.map do |value|
-        ModsDisplay::Values.new(label: displayLabel(value) || identifier_label(value), values: [value.text])
+        ModsDisplay::Values.new(label: displayLabel(value) || identifier_label(value), values: [element_text(value)])
       end
       collapse_fields(return_fields)
     end

data/lib/mods_display/fields/imprint.rb

@@ -31,7 +31,7 @@ module ModsDisplay
         other_pub_info(value).each do |pub_info|
           return_fields << ModsDisplay::Values.new(
             label: displayLabel(value) || pub_info_labels[pub_info.name.to_sym],
-            values: [pub_info.text.strip]
+            values: [element_text(pub_info)]
           )
         end
 
@@ -67,7 +67,7 @@ module ModsDisplay
         end
 
         # Element text reduced to digits and hyphen. Captures date ranges and
-        # negative (B.C.) dates. Used for comparison/deduping.
+        # negative (BCE) dates. Used for comparison/deduping.
         def base_value
           if text =~ /^\[?1\d{3}-\d{2}\??\]?$/
             return text.sub(/(\d{2})(\d{2})-(\d{2})/, '\1\2-\1\3')
@@ -93,10 +93,10 @@ module ModsDisplay
           when :year
             year = date.year
             if year < 1
-              "#{year.abs + 1} B.C."
-            # Any dates before the year 1000 are explicitly marked A.D.
+              "#{year.abs + 1} BCE"
+            # Any dates before the year 1000 are explicitly marked CE
             elsif year > 1 && year < 1000
-              "#{year} A.D."
+              "#{year} CE"
             else
               year.to_s
             end
@@ -109,7 +109,7 @@ module ModsDisplay
           end
         end
 
-        # Decoded date with "B.C." or "A.D." and qualifier markers. See (outdated):
+        # Decoded date with "BCE" or "CE" and qualifier markers. See (outdated):
         # https://consul.stanford.edu/display/chimera/MODS+display+rules#MODSdisplayrules-3b.%3CoriginInfo%3E
         def qualified_value
           date = decoded_value
@@ -143,7 +143,7 @@ module ModsDisplay
           @start&.encoding || @stop&.encoding
         end
 
-        # Decoded dates with "B.C." or "A.D." and qualifier markers applied to
+        # Decoded dates with "BCE" or "CE" and qualifier markers applied to
         # the entire range, or individually if dates differ.
         def qualified_value
           if @start&.qualifier == @stop&.qualifier
@@ -192,7 +192,7 @@ module ModsDisplay
                                .map(&:base_values).flatten
       dates = dates.reject { |date| range_base_values.include?(date.base_value) }
 
-      # output formatted dates with qualifiers, A.D./B.C., etc.
+      # output formatted dates with qualifiers, CE/BCE, etc.
       dates.map(&:qualified_value)
     end
 

data/lib/mods_display/fields/language.rb

@@ -11,7 +11,7 @@ module ModsDisplay
 
           ModsDisplay::Values.new(
             label: displayLabel(value) || displayLabel(term) || I18n.t('mods_display.language'),
-            values: [language_codes[term.text]]
+            values: [language_codes[element_text(term)]]
           )
         end.flatten.compact
       end.flatten.compact

data/lib/mods_display/fields/location.rb

@@ -10,10 +10,10 @@ module ModsDisplay
 
           if child.name.to_sym == :url
             loc_label = displayLabel(location) || I18n.t('mods_display.location')
-            value = "<a href='#{child.text}'>#{(displayLabel(child) || child.text).gsub(/:$/, '')}</a>"
+            value = "<a href='#{element_text(child)}'>#{(displayLabel(child) || element_text(child)).gsub(/:$/, '')}</a>"
           else
             loc_label = location_label(child) || displayLabel(location) || I18n.t('mods_display.location')
-            value = child.text
+            value = element_text(child)
           end
           return_fields << ModsDisplay::Values.new(
             label: loc_label || displayLabel(location) || I18n.t('mods_display.location'),

data/lib/mods_display/fields/name.rb

@@ -6,7 +6,7 @@ module ModsDisplay
     def fields
       return_fields = @values.map do |value|
         person = if value.displayForm.length.positive?
-                   ModsDisplay::Name::Person.new(name: value.displayForm.text)
+                   ModsDisplay::Name::Person.new(name: element_text(value.displayForm))
                  elsif !name_parts(value).empty?
                    ModsDisplay::Name::Person.new(name: name_parts(value))
                  end
@@ -58,7 +58,7 @@ module ModsDisplay
     end
 
     def format_role(element)
-      element.text.capitalize.sub(/[.,:;]+$/, '')
+      element_text(element).capitalize.sub(/[.,:;]+$/, '')
     end
 
     def role?(element)
@@ -87,7 +87,7 @@ module ModsDisplay
 
     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
 
@@ -95,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
@@ -121,7 +121,7 @@ module ModsDisplay
           end
         end.compact
       end
-      roles.map { |t| t.text.strip }
+      roles.map { |t| element_text(t) }
     end
 
     def unencoded_role_term?(element)

data/lib/mods_display/fields/nested_related_item.rb

@@ -25,7 +25,7 @@ module ModsDisplay
 
       component = ModsDisplay::ListFieldComponent.with_collection(
         fields,
-        value_transformer: ->(value) { helpers.link_urls_and_email(value.to_s) },
+        value_transformer: ->(value) { helpers.format_mods_html(value.to_s) },
         list_html_attributes: { class: 'mods_display_nested_related_items' },
         list_item_html_attributes: { class: 'mods_display_nested_related_item open' }
       )
@@ -37,7 +37,13 @@ module ModsDisplay
 
     def related_item_mods_object(value)
       mods = ::Stanford::Mods::Record.new.tap do |r|
-        r.from_str("<mods xmlns=\"http://www.loc.gov/mods/v3\">#{value.children.to_xml}</mods>")
+        # 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)
 

data/lib/mods_display/fields/note.rb

@@ -4,7 +4,7 @@ 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)], field: self)
       end
       collapse_fields(return_fields)
     end
@@ -12,7 +12,7 @@ module ModsDisplay
     private
 
     def delimiter
-      '<br />'
+      '<br />'.html_safe
     end
 
     def note_fields

data/lib/mods_display/fields/related_item.rb

@@ -9,13 +9,11 @@ module ModsDisplay
         next if related_item_is_a_collection?(value)
         next if render_nested_related_item?(value)
 
-        if related_item_is_a_location?(value)
-          process_location value
-        elsif 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
@@ -23,28 +21,32 @@ module ModsDisplay
     private
 
     def delimiter
-      '<br />'
-    end
-
-    def process_location(item)
-      ModsDisplay::Values.new(label: related_item_label(item), values: [item.location.text.strip])
+      '<br />'.html_safe
     end
 
-    def process_reference(item)
-      ModsDisplay::Values.new(label: related_item_label(item), values: [reference_title(item)])
-    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_related_item(item)
-      return unless item.titleInfo.length.positive?
+        return if title.empty?
 
-      title = item.titleInfo.text.strip
-      return_text = title
-      location = nil
-      location = item.location.url.text if item.location.length.positive? &&
-                                           item.location.url.length.positive?
-      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)

data/lib/mods_display/fields/resource_type.rb

@@ -4,7 +4,7 @@ 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/subject.rb

@@ -12,10 +12,10 @@ module ModsDisplay
           if respond_to?(:"process_#{child.name}")
             method_send = send(:"process_#{child.name}", child)
             return_text << method_send unless method_send.to_s.empty?
-          elsif child.text.include?('--')
-            return_text << child.text.split('--').map(&:strip)
+          elsif element_text(child).include?('--')
+            return_text << element_text(child).split('--').map(&:strip)
           else
-            return_text << child.text unless child.text.empty?
+            return_text << element_text(child) unless element_text(child).empty?
           end
         end
         return_values << return_text.flatten unless return_text.empty?
@@ -54,10 +54,10 @@ module ModsDisplay
     def values_from_subjects(element)
       return_values = []
       selected_subjects(element).each do |child|
-        return_values << if child.text.include?('--')
-                           child.text.split('--').map(&:strip)
+        return_values << if element_text(child).include?('--')
+                           element_text(child).split('--').map(&:strip)
                          else
-                           child.text.strip
+                           element_text(child)
                          end
       end
       return_values

data/lib/mods_display/fields/title.rb

@@ -16,7 +16,7 @@ module ModsDisplay
     private
 
     def delimiter
-      '<br />'
+      '<br />'.html_safe
     end
 
     def assemble_title(element)
@@ -24,7 +24,7 @@ module ModsDisplay
       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 = if title.empty? || title.end_with?(' ')

data/lib/mods_display/fields/values.rb

@@ -2,11 +2,12 @@
 
 module ModsDisplay
   class Values
-    attr_accessor :label, :values
+    attr_accessor :label, :values, :field
 
-    def initialize(label: nil, values: [])
+    def initialize(label: nil, values: [], field: nil)
       @label = label
       @values = values
+      @field = field
     end
   end
 end

data/lib/mods_display/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModsDisplay
-  VERSION = '1.0.0.alpha5'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha5
+  version: 1.2.0
 platform: ruby
 authors:
 - Jessie Keck
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stanford-mods
@@ -241,11 +241,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: The MODS Display gem allows implementers to configure a customized display