libxml-ruby 4.1.2 → 6.0.0

data/LICENSE

@@ -1,21 +1,21 @@
-  Copyright (c) 2008-2013 Charlie Savage and contributors
-  Copyright (c) 2002-2007 Sean Chittenden and contributors
-  Copyright (c) 2001 Wai-Sun "Squidster" Chia
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in 
-the Software without restriction, including without limitation the rights to 
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  Copyright (c) 2008-2013 Charlie Savage and contributors
+  Copyright (c) 2002-2007 Sean Chittenden and contributors
+  Copyright (c) 2001 Wai-Sun "Squidster" Chia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# LibXML Ruby
+
+## Overview
+The libxml gem provides Ruby language bindings for GNOME's Libxml2
+XML toolkit. It is free software, released under the MIT License.
+
+libxml-ruby let's you:
+
+* Read xml files
+* Write xml files
+* Search xml files using XPath
+* Validate XML files
+
+Full documentation is available at [xml4r.github.io/libxml-ruby](https://xml4r.github.io/libxml-ruby/) including a getting started guide.
+
+## Requirements
+
+libxml-ruby requires Ruby 3.2 or higher.
+
+## Installation
+The easiest way to install libxml-ruby is via RubyGems.  To install:
+
+```
+gem install libxml-ruby
+```
+
+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 `xml2-config`,
+see the additional configuration options.)
+
+This may be done with RubyGems:
+
+```
+gem install libxml-ruby -- --with-xml2-config=/path/to/xml2-config
+```
+
+Or bundler:
+
+```
+bundle config build.libxml-ruby --with-xml2-config=/path/to/xml2-config
+bundle install
+```
+
+Full documentation is available at [xml4r.github.io/libxml-ruby](https://xml4r.github.io/libxml-ruby/) including a [getting started](https://xml4r.github.io/libxml-ruby/getting_started/) guide.
+
+## Tests
+
+To run tests you first need to build the shared library:
+
+```
+rake compile
+```
+
+Once you have built the shared library, you can then run tests using rake:
+
+```
+rake test
+```
+
+## Support
+If you have any questions about using libxml-ruby, please report an issue
+on [GitHub](https://github.com/xml4r/libxml-ruby/issues).
+
+## License
+See [LICENSE](LICENSE) for license information.

data/Rakefile

@@ -1,99 +1,78 @@
-#!/usr/bin/env ruby
-
-require "rubygems"
-require "rake/extensiontask"
-require "rake/testtask"
-require "rubygems/package_task"
-require "rdoc/task"
-require "yaml"
-
-GEM_NAME = "libxml-ruby"
-SO_NAME  = "libxml_ruby"
-
-# Read the spec file
-spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
-
-task :default => [:test]
-
-# Setup compile tasks
-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
-
-# Setup generic gem
-Gem::PackageTask.new(spec) do |pkg|
-  pkg.package_dir = 'pkg'
-  pkg.need_tar    = false
-end
-
-# Setup Windows Gem
-if RUBY_PLATFORM.match(/mswin|mingw/)
-  binaries = (FileList['lib/**/*.so',
-                       'lib/**/*dll'])
-
-  # Windows specification
-  win_spec = spec.clone
-  win_spec.platform = Gem::Platform::CURRENT
-  win_spec.files += binaries.to_a
-  win_spec.instance_variable_set(:@cache_file, nil)
-
-  # Unset extensions
-  win_spec.extensions = nil
-
-  # Rake task to build the windows package
-  Gem::PackageTask.new(win_spec) do |pkg|
-    pkg.package_dir = 'pkg'
-    pkg.need_tar = false
-  end
-end
-
-# RDoc Task
-desc 'Generate rdoc documentation'
-RDoc::Task.new("rdoc") do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'LibXML'
-  rdoc.generator = 'hanna'
-
-  # Show source inline with line numbers
-  rdoc.options << '--line-numbers'
-  rdoc.options << '--charset=utf-8'
-  # Make the readme file the start page for the generated html
-  rdoc.main = 'README.rdoc'
-  rdoc.rdoc_files.include('doc/*.rdoc',
-                          'ext/**/libxml.c',
-                          'ext/**/ruby_xml.c',
-                          'ext/**/*.c',
-                          'lib/**/*.rb',
-                          'README.rdoc',
-                          'HISTORY',
-                          'LICENSE')
-end
-
-# Test Task
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test*.rb'] - ['test/test_suite.rb']
-  t.verbose = true
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "rake/extensiontask"
+require "rake/testtask"
+require "rubygems/package_task"
+require "rdoc/task"
+require "yaml"
+
+GEM_NAME = "libxml-ruby"
+SO_NAME  = "libxml_ruby"
+
+# Read the spec file
+spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
+
+task :default => [:test]
+
+# Setup compile tasks
+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+$/, '')}"
+end
+
+# Setup generic gem
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.package_dir = 'pkg'
+  pkg.need_tar    = false
+end
+
+# Setup Windows Gem
+if RUBY_PLATFORM.match(/mingw/)
+  binaries = (FileList['lib/**/*.so'])
+
+  # Windows specification
+  mingw_spec = spec.clone
+  mingw_spec.platform = Gem::Platform::CURRENT
+  mingw_spec.files += binaries.to_a
+  mingw_spec.instance_variable_set(:@cache_file, nil)
+
+  # Unset extensions
+  mingw_spec.extensions = nil
+
+  # Rake task to build the windows package
+  Gem::PackageTask.new(mingw_spec) do |pkg|
+    pkg.package_dir = 'pkg'
+    pkg.need_tar = false
+  end
+end
+
+# RDoc Task
+desc 'Generate rdoc documentation'
+RDoc::Task.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LibXML'
+  rdoc.generator = 'aliki'
+
+  # Show source inline with line numbers
+  rdoc.options << '--line-numbers'
+  rdoc.options << '--charset=utf-8'
+  # Make the readme file the start page for the generated html
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('ext/**/libxml.c',
+                          'ext/**/ruby_xml.c',
+                          'ext/**/*.c',
+                          'lib/**/*.rb',
+                          'README.md',
+                          'CHANGELOG.md',
+                          'LICENSE')
+end
+
+# Test Task
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb'] - ['test/test_suite.rb']
+  t.verbose = true
 end

