libxml-ruby 0.9.7 → 0.9.8

data/lib/libxml/attr_decl.rb

@@ -0,0 +1,81 @@
+# $Id: libxml.rb 374 2008-07-11 04:51:41Z cfis $ 
+# Please see the LICENSE file for copyright and distribution information 
+
+module LibXML
+  module XML
+    class AttrDecl
+      include Enumerable
+
+      # call-seq:
+      #   attr_decl.child -> nil
+      #
+      # Obtain this attribute declaration's child attribute(s).
+      # It will always be nil.
+      def child
+        nil
+      end
+
+      # call-seq:
+      #    attr_decl.child? -> (true|false)
+      #
+      # Returns whether this attribute declaration has child attributes.
+      #
+      def child?
+        not self.children.nil?
+      end
+
+      # call-seq:
+      #    attr_decl.doc? -> (true|false)
+      #
+      # Determine whether this attribute declaration is associated with an
+      # XML::Document.
+      def doc?
+        not self.doc.nil?
+      end
+
+      # call-seq:
+      #    attr_decl.next? -> (true|false)
+      #
+      # Determine whether there is a next attribute declaration.
+      def next?
+        not self.next.nil?
+      end
+
+      # call-seq:
+      #    attr_decl.parent? -> (true|false)
+      #
+      # Determine whether this attribute declaration has a parent .
+      def parent?
+        not self.parent.nil?
+      end
+
+      # call-seq:
+      #    attr_decl.prev? -> (true|false)
+      #
+      # Determine whether there is a previous attribute declaration.
+      def prev?
+        not self.prev.nil?
+      end
+
+      # call-seq:
+      #    attr_decl.node_type_name -> 'attribute declaration'
+      #
+      # Returns this attribute declaration's node type name.
+      def node_type_name
+        if node_type == Node::ATTRIBUTE_DECL
+          'attribute declaration'
+        else
+          raise(UnknownType, "Unknown node type: %n", node.node_type);
+        end
+      end
+
+      # call-seq:
+      #    attr_decl.to_s -> string
+      #
+      # Returns a string representation of this attribute declaration.
+      def to_s
+        "#{name} = #{value}"
+      end
+    end
+  end
+end

data/lib/libxml/document.rb

@@ -1,20 +1,77 @@
 module LibXML
   module XML
     class Document
-      def self.file(value)
-        Parser.file(value).parse
+      # call-seq:
+      #    XML::Document.document(document) -> XML::Document
+      #
+      # Creates a new document based on the specified document.
+      #
+      # Parameters:
+      #
+      #  document - A preparsed document.
+      def self.document(value)
+        Parser.document(value).parse
       end
 
-      def self.string(value)
-        Parser.string(value).parse
+      # call-seq:
+      #    XML::Document.file(path) -> XML::Document
+      #    XML::Document.file(path, :encoding => XML::Encoding::UTF_8,
+      #                             :options => XML::Parser::Options::NOENT) -> XML::Document
+      #
+      # Creates a new document from 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::Parser::Options.  Mutliple options can be combined
+      #            by using Bitwise OR (|).
+      def self.file(value, options = {})
+        Parser.file(value, options).parse
       end
 
-      def self.document(value)
-        Parser.document(value).parse
+      # call-seq:
+      #    XML::Document.io(io) -> XML::Document
+      #    XML::Document.io(io, :encoding => XML::Encoding::UTF_8,
+      #                         :options => XML::Parser::Options::NOENT
+      #                         :base_uri="http://libxml.org") -> XML::Document
+      #
+      # Creates a new document from 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::Parser::Options.  Mutliple options can be combined
+      #            by using Bitwise OR (|).
+      def self.io(value, options = {})
+        Parser.io(value, options).parse
       end
 
-      def self.io(value)
-        Parser.io(value).parse
+      # call-seq:
+      #    XML::Document.string(string)
+      #    XML::Document.string(string, :encoding => XML::Encoding::UTF_8,
+      #                               :options => XML::Parser::Options::NOENT
+      #                               :base_uri="http://libxml.org") -> XML::Document
+      #
+      # Creates a new document from 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::Parser::Options.  Mutliple options can be combined
+      #            by using Bitwise OR (|).
+      def self.string(value, options = {})
+        Parser.string(value, options).parse
       end
 
       # Returns a new XML::XPathContext for the document.
