datacite-mapping 0.3.0 → 0.4.0

data/lib/datacite/mapping/read_only_nodes.rb

@@ -22,12 +22,14 @@ module Datacite
 
       def value_str(val)
         return "[ #{val.map(&:to_s).join(', ')} ]" if val.is_a?(Array)
+
         "'#{val}'"
       end
 
       def obj_to_xml(obj, _xml)
         val = value_from(obj)
         return unless val
+
         warn_ignored(val)
       end
 
@@ -47,6 +49,7 @@ module Datacite
       def warn_ignored(val)
         raise ArgumentError, "Expected string, got #{val}" unless val.respond_to?(:strip)
         return if val.strip.empty?
+
         super
       end
       include ReadOnlyNodes
@@ -57,6 +60,7 @@ module Datacite
       def warn_ignored(val)
         raise ArgumentError, "Expected array, got #{val}" unless val.respond_to?(:empty?)
         return if val.empty?
+
         super
       end
       include ReadOnlyNodes

data/lib/datacite/mapping/related_identifier.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'xml/mapping_extensions'
+require 'datacite/mapping/resource_type'
 
 module Datacite
   module Mapping
@@ -37,6 +38,12 @@ module Datacite
       # @!parse IS_PREVIOUS_VERSION_OF = IsPreviousVersionOf
       new :IS_PREVIOUS_VERSION_OF, 'IsPreviousVersionOf'
 
+      # @!parse HAS_VERSION = HasVersion
+      new :HAS_VERSION, 'HasVersion'
+
+      # @!parse IS_VERSION_OF = IsVersionOf
+      new :IS_VERSION_OF, 'IsVersionOf'
+
       # @!parse IS_PART_OF = IsPartOf
       new :IS_PART_OF, 'IsPartOf'
 
@@ -82,6 +89,24 @@ module Datacite
       # @!parse IS_SOURCE_OF = IsSourceOf
       new :IS_SOURCE_OF, 'IsSourceOf'
 
+      # @!parse IS_OBSOLETED_BY = IsObsoletedBy
+      new :IS_OBSOLETED_BY, 'IsObsoletedBy'
+
+      # @!parse OBSOLETES = Obsoletes
+      new :OBSOLETES, 'Obsoletes'
+
+      # @!parse IS_DESCRIBED_BY = IsDescribedBy
+      new :IS_DESCRIBED_BY, 'IsDescribedBy'
+
+      # @!parse DESCRIBES = Describes
+      new :DESCRIBES, 'Describes'
+
+      # @!parse IS_REQUIRED_BY = IsRequiredBy
+      new :IS_REQUIRED_BY, 'IsRequiredBy'
+
+      # @!parse REQUIRES = Requires
+      new :REQUIRES, 'Requires'
+
     end
 
     # Controlled list of related identifier types.
@@ -139,11 +164,15 @@ module Datacite
 
       # @!parse IGSN = IGSN
       new :IGSN, 'IGSN'
+
+      # @!parse W3ID = w3id
+      new :W3ID, 'w3id'
     end
 
     class Datacite3RidTypeNode < XML::MappingExtensions::TypesafeEnumNode
       def to_xml_text(enum_instance)
         return super unless enum_instance == RelatedIdentifierType::IGSN
+
         super(RelatedIdentifierType::HANDLE)
       end
     end
@@ -152,6 +181,7 @@ module Datacite
     class Datacite3RidValueNode < XML::Mapping::TextNode
       def obj_to_xml(obj, xml)
         return super unless obj.identifier_type == RelatedIdentifierType::IGSN
+
         igsn_value = obj.value
         handle_value = "10273/#{igsn_value}"
         # TODO: move this somewhere more general
@@ -173,7 +203,7 @@ module Datacite
       # @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
+      def initialize(relation_type:, value:, identifier_type:, related_metadata_scheme: nil, scheme_uri: nil, scheme_type: nil)
         self.relation_type = relation_type
         self.value = value
         self.identifier_type = identifier_type
@@ -184,16 +214,19 @@ module Datacite
 
       def value=(value)
         raise ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
+
         @value = value
       end
 
       def identifier_type=(value)
         raise ArgumentError, 'Identifier type cannot be empty or nil' unless value
