mods 0.0.2 → 0.0.4

data/spec/physical_description_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe "Mods <physicalDescription> Element" do
+  before(:all) do
+    @mods_rec = Mods::Record.new
+    @extent_only = '<mods><physicalDescription><extent>extent</extent></physicalDescription></mods>'
+    @form_and_extent = '<mods><physicalDescription>
+                           <form authority="smd">map</form>
+                           <form type="material">foo</form>
+                           <extent>1 map ; 22 x 18 cm.</extent>
+                        </physicalDescription></mods>'
+    @forms_and_notes = '<mods><physicalDescription>
+                          <form authority="aat">Graphics</form>
+                          <form>plain form</form>
+                          <note displayLabel="Dimensions">dimension text</note>
+                          <note displayLabel="Condition">condition text</note>
+                        </physicalDescription></mods>'
+    @digital = '<mods><physicalDescription>
+                    <reformattingQuality>preservation</reformattingQuality>
+                    <internetMediaType>image/jp2</internetMediaType>
+                    <digitalOrigin>reformatted digital</digitalOrigin>
+                </physicalDescription></mods>'
+  end
+
+  context "basic physical_description terminology pieces" do
+    before(:all) do
+      @mods_rec.from_str(@form_and_extent)
+    end
+    
+    it "extent child element" do
+      @mods_rec.from_str(@extent_only)
+      @mods_rec.physical_description.extent.map { |n| n.text }.should == ["extent"]
+    end
+
+    context "note child element" do
+      before(:all) do
+        @mods_rec.from_str(@forms_and_notes)
+      end
+      it "should understand note element" do
+        @mods_rec.physical_description.note.map { |n| n.text }.should == ["dimension text", "condition text"]
+      end
+      it "should understand displayLabel attribute on note element" do
+        @mods_rec.physical_description.note.displayLabel.should == ["Dimensions", "Condition"]
+      end
+    end
+
+    context "form child element" do
+      before(:all) do
+        @mods_rec.from_str(@form_and_extent)
+      end
+      it "should understand form element" do
+        @mods_rec.physical_description.form.map { |n| n.text }.should == ["map", "foo"]
+      end
+      it "should understand authority attribute on form element" do
+        @mods_rec.physical_description.form.authority.should == ["smd"]
+      end
+      it "should understand type attribute on form element" do
+        @mods_rec.physical_description.form.type_at.should == ["material"]
+      end
+    end
+
+    context "digital materials" do
+      before(:all) do
+        @mods_rec.from_str(@digital)
+      end
+      it "should understand reformattingQuality child element" do
+        @mods_rec.physical_description.reformattingQuality.map { |n| n.text }.should == ["preservation"]
+      end
+      it "should understand digitalOrigin child element" do
+        @mods_rec.physical_description.digitalOrigin.map { |n| n.text }.should == ["reformatted digital"]
+      end
+      it "should understand internetMediaType child element" do
+        @mods_rec.physical_description.internetMediaType.map { |n| n.text }.should == ["image/jp2"]
+      end
+    end
+  
+  end # basic terminology pieces
+  
+end

