libxml-ruby 0.3.6

data/CHANGELOG

@@ -0,0 +1,49 @@
+===== 21.2.2006 Ross Bamford <rosco@roscopeco.co.uk>
+* Patched extconf.rb with OSX -fno-common workaround
+* Added gem and packaging support to Rakefile
+* Moved version update to Rakefile
+* Removed legacy project utility scripts
+
+===== 19.2.2006 Ross Bamford <rosco@roscopeco.co.uk>
+* Fixed doublefree bug in ruby_xml_attr.
+* Fixed small leak in parser
+
+===== 18.12.2005 Ross Bamford <rosco@roscopeco.co.uk>
+* Updated for GCC 4.0 (community patches)
+* Fixed default validation bug
+* Refactored project, removed outdated files, cleaned up tests.
+* Added RDoc documentation across .c files.
+* Fixed up a few strings.
+
+===== 14.4.2004 Mangler Jurgen <et@wkv.at>
+* ruby_xml_node.cz: fixed ruby_xml_node_property_set. The ill-behaviour
+	was, that there was added a second attribute of the same
+	name, when you were setting the value of an already existing
+	attribute.
+
+===== 17.3.2004 Lukas Svoboda <luks@fi.muni.cz>
+* ruby_xml_node.c: ruby_xml_node_to_s now returns XML subtree dump.
+
+===== 27.2.2004 Martin Povolny <martin@solnet.cz>
+* ruby_xml_node.c: added XML::Node.copy, this makes possible building
+	of xml documents from nodes taken from other xml documents
+	without making ruby SIGSEGV (see tests/copy_bug.rb).
+
+===== 26.2.2004 Martin Povolny <martin@solnet.cz>
+* ruby_xml_dtd.c, ruby_xml_dtd.h, ruby_xml_schema.c, ruby_xml_schema.h:
+	more work on validation, now you can actually validate
+	document using dtd or xml schema, also solved warning and
+	error propagation (see tests/{dtd|schema}-test.rb).
+
+===== 30.12.2003 Martin Povolny <martin@solnet.cz>
+* ruby_xml_dtd.c, ruby_xml_dtd.h, ruby_xml_schema.c, ruby_xml_schema.h:
+	prelimitary support for dtd and schema validation
+
+===== 15.9.2003 Martin Povolny <martin@solnet.cz>
+* ruby_xml_input_cbg.c, libxml.c: added class InputCallbacks to make
+	possible registering custom input callbacks
+	handlers (xmlRegisterInputCallbacks) written in ruby
+
+===== 1.8.2003 Martin Povolny <martin@solnet.cz>
+* ruby_xml_document.c: corrected argument handling in ruby_xml_document_find
+* ruby_xml_node.c: corrected argument handling in ruby_xml_node_find

data/LICENSE

@@ -0,0 +1,22 @@
+# $Id: LICENSE,v 1.2 2005/12/29 19:00:01 bshow Exp $
+
+ Copyright (c) 2002-2005 Sean Chittenden <sean@chittenden.org> and contributors
+ Copyright (c) 2001 Wai-Sun "Squidster" Chia <waisun.chia@compaq.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -0,0 +1,129 @@
+== INSTALLATION
+
+Installation is simple.  Follow the following steps:
+
+	$ ruby extconf.rb
+	$ make
+	# make install
+
+If extconf yacks up an error, follow the instructions it provides.
+Once installed, look at the test scripts (*.rb, not extconf.rb) and
+make sure you run document_self.rb to see what's available.
+
+== DEPENDENCIES
+
+libxml requires a few other libraries to be installed inorder to
+function properly.
+
+* libm      (math routines: very standard)
+* libz      (zlib)
+* libiconv
+* libxml2
+
+== USAGE
+
+Basic usage for reading and writing documents.
+
+=== WRITING
+
+Writing a simple document:
+
+	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 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>
+
+=== 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 '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}"
+	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
+
+== MORE INFORMATION
+
+If you have any questions, please send email to libxml-devel@rubyforge.org.
+
+# $Id: README,v 1.2 2005/12/19 20:51:39 roscopeco Exp $

data/Rakefile