@@ -70,31 +127,38 @@ module LibXML
       def find_first(xpath, nslist = nil)
         find(xpath, nslist).first
       end
-      
-      def dump # :nodoc:
+
+      # :enddoc:
+
+      def dump
         warn('Document#dump is deprecated.  Use Document#to_s instead.')
         self.to_s
       end
 
-      def format_dump # :nodoc:
+      def format_dump
         warn('Document#format_dump is deprecated.  Use Document#to_s instead.')
         self.to_s
       end
 
-      def debug_dump # :nodoc:
+      def debug_dump
         warn('Document#debug_dump is deprecated.  Use Document#debug instead.')
         self.debug
       end
 
-      def debug_dump_head # :nodoc:
+      def debug_dump_head
         warn('Document#debug_dump_head is deprecated.  Use Document#debug instead.')
         self.debug
       end
 
-      def debug_format_dump  # :nodoc:
+      def debug_format_dump
         warn('Document#debug_format_dump is deprecated.  Use Document#to_s instead.')
         self.to_s
       end
+
+      def reader
+        warn('Document#reader is deprecated.  Use XML::Reader.document(self) instead.')
+        XML::Reader.document(self)
+      end
     end
   end
 end  

data/lib/libxml/html_parser.rb

@@ -1,61 +1,94 @@
 module LibXML
   module XML
     class HTMLParser
-      def self.file(value)
-        parser = self.new
-        parser.input.file = value
-        parser
+      # 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
 
-      def self.string(value)
-        parser = self.new
-        parser.input.string = value
-        parser
+      # 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
 
-      def self.document(value)
-        parser = self.new
-        parser.input.document = value
-        parser
+      # 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
 
-      def self.io(value)
-        parser = self.new
-        parser.input.io = value
-        parser
-      end
-
-      def file
-        input.file
-      end
+      # :enddoc:
 
       def file=(value)
-        input.file = value
+        warn("XML::HTMLParser#file is deprecated.  Use XML::HTMLParser.file instead")
+        @context = XML::HTMLParser::Context.file(value)
       end
 
-      def string
-        input.string
+      def io=(value)
+        warn("XML::HTMLParser#io is deprecated.  Use XML::HTMLParser.io instead")
+        @context = XML::HTMLParser::Context.io(value)
       end
 
       def string=(value)
-        input.string = value
-      end
-
-      def document
-        input.document
-      end
-
-      def document=(value)
-        input.document = value
-      end
-
-      def io
-        input.io
-      end
-
-      def io=(value)
-        input.io = value
+        warn("XML::HTMLParser#string is deprecated.  Use XML::HTMLParser.string instead")
+        @context = XML::HTMLParser::Context.string(value)
       end
     end
   end
-end
+end

data/lib/libxml/node.rb

@@ -329,6 +329,16 @@ module LibXML
         !self.namespaces.definitions.nil?
       end
 
+      def base
+        warn('Node#base is deprecated.  Use Node#base_uri.')
+        self.base_uri
+      end
+
+      def base=(value)
+        warn('Node#base= is deprecated.  Use Node#base_uri=.')
+        self.base_uri = value
+      end
+
       def search_ns(prefix)
         warn('Node#search_ns is deprecated.  Use Node#namespaces.find_by_prefix instead.')
         self.namespaces.find_by_prefix(prefix)
@@ -338,6 +348,7 @@ module LibXML
         warn('Node#search_href is deprecated.  Use Node#namespaces.find_by_href instead.')
         self.namespaces.find_by_href(href)
       end
+
       # :startdoc:
     end
   end

data/lib/libxml/parser.rb

@@ -1,33 +1,89 @@
 module LibXML
   module XML
     class Parser
