xml-mapping_extensions 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fea3e32640619a2a820288fe42d28a8087062dc
-  data.tar.gz: f141e3b7ccc655cc8f2a09141c0e32f266dac8c4
+  metadata.gz: 58fe30758a9f3eee417329e21e489a1fcb05cee3
+  data.tar.gz: 5ce03257e351534e12cd07bbe7c0ccfa6e4e5689
 SHA512:
-  metadata.gz: 6530a2a270d47f95a11d909304b0899080cf315d6f6e7929ff2ac5d6400479130d2dfd7be8a5ea77ebbd9450f5ac1f129d11bb2b1aa1e5c0deac41d9b4305b4c
-  data.tar.gz: 8db7ece8cf07717ddecb34f837f71dd68792f47e4e593bfd36db241061030839d1b1f4982ae184bcd519c6d4110d5bb966e98442b6cc67b0310fc9273d36ccb3
+  metadata.gz: 470de71e5c996ec025d632218bb7f4a626f22362bcf345dd079b8107a6f3053a9868de32efd7b9283c0cf8ef660f3a4010a2b9fb8d01b40c7066b28fcfd114c6
+  data.tar.gz: 0747764d15df2ce7c9441985b6417f071e718c955e69959651295ea7a82302ad127612d71f92a8e0ee2f5c7390613b0dfea55f9bc9c77fb97cbe364ba76ffc66

data/CHANGES.md

@@ -1,3 +1,8 @@
-## 0.1.0 (21 Sep 2015)
+## 0.1.1 (24 September 2015)
+
+- Added support for UTC "Zulu" time designator to `DateNode`
+- Added example to `example.rb` and README
+
+## 0.1.0 (21 September 2015)
 
 - Initial release

data/README.md

@@ -1,5 +1,8 @@
-# XML::MappingExtensions [![Build Status](https://travis-ci.org/dmolesUC3/xml-mapping_extensions.png?branch=master)](https://travis-ci.org/dmolesUC3/xml-mapping_extensions) [![Code Climate](https://codeclimate.com/github/dmolesUC3/xml-mapping_extensions.png)](https://codeclimate.com/github/dmolesUC3/xml-mapping_extensions) [![Inline docs](http://inch-ci.org/github/dmolesUC3/xml-mapping_extensions.png)](http://inch-ci.org/github/dmolesUC3/xml-mapping_extensions)
+# XML::MappingExtensions
 
