datacite-mapping 0.2.4 → 0.4.1

data/lib/datacite/mapping/date_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -52,12 +54,13 @@ module Datacite
           @nsec = datetime.to_time.nsec
           @zone = datetime.zone
         end
-        fail ArgumentError, "Unable to parse date value '#{val}'" unless @year
+        raise ArgumentError, "Unable to parse date value '#{val}'" unless @year
       end
 
       def <=>(other)
         return nil unless other.class == self.class
-        [:year, :month, :day, :hour, :minute, :sec, :nsec].each do |v|
+
+        %i[year month day hour minute sec nsec].each do |v|
           order = send(v) <=> other.send(v)
           return order if order.nonzero?
         end
@@ -84,24 +87,28 @@ module Datacite
       def to_year(val)
         return val if val.is_a?(Integer)
         return val.year if val.respond_to?(:year)
+
         matchdata = val.to_s.match(/^[0-9]+/)
         matchdata[0].to_i if matchdata
       end
 
       def to_month(val)
         return val.month if val.respond_to?(:month)
+
         matchdata = val.to_s.match(/^[0-9]+-([0-9]{2})(?![0-9])/)
         matchdata[1].to_i if matchdata
       end
 
       def to_day(val)
         return val.day if val.respond_to?(:day)
+
         matchdata = val.to_s.match(/^[0-9]+-[0-9]{2}-([0-9]{2})(?![0-9])/)
         matchdata[1].to_i if matchdata
       end
 
       def to_datetime(val)
         return val if val.is_a?(DateTime)
+
         DateTime.parse(val.to_s)
       rescue ArgumentError
         nil
@@ -110,6 +117,7 @@ module Datacite
       def to_date(val)
         return val if val.is_a?(::Date)
         return ::Date.parse(val.iso8601) if val.respond_to?(:iso8601)
+
         ::Date.parse(val.to_s)
       rescue ArgumentError
         nil

data/lib/datacite/mapping/description.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -17,6 +19,9 @@ module Datacite
       # @!parse TABLE_OF_CONTENTS = TableOfContents
       new :TABLE_OF_CONTENTS, 'TableOfContents'
 
+      # @!parse TECHNICAL_INFO = TechnicalInfo
+      new :TECHNICAL_INFO, 'TechnicalInfo'
+
       # @!parse OTHER = Other
       new :OTHER, 'Other'
 
@@ -88,12 +93,13 @@ module Datacite
       end
 
       def language=(value)
-        @language = value && value.strip
+        @language = value&.strip
       end
 
-      def value=(v)
-        new_value = v && v.strip
-        fail ArgumentError, 'Value cannot be empty or nil' unless new_value && !new_value.empty?
+      def value=(a_value)
+        new_value = a_value&.strip
+        raise ArgumentError, 'Value cannot be empty or nil' unless new_value && !new_value.empty?
+
         @value = new_value
       end
 

data/lib/datacite/mapping/empty_filtering_nodes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -6,6 +8,7 @@ module Datacite
     module EmptyNodeUtils
       def not_empty(element)
         return unless element
+
         text = element.text
         empty = text.nil? || text.strip.empty?
         warn "Ignoring empty element #{element}" if empty

data/lib/datacite/mapping/funding_reference.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -13,6 +15,9 @@ module Datacite
       # @!parse CROSSREF_FUNDER = 'Crossref Funder ID'
       new :CROSSREF_FUNDER_ID, 'Crossref Funder ID'
 
+      # @!parse ROR = ROR
+      new :ROR, 'ROR'
+
       # @!parse OTHER = Other
       new :OTHER, 'Other'
     end
@@ -22,18 +27,21 @@ module Datacite
 
       # @param type [FunderIdentifierType] the identifier type. Cannot be nil.
       # @param value [String] the identifier value. Cannot be nil.
-      def initialize(type:, value:)
+      def initialize(type:, scheme_uri: nil, value:)
         self.type = type
+        self.scheme_uri = scheme_uri
         self.value = value
       end
 
       def value=(value)
-        fail ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
+        raise ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
+
         @value = value
       end
 
       def type=(value)
-        fail ArgumentError, 'Type cannot be nil' unless value
+        raise ArgumentError, 'Type cannot be nil' unless value
+
         @type = value
       end
 
@@ -45,6 +53,10 @@ module Datacite
       #   @return [FunderIdentifierType] the identifier type. Cannot be nil.
       typesafe_enum_node :type, '@funderIdentifierType', class: FunderIdentifierType
 
+      # @!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()'
@@ -59,7 +71,8 @@ module Datacite
       end
 
       def value=(value)
-        fail ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
+        raise ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
+
         @value = value
       end
 
