datacite-mapping 0.1.17.2 → 0.2.0

data/lib/datacite/mapping/date.rb

@@ -1,5 +1,7 @@
 require 'xml/mapping_extensions'
 
+require 'datacite/mapping/date_value'
+
 module Datacite
   module Mapping
 
@@ -35,32 +37,23 @@ module Datacite
     end
 
     # Represents a DataCite `<date/>` field, which can be a year, date (year-month-day or just year-month),
-    # or ISO8601 datetime.
+    # ISO8601 datetime, or [RKMS-ISO8601](http://www.ukoln.ac.uk/metadata/dcmi/collection-RKMS-ISO8601/) date range.
     #
-    # @!attribute [r] year
-    #   @return [Integer] The year.
-    # @!attribute [r] month
-    #   @return [Integer, nil] The month. Can be `nil` if no month was specified.
-    # @!attribute [r] day
-    #   @return [Integer, nil] The day. Can be `nil` if no day was specified.
-    # @!attribute [r] hour
-    #   @return [Integer, nil] The hour. Can be `nil` if no hour was specified.
-    # @!attribute [r] minute
-    #   @return [Integer, nil] The minutes. Can be `nil` if no minutes were specified.
-    # @!attribute [r] sec
-    #   @return [Integer, nil] The seconds. Can be `nil` if no seconds were specified.
-    # @!attribute [r] nsec
-    #   @return [Integer, nil] The nanoseconds. Can be `nil` if no nanoseconds were specified.
+    # @!attribute [r] date_value
+    #   @return [DateValue, nil] the single date/time represented by this `<date/>` field,
+    #     if it does not represent a ragne
+    # @!attribute [r] range_start
+    #   @return [DateValue, nil] the start of the date range represented by this `<date/> field`,
+    #     if it represents a range, and the range is not open on the lower end
+    # @!attribute [r] range_end
+    #   @return [DateValue, nil] the end of the date range represented by this `<date/> field`,
+    #     if it represents a range, and the range is not open on the upper end
     class Date
       include XML::Mapping
 
-      attr_reader :year
-      attr_reader :month
-      attr_reader :day
-      attr_reader :hour
-      attr_reader :minute
-      attr_reader :sec
-      attr_reader :nsec
+      attr_reader :date_value
+      attr_reader :range_start
+      attr_reader :range_end
 
       # Initializes a new `Date`
       #
@@ -77,65 +70,22 @@ module Datacite
         @type = val
       end
 
-      # Sets the value.
-      #
-      # @param val [DateTime, Date, Integer, String] The value, as a `DateTime`, `Date`, or `Integer`,
-      #   or as a `String` in any [W3C DateTime format](http://www.w3.org/TR/NOTE-datetime)
-      def value=(val) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        @date_time = to_datetime(val)
-        @date = @date_time ? @date_time.to_date : to_date(val)
-        @year = to_year(val)
-        @month = to_month(val)
-        @day = to_day(val)
-        new_value = val.respond_to?(:iso8601) ? val.iso8601 : val.to_s
-        if new_value.include?('T')
-          @hour = @date_time.hour if @date_time
-          @minute = @date_time.minute if @date_time
-          @sec = @date_time.sec if @date_time
-          @nsec = @date_time.to_time.nsec if @date_time
+      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
+          @date_value = DateValue.new(val)
+        elsif parts.size == 2
+          @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}"
         end
-        fail ArgumentError, "Unable to parse date value '#{val}'" unless @year
-        @value = new_value
+        @value = val
       end
 
       private
 
-      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 => e
-        Mapping.log.debug("Can't extract DateTime from date value '#{val}': #{e}")
-        nil
-      end
-
-      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 => e
-        Mapping.log.debug("Can't extract Date from date value '#{val}': #{e}")
-        nil
-      end
-
       # @!attribute [rw] type
       #  @return [DateType] the type of date. Cannot be nil.
       typesafe_enum_node :type, '@dateType', class: DateType
@@ -143,6 +93,8 @@ module Datacite
       # @!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()'
+
+      fallback_mapping :datacite_3, :_default
     end
   end
 end

data/lib/datacite/mapping/date_value.rb

