mods_display 1.0.0.alpha4 → 1.1.0

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/Rakefile

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+  task.options = ['--fail-level', 'error']
+end
+
 RSpec::Core::RakeTask.new(:spec)
 
 task :ci do
-  # Commenting out Rubocop as part of the CI build temporarily
-  # because TravisCI is not respecting the .rubocop_todo.yml
-  # You can and should still run rubocop in your editor or
-  # from the command line manually.
-  # Rake::Task['rubocop'].invoke
+  Rake::Task['rubocop'].invoke
   Rake::Task['spec'].invoke
 end
 

data/app/components/mods_display/field_component.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class FieldComponent < ViewComponent::Base
     with_collection_parameter :field

data/app/components/mods_display/list_field_component.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class ListFieldComponent < ModsDisplay::FieldComponent
     def initialize(field:, list_html_attributes: {}, list_item_html_attributes: {}, **args)

data/app/components/mods_display/record_component.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class RecordComponent < ViewComponent::Base
     DEFAULT_FIELDS = [

data/app/helpers/mods_display/record_helper.rb

@@ -15,7 +15,7 @@ module ModsDisplay
       render component.new(field: field, delimiter: delimiter, value_transformer: block)
     end
 
-    def mods_name_field(field, &block)
+    def mods_name_field(field)
       mods_record_field(field) do |name|
         block_given? ? capture { yield(name.name) } : name.name
       end
@@ -55,15 +55,13 @@ module ModsDisplay
       link_buffer = []
       linked_subjects = []
       subjects.each do |subject|
-        if subject.present?
-          linked_subjects << link_to_mods_subject(subject, link_buffer, &block)
-        end
+        linked_subjects << link_to_mods_subject(subject, link_buffer, &block) if subject.present?
       end
       linked_subjects
     end
 
     # @private
-    def link_to_mods_subject(subject, buffer = [], &block)
+    def link_to_mods_subject(subject, buffer = [])
       subject_text = subject.respond_to?(:name) ? subject.name : subject
       link = block_given? ? capture { yield(subject_text, buffer) } : subject_text
       buffer << subject_text.strip
@@ -73,7 +71,7 @@ module ModsDisplay
 
     # 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])
+    def link_urls_and_email(val, tags: %w[a dl dd dt i b em strong cite br])
       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..]
@@ -93,6 +91,8 @@ 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
@@ -101,6 +101,5 @@ module ModsDisplay
       sanitize val, tags: tags, attributes: %w[href]
     end
     # rubocop:enable Layout/LineLength
-
   end
 end

data/app/models/mods_display/record.rb

@@ -14,7 +14,8 @@ module ModsDisplay
 
     def mods_record
       return if xml.nil?
-      @mods_record ||= Stanford::Mods::Record.new.tap { |mods| mods.from_str(xml, false) }
+
+      @mods_record ||= Stanford::Mods::Record.new.tap { |mods| mods.from_str(xml) }
     end
 
     def mods_display_html

data/config.ru

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "rubygems"
-require "bundler"
+require 'rubygems'
+require 'bundler'
 
 Bundler.require :default, :development
 

data/lib/mods_display/country_codes.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module ModsDisplay
   module CountryCodes
     def country_codes

data/lib/mods_display/fields/abstract.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Abstract < Field
     private

data/lib/mods_display/fields/access_condition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class AccessCondition < Field
     LICENSES = {
@@ -71,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, '&copy;').gsub(/\(c\)/i, '&copy;')
+      element_text(element).gsub(/\(c\) copyright/i, '&copy;').gsub(/\(c\)/i, '&copy;')
     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
@@ -111,21 +113,22 @@ module ModsDisplay
     def access_label(element)
       type = normalize_type(element)
       return access_labels[type] if access_labels.key?(type)
+
       I18n.t('mods_display.access_condition')
     end
 
     def normalize_type(element)
       type = element.attributes['type']
       return type.value.strip.gsub(/\s*/, '').downcase if type.respond_to?(:value)
+
       ''
     end
 
     def access_labels
-      { 'useandreproduction'  => I18n.t('mods_display.use_and_reproduction'),
+      { 'useandreproduction' => I18n.t('mods_display.use_and_reproduction'),
         'restrictiononaccess' => I18n.t('mods_display.restriction_on_access'),
-        'copyright'           => I18n.t('mods_display.copyright'),
-        'license'             => I18n.t('mods_display.license')
-       }
+        'copyright' => I18n.t('mods_display.copyright'),
+        'license' => I18n.t('mods_display.license') }
     end
   end
 end

data/lib/mods_display/fields/audience.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Audience < Field
     private

data/lib/mods_display/fields/cartographics.rb

@@ -1,15 +1,22 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Cartographics < Field
     def fields
       return nil if @values.nil?
+
       return_fields = []
       @values.each do |value|
         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
