mods 0.0.23 → 1.0.0

data/spec/part_spec.rb

@@ -7,11 +7,11 @@ describe "Mods <part> Element" do
   end
 
   it "should normalize dates" do
-    pending "to be implemented"
+    skip "to be implemented"
   end
-  
+
   context "basic <part> terminology pieces" do
-    
+
     context "WITH namespaces" do
       before(:all) do
         @ex = @mods_rec.from_str("<mods #{@ns_decl}><part>
@@ -38,7 +38,7 @@ describe "Mods <part> Element" do
                   </detail>
               </part></mods>").part
       end
-      
+
       it "should be a NodeSet" do
         [@ex, @ex2, @detail].each { |p| p.should be_an_instance_of(Nokogiri::XML::NodeSet) }
       end
@@ -205,7 +205,7 @@ describe "Mods <part> Element" do
           @date.size.should == 1
         end
         it "should recognize all date attributes except keyDate" do
-          Mods::DATE_ATTRIBS.reject { |n| n == 'keyDate' }.each { |a|  
+          Mods::DATE_ATTRIBS.reject { |n| n == 'keyDate' }.each { |a|
             @mods_rec.from_str("<mods #{@ns_decl}><part><date #{a}='attr_val'>zzz</date></part></mods>")
             @mods_rec.part.date.send(a.to_sym).should == ['attr_val']
           }
@@ -265,7 +265,7 @@ describe "Mods <part> Element" do
                   </detail>
               </part></mods>", false).part
       end
-      
+
       it "should be a NodeSet" do
         [@ex, @ex2, @detail].each { |p| p.should be_an_instance_of(Nokogiri::XML::NodeSet) }
       end
@@ -432,7 +432,7 @@ describe "Mods <part> Element" do
           @date.size.should == 1
         end
         it "should recognize all date attributes except keyDate" do
-          Mods::DATE_ATTRIBS.reject { |n| n == 'keyDate' }.each { |a|  
+          Mods::DATE_ATTRIBS.reject { |n| n == 'keyDate' }.each { |a|
             @mods_rec.from_str("<mods><part><date #{a}='attr_val'>zzz</date></part></mods>", false)
             @mods_rec.part.date.send(a.to_sym).should == ['attr_val']
           }
@@ -468,4 +468,4 @@ describe "Mods <part> Element" do
 
 
   end # basic <part> terminoology
-end
+end

data/spec/reader_spec.rb

@@ -11,24 +11,40 @@ describe "Mods::Reader" do
     @example_ns_str = '<mods:mods xmlns:mods="http://www.loc.gov/mods/v3"><mods:note>ns</mods:note></mods:mods>'
     @example_no_ns_str = '<mods><note>no ns</note></mods>'
     @example_wrong_ns_str = '<mods xmlns="wrong"><note>wrong ns</note></mods>'
-    @doc_from_str_default_ns = Mods::Reader.new.from_str(@example_ns_str) 
-    @doc_from_str_ns = Mods::Reader.new.from_str(@example_ns_str) 
-    @doc_from_str_no_ns = Mods::Reader.new.from_str(@example_no_ns_str) 
-    @doc_from_str_wrong_ns = Mods::Reader.new.from_str(@example_wrong_ns_str)    
+    @doc_from_str_default_ns = Mods::Reader.new.from_str(@example_ns_str)
+    @doc_from_str_ns = Mods::Reader.new.from_str(@example_ns_str)
+    @doc_from_str_no_ns = Mods::Reader.new.from_str(@example_no_ns_str)
+    @doc_from_str_wrong_ns = Mods::Reader.new.from_str(@example_wrong_ns_str)
     @from_url = Mods::Reader.new.from_url(@example_url)
   end
-  
+
   it "from_str should turn an xml string into a Nokogiri::XML::Document object" do
-    @doc_from_str_default_ns.class.should == Nokogiri::XML::Document
-    @doc_from_str_ns.class.should == Nokogiri::XML::Document
-    @doc_from_str_no_ns.class.should == Nokogiri::XML::Document
-    @doc_from_str_wrong_ns.class.should == Nokogiri::XML::Document
+    expect(@doc_from_str_default_ns).to be_instance_of(Nokogiri::XML::Document)
+    expect(@doc_from_str_ns).to be_instance_of(Nokogiri::XML::Document)
+    expect(@doc_from_str_no_ns).to be_instance_of(Nokogiri::XML::Document)
+    expect(@doc_from_str_wrong_ns).to be_instance_of(Nokogiri::XML::Document)
+  end
+
+  context "from_url" do
+    it "from_url should turn the contents at the url into a Nokogiri::XML::Document object" do
+      expect(@from_url).to be_instance_of(Nokogiri::XML::Document)
+    end
   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
+
+  context "from_file" do
+    before(:all) do
+      @fixture_dir = File.join(File.dirname(__FILE__), 'fixture_data')
+      @fixture_mods_file = File.join(@fixture_dir, 'shpc1.mods.xml')
+      @from_file = Mods::Reader.new.from_file(@fixture_mods_file)
+    end
+    it "should turn the contents of a file into a Nokogiri::XML::Document object" do
+      expect(@from_file).to be_instance_of(Nokogiri::XML::Document)
+    end
+    it "should give a meaningful error if passed a bad file" do
+      expect(lambda{Mods::Record.new.from_file('/fake/file')}).to raise_error
+    end
   end
-  
+
   context "namespace awareness" do
     it "should care about namespace by default" do
       r = Mods::Reader.new
@@ -58,13 +74,13 @@ describe "Mods::Reader" do
       my_from_str_wrong_ns = r.from_str(@example_wrong_ns_str)
       my_from_str_wrong_ns.xpath('/m:mods/m:note', @ns_hash).size.should == 0
       my_from_str_wrong_ns.xpath('/mods/note').text.should == "wrong ns"
-    end    
+    end
   end
-  
+
   it "should do something useful when it gets unparseable XML" do
-    pending "need to implement error handling for bad xml"
+    skip "need to implement error handling for bad xml"
   end
-  
+
   context "normalizing mods" do
     it "should not lose UTF-8 encoding" do
       utf_mods = '<?xml version="1.0" encoding="UTF-8"?>
@@ -92,7 +108,7 @@ describe "Mods::Reader" do
       r.mods_ng_xml.root.attributes.keys.should_not include('xsi:schemaLocation')
     end
   end
-  
+
   context "from_nk_node" do
     before(:all) do
       oai_resp = '<?xml version="1.0" encoding="UTF-8"?>
@@ -132,7 +148,7 @@ describe "Mods::Reader" do
       mods_ng_doc.xpath('/m:mods/m:titleInfo/m:title', @ns_hash).size.should == 0
       mods_ng_doc.xpath('/mods/titleInfo/title').text.should == "boo"
       @r.namespace_aware = true
-    end  
+    end
   end # context from_nk_node
-  
-end
+
+end

data/spec/record_info_spec.rb

@@ -7,15 +7,15 @@ describe "Mods <recordInfo> Element" do
   end
 
   it "should translate language codes" do
-    pending "to be implemented"
+    skip "to be implemented"
   end
-  
+
   it "should normalize dates" do
-    pending "to be implemented"
+    skip "to be implemented"
   end
-  
+
   context "basic <record_info> terminology pieces" do
-    
+
     context "WITH namespaces" do
       before(:all) do
         @rec_info = @mods_rec.from_str("<mods #{@ns_decl}><recordInfo>
@@ -57,8 +57,8 @@ describe "Mods <recordInfo> Element" do
         [@rec_info, @rec_info2, @bnf, @rlin].each { |ri| ri.size.should == 1 }
       end
       it "should recognize language attributes on <recordInfo> element" do
-        pending "problem with xml:lang"
-        Mods::LANG_ATTRIBS.each { |a| 
+        skip "problem with xml:lang"
+        Mods::LANG_ATTRIBS.each { |a|
           @mods_rec.from_str("<mods #{@ns_decl}><recordInfo #{a}='val'><recordOrigin>nowhere</recordOrigin></recordInfo></mods>")
           @mods_rec.record_info.send(a.to_sym).should == ['val']
         }
@@ -86,7 +86,7 @@ describe "Mods <recordInfo> Element" do
           @bnf.recordContentSource.authority.size.should == 0
         end
         it "should recognize all authority attributes" do
-          Mods::AUTHORITY_ATTRIBS.each { |a|  
+          Mods::AUTHORITY_ATTRIBS.each { |a|
             @mods_rec.from_str("<mods #{@ns_decl}><recordInfo><recordContentSource #{a}='attr_val'>zzz</recordContentSource></recordInfo></mods>")
             @mods_rec.record_info.recordContentSource.send(a.to_sym).should == ['attr_val']
           }
@@ -111,7 +111,7 @@ describe "Mods <recordInfo> Element" do
           @bnf.recordCreationDate.encoding.should == ['w3cdtf']
         end
         it "should recognize all date attributes" do
-          Mods::DATE_ATTRIBS.each { |a|  
+          Mods::DATE_ATTRIBS.each { |a|
             @mods_rec.from_str("<mods #{@ns_decl}><recordInfo><recordCreationDate #{a}='attr_val'>zzz</recordCreationDate></recordInfo></mods>")
             @mods_rec.record_info.recordCreationDate.send(a.to_sym).should == ['attr_val']
           }
@@ -133,7 +133,7 @@ describe "Mods <recordInfo> Element" do
           @rlin.recordChangeDate.encoding.should == ['iso8601']
         end
         it "should recognize all date attributes" do
-          Mods::DATE_ATTRIBS.each { |a|  
+          Mods::DATE_ATTRIBS.each { |a|
             @mods_rec.from_str("<mods #{@ns_decl}><recordInfo><recordChangeDate #{a}='attr_val'>zzz</recordChangeDate></recordInfo></mods>")
             @mods_rec.record_info.recordChangeDate.send(a.to_sym).should == ['attr_val']
           }
@@ -201,9 +201,9 @@ describe "Mods <recordInfo> Element" do
         end
 
         # from http://www.loc.gov/standards/mods/userguide/recordinfo.html#languageofcataloging
-        # objectPart attribute defined for consistency with <language> . Unlikely to be used with <languageOfCataloging> 
+        # objectPart attribute defined for consistency with <language> . Unlikely to be used with <languageOfCataloging>
         it "objectType should get attribute value" do
-          pending "<languageOfCataloging objectType=''> to be implemented ... maybe ..."
+          skip "<languageOfCataloging objectType=''> to be implemented ... maybe ..."
         end
 
         context "<languageTerm> child element" do
@@ -224,7 +224,7 @@ describe "Mods <recordInfo> Element" do
 
         context "<scriptTerm> child element" do
           it "should do something" do
-            pending "<recordInfo><languageOfCataloging><scriptTerm> to be implemented"
+            skip "<recordInfo><languageOfCataloging><scriptTerm> to be implemented"
           end
         end
       end # <languageOfCataloging>
@@ -243,13 +243,13 @@ describe "Mods <recordInfo> Element" do
           @bnf.descriptionStandard.map { |n| n.text }.should == []
         end
         it "should recognize all authority attributes" do
-          Mods::AUTHORITY_ATTRIBS.each { |a|  
+          Mods::AUTHORITY_ATTRIBS.each { |a|
             @mods_rec.from_str("<mods #{@ns_decl}><recordInfo><descriptionStandard #{a}='attr_val'>zzz</descriptionStandard></recordInfo></mods>")
             @mods_rec.record_info.descriptionStandard.send(a.to_sym).should == ['attr_val']
           }
         end
       end # <descriptionStandard>
-      
+
     end # WITH namespaces
 
     context "WITHOUT namespaces" do
@@ -293,8 +293,8 @@ describe "Mods <recordInfo> Element" do
         [@rec_info, @rec_info2, @bnf, @rlin].each { |ri| ri.size.should == 1 }
       end
       it "should recognize language attributes on <recordInfo> element" do
-        pending "problem with xml:lang"
-        Mods::LANG_ATTRIBS.each { |a| 
+        skip "problem with xml:lang"
+        Mods::LANG_ATTRIBS.each { |a|
           @mods_rec.from_str("<mods><recordInfo #{a}='val'><recordOrigin>nowhere</recordOrigin></recordInfo></mods>", false)
           @mods_rec.record_info.send(a.to_sym).should == ['val']
         }
@@ -322,7 +322,7 @@ describe "Mods <recordInfo> Element" do
           @bnf.recordContentSource.authority.size.should == 0
         end
         it "should recognize all authority attributes" do
-          Mods::AUTHORITY_ATTRIBS.each { |a|  
+          Mods::AUTHORITY_ATTRIBS.each { |a|
             @mods_rec.from_str("<mods><recordInfo><recordContentSource #{a}='attr_val'>zzz</recordContentSource></recordInfo></mods>", false)
             @mods_rec.record_info.recordContentSource.send(a.to_sym).should == ['attr_val']
           }
@@ -347,7 +347,7 @@ describe "Mods <recordInfo> Element" do
           @bnf.recordCreationDate.encoding.should == ['w3cdtf']
         end
         it "should recognize all date attributes" do
-          Mods::DATE_ATTRIBS.each { |a|  
+          Mods::DATE_ATTRIBS.each { |a|
             @mods_rec.from_str("<mods><recordInfo><recordCreationDate #{a}='attr_val'>zzz</recordCreationDate></recordInfo></mods>", false)
             @mods_rec.record_info.recordCreationDate.send(a.to_sym).should == ['attr_val']
           }
@@ -369,7 +369,7 @@ describe "Mods <recordInfo> Element" do
           @rlin.recordChangeDate.encoding.should == ['iso8601']
         end
         it "should recognize all date attributes" do
-          Mods::DATE_ATTRIBS.each { |a|  
+          Mods::DATE_ATTRIBS.each { |a|
             @mods_rec.from_str("<mods><recordInfo><recordChangeDate #{a}='attr_val'>zzz</recordChangeDate></recordInfo></mods>", false)
             @mods_rec.record_info.recordChangeDate.send(a.to_sym).should == ['attr_val']
           }
@@ -437,9 +437,9 @@ describe "Mods <recordInfo> Element" do
         end
 
         # from http://www.loc.gov/standards/mods/userguide/recordinfo.html#languageofcataloging
-        # objectPart attribute defined for consistency with <language> . Unlikely to be used with <languageOfCataloging> 
+        # objectPart attribute defined for consistency with <language> . Unlikely to be used with <languageOfCataloging>
         it "objectType should get attribute value" do
-          pending "<languageOfCataloging objectType=''> to be implemented ... maybe ..."
+          skip "<languageOfCataloging objectType=''> to be implemented ... maybe ..."
         end
 
         context "<languageTerm> child element" do
@@ -460,7 +460,7 @@ describe "Mods <recordInfo> Element" do
 
         context "<scriptTerm> child element" do
           it "should do something" do
-            pending "<recordInfo><languageOfCataloging><scriptTerm> to be implemented"
+            skip "<recordInfo><languageOfCataloging><scriptTerm> to be implemented"
           end
         end
       end # <languageOfCataloging>
@@ -479,15 +479,15 @@ describe "Mods <recordInfo> Element" do
           @bnf.descriptionStandard.map { |n| n.text }.should == []
         end
         it "should recognize all authority attributes" do
-          Mods::AUTHORITY_ATTRIBS.each { |a|  
+          Mods::AUTHORITY_ATTRIBS.each { |a|
             @mods_rec.from_str("<mods><recordInfo><descriptionStandard #{a}='attr_val'>zzz</descriptionStandard></recordInfo></mods>", false)
             @mods_rec.record_info.descriptionStandard.send(a.to_sym).should == ['attr_val']
           }
         end
       end # <descriptionStandard>
-      
+
     end # WITHOUT namespaces
-    
+
   end # basic <record_info> terminology pieces
 
-end
+end

data/spec/record_spec.rb

@@ -7,8 +7,8 @@ describe "Mods::Record" do
     @example_ns_str = "<mods #{@def_ns_decl}><note>default ns</note></mods>"
     @example_no_ns_str = '<mods><note>no ns</note></mods>'
     @example_record_url = 'http://www.loc.gov/standards/mods/modsrdf/examples/0001.xml'
-    @doc_from_str_ns = Mods::Reader.new.from_str(@example_ns_str) 
-    @doc_from_str_no_ns = Mods::Reader.new.from_str(@example_no_ns_str) 
+    @doc_from_str_ns = Mods::Reader.new.from_str(@example_ns_str)
+    @doc_from_str_no_ns = Mods::Reader.new.from_str(@example_no_ns_str)
   end
 
   context "from_str" do
@@ -31,18 +31,31 @@ describe "Mods::Record" do
     end
   end
 
+  # Be able to create a new Mods::Record from a url
   context "from_url" do
     before(:all) do
       @mods_doc = Mods::Record.new.from_url(@example_record_url)
     end
-    it "should be a mods record" do
-      @mods_doc.kind_of? Mods::Record
+    it "should return a mods record" do
+      expect(@mods_doc).to be_a_kind_of(Mods::Record)
     end
     it "should raise an error on a bad url" do
       lambda{Mods::Record.new.from_url("http://example.org/fake.xml")}.should raise_error
     end
   end
-  
+
+  # Be able to create a new Mods::Record from a file
+  context "from_file" do
+    before(:all) do
+      @fixture_dir = File.join(File.dirname(__FILE__), 'fixture_data')
+      @fixture_mods_file = File.join(@fixture_dir, 'shpc1.mods.xml')
+      @mods_doc = Mods::Record.new.from_file(@fixture_mods_file)
+    end
+    it "should return a mods record" do
+      expect(@mods_doc).to be_a_kind_of(Mods::Record)
+    end
+  end
+
   context "from_nk_node" do
     before(:all) do
       oai_resp = '<?xml version="1.0" encoding="UTF-8"?>
@@ -76,7 +89,7 @@ describe "Mods::Record" do
 					</n:titleInfo>
 				</n:mods>
       </metadata>'
-      ng_xml = Nokogiri::XML(bad_ns_wrapped) 
+      ng_xml = Nokogiri::XML(bad_ns_wrapped)
       @mods_node_no_ns = ng_xml.xpath('//n:mods', {'n'=>'http://www.not.mods.org'}).first
     end
     it "should have namespace aware parsing turned on by default" do
@@ -94,7 +107,7 @@ describe "Mods::Record" do
       mods_ng_doc.title_info.title.map { |e| e.text }.should == ["What? No namespaces?"]
     end
   end # context from_nk_node
-  
+
   context "getting term values" do
     before(:all) do
       m = "<mods #{@def_ns_decl}>
@@ -108,7 +121,7 @@ describe "Mods::Record" do
       @mods_rec = Mods::Record.new
       @mods_rec.from_str(m)
     end
-    
+
     context "term_value (single value result)" do
       it "should return nil if there are no such values in the MODS" do
         @mods_rec.term_value(:identifier).should == nil
@@ -158,9 +171,9 @@ describe "Mods::Record" do
       it "should raise an error if the argument isn't a Symbol or an Array" do
         expect { @mods_rec.term_values(@mods_rec.subject) }.to raise_error(ArgumentError, /term_values called with unrecognized argument class:.*NodeSet.*/)
       end
-    end    
+    end
   end # getting term values
-  
+
   context "convenience methods for accessing tricky bits of terminology" do
     before(:all) do
       @mods_rec = Mods::Record.new
@@ -185,7 +198,7 @@ describe "Mods::Record" do
         @mods_rec.alternative_titles.should == ['12']
       end
     end
-    
+
     context "personal_names" do
       before(:all) do
         @pers_name = 'Crusty'
@@ -193,7 +206,7 @@ describe "Mods::Record" do
         @pers_role = 'creator'
         @mods_w_pers_name_role = "<mods #{@def_ns_decl}><name type='personal'><namePart>#{@pers_name}</namePart>"
         @given_family = '<mods xmlns="http://www.loc.gov/mods/v3"><name type="personal"><namePart type="given">Jorge Luis</namePart>
-                                <namePart type="family">Borges</namePart></name></mods>'        
+                                <namePart type="family">Borges</namePart></name></mods>'
         @given_family_date = '<mods xmlns="http://www.loc.gov/mods/v3"><name type="personal"><namePart type="given">Zaphod</namePart>
                                 <namePart type="family">Beeblebrox</namePart>
                                 <namePart type="date">1912-2362</namePart></name></mods>'
@@ -218,7 +231,7 @@ describe "Mods::Record" do
       it "should prefer displayForm over namePart pieces" do
         display_form_and_name_parts = '<mods xmlns="http://www.loc.gov/mods/v3"><name type="personal"><namePart type="given">Jorge Luis</namePart>
                                 <namePart type="family">Borges</namePart>
-                                <displayForm>display form</displayForm></name></mods>'        
+                                <displayForm>display form</displayForm></name></mods>'
         @mods_rec.from_str(display_form_and_name_parts)
         @mods_rec.personal_names.should include("display form")
       end
@@ -244,7 +257,7 @@ describe "Mods::Record" do
         @mods_rec.personal_names.should include("Borges, Jorge Luis")
       end
       it "should not include a comma when there is only a family or given name" do
-        [@family_only, @given_only].each { |mods_str|  
+        [@family_only, @given_only].each { |mods_str|
           @mods_rec.from_str(mods_str)
           @mods_rec.personal_names.first.should_not match(/,/)
         }
@@ -252,13 +265,13 @@ describe "Mods::Record" do
       it "should include terms of address" do
         @mods_rec.from_str(@all_name_parts)
         @mods_rec.personal_names.first.should match(/Mr./)
-      end      
-    end # personal_names 
-    
+      end
+    end # personal_names
+
     context "personal_names_w_dates" do
       before(:all) do
         @given_family = '<mods xmlns="http://www.loc.gov/mods/v3"><name type="personal"><namePart type="given">Jorge Luis</namePart>
-                                <namePart type="family">Borges</namePart></name></mods>'        
+                                <namePart type="family">Borges</namePart></name></mods>'
         @given_family_date = '<mods xmlns="http://www.loc.gov/mods/v3"><name type="personal"><namePart type="given">Zaphod</namePart>
                                 <namePart type="family">Beeblebrox</namePart>
                                 <namePart type="date">1912-2362</namePart></name></mods>'
@@ -276,13 +289,13 @@ describe "Mods::Record" do
         @mods_rec.personal_names_w_dates.first.should match(/, 1912-2362$/)
         @mods_rec.from_str(@all_name_parts)
         @mods_rec.personal_names_w_dates.first.should match(/, date$/)
-      end      
+      end
       it "should be just the personal_name if no date is available" do
         @mods_rec.from_str(@given_family)
         @mods_rec.personal_names_w_dates.first.should == 'Borges, Jorge Luis'
       end
     end
-      
+
     context "corporate_names" do
       before(:all) do
         @corp_name = 'ABC corp'
@@ -295,18 +308,18 @@ describe "Mods::Record" do
         corp_role = 'lithographer'
         mods_w_corp_name_role = "<mods #{@def_ns_decl}><name type='corporate'><namePart>#{@corp_name}</namePart>
           <role><roleTerm type='text'>#{corp_role}</roleTerm></role></name></mods>"
-        @mods_rec.from_str(mods_w_corp_name_role)      
+        @mods_rec.from_str(mods_w_corp_name_role)
         @mods_rec.corporate_names.first.should_not match(corp_role)
       end
 
       it "should prefer displayForm over namePart pieces" do
         display_form_and_name_parts = "<mods #{@def_ns_decl}><name type='corporate'><namePart>Food, Inc.</namePart>
-                                <displayForm>display form</displayForm></name></mods>"       
+                                <displayForm>display form</displayForm></name></mods>"
         @mods_rec.from_str(display_form_and_name_parts)
         @mods_rec.corporate_names.should include("display form")
       end
     end # corporate_names
-    
+
     context "languages" do
       before(:all) do
         @simple = "<mods #{@def_ns_decl}><language>Greek</language></mods>"