xmlmapper 0.7.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cb50a11700e4020d9084eda1c4cf15a4aafe660a
-  data.tar.gz: 97d7d192b1588615f37fe137cac1bbc80af791da
+SHA256:
+  metadata.gz: cb7a9048f9c5776bd95d515a304c9eb10874458681f2e271fc0e9be7ee2779d7
+  data.tar.gz: e529bfda1112b716a8941d0a43437c5178451473219e3a407aee9c3fbb1a1f1a
 SHA512:
-  metadata.gz: d8a935ac03e952b23034bf5dde9069aad8752f9d85fcb782abe5d194b05535584dd508493c69c6d8edd7c3e989b4d9f2c318765210bb886f4dcbfda0153731cf
-  data.tar.gz: 49ff18e349ddca6aff4ec59aa9848ee6777bb4e192a249b18a12458e3373c6ffef00a418eca277b3ee4882603f20ad91747c577e9ae47fe16e5a511c76c08f54
+  metadata.gz: 490ea2b98896969d34d5a8f91fb8dbc254b46d8d2d36cd740eabdf0dececfd986307ed615df7bbede06f570cb5ca43472e0305bdfc53d692f26f80405dcfd267
+  data.tar.gz: f77dc1661532920e0f8db940ccb22d6b2ed268987a12ad01bb3293691127212399481f21db2dbe72851103e39b07752ba03fbf08b58d4c872efb4b18a6ce8564

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.8.1 / 2021-08-13
+
+* Version 0.8.0 fixed a bug with newer versions of nokogiri, however due to the way this fix works it breaks compatability with
+  older versions so we now added `'nokogiri', '~> 1.11'` as dependency 
+* Update gemspec
+
+## 0.8.0 / 2021-08-12
+
+### WARNING: COMPATABILITY (see 0.8.1)
+* [Fix](https://github.com/digidentity/xmlmapper/pull/2) missing namespace when adding a child
+
 ## 0.7.0
 
 * Set xml_value with a non canonicalized version

data/README.md

@@ -1,7 +1,7 @@
-Xmlmapper
+XmlMapper
 ===========
 
-Xmlmapper allows you to parse XML data and convert it quickly and easily into ruby data structures.
+XmlMapper allows you to parse XML data and convert it quickly and easily into ruby data structures.
 
 This project is a fork of the great work done first by
 [jnunemaker](https://github.com/jnunemaker/happymapper).

data/lib/xmlmapper.rb

@@ -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.1"
+  VERSION = '0.8.1'.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.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Damien Le Berrigaud
@@ -10,10 +10,12 @@ authors:
 - Roland Swingler
 - Etienne Vallette d'Osia
 - Franklin Webber
+- Benoist Claassen
+- Johnny Dongelmans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2021-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -21,14 +23,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -45,7 +47,7 @@ dependencies:
         version: '2.8'
 description: Object to XML Mapping Library, using Nokogiri (fork from John Nunemaker's
   Happymapper)
-email: bclaassen@digidentity.eu
+email: jdongelmans@digidentity.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -90,6 +92,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
@@ -109,7 +112,7 @@ files:
 - spec/xmlmapper_parse_spec.rb
 - spec/xmlmapper_spec.rb
 - spec/xpath_spec.rb
-homepage: http://github.com/digidentity/xmlmapper
+homepage: https://github.com/digidentity/xmlmapper
 licenses:
 - MIT
 metadata: {}
@@ -121,17 +124,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Provides a simple way to map XML to Ruby Objects and back again.
 test_files:
 - spec/attribute_default_value_spec.rb
@@ -162,6 +164,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