mods_display 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87d30cb62dd40cfbea25fee74bbc570a1ce43d0f
-  data.tar.gz: b987e4fa1934888ee711883bbea27d77824eca33
+  metadata.gz: d059d0bb717d798e323ae91d62ac65420e0b7e34
+  data.tar.gz: bea28312f2984465139f312e585a315ec8de992f
 SHA512:
-  metadata.gz: c9fc24d3da9650dbffc6c41cc8ccd6e38f37e5f078e53842c7452e3d58ab86dc2d2e019c4d0a2b2dbb9ba61e5d83fd2382a1f8a7827768c57df4db6f2124c744
-  data.tar.gz: 907db93ea86278a194c8eb3fe0676e0a9842dcee22a413f89c5ca482898b9b8b41f5929e90ee258e7a61db49472b8a1ea2edbd023cacbb2abbe6fadb9d46ee8a
+  metadata.gz: a7f53d54b8fbbd9dee47ccbee7120e63725e63057602da3a3cd50f569fc1d3335ed38a326d0ae072a25457f207d4ccc7722aa79a28dab3f442b2bf78f81ea35a
+  data.tar.gz: 306dee0b66098f941dcfbb8c8f8138b001cf4f34b06b398b73a118c9f785b73c9ebab33f9e7b0233aa7cb6d8122034a0bc77f87ba355d5bc29fa45046ba6dca6

data/.travis.yml

@@ -1,5 +1,6 @@
 notifications:
   email: false
 rvm:
-  - 2.2.3
-  - 2.1.7
+  - 2.4.1
+  - 2.3.4
+  - 2.2.8

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mods_display.gemspec
 gemspec
+
+# Pin to activesupport 4.x for older versions of ruby
+gem 'activesupport', '~> 4.2' if RUBY_VERSION < '2.2.2'

data/README.md

@@ -21,7 +21,7 @@ And then execute:
 Or install it yourself as:
 
     $ gem install mods_display
-    
+
 Include the `ModelExtension` into your model.
 
     class MyClass
@@ -32,11 +32,11 @@ Configure the source of the MODS XML in your model.  You can pass a string of XM
 
     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).
