libxml-ruby 4.1.2 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d298b5603240e7ea8b02a030fce5d7a850cd00f0a6a1aac4325dc37b85f7bed4
-  data.tar.gz: 8f9f870fe5f055d9d4b3d30afc9a20cc5c1dbea3332e11e2426ee703fcb83202
+  metadata.gz: 24e442a3a4f3343aaae6bc6b513309faccd90af0c9e985c6729d91821c9b29b4
+  data.tar.gz: 698be20e816f96b896c3b8bd7cc0bcf89e131d8b46466e16b9d804133b8f5af2
 SHA512:
-  metadata.gz: ef9b908bf3c1b2f4fe1fe848557e3e8e5265e980a5285c9f213395b80229c295868e007f2f03913ff286d716720d1d995938bcdcdcccaf65dc73022b2cedf15e
-  data.tar.gz: d44818d023a575fd2e5c6d40580382fe809f694d28462fff16500109aa33fa483ee555c6ea27ece9dd4f9756f7fe6c34d1aeaa34162b99e847d4171585624265
+  metadata.gz: 4f90226185c4146bb9b0212d489e8913148408f09e315ebedbca43e44914534c595b89bd3238fa7bfabf9e21f1d3613e4b11980a82b8d4f844bbe07bd862b788
+  data.tar.gz: 9313c21dc1405b5d0b015120e37a2310a7d337ff0948b2f2ed54c105e276b090c246314315c937f25444fa187c4fe101b618a8dec24b774deba85cb8e0ad414f

data/HISTORY

@@ -1,5 +1,22 @@
 = 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
+  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 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)
+
 == 4.1.2 / 2023-11-04
 
 * Fix Ruby warnings about undefined allocators (yuuji.yaginuma, Christopher Sahnwaldt)

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_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