datacite-mapping 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ca854763f76a711279af3353b9c5a9a5414058c
-  data.tar.gz: 3f99767c5394f6ae49e2ef60253d5064bfe33cd7
+  metadata.gz: 31f2287ef40248012202b33a003f19aa2d43b2dd
+  data.tar.gz: 1c48f2fd6d1d77d78c4c0dac2aa3e794ed9d32e3
 SHA512:
-  metadata.gz: 4161a49d7de22ed8528970d7a90afd4231ddd4e7a311aff1f836cbcd34cdaddde9b13719bd3fba239045dd8f636f4e5a226714354dab57bbf2f10cbe89e3a2d0
-  data.tar.gz: c4af15defeecf0ed3c9a36c3de15ce980f157b1baafac5d1b43a5d393c0067d3a3c3fdef7b0b9634cf116d191e899e920b9cdd88a719f0f3ca5a08c17f73c1ca
+  metadata.gz: d40f600f404342223fa28d062f23086b2d22b19875f2b324a23b1bb6b4dba8526b2637b32aaf6d74337dd26ce6bcf26e152a221510e6bc512901ef36747a3f0e
+  data.tar.gz: 674b3c269064d693e6d06b3aad48cb3f4cd2346600240d14e2a08a90955a3a023e0f79e822cb309db2f19b7c52b016d70921e2b0cd252c0f7546031a545ebeaf

data/CHANGES.md

@@ -1,4 +1,9 @@
-## 0.2.0
+## 0.2.1 (28 September 2016)
+
+- Fixed issue where `Datacite::Mapping::Date` objects initialized with Ruby
+  `Dates` or `Datetimes` couldn't be serialized to XML.
+
+## 0.2.0 (26 September 2016)
 
 - Datacite 4.0 support:
   - reading supports both Datacite 3 and Datacite 4

data/README.md

@@ -88,6 +88,8 @@ To create XML from a `Resource` object, use `Resource.write_xml`, `Resource.save
 | file path         | `Resource.save_to_file` |
 | `REXML::Element`  | `Resource.save_xml`     |
 
+Example:
+
 ```ruby
 resource.write_xml
 #  => "<resource xsi:schemaLocation='http://datacite.org/schema/kernel-4 …

data/lib/datacite/mapping/date.rb

@@ -49,6 +49,7 @@ module Datacite
     #   @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 Comparable
       include XML::Mapping
 
       attr_reader :date_value
@@ -81,7 +82,24 @@ module Datacite
         else
           fail ArgumentError, "Unable to parse date value #{val}"
         end
-        @value = val
+        @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].each do |v|
+          order = send(v) <=> other.send(v)
+          return order if order.nonzero?
+        end
+        0
+      end
+
+      def hash
+        [date_value, range_start, range_end].hash
+      end
+
+      def to_s
+        @value
       end
 
       private

data/lib/datacite/mapping/date_value.rb

@@ -32,6 +32,7 @@ module Datacite
       attr_reader :nsec
       attr_reader :date
       attr_reader :zone
+      attr_reader :iso_value
 
       # Creates a new {DateValue}.
       #
@@ -43,7 +44,7 @@ module Datacite
         @year = to_year(val)
         @month = to_month(val)
         @day = to_day(val)
-        iso_value = val.respond_to?(:iso8601) ? val.iso8601 : val.to_s
+        @iso_value = val.respond_to?(:iso8601) ? val.iso8601 : val.to_s
         if datetime && iso_value.include?('T')
           @hour = datetime.hour
           @minute = datetime.minute
@@ -68,11 +69,14 @@ module Datacite
       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(', ') + ')'
+        @str_value = begin
+          str_value = iso_value
+          if nsec && nsec != 0
+            frac_str = (nsec / 1e9).to_s.sub('0', '')
+            str_value.sub!(/(T[0-9]+:[0-9]+:[0-9]+)/, "\\1#{frac_str}") unless str_value.include?(frac_str)
+          end
+          str_value
+        end
       end
 
       private

data/lib/datacite/mapping/module_info.rb

@@ -4,7 +4,7 @@ module Datacite
     NAME = 'datacite-mapping'.freeze
 
     # The version of this gem
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.2.1'.freeze
 
     # The copyright notice for this gem
     COPYRIGHT = 'Copyright (c) 2016 The Regents of the University of California'.freeze

data/spec/unit/datacite/mapping/date_spec.rb

@@ -29,6 +29,24 @@ module Datacite
         it 'fails on range-like non-ranges' do
           expect { Date.new(value: '5/18/72', type: DateType::VALID) }.to raise_error(ArgumentError)
         end
+
+        it 'saves closed ranges to XML' do
+          date = Date.new(value: '1997-07-16T19:30+10:00/1997-07-17T15:30-05:00', type: DateType::AVAILABLE)
+          expected_xml = '<date dateType="Available">1997-07-16T19:30+10:00/1997-07-17T15:30-05:00</date>'
+          expect(date.save_to_xml).to be_xml(expected_xml)
+        end
+
+        it 'saves right open ranges to XML' do
+          date = Date.new(value: '1997-07-16T19:30+10:00/', type: DateType::AVAILABLE)
+          expected_xml = '<date dateType="Available">1997-07-16T19:30+10:00/</date>'
+          expect(date.save_to_xml).to be_xml(expected_xml)
+        end
+
+        it 'saves left open ranges to XML' do
+          date = Date.new(value: '/1997-07-17T15:30-05:00', type: DateType::AVAILABLE)
+          expected_xml = '<date dateType="Available">/1997-07-17T15:30-05:00</date>'
+          expect(date.save_to_xml).to be_xml(expected_xml)
+        end
       end
 
       describe 'type=' do
