datacite-mapping 0.1.0

data/lib/datacite/mapping/module_info.rb

@@ -0,0 +1,12 @@
+module Datacite
+  module Mapping
+    # The name of this gem
+    NAME = 'datacite-mapping'
+
+    # The version of this gem
+    VERSION = '0.1.0'
+
+    # The copyright notice for this gem
+    COPYRIGHT = 'Copyright (c) 2015 The Regents of the University of California'
+  end
+end

data/lib/datacite/mapping/name_identifier.rb

@@ -0,0 +1,48 @@
+require 'xml/mapping_extensions'
+
+module Datacite
+  module Mapping
+    # Uniquely identifies an individual or legal entity, according to various schemes.
+    class NameIdentifier
+      include XML::Mapping
+
+      root_element_name 'nameIdentifier'
+
+      # @!attribute [rw] scheme
+      #   @return [String] the name identifier scheme. Cannot be nil.
+      text_node :scheme, '@nameIdentifierScheme'
+      # @!attribute [rw] scheme_uri
+      #   @return [URI, nil] the URI of the identifier scheme. Optional.
+      uri_node :scheme_uri, '@schemeURI', default_value: nil
+      # @!attribute [rw] value
+      #   @return [String] the identifier value. Cannot be nil.
+      text_node :value, 'text()'
+
+      alias_method :_scheme=, :scheme=
+      private :_scheme=
+
+      alias_method :_value=, :value=
+      private :_value=
+
+      # Initializes a new {NameIdentifier}
+      # @param scheme [Scheme] the name identifier scheme. Cannot be nil.
+      # @param scheme_uri [URI, nil] the URI of the identifier scheme. Optional.
+      # @param value [String] the identifier value. Cannot be nil.
+      def initialize(scheme:, scheme_uri: nil, value:)
+        self.scheme = scheme
+        self.scheme_uri = scheme_uri
+        self.value = value
+      end
+
+      def scheme=(v)
+        fail ArgumentError, 'Scheme cannot be empty or nil' unless v && !v.empty?
+        self._scheme = v
+      end
+
+      def value=(v)
+        fail ArgumentError, 'Value cannot be empty or nil' unless v && !v.empty?
+        self._value = v
+      end
+    end
+  end
+end

data/lib/datacite/mapping/related_identifier.rb

