digestr 0.0.2

data/CONTRIBUTORS

@@ -0,0 +1,3 @@
+== The Contributors
+
+None yet.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c)2006 Ross Bamford (and contributors). All rights reserved.
+
+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,136 @@
+= DigestR - Fast XML Digester for Ruby
+
+== What is this?
+
+DigestR is a fast rules-based XML processor (similar to the Jakarta 
+Commons Digester) for Ruby, based upon the libxml-ruby Libxml2 binding.
+It's SAX-based rules engine allows code to be executed based on patterns
+and individual elements in the source XML.
+
+For the whys and wherefores of this kind of thing, see:
+
+	http://jakarta.apache.org/commons/digester
+
+== Prerequisites
+
+DigestR requires Libxml-Ruby (http://libxml.rubyforge.org) version 0.3.7
+(2005/4/14, developmental) / 0.3.8 (release) or later. If not installing
+via Rubygems (or if you do not wish to auto-install dependencies) you
+will need to install it prior to installing DigestR.
+
+== Installation ... 
+
+=== ... with RubyGems?
+
+If you have RubyGems, you can install DigestR by simply issuing the command:
+
+	gem install -r digestr
+	
+Which should download the latest version and install it. If you experience 
+problems, or wish to perform an offline installation, then simply download 
+the .gem file from the FRS, and execute the gem command from within the same
+directory.
+
+*Note* if auto-installing dependencies: The libxml-ruby gem includes native
+extensions, and will require a sane build environment on the installation
+machine. If you experience problems with the libxml install you may need to
+install manually with additional extconf options - see the libxml-ruby 
+guide (http://libxml.rubyforge.org/install.html) for more information.
+
+=== ... with install.rb?
+
+If you don't have RubyGems, you can install from one of the tarball or zip
+packages, using the following command:
+
+	ruby install.rb
+	
+from the unpacked root directory. This will copy the libaries to the 
+appropriate	place for your ruby installation.
+
+=== Did it work?
+
+With that done, you should be able to run: 
+
+	ruby [-rubygems] -rxml/digestr -e 'puts XML::Digester::VERSION'
+	
+to verify that the installation succeeded and the library can be loaded
+by ruby.
+
+== How do I use it?
+
+Please see the API reference for usage information. The latest version can be
+found online at http://digestr.rubyforge.org/ , and documentation source for
+a specific release is included in the release package. 
+
+The RDoc can be built by running 'rake doc' in the source directory. 
+
+== How fast is 'fast'?
+
+Currently, 'fast' is a relative term - there is certainly room for improvement
+in DigestR itself, though the fact that it's based on the (native) libxml2
+ruby binding gives a good burst of speed and I think DigestR should be fast 
+enough for most uses. To give an idea, here are some informal benchmarks run
+against the REXML-based xmldigester 
+(http://rubyforge.org/projects/xmldigester/) using the addressbook example 
+included with that package (over 500 runs):
+
+	###### ORIGINAL TWO-PERSON ADDRESSBOOK ######
+	###### XMLDIGESTER ######
+	      user     system      total        real
+	  2.860000   0.170000   3.030000 (  3.097948)
+	      user     system      total        real
+	  2.820000   0.160000   2.980000 (  3.061908)
+	
+	###### DIGESTR ######
+	      user     system      total        real
+	  0.980000   0.070000   1.050000 (  1.118739)
+	      user     system      total        real
+	  0.970000   0.060000   1.030000 (  1.089957)
+	
+	
+	###### TWENTY-PERSON ADDRESSBOOK ######	
+	###### XMLDIGESTER ######
+	      user     system      total        real
+	 23.000000   0.990000  23.990000 ( 24.265204)
+	      user     system      total        real
+	 22.610000   1.010000  23.620000 ( 23.936342)
+	
+	###### DIGESTR ######
+	      user     system      total        real
+	  8.880000   0.140000   9.020000 (  9.144904)
+	      user     system      total        real
+	  8.930000   0.140000   9.070000 (  9.227588)
+
+== Notes
+=== A note about version numbers
+
+DigestR uses odd/even numbers for development/release versions. When the final
+version component is odd, the package is an 'unofficial' build - generally
+this means built manually from source, during development. These will never
+be distributed, and there's no guarantee that any two packages with the same
+development version will actually be the same. These packages will have no
+corresponding SCM tag.
+
+Even numbers always denote 'official' releases, which are released on 
+RubyForge and tagged as such in SCM. These packages can be trusted to exhibit
+version consistency.
+
+If you are bundling DigestR with your product, please ensure you use an 
+official release version whenever possible. If you must use a developmental
+version, please modify the package version to reflect the fact that it is a
+custom build (e.g. 0.1.3-mycompany-20051021) to prevent inconsistent 
+development packages from escaping into the wild.
+
+=== Further information
+
+DigestR is developed by Ross Bamford (rosco <at> roscopeco.co.uk), with help 
+from the developers listed in CONTRIBUTORS. Any bugs are probably all his own.
+
+* Homepage - http://digestr.rubyforge.org/
+* Project - http://rubyforge.org/projects/digestr
+
+As you may have guessed, DigestR's hosting and development services are 
+provided by http://RubyForge.org - many thanks to Tom Copeland and all concerned.
+
+Thanks also to Yukihiro Matsumoto for a consistently amazing platform, and all 
+those who write and contribute to the libraries DigestR depends on.

data/Rakefile

@@ -0,0 +1,420 @@
+# DigestR Rakefile (run with 'rake' command)
+#
+# Copyright 2006 Ross Bamford (and contributors). All rights reserved.
+# Distributed under an MIT style license.  See LICENSE for details.
+#
+# $Id: Rakefile 4 2006-04-17 19:05:32Z roscopeco $
+#
+
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+# This needs to go at the front of the libpath
+# Otherwise, any pre-installed lib gets found,
+# and used from there. This is only necessary
+# for DigestR's build, to make sure we always unit-
+# test and build doc with the working copy.
+$LOAD_PATH.unshift 'lib'
+require 'xml/digestr'
+
+CLEAN.include('tidy.log')
+CLOBBER.include('TAGS')
+CLOBBER.include('html')
+
+def announce(msg='')
+  STDERR.puts msg
+end
+
+# Determine the current version of the software
+CURRENT_VERSION = XML::Digester::VERSION || "0.0.0"
+
+if ENV['REL']
+  PKG_VERSION = ENV['REL']
+else
+  PKG_VERSION = CURRENT_VERSION
+end
+
+SRC_RB = FileList['lib/**/*.rb']
+
+# The default task is run if rake is given no explicit arguments.
+
+desc "Default Task (All tests)"
+task :default => :alltests
+
+# Test Tasks ---------------------------------------------------------
+
+task :ta => :alltests
+#task :tf => :funtests
+task :tu => :unittests
+task :test => :unittests
+
+Rake::TestTask.new(:alltests) do |t|
+  t.test_files = FileList[
+    'tests/tc_*.rb',
+    'tests/contrib/tc_*.rb',
+    'tests/fun_*.rb'
+  ]
+  t.warning = true
+  t.verbose = true
+end
+
+Rake::TestTask.new(:unittests) do |t|
+  t.test_files = FileList['tests/tc_*.rb']
+  t.warning = true
+  t.verbose = false
+end
+
+# Rake::TestTask.new(:funtests) do |t|
+#   t.test_files = FileList['test/fun*.rb']
+#   t.warning = true
+#   t.warning = true
+# end
+
+# directory 'testdata'
+# [:alltests, :unittests].each do |t|
+#   task t => ['testdata']
+# end
+
+# CVS Tasks ----------------------------------------------------------
+
+# Install using the standard install.rb script.
+desc "Install the application"
+task :install do
+  ruby "install.rb"
+end
+
+# Website / Doc tasks ------------------------------------------------
+
+# Create a task to build the RDOC documentation tree.
+rd = Rake::RDocTask.new(:doc) { |rdoc|
+  rdoc.rdoc_dir = 'html'
+#  rdoc.template = 'kilmer'
+#  rdoc.template = 'css2'
+  #rdoc.template = 'doc/jamis.rb'
+  rdoc.title    = "DigestR"
+  rdoc.options << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'LICENSE', 'TODO', 'CONTRIBUTORS')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+  rdoc.rdoc_files.exclude(/\bcontrib\b/)
+}
+
+desc "Publish the documentation and web site"
+task :doc_upload => [ :doc ] do
+  if acct = ENV['RUBYFORGE_ACCT']
+    require 'rake/contrib/sshpublisher'
+    Rake::SshDirPublisher.new(
+      "#{acct}@rubyforge.org",
+      "/var/www/gforge-projects/digestr",
+      "html"
+    ).upload
+  else
+    $stderr << "Skipping documentation upload - Need to set RUBYFORGE_ACCT to your rubyforge.org user name"
+  end
+end
+
+# ====================================================================
+# Create a task that will package the software into distributable
+# tar, zip and gem files.
+
+# don't include rendered website and all that Jazz 
+PKG_FILES = FileList[
+  'install.rb',
+  '[A-Z]*',
+  'lib/**/*.rb', 
+  'test/**/*',
+  'doc/**/*'
+]
+
+if ! defined?(Gem)
+  puts "Package Target requires RubyGEMs"
+else
+  spec = Gem::Specification.new do |s|
+    
+    #### Basic information.
+
+    s.name = 'digestr'
+    s.version = PKG_VERSION
+    s.summary = "Libxml2-based Commons Digester port for Ruby"
+    s.description = <<-EOF
+      DigestR is a fast rules-based XML processor (similar to the Jakarta 
+      Commons Digester) for Ruby, based upon the libxml-ruby Libxml2 binding.
+    EOF
+
+    #### Dependencies and requirements.
+
+    s.add_dependency('libxml-ruby', '>= 0.3.7')
+    #s.requirements << ""
+
+    #### Which files are to be included in this gem? 
+
+    s.files = PKG_FILES.to_a
+
+    #### Load-time details: library and application (you will need one or both).
+
+    s.require_path = 'lib'                         # Use these for libraries.
+
+    #### Documentation and testing.
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+    s.rdoc_options <<
+      '--title' <<  'DigestR - API' <<
+      '--main' << 'README'
+
+    s.test_files = Dir.glob('tests/runner.rb')
+    
+    #### Author and project details.
+
+    s.author = "Ross Bamford"
+    s.email = "rosco@roscopeco.co.uk"
+    s.homepage = "http://digestr.rubyforge.org"
+    s.rubyforge_project = "digestr"
+#     if ENV['CERT_DIR']
+#       s.signing_key = File.join(ENV['CERT_DIR'], 'gem-private_key.pem')
+#       s.cert_chain  = [File.join(ENV['CERT_DIR'], 'gem-public_cert.pem')]
+#     end
+  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
+end
+
+# Misc tasks =========================================================
+
+def count_lines(filename)
+  lines = 0
+  codelines = 0
+  open(filename) { |f|
+    f.each do |line|
+      lines += 1
+      next if line =~ /^\s*$/
+      next if line =~ /^\s*#/
+      codelines += 1
+    end
+  }
+  [lines, codelines]
+end
+
+def show_line(msg, lines, loc)
+  printf "%6s %6s   %s\n", lines.to_s, loc.to_s, msg
+end
+
+desc "Count total lines in source"
+task :lines do
+  total_lines = 0
+  total_code = 0
+  show_line("File Name", "LINES", "LOC")
+  SRC_RB.each do |fn|
+    lines, codelines = count_lines(fn)
+    show_line(fn, lines, codelines)
+    total_lines += lines
+    total_code  += codelines
+  end
+  show_line("TOTAL", total_lines, total_code)
+end
+
+ARCHIVEDIR = '/mnt/usb'
+
+task :archive => [:package] do
+  cp FileList["pkg/*.tar.gz", "pkg/*.zip", "pkg/*.gem"], ARCHIVEDIR
+end
+
+# Define an optional publish target in an external file.  If the
+# publish.rf file is not found, the publish targets won't be defined.
+
+load "publish.rf" if File.exist? "publish.rf"
+
+# Support Tasks ------------------------------------------------------
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  FileList['**/*.rb'].egrep /#.*(FIXME|TODO|TBD)/
+end
+
+desc "Look for Debugging print lines"
+task :dbg do
+  FileList['**/*.rb'].egrep /\bDBG|\bbreakpoint\b/
+end
+
+desc "List all ruby files"
+task :rubyfiles do 
+  puts Dir['**/*.rb'].reject { |fn| fn =~ /^pkg/ }
+  puts Dir['bin/*'].reject { |fn| fn =~ /CVS|(~$)|(\.rb$)/ }
+end
+
+desc "Show deprecation notes"
+task :deprecated do
+  Dir['lib/**/*.r?'].each do |fn|
+    File.open(fn) do |f| 
+      [*f].each_with_index do |line,i| 
+        if line =~ /#(.*)vv([0-9\.]+)(?:[\s\t]*)v-([0-9\.]+)/
+          cmnt = $~[1].strip
+          cmnt = '<No comment>' if (cmnt.nil? or cmnt.empty?)          
+          printf "%s:%d\n%-60s    %5s    %5s\n\n", fn, i+1, cmnt, $~[2].strip, $~[3].strip
+        end #if splits okay
+      end #each_w_idx
+    end #fopen
+  end #dir
+end
+
+desc "Find features deprecated at VER"
+task :deprecated_by do
+  fail "\nYou must specify the version to check (VER=x.y.z)\n\n" unless ver = ENV['VER']
+  Dir['lib/**/*.r?'].each do |fn|
+    File.open(fn) do |f| 
+      [*f].each_with_index do |line,i| 
+        if line =~ /vv#{ver}/
+          if line =~ /#(.*)vv([0-9\.]+)(?:[\s\t]*)v-([0-9\.]+)/
+            cmnt = $~[1].strip
+            cmnt = '<No comment>' if (cmnt.nil? or cmnt.empty?)          
+            printf "%s:%d\n%-60s    %5s    %5s\n\n", fn, i+1, cmnt, $~[2].strip, $~[3].strip
+          end #if splits okay
+        end #if line is dep remove
+      end #each_w_idx
+    end #fopen
+  end #dir
+end
+
+desc "Find deprecated features to be removed by VER"
+task :deprecated_due do
+  fail "\nYou must specify the version to check (VER=x.y.z)\n\n" unless ver = ENV['VER']
+  Dir['lib/**/*.r?'].each do |fn|
+    File.open(fn) do |f| 
+      [*f].each_with_index do |line,i| 
+        if line =~ /v-#{ver}/
+          if line =~ /#(.*)vv([0-9\.]+)(?:[\s\t]*)v-([0-9\.]+)/
+            cmnt = $~[1].strip
+            cmnt = '<No comment>' if (cmnt.nil? or cmnt.empty?)          
+            printf "%s:%d\n%-60s    %5s    %5s\n\n", fn, i+1, cmnt, $~[2].strip, $~[3].strip
+          end #if splits okay
+        end #if line is dep remove
+      end #each_w_idx
+    end #fopen
+  end #dir
+end
+
+# --------------------------------------------------------------------
+# Creating a release
+
+desc "Make a new release"
+task :release => [
+  :prerelease,
+  :clobber,
+  :alltests,
+  :update_version,
+  :package,
+  :tag,
+  :doc_upload] do
+  
+  announce 
+  announce "**************************************************************"
+  announce "* Release #{PKG_VERSION} Complete."
+  announce "* Packages ready to upload."
+  announce "**************************************************************"
+  announce 
+end
+
+# Validate that everything is ready to go for a release.
+task :prerelease do
+  announce 
+  announce "**************************************************************"
+  announce "* Making RubyGem Release #{PKG_VERSION}"
+  announce "* (current version #{CURRENT_VERSION})"
+  announce "**************************************************************"
+  announce  
+
+  # Is a release number supplied?
+  unless ENV['REL']
+    fail "Usage: rake release REL=x.y.z [REUSE=tag_suffix]"
+  end
+
+  # Is the release different than the current release.
+  # (or is REUSE set?)
+  if PKG_VERSION == CURRENT_VERSION && ! ENV['REUSE']
+    fail "Current version is #{PKG_VERSION}, must specify REUSE=tag_suffix to reuse version"
+  end
+
+  # Are all source files checked in?
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping checked-in file test"
+  else
+    announce "Checking for unchecked-in files..."
+    data = `svn status`
+    unless data =~ /^$/
+      fail "SVN status is not clean ... do you have unchecked-in files?"
+    end
+    announce "No outstanding checkins found ... OK"
+  end
+end
+
+task :update_version => [:prerelease] do
+  if PKG_VERSION == CURRENT_VERSION
+    announce "No version change ... skipping version update"
+  else
+    announce "Updating DigestR version to #{PKG_VERSION}"
+    open("lib/xml/digestr.rb") do |rakein|
+      open("lib/xml/digestr.rb.new", "w") do |rakeout|
+	rakein.each do |line|
+	  if line =~ /^VERSION\s*=\s*/
+	    rakeout.puts "VERSION = '#{PKG_VERSION}'"
+	  else
+	    rakeout.puts line
+	  end
+	end
+      end
+    end
+    mv "lib/xml/digestr.rb.new", "lib/xml/digestr.rb"
+    if ENV['RELTEST']
+      announce "Release Task Testing, skipping commiting of new version"
+    else
+      sh %{svn commit -m "Updated to version #{PKG_VERSION}" lib/xml/digestr.rb}
+    end
+  end
+end
+
+desc "Create a new SVN tag with the latest release number (REL=x.y.z)"
+task :tag => [:prerelease] do
+  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
+  reltag << ENV['REUSE'].gsub(/\./, '_') if ENV['REUSE']
+  announce "Tagging CVS with [#{reltag}]"
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping SVN tagging"
+  else
+    # need to get current base URL
+    s = `svn info`
+    if s =~ /URL:\s*([^\n]*)\n/
+      svnroot = $1
+      if svnroot =~ /^(.*)\/trunk/
+        svnbase = $1
+        sh %{svn cp #{svnroot} #{svnbase}/tags/#{reltag} -m "Release #{PKG_VERSION}"}
+      else
+        fail "Please merge to trunk before making a release"
+      end
+    else 
+      fail "Unable to determine repository URL from 'svn info' - is this a working copy?"
+    end  
+  end
+end
+
+# Require experimental XForge/Metaproject support.
+# load 'xforge.rf' if File.exist?('xforge.rf')
+