wordnet 0.0.5

data/spec/wordnet/synset_spec.rb

@@ -0,0 +1,288 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	libdir = basedir + 'lib'
+
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+begin
+	require 'fileutils'
+	require 'tmpdir'
+	require 'bdb'
+	require 'spec/runner'
+	require 'spec/lib/helpers'
+
+	require 'wordnet/lexicon'
+	require 'wordnet/synset'
+rescue LoadError
+	unless Object.const_defined?( :Gem )
+		require 'rubygems'
+		retry
+	end
+	raise
+end
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe WordNet::Synset do
+
+	Accessors = [
+		:part_of_speech,
+		:offset,
+		:filenum,
+		:wordlist,
+		:pointerlist,
+		:frameslist,
+		:gloss,
+	]
+
+	RelationMethods = [
+		:antonyms,
+		:hypernyms,
+		:entailment,
+		:hyponyms,
+		:causes,
+		:verb_groups,
+		:similar_to,
+		:participles,
+		:pertainyms,
+		:attributes,
+		:derived_from,
+		:derivations,
+		:see_also,
+
+        :instance_hyponyms,
+
+        :instance_hypernyms,
+
+		:member_meronyms,
+		:stuff_meronyms,
+		:portion_meronyms,
+		:component_meronyms,
+		:feature_meronyms,
+		:phase_meronyms,
+		:place_meronyms,
+
+		:member_holonyms,
+		:stuff_holonyms,
+		:portion_holonyms,
+		:component_holonyms,
+		:feature_holonyms,
+		:phase_holonyms,
+		:place_holonyms,
+
+		:category_domains,
+		:region_domains,
+		:usage_domains,
+
+		:category_members,
+		:region_members,
+		:usage_members,
+	]
+
+	AggregateRelationMethods = [
+		:meronyms,
+		:holonyms,
+		:domains,
+		:members,
+	]
+		
+
+	before( :each ) do
+		@blank_syn = WordNet::Synset::new( @lexicon, "1%n", WordNet::Noun )
+		@traversal_syn = @lexicon.lookup_synsets( 'linguistics', :noun, 1 )
+	end
+	
+
+	#################################################################
+	###	T E S T S
+	#################################################################
+
+	### Accessors
+	def test_accessors
+		printTestHeader "Synset: Accessors"
+		rval = nil
+
+		assert_respond_to @blankSyn, :lexicon
+		
+		Accessors.each do |meth|
+			assert_respond_to @blankSyn, meth
+			assert_respond_to @blankSyn, "#{meth}="
+
+			assert_nothing_raised do
+				rval = @blankSyn.send( meth )
+			end
+		end
+	end
+
+	### Relations
+	def test_relations
+		printTestHeader "Synset: Relation methods"
+		rval = nil
+		
+		RelationMethods.each do |meth|
+			casemeth = meth.to_s.sub( /^(\w)/ ) {|char| char.upcase }.intern
+
+			assert_respond_to @blankSyn, meth
+			assert_respond_to @blankSyn, "#{meth}="
+
+			assert_nothing_raised {
+				rval = @blankSyn.send( meth )
+			}
+
+			assert_instance_of Array, rval
+		end
+	end
+
+	### Aggregate relation methods
+	def test_aggregate_relations
+		printTestHeader "Synset: Aggregate relations"
+		rval = nil
+		
+		AggregateRelationMethods.each {|meth|
+			assert_respond_to @blankSyn, meth
+
+			assert_nothing_raised {
+				rval = @blankSyn.send( meth )
+			}
+
+			assert_instance_of Array, rval
+		}
+	end
+
+	### Traversal method
+	def test_synset_should_respond_to_traverse_method
+		printTestHeader "Synset: Traversal method"
+		assert_respond_to @traversalSyn, :traverse
+	end
+
+    ### :TODO: This should really be split into two tests.
+	### Traversal: include origin, break loop
+	def test_traversal_with_true_second_arg_should_include_origin
+		printTestHeader "Synset: Traversal, including origin, break"
+		rval = nil
+		count = depth = 0
+		sets = []
+
+		assert_nothing_raised {
+			rval = @traversalSyn.traverse( :hyponyms, true ) {|tsyn,tdepth|
+				sets << tsyn
+				depth = tdepth
+				count += 1
+				return true
+			}
+		}
+		assert_equal true, rval
+		assert_equal 1, sets.length
+		assert_equal @traversalSyn, sets[0]
+		assert_equal 0, depth
+		assert_equal 1, count
+	end
+
+    ### :TODO: This should really be split into two tests.
+	### Traversal: exclude origin, break loop
+	def test_traversal_with_false_second_arg_should_not_include_origin
+		printTestHeader "Synset: Traversal, excluding origin, break"
+		rval = nil
+		count = depth = 0
+		sets = []
+
+		assert_nothing_raised {
+			rval = @traversalSyn.traverse( :hyponyms, false ) {|tsyn,tdepth|
+				sets << tsyn
+				depth = tdepth
+				count += 1
+				return true
+			}
+		}
+		assert_equal true, rval
+		assert_equal 1, sets.length
+		assert_not_equal @traversalSyn, sets[0]
+		assert_equal 1, depth
+		assert_equal 1, count
+	end
+
+	### Traversal: include origin, nobreak, noblock
+	def test_hyponym_traversal_with_no_block_should_return_appropriate_hyponyms
+		printTestHeader "Synset: Traversal, include origin, nobreak, noblock"
+		sets = []
+
+		assert_nothing_raised {
+			sets = @traversalSyn.traverse( :hyponyms )
+		}
+		assert_block { sets.length > 1 }
+		assert_equal @traversalSyn, sets[0]
+		assert_block { sets.find {|hsyn| hsyn.words.include?( "grammar" )} }
+		assert_block { sets.find {|hsyn| hsyn.words.include?( "syntax" )} }
+		assert_block { sets.find {|hsyn| hsyn.words.include?( "computational linguistics" )} }
+	end
+	
+
+	### Traversal: exclude origin, nobreak, noblock
+	def test_hyponym_traversal_with_no_block_and_false_second_arg_should_return_holonyms_but_not_the_origin
+		printTestHeader "Synset: Traversal, exclude origin, nobreak, noblock"
+		sets = []
+
+		assert_nothing_raised {
+			sets = @traversalSyn.traverse( :hyponyms, false )
+		}
+		assert_block { sets.length > 1 }
+		assert_not_equal @traversalSyn, sets[0]
+		assert_block { sets.find {|hsyn| hsyn.words.include?( "grammar" )} }
+		assert_block { sets.find {|hsyn| hsyn.words.include?( "syntax" )} }
+		assert_block { sets.find {|hsyn| hsyn.words.include?( "computational linguistics" )} }
+	end
+	
+
+	### Traversal: include origin, nobreak, noblock
+	def test_traversal_break_after_3_should_include_three_sets_plus_origin
+		printTestHeader "Synset: Traversal, break after 3"
+		rval = nil
+		sets = Hash::new {|hsh,key| hsh[key] = []}
+
+		assert_nothing_raised {
+			rval = @traversalSyn.traverse( :hyponyms ) {|tsyn,tdepth|
+				sets[tdepth] << tsyn
+				tdepth == 3
+			}
+		}
+		assert_equal 4, sets.keys.length
+		assert_equal [0,1,2,3], sets.keys.sort
+		assert_equal 1, sets[3].length
+		assert rval, "Break early flag expected to be set"
+	end
+
+
+	### Part of speech: part_of_speech
+	def test_part_of_speech_should_return_the_symbol_part_of_speech
+		printTestHeader "Synset: part_of_speech"
+		rval = nil
+
+		assert_nothing_raised { rval = @traversalSyn.part_of_speech }
+		assert_equal :noun, rval
+	end
+
+
+	### Part of speech: pos
+	def test_pos_should_return_the_synsets_singlechar_part_of_speech
+		printTestHeader "Synset: pos"
+		rval = nil
+
+		assert_nothing_raised { rval = @traversalSyn.pos }
+		assert_equal "n", rval
+	end
+
+
+	### :TODO: Test traversal, content, storing, higher-order functions
+
+
+end
+
+