@@ -89,15 +102,11 @@ module Datacite
       end
 
       def award_number=(value)
-        @award_number = if value.nil? || value.is_a?(AwardNumber)
-                          value
-                        else
-                          AwardNumber.new(value: value.to_s)
-                        end
+        @award_number = award_number_or_nil(value)
       end
 
       def to_s
-        fields = [:name, :identifier, :award_number, :award_title].map { |f| "#{f}: #{send(f)}" }
+        fields = %i[name identifier award_number award_title].map { |f| "#{f}: #{send(f)}" }
         "FundingReference { #{fields.join(', ')} }"
       end
 
@@ -107,6 +116,18 @@ module Datacite
       text_node :award_title, 'awardTitle', default_value: nil
 
       fallback_mapping :datacite_3, :_default
+
+      private
+
+      def award_number_or_nil(value)
+        return nil unless value
+        return value if value.is_a?(AwardNumber)
+
+        new_value = value.to_s.strip
+        return nil if new_value.empty?
+
+        AwardNumber.new(value: new_value)
+      end
     end
   end
 end

data/lib/datacite/mapping/geo_location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 require 'datacite/mapping/geo_location_point'
 require 'datacite/mapping/geo_location_box'
@@ -19,11 +21,12 @@ module Datacite
       # @param box [GeoLocationBox, nil] the latitude-longitude quadrangle containing the area where the data was gathered or about which the data is focused.
       # @param place [String, nil] the spatial region or named place where the data was gathered or about which the data is focused.
       # @param polygon [GeoLocationPolygon, nil] a drawn polygon area containing the area where the data was gathered or about which the data is focused.
-      def initialize(point: nil, box: nil, place: nil, polygon: nil)
+      def initialize(point: nil, box: nil, place: nil, polygon: nil, polygons: [])
         self.point = point
         self.box = box
         self.place = place
         self.polygon = polygon
+        self.polygons = polygons
       end
 
       def place=(value)
@@ -48,6 +51,10 @@ module Datacite
       # #   @return [GeoLocationPolygon] a drawn polygon area containing the area where the data was gathered or about which the data is focused.
       object_node :polygon, 'geoLocationPolygon', class: GeoLocationPolygon, default_value: nil
 
+      # @!attribute [rw] polygons
+      #   @return [Array<GeoLocationPolygon>] multiple polygons where data is contained
+      array_node :polygons, 'geoLocationPolygons', 'geoLocationPolygon', class: GeoLocationPolygon, default_value: []
+
       # @!attribute [rw] place
       #   @return [String, nil] the spatial region or named place where the data was gathered or about which the data is focused.
       text_node :place, 'geoLocationPlace', default_value: nil

data/lib/datacite/mapping/geo_location_box.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping'
 require 'datacite/mapping/geo_location_node'
 
@@ -53,31 +55,35 @@ module Datacite
         when 4
           init_from_array(args)
         else
-          fail ArgumentError, "Can't construct GeoLocationBox from arguments: #{args}"
+          raise ArgumentError, "Can't construct GeoLocationBox from arguments: #{args}"
         end
       end
 
       def south_latitude=(value)
-        fail ArgumentError, 'South latitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid south latitude" unless value >= -90 && value <= 90
+        raise ArgumentError, 'South latitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid south latitude" unless value >= -90 && value <= 90
+
         @south_latitude = value
       end
 
       def west_longitude=(value)
-        fail ArgumentError, 'West longitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid west longitude" unless value >= -180 && value <= 180
+        raise ArgumentError, 'West longitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid west longitude" unless value >= -180 && value <= 180
+
         @west_longitude = value
       end
 
       def north_latitude=(value)
-        fail ArgumentError, 'North latitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid north latitude" unless value >= -90 && value <= 90
+        raise ArgumentError, 'North latitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid north latitude" unless value >= -90 && value <= 90
+
         @north_latitude = value
       end
 
       def east_longitude=(value)
-        fail ArgumentError, 'East longitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid east longitude" unless value >= -180 && value <= 180
+        raise ArgumentError, 'East longitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid east longitude" unless value >= -180 && value <= 180
+
         @east_longitude = value
       end
 
@@ -94,7 +100,8 @@ module Datacite
       #   {GeoLocationBox}
       def <=>(other)
         return nil unless other.class == self.class
-        [:south_latitude, :west_longitude, :north_latitude, :east_longitude].each do |c|
+
+        %i[south_latitude west_longitude north_latitude east_longitude].each do |c|
           order = send(c) <=> other.send(c)
           return order if order.nonzero?
         end

data/lib/datacite/mapping/geo_location_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -9,11 +11,12 @@ module Datacite
       attr_reader :coord_elements
 
       def initialize(*args)
