datacite-mapping 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdca4b9e61f6a7f61405cbfde5488540ba71afed
-  data.tar.gz: fd61a9ad1a4993765d6cb5eec62dd5767d2efe72
+  metadata.gz: 57920b6deb33af54ffc30bbce3cf2943f069b74d
+  data.tar.gz: 7864e0a91b9034cbb949df41b374c7700294c37d
 SHA512:
-  metadata.gz: ab8a01cf469aae1ce0cdc3b846bf0d17e30a481d567cdd084cf170af38d337c155a9d16574d972ea31e87e63d6b2b6795b0d79aba1f77847859dbf1980c10b15
-  data.tar.gz: 753a1634b39d52e98fe2c04983da1e5fc7a622c7f47048af740faba7e58c0a54f3912f0b52dd1864a52c6bbf955d61b17c87201f979115e70f032aec4d91ef0b
+  metadata.gz: bfc67fba2953a659de6c9d6068fa242896fb3c35c32b140db9a56aeadc89ee6e13d218c76aac1636dcf4c1edaad09e006eecfcb4892a8b14a53d5e1320aeee18
+  data.tar.gz: 0a42d5ac00ed8af6307a5fc4dc97def2dd5ec086fe3cd1bd22a2797abb586c94188bbd34cd59ee4f45ef94c61362397bf05bb243a2cc4b1d14cd66b1b8f3e51f

data/.gitignore

@@ -15,9 +15,9 @@
 *.a
 mkmf.log
 
-# Database
+# Gem
 
