nokogiri 1.10.3 → 1.13.9

data/lib/nokogiri/version/info.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "shellwords"
+
+module Nokogiri
+  class VersionInfo # :nodoc:
+    include Singleton
+
+    def jruby?
+      ::JRUBY_VERSION if ::RUBY_PLATFORM == "java"
+    end
+
+    def windows?
+      ::RUBY_PLATFORM =~ /mingw|mswin/
+    end
+
+    def ruby_minor
+      Gem::Version.new(::RUBY_VERSION).segments[0..1].join(".")
+    end
+
+    def engine
+      defined?(::RUBY_ENGINE) ? ::RUBY_ENGINE : "mri"
+    end
+
+    def loaded_libxml_version
+      Gem::Version.new(Nokogiri::LIBXML_LOADED_VERSION
+        .scan(/^(\d+)(\d\d)(\d\d)(?!\d)/).first
+        .collect(&:to_i)
+        .join("."))
+    end
+
+    def compiled_libxml_version
+      Gem::Version.new(Nokogiri::LIBXML_COMPILED_VERSION)
+    end
+
+    def loaded_libxslt_version
+      Gem::Version.new(Nokogiri::LIBXSLT_LOADED_VERSION
+        .scan(/^(\d+)(\d\d)(\d\d)(?!\d)/).first
+        .collect(&:to_i)
+        .join("."))
+    end
+
+    def compiled_libxslt_version
+      Gem::Version.new(Nokogiri::LIBXSLT_COMPILED_VERSION)
+    end
+
+    def libxml2?
+      defined?(Nokogiri::LIBXML_COMPILED_VERSION)
+    end
+
+    def libxml2_has_iconv?
+      defined?(Nokogiri::LIBXML_ICONV_ENABLED) && Nokogiri::LIBXML_ICONV_ENABLED
+    end
+
+    def libxslt_has_datetime?
+      defined?(Nokogiri::LIBXSLT_DATETIME_ENABLED) && Nokogiri::LIBXSLT_DATETIME_ENABLED
+    end
+
+    def libxml2_using_packaged?
+      libxml2? && Nokogiri::PACKAGED_LIBRARIES
+    end
+
+    def libxml2_using_system?
+      libxml2? && !libxml2_using_packaged?
+    end
+
+    def libxml2_precompiled?
+      libxml2_using_packaged? && Nokogiri::PRECOMPILED_LIBRARIES
+    end
+
+    def warnings
+      warnings = []
+
+      if libxml2?
+        if compiled_libxml_version != loaded_libxml_version
+          warnings << "Nokogiri was built against libxml version #{compiled_libxml_version}, but has dynamically loaded #{loaded_libxml_version}"
+        end
+
+        if compiled_libxslt_version != loaded_libxslt_version
+          warnings << "Nokogiri was built against libxslt version #{compiled_libxslt_version}, but has dynamically loaded #{loaded_libxslt_version}"
+        end
+      end
+
+      warnings
+    end
+
+    def to_hash
+      header_directory = File.expand_path(File.join(File.dirname(__FILE__), "../../../ext/nokogiri"))
+
+      {}.tap do |vi|
+        vi["warnings"] = []
+        vi["nokogiri"] = {}.tap do |nokogiri|
+          nokogiri["version"] = Nokogiri::VERSION
+
+          unless jruby?
+            #  enable gems like nokogumbo to build with the following in their extconf.rb:
+            #
+            #    append_cflags(Nokogiri::VERSION_INFO["nokogiri"]["cppflags"])
+            #    append_ldflags(Nokogiri::VERSION_INFO["nokogiri"]["ldflags"])
+            #
+            cppflags = ["-I#{header_directory.shellescape}"]
+            ldflags = []
+
+            if libxml2_using_packaged?
+              cppflags << "-I#{File.join(header_directory, "include").shellescape}"
+              cppflags << "-I#{File.join(header_directory, "include/libxml2").shellescape}"
+
+              if windows?
+                # on windows, nokogumbo needs to link against nokogiri.so to resolve symbols. see #2167
+                lib_directory = File.expand_path(File.join(File.dirname(__FILE__), "../#{ruby_minor}"))
+                unless File.exist?(lib_directory)
+                  lib_directory = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+                end
+                ldflags << "-L#{lib_directory.shellescape}"
+                ldflags << "-l:nokogiri.so"
+              end
+            end
+
+            nokogiri["cppflags"] = cppflags
+            nokogiri["ldflags"] = ldflags
+          end
+        end
+        vi["ruby"] = {}.tap do |ruby|
+          ruby["version"] = ::RUBY_VERSION
+          ruby["platform"] = ::RUBY_PLATFORM
+          ruby["gem_platform"] = ::Gem::Platform.local.to_s
+          ruby["description"] = ::RUBY_DESCRIPTION
+          ruby["engine"] = engine
+          ruby["jruby"] = jruby? if jruby?
+        end
+
+        if libxml2?
+          vi["libxml"] = {}.tap do |libxml|
+            if libxml2_using_packaged?
+              libxml["source"] = "packaged"
+              libxml["precompiled"] = libxml2_precompiled?
+              libxml["patches"] = Nokogiri::LIBXML2_PATCHES
+
+              # this is for nokogumbo and shouldn't be forever
+              libxml["libxml2_path"] = header_directory
+            else
+              libxml["source"] = "system"
+            end
+            libxml["memory_management"] = Nokogiri::LIBXML_MEMORY_MANAGEMENT
+            libxml["iconv_enabled"] = libxml2_has_iconv?
+            libxml["compiled"] = compiled_libxml_version.to_s
+            libxml["loaded"] = loaded_libxml_version.to_s
+          end
+
+          vi["libxslt"] = {}.tap do |libxslt|
+            if libxml2_using_packaged?
+              libxslt["source"] = "packaged"
+              libxslt["precompiled"] = libxml2_precompiled?
+              libxslt["patches"] = Nokogiri::LIBXSLT_PATCHES
+            else
+              libxslt["source"] = "system"
+            end
+            libxslt["datetime_enabled"] = libxslt_has_datetime?
+            libxslt["compiled"] = compiled_libxslt_version.to_s
+            libxslt["loaded"] = loaded_libxslt_version.to_s
+          end
+
+          vi["warnings"] = warnings
+        end
+
+        if defined?(Nokogiri::OTHER_LIBRARY_VERSIONS)
+          # see extconf for how this string is assembled: "lib1name:lib1version,lib2name:lib2version"
+          vi["other_libraries"] = Hash[*Nokogiri::OTHER_LIBRARY_VERSIONS.split(/[,:]/)]
+        elsif jruby?
+          vi["other_libraries"] = {}.tap do |ol|
+            ol["xerces"] = Nokogiri::XERCES_VERSION
+            ol["nekohtml"] = Nokogiri::NEKO_VERSION
+          end
+        end
+      end
+    end
+
+    def to_markdown
+      require "yaml"
+      "# Nokogiri (#{Nokogiri::VERSION})\n" +
+        YAML.dump(to_hash).each_line.map { |line| "    #{line}" }.join
+    end
+
+    instance.warnings.each do |warning|
+      warn "WARNING: #{warning}"
+    end
+  end
+
+  # :nodoc:
+  def self.uses_libxml?(requirement = nil)
+    return false unless VersionInfo.instance.libxml2?
+    return true unless requirement
+
+    Gem::Requirement.new(requirement).satisfied_by?(VersionInfo.instance.loaded_libxml_version)
+  end
+
+  # :nodoc:
+  def self.uses_gumbo?
+    uses_libxml? # TODO: replace with Gumbo functionality
+  end
+
+  # :nodoc:
+  def self.jruby?
+    VersionInfo.instance.jruby?
+  end
+
+  # :nodoc:
+  def self.libxml2_patches
+    if VersionInfo.instance.libxml2_using_packaged?
+      Nokogiri::VERSION_INFO["libxml"]["patches"]
+    else
+      []
+    end
+  end
+
+  require_relative "../jruby/dependencies" if Nokogiri.jruby?
+  require_relative "../extension"
+
+  # Detailed version info about Nokogiri and the installed extension dependencies.
+  VERSION_INFO = VersionInfo.instance.to_hash
+end

