libxml-ruby 4.1.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d298b5603240e7ea8b02a030fce5d7a850cd00f0a6a1aac4325dc37b85f7bed4
-  data.tar.gz: 8f9f870fe5f055d9d4b3d30afc9a20cc5c1dbea3332e11e2426ee703fcb83202
+  metadata.gz: 754e55b0e4c9df24e3c7d72d501dea38da247d159696782ee32b8b88d09fc7ef
+  data.tar.gz: 710ec1aa2bcaaf57003c33495cf4e410551c6b741d0bab3f1ef1f5d29775fe1a
 SHA512:
-  metadata.gz: ef9b908bf3c1b2f4fe1fe848557e3e8e5265e980a5285c9f213395b80229c295868e007f2f03913ff286d716720d1d995938bcdcdcccaf65dc73022b2cedf15e
-  data.tar.gz: d44818d023a575fd2e5c6d40580382fe809f694d28462fff16500109aa33fa483ee555c6ea27ece9dd4f9756f7fe6c34d1aeaa34162b99e847d4171585624265
+  metadata.gz: be0bfd383209044c12152db6ae98b87f326acd0c465a142a2ba0fab5563d06583a09c0f2d160e2c4874b44208966400246f9e3b871e4443f24cbcf1cd96787ea
+  data.tar.gz: 2dd60b858d16be0bf5f8405564d1add5c3163d2b1450ebc9c14ca29aecfcff99af2f4b5c7f07c79247e4a20110d9bebd5b597e6f62c664bdf85c4bd4b9fc9ac2

data/HISTORY

@@ -1,5 +1,19 @@
 = Release History
 
+== 5.0.0 / 2024-01-07
+
+* This release is major version bump because it removes access to global parser options
+  that libxml2 version 2.12.0 deprecated (see https://gitlab.gnome.org/GNOME/libxml2/-/releases/v2.12.0)
+  In the unlikely event your code uses these options, then you will need to update it.
+  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)
+* Add support for Ruby 3.3.*
+* Remove support for Ruby 2.7.* (gem should still work but is no longer tested)
+
 == 4.1.2 / 2023-11-04
 
 * Fix Ruby warnings about undefined allocators (yuuji.yaginuma, Christopher Sahnwaldt)

data/ext/libxml/ruby_libxml.h

@@ -1,44 +1,43 @@
-/* Please see the LICENSE file for copyright and distribution information */
-
-#ifndef __RUBY_LIBXML_H__
-#define __RUBY_LIBXML_H__
-
-#include <ruby.h>
-#include <libxml/xmlversion.h>
-
-#include "ruby_xml_version.h"
-#include "ruby_xml.h"
-#include "ruby_xml_io.h"
-#include "ruby_xml_error.h"
-#include "ruby_xml_encoding.h"
-#include "ruby_xml_attributes.h"
-#include "ruby_xml_attr.h"
-#include "ruby_xml_attr_decl.h"
-#include "ruby_xml_document.h"
-#include "ruby_xml_node.h"
-#include "ruby_xml_namespace.h"
-#include "ruby_xml_namespaces.h"
-#include "ruby_xml_parser.h"
-#include "ruby_xml_parser_options.h"
-#include "ruby_xml_parser_context.h"
-#include "ruby_xml_html_parser.h"
-#include "ruby_xml_html_parser_options.h"
-#include "ruby_xml_html_parser_context.h"
-#include "ruby_xml_reader.h"
-#include "ruby_xml_writer.h"
-#include "ruby_xml_sax2_handler.h"
-#include "ruby_xml_sax_parser.h"
-#include "ruby_xml_writer.h"
-#include "ruby_xml_xinclude.h"
-#include "ruby_xml_xpath.h"
-#include "ruby_xml_xpath_expression.h"
-#include "ruby_xml_xpath_context.h"
-#include "ruby_xml_xpath_object.h"
-#include "ruby_xml_input_cbg.h"
-#include "ruby_xml_dtd.h"
-#include "ruby_xml_schema.h"
-#include "ruby_xml_relaxng.h"
-
-extern VALUE mLibXML;
-
-#endif
+/* Please see the LICENSE file for copyright and distribution information */
+
+#ifndef __RUBY_LIBXML_H__
+#define __RUBY_LIBXML_H__
+
+#include <ruby.h>
+
+#include "ruby_xml_version.h"
+#include "ruby_xml.h"
+#include "ruby_xml_io.h"
+#include "ruby_xml_error.h"
+#include "ruby_xml_encoding.h"
+#include "ruby_xml_attributes.h"
+#include "ruby_xml_attr.h"
+#include "ruby_xml_attr_decl.h"
+#include "ruby_xml_document.h"
+#include "ruby_xml_node.h"
+#include "ruby_xml_namespace.h"
+#include "ruby_xml_namespaces.h"
+#include "ruby_xml_parser.h"
+#include "ruby_xml_parser_options.h"
+#include "ruby_xml_parser_context.h"
+#include "ruby_xml_html_parser.h"
+#include "ruby_xml_html_parser_options.h"
+#include "ruby_xml_html_parser_context.h"
+#include "ruby_xml_reader.h"
+#include "ruby_xml_writer.h"
+#include "ruby_xml_sax2_handler.h"
+#include "ruby_xml_sax_parser.h"
+#include "ruby_xml_writer.h"
+#include "ruby_xml_xinclude.h"
+#include "ruby_xml_xpath.h"
+#include "ruby_xml_xpath_expression.h"
+#include "ruby_xml_xpath_context.h"
+#include "ruby_xml_xpath_object.h"
+#include "ruby_xml_input_cbg.h"
+#include "ruby_xml_dtd.h"
+#include "ruby_xml_schema.h"
+#include "ruby_xml_relaxng.h"
+
+extern VALUE mLibXML;
+
+#endif

