xmlhash 1.3.5 → 1.3.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f72be19a08e60ff2efe59afb44753d23f3bb9eea969e98c6dbb80e03df376a8
+  data.tar.gz: e1114dead31f0e4ecedf639a22dac1f114ba136f21875183b35a65dd88867e5b
+SHA512:
+  metadata.gz: c57699c0ca0943c498b154dfefd9d9e2039fd05daf19427852417b634dd364b75c0f03280e0017ea1da04745684e82e19d68176ef3382c864db111c9dfb292c2
+  data.tar.gz: fb8689064ee31b7dcd827682ac0d25bbc1b7c8eed41284118d283ec6aecd59a076e984d37c9539b3dbbd70fdd8b75f940743004cc86fe1846c9e86fa5fcd2606

data/Gemfile

@@ -4,3 +4,4 @@ gem 'hoe'
 gem 'rake-compiler'
 gem 'pkg-config'
 gem 'json'
+gem 'minitest', '>= 5.0.0', group: :test

data/History.txt

@@ -1,3 +1,16 @@
+=== 1.3.8 / 2022-04-04
+
+* Do not replace entities while parsing
+
+=== 1.3.7 / 2016-07-04
+
+* Fix XML parsing: ignore comments and parse huge TXT nodes
+
+=== 1.3.6 / 2013-09-11
+
+* Wrap libxml2 parsing in a synchronize block - otherwise the stacking
+  will not work and it's too much work to make it reentrant
+
 === 1.3.5 / 2012-12-21 ("final edition")
 
 * Initialize result so we don't return something random in case of parse error

data/README.txt

@@ -37,7 +37,7 @@ and generate the RDoc.
 
 (The MIT License)
 
-Copyright (c) 2012 Stephan Kulow
+Copyright (c) 2012-2022 Stephan Kulow
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -7,6 +7,7 @@ require 'rake/extensiontask'
 Hoe.spec 'xmlhash' do
   developer('Stephan Kulow', 'coolo@suse.com')
   self.readme_file = 'README.txt'
+  self.license('MIT')
   self.spec_extras = { :extensions => ["ext/xmlhash/extconf.rb"] }
   self.extra_dev_deps << ['rake-compiler', '>= 0']
   self.extra_deps << ['pkg-config']

data/ext/xmlhash/extconf.rb

@@ -4,4 +4,5 @@ unless find_library('xml2', 'xmlAddID')
   abort "xml2 is missing.  please install libxml2"
 end
 $CFLAGS << ' ' + PackageConfig.new('libxml-2.0').cflags
+$CFLAGS += " -Werror "
 create_makefile('xmlhash/xmlhash')

data/ext/xmlhash/xmlhash.c

@@ -19,6 +19,7 @@
 static VALUE m_current = Qnil;
 static VALUE m_stack = Qnil;
 static VALUE m_cstring = Qnil;
+static VALUE m_mutex = Qnil;
 static VALUE m_result = Qnil;
 static VALUE m_xmlClass = Qnil;
 #ifdef HAVE_RUBY_ENCODING_H
@@ -150,6 +151,9 @@ void processNode(xmlTextReaderPtr reader)
 
   nodetype = xmlTextReaderNodeType(reader);
   
+  if (nodetype == XML_READER_TYPE_COMMENT)
+    return; // ignore
+
   if (nodetype == XML_READER_TYPE_END_ELEMENT) {
     xml_hash_end_element(name);
     assert(value == NULL);
@@ -192,6 +196,8 @@ void processNode(xmlTextReaderPtr reader)
 
 static VALUE parse_xml_hash(VALUE self, VALUE rb_xml)
 {
+  rb_mutex_lock(m_mutex);
+
   char *data;
   xmlTextReaderPtr reader;
   int ret;
@@ -209,7 +215,7 @@ static VALUE parse_xml_hash(VALUE self, VALUE rb_xml)
   memcpy(data, StringValuePtr(rb_xml), RSTRING_LEN(rb_xml));
 
   reader = xmlReaderForMemory(data, RSTRING_LEN(rb_xml), 
-			      NULL, NULL, XML_PARSE_NOENT | XML_PARSE_NOERROR | XML_PARSE_NOWARNING );
+			      NULL, NULL, XML_PARSE_NOERROR | XML_PARSE_NOWARNING | XML_PARSE_HUGE );
   init_XmlhashParserData();
 
   if (reader != NULL) {
@@ -228,6 +234,7 @@ static VALUE parse_xml_hash(VALUE self, VALUE rb_xml)
 #ifdef HAVE_RUBY_ENCODING_H
   m_current_encoding = 0;
 #endif
+  rb_mutex_unlock(m_mutex);
   return m_result;
 }
 
@@ -236,9 +243,11 @@ void Init_xmlhash()
   VALUE mXmlhash;
 
   LIBXML_TEST_VERSION
+  m_mutex = rb_mutex_new();
+  rb_global_variable(&m_mutex);
   mXmlhash = rb_define_module("Xmlhash");
   m_xmlClass = rb_define_class_under(mXmlhash, "XMLHash", rb_cHash);
-  rb_define_singleton_method(mXmlhash, "parse", &parse_xml_hash, 1);
+  rb_define_singleton_method(mXmlhash, "parse_int", &parse_xml_hash, 1);
   m_stack = rb_ary_new();
   rb_global_variable(&m_stack);
   m_cstring = rb_ary_new();

data/lib/xmlhash.rb

@@ -1,7 +1,7 @@
 require 'xmlhash/xmlhash'
 
 module Xmlhash
-  VERSION = '1.3.5'
+  VERSION = '1.3.8'
 
   class XMLHash < Hash
     
@@ -61,5 +61,11 @@ module Xmlhash
     def inspect
       "X(#{super})"
     end
+
+  end
+
+  def self.parse(str)
+    parse_int(str)
   end
-end 
+
+end

data/test/test_xmlhash.rb

@@ -1,123 +1,124 @@
 # encoding: UTF-8
 
-require "test/unit"
+require "minitest/autorun"
 require "xmlhash"
 require 'json'
-
-class TestXmlhash < Test::Unit::TestCase
-  def test_xml
-    xml = <<eos
-<request id="93651">
-  <action type="submit">
-    <source project="server:dns" package="pdns" rev="65"/>
-    <target project="openSUSE:Factory" package="pdns"/>
-  </action>
-  <state name="revoked" who="coolo" when="2011-12-19T13:20:50">
-    <comment/>
-  </state>
-  <review state="accepted" by_group="legal-auto" who="licensedigger" when="2011-11-25T15:09:55">
-    <comment>{"approve": "preliminary, version number changed"} &lt;!-- {
-  "dest": {
-    "ldb": {
-      "review": "done", 
-      "rpm_license": "GPLv2+", 
-      "status": "production", 
-      "version": "3.0.rc1"
-    }, 
-    "license": "GPLv2+", 
-    "version": "2.9.22"
-  }, 
-  "hint": [
-    "src('3.0') and dest('2.9.22') version numbers differ"
-  ], 
-  "plugin": "0.35", 
-  "src": {
-    "auto-co": "/api.opensuse.org/server:dns/pdns%3.0%r65", 
-    "license": "GPLv2+", 
-    "rev": "65", 
-    "version": "3.0"
-  }
-} --&gt;</comment>
-  </review>
-  <review state="new" by_group="factory-auto"/>
-  <history name="review" who="coolo" when="2011-11-25T15:02:53"/>
-  <history name="declined" who="coolo" when="2011-11-25T16:17:30">
-    <comment>please make sure to wait before these depencencies are in openSUSE:Factory: libopendbx-devel, libopendbx1, libopendbxplus1, opendbx-backend-pgsql</comment>
-  </history>
-  <description>update and factory fix (forwarded request 86230 from -miska-)</description>
-</request>
+require 'thread'
+
+Minitest::Test.make_my_diffs_pretty!
+
+Xml = <<~eos
+  <request id="93651">
+    <action type="submit">
+      <source project="server:dns" package="pdns" rev="65"/>
+      <target project="openSUSE:Factory" package="pdns"/>
+    </action>
+    <state name="revoked" who="coolo" when="2011-12-19T13:20:50">
+      <comment/>
+    </state>
+    <review state="accepted" by_group="legal-auto" who="licensedigger" when="2011-11-25T15:09:55">
+      <comment>Big comment</comment>
+    </review>
+    <review state="new" by_group="factory-auto"/>
+    <history name="review" who="coolo" when="2011-11-25T15:02:53"/>
+    <history name="declined" who="coolo" when="2011-11-25T16:17:30">
+      <comment>please make sure to wait before these depencencies are in openSUSE:Factory: libopendbx-devel, libopendbx1, libopendbxplus1, opendbx-backend-pgsql</comment>
+    </history>
+    <description>update and factory fix (forwarded request 86230 from -miska-)</description>
+  </request>
 eos
 
-    rubyoutput =  {"history"=> 
-      [ {"name"=>"review", "when"=>"2011-11-25T15:02:53", "who"=>"coolo"}, 
-        {"comment"=>"please make sure to wait before these depencencies are in openSUSE:Factory: libopendbx-devel, libopendbx1, libopendbxplus1, opendbx-backend-pgsql", 
-          "name"=>"declined", "when"=>"2011-11-25T16:17:30", "who"=>"coolo"}
-      ], 
-      "review"=> 
-      [
-       {"comment"=>"{\"approve\": \"preliminary, version number changed\"} <!-- {\n  \"dest\": {\n    \"ldb\": {\n      \"review\": \"done\", \n      \"rpm_license\": \"GPLv2+\", \n      \"status\": \"production\", \n      \"version\": \"3.0.rc1\"\n    }, \n    \"license\": \"GPLv2+\", \n    \"version\": \"2.9.22\"\n  }, \n  \"hint\": [\n    \"src('3.0') and dest('2.9.22') version numbers differ\"\n  ], \n  \"plugin\": \"0.35\", \n  \"src\": {\n    \"auto-co\": \"/api.opensuse.org/server:dns/pdns%3.0%r65\", \n    \"license\": \"GPLv2+\", \n    \"rev\": \"65\", \n    \"version\": \"3.0\"\n  }\n} -->", "by_group"=>"legal-auto", "when"=>"2011-11-25T15:09:55", "who"=>"licensedigger", "state"=>"accepted"}, {"by_group"=>"factory-auto", "state"=>"new"}], "action"=>{"type"=>"submit", "target"=>{"project"=>"openSUSE:Factory", "package"=>"pdns"}, "source"=>{"rev"=>"65", "project"=>"server:dns", "package"=>"pdns"}}, "id"=>"93651", "description"=>"update and factory fix (forwarded request 86230 from -miska-)", "state"=>{"comment"=>{}, "name"=>"revoked", "when"=>"2011-12-19T13:20:50", "who"=>"coolo"}}
-
-    1000.times {
-      ret = Xmlhash.parse(xml)
+Output = { "history" =>
+              [{ "name" => "review", "when" => "2011-11-25T15:02:53", "who" => "coolo" },
+               { "comment" => "please make sure to wait before these depencencies are in openSUSE:Factory: libopendbx-devel, libopendbx1, libopendbxplus1, opendbx-backend-pgsql",
+                 "name" => "declined", "when" => "2011-11-25T16:17:30", "who" => "coolo" }],
+           "review" =>
+              [
+                { "comment" => "Big comment",
+                  "by_group" => "legal-auto",
+                  "when" => "2011-11-25T15:09:55",
+                  "who" => "licensedigger",
+                  "state" => "accepted" },
+                { "by_group" => "factory-auto",
+                  "state" => "new" }
+              ], "action" => { "type" => "submit", "target" => { "project" => "openSUSE:Factory", "package" => "pdns" }, "source" => { "rev" => "65", "project" => "server:dns", "package" => "pdns" } }, "id" => "93651", "description" => "update and factory fix (forwarded request 86230 from -miska-)", "state" => { "comment" => {}, "name" => "revoked", "when" => "2011-12-19T13:20:50", "who" => "coolo" } }
+
+class TestXmlhash < Minitest::Test
+  def test_xml
+    1000.times { |i|
+      ret = Xmlhash.parse(Xml)
       GC.start
-      assert_equal ret, rubyoutput
+      assert_equal ret, Output
     }
- 
+
     10000.times {
-      ret = Xmlhash.parse(xml)
-      assert_equal ret, rubyoutput
-     }
+      ret = Xmlhash.parse(Xml)
+      assert_equal ret, Output
+    }
+  end
 
+  def test_threading
+    counter = Array.new(10, 100)
+    threads = []
+    10.times do |t|
+      threads << Thread.new do
+        while counter[t] > 0 do
+          ret = Xmlhash.parse(Xml)
+          counter[t] -= 1
+          assert_equal ret, Output
+        end
+      end
+    end
+    threads.each { |thr| thr.join }
   end
 
   def test_entry
-      xml = <<eos
-<?xml version='1.0' encoding='UTF-8'?>
-<directory count="4">
-   <entry name="Apache"/>
-   <entry name="Apache:APR_Pool_Debug"/>
-   <entry name="Apache:MirrorBrain"/>
-   <entry name="Apache:Modules"/>
-</directory>
-eos
+    xml = <<~eos
+      <?xml version='1.0' encoding='UTF-8'?>
+      <directory count="4">
+         <entry name="Apache"/>
+         <entry name="Apache:APR_Pool_Debug"/>
+         <entry name="Apache:MirrorBrain"/>
+         <entry name="Apache:Modules"/>
+      </directory>
+    eos
+
+    rubyoutput = { "count" => "4",
+                   "entry" =>
+                      [{ "name" => "Apache" },
+                       { "name" => "Apache:APR_Pool_Debug" },
+                       { "name" => "Apache:MirrorBrain" },
+                       { "name" => "Apache:Modules" }] }
 
-    rubyoutput = {"count" => "4",
-      "entry"=>
-      [{"name"=>"Apache"},
-       {"name"=>"Apache:APR_Pool_Debug"},
-       {"name"=>"Apache:MirrorBrain"},
-       {"name"=>"Apache:Modules"}]}
-    
     ret = Xmlhash.parse(xml)
     assert_equal ret, rubyoutput
 
     assert_equal ret.elements("entry").first.value("name"), "Apache"
-
   end
 
   def test_encoding
-     xml = "<?xml version='1.0' encoding='UTF-8'?><name>Adrian Schröter</name>"
+    xml = "<?xml version='1.0' encoding='UTF-8'?><name>Adrian Schröter</name>"
 
-     ret = Xmlhash.parse(xml)
-     assert_equal ret, "Adrian Schröter"
+    ret = Xmlhash.parse(xml)
+    assert_equal ret, "Adrian Schröter"
 
-     xml = "<?xml version='1.0' encoding='UTF-8'?><name value='Adrian Schröter'/>"
-     ret = Xmlhash.parse(xml)
-     assert_equal ret, {"value"=>"Adrian Schröter"}
+    xml = "<?xml version='1.0' encoding='UTF-8'?><name value='Adrian Schröter'/>"
+    ret = Xmlhash.parse(xml)
+    assert_equal ret, { "value" => "Adrian Schröter" }
 
-     assert_equal ret.get("value"), "Adrian Schröter"
+    assert_equal ret.get("value"), "Adrian Schröter"
   end
 
   def test_cdata
-    xml = <<eos
-<sourcediff key="7ebf6606bf56a9f952dda73f0d861738">
-   <new name="myfile" md5="299d8fe34c516b078c3d367e3fb460b9" size="12"/>
-    <diff lines="1">DummyContent</diff>
-</sourcediff>
-eos
+    xml = <<~eos
+      <sourcediff key="7ebf6606bf56a9f952dda73f0d861738">
+         <new name="myfile" md5="299d8fe34c516b078c3d367e3fb460b9" size="12"/>
+          <diff lines="1">DummyContent</diff>
+      </sourcediff>
+    eos
 
     ret = Xmlhash.parse(xml)
-    assert_equal ret['diff'], {"lines" => "1", "_content" => "DummyContent" }
+    assert_equal ret['diff'], { "lines" => "1", "_content" => "DummyContent" }
   end
 
   def test_empty
@@ -129,11 +130,16 @@ eos
   def test_garbage
     # unfortunately it's rather challening testing nothing is printed to stderr
     ret = Xmlhash.parse("asdasdaskdladka")
-    assert_equal nil, ret
+    assert_nil ret
+  end
+
+  def test_entities
+    ret = Xmlhash.parse("<ents><text>&lt;</text><text>&gt;</text></ents>")
+    assert_equal ret, {"text"=>["<", ">"]}
   end
 
   def test_utf8
-     xml = '<package name="libconfig" project="home:coolo">
+    xml = '<package name="libconfig" project="home:coolo">
   <title>libconfig &#8211; C/C++ Configuration File Library</title>
   <description>Libconfig is a simple library for processing structured configuration files, like this one: test.cfg. This file format is more compact and more readable than XML. And unlike XML, it is type-aware, so it is not necessary to do string parsing in application code.
 
@@ -154,12 +160,11 @@ The library includes bindings for both the C and C++ languages. It works on POSI
     xml.encode!('ISO-8859-1')
     xh = Xmlhash.parse(xml)
     assert_equal "ISO-8859-1", xh['title'].encoding.to_s
-    
+
     xml = '<?xml version="1.0" encoding="ISO-8859-1"?>
     <package><title>&#228;&#211;&#254;</title></package>'
     xml.encode!('US-ASCII')
     xh = Xmlhash.parse(xml)
     assert_equal "UTF-8", xh['title'].encoding.to_s
-
   end
 end

metadata

@@ -1,83 +1,80 @@
 --- !ruby/object:Gem::Specification
 name: xmlhash
 version: !ruby/object:Gem::Version
-  version: 1.3.5
-  prerelease: 
+  version: 1.3.8
 platform: ruby
 authors:
 - Stephan Kulow
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-12-21 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pkg-config
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
-description: ! 'A small C module that wraps libxml2''s xmlreader to parse a XML
-
-  string into a ruby hash'
+        version: '3.23'
+description: |-
+  A small C module that wraps libxml2's xmlreader to parse a XML
+  string into a ruby hash
 email:
 - coolo@suse.com
 executables: []
@@ -88,8 +85,8 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 files:
-- .autotest
-- .travis.yml
+- ".autotest"
+- ".travis.yml"
 - Gemfile
 - History.txt
 - Manifest.txt
@@ -99,33 +96,31 @@ files:
 - ext/xmlhash/xmlhash.c
 - lib/xmlhash.rb
 - test/test_xmlhash.rb
-- .gemtest
 homepage: https://github.com/coolo/xmlhash
-licenses: []
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/coolo/xmlhash
+post_install_message:
 rdoc_options:
-- --main
+- "--main"
 - README.txt
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: xmlhash
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
 summary: A small C module that wraps libxml2's xmlreader to parse a XML string into
   a ruby hash
-test_files:
-- test/test_xmlhash.rb
+test_files: []