datacite-mapping 0.2.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e8d570ed19b36949ccbd477c42b99eb16decca70
-  data.tar.gz: 3f9608fb7b9520b69bfc5a4f802d36d3cfeba96b
+SHA256:
+  metadata.gz: 8775fcefefd2e9b7d31347a04a0495018109f239f1710c45a909c0c6a00f3a7d
+  data.tar.gz: 2d2ff543b99b85846be3c8d322f41967038cb836b83e2d8db6dba3ff7bafb4d8
 SHA512:
-  metadata.gz: 1a4d62507b31e9a3c3086ae9a4f2721c7e8539d0e08d49ccff037e85eaca7a2b740d3055791ba81f8df5589e01ca0ab04d90beec3881c979039a58f874a06a4a
-  data.tar.gz: 56f0d8270aca2b12cca28998fca293490d8cb30ff89f4af1274fbb571bb81bd1a99d50f978cf42b6e1532ec4e573ebdecaf8e5b067978d5bc5dfb1b6b839cfeb
+  metadata.gz: 54c5fc88e7ec891b088feff0022dcf89b8cbe8408e1fe6e2de6de76695e5c074397061210378a22c51d1db6653eccd07fe01076fea6807e49d199b8b73c98f90
+  data.tar.gz: 419006f6182826184d8a009552aac66aa59355422e679c43c56ce6b6f399fe21507b2c170800ddc5633135f49171cba54734c3f6fe9d70fc3a741d598594afd4

data/.rubocop.yml

@@ -1,28 +1,44 @@
-# 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 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
 
-# Allow one line around class body (Style/EmptyLines will still disallow two or more)
-Style/EmptyLinesAroundClassBody:
+# Allow one line around class body (Layout/EmptyLines will still disallow two or more)
+Layout/EmptyLinesAroundClassBody:
   Enabled: false
 
-# Allow one line around module body (Style/EmptyLines will still disallow two or more)
-Style/EmptyLinesAroundModuleBody:
+# Allow one line around module body (Layout/EmptyLines will still disallow two or more)
+Layout/EmptyLinesAroundModuleBody:
   Enabled: false
 
-# Allow one line around block body (Style/EmptyLines will still disallow two or more)
-Style/EmptyLinesAroundBlockBody:
+# Allow one line around block body (Layout/EmptyLines will still disallow two or more)
+Layout/EmptyLinesAroundBlockBody:
   Enabled: false
 
 # Allow leading underscores for 'internal' accessors
 Lint/UnderscorePrefixedVariableName:
   Enabled: false
+
+# Seriously?
+Style/CommentedKeyword:
+  Enabled: false
+
+# Use DateTime to preserve compatibility
+Style/DateTime:
+  Enabled: false
+
+# Disable some checks in sample code
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'examples/*'
+
+Style/MixinUsage:
+  Exclude:
+    - 'examples/*'

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.6.6

data/CHANGES.md

