datacite-mapping 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdca4b9e61f6a7f61405cbfde5488540ba71afed
+  data.tar.gz: fd61a9ad1a4993765d6cb5eec62dd5767d2efe72
+SHA512:
+  metadata.gz: ab8a01cf469aae1ce0cdc3b846bf0d17e30a481d567cdd084cf170af38d337c155a9d16574d972ea31e87e63d6b2b6795b0d79aba1f77847859dbf1980c10b15
+  data.tar.gz: 753a1634b39d52e98fe2c04983da1e5fc7a622c7f47048af740faba7e58c0a54f3912f0b52dd1864a52c6bbf955d61b17c87201f979115e70f032aec4d91ef0b

data/.gitignore

@@ -0,0 +1,42 @@
+# Ruby defaults
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# Database
+
+db/*.sqlite3
+
+# Logs
+
+/log/
+
+# IntellJ
+
+*.iml
+*.ipr
+*.iws
+*.ids
+.rakeTasks
+
+# Emacs
+
+*~
+\#*
+.#*
+
+# Mac OS
+
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,28 @@
+# Disable compact style check for example.rb
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'example.rb'
+
+# Disable line-length check; it's too easy for the cure to be worse than the disease
+Metrics/LineLength:
+  Enabled: False
+
+# Disable problematic module documentation check (see https://github.com/bbatsov/rubocop/issues/947)
+Style/Documentation:
+  Enabled: false
+
+# Allow one line around class body (Style/EmptyLines will still disallow two or more)
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Allow one line around module body (Style/EmptyLines will still disallow two or more)
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# Allow one line around block body (Style/EmptyLines will still disallow two or more)
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# Allow leading underscores for 'internal' accessors
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,2 @@
+language: ruby
+

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--default-return ''

data/CHANGES.md

@@ -0,0 +1,3 @@
+## 0.1.0 (10 Dec 2015)
+
+- Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 The Regents of the University of California
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,168 @@
+# datacite-mapping
+
+[![Build Status](https://travis-ci.org/CDLUC3/datacite-mapping.png?branch=master)](https://travis-ci.org/CDLUC3/datacite-mapping)
+[![Code Climate](https://codeclimate.com/github/CDLUC3/datacite-mapping.png)](https://codeclimate.com/github/CDLUC3/datacite-mapping)
+[![Inline docs](http://inch-ci.org/github/CDLUC3/datacite-mapping.png)](http://inch-ci.org/github/CDLUC3/datacite-mapping)
+[![Gem Version](https://img.shields.io/gem/v/datacite-mapping.svg)](https://github.com/CDLUC3/datacite-mapping/releases)
+
+A library for mapping [DataCite XML](http://schema.datacite.org/meta/kernel-3/) to Ruby objects.
+Full API documentation on [RubyDoc.info](http://www.rubydoc.info/github/CDLUC3/datacite-mapping/master/frames).
+
+## Reading
+
+```ruby
+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}")
+```
+
+Results:
+
+```
+Citation: Schumann, Kai; Völker, David; Weinrebe, Wilhelm Reiber (2011):
+Gridded results of swath bathymetric mapping of Disko Bay, Western
+Greenland, 2007-2008. PANGAEA - Data Publisher for Earth & Environmental
+Science
+
+Abstract: A ship-based acoustic mapping campaign was conducted at the exit
+of Ilulissat Ice Fjord and in the sedimentary basin of Disko Bay to the
+west of the fjord mouth. Submarine landscape and sediment distribution
+patterns are interpreted in terms of glaciomarine facies types that are
+related to variations in the past position of the glacier front. In
+particular, asymmetric ridges that form a curved entity and a large sill at
+the fjord mouth may represent moraines that depict at least two relatively
+stable positions of the ice front in the Disko Bay and at the fjord mouth.
+In this respect, Ilulissat Glacier shows prominent differences to the East
+Greenland Kangerlussuaq Glacier which is comparable in present size and
+present role for the ice discharge from the inland ice sheet. Two linear
+clusters of pockmarks in the center of the sedimentary basin seem to be
+linked to ongoing methane release due to dissociation of gas hydrates, a
+process fueled by climate warming in the Arctic realm.
+```
+
+## Writing
+
+```ruby
+require 'datacite/mapping'
+include Datacite::Mapping
+
+# Based on "Example for a simple dataset"
+# http://schema.datacite.org/meta/kernel-3/example/datacite-example-dataset-v3.0.xml
+resource = Resource.new(
+  identifier: Identifier.new(value: '10.5072/D3P26Q35R-Test'),
+  creators: [
+    Creator.new(name: 'Fosmire, Michael'),
+    Creator.new(name: 'Wertz, Ruth'),
+    Creator.new(name: 'Purzer, Senay')
+  ],
+  titles: [
+    Title.new(value: 'Critical Engineering Literacy Test (CELT)')
+  ],
+  publisher: 'Purdue University Research Repository (PURR)',
+  publication_year: 2013,
+  subjects: [
+    Subject.new(value: 'Assessment'),
+    Subject.new(value: 'Information Literacy'),
+    Subject.new(value: 'Engineering'),
+    Subject.new(value: 'Undergraduate Students'),
+    Subject.new(value: 'CELT'),
+    Subject.new(value: 'Purdue University')
+  ],
+  language: 'en',
+  resource_type: ResourceType.new(resource_type_general: ResourceTypeGeneral::DATASET, value: 'Dataset'),
+  version: '1',
+  descriptions: [
+    Description.new(
+      type: DescriptionType::ABSTRACT,
+      value: 'We developed an instrument, Critical Engineering Literacy Test
+              (CELT), which is a multiple choice instrument designed to
+              measure undergraduate students’ scientific and information
+              literacy skills. It requires students to first read a
+              technical memo and, based on the memo’s arguments, answer
+              eight multiple choice and six open-ended response questions.
+              We collected data from 143 first-year engineering students and
+              conducted an item analysis. The KR-20 reliability of the
+              instrument was .39. Item difficulties ranged between .17 to
+              .83. The results indicate low reliability index but acceptable
+              levels of item difficulties and item discrimination indices.
+              Students were most challenged when answering items measuring
+              scientific and mathematical literacy (i.e., identifying
+              incorrect information).'
+    )
+  ]
+)
+
+xml = resource.save_to_xml
+formatter = REXML::Formatters::Pretty.new
+formatter.compact = true
+formatter.write(xml, $stdout)
+```
+
+Results:
+
+```xml
+<resource xmlns='http://datacite.org/schema/kernel-3' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://datacite.org/schema/kernel-3 http://schema.datacite.org/meta/kernel-3/metadata.xsd'>
+  <identifier identifierType='DOI'>10.5072/D3P26Q35R-Test</identifier>
+  <creators>
+    <creator>
+      <creatorName>Fosmire, Michael</creatorName>
+    </creator>
+    <creator>
+      <creatorName>Wertz, Ruth</creatorName>
+    </creator>
+    <creator>
+      <creatorName>Purzer, Senay</creatorName>
+    </creator>
+  </creators>
+  <titles>
+    <title xml:lang='en'>Critical Engineering Literacy Test (CELT)</title>
+  </titles>
+  <publisher>Purdue University Research Repository (PURR)</publisher>
+  <publicationYear>2013</publicationYear>
+  <subjects>
+    <subject xml:lang='en'>Assessment</subject>
+    <subject xml:lang='en'>Information Literacy</subject>
+    <subject xml:lang='en'>Engineering</subject>
+    <subject xml:lang='en'>Undergraduate Students</subject>
+    <subject xml:lang='en'>CELT</subject>
+    <subject xml:lang='en'>Purdue University</subject>
+  </subjects>
+  <language>en</language>
+  <resourceType resourceTypeGeneral='Dataset'>Dataset</resourceType>
+  <version>1</version>
+  <descriptions>
+    <description xml:lang='en' descriptionType='Abstract'>
+      We developed an instrument, Critical Engineering Literacy Test (CELT),
+      which is a multiple choice instrument designed to measure undergraduate
+      students’ scientific and information literacy skills. It requires students
+      to first read a technical memo and, based on the memo’s arguments, answer
+      eight multiple choice and six open-ended response questions. We collected
+      data from 143 first-year engineering students and conducted an item
+      analysis. The KR-20 reliability of the instrument was .39. Item
+      difficulties ranged between .17 to .83. The results indicate low
+      reliability index but acceptable levels of item difficulties and item
+      discrimination indices. Students were most challenged when answering items
+      measuring scientific and mathematical literacy (i.e., identifying
+      incorrect information).
+    </description>
+  </descriptions>
+</resource>
+```

data/Rakefile

@@ -0,0 +1,49 @@
+# ------------------------------------------------------------
+# RSpec
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+
+  desc 'Run all unit tests'
+  RSpec::Core::RakeTask.new(:unit) do |task|
+    task.rspec_opts = %w(--color --format documentation --order default)
+    task.pattern = 'unit/**/*_spec.rb'
+  end
+
+  task all: [:unit]
+end
+
+desc 'Run all tests'
+task spec: 'spec:all'
+
+# ------------------------------------------------------------
+# Coverage
+
+desc 'Run all unit tests with coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec:unit'].execute
+end
+
+# ------------------------------------------------------------
+# RuboCop
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+# ------------------------------------------------------------
+# TODOs
+
+desc 'List TODOs (from spec/todo.rb)'
+RSpec::Core::RakeTask.new(:todo) do |task|
+  task.rspec_opts = %w(--color --format documentation --order default)
+  task.pattern = 'todo.rb'
+end
+
+# ------------------------------------------------------------
+# Defaults
+
+desc 'Run unit tests, check test coverage, run acceptance tests, check code style'
+task default: [:coverage, :rubocop]