-          post_scale = [projection, coordinates].compact.length > 0 ? [projection, coordinates].compact.join(' ') : nil
+          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
           return_fields << ModsDisplay::Values.new(
             label: (displayLabel(field) || label || I18n.t('mods_display.map_data')),
             values: [[scale, post_scale].compact.join(' ; ')]

data/lib/mods_display/fields/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   ###
   #  Collection class to parse collection data out of Mods relatedItem fields
@@ -11,9 +13,10 @@ module ModsDisplay
       return_fields = []
       @values.each do |value|
         next unless related_item_is_a_collection?(value)
+
         return_fields << ModsDisplay::Values.new(
           label: collection_label(value),
-          values: [value.titleInfo.text.strip]
+          values: [element_text(value.titleInfo)]
         )
       end
       collapse_fields(return_fields)
@@ -27,8 +30,9 @@ module ModsDisplay
 
     def resource_type_is_collection?(value)
       return unless value.respond_to?(:typeOfResource)
-      return unless value.typeOfResource.attributes.length > 0
-      value.typeOfResource.attributes.length > 0 &&
+      return unless value.typeOfResource.attributes.length.positive?
+
+      value.typeOfResource.attributes.length.positive? &&
         value.typeOfResource.attributes.first.key?('collection') &&
         value.typeOfResource.attributes.first['collection'].value == 'yes'
     end

data/lib/mods_display/fields/contact.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Contents < Field
     def to_html(view_context = ApplicationController.renderer)

data/lib/mods_display/fields/description.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 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
@@ -21,8 +23,7 @@ module ModsDisplay
 
     def labels
       { digitalOrigin: I18n.t('mods_display.digital_origin'),
-        note: I18n.t('mods_display.note')
-       }
+        note: I18n.t('mods_display.note') }
     end
   end
 end

data/lib/mods_display/fields/extent.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Extent < Field
     def fields
       return [] unless extent_fields.present?
+
       [
         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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module ModsDisplay
   class Field
     def initialize(values)
@@ -9,7 +10,7 @@ module ModsDisplay
       return_fields = @values.map do |value|
         ModsDisplay::Values.new(
           label: displayLabel(value) || label,
-          values: [displayForm(@values) || value.text].flatten
+          values: [element_text(value)]
         )
       end
       collapse_fields(return_fields)
@@ -17,6 +18,7 @@ module ModsDisplay
 
     def label
       return nil if @values.nil?
+
       displayLabel(@values.first)
     end
 
@@ -34,15 +36,10 @@ module ModsDisplay
       nil
     end
 
-    def displayForm(element)
-      return element unless element # basically return nil
-      display = element.children.find { |c| c.name == 'displayForm' }
-      return display.text if display
-    end
-
     def displayLabel(element)
       return unless element.respond_to?(:attributes) &&
                     element.attributes['displayLabel'].respond_to?(:value)
+
       "#{element.attributes['displayLabel'].value}:"
     end
 
@@ -52,8 +49,12 @@ 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)
+        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

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Form < Field
     def fields
       return [] unless form_fields.present?
+
       [
         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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 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/geo.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module ModsDisplay
   class Geo < Field
     def fields
       return [] unless geo_extensions.present?
+
       extensions = geo_extensions.map(&method(:process_geo_extension))
       [
         ModsDisplay::Values.new(
@@ -16,8 +19,8 @@ module ModsDisplay
     def process_geo_extension(extension)
       rdf = Nokogiri::XML(extension.children.to_s)
       [
-        rdf.xpath('//format').text[/format=(.*)$/, 1],
-        rdf.xpath('//type').text[/#(.*)$/, 1]
+        rdf.xpath('//dc:format', dc: 'http://purl.org/dc/elements/1.1/').text[/format=(.*)$/, 1],
+        rdf.xpath('//dc:type', dc: 'http://purl.org/dc/elements/1.1/').text[/#(.*)$/, 1]
       ].compact.join('; ')
     end
 

data/lib/mods_display/fields/identifier.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 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
@@ -13,28 +15,29 @@ module ModsDisplay
       if element.attributes['type'].respond_to?(:value)
         return identifier_labels[element.attributes['type'].value] || "#{element.attributes['type'].value}:"
       end
+
       I18n.t('mods_display.identifier')
     end
 
     def identifier_labels
-      { 'local'                     => I18n.t('mods_display.identifier'),
-        'isbn'                      => I18n.t('mods_display.isbn'),
-        'issn'                      => I18n.t('mods_display.issn'),
-        'issn-l'                    => I18n.t('mods_display.issn'),
-        'doi'                       => I18n.t('mods_display.doi'),
-        'hdl'                       => I18n.t('mods_display.handle'),
-        'isrc'                      => I18n.t('mods_display.isrc'),
-        'ismn'                      => I18n.t('mods_display.ismn'),
-        'issue number'              => I18n.t('mods_display.issue_number'),
-        'lccn'                      => I18n.t('mods_display.lccn'),
-        'oclc'                      => I18n.t('mods_display.oclc'),
-        'matrix number'             => I18n.t('mods_display.matrix_number'),
-        'music publisher'           => I18n.t('mods_display.music_publisher'),
-        'music plate'               => I18n.t('mods_display.music_plate'),
-        'sici'                      => I18n.t('mods_display.sici'),
-        'upc'                       => I18n.t('mods_display.upc'),
+      { 'local' => I18n.t('mods_display.identifier'),
+        'isbn' => I18n.t('mods_display.isbn'),
+        'issn' => I18n.t('mods_display.issn'),
+        'issn-l' => I18n.t('mods_display.issn'),
+        'doi' => I18n.t('mods_display.doi'),
+        'hdl' => I18n.t('mods_display.handle'),
+        'isrc' => I18n.t('mods_display.isrc'),
+        'ismn' => I18n.t('mods_display.ismn'),
+        'issue number' => I18n.t('mods_display.issue_number'),
+        'lccn' => I18n.t('mods_display.lccn'),
+        'oclc' => I18n.t('mods_display.oclc'),
+        'matrix number' => I18n.t('mods_display.matrix_number'),
+        'music publisher' => I18n.t('mods_display.music_publisher'),
+        'music plate' => I18n.t('mods_display.music_plate'),
+        'sici' => I18n.t('mods_display.sici'),
+        'upc' => I18n.t('mods_display.upc'),
         'videorecording identifier' => I18n.t('mods_display.videorecording_identifier'),
-        'stock number'              => I18n.t('mods_display.stock_number') }
+        'stock number' => I18n.t('mods_display.stock_number') }
     end
   end
 end