libxml-ruby 4.1.2 → 6.0.0

data/lib/libxml/html_parser.rb

@@ -1,96 +1,80 @@
-# encoding: UTF-8
-
-module LibXML
-  module XML
-    class HTMLParser
-      # call-seq:
-      #    XML::HTMLParser.file(path) -> XML::HTMLParser
-      #    XML::HTMLParser.file(path, :encoding => XML::Encoding::UTF_8,
-      #                           :options => XML::HTMLParser::Options::NOENT) -> XML::HTMLParser
-      #
-      # Creates a new parser by parsing the specified file or uri.
-      #
-      # You may provide an optional hash table to control how the
-      # parsing is performed.  Valid options are:
-      #
-      #  encoding - The document encoding, defaults to nil. Valid values
-      #             are the encoding constants defined on XML::Encoding.
-      #  options - Parser options.  Valid values are the constants defined on
-      #            XML::HTMLParser::Options.  Mutliple options can be combined
-      #            by using Bitwise OR (|).
-      def self.file(path, options = {})
-        context = XML::HTMLParser::Context.file(path)
-        context.encoding = options[:encoding] if options[:encoding]
-        context.options = options[:options] if options[:options]
-        self.new(context)
-      end
-
-      # call-seq:
-      #    XML::HTMLParser.io(io) -> XML::HTMLParser
-      #    XML::HTMLParser.io(io, :encoding => XML::Encoding::UTF_8,
-      #                       :options => XML::HTMLParser::Options::NOENT
-      #                       :base_uri="http://libxml.org") -> XML::HTMLParser
-      #
-      # Creates a new reader by parsing the specified io object.
-      #
-      # Parameters:
-      #
-      #  io - io object that contains the xml to parser
-      #  base_uri - The base url for the parsed document.
-      #  encoding - The document encoding, defaults to nil. Valid values
-      #             are the encoding constants defined on XML::Encoding.
-      #  options - Parser options.  Valid values are the constants defined on
-      #            XML::HTMLParser::Options.  Mutliple options can be combined
-      #            by using Bitwise OR (|).
-      def self.io(io, options = {})
-        context = XML::HTMLParser::Context.io(io)
-        context.base_uri = options[:base_uri] if options[:base_uri]
-        context.encoding = options[:encoding] if options[:encoding]
-        context.options = options[:options] if options[:options]
-        self.new(context)
-      end
-
-      # call-seq:
-      #    XML::HTMLParser.string(string)
-      #    XML::HTMLParser.string(string, :encoding => XML::Encoding::UTF_8,
-      #                               :options => XML::HTMLParser::Options::NOENT
-      #                               :base_uri="http://libxml.org") -> XML::HTMLParser
-      #
-      # Creates a new parser by parsing the specified string.
-      #
-      # You may provide an optional hash table to control how the
-      # parsing is performed.  Valid options are:
-      #
-      #  base_uri - The base url for the parsed document.
-      #  encoding - The document encoding, defaults to nil. Valid values
-      #             are the encoding constants defined on XML::Encoding.
-      #  options - Parser options.  Valid values are the constants defined on
-      #            XML::HTMLParser::Options.  Mutliple options can be combined
-      #            by using Bitwise OR (|).
-      def self.string(string, options = {})
-        context = XML::HTMLParser::Context.string(string)
-        context.base_uri = options[:base_uri] if options[:base_uri]
-        context.encoding = options[:encoding] if options[:encoding]
-        context.options = options[:options] if options[:options]
-        self.new(context)
-      end
-
-      # :enddoc:
-
-      def file=(value)
-        warn("XML::HTMLParser#file is deprecated.  Use XML::HTMLParser.file instead")
-        @context = XML::HTMLParser::Context.file(value)
-      end
-
-      def io=(value)
-        warn("XML::HTMLParser#io is deprecated.  Use XML::HTMLParser.io instead")
-        @context = XML::HTMLParser::Context.io(value)
-      end
-
-      def string=(value)
-        warn("XML::HTMLParser#string is deprecated.  Use XML::HTMLParser.string instead")
-        @context = XML::HTMLParser::Context.string(value)
-      end
-    end
-  end
-end
+# encoding: UTF-8
+
+module LibXML
+  module XML
+    class HTMLParser
+      # call-seq:
+      #    XML::HTMLParser.file(path) -> XML::HTMLParser
+      #    XML::HTMLParser.file(path, encoding: XML::Encoding::UTF_8,
+      #                               options: XML::HTMLParser::Options::NOENT) -> XML::HTMLParser
+      #
+      # Creates a new parser by parsing the specified file or uri.
+      #
+      # Parameters:
+      #
+      #  path - Path to file to parse
+      #  encoding - The document encoding, defaults to nil. Valid values
+      #             are the encoding constants defined on XML::Encoding.
+      #  options - Parser options.  Valid values are the constants defined on
+      #            XML::HTMLParser::Options.  Mutliple options can be combined
+      #            by using Bitwise OR (|).
+      def self.file(path, encoding: nil, options: nil)
+        context = XML::HTMLParser::Context.file(path)
+        context.encoding = encoding if encoding
+        context.options = options if options
+        self.new(context)
+      end
+
+      # call-seq:
+      #    XML::HTMLParser.io(io) -> XML::HTMLParser
+      #    XML::HTMLParser.io(io, encoding: XML::Encoding::UTF_8,
+      #                           options: XML::HTMLParser::Options::NOENT
+      #                           base_uri: "http://libxml.org") -> XML::HTMLParser
+      #
+      # Creates a new reader by parsing the specified io object.
+      #
+      # Parameters:
+      #
+      #  io - io object that contains the xml to parser
+      #  base_uri - The base url for the parsed document.
+      #  encoding - The document encoding, defaults to nil. Valid values
+      #             are the encoding constants defined on XML::Encoding.
+      #  options - Parser options.  Valid values are the constants defined on
+      #            XML::HTMLParser::Options.  Mutliple options can be combined
+      #            by using Bitwise OR (|).
+      def self.io(io, base_uri: nil, encoding: nil, options: nil)
+        context = XML::HTMLParser::Context.io(io)
+        context.base_uri = base_uri if base_uri
+        context.encoding = encoding if encoding
+        context.options = options if options
+        self.new(context)
+      end
+
+      # call-seq:
+      #    XML::HTMLParser.string(string)
+      #    XML::HTMLParser.string(string, encoding: XML::Encoding::UTF_8,
+      #                                   options: XML::HTMLParser::Options::NOENT
+      #                                   base_uri: "http://libxml.org") -> XML::HTMLParser
+      #
+      # Creates a new parser by parsing the specified string.
+      #
+      # Parameters:
+      #
+      #  string - String to parse
+      #  base_uri - The base url for the parsed document.
+      #  encoding - The document encoding, defaults to nil. Valid values
+      #             are the encoding constants defined on XML::Encoding.
+      #  options - Parser options.  Valid values are the constants defined on
+      #            XML::HTMLParser::Options.  Mutliple options can be combined
+      #            by using Bitwise OR (|).
+      def self.string(string, base_uri: nil, encoding: nil, options: nil)
+        context = XML::HTMLParser::Context.string(string)
+        context.base_uri = base_uri if base_uri
+        context.encoding = encoding if encoding
+        context.options = options if options
+        self.new(context)
+      end
+
+    end
+  end
+end