@@ -51,6 +69,24 @@ module Datacite
           expected_xml = '<date dateType="Available">1914-08-04T11:01:06.0123+01:00</date>'
           expect(d.save_to_xml).to be_xml(expected_xml)
         end
+
+        it 'writes XML with all value types' do
+          {
+            with_date_time: DateTime.new(1914, 8, 4, 11, 1, 6.0123, '+1'),
+            with_date: ::Date.new(1914, 8, 4),
+            with_year: 1914,
+            with_year_str: '1914',
+            with_year_month: '1914-08',
+            iso8601: '1914-08-04T11:01+01:00',
+            iso8601_secs: '1914-08-04T11:01:06+01:00',
+            iso8601_frac: '1914-08-04T11:01:06.0123+01:00'
+          }.each do |k, v|
+            d = Date.new(value: v, type: DateType::AVAILABLE)
+            xml = d.save_to_xml
+            parsed = Date.parse_xml(xml)
+            expect(parsed).to eq(d), "Expected #{d}, got #{parsed} for #{k}"
+          end
+        end
       end
 
       describe '#load_from_xml' do

data/spec/unit/datacite/mapping/date_value_spec.rb

@@ -4,6 +4,9 @@ module Datacite
   module Mapping
     describe DateValue do
 
+      attr_reader :values
+      attr_reader :dates
+
       before(:all) do
         @values = {
           with_date_time: DateTime.new(1914, 8, 4, 11, 1, 6.0123, '+1'),
@@ -15,12 +18,12 @@ module Datacite
           iso8601_secs: '1914-08-04T11:01:06+01:00',
           iso8601_frac: '1914-08-04T11:01:06.0123+01:00'
         }
-        @dates = @values.map { |format, v| [format, DateValue.new(v)] }.to_h
+        @dates = values.map { |format, v| [format, DateValue.new(v)] }.to_h
       end
 
       describe '#initialize' do
         it 'accepts a DateTime' do
-          d = @dates[:with_date_time]
+          d = dates[:with_date_time]
           expect(d).to be_a(DateValue)
           expect(d.year).to eq(1914)
           expect(d.month).to eq(8)
@@ -33,7 +36,7 @@ module Datacite
         end
 
         it 'accepts a DateValue' do
-          d = @dates[:with_date]
+          d = dates[:with_date]
           expect(d).to be_a(DateValue)
           expect(d.year).to eq(1914)
           expect(d.month).to eq(8)
@@ -42,26 +45,26 @@ module Datacite
         end
 
         it 'accepts a year as an integer' do
-          d = @dates[:with_year]
+          d = dates[:with_year]
           expect(d).to be_a(DateValue)
           expect(d.year).to eq(1914)
         end
 
         it 'accepts a year as a string' do
-          d = @dates[:with_year_str]
+          d = dates[:with_year_str]
           expect(d).to be_a(DateValue)
           expect(d.year).to eq(1914)
         end
 
         it 'accepts a year-month string' do
-          d = @dates[:with_year_month]
+          d = dates[:with_year_month]
           expect(d).to be_a(DateValue)
           expect(d.year).to eq(1914)
           expect(d.month).to eq(8)
         end
 
         it 'accepts an ISO 8601 DateValue string with hours and minutes' do
-          d = @dates[:iso8601]
+          d = dates[:iso8601]
           expect(d).to be_a(DateValue)
           expect(d.year).to eq(1914)
           expect(d.month).to eq(8)
@@ -72,7 +75,7 @@ module Datacite
         end
 
         it 'accepts an ISO 8601 DateValue string with hours, minutes, and seconds' do
-          d = @dates[:iso8601_secs]
+          d = dates[:iso8601_secs]
           expect(d).to be_a(DateValue)
           expect(d.year).to eq(1914)
           expect(d.month).to eq(8)
@@ -84,7 +87,7 @@ module Datacite
         end
 
         it 'accepts an ISO 8601 DateValue string with hours, minutes, seconds, and fractional seconds' do
-          d = @dates[:iso8601_frac]
+          d = dates[:iso8601_frac]
           expect(d).to be_a(DateValue)
           expect(d.year).to eq(1914)
           expect(d.month).to eq(8)
@@ -129,12 +132,21 @@ module Datacite
       end
 
       describe '#to_s' do
-        it 'includes all relevant fields' do
-          val = '1914-08-04T11:01:06.0123+01:00'
-          str = DateValue.new(val).to_s
-          val.split(/[-T:+.]/).each do |v|
-            v = 12_300_000.to_s if v == '0123' # special case nanos
-            expect(str).to include(v)
+        it 'returns an ISO-8601 string for all formats' do
+          expected = {
+            with_date_time: '1914-08-04T11:01:06.0123+01:00',
+            with_date: '1914-08-04',
+            with_year: '1914',
+            with_year_str: '1914',
+            with_year_month: '1914-08',
+            iso8601: '1914-08-04T11:01+01:00',
+            iso8601_secs: '1914-08-04T11:01:06+01:00',
+            iso8601_frac: '1914-08-04T11:01:06.0123+01:00'
+          }
+          dates.each do |format, v|
+            actual_str = v.to_s
+            expected_str = expected[format]
+            expect(actual_str).to eq(expected_str), "expected '#{expected_str}' for #{format}, got '#{actual_str}'"
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datacite-mapping
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typesafe_enum