data/ext/libxml/ruby_xml.c

@@ -328,264 +328,6 @@ static VALUE rxml_enabled_zlib_q(VALUE klass)
 #endif
 }
 
-/*
- * call-seq:
- *    XML.debug_entities -> (true|false)
- *
- * Determine whether included-entity debugging is enabled.
- * (Requires Libxml to be compiled with debugging support)
- */
-static VALUE rxml_debug_entities_get(VALUE klass)
-{
-#ifdef LIBXML_DEBUG_ENABLED
-  if (xmlParserDebugEntities)
-  return(Qtrue);
-  else
-  return(Qfalse);
-#else
-  rb_warn("libxml was compiled with debugging turned off");
-  return (Qfalse);
-#endif
-}
-
-/*
- * call-seq:
- *    XML.debug_entities = true|false
- *
- * Enable or disable included-entity debugging.
- * (Requires Libxml to be compiled with debugging support)
- */
-static VALUE rxml_debug_entities_set(VALUE klass, VALUE value)
-{
-#ifdef LIBXML_DEBUG_ENABLED
-  if (value == Qfalse)
-  {
-    xmlParserDebugEntities = 0;
-    return(Qfalse);
-  }
-  else
-  {
-    xmlParserDebugEntities = 1;
-    return(Qtrue);
-  }
-#else
-  rb_warn("libxml was compiled with debugging turned off");
-#endif
-}
-
-/*
- * call-seq:
- *    XML.default_keep_blanks -> (true|false)
- *
- * Determine whether parsers retain whitespace by default.
- */
-static VALUE rxml_default_keep_blanks_get(VALUE klass)
-{
-  if (xmlKeepBlanksDefaultValue)
-    return (Qtrue);
-  else
-    return (Qfalse);
-}
-
-/*
- * call-seq:
- *    XML.default_keep_blanks = true|false
- *
- * Controls whether parsers retain whitespace by default.
- */
-static VALUE rxml_default_keep_blanks_set(VALUE klass, VALUE value)
-{
-  if (value == Qfalse)
-  {
-    xmlKeepBlanksDefaultValue = 0;
-    return (Qfalse);
-  }
-  else if (value == Qtrue)
-  {
-    xmlKeepBlanksDefaultValue = 1;
-    return (Qtrue);
-  }
-  else
-  {
-    rb_raise(rb_eArgError, "Invalid argument, must be a boolean");
-  }
-}
-
-/*
- * call-seq:
- *    XML.default_load_external_dtd -> (true|false)
- *
- * Determine whether parsers load external DTDs by default.
- */
-static VALUE rxml_default_load_external_dtd_get(VALUE klass)
-{
-  if (xmlLoadExtDtdDefaultValue)
-    return (Qtrue);
-  else
-    return (Qfalse);
-}
-
-/*
- * call-seq:
- *    XML.default_load_external_dtd = true|false
- *
- * Controls whether parsers load external DTDs by default.
- */
-static VALUE rxml_default_load_external_dtd_set(VALUE klass, VALUE value)
-{
-  if (value == Qfalse)
-  {
-    xmlLoadExtDtdDefaultValue = 0;
-    return (Qfalse);
-  }
-  else
-  {
-    xmlLoadExtDtdDefaultValue = 1;
-    return (Qtrue);
-  }
-}
-
-/*
- * call-seq:
- *    XML.default_line_numbers -> (true|false)
- *
- * Determine whether parsers retain line-numbers by default.
- */
-static VALUE rxml_default_line_numbers_get(VALUE klass)
-{
-  if (xmlLineNumbersDefaultValue)
-    return (Qtrue);
-  else
-    return (Qfalse);
-}
-
-/*
- * call-seq:
- *    XML.default_line_numbers = true|false
- *
- * Controls whether parsers retain line-numbers by default.
- */
-static VALUE rxml_default_line_numbers_set(VALUE klass, VALUE value)
-{
-  if (value == Qfalse)
-  {
-    xmlLineNumbersDefault(0);
-    return (Qfalse);
-  }
-  else
-  {
-    xmlLineNumbersDefault(1);
-    return (Qtrue);
-  }
-}
-
-int rxml_libxml_default_options(void)
-{
-  int options = 0;
-
-  if (xmlLoadExtDtdDefaultValue)
-    options |= XML_PARSE_DTDLOAD;
-
-  if (xmlDoValidityCheckingDefaultValue)
-    options |= XML_PARSE_DTDVALID;
-
-  if (!xmlKeepBlanksDefaultValue)
-    options |= XML_PARSE_NOBLANKS;
-
-  if (xmlSubstituteEntitiesDefaultValue)
-    options |= XML_PARSE_NOENT;
-
-  if (!xmlGetWarningsDefaultValue)
-    options |= XML_PARSE_NOWARNING;
-
-  if (xmlPedanticParserDefaultValue)
-    options |= XML_PARSE_PEDANTIC;
-  
-  return options;
-}
-
-/*
- * call-seq:
- *    XML.default_options -> int
- *
- * Returns an integer that summarize libxml2's default options.
- */
-static VALUE rxml_default_options_get(VALUE klass)
-{
-  int options = rxml_libxml_default_options();
-  return INT2NUM(options);
-}
-
-/*
- * call-seq:
- *    XML.default_pedantic_parser -> (true|false)
- *
- * Determine whether parsers are pedantic by default.
- */
-static VALUE rxml_default_pedantic_parser_get(VALUE klass)
-{
-  if (xmlPedanticParserDefaultValue)
-    return (Qtrue);
-  else
-    return (Qfalse);
-}
-
-/*
- * call-seq:
- *    XML.default_pedantic_parser = true|false
- *
- * Controls whether parsers are pedantic by default.
- */
-static VALUE rxml_default_pedantic_parser_set(VALUE klass, VALUE value)
-{
-  if (value == Qfalse)
-  {
-    xmlPedanticParserDefault(0);
-    return (Qfalse);
-  }
-  else
-  {
-    xmlPedanticParserDefault(1);
-    return (Qtrue);
-  }
-}
-
-/*
- * call-seq:
- *    XML.default_substitute_entities -> (true|false)
- *
- * Determine whether parsers perform inline entity substitution
- * (for external entities) by default.
- */
-static VALUE rxml_default_substitute_entities_get(VALUE klass)
-{
-  if (xmlSubstituteEntitiesDefaultValue)
-    return (Qtrue);
-  else
-    return (Qfalse);
-}
-
-/*
- * call-seq:
- *    XML.default_substitute_entities = true|false
- *
- * Controls whether parsers perform inline entity substitution
- * (for external entities) by default.
- */
-static VALUE rxml_default_substitute_entities_set(VALUE klass, VALUE value)
-{
-  if (value == Qfalse)
-  {
-    xmlSubstituteEntitiesDefault(0);
-    return (Qfalse);
-  }
-  else
-  {
-    xmlSubstituteEntitiesDefault(1);
-    return (Qtrue);
-  }
-}
-
 /*
  * call-seq:
  *    XML.default_tree_indent_string -> "string"
@@ -615,74 +357,6 @@ static VALUE rxml_default_tree_indent_string_set(VALUE klass, VALUE string)
   return (string);
 }
 
-/*
- * call-seq:
- *    XML.default_validity_checking -> (true|false)
- *
- * Determine whether parsers perform XML validation by default.
- */
-static VALUE rxml_default_validity_checking_get(VALUE klass)
-{
-  if (xmlDoValidityCheckingDefaultValue)
-    return (Qtrue);
-  else
-    return (Qfalse);
-}
-
-/*
- * call-seq:
- *    XML.default_validity_checking = true|false
- *
- * Controls whether parsers perform XML validation by default.
- */
-static VALUE rxml_default_validity_checking_set(VALUE klass, VALUE value)
-{
-  if (value == Qfalse)
-  {
-    xmlDoValidityCheckingDefaultValue = 0;
-    return (Qfalse);
-  }
-  else
-  {
-    xmlDoValidityCheckingDefaultValue = 1;
-    return (Qtrue);
-  }
-}
-
-/*
- * call-seq:
- *    XML.default_warnings -> (true|false)
- *
- * Determine whether parsers output warnings by default.
- */
-static VALUE rxml_default_warnings_get(VALUE klass)
-{
-  if (xmlGetWarningsDefaultValue)
-    return (Qtrue);
-  else
-    return (Qfalse);
-}
-
-/*
- * call-seq:
- *    XML.default_warnings = true|false
- *
- * Controls whether parsers output warnings by default.
- */
-static VALUE rxml_default_warnings_set(VALUE klass, VALUE value)
-{
-  if (value == Qfalse)
-  {
-    xmlGetWarningsDefaultValue = 0;
-    return (Qfalse);
-  }
-  else
-  {
-    xmlGetWarningsDefaultValue = 1;
-    return (Qtrue);
-  }
-}
-
 /*
  * call-seq:
  *    XML.default_compression -> (true|false)
@@ -869,27 +543,10 @@ void rxml_init_xml(void)
   rb_define_module_function(mXML, "catalog_dump", rxml_catalog_dump, 0);
   rb_define_module_function(mXML, "catalog_remove", rxml_catalog_remove, 1);
   rb_define_module_function(mXML, "check_lib_versions", rxml_check_lib_versions, 0);
-  rb_define_module_function(mXML, "debug_entities", rxml_debug_entities_get, 0);
-  rb_define_module_function(mXML, "debug_entities=", rxml_debug_entities_set, 1);
   rb_define_module_function(mXML, "default_compression", rxml_default_compression_get, 0);
   rb_define_module_function(mXML, "default_compression=", rxml_default_compression_set, 1);
-  rb_define_module_function(mXML, "default_keep_blanks", rxml_default_keep_blanks_get, 0);
-  rb_define_module_function(mXML, "default_keep_blanks=", rxml_default_keep_blanks_set, 1);
-  rb_define_module_function(mXML, "default_load_external_dtd", rxml_default_load_external_dtd_get, 0);
-  rb_define_module_function(mXML, "default_load_external_dtd=", rxml_default_load_external_dtd_set, 1);
-  rb_define_module_function(mXML, "default_line_numbers", rxml_default_line_numbers_get, 0);
-  rb_define_module_function(mXML, "default_line_numbers=", rxml_default_line_numbers_set, 1);
-  rb_define_module_function(mXML, "default_options", rxml_default_options_get, 0);
-  rb_define_module_function(mXML, "default_pedantic_parser", rxml_default_pedantic_parser_get, 0);
-  rb_define_module_function(mXML, "default_pedantic_parser=", rxml_default_pedantic_parser_set, 1);
-  rb_define_module_function(mXML, "default_substitute_entities", rxml_default_substitute_entities_get, 0);
-  rb_define_module_function(mXML, "default_substitute_entities=", rxml_default_substitute_entities_set, 1);
   rb_define_module_function(mXML, "default_tree_indent_string", rxml_default_tree_indent_string_get, 0);
   rb_define_module_function(mXML, "default_tree_indent_string=", rxml_default_tree_indent_string_set, 1);
-  rb_define_module_function(mXML, "default_validity_checking", rxml_default_validity_checking_get, 0);
-  rb_define_module_function(mXML, "default_validity_checking=", rxml_default_validity_checking_set, 1);
-  rb_define_module_function(mXML, "default_warnings", rxml_default_warnings_get, 0);
-  rb_define_module_function(mXML, "default_warnings=", rxml_default_warnings_set, 1);
   rb_define_module_function(mXML, "default_save_no_empty_tags", rxml_default_save_no_empty_tags_get, 0);
   rb_define_module_function(mXML, "default_save_no_empty_tags=", rxml_default_save_no_empty_tags_set, 1);
   rb_define_module_function(mXML, "indent_tree_output", rxml_indent_tree_output_get, 0);

data/ext/libxml/ruby_xml.h

@@ -1,10 +1,9 @@
-/* Please see the LICENSE file for copyright and distribution information */
-
-#ifndef __RUBY_XML_H__
-#define __RUBY_XML_H__
-
-extern VALUE mXML;
-int rxml_libxml_default_options(void);
-void rxml_init_xml(void);
-
-#endif
+/* Please see the LICENSE file for copyright and distribution information */
+
+#ifndef __RUBY_XML_H__
+#define __RUBY_XML_H__
+
+extern VALUE mXML;
+void rxml_init_xml(void);
+
+#endif

