mods_display 0.0.1.beta1

data/spec/fields/note_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+def mods_display_note(mods_record)
+  ModsDisplay::Note.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Note do
+  before(:all) do
+    @note = Stanford::Mods::Record.new.from_str("<mods><note>Note Field</note></mods>", false).note
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><note displayLabel='Special Label'>Note Field</note></mods>", false).note
+    @sor_label = Stanford::Mods::Record.new.from_str("<mods><note type='statement of responsibility'>Note Field</note></mods>", false).note
+    @type_label = Stanford::Mods::Record.new.from_str("<mods><note type='Some other Type'>Note Field</note></mods>", false).note
+    @complex_label = Stanford::Mods::Record.new.from_str("<mods><note>Note Field</note><note>2nd Note Field</note><note type='statement of responsibility'>SoR</note><note>Another Note</note></mods>", false).note
+  end
+  describe "label" do
+    it "should have a default label" do
+      mods_display_note(@note).fields.first.label.should == "Note"
+    end
+    it "should use the displayLabel attribute when one is available" do
+      mods_display_note(@display_label).fields.first.label.should == "Special Label"
+    end
+    it "should use get a label from a list of translations" do
+      mods_display_note(@sor_label).fields.first.label.should == "Statement of Responsibility"
+    end
+    it "should use use the raw type attribute if one is present" do
+      mods_display_note(@type_label).fields.first.label.should == "Some other Type"
+    end
+  end
+  
+  describe "fields" do
+    it "should handle single values" do
+      fields = mods_display_note(@note).fields
+      fields.length.should == 1
+      fields.first.values.should == ["Note Field"]
+    end
+    it "should handle complex grouping" do
+      fields = mods_display_note(@complex_label).fields
+      fields.length.should == 3
+      fields.first.label.should == "Note"
+      fields.first.values.length == 2
+      fields.first.values.should == ["Note Field", "2nd Note Field"]
+      
+      fields[1].label == "Statement of Responsibility"
+      fields[1].values.length == 1
+      fields[1].values.should == ["SoR"]
+      
+      fields.last.label.should == "Note"
+      fields.last.values.length == 1
+      fields.last.values.should == ["Another Note"]
+    end
+  end
+  
+end

data/spec/fields/related_item_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+def mods_display_item(mods_record)
+  ModsDisplay::RelatedItem.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::RelatedItem do
+  before(:all) do
+    @item = Stanford::Mods::Record.new.from_str("<mods><relatedItem><titleInfo>A Related Item</titleInfo></relatedItem></mods>", false).related_item
+    @linked_item = Stanford::Mods::Record.new.from_str("<mods><relatedItem><titleInfo>A Related Item</titleInfo><location><url>http://library.stanford.edu/</url></location></relatedItem></mods>", false).related_item
+    @collection = Stanford::Mods::Record.new.from_str("<mods><relatedItem><titleInfo>This is a Collection</titleInfo><typeOfResource collection='yes' /></relatedItem></mods>", false).related_item
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><relatedItem displayLabel='Special Item'><titleInfo>A Related Item</titleInfo></relatedItem></mods>", false).related_item
+  end
+  describe "label" do
+    it "should default to Related Item" do
+      mods_display_item(@item).fields.first.label.should == "Related Item"
+    end
+    it "should get the displayLabel if available" do
+      mods_display_item(@display_label).fields.first.label.should == "Special Item"
+    end
+  end
+  describe "fields" do
+    it "should get a location if it is available" do
+      fields = mods_display_item(@item).fields
+      fields.length.should == 1
+      fields.first.values.should == ["A Related Item"]
+    end
+    it "should return a link if there is a location/url present" do
+      fields = mods_display_item(@linked_item).fields
+      fields.length.should == 1
+      fields.first.values.should == ["<a href='http://library.stanford.edu/'>A Related Item</a>"]
+    end
+    it "should not return any fields if the described related item is a collection" do
+      mods_display_item(@collection).fields.should == []
+    end
+  end
+end