data/lib/nokogiri/version.rb

@@ -1,109 +1,4 @@
-module Nokogiri
-  # The version of Nokogiri you are using
-  VERSION = "1.10.3"
+# frozen_string_literal: true
 
-  class VersionInfo # :nodoc:
-    def jruby?
-      ::JRUBY_VERSION if RUBY_PLATFORM == "java"
-    end
-
-    def engine
-      defined?(RUBY_ENGINE) ? RUBY_ENGINE : "mri"
-    end
-
-    def loaded_parser_version
-      LIBXML_PARSER_VERSION.
-        scan(/^(\d+)(\d\d)(\d\d)(?!\d)/).first.
-        collect(&:to_i).
-        join(".")
-    end
-
-    def compiled_parser_version
-      LIBXML_VERSION
-    end
-
-    def libxml2?
-      defined?(LIBXML_VERSION)
-    end
-
-    def libxml2_using_system?
-      !libxml2_using_packaged?
-    end
-
-    def libxml2_using_packaged?
-      NOKOGIRI_USE_PACKAGED_LIBRARIES
-    end
-
-    def warnings
-      return [] unless libxml2?
-
-      if compiled_parser_version != loaded_parser_version
-        ["Nokogiri was built against LibXML version #{compiled_parser_version}, but has dynamically loaded #{loaded_parser_version}"]
-      else
-        []
-      end
-    end
-
-    def to_hash
-      hash_info = {}
-      hash_info["warnings"] = []
-      hash_info["nokogiri"] = Nokogiri::VERSION
-      hash_info["ruby"] = {}
-      hash_info["ruby"]["version"] = ::RUBY_VERSION
-      hash_info["ruby"]["platform"] = ::RUBY_PLATFORM
-      hash_info["ruby"]["description"] = ::RUBY_DESCRIPTION
-      hash_info["ruby"]["engine"] = engine
-      hash_info["ruby"]["jruby"] = jruby? if jruby?
-
-      if libxml2?
-        hash_info["libxml"] = {}
-        hash_info["libxml"]["binding"] = "extension"
-        if libxml2_using_packaged?
-          hash_info["libxml"]["source"] = "packaged"
-          hash_info["libxml"]["libxml2_path"] = NOKOGIRI_LIBXML2_PATH
-          hash_info["libxml"]["libxslt_path"] = NOKOGIRI_LIBXSLT_PATH
-          hash_info["libxml"]["libxml2_patches"] = NOKOGIRI_LIBXML2_PATCHES
-          hash_info["libxml"]["libxslt_patches"] = NOKOGIRI_LIBXSLT_PATCHES
-        else
-          hash_info["libxml"]["source"] = "system"
-        end
-        hash_info["libxml"]["compiled"] = compiled_parser_version
-        hash_info["libxml"]["loaded"] = loaded_parser_version
-        hash_info["warnings"] = warnings
-      elsif jruby?
-        hash_info["xerces"] = Nokogiri::XERCES_VERSION
-        hash_info["nekohtml"] = Nokogiri::NEKO_VERSION
-      end
-
-      hash_info
-    end
-
-    def to_markdown
-      begin
-        require "psych"
-      rescue LoadError
-      end
-      require "yaml"
-      "# Nokogiri (#{Nokogiri::VERSION})\n" +
-      YAML.dump(to_hash).each_line.map { |line| "    #{line}" }.join
-    end
-
-    # FIXME: maybe switch to singleton?
-    @@instance = new
-    @@instance.warnings.each do |warning|
-      warn "WARNING: #{warning}"
-    end
-    def self.instance; @@instance; end
-  end
-
-  # More complete version information about libxml
-  VERSION_INFO = VersionInfo.instance.to_hash
-
-  def self.uses_libxml? # :nodoc:
-    VersionInfo.instance.libxml2?
-  end
-
-  def self.jruby? # :nodoc:
-    VersionInfo.instance.jruby?
-  end
-end
+require_relative "version/constant"
+require_relative "version/info"