data/lib/libxml/namespace.rb

@@ -1,62 +1,62 @@
-# encoding: UTF-8
-
-module LibXML
-  module XML
-    class Namespace
-      include Comparable
-      include Enumerable
-
-      # call-seq:
-      #   namespace1 <=> namespace2
-      #
-      # Compares two namespace objects.  Namespace objects are
-      # considered equal if their prefixes and hrefs are the same.
-      def <=>(other)
-        if self.prefix.nil? and other.prefix.nil?
-          self.href <=> other.href
-        elsif self.prefix.nil?
-          -1
-        elsif other.prefix.nil?
-          1
-        else
-          self.prefix <=> other.prefix
-        end
-      end
-
-      # call-seq:
-      #   namespace.each {|ns| .. }
-      #
-      # libxml stores namespaces in memory as a linked list.
-      # Use the each method to iterate over the list.  Note
-      # the first namespace in the loop is the current namespace.
-      #
-      # Usage:
-      #   namespace.each do |ns|
-      #     ..
-      #   end
-      def each
-        ns = self
-
-        while ns
-          yield ns
-          ns = ns.next
-        end
-      end
-
-      # call-seq:
-      #   namespace.to_s -> "string"
-      #
-      # Returns the string represenation of a namespace.
-      #
-      # Usage:
-      #   namespace.to_s
-      def to_s
-        if self.prefix
-          "#{self.prefix}:#{self.href}"
-        else
-          self.href
-        end
-      end
-    end
-  end
+# encoding: UTF-8
+
+module LibXML
+  module XML
+    class Namespace
+      include Comparable
+      include Enumerable
+
+      # call-seq:
+      #   namespace1 <=> namespace2
+      #
+      # Compares two namespace objects.  Namespace objects are
+      # considered equal if their prefixes and hrefs are the same.
+      def <=>(other)
+        if self.prefix.nil? and other.prefix.nil?
+          self.href <=> other.href
+        elsif self.prefix.nil?
+          -1
+        elsif other.prefix.nil?
+          1
+        else
+          self.prefix <=> other.prefix
+        end
+      end
+
+      # call-seq:
+      #   namespace.each {|ns| .. }
+      #
+      # libxml stores namespaces in memory as a linked list.
+      # Use the each method to iterate over the list.  Note
+      # the first namespace in the loop is the current namespace.
+      #
+      # Usage:
+      #   namespace.each do |ns|
+      #     ..
+      #   end
+      def each
+        ns = self
+
+        while ns
+          yield ns
+          ns = ns.next
+        end
+      end
+
+      # call-seq:
+      #   namespace.to_s -> "string"
+      #
+      # Returns the string represenation of a namespace.
+      #
+      # Usage:
+      #   namespace.to_s
+      def to_s
+        if self.prefix
+          "#{self.prefix}:#{self.href}"
+        else
+          self.href
+        end
+      end
+    end
+  end
 end