data/ext/libxml/extconf.rb

@@ -23,32 +23,46 @@ if xc
   end
 else
   dir_config('xml2')
+  pkg_config('libxml-2.0')
 end
 
-found_header = find_header('libxml/xmlversion.h',
-                           '/opt/include/libxml2',
-                           '/opt/local/include/libxml2',
-                           '/opt/homebrew/opt/libxml2/include/libxml2',
-                           '/usr/local/include/libxml2',
-                           '/usr/include/libxml2',
-                           '/usr/local/include',
-                           '/usr/local/opt/libxml2/include/libxml2')
+include_dirs = []
+lib_dirs = []
+
+if (msystem_prefix = ENV['MSYSTEM_PREFIX']) && !msystem_prefix.empty?
+  include_dirs.concat([
+    "#{msystem_prefix}/include/libxml2",
+    "#{msystem_prefix}/include"
+  ])
+  lib_dirs << "#{msystem_prefix}/lib"
+end
+
+include_dirs.concat([
+  '/opt/include/libxml2',
+  '/opt/local/include/libxml2',
+  '/opt/homebrew/opt/libxml2/include/libxml2',
+  '/usr/local/include/libxml2',
+  '/usr/include/libxml2',
+  '/usr/local/include',
+  '/usr/local/opt/libxml2/include/libxml2'
+])
+
+lib_dirs.concat([
+  '/opt/lib',
+  '/opt/local/lib',
+  '/opt/homebrew/opt/libxml2/lib',
+  '/usr/lib',
+  '/usr/local/lib',
+  '/usr/local/opt/libxml2/lib'
+])
+
+found_header = find_header('libxml/xmlversion.h', *include_dirs)
 
 found_lib = find_library('xml2', 'xmlParseDoc',
-                           '/opt/lib',
-                           '/opt/local/lib',
-                           '/opt/homebrew/opt/libxml2/lib',
-                           '/usr/lib',
-                           '/usr/local/lib',
-                           '/usr/local/opt/libxml2/lib')
+                         *lib_dirs)
 
 found_lib ||= find_library('libxml2', 'xmlParseDoc',
-                           '/opt/lib',
-                           '/opt/local/lib',
-                           '/opt/homebrew/opt/libxml2/lib',
-                           '/usr/lib',
-                           '/usr/local/lib',
-                           '/usr/local/opt/libxml2/lib')
+                           *lib_dirs)
 
 if !found_header || !found_lib
     crash(<<~EOL)
@@ -63,5 +77,10 @@ if !found_header || !found_lib
     EOL
 end
 
+# Optional zlib support via libxml2; defines HAVE_ZLIB_H if available.
+unless have_header("zlib.h")
+  message "zlib not found: building without compression support\n"
+end
+
 create_header()
 create_makefile('libxml_ruby')

data/ext/libxml/libxml.c