data/spec/reader_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe "Mods::Reader" do
+  before(:all) do
+    # url is for a namespaced document
+    @example_url = 'http://www.loc.gov/standards/mods/v3/mods99042030_linkedDataAdded.xml'
+    @example_no_ns_str = '<mods><note>hi</note></mods>'
+    @example_wrong_ns_str = '<mods xmlns="whoops"><note>hi</note></mods>'
+    @from_no_ns_str = Mods::Reader.new.from_str(@example_no_ns_str)    
+    @from_wrong_ns_str = Mods::Reader.new.from_str(@example_wrong_ns_str)    
+    @from_url = Mods::Reader.new.from_url(@example_url)
+    @ns_hash = {'mods' => Mods::MODS_NS}
+  end
+  
+  it "from_str should turn an xml string into a Nokogiri::XML::Document object" do
+    @from_no_ns_str.class.should == Nokogiri::XML::Document
+    @from_wrong_ns_str.class.should == Nokogiri::XML::Document
+  end
+  
+  it "from_url should turn the contents at the url into a Nokogiri::XML::Document object" do
+    @from_url.class.should == Nokogiri::XML::Document
+  end
+
+  context "namespace awareness" do
+    it "should not care about namespace by default" do
+      r = Mods::Reader.new
+      r.namespace_aware.should == false
+      @from_no_ns_str.xpath('/mods/note').text.should == "hi"
+      @from_wrong_ns_str.xpath('/mods/note').text.should == "hi"
+#      @from_no_ns_str.xpath('/mods:mods/mods:note', @ns_hash).text.should == ""
+#      @from_wrong_ns_str.xpath('/mods:mods/mods:note', @ns_hash).text.should == ""
+    end
+
+    it "should be allowed to care about namespaces" do
+      r = Mods::Reader.new
+      r.namespace_aware = true
+      r.from_url(@example_url).root.namespace.href.should == Mods::MODS_NS
+      my_from_str_no_ns = r.from_str(@example_no_ns_str)
+      my_from_str_no_ns.xpath('/mods:mods/mods:note', @ns_hash).text.should_not == "hi"
+      my_from_str_wrong_ns = r.from_str(@example_wrong_ns_str)
+      my_from_str_wrong_ns.root.namespace.href.should == 'whoops'
+      my_from_str_wrong_ns.xpath('/mods:mods/mods:note', @ns_hash).text.should_not == "hi"
+      my_from_str_wrong_ns.xpath('/mods/note').text.should_not == "hi"
+    end
+  end
+  
+  it "should do something useful when it gets unparseable XML" do
+    pending "need to implement error handling for bad xml"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# for test coverage
+require 'simplecov'
+require 'simplecov-rcov'
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+     SimpleCov::Formatter::HTMLFormatter.new.format(result)
+     SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'mods'
+
+#RSpec.configure do |config|
+#end

