libxml-ruby 0.6.0 → 0.7.0

data/CHANGES

@@ -1,5 +1,47 @@
 (See log/ChangeLog for more detailed changes derived directly from source control.)
 
+== 0.7.0 / 2008-07-09 Charlie Savage
+
+* Added new attributes class to provide a more natural way of working with attributes
+
+* Fixed XML::Attr to better support namespaces
+
+* Added documentation on how to use namespaces with XPath
+
+* Removed allocation of extraneous structures used to wrap nodes, namespaces and attributes
+
+* Cleaned up tests and added new test suite
+
+* Updated rdocs
+
+* Cleaned out most of the bug list
+
+
+== 0.6.0 / 2008-07-01 Charlie Savage
+
+* Fixed memory allocation errors in Windows.  On Windows, it is essential that the same library that allocates memory must free it. Thus ALLOC calls must be matched to ruby_xfree calls, which they were not.  In addition, in one case Ruby was allocating memory to be freed by libxml.  On Windows, that's a segmentation fault.  On Linux it might fly, but still seems like a bad idea.
+
+* Fixed segmentation fault in xml reader expand (same xml tree freed twice)
+
+* Applied a number of patches from Tom Bagby, including fixes for xpath segmentation faults and fixes for various memory leaks
+
+* Cleaned up a number of compiler warnings
+
+* Renamed libxml_so.so to libxml_ruby.so (same for xslt).  That wasn't actually my original intention, but um, it kind of sort of happened.  It should not be noticeable from an end-user perspective.
+
+* Added rake files for building with MingW
+
+* Added rake files for packing gems.  Note that I did this outside the existing rake tasks because I didn't see how they were actually building the gems.
+
+* Cleaned up the tests and added a few more based on bug reports from the Tracker and mailing list.
+
+* Cleaned out the patch queue and went through about 1/2 the bug list
+
+
+=== 2007-11-16 "Dan Janowski" <danj at 3skel.com>
+
+* Merged Dan's MEM2 branch to trunk.
+
 == 0.5.3 /
 
 === 2007-11-16 "Dan Janowski" <danj at 3skel.com>

data/README

@@ -1,144 +1,150 @@
-== INSTALLATION
-
-Installation is simple.  Follow the following steps:
-
-=== Rubygems
+= libxml-ruby
 
-  gem install libxml-ruby
-	
-=== Tarball/zip	
+== Overview
 
-  $ rake test
-  $ rake install
+The libxml gem provides Ruby language bindings for GNOME's Libxml2
+XML toolkit. It is free software, released under the MIT License.
 
-If extconf yacks up an error, follow the instructions it provides.
-You will need to chdir to ext/xml and run 'ruby extconf.rb' to provide
-options, after which you can either use Rake for everything or 
-do with make (make && make install).
+libxml-ruby provides several advantages over REXML:
 