data/ext/libxml/ruby_xml_attributes.h

@@ -3,6 +3,8 @@
 #ifndef __RXML_ATTRIBUTES__
 #define __RXML_ATTRIBUTES__
 
+#include <libxml/tree.h>
+
 extern VALUE cXMLAttributesibutes;
 
 void rxml_init_attributes(void);

data/ext/libxml/ruby_xml_document.c

@@ -542,7 +542,7 @@ static VALUE rxml_document_import(VALUE self, VALUE node)
   xresult = xmlDocCopyNode(xnode, xdoc, 1);
 
   if (xresult == NULL)
-    rxml_raise(&xmlLastError);
+    rxml_raise(xmlGetLastError());
 
   return rxml_node_wrap(xresult);
 }
@@ -808,7 +808,7 @@ static VALUE rxml_document_save(int argc, VALUE *argv, VALUE self)
   length = xmlSaveFormatFileEnc(xfilename, xdoc, (const char*)xencoding, indent);
 
   if (length == -1)
-    rxml_raise(&xmlLastError);
+    rxml_raise(xmlGetLastError());
 
   return (INT2NUM(length));
 }
@@ -958,7 +958,7 @@ static VALUE rxml_document_xinclude(VALUE self)
   }
   else
   {
-    rxml_raise(&xmlLastError);
+    rxml_raise(xmlGetLastError());
     return Qnil;
   }
 #else
