datacite-mapping 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c6c6c78e95b15168e1d50cca76a43313c568e96f
-  data.tar.gz: '08f1de9f06449584c9b4bab11139cd0e79882bf0'
+SHA256:
+  metadata.gz: 735d8cc7ab80f9534cba40b1b46b38b15dc8124f4e0cd53bb1963c5b31b2a9c2
+  data.tar.gz: f052e557983ea3af4ea3c025db12daa93ad5e60253f3e427c0cfe1ee39277bf1
 SHA512:
-  metadata.gz: 4d2b532ba6cb94d49403bebcef4afb565c7baee59c6ae43725b74fdbd9f6a40dd08ac88e68c2e907db47bab444352dc7c7d52046a2944341ca3df386cf088def
-  data.tar.gz: c69fc51f41731b7fd77692cf70714e8072ebfc0d3f847a24ee345428a2c382a3f2f901c5483c1d0ac26f2b0108c8081f9f4814ee92fe935556f7c84a8019e211
+  metadata.gz: 21645ef65182b9800dd3657188d31dc38a2ce148a910853d667eacaebf20dd334bdcd2ee34c32b85dd5bfa8b681b47a9380b0ab600367af5750a39c80c4ddf35
+  data.tar.gz: 33c2ff60458e0c835c086b2eff99e5198b26e0783ef483444418cd74e98f715ff4f149534e979fa5f124044924f5ad781088021ca56ad867a0af5ae89fe8c286

data/.rubocop.yml

@@ -2,6 +2,10 @@
 Metrics/LineLength:
   Enabled: False
 
+# Disable parameter-length check; this is determined by the number of XML attributes defined in the DataCite schema
+Metrics/ParameterLists:
+  Enabled: False
+
 # Disable problematic module documentation check (see https://github.com/bbatsov/rubocop/issues/947)
 Style/Documentation:
   Enabled: false

data/CHANGES.md

@@ -1,3 +1,18 @@
+## 0.4.0 (12 November 2019
+
+- Datacite 4.3 support:
+  - Added the new elements and attributes introduced in DataCite 4.1, 4.2, and 4.3.
+  - Updated sample DataCite XML documents to include the new examples introduced in DataCite 4.3.
+  - Reading from XML still supports any version of the DataCite schema from 3.0 through 4.3.
+  - Object mapping for some items was updated to use full objects instead of simple Strings
+    when the DataCite schema introduced more complicated structure. E.g., because ContributorName
+    can now include a nameType and an xml:lang, the simple "name" String in the Contributor object was
+    replaced with a ContributorName object, accessed through Contributor.contributor_name, while
+    Contributor.name is now a convenience method that allows access to the value as a String.
+- These updates to the gem are fully backwards compatible with respect to the input/output XML, but some changes in the object 
+  model were required to support the more complex XML. So ruby code that worked with version 0.3.0 will require minor updates to use
+  this version.
+
 ## 0.3.0 (2 January 2018)
 
 - Update to Ruby 2.4.1

data/README.md