@@ -44,7 +44,7 @@ Include the `ControllerExtension` into your rails controller (or another class i
     class MyController
       include ModsDisplay::ControllerExtension
     end
-    
+
 Optionally configure the mods display gem (more on configuration later).
 
     class MyController
@@ -70,7 +70,7 @@ Both label_ and value_class accept strings to put in as a class.
 
     class MyController
       include ModsDisplay::ControllerExtension
-      
+
       configure_mods_display do
         title do
           label_class "title-label"
@@ -85,7 +85,7 @@ In certain cases an application may need to explicitly remove a portion of the M
 
     class MyController
       include ModsDisplay::ControllerExtension
-      
+
       configure_mods_display do
         contact do
           ignore!
@@ -111,13 +111,13 @@ The link configuration option takes 2 parameters. The first is a key that is a m
 
     class MyController
       include ModsDisplay::ControllerExtension
-      
+
       configure_mods_display do
         format do
           link :format_path, '"%value%"'
         end
       end
-      
+
       def format_path(format)
         "http://example.com/?f[format_field][]=#{format}"
       end
@@ -128,7 +128,7 @@ The link configuration option takes 2 parameters. The first is a key that is a m
 Depending on the implementation of subjects there may be different ways you would want to link them.  The standard way of linking will just create a link passing the value to the href and the link text.  However; in certain cases the subjects should be linked so that each subject to the right of a delimiter should have the values of all its preceding values in the href.
 
 [Country](http://example.com/?"Country") > [State](http://example.com/?"Country State") > [City](http://example.com/?"Country State City")
-    
+
 This can be accomplished by setting the hierarchical_link configuration option to true for subjects
 
     configure_mods_display do
@@ -182,6 +182,15 @@ Given that this semantics that we're concerned with here are more about titles a
 
 ## Release/Upgrade Notes
 
+#### v0.5.0
+There are three major changes in this version.
+
+1. RelatedItem nodes with a type of `constituent` or `host` are now treated separately and will render the full MODS display of any nested metadata.  If accessing the `ModsDisplay::Values` directly through their accessors (e.g. custom grouping), this new metadata is available under `.nested_related_items`.
+    * _**Note:** You may want to style and add some javascript toggling behavior (see exhibits for an example)._
+2. Name nodes are now grouped/labeled by their role.  If you were iterating over the names and splitting them out by their labels, that will need to change.
+3. Table of contents/Summaries are now split on `--` and rendered as an unordered list.
+    * _**Note:** You may want to style this list._
+
 #### v0.3.0
 
 Labels now have internationalization support.  We have added colons to the english labels due to certain languages' punctuation rules requiring different spacing between the label and colon.

data/config/locales/en.yml

@@ -4,12 +4,13 @@ en:
     abstract: "Abstract:"
     access_condition: "Access condition:"
     alternative_title: "Alternative title:"
-    author_creator: "Author/Creator:"
+    associated_with: "Associated with:"
     bibliography: "Bibliography:"
     biographical_historical: "Biographical/Historical:"
     citation_reference: "Citation/Reference:"
     collection: "Collection:"
     contact: "Contact:"
+    constituent: "Contains:"
     contributor: "Contributor:"
     copyright: "Copyright:"
     copyright_date: "Copyright date:"
@@ -27,6 +28,7 @@ en:
     genre: "Genre:"
     geo_extension: 'Format:'
     handle: "Handle:"
+    host: "Appears in:"
     identifier: "Identifier:"
     imprint: "Imprint:"
     isbn: "ISBN:"

data/lib/mods_display.rb

@@ -4,6 +4,7 @@ require 'mods_display/html'
 require 'mods_display/model_extension'
 require 'mods_display/country_codes'
 require 'mods_display/relator_codes'
+require 'mods_display/related_item_concerns'
 require 'mods_display/configuration'
 require 'mods_display/configuration/base'
 require 'mods_display/configuration/access_condition'
@@ -32,6 +33,7 @@ require 'mods_display/fields/imprint'
 require 'mods_display/fields/language'
 require 'mods_display/fields/location'
 require 'mods_display/fields/name'
+require 'mods_display/fields/nested_related_item'
 require 'mods_display/fields/note'
 require 'mods_display/fields/related_item'
 require 'mods_display/fields/resource_type'

data/lib/mods_display/configuration.rb

@@ -70,6 +70,10 @@ module ModsDisplay
       @related_item ||= ModsDisplay::Configuration::RelatedItem.new(&related_item || proc {})
     end
 
+    def nested_related_item(&nested_related_item)
+      @nested_related_item ||= ModsDisplay::Configuration::Base.new(&nested_related_item || proc {})
+    end
+
     def subject(&subject)
       @subject ||= ModsDisplay::Configuration::Subject.new(&subject || proc {})
     end

data/lib/mods_display/fields/contents.rb

@@ -1,5 +1,23 @@
 module ModsDisplay
   class Contents < Field
+    def to_html
+      return nil if fields.empty? || @config.ignore?
+      output = ''
+      fields.each do |field|
+        next unless field.values.any? { |f| f && !f.empty? }
+        output << "<dt#{label_class} #{sanitized_field_title(field.label)}>#{field.label}</dt>"
+        output << "<dd#{value_class}>"
+        output << '<ul><li>'
+        # compress all values into a "--"-delimited string then split them up
+        output << field.values.join('--').split('--').map(&:strip).map do |val|
+          @config.link ? link_to_value(val.to_s) : link_urls_and_email(val.to_s)
+        end.join('</li><li>')
+        output << '</li></ul>'
+        output << '</dd>'
+      end
+      output
+    end
+
     private
 
     def displayLabel(element)

data/lib/mods_display/fields/name.rb

@@ -3,16 +3,17 @@ module ModsDisplay
     include ModsDisplay::RelatorCodes
     def fields
       return_fields = @values.map do |value|
-        roles = process_role(value)
-        person = nil
-        if value.displayForm.length > 0
-          person = ModsDisplay::Name::Person.new(name: value.displayForm.text, roles: roles)
-        elsif !name_parts(value).empty?
-          person = ModsDisplay::Name::Person.new(name: name_parts(value), roles: roles)
+        person = if value.displayForm.length > 0
+                   ModsDisplay::Name::Person.new(name: value.displayForm.text)
+                 elsif !name_parts(value).empty?
+                   ModsDisplay::Name::Person.new(name: name_parts(value))
+                 end
+        # The person may have multiple roles, so we have to divide them up into an array
+        role_labels(value).collect do |role_label|
+          ModsDisplay::Values.new(label: displayLabel(value) || role_label, values: [person]) if person
         end
-        ModsDisplay::Values.new(label: displayLabel(value) || name_label(value), values: [person]) if person
-      end.compact
-      collapse_fields(return_fields)
+      end.flatten.compact
+      collapse_roles(collapse_fields(return_fields))
     end
 
     def to_html
@@ -23,9 +24,7 @@ module ModsDisplay
         output << "<dd#{value_class}>"
         output << field.values.map do |val|
           if @config.link
-            txt = link_to_value(val.name)
-            txt << " (#{val.roles.join(', ')})" if val.roles
-            txt
+            link_to_value(val.name)
           else
             val.to_s
           end
@@ -37,12 +36,21 @@ module ModsDisplay
 
     private
 
-    def name_label(element)
-      if !role?(element) || primary?(element) || author_or_creator_roles?(element)
-        I18n.t('mods_display.author_creator')
-      else
-        I18n.t('mods_display.contributor')
-      end
+    def collapse_roles(fields)
+      return [] if fields.blank?
+
+      label_order = fields.map(&:label)
+      results = consolidate_under_labels(fields)
+      label_keys = normalize_labels(label_order, results)
+      rebuild_fields_with_new_labels(label_keys, results)
+    end
+
+    def role_labels(element)
+      default_label = I18n.t('mods_display.associated_with')
+      return [default_label] unless element.role.present? && element.role.roleTerm.present?
+      element.role.roleTerm.collect do |role|
+        relator_codes[role.text.downcase] || role.text.capitalize || default_label
+      end.uniq
     end
 
     def role?(element)
@@ -54,12 +62,6 @@ module ModsDisplay
         element.attributes['usage'].value == 'primary'
     end
 
-    def author_or_creator_roles?(element)
-      ['author', 'aut', 'creator', 'cre', ''].include?(element.role.roleTerm.text.downcase)
-    rescue
-      false
-    end
-
     def name_parts(element)
       output = ''
       output << [unqualified_name_parts(element),
@@ -100,22 +102,6 @@ module ModsDisplay
       end
     end
 
-    def process_role(element)
-      return unless element.role.length > 0 && element.role.roleTerm.length > 0
-      if unencoded_role_term?(element)
-        unencoded_role_term(element)
-      else
-        element.role.roleTerm.map do |term|
-          next unless term.attributes['type'].respond_to?(:value) &&
-                      term.attributes['type'].value == 'code' &&
-                      term.attributes['authority'].respond_to?(:value) &&
-                      term.attributes['authority'].value == 'marcrelator' &&
-                      relator_codes.include?(term.text.strip)
-          relator_codes[term.text.strip]
-        end.compact
-      end
-    end
-
     def unencoded_role_term(element)
       roles = element.role.map do |role|
         role.roleTerm.find do |term|
@@ -138,17 +124,49 @@ module ModsDisplay
       end
     end
 
+    # Consolidate all names under label headings
+    def consolidate_under_labels(fields)
+      results = {}
+      fields.each do |mdv| # ModsDisplay::Values
+        results[mdv.label] ||= []
+        results[mdv.label] << mdv.values
+        results[mdv.label].flatten!
+      end
+      results
+    end
+
+    # Normalize label headings by filtering out some punctuation and ending in :
+    def normalize_labels(label_order, results)
+      label_order.uniq.map do |k|
+        label = k.tr('.', '').tr(':', '').strip + ':'
+        if label != k
+          results[label] = results[k]
+          results.delete(k)
+        end
+        label
+      end
+    end
+
+    def rebuild_fields_with_new_labels(label_keys, results)
+      # Build the new fields data, stripping out the roles within the Person classes
+      label_keys.uniq.map do |k|
+        mdv = ModsDisplay::Values.new({})
+        mdv.label = k
+        mdv.values = results[k].map do |person|
+          ModsDisplay::Name::Person.new(name: person.name)
+        end
+        mdv
+      end
+    end
+
     class Person
-      attr_accessor :name, :roles
+      attr_accessor :name
       def initialize(data)
         @name =  data[:name]
-        @roles = data[:roles] && !data[:roles].empty? ? data[:roles] : nil
       end
 
       def to_s
-        text = @name.dup
-        text << " (#{@roles.join(', ')})" if @roles
-        text
+        @name
       end
     end
   end

data/lib/mods_display/fields/nested_related_item.rb

@@ -0,0 +1,60 @@
+module ModsDisplay
+  ##
+  # This class will hopefully take over for related item support more broadly.
+  # Currently there is behavior in RelatedItem and Collection that would need
+  # to be accounted for when adding nested metadata support.
+  class NestedRelatedItem < Field
+    include ModsDisplay::RelatedItemConcerns
+
+    def fields
+      return_fields = @values.map do |value|
+        next if related_item_is_a_collection?(value)
+        next unless render_nested_related_item?(value)
+
+        related_item_mods_object(value)
+      end.compact
+      collapse_fields(return_fields)
+    end
+
+    def to_html
+      return nil if fields.empty? || @config.ignore?
+      output = ''
+      fields.each do |field|
+        next unless field.values.any? { |f| f && !f.empty? }
+        output << "<dt#{label_class} #{sanitized_field_title(field.label)}>#{field.label}</dt>"
+        output << "<dd#{value_class}>"
+        output << '<ul class="mods_display_nested_related_items">'
+        output << field.values.map do |val|
+          "<li class='mods_display_nested_related_item open'>#{link_urls_and_email(val.to_s)}</li>"
+        end.join
+        output << '</ul>'
+        output << '</dd>'
+      end
+      output
+    end
+
+    private
+
+    def related_item_mods_object(value)
+      mods = ::Stanford::Mods::Record.new.tap { |r| r.from_str("<mods>#{value.children.to_xml}</mods>", false) }
+      related_item = ModsDisplay::HTML.new(@config, mods, @klass)
+
+      ModsDisplay::Values.new(
+        label: related_item_label(value),
+        values: [[Array.wrap(related_item.title).first, related_item_body(related_item)].compact.join]
+      )
+    end
+
+    def related_item_body(related_item)
+      return if related_item.body == '<dl></dl>'
+      related_item.body
+    end
+
+    def related_item_label(item)
+      return displayLabel(item) if displayLabel(item)
+      return I18n.t('mods_display.constituent') if related_item_is_a_constituent?(item)
+
+      I18n.t('mods_display.host')
+    end
+  end
+end

data/lib/mods_display/fields/related_item.rb

@@ -1,8 +1,11 @@
 module ModsDisplay
   class RelatedItem < Field
+    include ModsDisplay::RelatedItemConcerns
+
     def fields
       return_fields = @values.map do |value|
         next if related_item_is_a_collection?(value)
+        next if render_nested_related_item?(value)
         case
         when related_item_is_a_location?(value)
           process_location value
@@ -44,14 +47,6 @@ module ModsDisplay
        item.note].flatten.compact.map!(&:text).map!(&:strip).join(' ')
     end
 
-    def related_item_is_a_collection?(item)
-      item.respond_to?(:titleInfo) &&
-        item.respond_to?(:typeOfResource) &&
-        item.typeOfResource.attributes.length > 0 &&
-        item.typeOfResource.attributes.first.key?('collection') &&
-        item.typeOfResource.attributes.first['collection'].value == 'yes'
-    end
-
     def related_item_is_a_location?(item)
       !related_item_is_a_collection?(item) &&
         !related_item_is_a_reference?(item) &&

data/lib/mods_display/fields/subject.rb

@@ -45,17 +45,13 @@ module ModsDisplay
             end
             if @config.link && @config.hierarchical_link
               if val.is_a?(ModsDisplay::Name::Person)
-                txt = link_to_value(val.name, buffer.join(' '))
-                txt << " (#{val.roles.join(', ')})" if val.roles
-                sub_parts << txt
+                sub_parts << link_to_value(val.name, buffer.join(' '))
               else
                 sub_parts << link_to_value(val, buffer.join(' '))
               end
             elsif @config.link
               if val.is_a?(ModsDisplay::Name::Person)
-                txt = link_to_value(val.name)
-                txt << " (#{val.roles.join(', ')})" if val.roles
-                sub_parts << txt
+                sub_parts << link_to_value(val.name)
               else
                 sub_parts << link_to_value(val.to_s)
               end

data/lib/mods_display/html.rb

@@ -89,6 +89,7 @@ module ModsDisplay
        :note,
        :contact,
        :collection,
+       :nestedRelatedItem,
        :relatedItem,
        :subject,
        :identifier,
@@ -116,6 +117,7 @@ module ModsDisplay
         note: :note,
         contact: :note,
         collection: :related_item,
+        nestedRelatedItem: :related_item,
         relatedItem: :related_item,
         subject: :subject,
         identifier: :identifier,
@@ -127,7 +129,8 @@ module ModsDisplay
       { subTitle: :sub_title,
         resourceType: :resource_type,
         relatedItem: :related_item,
-        accessCondition: :access_condition
+        accessCondition: :access_condition,
+        nestedRelatedItem: :nested_related_item
       }
     end
   end

data/lib/mods_display/related_item_concerns.rb

@@ -0,0 +1,27 @@
+module ModsDisplay
+  module RelatedItemConcerns
+    private
+
+    def render_nested_related_item?(item)
+      related_item_is_a_constituent?(item) || related_item_is_host?(item)
+    end
+
+    def related_item_is_a_collection?(item)
+      item.respond_to?(:titleInfo) &&
+        item.respond_to?(:typeOfResource) &&
+        !item.typeOfResource.attributes.empty? &&
+        item.typeOfResource.attributes.first.key?('collection') &&
+        item.typeOfResource.attributes.first['collection'].value == 'yes'
+    end
+
+    def related_item_is_a_constituent?(item)
+      item.attributes['type'].respond_to?(:value) &&
+      item.attributes['type'].value == 'constituent'
+    end
+
+    def related_item_is_host?(item)
+      item.attributes['type'].respond_to?(:value) &&
+      item.attributes['type'].value == 'host'
+    end
+  end
+end

data/lib/mods_display/version.rb

@@ -1,3 +1,3 @@
 module ModsDisplay
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/mods_display.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'capybara'
+  gem.add_development_dependency 'byebug'
 end

data/spec/fields/contents_spec.rb

@@ -21,4 +21,19 @@ describe ModsDisplay::Contents do
       expect(mods_display_contents(@display_label).label).to eq('Special Label:')
     end
   end
+  context 'multi-valued contents' do
+    let(:toc) do
+      Stanford::Mods::Record.new.from_str(
+              '<mods><tableOfContents>Content Note 1 -- Content Note 2</tableOfContents></mods>', false
+            ).tableOfContents
+    end
+    it 'should have one value with "--" marker' do
+      mdc = mods_display_contents(toc)
+      expect(mdc.fields.first.values).to eq ['Content Note 1 -- Content Note 2']
+    end
+    it 'should render as a list' do
+      html = mods_display_contents(toc).to_html
+      expect(html).to include '<dd><ul><li>Content Note 1</li><li>Content Note 2</li></ul></dd>'
+    end
+  end
 end

data/spec/fields/name_spec.rb

@@ -19,6 +19,7 @@ describe ModsDisplay::Language do
     @name = Stanford::Mods::Record.new.from_str(simple_name_fixture, false).plain_name
     @blank_name = Stanford::Mods::Record.new.from_str(blank_name_fixture, false).plain_name
     @primary_name = Stanford::Mods::Record.new.from_str(primary_name_fixture, false).plain_name
+    @primary_name_solo = Stanford::Mods::Record.new.from_str(primary_name_solo_fixture, false).plain_name
     @contributor = Stanford::Mods::Record.new.from_str(contributor_fixture, false).plain_name
     @encoded_role = Stanford::Mods::Record.new.from_str(encoded_role_fixture, false).plain_name
     @mixed_role = Stanford::Mods::Record.new.from_str(mixed_role_fixture, false).plain_name
@@ -30,16 +31,27 @@ describe ModsDisplay::Language do
     @complex_roles = Stanford::Mods::Record.new.from_str(complex_role_name_fixture, false).plain_name
     @name_with_role = Stanford::Mods::Record.new.from_str(name_with_role_fixture, false).plain_name
     @multiple_roles = Stanford::Mods::Record.new.from_str(multiple_roles_fixture, false).plain_name
+    @author_role = Stanford::Mods::Record.new.from_str(author_role_fixture, false).plain_name
+    @many_roles_and_names = Stanford::Mods::Record.new.from_str(many_roles_and_names_fixture, false).plain_name
+    @names_with_code_and_text_roles = Stanford::Mods::Record.new.from_str(names_with_code_and_text_roles_fixture, false).plain_name
   end
+  let(:default_label) { 'Associated with:' }
+
   describe 'label' do
     it 'should default Author/Creator when no role is available' do
-      expect(mods_display_name(@name).fields.first.label).to eq('Author/Creator:')
+      expect(mods_display_name(@name).fields.first.label).to eq(default_label)
+    end
+    it "should label as role for primary authors with a role" do
+      expect(mods_display_name(@primary_name).fields.first.label).to eq('Lithographer:')
     end
-    it "should label 'Author/Creator' for primary authors" do
-      expect(mods_display_name(@primary_name).fields.first.label).to eq('Author/Creator:')
+    it "should label 'Author/Creator' for non-role primary authors" do
+      expect(mods_display_name(@primary_name_solo).fields.first.label).to eq(default_label)
     end
-    it 'should apply contributor labeling to all non blank/author/creator roles' do
-      expect(mods_display_name(@contributor).fields.first.label).to eq('Contributor:')
+    it 'should apply role labeling with text' do
+      expect(mods_display_name(@contributor).fields.first.label).to eq('Lithographer:')
+    end
+    it 'should apply role labeling with code' do
+      expect(mods_display_name(@author_role).fields.first.label).to eq('Author:')
     end
   end
 
@@ -71,7 +83,7 @@ describe ModsDisplay::Language do
     it 'should collapse adjacent matching labels' do
       fields = mods_display_name(@collapse_label).fields
       expect(fields.length).to eq(1)
-      expect(fields.first.label).to eq('Author/Creator:')
+      expect(fields.first.label).to eq(default_label)
       fields.first.values.each do |val|
         expect(['John Doe', 'Jane Doe']).to include val.to_s
       end
@@ -79,59 +91,64 @@ describe ModsDisplay::Language do
     it 'should perseve order and separation of non-adjesent matching labels' do
       fields = mods_display_name(@complex_labels).fields
 
-      expect(fields.length).to eq(3)
-      expect(fields.first.label).to eq('Author/Creator:')
-      expect(fields.first.values.length).to eq(1)
-      expect(fields.first.values.first.to_s).to eq('John Doe')
+      expect(fields.length).to eq(2)
+      expect(fields.first.label).to eq(default_label)
+      expect(fields.first.values.length).to eq(3)
+      expect(fields.first.values.map(&:to_s)).to include 'John Doe', 'Jane Dough', 'John Dough'
 
-      expect(fields[1].label).to eq('Contributor:')
+      expect(fields[1].label).to eq('Lithographer:')
       expect(fields[1].values.length).to eq(1)
       expect(fields[1].values.first.name).to eq('Jane Doe')
-      expect(fields[1].values.first.roles).to eq(['lithographer'])
-
-      expect(fields.last.label).to eq('Author/Creator:')
-      expect(fields.last.values.length).to eq(2)
-      fields.last.values.each do |val|
-        expect(['Jane Dough', 'John Dough']).to include val.to_s
-      end
     end
     describe 'roles' do
       it 'should get the role when present' do
         fields = mods_display_name(@name_with_role).fields
         expect(fields.length).to eq(1)
+        expect(fields.first.label).to eq('Depicted:')
         expect(fields.first.values.length).to eq(1)
         expect(fields.first.values.first).to be_a(ModsDisplay::Name::Person)
-        expect(fields.first.values.first.roles).to eq(['Depicted'])
       end
       it 'should decode encoded roleTerms when no text (or non-typed) roleTerm is available' do
         fields = mods_display_name(@encoded_role).fields
         expect(fields.length).to eq(1)
+        expect(fields.first.label).to eq('Lithographer:')
         expect(fields.first.values.length).to eq(1)
-        expect(fields.first.values.first.to_s).to eq('John Doe (Lithographer)')
+        expect(fields.first.values.first.to_s).to eq('John Doe')
       end
       it "should get the type='text' role before an untyped role" do
         fields = mods_display_name(@mixed_role).fields
-        expect(fields.length).to eq(1)
+        expect(fields.length).to eq(2)
+        expect(fields.first.label).to eq 'Publisher:'
+        expect(fields.last.label).to eq 'Engraver:'
         expect(fields.first.values.length).to eq(1)
-        expect(fields.first.values.first.roles).to eq(['engraver'])
+        expect(fields.last.values.length).to eq(1)
+        expect(fields.first.values.first.name).to eq fields.last.values.first.name
       end
       it 'should be handled correctly when there are more than one' do
         fields = mods_display_name(@multiple_roles).fields
-        expect(fields.length).to eq(1)
+        expect(fields.length).to eq 2
+        expect(fields.first.label).to eq 'Depicted:'
+        expect(fields.last.label).to eq 'Artist:'
         expect(fields.first.values.length).to eq(1)
-        expect(fields.first.values.first.roles).to eq(%w(Depicted Artist))
+        expect(fields.last.values.length).to eq(1)
+        expect(fields.first.values.first.name).to eq fields.last.values.first.name
       end
       it 'should handle code and text roleTerms together correctly' do
         fields = mods_display_name(@complex_roles).fields
-        expect(fields.length).to eq(1)
-        expect(fields.first.values.length).to eq(1)
-        expect(fields.first.values.first.roles).to eq(['Depicted'])
+        expect(fields.length).to eq 2
+        expect(fields.first.label).to eq 'Depicted:'
+        expect(fields.last.label).to eq 'Depositor:'
+        expect(fields.first.values.first.name).to eq fields.last.values.first.name
       end
-      it 'should comma seperate multiple roles' do
-        fields = mods_display_name(@multiple_roles).fields
-        expect(fields.length).to eq(1)
-        expect(fields.first.values.length).to eq(1)
-        expect(fields.first.values.first.to_s).to eq('John Doe (Depicted, Artist)')
+      it 'should handle consolidation of many roles and names' do
+        fields = mods_display_name(@many_roles_and_names).fields
+        expect(fields.length).to eq 6
+        expect(fields.map(&:label)).to eq %w[Associated\ with: Surveyor: Cartographer: Editor: Electrotyper: Lithographer:]
+      end
+      it 'should handle consolidation of names with both code and text roleTerms' do
+        fields = mods_display_name(@names_with_code_and_text_roles).fields
+        expect(fields.length).to eq 3
+        expect(fields.map(&:label)).to eq %w[Author: Printer: Donor:]
       end
     end
   end
@@ -139,11 +156,11 @@ describe ModsDisplay::Language do
   describe 'to_html' do
     it 'should add the role to the name in parens' do
       html = mods_display_name(@name_with_role).to_html
-      expect(html).to match(%r{<dd>John Doe \(Depicted\)</dd>})
+      expect(html).to match(%r{<dd>John Doe</dd>})
     end
-    it 'should linke the name and not the role if requested' do
+    it 'should link the name and not the role if requested' do
       html = mods_display_name_link(@name_with_role).to_html
-      expect(html).to match(%r{<dd><a href='.*\?John Doe'>John Doe</a> \(Depicted\)</dd>})
+      expect(html).to match(%r{<dd><a href='.*\?John Doe'>John Doe</a></dd>})
     end
   end
 end

data/spec/fields/nested_related_item_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe ModsDisplay::NestedRelatedItem do
+  include RelatedItemFixtures
+  include NestedRelatedItemFixtures
+
+  let(:nested_related_item) do
+    described_class.new(
+      Stanford::Mods::Record.new.from_str(mods, false).related_item,
+      ModsDisplay::Configuration::Base.new,
+      double('controller')
+    )
+  end
+
+  describe '#label' do
+    subject(:label) { nested_related_item.fields.first.label }
+
+    context 'when a constituent' do
+      let(:mods) { multi_constituent_fixture }
+
+      it { is_expected.to eq 'Contains:' }
+    end
+
+    context 'when a host' do
+      let(:mods) { related_item_host_fixture }
+
+      it { is_expected.to eq 'Appears in:' }
+    end
+  end
+
+  describe '#fields' do
+    subject(:fields) { nested_related_item.fields }
+
+    context 'when an element that should be nested' do
+      let(:mods) { multi_constituent_fixture }
+
+      it 'has a field for each related item' do
+        expect(fields.length).to eq 1
+      end
+    end
+
+    context 'when a collection' do
+      let(:mods) { related_item_host_fixture }
+
+      it 'is not included' do
+        expect(fields.length).to eq 1 # This fixture has two host related items one of which is a collection
+        expect(fields.first.values.to_s).not_to include 'A collection'
+      end
+    end
+
+    context 'when handled by another related_item class' do
+      let(:mods) { basic_related_item_fixture }
+
+      it { is_expected.to be_empty }
+    end
+  end
+
+  describe '#to_html' do
+    subject(:html) { Capybara.string(nested_related_item.to_html) }
+    let(:mods) { related_item_host_fixture }
+
+    it 'renders an unordered list with an embedded dl containing the metadata of the related item' do
+      within(html.first('dd')) do |dd|
+        expect(dd).to have_css('ul.mods_display_nested_related_items')
+        within(dd.find('ul.mods_display_nested_related_items li')) do |li|
+          expect(li).to have_css('dl dt', text: 'Custom Notes:')
+          expect(li).to have_css('dl dd', text: 'A note content')
+        end
+      end
+    end
+  end
+end

data/spec/fields/related_item_spec.rb

@@ -6,6 +6,7 @@ end
 
 describe ModsDisplay::RelatedItem do
   include RelatedItemFixtures
+  include NestedRelatedItemFixtures
 
   before(:all) do
     @item = Stanford::Mods::Record.new.from_str(basic_related_item_fixture, false).related_item
@@ -16,7 +17,13 @@ describe ModsDisplay::RelatedItem do
     @reference = Stanford::Mods::Record.new.from_str(related_item_reference_fixture, false).related_item
     @blank_item = Stanford::Mods::Record.new.from_str(blank_related_item_fixture, false).related_item
     @multi_items = Stanford::Mods::Record.new.from_str(multi_related_item_fixture, false).related_item
+    @constituent_items = Stanford::Mods::Record.new.from_str(multi_constituent_fixture, false).related_item
   end
+
+  it 'excludes related items that will be rendered as a nested record' do
+    expect(mods_display_item(@constituent_items).fields).to be_empty
+  end
+
   describe 'label' do
     it 'should default to Related Item' do
       expect(mods_display_item(@item).fields.first.label).to eq('Related item:')

data/spec/fields/subject_spec.rb

@@ -68,16 +68,15 @@ describe ModsDisplay::Subject do
       expect(fields.length).to eq(1)
       expect(fields.first.values.first.first).to be_a(ModsDisplay::Name::Person)
       expect(fields.first.values.first.first.name).to eq('John Doe')
-      expect(fields.first.values.first.first.roles).to eq(['Depicted'])
     end
     it 'should link the name (and not the role) correctly' do
       html = mods_display_subject(@name_subject).to_html
-      expect(html).to match(%r{<a href='.*\?John Doe'>John Doe</a> \(Depicted\)})
+      expect(html).to match(%r{<a href='.*\?John Doe'>John Doe</a>})
       expect(html).to match(%r{<a href='.*\?Anonymous People'>Anonymous People</a>})
     end
     it 'should linke the name (and not the role) correctly when linking hierarchicaly' do
       html = mods_display_hierarchical_subject(@name_subject).to_html
-      expect(html).to match(%r{<a href='.*\?John Doe'>John Doe</a> \(Depicted\)})
+      expect(html).to match(%r{<a href='.*\?John Doe'>John Doe</a>})
       expect(html).to match(%r{<a href='.*\?John Doe Anonymous People'>Anonymous People</a>})
     end
   end

data/spec/fixtures/name_fixtures.rb

@@ -35,6 +35,16 @@ module NameFixtures
     XML
   end
 
+  def primary_name_solo_fixture
+    <<-XML
+      <mods>
+        <name usage='primary'>
+          <namePart>John Doe</namePart>
+        </name>
+      </mods>
+    XML
+  end
+
   def contributor_fixture
     <<-XML
       <mods>
@@ -193,4 +203,196 @@ module NameFixtures
       </mods>
     XML
   end
+  def author_role_fixture
+    <<-XML
+      <mods>
+        <name>
+          <namePart>John Doe</namePart>
+          <role>
+            <roleTerm type='code' authority='marcrelator'>aut</roleTerm>
+          </role>
+        </name>
+      </mods>
+    XML
+  end
+  def many_roles_and_names_fixture # from fs947tw3404
+    <<-XML
+      <mods>
+        <name type="corporate">
+          <namePart>United States Coast Survey</namePart>
+        </name>
+        <name type="personal">
+          <namePart>Lawson, J. S.</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Wilkes, Charles</namePart>
+          <namePart type="date">1798-1877</namePart>
+          <role>
+            <roleTerm type="text">cartographer.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Jones, John P. (John Percival)</namePart>
+          <namePart type="date">1829-1912</namePart>
+          <role>
+            <roleTerm type="text">cartographer.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Patterson, C. P. (Carlile Pollock)</namePart>
+          <namePart type="date">1816-1881</namePart>
+          <role>
+            <roleTerm type="text">cartographer.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Schott, C. A.</namePart>
+          <role>
+            <roleTerm type="text">editor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Cutts, R. D. (Richard Dominicus)</namePart>
+          <namePart type="date">1817-1883</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Gilbert, J. J.</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Rockwell, Cleveland</namePart>
+          <namePart type="date">1837-1907</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Coffin, G. W.</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Cordell, E.</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Davidson, George</namePart>
+          <namePart type="date">1825-1911</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Eimbeck, W.</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Hilgard, J. E. (Julius Erasmus)</namePart>
+          <namePart type="date">1825-1891</namePart>
+          <role>
+            <roleTerm type="text">editor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Bache, A. D. (Alexander Dallas)</namePart>
+          <namePart type="date">1806-1867</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Rodgers, A. F.</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Harrison, A. M. (Alexander Medina)</namePart>
+          <namePart type="date">1829-1881</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Alden, James</namePart>
+          <namePart type="date">1810-1877</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Mathiot, G.</namePart>
+          <role>
+            <roleTerm type="text">electrotyper.</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Harrison, A. M. (Alexander Medina)</namePart>
+          <namePart type="date">1829-1881</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="corporate">
+          <namePart>U.S. Coast and Geodetic Survey</namePart>
+          <role>
+            <roleTerm type="text">surveyor.</roleTerm>
+          </role>
+        </name>
+        <name type="corporate">
+          <namePart>N.Y. Lithographing, Engraving & Printing Co</namePart>
+          <role>
+            <roleTerm type="text">lithographer.</roleTerm>
+          </role>
+        </name>
+      </mods>
+    XML
+  end
+  def names_with_code_and_text_roles_fixture # from vn199zb9806
+    <<-XML
+      <mods>
+        <name type="personal" usage="primary" authority="naf" authorityURI="http://id.loc.gov/authorities/names" valueURI="http://id.loc.gov/authorities/names/n78095825" nameTitleGroup="1">
+          <namePart>Johnson, Samuel, 1709-1784</namePart>
+          <role>
+            <roleTerm type="code" authority="marcrelator" authorityURI="http://id.loc.gov/vocabulary/relators" valueURI="http://id.loc.gov/vocabulary/relators/aut">aut</roleTerm>
+            <roleTerm type="text" authority="marcrelator" authorityURI="http://id.loc.gov/vocabulary/relators" valueURI="http://id.loc.gov/vocabulary/relators/aut">author</roleTerm>
+          </role>
+        </name>
+        <name type="personal" authority="naf" authorityURI="http://id.loc.gov/authorities/names" valueURI="http://id.loc.gov/authorities/names/n78095825">
+          <namePart>Johnson, Samuel, 1709-1784</namePart>
+          <role>
+            <roleTerm type="code" authority="marcrelator" authorityURI="http://id.loc.gov/vocabulary/relators" valueURI="http://id.loc.gov/vocabulary/relators/prt">prt</roleTerm>
+            <roleTerm type="text" authority="marcrelator" authorityURI="http://id.loc.gov/vocabulary/relators" valueURI="http://id.loc.gov/vocabulary/relators/prt">printer</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Downing, Donn Faber</namePart>
+          <role>
+            <roleTerm type="code" authority="marcrelator" authorityURI="http://id.loc.gov/vocabulary/relators" valueURI="http://id.loc.gov/vocabulary/relators/dnr">dnr</roleTerm>
+            <roleTerm type="text" authority="marcrelator" authorityURI="http://id.loc.gov/vocabulary/relators" valueURI="http://id.loc.gov/vocabulary/relators/dnr">donor</roleTerm>
+          </role>
+        </name>
+        <name type="personal">
+          <namePart>Sanders, Letitia Leigh</namePart>
+          <role>
+            <roleTerm type="code" authority="marcrelator" authorityURI="http://id.loc.gov/vocabulary/relators" valueURI="http://id.loc.gov/vocabulary/relators/dnr">dnr</roleTerm>
+            <roleTerm type="text" authority="marcrelator" authorityURI="http://id.loc.gov/vocabulary/relators" valueURI="http://id.loc.gov/vocabulary/relators/dnr">donor</roleTerm>
+          </role>
+        </name>
+      </mods>
+    XML
+  end
 end

data/spec/fixtures/nested_realted_items_fixtures.rb

@@ -0,0 +1,64 @@
+module NestedRelatedItemFixtures
+  def related_item_host_fixture
+    <<-XML
+      <mods>
+        <relatedItem type="host">
+          <titleInfo>A host type related item</titleInfo>
+          <note displayLabel="Custom Notes">A note content</note>
+        </relatedItem>
+        <relatedItem type="host">
+          <titleInfo>A collection</titleInfo>
+          <typeOfResource collection="yes" />
+        </relatedItem>
+      </mods>
+    XML
+  end
+
+  def multi_constituent_fixture
+    <<-XML
+      <mods>
+        <relatedItem type="constituent">
+          <titleInfo>
+            <title>Polychronicon (epitome and continuation to 1429)</title>
+            <partNumber>ff. 1r - 29v</partNumber>
+          </titleInfo>
+          <titleInfo displayLabel="Nasmith Title" type="alternative">
+            <title>Epitome chronicae Cicestrensis, sed extractum e Polychronico, usque ad annum Christi 1429</title>
+          </titleInfo>
+          <name type="personal">
+            <namePart>Ranulf Higden OSB</namePart>
+            <role>
+              <roleTerm authority="marcrelator" type="text" valueURI="http://id.loc.gov/vocabulary/relators/aut">author</roleTerm>
+            </role>
+          </name>
+          <note>Dates are marked in the margin. Ends with the coronation of Henry VI at St Denis</note>
+          <note displayLabel="Incipit" type="incipit">Ieronimus ad eugenium in epistola 43a dicit quod decime leguntur primum date ab abraham</note>
+          <note displayLabel="Explicit" type="explicit">videlicet nono die mensis decembris ano etatis sue 10o</note>
+        </relatedItem>
+        <relatedItem type="constituent">
+          <titleInfo>
+            <title>Gesta regum ad Henricum VI</title>
+            <partNumber>ff. 30r - 53r</partNumber>
+          </titleInfo>
+          <titleInfo displayLabel="Nasmith Title" type="alternative">
+            <title>Breviarium historiae Angliae ad annum quartum Henrici IV. viz. 1402</title>
+          </titleInfo>
+          <titleInfo displayLabel="M.R. James Title" type="alternative">
+            <title>Breuiarium</title>
+          </titleInfo>
+          <name type="personal">
+            <namePart>Thomas Harsfield</namePart>
+            <role>
+              <roleTerm authority="marcrelator" type="text" valueURI="http://id.loc.gov/vocabulary/relators/aut">author</roleTerm>
+            </role>
+          </name>
+          <note>Another hand. Begins with 19 lines</note>
+          <note displayLabel="Incipit 1" type="incipit">Albion est terra constans in finibus orbis</note>
+          <note displayLabel="Explicit 1" type="explicit">Petrus pictauis dat cistrensis monachusque</note>
+          <note displayLabel="Incipit 2" type="incipit">Et quia confrater carissime non solum audiendo sacre scripture verbis aurem sedulus auditor accomodatur (!) tenetur</note>
+          <note displayLabel="Explicit 2" type="explicit">Tempore huius regis Owynus quidam Wallensis erigens se in principem Wallie toto vite sue tempore cum Wallensibus rebellauit</note>
+        </relatedItem>
+      </mods>
+    XML
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'mods_display'
 require 'stanford-mods'
+require 'capybara'
+
 Dir["#{File.expand_path('..', __FILE__)}/fixtures/*.rb"].each { |file| require file }
 # Load i18n test file.
 # We don't have any reliable translations yet so this

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jessie Keck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2017-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stanford-mods
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: 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'
 description: MODS Display is a gem to centralize the display logic of MODS medadata.
 email:
 - jessie.keck@gmail.com
@@ -127,6 +155,7 @@ files:
 - lib/mods_display/fields/language.rb
 - lib/mods_display/fields/location.rb
 - lib/mods_display/fields/name.rb
+- lib/mods_display/fields/nested_related_item.rb
 - lib/mods_display/fields/note.rb
 - lib/mods_display/fields/related_item.rb
 - lib/mods_display/fields/resource_type.rb
@@ -136,6 +165,7 @@ files:
 - lib/mods_display/fields/values.rb
 - lib/mods_display/html.rb
 - lib/mods_display/model_extension.rb
+- lib/mods_display/related_item_concerns.rb
 - lib/mods_display/relator_codes.rb
 - lib/mods_display/version.rb
 - mods_display.gemspec
@@ -158,6 +188,7 @@ files:
 - spec/fields/language_spec.rb
 - spec/fields/location_spec.rb
 - spec/fields/name_spec.rb
+- spec/fields/nested_related_item_spec.rb
 - spec/fields/note_spec.rb
 - spec/fields/related_item_spec.rb
 - spec/fields/resource_type_spec.rb
@@ -168,6 +199,7 @@ files:
 - spec/fixtures/cartographics_fixtures.rb
 - spec/fixtures/imprint_fixtures.rb
 - spec/fixtures/name_fixtures.rb
+- spec/fixtures/nested_realted_items_fixtures.rb
 - spec/fixtures/related_item_fixtures.rb
 - spec/fixtures/subjects_fixtures.rb
 - spec/fixtures/title_fixtures.rb
@@ -195,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: The MODS Display gem allows implementers to configure a customized display
@@ -221,6 +253,7 @@ test_files:
 - spec/fields/language_spec.rb
 - spec/fields/location_spec.rb
 - spec/fields/name_spec.rb
+- spec/fields/nested_related_item_spec.rb
 - spec/fields/note_spec.rb
 - spec/fields/related_item_spec.rb
 - spec/fields/resource_type_spec.rb
@@ -231,6 +264,7 @@ test_files:
 - spec/fixtures/cartographics_fixtures.rb
 - spec/fixtures/imprint_fixtures.rb
 - spec/fixtures/name_fixtures.rb
+- spec/fixtures/nested_realted_items_fixtures.rb
 - spec/fixtures/related_item_fixtures.rb
 - spec/fixtures/subjects_fixtures.rb
 - spec/fixtures/title_fixtures.rb