libxml-ruby 0.9.5 → 0.9.6

data/lib/libxml/hpricot.rb

@@ -1,76 +1,76 @@
-# Provide hpricot API for libxml.  Provided by Michael Guterl,
-# inspired by http://thebogles.com/blog/an-hpricot-style-interface-to-libxml
-
-class String
-  def to_libxml_doc
-    xp = XML::Parser.new
-    xp.string = self
-    xp.parse
-  end
-end
-
-module LibXML
-  module XML
-    class Document
-      alias :search :find
-    end
-    
-    class Node
-      # find the child node with the given xpath
-      def at(xpath)
-        self.find_first(xpath)
-      end
-
-      # find the array of child nodes matching the given xpath
-      def search(xpath)
-        results = self.find(xpath).to_a
-        if block_given?
-          results.each do |result|
-            yield result
-          end
-        end
-        return results
-      end
-
-      def /(xpath)
-        search(xpath)
-      end
-
-      # return the inner contents of this node as a string
-      def inner_xml
-        child.to_s
-      end
-
-      # alias for inner_xml
-      def inner_html
-        inner_xml
-      end
-
-      # return this node and its contents as an xml string
-      def to_xml
-        self.to_s
-      end
-
-      # alias for path
-      def xpath
-        self.path
-      end
-
-      def find_with_default_ns(xpath_expr, namespace=nil)
-        find_base(xpath_expr, namespace || default_namespaces)
-      end
-
-      def find_first_with_default_ns(xpath_expr, namespace=nil)
-        find_first_base(xpath_expr, namespace || default_namespaces)
-      end
-
-#      alias_method :find_base, :find unless method_defined?(:find_base)
-#      alias_method :find, :find_with_default_ns
-#      alias_method :find_first_base, :find_first unless method_defined?(:find_first_base)
-#      alias_method :find_first, :find_first_with_default_ns
-#      alias :child? :first?
-#      alias :children? :first?
-#      alias :child :first
-    end
-  end
-end
+## Provide hpricot API for libxml.  Provided by Michael Guterl,
+## inspired by http://thebogles.com/blog/an-hpricot-style-interface-to-libxml
+#
+#class String
+#  def to_libxml_doc
+#    xp = XML::Parser.new
+#    xp.string = self
+#    xp.parse
+#  end
+#end
+#
+#module LibXML
+#  module XML
+#    class Document
+#      alias :search :find
+#    end
+#
+#    class Node
+#      # find the child node with the given xpath
+#      def at(xpath)
+#        self.find_first(xpath)
+#      end
+#
+#      # find the array of child nodes matching the given xpath
+#      def search(xpath)
+#        results = self.find(xpath).to_a
+#        if block_given?
+#          results.each do |result|
+#            yield result
+#          end
+#        end
+#        return results
+#      end
+#
+#      def /(xpath)
+#        search(xpath)
+#      end
+#
+#      # return the inner contents of this node as a string
+#      def inner_xml
+#        child.to_s
+#      end
+#
+#      # alias for inner_xml
+#      def inner_html
+#        inner_xml
+#      end
+#
+#      # return this node and its contents as an xml string
+#      def to_xml
+#        self.to_s
+#      end
+#
+#      # alias for path
+#      def xpath
+#        self.path
+#      end
+#
+#      def find_with_default_ns(xpath_expr, namespace=nil)
+#        find_base(xpath_expr, namespace || default_namespaces)
+#      end
+#
+#      def find_first_with_default_ns(xpath_expr, namespace=nil)
+#        find_first_base(xpath_expr, namespace || default_namespaces)
+#      end
+#
+##      alias_method :find_base, :find unless method_defined?(:find_base)
+##      alias_method :find, :find_with_default_ns
+##      alias_method :find_first_base, :find_first unless method_defined?(:find_first_base)
+##      alias_method :find_first, :find_first_with_default_ns
+##      alias :child? :first?
+##      alias :children? :first?
+##      alias :child :first
+#    end
+#  end
+#end

data/lib/libxml/namespace.rb

@@ -0,0 +1,60 @@
+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

@@ -0,0 +1,36 @@
+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

data/lib/libxml/node.rb

@@ -1,20 +1,6 @@
 module LibXML
   module XML
     class Node