-Once installed, look at the test scripts (tests/*.rb), and run 
-'rake doc' to generate API documentation.
-You can find the latest documentation at:
+* Speed - libxml is many times faster than REXML
+* Features - libxml provides a number of additional features over REXML, including XML Schema Validation, RelaxNg validation, xslt (see libxslt-ruby)
+* Correctness - libxml passes all 1800+ tests from the OASIS XML Tests Suite 
 
-* http://libxml.rubyforge.org/doc
 
-== DEPENDENCIES
+== Requirements
 
-libxml requires a few other libraries to be installed inorder to
-function properly.
+libxml-ruby requires Ruby 1.8.4 or higher.  It is dependent on 
+the following libraries to function properly:
 
 * libm      (math routines: very standard)
 * libz      (zlib)
 * libiconv
 * libxml2
 
-== USAGE
+If you are running Linux or Unix you'll need a C compiler so the extension
+can be compiled when it is installed.  If you are running Windows, then install the Windows specific RubyGem which
+includes an already built extension.
 
-Basic usage for reading and writing documents.
 
-=== WRITING
+== INSTALLATION
 
-Writing a simple document:
-
-  # require 'rubygems' # if installed via Gems
-	require 'xml/libxml'
-	
-	doc = XML::Document.new()
-	doc.root = XML::Node.new('root_node')
-	root = doc.root
-	
-	root << elem1 = XML::Node.new('elem1')
-	elem1['attr1'] = 'val1'
-	elem1['attr2'] = 'val2'
-	
-	root << elem2 = XML::Node.new('elem2')
-	elem2['attr1'] = 'val1'
-	elem2['attr2'] = 'val2'
-	
-	root << elem3 = XML::Node.new('elem3')
-	elem3 << elem4 = XML::Node.new('elem4')
-	elem3 << elem5 = XML::Node.new('elem5')
-	
-	elem5 << elem6 = XML::Node.new('elem6')
-	elem6 << 'Content for element 6'
-	
-	elem3['attr'] = 'baz'
-	
-	# Namespace hack to reduce the numer of times XML:: is typed
-	include XML
-	root << elem7 = Node.new('foo')
-	1.upto(10) do |i|
-	  elem7 << n = Node.new('bar')
-	  n << i
-	end
-	
-	format = true
-	doc.save('output.xml', format)
+The easiest way to install ruby-prof is by using Ruby Gems.  To install:
+
+<tt>gem install libxml-ruby</tt>
+
+If you are running Windows, make sure to install the Win32 RubyGem which 
+includes an already built binary file.  The binary is built against
+libxml2 version 2.6.32 and iconv version 1.12.  Both of these are also 
+included as pre-built binaries, and should be put either in the 
+libxml/lib directory or on the Windows path.
+
+The Windows binaries are biult with MingW.  The gem also includes 
+a Microsoft VC++ 2005 solution.  If you wish to run a debug version
+of libxml-ruby on Windows, then it is highly recommended
+you use VC++.
 
-The file output.xml contains:
 
-	<?xml version="1.0"?>
-	<root_node>
-	  <elem1 attr1="val1" attr2="val2"/>
-	  <elem2 attr1="val1" attr2="val2"/>
-	  <elem3 attr="baz">
-	    <elem4/>
-	    <elem5>
-	      <elem6>Content for element 6</elem6>
-	    </elem5>
-	  </elem3>
-	  <foo>
-	    <bar>1</bar>
-	    <bar>2</bar>
-	    <bar>3</bar>
-	    <bar>4</bar>
-	    <bar>5</bar>
-	    <bar>6</bar>
-	    <bar>7</bar>
-	    <bar>8</bar>
-	    <bar>9</bar>
-	    <bar>10</bar>
-	  </foo>
-	</root_node>
+== USAGE
+
+Basic usage for reading and writing documents.
 
 === READING
 
-Reading XML is slightly more complex and there are many more ways to
-perform this operation.  This reads in and processes the above
-generated XML document, output.xml. This script assumes that the
-structure of the document is already known.
-
-  # require 'rubygems' # if installed via Gems
-	require 'xml/libxml'
-	doc = XML::Document.file('output.xml')
-	root = doc.root
-	
-	puts "Root element name: #{root.name}"
-	
-	elem3 = root.find('elem3').to_a.first
-	puts "Elem3: #{elem3['attr']}"
-	
-	doc.find('//root_node/foo/bar').each do |node|
-	  puts "Node path: #{node.path} \t Contents: #{node.content}"
-	end
+There are several ways to read xml documents.
+
+  require 'libxml'
+  doc = XML::Document.file('output.xml')
+  root = doc.root
+  
+  puts "Root element name: #{root.name}"
+  
+  elem3 = root.find('elem3').to_a.first
+  puts "Elem3: #{elem3['attr']}"
+  
+  doc.find('//root_node/foo/bar').each do |node|
+    puts "Node path: #{node.path} \t Contents: #{node.content}"
+  end
 
 And your terminal should look like:
 
-	Root element name: root_node
-	Elem3: baz
-	Node path: /root_node/foo/bar[1]         Contents: 1
-	Node path: /root_node/foo/bar[2]         Contents: 2
-	Node path: /root_node/foo/bar[3]         Contents: 3
-	Node path: /root_node/foo/bar[4]         Contents: 4
-	Node path: /root_node/foo/bar[5]         Contents: 5
-	Node path: /root_node/foo/bar[6]         Contents: 6
-	Node path: /root_node/foo/bar[7]         Contents: 7
-	Node path: /root_node/foo/bar[8]         Contents: 8
-	Node path: /root_node/foo/bar[9]         Contents: 9
-	Node path: /root_node/foo/bar[10]        Contents: 10
+  Root element name: root_node
+  Elem3: baz
+  Node path: /root_node/foo/bar[1]         Contents: 1
+  Node path: /root_node/foo/bar[2]         Contents: 2
+  Node path: /root_node/foo/bar[3]         Contents: 3
+  Node path: /root_node/foo/bar[4]         Contents: 4
+  Node path: /root_node/foo/bar[5]         Contents: 5
+  Node path: /root_node/foo/bar[6]         Contents: 6
+  Node path: /root_node/foo/bar[7]         Contents: 7
+  Node path: /root_node/foo/bar[8]         Contents: 8
+  Node path: /root_node/foo/bar[9]         Contents: 9
+  Node path: /root_node/foo/bar[10]        Contents: 10
 
-== MORE INFORMATION
 
-If you have any questions, please send email to libxml-devel@rubyforge.org.
+=== WRITING
+
+To write a simple document:
+
+  require 'libxml'
+  
+  doc = XML::Document.new()
+  doc.root = XML::Node.new('root_node')
+  root = doc.root
+  
+  root << elem1 = XML::Node.new('elem1')
+  elem1['attr1'] = 'val1'
+  elem1['attr2'] = 'val2'
+  
+  root << elem2 = XML::Node.new('elem2')
+  elem2['attr1'] = 'val1'
+  elem2['attr2'] = 'val2'
+  
+  root << elem3 = XML::Node.new('elem3')
+  elem3 << elem4 = XML::Node.new('elem4')
+  elem3 << elem5 = XML::Node.new('elem5')
+  
+  elem5 << elem6 = XML::Node.new('elem6')
+  elem6 << 'Content for element 6'
+  
+  elem3['attr'] = 'baz'
+  
+  format = true
+  doc.save('output.xml', format)
+
+The file output.xml contains:
+
+  <?xml version="1.0"?>
+  <root_node>
+    <elem1 attr1="val1" attr2="val2"/>
+    <elem2 attr1="val1" attr2="val2"/>
+    <elem3 attr="baz">
+      <elem4/>
+      <elem5>
+        <elem6>Content for element 6</elem6>
+      </elem5>
+    </elem3>
+    <foo>
+      <bar>1</bar>
+      <bar>2</bar>
+      <bar>3</bar>
+      <bar>4</bar>
+      <bar>5</bar>
+      <bar>6</bar>
+      <bar>7</bar>
+      <bar>8</bar>
+      <bar>9</bar>
+      <bar>10</bar>
+    </foo>
+  </root_node>
+
+
+
+== License
+
+See LICENSE for license information.
+
+== MORE INFORMATION
 
-# $Id: README 143 2007-08-29 21:45:48Z transami $
+For more information please refer to the documentation.  If you have any
+questions, please send email to libxml-devel@rubyforge.org.

data/doc/classes/XML.html

@@ -0,0 +1,226 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: XML</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">XML</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/ext/libxml/libxml_c.html">
+                ext/libxml/libxml.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_attr_c.html">
+                ext/libxml/ruby_xml_attr.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_attributes_c.html">
+                ext/libxml/ruby_xml_attributes.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_document_c.html">
+                ext/libxml/ruby_xml_document.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_dtd_c.html">
+                ext/libxml/ruby_xml_dtd.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_html_parser_c.html">
+                ext/libxml/ruby_xml_html_parser.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_input_cbg_c.html">
+                ext/libxml/ruby_xml_input_cbg.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_node_c.html">
+                ext/libxml/ruby_xml_node.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_node_set_c.html">
+                ext/libxml/ruby_xml_node_set.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_ns_c.html">
+                ext/libxml/ruby_xml_ns.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_parser_c.html">
+                ext/libxml/ruby_xml_parser.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_parser_context_c.html">
+                ext/libxml/ruby_xml_parser_context.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_reader_c.html">
+                ext/libxml/ruby_xml_reader.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_sax_parser_c.html">
+                ext/libxml/ruby_xml_sax_parser.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_state_c.html">
+                ext/libxml/ruby_xml_state.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_tree_c.html">
+                ext/libxml/ruby_xml_tree.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_xinclude_c.html">
+                ext/libxml/ruby_xml_xinclude.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_xpath_c.html">
+                ext/libxml/ruby_xml_xpath.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_xpath_context_c.html">
+                ext/libxml/ruby_xml_xpath_context.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_xpath_object_c.html">
+                ext/libxml/ruby_xml_xpath_object.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_xpointer_c.html">
+                ext/libxml/ruby_xml_xpointer.c
+                </a>
+        <br />
+                <a href="../files/ext/libxml/ruby_xml_xpointer_context_c.html">
+                ext/libxml/ruby_xml_xpointer_context.c
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="XML/SiblingEnum.html" class="link">XML::SiblingEnum</a><br />
+Module <a href="XML/XMLParserOptions.html" class="link">XML::XMLParserOptions</a><br />
+Class <a href="XML/Attr.html" class="link">XML::Attr</a><br />
+Class <a href="XML/Attributes.html" class="link">XML::Attributes</a><br />
+Class <a href="XML/Document.html" class="link">XML::Document</a><br />
+Class <a href="XML/Dtd.html" class="link">XML::Dtd</a><br />
+Class <a href="XML/Error.html" class="link">XML::Error</a><br />
+Class <a href="XML/HTMLParser.html" class="link">XML::HTMLParser</a><br />
+Class <a href="XML/InputCallbacks.html" class="link">XML::InputCallbacks</a><br />
+Class <a href="XML/NS.html" class="link">XML::NS</a><br />
+Class <a href="XML/Node.html" class="link">XML::Node</a><br />
+Class <a href="XML/Parser.html" class="link">XML::Parser</a><br />
+Class <a href="XML/Reader.html" class="link">XML::Reader</a><br />
+Class <a href="XML/SaxParser.html" class="link">XML::SaxParser</a><br />
+Class <a href="XML/State.html" class="link">XML::State</a><br />
+Class <a href="XML/Tree.html" class="link">XML::Tree</a><br />
+Class <a href="XML/XInclude.html" class="link">XML::XInclude</a><br />
+Class <a href="XML/XPath.html" class="link">XML::XPath</a><br />
+Class <a href="XML/XPointer.html" class="link">XML::XPointer</a><br />
+
+    </div>
+
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">XML_NAMESPACE</td>
+          <td>=</td>
+          <td class="context-item-value">rb_str_new2((const char*)XML_XML_NAMESPACE)</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>