datacite-mapping 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8775fcefefd2e9b7d31347a04a0495018109f239f1710c45a909c0c6a00f3a7d
-  data.tar.gz: 2d2ff543b99b85846be3c8d322f41967038cb836b83e2d8db6dba3ff7bafb4d8
+  metadata.gz: 370ed14bb82380efcbf6786213d3be379df734d5922af601d9b0db6116577d00
+  data.tar.gz: 645f09ba29266c3c9614d4ff5c37c90755259b48a8027c882da4ef2906efe7a4
 SHA512:
-  metadata.gz: 54c5fc88e7ec891b088feff0022dcf89b8cbe8408e1fe6e2de6de76695e5c074397061210378a22c51d1db6653eccd07fe01076fea6807e49d199b8b73c98f90
-  data.tar.gz: 419006f6182826184d8a009552aac66aa59355422e679c43c56ce6b6f399fe21507b2c170800ddc5633135f49171cba54734c3f6fe9d70fc3a741d598594afd4
+  metadata.gz: d214d5e04f36c80ffde982f85e02b5d2663bb1e5ffcf71f5010d7d86c050917cc3c300caa9c99e03577de894ef5bd7a0320f5a3135ad4257b17b1b00e569015a
+  data.tar.gz: 989fb22bb7c733a72ea7625b9628b6203326fb205c142a3b4739e51e7162174782b6c58d561e15c3c3e7e459e1d3e95795bdd3e17464ee483c667904c2aa6378

data/.rubocop.yml

@@ -1,5 +1,5 @@
 # Disable line-length check; it's too easy for the cure to be worse than the disease
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: False
 
 # Disable parameter-length check; this is determined by the number of XML attributes defined in the DataCite schema
@@ -42,3 +42,9 @@ Style/ClassAndModuleChildren:
 Style/MixinUsage:
   Exclude:
     - 'examples/*'
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.3.7

data/CHANGES.md

@@ -1,4 +1,15 @@
-## 0.4.0 (12 November 2019
+## 0.6.0 (7 April 2026)
+- Update to Ruby 3.3.7
+- Datacite 4.7 support:
+  - Added the new elements and attributes introduced in DataCite 4.4, 4.5, 4.6, and 4.7.
+  - Reading from XML still supports any version of the DataCite schema from 3.0 through 4.7.
+
+
+## 0.5.0 (14 March 2023)
+- Update to Ruby 3.0.4
+- Update to Rubocop 0.93
+
+## 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.

data/README.md

