xml-mapping_extensions 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f632745c95852e892e50841d1dae290012d7941
-  data.tar.gz: 308acdeaa42233881b291b2adce912641e50a993
+  metadata.gz: e6415479b9ea2414249436f8273893c81b8bfbdb
+  data.tar.gz: 3ada581c17b547c1961e48dd72003a4bcba3c03a
 SHA512:
-  metadata.gz: 3280dae9565abd98b0a8800ae66d217097ded31f275dde511b5c652760ad54f27462940b92b7ab539cb1550755af34773879e0fe10b38c866d97e0d290ddb140
-  data.tar.gz: 0885775aa138a6dacf348f572f9843a97994c036abeab239a36d75816ef19719af29803e54ff57889078d752f47dce67fbeb590e0c40e8c700ea1e14d858794e
+  metadata.gz: fb643f42be329656e36d04acf0f759fbc0edcc8636147c2164182f8a7182ef6415b43fcab66331a7b88ff8b00e696155632a6b2fb3e4e133fb84e211e0c63f21
+  data.tar.gz: 54ab830f4b26b5b56d6d7afe3e5ca8b8d4f8b5feec004ea89b84bb0aa609b5c801a1fcd67d37601dff0fd94fba99cac8dcf5d6b07d44c0930607ab4bf867d4bd

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 0.3.6 (2 May 2016)
+
+- Added `XML::MappingExtensions::Namespace`, with corresponding extension module
+  `XML::MappingExtensions::NamespacedElement`, to support more or less proper XML namespace
+  URLs and prefixing
+
 ## 0.3.5 (28 April 2016)
 
 - `DateNode`: Fix issues with `Date.xmlschema` misbehaving in a Rails / ActiveSupport environment

data/README.md