@@ -0,0 +1,116 @@
+require 'xml/mapping_extensions'
+
+module Datacite
+  module Mapping
+
+    # Represents a DataCite "date" value, which can be a year, date (year-month-day or just year-month),
+    # or ISO8601 datetime.
+    #
+    # @!attribute [r] year
+    #   @return [Integer] The year.
+    # @!attribute [r] month
+    #   @return [Integer, nil] The month. Can be `nil` if no month was specified.
+    # @!attribute [r] day
+    #   @return [Integer, nil] The day. Can be `nil` if no day was specified.
+    # @!attribute [r] hour
+    #   @return [Integer, nil] The hour. Can be `nil` if no hour was specified.
+    # @!attribute [r] minute
+    #   @return [Integer, nil] The minutes. Can be `nil` if no minutes were specified.
+    # @!attribute [r] sec
+    #   @return [Integer, nil] The seconds. Can be `nil` if no seconds were specified.
+    # @!attribute [r] nsec
+    #   @return [Integer, nil] The nanoseconds. Can be `nil` if no nanoseconds were specified.
+    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
+
+      # Creates a new {DateValue}.
+      #
+      # @param val [DateTime, Date, Integer, String] The value, as a `DateTime`, `Date`, or `Integer`,
+      #   or as a `String` in any [W3C DateTime format](http://www.w3.org/TR/NOTE-datetime)
+      def initialize(val) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        datetime = to_datetime(val)
+        @date = datetime ? datetime.to_date : to_date(val)
+        @year = to_year(val)
+        @month = to_month(val)
+        @day = to_day(val)
+        iso_value = val.respond_to?(:iso8601) ? val.iso8601 : val.to_s
+        if datetime && iso_value.include?('T')
+          @hour = datetime.hour
+          @minute = datetime.minute
+          @sec = datetime.sec
+          @nsec = datetime.to_time.nsec
+          @zone = datetime.zone
+        end
+        fail 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|
+          order = send(v) <=> other.send(v)
+          return order if order.nonzero?
+        end
+        0
+      end
+
+      def hash
+        [year, month, day, hour, minute, sec, nsec, zone].hash
+      end
+
+      def to_s
+        'DateTime(' + [:year, :month, :day, :hour, :minute, :sec, :nsec, :zone].map do |field|
+          value = send(field)
+          value = format('%02d', value) if value && value.is_a?(Integer)
+          "#{field}: #{value}" if value
+        end.compact.join(', ') + ')'
+      end
+
+      private
+
+      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
+      end
+
+      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
+      end
+
+    end
+  end
+end

data/lib/datacite/mapping/description.rb

@@ -77,28 +77,28 @@ module Datacite
       include XML::Mapping
 
       # Initializes a new {Description}
-      # @param language [String] an IETF BCP 47, ISO 639-1 language code identifying the language.
-      #   It's unclear from the spec whether language is required; to play it safe, if it's missing, we default to 'en'.
+      # @param language [String, nil] an IETF BCP 47, ISO 639-1 language code identifying the language.
       # @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: 'en', type:, value:)
+      def initialize(language: nil, type:, value:)
         self.language = language
         self.type = type
         self.value = value
       end
 
-      def language
-        @language || 'en'
+      def language=(value)
+        @language = value && value.strip
       end
 
-      def language=(value)
-        @language = value.strip if value
+      def value=(v)
+        new_value = v && v.strip
+        fail ArgumentError, 'Value cannot be empty or nil' unless new_value && !new_value.empty?
+        @value = new_value
       end
 
       # @!attribute [rw] language
       #   @return [String] an IETF BCP 47, ISO 639-1 language code identifying the language.
-      #     It's unclear from the spec whether language is required; to play it safe, if it's missing, we default to 'en'.
       text_node :language, '@xml:lang', default_value: nil
 
       # @!attribute [rw] type
@@ -110,6 +110,7 @@ module Datacite
       #     handling of `<br/>` tags.
       break_preserving_value_node :value, 'node()'
 
+      fallback_mapping :datacite_3, :_default
     end
   end
 end

data/lib/datacite/mapping/funding_reference.rb

@@ -37,6 +37,10 @@ module Datacite
         @type = value
       end
 
+      def to_s
+        "#{type.value}: #{value}"
+      end
+
       # @!attribute [rw] type
       #   @return [FunderIdentifierType] the identifier type. Cannot be nil.
       typesafe_enum_node :type, '@funderIdentifierType', class: FunderIdentifierType
@@ -59,6 +63,10 @@ module Datacite
         @value = value
       end
 
+      def to_s
+        "#{value} (#{uri})"
+      end
+
       # @!attribute [rw] uri
       #  @return [URI, nil] The URI leading to a page provided by the funder for more information about the award
       uri_node :uri, '@awardURI', default_value: nil
@@ -81,17 +89,24 @@ module Datacite
       end
 
       def award_number=(value)