@@ -0,0 +1,209 @@
+require 'xml/mapping_extensions'
+
+module Datacite
+  module Mapping
+
+    # Controlled list of relationships of the {Resource} to a related resource.
+    class RelationType < TypesafeEnum::Base
+      # @!parse IS_CITED_BY = IsCitedBy
+      new :IS_CITED_BY, 'IsCitedBy'
+
+      # @!parse CITES = Cites
+      new :CITES, 'Cites'
+
+      # @!parse IS_SUPPLEMENT_TO = IsSupplementTo
+      new :IS_SUPPLEMENT_TO, 'IsSupplementTo'
+
+      # @!parse IS_SUPPLEMENTED_BY = IsSupplementedBy
+      new :IS_SUPPLEMENTED_BY, 'IsSupplementedBy'
+
+      # @!parse IS_CONTINUED_BY = IsContinuedBy
+      new :IS_CONTINUED_BY, 'IsContinuedBy'
+
+      # @!parse CONTINUES = Continues
+      new :CONTINUES, 'Continues'
+
+      # @!parse HAS_METADATA = HasMetadata
+      new :HAS_METADATA, 'HasMetadata'
+
+      # @!parse IS_METADATA_FOR = IsMetadataFor
+      new :IS_METADATA_FOR, 'IsMetadataFor'
+
+      # @!parse IS_NEW_VERSION_OF = IsNewVersionOf
+      new :IS_NEW_VERSION_OF, 'IsNewVersionOf'
+
+      # @!parse IS_PREVIOUS_VERSION_OF = IsPreviousVersionOf
+      new :IS_PREVIOUS_VERSION_OF, 'IsPreviousVersionOf'
+
+      # @!parse IS_PART_OF = IsPartOf
+      new :IS_PART_OF, 'IsPartOf'
+
+      # @!parse HAS_PART = HasPart
+      new :HAS_PART, 'HasPart'
+
+      # @!parse IS_REFERENCED_BY = IsReferencedBy
+      new :IS_REFERENCED_BY, 'IsReferencedBy'
+
+      # @!parse REFERENCES = References
+      new :REFERENCES, 'References'
+
+      # @!parse IS_DOCUMENTED_BY = IsDocumentedBy
+      new :IS_DOCUMENTED_BY, 'IsDocumentedBy'
+
+      # @!parse DOCUMENTS = Documents
+      new :DOCUMENTS, 'Documents'
+
+      # @!parse IS_COMPILED_BY = IsCompiledBy
+      new :IS_COMPILED_BY, 'IsCompiledBy'
+
+      # @!parse COMPILES = Compiles
+      new :COMPILES, 'Compiles'
+
+      # @!parse IS_VARIANT_FORM_OF = IsVariantFormOf
+      new :IS_VARIANT_FORM_OF, 'IsVariantFormOf'
+
+      # @!parse IS_ORIGINAL_FORM_OF = IsOriginalFormOf
+      new :IS_ORIGINAL_FORM_OF, 'IsOriginalFormOf'
+
+      # @!parse IS_IDENTICAL_TO = IsIdenticalTo
+      new :IS_IDENTICAL_TO, 'IsIdenticalTo'
+
+      # @!parse IS_REVIEWED_BY = IsReviewedBy
+      new :IS_REVIEWED_BY, 'IsReviewedBy'
+
+      # @!parse REVIEWS = Reviews
+      new :REVIEWS, 'Reviews'
+
+      # @!parse IS_DERIVED_FROM = IsDerivedFrom
+      new :IS_DERIVED_FROM, 'IsDerivedFrom'
+
+      # @!parse IS_SOURCE_OF = IsSourceOf
+      new :IS_SOURCE_OF, 'IsSourceOf'
+
+    end
+
+    # Controlled list of related identifier types.
+    class RelatedIdentifierType < TypesafeEnum::Base
+      # @!parse ARK = ARK
+      new :ARK, 'ARK'
+
+      # @!parse ARXIV = arXiv
+      new :ARXIV, 'arXiv'
+
+      # @!parse BIBCODE = bibcode
+      new :BIBCODE, 'bibcode'
+
+      # @!parse DOI = DOI
+      new :DOI, 'DOI'
+
+      # @!parse EAN13 = EAN13
+      new :EAN13, 'EAN13'
+
+      # @!parse EISSN = EISSN
+      new :EISSN, 'EISSN'
+
+      # @!parse HANDLE = Handle
+      new :HANDLE, 'Handle'
+
+      # @!parse ISBN = ISBN
+      new :ISBN, 'ISBN'
+
+      # @!parse ISSN = ISSN
+      new :ISSN, 'ISSN'
+
+      # @!parse ISTC = ISTC
+      new :ISTC, 'ISTC'
+
+      # @!parse LISSN = LISSN
+      new :LISSN, 'LISSN'
+
+      # @!parse LSID = LSID
+      new :LSID, 'LSID'
+
+      # @!parse PMID = PMID
+      new :PMID, 'PMID'
+
+      # @!parse PURL = PURL
+      new :PURL, 'PURL'
+
+      # @!parse UPC = UPC
+      new :UPC, 'UPC'
+
+      # @!parse URL = URL
+      new :URL, 'URL'
+
+      # @!parse URN = URN
+      new :URN, 'URN'
+
+    end
+
+    # Globally unique identifier of a related resource.
+    class RelatedIdentifier
+      include XML::Mapping
+
+      root_element_name 'relatedIdentifier'
+
+      # @!attribute [rw] relation_type
+      #   @return [RelationType] the relationship of the {Resource} to the related resource. Cannot be nil.
+      typesafe_enum_node :relation_type, '@relationType', class: RelationType
+
+      # @!attribute [rw] value
+      #   @return [String] the identifier value. Cannot be nil.
+      text_node :value, 'text()'
+
+      # @!attribute [rw] identifier_type
+      #   @return [RelatedIdentifierType] the type of the related identifier. Cannot be nil.
+      typesafe_enum_node :identifier_type, '@relatedIdentifierType', class: RelatedIdentifierType
+
+      # @!attribute [rw] related_metadata_scheme
+      #   @return [String, nil] the name of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+      text_node :related_metadata_scheme, '@relatedMetadataScheme', default_value: nil
+
+      # @!attribute [rw] scheme_uri
+      #   @return [URI, nil] the URI of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+      uri_node :scheme_uri, '@schemeURI', default_value: nil
+
+      # @!attribute [rw] scheme_type
+      #   @return [String, nil] the type of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+      text_node :scheme_type, '@schemeType', default_value: nil
+
+      alias_method :_relation_type=, :relation_type=
+      private :_relation_type=
+      alias_method :_value=, :value=
+      private :_value=
+      alias_method :_identifier_type=, :identifier_type=
+      private :_identifier_type=
+
+      # Initializes a new {RelatedIdentifier}.
+      # @param relation_type [RelationType] the relationship of the {Resource} to the related resource. Cannot be nil.
+      # @param value [String] the identifier value. Cannot be nil.
+      # @param identifier_type [RelatedIdentifierType] the type of the related identifier. Cannot be nil.
+      # @param related_metadata_scheme [String, nil] the name of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+      # @param scheme_uri [URI, nil] the URI of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+      # @param scheme_type [String, nil] the type of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+      def initialize(relation_type:, value:, identifier_type:, related_metadata_scheme: nil, scheme_uri: nil, scheme_type: nil) # rubocop:disable Metrics/ParameterLists
+        self.relation_type = relation_type
+        self.value = value
+        self.identifier_type = identifier_type
+        self.related_metadata_scheme = related_metadata_scheme
+        self.scheme_uri = scheme_uri
+        self.scheme_type = scheme_type
+      end
+
+      def value=(value)
+        fail ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
+        self._value = value
+      end
+
+      def identifier_type=(value)
+        fail ArgumentError, 'Identifier type cannot be empty or nil' unless value
+        self._identifier_type = value
+      end
+
+      def relation_type=(value)
+        fail ArgumentError, 'Relation type cannot be nil' unless value
+        self._relation_type = value
+      end
+    end
+  end
+end