data/lib/nokogiri/xml/attr.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 module Nokogiri
   module XML
     class Attr < Node
-      alias :value :content
-      alias :to_s :content
-      alias :content= :value=
+      alias_method :value, :content
+      alias_method :to_s, :content
+      alias_method :content=, :value=
 
       private
+
       def inspect_attributes
         [:name, :namespace, :value]
       end

data/lib/nokogiri/xml/attribute_decl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nokogiri
   module XML
     ###
@@ -11,7 +13,7 @@ module Nokogiri
       undef_method :line if method_defined?(:line)
 
       def inspect
-        "#<#{self.class.name}:#{sprintf("0x%x", object_id)} #{to_s.inspect}>"
+        "#<#{self.class.name}:#{format("0x%x", object_id)} #{to_s.inspect}>"
       end
     end
   end

data/lib/nokogiri/xml/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nokogiri
   module XML
     ###
@@ -195,6 +197,41 @@ module Nokogiri
     #
     # Note the "foo:object" tag.
     #
+    # === Namespace inheritance
+    #
+    # In the Builder context, children will inherit their parent's namespace. This is the same
+    # behavior as if the underlying {XML::Document} set +namespace_inheritance+ to +true+:
+    #
+    #   result = Nokogiri::XML::Builder.new do |xml|
+    #     xml["soapenv"].Envelope("xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/") do
+    #       xml.Header
+    #     end
+    #   end
+    #   result.doc.to_xml
+    #   # => <?xml version="1.0" encoding="utf-8"?>
+    #   #    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+    #   #      <soapenv:Header/>
+    #   #    </soapenv:Envelope>
+    #
+    # Users may turn this behavior off by passing a keyword argument +namespace_inheritance:false+
+    # to the initializer:
+    #
+    #   result = Nokogiri::XML::Builder.new(namespace_inheritance: false) do |xml|
+    #     xml["soapenv"].Envelope("xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/") do
+    #       xml.Header
+    #       xml["soapenv"].Body # users may explicitly opt into the namespace
+    #     end
+    #   end
+    #   result.doc.to_xml
+    #   # => <?xml version="1.0" encoding="utf-8"?>
+    #   #    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+    #   #      <Header/>
+    #   #      <soapenv:Body/>
+    #   #    </soapenv:Envelope>
+    #
+    # For more information on namespace inheritance, please see {XML::Document#namespace_inheritance}
+    #
+    #
     # == Document Types
     #
     # To create a document type (DTD), access use the Builder#doc method to get
