datacite-mapping 0.1.0

data/lib/datacite/mapping/resource_type.rb

@@ -0,0 +1,83 @@
+require 'xml/mapping_extensions'
+
+module Datacite
+  module Mapping
+
+    # Controlled vocabulary of general resource types.
+    class ResourceTypeGeneral < TypesafeEnum::Base
+      # @!parse AUDIOVISUAL = Audiovisual
+      new :AUDIOVISUAL, 'Audiovisual'
+
+      # @!parse COLLECTION = Collection
+      new :COLLECTION, 'Collection'
+
+      # @!parse DATASET = Dataset
+      new :DATASET, 'Dataset'
+
+      # @!parse EVENT = Event
+      new :EVENT, 'Event'
+
+      # @!parse IMAGE = Image
+      new :IMAGE, 'Image'
+
+      # @!parse INTERACTIVE_RESOURCE = InteractiveResource
+      new :INTERACTIVE_RESOURCE, 'InteractiveResource'
+
+      # @!parse MODEL = Model
+      new :MODEL, 'Model'
+
+      # @!parse PHYSICAL_OBJECT = PhysicalObject
+      new :PHYSICAL_OBJECT, 'PhysicalObject'
+
+      # @!parse SERVICE = Service
+      new :SERVICE, 'Service'
+
+      # @!parse SOFTWARE = Software
+      new :SOFTWARE, 'Software'
+
+      # @!parse SOUND = Sound
+      new :SOUND, 'Sound'
+
+      # @!parse TEXT = Text
+      new :TEXT, 'Text'
+
+      # @!parse WORKFLOW = Workflow
+      new :WORKFLOW, 'Workflow'
+
+      # @!parse OTHER = Other
+      new :OTHER, 'Other'
+
+    end
+
+    # The type of the resource
+    class ResourceType
+      include XML::Mapping
+
+      root_element_name 'resourceType'
+
+      # @!attribute [rw] resource_type_general
+      #    @return [ResourceTypeGeneral] the general resource type
+      typesafe_enum_node :resource_type_general, '@resourceTypeGeneral', class: ResourceTypeGeneral
+
+      # @!attribute [rw] value
+      #    @return [String] additional free text description of the resource type. Optional.
+      text_node :value, 'text()', default_value: nil
+
+      alias_method :_resource_type_general=, :resource_type_general=
+      private :_resource_type_general=
+
+      # Initializes a new {ResourceType}
+      # @param resource_type_general [ResourceTypeGeneral] the general resource type
+      # @param value [String] additional free text description of the resource type.
+      def initialize(resource_type_general:, value: nil)
+        self.resource_type_general = resource_type_general
+        self.value = value
+      end
+
+      def resource_type_general=(val)
+        fail ArgumentError, 'General resource type cannot be nil' unless val
+        self._resource_type_general = val
+      end
+    end
+  end
+end

data/lib/datacite/mapping/rights.rb

@@ -0,0 +1,36 @@
+require 'xml/mapping_extensions'
+
+module Datacite
+  module Mapping
+
+    # Rights information for the {Resource}
+    class Rights
+      include XML::Mapping
+
+      # @!attribute [rw] uri
+      #   @return [URI, nil] a URI for the license. Optional.
+      uri_node :uri, '@rightsURI', default_value: nil
+
+      # @!attribute [rw] value
+      #   @return [String] the rights statement. Cannot be empty or nil.
+      text_node :value, 'text()'
+
+      # Initializes a new {Rights} object
+      #
+      # @param uri [URI, nil] a URI for the license. Optional.
+      # @param value [String] the rights statement. Cannot be empty or nil.
+      def initialize(uri: nil, value:)
+        self.uri = uri
+        self.value = value
+      end
+
+      alias_method :_value=, :value=
+      private :_value=
+
+      def value=(v)
+        fail ArgumentError, 'Value cannot be empty or nil' unless v && !v.empty?
+        self._value = v.strip
+      end
+    end
+  end
+end

data/lib/datacite/mapping/subject.rb