-        fail 'No geometry class provided' unless @geom_class
-        fail 'No coordinate elements provided' unless @coord_elements
-        path, *args = super(*args)
+        raise 'No geometry class provided' unless @geom_class
+        raise 'No coordinate elements provided' unless @coord_elements
+
+        path, *myargs = super(*args)
         @path = ::XML::XXPath.new(path)
-        args
+        myargs # rubocop:disable Lint/Void
       end
 
       def datacite_3?
@@ -21,13 +24,14 @@ module Datacite
       end
 
       def extract_attr_value(xml)
-        return from_text(xml) || from_children(xml)
-      rescue => e
+        from_text(xml) || from_children(xml)
+      rescue StandardError => e
         raise e, "#{@owner}.#{@attrname}: Can't extract #{self.class} from #{xml}: #{e.message}"
       end
 
-      def set_attr_value(xml, value) # rubocop:disable Metrics/AbcSize
-        fail "Invalid value: expected #{geom_class} instance, was #{value || 'nil'}" unless value && value.is_a?(geom_class)
+      def set_attr_value(xml, value)
+        raise "Invalid value: expected #{geom_class} instance, was #{value || 'nil'}" unless value&.is_a?(geom_class)
+
         element = @path.first(xml, ensure_created: true)
 
         if datacite_3?

data/lib/datacite/mapping/geo_location_point.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping'
 require 'datacite/mapping/geo_location_node'
 
@@ -33,19 +35,21 @@ module Datacite
         when 2
           init_from_array(args)
         else
-          fail ArgumentError, "Can't construct GeoLocationPoint from arguments: #{args}"
+          raise ArgumentError, "Can't construct GeoLocationPoint from arguments: #{args}"
         end
       end
 
       def latitude=(value)
-        fail ArgumentError, 'Latitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid latitude" unless value >= -90 && value <= 90
+        raise ArgumentError, 'Latitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid latitude" unless value >= -90 && value <= 90
+
         @latitude = value
       end
 
       def longitude=(value)
-        fail ArgumentError, 'Longitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid longitude" unless value >= -180 && value <= 180
+        raise ArgumentError, 'Longitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid longitude" unless value >= -180 && value <= 180
+
         @longitude = value
       end
 
@@ -62,7 +66,8 @@ module Datacite
       #   {GeoLocationPoint}
       def <=>(other)
         return nil unless other.class == self.class
-        [:latitude, :longitude].each do |c|
+
+        %i[latitude longitude].each do |c|
           order = send(c) <=> other.send(c)
           return order if order.nonzero?
         end

data/lib/datacite/mapping/geo_location_polygon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping'
 
 module Datacite
@@ -11,10 +13,11 @@ module Datacite
       # @param points [Array<GeoLocationPoint>] an array of points defining the polygon area.
       #   Per the spec, the array should contain at least four points, the first and last being
       #   identical to close the polygon.
-      def initialize(points:) # TODO: allow simple array of point args, array of hashes
+      def initialize(points:, in_polygon_point: nil) # TODO: allow simple array of point args, array of hashes
         self.points = points
+        self.in_polygon_point = in_polygon_point
         warn "Polygon should contain at least 4 points, but has #{points.size}" if points.size < 4
-        warn "Polygon is not closed; last and first point should be identical, but were: [#{points[0]}], [#{points[-1]}]" if points.size > 1 unless points[0] == points[-1]
+        warn "Polygon is not closed; last and first point should be identical, but were: [#{points[0]}], [#{points[-1]}]" unless points[0] == points[-1] || points.size <= 1
       end
 
       def points=(value)
@@ -23,6 +26,7 @@ module Datacite
 
       def <=>(other)
         return nil unless other.class == self.class
+
         points <=> other.points
       end
 
@@ -42,6 +46,13 @@ module Datacite
                  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) })
+
       use_mapping :datacite_3
 
       # TODO: does this ever get called?

data/lib/datacite/mapping/identifier.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'xml/mapping'
 require 'datacite/mapping/empty_filtering_nodes'
 
 module Datacite
   module Mapping
-    DOI_PATTERN = %r{10\.\S+/\S+}
+    DOI_PATTERN = %r{10\.\S+/\S+}.freeze
 
     # The persistent identifier that identifies the resource.
     #
@@ -14,7 +16,7 @@ module Datacite
     class Identifier
       include XML::Mapping
 
-      DOI = 'DOI'.freeze
+      DOI = 'DOI'
 
       # Initializes a new {Identifier}
       # @param value [String]
@@ -24,19 +26,21 @@ module Datacite
         self.value = value
       end
 
