nokogiri 1.14.0.rc1-arm-linux

data/lib/nokogiri/xml/pp/node.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Nokogiri
+  module XML
+    # :nodoc: all
+    module PP
+      module Node
+        COLLECTIONS = [:attribute_nodes, :children]
+
+        def inspect
+          attributes = inspect_attributes.reject do |x|
+            attribute = send(x)
+            !attribute || (attribute.respond_to?(:empty?) && attribute.empty?)
+          rescue NoMethodError
+            true
+          end.map do |attribute|
+            "#{attribute.to_s.sub(/_\w+/, "s")}=#{send(attribute).inspect}"
+          end.join(" ")
+          "#<#{self.class.name}:#{format("0x%x", object_id)} #{attributes}>"
+        end
+
+        def pretty_print(pp)
+          nice_name = self.class.name.split("::").last
+          pp.group(2, "#(#{nice_name}:#{format("0x%x", object_id)} {", "})") do
+            pp.breakable
+            attrs = inspect_attributes.filter_map do |t|
+              [t, send(t)] if respond_to?(t)
+            end.find_all do |x|
+              if x.last
+                if COLLECTIONS.include?(x.first)
+                  !x.last.empty?
+                else
+                  true
+                end
+              end
+            end
+
+            pp.seplist(attrs) do |v|
+              if COLLECTIONS.include?(v.first)
+                pp.group(2, "#{v.first.to_s.sub(/_\w+$/, "s")} = [", "]") do
+                  pp.breakable
+                  pp.seplist(v.last) do |item|
+                    pp.pp(item)
+                  end
+                end
+              else
+                pp.text("#{v.first} = ")
+                pp.pp(v.last)
+              end
+            end
+            pp.breakable
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/pp.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "pp/node"
+require_relative "pp/character_data"

data/lib/nokogiri/xml/processing_instruction.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Nokogiri
+  module XML
+    class ProcessingInstruction < Node
+      def initialize(document, name, content)
+        super(document, name)
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/reader.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Nokogiri
+  module XML
+    ###
+    # Nokogiri::XML::Reader parses an XML document similar to the way a cursor
+    # would move.  The Reader is given an XML document, and yields nodes
+    # to an each block.
+    #
+    # Here is an example of usage:
+    #
+    #     reader = Nokogiri::XML::Reader(<<-eoxml)
+    #       <x xmlns:tenderlove='http://tenderlovemaking.com/'>
+    #         <tenderlove:foo awesome='true'>snuggles!</tenderlove:foo>
+    #       </x>
+    #     eoxml
+    #
+    #     reader.each do |node|
+    #
+    #       # node is an instance of Nokogiri::XML::Reader
+    #       puts node.name
+    #
+    #     end
+    #
+    # Note that Nokogiri::XML::Reader#each can only be called once!!  Once
+    # the cursor moves through the entire document, you must parse the
+    # document again.  So make sure that you capture any information you
+    # need during the first iteration.
+    #
+    # The Reader parser is good for when you need the speed of a SAX parser,
+    # but do not want to write a Document handler.
+    class Reader
+      include Enumerable
+
+      TYPE_NONE = 0
+      # Element node type
+      TYPE_ELEMENT = 1
+      # Attribute node type
+      TYPE_ATTRIBUTE = 2
+      # Text node type
+      TYPE_TEXT = 3
+      # CDATA node type
+      TYPE_CDATA = 4
+      # Entity Reference node type
+      TYPE_ENTITY_REFERENCE = 5
+      # Entity node type
+      TYPE_ENTITY = 6
+      # PI node type
+      TYPE_PROCESSING_INSTRUCTION = 7
+      # Comment node type
+      TYPE_COMMENT = 8
+      # Document node type
+      TYPE_DOCUMENT = 9
+      # Document Type node type
+      TYPE_DOCUMENT_TYPE = 10
+      # Document Fragment node type
+      TYPE_DOCUMENT_FRAGMENT = 11
+      # Notation node type
+      TYPE_NOTATION = 12
+      # Whitespace node type
+      TYPE_WHITESPACE = 13
+      # Significant Whitespace node type
+      TYPE_SIGNIFICANT_WHITESPACE = 14
+      # Element end node type
+      TYPE_END_ELEMENT = 15
+      # Entity end node type
+      TYPE_END_ENTITY = 16
+      # XML Declaration node type
+      TYPE_XML_DECLARATION = 17
+
+      # A list of errors encountered while parsing
+      attr_accessor :errors
+
+      # The XML source
+      attr_reader :source
+
+      alias_method :self_closing?, :empty_element?
+
+      def initialize(source, url = nil, encoding = nil) # :nodoc:
+        @source   = source
+        @errors   = []
+        @encoding = encoding
+      end
+      private :initialize
+
+      # Get the attributes and namespaces of the current node as a Hash.
+      #
+      # This is the union of Reader#attribute_hash and Reader#namespaces
+      #
+      # [Returns]
+      #   (Hash<String, String>) Attribute names and values, and namespace prefixes and hrefs.
+      def attributes
+        attribute_hash.merge(namespaces)
+      end
+
+      ###
+      # Move the cursor through the document yielding the cursor to the block
+      def each
+        while (cursor = read)
+          yield cursor
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/relax_ng.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Nokogiri
+  module XML
+    class << self
+      ###
+      # Create a new Nokogiri::XML::RelaxNG document from +string_or_io+.
+      # See Nokogiri::XML::RelaxNG for an example.
+      def RelaxNG(string_or_io, options = ParseOptions::DEFAULT_SCHEMA)
+        RelaxNG.new(string_or_io, options)
+      end
+    end
+
+    ###
+    # Nokogiri::XML::RelaxNG is used for validating XML against a
+    # RelaxNG schema.
+    #
+    # == Synopsis
+    #
+    # Validate an XML document against a RelaxNG schema.  Loop over the errors
+    # that are returned and print them out:
+    #
+    #   schema  = Nokogiri::XML::RelaxNG(File.open(ADDRESS_SCHEMA_FILE))
+    #   doc     = Nokogiri::XML(File.open(ADDRESS_XML_FILE))
+    #
+    #   schema.validate(doc).each do |error|
+    #     puts error.message
+    #   end
+    #
+    # The list of errors are Nokogiri::XML::SyntaxError objects.
+    #
+    # NOTE: RelaxNG input is always treated as TRUSTED documents, meaning that they will cause the
+    # underlying parsing libraries to access network resources. This is counter to Nokogiri's
+    # "untrusted by default" security policy, but is a limitation of the underlying libraries.
+    class RelaxNG < Nokogiri::XML::Schema
+    end
+  end
+end