-        if value.nil? || value.is_a?(AwardNumber)
-          @award_number = value
-        else
-          @award_number = AwardNumber.new(value: value.to_s)
-        end
+        @award_number = if value.nil? || value.is_a?(AwardNumber)
+                          value
+                        else
+                          AwardNumber.new(value: value.to_s)
+                        end
+      end
+
+      def to_s
+        fields = [:name, :identifier, :award_number, :award_title].map { |f| "#{f}: #{send(f)}" }
+        "FundingReference { #{fields.join(', ')} }"
       end
 
       text_node :name, 'funderName'
       object_node :identifier, 'funderIdentifier', class: FunderIdentifier, default_value: nil
       object_node :award_number, 'awardNumber', class: AwardNumber, default_value: nil
       text_node :award_title, 'awardTitle', default_value: nil
+
+      fallback_mapping :datacite_3, :_default
     end
   end
 end

data/lib/datacite/mapping/geo_location.rb

@@ -1,6 +1,7 @@
 require 'xml/mapping_extensions'
 require 'datacite/mapping/geo_location_point'
 require 'datacite/mapping/geo_location_box'
+require 'datacite/mapping/geo_location_polygon'
 
 module Datacite
   module Mapping
@@ -17,18 +18,28 @@ module Datacite
       # @param point [GeoLocationPoint, nil] the latitude and longitude at which the data was gathered or about which the data is focused.
       # @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.
-      def initialize(point: nil, box: nil, place: nil)
+      # @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)
         self.point = point
         self.box = box
         self.place = place
+        self.polygon = polygon
       end
 
       def place=(value)
         @place = value.respond_to?(:strip) ? value.strip : value
       end
 
+      def location?
+        point || box || place || polygon
+      end
+
       root_element_name 'geoLocation'
 
+      # @!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
+
       # @!attribute [rw] point
       #   @return [GeoLocationPoint, nil] the latitude and longitude at which the data was gathered or about which the data is focused.
       geo_location_point_node :point, 'geoLocationPoint', default_value: nil
@@ -37,10 +48,20 @@ module Datacite
       #   @return [GeoLocationBox, nil] the latitude-longitude quadrangle containing the area where the data was gathered or about which the data is focused.
       geo_location_box_node :box, 'geoLocationBox', default_value: nil
 
-      # @!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
+      # # @!attribute [rw] polygon
+      # #   @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
+
+      use_mapping :datacite_3
+
+      # Workaround for https://github.com/dmolesUC3/xml-mapping_extensions/issues/6
+      object_node :polygon, 'geoLocationPolygon', class: GeoLocationPolygon, default_value: nil, marshaller: (proc do |xml, value|
+        # TODO: Move ReadOnlyNodes.warn() somewhere more obvious
+        ReadOnlyNodes.warn "<geoLocationPolygon/> not supported in Datacite 3; ignoring polygon #{value}"
+        xml.parent.delete_element(xml)
+      end)
 
+      fallback_mapping :datacite_3, :_default
     end
   end
 end

data/lib/datacite/mapping/geo_location_box.rb

@@ -1,4 +1,5 @@
 require 'xml/mapping'
+require 'datacite/mapping/geo_location_node'
 
 module Datacite
   module Mapping
@@ -95,7 +96,7 @@ module Datacite
         return nil unless other.class == self.class
         [:south_latitude, :west_longitude, :north_latitude, :east_longitude].each do |c|
           order = send(c) <=> other.send(c)
-          return order if order != 0
+          return order if order.nonzero?
         end
         0
       end
@@ -122,13 +123,14 @@ module Datacite
     end
 
     # XML mapping node for `<geoLocationBox/>`
-    class GeoLocationBoxNode < XML::MappingExtensions::NodeBase
-      # Converts a whitespace-separated list of coordinates to a {GeoLocationBox}.
-      # @param xml_text [String] the coordinates, in the order `lat long lat long`.
-      def to_value(xml_text)
-        stripped = xml_text.strip
-        coords = stripped.split(/\s+/).map(&:to_f)
-        GeoLocationBox.new(*coords)
+    class GeoLocationBoxNode < GeoLocationNode
+      def initialize(*args)
+        @geom_class = GeoLocationBox
+        @coord_elements = { west_longitude: 'westBoundLongitude',
+                            east_longitude: 'eastBoundLongitude',
+                            south_latitude: 'southBoundLatitude',
+                            north_latitude: 'northBoundLatitude' }.freeze
+        super
       end
     end
     XML::Mapping.add_node_class GeoLocationBoxNode