-db/*.sqlite3
+datacite*gem
 
 # Logs
 

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 0.1.1 (14 Dec 2015)
+
+- Update to [XML::MappingExtensions](https://github.com/dmolesUC3/xml-mapping_extensions) 0.3.2, allowing
+  use of [#parse_xml](http://www.rubydoc.info/github/dmolesUC3/xml-mapping_extensions/master/XML/Mapping/ClassMethods#parse_xml-instance_method)
+  and [#write_xml](http://www.rubydoc.info/github/dmolesUC3/xml-mapping_extensions/master/XML/Mapping#write_xml-instance_method)
+  in examples and tests
+
 ## 0.1.0 (10 Dec 2015)
 
-- Initial release.
+- Initial release

data/README.md

@@ -15,23 +15,25 @@ require 'datacite/mapping'
 
 include Datacite::Mapping
 
-xml_text = File.read('resource.xml')
-resource = Resource.load_from_xml(xml.root)
-creators = resource.creators
-citation = ''
-citation << creators.map(&:name).join('; ')
-citation << ' '
-citation << "(#{resource.publication_year})"
-citation << ': '
-title = resource.titles[0].value
-citation << title
-citation << (title.end_with?('.') ? ' ' : '. ')
-citation << resource.publisher
-
-puts("Citation: #{citation}")
-
-abstract = resource.descriptions.find { |d| d.type = DescriptionType::ABSTRACT }
-puts("Abstract: #{abstract.value}")
+File.open('resource.xml', 'r') do |xml_file|
+  resource = Resource.parse_xml(xml_file)
+
+  creators = resource.creators
+  citation = ''
+  citation << creators.map(&:name).join('; ')
+  citation << ' '
+  citation << "(#{resource.publication_year})"
+  citation << ': '
+  title = resource.titles[0].value
+  citation << title
+  citation << (title.end_with?('.') ? ' ' : '. ')
+  citation << resource.publisher
+
+  puts("Citation: #{citation}")
+
+  abstract = resource.descriptions.find { |d| d.type = DescriptionType::ABSTRACT }
+  puts("Abstract: #{abstract.value}")
+end
 ```
 
 Results:
@@ -110,10 +112,7 @@ resource = Resource.new(
   ]
 )
 
-xml = resource.save_to_xml
-formatter = REXML::Formatters::Pretty.new
-formatter.compact = true
-formatter.write(xml, $stdout)
+puts resource.write_xml
 ```
 
 Results:

data/datacite-mapping.gemspec

@@ -2,7 +2,7 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'URI'
+require 'uri'
 require 'datacite/mapping/module_info'
 
 Gem::Specification.new do |spec|
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'typesafe_enum', '~> 0.1', '>= 0.1.2'
-  spec.add_dependency 'xml-mapping_extensions', '~> 0.3'
+  spec.add_dependency 'xml-mapping_extensions', '~> 0.3', '>= 0.3.2'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'equivalent-xml', '~> 0.6.0'

data/examples/reading.rb

@@ -55,8 +55,7 @@ xml_text = '<?xml version="1.0" encoding="UTF-8"?>
               </geoLocations>
             </resource>'
 
-xml = REXML::Document.new(xml_text)
-resource = Resource.load_from_xml(xml.root)
+resource = Resource.parse_xml(xml_text)
 
 creators = resource.creators
 citation = ''

data/examples/writing.rb

@@ -43,7 +43,4 @@ resource = Resource.new(
   ]
 )
 
-xml = resource.save_to_xml
-formatter = REXML::Formatters::Pretty.new
-formatter.compact = true
-formatter.write(xml, $stdout)
+puts resource.write_xml

data/lib/datacite/mapping/module_info.rb

@@ -4,7 +4,7 @@ module Datacite
     NAME = 'datacite-mapping'
 
     # The version of this gem
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
 
     # The copyright notice for this gem
     COPYRIGHT = 'Copyright (c) 2015 The Regents of the University of California'

data/spec/unit/datacite/mapping/alternate_identifier_spec.rb

@@ -41,8 +41,7 @@ module Datacite
       describe '#load_from_xml' do
         it 'parses XML' do
           xml_text = '<alternateIdentifier alternateIdentifierType="URL">http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml</alternateIdentifier>'
-          xml = REXML::Document.new(xml_text).root
-          id = AlternateIdentifier.load_from_xml(xml)
+          id = AlternateIdentifier.parse_xml(xml_text)
           expect(id.type).to eq('URL')
           expect(id.value).to eq('http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml')
         end

data/spec/unit/datacite/mapping/contributor_spec.rb

@@ -88,8 +88,7 @@ module Datacite
                         <affiliation>Gaumont Buena Vista International</affiliation>
                         <affiliation>20th Century Fox</affiliation>
                       </contributor>'
-          xml = REXML::Document.new(xml_text).root
-          contributor = Contributor.load_from_xml(xml)
+          contributor = Contributor.parse_xml(xml_text)
           expect(contributor.name).to eq('Hershlag, Natalie')
           expect(contributor.affiliations).to eq(['Gaumont Buena Vista International', '20th Century Fox'])
           id = contributor.identifier
@@ -105,8 +104,7 @@ module Datacite
                         <contributorName>Hedy Lamarr</contributorName>
                         <nameIdentifier schemeURI="http://isni.org/" nameIdentifierScheme="ISNI">0000-0001-1690-159X</nameIdentifier>
                       </contributor>'
-          xml = REXML::Document.new(xml_text).root
-          contributor = Contributor.load_from_xml(xml)
+          contributor = Contributor.parse_xml(xml_text)
           expect(contributor.affiliations).to eq([])
         end
       end

data/spec/unit/datacite/mapping/creator_spec.rb

@@ -86,8 +86,7 @@ module Datacite
                         <affiliation>United Artists</affiliation>
                         <affiliation>Metro-Goldwyn-Mayer</affiliation>
                       </creator>'
-          xml = REXML::Document.new(xml_text).root
-          creator = Creator.load_from_xml(xml)
+          creator = Creator.parse_xml(xml_text)
           expect(creator.name).to eq('Hedy Lamarr')
           expect(creator.affiliations).to eq(['United Artists', 'Metro-Goldwyn-Mayer'])
           id = creator.identifier
@@ -101,8 +100,7 @@ module Datacite
                         <creatorName>Hedy Lamarr</creatorName>
                         <nameIdentifier schemeURI="http://isni.org/" nameIdentifierScheme="ISNI">0000-0001-1690-159X</nameIdentifier>
                       </creator>'
-          xml = REXML::Document.new(xml_text).root
-          creator = Creator.load_from_xml(xml)
+          creator = Creator.parse_xml(xml_text)
           expect(creator.affiliations).to eq([])
         end
       end

data/spec/unit/datacite/mapping/description_spec.rb

@@ -8,8 +8,7 @@ module Datacite
           xml_text = '<description xml:lang="en-us" descriptionType="Abstract">
                         XML example of all DataCite Metadata Schema v3.1 properties.
                       </description>'
-          xml = REXML::Document.new(xml_text).root
-          desc = Description.load_from_xml(xml)
+          desc = Description.parse_xml(xml_text)
 
           expected_lang = 'en-us'
           expected_type = DescriptionType::ABSTRACT
@@ -24,8 +23,7 @@ module Datacite
           xml_text = '<description xml:lang="en-us" descriptionType="Abstract">
                         &lt;p&gt;This is HTML text&lt;/p&gt;&lt;p&gt;&lt;small&gt;despite the advice in the standard&lt;/small&gt;&lt;/p&gt;
                       </description>'
-          xml = REXML::Document.new(xml_text).root
-          desc = Description.load_from_xml(xml)
+          desc = Description.parse_xml(xml_text)
 
           expected_value = '<p>This is HTML text</p><p><small>despite the advice in the standard</small></p>'
           expect(desc.value).to eq(expected_value)
@@ -35,8 +33,7 @@ module Datacite
           xml_text = '<description xml:lang="en-us" descriptionType="Abstract">
                         This is the value
                       </description>'
-          xml = REXML::Document.new(xml_text).root
-          desc = Description.load_from_xml(xml)
+          desc = Description.parse_xml(xml_text)
           expect(desc.value).to eq('This is the value')
         end
 
@@ -44,8 +41,7 @@ module Datacite
           xml_text = '<description descriptionType="Abstract">
                         I am an <br></br> abstract <br/> full <br/> of &lt;br/&gt;s
                       </description>'
-          xml = REXML::Document.new(xml_text).root
-          desc = Description.load_from_xml(xml)
+          desc = Description.parse_xml(xml_text)
           expected_value = 'I am an <br/> abstract <br/> full <br/> of <br/>s'
           expect(desc.value.strip).to eq(expected_value)
         end
@@ -71,15 +67,13 @@ module Datacite
 
       it 'round-trips to XML' do
         xml_text = '<description xml:lang="en-us" descriptionType="Abstract">foo</description>'
-        xml = REXML::Document.new(xml_text).root
-        desc = Description.load_from_xml(xml)
+        desc = Description.parse_xml(xml_text)
         expect(desc.save_to_xml).to be_xml(xml_text)
       end
 
       it 'un-escapes <br/> tags when round-tripping' do
         xml_text = '<description xml:lang="en-us" descriptionType="Abstract"><br/> &lt;br/&gt; abstract <br></br> full <br /> of <br> </br>s</description>'
-        xml = REXML::Document.new(xml_text).root
-        desc = Description.load_from_xml(xml)
+        desc = Description.parse_xml(xml_text)
         expected_xml = '<description xml:lang="en-us" descriptionType="Abstract"><br/> <br/> abstract <br></br> full <br /> of <br> </br>s</description>'
         expect(desc.save_to_xml).to be_xml(expected_xml)
 

data/spec/unit/datacite/mapping/geo_location_spec.rb

@@ -77,8 +77,7 @@ module Datacite
                         <geoLocationBox>41.090 -71.032 42.893 -68.211</geoLocationBox>
                         <geoLocationPlace>Atlantic Ocean</geoLocationPlace>
                       </geoLocation>'
-          xml = REXML::Document.new(xml_text).root
-          loc = GeoLocation.load_from_xml(xml)
+          loc = GeoLocation.parse_xml(xml_text)
           expect(loc.point).to eq(GeoLocationPoint.new(31.233, -67.302))
           expect(loc.box).to eq(GeoLocationBox.new(41.09, -71.032, 42.893, -68.211))
           expect(loc.place).to eq('Atlantic Ocean')
@@ -90,8 +89,7 @@ module Datacite
                           Atlantic Ocean
                         </geoLocationPlace>
                       </geoLocation>'
-          xml = REXML::Document.new(xml_text).root
-          loc = GeoLocation.load_from_xml(xml)
+          loc = GeoLocation.parse_xml(xml_text)
           expect(loc.place).to eq('Atlantic Ocean')
         end
       end

data/spec/unit/datacite/mapping/identifier_spec.rb

@@ -55,8 +55,7 @@ module Datacite
       describe '#load_from_xml' do
         it 'parses XML' do
           xml_text = "<identifier identifierType='DOI'>10.14749/1407399498</identifier>"
-          xml = REXML::Document.new(xml_text).root
-          id = Identifier.load_from_xml(xml)
+          id = Identifier.parse_xml(xml_text)
           expect(id.identifier_type).to eq('DOI')
           expect(id.value).to eq('10.14749/1407399498')
         end

data/spec/unit/datacite/mapping/name_identifier_spec.rb

@@ -69,8 +69,7 @@ module Datacite
       describe '#load_from_xml' do
         it 'parses XML' do
           xml_text = '<nameIdentifier schemeURI="http://orcid.org/" nameIdentifierScheme="ORCID">0000-0003-1632-8708</nameIdentifier>'
-          xml = REXML::Document.new(xml_text).root
-          id = NameIdentifier.load_from_xml(xml)
+          id = NameIdentifier.parse_xml(xml_text)
           expect(id.scheme).to eq('ORCID')
           expect(id.scheme_uri).to eq(URI('http://orcid.org/'))
           expect(id.value).to eq('0000-0003-1632-8708')

data/spec/unit/datacite/mapping/related_identifier_spec.rb

@@ -120,8 +120,7 @@ module Datacite
       describe '#load_from_xml' do
         it 'parses XML' do
           xml_text = '<relatedIdentifier relatedIdentifierType="URL" relationType="HasMetadata" relatedMetadataScheme="citeproc+json" schemeType="Turtle" schemeURI="https://github.com/citation-style-language/schema/raw/master/csl-data.json">http://data.datacite.org/application/citeproc+json/10.5072/example-full</relatedIdentifier>'
-          xml = REXML::Document.new(xml_text).root
-          id = RelatedIdentifier.load_from_xml(xml)
+          id = RelatedIdentifier.parse_xml(xml_text)
 
           expected_id_type = RelatedIdentifierType::URL
           expected_rel_type = RelationType::HAS_METADATA

data/spec/unit/datacite/mapping/resource_spec.rb

@@ -717,8 +717,7 @@ module Datacite
 
         it 'round-trips' do
           xml_text = File.read('spec/data/resource.xml')
-          xml = REXML::Document.new(xml_text).root
-          resource = Resource.load_from_xml(xml)
+          resource = Resource.parse_xml(xml_text)
           expect(resource.save_to_xml).to be_xml(xml_text)
         end
       end

data/spec/unit/datacite/mapping/resource_type_spec.rb

@@ -50,8 +50,7 @@ module Datacite
       describe '#load_from_xml' do
         it 'parses XML' do
           xml_text = '<resourceType resourceTypeGeneral="Software">XML</resourceType>'
-          xml = REXML::Document.new(xml_text).root
-          rt = ResourceType.load_from_xml(xml)
+          rt = ResourceType.parse_xml(xml_text)
           expect(rt.resource_type_general).to eq(ResourceTypeGeneral::SOFTWARE)
           expect(rt.value).to eq('XML')
         end

data/spec/unit/datacite/mapping/rights_spec.rb

@@ -51,8 +51,7 @@ module Datacite
       describe '#load_from_xml' do
         it 'reads XML' do
           xml_text = '<rights rightsURI="http://creativecommons.org/publicdomain/zero/1.0/">CC0 1.0 Universal</rights>'
-          xml = REXML::Document.new(xml_text).root
-          rights = Rights.load_from_xml(xml)
+          rights = Rights.parse_xml(xml_text)
           expect(rights.value).to eq('CC0 1.0 Universal')
           expect(rights.uri).to eq(URI('http://creativecommons.org/publicdomain/zero/1.0/'))
         end
@@ -60,8 +59,7 @@ module Datacite
           xml_text = '<rights>
                         CC0 1.0 Universal
                       </rights>'
-          xml = REXML::Document.new(xml_text).root
-          rights = Rights.load_from_xml(xml)
+          rights = Rights.parse_xml(xml_text)
           expect(rights.value).to eq('CC0 1.0 Universal')
         end
       end

data/spec/unit/datacite/mapping/subject_spec.rb

@@ -63,8 +63,7 @@ module Datacite
       describe '#load_from_xml' do
         it 'parses XML' do
           xml_text = '<subject xml:lang="en-us" schemeURI="http://id.loc.gov/authorities/subjects" subjectScheme="LCSH">Mammals--Embryology</subject>'
-          xml = REXML::Document.new(xml_text).root
-          subject = Subject.load_from_xml(xml)
+          subject = Subject.parse_xml(xml_text)
 
           value = 'Mammals--Embryology'
           lang = 'en-us'
@@ -79,8 +78,7 @@ module Datacite
 
         it 'treats missing language as en' do
           xml_text = '<subject schemeURI="http://id.loc.gov/authorities/subjects" subjectScheme="LCSH">Mammals--Embryology</subject>'
-          xml = REXML::Document.new(xml_text).root
-          subject = Subject.load_from_xml(xml)
+          subject = Subject.parse_xml(xml_text)
           expect(subject.language).to eq('en')
         end
       end

data/spec/unit/datacite/mapping/title_spec.rb

@@ -68,8 +68,7 @@ module Datacite
       describe '#load_from_xml' do
         it 'parses XML' do
           xml_text = '<title xml:lang="en-emodeng" titleType="Subtitle">Together with an Appendix of the Same, Containing an Answer to Some Objections, Made by Severall Persons against That Hypothesis</title>'
-          xml = REXML::Document.new(xml_text).root
-          title = Title.load_from_xml(xml)
+          title = Title.parse_xml(xml_text)
 
           expected_lang = 'en-emodeng'
           expected_type = TitleType::SUBTITLE
@@ -82,8 +81,7 @@ module Datacite
 
         it 'treats missing language as en' do
           xml_text = '<title>Physical oceanography from BT during cruise U99XX00542B_1979</title>'
-          xml = REXML::Document.new(xml_text).root
-          title = Title.load_from_xml(xml)
+          title = Title.parse_xml(xml_text)
           expect(title.language).to eq('en')
         end
 
@@ -91,8 +89,7 @@ module Datacite
           xml_text = '<title>
                          Physical oceanography from BT during cruise U99XX00542B_1979
                       </title>'
-          xml = REXML::Document.new(xml_text).root
-          title = Title.load_from_xml(xml)
+          title = Title.parse_xml(xml_text)
           expect(title.value).to eq('Physical oceanography from BT during cruise U99XX00542B_1979')
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datacite-mapping
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2015-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typesafe_enum
@@ -37,6 +37,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,6 +47,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement