mods_display 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 500f8d5ce86766dcc1ca2566ea27396d4e5ea6e4
-  data.tar.gz: 443a83f2ab61cad2419b29a735e806c009cb38b0
+  metadata.gz: 5341a52d7bf05861b22abcee4950b5d0a45f6d0b
+  data.tar.gz: cd919cf57341abbe5c5fc46c3d8ce755e8ee780c
 SHA512:
-  metadata.gz: 9f2aeacc7a2fbbcda36c92bf5ab36a5f9eb6cafe40313adb9087fdfa56c5c15dc56928c72220b3339e76940785dc8f2c60e396b6561d0d4f8f6563da4b803981
-  data.tar.gz: a53e73d8ca3b0668bc69c56b025a337b718fb2b953fc2471571fe68f81758bc1b58b00f796f28e9075281f3294900d00d35ffe827ef28c2abef24ce4273fdf2f
+  metadata.gz: 7068515bccf5840a7c008d395f356a8b6c2695794dc4ec3aff1c85c24d84b535444db592ac2494e314db6f764746839b5d8fe0a7628b8cd705130adc427b9af2
+  data.tar.gz: ceff1ea49af522991dd8dc7048a4642df4aff43409a5f31a97907e6d91c2b23ec42ff36a9726a054712e9d4a410a2417288e310919c6b583758c0e8317fb0921

data/.rubocop_todo.yml

@@ -1,18 +1,17 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-11-06 16:51:15 -0800 using RuboCop version 0.34.2.
+# on 2016-02-17 16:15:37 -0800 using RuboCop version 0.37.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-Lint/NestedMethodDefinition:
+# Offense count: 1
+Lint/UselessAccessModifier:
   Exclude:
     - 'lib/mods_display/controller_extension.rb'
-    - 'lib/mods_display/model_extension.rb'
 
-# Offense count: 29
+# Offense count: 28
 Metrics/AbcSize:
   Max: 55
 
@@ -21,11 +20,11 @@ Metrics/AbcSize:
 Metrics/ClassLength:
   Max: 263
 
-# Offense count: 12
+# Offense count: 11
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 30
+# Offense count: 29
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 378
@@ -35,17 +34,44 @@ Metrics/MethodLength:
 Metrics/ModuleLength:
   Max: 380
 
-# Offense count: 12
+# Offense count: 11
 Metrics/PerceivedComplexity:
   Max: 15
 
+# Offense count: 3
+# Cop supports --auto-correct.
+Performance/Casecmp:
+  Exclude:
+    - 'lib/mods_display/fields/contact.rb'
+    - 'lib/mods_display/fields/field.rb'
+    - 'lib/mods_display/fields/note.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: SingleLineConditionsOnly.
+Style/ConditionalAssignment:
+  Exclude:
+    - 'lib/mods_display/fields/field.rb'
+    - 'lib/mods_display/fields/subject.rb'
+
 # Offense count: 42
-# Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
 
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/mods_display/fields/related_item.rb'
+
+# Offense count: 1
+Style/IfInsideElse:
+  Exclude:
+    - 'lib/mods_display/fields/subject.rb'
+
 # Offense count: 8
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: snake_case, camelCase
 Style/MethodName:
   Enabled: false
 
@@ -54,7 +80,36 @@ Style/MultilineBlockChain:
   Exclude:
     - 'lib/mods_display/fields/imprint.rb'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: aligned, indented
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/mods_display/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/mods_display/fields/subject.rb'
+
 # Offense count: 8
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: snake_case, camelCase
 Style/VariableName:
   Enabled: false
+
+# Offense count: 13
+Style/ZeroLengthPredicate:
+  Exclude:
+    - 'lib/mods_display/fields/cartographics.rb'
+    - 'lib/mods_display/fields/collection.rb'
+    - 'lib/mods_display/fields/imprint.rb'
+    - 'lib/mods_display/fields/name.rb'
+    - 'lib/mods_display/fields/related_item.rb'

data/.travis.yml

@@ -3,4 +3,3 @@ notifications:
 rvm:
   - 2.2.3
   - 2.1.7
-  - 1.9.3

data/Rakefile

@@ -6,7 +6,11 @@ RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
 task :ci do
-  Rake::Task['rubocop'].invoke
+  # 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['spec'].invoke
 end
 