-      def self.filename(value)
-        warn("Parser.filename is deprecated.  Use Parser.file instead")
-        self.file(value)
-      end
-
-      def self.file(value)
-        parser = self.new
-        parser.input.file = value
-        parser
-      end
-
-      def self.string(value)
-        parser = self.new
-        parser.input.string = value
-        parser
-      end
-
-      def self.document(value)
-        parser = self.new
-        parser.input.document = value
-        parser
-      end
-
-      def self.io(value)
-        parser = self.new
-        parser.input.io = value
-        parser
+      # call-seq:
+      #    XML::Parser.document(document) -> XML::Parser
+      #
+      # Creates a new parser for the specified document.
+      #
+      # Parameters:
+      #
+      #  document - A preparsed document.
+      def self.document(doc)
+        context = XML::Parser::Context.document(doc)
+        self.new(context)
+      end
+
+      # call-seq:
+      #    XML::Parser.file(path) -> XML::Parser
+      #    XML::Parser.file(path, :encoding => XML::Encoding::UTF_8,
+      #                           :options => XML::Parser::Options::NOENT) -> XML::Parser
+      #
+      # Creates a new parser for 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::Parser::Options.  Mutliple options can be combined
+      #            by using Bitwise OR (|).
+      def self.file(path, options = {})
+        context = XML::Parser::Context.file(path)
+        context.encoding = options[:encoding] if options[:encoding]
+        context.options = options[:options] if options[:options]
+        self.new(context)
+      end
+
+      # call-seq:
+      #    XML::Parser.io(io) -> XML::Parser
+      #    XML::Parser.io(io, :encoding => XML::Encoding::UTF_8,
+      #                       :options => XML::Parser::Options::NOENT
+      #                       :base_uri="http://libxml.org") -> XML::Parser
+      #
+      # Creates a new parser for 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::Parser::Options.  Mutliple options can be combined
+      #            by using Bitwise OR (|).
+      def self.io(io, options = {})
+        context = XML::Parser::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::Parser.string(string)
+      #    XML::Parser.string(string, :encoding => XML::Encoding::UTF_8,
+      #                               :options => XML::Parser::Options::NOENT
+      #                               :base_uri="http://libxml.org") -> XML::Parser
+      #
+      # 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::Parser::Options.  Mutliple options can be combined
+      #            by using Bitwise OR (|).
+      def self.string(string, options = {})
+        context = XML::Parser::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
 
       def self.register_error_handler(proc)
@@ -39,53 +95,36 @@ module LibXML
         end
       end
 
-      def filename
-        warn("Parser#filename is deprecated.  Use Parser#file instead")
-        self.file
-      end
+      # :enddoc:
 
-      def filename=(value)
-        warn("Parser#filename is deprecated.  Use Parser#file instead")
-        self.file = value
-      end
+      # Bunch of deprecated methods that have moved to the XML module
+      VERSION = XML::VERSION
+      VERNUM = XML::VERNUM
 
-      def file
-        input.file
+      def document=(value)
+        warn("XML::Parser#document= is deprecated.  Use XML::Parser.document= instead")
+        @context = XML::Parser::Context.document(value)
       end
 
       def file=(value)
-        input.file = value
-      end
-
-      def string
-        input.string
+        warn("XML::Parser#file is deprecated.  Use XML::Parser.file instead")
+        @context = XML::Parser::Context.file(value)
       end
 
-      def string=(value)
-        input.string = value
-      end
-
-      def document
-        input.document
-      end
-
-      def document=(value)
-        input.document = value
-      end
-
-      def io
-        input.io
+      def filename=(value)
+        warn("XML::Parser#filename is deprecated.  Use XML::Parser.file instead")
+        self.file = value
       end
 
       def io=(value)
-        input.io = value
+        warn("XML::Parser#io is deprecated.  Use XML::Parser.io instead")
+        @context = XML::Parser::Context.io(value)
       end
 
-      # :enddoc:
-
-      # Bunch of deprecated methods that have moved to the XML module
-      VERSION = XML::VERSION
-      VERNUM = XML::VERNUM
+      def string=(value)
+        warn("XML::Parser#string is deprecated.  Use XML::Parser.string instead")
+        @context = XML::Parser::Context.string(value)
+      end
 
       def self.enabled_automata?
         warn("XML::Parser.enabled_automata? has been deprecated.  Use XML.enabled_automata? instead")
@@ -307,6 +346,11 @@ module LibXML
         XML.indent_tree_output= value
       end
 
+      def self.filename(value)
+        warn("Parser.filename is deprecated.  Use Parser.file instead")
+        self.file(value)
+      end
+
       def self.memory_dump
         warn("XML::Parser.memory_dump has been deprecated.  Use XML.memory_dump instead")
         XML.memory_dump