data/spec/title_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe "Mods <titleInfo> element" do
+  
+  before(:all) do
+    @mods_rec = Mods::Record.new
+  end
+    
+  it "should recognize type attribute on titleInfo element" do
+    Mods::TitleInfo::TYPES.each { |t|
+      @mods_rec.from_str("<mods><titleInfo type='#{t}'>hi</titleInfo></mods>")
+      @mods_rec.title_info.type_at.text.should == t
+    }
+  end
+  
+  it "should recognize subelements" do
+    Mods::TitleInfo::SUBELEMENTS.each { |e|
+      @mods_rec.from_str("<mods><titleInfo><#{e}>oofda</#{e}></titleInfo></mods>")
+      @mods_rec.title_info.send(e).text.should == 'oofda'
+    }
+  end
+  
+  context "short_title" do
+    it "should start with nonSort element" do
+      @mods_rec.from_str('<mods><titleInfo><title>Jerk</title><nonSort>The</nonSort></titleInfo></mods>')
+      @mods_rec.title_info.short_title.should == ["The Jerk"]
+    end
+    it "should not include subtitle" do
+      @mods_rec.from_str('<mods><titleInfo><title>Jerk</title><subTitle>A Tale of Tourettes</subTitle><nonSort>The</nonSort></titleInfo></mods>')
+      @mods_rec.title_info.short_title.should == ["The Jerk"]
+    end
+    it "Mods::Record.short_titles convenience method should return an Array (multiple titles are legal in Mods)" do
+      @mods_rec.from_str('<mods><titleInfo><title>Jerk</title><nonSort>The</nonSort></titleInfo><titleInfo><title>Joke</title></titleInfo></mods>')
+      @mods_rec.short_titles.should == ["The Jerk", "Joke"]
+    end
+    it "should not include alternative titles" do
+      @mods_rec.from_str('<mods><titleInfo type="alternative"><title>ta da!</title></titleInfo></mods>')
+      @mods_rec.short_titles.should_not include("ta da!")
+      @mods_rec.from_str("<mods><titleInfo type='alternative'><title>1</title></titleInfo><titleInfo><title>2</title></titleInfo></mods>")
+      @mods_rec.short_titles.should == ['2']
+    end
+  end
+  
+  context "full_title" do
+    it "should start with nonSort element" do
+      @mods_rec.from_str('<mods><titleInfo><title>Jerk</title><nonSort>The</nonSort></titleInfo></mods>')
+      @mods_rec.title_info.full_title.should == ["The Jerk"]
+    end
+    it "should include subtitle" do
+      @mods_rec.from_str('<mods><titleInfo><title>Jerk</title><subTitle>A Tale of Tourettes</subTitle><nonSort>The</nonSort></titleInfo></mods>')
+      @mods_rec.title_info.full_title.should == ["The Jerk A Tale of Tourettes"]
+    end
+    it "Mods::Record.full_titles convenience method should return an Array (multiple titles are legal in Mods)" do
+      @mods_rec.from_str('<mods><titleInfo><title>Jerk</title><nonSort>The</nonSort></titleInfo><titleInfo><title>Joke</title></titleInfo></mods>')
+      @mods_rec.full_titles.should == ["The Jerk", "Joke"]
+    end
+  end
+
+  context "sort_title" do
+    it "should skip nonSort element" do
+      @mods_rec.from_str('<mods><titleInfo><title>Jerk</title><nonSort>The</nonSort></titleInfo></mods>')
+      @mods_rec.title_info.sort_title.should == ["Jerk"]
+    end
+    it "should contain title and subtitle" do
+      @mods_rec.from_str('<mods><titleInfo><title>Jerk</title><subTitle>A Tale of Tourettes</subTitle><nonSort>The</nonSort></titleInfo></mods>')
+      @mods_rec.title_info.sort_title.should == ["Jerk A Tale of Tourettes"]
+    end
+    it "should be an alternative title if there are no other choices" do
+      @mods_rec.from_str("<mods><titleInfo type='alternative'><title>1</title></titleInfo></mods>")
+      @mods_rec.title_info.sort_title.should == ['1']
+    end
+    it "should not be an alternative title if there are other choices" do
+      @mods_rec.from_str("<mods><titleInfo type='alternative'><title>1</title></titleInfo><titleInfo><title>2</title></titleInfo></mods>")
+      @mods_rec.title_info.sort_title.should == ['2']
+      @mods_rec.sort_title.should == '2'
+    end
+    it "should have a configurable delimiter between title and subtitle" do
+      m = Mods::Record.new(' : ')
+      m.from_str('<mods><titleInfo><title>Jerk</title><subTitle>A Tale of Tourettes</subTitle><nonSort>The</nonSort></titleInfo></mods>')
+      m.title_info.sort_title.should == ["Jerk : A Tale of Tourettes"]
+    end
+    context "Mods::Record.sort_title convenience method" do
+      it "convenience method sort_title in Mods::Record should return a string" do
+        @mods_rec.from_str('<mods><titleInfo><title>Jerk</title><subTitle>A Tale of Tourettes</subTitle><nonSort>The</nonSort></titleInfo></mods>')
+        @mods_rec.sort_title.should == "Jerk A Tale of Tourettes"
+      end
+    end
+  end
+  
+  context "alternative_title" do
+    it "should get an alternative title, if it exists" do
+      @mods_rec.from_str('<mods><titleInfo type="alternative"><title>ta da!</title></titleInfo></mods>')
+      @mods_rec.title_info.alternative_title.should == ["ta da!"]
+    end
+    it "Mods::Record.alternative_titles convenience method for getting an Array of alternative titles when there are multiple elements" do
+      @mods_rec.from_str("<mods><titleInfo type='alternative'><title>1</title></titleInfo><titleInfo type='alternative'><title>2</title></titleInfo></mods>")
+      @mods_rec.alternative_titles.should == ['1', '2']
+      @mods_rec.from_str("<mods><titleInfo type='alternative'><title>1</title><title>2</title></titleInfo></mods>")
+      @mods_rec.alternative_titles.should == ['12']
+    end
+    it "should not get an alternative title if type attribute is absent from titleInfo" do
+      @mods_rec.from_str('<mods><titleInfo><title>ta da!</title></titleInfo></mods>')
+      @mods_rec.alternative_titles.should == []
+    end
+    it "should not get an alternative title if type attribute from titleInfo is not 'alternative'" do
+      @mods_rec.from_str('<mods><titleInfo type="uniform"><title>ta da!</title></titleInfo></mods>')
+      @mods_rec.alternative_titles.should == []
+    end
+  end
+      
+end