@@ -0,0 +1,197 @@
+require 'net/ftp'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+CLEAN.include '**/*.o'
+CLEAN.include '**/*.so'
+CLEAN.include 'html'
+CLOBBER.include '**/*.log'
+CLOBBER.include '**/Makefile'
+CLOBBER.include '**/extconf.h'
+
+desc "Default Task (Build release)"
+task :default => :release
+
+# Determine the current version of the software
+if File.read('ext/xml/libxml.h') =~ /\s*RUBY_LIBXML_VERSION\s*['"](\d.+)['"]/
+  CURRENT_VERSION = $1
+else
+  CURRENT_VERSION = "0.0.0"
+end
+
+if ENV['REL']
+  PKG_VERSION = ENV['REL']
+else
+  PKG_VERSION = CURRENT_VERSION
+end
+
+task :test_ver do
+  puts PKG_VERSION
+end
+
+# Make tasks -----------------------------------------------------
+MAKECMD = ENV['MAKE_CMD'] || 'make'
+MAKEOPTS = ENV['MAKE_OPTS'] || ''
+
+file 'ext/xml/Makefile' => 'ext/xml/extconf.rb' do
+  Dir.chdir('ext/xml') do
+    ruby 'extconf.rb'
+  end
+end
+
+def make(target = '')
+  Dir.chdir('ext/xml') do
+    pid = fork { exec "#{MAKECMD} #{MAKEOPTS} #{target}" }
+    Process.waitpid pid
+  end
+  $?.exitstatus
+end
+
+# Let make handle dependencies between c/o/so - we'll just run it. 
+file 'ext/xml/libxml.so' => 'ext/xml/Makefile' do
+  m = make
+  fail "Make failed (status #{m})" unless m == 0
+end
+
+desc "Compile the shared object"
+task :compile => 'ext/xml/libxml.so'
+
+desc "Install to your site_ruby directory"
+task :install => :compile do
+  m = make 'install' 
+  fail "Make install failed (status #{m})" unless m == 0
+end
+
+# Test Tasks ---------------------------------------------------------
+task :ta => :alltests
+task :tu => :unittests
+task :test => :unittests
+
+Rake::TestTask.new(:alltests) do |t|
+  t.test_files = FileList[
+    'tests/tc_*.rb',
+    'tests/contrib/*.rb',
+  ]
+  t.verbose = true
+end
+                    
+Rake::TestTask.new(:unittests) do |t|
+  t.test_files = FileList['tests/tc_*.rb']
+  t.verbose = false
+end
+                          
+#Rake::TestTask.new(:funtests) do |t|
+  #  t.test_files = FileList['test/fun*.rb']
+  #t.warning = true
+  #t.warning = true
+#end
+
+task :unittests => :compile
+task :alltests => :compile
+
+# RDoc Tasks ---------------------------------------------------------
+desc "Create the RDOC documentation tree"
+rd = Rake::RDocTask.new(:doc) do |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.title    = "Libxml-Ruby API"
+  rdoc.options << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'LICENSE', 'TODO')
+  rdoc.rdoc_files.include('ext/xml/ruby_xml*.c', '*.rdoc')
+end
+
+desc "Publish the RDoc documentation to project web site"
+task :pubdoc => [ :doc ] do
+  unless ENV['RUBYFORGE_ACCT']
+    raise "Need to set RUBYFORGE_ACCT to your rubyforge.org user name (e.g. 'fred')"
+  end
+  require 'rake/contrib/sshpublisher'
+  Rake::SshDirPublisher.new(
+    "#{ENV['RUBYFORGE_ACCT']}@rubyforge.org",
+    "/var/www/gforge-projects/libxml/doc",
+    "html"
+  ).upload
+end
+
+# Packaging / Version number tasks -----------------------------------
+# Used during release packaging if a REL is supplied
+task :update_version do
+  unless PKG_VERSION == CURRENT_VERSION
+    File.open('ext/xml/libxml.h.new','w+') do |f|      
+      f << File.read('ext/xml/libxml.h').
+           gsub(/RUBY_LIBXML_VERSION\s+"(\d.+)"/) { "RUBY_LIBXML_VERSION  \"#{PKG_VERSION}\"" }.
+           gsub(/RUBY_LIBXML_VERNUM\s+\d+/) { "RUBY_LIBXML_VERNUM   #{PKG_VERSION.tr('.','')}" }
+    end
+    mv('ext/xml/libxml.h.new', 'ext/xml/libxml.h')     
+  end
+end
+
+PKG_FILES = FileList[
+  'ext/xml/extconf.rb',
+  '[A-Z]*',
+  'ext/xml/*.c', 
+  'ext/xml/ruby_xml*.h',
+  'ext/xml/libxml.h',
+  'tests/**/*',
+]
+
+if ! defined?(Gem)
+  warn "Package Target requires RubyGEMs"
+else
+  spec = Gem::Specification.new do |s|
+    
+    #### Basic information.
+
+    s.name = 'libxml-ruby'
+    s.version = PKG_VERSION
+    s.summary = "LibXML2 bindings for Ruby"
+    s.description = <<-EOF
+      C-language bindings for Gnome LibXML2 and Ruby. Supports
+      high-speed, feature rich XML processing in Ruby apps.
+    EOF
+    s.extensions = 'ext/xml/extconf.rb'    
+
+    #### Which files are to be included in this gem? 
+
+    s.files = PKG_FILES.to_a
+
+    #### Load-time details
+    s.require_path = 'ext'
+    
+    #### Documentation and testing.
+    s.has_rdoc = true
+    s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+    s.rdoc_options <<
+      '--title' <<  'Libxml-Ruby API' <<
+      '--main' << 'README' <<
+      '-o' << 'rdoc'      
+
+    s.test_files = Dir.glob('tests/*runner.rb')
+    
+    #### Author and project details.
+
+    s.author = "Sean Chittenden"
+    s.email = "libxml-devel@rubyforge.org"
+    s.homepage = "http://libxml.rubyforge.org"
+    s.rubyforge_project = "libxml"
+  end
+  
+  # Quick fix for Ruby 1.8.3 / YAML bug
+  if (RUBY_VERSION == '1.8.3')
+    def spec.to_yaml
+      out = super
+      out = '--- ' + out unless out =~ /^---/
+      out
+    end  
+  end
+
+  package_task = Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar_gz = true
+    pkg.package_dir = 'pkg'    
+  end
+      
+  desc "Build a full release"
+  task :release => [:clobber, :update_version, :compile, :test, :package]
+end