+[![Build Status](https://travis-ci.org/dmolesUC3/xml-mapping_extensions.png?branch=master)](https://travis-ci.org/dmolesUC3/xml-mapping_extensions)
+[![Code Climate](https://codeclimate.com/github/dmolesUC3/xml-mapping_extensions.png)](https://codeclimate.com/github/dmolesUC3/xml-mapping_extensions)
+[![Inline docs](http://inch-ci.org/github/dmolesUC3/xml-mapping_extensions.png)](http://inch-ci.org/github/dmolesUC3/xml-mapping_extensions)
 
 Additional mapping nodes and other utility classes for working with
 [XML::Mapping](http://multi-io.github.io/xml-mapping/).
@@ -24,3 +27,85 @@ to be registered with the XML mapping engine.
 - `TimeNode`: ISO 8601 strings to `Time` objects
 - `UriNode`: maps URI strings to `URI` objects
 - `MimeTypeNode`: maps MIME type strings to `MIME::Type` objects
+
+### Example
+
+```ruby
+require 'xml/mapping_extensions'
+require 'rexml/document'
+
+class MyElem
+  include ::XML::Mapping
+
+  root_element_name 'my_elem'
+
+  date_node :plain_date, 'plain_date'
+  date_node :zulu_date, 'zulu_date', zulu: true
+  time_node :time, 'time'
+  uri_node :uri, 'uri'
+  mime_type_node :mime_type, 'mime_type'
+end
+```
+
+#### Reading XML:
+
+```ruby
+xml_str = "<my_elem>
+  <plain_date>1999-12-31</plain_date>
+  <zulu_date>2000-01-01Z</zulu_date>
+  <time>2000-01-01T02:34:56Z</time>
+  <uri>http://example.org</uri>
+  <mime_type>text/plain</mime_type>
+</my_elem>"
+
+xml_doc = REXML::Document.new(xml_str)
+xml_elem = xml_doc.root
+
+elem = MyElem.load_from_xml(xml_elem)
+
+puts elem.plain_date.inspect
+puts elem.zulu_date.inspect
+puts elem.time.inspect
+puts elem.uri.inspect
+puts elem.mime_type.inspect
+```
+
+Outputs
+
+```
+#<Date: 1999-12-31 ((2451544j,0s,0n),+0s,2299161j)>
+#<Date: 2000-01-01 ((2451545j,0s,0n),+0s,2299161j)>
+2000-01-01 02:34:56 UTC
+#<URI::HTTP http://example.org>
+#<MIME::Type:0x007f864bdc4f78 @friendly={"en"=>"Text File"}, @system=nil, @obsolete=false, @registered=true, @use_instead=nil, @signature=false, @content_type="text/plain", @raw_media_type="text", @raw_sub_type="plain", @simplified="text/plain", @i18n_key="text.plain", @media_type="text", @sub_type="plain", @docs=[], @encoding="quoted-printable", @extensions=["txt", "asc", "c", "cc", "h", "hh", "cpp", "hpp", "dat", "hlp", "conf", "def", "doc", "in", "list", "log", "markdown", "md", "rst", "text", "textile"], @references=["IANA", "RFC2046", "RFC3676", "RFC5147"], @xrefs={"rfc"=>["rfc2046", "rfc3676", "rfc5147"]}>
+```
+
+#### Writing XML:
+
+```ruby
+elem = MyElem.new
+elem.plain_date = Date.new(1999, 12, 31)
+elem.zulu_date = Date.new(2000, 1, 1)
+elem.time = Time.utc(2000, 1, 1, 2, 34, 56)
+elem.uri = URI('http://example.org')
+elem.mime_type = MIME::Types['text/plain'].first
+
+xml = elem.save_to_xml
+
+formatter = REXML::Formatters::Pretty.new
+formatter.compact = true
+
+puts(formatter.write(xml, ""))
+```
+
+Outputs:
+
+```xml
+<my_elem>
+  <plain_date>1999-12-31</plain_date>
+  <zulu_date>2000-01-01Z</zulu_date>
+  <time>2000-01-01T02:34:56Z</time>
+  <uri>http://example.org</uri>
+  <mime_type>text/plain</mime_type>
+</my_elem>
+```

data/example.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+require 'xml/mapping_extensions'
+require 'rexml/document'
+
+class MyElem
+  include ::XML::Mapping
+
+  root_element_name 'my_elem'
+
+  date_node :plain_date, 'plain_date'
+  date_node :zulu_date, 'zulu_date', zulu: true
+  time_node :time, 'time'
+  uri_node :uri, 'uri'
+  mime_type_node :mime_type, 'mime_type'
+end
+
+# Reading XML
+
+xml_str = "<my_elem>
+  <plain_date>1999-12-31</plain_date>
+  <zulu_date>2000-01-01Z</zulu_date>
+  <time>2000-01-01T02:34:56Z</time>
+  <uri>http://example.org</uri>
+  <mime_type>text/plain</mime_type>
+</my_elem>"
+
+xml_doc = REXML::Document.new(xml_str)
+xml_elem = xml_doc.root
+
+elem = MyElem.load_from_xml(xml_elem)
+
+puts elem.plain_date.inspect
+puts elem.zulu_date.inspect
+puts elem.time.inspect
+puts elem.uri.inspect
+puts elem.mime_type.inspect
+
+# Writing XML
+
+elem = MyElem.new
+elem.plain_date = Date.new(1999, 12, 31)
+elem.zulu_date = Date.new(2000, 1, 1)
+elem.time = Time.utc(2000, 1, 1, 2, 34, 56)
+elem.uri = URI('http://example.org')
+elem.mime_type = MIME::Types['text/plain'].first
+
+xml = elem.save_to_xml
+
+formatter = REXML::Formatters::Pretty.new
+formatter.compact = true
+
+puts(formatter.write(xml, ""))
+
+

data/lib/xml/mapping_extensions/date_node.rb

@@ -8,6 +8,18 @@ module XML
     # Known limitation: loses time zone info
     class DateNode < NodeBase
 
+      def initialize(*args)
+        super
+      end
+
+      # Whether date should be output with UTC "Zulu" time
+      # designator ("Z")
+      # @return [Boolean, nil] True if date should be output
+      #   with "Z" time designator, false or nil otherwise
+      def zulu
+        @options[:zulu]
+      end
+
       # param xml_text [String] an XML Schema date
       # @return [Date] the value as a `Date`
       def to_value(xml_text)
@@ -18,7 +30,8 @@ module XML
       # @return [String] the value as an XML Schema date string, without
       #   time zone information
       def to_xml_text(value)
-        value.xmlschema
+        text = value.xmlschema
+        zulu ? "#{text}Z" : text
       end
     end
     ::XML::Mapping.add_node_class DateNode

data/lib/xml/mapping_extensions/version.rb

@@ -1,6 +1,6 @@
 module XML
   module MappingExtensions
     # The version of this gem
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/spec/unit/xml/mapping_extensions/date_node_spec.rb

@@ -5,9 +5,10 @@ module XML
     class DateNodeSpecElem
       include ::XML::Mapping
       date_node :date, '@date', default_value: nil
+      date_node :zulu_date, '@zulu_date', default_value: nil, zulu: true
 
       def self.from_str(date_str)
-        xml_string = "<elem date='#{date_str}'/>"
+        xml_string = "<elem date='#{date_str}' zulu_date='#{date_str}'/>"
         doc = REXML::Document.new(xml_string)
         load_from_xml(doc.root)
       end
@@ -25,6 +26,13 @@ module XML
         xml.attributes['date']
       end
 
+      def to_zulu_text(date)
+        elem = DateNodeSpecElem.new
+        elem.zulu_date = date
+        xml = elem.save_to_xml
+        xml.attributes['zulu_date']
+      end
+
       it 'parses a date' do
         actual = to_date('2002-09-24')
         expected = Date.new(2002, 9, 24)
@@ -49,6 +57,12 @@ module XML
         expect(actual).to eq(expected)
       end
 
+      it 'outputs a UTC "zulu" date (time zone designator "Z")' do
+        expected = '2002-09-24Z'
+        actual = to_zulu_text(Date.new(2002, 9, 24))
+        expect(actual).to eq(expected)
+      end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml-mapping_extensions
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -166,6 +166,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- example.rb
 - lib/xml/mapping_extensions.rb
 - lib/xml/mapping_extensions/date_node.rb
 - lib/xml/mapping_extensions/enum_node_base.rb
@@ -203,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Some extensions for for XML::Mapping