dep: update minimum supported version of libxml to 2.7.7 (#3232)

**What problem is this PR intended to solve?** We have some code that exists to workaround old versions of libxml, and I want to get rid of it. v2.7.7 is a convenient version that lets us get rid of most of the C workarounds and is also 14 years old so I hope to hell nobody is still running it. We could probably choose a later version, but it wouldn't simplify the code much. I'm fine waiting for a compelling reason to do so. I've also removed some tests/assertions that were conditional on now-unsupported versions of libxml2. **Have you included adequate test coverage?** N/A **Does this change affect the behavior of either the C or the Java implementations?** N/A
sparklemotion · Jun 14, 2024 · 526b814 · 526b814
2 parents baa215a + e57e406
commit 526b814
Show file tree

Hide file tree

Showing 14 changed files with 13 additions and 204 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,8 +8,9 @@ Nokogiri follows [Semantic Versioning](https://semver.org/), please see the [REA
 
 ### Dependencies
 
-* [CRuby] Vendored libxml2 is updated to [v2.13.0](https://gitlab.gnome.org/GNOME/libxml2/-/releases/v2.13.0). @flavorjones
-* [CRuby] Vendored libxslt is updated to [v1.1.40](https://gitlab.gnome.org/GNOME/libxslt/-/releases/v1.1.40). @flavorjones
+* [CRuby] Vendored libxml2 is updated to [v2.13.0](https://gitlab.gnome.org/GNOME/libxml2/-/releases/v2.13.0). [#3230] @flavorjones
+* [CRuby] Vendored libxslt is updated to [v1.1.40](https://gitlab.gnome.org/GNOME/libxslt/-/releases/v1.1.40). [#3230] @flavorjones
+* [CRuby] Minimum supported version of libxml2 raised to v2.7.7 (released 2010-03-15) from v2.6.21. @flavorjones
 
 
 ### Added

diff --git a/ext/nokogiri/extconf.rb b/ext/nokogiri/extconf.rb
@@ -12,7 +12,7 @@
 
 # helpful constants
 PACKAGE_ROOT_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
-REQUIRED_LIBXML_VERSION = "2.6.21"
+REQUIRED_LIBXML_VERSION = "2.7.7"
 RECOMMENDED_LIBXML_VERSION = "2.9.3"
 
 REQUIRED_MINI_PORTILE_VERSION = "~> 2.8.2" # keep this version in sync with the one in the gemspec
@@ -1116,12 +1116,6 @@ def compile
   ensure_func("gumbo_parse_with_options", "nokogiri_gumbo.h")
 end
 
-have_func("xmlHasFeature") || abort("xmlHasFeature() is missing.") # introduced in libxml 2.6.21
-have_func("xmlFirstElementChild") # introduced in libxml 2.7.3
-have_func("xmlRelaxNGSetParserStructuredErrors") # introduced in libxml 2.6.24
-have_func("xmlRelaxNGSetValidStructuredErrors") # introduced in libxml 2.6.21
-have_func("xmlSchemaSetValidStructuredErrors") # introduced in libxml 2.6.23
-have_func("xmlSchemaSetParserStructuredErrors") # introduced in libxml 2.6.23
 have_func("rb_category_warning") # introduced in Ruby 3.0
 
 other_library_versions_string = OTHER_LIBRARY_VERSIONS.map { |k, v| [k, v].join(":") }.join(",")

diff --git a/ext/nokogiri/libxml2_backwards_compat.c b/ext/nokogiri/libxml2_backwards_compat.c
diff --git a/ext/nokogiri/nokogiri.h b/ext/nokogiri/nokogiri.h
@@ -56,13 +56,6 @@
 
 #include <libexslt/exslt.h>
 
-/* libxml2_backwards_compat.c */
-#ifndef HAVE_XMLFIRSTELEMENTCHILD
-xmlNodePtr xmlFirstElementChild(xmlNodePtr parent);
-xmlNodePtr xmlNextElementSibling(xmlNodePtr node);
-xmlNodePtr xmlLastElementChild(xmlNodePtr parent);
-#endif
-
 #define XMLNS_PREFIX "xmlns"
 #define XMLNS_PREFIX_LEN 6 /* including either colon or \0 */
 

diff --git a/ext/nokogiri/xml_node.c b/ext/nokogiri/xml_node.c
@@ -1066,17 +1066,10 @@ previous_element(VALUE self)
   xmlNodePtr node, sibling;
   Noko_Node_Get_Struct(self, xmlNode, node);
 
-  /*
-   *  note that we don't use xmlPreviousElementSibling here because it's buggy pre-2.7.7.
-   */
-  sibling = node->prev;
+  sibling = xmlPreviousElementSibling(node);
   if (!sibling) { return Qnil; }
 
-  while (sibling && sibling->type != XML_ELEMENT_NODE) {
-    sibling = sibling->prev;
-  }
-
-  return sibling ? noko_xml_node_wrap(Qnil, sibling) : Qnil ;
+  return noko_xml_node_wrap(Qnil, sibling);
 }
 
 /* :nodoc: */
@@ -2165,15 +2158,6 @@ in_context(VALUE self, VALUE _str, VALUE _options)
 
   xmlSetStructuredErrorFunc((void *)err, Nokogiri_error_array_pusher);
 
-  /* Twiddle global variable because of a bug in libxml2.
-   * http://git.gnome.org/browse/libxml2/commit/?id=e20fb5a72c83cbfc8e4a8aa3943c6be8febadab7
-   *
-   * TODO: this is fixed, and HTML_PARSE_NOIMPLIED is defined, in libxml2 2.7.7
-   */
-#ifndef HTML_PARSE_NOIMPLIED
-  htmlHandleOmittedElem(0);
-#endif
-
   /* This function adds a fake node to the child of +node+.  If the parser
    * does not exit cleanly with XML_ERR_OK, the list is freed.  This can
    * leave the child pointers in a bad state if they were originally empty.
@@ -2202,10 +2186,6 @@ in_context(VALUE self, VALUE _str, VALUE _options)
     child_iter = child_iter->next;
   }
 
-#ifndef HTML_PARSE_NOIMPLIED
-  htmlHandleOmittedElem(1);
-#endif
-
   xmlSetStructuredErrorFunc(NULL, NULL);
 
   /*

diff --git a/ext/nokogiri/xml_relax_ng.c b/ext/nokogiri/xml_relax_ng.c
@@ -43,13 +43,11 @@ validate_document(VALUE self, VALUE document)
     rb_raise(rb_eRuntimeError, "Could not create a validation context");
   }
 
-#ifdef HAVE_XMLRELAXNGSETVALIDSTRUCTUREDERRORS
   xmlRelaxNGSetValidStructuredErrors(
     valid_ctxt,
     Nokogiri_error_array_pusher,
     (void *)errors
   );
-#endif
 
   xmlRelaxNGValidateDoc(valid_ctxt, doc);
 
@@ -79,13 +77,11 @@ xml_relax_ng_parse_schema(
   rb_errors = rb_ary_new();
   xmlSetStructuredErrorFunc((void *)rb_errors, Nokogiri_error_array_pusher);
 
-#ifdef HAVE_XMLRELAXNGSETPARSERSTRUCTUREDERRORS
   xmlRelaxNGSetParserStructuredErrors(
     c_parser_context,
     Nokogiri_error_array_pusher,
     (void *)rb_errors
   );
-#endif
 
   c_schema = xmlRelaxNGParse(c_parser_context);
 

diff --git a/ext/nokogiri/xml_schema.c b/ext/nokogiri/xml_schema.c
@@ -43,13 +43,11 @@ validate_document(VALUE self, VALUE document)
     rb_raise(rb_eRuntimeError, "Could not create a validation context");
   }
 
-#ifdef HAVE_XMLSCHEMASETVALIDSTRUCTUREDERRORS
   xmlSchemaSetValidStructuredErrors(
     valid_ctxt,
     Nokogiri_error_array_pusher,
     (void *)errors
   );
-#endif
 
   xmlSchemaValidateDoc(valid_ctxt, doc);
 
@@ -84,13 +82,11 @@ validate_file(VALUE self, VALUE rb_filename)
     rb_raise(rb_eRuntimeError, "Could not create a validation context");
   }
 
-#ifdef HAVE_XMLSCHEMASETVALIDSTRUCTUREDERRORS
   xmlSchemaSetValidStructuredErrors(
     valid_ctxt,
     Nokogiri_error_array_pusher,
     (void *)errors
   );
-#endif
 
   xmlSchemaValidateFile(valid_ctxt, filename, 0);
 
@@ -122,13 +118,11 @@ xml_schema_parse_schema(
   rb_errors = rb_ary_new();
   xmlSetStructuredErrorFunc((void *)rb_errors, Nokogiri_error_array_pusher);
 
-#ifdef HAVE_XMLSCHEMASETPARSERSTRUCTUREDERRORS
   xmlSchemaSetParserStructuredErrors(
     c_parser_context,
     Nokogiri_error_array_pusher,
     (void *)rb_errors
   );
-#endif
 
   parse_options_int = (int)NUM2INT(rb_funcall(rb_parse_options, rb_intern("to_i"), 0));
   if (parse_options_int & XML_PARSE_NONET) {

diff --git a/lib/nokogiri/xml/node.rb b/lib/nokogiri/xml/node.rb
@@ -1577,19 +1577,12 @@ def add_sibling(next_or_previous, node_or_tags)
         node_or_tags
       end
 
-      USING_LIBXML_WITH_BROKEN_SERIALIZATION = Nokogiri.uses_libxml?("~> 2.6.0").freeze
-      private_constant :USING_LIBXML_WITH_BROKEN_SERIALIZATION
-
       def to_format(save_option, options)
-        return dump_html if USING_LIBXML_WITH_BROKEN_SERIALIZATION
-
         options[:save_with] = save_option unless options[:save_with]
         serialize(options)
       end
 
       def write_format_to(save_option, io, options)
-        return (io << dump_html) if USING_LIBXML_WITH_BROKEN_SERIALIZATION
-
         options[:save_with] ||= save_option
         write_to(io, options)
       end

diff --git a/nokogiri.gemspec b/nokogiri.gemspec
@@ -152,7 +152,6 @@ Gem::Specification.new do |spec|
     "ext/nokogiri/html4_entity_lookup.c",
     "ext/nokogiri/html4_sax_parser_context.c",
     "ext/nokogiri/html4_sax_push_parser.c",
-    "ext/nokogiri/libxml2_backwards_compat.c",
     "ext/nokogiri/nokogiri.c",
     "ext/nokogiri/nokogiri.h",
     "ext/nokogiri/xml_attr.c",

diff --git a/test/html4/sax/test_parser.rb b/test/html4/sax/test_parser.rb
@@ -116,11 +116,7 @@ def test_parser_attributes
 
           assert(block_called)
 
-          noshade_value = if Nokogiri.uses_libxml?("< 2.7.7")
-            ["noshade", "noshade"]
-          else
-            ["noshade", nil]
-          end
+          noshade_value = ["noshade", nil]
 
           assert_equal(
             [

diff --git a/test/html4/test_document.rb b/test/html4/test_document.rb
@@ -74,14 +74,12 @@ def test_empty_string_returns_empty_doc
         end
 
         def test_to_xhtml_with_indent
-          skip if Nokogiri.uses_libxml?("~> 2.6.0")
           doc = Nokogiri::HTML4("<html><body><a>foo</a></body></html>")
           doc = Nokogiri::HTML4(doc.to_xhtml(indent: 2))
           assert_indent(2, doc)
         end
 
         def test_write_to_xhtml_with_indent
-          skip if Nokogiri.uses_libxml?("~> 2.6.0")
           io = StringIO.new
           doc = Nokogiri::HTML4("<html><body><a>foo</a></body></html>")
           doc.write_xhtml_to(io, indent: 5)

diff --git a/test/html4/test_document_fragment.rb b/test/html4/test_document_fragment.rb
@@ -100,11 +100,7 @@ def test_html_fragment
         def test_html_fragment_has_outer_text
           doc = "a<div>b</div>c"
           fragment = Nokogiri::HTML4::Document.new.fragment(doc)
-          if Nokogiri.uses_libxml?("<= 2.6.16")
-            assert_equal("a<div>b</div><p>c</p>", fragment.to_s)
-          else
-            assert_equal("a<div>b</div>c", fragment.to_s)
-          end
+          assert_equal("a<div>b</div>c", fragment.to_s)
         end
 
         def test_html_fragment_case_insensitivity
@@ -162,13 +158,7 @@ def test_to_html
         def test_to_xhtml
           doc = "<span>foo<br></span><span>bar</span><p></p>"
           fragment = Nokogiri::HTML4::Document.new.fragment(doc)
-          if Nokogiri.jruby? || Nokogiri.uses_libxml?(">= 2.7.0")
-            assert_equal("<span>foo<br /></span><span>bar</span><p></p>", fragment.to_xhtml)
-          else
-            # FIXME: why are we doing this ? this violates the spec,
-            # see http://www.w3.org/TR/xhtml1/#C_2
-            assert_equal("<span>foo<br></span><span>bar</span><p></p>", fragment.to_xhtml)
-          end
+          assert_equal("<span>foo<br /></span><span>bar</span><p></p>", fragment.to_xhtml)
         end
 
         def test_to_xml

diff --git a/test/html4/test_element_description.rb b/test/html4/test_element_description.rb
@@ -58,10 +58,8 @@ def test_description
 
       def test_subelements
         sub_elements = ElementDescription["body"].sub_elements
-        if Nokogiri.uses_libxml?(">= 2.7.7")
+        if Nokogiri.uses_libxml?
           assert_equal(65, sub_elements.length)
-        elsif Nokogiri.uses_libxml?
-          assert_equal(61, sub_elements.length)
         else
           assert_equal(105, sub_elements.length)
         end

diff --git a/test/xml/test_document.rb b/test/xml/test_document.rb
@@ -646,11 +646,9 @@ def test_write_xml_to_with_indent
           assert_indent(5, doc)
         end
 
-        unless Nokogiri.uses_libxml?("~> 2.6.0")
-          def test_encoding
-            xml = Nokogiri::XML(File.read(XML_FILE), XML_FILE, "UTF-8")
-            assert_equal("UTF-8", xml.encoding)
-          end
+        def test_encoding
+          xml = Nokogiri::XML(File.read(XML_FILE), XML_FILE, "UTF-8")
+          assert_equal("UTF-8", xml.encoding)
         end
 
         def test_memory_explosion_on_invalid_xml