mods 0.0.23 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDEwMWE1MTQ2NzZiZWY5N2U4NDg0MDAyZjdlZDVhYmQ1M2I2ZWVmZA==
-  data.tar.gz: !binary |-
-    YTc1MTZhZjg2MWI1MmVhNmJlYjdmODU0N2M5OTg3MDNmM2I4ZTZhMA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZjE1N2RmMmI3YTZkYWU1ZTU4ZDg4MWM3MzUzMDQ4N2RiZjEzNDAzNDE2NmFm
-    ZWFlZDllMTcyNWU0MzlkM2FjNjE1YmM3ODllYTlkMDMyMzg0MjI2OWY2N2My
-    YzVjODkwMDJiNDExOGJhMTZjODBiYzc5YzFmOWY2MGNhZDU5ODc=
-  data.tar.gz: !binary |-
-    ZWNkYjNkZTQxMmZjNzI4NDhhODFmNGNmMjMxOGFjOTc1MjNiYTIyNGYyOThj
-    MmE0NTNmOTEwNWU4YjY1MzIzNTEyZWU5MGNkMTkzODU5NDg3MjYyNDUwNjYz
-    Mzc5YmZkZjI0YWMwMjVkZDA2OGVkNTUzYjVhNTA1NTU1OTExNGQ=
+SHA1:
+  metadata.gz: 4fe75882ef2b666a42f3ad2ed28beb3535c19145
+  data.tar.gz: 7c772c0a8ac2336a7590399dc4f8811bc58d8df7
+SHA512:
+  metadata.gz: d72061a466439b824e8a003656cb115b9f8be14a531efa0b9cf9f67e4fbd195058ddc25ec6c9f5ccb5950038b86165ab5783c7d9e05affc14d89256aa0daff48
+  data.tar.gz: 594347b7fbd0608009614bfe0a546ab7ec28a14bb98a2e8bec7d8f1d56d9a84fe6f6416862175bfe6a1f9ff6092bc47b24e65a67574873776ab36cce9e3e7e45

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -1,11 +1,18 @@
 language: ruby
 script: rake rspec
 rvm:
+  - 2.2.0
+  - 2.1.5
+  - 2.1.1
+  - 2.0.0
   - 1.9.3
-  - 1.9.2
-  - jruby-19mode
+  - ruby-head
+  - jruby-1.7.9-d19 # fails after 1.7.10 for some reason
+#  - jruby-19mode # JRuby in 1.9 mode
+#  - jruby-head
 notifications:
   email:
     - ndushay@stanford.edu
+    - laneymcg@stanford.edu
     - jkeck@stanford.edu
     - bess@stanford.edu

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # See mods.gemspec for this gem's dependencies
 gemspec
+
+group :test do
+  gem 'coveralls', require: false
+end

data/README.rdoc

@@ -1,7 +1,6 @@
 = Mods
 