@@ -213,7 +250,7 @@ module Nokogiri
     #       xml.foo
     #     end
     #   end
-    #   
+    #
     #   puts builder.to_xml
     #
     # Will output this xml:
@@ -225,6 +262,10 @@ module Nokogiri
     #   </root>
     #
     class Builder
+      include Nokogiri::ClassResolver
+
+      DEFAULT_DOCUMENT_OPTIONS = { namespace_inheritance: true }
+
       # The current Document object being built
       attr_accessor :doc
 
@@ -244,13 +285,13 @@ module Nokogiri
       #
       # For example:
       #
-      #   doc = Nokogiri::XML(open('somedoc.xml'))
-      #   Nokogiri::XML::Builder.with(doc.at('some_tag')) do |xml|
+      #   doc = Nokogiri::XML(File.read('somedoc.xml'))
+      #   Nokogiri::XML::Builder.with(doc.at_css('some_tag')) do |xml|
       #     # ... Use normal builder methods here ...
       #     xml.awesome # add the "awesome" tag below "some_tag"
       #   end
       #
-      def self.with root, &block
+      def self.with(root, &block)
         new({}, root, &block)
       end
 
@@ -263,31 +304,28 @@ module Nokogiri
       #   Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
       #     ...
       #   end
-      def initialize options = {}, root = nil, &block
-
+      def initialize(options = {}, root = nil, &block)
         if root
-          @doc    = root.document
+          @doc = root.document
           @parent = root
         else
-          namespace     = self.class.name.split('::')
-          namespace[-1] = 'Document'
-          @doc          = eval(namespace.join('::')).new
-          @parent       = @doc
+          @parent = @doc = related_class("Document").new
         end
 
-        @context  = nil
-        @arity    = nil
-        @ns       = nil
+        @context = nil
+        @arity = nil
+        @ns = nil
 
-        options.each do |k,v|
+        options = DEFAULT_DOCUMENT_OPTIONS.merge(options)
+        options.each do |k, v|
           @doc.send(:"#{k}=", v)
         end
 
-        return unless block_given?
+        return unless block
 
         @arity = block.arity
         if @arity <= 0
-          @context = eval('self', block.binding)
+          @context = eval("self", block.binding)
           instance_eval(&block)
         else
           yield self
@@ -298,26 +336,26 @@ module Nokogiri
 
       ###
       # Create a Text Node with content of +string+
-      def text string
-        insert @doc.create_text_node(string)
+      def text(string)
+        insert(@doc.create_text_node(string))
       end
 
       ###
       # Create a CDATA Node with content of +string+
-      def cdata string
-        insert doc.create_cdata(string)
+      def cdata(string)
+        insert(doc.create_cdata(string))
       end
 
       ###
       # Create a Comment Node with content of +string+
-      def comment string
-        insert doc.create_comment(string)
+      def comment(string)
+        insert(doc.create_comment(string))
       end
 
       ###
       # Build a tag that is associated with namespace +ns+.  Raises an
       # ArgumentError if +ns+ has not been defined higher in the tree.
-      def [] ns
+      def [](ns)
         if @parent != @doc
           @ns = @parent.namespace_definitions.find { |x| x.prefix == ns.to_s }
         end
@@ -325,12 +363,13 @@ module Nokogiri
 
         @parent.ancestors.each do |a|
           next if a == doc