@@ -1,3 +1,28 @@
+## 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
+- Update to RuboCop 0.52
+
+## 0.2.5 (10 January 2017)
+
+- Update to Ruby 2.2.5
+- Treat blank or empty award number as nil when constructing a `FundingReference`.
+
 ## 0.2.4 (8 November 2016)
 
 - Fix issue where writing a resource in Datacite 3 would cause the Datacite 3 namespace

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 The Regents of the University of California
+Copyright (c) 2018 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

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,17 +42,17 @@ 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` gem to represent controlled vocabularies such
-as [ResourceTypeGeneral](http://www.rubydoc.info/github/CDLUC3/datacite-mapping/master/Datacite/Mapping/ResourceTypeGeneral)
+Note that Datacite::Mapping uses the [TypesafeEnum](https://github.com/dmolesUC3/typesafe_enum) gem to represent controlled 
+vocabularies such as [ResourceTypeGeneral](http://www.rubydoc.info/github/CDLUC3/datacite-mapping/master/Datacite/Mapping/ResourceTypeGeneral)
 and [DescriptionType](http://www.rubydoc.info/github/CDLUC3/datacite-mapping/master/Datacite/Mapping/DescriptionType).
 
 ### Writing

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ------------------------------------------------------------
 # RSpec
 
@@ -8,7 +10,7 @@ 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.rspec_opts = %w[--color --format documentation --order default]
     task.pattern = 'unit/**/*_spec.rb'
   end
 
@@ -38,7 +40,7 @@ RuboCop::RakeTask.new
 
 desc 'List TODOs (from spec/todo.rb)'
 RSpec::Core::RakeTask.new(:todo) do |task|
-  task.rspec_opts = %w(--color --format documentation --order default)
+  task.rspec_opts = %w[--color --format documentation --order default]
   task.pattern = 'todo.rb'
 end
 
@@ -46,4 +48,4 @@ end
 # Defaults
 
 desc 'Run unit tests, check test coverage, run acceptance tests, check code style'
-task default: [:coverage, :rubocop]
+task default: %i[coverage rubocop]

data/datacite-mapping.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'uri'
@@ -15,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   origin = `git config --get remote.origin.url`.chomp
-  origin_uri = origin.start_with?('http') ? URI(origin) : URI(origin.sub('git@github.com:', 'https://github.com/'))
+  origin_uri = origin.start_with?('http') ? URI(origin) : URI(origin.gsub(%r{git@([^:]+)(.com|.org)[^\/]+}, 'http://\1\2'))
   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")
@@ -27,14 +28,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'typesafe_enum', '~> 0.1', '>= 0.1.7'
   spec.add_dependency 'xml-mapping_extensions', '~> 0.4', '>= 0.4.7'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler', '>= 2.2.33'
   spec.add_development_dependency 'equivalent-xml', '~> 0.6.0'
-  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'github-markup', '~> 1.4'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'redcarpet', '~> 3.3'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
   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 'redcarpet', '~> 3.3'
-  spec.add_development_dependency 'github-markup', '~> 1.4'
-  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

data/examples/reading.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# coding: UTF-8
+# frozen_string_literal: true
 
 require 'datacite/mapping'
 include Datacite::Mapping

data/examples/writing.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'datacite/mapping'
 include Datacite::Mapping

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -19,14 +21,16 @@ module Datacite
       # Sets the type. Cannot be nil.
       # @param val [String] the identifier type
       def type=(val)
-        fail ArgumentError, 'No identifier type provided' unless val
+        raise ArgumentError, 'No identifier type provided' unless val
+
         @type = val
       end
 
       # Sets the value. Cannot be nil.
       # @param val [String] the value
       def value=(val)
-        fail ArgumentError, 'No identifier value provided' unless val
+        raise ArgumentError, 'No identifier value provided' unless val
+
         @value = val
       end
 

data/lib/datacite/mapping/contributor.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 require 'datacite/mapping/name_identifier'
+require 'datacite/mapping/contributor_name'
 
 module Datacite
   module Mapping
@@ -91,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 && value.strip
-        fail 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)
-        fail ArgumentError, 'Type cannot be nil' unless 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.
@@ -112,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

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
+
 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
@@ -13,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
@@ -22,29 +27,58 @@ 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 && value.strip
-        fail 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)
-        new_value = value && value.strip
+        new_value = value&.strip
         @given_name = new_value
       end
 
       def family_name=(value)
-        new_value = value && value.strip
+        new_value = value&.strip
         @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.
@@ -60,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 require 'datacite/mapping/date_value'
@@ -25,6 +27,9 @@ module Datacite
       # @!parse ISSUED = Issued
       new :ISSUED, 'Issued'
 
+      # @!parse OTHER = Other
+      new :OTHER, 'Other'
+
       # @!parse SUBMITTED = Submitted
       new :SUBMITTED, 'Submitted'
 
@@ -34,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),
@@ -67,7 +75,8 @@ module Datacite
       end
 
       def type=(val)
-        fail ArgumentError, 'Date type cannot be nil' unless val
+        raise ArgumentError, 'Date type cannot be nil' unless val
+
         @type = val
       end
 
@@ -80,14 +89,15 @@ module Datacite
           @range_start, @range_end = parts.map(&:strip).map { |part| DateValue.new(part) unless part == '' }
           # puts "#{val} -> [#{range_start}, #{range_end}]"
         else
-          fail ArgumentError, "Unable to parse date value #{val}"
+          raise ArgumentError, "Unable to parse date value #{val}"
         end
         @value = date_value ? date_value.to_s : "#{range_start}/#{range_end}"
       end
 
       def <=>(other)
         return nil unless other.class == self.class
-        [:date_value, :range_start, :range_end, :type].each do |v|
+
+        %i[date_value range_start range_end type].each do |v|
           order = send(v) <=> other.send(v)
           return order if order.nonzero?
         end
@@ -102,12 +112,14 @@ module Datacite
         @value
       end
 
-      private
-
       # @!attribute [rw] type
       #  @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()'