data/lib/nokogiri/xml/sax/document.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Nokogiri
+  module XML
+    ###
+    # SAX Parsers are event driven parsers. Nokogiri provides two different event based parsers when
+    # dealing with XML. If you want to do SAX style parsing using HTML, check out
+    # Nokogiri::HTML4::SAX.
+    #
+    # The basic way a SAX style parser works is by creating a parser, telling the parser about the
+    # events we're interested in, then giving the parser some XML to process. The parser will notify
+    # you when it encounters events you said you would like to know about.
+    #
+    # To register for events, you simply subclass Nokogiri::XML::SAX::Document, and implement the
+    # methods for which you would like notification.
+    #
+    # For example, if I want to be notified when a document ends, and when an element starts, I
+    # would write a class like this:
+    #
+    #   class MyDocument < Nokogiri::XML::SAX::Document
+    #     def end_document
+    #       puts "the document has ended"
+    #     end
+    #
+    #     def start_element name, attributes = []
+    #       puts "#{name} started"
+    #     end
+    #   end
+    #
+    # Then I would instantiate a SAX parser with this document, and feed the parser some XML
+    #
+    #   # Create a new parser
+    #   parser = Nokogiri::XML::SAX::Parser.new(MyDocument.new)
+    #
+    #   # Feed the parser some XML
+    #   parser.parse(File.open(ARGV[0]))
+    #
+    # Now my document handler will be called when each node starts, and when then document ends. To
+    # see what kinds of events are available, take a look at Nokogiri::XML::SAX::Document.
+    #
+    # Two SAX parsers for XML are available, a parser that reads from a string or IO object as it
+    # feels necessary, and a parser that lets you spoon feed it XML. If you want to let Nokogiri
+    # deal with reading your XML, use the Nokogiri::XML::SAX::Parser. If you want to have fine grain
+    # control over the XML input, use the Nokogiri::XML::SAX::PushParser.
+    module SAX
+      ###
+      # This class is used for registering types of events you are interested in handling. All of
+      # the methods on this class are available as possible events while parsing an XML document. To
+      # register for any particular event, just subclass this class and implement the methods you
+      # are interested in knowing about.
+      #
+      # To only be notified about start and end element events, write a class like this:
+      #
+      #   class MyDocument < Nokogiri::XML::SAX::Document
+      #     def start_element name, attrs = []
+      #       puts "#{name} started!"
+      #     end
+      #
+      #     def end_element name
+      #       puts "#{name} ended"
+      #     end
+      #   end
+      #
+      # You can use this event handler for any SAX style parser included with Nokogiri. See
+      # Nokogiri::XML::SAX, and Nokogiri::HTML4::SAX.
+      class Document
+        ###
+        # Called when an XML declaration is parsed
+        def xmldecl(version, encoding, standalone)
+        end
+
+        ###
+        # Called when document starts parsing
+        def start_document
+        end
+
+        ###
+        # Called when document ends parsing
+        def end_document
+        end
+
+        ###
+        # Called at the beginning of an element
+        # * +name+ is the name of the tag
+        # * +attrs+ are an assoc list of namespaces and attributes, e.g.:
+        #     [ ["xmlns:foo", "http://sample.net"], ["size", "large"] ]
+        def start_element(name, attrs = [])
+        end
+
+        ###
+        # Called at the end of an element
+        # +name+ is the tag name
+        def end_element(name)
+        end
+
+        ###
+        # Called at the beginning of an element
+        # +name+ is the element name
+        # +attrs+ is a list of attributes
+        # +prefix+ is the namespace prefix for the element
+        # +uri+ is the associated namespace URI
+        # +ns+ is a hash of namespace prefix:urls associated with the element
+        def start_element_namespace(name, attrs = [], prefix = nil, uri = nil, ns = [])
+          ###
+          # Deal with SAX v1 interface
+          name = [prefix, name].compact.join(":")
+          attributes = ns.map do |ns_prefix, ns_uri|
+            [["xmlns", ns_prefix].compact.join(":"), ns_uri]
+          end + attrs.map do |attr|
+            [[attr.prefix, attr.localname].compact.join(":"), attr.value]
+          end
+          start_element(name, attributes)
+        end
+
+        ###
+        # Called at the end of an element
+        # +name+ is the element's name
+        # +prefix+ is the namespace prefix associated with the element
+        # +uri+ is the associated namespace URI
+        def end_element_namespace(name, prefix = nil, uri = nil)
+          ###
+          # Deal with SAX v1 interface
+          end_element([prefix, name].compact.join(":"))
+        end
+
+        ###
+        # Characters read between a tag. This method might be called multiple
+        # times given one contiguous string of characters.
+        #
+        # +string+ contains the character data
+        def characters(string)
+        end
+
+        ###
+        # Called when comments are encountered
+        # +string+ contains the comment data
+        def comment(string)
+        end
+
+        ###
+        # Called on document warnings
+        # +string+ contains the warning
+        def warning(string)
+        end
+
+        ###
+        # Called on document errors
+        # +string+ contains the error
+        def error(string)
+        end
+
+        ###
+        # Called when cdata blocks are found
+        # +string+ contains the cdata content
+        def cdata_block(string)
+        end
+
+        ###
+        # Called when processing instructions are found
+        # +name+ is the target of the instruction
+        # +content+ is the value of the instruction
+        def processing_instruction(name, content)
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/sax/parser.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Nokogiri
+  module XML
+    module SAX
+      ###
+      # This parser is a SAX style parser that reads it's input as it
+      # deems necessary.  The parser takes a Nokogiri::XML::SAX::Document,
+      # an optional encoding, then given an XML input, sends messages to
+      # the Nokogiri::XML::SAX::Document.
+      #
+      # Here is an example of using this parser:
+      #
+      #   # Create a subclass of Nokogiri::XML::SAX::Document and implement
+      #   # the events we care about:
+      #   class MyDoc < Nokogiri::XML::SAX::Document
+      #     def start_element name, attrs = []
+      #       puts "starting: #{name}"
+      #     end
+      #
+      #     def end_element name
+      #       puts "ending: #{name}"
+      #     end
+      #   end
+      #
+      #   # Create our parser
+      #   parser = Nokogiri::XML::SAX::Parser.new(MyDoc.new)
+      #
+      #   # Send some XML to the parser
+      #   parser.parse(File.open(ARGV[0]))
+      #
+      # For more information about SAX parsers, see Nokogiri::XML::SAX.  Also
+      # see Nokogiri::XML::SAX::Document for the available events.
+      class Parser
+        class Attribute < Struct.new(:localname, :prefix, :uri, :value)
+        end
+
+        # Encodinds this parser supports
+        ENCODINGS = {
+          "NONE" => 0, # No char encoding detected
+          "UTF-8" => 1, # UTF-8
+          "UTF16LE" => 2, # UTF-16 little endian
+          "UTF16BE" => 3, # UTF-16 big endian
+          "UCS4LE" => 4, # UCS-4 little endian
+          "UCS4BE" => 5, # UCS-4 big endian
+          "EBCDIC" => 6, # EBCDIC uh!
+          "UCS4-2143" => 7, # UCS-4 unusual ordering
+          "UCS4-3412" => 8, # UCS-4 unusual ordering
+          "UCS2" => 9, # UCS-2
+          "ISO-8859-1" => 10, # ISO-8859-1 ISO Latin 1
+          "ISO-8859-2" => 11, # ISO-8859-2 ISO Latin 2
+          "ISO-8859-3" => 12, # ISO-8859-3
+          "ISO-8859-4" => 13, # ISO-8859-4
+          "ISO-8859-5" => 14, # ISO-8859-5
+          "ISO-8859-6" => 15, # ISO-8859-6
+          "ISO-8859-7" => 16, # ISO-8859-7
+          "ISO-8859-8" => 17, # ISO-8859-8
+          "ISO-8859-9" => 18, # ISO-8859-9
+          "ISO-2022-JP" => 19, # ISO-2022-JP
+          "SHIFT-JIS" => 20, # Shift_JIS
+          "EUC-JP" => 21, # EUC-JP
+          "ASCII" => 22, # pure ASCII
+        }
+
+        # The Nokogiri::XML::SAX::Document where events will be sent.
+        attr_accessor :document
+
+        # The encoding beings used for this document.
+        attr_accessor :encoding
+
+        # Create a new Parser with +doc+ and +encoding+
+        def initialize(doc = Nokogiri::XML::SAX::Document.new, encoding = "UTF-8")
+          @encoding = check_encoding(encoding)
+          @document = doc
+          @warned   = false
+        end
+
+        ###
+        # Parse given +thing+ which may be a string containing xml, or an
+        # IO object.
+        def parse(thing, &block)
+          if thing.respond_to?(:read) && thing.respond_to?(:close)
+            parse_io(thing, &block)
+          else
+            parse_memory(thing, &block)
+          end
+        end
+
+        ###
+        # Parse given +io+
+        def parse_io(io, encoding = @encoding)
+          ctx = ParserContext.io(io, ENCODINGS[check_encoding(encoding)])
+          yield ctx if block_given?
+          ctx.parse_with(self)
+        end
+
+        ###
+        # Parse a file with +filename+
+        def parse_file(filename)
+          raise ArgumentError unless filename
+          raise Errno::ENOENT unless File.exist?(filename)
+          raise Errno::EISDIR if File.directory?(filename)
+
+          ctx = ParserContext.file(filename)
+          yield ctx if block_given?
+          ctx.parse_with(self)
+        end
+
+        def parse_memory(data)
+          ctx = ParserContext.memory(data)
+          yield ctx if block_given?
+          ctx.parse_with(self)
+        end
+
+        private
+
+        def check_encoding(encoding)
+          encoding.upcase.tap do |enc|
+            raise ArgumentError, "'#{enc}' is not a valid encoding" unless ENCODINGS[enc]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/sax/parser_context.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Nokogiri
+  module XML
+    module SAX
+      ###
+      # Context for XML SAX parsers.  This class is usually not instantiated
+      # by the user.  Instead, you should be looking at
+      # Nokogiri::XML::SAX::Parser
+      class ParserContext
+        def self.new(thing, encoding = "UTF-8")
+          if [:read, :close].all? { |x| thing.respond_to?(x) }
+            io(thing, Parser::ENCODINGS[encoding])
+          else
+            memory(thing)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/sax/push_parser.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Nokogiri
+  module XML
+    module SAX
+      ###
+      # PushParser can parse a document that is fed to it manually.  It
+      # must be given a SAX::Document object which will be called with
+      # SAX events as the document is being parsed.
+      #
+      # Calling PushParser#<< writes XML to the parser, calling any SAX
+      # callbacks it can.
+      #
+      # PushParser#finish tells the parser that the document is finished
+      # and calls the end_document SAX method.
+      #
+      # Example:
+      #
+      #   parser = PushParser.new(Class.new(XML::SAX::Document) {
+      #     def start_document
+      #       puts "start document called"
+      #     end
+      #   }.new)
+      #   parser << "<div>hello<"
+      #   parser << "/div>"
+      #   parser.finish
+      class PushParser
+        # The Nokogiri::XML::SAX::Document on which the PushParser will be
+        # operating
+        attr_accessor :document
+
+        ###
+        # Create a new PushParser with +doc+ as the SAX Document, providing
+        # an optional +file_name+ and +encoding+
+        def initialize(doc = XML::SAX::Document.new, file_name = nil, encoding = "UTF-8")
+          @document = doc
+          @encoding = encoding
+          @sax_parser = XML::SAX::Parser.new(doc)
+
+          ## Create our push parser context
+          initialize_native(@sax_parser, file_name)
+        end
+
+        ###
+        # Write a +chunk+ of XML to the PushParser.  Any callback methods
+        # that can be called will be called immediately.
+        def write(chunk, last_chunk = false)
+          native_write(chunk, last_chunk)
+        end
+        alias_method :<<, :write
+
+        ###
+        # Finish the parsing.  This method is only necessary for
+        # Nokogiri::XML::SAX::Document#end_document to be called.
+        def finish
+          write("", true)
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/sax.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "sax/document"
+require_relative "sax/parser_context"
+require_relative "sax/parser"
+require_relative "sax/push_parser"