@@ -8,6 +8,19 @@
 Additional mapping nodes and other utility code for working with
 [XML::Mapping](http://multi-io.github.io/xml-mapping/).
 
+### Table of contents
+
+- [Extension methods](#extension-methods)
+- [Custom nodes](#custom-nodes)
+  - [Abstract nodes](#abstract-nodes)
+    - [Example](#example)
+  - [Provided implementations](#provided-implementations)
+    - [Example](#example-1)
+    - [Reading XML:](#reading-xml)
+    - [Writing XML:](#writing-xml)
+- [Namespaces](#namespaces)
+
+
 ## Extension methods
 
 This gem adds two methods, `write_xml` and `parse_xml`, to XML mapping instances and classes respectively, to reduce
@@ -153,12 +166,7 @@ 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, ""))
+puts(elem.write_xml)
 ```
 
 Outputs:
@@ -172,3 +180,52 @@ Outputs:
   <mime_type>text/plain</mime_type>
 </my_elem>
 ```
+
+## Namespaces
+
+The `Namespace` class encapsulates an XML namespace:
+
+```ruby
+namespace = Namespace.new(uri: 'http://example.org/px', schema_location: 'http://example.org/px.xsd')
+```
+
+Setting a namespace on a mapped object will cause that namespace to be written out when the object is saved
+to XML:
+
+```ruby
+obj = MyElem.new(...)
+obj.namespace = namespace
+
+puts obj.write_xml
+```
+
+Outputs:
+
+```xml
+<element xmlns='http://example.org/px/' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://example.org/px.xsd' attribute='123'>
+  element text
+  <child>child 1</child>
+  <child>child 2</child>
+</element>
+```
+
+Setting a `prefix` attribute on the namespace will set the prefix on each element in the output:
+
+```ruby
+namespace = Namespace.new(prefix: 'px', uri: 'http://example.org/px', schema_location: 'http://example.org/px.xsd')
+
+obj = MyElem.new(...)
+obj.namespace = namespace
+
+puts obj.write_xml
+```
+
+Outputs:
+
+```xml
+<px:element xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://example.org/px.xsd' xmlns:px='http://example.org/px/' attribute='123'>
+  element text
+  <px:child>child 1</px:child>
+  <px:child>child 2</px:child>
+</px:element>
+```

data/lib/xml/mapping_extensions/namespace.rb

@@ -0,0 +1,85 @@
+require 'uri'
+
+module XML
+  module MappingExtensions
+
+    # Encapsulates an XML namespace with a URI, schema location, and optional prefix.
+    class Namespace
+
+      # @return [String] the string form of the namespace URI
+      attr_reader :uri
+
+      # @return [String, nil] the namespace prefix
+      attr_reader :prefix
+
+      # @return [String] the schema location URI(s), as a space-separated string list
+      attr_reader :schema_location
+
+      # Creates a new {Namespace}
+      # @param uri [URI, String] the namespace URI
+      # @param prefix [String, nil] the namespace prefix
+      # @param schema_location [String] the schema location(s)
+      def initialize(uri:, prefix: nil, schema_location:)
+        @uri = uri.to_s
+        @prefix = prefix
+        @schema_location = schema_location.to_s
+      end
+
+      # Sets `uri` as the default (no-prefix) namespace on `elem`, with
+      # `schema_location` as the schema location.
+      # @param elem [REXML::Element] The element to set the namespace on
+      def set_default_namespace(elem) # rubocop:disable Style/AccessorMethodName
+        elem.add_namespace(uri)
+        elem.add_namespace('xsi', 'http://www.w3.org/2001/XMLSchema-instance')
+        elem.add_attribute('xsi:schemaLocation', schema_location)
+      end
+
+      # Sets `prefix` as the prefix for namespace `uri` on the specified document
+      # root element, and all its descendants that have that namespace.
+      # @param root [REXML::Element] The document root to set the namespace on
+      def set_prefix(root) # rubocop:disable Style/AccessorMethodName
+        return unless prefix
+        set_prefix_recursive(root)
+        root.add_namespace(nil) if root.attributes['xmlns'] == uri # clear the no-prefix namespace
+        root.add_namespace(prefix, uri)
+      end
+
+      private
+
+      def set_prefix_recursive(elem) # rubocop:disable Style/AccessorMethodName
+        return unless elem.namespace == uri
+        # name= with a prefixed name sets namespace by side effect and is the only way to actually output the prefix
+        elem.name = "#{prefix}:#{elem.name}"
+        elem.each_element { |e| set_prefix_recursive(e) }
+      end
+    end
+  end
+
+  # Patches `XML::Mapping` to add a namespace attribute and write the namespace
+  # out when saving to XML.
+  module NamespacedElement
+
+    # @return [Namespace, nil] the namespace, if any
+    attr_accessor :namespace
+
+    # Overrides `XML::Mapping#pre_save` to set the XML namespace and schema location
+    # on the generated element.
+    def pre_save(options = { mapping: :_default })
+      xml = super(options)
+      namespace.set_default_namespace(xml) if namespace
+      xml
+    end
+
+    # Overrides `XML::Mapping#save_to_xml` to set the XML namespace prefix on
+    # the generated element, and all its descendants that have that namespace.
+    def save_to_xml(options = { mapping: :_default })
+      xml = super(options)
+      namespace.set_prefix(xml) if namespace
+      xml
+    end
+  end
+
+  module Mapping
+    prepend NamespacedElement
+  end
+end

data/lib/xml/mapping_extensions/version.rb

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

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

@@ -3,7 +3,7 @@ require 'tempfile'
 
 module XML
   module Mapping
-    class ParseXMLSpecElement
+    class MXSpecObject
       include ::XML::Mapping
       include Comparable
 
@@ -29,17 +29,55 @@ module XML
 
     describe '#write_xml' do
       it 'writes an XML string' do
-        elem = ParseXMLSpecElement.new
-        elem.attribute = 123
-        elem.text = 'element text'
-        elem.children = ['child 1', 'child 2']
-        expected_xml = elem.save_to_xml
-        xml_string = elem.write_xml
+        obj = MXSpecObject.new
+        obj.attribute = 123
+        obj.text = 'element text'
+        obj.children = ['child 1', 'child 2']
+        expected_xml = obj.save_to_xml
+        xml_string = obj.write_xml
         expect(xml_string).to be_a(String)
         expect(xml_string).to be_xml(expected_xml)
       end
     end
 
+    describe ':namespace' do
+      it 'sets the namespace on save' do
+        uri = 'http://example.org/px/'
+        schema_location = 'http://example.org/px.xsd'
+        namespace = MappingExtensions::Namespace.new(uri: uri, prefix: 'px', schema_location: schema_location)
+
+        obj = MXSpecObject.new
+        obj.attribute = 123
+        obj.text = 'element text'
+        obj.children = ['child 1', 'child 2']
+        obj.namespace = namespace
+
+        namespace_attribs = "xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='#{schema_location}' xmlns:px='#{uri}'"
+        expected = "<px:element #{namespace_attribs} attribute='123'>element text<px:child>child 1</px:child><px:child>child 2</px:child></px:element>"
+
+        expect(obj.save_to_xml).to be_xml(expected)
+        puts(obj.write_xml)
+      end
+
+      it 'works without prefixes' do
+        uri = 'http://example.org/px/'
+        schema_location = 'http://example.org/px.xsd'
+        namespace = MappingExtensions::Namespace.new(uri: uri, schema_location: schema_location)
+
+        obj = MXSpecObject.new
+        obj.attribute = 123
+        obj.text = 'element text'
+        obj.children = ['child 1', 'child 2']
+        obj.namespace = namespace
+
+        namespace_attribs = "xmlns='#{uri}' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='#{schema_location}'"
+        expected = "<element #{namespace_attribs} attribute='123'>element text<child>child 1</child><child>child 2</child></element>"
+
+        expect(obj.save_to_xml).to be_xml(expected)
+        puts(obj.write_xml)
+      end
+    end
+
     module ClassMethods
       describe '#parse_xml' do
 
@@ -51,28 +89,28 @@ module XML
                          </element>'
           @xml_document = REXML::Document.new(@xml_string)
           @xml_element = @xml_document.root
-          @expected_element = ParseXMLSpecElement.load_from_xml(@xml_element)
+          @expected_element = MXSpecObject.load_from_xml(@xml_element)
         end
 
         it 'parses a String' do
-          elem = ParseXMLSpecElement.parse_xml(@xml_string)
-          expect(elem).to eq(@expected_element)
+          obj = MXSpecObject.parse_xml(@xml_string)
+          expect(obj).to eq(@expected_element)
         end
 
         it 'parses a REXML::Document' do
-          elem = ParseXMLSpecElement.parse_xml(@xml_document)
-          expect(elem).to eq(@expected_element)
+          obj = MXSpecObject.parse_xml(@xml_document)
+          expect(obj).to eq(@expected_element)
         end
 
         it 'parses a REXML::Element' do
-          elem = ParseXMLSpecElement.parse_xml(@xml_element)
-          expect(elem).to eq(@expected_element)
+          obj = MXSpecObject.parse_xml(@xml_element)
+          expect(obj).to eq(@expected_element)
         end
 
         it 'parses an IO' do
           xml_io = StringIO.new(@xml_string)
-          elem = ParseXMLSpecElement.parse_xml(xml_io)
-          expect(elem).to eq(@expected_element)
+          obj = MXSpecObject.parse_xml(xml_io)
+          expect(obj).to eq(@expected_element)
         end
 
         it 'parses a file' do
@@ -80,8 +118,8 @@ module XML
           begin
             xml_file.write(@xml_string)
             xml_file.rewind
-            elem = ParseXMLSpecElement.parse_xml(xml_file)
-            expect(elem).to eq(@expected_element)
+            obj = MXSpecObject.parse_xml(xml_file)
+            expect(obj).to eq(@expected_element)
           ensure
             xml_file.close(true)
           end

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

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module XML
+  module MappingExtensions
+    describe Namespace do
+      describe '#set_default_namespace' do
+        it 'sets the default namespace'
+        it 'sets the schema location'
+      end
+
+      describe '#set_prefix' do
+        it 'sets the prefix'
+        it 'clears the no-prefix namespace, if previously present'
+        it 'leaves an unrelated no-prefix namespace intact'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml-mapping_extensions
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2016-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -190,6 +190,7 @@ files:
 - lib/xml/mapping_extensions.rb
 - lib/xml/mapping_extensions/date_node.rb
 - lib/xml/mapping_extensions/mime_type_node.rb
+- lib/xml/mapping_extensions/namespace.rb
 - lib/xml/mapping_extensions/node_base.rb
 - lib/xml/mapping_extensions/time_node.rb
 - lib/xml/mapping_extensions/typesafe_enum_node.rb
@@ -202,6 +203,7 @@ files:
 - spec/unit/xml/mapping_extensions/date_node_spec.rb
 - spec/unit/xml/mapping_extensions/mapping_extensions_spec.rb
 - spec/unit/xml/mapping_extensions/mime_type_node_spec.rb
+- spec/unit/xml/mapping_extensions/namespace_spec.rb
 - spec/unit/xml/mapping_extensions/node_base_spec.rb
 - spec/unit/xml/mapping_extensions/time_node_spec.rb
 - spec/unit/xml/mapping_extensions/typesafe_enum_node_spec.rb
@@ -239,6 +241,7 @@ test_files:
 - spec/unit/xml/mapping_extensions/date_node_spec.rb
 - spec/unit/xml/mapping_extensions/mapping_extensions_spec.rb
 - spec/unit/xml/mapping_extensions/mime_type_node_spec.rb
+- spec/unit/xml/mapping_extensions/namespace_spec.rb
 - spec/unit/xml/mapping_extensions/node_base_spec.rb
 - spec/unit/xml/mapping_extensions/time_node_spec.rb
 - spec/unit/xml/mapping_extensions/typesafe_enum_node_spec.rb