libxml-ruby 3.2.0 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e28e87b2fe506944adbde7b4562e216ef39a858dfd3c75257bbbbf8b4ea22a8
-  data.tar.gz: 8fc1f4d3684c17f6fcc83697c6ec2846742ce102ee8c56876dec6a9704d4fee0
+  metadata.gz: 5173bcced46009decd7e7a710aaf20b4005cf8baa5e8ee55148cb28733fd3c97
+  data.tar.gz: 3649de749c1064ec31c3d563a1328abfb43e401372beb6af4b0b5ad891af1ae3
 SHA512:
-  metadata.gz: '035593030f9bbaa922f967e25869d36203efe96fa3cbc63e18d02abf6a615352574d1c82bfd1c6ad7792daa5fe95873902821e45442ed513ae567fc22fc1ac95'
-  data.tar.gz: 62ef0548e25879fe1b1414a5e9b82ff97f8fe5f7cb9308bf5957c33cf2e8ac9c73a529f78112d9166a842bfbd684c10d4835c4321ff6e740e65b3ed9a9ba7698
+  metadata.gz: 3f5e71808404d9553073ae483c15a55b4d72e7a0e5b40939c7f2c72c8867386e7c7489769f6da2ce7da13cbbbd3329f0851d949f6dc48d7c5b40d9ec5784b630
+  data.tar.gz: 731d9152dca3cf219af862eb67171b9e5cce8df6c8bde4262eae3c53f1a5528e211188a50b472be67e3a294cf4b4f0d2a239317b5c08a3b2886b5e9c5fece14a

data/HISTORY

@@ -1,10 +1,32 @@
 = Release History
 
+== 3.2.3 / 2022-05-22
+
+* Change some getter methods to instance variables with attr_accessors for easier debuggability (David Hansen)
+* Add a number of tests related to schemas  (David Hansen)
+* Add schema.imported_elements so we can find imported elements (David Hansen)
+* Fix segfault under windows when dereferencing a pre-existing error where the node has already been freed (David Hansen)
+* Update to change name from imported_elements to imported_ns_elements and return a hash of hashes for namespaced elements (David Hansen)
+* Only call xmlGetFeaturesList if LIBXML_LEGACY_ENABLED is defined. Most distros still ship libxml2 with legacy features enabled, but this will change (Nick Wellnhofer)
+* Update GitHub Actions to use ruby/setup-ruby (Greg)
+* Fix memory leak in rxml_node_path, node.path (vovanmozg)
+
+== 3.2.2 / 2022-01-15
+* Switch to Github actions for CI/CD (Greg)
+* Test fixes (Greg, Sergio Durigan Junior)
+* Fix typo on test/test_sax_parser.rb (Sergio Durigan Junior)
+* Update homepage in gemspec (Pirate Praveen Arimbrathodiyil)
+
+== 3.2.1 / 2020-11-05
+
+* Fix incorrect handling of encodings when using XMLWriter.io (Charlie Savage)
+* Clean up README  (Richard Michael)
+
 == 3.2.0 / 2020-05-09 Charlie Savage
 
 * Fix crash when creating an empty DTD
 * Modernize tests to use Bundler to load gem
-* Add libxml-ruby.rb file so gem loads in expted way.
+* Add libxml-ruby.rb file so gem loads in expected way.
 * Add support for xmlSaveNoEmptyTags.
 * Clean up extconf.rb file
 

data/README.rdoc

@@ -12,7 +12,7 @@ We think libxml-ruby is the best XML library for Ruby because:
 
 == Requirements
 libxml-ruby requires Ruby 1.8.7 or higher.  It depends on libxml2 to
-function propoerly.  libxml2, in turn, depends on:
+function properly.  libxml2, in turn, depends on:
 
 * libm      (math routines: very standard)
 * libz      (zlib)