@@ -1,79 +1,67 @@
-#include "ruby_libxml.h"
-
-#if RUBY_INTERN_H
-#include <ruby/util.h>
-#else
-#include <util.h>
-#endif
-
-
-VALUE mLibXML;
-
-static void rxml_init_memory(void)
-{
- /* Disable for now - broke attributes. 
-  xmlGcMemSetup(
-      (xmlFreeFunc)ruby_xfree,
-      (xmlMallocFunc)ruby_xmalloc,
-      (xmlMallocFunc)ruby_xmalloc,
-      (xmlReallocFunc)ruby_xrealloc,
-      (xmlStrdupFunc)ruby_strdup
-  );*/
-}
-
-void Init_libxml_ruby(void)
-{
-/* The libxml gem provides Ruby language bindings for GNOME's Libxml2
- * XML toolkit.  To get started you may:
- *
- *  require 'test_helper'
- *  document = XML::Document.new
- *
- * However, when creating an application or library you plan to
- * redistribute, it is best to not add the LibXML module to the global
- * namespace, in which case you can either write your code like this:
- *
- *  require 'libxml'
- *  document = LibXML::XML::Document.new
- *
- * Refer to the README file to get started and the LICENSE file for
- * copyright and distribution information.
- */
-
-  // Seutp for threading. http://xmlsoft.org/threads.html
-  xmlInitParser();
-
-  mLibXML = rb_define_module("LibXML");
-
-  rxml_init_memory();
-  rxml_init_xml();
-  rxml_init_io();
-  rxml_init_error();
-  rxml_init_encoding();
-  rxml_init_parser();
-  rxml_init_parser_context();
-  rxml_init_parser_options();
-  rxml_init_node();
-  rxml_init_attributes();
-  rxml_init_attr();
-  rxml_init_attr_decl();
-  rxml_init_document();
-  rxml_init_namespaces();
-  rxml_init_namespace();
-  rxml_init_sax_parser();
-  rxml_init_sax2_handler();
-  rxml_init_xinclude();
-  rxml_init_xpath();
-  rxml_init_xpath_object();
-  rxml_init_xpath_context();
-  rxml_init_xpath_expression();
-  rxml_init_html_parser();
-  rxml_init_html_parser_options();
-  rxml_init_html_parser_context();
-  rxml_init_input_callbacks();
-  rxml_init_dtd();
-  rxml_init_schema();
-  rxml_init_relaxng();
-  rxml_init_reader();
-  rxml_init_writer();
-}
+#include "ruby_libxml.h"
+
+#if RUBY_INTERN_H
+#include <ruby/util.h>
+#else
+#include <util.h>
+#endif
+
+
+VALUE mLibXML;
+
+void Init_libxml_ruby(void)
+{
+/* The libxml gem provides Ruby language bindings for GNOME's Libxml2
+ * XML toolkit.  To get started you may:
+ *
+ *  require 'test_helper'
+ *  document = XML::Document.new
+ *
+ * However, when creating an application or library you plan to
+ * redistribute, it is best to not add the LibXML module to the global
+ * namespace, in which case you can either write your code like this:
+ *
+ *  require 'libxml'
+ *  document = LibXML::XML::Document.new
+ *
+ * Refer to the README file to get started and the LICENSE file for
+ * copyright and distribution information.
+ */
+
+  // Setup for threading. http://xmlsoft.org/threads.html
+  xmlInitParser();
+
+  mLibXML = rb_define_module("LibXML");
+
+  rxml_init_registry();
+  rxml_init_xml();
+  rxml_init_io();
+  rxml_init_error();
+  rxml_init_encoding();
+  rxml_init_parser();
+  rxml_init_parser_context();
+  rxml_init_parser_options();
+  rxml_init_node();
+  rxml_init_attributes();
+  rxml_init_attr();
+  rxml_init_attr_decl();
+  rxml_init_document();
+  rxml_init_namespaces();
+  rxml_init_namespace();
+  rxml_init_sax_parser();
+  rxml_init_sax2_handler();
+  rxml_init_xinclude();
+  rxml_init_xpath();
+  rxml_init_xpath_object();
+  rxml_init_xpath_context();
+  rxml_init_xpath_expression();
+  rxml_init_html_parser();
+  rxml_init_html_parser_options();
+  rxml_init_html_parser_context();
+  rxml_init_input_callbacks();
+  rxml_init_dtd();
+  rxml_init_schema();
+  rxml_init_relaxng();
+  rxml_init_reader();
+  rxml_init_writer();
+}

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_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"
+#include "ruby_xml_registry.h"
+
+extern VALUE mLibXML;
+
+#endif