mods_display 0.0.1.beta1

data/spec/fields/audience_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+def mods_display_audience(mods_record)
+  ModsDisplay::Audience.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Contents do
+  before(:all) do
+    @audience = Stanford::Mods::Record.new.from_str("<mods><targetAudience>Audience Note</targetAudience></mods>", false).targetAudience
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><targetAudience displayLabel='Special Label'>Audience Note</tableOfContents></mods>", false).targetAudience
+  end
+  describe "label" do
+    it "should have a default label" do
+      mods_display_audience(@audience).label.should == "Target audience"
+    end
+    it "should use the displayLabel attribute when one is available" do
+      mods_display_audience(@display_label).label.should == "Special Label"
+    end
+  end  
+  
+end

data/spec/fields/cartographics_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+require "fixtures/cartographics_fixtures"
+include CartographicsFixtures
+
+def mods_display_cartographics(mods)
+  ModsDisplay::Cartographics.new(mods, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Cartographics do
+  before(:all) do
+    @cart = Stanford::Mods::Record.new.from_str(full_cartographic, false).subject
+    @scale_only = Stanford::Mods::Record.new.from_str(scale_only, false).subject
+    @no_scale = Stanford::Mods::Record.new.from_str(no_scale_cartographic, false).subject
+    @coordinates = Stanford::Mods::Record.new.from_str(coordinates_only, false).subject
+  end
+  describe "values" do
+    it "should get the full cartographic note" do
+      values = mods_display_cartographics(@cart).fields
+      values.length.should == 1
+      values.first.values.should == ["The scale ; the projection the coordinates"]
+    end
+    it "should put a scale not given note if no scale is present" do
+      values = mods_display_cartographics(@no_scale).fields
+      values.length.should == 1
+      values.first.values.should == ["Scale not given ; the projection the coordinates"]
+    end
+    it "should handle when there is only a scale note" do
+      values = mods_display_cartographics(@scale_only).fields
+      values.length.should == 1
+      values.first.values.should == ["The scale"]
+    end
+    it "should handle when only one post-scale piece of the data is available" do
+      values = mods_display_cartographics(@coordinates).fields
+      values.length.should == 1
+      values.first.values.should == ["Scale not given ; the coordinates"]
+    end
+  end
+
+end

data/spec/fields/collection_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+def mods_display_collection(mods_record)
+  ModsDisplay::Collection.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Collection do
+  before(:all) do
+    @collection = Stanford::Mods::Record.new.from_str("<mods><relatedItem><titleInfo><title>The Collection</title></titleInfo><typeOfResource collection='yes' /></relatedItem></mods>", false).related_item
+    @non_collection = Stanford::Mods::Record.new.from_str("<mods><relatedItem><titleInfo><title>Not a Collection</title></titleInfo></relatedItem></mods>", false).related_item
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><relatedItem displayLabel='Special Collection'><titleInfo><title>Not a Collection</title></titleInfo></relatedItem></mods>", false).related_item
+  end
+  describe "label" do
+    it "should default to Collection" do
+      mods_display_collection(@collection).label.should == "Collection"
+    end
+    it "should get the displayLabel if available" do
+      mods_display_collection(@display_label).label.should == "Special Collection"
+    end
+  end
+  describe "fields" do
+    it "should get a collection title if there is an appropriate typeOfResource field with the collection attribute" do
+      fields = mods_display_collection(@collection).fields
+      fields.length.should == 1
+      fields.first.values.should == ["The Collection"]
+    end
+    it "should not return anything if the there is not an appropriate typeOfResource field with the collection attribute" do
+      mods_display_collection(@non_collection).fields.should == []
+    end
+  end
+end

data/spec/fields/contents_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+def mods_display_contents(mods_record)
+  ModsDisplay::Contents.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Contents do
+  before(:all) do
+    @contents = Stanford::Mods::Record.new.from_str("<mods><tableOfContents>Content Note</tableOfContents></mods>", false).tableOfContents
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><tableOfContents displayLabel='Special Label'>Content Note</tableOfContents></mods>", false).tableOfContents
+  end
+  describe "label" do
+    it "should have a default label" do
+      mods_display_contents(@contents).label.should == "Table of Contents"
+    end
+    it "should use the displayLabel attribute when one is available" do
+      mods_display_contents(@display_label).label.should == "Special Label"
+    end
+  end  
+  
+end

data/spec/fields/description_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+def mods_display_description(mods)
+  ModsDisplay::Description.new(mods, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Description do
+  before(:all) do
+    @form = Stanford::Mods::Record.new.from_str("<mods><physicalDescription><form>Form Note</form></physicalDescription></mods>", false).physical_description
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><physicalDescription displayLabel='SpecialLabel'><form>Form Note</form></physicalDescription></mods>", false).physical_description
+    @child_display_label = Stanford::Mods::Record.new.from_str("<mods><physicalDescription><form displayLabel='Form Label'>Form Note</form></physicalDescription></mods>", false).physical_description
+    @mixed = Stanford::Mods::Record.new.from_str("<mods><physicalDescription><form>Form Note</form><extent>Extent Note</extent></physicalDescription></mods>", false).physical_description
+  end
+  describe "labels" do
+    it "should use the dislayLabel if one is provided" do
+      mods_display_description(@display_label).fields.first.label.should == "SpecialLabel"
+    end
+    it "should get the default label for a child element" do
+      mods_display_description(@form).fields.first.label.should == "Form"
+    end
+    it "should get multiple lables for mixed content" do
+      mods_display_description(@mixed).fields.map{|v| v.label }.should == ["Form", "Extent"]
+    end
+    it "should get the display label from child elements" do
+      mods_display_description(@child_display_label).fields.map{|f| f.label }.should == ["Form Label"]
+    end
+  end
+  
+  describe "fields" do
+    it "should get the value from a field in physicalDescription" do
+      mods_display_description(@form).fields.first.values.should == ["Form Note"]
+    end
+    it "should get multiple values for mixed content" do
+      mods_display_description(@mixed).fields.map{|v| v.values }.should == [["Form Note"], ["Extent Note"]]
+    end
+  end
+end

data/spec/fields/format_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+def mods_display_format(mods)
+  ModsDisplay::Format.new(mods, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Format do
+  before(:all) do
+    @format = Stanford::Mods::Record.new.from_str("<mods><typeOfResource>Format</typeOfResource></mods>", false).typeOfResource
+    @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 "labels" do
+    it "should return the format label" do
+      mods_display_format(@format).to_html.should match(/<dt title='Format'>Format:<\/dt>/)
+    end
+    it "should return the displayLabel when available" do
+      mods_display_format(@display_label).to_html.should match(/<dt title='SpecialFormat'>SpecialFormat:<\/dt>/)
+    end
+  end
+  describe "format_class" do
+    it "should wrap the format in a span w/ the format class in it" do
+      mods_display_format(@format).to_html.should match(/<span class='format'>Format<\/span>/)
+    end
+    it "should remove any spaces" do
+      ModsDisplay::Format.send(:format_class, "Mixed Materials").should == "mixed_materials"
+    end
+    it "should replace any slashes" do
+      ModsDisplay::Format.send(:format_class, "Manuscript/Archive").should == "manuscript_archive"
+    end
+  end
+
+end

data/spec/fields/identifier_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+def mods_display_id(mods_record)
+  ModsDisplay::Identifier.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Note do
+  before(:all) do
+    @id = Stanford::Mods::Record.new.from_str("<mods><identifier>12345</identifier></mods>", false).identifier
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><identifier displayLabel='Special Label'>54321</identifier></mods>", false).identifier
+    @issue_label = Stanford::Mods::Record.new.from_str("<mods><identifier type='issue number'>Issue 1</identifier></mods>", false).identifier
+    @type_label = Stanford::Mods::Record.new.from_str("<mods><identifier type='Some other Type'>98765</identifier></mods>", false).identifier
+    @complex_label = Stanford::Mods::Record.new.from_str("<mods><identifier>12345</identifier><identifier>54321</identifier><identifier type='issue number'>12345</identifier><identifier>98765</identifier></mods>", false).identifier
+  end
+  describe "label" do
+    it "should have a default label" do
+      mods_display_id(@id).fields.first.label.should == "Identifier"
+    end
+    it "should use the displayLabel attribute when one is available" do
+      mods_display_id(@display_label).fields.first.label.should == "Special Label"
+    end
+    it "should use get a label from a list of translations" do
+      mods_display_id(@issue_label).fields.first.label.should == "Issue Number"
+    end
+    it "should use use the raw type attribute if one is present" do
+      mods_display_id(@type_label).fields.first.label.should == "Some other Type"
+    end
+  end
+  
+  describe "fields" do
+    it "should handle matching adjacent labels" do
+      fields = mods_display_id(@complex_label).fields
+      fields.length.should == 3
+      
+      fields.first.label.should == "Identifier"
+      fields.first.values.length.should == 2
+      fields.first.values.should == ["12345", "54321"]
+      
+      fields[1].label.should == "Issue Number"
+      fields[1].values.length.should == 1
+      fields[1].values.should == ["12345"]
+      
+      fields.last.label.should == "Identifier"
+      fields.last.values.length.should == 1
+      fields.last.values.should == ["98765"]
+    end
+  end
+  
+end

data/spec/fields/imprint_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+require "fixtures/imprint_fixtures"
+
+include ImprintFixtures
+
+def mods_display_imprint(mods_record)
+  ModsDisplay::Imprint.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Imprint do
+  before(:all) do
+    @imprint = Stanford::Mods::Record.new.from_str(imprint_mods, false).origin_info
+    @edition_and_date = Stanford::Mods::Record.new.from_str(origin_info_mods, false).origin_info
+    @encoded_date = Stanford::Mods::Record.new.from_str(encoded_date, false).origin_info
+    @encoded_only = Stanford::Mods::Record.new.from_str(only_encoded_data, false).origin_info
+    @mixed = Stanford::Mods::Record.new.from_str(mixed_mods, false).origin_info
+    @display_form = Stanford::Mods::Record.new.from_str(display_form, false).origin_info
+    @display_form_with_label = Stanford::Mods::Record.new.from_str(display_form, false).origin_info
+    @display_label = Stanford::Mods::Record.new.from_str(display_label, false).origin_info
+  end
+
+  describe "labels" do
+    it "should get the Imprint label by default" do
+      mods_display_imprint(@imprint).fields.first.label.should == "Imprint"
+    end
+    it "should get the label from non-imprint origin info fields" do
+      fields = mods_display_imprint(@edition_and_date).fields
+      fields.first.label.should == "Date Valid"
+      fields.last.label.should == "Edition"
+    end
+    it "should get multiple labels when we have mixed content" do
+      mods_display_imprint(@mixed).fields.map{|val| val.label }.should == ["Imprint", "Edition"]
+    end
+    it "should use the displayLabel when available" do
+       mods_display_imprint(@display_label).fields.map{|val| val.label }.should == ["TheLabel", "EditionLabel", "EditionLabel"]
+    end
+  end
+
+  describe "fields" do
+    it "should return various parts of the imprint" do
+      mods_display_imprint(@imprint).fields.map{|val| val.values }.join(" ").should == "A Place : A Publisher, A Create Date, An Issue Date, A Capture Date, Another Date"
+    end
+    it "should get the text for non-imprint origin info fields" do
+      fields = mods_display_imprint(@edition_and_date).fields
+      fields.first.values.should == ["A Valid Date"]
+      fields.last.values.should == ["The Edition"]
+    end
+    it "should omit dates with an encoding attribute" do
+      mods_display_imprint(@encoded_date).fields.map{|val| val.values }.join.should_not include("An Encoded Date")
+    end
+    it "should not try to return data w/ only encoded data" do
+      mods_display_imprint(@encoded_only).fields.should be_empty
+    end
+    it "should handle mixed mods properly" do
+      values = mods_display_imprint(@mixed).fields
+      values.length.should == 2
+      values.map{|val| val.values}.should include(["A Place : A Publisher"])
+      values.map{|val| val.values}.should include(["The Edition"])
+    end
+  end
+  describe "to_html" do
+    it "should return the display form if one is available" do
+      html = mods_display_imprint(@display_form).to_html
+      html.scan(/<dd>/).length.should == 2
+      html.scan(/<dd>The Display Form<\/dd>/).length.should == 2
+    end
+    it "should return the displayLabel when present if we're using the displayForm" do
+      mods_display_imprint(@display_form_with_label).to_html.should match(/<dt title='TheLabel'>TheLabel:<\/dt>/)
+    end
+    it "should have individual dt/dd pairs for mixed content" do
+      html = mods_display_imprint(@mixed).to_html
+      html.scan(/<dt title='Imprint'>Imprint:<\/dt>/).length.should == 1
+      html.scan(/<dt title='Edition'>Edition:<\/dt>/).length.should == 1
+      html.scan(/<dd>/).length.should == 2
+    end
+  end
+
+end

data/spec/fields/language_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+def mods_display_language(mods_record)
+  ModsDisplay::Language.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Language do
+  before(:all) do
+    @language = Stanford::Mods::Record.new.from_str("<mods><language><languageTerm type='code'>eng</languageTerm></language></mods>", false).language
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><language displayLabel='Lang'><languageTerm type='code'>eng</languageTerm></language></mods>", false).language
+    @no_lang = Stanford::Mods::Record.new.from_str("<mods><language displayLabel='Lang'><languageTerm type='code'>zzzxxx</languageTerm></language></mods>", false).language
+    @mixed = Stanford::Mods::Record.new.from_str("<mods><language><languageTerm type='text'>ger</languageTerm><languageTerm type='code'>eng</languageTerm></language></mods>", false).language
+    @multi = Stanford::Mods::Record.new.from_str("<mods><language><languageTerm type='code'>ger</languageTerm><languageTerm type='code'>eng</languageTerm></language></mods>", false).language
+    @display_form = Stanford::Mods::Record.new.from_str("<mods><language><languageTerm>zzzxxx</languageTerm><displayForm>Klingon</displayForm></language></mods>", false).language
+  end
+  describe "label" do
+    it "should default to Language when no displayLabel is available" do
+      mods_display_language(@language).label.should == "Language"
+    end
+    it "should use the displayLabel attribute when present" do
+      mods_display_language(@display_label).label.should == "Lang"
+    end
+  end
+  describe "fields" do
+    it "should return an array with a label/values object" do
+      values = mods_display_language(@display_label).fields
+      values.length.should == 1
+      values.first.should be_a ModsDisplay::Values
+      values.first.label.should == "Lang"
+      values.first.values.should == ["English"]
+    end
+    it "should not return any non type='code' languageTerms from the XML" do
+      values = mods_display_language(@mixed).fields
+      values.length.should == 1
+      values.first.values.should == ["English"]
+    end
+    it "should handle multiple languages correctly" do
+      values = mods_display_language(@multi).fields
+      values.length.should == 1
+      values.first.values.should == ["German", "English"]
+    end
+  end
+  describe "text" do
+    it "should return the language code translation" do
+      mods_display_language(@language).text.should == "English"
+    end
+    it "should return the code if the languages table does not have a translation" do
+      mods_display_language(@no_lang).text.should == "zzzxxx"
+    end
+    it "should return a displayForm if there is one" do
+      mods_display_language(@display_form).text.should == "Klingon"
+    end
+  end
+  
+end

data/spec/fields/location_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+def mods_display_location(mods_record)
+  ModsDisplay::Location.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+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
+    @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 type='repository'><physicalLocation>Location Field</physicalLocation></location></mods>", false).location
+  end
+  describe "label" do
+    it "should have a default label" do
+      mods_display_location(@location).fields.first.label.should == "Location"
+    end
+    it "should use the displayLabel attribute when one is available" do
+      mods_display_location(@display_label).fields.first.label.should == "Special Label"
+    end
+    it "should use get a label from a list of translations" do
+      mods_display_location(@repository_label).fields.first.label.should == "Repository"
+    end
+  end  
+  
+end

data/spec/fields/name_spec.rb

@@ -0,0 +1,88 @@
+require "spec_helper"
+require "fixtures/name_fixtures"
+include NameFixtures
+
+def mods_display_name_link(mods_record)
+  config = ModsDisplay::Configuration::Base.new do
+    link :link_method, '%value%'
+  end
+  ModsDisplay::Name.new(mods_record, config, TestController.new)
+end
+
+def mods_display_name(mods_record)
+  ModsDisplay::Name.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Language do
+  before(:all) do
+    @name = Stanford::Mods::Record.new.from_str("<mods><name><namePart>John Doe</namePart></name></mods>", false).plain_name
+    @conf_name = Stanford::Mods::Record.new.from_str("<mods><name type='conference'><namePart>John Doe</namePart></name></mods>", false).plain_name
+    @display_form = Stanford::Mods::Record.new.from_str("<mods><name><namePart>John Doe</namePart><displayForm>Mr. John Doe</displayForm></name></mods>", false).plain_name
+    @collapse_label = Stanford::Mods::Record.new.from_str("<mods><name><namePart>John Doe</namePart></name><name><namePart>Jane Doe</namePart></name></mods>", false).plain_name
+    @complex_labels = Stanford::Mods::Record.new.from_str("<mods><name><namePart>John Doe</namePart></name><name><namePart>Jane Doe</namePart></name><name type='conference'><namePart>John Dough</namePart></name><name><namePart>Jane Dough</namePart></name></mods>", false).plain_name
+    @name_with_role = Stanford::Mods::Record.new.from_str("<mods><name><namePart>John Doe</namePart><role><roleTerm type='text'>Depicted</roleTerm></role></name></mods>", false).plain_name
+  end
+  describe "label" do
+    it "should default Creator/Contributor when none is available" do
+      mods_display_name(@name).fields.first.label.should == "Creator/Contributor"
+    end
+    it "should derive the name from the type attribute if one is available" do
+      mods_display_name(@conf_name).fields.first.label.should == "Meeting"
+    end
+  end
+  
+  describe "fields" do
+    it "should use the display form when available" do
+      fields = mods_display_name(@display_form).fields
+      fields.length.should == 1
+      fields.first.values.length.should == 1
+      fields.first.values.first.should be_a(ModsDisplay::Name::Person)
+      fields.first.values.first.name.should == "Mr. John Doe"
+    end
+    it "should get the role when present" do
+      fields = mods_display_name(@name_with_role).fields
+      fields.length.should == 1
+      fields.first.values.length.should == 1
+      fields.first.values.first.should be_a(ModsDisplay::Name::Person)
+      fields.first.values.first.role.should == "Depicted"
+    end
+    it "should collapse adjacent matching labels" do
+      fields = mods_display_name(@collapse_label).fields
+      fields.length.should == 1
+      fields.first.label.should == "Creator/Contributor"
+      fields.first.values.each do |val|
+        ["John Doe", "Jane Doe"].should include val.to_s
+      end
+    end
+    it "should perseve order and separation of non-adjesent matching labels" do
+      fields = mods_display_name(@complex_labels).fields
+
+      fields.length.should == 3
+      fields.first.label.should == "Creator/Contributor"
+      fields.first.values.length.should == 2
+      fields.first.values.each do |val|
+        ["John Doe", "Jane Doe"].should include val.to_s
+      end
+
+      fields[1].label.should == "Meeting"
+      fields[1].values.length.should == 1
+      fields[1].values.first.to_s.should == "John Dough"
+
+      fields.last.label.should == "Creator/Contributor"
+      fields.last.values.length.should == 1
+      fields.last.values.first.to_s.should == "Jane Dough"
+    end
+  end
+  
+  describe "to_html" do
+    it "should add the role to the name in parens" do
+      html = mods_display_name(@name_with_role).to_html
+      html.should match(/<dd>John Doe \(Depicted\)<\/dd>/)
+    end
+    it "should linke the name and not the role if requested" do
+      html = mods_display_name_link(@name_with_role).to_html
+      html.should match(/<dd><a href='.*\?John Doe'>John Doe<\/a> \(Depicted\)<\/dd>/)
+    end
+  end
+  
+end