data/lib/libxml/namespaces.rb

@@ -1,38 +1,38 @@
-# encoding: UTF-8
-
-module LibXML
-  module XML
-    class Namespaces
-      # call-seq:
-      #   namespace.default -> XML::Namespace
-      #
-      # Returns the default namespace for this node or nil.
-      #
-      # Usage:
-      #   doc = XML::Document.string('<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"/>')
-      #   ns = doc.root.namespaces.default_namespace
-      #   assert_equal(ns.href, 'http://schemas.xmlsoap.org/soap/envelope/')
-      def default
-        find_by_prefix(nil)
-      end
-
-      # call-seq:
-      #   namespace.default_prefix = "string"
-      #
-      # Assigns a name (prefix) to the default namespace.
-      # This makes it much easier to perform XML::XPath
-      # searches.
-      #
-      # Usage:
-      #   doc = XML::Document.string('<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"/>')
-      #   doc.root.namespaces.default_prefix = 'soap'
-      #   node = doc.root.find_first('soap:Envelope')
-      def default_prefix=(prefix)
-        # Find default prefix
-        ns = find_by_prefix(nil)
-        raise(ArgumentError, "No default namespace was found") unless ns
-        Namespace.new(self.node, prefix, ns.href)
-      end
-    end
-  end
+# encoding: UTF-8
+
+module LibXML
+  module XML
+    class Namespaces
+      # call-seq:
+      #   namespace.default -> XML::Namespace
+      #
+      # Returns the default namespace for this node or nil.
+      #
+      # Usage:
+      #   doc = XML::Document.string('<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"/>')
+      #   ns = doc.root.namespaces.default_namespace
+      #   assert_equal(ns.href, 'http://schemas.xmlsoap.org/soap/envelope/')
+      def default
+        find_by_prefix(nil)
+      end
+
+      # call-seq:
+      #   namespace.default_prefix = "string"
+      #
+      # Assigns a name (prefix) to the default namespace.
+      # This makes it much easier to perform XML::XPath
+      # searches.
+      #
+      # Usage:
+      #   doc = XML::Document.string('<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"/>')
+      #   doc.root.namespaces.default_prefix = 'soap'
+      #   node = doc.root.find_first('soap:Envelope')
+      def default_prefix=(prefix)
+        # Find default prefix
+        ns = find_by_prefix(nil)
+        raise(ArgumentError, "No default namespace was found") unless ns
+        Namespace.new(self.node, prefix, ns.href)
+      end
+    end
+  end
 end