data/config/locales/en.yml

@@ -21,9 +21,11 @@ en:
     date_valid: "Date valid:"
     digital_origin: "Digital origin:"
     doi: "DOI:"
-    format: "Format:"
+    extent: "Extent:"
+    form: "Form:"
     frequency: "Frequency:"
     genre: "Genre:"
+    geo_extension: 'Format:'
     handle: "Handle:"
     identifier: "Identifier:"
     imprint: "Imprint:"

data/lib/mods_display.rb

@@ -8,7 +8,6 @@ require 'mods_display/configuration'
 require 'mods_display/configuration/base'
 require 'mods_display/configuration/access_condition'
 require 'mods_display/configuration/imprint'
-require 'mods_display/configuration/format'
 require 'mods_display/configuration/genre'
 require 'mods_display/configuration/name'
 require 'mods_display/configuration/note'
@@ -24,8 +23,10 @@ require 'mods_display/fields/contact'
 require 'mods_display/fields/contents'
 require 'mods_display/fields/cartographics'
 require 'mods_display/fields/description'
-require 'mods_display/fields/format'
+require 'mods_display/fields/extent'
+require 'mods_display/fields/form'
 require 'mods_display/fields/genre'
+require 'mods_display/fields/geo'
 require 'mods_display/fields/identifier'
 require 'mods_display/fields/imprint'
 require 'mods_display/fields/language'

data/lib/mods_display/configuration.rb

@@ -26,10 +26,6 @@ module ModsDisplay
       @genre ||= ModsDisplay::Configuration::Genre.new(&genre || proc {})
     end
 
-    def format(&format)
-      @format ||= ModsDisplay::Configuration::Format.new(&format || proc {})
-    end
-
     def imprint(&imprint)
       @imprint ||= ModsDisplay::Configuration::Imprint.new(&imprint || proc {})
     end

data/lib/mods_display/fields/extent.rb

@@ -0,0 +1,19 @@
+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)
+        )
+      ]
+    end
+
+    private
+
+    def extent_fields
+      @values.map(&:extent)
+    end
+  end
+end

data/lib/mods_display/fields/form.rb

@@ -0,0 +1,19 @@
+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)
+        )
+      ]
+    end
+
+    private
+
+    def form_fields
+      @values.map(&:form)
+    end
+  end
+end

data/lib/mods_display/fields/geo.rb