@@ -1007,7 +1007,7 @@ static VALUE rxml_document_validate_schema(VALUE self, VALUE schema)
   xmlSchemaFreeValidCtxt(vptr);
   if (is_invalid)
   {
-    rxml_raise(&xmlLastError);
+    rxml_raise(xmlGetLastError());
     return Qfalse;
   }
   else
@@ -1040,7 +1040,7 @@ static VALUE rxml_document_validate_relaxng(VALUE self, VALUE relaxng)
   xmlRelaxNGFreeValidCtxt(vptr);
   if (is_invalid)
   {
-    rxml_raise(&xmlLastError);
+    rxml_raise(xmlGetLastError());
     return Qfalse;
   }
   else
@@ -1075,7 +1075,7 @@ static VALUE rxml_document_validate_dtd(VALUE self, VALUE dtd)
   }
   else
   {
-    rxml_raise(&xmlLastError);
+    rxml_raise(xmlGetLastError());
     return Qfalse;
   }
 }

data/ext/libxml/ruby_xml_document.h

@@ -1,11 +1,11 @@
-/* Please see the LICENSE file for copyright and distribution information */
-
-#ifndef __RXML_DOCUMENT__
-#define __RXML_DOCUMENT__
-
-extern VALUE cXMLDocument;
-void rxml_init_document();
-VALUE rxml_document_wrap(xmlDocPtr xnode);
-
-typedef xmlChar * xmlCharPtr;
-#endif
+/* Please see the LICENSE file for copyright and distribution information */
+
+#ifndef __RXML_DOCUMENT__
+#define __RXML_DOCUMENT__
+
+extern VALUE cXMLDocument;
+void rxml_init_document(void);
+VALUE rxml_document_wrap(xmlDocPtr xnode);
+
+typedef xmlChar * xmlCharPtr;
+#endif