+
         @identifier_type = value
       end
 
       def relation_type=(value)
         raise ArgumentError, 'Relation type cannot be nil' unless value
+
         @relation_type = value
       end
 
@@ -215,6 +248,10 @@ module Datacite
       #   @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] resource_type_general
+      #    @return [ResourceTypeGeneral] the general resource type
+      typesafe_enum_node :resource_type_general, '@resourceTypeGeneral', class: ResourceTypeGeneral, 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

data/lib/datacite/mapping/resource.rb

@@ -46,7 +46,7 @@ module Datacite
       # @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 publisher [Publisher] 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 funding_references [Array<FundingReference>] information about financial support (funding) for the resource being registered.
@@ -62,7 +62,7 @@ module Datacite
       # @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: nil, funding_references: [], resource_type: nil, alternate_identifiers: [], related_identifiers: [], sizes: [], formats: [], version: nil, rights_list: [], descriptions: [], geo_locations: []) # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists, Metrics/AbcSize
+      def initialize(identifier:, creators:, titles:, publisher:, publication_year:, subjects: [], contributors: [], dates: [], language: nil, funding_references: [], resource_type: nil, alternate_identifiers: [], related_identifiers: [], sizes: [], formats: [], version: nil, rights_list: [], descriptions: [], geo_locations: []) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         self.identifier = identifier
         self.creators = creators
         self.titles = titles
@@ -94,27 +94,37 @@ module Datacite
 
       def identifier=(value)
         raise ArgumentError, 'Resource must have an identifier' unless value
+
         @identifier = value
       end
 
       def creators=(value)
         raise ArgumentError, 'Resource must have at least one creator' unless value && !value.empty?
+
         @creators = value
       end
 
       def titles=(value)
         raise ArgumentError, 'Resource must have at least one title' unless value && !value.empty?
+
         @titles = value
       end
 
+      # publisher can be entered as a string or a Publisher object, but it will be stored
+      # as a Publisher object
       def publisher=(value)
-        new_value = value&.strip
-        raise ArgumentError, 'Resource must have a publisher' unless new_value && !new_value.empty?
-        @publisher = new_value.strip
+        raise ArgumentError, 'Publisher must have a value' unless value
+
+        @publisher = if value.is_a?(Publisher)
+                       value
+                     else
+                       Publisher.new(value: value)
+                     end
       end
 
       def publication_year=(value)
-        raise ArgumentError, 'Resource must have a four-digit publication year' unless value && value.to_i.between?(1000, 9999)
+        raise ArgumentError, 'Resource must have a four-digit publication year' unless value&.to_i&.between?(1000, 9999)
+
         @publication_year = value.to_i
       end
 
@@ -151,7 +161,7 @@ module Datacite
       end
 
       def version=(value)
-        new_value = value && value.to_s
+        new_value = value&.to_s
         @version = new_value&.strip
       end
 
@@ -180,8 +190,12 @@ module Datacite
       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'
+      #   @return [Publisher] the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
+      object_node :publisher, 'publisher', class: Publisher
+
+      # @!attribute [rw] resource_type
+      #   @return [ResourceType, nil] the type of the resource
+      object_node :resource_type, 'resourceType', class: ResourceType, default_value: nil
 
       # @!attribute [rw] publication_year
       #   @return [Integer] year when the resource is made publicly available.
@@ -246,14 +260,14 @@ module Datacite
       # Convenience method to get the creators' names.
       # @return [[Array[String]] An array of the creators' names.
       def creator_names
-        creators.map(&:name)
+        creators.map { |c| c&.creator_name&.value }
       end
 
       # Convenience method to get the creators' affiliations. (Bear in mind that each creator
       # can have multiple affiliations.)
       # @return [Array[Array[String]]] An array containing each creator's array of affiliations.
       def creator_affiliations
-        creators.map(&:affiliations)
+        creators.map(&:affiliation_names)
       end
 
       # Convenience method to get the funding contributor.

data/lib/datacite/mapping/resource_type.rb

@@ -16,6 +16,9 @@ module Datacite
       # @!parse DATASET = Dataset
       new :DATASET, 'Dataset'
 
