xmlmapper 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 92105182b50fec5c2c9b4d00664c6807b2c51d01
-  data.tar.gz: 8721d8e5db3c52d269db18d592ad2742e72199e2
+SHA256:
+  metadata.gz: 6f441ea6ddce1f32eefcb965b6c4e3188ba70217a363433044b425ee4ba5aaf7
+  data.tar.gz: 0ebf4f7fd0919509aa7fa12488ac17c66322fd6c53c4b8c541087bb50c190501
 SHA512:
-  metadata.gz: 8d06c8b61063ca2234f4a720e7b19c14f4076a0befc7448f26b120647a3281aec2ed395f9f3a8e91fa221a13409ef3af1b15edc83fad407832d9929c0836ca84
-  data.tar.gz: b6a4763251048f38892b364579678e9367dc6dda150539b3f88f2c4fc064b4e0778bfad40c73d0aabca7a34408c7e1c1361b3e0be04898b12e21f233285dd4fe
+  metadata.gz: 3ee1dad25a3fb5654c6a49d0c4d34fc466f65968c1b123b5eeb77007097d0b7ceaa47fa78c896f7f65f2d91bab3c97c1448bf9aa93edfc162388940b5ff5633a
+  data.tar.gz: af8e018ec9910204b0465113f886e8f2c900e822058227e8841ab2b970984d46b8d0943eed6bad643dda635ef1fb7d0c8c43ac04030ab8a9977a1c6a9ff9fe33

data/lib/xmlmapper.rb

@@ -437,8 +437,8 @@ module XmlMapper
           if obj.respond_to?('xml_value=')
             # n.namespaces.each {|name,path| n[name] = path }
 
-            # obj.xml_value = n.canonicalize(Nokogiri::XML::XML_C14N_EXCLUSIVE_1_0, n.document.collect_namespaces.keys.map { |name| name.split(":").last })
-            obj.xml_value = n.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+            obj.xml_value = n.canonicalize(Nokogiri::XML::XML_C14N_EXCLUSIVE_1_0, n.document.collect_namespaces.keys.map { |name| name.split(":").last })
+            # obj.xml_value = n.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
           end
 
           if obj.respond_to?('xml_node=')
@@ -687,7 +687,34 @@ 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 or with Nokogiri version >= 1.12.0 (libxml >= 2.9.12),
+            # the 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 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' || Nokogiri.uses_libxml?('>= 2.9.12')) && !registered_namespaces.empty?
+              ns = registered_namespaces.keys.first.to_sym
+              xml[ns].send("#{tag}_","")
+            else
+              xml.send("#{tag}_","")
+            end
           end
 
           #

data/lib/xmlmapper/text_node.rb

@@ -2,7 +2,11 @@ module XmlMapper
   class TextNode < Item
 
     def find(node, namespace, xpath_options)
-      yield(node.children.detect{|c| c.text?})
+      if node.children.any? {|c| c.text?}
+        yield(node)
+      else
+        yield(nil)
+      end
     end
   end
 end

data/lib/xmlmapper/version.rb

@@ -1,3 +1,3 @@
 module XmlMapper
-  VERSION = "0.7.0"
+  VERSION = '0.8.0'.freeze
 end

data/spec/fixtures/text_node_with_comment.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<textnode>With <!----> Comment</textnode>

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
 

data/spec/xmlmapper_spec.rb

@@ -554,7 +554,6 @@ end
 class DefaultNamespaceCombi
   include XmlMapper
 
-
   register_namespace 'bk', "urn:loc.gov:books"
   register_namespace 'isbn', "urn:ISBN:0-395-36341-6"
   register_namespace 'p', "urn:loc.gov:people"
@@ -567,6 +566,14 @@ class DefaultNamespaceCombi
   element :author, String, :namespace => 'p', :tag => "author"
 end
 
+class TextNodeWithComment
+  include XmlMapper
+
+  tag 'textnode'
+
+  content :value, String
+end
+
 describe XmlMapper do
 
   describe "being included into another class" do
@@ -1134,4 +1141,13 @@ describe XmlMapper do
     end
   end
 
+  context 'text_node with comments' do
+    it 'returns the full text in the node' do
+      xml = fixture_file('text_node_with_comment.xml')
+      text_node = TextNodeWithComment.parse(xml, single: true)
+
+      expect(text_node.value).to eq "With  Comment"
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmlmapper
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Damien Le Berrigaud
@@ -90,6 +90,7 @@ files:
 - spec/fixtures/set_config_options.xml
 - spec/fixtures/statuses.xml
 - spec/fixtures/subclass_namespace.xml
+- spec/fixtures/text_node_with_comment.xml
 - spec/fixtures/unformatted_address.xml
 - spec/fixtures/wrapper.xml
 - spec/has_many_empty_array_spec.rb
@@ -128,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 3
 summary: Provides a simple way to map XML to Ruby Objects and back again.
@@ -162,6 +162,7 @@ test_files:
 - spec/fixtures/set_config_options.xml
 - spec/fixtures/statuses.xml
 - spec/fixtures/subclass_namespace.xml
+- spec/fixtures/text_node_with_comment.xml
 - spec/fixtures/unformatted_address.xml
 - spec/fixtures/wrapper.xml
 - spec/has_many_empty_array_spec.rb