data/datacite-mapping.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'URI'
+require 'datacite/mapping/module_info'
+
+Gem::Specification.new do |spec|
+  spec.name          = Datacite::Mapping::NAME
+  spec.version       = Datacite::Mapping::VERSION
+  spec.authors       = ['David Moles']
+  spec.email         = ['david.moles@ucop.edu']
+  spec.summary       = 'Parses and generates Datacite XML documents'
+  spec.description   = 'A gem for working with the Datacite XML format'
+  spec.license       = 'MIT'
+
+  origin_uri = URI(`git config --get remote.origin.url`.chomp)
+  spec.homepage = URI::HTTP.build(host: origin_uri.host, path: origin_uri.path.chomp('.git')).to_s
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'typesafe_enum', '~> 0.1', '>= 0.1.2'
+  spec.add_dependency 'xml-mapping_extensions', '~> 0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'equivalent-xml', '~> 0.6.0'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'simplecov', '~> 0.9.2'
+  spec.add_development_dependency 'simplecov-console', '~> 0.2.0'
+  spec.add_development_dependency 'rubocop', '~> 0.32.1'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

data/examples/reading.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+# coding: UTF-8
+
+require 'datacite/mapping'
+include Datacite::Mapping
+
+xml_text = '<?xml version="1.0" encoding="UTF-8"?>
+            <resource xsi:schemaLocation="http://datacite.org/schema/kernel-3 http://schema.datacite.org/meta/kernel-3/metadata.xsd" xmlns="http://datacite.org/schema/kernel-3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+              <identifier identifierType="DOI">10.5072/geoPointExample</identifier>
+              <creators>
+                <creator>
+                  <creatorName>Schumann, Kai</creatorName>
+                </creator>
+                <creator>
+                  <creatorName>Völker, David</creatorName>
+                </creator>
+                <creator>
+                  <creatorName>Weinrebe, Wilhelm Reiber</creatorName>
+                </creator>
+              </creators>
+              <titles>
+                <title>Gridded results of swath bathymetric mapping of Disko Bay, Western Greenland, 2007-2008</title>
+              </titles>
+              <publisher>PANGAEA - Data Publisher for Earth &amp; Environmental Science</publisher>
+              <publicationYear>2011</publicationYear>
+              <subjects>
+                <subject subjectScheme="DDC">551 Geology, hydrology, meteorology</subject>
+              </subjects>
+              <contributors>
+                <contributor contributorType="HostingInstitution">
+                  <contributorName>IFM-GEOMAR Leibniz-Institute of Marine Sciences, Kiel University</contributorName>
+                </contributor>
+              </contributors>
+              <language>en</language>
+              <resourceType resourceTypeGeneral="Dataset"/>
+              <relatedIdentifiers>
+                <relatedIdentifier relatedIdentifierType="DOI" relationType="Continues">10.5072/timeSeries</relatedIdentifier>
+              </relatedIdentifiers>
+              <sizes>
+                <size>4 datasets</size>
+              </sizes>
+              <formats>
+                <format>application/zip</format>
+              </formats>
+              <rightsList><rights rightsURI="http://creativecommons.org/licenses/by/3.0/deed">Creative Commons Attribution 3.0 Unported</rights></rightsList>
+              <descriptions>
+                <description descriptionType="Abstract">A ship-based acoustic mapping campaign was conducted at the exit of Ilulissat Ice Fjord and in the sedimentary basin of Disko Bay to the west of the fjord mouth. Submarine landscape and sediment distribution patterns are interpreted in terms of glaciomarine facies types that are related to variations in the past position of the glacier front. In particular, asymmetric ridges that form a curved entity and a large sill at the fjord mouth may represent moraines that depict at least two relatively stable positions of the ice front in the Disko Bay and at the fjord mouth. In this respect, Ilulissat Glacier shows prominent differences to the East Greenland Kangerlussuaq Glacier which is comparable in present size and present role for the ice discharge from the inland ice sheet. Two linear clusters of pockmarks in the center of the sedimentary basin seem to be linked to ongoing methane release due to dissociation of gas hydrates, a process fueled by climate warming in the Arctic realm.
+                </description>
+              </descriptions>
+              <geoLocations>
+                <geoLocation>
+                  <geoLocationPoint>-52.000000 69.000000 </geoLocationPoint>
+                  <geoLocationPlace>Disko Bay</geoLocationPlace>
+                </geoLocation>
+              </geoLocations>
+            </resource>'
+
+xml = REXML::Document.new(xml_text)
+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}")