mods_display 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab657c57e41e5c014b54751efb2a1e7e2a3de69449215a040446ba56e5012cc3
-  data.tar.gz: 19b3ffeda4c16b78a66cbe644f8c1894cdce91ca1eac9902d52a89676357432b
+  metadata.gz: fca38dd10bf2fbf3ebe62b1162b82cd9c5f63c43fff47e8021ff8d0cfa2a3f62
+  data.tar.gz: 60f1b639ea711faf9d021534e429f8789f0bfe3d7a5be94aa9c73da765cf180b
 SHA512:
-  metadata.gz: df1c227cf9f7a8dc03ff406f3e6e18f5697324216621a609bd0c8e137a8ce3fc8b7cd2e1d11bb6354d40bc8d404790c9a2d6f6512b14338f4d903c9ea3c75eeb
-  data.tar.gz: 70063931db7fae164481f2be8d7e8ab0b155ed1231934deea4fb630092711a69c51b17ab499575f29ac02ee6af9036a10efbf9e2d1c8dded8bd0de11cd17d3e4
+  metadata.gz: 6bf3145385c0d2e40b2cabe5db955a5ccb1abb3d63a6af3825c34da1e5d4cfef3d89020866dd6d3b2de71b1ed55516833c8a550cacab2899a7b496552f878878
+  data.tar.gz: abf9b36c1a4299c954c7851487404fa7b0f8a29cae6c48145cd9b37a0d032fffc46bd322f00cec3519df4b356bf676cbd7e085d7b8ff13fb2484a89e88114381

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 cite 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..]}"
@@ -98,7 +105,24 @@ module ModsDisplay
         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/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/field.rb

@@ -10,7 +10,8 @@ module ModsDisplay
       return_fields = @values.map do |value|
         ModsDisplay::Values.new(
           label: displayLabel(value) || label,
-          values: [element_text(value)]
+          values: [element_text(value)],
+          field: self
         )
       end
       collapse_fields(return_fields)

data/lib/mods_display/fields/imprint.rb

@@ -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/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' }
       )

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: [element_text(value)])
+        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/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.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jessie Keck
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stanford-mods
@@ -245,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       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