datacite-mapping 0.1.0

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

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+module Datacite
+  module Mapping
+    describe ResourceType do
+      describe '#initialize' do
+        it 'sets the value' do
+          rt = ResourceType.new(resource_type_general: ResourceTypeGeneral::DATASET, value: 'some data')
+          expect(rt.value).to eq('some data')
+        end
+        it 'sets the general resource type' do
+          rt = ResourceType.new(resource_type_general: ResourceTypeGeneral::DATASET, value: 'some data')
+          expect(rt.resource_type_general).to eq(ResourceTypeGeneral::DATASET)
+        end
+        it 'allows a nil value' do
+          rt = ResourceType.new(resource_type_general: ResourceTypeGeneral::DATASET)
+          expect(rt.value).to be_nil
+        end
+        it 'requires a general resource type' do
+          expect { ResourceType.new(value: 'some data') }.to raise_error(ArgumentError)
+        end
+      end
+
+      describe 'resourceTypeGeneral=' do
+        it 'sets the general resource type' do
+          rt = ResourceType.allocate
+          rt.resource_type_general = ResourceTypeGeneral::DATASET
+          expect(rt.resource_type_general).to eq(ResourceTypeGeneral::DATASET)
+        end
+        it 'requires a general resource type' do
+          rt = ResourceType.new(resource_type_general: ResourceTypeGeneral::DATASET, value: 'some data')
+          expect { rt.resource_type_general = nil }.to raise_error(ArgumentError)
+          expect(rt.resource_type_general).to eq(ResourceTypeGeneral::DATASET)
+        end
+      end
+
+      describe 'value' do
+        it 'sets the value' do
+          rt = ResourceType.allocate
+          rt.value = 'some data'
+          expect(rt.value).to eq('some data')
+        end
+        it 'allows a nil value' do
+          rt = ResourceType.new(resource_type_general: ResourceTypeGeneral::DATASET, value: 'some data')
+          rt.value = nil
+          expect(rt.value).to be_nil
+        end
+      end
+
+      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)
+          expect(rt.resource_type_general).to eq(ResourceTypeGeneral::SOFTWARE)
+          expect(rt.value).to eq('XML')
+        end
+      end
+
+      describe '#save_to_xml' do
+        it 'writes XML' do
+          rt = ResourceType.new(resource_type_general: ResourceTypeGeneral::DATASET, value: 'some data')
+          expected_xml = '<resourceType resourceTypeGeneral="Dataset">some data</resourceType>'
+          expect(rt.save_to_xml).to be_xml(expected_xml)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+module Datacite
+  module Mapping
+    describe Rights do
+      describe '#initialize' do
+        it 'sets the value' do
+          rights = Rights.new(value: 'CC0 1.0 Universal')
+          expect(rights.value).to eq('CC0 1.0 Universal')
+        end
+        it 'sets the URI' do
+          rights = Rights.new(value: 'CC0 1.0 Universal', uri: URI('http://creativecommons.org/publicdomain/zero/1.0/'))
+          expect(rights.uri).to eq(URI('http://creativecommons.org/publicdomain/zero/1.0/'))
+        end
+        it 'requires a value' do
+          expect { Rights.new(uri: URI('http://creativecommons.org/publicdomain/zero/1.0/')) }.to raise_error(ArgumentError)
+        end
+      end
+
+      describe '#value=' do
+        it 'sets the value' do
+          rights = Rights.allocate
+          rights.value = 'CC0 1.0 Universal'
+          expect(rights.value).to eq('CC0 1.0 Universal')
+        end
+        it 'requires a value' do
+          rights = Rights.new(value: 'CC0 1.0 Universal')
+          expect { rights.value = nil }.to raise_error(ArgumentError)
+          expect(rights.value).to eq('CC0 1.0 Universal')
+        end
+        it 'requires a non-empty value' do
+          rights = Rights.new(value: 'CC0 1.0 Universal')
+          expect { rights.value = '' }.to raise_error(ArgumentError)
+          expect(rights.value).to eq('CC0 1.0 Universal')
+        end
+      end
+
+      describe '#uri=' do
+        it 'sets the URI' do
+          rights = Rights.allocate
+          rights.uri = URI('http://creativecommons.org/publicdomain/zero/1.0/')
+          expect(rights.uri).to eq(URI('http://creativecommons.org/publicdomain/zero/1.0/'))
+        end
+        it 'allows a nil URI' do
+          rights = Rights.new(value: 'CC0 1.0 Universal', uri: URI('http://creativecommons.org/publicdomain/zero/1.0/'))
+          rights.uri = nil
+          expect(rights.uri).to be_nil
+        end
+      end
+
+      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)
+          expect(rights.value).to eq('CC0 1.0 Universal')
+          expect(rights.uri).to eq(URI('http://creativecommons.org/publicdomain/zero/1.0/'))
+        end
+        it 'trims the value' do
+          xml_text = '<rights>
+                        CC0 1.0 Universal
+                      </rights>'
+          xml = REXML::Document.new(xml_text).root
+          rights = Rights.load_from_xml(xml)
+          expect(rights.value).to eq('CC0 1.0 Universal')
+        end
+      end
+
+      describe '#save_to_xml' do
+        it 'writes XML' do
+          rights = Rights.new(value: 'CC0 1.0 Universal', uri: URI('http://creativecommons.org/publicdomain/zero/1.0/'))
+          expected_xml = '<rights rightsURI="http://creativecommons.org/publicdomain/zero/1.0/">CC0 1.0 Universal</rights>'
+          expect(rights.save_to_xml).to be_xml(expected_xml)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+module Datacite
+  module Mapping
+    describe Subject do
+      describe '#initialize' do
+        it 'sets the value' do
+          value = 'Mammals--Embryology'
+          subject = Subject.new(value: value, language: 'en-us')
+          expect(subject.value).to eq(value)
+        end
+
+        it 'sets the language' do
+          lang = 'en-us'
+          subject = Subject.new(value: 'Mammals--Embryology', language: lang)
+          expect(subject.language).to eq(lang)
+        end
+
+        it 'sets the scheme' do
+          scheme = 'LCSH'
+          subject = Subject.new(value: 'Mammals--Embryology', language: 'en-us', scheme: scheme)
+          expect(subject.scheme).to eq(scheme)
+        end
+
+        it 'sets the schemeURI' do
+          scheme_uri = URI('http://id.loc.gov/authorities/subjects')
+          subject = Subject.new(value: 'Mammals--Embryology', language: 'en-us', scheme: 'LCSH', scheme_uri: scheme_uri)
+          expect(subject.scheme_uri).to eq(scheme_uri)
+        end
+
+        it 'defaults to a nil scheme' do
+          subject = Subject.new(value: 'Mammals--Embryology', language: 'en-us')
+          expect(subject.scheme).to be_nil
+        end
+
+        it 'defaults to a nil schemeURI' do
+          subject = Subject.new(value: 'Mammals--Embryology', language: 'en-us')
+          expect(subject.scheme_uri).to be_nil
+        end
+
+        it 'defaults language to "en"' do
+          subject = Subject.new(value: 'Mammals--Embryology')
+          expect(subject.language).to eq('en')
+        end
+
+      end
+
+      describe 'lang=' do
+        it 'sets the language' do
+          subject = Subject.new(value: 'Mammals--Embryology', language: 'en')
+          new_lang = 'en-us'
+          subject.language = new_lang
+          expect(subject.language).to eq(new_lang)
+        end
+
+        it 'ignores nil' do
+          subject = Subject.new(value: 'Mammals--Embryology', language: 'en-us')
+          subject.language = nil
+          expect(subject.language).to eq('en-us')
+        end
+      end
+
+      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)
+
+          value = 'Mammals--Embryology'
+          lang = 'en-us'
+          scheme = 'LCSH'
+          scheme_uri = URI('http://id.loc.gov/authorities/subjects')
+
+          expect(subject.value).to eq(value)
+          expect(subject.language).to eq(lang)
+          expect(subject.scheme).to eq(scheme)
+          expect(subject.scheme_uri).to eq(scheme_uri)
+        end
+
+        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)
+          expect(subject.language).to eq('en')
+        end
+      end
+
+      describe '#save_to_xml' do
+        it 'writes XML' do
+          value = 'Mammals--Embryology'
+          lang = 'en-us'
+          scheme = 'LCSH'
+          scheme_uri = URI('http://id.loc.gov/authorities/subjects')
+
+          subject = Subject.new(
+            language: lang,
+            scheme: scheme,
+            scheme_uri: scheme_uri,
+            value: value
+          )
+
+          expected_xml = '<subject xml:lang="en-us" schemeURI="http://id.loc.gov/authorities/subjects" subjectScheme="LCSH">Mammals--Embryology</subject>'
+          expect(subject.save_to_xml).to be_xml(expected_xml)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+module Datacite
+  module Mapping
+    describe Title do
+      describe '#initialize' do
+        it 'sets the value' do
+          value = 'An Account of a Very Odd Monstrous Calf'
+          title = Title.new(value: value, language: 'en-emodeng')
+          expect(title.value).to eq(value)
+        end
+
+        it 'sets the language' do
+          lang = 'en-emodeng'
+          title = Title.new(language: lang, value: 'Observables upon a Monstrous Head')
+          expect(title.language).to eq(lang)
+        end
+
+        it 'defaults language to "en"' do
+          title = Title.new(value: 'A Relation of an Accident by Thunder and Lightning, at Oxford')
+          expect(title.language).to eq('en')
+        end
+
+        it 'sets the type' do
+          type = TitleType::SUBTITLE
+          title = Title.new(type: type, value: 'And a Contest between Two Artists about Optick Glasses, &c', language: 'en-emodeng')
+          expect(title.type).to eq(type)
+        end
+
+        it 'defaults to a nil type' do
+          title = Title.new(value: "Of Some Books Lately Publish't", language: 'en-emodeng')
+          expect(title.type).to be_nil
+        end
+      end
+
+      describe 'value=' do
+        it 'sets the value' do
+          title = Title.allocate
+          title.value = "Of Some Books Lately Publish't"
+          expect(title.value).to eq("Of Some Books Lately Publish't")
+        end
+        it 'requires a value' do
+          title = Title.new(value: "Of Some Books Lately Publish't", language: 'en-emodeng')
+          expect { title.value = nil }.to raise_error(ArgumentError)
+          expect(title.value).to eq("Of Some Books Lately Publish't")
+        end
+        it 'requires a non-empty value' do
+          title = Title.new(value: "Of Some Books Lately Publish't", language: 'en-emodeng')
+          expect { title.value = '' }.to raise_error(ArgumentError)
+          expect(title.value).to eq("Of Some Books Lately Publish't")
+        end
+      end
+
+      describe 'lang=' do
+        it 'sets the language' do
+          title = Title.new(value: "Of Some Books Lately Publish't", language: 'en-emodeng')
+          new_lang = 'en-gb'
+          title.language = new_lang
+          expect(title.language).to eq(new_lang)
+        end
+        it 'ignores nil' do
+          title = Title.new(value: "Of Some Books Lately Publish't", language: 'en-emodeng')
+          title.language = nil
+          expect(title.language).to eq('en-emodeng')
+        end
+      end
+
+      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)
+
+          expected_lang = 'en-emodeng'
+          expected_type = TitleType::SUBTITLE
+          expected_value = 'Together with an Appendix of the Same, Containing an Answer to Some Objections, Made by Severall Persons against That Hypothesis'
+
+          expect(title.language).to eq(expected_lang)
+          expect(title.type).to eq(expected_type)
+          expect(title.value).to eq(expected_value)
+        end
+
+        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)
+          expect(title.language).to eq('en')
+        end
+
+        it 'trims the value' 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)
+          expect(title.value).to eq('Physical oceanography from BT during cruise U99XX00542B_1979')
+        end
+      end
+
+      describe '#save_to_xml' do
+        it 'writes XML' do
+          title = Title.new(
+            language: 'en-emodeng',
+            type: TitleType::SUBTITLE,
+            value: 'Together with an Appendix of the Same, Containing an Answer to Some Objections, Made by Severall Persons against That Hypothesis'
+          )
+          expected_xml = '<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>'
+          expect(title.save_to_xml).to be_xml(expected_xml)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,262 @@
+--- !ruby/object:Gem::Specification
+name: datacite-mapping
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Moles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typesafe_enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: xml-mapping_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A gem for working with the Datacite XML format
+email:
+- david.moles@ucop.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- CHANGES.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- datacite-mapping.gemspec
+- examples/reading.rb
+- examples/writing.rb
+- lib/datacite/mapping.rb
+- lib/datacite/mapping/alternate_identifier.rb
+- lib/datacite/mapping/contributor.rb
+- lib/datacite/mapping/creator.rb
+- lib/datacite/mapping/date.rb
+- lib/datacite/mapping/description.rb
+- lib/datacite/mapping/geo_location.rb
+- lib/datacite/mapping/geo_location_box.rb
+- lib/datacite/mapping/geo_location_point.rb
+- lib/datacite/mapping/identifier.rb
+- lib/datacite/mapping/module_info.rb
+- lib/datacite/mapping/name_identifier.rb
+- lib/datacite/mapping/related_identifier.rb
+- lib/datacite/mapping/resource.rb
+- lib/datacite/mapping/resource_type.rb
+- lib/datacite/mapping/rights.rb
+- lib/datacite/mapping/subject.rb
+- lib/datacite/mapping/title.rb
+- spec/.rubocop.yml
+- spec/data/resource.xml
+- spec/rspec_custom_matchers.rb
+- spec/spec_helper.rb
+- spec/unit/datacite/mapping/alternate_identifier_spec.rb
+- spec/unit/datacite/mapping/contributor_spec.rb
+- spec/unit/datacite/mapping/creator_spec.rb
+- spec/unit/datacite/mapping/date_spec.rb
+- spec/unit/datacite/mapping/description_spec.rb
+- spec/unit/datacite/mapping/geo_location_box_spec.rb
+- spec/unit/datacite/mapping/geo_location_point_spec.rb
+- spec/unit/datacite/mapping/geo_location_spec.rb
+- spec/unit/datacite/mapping/identifier_spec.rb
+- spec/unit/datacite/mapping/name_identifier_spec.rb
+- spec/unit/datacite/mapping/related_identifier_spec.rb
+- spec/unit/datacite/mapping/resource_spec.rb
+- spec/unit/datacite/mapping/resource_type_spec.rb
+- spec/unit/datacite/mapping/rights_spec.rb
+- spec/unit/datacite/mapping/subject_spec.rb
+- spec/unit/datacite/mapping/title_spec.rb
+homepage: http://github.com/CDLUC3/datacite-mapping
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Parses and generates Datacite XML documents
+test_files:
+- spec/.rubocop.yml
+- spec/data/resource.xml
+- spec/rspec_custom_matchers.rb
+- spec/spec_helper.rb
+- spec/unit/datacite/mapping/alternate_identifier_spec.rb
+- spec/unit/datacite/mapping/contributor_spec.rb
+- spec/unit/datacite/mapping/creator_spec.rb
+- spec/unit/datacite/mapping/date_spec.rb
+- spec/unit/datacite/mapping/description_spec.rb
+- spec/unit/datacite/mapping/geo_location_box_spec.rb
+- spec/unit/datacite/mapping/geo_location_point_spec.rb
+- spec/unit/datacite/mapping/geo_location_spec.rb
+- spec/unit/datacite/mapping/identifier_spec.rb
+- spec/unit/datacite/mapping/name_identifier_spec.rb
+- spec/unit/datacite/mapping/related_identifier_spec.rb
+- spec/unit/datacite/mapping/resource_spec.rb
+- spec/unit/datacite/mapping/resource_type_spec.rb
+- spec/unit/datacite/mapping/rights_spec.rb
+- spec/unit/datacite/mapping/subject_spec.rb
+- spec/unit/datacite/mapping/title_spec.rb
+has_rdoc: