libxml-ruby 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 754e55b0e4c9df24e3c7d72d501dea38da247d159696782ee32b8b88d09fc7ef
-  data.tar.gz: 710ec1aa2bcaaf57003c33495cf4e410551c6b741d0bab3f1ef1f5d29775fe1a
+  metadata.gz: 24e442a3a4f3343aaae6bc6b513309faccd90af0c9e985c6729d91821c9b29b4
+  data.tar.gz: 698be20e816f96b896c3b8bd7cc0bcf89e131d8b46466e16b9d804133b8f5af2
 SHA512:
-  metadata.gz: be0bfd383209044c12152db6ae98b87f326acd0c465a142a2ba0fab5563d06583a09c0f2d160e2c4874b44208966400246f9e3b871e4443f24cbcf1cd96787ea
-  data.tar.gz: 2dd60b858d16be0bf5f8405564d1add5c3163d2b1450ebc9c14ca29aecfcff99af2f4b5c7f07c79247e4a20110d9bebd5b597e6f62c664bdf85c4bd4b9fc9ac2
+  metadata.gz: 4f90226185c4146bb9b0212d489e8913148408f09e315ebedbca43e44914534c595b89bd3238fa7bfabf9e21f1d3613e4b11980a82b8d4f844bbe07bd862b788
+  data.tar.gz: 9313c21dc1405b5d0b015120e37a2310a7d337ff0948b2f2ed54c105e276b090c246314315c937f25444fa187c4fe101b618a8dec24b774deba85cb8e0ad414f

data/HISTORY

@@ -1,5 +1,9 @@
 = Release History
 
+== 5.0.1 / 2024-01-08
+
+* Fix broken Document#io method that was broken by switching Parsers to use keyword arguments
+
 == 5.0.0 / 2024-01-07
 
 * This release is major version bump because it removes access to global parser options
@@ -8,9 +12,8 @@
   Specifically, instead of setting global parser options, pass them directly to either Parsers
   or ParserContexts when creating them. Options are defined as constants in
   LibXML::XML::Parser::Options and LibXML::HTML::Parser::Options
-* Update Parser initialize methods to take named parameters instead of a hash table (you should *not*
-  have to update your code due to this change)
-* Fix broken compiliation with libxml2 version 2.12.0 (due to libxml2 header changes)
+* Update Parser initialize methods to take keyword parameters instead of a hash table (you may have to update your code due to this change)
+* Fix broken compilation with libxml2 version 2.12.0 (due to libxml2 header changes)
 * Add support for Ruby 3.3.*
 * Remove support for Ruby 2.7.* (gem should still work but is no longer tested)
 

data/README.rdoc

@@ -11,7 +11,7 @@ We think libxml-ruby is the best XML library for Ruby because:
 * Conformance - It passes all 1800+ tests from the OASIS XML Tests Suite
 
 == Requirements
-libxml-ruby requires Ruby 1.8.7 or higher.  It depends on libxml2 to
+libxml-ruby requires Ruby 3.0.0 or higher.  It depends on libxml2 to
 function properly.  libxml2, in turn, depends on:
 
 * libm      (math routines: very standard)
@@ -20,9 +20,9 @@ function properly.  libxml2, in turn, depends on:
 
 If you are running Linux or Unix you'll need a C compiler so the
 extension can be compiled when it is installed.  If you are running
-Windows, then install the x64-mingw32 gem or build it yourself using
-Devkit[http://rubyinstaller.org/add-ons/devkit/] or
-msys2[https://msys2.github.io/].
+Windows, then install the x64-mingw-ucr gem or build it yourself using (Ruby
+for Windows)[https://rubyinstaller.org/] or directly with msys2[https://msys2.github.io/]
+and ucrt64.
 
 == Installation
 The easiest way to install libxml-ruby is via RubyGems.  To install:
@@ -46,13 +46,9 @@ Or bundler:
 <tt>bundle install libxml-ruby</tt>
 
 If you are running Windows, then install the libxml-ruby-x64-mingw32 gem.
-The gem includes prebuilt extensions for Ruby 2.3.  These
-extensions are built using MinGW64 and libxml2 version 2.9.3,
-iconv version 1.14 and zlib version 1.2.8. Note these binaries
-are available in the <tt>lib\\libs</tt> directory.  To use them, put them
-on your <tt>PATH</tt>.
+The gem includes prebuilt extensions for Ruby 3.2 and 3.3.
 
-The gem also includes a Microsoft VC++ 2012 solution and XCode 5 project - these
+The gem also includes a Microsoft VC++ solution and XCode project - these
 are very useful for debugging.
 
 libxml-ruby's source codes lives on GitHub[https://github.com/xml4r/libxml-ruby].
@@ -128,11 +124,6 @@ For example:
 
 For simplicity's sake, the documentation uses the xml module in its examples.
 
-== Threading
-libxml-ruby fully supports native, background Ruby threads.  This of course
-only applies to Ruby 1.9.x and higher since earlier versions of Ruby do not
-support native threads.
-
 == Tests
 
 To run tests you first need to build the shared libary:
@@ -143,7 +134,7 @@ Once you have build the shared libary, you can then run tests using rake:
 
   rake test
 
-+Travis build status: {<img src="https://travis-ci.org/xml4r/libxml-ruby.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/xml4r/libxml-ruby]
++Build status: {rdoc-image:https://github.com/xml4r/libxml-ruby/actions/workflows/mri.yml/badge.svg}[https://github.com/xml4r/libxml-ruby/actions/workflows/mri.yml]
 
 == Performance
 

data/ext/libxml/ruby_xml_dtd.c

@@ -124,112 +124,118 @@ static VALUE rxml_dtd_type(VALUE self)
 
 /*
  * call-seq:
- *    XML::Dtd.new("DTD string") -> dtd
- *    XML::Dtd.new("public", "system") -> dtd
- *    XML::Dtd.new("name", "public", "system", document) -> external subset dtd
- *    XML::Dtd.new("name", "public", "system", document, false) -> internal subset dtd
- *    XML::Dtd.new("name", "public", "system", document, true) -> internal subset dtd
+ *    XML::Dtd.new(dtd_string) -> dtd
+ *    XML::Dtd.new(external_id, system_id) -> dtd
+ *    XML::Dtd.new(external_id, system_id, name, document, internal) -> dtd
  *
- * Create a new Dtd from the specified public and system
- * identifiers.
+ * Create a new Dtd from the specified public and system identifiers:
+ *   
+ *   * The first usage creates a DTD from a string and requires 1 parameter.
+ *   * The second usage loads and parses an external DTD and requires 2 parameters.
+ *   * The third usage creates a new internal or external DTD and requires 3 parameters and 2 optional parameters.
+ *     It then attaches the DTD to the specified document if it is not nil
+ * 
+ * Parameters:
+ * 
+ *   dtd_string - A string that contains a complete DTD
+ *   external_id - A string that specifies the DTD's external name. For example, "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ *   system_id - A string that specififies the DTD's system name. For example, "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
+ *   name - A string that specifies the DTD's name. For example "xhtml1".
+ *   document - A xml document.
+ *   internal - Boolean value indicating whether this is an internal or external DTD. Optional. If not specified
+ *              then external is assumed.
  */
 static VALUE rxml_dtd_initialize(int argc, VALUE *argv, VALUE self)
 {
-  VALUE external, system, dtd_string;
-  xmlParserInputBufferPtr buffer;
-  xmlCharEncoding enc = XML_CHAR_ENCODING_NONE;
-  xmlChar *new_string;
   xmlDtdPtr xdtd;
+  VALUE external, system;
 
-  // 1 argument -- string                            --> parsujeme jako dtd
-  // 2 arguments -- public, system                   --> bude se hledat
-  // 3 arguments -- public, system, name             --> creates an external subset (any parameter may be nil)
-  // 4 arguments -- public, system, name, doc        --> creates an external subset (any parameter may be nil)
-  // 5 arguments -- public, system, name, doc, true  --> creates an internal subset (all but last parameter may be nil)
   switch (argc)
   {
-  case 3:
-  case 4:
-  case 5: {
-      VALUE name, doc, internal;
-      const xmlChar *xname = NULL, *xpublic = NULL, *xsystem = NULL;
-      xmlDocPtr xdoc = NULL;
+      case 3:
+      case 4:
+      case 5:
+      {
+          const xmlChar *xname = NULL, *xpublic = NULL, *xsystem = NULL;
+          xmlDocPtr xdoc = NULL;
 
-      rb_scan_args(argc, argv, "32", &external, &system, &name, &doc, &internal);
+          VALUE name, doc, internal;
+          rb_scan_args(argc, argv, "32", &external, &system, &name, &doc, &internal);
 
-      if (external != Qnil) {
-        Check_Type(external, T_STRING);
-        xpublic = (const xmlChar*) StringValuePtr(external);
-      }
-      if (system != Qnil) {
-        Check_Type(system, T_STRING);
-        xsystem = (const xmlChar*) StringValuePtr(system);
-      }
-      if (name != Qnil) {
-        Check_Type(name, T_STRING);
-        xname = (const xmlChar*) StringValuePtr(name);
-      }
-      if (doc != Qnil) {
-        if (rb_obj_is_kind_of(doc, cXMLDocument) == Qfalse)
-          rb_raise(rb_eTypeError, "Must pass an LibXML::XML::Document object");
-        Data_Get_Struct(doc, xmlDoc, xdoc);
-      }
+          Check_Type(external, T_STRING);
+          xpublic = (const xmlChar*) StringValuePtr(external);
 
-      if (internal == Qnil || internal == Qfalse)
-        xdtd = xmlNewDtd(xdoc, xname, xpublic, xsystem);
-      else
-        xdtd = xmlCreateIntSubset(xdoc, xname, xpublic, xsystem);
+          Check_Type(system, T_STRING);
+          xsystem = (const xmlChar*) StringValuePtr(system);
 
-      if (xdtd == NULL)
-        rxml_raise(xmlGetLastError());
+          Check_Type(name, T_STRING);
+          xname = (const xmlChar*) StringValuePtr(name);
 
-      /* Document will free this dtd now. */
-      RDATA(self)->dfree = NULL;
-      DATA_PTR(self) = xdtd;
+          if (doc != Qnil)
+          {
+            if (rb_obj_is_kind_of(doc, cXMLDocument) == Qfalse)
+              rb_raise(rb_eTypeError, "Must pass an LibXML::XML::Document object");
+            Data_Get_Struct(doc, xmlDoc, xdoc);
+          }
 
-      xmlSetTreeDoc((xmlNodePtr) xdtd, xdoc);
-    }
-    break;
+          if (internal == Qnil || internal == Qfalse)
+            xdtd = xmlNewDtd(xdoc, xname, xpublic, xsystem);
+          else
+            xdtd = xmlCreateIntSubset(xdoc, xname, xpublic, xsystem);
 
-  case 2:
-    rb_scan_args(argc, argv, "20", &external, &system);
+          if (xdtd == NULL)
+            rxml_raise(xmlGetLastError());
 
-    Check_Type(external, T_STRING);
-    Check_Type(system, T_STRING);
+          /* The document will free the dtd so Ruby should not */
+          RDATA(self)->dfree = NULL;
+          DATA_PTR(self) = xdtd;
 
-    xdtd = xmlParseDTD((xmlChar*) StringValuePtr(external),
-        (xmlChar*) StringValuePtr(system));
+          xmlSetTreeDoc((xmlNodePtr) xdtd, xdoc);
+        }
+        break;
 
-    if (xdtd == NULL)
-      rxml_raise(xmlGetLastError());
+      case 2:
+      {
+        rb_scan_args(argc, argv, "20", &external, &system);
 
-    DATA_PTR(self) = xdtd;
+        Check_Type(external, T_STRING);
+        Check_Type(system, T_STRING);
 
-    xmlSetTreeDoc((xmlNodePtr) xdtd, NULL);
-    break;
+        xdtd = xmlParseDTD((xmlChar*) StringValuePtr(external), (xmlChar*) StringValuePtr(system));
 
-  case 1:
-    rb_scan_args(argc, argv, "10", &dtd_string);
-    Check_Type(dtd_string, T_STRING);
+        if (xdtd == NULL)
+          rxml_raise(xmlGetLastError());
 
-    /* Note that buffer is freed by xmlParserInputBufferPush*/
-    buffer = xmlAllocParserInputBuffer(enc);
-    new_string = xmlStrdup((xmlChar*) StringValuePtr(dtd_string));
-    xmlParserInputBufferPush(buffer, xmlStrlen(new_string),
-        (const char*) new_string);
+        DATA_PTR(self) = xdtd;
 
-    xdtd = xmlIOParseDTD(NULL, buffer, enc);
+        xmlSetTreeDoc((xmlNodePtr) xdtd, NULL);
+        break;
+      }
+      case 1:
+      {
+        VALUE dtd_string;
+        rb_scan_args(argc, argv, "10", &dtd_string);
+        Check_Type(dtd_string, T_STRING);
 
-    if (xdtd == NULL)
-      rxml_raise(xmlGetLastError());
+        /* Note that buffer is freed by xmlParserInputBufferPush*/
+        xmlCharEncoding enc = XML_CHAR_ENCODING_NONE;
+        xmlParserInputBufferPtr buffer = xmlAllocParserInputBuffer(enc);
+        xmlChar *new_string = xmlStrdup((xmlChar*) StringValuePtr(dtd_string));
+        xmlParserInputBufferPush(buffer, xmlStrlen(new_string),
+            (const char*) new_string);
 
-    xmlFree(new_string);
+        xdtd = xmlIOParseDTD(NULL, buffer, enc);
 
-    DATA_PTR(self) = xdtd;
-    break;
+        if (xdtd == NULL)
+          rxml_raise(xmlGetLastError());
 
-  default:
-    rb_raise(rb_eArgError, "wrong number of arguments");
+        xmlFree(new_string);
+
+        DATA_PTR(self) = xdtd;
+        break;
+      }
+      default:
+        rb_raise(rb_eArgError, "wrong number of arguments");
   }
 
   return self;

data/ext/libxml/ruby_xml_version.h

@@ -1,9 +1,9 @@
 /* Don't nuke this block!  It is used for automatically updating the
  * versions below. VERSION = string formatting, VERNUM = numbered
  * version for inline testing: increment both or none at all.*/
-#define RUBY_LIBXML_VERSION  "5.0.0"
-#define RUBY_LIBXML_VERNUM   500
+#define RUBY_LIBXML_VERSION  "5.0.1"
+#define RUBY_LIBXML_VERNUM   501
 #define RUBY_LIBXML_VER_MAJ   5
 #define RUBY_LIBXML_VER_MIN   0
-#define RUBY_LIBXML_VER_MIC   0
+#define RUBY_LIBXML_VER_MIC   1
 #define RUBY_LIBXML_VER_PATCH 0

data/lib/libxml/document.rb

@@ -51,8 +51,8 @@ module LibXML
       #  options - Parser options.  Valid values are the constants defined on
       #            XML::Parser::Options.  Mutliple options can be combined
       #            by using Bitwise OR (|).
-      def self.io(value, options = {})
-        Parser.io(value, options).parse
+      def self.io(io, base_uri: nil, encoding: nil, options: nil)
+        Parser.io(io, base_uri: base_uri, encoding: encoding, options: options).parse
       end
 
       # call-seq:

data/test/test_document.rb

@@ -129,4 +129,12 @@ class TestDocument < Minitest::Test
     file = File.join(File.dirname(__FILE__), 'model/atom.xml')
     schema_document = LibXML::XML::Document.file(file, options: LibXML::XML::Parser::Options::NONET)
   end
+
+  def test_io
+    File.open(File.join(File.dirname(__FILE__), 'model/rubynet.xml')) do |io|
+      doc = LibXML::XML::Document.io(io)
+      assert_instance_of(LibXML::XML::Document, doc)
+    end
+  end
+
 end

data/test/test_dtd.rb

@@ -31,13 +31,13 @@ class TestDtd < Minitest::Test
   end
   
   def test_internal_subset
-    xhtml_dtd = LibXML::XML::Dtd.new "-//W3C//DTD XHTML 1.0 Transitional//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", nil, nil, true
+    xhtml_dtd = LibXML::XML::Dtd.new("-//W3C//DTD XHTML 1.0 Transitional//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", nil, nil, true)
 		assert xhtml_dtd.name.nil?
 		assert_equal "-//W3C//DTD XHTML 1.0 Transitional//EN", xhtml_dtd.external_id
 		assert_equal "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", xhtml_dtd.uri
 		assert_equal "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", xhtml_dtd.system_id
 
-    xhtml_dtd = LibXML::XML::Dtd.new "-//W3C//DTD XHTML 1.0 Transitional//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", "xhtml1", nil, true
+    xhtml_dtd = LibXML::XML::Dtd.new("-//W3C//DTD XHTML 1.0 Transitional//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", "xhtml1", nil, true)
 		assert_equal "xhtml1", xhtml_dtd.name
 		assert_equal "-//W3C//DTD XHTML 1.0 Transitional//EN", xhtml_dtd.external_id
 		assert_equal "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", xhtml_dtd.uri
@@ -45,13 +45,13 @@ class TestDtd < Minitest::Test
   end
 
   def test_external_subset
-    xhtml_dtd = LibXML::XML::Dtd.new "-//W3C//DTD XHTML 1.0 Transitional//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", nil
+    xhtml_dtd = LibXML::XML::Dtd.new("-//W3C//DTD XHTML 1.0 Transitional//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", nil)
 		assert xhtml_dtd.name.nil?
 		assert_equal "-//W3C//DTD XHTML 1.0 Transitional//EN", xhtml_dtd.external_id
 		assert_equal "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", xhtml_dtd.uri
 		assert_equal "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", xhtml_dtd.system_id
 
-    xhtml_dtd = LibXML::XML::Dtd.new "-//W3C//DTD XHTML 1.0 Transitional//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", "xhtml1"
+    xhtml_dtd = LibXML::XML::Dtd.new("-//W3C//DTD XHTML 1.0 Transitional//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", "xhtml1")
 		assert_equal "xhtml1", xhtml_dtd.name
 		assert_equal "-//W3C//DTD XHTML 1.0 Transitional//EN", xhtml_dtd.external_id
 		assert_equal "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd", xhtml_dtd.uri

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libxml-ruby
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Ross Bamform
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -275,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Ruby Bindings for LibXML2