data/TODO

@@ -0,0 +1,84 @@
+$Id: TODO,v 1.1 2005/12/19 19:53:07 roscopeco Exp $
+
+==== BUGS
+
+* Hunt down a 4-8KB/s leak while running rubytest -i0 -F on the library.
+
+* Also some other C-side problems:
+  * doublefree at Ruby exit when copying nodes between documents,
+	  and using node sets, sample trace in node_set_bug.txt
+  * XML::Attr.name gives [BUG] segfault line.
+
+* Some C funcs need more NULL checking, they're throwing wierd 
+  ArgumentErrors into RubyLand. See TODOs in source.
+  
+* Get libxml to compile and build with OS-X.
+
+==== ENHANCEMENTS
+
+* Add warnings to each of the xpath functions if xpath isn't compiled
+  in.
+
+* Flush out XML::XPath::Context to more closely mirror the
+  _xmlXPathContext(libxml/xpath.h) structure.
+
+* Add XML::Node#sibling= to add siblings to an XML document
+
+* Cleanup the variable naming schemes and standardize on one.  Ideas:
+
+  * All VALUE encapsulated objects are prefixed with the character
+    'r'.  rnode, rdoc, rctxt, rxpath, rxnset, rxns.
+
+  * Their unwrapped C equiv drops the 'r'.  Since operating with
+    libxml isn't context less, this should help catch the cases
+    where having routines that are libxml derived (ex: xmlNodePtr)
+    and ruby-libxml derived (ex: ruby_xml_node) should collide in
+    the same name space convention.  This will act as a reminder
+    and deterrant against haphazardly returning and using libxml
+    objects when they should be passed in.  ruby-libxml is a set
+    of tools, not and end result.  Put the power and options in
+    the hands of the user and don't confine or constrain anything
+    within reason.  Just because someone can't think of a use for
+    it doesn't mean it's not possible or useful to someone.  It's
+    the weird shit that makes a library powerful. 
+
+	      rnode  -> node
+	      rdoc   -> doc
+	      rctxt  -> ctxt
+	      rxpath -> xpath
+
+* Should sweep through the code and remove all instances of
+  'return(Qnil)' with exceptions if 'return(Qnil)' is being used for
+  signaling an error or inability to process the document.
+  
+* Pointer target signedness warnings (GCC 4.0)  
+
+* Need to add the ability to create namespace objects and modify them
+  accordingly.
+
+* Need to figure out how to easily apply a namespace object to either a
+  document or a node.
+
+* Add an XML::DTD class.
+
+* Add ability to dynamically create DTD's.
+
+* Add ability to set auto-parse on XML::Parser classes.
+
+* Add ability to set auto-set on XML::XPath classes.
+
+* What's the counter part to XML::Node#sibling= ?  XML::Node#next ??
+  There's a certain degree of othogonality that I'm missing in the API
+  at the moment and it's picking away at my brain like a bad Dan Quale
+  quote.
+
+* Add a way of inspecting an XML::Node so that it can be serialized.
+
+* Have XML::Node#child= accept ChildNodeLists.
+
+* Add ability to append hashes and arrays via the XML::Node#<< method.
+
+==== Data Serialization
+
+* Need to define DTD for basic ruby types that have been XML serialized
+  and deserialized.