+      # @!parse DATA_PAPER = DataPaper
+      new :DATA_PAPER, 'DataPaper'
+
       # @!parse EVENT = Event
       new :EVENT, 'Event'
 
@@ -65,6 +68,7 @@ module Datacite
 
       def resource_type_general=(val)
         raise ArgumentError, 'General resource type cannot be nil' unless val
+
         @resource_type_general = val
       end
 

data/lib/datacite/mapping/rights.rb

@@ -12,24 +12,51 @@ module Datacite
       # 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:)
+      # @param identifier [String, nil] Optional.
+      # @param identifier_scheme [String, nil] Optional.
+      # @param scheme_url [URI, nil] Optional.
+      # @param language [String, nil] Optional.
+      # @param value [String] a rights statement.
+      def initialize(uri: nil, identifier: nil, identifier_scheme: nil, scheme_uri: nil, language: nil, value: nil)
         self.uri = uri
+        self.identifier = identifier
+        self.identifier_scheme = identifier_scheme
+        self.scheme_uri = scheme_uri
+        self.language = language
         self.value = value
       end
 
-      def value=(v)
-        raise ArgumentError, 'Value cannot be empty or nil' unless v && !v.empty?
-        @value = v.strip
+      def language=(value)
+        @language = value&.strip
+      end
+
+      def value=(new_value)
+        @value = new_value&.strip
       end
 
       # @!attribute [rw] uri
       #   @return [URI, nil] a URI for the license. Optional.
       uri_node :uri, '@rightsURI', default_value: nil
 
+      # @!attribute [rw] language
+      #   @return [String, nil] an IETF BCP 47, ISO 639-1 language code identifying the language.
+      text_node :language, '@xml:lang', default_value: nil
+
+      # @!attribute [rw] identifier
+      #   @return [String, nil] an identifier for the rights setting. Optional.
+      text_node :identifier, '@rightsIdentifier', default_value: nil
+
+      # @!attribute [rw] identifier_scheme
+      #   @return [String, nil] an identifier for the rights scheme. Optional.
+      text_node :identifier_scheme, '@rightsIdentifierScheme', default_value: nil
+
+      # @!attribute [rw] scheme_uri
+      #   @return [URI, nil] a URI for the rights scheme. Optional.
+      uri_node :scheme_uri, '@schemeURI', default_value: nil
+
       # @!attribute [rw] value
       #   @return [String] the rights statement. Cannot be empty or nil.
-      text_node :value, 'text()'
+      text_node :value, 'text()', default_value: nil
 
       fallback_mapping :datacite_3, :_default
     end

data/lib/datacite/mapping/subject.rb

@@ -25,9 +25,10 @@ module Datacite
         @language = value&.strip
       end
 
-      def value=(v)
-        new_value = v&.strip
+      def value=(value)
+        new_value = value&.strip
         raise ArgumentError, 'Value cannot be empty or nil' unless new_value && !new_value.empty?
+
         @value = new_value
       end
 

data/lib/datacite/mapping/title.rb

@@ -36,9 +36,10 @@ module Datacite
         @language = value&.strip
       end
 
-      def value=(v)
-        new_value = v&.strip
+      def value=(value)
+        new_value = value&.strip
         raise ArgumentError, 'Value cannot be empty or nil' unless new_value && !new_value.empty?
+
         @value = new_value.strip
       end
 

data/spec/data/datacite4/{datacite-example-Box_dateCollected_DataCollector-v4.0.xml → datacite-example-Box_dateCollected_DataCollector-v4.xml}

@@ -3,25 +3,23 @@
   <identifier identifierType="DOI">10.5072/DataCollector_dateCollected_geoLocationBox</identifier>
   <creators>
     <creator>
-      <creatorName>Peach, A.</creatorName>
+      <creatorName nameType="Personal">Peach, A.</creatorName>
     </creator>
   </creators>
   <titles>
-    <title>
-      Temperature and Humidity in School Classrooms, Ponhook Lake, N.S., 1961-1962
-    </title>
+    <title xml:lang="en">Temperature and Humidity in School Classrooms, Ponhook Lake, N.S., 1961-1962</title>
   </titles>
-  <publisher>National Research Council Canada</publisher>
+  <publisher xml:lang="en">National Research Council Canada</publisher>
   <publicationYear>1963</publicationYear>
   <subjects>