@@ -10,7 +10,7 @@ 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.3](https://schema.labs.datacite.org/meta/kernel-4.3/); backward-compatible with 
+Supports [Datacite 4.7](https://datacite-metadata-schema.readthedocs.io/en/4.7); backward-compatible with 
 [Datacite 3.1](https://schema.labs.datacite.org/meta/kernel-3/).
 
 Note that although this gem maintains compatibility with multiple

data/datacite-mapping.gemspec

@@ -16,9 +16,11 @@ 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.gsub(%r{git@([^:]+)(.com|.org)[^\/]+}, 'http://\1\2'))
+  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.required_ruby_version = '>= 3.0.0'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 

data/lib/datacite/mapping/affiliation.rb

@@ -8,7 +8,7 @@ module Datacite
     class Affiliation
       include XML::Mapping
 
-      def initialize(identifier: nil, identifier_scheme: nil, scheme_uri: nil, value:)
+      def initialize(value:, identifier: nil, identifier_scheme: nil, scheme_uri: nil)
         self.identifier = identifier
         self.identifier_scheme = identifier_scheme
         self.scheme_uri = scheme_uri

data/lib/datacite/mapping/contributor.rb

@@ -70,6 +70,9 @@ module Datacite
       # @!parse SUPERVISOR = Supervisor
       new :SUPERVISOR, 'Supervisor'
 
+      # @!parse TRANSLATOR = Translator
+      new :TRANSLATOR, 'Translator'
+
       # @!parse WORK_PACKAGE_LEADER = WorkPackageLeader
       new :WORK_PACKAGE_LEADER, 'WorkPackageLeader'
 
@@ -87,7 +90,7 @@ module Datacite
       # @param identifier [NameIdentifier, nil] an identifier for the contributor. Optional.
       # @param affiliations [Array<Affiliation>] the contributor's affiliations. Defaults to an empty list.
       # @param type [ContributorType] the contributor type. Cannot be nil.
-      def initialize(name:, identifier: nil, affiliations: nil, type:)
+      def initialize(name:, type:, identifier: nil, affiliations: nil)
         self.name = name
         self.identifier = identifier
         self.affiliations = affiliations || []

data/lib/datacite/mapping/contributor_name.rb

@@ -9,7 +9,7 @@ module Datacite
   module Mapping
     class ContributorName
       include XML::Mapping
-      def initialize(type: nil, language: nil, value:)
+      def initialize(value:, type: nil, language: nil)
         self.type = type
         self.language = language
         self.value = value

data/lib/datacite/mapping/creator_name.rb

@@ -9,7 +9,7 @@ module Datacite
   module Mapping
     class CreatorName
       include XML::Mapping
-      def initialize(type: nil, language: nil, value:)
+      def initialize(value:, type: nil, language: nil)
         self.type = type
         self.language = language
         self.value = value

data/lib/datacite/mapping/date.rb

@@ -21,6 +21,9 @@ module Datacite
       # @!parse COLLECTED = Collected
       new :COLLECTED, 'Collected'
 
+      # @!parse COVERAGE = Coverage
+      new :COVERAGE, 'Coverage'
+
       # @!parse CREATED = Created
       new :CREATED, 'Created'
 
@@ -60,9 +63,7 @@ module Datacite
       include Comparable
       include XML::Mapping
 
-      attr_reader :date_value
-      attr_reader :range_start
-      attr_reader :range_end
+      attr_reader :date_value, :range_start, :range_end
 
       # Initializes a new `Date`
       #
@@ -80,12 +81,15 @@ module Datacite
         @type = val
       end
 
+      # rubocop:disable Metrics/MethodLength
+
       def value=(val) # rubocop:disable Metrics/AbcSize
         parts = val.to_s.split('/', -1) # negative limit so we don't drop trailing empty string
         @date_value, @range_start, @range_end = nil
-        if parts.size == 1
+        case parts.size
+        when 1
           @date_value = DateValue.new(val)
-        elsif parts.size == 2
+        when 2
           @range_start, @range_end = parts.map(&:strip).map { |part| DateValue.new(part) unless part == '' }
           # puts "#{val} -> [#{range_start}, #{range_end}]"
         else
@@ -93,9 +97,10 @@ module Datacite
         end
         @value = date_value ? date_value.to_s : "#{range_start}/#{range_end}"
       end
+      # rubocop:enable Metrics/MethodLength
 
       def <=>(other)
-        return nil unless other.class == self.class
+        return nil unless other.instance_of?(self.class)
 
         %i[date_value range_start range_end type].each do |v|
           order = send(v) <=> other.send(v)

data/lib/datacite/mapping/date_value.rb

@@ -25,16 +25,7 @@ module Datacite
     class DateValue
       include Comparable
 
-      attr_reader :year
-      attr_reader :month
-      attr_reader :day
-      attr_reader :hour
-      attr_reader :minute
-      attr_reader :sec
-      attr_reader :nsec
-      attr_reader :date
-      attr_reader :zone
-      attr_reader :iso_value
+      attr_reader :year, :month, :day, :hour, :minute, :sec, :nsec, :date, :zone, :iso_value
 
       # Creates a new {DateValue}.
       #
@@ -58,7 +49,7 @@ module Datacite
       end
 
       def <=>(other)
-        return nil unless other.class == self.class
+        return nil unless other.instance_of?(self.class)
 
         %i[year month day hour minute sec nsec].each do |v|
           order = send(v) <=> other.send(v)

data/lib/datacite/mapping/description.rb

@@ -86,7 +86,7 @@ module Datacite
       # @param type [DescriptionType] the description type.
       # @param value [String] the description itself. See {Description} for notes on special
       #     handling of `<br/>` tags.
-      def initialize(language: nil, type:, value:)
+      def initialize(type:, value:, language: nil)
         self.language = language
         self.type = type
         self.value = value

data/lib/datacite/mapping/funding_reference.rb

@@ -27,7 +27,7 @@ module Datacite
 
       # @param type [FunderIdentifierType] the identifier type. Cannot be nil.
       # @param value [String] the identifier value. Cannot be nil.
-      def initialize(type:, scheme_uri: nil, value:)
+      def initialize(type:, value:, scheme_uri: nil)
         self.type = type
         self.scheme_uri = scheme_uri
         self.value = value
@@ -65,7 +65,7 @@ module Datacite
     class AwardNumber
       include XML::Mapping
 
-      def initialize(uri: nil, value:)
+      def initialize(value:, uri: nil)
         self.uri = uri
         self.value = value
       end

data/lib/datacite/mapping/geo_location_box.rb

@@ -19,10 +19,7 @@ module Datacite
     class GeoLocationBox
       include Comparable
 
-      attr_reader :south_latitude
-      attr_reader :west_longitude
-      attr_reader :north_latitude
-      attr_reader :east_longitude
+      attr_reader :south_latitude, :west_longitude, :north_latitude, :east_longitude
 
       # Initializes a new {GeoLocationBox}. The arguments can be provided
       # either as a named-parameter hash, or as a list of four coordinates
@@ -51,7 +48,10 @@ module Datacite
       def initialize(*args)
         case args.length
         when 1
-          init_from_hash(args[0])
+          raise ArgumentError, "Can't construct GeoLocationBox from arguments: #{args}" unless args[0].respond_to?(:keys)
+
+          init_from_hash(**args[0])
+
         when 4
           init_from_array(args)
         else
@@ -99,7 +99,7 @@ module Datacite
       # @return [Fixnum, nil] the sort order (-1, 0, or 1), or nil if `other` is not a
       #   {GeoLocationBox}
       def <=>(other)
-        return nil unless other.class == self.class
+        return nil unless other.instance_of?(self.class)
 
         %i[south_latitude west_longitude north_latitude east_longitude].each do |c|
           order = send(c) <=> other.send(c)

data/lib/datacite/mapping/geo_location_node.rb

@@ -7,8 +7,7 @@ module Datacite
     # Abstract superclass of GeoLocation parsing nodes
     class GeoLocationNode < XML::Mapping::SingleAttributeNode
 
-      attr_reader :geom_class
-      attr_reader :coord_elements
+      attr_reader :geom_class, :coord_elements
 
       def initialize(*args)
         raise 'No geometry class provided' unless @geom_class
@@ -30,7 +29,7 @@ module Datacite
       end
 
       def set_attr_value(xml, value)
-        raise "Invalid value: expected #{geom_class} instance, was #{value || 'nil'}" unless value&.is_a?(geom_class)
+        raise "Invalid value: expected #{geom_class} instance, was #{value || 'nil'}" unless value.is_a?(geom_class)
 
         element = @path.first(xml, ensure_created: true)
 

data/lib/datacite/mapping/geo_location_point.rb

@@ -15,8 +15,7 @@ module Datacite
     class GeoLocationPoint
       include Comparable
 
-      attr_reader :latitude
-      attr_reader :longitude
+      attr_reader :latitude, :longitude
 
       # Initializes a new {GeoLocationPoint}. The arguments can be provided
       # either as a named-parameter hash, or as a pair of coordinates in the
@@ -31,7 +30,10 @@ module Datacite
       def initialize(*args)
         case args.length
         when 1
-          init_from_hash(args[0])
+          raise ArgumentError, "Can't construct GeoLocationPoint from arguments: #{args}" unless args[0].respond_to?(:keys)
+
+          init_from_hash(**args[0])
+
         when 2
           init_from_array(args)
         else
@@ -65,7 +67,7 @@ module Datacite
       # @return [Fixnum, nil] the sort order (-1, 0, or 1), or nil if `other` is not a
       #   {GeoLocationPoint}
       def <=>(other)
-        return nil unless other.class == self.class
+        return nil unless other.instance_of?(self.class)
 
         %i[latitude longitude].each do |c|
           order = send(c) <=> other.send(c)

data/lib/datacite/mapping/geo_location_polygon.rb

@@ -25,7 +25,7 @@ module Datacite
       end
 
       def <=>(other)
-        return nil unless other.class == self.class
+        return nil unless other.instance_of?(self.class)
 
         points <=> other.points
       end
@@ -43,15 +43,15 @@ module Datacite
       # #   @return [Array<GeoLocationPoint>] an array of points defining the polygon area.
       array_node :points, 'polygonPoint',
                  default_value: [],
-                 marshaller: (proc { |xml, value| marshal_point(xml, value) }),
-                 unmarshaller: (proc { |xml| unmarshal_point(xml) })
+                 marshaller: proc { |xml, value| marshal_point(xml, value) },
+                 unmarshaller: proc { |xml| unmarshal_point(xml) }
 
       # # @!attribute [rw] in_polygon_point
       # #   @return [InPolygonPoint] a point within the target polygon
       object_node :in_polygon_point, 'inPolygonPoint',
                   default_value: nil,
-                  marshaller: (proc { |xml, value| marshal_point(xml, value) }),
-                  unmarshaller: (proc { |xml| unmarshal_point(xml) })
+                  marshaller: proc { |xml, value| marshal_point(xml, value) },
+                  unmarshaller: proc { |xml| unmarshal_point(xml) }
 
       use_mapping :datacite_3
 

data/lib/datacite/mapping/identifier.rb

@@ -5,7 +5,7 @@ require 'datacite/mapping/empty_filtering_nodes'
 
 module Datacite
   module Mapping
-    DOI_PATTERN = %r{10\.\S+/\S+}.freeze
+    DOI_PATTERN = %r{10\.\S+/\S+}
 
     # The persistent identifier that identifies the resource.
     #
@@ -38,7 +38,7 @@ module Datacite
       # @param new_value [String]
       #   the identifier type (always 'DOI')
       def identifier_type=(new_value)
-        raise ArgumentError, "Identifier type '#{new_value}' must be 'DOI'" unless DOI == new_value
+        raise ArgumentError, "Identifier type '#{new_value}' must be 'DOI'" unless new_value == DOI
 
         @identifier_type = new_value
       end
@@ -68,12 +68,12 @@ module Datacite
     class IdentifierNode < XML::Mapping::ObjectNode
       include EmptyNodeUtils
       def xml_to_obj(_obj, xml)
-        return super if (element = has_element?(xml)) && not_empty(element)
+        super if (element = element?(xml)) && not_empty(element)
       end
 
       private
 
-      def has_element?(xml) # rubocop:disable Naming/PredicateName
+      def element?(xml)
         @path.first(xml)
       rescue XML::XXPathError
         false

data/lib/datacite/mapping/module_info.rb

@@ -6,9 +6,9 @@ module Datacite
     NAME = 'datacite-mapping'
 
     # The version of this gem
-    VERSION = '0.4.1'
+    VERSION = '0.6.0'
 
     # The copyright notice for this gem
-    COPYRIGHT = 'Copyright (c) 2022 The Regents of the University of California'
+    COPYRIGHT = 'Copyright (c) 2026 Dryad'
   end
 end

data/lib/datacite/mapping/name_identifier.rb

@@ -12,7 +12,7 @@ module Datacite
       # @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:)
+      def initialize(scheme:, value:, scheme_uri: nil)
         self.scheme = scheme
         self.scheme_uri = scheme_uri
         self.value = value

data/lib/datacite/mapping/publisher.rb

@@ -12,8 +12,11 @@ module Datacite
       # Initializes a new {Publisher}
       # @param language [String, nil] an IETF BCP 47, ISO 639-1 language code identifying the language.
       # @param value [String] name of the publisher
-      def initialize(language: nil, value:)
+      def initialize(value:, language: nil, identifier: nil, identifier_scheme: nil, scheme_uri: nil)
         self.language = language
+        self.identifier = identifier
+        self.identifier_scheme = identifier_scheme
+        self.scheme_uri = scheme_uri
         self.value = value
       end
 
@@ -32,6 +35,18 @@ module Datacite
       #   @return [String] 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] The publisher identifier. Optional.
+      text_node :identifier, '@publisherIdentifier', default_value: nil
+
+      # @!attribute [rw] identifier_scheme
+      #   @return [String, nil] The scheme for the publisher identifier. Optional.
+      text_node :identifier_scheme, '@publisherIdentifierScheme', 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 title itself.
       text_node :value, 'text()'

data/lib/datacite/mapping/read_only_nodes.rb

@@ -39,10 +39,13 @@ module Datacite
         ReadOnlyNodes.warn(warning)
       end
 
+      # rubocop:disable Lint/UselessMethodDefinition
       # public to allow testing
       def self.warn(warning)
         super
       end
+
+      # rubocop:enable Lint/UselessMethodDefinition
     end
 
     class ReadOnlyTextNode < XML::Mapping::TextNode

data/lib/datacite/mapping/related_identifier.rb

@@ -107,6 +107,24 @@ module Datacite
       # @!parse REQUIRES = Requires
       new :REQUIRES, 'Requires'
 
+      # @!parse IS_PUBLISHED_IN = IsPublishedIn
+      new :IS_PUBLISHED_IN, 'IsPublishedIn'
+
+      # @!parse IS_COLLECTED_BY = IsCollectedBy
+      new :IS_COLLECTED_BY, 'IsCollectedBy'
+
+      # @!parse COLLECTS = Collects
+      new :COLLECTS, 'Collects'
+
+      # @!parse HAS_TRANSLATION = HasTranslation
+      new :HAS_TRANSLATION, 'HasTranslation'
+
+      # @!parse IS_TRANSLATION_OF = IsTranslationOf
+      new :IS_TRANSLATION_OF, 'IsTranslationOf'
+
+      # @!parse OTHER = Other
+      new :OTHER, 'Other'
+
     end
 
     # Controlled list of related identifier types.
@@ -120,6 +138,9 @@ module Datacite
       # @!parse BIBCODE = bibcode
       new :BIBCODE, 'bibcode'
 
+      # @!parse CSTR = CSTR
+      new :CSTR, 'CSTR'
+
       # @!parse DOI = DOI
       new :DOI, 'DOI'
 
@@ -153,6 +174,15 @@ module Datacite
       # @!parse PURL = PURL
       new :PURL, 'PURL'
 
+      # @!parse RAID = RAiD
+      new :RAID, 'RAiD'
+
+      # @!parse RRID = RRID
+      new :RRID, 'RRID'
+
+      # @!parse SWHID = SWHID
+      new :SWHID, 'SWHID'
+
       # @!parse UPC = UPC
       new :UPC, 'UPC'
 
@@ -198,13 +228,15 @@ module Datacite
 
       # Initializes a new {RelatedIdentifier}.
       # @param relation_type [RelationType] the relationship of the {Resource} to the related resource. Cannot be nil.
+      # @param relation_type_information [String] additional information about the selected [RelationType], if appropriate.
       # @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)
+      def initialize(relation_type:, value:, identifier_type:, relation_type_information: nil, related_metadata_scheme: nil, scheme_uri: nil, scheme_type: nil)
         self.relation_type = relation_type
+        self.relation_type_information = relation_type_information
         self.value = value
         self.identifier_type = identifier_type
         self.related_metadata_scheme = related_metadata_scheme
@@ -236,6 +268,10 @@ module Datacite
       #   @return [RelationType] the relationship of the {Resource} to the related resource. Cannot be nil.
       typesafe_enum_node :relation_type, '@relationType', class: RelationType
 
+      # @!attribute [rw] relation_type_information
+      #   @return [String, nil] Additional information about the selected relationType, if appropriate. Recommended for use with the relationType Other.
+      text_node :relation_type_information, '@rrelationTypeInformation', default_value: nil
+
       # @!attribute [rw] value
       #   @return [String] the identifier value. Cannot be nil.
       text_node :value, 'text()'