data/lib/datacite/mapping/resource.rb

@@ -0,0 +1,201 @@
+require 'xml/mapping'
+require_relative 'identifier'
+require_relative 'creator'
+require_relative 'title'
+require_relative 'subject'
+require_relative 'resource_type'
+require_relative 'alternate_identifier'
+require_relative 'related_identifier'
+require_relative 'rights'
+
+module Datacite
+  module Mapping
+
+    # A collection of metadata properties chosen for the accurate and consistent identification
+    # of a resource for citation and retrieval purposes, along with recommended use instructions.
+    # The resource that is being identified can be of any kind, but it is typically a dataset.
+    class Resource
+      include XML::Mapping
+
+      # @!attribute [rw] identifier
+      #   @return [Identifier] a persistent identifier that identifies a resource.
+      object_node :identifier, 'identifier', class: Identifier
+
+      # @!attribute [rw] creators
+      #   @return [Array<Creator>] the main researchers involved working on the data, or the authors of the publication in priority order.
+      array_node :creators, 'creators', 'creator', class: Creator
+
+      # @!attribute [rw] titles
+      #   @return [Array<Title>] the names or titles by which a resource is known.
+      array_node :titles, 'titles', 'title', class: Title
+
+      # @!attribute [rw] publisher
+      #   @return [String] the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
+      text_node :publisher, 'publisher'
+
+      # @!attribute [rw] publication_year
+      #   @return [Integer] year when the resource is made publicly available.
+      numeric_node :publication_year, 'publicationYear'
+
+      # @!attribute [rw] subjects
+      #   @return [Array<Subject>] subjects, keywords, classification codes, or key phrases describing the resource.
+      array_node :subjects, 'subjects', 'subject', class: Subject, default_value: []
+
+      # @!attribute [rw] contributors
+      #   @return [Array<Contributor>] institutions or persons responsible for collecting, creating, or otherwise contributing to the developement of the dataset.
+      array_node :contributors, 'contributors', 'contributor', class: Contributor, default_value: []
+
+      # @!attribute [rw] dates
+      #   @return [Array<Date>] different dates relevant to the work.
+      array_node :dates, 'dates', 'date', class: Date, default_value: []
+
+      # @!attribute [rw] language
+      #   @return [String] Primary language of the resource: an IETF BCP 47, ISO 639-1 language code.
+      #   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, 'language'
+
+      # @!attribute [rw] resource_type
+      #   @return [ResourceType, nil] the type of the resource. Optional.
+      object_node :resource_type, 'resourceType', class: ResourceType, default_value: nil
+
+      # @!attribute [rw] alternate_identifiers
+      #   @return [Array<AlternateIdentifier>] an identifier or identifiers other than the primary {Identifier} applied to the resource being registered.
+      array_node :alternate_identifiers, 'alternateIdentifiers', 'alternateIdentifier', class: AlternateIdentifier, default_value: []
+
+      # @!attribute [rw] related_identifiers
+      #   @return [Array<RelatedIdentifier>] identifiers of related resources.
+      array_node :related_identifiers, 'relatedIdentifiers', 'relatedIdentifier', class: RelatedIdentifier, default_value: []
+
+      # @!attribute [rw] sizes
+      #   @return [Array<String>] unstructured size information about the resource.
+      array_node :sizes, 'sizes', 'size', class: String, default_value: []
+
+      # @!attribute [rw] formats
+      #   @return [Array<String>] technical format of the resource, e.g. file extension or MIME type.
+      array_node :formats, 'formats', 'format', class: String, default_value: []
+
+      # @!attribute [rw] version
+      #   @return [String] version number of the resource. Optional.
+      text_node :version, 'version', default_value: nil
+
+      # @!attribute [rw] rights_list
+      #   @return [Array<Rights>] rights information for this resource.
+      array_node :rights_list, 'rightsList', 'rights', class: Rights, default_value: []
+
+      # @!attribute [rw] descriptions
+      #   @return [Array<Description>] all additional information that does not fit in any of the other categories.
+      array_node :descriptions, 'descriptions', 'description', class: Description, default_value: []
+
+      # @!attribute [rw] geo_locations
+      #   @return [Array<GeoLocations>] spatial region or named place where the data was gathered or about which the data is focused.
+      array_node :geo_locations, 'geoLocations', 'geoLocation', class: GeoLocation, default_value: []
+
+      # Initialies a new {Resource}
+      #
+      # @param identifier [Identifier] a persistent identifier that identifies a resource.
+      # @param creators [Array<Creator>] the main researchers involved working on the data, or the authors of the publication in priority order.
+      # @param titles [Array<Title>] the names or titles by which a resource is known.
+      # @param publisher [String] the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
+      # @param publication_year [Integer] year when the resource is made publicly available.
+      # @param subjects [Array<Subject>] subjects, keywords, classification codes, or key phrases describing the resource.
+      # @param contributors [Array<Contributor>] institutions or persons responsible for collecting, creating, or otherwise contributing to the developement of the dataset.
+      # @param dates [Array<Date>] different dates relevant to the work.
+      # @param language [String] Primary language of the resource: an IETF BCP 47, ISO 639-1 language code.
+      #   It's unclear from the spec whether language is required; to play it safe, if it's missing, we default to 'en'.
+      # @param resource_type [ResourceType, nil] the type of the resource
+      # @param alternate_identifiers [Array<AlternateIdentifier>] an identifier or identifiers other than the primary {Identifier} applied to the resource being registered.
+      # @param related_identifiers [Array<RelatedIdentifier>] identifiers of related resources.
+      # @param sizes [Array<String>] unstructured size information about the resource.
+      # @param formats [Array<String>] technical format of the resource, e.g. file extension or MIME type.
+      # @param version [String] version number of the resource.
+      # @param rights_list [Array<Rights>] rights information for this resource.
+      # @param descriptions [Array<Description>] all additional information that does not fit in any of the other categories.
+      # @param geo_locations [Array<GeoLocations>] spatial region or named place where the data was gathered or about which the data is focused.
+      def initialize(identifier:, creators:, titles:, publisher:, publication_year:, subjects: [], contributors: [], dates: [], language: 'en', resource_type: nil, alternate_identifiers: [], related_identifiers: [], sizes: [], formats: [], version: nil, rights_list: [], descriptions: [], geo_locations: []) # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists, Metrics/AbcSize
+        self.identifier = identifier
+        self.creators = creators
+        self.titles = titles
+        self.publisher = publisher
+        self.publication_year = publication_year
+        self.subjects = subjects
+        self.contributors = contributors
+        self.dates = dates
+        self.language = language
+        self.resource_type = resource_type
+        self.alternate_identifiers = alternate_identifiers
+        self.related_identifiers = related_identifiers
+        self.sizes = sizes
+        self.formats = formats
+        self.version = version
+        self.rights_list = rights_list
+        self.descriptions = descriptions
+        self.geo_locations = geo_locations
+      end
+
+      alias_method :_language, :language
+      private :_language
+
+      alias_method :_language=, :language=
+      private :_language=
+
+      def language
+        _language || 'en'
+      end
+
+      def language=(value)
+        self._language = value.strip if value
+      end
+
+      alias_method :_identifier=, :identifier=
+      private :_identifier=
+
+      def identifier=(value)
+        fail ArgumentError, 'Resource must have an identifier' unless value
+        self._identifier = value
+      end
+
+      alias_method :_creators=, :creators=
+      private :_creators=
+
+      def creators=(value)
+        fail ArgumentError, 'Resource must have at least one creator' unless value && value.size > 0
+        self._creators = value
+      end
+
+      alias_method :_titles=, :titles=
+      private :_titles=
+
+      def titles=(value)
+        fail ArgumentError, 'Resource must have at least one title' unless value && value.size > 0
+        self._titles = value
+      end
+
+      alias_method :_publisher=, :publisher=
+      private :_publisher=
+
+      def publisher=(value)
+        fail ArgumentError, 'Resource must have at least one publisher' unless value && value.size > 0
+        self._publisher = value.strip
+      end
+
+      alias_method :_publication_year=, :publication_year=
+      private :_publication_year=
+
+      def publication_year=(value)
+        fail ArgumentError, 'Resource must have a four-digit publication year' unless value && value.to_i.between?(1000, 9999)
+        self._publication_year = value.to_i
+      end
+
+      # Overrides +::XML::Mapping.pre_save+ to write namespace information.
+      # Used for writing.
+      def pre_save(options = { mapping: :_default })
+        xml = super(options)
+        xml.add_namespace('http://datacite.org/schema/kernel-3')
+        xml.add_namespace('xsi', 'http://www.w3.org/2001/XMLSchema-instance')
+        xml.add_attribute('xsi:schemaLocation', 'http://datacite.org/schema/kernel-3 http://schema.datacite.org/meta/kernel-3/metadata.xsd')
+        xml
+      end
+
+    end
+  end
+end