mods_display 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c13877b6d0839a4341a26072d23f3e31ed3d27e173f05bb0b1cbbc6e5c0d77b1
-  data.tar.gz: d99b93bfb31352d75299990cea5810ce6668c06035fa5aa90d4ffd3f4fb31f0d
+  metadata.gz: a3c2bc98c15b659a075bccc6e3dea41e55f757f3318ad4d1e34109c314d10792
+  data.tar.gz: 3fc189b77cd0088578718fa5f1645e5390c0442825faacc51e7ec9de92f568c7
 SHA512:
-  metadata.gz: 281488c21b60e419dc943a7af91a08f0ab32c4ba92e6ed276b1c86ab0b64722c87a4915f81b482e25c968ecc3855da7736b2b699a0dc6534635bf1822cf73ab1
-  data.tar.gz: cebd18e35b4c81f9ac2dc3d2251a1bf9f8af7e2d9d36e1adc0561e33c48c5ca05faf057f8cd8df1943294aebd2a70914c9a25d7cf893e6aff3dd2e08061057af
+  metadata.gz: 2a35e824baad68b451eb64f126a3eea9eb61c0fd190c767933c4f6946336034d5f604fa8f81a24c1060ab9e29ed7c9d72c941f526b7bf42288870e51862d60fc
+  data.tar.gz: 9fbd968fe4409450090e9f3285a19f9eb86f3834ddf36061e6d4b5d5c617efaeb2996cdc88a8363a6cb29e79525403578e62266b0873423266d85ea484c461ed

data/Gemfile

@@ -3,6 +3,7 @@
 source 'https://rubygems.org'
 
 gem 'rubocop-rspec', require: false
+gem 'debug'
 
 # Specify your gem's dependencies in mods_display.gemspec
 gemspec

data/lib/mods_display/fields/imprint.rb

@@ -39,163 +39,20 @@ module ModsDisplay
       end
     end
 
-    def date_values(element)
-      date_field_keys.map do |date_field|
-        next unless element.respond_to?(date_field)
+    def date_values(element, date_field_keys: %i[dateCreated dateCaptured dateValid dateModified copyrightDate])
+      imprint = Stanford::Mods::Imprint.new(element)
 
-        elements = element.send(date_field)
-        next if elements.empty?
+      date_field_keys.map do |date_field|
+        date_values = imprint.dates([date_field])
+        next if date_values.empty?
 
         ModsDisplay::Values.new(
-          label: displayLabel(element) || pub_info_labels[elements.first.name.to_sym],
-          values: parse_dates(elements)
+          label: displayLabel(element) || pub_info_labels[date_field],
+          values: select_the_best_date(date_values)
         )
       end.compact
     end
 