@@ -10,9 +10,14 @@ based on [xml-mapping](http://multi-io.github.io/xml-mapping/) and
 [xml-mapping_extensions](https://github.com/dmolesUC3/xml-mapping_extensions).
 Full API documentation on [RubyDoc.info](http://www.rubydoc.info/github/CDLUC3/datacite-mapping/master/frames).
 
-Supports [Datacite 4.0](https://schema.labs.datacite.org/meta/kernel-4.0/); backward-compatible with 
+Supports [Datacite 4.3](https://schema.labs.datacite.org/meta/kernel-4.3/); backward-compatible with 
 [Datacite 3.1](https://schema.labs.datacite.org/meta/kernel-3/).
 
+Note that although this gem maintains compatibility with multiple
+versions of DataCite XML, changes to DataCite XML sometimes force
+changes to the internal object model of the gem. So different versions
+of this gem may require minor updates to how a part of the model is accessed.
+
 ## Usage
 
 The core of the Datacite::Mapping library is the `Resource` class, corresponding to the root `<resource/>` element
@@ -37,13 +42,13 @@ Example:
 require 'datacite/mapping'
 include Datacite::Mapping
 
-resource = Resource.load_from_file('datacite-example-full-v4.0.xml')
+resource = Resource.load_from_file('datacite-example-full-v4.3.xml')
 # => #<Datacite::Mapping::Resource:0x007f97689e87a0 …
 
 abstract = resource.descriptions.find { |d| d.type = DescriptionType::ABSTRACT }
 # => #<Datacite::Mapping::Description:0x007f976aafa330 …
 abstract.value
-# => "XML example of all DataCite Metadata Schema v4.0 properties."
+# => "XML example of all DataCite Metadata Schema v4.3 properties."
 ```
 
 Note that Datacite::Mapping uses the [TypesafeEnum](https://github.com/dmolesUC3/typesafe_enum) gem to represent controlled 

data/datacite-mapping.gemspec

@@ -1,13 +1,12 @@
-
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'uri'
 require 'datacite/mapping/module_info'
 
-Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
   spec.name          = Datacite::Mapping::NAME
   spec.version       = Datacite::Mapping::VERSION
   spec.authors       = ['David Moles']

data/lib/datacite/mapping.rb

@@ -19,7 +19,7 @@ module Datacite
       schema_location: 'http://schema.datacite.org/meta/kernel-4/metadata.xsd'
     )
 
-    Dir.glob(File.expand_path('../mapping/*.rb', __FILE__)).sort.each(&method(:require))
+    Dir.glob(File.expand_path('mapping/*.rb', __dir__)).sort.each(&method(:require))
 
   end
 end

data/lib/datacite/mapping/affiliation.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'xml/mapping'
+require 'datacite/mapping/read_only_nodes'
+
+module Datacite
+  module Mapping
+    class Affiliation
+      include XML::Mapping
+
+      def initialize(identifier: nil, identifier_scheme: nil, scheme_uri: nil, value:)
+        self.identifier = identifier
+        self.identifier_scheme = identifier_scheme
+        self.scheme_uri = scheme_uri
+        self.value = value
+      end
+
+      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
+
+      # @!attribute [rw] identifier
+      #   @return [String, nil] The affiliation identifier. Optional.
+      text_node :identifier, '@affiliationIdentifier', default_value: nil
+
+      # @!attribute [rw] identifier_scheme
+      #   @return [String, nil] The scheme for the affiliation identifier. Optional.
+      text_node :identifier_scheme, '@affiliationIdentifierScheme', default_value: nil
+
+      # @!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 name itself.
+      text_node :value, 'text()'
+
+      fallback_mapping :datacite_3, :_default
+    end
+  end
+end

data/lib/datacite/mapping/alternate_identifier.rb

@@ -22,6 +22,7 @@ module Datacite
       # @param val [String] the identifier type
       def type=(val)
         raise ArgumentError, 'No identifier type provided' unless val
+
         @type = val
       end
 
@@ -29,6 +30,7 @@ module Datacite
       # @param val [String] the value
       def value=(val)
         raise ArgumentError, 'No identifier value provided' unless val
+
         @value = val
       end
 

data/lib/datacite/mapping/contributor.rb

@@ -2,6 +2,7 @@
 
 require 'xml/mapping_extensions'
 require 'datacite/mapping/name_identifier'
+require 'datacite/mapping/contributor_name'
 
 module Datacite
   module Mapping
@@ -93,20 +94,45 @@ module Datacite
         self.type = type
       end
 
+      # name can be entered as a string or a ContributorName object, but it will be stored
+      # internally as a ContributorName object
       def name=(value)
-        new_value = value&.strip
-        raise ArgumentError, 'Name cannot be empty or nil' unless new_value && !new_value.empty?
-        @name = new_value
+        raise ArgumentError, 'Name cannot be empty or nil' unless value
+
+        @contributor_name = if value.is_a?(ContributorName)
+                              value
+                            else
+                              ContributorName.new(value: value)
+                            end
+      end
+
+      def contributor_name=(value)
+        raise ArgumentError, 'ContributorName cannot be empty or nil' unless value
+
+        @contributor_name = value
+      end
+
+      def name
+        @contributor_name&.value
       end
 
       def type=(value)
         raise ArgumentError, 'Type cannot be nil' unless value
+
         @type = value
       end
 
       # @!attribute [rw] name
-      #   @return [String] the personal name of the contributor, in the format `Family, Given`. Cannot be empty or nil
-      text_node :name, 'contributorName'
+      #   @return [String] The personal name of the creator, in the format `Family, Given`. Cannot be empty or nil.
+      object_node :contributor_name, 'contributorName', class: ContributorName
+
+      # @!attribute [rw] given_name
+      #   @return [String, nil] The given name of the creator. Optional.
+      text_node :given_name, 'givenName', default_value: nil
+
+      # @!attribute [rw] family_name
+      #   @return [String, nil] The family name of the creator. Optional.
+      text_node :family_name, 'familyName', default_value: nil
 
       # @!attribute [rw] identifier
       #   @return [NameIdentifier, nil] an identifier for the contributor. Optional.
@@ -114,7 +140,7 @@ module Datacite
 
       # @!attribute [rw] affiliations
       #   @return [Array<String>] the contributor's affiliations. Defaults to an empty list.
-      array_node :affiliations, 'affiliation', class: String, default_value: []
+      array_node :affiliations, 'affiliation', class: Affiliation, default_value: []
 
       # @!attribute [rw] type
       #   @return [ContributorType] the contributor type. Cannot be nil.

data/lib/datacite/mapping/contributor_name.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'xml/mapping'
+require 'datacite/mapping/read_only_nodes'
+require 'datacite/mapping/name_identifier'
+require 'datacite/mapping/name_type'
+
+module Datacite
+  module Mapping
+    class ContributorName
+      include XML::Mapping
+      def initialize(type: nil, language: nil, value:)
+        self.type = type
+        self.language = language
+        self.value = value
+      end
+
+      def language=(value)
+        @language = value&.strip
+      end
+
+      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
+
+      # @!attribute [rw] type
+      #   @return [NameType, nil] the name type. Optional.
+      typesafe_enum_node :type, '@nameType', class: NameType, 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] value
+      #   @return [String] the name itself.
+      text_node :value, 'text()'
+    end
+  end
+end

data/lib/datacite/mapping/creator.rb

@@ -3,9 +3,12 @@
 require 'xml/mapping'
 require 'datacite/mapping/read_only_nodes'
 require 'datacite/mapping/name_identifier'
+require 'datacite/mapping/creator_name'
+require 'datacite/mapping/affiliation'
 
 module Datacite
   module Mapping
+
     # The main researchers involved working on the data, or the authors of the publication in priority order.
     class Creator
       include XML::Mapping
@@ -15,7 +18,7 @@ module Datacite
       # @param given_name [String, nil] The given name of the creator. Optional.
       # @param given_name [String, nil] The family name of the creator. Optional.
       # @param identifier [NameIdentifier, nil] An identifier for the creator. Optional.
-      # @param affiliations [Array<String>, nil] The creator's affiliations. Defaults to an empty list.
+      # @param affiliations [Array<Affiliation>, nil] The creator's affiliations. Defaults to an empty list.
       def initialize(name:, given_name: nil, family_name: nil, identifier: nil, affiliations: [])
         self.name = name
         self.given_name = given_name
@@ -24,10 +27,26 @@ module Datacite
         self.affiliations = affiliations
       end
 
+      # name can be entered as a string or a CreatorName object, but it will be stored
+      # internally as a CreatorName object
       def name=(value)
-        new_value = value&.strip
-        raise ArgumentError, 'Name cannot be empty or nil' unless new_value && !new_value.empty?
-        @name = new_value
+        raise ArgumentError, 'Name cannot be empty or nil' unless value
+
+        @creator_name = if value.is_a?(CreatorName)
+                          value
+                        else
+                          CreatorName.new(value: value)
+                        end
+      end
+
+      def creator_name=(value)
+        raise ArgumentError, 'CreatorName cannot be empty or nil' unless value
+
+        @creator_name = value
+      end
+
+      def name
+        @creator_name&.value
       end
 
       def given_name=(value)
@@ -40,13 +59,26 @@ module Datacite
         @family_name = new_value
       end
 
+      # Affiliations can be entered as an array of Strings or an array of Affiliation objects,
+      # but will be stored internally as an array of Affiliation objects
       def affiliations=(value)
-        @affiliations = value || []
+        @affiliations = []
+        value&.each do |affil|
+          @affiliations << if affil.is_a?(Affiliation)
+                             affil
+                           else
+                             Affiliation.new(value: affil)
+                           end
+        end
+      end
+
+      def affiliation_names
+        @affiliations.map { |affil| affil&.value }
       end
 
       # @!attribute [rw] name
       #   @return [String] The personal name of the creator, in the format `Family, Given`. Cannot be empty or nil.
-      text_node :name, 'creatorName'
+      object_node :creator_name, 'creatorName', class: CreatorName
 
       # @!attribute [rw] given_name
       #   @return [String, nil] The given name of the creator. Optional.
@@ -62,7 +94,7 @@ module Datacite
 
       # @!attribute [rw] affiliations
       #   @return [Array<String>, nil] The creator's affiliations. Defaults to an empty list.
-      array_node :affiliations, 'affiliation', class: String, default_value: []
+      array_node :affiliations, 'affiliation', class: Affiliation, default_value: []
 
       use_mapping :datacite_3
 

data/lib/datacite/mapping/creator_name.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'xml/mapping'
+require 'datacite/mapping/read_only_nodes'
+require 'datacite/mapping/name_identifier'
+require 'datacite/mapping/name_type'
+
+module Datacite
+  module Mapping
+    class CreatorName
+      include XML::Mapping
+      def initialize(type: nil, language: nil, value:)
+        self.type = type
+        self.language = language
+        self.value = value
+      end
+
+      def language=(value)
+        @language = value&.strip
+      end
+
+      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
+
+      # @!attribute [rw] type
+      #   @return [NameType, nil] the name type. Optional.
+      typesafe_enum_node :type, '@nameType', class: NameType, default_value: nil
+
+      # @!attribute [rw] language
+      #   @return [String] an IETF BCP 47, ISO 639-1 language code identifying the language.
+      text_node :language, '@xml:lang', default_value: nil
+
+      # @!attribute [rw] value
+      #   @return [String] the name itself.
+      text_node :value, 'text()'
+    end
+  end
+end

data/lib/datacite/mapping/date.rb

@@ -27,6 +27,9 @@ module Datacite
       # @!parse ISSUED = Issued
       new :ISSUED, 'Issued'
 
+      # @!parse OTHER = Other
+      new :OTHER, 'Other'
+
       # @!parse SUBMITTED = Submitted
       new :SUBMITTED, 'Submitted'
 
@@ -36,6 +39,9 @@ module Datacite
       # @!parse VALID = Valid
       new :VALID, 'Valid'
 
+      # @!parse WITHDRAWN = Withdrawn
+      new :WITHDRAWN, 'Withdrawn'
+
     end
 
     # Represents a DataCite `<date/>` field, which can be a year, date (year-month-day or just year-month),
@@ -70,6 +76,7 @@ module Datacite
 
       def type=(val)
         raise ArgumentError, 'Date type cannot be nil' unless val
+
         @type = val
       end
 
@@ -89,6 +96,7 @@ module Datacite
 
       def <=>(other)
         return nil unless other.class == self.class
+
         %i[date_value range_start range_end type].each do |v|
           order = send(v) <=> other.send(v)
           return order if order.nonzero?
@@ -108,6 +116,10 @@ module Datacite
       #  @return [DateType] the type of date. Cannot be nil.
       typesafe_enum_node :type, '@dateType', class: DateType
 
+      # @!attribute [rw] date_information
+      #   @return [String] information to clarify a date
+      text_node :date_information, '@dateInformation', default_value: nil
+
       # @!method value
       #   @return [String] The value as a string. May be any [W3C DateTime format](http://www.w3.org/TR/NOTE-datetime).
       text_node :value, 'text()'