-{<img src="https://secure.travis-ci.org/sul-dlss/mods.png?branch=master" alt="Build Status" />}[http://travis-ci.org/sul-dlss/mods]
-{<img src="https://gemnasium.com/sul-dlss/mods.png" alt="Dependency Status" />}[https://gemnasium.com/sul-dlss/mods]
+{<img src="https://secure.travis-ci.org/sul-dlss/mods.png?branch=master" alt="Build Status" />}[http://travis-ci.org/sul-dlss/mods] {<img src="https://coveralls.io/repos/sul-dlss/mods/badge.png" alt="Coverage Status" />}[https://coveralls.io/r/sul-dlss/mods] {<img src="https://gemnasium.com/sul-dlss/mods.png" alt="Dependency Status" />}[https://gemnasium.com/sul-dlss/mods] {<img src="https://badge.fury.io/rb/mods.svg" alt="Gem Version" />}[http://badge.fury.io/rb/mods]
 
 A 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.
 
@@ -25,7 +24,13 @@ Or install it yourself as:
 
 == Usage
 
-TODO: Write usage instructions here
+Create a new Mods::Record from a url:
+
+  foo = Mods::Record.new.from_url('http://purl.stanford.edu/bb340tm8592.mods')
+
+Create a new Mods::Record from a file:
+
+  foo = Mods::Record.new.from_file('/path/to/mods/file.xml')
 
 == Contributing
 

data/lib/mods/reader.rb

@@ -2,18 +2,18 @@
 
 module Mods
   class Reader
-    
+
     DEFAULT_NS_AWARE = true
 
-    # true if the XML parsing should be strict about using namespaces. 
+    # true if the XML parsing should be strict about using namespaces.
     attr_accessor :namespace_aware
     attr_reader :mods_ng_xml
-    
+
     # @param ns_aware true if the XML parsing should be strict about using namespaces.  Default is true
     def initialize(ns_aware = DEFAULT_NS_AWARE)
       @namespace_aware = ns_aware
     end
-    
+
     # @param str - a string containing mods xml
     # @return Nokogiri::XML::Document
     def from_str(str)
@@ -21,16 +21,32 @@ module Mods
       normalize_mods
       @mods_ng_xml
     end
-  
+
+    # Read in the contents of a Mods file from a url.
     # @param url (String) - url that has mods xml as its content
     # @return Nokogiri::XML::Document
+    # @example
+    #   foo = Mods::Reader.new.from_url('http://purl.stanford.edu/bb340tm8592.mods')
     def from_url(url, encoding = nil, options = Nokogiri::XML::ParseOptions::DEFAULT_XML)
       require 'open-uri'
       @mods_ng_xml = Nokogiri::XML(open(url).read)
       normalize_mods
       @mods_ng_xml
     end
-    
+
+    # Read in the contents of a Mods record from a file.
+    # @param filename (String) - path to file that has mods xml as its content
+    # @return Nokogiri::XML::Document
+    # @example
+    #   foo = Mods::Reader.new.from_file('/path/to/mods/file.xml')
+    def from_file(filename, encoding = nil, options = Nokogiri::XML::ParseOptions::DEFAULT_XML)
+      file = File.open(filename)
+      @mods_ng_xml = Nokogiri::XML(file)
+      file.close
+      normalize_mods
+      @mods_ng_xml
+    end
+
     # @param node (Nokogiri::XML::Node) - Nokogiri::XML::Node that is the top level element of a mods record
     # @return Nokogiri::XML::Document
     def from_nk_node(node)
@@ -38,7 +54,7 @@ module Mods
       normalize_mods
       @mods_ng_xml
     end
-    
+
     # Whatever we get, normalize it into a Nokogiri::XML::Document,
     def normalize_mods
       if !@namespace_aware
@@ -53,6 +69,6 @@ module Mods
         @mods_ng_xml = Nokogiri::XML(@mods_ng_xml.to_s, nil, @mods_ng_xml.encoding)
       end
     end
-    
-  end # class 
-end # module
+
+  end # class
+end # module

data/lib/mods/record.rb

@@ -5,16 +5,16 @@ module Mods
   class Record
 
     attr_reader :mods_ng_xml
-    # string to use when combining a title and subtitle, e.g. 
+    # string to use when combining a title and subtitle, e.g.
     #  for title "MODS" and subtitle "Metadata Odious Delimited Stuff" and delimiter " : "
     #  we get "MODS : Metadata Odious Delimited Stuff"
     attr_accessor :title_delimiter
 
     NS_HASH = {'m' => MODS_NS_V3}
-    
+
     ATTRIBUTES = ['id', 'version']
 
-    # @param (String) title_delimiter what to use when combining a title and subtitle, e.g. 
+    # @param (String) title_delimiter what to use when combining a title and subtitle, e.g.
     #  for title "MODS" and subtitle "Metadata Odious Delimited Stuff" and delimiter " : "
     #  we get "MODS : Metadata Odious Delimited Stuff"
     def initialize(title_delimiter = Mods::TitleInfo::DEFAULT_TITLE_DELIM)
@@ -33,9 +33,13 @@ module Mods
       end
     end
 
-    # convenience method to call Mods::Reader.new.from_url and to nom
-    # @param namespace_aware true if the XML parsing should be strict about using namespaces.  Default is true
+    # Convenience method to call Mods::Reader.new.from_url and to nom.
+    # Returns a new instance of Mods::Record instantiated with the content from the given URL.
     # @param url (String) - url that has mods xml as its content
+    # @param namespace_aware true if the XML parsing should be strict about using namespaces.  Default is true
+    # @return Mods::Record
+    # @example
+    #   foo = Mods::Record.new.from_url('http://purl.stanford.edu/bb340tm8592.mods')
     def from_url(url, ns_aware = true)
       @mods_ng_xml = Mods::Reader.new(ns_aware).from_url(url)
       if ns_aware
@@ -43,6 +47,24 @@ module Mods
       else
         set_terminology_no_ns(@mods_ng_xml)
       end
+      return self
+    end
+
+    # Convenience method to call Mods::Reader.new.from_file.
+    # Returns a new instance of Mods::Record instantiated with the content from the given file.
+    # @param file (String) - path to file that has mods xml as its content
+    # @param namespace_aware true if the XML parsing should be strict about using namespaces.  Default is true
+    # @return Mods::Record
+    # @example
+    #   foo = Mods::Record.new.from_file('/path/to/file/bb340tm8592.mods')
+    def from_file(url, ns_aware = true)
+      @mods_ng_xml = Mods::Reader.new(ns_aware).from_file(url)
+      if ns_aware
+        set_terminology_ns(@mods_ng_xml)
+      else
+        set_terminology_no_ns(@mods_ng_xml)
+      end
+      return self
     end
 
     # convenience method to call Mods::Reader.new.from_nk_node and to nom
@@ -56,11 +78,11 @@ module Mods
         set_terminology_no_ns(@mods_ng_xml)
       end
     end
-    
-    # get the value for the terms, as a String. f there are multiple values, they will be joined with the separator. 
+
+    # get the value for the terms, as a String. f there are multiple values, they will be joined with the separator.
     #  If there are no values, the result will be nil.
     # @param [Symbol or String or Array<Symbol>] messages the single symbol of the message to send to the Stanford::Mods::Record object
-    #  (as a Symbol or a String), or an Array of (Symbols or Strings) to be sent as messages. 
+    #  (as a Symbol or a String), or an Array of (Symbols or Strings) to be sent as messages.
     #  Messages will usually be terms from the nom-xml terminology defined in the mods gem.)
     # @param [String] sep - the separator string to insert between multiple values
     # @return [String] a String representing the value(s) or nil.
@@ -72,7 +94,7 @@ module Mods
 
     # get the values for the terms, as an Array. If there are no values, the result will be nil.
     # @param [Symbol or String or Array<Symbol>] messages the single symbol of the message to send to the Stanford::Mods::Record object
-    #  (as a Symbol or a String), or an Array of (Symbols or Strings) to be sent as messages. 
+    #  (as a Symbol or a String), or an Array of (Symbols or Strings) to be sent as messages.
     #  Messages will usually be terms from the nom-xml terminology defined in the mods gem.)
     # @return [Array<String>] an Array with a String value for each result node's non-empty text, or nil if none
     def term_values messages
@@ -99,7 +121,7 @@ module Mods
 
       vals = []
       if nodes
-        nodes.each { |n| 
+        nodes.each { |n|
           vals << n.text unless n.text.empty?
         }
       end
@@ -108,7 +130,7 @@ module Mods
     rescue NoMethodError
       raise ArgumentError, "term_values called with unknown argument: #{messages.inspect}", caller
     end
-    
+
 
     # @return Array of Strings, each containing the text contents of <mods><titleInfo>   <nonSort> + ' ' + <title> elements
     #  but not including any titleInfo elements with type="alternative"
@@ -120,17 +142,17 @@ module Mods
     def full_titles
       @mods_ng_xml.title_info.full_title.map { |n| n }
     end
-        
+
     # @return Array of Strings, each containing the text contents of <mods><titleInfo @type="alternative"><title>  elements
     def alternative_titles
       @mods_ng_xml.title_info.alternative_title.map { |n| n }
     end
-    
+
     # @return String containing sortable title for this mods record
     def sort_title
       @mods_ng_xml.title_info.sort_title.find { |n| !n.nil? }
     end
-    
+
     # @return Array of Strings, each containing the computed display value of a personal name
     #   (see nom_terminology for algorithm)
     def personal_names
@@ -149,17 +171,17 @@ module Mods
     def corporate_names
       @mods_ng_xml.corporate_name.map { |n| n.display_value }
     end
-    
+
     # Translates iso-639 language codes, and leaves everything else alone.
     # @return Array of Strings, each a (hopefully English) name of a language
     def languages
       result = []
-      @mods_ng_xml.language.each { |n| 
+      @mods_ng_xml.language.each { |n|
         # get languageTerm codes and add their translations to the result
-        n.code_term.each { |ct| 
+        n.code_term.each { |ct|
           if ct.authority.match(/^iso639/)
             begin
-              vals = ct.text.split(/[,|\ ]/).reject {|x| x.strip.length == 0 } 
+              vals = ct.text.split(/[,|\ ]/).reject {|x| x.strip.length == 0 }
               vals.each do |v|
                 result << ISO_639.find(v.strip).english_name
               end
@@ -172,11 +194,11 @@ module Mods
           end
         }
         # add languageTerm text values
-        n.text_term.each { |tt| 
+        n.text_term.each { |tt|
           val = tt.text.strip
           result << val if val.length > 0
         }
-          
+
         # add language values that aren't in languageTerm subelement
         if n.languageTerm.size == 0
           result << n.text
@@ -192,7 +214,7 @@ module Mods
         super.method_missing(method_name, *args)
       end
     end
-    
+
   end # class Record
 
 end # module Mods

data/lib/mods/version.rb

@@ -1,4 +1,4 @@
 module Mods
   # this is the Ruby Gem version
-  VERSION = "0.0.23"
+  VERSION = "1.0.0"
 end

data/mods.gemspec

@@ -31,9 +31,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rdoc"
   gem.add_development_dependency "yard"
   # tests
-	gem.add_development_dependency 'rspec'
-	gem.add_development_dependency 'simplecov'
-	gem.add_development_dependency 'simplecov-rcov'
+	gem.add_development_dependency 'rspec', '~> 3.0'
+	# using coveralls with travis 
 	# gem.add_development_dependency 'ruby-debug19'
   gem.add_development_dependency 'equivalent-xml'
 end

data/spec/fixture_data/shpc1.mods.xml

@@ -0,0 +1,43 @@
+<!--
+Sample record from the Stanford Historical Photo Collection, house in the Stanford Digital Repository. 
+Also available at http://purl.stanford.edu/bb340tm8592.mods
+-->
+<mods xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.loc.gov/mods/v3" version="3.4" xsi:schemaLocation="http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-4.xsd">
+  <titleInfo>
+    <title>Arboretum, road with oaks</title>
+  </titleInfo>
+  <name type="corporate" authority="naf" authorityURI="http://id.loc.gov/authorities/names/no98095678">
+    <namePart>PAHA (Palo Alto Historical Association</namePart>
+    <role>
+      <roleTerm type="text">donor</roleTerm>
+    </role>
+  </name>
+  <physicalDescription>
+    <form>black and white photographic print</form>
+    <internetMediaType>image/tiff</internetMediaType>
+    <note displayLabel="Dimensions">11 in. x 7 in.</note>
+  </physicalDescription>
+  <typeOfResource>still image</typeOfResource>
+  <language>
+    <languageTerm type="code" authority="iso639-2b">en</languageTerm>
+  </language>
+  <genre authority="ftamc">Photoprints.</genre>
+  <subject>
+    <topic>Arboretum</topic>
+    <topic>Trees</topic>
+  </subject>
+  <location>
+    <physicalLocation type="repository">Stanford University. Libraries. Dept. of Special Collections &amp; University Archives.</physicalLocation>
+  </location>
+  <identifier type="local" displayLabel="University Archives Photo ID">94</identifier>
+  <identifier type="local" displayLabel="Luna Object ID">1613</identifier>
+  <note>"PAHA 8/13/57" written on back.</note>
+  <relatedItem type="host">
+    <titleInfo>
+      <title>Stanford historical photograph collection, 1887-circa 1996</title>
+    </titleInfo>
+    <identifier type="uri">http://purl.stanford.edu/kx532cb7981</identifier>
+    <typeOfResource collection="yes"/>
+  </relatedItem>
+  <accessCondition type="useAndReproduction">Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Special Collections Public Services Librarian at speccollref@stanford.edu.</accessCondition>
+</mods>

data/spec/origin_info_spec.rb

@@ -146,62 +146,62 @@ describe "Mods <originInfo> Element" do
        <issuance>monographic</issuance>
     </originInfo>
     </mods>"
-    
+
     xml = "<originInfo>
     <dateCreated encoding='w3cdtf' keyDate='yes' point='start' qualifier='approximate'>250 B.C.</dateCreated>
     <dateCreated encoding='w3cdtf' keyDate='yes' point='end' qualifier='approximate'>150 B.C.</dateCreated>
     </originInfo>"
-    
+
   end
 
   context "parsing date values" do
     it "should cope with slop" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
     it "should know something about various date encodings: w3cdtf, iso8601, marc, edtf, temper" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
     it "should know the only valid values for point attribute are 'start' and 'end'" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
     it "should know the only valid value for keyDate attribute is 'yes" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
     it "should know the only valid values for qualifier attribute: approximate, inferred, questionable" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
   end
-  
+
   context "parsing issuance" do
     it "should know the only valid values are: continuing, monographic, single unit, multipart monograph, serial, integrating resource" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
   end
-  
+
   context "parsing publisher" do
     it "should ignore s.n. value (from MARC)" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
     it "should leave square brackets alone, except for s.n." do
-      pending "to be implemented"
+      skip "to be implemented"
     end
   end
-  
+
   context "parsing placeTerm" do
     it "should be able to translate marccountry codes" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
     it "should ignore s.l. value (from MARC)" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
     it "should be forgiving of square brackets (from MARC), matched or unmatched" do
-      pending "to be implemented"
+      skip "to be implemented"
     end
   end
 
 
   context "basic <originInfo> terminology pieces" do
-    
+
     context "WITH namespaces" do
       context "<place> child element" do
         before(:all) do
@@ -430,4 +430,4 @@ describe "Mods <originInfo> Element" do
 
   end # basic terminology
 
-end
+end