data/spec/fields/related_location_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+def mods_display_related_location(mods_record)
+  ModsDisplay::RelatedLocation.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::RelatedLocation do
+  before(:all) do
+    @location = Stanford::Mods::Record.new.from_str("<mods><relatedItem><location>The Location</location></relatedItem></mods>", false).related_item
+    @non_location = Stanford::Mods::Record.new.from_str("<mods><relatedItem><title>No Location</title></relatedItem></mods>", false).related_item
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><relatedItem displayLabel='Special Location'><location>The Location</location></relatedItem></mods>", false).related_item
+  end
+  describe "label" do
+    it "should default to Location" do
+      mods_display_related_location(@location).fields.first.label.should == "Location"
+    end
+    it "should get the displayLabel if available" do
+      mods_display_related_location(@display_label).label.should == "Special Location"
+    end
+  end
+  describe "fields" do
+    it "should get a location if it is available" do
+      fields = mods_display_related_location(@location).fields
+      fields.length.should == 1
+      fields.first.values.should == ["The Location"]
+    end
+    it "should not return any fields if there is no location" do
+      mods_display_related_location(@non_location).fields.should == []
+    end
+  end
+end

data/spec/fields/subject_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+require "fixtures/subjects_fixtures"
+include SubjectsFixtures
+
+def mods_display_subject(mods_record)
+  config = ModsDisplay::Configuration::Subject.new do
+    link :link_method, "%value%"
+  end
+  ModsDisplay::Subject.new(mods_record, config, TestController.new)
+end
+
+def mods_display_hierarchical_subject(mods_record)
+  config = ModsDisplay::Configuration::Subject.new do
+    hierarchical_link true
+    link :link_method, "%value%"
+  end
+  ModsDisplay::Subject.new(mods_record, config, TestController.new)
+end
+
+describe ModsDisplay::Subject do
+  before(:all) do
+    @subject = Stanford::Mods::Record.new.from_str(subjects, false).subject
+    @emdash_subject = Stanford::Mods::Record.new.from_str(emdash_subjects, false).subject
+    @geo_subject = Stanford::Mods::Record.new.from_str(hierarchical_geo_subjects, false).subject
+    @name_subject = Stanford::Mods::Record.new.from_str(name_subjects, false).subject
+    @complex_subject = Stanford::Mods::Record.new.from_str(complex_subjects, false).subject
+  end
+
+  describe "fields" do
+    it "should split individual child elments of subject into separate parts" do
+      fields = mods_display_subject(@subject).fields
+      fields.length.should == 1
+      fields.first.values.should == [["Jazz", "Japan", "History and criticism"]]
+    end
+    it "should split horizontalized subjects split with an emdash into separate parts" do
+      fields = mods_display_subject(@emdash_subject).fields
+      fields.length.should == 1
+      fields.first.values.should == [["Jazz", "Japan", "History and criticism"]]
+    end
+    it "should handle hierarchicalGeogaphic subjects properly" do
+      fields = mods_display_subject(@geo_subject).fields
+      fields.length.should == 1
+      fields.first.values.should == [["United States", "California", "Stanford"]]
+    end
+  end
+
+  describe "name subjects" do
+    it "should handle name subjects properly" do
+      fields = mods_display_subject(@name_subject).fields
+      fields.length.should == 1
+      fields.first.values.first.first.should be_a(ModsDisplay::Name::Person)
+      fields.first.values.first.first.name.should == "John Doe"
+      fields.first.values.first.first.role.should == "Depicted"
+    end
+    it "should link the name (and not the role) correctly" do
+      html = mods_display_subject(@name_subject).to_html
+      html.should match(/<a href='.*\?John Doe'>John Doe<\/a> \(Depicted\)/)
+      html.should match(/<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
+      html.should match(/<a href='.*\?John Doe'>John Doe<\/a> \(Depicted\)/)
+      html.should match(/<a href='.*\?John Doe Anonymous People'>Anonymous People<\/a>/)
+    end
+  end
+
+  describe "to_html" do
+    it "should link the values when requested" do
+      html = mods_display_subject(@subject).to_html
+      html.should match(/<a href='http:\/\/library.stanford.edu\?Jazz'>Jazz<\/a>/)
+      html.should match(/<a href='http:\/\/library.stanford.edu\?Japan'>Japan<\/a>/)
+      html.should match(/<a href='http:\/\/library.stanford.edu\?History and criticism'>History and criticism<\/a>/)
+    end
+    it "does something" do
+      html = mods_display_hierarchical_subject(@subject).to_html
+      html.should match(/<a href='http:\/\/library.stanford.edu\?Jazz'>Jazz<\/a>/)
+      html.should match(/<a href='http:\/\/library.stanford.edu\?Jazz Japan'>Japan<\/a>/)
+      html.should match(/<a href='http:\/\/library.stanford.edu\?Jazz Japan History and criticism'>History and criticism<\/a>/)
+    end
+    it "should collapse fields into the same label" do
+      html = mods_display_subject(@complex_subject).to_html
+      html.scan(/<dt title='Subject'>Subject:<\/dt>/).length.should == 1
+      html.scan(/<dd>/).length.should == 1
+      html.scan(/<br\/>/).length.should == 1
+      html.scan(/ &gt; /).length.should == 3
+    end
+  end
+
+end

data/spec/fields/title_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+def mods_display_title(mods_record)
+  ModsDisplay::Title.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+end
+
+describe ModsDisplay::Title do
+  before(:all) do
+    @title = Stanford::Mods::Record.new.from_str("<mods><titleInfo><title>Title</title></titleInfo></mods>", false).title_info
+    @title_parts = Stanford::Mods::Record.new.from_str("<mods><titleInfo><nonSort>The</nonSort><title>Title</title><subTitle>For</subTitle><partName>Something</partName><partNumber>62</partNumber></titleInfo></mods>", false).title_info
+    @display_label = Stanford::Mods::Record.new.from_str("<mods><titleInfo displayLabel='MyTitle'><title>Title</title></titleInfo></mods>", false).title_info
+    @display_form = Stanford::Mods::Record.new.from_str("<mods><titleInfo><title>Title</title><displayForm>The Title of This Item</displayForm></titleInfo></mods>", false).title_info
+    @alt_title = Stanford::Mods::Record.new.from_str("<mods><titleInfo type='alternative'><title>Title</title></titleInfo></mods>", false).title_info
+  end
+  describe "labels" do
+    it "should return a default label of Title if nothing else is available" do
+      mods_display_title(@title).fields.first.label.should == "Title"
+    end
+    it "should return an appropriate label from the type attribute" do
+      mods_display_title(@alt_title).fields.first.label.should == "Alternative Title"
+    end
+    it "should return the label held in the displayLabel attribute of the titleInfo element when available" do
+      mods_display_title(@display_label).fields.first.label.should == "MyTitle"
+    end
+  end
+  describe "fields" do
+    it "should return an array of label/value objects" do
+      values = mods_display_title(@display_label).fields
+      values.length.should == 1
+      values.first.should be_a ModsDisplay::Values
+      values.first.label.should == "MyTitle"
+      values.first.values.should == ["Title"]
+    end
+  end
+  describe "text" do
+    it "should construct all the elements in titleInfo" do
+      mods_display_title(@title_parts).fields.first.values.should include "The Title : For. Something, 62"
+    end
+    it "should use the displayForm when available" do
+      mods_display_title(@display_form).fields.first.values.should include "The Title of This Item"
+    end
+    it "should return the basic text held in a sub element of titleInfo" do
+      mods_display_title(@title).fields.first.values.should include "Title"
+    end
+  end
+  
+end

data/spec/fixtures/cartographics_fixtures.rb

@@ -0,0 +1,52 @@
+module CartographicsFixtures
+  def full_cartographic
+    <<-MODS
+      <mods>
+        <subject>
+          <cartographics>
+            <scale>The scale</scale>
+            <coordinates>the coordinates</coordinates>
+            <projection>the projection</projection>
+          </cartographics>
+        </subject>
+      </mods>
+    MODS
+  end
+
+  def no_scale_cartographic
+    <<-MODS
+      <mods>
+        <subject>
+          <cartographics>
+            <coordinates>the coordinates</coordinates>
+            <projection>the projection</projection>
+          </cartographics>
+        </subject>
+      </mods>
+    MODS
+  end
+
+  def coordinates_only
+    <<-MODS
+      <mods>
+        <subject>
+          <cartographics>
+            <coordinates>the coordinates</coordinates>
+          </cartographics>
+        </subject>
+      </mods>
+    MODS
+  end
+
+  def scale_only
+    <<-MODS
+      <mods>
+        <subject>
+          <cartographics>
+            <scale>The scale</scale>
+          </cartographics>
+        </subject>
+      </mods>
+    MODS
+  end
+end

data/spec/fixtures/imprint_fixtures.rb

@@ -0,0 +1,89 @@
+module ImprintFixtures
+  def imprint_mods
+    <<-MODS
+      <mods>
+        <originInfo>
+          <place>A Place</place>
+          <publisher>A Publisher</publisher>
+          <dateCreated>A Create Date</dateCreated>
+          <dateIssued>An Issue Date</dateIssued>
+          <dateCaptured>A Capture Date</dateCaptured>
+          <dateOther>Another Date</dateOther>
+        </originInfo>
+      </mods>
+    MODS
+  end
+  def origin_info_mods
+    <<-MODS
+      <mods>
+        <originInfo>
+          <dateValid>A Valid Date</dateValid>
+        </originInfo>
+        <originInfo>
+          <edition>The Edition</edition>
+        </originInfo>
+      </mods>
+    MODS
+  end
+  def encoded_date
+    <<-MODS
+      <mods>
+        <originInfo>
+          <place>A Place</place>
+          <dateIssued encoding="an-encoding">An Encoded Date</dateIssued>
+        </originInfo>
+      </mods>
+    MODS
+  end
+  def only_encoded_data
+    <<-MODS
+      <mods>
+        <originInfo>
+          <dateIssued encoding="an-encoding">An Encoded Date</dateIssued>
+        </originInfo>
+      </mods>
+    MODS
+  end
+  def mixed_mods
+    <<-MODS
+      <mods>
+        <originInfo>
+          <place>A Place</place>
+          <publisher>A Publisher</publisher>
+          <edition>The Edition</edition>
+        </originInfo>
+      </mods>
+    MODS
+  end
+  def display_form
+    <<-MODS
+      <mods>
+        <originInfo>
+          <place>A Place</place>
+          <publisher>A Publisher</publisher>
+          <displayForm>The Display Form</displayForm>
+        </originInfo>
+        <originInfo displayLabel="TheLabel">
+          <place>A Place</place>
+          <publisher>A Publisher</publisher>
+          <displayForm>The Display Form</displayForm>
+        </originInfo>
+      </mods>
+    MODS
+  end
+  def display_label
+    <<-MODS
+      <mods>
+        <originInfo displayLabel="TheLabel">
+          <place>A Place</place>
+          <publisher>A Publisher</publisher>
+        </originInfo>
+        <originInfo displayLabel="EditionLabel">
+          <place>A Place</place>
+          <publisher>A Publisher</publisher>
+          <edition>The Edition</edition>
+        </originInfo>
+      </mods>
+    MODS
+  end
+end

data/spec/fixtures/name_fixtures.rb

@@ -0,0 +1,3 @@
+module NameFixtures
+  
+end

data/spec/fixtures/subjects_fixtures.rb

@@ -0,0 +1,70 @@
+module SubjectsFixtures
+  def subjects
+    <<-XML
+      <mods>
+        <subject>
+          <topic>Jazz</topic>
+          <geographical>Japan</geographical>
+          <topic>History and criticism</topic>
+        </subject>
+      </mods>
+    XML
+  end
+
+  def emdash_subjects
+    <<-XML
+      <mods>
+        <subject>
+          <topic>Jazz -- Japan -- History and criticism</topic>
+        </subject>
+      </mods>
+    XML
+  end
+
+  def hierarchical_geo_subjects
+    <<-XML
+      <mods>
+        <subject>
+          <hierarchicalGeographic>
+            <country>United States</country>
+            <state>California</state>
+            <city>Stanford</city>
+          </hierarchicalGeographic>
+        </subject>
+      </mods>
+    XML
+  end
+
+  def name_subjects
+    <<-XML
+      <mods>
+        <subject>
+          <name>
+            <role>
+              <roleTerm type='text'>Depicted</roleTerm>
+            </role>
+            <namePart>John Doe</namePart>
+          </name>
+          <topic>Anonymous People</topic>
+        </subject>
+      </mods>
+    XML
+  end
+
+  def complex_subjects
+    <<-XML
+      <mods>
+        <subject>
+          <topic>Jazz</topic>
+          <geographical>Japan</geographical>
+          <topic>History and criticism</topic>
+        </subject>
+        <subject>
+          <topic>Bay Area</topic>
+          <geographical>Stanford</geographical>
+        </subject>
+      </mods>
+    XML
+  end
+
+end