@@ -0,0 +1,30 @@
+module ModsDisplay
+  class Geo < Field
+    def fields
+      return [] unless geo_extensions.present?
+      extensions = geo_extensions.map(&method(:process_geo_extension))
+      [
+        ModsDisplay::Values.new(
+          label: I18n.t('mods_display.geo_extension'),
+          values: extensions
+        )
+      ]
+    end
+
+    private
+
+    def process_geo_extension(extension)
+      rdf = Nokogiri::XML(extension.children.to_s)
+      [
+        rdf.xpath('//format').text[/format=(.*)$/, 1],
+        rdf.xpath('//type').text[/#(.*)$/, 1]
+      ].compact.join('; ')
+    end
+
+    def geo_extensions
+      @geo_values ||= @values.select do |value|
+        displayLabel(value) =~ /^geo:?$/
+      end
+    end
+  end
+end

data/lib/mods_display/html.rb

@@ -78,7 +78,9 @@ module ModsDisplay
        :imprint,
        :resourceType,
        :genre,
-       :format,
+       :form,
+       :extent,
+       :geo,
        :description,
        :cartographics,
        :abstract,
@@ -101,7 +103,9 @@ module ModsDisplay
         name: :plain_name,
         resourceType: :typeOfResource,
         genre: :genre,
-        format: :format,
+        form: :physical_description,
+        extent: :physical_description,
+        geo: :extension,
         imprint: :origin_info,
         language: :language,
         description: :physical_description,

data/lib/mods_display/version.rb

@@ -1,3 +1,3 @@
 module ModsDisplay
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

data/mods_display.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(spec)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'stanford-mods'
+  # Need to pin to < 1.2.0 because stanford-mods 13e5f23 breaks location
+  gem.add_dependency 'stanford-mods', '< 1.2.0'
   gem.add_dependency 'i18n'
 
   gem.add_development_dependency 'rake'

data/spec/fields/extent_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ModsDisplay::Extent do
+  let(:mods) do
+    <<-XML
+      <mods>
+        <physicalDescription>
+          <extent>Extent Value</extent>
+        </physicalDescription>
+      </mods>
+    XML
+  end
+
+  subject do
+    parsed_mods = Stanford::Mods::Record.new.from_str(mods, false).physical_description
+    described_class.new(parsed_mods, ModsDisplay::Configuration::Base.new, double('controller')).fields
+  end
+
+  describe 'label' do
+    it 'is "Extent"' do
+      expect(subject.first.label).to eq 'Extent:'
+    end
+  end
+
+  describe 'values' do
+    it 'returns the text of the extent element' do
+      expect(subject.first.values).to eq ['Extent Value']
+    end
+  end
+end

data/spec/fields/form_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ModsDisplay::Form do
+  let(:mods) do
+    <<-XML
+      <mods>
+        <physicalDescription>
+          <form>Form Value</form>
+        </physicalDescription>
+      </mods>
+    XML
+  end
+
+  subject do
+    parsed_mods = Stanford::Mods::Record.new.from_str(mods, false).physical_description
+    described_class.new(parsed_mods, ModsDisplay::Configuration::Base.new, double('controller')).fields
+  end
+
+  describe 'label' do
+    it 'is "Form"' do
+      expect(subject.first.label).to eq 'Form:'
+    end
+  end
+
+  describe 'values' do
+    it 'returns the text of the form element' do
+      expect(subject.first.values).to eq ['Form Value']
+    end
+  end
+end

data/spec/fields/geo_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+def mods_display_geo(mods_record)
+  ModsDisplay::Geo.new(mods_record, ModsDisplay::Configuration::Base.new, double('controller'))
+end
+
+describe ModsDisplay::Geo do
+  let(:mods) do
+    <<-XML
+      <mods>
+        <extension displayLabel="geo">
+          <rdf:RDF xmlns:gml="http://www.opengis.net/gml/3.2/" xmlns:dc="http://purl.org/dc/elements/1.1/">
+            <rdf:Description>
+              <dc:format>image/tiff; format=ArcGRID</dc:format>
+              <dc:type>Dataset#Raster</dc:type>
+            </rdf:Description>
+          </rdf:RDF>
+        </extension>
+      </mods>
+    XML
+  end
+
+  subject do
+    mods_display_geo(Stanford::Mods::Record.new.from_str(mods, false).extension).fields
+  end
+
+  describe 'labels' do
+    it 'is Format' do
+      expect(subject.length).to eq(1)
+      expect(subject.first.label).to eq('Format:')
+    end
+  end
+
+  describe 'fields' do
+    it 'joins the normalized format and type with a semicolon' do
+      expect(subject.length).to eq(1)
+      expect(subject.first.values).to eq(['ArcGRID; Raster'])
+    end
+  end
+end

data/spec/fields/location_spec.rb

@@ -1,58 +1,79 @@
 require 'spec_helper'
 
-def mods_display_location(mods_record)
-  ModsDisplay::Location.new(mods_record, ModsDisplay::Configuration::Base.new, double('controller'))
-end
+describe ModsDisplay::Location do
+  let(:location_mods) do
+    <<-XML
+      <mods>
+        <location>
+          <shelfLocation>On Shelf A</shelfLocation>
+        </location>
+      </mods>
+    XML
+  end
 
-describe ModsDisplay::Note do
-  before(:all) do
-    @location = Stanford::Mods::Record.new.from_str(
-      '<mods><location><physicalLocation>The Location</physicalLocation></location></mods>', false
-    ).location
-    @urls = Stanford::Mods::Record.new.from_str(
-      "<mods>
+  let(:url_mods) do
+    <<-XML
+      <mods>
         <location>
           <url displayLabel='Stanford University Library'>http://library.stanford.edu</url>
         </location>
         <location displayLabel='PURL'>
           <url>http://purl.stanford.edu</url>
         </location>
-      </mods>",
-      false
-    ).location
-    @display_label = Stanford::Mods::Record.new.from_str(
-      "<mods><location displayLabel='Special Label'><shelfLocation>On Shelf A</shelfLocation></location></mods>", false
-    ).location
-    @repository_label = Stanford::Mods::Record.new.from_str(
-      "<mods><location><physicalLocation type='repository'>Location Field</physicalLocation></location></mods>", false
-    ).location
+      </mods>
+    XML
+  end
+
+  let(:repository_mods) do
+    <<-XML
+      <mods>
+        <location>
+          <physicalLocation type='repository'>Location Field</physicalLocation>
+        </location>
+      </mods>
+    XML
+  end
+
+  let(:location) do
+    mods = Stanford::Mods::Record.new.from_str(location_mods, false).location
+    described_class.new(mods, ModsDisplay::Configuration::Base.new, double('controller')).fields
   end
+
+  let(:urls) do
+    mods = Stanford::Mods::Record.new.from_str(url_mods, false).location
+    described_class.new(mods, ModsDisplay::Configuration::Base.new, double('controller')).fields
+  end
+
+  let(:repository_label) do
+    mods = Stanford::Mods::Record.new.from_str(repository_mods, false).location
+    described_class.new(mods, ModsDisplay::Configuration::Base.new, double('controller')).fields
+  end
+
   describe 'label' do
     it 'should have a default label' do
-      expect(mods_display_location(@location).fields.first.label).to eq('Location:')
-    end
-    it 'should use the displayLabel attribute when one is available' do
-      expect(mods_display_location(@display_label).fields.first.label).to eq('Special Label:')
+      expect(location.first.label).to eq 'Location:'
     end
+
     it 'should handle the URL labels correctly' do
-      expect(mods_display_location(@urls).fields.map(&:label)).to eq(['Location:', 'PURL:'])
+      expect(urls.map(&:label)).to eq ['Location:', 'PURL:']
     end
+
     it 'should use get a label from a list of translations' do
-      expect(mods_display_location(@repository_label).fields.first.label).to eq('Repository:')
+      expect(repository_label.first.label).to eq 'Repository:'
     end
   end
+
   describe 'fields' do
     describe 'URLs' do
       it 'should link and use the displayLabel as text' do
-        fields = mods_display_location(@urls).fields
-        expect(fields.length).to eq(2)
-        field = fields.find { |f| f.label == 'Location:' }
+        expect(urls.length).to eq(2)
+        field = urls.find { |f| f.label == 'Location:' }
         expect(field.values).to eq(["<a href='http://library.stanford.edu'>Stanford University Library</a>"])
       end
+
       it 'should link the URL itself in the absence of a displayLabel on the url element' do
-        fields = mods_display_location(@urls).fields
-        expect(fields.length).to eq(2)
-        field = fields.find { |f| f.label == 'PURL:' }
+        expect(urls.length).to eq(2)
+        field = urls.find { |f| f.label == 'PURL:' }
         expect(field.values).to eq(["<a href='http://purl.stanford.edu'>http://purl.stanford.edu</a>"])
       end
     end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Jessie Keck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stanford-mods
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +100,6 @@ files:
 - lib/mods_display/configuration.rb
 - lib/mods_display/configuration/access_condition.rb
 - lib/mods_display/configuration/base.rb
-- lib/mods_display/configuration/format.rb
 - lib/mods_display/configuration/genre.rb
 - lib/mods_display/configuration/imprint.rb
 - lib/mods_display/configuration/name.rb
@@ -118,9 +117,11 @@ files:
 - lib/mods_display/fields/contact.rb
 - lib/mods_display/fields/contents.rb
 - lib/mods_display/fields/description.rb
+- lib/mods_display/fields/extent.rb
 - lib/mods_display/fields/field.rb
-- lib/mods_display/fields/format.rb
+- lib/mods_display/fields/form.rb
 - lib/mods_display/fields/genre.rb
+- lib/mods_display/fields/geo.rb
 - lib/mods_display/fields/identifier.rb
 - lib/mods_display/fields/imprint.rb
 - lib/mods_display/fields/language.rb
@@ -148,8 +149,10 @@ files:
 - spec/fields/contact_spec.rb
 - spec/fields/contents_spec.rb
 - spec/fields/description_spec.rb
-- spec/fields/format_spec.rb
+- spec/fields/extent_spec.rb
+- spec/fields/form_spec.rb
 - spec/fields/genre_spec.rb
+- spec/fields/geo_spec.rb
 - spec/fields/identifier_spec.rb
 - spec/fields/imprint_spec.rb
 - spec/fields/language_spec.rb
@@ -209,8 +212,10 @@ test_files:
 - spec/fields/contact_spec.rb
 - spec/fields/contents_spec.rb
 - spec/fields/description_spec.rb
-- spec/fields/format_spec.rb
+- spec/fields/extent_spec.rb
+- spec/fields/form_spec.rb
 - spec/fields/genre_spec.rb
+- spec/fields/geo_spec.rb
 - spec/fields/identifier_spec.rb
 - spec/fields/imprint_spec.rb
 - spec/fields/language_spec.rb

data/lib/mods_display/configuration/format.rb

@@ -1,9 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class Format < Base
-      def delimiter(delimiter = '<br/>')
-        @delimiter ||= delimiter
-      end
-    end
-  end
-end

data/lib/mods_display/fields/format.rb

@@ -1,45 +0,0 @@
-module ModsDisplay
-  class Format < Field
-    def fields
-      return_fields = []
-      if @values.respond_to?(:format) &&
-         !@values.format.nil? &&
-         !@values.format.empty?
-        return_fields << ModsDisplay::Values.new(label: format_label,
-                                                 values: [decorate_formats(@values.format).join(', ')])
-      end
-      unless @values.physical_description.nil?
-        @values.physical_description.each do |description|
-          unless description.form.nil? || description.form.empty?
-            return_fields << ModsDisplay::Values.new(
-              label: displayLabel(description) || format_label,
-              values: [description.form.map { |f| f.text.strip }.uniq.join(', ')]
-            )
-          end
-          unless description.extent.nil? || description.extent.empty?
-            return_fields << ModsDisplay::Values.new(label: displayLabel(description) || format_label,
-                                                     values: [description.extent.map(&:text).join(', ')])
-          end
-        end
-      end
-      collapse_fields(return_fields)
-    end
-
-    private
-
-    def decorate_formats(formats)
-      formats.map do |format|
-        "<span data-mods-display-format='#{self.class.format_class(format)}'>#{format}</span>"
-      end
-    end
-
-    def self.format_class(format)
-      return format if format.nil?
-      format.strip.downcase.gsub(%r{/|\\|\s+}, '_')
-    end
-
-    def format_label
-      I18n.t('mods_display.format')
-    end
-  end
-end

data/spec/fields/format_spec.rb

@@ -1,41 +0,0 @@
-require 'spec_helper'
-def mods_display_format(mods)
-  ModsDisplay::Format.new(mods, ModsDisplay::Configuration::Base.new, double('controller'))
-end
-
-describe ModsDisplay::Format do
-  before(:all) do
-    @format = Stanford::Mods::Record.new.from_str(
-      '<mods><typeOfResource>Format</typeOfResource></mods>', false
-    ).typeOfResource
-    @duplicate_forms = Stanford::Mods::Record.new.from_str(
-      '<mods><physicalDescription><form>Map</form><form>Map</form></physicalDescription></mods>', false
-    )
-    @display_label = Stanford::Mods::Record.new.from_str(
-      "<mods><typeOfResource displayLabel='SpecialFormat'>Mixed Materials</typeOfResource></mods>", false
-    ).typeOfResource
-    @space_format = Stanford::Mods::Record.new.from_str(
-      '<mods><typeOfResource>Mixed Materials</typeOfResource></mods>', false
-    ).typeOfResource
-    @slash_format = Stanford::Mods::Record.new.from_str(
-      '<mods><typeOfResource>Manuscript/Archive</typeOfResource></mods>', false
-    ).typeOfResource
-  end
-  describe 'format_class' do
-    it 'should remove any spaces' do
-      expect(ModsDisplay::Format.send(:format_class, 'Mixed Materials')).to eq('mixed_materials')
-    end
-    it 'should replace any slashes' do
-      expect(ModsDisplay::Format.send(:format_class, 'Manuscript/Archive')).to eq('manuscript_archive')
-    end
-  end
-  describe 'fields' do
-    describe 'form' do
-      it 'should remove duplicate values' do
-        fields = mods_display_format(@duplicate_forms).fields
-        expect(fields.length).to eq(1)
-        expect(fields.first.values).to eq(['Map'])
-      end
-    end
-  end
-end