@@ -0,0 +1,55 @@
+require 'xml/mapping'
+
+module Datacite
+  module Mapping
+
+    # Subject, keyword, classification code, or key phrase describing the {Resource}.
+    class Subject
+      include XML::Mapping
+
+      # @!attribute [rw] scheme
+      #   @return [String, nil] the subject scheme or classification code or authority if one is used. Optional.
+      text_node :scheme, '@subjectScheme', default_value: nil
+
+      # @!attribute [rw] scheme_uri
+      #   @return [URI, nil] the URI of the subject scheme or classification code or authority if one is used. Optional.
+      uri_node :scheme_uri, '@schemeURI', default_value: nil
+
+      # @!attribute [rw] language
+      #   @return [String] an IETF BCP 47, ISO 639-1 language code identifying the language.
+      #     It's unclear from the spec whether language is required; to play it safe, if it's missing, we default to 'en'.
+      text_node :language, '@xml:lang', default_value: nil
+
+      # @!attribute [rw] value
+      #   @return [String] the subject itself.
+      text_node :value, 'text()'
+
+      alias_method :_language, :language
+      private :_language
+
+      alias_method :_language=, :language=
+      private :_language=
+
+      # Initializes a new {Subject}
+      # @param scheme [String, nil] the subject scheme or classification code or authority if one is used. Optional.
+      # @param scheme_uri [URI, nil] the URI of the subject scheme or classification code or authority if one is used. Optional.
+      # @param language [String] an IETF BCP 47, ISO 639-1 language code identifying the language.
+      #   It's unclear from the spec whether language is required; to play it safe, if it's missing, we default to 'en'.
+      # @param value [String] the subject itself.
+      def initialize(scheme: nil, scheme_uri: nil, language: 'en', value:)
+        self.scheme = scheme
+        self.scheme_uri = scheme_uri
+        self.language = language
+        self.value = value
+      end
+
+      def language
+        _language || 'en'
+      end
+
+      def language=(value)
+        self._language = value.strip if value
+      end
+    end
+  end
+end

data/lib/datacite/mapping/title.rb

@@ -0,0 +1,69 @@
+require 'xml/mapping_extensions'
+
+module Datacite
+  module Mapping
+
+    # Controlled vocabulary of title types (for titles other than the main/default title).
+    class TitleType < TypesafeEnum::Base
+      # @!parse ALTERNATIVE_TITLE = AlternativeTitle
+      new :ALTERNATIVE_TITLE, 'AlternativeTitle'
+
+      # @!parse SUBTITLE = Subtitle
+      new :SUBTITLE, 'Subtitle'
+
+      # @!parse TRANSLATED_TITLE = TranslatedTitle
+      new :TRANSLATED_TITLE, 'TranslatedTitle'
+
+    end
+
+    # A name or title by which a {Resource} is known.
+    class Title
+      include XML::Mapping
+
+      # @!attribute [rw] language
+      #   @return [String] an IETF BCP 47, ISO 639-1 language code identifying the language.
+      #     It's unclear from the spec whether language is required; to play it safe, if it's missing, we default to 'en'.
+      text_node :language, '@xml:lang', default_value: nil
+
+      # @!attribute [rw] type
+      #   @return [TitleType, nil] the title type. Optional.
+      typesafe_enum_node :type, '@titleType', class: TitleType, default_value: nil
+
+      # @!attribute [rw] value
+      #   @return [String] the title itself.
+      text_node :value, 'text()'
+
+      alias_method :_language, :language
+      private :_language
+
+      alias_method :_language=, :language=
+      private :_language=
+
+      # Initializes a new {Title}.
+      # @param language [String] an IETF BCP 47, ISO 639-1 language code identifying the language.
+      #   It's unclear from the spec whether language is required; to play it safe, if it's missing, we default to 'en'.
+      # @param value [String] the title itself.
+      # @param type [TitleType, nil] the title type. Optional.
+      def initialize(language: 'en', value:, type: nil)
+        self.language = language
+        self.type = type
+        self.value = value
+      end
+
+      def language
+        _language || 'en'
+      end
+
+      def language=(value)
+        self._language = value.strip if value
+      end
+
+      alias_method :_value=, :value=
+
+      def value=(v)
+        fail ArgumentError, 'Value cannot be empty or nil' unless v && !v.empty?
+        self._value = v.strip
+      end
+    end
+  end
+end