-    class DateValue
-        attr_reader :value
-        delegate :text, :date, :point, :qualifier, :encoding, to: :value
-
-        def initialize(value)
-          @value = value
-        end
-
-        # True if the element text isn't blank or the placeholder "9999".
-        def valid?
-          text.present? && !['9999', '0000-00-00', 'uuuu'].include?(text.strip)
-        end
-
-        # Element text reduced to digits and hyphen. Captures date ranges and
-        # 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')
-          end
-
-          text.gsub(/(?<![\d])(\d{1,3})([xu-]{1,3})/i) { "#{$1}#{'0' * $2.length}"}.scan(/[\d-]/).join
-        end
-
-        # Decoded version of the date, if it was encoded. Strips leading zeroes.
-        def decoded_value
-          return text.strip unless date
-
-          unless encoding.present?
-            return text.strip unless text =~ /^-?\d+$/ || text =~ /^[\dXxu?-]{4}$/
-          end
-
-          # Delegate to the appropriate decoding method, if any
-          case value.precision
-          when :day
-            date.strftime('%B %e, %Y')
-          when :month
-            date.strftime('%B %Y')
-          when :year
-            year = date.year
-            if year < 1
-              "#{year.abs + 1} BCE"
-            # Any dates before the year 1000 are explicitly marked CE
-            elsif year > 1 && year < 1000
-              "#{year} CE"
-            else
-              year.to_s
-            end
-          when :century
-            return "#{(date.to_s[0..1].to_i + 1).ordinalize} century"
-          when :decade
-            return "#{date.year}s"
-          else
-            text.strip
-          end
-        end
-
-        # 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
-
-          return "[ca. #{date}]" if qualifier == 'approximate'
-          return "[#{date}?]" if qualifier == 'questionable'
-          return "[#{date}]" if qualifier == 'inferred'
-
-          date
-        end
-      end
-
-      class DateRange
-        def initialize(start: nil, stop: nil)
-          @start = start
-          @stop = stop
-        end
-
-        # Base value as hyphen-joined string. Used for comparison/deduping.
-        def base_value
-          "#{@start&.base_value}-#{@stop&.base_value}"
-        end
-
-        # Base values as array. Used for comparison/deduping of individual dates.
-        def base_values
-          [@start&.base_value, @stop&.base_value].compact
-        end
-
-        # The encoding value for the start of the range, or stop if not present.
-        def encoding
-          @start&.encoding || @stop&.encoding
-        end
-
-        # 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
-            qualifier = @start&.qualifier || @stop&.qualifier
-            date = "#{@start&.decoded_value}-#{@stop&.decoded_value}"
-            return "[ca. #{date}]" if qualifier == 'approximate'
-            return "[#{date}?]" if qualifier == 'questionable'
-            return "[#{date}]" if qualifier == 'inferred'
-
-            date
-          else
-            "#{@start&.qualified_value}-#{@stop&.qualified_value}"
-          end
-        end
-      end
-    def parse_dates(elements)
-      # convert to DateValue objects and keep only valid ones
-      dates = elements.map(&:as_object).flatten.map { |element| DateValue.new(element) }.select(&:valid?)
-
-      # join any date ranges into DateRange objects
-      point, nonpoint = dates.partition(&:point)
-      if point.any?
-        range = DateRange.new(start: point.find { |date| date.point == 'start' },
-                              stop: point.find { |date| date.point == 'end' })
-        nonpoint.unshift(range)
-      end
-      dates = nonpoint
-
-      # 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
-        if group.reject(&:encoding).any?
-          group.reject(&:encoding).first
-
-        # otherwise just randomly pick the last in the group
-        else
-          group.last
-        end
-      end
-
-      # if any single dates are already part of a range, discard them
-      range_base_values = dates.select { |date| date.is_a?(DateRange) }
-                               .map(&:base_values).flatten
-      dates = dates.reject { |date| range_base_values.include?(date.base_value) }
-
-      # output formatted dates with qualifiers, CE/BCE, etc.
-      dates.map(&:qualified_value)
-    end
-
     def other_pub_info(element)
       element.children.select do |child|
         pub_info_parts.include?(child.name.to_sym)
@@ -278,11 +135,14 @@ module ModsDisplay
       compact_and_join_with_delimiter(publishers, ' : ')
     end
 
-    def parts_element(value)
-      date_elements = %w[dateIssued dateOther].map do |date_field_name|
-        next unless value.respond_to?(date_field_name.to_sym)
+    def parts_element(value, date_field_keys: %i[dateIssued dateOther])
+      imprint = Stanford::Mods::Imprint.new(value)
 
-        parse_dates(value.send(date_field_name.to_sym))
+      date_elements = date_field_keys.map do |date_field|
+        date_values = imprint.dates([date_field])
+        next if date_values.empty?
+
+        select_the_best_date(date_values)
       end.flatten.compact.reject do |date|
         date.strip.empty?
       end.map(&:strip)
@@ -293,10 +153,6 @@ module ModsDisplay
       %i[issuance frequency]
     end
 