@@ -21,25 +21,41 @@ function propoerly.  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/).
+Devkit[http://rubyinstaller.org/add-ons/devkit/] or
+msys2[https://msys2.github.io/].
 
-== INSTALLATION
-The easiest way to install libxml-ruby is via Ruby Gems.  To install:
+== Installation
+The easiest way to install libxml-ruby is via RubyGems.  To install:
 
 <tt>gem install libxml-ruby</tt>
 
+If the extension compile process cannot find libxml2, you may need to indicate
+the location of the libxml2 configuration utility as it is used to find the
+required header and include files.  (If you need to indicate a location for the
+libxml2 library or header files different than reported by <tt>xml2-config</tt>,
+see the additional configuration options.)
+
+This may be done with RubyGems:
+
+<tt>gem install libxml-ruby -- --with-xml2-dir=/path/to/xml2-config</tt>
+
+Or bundler:
+
+<tt>bundle config build.libxml-ruby --with-xml2-config=/path/to/xml2-config</tt>
+
+<tt>bundle install libxml-ruby</tt>
+
 If you are running Windows, then install the libxml-ruby-x64-mingw32 gem.
-THe gem inncludes prebuilt extensions for Ruby 2.3.  These
+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 lib\libs directory.  To use them, put them
-someplace on your path.
+are available in the <tt>lib\\libs</tt> directory.  To use them, put them
+on your <tt>PATH</tt>.
 
 The gem also includes a Microsoft VC++ 2012 solution and XCode 5 project - these
 are very useful for debugging.
 
-libxml-ruby's source codes lives on Github at https://github.com/xml4r/libxml-ruby.
+libxml-ruby's source codes lives on GitHub[https://github.com/xml4r/libxml-ruby].
 
 == Getting Started
 Using libxml is easy. First decide what parser you want to use:
@@ -60,7 +76,7 @@ Beyond the basics of parsing and processing XML and HTML documents,
 libxml provides a wealth of additional functionality.
 
 Most commonly, you'll want to use its LibXML::XML::XPath support, which makes
-it easy to find data inside a XML document.  Although not as popular,
+it easy to find data inside an XML document.  Although not as popular,
 LibXML::XML::XPointer provides another API for finding data inside an XML document.
 
 Often times you'll need to validate data before processing it. For example,
@@ -72,17 +88,16 @@ This can be done using libxml's powerful set of validators:
 * Relax Schemas (LibXML::XML::RelaxNG)
 * XML Schema (LibXML::XML::Schema)
 
-Finally, if you'd like to use XSL Transformations to process data,
-then install the libxslt gem which is available at
-https://github.com/xml4r/libxslt-ruby.
+Finally, if you'd like to use XSL Transformations to process data, then install
+the {libxslt gem}[https://github.com/xml4r/libxslt-rubygem].
 
 == Usage
-For information about using libxml-ruby please refer to its documentation at
-http://xml4r.github.com/libxml-ruby/rdoc/index.html. Some tutorials are also
-available at https://github.com/xml4r/libxml-ruby/wiki.
+For information about using libxml-ruby please refer to its
+documentation[http://xml4r.github.io/libxml-ruby]. Some tutorials are also
+available[https://github.com/xml4r/libxml-ruby/wiki].
 
 All libxml classes are in the LibXML::XML module. The easiest
-way to use libxml is to require 'xml'.  This will mixin
+way to use libxml is to <tt>require 'xml'</tt>.  This will mixin
 the LibXML module into the global namespace, allowing you to
 write code like this:
 
@@ -131,10 +146,11 @@ Once you have build the shared libary, you can then run tests using rake:
 +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]
 
 == Performance
+
 In addition to being feature rich and conformation, the main reason
-people use libxml-ruby is for performance.  Here are the results 
+people use libxml-ruby is for performance.  Here are the results
 of a couple simple benchmarks recently blogged about on the
-Web (you can find them in the benchmark directory of the 
+Web (you can find them in the benchmark directory of the
 libxml distribution).
 
 From http://depixelate.com/2008/4/23/ruby-xml-parsing-benchmarks
@@ -156,46 +172,46 @@ From https://svn.concord.org/svn/projects/trunk/common/ruby/xml_benchmarks/
 Documentation is available via rdoc, and is installed automatically with the
 gem.
 
-libxml-ruby's online documentation is generated using Hanna, which is a
-development gem dependency.
+libxml-ruby's {online
+documentation}[https://xml4r.github.io/libxml-ruby/rdoc/index.html] is generated
+using Hanna, which is a development gem dependency.
 
 Note that older versions of Rdoc, which ship with Ruby 1.8.x, will report
 a number of errors.  To avoid them, install Rdoc 2.1 or higher.  Once you have
 installed the gem, you'll have to disable the version of Rdoc that Ruby 1.8.x
-includes.  An easy way to do that is rename the directory ruby/lib/ruby/1.8/rdoc to
-ruby/lib/ruby/1.8/rdoc_old.
+includes.  An easy way to do that is rename the directory
+<tt>ruby/lib/ruby/1.8/rdoc</tt> to
+<tt>ruby/lib/ruby/1.8/rdoc_old</tt>.
 
 == Support
-
-If you have any questions about using libxml-ruby, please report them to
-Git Hub at https://github.com/xml4r/libxml-ruby/issues
+If you have any questions about using libxml-ruby, please report an issue
+on GitHub[https://github.com/xml4r/libxml-ruby/issues].
 
 == Memory Management
 libxml-ruby automatically manages memory associated with the
 underlying libxml2 library.  The bindings create a one-to-one mapping between
-ruby objects and libxml documents and libxml parent nodes (ie, nodes that do not
-have a parent and do not belong to a document). In these cases,
+Ruby objects and libxml documents and libxml parent nodes (ie, nodes that do not
+have a parent and do not belong to a document).  In these cases,
 the bindings manage the memory.  They do this by installing a free
 function and storing a back pointer to the Ruby object from the xmlnode
 using the _private member on libxml structures.  When the Ruby object
 goes out of scope, the underlying libxml structure is freed.  Libxml
-itself then frees all child node (recursively).
+itself then frees all child nodes (recursively).
 
 For all other nodes (the vast majority), the bindings create temporary
 Ruby objects that get freed once they go out of scope. Thus there can be
-more than one ruby object pointing to the same xml node. To mostly hide
-this from programmers on the ruby side, the #eql? and #== methods are
-overriden to check if two ruby objects wrap the same xmlnode.  If they do,
+more than one Ruby object pointing to the same xml node. To mostly hide
+this from a programmer on the Ruby side, the <tt>#eql?</tt> and <tt>#==</tt> methods are
+overriden to check if two Ruby objects wrap the same xmlnode.  If they do,
 then the methods return true.  During the mark phase, each of these temporary
 objects marks its owning document, thereby keeping the Ruby document object
 alive and thus the xmldoc tree.
 
 In the sweep phase of the garbage collector, or when a program ends,
-there is no order to how Ruby objects are freed. In fact, the ruby document
-object is almost always freed before any ruby objects that wrap child nodes.
-However, this is ok because those ruby objects do not have a free function
+there is no order to how Ruby objects are freed.  In fact, the Ruby document
+object is almost always freed before any Ruby objects that wrap child nodes.
+However, this is ok because those Ruby objects do not have a free function
 and are no longer in scope (since if they were the document would not be freed).
 
 == License
 See LICENSE for license information.
-

data/Rakefile

@@ -16,21 +16,29 @@ spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
 task :default => [:test]
 
 # Setup compile tasks
-if RUBY_PLATFORM.match(/mswin32|mswin64|mingw32/)
-  Rake::ExtensionTask.new do |ext|
-    ext.gem_spec = spec
-    ext.name = SO_NAME
-    ext.ext_dir = "ext/libxml"
-    ext.lib_dir = "lib/#{RUBY_VERSION.sub(/\.\d$/, '')}"
-    ext.config_options << "--with-xml2-include=C:/msys64/mingw64/include/libxml2"
-  end
-else
-  Rake::ExtensionTask.new do |ext|
-    ext.gem_spec = spec
-    ext.name = SO_NAME
-    ext.ext_dir = "ext/libxml"
-    ext.lib_dir = "lib/#{RUBY_VERSION.sub(/\.\d$/, '')}"
-    ext.config_options << "--with-xml2-include=/usr/include/libxml2"
+Rake::ExtensionTask.new do |ext|
+  ext.gem_spec = spec
+  ext.name = SO_NAME
+  ext.ext_dir = "ext/libxml"
+  ext.lib_dir = "lib/#{RUBY_VERSION.sub(/\.\d$/, '')}"
+  if RUBY_PLATFORM.match(/mswin|mingw/)
+    ext.config_options <<
+      if (dir = ENV['WINDOWS_XML2_INCLUDE'])
+        "--with-xml2-include=#{dir}"
+      else
+        case RUBY_PLATFORM
+        when 'i386-mingw32'
+          '--with-xml2-include=C:/msys64/mingw32/include/libxml2'
+        when 'x64-mingw32'
+          '--with-xml2-include=C:/msys64/mingw64/include/libxml2'
+        when 'x64-mingw-ucrt'
+          '--with-xml2-include=C:/msys64/ucrt64/include/libxml2'
+        else
+          raise "Unknown Windows Ruby, please set ENV['WINDOWS_XML2_INCLUDE']"
+        end
+      end
+  else
+    ext.config_options << '--with-xml2-include=/usr/include/libxml2'
   end
 end
 
@@ -41,7 +49,7 @@ Gem::PackageTask.new(spec) do |pkg|
 end
 
 # Setup Windows Gem
-if RUBY_PLATFORM.match(/mswin32|mswin64|mingw32/)
+if RUBY_PLATFORM.match(/mswin|mingw/)
   binaries = (FileList['lib/**/*.so',
                        'lib/**/*dll'])
 

data/ext/libxml/ruby_xml.c

@@ -764,6 +764,9 @@ static VALUE rxml_default_save_no_empty_tags_set(VALUE klass, VALUE value)
  */
 static VALUE rxml_features(VALUE klass)
 {
+#ifndef LIBXML_LEGACY_ENABLED
+  return Qnil;
+#else
   VALUE arr, str;
   int i, len = MAX_LIBXML_FEATURES_LEN;
   char **list = NULL;
@@ -788,6 +791,7 @@ static VALUE rxml_features(VALUE klass)
 
   ruby_xfree(list);
   return (arr);
+#endif /* LIBXML_LEGACY_ENABLED */
 }
 
 /*

data/ext/libxml/ruby_xml_document.c

@@ -483,7 +483,6 @@ static VALUE rxml_document_encoding_get(VALUE self)
  * Returns the Ruby encoding specified by this document
  * (available on Ruby 1.9.x and higher).
  */
-#ifdef HAVE_RUBY_ENCODING_H
 static VALUE rxml_document_rb_encoding_get(VALUE self)
 {
   xmlDocPtr xdoc;
@@ -493,7 +492,6 @@ static VALUE rxml_document_rb_encoding_get(VALUE self)
   rbencoding = rxml_xml_encoding_to_rb_encoding(mXMLEncoding, xmlParseCharEncoding((const char*)xdoc->encoding));
   return rb_enc_from_encoding(rbencoding);
 }
-#endif
 
 /*
  * call-seq:
@@ -1097,9 +1095,7 @@ void rxml_init_document(void)
   rb_define_method(cXMLDocument, "compression?", rxml_document_compression_q, 0);
   rb_define_method(cXMLDocument, "debug", rxml_document_debug, 0);
   rb_define_method(cXMLDocument, "encoding", rxml_document_encoding_get, 0);
-#ifdef HAVE_RUBY_ENCODING_H
   rb_define_method(cXMLDocument, "rb_encoding", rxml_document_rb_encoding_get, 0);
-#endif
   rb_define_method(cXMLDocument, "encoding=", rxml_document_encoding_set, 1);
   rb_define_method(cXMLDocument, "import", rxml_document_import, 1);
   rb_define_method(cXMLDocument, "last", rxml_document_last_get, 0);

data/ext/libxml/ruby_xml_encoding.c

@@ -74,7 +74,6 @@ static VALUE rxml_encoding_to_s(VALUE klass, VALUE encoding)
     return rxml_new_cstr(xencoding, xencoding);
 }
 
-#ifdef HAVE_RUBY_ENCODING_H
 /*
  * Converts an xmlCharEncoding enum value into a Ruby Encoding object (available
  * on Ruby 1.9.* and higher).
@@ -179,26 +178,17 @@ rb_encoding* rxml_figure_encoding(const xmlChar* xencoding)
   }
   return result;
 }
-#endif
 
 VALUE rxml_new_cstr(const xmlChar* xstr, const xmlChar* xencoding)
 {
-#ifdef HAVE_RUBY_ENCODING_H
   rb_encoding *rbencoding = rxml_figure_encoding(xencoding);
   return rb_external_str_new_with_enc((const char*)xstr, strlen((const char*)xstr), rbencoding);
-#else
-  return rb_str_new2((const char*)xstr);
-#endif
 }
 
 VALUE rxml_new_cstr_len(const xmlChar* xstr, const long length, const xmlChar* xencoding)
 {
-#ifdef HAVE_RUBY_ENCODING_H
   rb_encoding *rbencoding = rxml_figure_encoding(xencoding);
   return rb_external_str_new_with_enc((const char*)xstr, length, rbencoding);
-#else
-  return rb_str_new((const char*)xstr, length);
-#endif
 }
 
 void rxml_init_encoding(void)
@@ -207,9 +197,7 @@ void rxml_init_encoding(void)
   rb_define_module_function(mXMLEncoding, "from_s", rxml_encoding_from_s, 1);
   rb_define_module_function(mXMLEncoding, "to_s", rxml_encoding_to_s, 1);
 
-#ifdef HAVE_RUBY_ENCODING_H
- // rb_define_module_function(mXMLEncoding, "to_rb_encoding", rxml_encoding_to_rb_encoding, 2);
-#endif
+  rb_define_module_function(mXMLEncoding, "to_rb_encoding", rxml_encoding_to_rb_encoding, 2);
 
   /* -1: No char encoding detected. */
   rb_define_const(mXMLEncoding, "ERROR", INT2NUM(XML_CHAR_ENCODING_ERROR));

data/ext/libxml/ruby_xml_encoding.h

@@ -7,13 +7,10 @@ extern VALUE mXMLEncoding;
 
 void rxml_init_encoding();
 
-// Ruby 1.8/1.9 encoding compatibility
 VALUE rxml_new_cstr(const xmlChar* xstr, const xmlChar* xencoding);
 VALUE rxml_new_cstr_len(const xmlChar* xstr, const long length, const xmlChar* xencoding);
 
-#ifdef HAVE_RUBY_ENCODING_H
 rb_encoding* rxml_xml_encoding_to_rb_encoding(VALUE klass, xmlCharEncoding xmlEncoding);
 rb_encoding* rxml_figure_encoding(const xmlChar* xencoding);
-#endif
 
 #endif

data/ext/libxml/ruby_xml_io.c

@@ -1,13 +1,10 @@
 /* Please see the LICENSE file for copyright and distribution information */
 
 #include "ruby_libxml.h"
+#include <ruby/io.h>
 
 static ID READ_METHOD;
-#ifdef HAVE_RB_IO_BUFWRITE
-#include <ruby/io.h>
-#else
 static ID WRITE_METHOD;
-#endif /* !HAVE_RB_IO_BUFWRITE */
 
 /* This method is called by libxml when it wants to read
  more data from a stream. We go with the duck typing
@@ -27,25 +24,24 @@ int rxml_read_callback(void *context, char *buffer, int len)
   return (int)size;
 }
 
-int rxml_write_callback(void *context, const char *buffer, int len)
+int rxml_write_callback(VALUE io, const char *buffer, int len)
 {
-#ifndef HAVE_RB_IO_BUFWRITE
-  VALUE io, written, string;
-
-  io = (VALUE) context;
-  string = rb_str_new(buffer, len);
-  written = rb_funcall(io, WRITE_METHOD, 1, string);
-
-  return NUM2INT(written);
-#else
-  return (int)rb_io_bufwrite((VALUE) context, buffer, (size_t)len);
-#endif /* !HAVE_RB_IO_BUFWRITE */
+    if (rb_io_check_io(io) == Qnil)
+    {
+        // Could be StringIO
+        VALUE written, string;
+        string = rb_external_str_new_with_enc(buffer, strlen(buffer), rb_enc_get(io));
+        written = rb_funcall(io, WRITE_METHOD, 1, string);
+        return NUM2INT(written);
+    }
+    else
+    {
+        return (int)rb_io_bufwrite(io, buffer, (size_t)len);
+    }
 }
 
 void rxml_init_io(void)
 {
   READ_METHOD = rb_intern("read");
-#ifndef HAVE_RB_IO_BUFWRITE
   WRITE_METHOD = rb_intern("write");
-#endif /* !HAVE_RB_IO_BUFWRITE */
 }

data/ext/libxml/ruby_xml_io.h

@@ -4,7 +4,7 @@
 #define __RXML_IO__
 
 int rxml_read_callback(void *context, char *buffer, int len);
-int rxml_write_callback(void *context, const char *buffer, int len);
+int rxml_write_callback(VALUE io, const char *buffer, int len);
 void rxml_init_io(void);
 
 #endif

data/ext/libxml/ruby_xml_namespace.c

@@ -52,6 +52,7 @@ static VALUE rxml_namespace_initialize(VALUE self, VALUE node, VALUE prefix,
 
   Check_Type(node, T_DATA);
   Data_Get_Struct(node, xmlNode, xnode);
+  xmlResetLastError();
 
   /* Prefix can be null - that means its the default namespace */
   xmlPrefix = NIL_P(prefix) ? NULL : (xmlChar *)StringValuePtr(prefix);

data/ext/libxml/ruby_xml_node.c

@@ -983,14 +983,18 @@ static VALUE rxml_node_path(VALUE self)
 {
   xmlNodePtr xnode;
   xmlChar *path;
+  VALUE result = Qnil;
 
   xnode = rxml_get_xnode(self);
   path = xmlGetNodePath(xnode);
 
-  if (path == NULL)
-    return (Qnil);
-  else
-    return (rxml_new_cstr( path, NULL));
+  if (path)
+  {
+    result = rxml_new_cstr( path, NULL);
+    xmlFree(path);
+  }
+
+  return result;
 }
 
 /*