-    <subject schemeURI="http://lccn.loc.gov/sh85062931" subjectScheme="LCCN">Temperature</subject>
-    <subject schemeURI="http://lccn.loc.gov/sh85133712" subjectScheme="LCCN">Humidity</subject>
-    <subject schemeURI="http://lccn.loc.gov/sh88003345" subjectScheme="LCCN">Classrooms</subject>
-    <subject>Ponhook Lake (N.S.)</subject>
+    <subject xml:lang="en" schemeURI="http://lccn.loc.gov/sh85062931" subjectScheme="LCCN">Temperature</subject>
+    <subject xml:lang="en" schemeURI="http://lccn.loc.gov/sh85133712" subjectScheme="LCCN">Humidity</subject>
+    <subject xml:lang="en" schemeURI="http://lccn.loc.gov/sh88003345" subjectScheme="LCCN">Classrooms</subject>
+    <subject xml:lang="en">Ponhook Lake (N.S.)</subject>
   </subjects>
   <contributors>
     <contributor contributorType="DataCollector">
-      <contributorName>Pomegranate, B.</contributorName>
+      <contributorName nameType="Personal">Pomegranate, B.</contributorName>
     </contributor>
   </contributors>
   <dates>
@@ -33,7 +31,7 @@
     <size>10 p.</size>
   </sizes>
   <descriptions>
-    <description descriptionType="Abstract">
+    <description xml:lang="en" descriptionType="Abstract">
       The Division has been taking records of temperatures and humidities in groups of houses at various locations in Canada over the past several years. This survey has more recently been extended to include schools. Records obtained from classrooms in
       six schools in Ponhook Lake, Nova Scotia from June 1, 1961-October 12, 1962 are now reported.
     </description>

data/spec/data/datacite4/{datacite-example-GeoLocation-v4.0.xml → datacite-example-GeoLocation-v4.xml}

@@ -3,32 +3,33 @@
   <identifier identifierType="DOI">10.5072/geoPointExample</identifier>
   <creators>
     <creator>
-      <creatorName>Schumann, Kai</creatorName>
+      <creatorName nameType="Personal">Schumann, Kai</creatorName>
     </creator>
     <creator>
-      <creatorName>Völker, David</creatorName>
+      <creatorName nameType="Personal">Völker, David</creatorName>
     </creator>
     <creator>
-      <creatorName>Weinrebe, Wilhelm Reiber</creatorName>
+      <creatorName nameType="Personal">Weinrebe, Wilhelm Reiber</creatorName>
     </creator>
   </creators>
   <titles>
-    <title>
+    <title xml:lang="en">
       Gridded results of swath bathymetric mapping of Disko Bay, Western Greenland, 2007-2008
     </title>
   </titles>
-  <publisher>
+  <publisher xml:lang="en">
     PANGAEA - Data Publisher for Earth &amp; Environmental Science
   </publisher>
   <publicationYear>2011</publicationYear>
   <subjects>
-    <subject subjectScheme="DDC">551 Geology, hydrology, meteorology</subject>
+    <subject xml:lang="en" subjectScheme="DDC">551 Geology, hydrology, meteorology</subject>
   </subjects>
   <contributors>
     <contributor contributorType="HostingInstitution">
-      <contributorName>
+      <contributorName nameType="Organizational">
         IFM-GEOMAR Leibniz-Institute of Marine Sciences, Kiel University
       </contributorName>
+      <nameIdentifier nameIdentifierScheme="ROR" schemeURI="http://ror.org/">https://ror.org/02h2x0161</nameIdentifier>
     </contributor>
   </contributors>
   <language>en</language>
@@ -43,10 +44,10 @@
     <format>application/zip</format>
   </formats>
   <rightsList>
-    <rights rightsURI="http://creativecommons.org/licenses/by/3.0/deed">Creative Commons Attribution 3.0 Unported</rights>
-  </rightsList>
+    <rights xml:lang="en-US" schemeURI="https://spdx.org/licenses/" rightsIdentifierScheme="SPDX" rightsIdentifier="
+CC-BY-3.0"  rightsURI="http://creativecommons.org/licenses/by/3.0/deed">Creative Commons Attribution-NoDerivs 2.0 Generic</rights></rightsList>
   <descriptions>