-      def value=(v)
-        new_value = v && v.strip
-        fail ArgumentError, 'Identifier must have a non-nil value' unless new_value
-        fail ArgumentError, "Identifier value '#{new_value}' is not a valid DOI" unless new_value.match(DOI_PATTERN)
+      def value=(new_value)
+        new_value = new_value&.strip
+        raise ArgumentError, 'Identifier must have a non-nil value' unless new_value
+        raise ArgumentError, "Identifier value '#{new_value}' is not a valid DOI" unless new_value.match?(DOI_PATTERN)
+
         @value = new_value
       end
 
       # Sets the identifier type. Should only be called by the XML mapping engine.
-      # @param v [String]
+      # @param new_value [String]
       #   the identifier type (always 'DOI')
-      def identifier_type=(v)
-        fail ArgumentError, "Identifier type '#{v}' must be 'DOI'" unless DOI == v
-        @identifier_type = v
+      def identifier_type=(new_value)
+        raise ArgumentError, "Identifier type '#{new_value}' must be 'DOI'" unless DOI == new_value
+
+        @identifier_type = new_value
       end
 
       # Gets the identifiery type.
@@ -48,7 +52,8 @@ module Datacite
       # @param doi_string [String]
       def self.from_doi(doi_string)
         match = doi_string.match(DOI_PATTERN)
-        fail ArgumentError, "'#{doi_string}' does not appear to contain a valid DOI" unless match
+        raise ArgumentError, "'#{doi_string}' does not appear to contain a valid DOI" unless match
+
         Identifier.new(value: match[0])
       end
 
@@ -58,18 +63,17 @@ module Datacite
       fallback_mapping :datacite_3, :_default
     end
 
-    # Custom node to warn (but not blow up) if we read an XML `<resource/>` that's
+    # Custom node to allow (but ignore) if we read an XML `<resource/>` that's
     # missing its `<identifier/>`.
     class IdentifierNode < XML::Mapping::ObjectNode
       include EmptyNodeUtils
       def xml_to_obj(_obj, xml)
         return super if (element = has_element?(xml)) && not_empty(element)
-        warn 'Identifier not found; add a valid Identifier to the Resource before saving'
       end
 
       private
 
-      def has_element?(xml) # rubocop:disable Style/PredicateName
+      def has_element?(xml) # rubocop:disable Naming/PredicateName
         @path.first(xml)
       rescue XML::XXPathError
         false

data/lib/datacite/mapping/module_info.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Datacite
   module Mapping
     # The name of this gem
-    NAME = 'datacite-mapping'.freeze
+    NAME = 'datacite-mapping'
 
     # The version of this gem
-    VERSION = '0.2.4'.freeze
+    VERSION = '0.4.1'
 
     # The copyright notice for this gem
-    COPYRIGHT = 'Copyright (c) 2016 The Regents of the University of California'.freeze
+    COPYRIGHT = 'Copyright (c) 2022 The Regents of the University of California'
   end
 end

data/lib/datacite/mapping/name_identifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -16,14 +18,16 @@ module Datacite
         self.value = value
       end
 
-      def scheme=(v)
-        fail ArgumentError, 'Scheme cannot be empty or nil' unless v && !v.empty?
-        @scheme = v
+      def scheme=(new_value)
+        raise ArgumentError, 'Scheme cannot be empty or nil' unless new_value && !new_value.empty?
+
+        @scheme = new_value
       end
 
-      def value=(v)
-        fail ArgumentError, 'Value cannot be empty or nil' unless v && !v.empty?
-        @value = v
+      def value=(new_value)
+        raise ArgumentError, 'Value cannot be empty or nil' unless new_value && !new_value.empty?
+
+        @value = new_value
       end
 
       root_element_name 'nameIdentifier'
@@ -31,9 +35,11 @@ module Datacite
       # @!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()'

data/lib/datacite/mapping/name_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'xml/mapping'
+require 'datacite/mapping/read_only_nodes'
+
+module Datacite
+  module Mapping
+
+    # Controlled vocabulary of name types
+    class NameType < TypesafeEnum::Base
+      # @!parse ORGANIZATIONAL = Organizational
+      new :ORGANIZATIONAL, 'Organizational'
+
+      # @!parse PERSONAL = Personal
+      new :PERSONAL, 'Personal'
+    end
+  end
+end

data/lib/datacite/mapping/namespace_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 # TODO: port this to xml-mapping_extensions

data/lib/datacite/mapping/publisher.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'xml/mapping_extensions'
+
+module Datacite
+  module Mapping
+
+    # The type of the resource
+    class Publisher
+      include XML::Mapping
+
+      # 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:)
+        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] 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 title itself.
+      text_node :value, 'text()'
+
+      fallback_mapping :datacite_3, :_default
+    end
+  end
+end