data/ext/libxml/ruby_xml_dtd.c

@@ -181,7 +181,7 @@ static VALUE rxml_dtd_initialize(int argc, VALUE *argv, VALUE self)
         xdtd = xmlCreateIntSubset(xdoc, xname, xpublic, xsystem);
 
       if (xdtd == NULL)
-        rxml_raise(&xmlLastError);
+        rxml_raise(xmlGetLastError());
 
       /* Document will free this dtd now. */
       RDATA(self)->dfree = NULL;
@@ -201,7 +201,7 @@ static VALUE rxml_dtd_initialize(int argc, VALUE *argv, VALUE self)
         (xmlChar*) StringValuePtr(system));
 
     if (xdtd == NULL)
-      rxml_raise(&xmlLastError);
+      rxml_raise(xmlGetLastError());
 
     DATA_PTR(self) = xdtd;
 
@@ -221,7 +221,7 @@ static VALUE rxml_dtd_initialize(int argc, VALUE *argv, VALUE self)
     xdtd = xmlIOParseDTD(NULL, buffer, enc);
 
     if (xdtd == NULL)
-      rxml_raise(&xmlLastError);
+      rxml_raise(xmlGetLastError());
 
     xmlFree(new_string);
 

data/ext/libxml/ruby_xml_encoding.h