data/utils.rb

@@ -0,0 +1,838 @@
+#
+#	Install/distribution utility functions
+#	$Id: utils.rb 94 2008-07-25 02:47:42Z deveiant $
+#
+#	Copyright (c) 2001-2008, The FaerieMUD Consortium.
+#
+#   All rights reserved.
+#   
+#   Redistribution and use in source and binary forms, with or without modification, are
+#   permitted provided that the following conditions are met:
+#   
+#       * Redistributions of source code must retain the above copyright notice, this
+#         list of conditions and the following disclaimer.
+#   
+#       * Redistributions in binary form must reproduce the above copyright notice, this
+#         list of conditions and the following disclaimer in the documentation and/or
+#         other materials provided with the distribution.
+#   
+#       * Neither the name of FaerieMUD, nor the names of its contributors may be used to
+#         endorse or promote products derived from this software without specific prior
+#         written permission.
+#   
+#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+#   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+#   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+#   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+#   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+#   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+#   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+#   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+#   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+#   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# 
+
+
+BEGIN {
+	require 'pathname'
+	require 'rbconfig'
+	require 'uri'
+	require 'find'
+	require 'pp'
+	require 'irb'
+
+	begin
+		require 'readline'
+		include Readline
+	rescue LoadError => e
+		$stderr.puts "Faking readline..."
+		def readline( prompt )
+			$stderr.print prompt.chomp
+			return $stdin.gets.chomp
+		end
+	end
+
+}
+
+
+### Command-line utility functions
+module UtilityFunctions
+	include Config
+
+	# The list of regexen that eliminate files from the MANIFEST
+	ANTIMANIFEST = [
+		/makedist\.rb/,
+		/\bCVS\b/,
+		/~$/,
+		/^#/,
+		%r{docs/html},
+		%r{docs/man},
+		/\bTEMPLATE\.\w+\.tpl\b/,
+		/\.cvsignore/,
+		/\.s?o$/,
+	]
+
+	# Set some ANSI escape code constants (Shamelessly stolen from Perl's
+	# Term::ANSIColor by Russ Allbery <rra@stanford.edu> and Zenin <zenin@best.com>
+	AnsiAttributes = {
+		'clear'      => 0,
+		'reset'      => 0,
+		'bold'       => 1,
+		'dark'       => 2,
+		'underline'  => 4,
+		'underscore' => 4,
+		'blink'      => 5,
+		'reverse'    => 7,
+		'concealed'  => 8,
+
+		'black'      => 30,   'on_black'   => 40, 
+		'red'        => 31,   'on_red'     => 41, 
+		'green'      => 32,   'on_green'   => 42, 
+		'yellow'     => 33,   'on_yellow'  => 43, 
+		'blue'       => 34,   'on_blue'    => 44, 
+		'magenta'    => 35,   'on_magenta' => 45, 
+		'cyan'       => 36,   'on_cyan'    => 46, 
+		'white'      => 37,   'on_white'   => 47
+	}
+
+	ErasePreviousLine = "\033[A\033[K"
+
+	ManifestHeader = (<<-"EOF").gsub( /^\t+/, '' )
+		#
+		# Distribution Manifest
+		# Created: #{Time::now.to_s}
+		# 
+
+	EOF
+
+	# A cache of programs found by find_program()
+	Programs = {}
+	
+
+	###############
+	module_function
+	###############
+
+	# Create a string that contains the ANSI codes specified and return it
+	def ansi_code( *attributes )
+		attributes.flatten!
+		# $stderr.puts "Returning ansicode for TERM = %p: %p" %
+		# 	[ ENV['TERM'], attributes ]
+		return '' unless /(?:vt10[03]|xterm(?:-color)?|linux|screen)/i =~ ENV['TERM']
+		attributes = AnsiAttributes.values_at( *attributes ).compact.join(';')
+
+		# $stderr.puts "  attr is: %p" % [attributes]
+		if attributes.empty? 
+			return ''
+		else
+			return "\e[%sm" % attributes
+		end
+	end
+
+
+	### Colorize the given +string+ with the specified +attributes+ and return it, handling line-endings, etc.
+	def colorize( string, *attributes )
+		ending = string[/(\s)$/] || ''
+		string = string.rstrip
+		return ansi_code( attributes.flatten ) + string + ansi_code( 'reset' ) + ending
+	end
+
+
+	# Test for the presence of the specified <tt>library</tt>, and output a
+	# message describing the test using <tt>nicename</tt>. If <tt>nicename</tt>
+	# is <tt>nil</tt>, the value in <tt>library</tt> is used to build a default.
+	def test_for_library( library, nicename=nil, progress=false )
+		nicename ||= library
+		message( "Testing for the #{nicename} library..." ) if progress
+		if $LOAD_PATH.detect {|dir|
+				File.exists?(File.join(dir,"#{library}.rb")) ||
+				File.exists?(File.join(dir,"#{library}.#{CONFIG['DLEXT']}"))
+			}
+			message( "found.\n" ) if progress
+			return true
+		else
+			message( "not found.\n" ) if progress
+			return false
+		end
+	end
+
+
+	# Test for the presence of the specified <tt>library</tt>, and output a
+	# message describing the problem using <tt>nicename</tt>. If
+	# <tt>nicename</tt> is <tt>nil</tt>, the value in <tt>library</tt> is used
+	# to build a default. If <tt>raa_url</tt> and/or <tt>download_url</tt> are
+	# specified, they are also use to build a message describing how to find the
+	# required library. If <tt>fatal</tt> is <tt>true</tt>, a missing library
+	# will cause the program to abort.
+	def test_for_required_library( library, nicename=nil, raa_url=nil, download_url=nil, fatal=true )
+		nicename ||= library
+		unless test_for_library( library, nicename )
+			msgs = [ "You are missing the required #{nicename} library.\n" ]
+			msgs << "RAA: #{raa_url}\n" if raa_url
+			msgs << "Download: #{download_url}\n" if download_url
+			if fatal
+				abort msgs.join('')
+			else
+				error_message msgs.join('')
+			end
+		end
+		return true
+	end
+
+
+	### Output <tt>msg</tt> as a ANSI-colored program/section header (white on
+	### blue).
+	def header( msg )
+		msg.chomp!
+		$stderr.puts ansi_code( 'bold', 'white', 'on_blue' ) + msg + ansi_code( 'reset' )
+		$stderr.flush
+	end
+
+
+	### Output <tt>msg</tt> to STDERR and flush it.
+	def message( *msgs )
+		$stderr.print( msgs.join("\n") )
+		$stderr.flush
+	end
+
+
+	### Output +msg+ to STDERR and flush it if $VERBOSE is true.
+	def verbose_msg( msg )
+		msg.chomp!
+		message( msg + "\n" ) if $VERBOSE
+	end
+
+
+	### Output the specified <tt>msg</tt> as an ANSI-colored error message
+	### (white on red).
+	def error_msg( msg )
+		message ansi_code( 'bold', 'white', 'on_red' ) + msg + ansi_code( 'reset' )
+	end
+	alias :error_message :error_msg
+
+
+	### Output the specified <tt>msg</tt> as an ANSI-colored debugging message
+	### (yellow on blue).
+	def debug_msg( msg )
+		return unless $DEBUG
+		msg.chomp!
+		$stderr.puts ansi_code( 'bold', 'yellow', 'on_blue' ) + ">>> #{msg}" + ansi_code( 'reset' )
+		$stderr.flush
+	end
+
+
+	### Erase the previous line (if supported by your terminal) and output the
+	### specified <tt>msg</tt> instead.
+	def replace_msg( msg )
+		$stderr.puts
+		$stderr.print ErasePreviousLine
+		message( msg )
+	end
+	alias :replace_message :replace_msg
+
+
+	### Output a divider made up of <tt>length</tt> hyphen characters.
+	def divider( length=75 )
+		$stderr.puts "\r" + ("-" * length )
+	end
+	alias :write_line :divider
+
+
+	### Output the specified <tt>msg</tt> colored in ANSI red and exit with a
+	### status of 1.
+	def abort( msg )
+		print ansi_code( 'bold', 'red' ) + "Aborted: " + msg.chomp + ansi_code( 'reset' ) + "\n\n"
+		Kernel.exit!( 1 )
+	end
+
+
+	### Output the specified <tt>prompt_string</tt> as a prompt (in green) and
+	### return the user's input with leading and trailing spaces removed.  If a
+	### test is provided, the prompt will repeat until the test returns true.
+	### An optional failure message can also be passed in.
+	def prompt( prompt_string, failure_msg="Try again." ) # :yields: response
+		prompt_string.chomp!
+		prompt_string << ":" unless /\W$/.match( prompt_string )
+		response = nil
+
+		begin
+			response = readline( ansi_code('bold', 'green') +
+				"#{prompt_string} " + ansi_code('reset') ) || ''
+			response.strip!
+			if block_given? && ! yield( response ) 
+				error_message( failure_msg + "\n\n" )
+				response = nil
+			end
+		end until response
+
+		return response
+	end
+
+
+	### Prompt the user with the given <tt>prompt_string</tt> via #prompt,
+	### substituting the given <tt>default</tt> if the user doesn't input
+	### anything.  If a test is provided, the prompt will repeat until the test
+	### returns true.  An optional failure message can also be passed in.
+	def prompt_with_default( prompt_string, default, failure_msg="Try again." )
+		response = nil
+
+		begin
+			response = prompt( "%s [%s]" % [ prompt_string, default ] )
+			response = default if response.empty?
+
+			if block_given? && ! yield( response ) 
+				error_message( failure_msg + "\n\n" )
+				response = nil
+			end
+		end until response
+
+		return response
+	end
+
+
+	### Display a description of a potentially-dangerous task, and prompt
+	### for confirmation. If the user answers with anything that begins
+	### with 'y', yield to the block, else raise with an error.
+	def ask_for_confirmation( description )
+		puts description
+
+		answer = prompt_with_default( "Continue?", 'n' ) do |input|
+			input =~ /^[yn]/i
+		end
+
+		case answer
+		when /^y/i
+			yield
+		else
+			error "Aborted."
+			fail
+		end
+	end
+
+
+	### Search for the program specified by the given <tt>progname</tt> in the
+	### user's <tt>PATH</tt>, and return the full path to it, or <tt>nil</tt> if
+	### no such program is in the path.
+	def find_program( progname )
+		unless Programs.key?( progname )
+			ENV['PATH'].split(File::PATH_SEPARATOR).
+				collect {|dir| Pathnanme.new(dir) }.each do |dir|
+					file = dir + progname
+					if file.executable?
+						Programs[ progname ] = file 
+						break
+					end
+				end
+		end
+
+		return Programs[ progname ].to_s
+	end
+
+
+	### Search for the release version for the project in the specified
+	### +directory+ using tags named "RELEASE_<major>_<minor>" if it's a CVS project
+	### or the 'project-version' metadata value of the toplevel directory if it's
+	### a Subversion project.
+	def extract_version( directory='.' )
+		release = nil
+
+		Dir::chdir( directory ) do
+			if File::directory?( "CVS" )
+				verbose_msg( "Project is versioned via CVS. Searching for RELEASE_*_* tags..." )
+
+				if (( cvs = find_program('cvs') ))
+					revs = []
+					output = %x{cvs log}
+					output.scan( /RELEASE_(\d+(?:_\d\w+)*)/ ) {|match|
+						rev = $1.split(/_/).collect {|s| Integer(s) rescue 0}
+						verbose_msg( "Found %s...\n" % rev.join('.') )
+						revs << rev
+					}
+
+					release = revs.sort.last
+				end
+
+			elsif File::directory?( '.svn' )
+				verbose_msg( "Project is versioned via Subversion" )
+
+				if (( svn = find_program('svn') ))
+					output = %x{svn pg project-version}.chomp
+					unless output.empty?
+						verbose_msg( "Using 'project-version' property: %p" % output )
+						release = output.split( /[._]/ ).collect {|s| Integer(s) rescue 0}
+					end
+				end
+			end
+		end
+
+		return release
+	end
+
+
+	### Find the current release version for the project in the specified
+	### +directory+ and return its successor.
+	def extract_next_version( directory='.' )
+		version = extract_version( directory ) || [0,0,0]
+		version.compact!
+		version[-1] += 1
+
+		return version
+	end
+
+
+	# Pattern for extracting the name of the project from a Subversion URL
+	SVNUrlPath = %r{
+		.*/						# Skip all but the last bit
+		([^/]+)					# $1 = project name
+		/						# Followed by / +
+		(?:
+			trunk |				# 'trunk'
+			(
+				branches |		# ...or branches/branch-name
+				tags			# ...or tags/tag-name
+			)/\w	
+		)
+		$						# bound to the end
+	}ix
+
+	### Extract the project name for the given +directory+. The project name is
+	### the repository name if it's versioned with CVS, set via the 'project-name'
+	### metadata value if versioned with Subversion, or just based on the name of the
+	### directory itself if it's not versioned with one of those two systems.
+	def extract_project_name( directory='.' )
+		name = nil
+
+		Dir::chdir( directory ) do
+
+			# CVS-controlled
+			if File::directory?( "CVS" )
+				verbose_msg( "Project is versioned via CVS. Using repository name." )
+				name = File.open( "CVS/Repository", "r").readline.chomp
+				name.sub!( %r{.*/}, '' )
+
+			# Subversion-controlled
+			elsif File::directory?( '.svn' )
+				verbose_msg( "Project is versioned via Subversion" )
+
+				# If the machine has the svn tool, try to get the project name
+				if (( svn = find_program( 'svn' ) ))
+
+					# First try an explicit property
+					output = shell_command( svn, 'pg', 'project-name' )
+					if !output.empty?
+						verbose_msg( "Using 'project-name' property: %p" % output )
+						name = output.first.chomp
+
+					# If that doesn't work, try to figure it out from the URL
+					elsif (( uri = get_svn_uri() ))
+						name = uri.path.sub( SVNUrlPath ) { $1 }
+					end
+				end
+			end
+
+			# Fall back to guessing based on the directory name
+			unless name
+				name = File::basename(File::dirname( File::expand_path(__FILE__) ))
+			end
+		end
+
+		return name
+	end
+
+
+	### Extract the Subversion URL from the specified directory and return it as
+	### a URI object.
+	def get_svn_uri( directory='.' )
+		uri = nil
+
+		Dir::chdir( directory ) do
+			output = %x{svn info}
+			debug_msg( "Using info: %p" % output )
+
+			if /^URL: \s* ( .* )/xi.match( output )
+				uri = URI::parse( $1 )
+			end
+		end
+
+		return uri
+	end
+
+
+	### (Re)make a manifest file in the specified +path+.
+	def make_manifest( path="MANIFEST" )
+		if File::exists?( path )
+			reply = prompt_with_default( "Replace current '#{path}'? [yN]", "n" )
+			return false unless /^y/i.match( reply )
+
+			verbose_msg "Replacing manifest at '#{path}'"
+		else
+			verbose_msg "Creating new manifest at '#{path}'"
+		end
+
+		files = []
+		verbose_msg( "Finding files...\n" )
+		Find::find( Dir::pwd ) do |f|
+			Find::prune if File::directory?( f ) &&
+				/^\./.match( File::basename(f) )
+			verbose_msg( "  found: #{f}\n" )
+			files << f.sub( %r{^#{Dir::pwd}/?}, '' )
+		end
+		files = vet_manifest( files )
+
+		verbose_msg( "Writing new manifest to #{path}..." )
+		File::open( path, File::WRONLY|File::CREAT|File::TRUNC ) do |ofh|
+			ofh.puts( ManifestHeader )
+			ofh.puts( files )
+		end
+		verbose_msg( "done." )
+	end
+
+
+	### Read the specified <tt>manifest_file</tt>, which is a text file
+	### describing which files to package up for a distribution. The manifest
+	### should consist of one or more lines, each containing one filename or
+	### shell glob pattern.
+	def read_manifest( manifest_file="MANIFEST" )
+		verbose_msg "Building manifest..."
+		raise "Missing #{manifest_file}, please remake it" unless File.exists? manifest_file
+
+		manifest = IO::readlines( manifest_file ).collect {|line|
+			line.chomp
+		}.select {|line|
+			line !~ /^(\s*(#.*)?)?$/
+		}
+
+		filelist = []
+		for pat in manifest
+			verbose_msg "Adding files that match '#{pat}' to the file list"
+			filelist |= Dir.glob( pat ).find_all {|f| FileTest.file?(f)}
+		end
+
+		verbose_msg "found #{filelist.length} files.\n"
+		return filelist
+	end
+
+
+	### Given a <tt>filelist</tt> like that returned by #read_manifest, remove
+	### the entries therein which match the Regexp objects in the given
+	### <tt>antimanifest</tt> and return the resultant Array.
+	def vet_manifest( filelist, antimanifest=ANTIMANIFEST )
+		orig_length = filelist.length
+		verbose_msg "Vetting manifest..."
+
+		for regex in antimanifest
+			verbose_msg "\n\tPattern /#{regex.source}/ removed: " +
+				filelist.find_all {|file| regex.match(file)}.join(', ')
+			filelist.delete_if {|file| regex.match(file)}
+		end
+
+		verbose_msg "removed #{orig_length - filelist.length} files from the list.\n"
+		return filelist
+	end
+
+
+	### Combine a call to #read_manifest with one to #vet_manifest.
+	def get_vetted_manifest( manifest_file="MANIFEST", antimanifest=ANTIMANIFEST )
+		vet_manifest( read_manifest(manifest_file), antimanifest )
+	end
+
+
+	### Given a documentation <tt>catalog_file</tt>, extract the title, if
+	### available, and return it. Otherwise generate a title from the name of
+	### the CVS module.
+	def find_rdoc_title( catalog_file="docs/CATALOG" )
+
+		# Try extracting it from the CATALOG file from a line that looks like:
+		# Title: Foo Bar Module
+		title = find_catalog_keyword( 'title', catalog_file )
+
+		# If that doesn't work for some reason, use the name of the project.
+		title = extract_project_name()
+
+		return title
+	end
+
+
+	### Given a documentation <tt>catalog_file</tt>, extract the name of the file
+	### to use as the initally displayed page. If extraction fails, the
+	### +default+ will be used if it exists. Returns +nil+ if there is no main
+	### file to be found.
+	def find_rdoc_main( catalog_file="docs/CATALOG", default="README" )
+
+		# Try extracting it from the CATALOG file from a line that looks like:
+		# Main: Foo Bar Module
+		main = find_catalog_keyword( 'main', catalog_file )
+
+		# Try to make some educated guesses if that doesn't work
+		if main.nil?
+			basedir = File::dirname( __FILE__ )
+			basedir = File::dirname( basedir ) if /docs$/ =~ basedir
+
+			if File::exists?( File::join(basedir, default) )
+				main = default
+			end
+		end
+
+		return main
+	end
+
+
+	### Given a documentation <tt>catalog_file</tt>, extract an upload URL for
+	### RDoc.
+	def find_rdoc_upload( catalog_file="docs/CATALOG" )
+		find_catalog_keyword( 'upload', catalog_file )
+	end
+
+
+	### Given a documentation <tt>catalog_file</tt>, extract a CVS web frontend
+	### URL for RDoc.
+	def find_rdoc_cvs_url( catalog_file="docs/CATALOG" )
+		find_catalog_keyword( 'webcvs', catalog_file )
+	end
+
+
+	### Find one or more 'accessor' directives in the catalog if they exist and
+	### return an Array of them.
+	def find_rdoc_accessors( catalog_file="docs/CATALOG" )
+		accessors = []
+		in_attr_section = false
+		indent = ''
+
+		if File::exists?( catalog_file )
+			verbose_msg "Extracting accessors from CATALOG file (%s).\n" % catalog_file
+
+			# Read lines from the catalog
+			File::foreach( catalog_file ) do |line|
+				debug_msg( "  Examining line #{line.inspect}..." )
+
+				# Multi-line accessors
+				if in_attr_section
+					if /^#\s+([a-z0-9_]+(?:\s*=\s*.*)?)$/i.match( line )
+						debug_msg( "    Found accessor: #$1" )
+						accessors << $1
+						next
+					end
+
+					debug_msg( "  End of accessors section." )
+					in_attr_section = false
+
+				# Single-line accessor
+				elsif /^#\s*Accessors:\s*(\S+)$/i.match( line )
+					debug_msg( "  Found single accessors line: #$1" )
+					vals = $1.split(/,/).collect {|val| val.strip }
+					accessors.replace( vals )
+
+				# Multi-line accessor header
+				elsif /^#\s*Accessors:\s*$/i.match( line )
+					debug_msg( "  Start of accessors section." )
+					in_attr_section = true
+				end
+
+			end
+		end
+
+		debug_msg( "Found accessors: %s" % accessors.join(",") )
+		return accessors
+	end
+
+
+	### Given a documentation <tt>catalog_file</tt>, try extracting the given
+	### +keyword+'s value from it. Keywords are lines that look like:
+	###   # <keyword>: <value>
+	### Returns +nil+ if the catalog file was unreadable or didn't contain the
+	### specified +keyword+.
+	def find_catalog_keyword( keyword, catalog_file="docs/CATALOG" )
+		val = nil
+
+		if File::exists? catalog_file
+			verbose_msg "Extracting '#{keyword}' from CATALOG file (%s).\n" % catalog_file
+			File::foreach( catalog_file ) do |line|
+				debug_msg( "Examining line #{line.inspect}..." )
+				val = $1.strip and break if /^#\s*#{keyword}:\s*(.*)$/i.match( line )
+			end
+		end
+
+		return val
+	end
+
+
+	### Given a documentation <tt>catalog_file</tt>, which is in the same format
+	### as that described by #read_manifest, read and expand it, and then return
+	### a list of those files which appear to have RDoc documentation in
+	### them. If <tt>catalog_file</tt> is nil or does not exist, the MANIFEST
+	### file is used instead.
+	def find_rdocable_files( catalog_file="docs/CATALOG" )
+		startlist = []
+		if File.exists? catalog_file
+			verbose_msg "Using CATALOG file (%s).\n" % catalog_file
+			startlist = get_vetted_manifest( catalog_file )
+		else
+			verbose_msg "Using default MANIFEST\n"
+			startlist = get_vetted_manifest()
+		end
+
+		verbose_msg "Looking for RDoc comments in:\n"
+		startlist.select {|fn|
+			verbose_msg "  #{fn}: "
+			found = false
+			File::open( fn, "r" ) {|fh|
+				fh.each {|line|
+					if line =~ /^(\s*#)?\s*=/ || line =~ /:\w+:/ || line =~ %r{/\*}
+						found = true
+						break
+					end
+				}
+			}
+
+			verbose_msg( (found ? "yes" : "no") + "\n" )
+			found
+		}
+	end
+
+
+	### Open a file and filter each of its lines through the given block a
+	### <tt>line</tt> at a time. The return value of the block is used as the
+	### new line, or omitted if the block returns <tt>nil</tt> or
+	### <tt>false</tt>.
+	def edit_in_place( file, test_mode=false ) # :yields: line
+		raise "No block specified for editing operation" unless block_given?
+
+		temp_name = "#{file}.#{$$}"
+		File::open( temp_name, File::RDWR|File::CREAT, 0600 ) do |tempfile|
+			File::open( file, File::RDONLY ) do |fh|
+				fh.each do |line|
+					newline = yield( line ) or next
+					tempfile.print( newline )
+					$stderr.puts "%p -> %p" % [ line, newline ] if
+						line != newline
+				end
+			end
+		end
+
+		if test_mode
+			File::unlink( temp_name )
+		else
+			File::rename( temp_name, file )
+		end
+	end
+
+
+	### Execute the specified shell <tt>command</tt>, read the results, and
+	### return them. Like a %x{} that returns an Array instead of a String.
+	def shell_command( *command )
+		raise "Empty command" if command.empty?
+
+		cmdpipe = IO::open( '|-' ) or exec( *command )
+		return cmdpipe.readlines
+	end
+
+
+	### Execute a block with $VERBOSE set to +false+, restoring it to its
+	### previous value before returning.
+	def verbose_off
+		raise LocalJumpError, "No block given" unless block_given?
+
+		thrcrit = Thread.critical
+		oldverbose = $VERBOSE
+		begin
+			Thread.critical = true
+			$VERBOSE = false
+			yield
+		ensure
+			$VERBOSE = oldverbose
+			Thread.critical = false
+		end
+	end
+
+
+	### Try the specified code block, printing the given 
+	def try( msg, bind=TOPLEVEL_BINDING )
+		result = ''
+		if msg =~ /^to\s/
+			message "Trying #{msg}...\n"
+		else
+			message msg + "\n"
+		end
+
+		begin
+			rval = nil
+			if block_given?
+				rval = yield
+			else
+				file, line = caller(1)[0].split(/:/,2)
+				rval = eval( msg, bind, file, line.to_i )
+			end
+
+			PP.pp( rval, result )
+
+		rescue Exception => err
+			if err.backtrace
+				nicetrace = err.backtrace.delete_if {|frame|
+					/in `(try|eval)'/ =~ frame
+				}.join("\n\t")
+			else
+				nicetrace = "Exception had no backtrace"
+			end
+
+			result = err.message + "\n\t" + nicetrace
+
+		ensure
+			divider
+			message result.chomp + "\n"
+			divider
+			$stderr.puts
+		end
+	end
+
+
+	### Start an IRB session with the specified binding +b+ as the current scope.
+	def start_irb_session( b )
+		IRB.setup(nil)
+
+		workspace = IRB::WorkSpace.new( b )
+
+		if IRB.conf[:SCRIPT]
+			irb = IRB::Irb.new( workspace, IRB.conf[:SCRIPT] )
+		else
+			irb = IRB::Irb.new( workspace )
+		end
+
+		IRB.conf[:IRB_RC].call( irb.context ) if IRB.conf[:IRB_RC]
+		IRB.conf[:MAIN_CONTEXT] = irb.context
+
+		trap("SIGINT") do
+			irb.signal_handle
+		end
+
+		catch(:IRB_EXIT) do
+			irb.eval_input
+		end
+	end
+
+end # module UtilityFunctions
+
+
+
+if __FILE__ == $0
+	# $DEBUG = true
+	include UtilityFunctions
+
+	projname = extract_project_name()
+	header "Project: #{projname}"
+
+	ver = extract_version() || [0,0,1]
+	puts "Version: %s\n" % ver.join('.')
+
+	if File::directory?( "docs" )
+		puts "Rdoc:",
+			"  Title: " + find_rdoc_title(),
+			"  Main: " + find_rdoc_main(),
+			"  Upload: " + find_rdoc_upload(),
+			"  VCS URL: " + find_rdoc_cvs_url(),
+			"  Accessors: " + find_rdoc_accessors().join(",")
+	end
+
+	puts "Manifest:",
+		"  " + get_vetted_manifest().join("\n  ")
+end