rwdeliza 0.03

data/lib/linkparser/utils.rb

@@ -0,0 +1,540 @@
+#!/usr/bin/ruby
+#
+#	utils.rb - a file with general purpose utilities for the link parser system.
+#
+# == Synopsis
+#
+#   require "linkparser/utils"
+#
+# == Rcsid
+#
+# $Id: utils.rb,v 1.5 2003/08/09 17:53:53 stillflame Exp $
+#
+# == Authors
+#
+#	Martin Chase <stillflame@FaerieMUD.org>
+#
+#:include: COPYRIGHT
+#
+#---
+#
+# Please see the file COPYRIGHT for licensing details.
+#
+
+
+### Some minor modifications to the base Array class.
+class Array
+
+	# Returns all 'right' elements.
+	def right
+		self.find_all {|elem| elem.right?}
+	end
+
+	# Returns all 'left' elements.
+	def left
+		self.find_all {|elem| elem.left?}
+	end
+
+	# Performs combine in place
+	def combine!(other)
+		return self.replace(other) if self.empty?
+		return self if other.empty?
+		temp = self.dup
+		self.clear
+		temp.each {|mine|
+			other.each {|theirs|
+				self << mine + theirs
+			}
+		}
+		self
+	end
+
+	# Returns every possible combination of the elements in both this array and
+	# the supplied other array.  Combinations are formed using the '+' method.
+	def combine(other)
+		return other.dup if self.empty?
+		return self.dup if other.empty?
+		temp = []
+		self.each {|mine|
+			other.each {|theirs|
+				temp << mine + theirs
+			}
+		}
+		temp
+	end
+
+	### Performs '+' in place.
+	def add!( other )
+		self.replace(self + other) # not optimized.
+	end
+
+	### An alias for '+' to go along with 'add!'.
+	alias :add :+;
+
+	### Performs a varient on '==', similar to what would be set equality, but
+	### with the extra assumption that the elements of this set are sets
+	### themselves.
+	def set_of_sets_equal?(other)
+		self.set_of_sets_minus(other).empty? and other.set_of_sets_minus(self).empty?
+	end
+
+	### Performs a varient on '-', similar to what would be set subtraction, but
+	### with the extra assumption that the elements of this set are sets
+	### themselves.
+	def set_of_sets_minus(other)
+		self.dup.set_of_sets_minus!(other)
+	end
+
+	### Performs set_of_sets_minus in place.
+	def set_of_sets_minus!(other)
+		self.delete_if {|set|
+			other.set_include?(set)
+		}
+	end
+
+	### Performs a varient on 'include?', only assuming that the elements of
+	### both arrays are sets of objects.
+	def set_include?(other)
+		self.find {|set|
+			set.set_equal?(other)
+		}
+	end
+
+	### Performs a varient on '==', similar to what would be set equality.
+	def set_equal?(other)
+		(self.minus other).empty? and (other.minus self).empty?
+	end
+
+	### Like "-", but uses == instead of an id comparison.
+	def minus(other)
+		self.dup.minus!(other)
+	end
+
+	### Like minus, but in place.
+	def minus!(other)
+		other.each {|bad|
+			self.delete_if {|elem| elem == bad}
+		}
+		self
+	end
+
+	### Superimposes one array over another, overwriting non-nil values.
+	def superimpose(other)
+		self.dup.superimpose!(other)
+	end
+
+	### Performs superimpose in place.
+	def superimpose!(other)
+		return self unless other.respond_to?(:[])
+		other.each_with_index {|o,i|
+			(self[i] = o) unless(self[i])
+		}
+		self
+	end
+
+	### Creates the set of all the combinations of the members of this set and
+	### another.
+	def set_combine(other)
+		if self.empty?
+			return other
+		elsif other.empty?
+			return self
+		else
+			results = []
+			self.each {|a|
+				other.each {|b|
+					results << a.combine(b)
+				}
+			}
+			return results
+		end
+	end
+
+	### Performs set_combine in place.
+	def set_combine!(other)
+		self.replace(self.set_combine(other))
+	end
+
+	### Returns whether or not the array has any elements which respond
+	### positively to the provided test.
+	def any_pass?(test, *args)
+		self.find {|elem| elem.send(test, *args)}
+	end
+
+	### Returns whether or not the array has any elements which respond
+	### negatively to the provided test.
+	def any_fail?(test, *args)
+		self.find {|elem| ! elem.send(test, *args)}
+	end
+
+	### Returns whether or not the array has no elements which respond
+	### negatively to the provided test.
+	def all_pass?(test, *args)
+		self.find_all {|elem| ! elem.send(test, *args)}.empty?
+	end
+
+	### Returns whether or not the array has no elements which respond
+	### positively to the provided test.
+	def all_fail?(test, *args)
+		self.find_all {|elem| elem.send(test, *args)}.empty?
+	end
+
+end # class Array
+
+class LinkParser
+
+	### An exception for parses.
+    class ParseError < Exception; end
+
+end # class LinkParser
+
+
+### Minor addition to the behavior of a struct.
+class Struct
+
+	### Using either another struct or a hash, updates all the values of this
+	### instance of a struct.
+	def update(obj)
+		self.members.each {|member|
+			self[member.to_s] = obj[member.intern] || self[member]
+		}
+		self
+	end
+
+end # class Struct
+
+# Stuff for installation usage.
+
+BEGIN {
+	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
+}
+
+module UtilityFunctions
+
+	# The list of regexen that eliminate files from the MANIFEST
+	ANTIMANIFEST = [
+		/makedist\.rb/,
+		/\bCVS\b/,
+		/~$/,
+		/^#/,
+		%r{docs/html},
+		%r{docs/man},
+		/^TEMPLATE/,
+		/\.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"
+
+
+	###############
+	module_function
+	###############
+
+	# Create a string that contains the ANSI codes specified and return it
+	def ansiCode( *attributes )
+		attr = attributes.collect {|a| AnsiAttributes[a] ? AnsiAttributes[a] : nil}.compact.join(';')
+		if attr.empty? 
+			return ''
+		else
+			return "\e[%sm" % attr
+		end
+	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 testForLibrary( library, nicename=nil )
+		nicename ||= library
+		message( "Testing for the #{nicename} library..." )
+		if $:.detect {|dir| File.exists?(File.join(dir,"#{library}.rb")) || File.exists?(File.join(dir,"#{library}.so"))}
+			message( "found.\n" )
+			return true
+		else
+			message( "not found.\n" )
+			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>raaUrl</tt> and/or <tt>downloadUrl</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 testForRequiredLibrary( library, nicename=nil, raaUrl=nil, downloadUrl=nil, fatal=true )
+		nicename ||= library
+		unless testForLibrary( library, nicename )
+			msgs = [ "You are missing the required #{nicename} library.\n" ]
+			msgs << "RAA: #{raaUrl}\n" if raaUrl
+			msgs << "Download: #{downloadUrl}\n" if downloadUrl
+			if fatal
+				abort msgs.join('')
+			else
+				errorMessage 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 ansiCode( 'bold', 'white', 'on_blue' ) + msg + ansiCode( 'reset' )
+		$stderr.flush
+	end
+
+	### Output <tt>msg</tt> to STDERR and flush it.
+	def message( msg )
+		$stderr.print msg
+		$stderr.flush
+	end
+
+	### Output the specified <tt>msg</tt> as an ANSI-colored error message
+	### (white on red).
+	def errorMessage( msg )
+		message ansiCode( 'bold', 'white', 'on_red' ) + msg + ansiCode( 'reset' )
+	end
+
+	### Output the specified <tt>msg</tt> as an ANSI-colored debugging message
+	### (yellow on blue).
+	def debugMsg( msg )
+		return unless $DEBUG
+		msg.chomp!
+		$stderr.puts ansiCode( 'bold', 'yellow', 'on_blue' ) + ">>> #{msg}" + ansiCode( 'reset' )
+		$stderr.flush
+	end
+
+	### Erase the previous line (if supported by your terminal) and output the
+	### specified <tt>msg</tt> instead.
+	def replaceMessage( msg )
+		print ErasePreviousLine
+		message( msg )
+	end
+
+	### Output a divider made up of <tt>length</tt> hyphen characters.
+	def divider( length=75 )
+		puts "\r" + ("-" * length )
+	end
+	alias :writeLine :divider
+
+	### Output the specified <tt>msg</tt> colored in ANSI red and exit with a
+	### status of 1.
+	def abort( msg )
+		print ansiCode( 'bold', 'red' ) + "Aborted: " + msg.chomp + ansiCode( 'reset' ) + "\n\n"
+		Kernel.exit!( 1 )
+	end
+
+	### Output the specified <tt>promptString</tt> as a prompt (in green) and
+	### return the user's input with leading and trailing spaces removed.
+	def prompt( promptString )
+		promptString.chomp!
+		return readline( ansiCode('bold', 'green') + "#{promptString}: " + ansiCode('reset') ).strip
+	end
+
+	### Prompt the user with the given <tt>promptString</tt> via #prompt,
+	### substituting the given <tt>default</tt> if the user doesn't input
+	### anything.
+	def promptWithDefault( promptString, default )
+		response = prompt( "%s [%s]" % [ promptString, default ] )
+		if response.empty?
+			return default
+		else
+			return response
+		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 findProgram( progname )
+		ENV['PATH'].split(File::PATH_SEPARATOR).each {|d|
+			file = File.join( d, progname )
+			return file if File.executable?( file )
+		}
+		return nil
+	end
+
+	### Using the CVS log for the given <tt>file</tt> attempt to guess what the
+	### next release version might be. This only works if releases are tagged
+	### with tags like 'RELEASE_x_y'.
+	def extractNextVersionFromTags( file )
+		message "Attempting to extract next release version from CVS tags for #{file}...\n"
+		raise RuntimeError, "No such file '#{file}'" unless File.exists?( file )
+		cvsPath = findProgram( 'cvs' ) or
+			raise RuntimeError, "Cannot find the 'cvs' program. Aborting."
+
+		output = %x{#{cvsPath} log #{file}}
+		release = [ 0, 0 ]
+		output.scan( /RELEASE_(\d+)_(\d+)/ ) {|match|
+			if $1.to_i > release[0] || $2.to_i > release[1]
+				release = [ $1.to_i, $2.to_i ]
+				replaceMessage( "Found %d.%02d...\n" % release )
+			end
+		}
+
+		if release[1] >= 99
+			release[0] += 1
+			release[1] = 1
+		else
+			release[1] += 1
+		end
+
+		return "%d.%02d" % release
+	end
+
+	### Extract the project name (CVS Repository name) for the given directory.
+	def extractProjectName
+		File.open( "CVS/Repository", "r").readline.chomp
+	end
+
+	### Read the specified <tt>manifestFile</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 readManifest( manifestFile="MANIFEST" )
+		message "Building manifest..."
+		raise "Missing #{manifestFile}, please remake it" unless File.exists? manifestFile
+
+		manifest = IO::readlines( manifestFile ).collect {|line|
+			line.chomp
+		}.select {|line|
+			line !~ /^(\s*(#.*)?)?$/
+		}
+
+		filelist = []
+		for pat in manifest
+			$stderr.puts "Adding files that match '#{pat}' to the file list" if $VERBOSE
+			filelist |= Dir.glob( pat ).find_all {|f| FileTest.file?(f)}
+		end
+
+		message "found #{filelist.length} files.\n"
+		return filelist
+	end
+
+	### Given a <tt>filelist</tt> like that returned by #readManifest, remove
+	### the entries therein which match the Regexp objects in the given
+	### <tt>antimanifest</tt> and return the resultant Array.
+	def vetManifest( filelist, antimanifest=ANITMANIFEST )
+		origLength = filelist.length
+		message "Vetting manifest..."
+
+		for regex in antimanifest
+			if $VERBOSE
+				message "\n\tPattern /#{regex.source}/ removed: " +
+					filelist.find_all {|file| regex.match(file)}.join(', ')
+			end
+			filelist.delete_if {|file| regex.match(file)}
+		end
+
+		message "removed #{origLength - filelist.length} files from the list.\n"
+		return filelist
+	end
+
+	### Combine a call to #readManifest with one to #vetManifest.
+	def getVettedManifest( manifestFile="MANIFEST", antimanifest=ANTIMANIFEST )
+		vetManifest( readManifest(manifestFile), antimanifest )
+	end
+
+	### Given a documentation <tt>catalogFile</tt>, which is in the same format
+	### as that described by #readManifest, read and expand it, and then return
+	### a list of those files which appear to have RDoc documentation in
+	### them. If <tt>catalogFile</tt> is nil or does not exist, the MANIFEST
+	### file is used instead.
+	def findRdocableFiles( catalogFile="docs/CATALOG" )
+		startlist = []
+		if File.exists? catalogFile
+			message "Using CATALOG file (%s).\n" % catalogFile
+			startlist = getVettedManifest( catalogFile )
+		else
+			message "Using default MANIFEST\n"
+			startlist = getVettedManifest()
+		end
+
+		message "Looking for RDoc comments in:\n" if $VERBOSE
+		startlist.select {|fn|
+			message "  #{fn}: " if $VERBOSE
+			found = false
+			File::open( fn, "r" ) {|fh|
+				fh.each {|line|
+					if line =~ /^(\s*#)?\s*=/ || line =~ /:\w+:/ || line =~ %r{/\*}
+						found = true
+						break
+					end
+				}
+			}
+
+			message( (found ? "yes" : "no") + "\n" ) if $VERBOSE
+			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 editInPlace( file ) # :yields: line
+		raise "No block specified for editing operation" unless block_given?
+
+		tempName = "#{file}.#{$$}"
+		File::open( tempName, File::RDWR|File::CREAT, 0600 ) {|tempfile|
+			File::unlink( tempName )
+			File::open( file, File::RDONLY ) {|fh|
+				fh.each {|line|
+					newline = yield( line ) or next
+					tempfile.print( newline )
+				}
+			}
+
+			tempfile.seek(0)
+
+			File::open( file, File::TRUNC|File::WRONLY, 0644 ) {|newfile|
+				newfile.print( tempfile.read )
+			}
+		}
+	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 shellCommand( *command )
+		raise "Empty command" if command.empty?
+
+		cmdpipe = IO::popen( command.join(' '), 'r' )
+		return cmdpipe.readlines
+	end
+
+end