-      # Register the prefix (i.e., name) of the default namespace to
-      # make xpath searches easier
-      def register_default_namespace(prefix)
-        ns = self.namespace.find do |ns|
-          ns.prefix.nil?
-        end
-
-        if ns
-          NS.new(self, ns.href, prefix)
-        else
-          raise(ArgumentError, "No default namespace was found")
-        end
-      end
-
       # Determines whether this node has attributes
       def attributes?
         attributes.length > 0
@@ -26,37 +12,66 @@ module LibXML
         copy(false)
       end
       
+      # :call-seq:
+      #   node.dup -> XML::Node
+      #
       # Create a shallow copy of the node.  To create
       # a deep copy call Node#copy(true)
       def dup
         copy(false)
       end
     
-      # Return nodes matching the specified xpath expression.
-      # For more information, please refer to the documentation
-      # for XML::Document#find.
-      def find(xpath, nslist = nil)
+      # call-seq:
+      #   node.context(namespaces=nil) -> XPath::Context
+      #
+      # Returns a new XML::XPathContext for the current node.
+      #
+      # Namespaces is an optional array of XML::NS objects
+      def context(nslist = nil)
         if not self.doc
-          raise(TypeError, "A node must belong to a document before " +
-                           "it can be searched with XPath.")
+          raise(TypeError, "A node must belong to a document before a xpath context can be created")
         end
-      
+
         context = XPath::Context.new(self)
-        context.node = self  
+        context.node = self
         context.register_namespaces_from_node(self)
         context.register_namespaces_from_node(self.doc.root)
         context.register_namespaces(nslist) if nslist
+        context
+      end
 
-        context.find(xpath)
+      # call-seq:
+      #   node.find(namespaces=nil) -> XPath::XPathObject
+      #
+      # Return nodes matching the specified xpath expression.
+      # For more information, please refer to the documentation
+      # for XML::Document#find.
+      #
+      # Namespaces is an optional array of XML::NS objects
+      def find(xpath, nslist = nil)
+        self.context(nslist).find(xpath)
       end
     
+      # call-seq:
+      #   node.find_first(namespaces=nil) -> XML::Node
+      #
       # Return the first node matching the specified xpath expression.
       # For more information, please refer to the documentation
-      # for XML::Node#find.
+      # for the #find method.
       def find_first(xpath, nslist = nil)
         find(xpath, nslist).first
       end
-    
+
+      # call-seq:
+      #   node.namespacess -> XML::Namespaces
+      #   
+      # Returns this node's XML::Namespaces object,
+      # which is used to access the namespaces
+      # associated with this node.
+      def namespaces
+        @namespaces ||= XML::Namespaces.new(self)
+      end
+      
       # -------  Traversal  ----------------
       # Iterates over this node's attributes.
       #
@@ -270,6 +285,55 @@ module LibXML
       alias :children? :first?  
       alias :child :first
       alias :each_child :each
+
+      # --- Deprecated Output ---
+      # :stopdoc:
+      def dump
+        warn('Node#dump is deprecated.  Use Node#to_s instead.')
+        self.to_s
+      end
+
+      # --- Deprecated Namespaces ---
+      def namespace
+        warn('Node#namespace is deprecated.  Use Node#namespaces.namespace instead.')
+        self.namespaces.namespace
+      end
+
+      def namespace=(value)
+        warn('Node#namespace= is deprecated.  Use Node#namespaces.namespace= instead.')
+        self.namespaces.namespace = value
+      end
+
+      def ns
+        warn('Node#ns is deprecated.  Use Node#namespaces.namespace instead.')
+        self.namespaces.namespace
+      end
+
+      def ns?
+        warn('Node#ns? is deprecated.  Use !Node#namespaces.namespace.nil? instead.')
+        !self.namespaces.namespace.nil?
+      end
+
+      def ns_def
+        warn('Node#ns_def is deprecated.  Use Node#namespaces.definitions instead.')
+        self.namespaces.definitions
+      end
+
+      def ns_def?
+        warn('Node#ns_def? is deprecated.  Use !Node#namespaces.definitions.nil? instead.')
+        !self.namespaces.definitions.nil?
+      end
+
+      def search_ns(prefix)
+        warn('Node#search_ns is deprecated.  Use Node#namespaces.find_by_prefix instead.')
+        self.namespaces.find_by_prefix(prefix)
+      end
+
+      def search_href(href)
+        warn('Node#search_href is deprecated.  Use Node#namespaces.find_by_href instead.')
+        self.namespaces.find_by_href(href)
+      end
+      # :startdoc:
     end
   end