+
           @ns = a.namespace_definitions.find { |x| x.prefix == ns.to_s }
           return self if @ns
         end
 
-        @ns = { :pending => ns.to_s }
-        return self
+        @ns = { pending: ns.to_s }
+        self
       end
 
       ###
@@ -338,7 +377,7 @@ module Nokogiri
       def to_xml(*args)
         if Nokogiri.jruby?
           options = args.first.is_a?(Hash) ? args.shift : {}
-          if !options[:save_with]
+          unless options[:save_with]
             options[:save_with] = Node::SaveOptions::AS_BUILDER
           end
           args.insert(0, options)
@@ -348,27 +387,28 @@ module Nokogiri
 
       ###
       # Append the given raw XML +string+ to the document
-      def << string
+      def <<(string)
         @doc.fragment(string).children.each { |x| insert(x) }
       end
 
-      def method_missing method, *args, &block # :nodoc:
-        if @context && @context.respond_to?(method)
+      def method_missing(method, *args, &block) # :nodoc:
+        if @context&.respond_to?(method)
           @context.send(method, *args, &block)
         else
-          node = @doc.create_element(method.to_s.sub(/[_!]$/, ''),*args) { |n|
+          node = @doc.create_element(method.to_s.sub(/[_!]$/, ""), *args) do |n|
             # Set up the namespace
-            if @ns.is_a? Nokogiri::XML::Namespace
+            if @ns.is_a?(Nokogiri::XML::Namespace)
               n.namespace = @ns
               @ns = nil
             end
-          }
+          end
 
-          if @ns.is_a? Hash
+          if @ns.is_a?(Hash)
             node.namespace = node.namespace_definitions.find { |x| x.prefix == @ns[:pending] }
             if node.namespace.nil?
               raise ArgumentError, "Namespace #{@ns[:pending]} has not been defined"
             end
+
             @ns = nil
           end
 
@@ -377,35 +417,39 @@ module Nokogiri
       end
 
       private
+
       ###
       # Insert +node+ as a child of the current Node
       def insert(node, &block)
         node = @parent.add_child(node)
-        if block_given?
-          old_parent = @parent
-          @parent    = node
-          @arity ||= block.arity
-          if @arity <= 0
-            instance_eval(&block)
-          else
-            block.call(self)
+        if block
+          begin
+            old_parent = @parent
+            @parent = node
+            @arity ||= block.arity
+            if @arity <= 0
+              instance_eval(&block)
+            else
+              yield(self)
+            end
+          ensure
+            @parent = old_parent
           end
-          @parent = old_parent
         end
         NodeBuilder.new(node, self)
       end
 
       class NodeBuilder # :nodoc:
-        def initialize node, doc_builder
+        def initialize(node, doc_builder)
           @node = node
           @doc_builder = doc_builder
         end
 
-        def []= k, v
+        def []=(k, v)
           @node[k] = v
         end
 
-        def [] k
+        def [](k)
           @node[k]
         end
 
@@ -413,22 +457,22 @@ module Nokogiri
           opts = args.last.is_a?(Hash) ? args.pop : {}
           case method.to_s
           when /^(.*)!$/
-            @node['id'] = $1
+            @node["id"] = Regexp.last_match(1)
             @node.content = args.first if args.first
           when /^(.*)=/
-            @node[$1] = args.first
+            @node[Regexp.last_match(1)] = args.first
           else
-            @node['class'] =
-              ((@node['class'] || '').split(/\s/) + [method.to_s]).join(' ')
+            @node["class"] =
+              ((@node["class"] || "").split(/\s/) + [method.to_s]).join(" ")
             @node.content = args.first if args.first
           end
 
           # Assign any extra options
-          opts.each do |k,v|
-            @node[k.to_s] = ((@node[k.to_s] || '').split(/\s/) + [v]).join(' ')
+          opts.each do |k, v|
+            @node[k.to_s] = ((@node[k.to_s] || "").split(/\s/) + [v]).join(" ")
           end
 
-          if block_given?
+          if block
             old_parent = @doc_builder.parent
             @doc_builder.parent = @node
             value = @doc_builder.instance_eval(&block)

data/lib/nokogiri/xml/cdata.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Nokogiri
   module XML
     class CDATA < Nokogiri::XML::Text
       ###
       # Get the name of this CDATA node
       def name
-        '#cdata-section'
+        "#cdata-section"
       end
     end
   end

data/lib/nokogiri/xml/character_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nokogiri
   module XML
     class CharacterData < Nokogiri::XML::Node