data/spec/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: ../.rubocop.yml
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false

data/spec/data/resource.xml

@@ -0,0 +1,61 @@
+<?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/example-full</identifier>
+  <creators>
+    <creator>
+      <creatorName>Miller, Elizabeth</creatorName>
+      <nameIdentifier schemeURI="http://orcid.org/" nameIdentifierScheme="ORCID">0000-0001-5000-0007</nameIdentifier>
+      <affiliation>DataCite</affiliation>
+    </creator>
+  </creators>
+  <titles>
+    <title xml:lang="en-us">Full DataCite XML Example</title>
+    <title xml:lang="en-us" titleType="Subtitle">Demonstration of DataCite Properties.</title>
+  </titles>
+  <publisher>DataCite</publisher>
+  <publicationYear>2014</publicationYear>
+  <subjects>
+    <subject xml:lang="en-us" schemeURI="http://dewey.info/" subjectScheme="dewey">000 computer science</subject>
+  </subjects>
+  <contributors>
+    <contributor contributorType="ProjectLeader">
+      <contributorName>Starr, Joan</contributorName>
+      <nameIdentifier schemeURI="http://orcid.org/" nameIdentifierScheme="ORCID">0000-0002-7285-027X</nameIdentifier>
+      <affiliation>California Digital Library</affiliation>
+    </contributor>
+  </contributors>
+  <dates>
+    <date dateType="Updated">2014-10-17</date>
+  </dates>
+  <language>en-us</language>
+  <resourceType resourceTypeGeneral="Software">XML</resourceType>
+  <alternateIdentifiers>
+    <alternateIdentifier alternateIdentifierType="URL">http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml</alternateIdentifier>
+  </alternateIdentifiers>
+  <relatedIdentifiers>
+    <relatedIdentifier relatedIdentifierType="URL" relationType="HasMetadata" relatedMetadataScheme="citeproc+json" 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>
+    <relatedIdentifier relatedIdentifierType="arXiv" relationType="IsReviewedBy">arXiv:0706.0001</relatedIdentifier>
+  </relatedIdentifiers>
+  <sizes>
+    <size>3KB</size>
+  </sizes>
+  <formats>
+    <format>application/xml</format>
+  </formats>
+  <version>3.1</version>
+  <rightsList>
+    <rights rightsURI="http://creativecommons.org/publicdomain/zero/1.0/">CC0 1.0 Universal</rights>
+  </rightsList>
+  <descriptions>
+    <description xml:lang="en-us" descriptionType="Abstract">
+      XML example of all DataCite Metadata Schema v3.1 properties.
+    </description>
+  </descriptions>
+  <geoLocations>
+    <geoLocation>
+      <geoLocationPoint>31.233 -67.302</geoLocationPoint>
+      <geoLocationBox>41.09 -71.032 42.893 -68.211</geoLocationBox>
+      <geoLocationPlace>Atlantic Ocean</geoLocationPlace>
+    </geoLocation>
+  </geoLocations>
+</resource>

data/spec/rspec_custom_matchers.rb