-    <description descriptionType="Abstract">
+    <description xml:lang="en" 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 hat 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

data/spec/data/datacite4/{datacite-example-HasMetadata-v4.0.xml → datacite-example-HasMetadata-v4.xml}

@@ -3,24 +3,32 @@
   <identifier identifierType="DOI">10.5072/example</identifier>
   <creators>
     <creator>
-      <creatorName>Mari, Bernard</creatorName>
+      <creatorName nameType="Personal">Mari, Bernard</creatorName>
+      <givenName>Bernard</givenName>
+      <familyName>Mari</familyName>
     </creator>
     <creator>
-      <creatorName>Puissegur, Marie-Pierre</creatorName>
+      <creatorName nameType="Personal">Puissegur, Marie-Pierre</creatorName>
+      <givenName>Marie-Pierre</givenName>
+      <familyName>Puissegur</familyName>
     </creator>
     <creator>
-      <creatorName>Barbry, Pascal</creatorName>
+      <creatorName nameType="Personal">Barbry, Pascal</creatorName>
+      <givenName>Pascal</givenName>
+      <familyName>Barbry</familyName>
     </creator>
     <creator>
-      <creatorName>Lebrigand, Kevin</creatorName>
+      <creatorName nameType="Personal">Lebrigand, Kevin</creatorName>
+      <givenName>Kevin</givenName>
+      <familyName>Lebrigand</familyName>
     </creator>
   </creators>
   <titles>
-    <title>
+    <title xml:lang="en">
       Identification of putative novel specific targets of mir-210 in A549 human adenocarcinoma cells
     </title>
   </titles>
-  <publisher>
+  <publisher xml:lang="fr">
     Institut de Pharmacologie Moleculaire et Cellulaire (IPMC), CNRS UMR6097, Universite de Nice Sophia-Antipolis, 660 route des lucioles, 06560 Valbonne - Sophia-Antipolis, France
   </publisher>
   <publicationYear>2010</publicationYear>
@@ -33,10 +41,10 @@
   </subjects>
   <contributors>
     <contributor contributorType="HostingInstitution">
-      <contributorName>INIST-CNRS</contributorName>
+      <contributorName xml:lang="fr" nameType="Organizational">INIST-CNRS</contributorName>
     </contributor>
   </contributors>
-  <language>eng</language>
+  <language>en</language>
   <resourceType resourceTypeGeneral="Text">Experiment report</resourceType>
   <relatedIdentifiers>
     <relatedIdentifier relatedIdentifierType="URL" relatedMetadataScheme="ISA-Tab" relationType="HasMetadata" schemeType="Text" schemeURI="http://isatab.sourceforge.net/docs/ISA-TAB_release-candidate-1_v1.0_24nov08.pdf">http://www.ncbi.nlm.nih.gov/geo/query/acc.cgi?acc=GSE18695</relatedIdentifier>
@@ -49,12 +57,9 @@
     <format>PDF</format>
   </formats>
   <rightsList>
-    <rights rightsURI="http://creativecommons.org/licenses/by-nc-nd/3.0/">
-      Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported
-    </rights>
-  </rightsList>
+    <rights xml:lang="en-US" schemeURI="https://spdx.org/licenses/"   rightsIdentifierScheme="SPDX" rightsIdentifier="CC-BY-NC-ND-3.0"  rightsURI="http://creativecommons.org/licenses/by-nc-nd/3.0/"/>  </rightsList>
   <descriptions>
-    <description descriptionType="Abstract">
+    <description xml:lang="en" descriptionType="Abstract">
       To identify putative novel specific targets of mir-210, we overexpressed miR-210 as well as miR-34a and a siRNA targeted against E2F3 in A549 human adenocarcinoma cells by transfecting them with synthetic pre-miRNAs or a synthetic negative pre-miRNA
       as control (miR-Neg). RNA samples were harvested at 48 hours post-transfection and 2 independent experiments performed in dye-swap: miR-210 versus miR-Neg ; miR-34a versus miR-Neg ; si-E2F3 versus miR-Neg ; si-control versus miR-Neg.
     </description>