data/spec/top_level_elmnts_simple_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "Mods Top Level Elements that do not have Child Elements" do
+
+  before(:all) do
+    @mods_rec = Mods::Record.new
+  end
+
+  it "should get the text contents of any single simple (cannot have child elements) top level element" do
+    Mods::TOP_LEVEL_ELEMENTS_SIMPLE.each { |elname|
+      @mods_rec.from_str("<mods><#{elname}>hi</#{elname}></mods>")
+      @mods_rec.send(elname.to_sym).map { |e| e.text }.should == ["hi"]
+    }
+  end
+  
+  it "should get the text contents of any single complex top level element instance with no child elements" do
+    pending "to be implemented"
+    Mods::TOP_LEVEL_ELEMENTS_COMPLEX.each { |elname|
+      @mods_rec.from_str("<mods><#{elname}>hi</#{elname}></mods>")
+      @mods_rec.send(elname.to_sym).map { |e| e.text }.should == ["hi"]
+    }
+  end
+  
+  it "should return an array of strings when there are multiple occurrences of simple top level elements" do
+    @mods_rec.from_str('<mods><note>hi</note><note>hello</note></mods>').note.map { |e| e.text }.should == ["hi", "hello"]
+  end
+  
+  it "should deal with camelcase vs. ruby underscore convention" do
+    pending "need to implement ruby style version of (element/attribute) method names"
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mods
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2012-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -28,6 +28,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nom-xml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: iso-639
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -124,13 +156,16 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby gem to parse MODS (Metadata Object Description Schema) records
+description: Parse MODS (Metadata Object Description Schema) records.  More information
+  about MODS can be found at http://www.loc.gov/standards/mods/
 email:
 - ndushay AT stanford.edu
 - bess AT stanford.edu
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
 files:
 - .gitignore
 - .rvmrc
@@ -141,9 +176,25 @@ files:
 - README.rdoc
 - Rakefile
 - lib/mods.rb
+- lib/mods/constants.rb
+- lib/mods/marc_relator_codes.rb
+- lib/mods/name.rb
+- lib/mods/nom_terminology.rb
+- lib/mods/reader.rb
+- lib/mods/record.rb
+- lib/mods/title_info.rb
 - lib/mods/version.rb
 - mods.gemspec
-homepage: ''
+- spec/language_spec.rb
+- spec/location_spec.rb
+- spec/name_spec.rb
+- spec/origin_info_spec.rb
+- spec/physical_description_spec.rb
+- spec/reader_spec.rb
+- spec/spec_helper.rb
+- spec/title_spec.rb
+- spec/top_level_elmnts_simple_spec.rb
+homepage: https://github.com/sul-dlss/mods
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -157,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 94644165565743159
+      hash: 1304587137062887266
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -166,13 +217,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 94644165565743159
+      hash: 1304587137062887266
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A Ruby gem to parse MODS (Metadata Object Description Schema) records.  More
-  information about MODS can be found at http://www.loc.gov/standards/mods/registry.php.
-test_files: []
+summary: Parse MODS (Metadata Object Description Schema) records.
+test_files:
+- spec/language_spec.rb
+- spec/location_spec.rb
+- spec/name_spec.rb
+- spec/origin_info_spec.rb
+- spec/physical_description_spec.rb
+- spec/reader_spec.rb
+- spec/spec_helper.rb
+- spec/title_spec.rb
+- spec/top_level_elmnts_simple_spec.rb
 has_rdoc: