pluginfactory 1.0.4 → 1.0.5

data/lib/pluginfactory.rb

@@ -63,10 +63,6 @@ class FactoryError < RuntimeError; end
 #	driver.class #=> MysqlDriver
 #	pgdriver = Driver.create( "PostGresDriver" )
 # 
-# == Subversion ID
-# 
-# $Id: pluginfactory.rb 57 2009-02-25 17:50:55Z deveiant $
-# 
 # == Authors
 # 
 # * Martin Chase <stillflame@FaerieMUD.org>
@@ -80,8 +76,8 @@ class FactoryError < RuntimeError; end
 #
 module PluginFactory
 
-	VERSION = '1.0.4'
-	
+	VERSION = '1.0.5'
+
 
 	### Logging 
 	@default_logger = Logger.new( $stderr )
@@ -93,7 +89,7 @@ module PluginFactory
 	class << self
 		# The logger that will be used when the logging subsystem is reset
 		attr_accessor :default_logger
-		
+
 		# The logger that's currently in effect
 		attr_accessor :logger
 		alias_method :log, :logger
@@ -113,14 +109,14 @@ module PluginFactory
 			}
 		end
 	end
-	
+
 
 	### Reset the global logger object to the default
 	def self::reset_logger
 		self.logger = self.default_logger
 		self.logger.level = Logger::WARN
 	end
-	
+
 
 	### Returns +true+ if the global logger has not been set to something other than
 	### the default one.
@@ -181,7 +177,7 @@ module PluginFactory
 	end
 	alias_method :factoryType, :factory_type
 
-	
+
 	### Inheritance callback -- Register subclasses in the derivatives hash
 	### so that ::create knows about them.
 	def inherited( subclass )
@@ -273,7 +269,7 @@ module PluginFactory
 		return self.derivatives[ class_name.downcase ]
 	end
 	alias_method :getSubclass, :get_subclass
-	
+
 
 	### Calculates an appropriate filename for the derived class using the
 	### name of the base class and tries to load it via <tt>require</tt>. If

data/rake/dependencies.rb

@@ -1,6 +1,6 @@
 # 
 # Dependency-checking and Installation Rake Tasks
-# $Id: dependencies.rb 43 2008-09-05 18:19:16Z deveiant $
+
 # 
 
 require 'rubygems/dependency_installer'

data/rake/helpers.rb

@@ -5,6 +5,8 @@
 
 
 require 'pathname'
+require 'uri'
+require 'open3'
 
 begin
 	require 'readline'
@@ -66,17 +68,23 @@ def trace( *msg )
 end
 
 
+### Return the specified args as a string, quoting any that have a space.
+def quotelist( *args )
+	return args.flatten.collect {|part| part =~ /\s/ ? part.inspect : part}
+end
+
+
 ### Run the specified command +cmd+ with system(), failing if the execution
 ### fails.
 def run( *cmd )
 	cmd.flatten!
 
 	if cmd.length > 1
-		trace( cmd.collect {|part| part =~ /\s/ ? part.inspect : part} ) 
+		trace( quotelist(*cmd) )
 	else
 		trace( cmd )
 	end
-	
+
 	if $dryrun
 		$stderr.puts "(dry run mode)"
 	else
@@ -88,6 +96,15 @@ def run( *cmd )
 end
 
 
+### Run the given +cmd+ with the specified +args+ without interpolation by the shell and
+### return anything written to its STDOUT.
+def read_command_output( cmd, *args )
+	trace "Reading output from: %s" % [ cmd, quotelist(cmd, *args) ]
+	output = IO.read( '|-' ) or exec cmd, *args
+	return output
+end
+
+
 ### Run a subordinate Rake process with the same options and the specified +targets+.
 def rake( *targets )
 	opts = ARGV.select {|arg| arg[0,1] == '-' }
@@ -106,7 +123,7 @@ def pipeto( *cmd )
 		$stderr.puts "(dry run mode)"
 	else
 		open( '|-', 'w+' ) do |io|
-		
+
 			# Parent
 			if io
 				yield( io )
@@ -123,52 +140,35 @@ end
 
 ### Download the file at +sourceuri+ via HTTP and write it to +targetfile+.
 def download( sourceuri, targetfile=nil )
-	oldsync = $defout.sync
-	$defout.sync = true
-	require 'net/http'
-	require 'uri'
+	oldsync = $stdout.sync
+	$stdout.sync = true
+	require 'open-uri'
 
 	targetpath = Pathname.new( targetfile )
 
 	log "Downloading %s to %s" % [sourceuri, targetfile]
-	targetpath.open( File::WRONLY|File::TRUNC|File::CREAT, 0644 ) do |ofh|
-	
-		url = sourceuri.is_a?( URI ) ? sourceuri : URI( sourceuri )
-		downloaded = false
-		limit = 5
-		
-		until downloaded or limit.zero?
-			Net::HTTP.start( url.host, url.port ) do |http|
-				req = Net::HTTP::Get.new( url.path )
-
-				http.request( req ) do |res|
-					if res.is_a?( Net::HTTPSuccess )
-						log "Downloading..."
-						res.read_body do |buf|
-							ofh.print( buf )
-						end
-						downloaded = true
-						puts "done."
-		
-					elsif res.is_a?( Net::HTTPRedirection )
-						url = URI( res['location'] )
-						log "...following redirection to: %s" % [ url ]
-						limit -= 1
-						sleep 0.2
-						next
-				
-					else
-						res.error!
-					end
+	trace "  connecting..."
+	ifh = open( sourceuri ) do |ifh|
+		trace "  connected..."
+		targetpath.open( File::WRONLY|File::TRUNC|File::CREAT, 0644 ) do |ofh|
+			log "Downloading..."
+			buf = ''
+
+			while ifh.read( 16384, buf )
+				until buf.empty?
+					bytes = ofh.write( buf )
+					buf.slice!( 0, bytes )
 				end
 			end
+
+			log "Done."
 		end
-		
+
 	end
-	
+
 	return targetpath
 ensure
-	$defout.sync = oldsync
+	$stdout.sync = oldsync
 end
 
 
@@ -202,13 +202,13 @@ end
 ### line-endings, color reset, etc.
 def colorize( *args )
 	string = ''
-	
+
 	if block_given?
 		string = yield
 	else
 		string = args.shift
 	end
-	
+
 	ending = string[/(\s)$/] || ''
 	string = string.rstrip
 
@@ -290,7 +290,7 @@ def prompt_for_multiple_values( label, default=nil )
 
     results = []
     result = nil
-    
+
     begin
         result = readline( make_prompt_string("> ") )
 		if result.nil? || result.empty?
@@ -299,7 +299,7 @@ def prompt_for_multiple_values( label, default=nil )
         	results << result 
 		end
     end until result.nil? || result.empty?
-    
+
     return results.flatten
 end
 
@@ -322,7 +322,7 @@ def noecho( masked=false )
 	ensure
 		Termios.tcsetattr( $stdin, Termios::TCSANOW, term )
 	end
-	
+
 	return rval
 end
 
@@ -365,7 +365,7 @@ alias :prompt_for_confirmation :ask_for_confirmation
 ### those will be returned in an Array, else the whole matching line is returned.
 def find_pattern_in_file( regexp, file )
 	rval = nil
-	
+
 	File.open( file, 'r' ).each do |line|
 		if (( match = regexp.match(line) ))
 			rval = match.captures.empty? ? match[0] : match.captures
@@ -377,12 +377,32 @@ def find_pattern_in_file( regexp, file )
 end
 
 
+### Search line-by-line in the output of the specified +cmd+ for the given +regexp+,
+### returning the first match, or nil if no match was found. If the +regexp+ has any 
+### capture groups, those will be returned in an Array, else the whole matching line
+### is returned.
+def find_pattern_in_pipe( regexp, *cmd )
+	output = []
+
+	log( cmd.collect {|part| part =~ /\s/ ? part.inspect : part} ) 
+	Open3.popen3( *cmd ) do |stdin, stdout, stderr|
+		stdin.close
+
+		output << stdout.gets until stdout.eof?
+		output << stderr.gets until stderr.eof?
+	end
+
+	result = output.find { |line| regexp.match(line) } 
+	return $1 || result
+end
+
+
 ### Invoke the user's editor on the given +filename+ and return the exit code
 ### from doing so.
 def edit( filename )
 	editor = ENV['EDITOR'] || ENV['VISUAL'] || DEFAULT_EDITOR
 	system editor, filename
-	unless $?.success?
+	unless $?.success? || editor =~ /vim/i
 		fail "Editor exited uncleanly."
 	end
 end
@@ -398,10 +418,17 @@ end
 ### Log a subdirectory change, execute a block, and exit the subdirectory
 def in_subdirectory( subdir )
 	block = Proc.new
-	
+
 	log "Entering #{subdir}"
 	Dir.chdir( subdir, &block )
 	log "Leaving #{subdir}"
 end
-	
+
+
+### Make an easily-comparable version vector out of +ver+ and return it.
+def vvec( ver )
+	return ver.split('.').collect {|char| char.to_i }.pack('N*')
+end
+
+
 

data/rake/hg.rb

@@ -0,0 +1,261 @@
+# 
+# Mercurial Rake Tasks
+
+require 'enumerator'
+
+# 
+# Authors:
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+unless defined?( HG_DOTDIR )
+
+	# Mercurial constants
+	HG_DOTDIR = BASEDIR + '.hg'
+	HG_STORE  = HG_DOTDIR + 'store'
+
+	IGNORE_FILE = BASEDIR + '.hgignore'
+
+
+	### 
+	### Helpers
+	### 
+
+	module MercurialHelpers
+
+		###############
+		module_function
+		###############
+
+		### Generate a commit log from a diff and return it as a String.
+		def make_commit_log
+			diff = read_command_output( 'hg', 'diff' )
+			fail "No differences." if diff.empty?
+
+			return diff
+		end
+
+		### Generate a commit log and invoke the user's editor on it.
+		def edit_commit_log
+			diff = make_commit_log()
+
+			File.open( COMMIT_MSG_FILE, File::WRONLY|File::TRUNC|File::CREAT ) do |fh|
+				fh.print( diff )
+			end
+
+			edit( COMMIT_MSG_FILE )
+		end
+
+		### Generate a changelog.
+		def make_changelog
+			log = read_command_output( 'hg', 'log', '--style', 'compact' )
+			return log
+		end
+
+		### Get the 'tip' info and return it as a Hash
+		def get_tip_info
+			data = read_command_output( 'hg', 'tip' )
+			return YAML.load( data )
+		end
+
+		### Return the ID for the current rev
+		def get_current_rev
+			id = read_command_output( 'hg', '-q', 'identify' )
+			return id.chomp
+		end
+
+		### Read the list of existing tags and return them as an Array
+		def get_tags
+			taglist = read_command_output( 'hg', 'tags' )
+			return taglist.split( /\n/ )
+		end
+
+
+		### Read any remote repo paths known by the current repo and return them as a hash.
+		def get_repo_paths
+			paths = {}
+			pathspec = read_command_output( 'hg', 'paths' )
+			pathspec.split.each_slice( 3 ) do |name, _, url|
+				paths[ name ] = url
+			end
+			return paths
+		end
+
+		### Return the list of files which are of status 'unknown'
+		def get_unknown_files
+			list = read_command_output( 'hg', 'status', '-un', '--no-color' )
+			list = list.split( /\n/ )
+
+			trace "New files: %p" % [ list ]
+			return list
+		end
+
+		### Returns a human-scannable file list by joining and truncating the list if it's too long.
+		def humanize_file_list( list, indent=FILE_INDENT )
+			listtext = list[0..5].join( "\n#{indent}" )
+			if list.length > 5
+				listtext << " (and %d other/s)" % [ list.length - 5 ]
+			end
+
+			return listtext
+		end
+
+
+		### Add the list of +pathnames+ to the .hgignore list.
+		def hg_ignore_files( *pathnames )
+			patterns = pathnames.flatten.collect do |path|
+				'^' + Regexp.escape(path) + '$'
+			end
+			trace "Ignoring %d files." % [ pathnames.length ]
+
+			IGNORE_FILE.open( File::CREAT|File::WRONLY|File::APPEND, 0644 ) do |fh|
+				fh.puts( patterns )
+			end
+		end
+
+
+		### Delete the files in the given +filelist+ after confirming with the user.
+		def delete_extra_files( filelist )
+			description = humanize_file_list( filelist, '  ' )
+			log "Files to delete:\n ", description
+			ask_for_confirmation( "Really delete them?", false ) do
+				filelist.each do |f|
+					rm_rf( f, :verbose => true )
+				end
+			end
+		end
+
+	end # module MercurialHelpers
+
+
+	### Rakefile support
+	def get_vcs_rev( dir='.' )
+		return MercurialHelpers.get_current_rev
+	end
+	def make_changelog
+		return MercurialHelpers.make_changelog
+	end
+
+
+	###
+	### Tasks
+	###
+
+	desc "Mercurial tasks"
+	namespace :hg do
+		include MercurialHelpers
+
+		desc "Prepare for a new release"
+		task :prep_release do
+			tags = get_tags()
+			rev = get_current_rev()
+
+			# Look for a tag for the current release version, and if it exists abort
+			if tags.include?( PKG_VERSION )
+				error "Version #{PKG_VERSION} already has a tag. Did you mean " +
+					"to increment the version in #{VERSION_FILE}?"
+				fail
+			end
+
+			# Sign the current rev
+			log "Signing rev #{rev}"
+			run 'hg', 'sign'
+
+			# Tag the current rev
+			log "Tagging rev #{rev} as #{PKG_VERSION}"
+			run 'hg', 'tag', PKG_VERSION
+
+			# Offer to push
+			Rake::Task['hg:push'].invoke
+		end
+
+		desc "Check for new files and offer to add/ignore/delete them."
+		task :newfiles do
+			log "Checking for new files..."
+
+			entries = get_unknown_files()
+
+			unless entries.empty?
+				files_to_add = []
+				files_to_ignore = []
+				files_to_delete = []
+
+				entries.each do |entry|
+					action = prompt_with_default( "  #{entry}: (a)dd, (i)gnore, (s)kip (d)elete", 's' )
+					case action
+					when 'a'
+						files_to_add << entry
+					when 'i'
+						files_to_ignore << entry
+					when 'd'
+						files_to_delete << entry
+					end
+				end
+
+				unless files_to_add.empty?
+					run 'hg', 'add', *files_to_add
+				end
+
+				unless files_to_ignore.empty?
+					hg_ignore_files( *files_to_ignore )
+				end
+
+				unless files_to_delete.empty?
+					delete_extra_files( files_to_delete )
+				end
+			end
+		end
+		task :add => :newfiles
+
+
+		desc "Check the current code in if tests pass"
+		task :checkin => ['hg:newfiles', 'test', COMMIT_MSG_FILE] do
+			targets = get_target_args()
+			$stderr.puts '---', File.read( COMMIT_MSG_FILE ), '---'
+			ask_for_confirmation( "Continue with checkin?" ) do
+				run 'hg', 'ci', '-l', COMMIT_MSG_FILE, targets
+				rm_f COMMIT_MSG_FILE
+			end
+			Rake::Task['hg:push'].invoke
+		end
+		task :commit => :checkin
+		task :ci => :checkin
+
+		CLEAN.include( COMMIT_MSG_FILE )
+
+		desc "Push to the default origin repo (if there is one)"
+		task :push do
+			paths = get_repo_paths()
+			if origin_url = paths['default']
+				ask_for_confirmation( "Push to '#{origin_url}'?", false ) do
+					run 'hg', 'push'
+				end
+			else
+				trace "Skipping push: No 'default' path."
+			end
+		end
+
+	end
+
+	if HG_DOTDIR.exist?
+		trace "Defining mercurial VCS tasks"
+
+		desc "Check in all the changes in your current working copy"
+		task :ci => 'hg:ci'
+		desc "Check in all the changes in your current working copy"
+		task :checkin => 'hg:ci'
+
+		desc "Tag and sign revision before a release"
+		task :prep_release => 'hg:prep_release'
+
+		file COMMIT_MSG_FILE do
+			edit_commit_log()
+		end
+
+	else
+		trace "Not defining mercurial tasks: no #{HG_DOTDIR}"
+	end
+
+end
+
+