data/lib/nokogiri/xml/schema.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Nokogiri
+  module XML
+    class << self
+      ###
+      # Create a new Nokogiri::XML::Schema object using a +string_or_io+
+      # object.
+      def Schema(string_or_io, options = ParseOptions::DEFAULT_SCHEMA)
+        Schema.new(string_or_io, options)
+      end
+    end
+
+    ###
+    # Nokogiri::XML::Schema is used for validating XML against a schema
+    # (usually from an xsd file).
+    #
+    # == Synopsis
+    #
+    # Validate an XML document against a Schema.  Loop over the errors that
+    # are returned and print them out:
+    #
+    #   xsd = Nokogiri::XML::Schema(File.read(PO_SCHEMA_FILE))
+    #   doc = Nokogiri::XML(File.read(PO_XML_FILE))
+    #
+    #   xsd.validate(doc).each do |error|
+    #     puts error.message
+    #   end
+    #
+    # The list of errors are Nokogiri::XML::SyntaxError objects.
+    #
+    # NOTE: As of v1.11.0, Schema treats inputs as UNTRUSTED by default, and so external entities
+    # are not resolved from the network (`http://` or `ftp://`). Previously, parsing treated
+    # documents as "trusted" by default which was counter to Nokogiri's "untrusted by default"
+    # security policy. If a document is trusted, then the caller may turn off the NONET option via
+    # the ParseOptions to re-enable external entity resolution over a network connection.
+    class Schema
+      # Errors while parsing the schema file
+      attr_accessor :errors
+      # The Nokogiri::XML::ParseOptions used to parse the schema
+      attr_accessor :parse_options
+
+      ###
+      # Create a new Nokogiri::XML::Schema object using a +string_or_io+
+      # object.
+      def self.new(string_or_io, options = ParseOptions::DEFAULT_SCHEMA)
+        from_document(Nokogiri::XML(string_or_io), options)
+      end
+
+      ###
+      # Validate +thing+ against this schema.  +thing+ can be a
+      # Nokogiri::XML::Document object, or a filename.  An Array of
+      # Nokogiri::XML::SyntaxError objects found while validating the
+      # +thing+ is returned.
+      def validate(thing)
+        if thing.is_a?(Nokogiri::XML::Document)
+          validate_document(thing)
+        elsif File.file?(thing)
+          validate_file(thing)
+        else
+          raise ArgumentError, "Must provide Nokogiri::Xml::Document or the name of an existing file"
+        end
+      end
+
+      ###
+      # Returns true if +thing+ is a valid Nokogiri::XML::Document or
+      # file.
+      def valid?(thing)
+        validate(thing).empty?
+      end
+    end
+  end
+end