@@ -1,18 +1,20 @@
-/* Please see the LICENSE file for copyright and distribution information */
-
-#ifndef __RXML_ENCODING__
-#define __RXML_ENCODING__
-
-#include <ruby/encoding.h>
-
-extern VALUE mXMLEncoding;
-
-void rxml_init_encoding();
-
-VALUE rxml_new_cstr(const xmlChar* xstr, const xmlChar* xencoding);
-VALUE rxml_new_cstr_len(const xmlChar* xstr, const long length, const xmlChar* xencoding);
-
-rb_encoding* rxml_xml_encoding_to_rb_encoding(VALUE klass, xmlCharEncoding xmlEncoding);
-rb_encoding* rxml_figure_encoding(const xmlChar* xencoding);
-
-#endif
+/* Please see the LICENSE file for copyright and distribution information */
+
+#ifndef __RXML_ENCODING__
+#define __RXML_ENCODING__
+
+#include <ruby/encoding.h>
+#include <libxml/encoding.h>
+#include <libxml/xmlstring.h>
+
+extern VALUE mXMLEncoding;
+
+void rxml_init_encoding(void);
+
+VALUE rxml_new_cstr(const xmlChar* xstr, const xmlChar* xencoding);
+VALUE rxml_new_cstr_len(const xmlChar* xstr, const long length, const xmlChar* xencoding);
+
+rb_encoding* rxml_xml_encoding_to_rb_encoding(VALUE klass, xmlCharEncoding xmlEncoding);
+rb_encoding* rxml_figure_encoding(const xmlChar* xencoding);
+
+#endif