xmlmapper 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb50a11700e4020d9084eda1c4cf15a4aafe660a
-  data.tar.gz: 97d7d192b1588615f37fe137cac1bbc80af791da
+  metadata.gz: b2751c0d13928157eb7e417f96fd379e3bb38a20
+  data.tar.gz: 6fcbf0cf9ffb20975b4d01b8d6e84e73eddf58b1
 SHA512:
-  metadata.gz: d8a935ac03e952b23034bf5dde9069aad8752f9d85fcb782abe5d194b05535584dd508493c69c6d8edd7c3e989b4d9f2c318765210bb886f4dcbfda0153731cf
-  data.tar.gz: 49ff18e349ddca6aff4ec59aa9848ee6777bb4e192a249b18a12458e3373c6ffef00a418eca277b3ee4882603f20ad91747c577e9ae47fe16e5a511c76c08f54
+  metadata.gz: f9acda69db552cdd80c9ec8adce3149f255ba9d8fc5a0c858e44423c7e3c36e099f21fab71960427dd52bbda8eafa9494a4d30744d56302b0cb5abeeffedf71b
+  data.tar.gz: 8ce8d94c5d2d26e9b0cc4f77ee74250e8cabfa19225ec724b0cb1853d8927181ffda43766c79549ff8f6f19acbb67e3451ecb312ad8154b99878c5bc116f6978

data/lib/xmlmapper.rb

@@ -687,7 +687,32 @@ module XmlMapper
           # an empty element will be written to the xml
           #
           if value.nil? && element.options[:single] && element.options[:state_when_nil]
-            xml.send("#{tag}_","")
+            # NOTE In JRuby 9.0.4.0+ and Nokogiri version 1.6.8, Nokogiri::XML::Builder::NodeBuilder
+            # does not retain the XML namespace prefix for an element when adding an element
+            # to a parent node.
+            #
+            # The namespace prefix must be specified when adding the node to its parent.
+            # This issue manifests when setting an element's :state_when_nil' option to true.
+            #
+            # This JRuby workaround is intended for XML element prefixes that originate from a
+            # single namespace defined in 'registered_namespaces'. If there are
+            # multiple namespaces defined in the 'registered_namespaces' array,
+            # then the first namespace is selected.
+            #
+            # Possible related open issues in Nokogiri:
+            # 1. Nokogiri under jruby fails to create namespaces named the same as a sibling
+            # https://github.com/sparklemotion/nokogiri/issues/1247
+            # 2. Attribute loses namespace when node moved
+            # https://github.com/sparklemotion/nokogiri/issues/1278
+            # 3. Adding namespace-less node to namespaced parent attaches the parent namespace to the child
+            # https://github.com/sparklemotion/nokogiri/issues/425
+            #
+            if RUBY_ENGINE == 'jruby' && !registered_namespaces.empty?
+              ns = registered_namespaces.keys.first.to_sym
+              xml[ns].send("#{tag}_","")
+            else
+              xml.send("#{tag}_","")
+            end
           end
 
           #

data/lib/xmlmapper/version.rb

@@ -1,3 +1,3 @@
 module XmlMapper
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

data/spec/to_xml_with_namespaces_spec.rb

@@ -138,8 +138,15 @@ describe "Saving #to_xml", "with xml namespaces" do
     end
 
     context "when an element has a 'state_when_nil' parameter" do
+      let(:element) { subject.xpath('address:description').first }
+
       it "saves an empty element" do
-        expect(subject.xpath('address:description').text).to eq ""
+        expect(element.text).to eq ""
+      end
+
+      it "the empty element has the correct namespace prefix from the array of registered namespaces" do
+        ns_scopes = element.namespace_scopes
+        expect(ns_scopes.select { |ns| ns == element.namespace }.first.prefix).to eq "address"
       end
     end
 
@@ -194,10 +201,27 @@ describe "Saving #to_xml", "with xml namespaces" do
     end
   end
 
+  # NOTE While the original implementation of the test below is correct, the order of XML namespaces
+  # in the XML generated by 'to_xml' differs under JRuby and MRI. In terms of information content,
+  # the XML produced under both platforms are identical. However, the difference in namespace ordering
+  # will produce different XML documents and consequently XML digests. The test below and various tests
+  # in the 'libsaml' gem will compare XML documents and digests of XML documents generated by 'to_xml' which,
+  # while informationally correct, have different values. Unfortunately, the cause of this behavior has
+  # not been identified. In the meantime, it is important to explictly call out this behavior.
+
   context 'namespace supplied by element declaration trumps namespace ' \
           'specified by element class' do
 
-    let(:expected_xml) do
+    let(:expected_xml_jruby) do
+      <<-XML.gsub(/^\s*\|/, '')
+        |<?xml version="1.0"?>
+        |<coffeemachine xmlns:beverage="http://beverages.org/Beverage/0.1" xmlns:coffee="http://coffee.org/Coffee/0.1">
+        |  <beverage:beverage name="coffee"/>
+        |</coffeemachine>
+      XML
+    end
+
+    let(:expected_xml_mri) do
       <<-XML.gsub(/^\s*\|/, '')
         |<?xml version="1.0"?>
         |<coffeemachine xmlns:coffee="http://coffee.org/Coffee/0.1" xmlns:beverage="http://beverages.org/Beverage/0.1">
@@ -224,7 +248,11 @@ describe "Saving #to_xml", "with xml namespaces" do
     it 'uses the element declaration namespace on the element' do
       machine = CoffeeMachine.new
       machine.beverage = Beverage.new.tap {|obj| obj.name = 'coffee'}
-      machine.to_xml.should be == expected_xml
+      if RUBY_ENGINE == 'jruby'
+        machine.to_xml.should be == expected_xml_jruby
+      else
+        machine.to_xml.should be == expected_xml_mri
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmlmapper
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Damien Le Berrigaud