@@ -0,0 +1,69 @@
+require 'rspec/expectations'
+require 'equivalent-xml'
+
+RSpec::Matchers.define :be_xml do |expected|
+
+  def to_nokogiri(xml)
+    return nil unless xml
+    case xml
+    when Nokogiri::XML::Element
+      xml
+    when Nokogiri::XML::Document
+      xml.root
+    when String
+      to_nokogiri(Nokogiri::XML(xml))
+    when REXML::Element
+      to_nokogiri(xml.to_s)
+    else
+      fail "be_xml() expected XML, got #{xml.class}"
+    end
+  end
+
+  def to_pretty(nokogiri)
+    return nil unless nokogiri
+    out = StringIO.new
+    save_options = Nokogiri::XML::Node::SaveOptions::FORMAT | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
+    nokogiri.write_xml_to(out, encoding: 'UTF-8', indent: 2, save_with: save_options)
+    out.string
+  end
+
+  match do |actual|
+    expected_xml = to_nokogiri(expected) || fail("expected value #{expected} does not appear to be XML")
+    actual_xml = to_nokogiri(actual)
+
+    EquivalentXml.equivalent?(expected_xml, actual_xml, element_order: false, normalize_whitespace: true)
+  end
+
+  failure_message do |actual|
+    expected_string = to_pretty(to_nokogiri(expected))
+    actual_string = to_pretty(to_nokogiri(actual)) || actual
+    "expected XML:\n#{expected_string}\n\nbut was:\n#{actual_string}"
+  end
+
+  failure_message_when_negated do |actual|
+    actual_xml = to_element(actual) || actual
+    "expected not to get XML:\n\t#{actual_xml}"
+  end
+end
+
+RSpec::Matchers.define :be_time do |expected|
+
+  def to_string(time)
+    time.is_a?(Time) ? time.utc.round(2).iso8601(2) : time.to_s
+  end
+
+  match do |actual|
+    if expected
+      fail "Expected value #{expected} is not a Time" unless expected.is_a?(Time)
+      actual.is_a?(Time) && (to_string(expected) == to_string(actual))
+    else
+      return actual.nil?
+    end
+  end
+
+  failure_message do |actual|
+    expected_str = to_string(expected)
+    actual_str = to_string(actual)
+    "expected time:\n#{expected_str}\n\nbut was:\n#{actual_str}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# ------------------------------------------------------------
+# SimpleCov setup
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'simplecov-console'
+
+  SimpleCov.minimum_coverage 100
+  SimpleCov.start do
+    add_filter '/spec/'
+    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::Console,
+    ]
+  end
+end
+
+# ------------------------------------------------------------
+# Rspec configuration
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+  config.mock_with :rspec
+end
+
+require 'rspec_custom_matchers'
+
+# ------------------------------------------------------------
+# Stash::Wrapper
+
+require 'datacite/mapping'

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

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module Datacite
+  module Mapping
+    describe AlternateIdentifier do
+
+      describe '#initialize' do
+        it 'sets the identifier type and value' do
+          id = AlternateIdentifier.new(type: 'URL', value: 'http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml')
+          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
+      end
+
+      describe 'type' do
+        it 'sets the type' do
+          rt = AlternateIdentifier.allocate
+          rt.type = 'URL'
+          expect(rt.type).to eq('URL')
+        end
+        it 'requires a type' do
+          rt = AlternateIdentifier.new(type: 'URL', value: 'http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml')
+          expect { rt.type = nil }.to raise_error(ArgumentError)
+          expect(rt.type).to eq('URL')
+        end
+      end
+
+      describe 'value' do
+        it 'sets the value' do
+          rt = AlternateIdentifier.allocate
+          rt.value = 'http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml'
+          expect(rt.value).to eq('http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml')
+        end
+        it 'requires a value' do
+          rt = AlternateIdentifier.new(type: 'URL', value: 'http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml')
+          expect { rt.value = nil }.to raise_error(ArgumentError)
+          expect(rt.value).to eq('http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml')
+        end
+      end
+
+      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)
+          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
+      end
+
+      describe '#save_to_xml' do
+        it 'writes XML' do
+          id = AlternateIdentifier.new(type: 'URL', value: 'http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml')
+          expected_xml = '<alternateIdentifier alternateIdentifierType="URL">http://schema.datacite.org/schema/meta/kernel-3.1/example/datacite-example-full-v3.1.xml</alternateIdentifier>'
+          expect(id.save_to_xml).to be_xml(expected_xml)
+        end
+      end
+    end
+  end
+end