-    def date_field_keys
-      %i[dateCreated dateCaptured dateValid dateModified copyrightDate]
-    end
-
     def pub_info_labels
       { dateCreated: I18n.t('mods_display.date_created'),
         dateCaptured: I18n.t('mods_display.date_captured'),
@@ -306,5 +162,30 @@ module ModsDisplay
         issuance: I18n.t('mods_display.issuance'),
         frequency: I18n.t('mods_display.frequency') }
     end
+
+    def select_the_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
+        if group.reject(&:encoding).any?
+          group.reject(&:encoding).first
+
+        # otherwise just randomly pick the last in the group
+        else
+          group.last
+        end
+      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) }
+
+      # output formatted dates with qualifiers, CE/BCE, etc.
+      dates.map(&:qualified_value)
+    end
   end
 end

data/lib/mods_display/fields/name.rb

@@ -30,6 +30,11 @@ module ModsDisplay
       '<br />'
     end
 
+    # Override of Field#element_text to get text rather than HTML
+    def element_text(element)
+      element.text.strip
+    end
+
     def collapse_roles(fields)
       return [] if fields.blank?
 

data/lib/mods_display/fields/title.rb

@@ -3,9 +3,8 @@
 module ModsDisplay
   class Title < Field
     def fields
-      return_values = []
-      @values&.each do |value|
-        return_values << ModsDisplay::Values.new(
+      return_values = sorted_values.map do |value|
+        ModsDisplay::Values.new(
           label: displayLabel(value) || title_label(value),
           values: [assemble_title(value)]
         )
@@ -15,6 +14,11 @@ module ModsDisplay
 
     private
 
+    # If there is a node with usage="primary", then it should come first.
+    def sorted_values
+      Array(@values).sort_by { |node| node['usage'] == 'primary' ? 0 : 1 }
+    end
+
     def delimiter
       '<br />'.html_safe
     end

data/lib/mods_display/html.rb

@@ -35,9 +35,8 @@ module ModsDisplay
     end
 
     def title
-      return mods_field(:title).fields.first.values unless mods_field(:title).fields.empty?
-
-      ''
+      title_fields = mods_field(:title).fields
+      title_fields.empty? ? '' : title_fields.first.values
     end
 
     def render_in(view_context)
@@ -45,7 +44,7 @@ module ModsDisplay
     end
 
     # Need to figure out how to get the 1st title out of the list.
-    # Maybe have a separate class that will omit the first tite natively
+    # Maybe have a separate class that will omit the first title natively
     # and replace the first key in the the fields list with that.
     def body(view_context = ApplicationController.renderer)
       view_context.render ModsDisplay::RecordComponent.new(record: self), layout: false

data/lib/mods_display/version.rb

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

data/mods_display.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.version       = ModsDisplay::VERSION
   gem.authors       = ['Jessie Keck']
   gem.email         = ['jessie.keck@gmail.com']
-  gem.description   = 'MODS Display is a gem to centralize the display logic of MODS medadata.'
+  gem.description   = 'MODS Display is a gem to centralize the display logic of MODS metadata.'
   gem.summary       = 'The MODS Display gem allows implementers to configure a customized display of MODS metadata.  This display implements the specifications defined at Stanford for how to display MODS.'
   gem.homepage      = 'https://github.com/sul-dlss/mods_display'
 
@@ -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', '>= 3.0.0.alpha1', '< 4'
+  gem.add_dependency 'stanford-mods', '~> 3.3'
   gem.add_dependency 'i18n'
   gem.add_dependency 'view_component'
 
@@ -30,7 +30,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec-rails'
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'capybara'
-  gem.add_development_dependency 'byebug'
   gem.add_development_dependency 'rails', ENV['RAILS_VERSION'] || '~> 6.0'
   gem.add_development_dependency 'combustion', '~> 1.3'
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Jessie Keck
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stanford-mods
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0.alpha1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0.alpha1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -128,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -170,7 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: MODS Display is a gem to centralize the display logic of MODS medadata.
+description: MODS Display is a gem to centralize the display logic of MODS metadata.
 email:
 - jessie.keck@gmail.com
 executables: []
@@ -245,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: The MODS Display gem allows implementers to configure a customized display