-end
+end

data/lib/libxml/ns.rb

@@ -0,0 +1,20 @@
+module LibXML
+  module XML
+    class NS < Namespace # :nodoc: 
+      def initialize(node, prefix, href)
+        warn('The XML::NS class is deprecated.  Use XML::Namespace instead.')
+        super(node, href, prefix)
+      end
+
+      def href?
+        warn('XML::NS#href? is deprecated.  Use !XML::NS#href.nil? instead.')
+        not self.href.nil?
+      end
+
+      def prefix?
+        warn('XML::NS#prefix? is deprecated.  Use !XML::NS#prefix?.nil? instead.')
+        not self.previx.nil?
+      end
+    end
+  end
+end

data/test/model/bands.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<bands genre="metal">
+  <mötley_crüe country="us">An American heavy metal band formed in Los Angeles, California in 1981.</mötley_crüe>
+  <iron_maiden country="uk">British heavy metal band formed in 1975.</iron_maiden>
+</bands>

data/test/tc_attributes.rb

@@ -59,7 +59,7 @@ class AttributesTest < Test::Unit::TestCase
 
     attr = attributes.get_attribute('href')
     assert_instance_of(XML::Attr, attr)
-    assert_instance_of(XML::NS, attr.ns)
+    assert_instance_of(XML::Namespace, attr.ns)
     assert_equal('xlink', attr.ns.prefix)
     assert_equal('http://www.w3.org/1999/xlink', attr.ns.href)
 

data/test/tc_document.rb

@@ -2,7 +2,7 @@ require "xml"
 require 'test/unit'
 
 
-class TC_XML_Document < Test::Unit::TestCase
+class TestDocument < Test::Unit::TestCase
   def setup
     xp = XML::Parser.new
     assert_instance_of(XML::Parser, xp)
@@ -16,7 +16,16 @@ class TC_XML_Document < Test::Unit::TestCase
     @doc = nil
   end
 
-  def test_libxml_document_find
+  def test_klass
+    assert_instance_of(XML::Document, @doc)
+  end
+
+  def test_context
+    context = @doc.context
+    assert_instance_of(XML::XPath::Context, context)
+  end
+
+  def test_find
     set = @doc.find('/ruby_array/fixnum')
     assert_instance_of(XML::XPath::Object, set)
     assert_raise(NoMethodError) {
@@ -49,45 +58,19 @@ class TC_XML_Document < Test::Unit::TestCase
       end
     end
   end
-  
-  def test_save
-    filename = 'test_write' 
-    bytes = @doc.save(filename)
-    assert_equal(110, bytes)
-    contents = File.read(filename)
-    
-    expected =<<-EOS
-<?xml version="1.0"?>
-<ruby_array uga="booga" foo="bar"><fixnum>one</fixnum><fixnum>two</fixnum></ruby_array>
-EOS
-    assert_equal(expected, contents)
-  ensure
-    File.delete(filename)    
+
+  def test_version
+    assert_equal('1.0', @doc.version)
+
+    doc = XML::Document.new('6.9')
+    assert_equal('6.9', doc.version)
   end
-  
-  def test_save_formatted
-    filename = 'test_write' 
-    bytes = @doc.save(filename, true)
-    assert_equal(117, bytes)
-    contents = File.read(filename)
-    
-    expected =<<-EOS
-<?xml version="1.0"?>
-<ruby_array uga="booga" foo="bar">
-  <fixnum>one</fixnum>
-  <fixnum>two</fixnum>
-</ruby_array>
-EOS
-    assert_equal(expected, contents)
-  ensure
-    File.delete(filename)    
+
+  def test_write_root
+    @doc.root = XML::Node.new('rubynet')
+    assert_instance_of(XML::Node, @doc.root)
+    assert_instance_of(XML::Document, @doc.root.doc)
+    assert_equal("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rubynet/>\n",
+                 @doc.to_s(:indent => false))
   end
-  
-  def test_save_formatted_invalid
-    filename = 'test_write' 
-    
-    assert_raise(ArgumentError) do
-      @doc.save(filename, 1)
-    end
-  end  
 end