pluginfactory 1.0.3 → 1.0.4

data/rake/publishing.rb

@@ -100,15 +100,17 @@ begin
 
 
 	namespace :release do
-		task :default => [ 'svn:release', :publish, :announce, :project ]
+		task :default => [ 'svn:release', :upload, :publish, :announce ]
 
 		desc "Re-publish the release with the current version number"
-		task :rerelease => [ :publish, :announce, :project ]
+		task :rerelease => [  :upload, :publish, :announce ]
 
+		desc "Re-run the publication tasks, but send notifications to debugging address"
 		task :test do
+			trace "Will publish privately"
 			$publish_privately = true
+			Rake::Task['release:rerelease'].invoke
 		end
-		task :test => [ :rerelease ]
 		
 
 		desc "Generate the release notes"
@@ -127,24 +129,34 @@ begin
 
 			edit task.name
 		end
-		CLEAN.include( RELEASE_NOTES_FILE )
+		CLOBBER.include( RELEASE_NOTES_FILE )
 		
 		
-		task :project => [ :rdoc ] do
-			when_writing( "Publishing docs to #{PROJECT_SCPURL}" ) do
+		desc "Upload project documentation and packages to #{PROJECT_HOST}"
+		task :upload => [ :upload_docs, :upload_packages ]
+		task :project => :upload # the old name
+		
+		desc "Publish the project docs to #{PROJECT_HOST}"
+		task :upload_docs => [ :rdoc ] do
+			when_writing( "Publishing docs to #{PROJECT_SCPDOCURL}" ) do
+				log "Uploading API documentation to %s:%s" % [ PROJECT_HOST, PROJECT_DOCDIR ]
 				run 'ssh', PROJECT_HOST, "rm -rf #{PROJECT_DOCDIR}"
-				run 'scp', '-qCr', 'docs', PROJECT_SCPURL
+				run 'scp', '-qCr', RDOCDIR, PROJECT_SCPDOCURL
 			end
+		end
+
+		desc "Publish the project packages to #{PROJECT_HOST}"
+		task :upload_packages => [ :package ] do
 			when_writing( "Uploading packages") do
 				pkgs = Pathname.glob( PKGDIR + "#{PKG_FILE_NAME}.{gem,tar.gz,tar.bz2,zip}" )
-				log "Uploading %d packages to #{PROJECT_SCPURL}" % [ pkgs.length ]
+				log "Uploading %d packages to #{PROJECT_SCPPUBURL}" % [ pkgs.length ]
 				pkgs.each do |pkgfile|
-					run 'scp', '-qC', pkgfile, PROJECT_SCPURL
+					run 'scp', '-qC', pkgfile, PROJECT_SCPPUBURL
                 end
             end
 		end
 
-		
+
 		file RELEASE_ANNOUNCE_FILE => [RELEASE_NOTES_FILE] do |task|
 			relnotes = File.read( RELEASE_NOTES_FILE )
 			announce_body = %{
@@ -180,7 +192,7 @@ begin
 
 			edit task.name
 		end
-		CLEAN.include( RELEASE_ANNOUNCE_FILE )
+		CLOBBER.include( RELEASE_ANNOUNCE_FILE )
 		
 		
 		desc 'Send out a release announcement'
@@ -188,12 +200,11 @@ begin
 			email         = TMail::Mail.new
 			if $publish_privately
 				trace "Sending private announce mail"
-				email.to      = 'rubymage@gmail.com'
+				email.to = 'rubymage@gmail.com'
 			else
 				trace "Sending public announce mail"
-				email.to      = 'rubymage@gmail.com'
-				# email.to      = 'Ruby-Talk List <ruby-talk@ruby-lang.org>'
-				# email.bcc     = 'rubymage@gmail.com'
+				email.to  = 'Ruby-Talk List <ruby-talk@ruby-lang.org>'
+				email.bcc = 'rubymage@gmail.com'
 			end
 			email.from    = GEMSPEC.email
 			email.subject = "[ANN] #{PKG_NAME} #{PKG_VERSION}"
@@ -229,7 +240,7 @@ begin
 		
 	
 		desc 'Publish the new release to RubyForge'
-		task :publish => [:clobber, :package, :notes] do |task|
+		task :publish => [:clean, :package, :notes] do |task|
 			project = GEMSPEC.rubyforge_project
 
 			rf = RubyForge.new
@@ -299,5 +310,8 @@ rescue LoadError => err
 	task "release:notes" => :no_release_tasks
 end
 
+desc "Package up a release, publish it, and send out notifications"
 task :release => 'release:default'
+task :rerelease => 'release:rerelease'
+task :testrelease => 'release:test'
 

data/rake/rdoc.rb

@@ -1,30 +1,45 @@
 # 
-# RDoc Rake tasks for ThingFish
-# $Id: rdoc.rb 28 2008-08-13 04:50:05Z deveiant $
+# RDoc Rake tasks
+# $Id: rdoc.rb 86 2009-02-23 06:38:40Z deveiant $
 # 
 
-require 'rake/rdoctask'
-$have_darkfish = false
+require 'rdoc/rdoc'
+require 'rake/clean'
 
-begin
-	require 'darkfish-rdoc'
+
+if RDoc::RDoc::GENERATORS.key?( 'darkfish' )
 	$have_darkfish = true
-rescue LoadError => err
-	unless Object.const_defined?( :Gem )
-		require 'rubygems'
-		gem 'darkfish-rdoc'
-		retry
-	end
-	
-	log "No DarkFish: %s: %s" % [ err.class.name, err.message ]
-	trace "Backtrace:\n  %s" % [ err.backtrace.join("\n  ") ]
+else
+	trace "No darkfish generator."
+	$have_darkfish = false
 end
 
-Rake::RDocTask.new do |rdoc|
-	rdoc.rdoc_dir = 'docs/html'
-	rdoc.title    = "#{PKG_NAME} - #{PKG_SUMMARY}"
-	rdoc.options += RDOC_OPTIONS + [ '-f', 'darkfish' ] if $have_darkfish
 
-	rdoc.rdoc_files.include 'README'
-	rdoc.rdoc_files.include LIB_FILES.collect {|f| f.to_s }
+# Append docs/lib to the load path if it exists for a locally-installed Darkfish
+DOCSLIB = DOCSDIR + 'lib'
+$LOAD_PATH.unshift( DOCSLIB.to_s ) if DOCSLIB.exist?
+
+# Make relative string paths of all the stuff we need to generate docs for
+DOCFILES = LIB_FILES + EXT_FILES + GEMSPEC.extra_rdoc_files
+
+
+directory RDOCDIR.to_s
+CLOBBER.include( RDOCDIR )
+
+desc "Build API documentation in #{RDOCDIR}"
+task :rdoc => [ Rake.application.rakefile, *DOCFILES ] do
+	args = RDOC_OPTIONS 
+	args += [ '-o', RDOCDIR.to_s ]
+	args += [ '-f', 'darkfish' ] if $have_darkfish
+	args += DOCFILES.collect {|pn| pn.to_s }
+
+	trace "Building docs with arguments: %s" % [ args.join(' ') ]
+	RDoc::RDoc.new.document( args ) rescue nil
+end
+
+desc "Rebuild API documentation in #{RDOCDIR}"
+task :rerdoc do
+	rm_r( RDOCDIR ) if RDOCDIR.exist?
+	Rake::Task[ :rdoc ].invoke
 end
+

data/rake/svn.rb

@@ -1,15 +1,15 @@
 # 
 # Subversion Rake Tasks
-# $Id: svn.rb 25 2008-08-09 01:19:41Z deveiant $
+# $Id: svn.rb 86 2009-02-23 06:38:40Z deveiant $
 # 
 # Authors:
 # * Michael Granger <ged@FaerieMUD.org>
 # 
 
-
 require 'pp'
 require 'yaml'
 require 'date'
+require 'time'
 
 # Strftime format for tags/releases
 TAG_TIMESTAMP_FORMAT = '%Y%m%d-%H%M%S'
@@ -19,8 +19,15 @@ RELEASE_VERSION_PATTERN = /\d+\.\d+\.\d+/
 
 DEFAULT_EDITOR = 'vi'
 DEFAULT_KEYWORDS = %w[Date Rev Author URL Id]
-KEYWORDED_FILEDIRS = %w[applets bin etc lib misc]
-KEYWORDED_FILEPATTERN = /^(?:Rakefile|.*\.(?:rb|js|html|template))$/i
+KEYWORDED_FILEDIRS = %w[applets spec bin etc ext experiments examples lib misc docs]
+KEYWORDED_FILEPATTERN = /
+	^(?:
+		(?:meta)?rakefile.*									# Rakefiles
+		|
+		.*\.(?:rb|c|h|js|html|css|template|erb|page)		# Source file extensions
+		|
+		readme|install|todo
+	)$/ix
 
 COMMIT_MSG_FILE = 'commit-msg.txt'
 
@@ -50,6 +57,9 @@ def get_svn_info( dir='.' )
 	return {} unless File.directory?( File.join(dir, '.svn') )
 	info = IO.read( '|-' ) or exec 'svn', 'info', dir
 	return YAML.load( info ) # 'svn info' outputs valid YAML! Yay!
+rescue NotImplementedError
+	trace "No fork(), proceeding without svn info..."
+	return {}
 end
 
 
@@ -64,7 +74,7 @@ def get_svn_filelist( dir='.' )
 	# the additional complexity to make it handle that case. If we do need that, there's
 	# always the --xml output for 'svn st'...
 	return list.split( $/ ).
-		reject {|line| line =~ /^\?/ }.
+		reject {|line| line =~ /^(\?|(\s*|--- .*)$)/ }.
 		collect {|fn| Pathname(fn[/\S+$/]) }
 end
 
@@ -93,7 +103,10 @@ end
 
 
 ### Return the keywords for the specified array of +files+ as a Hash keyed by filename.
-def get_svn_keyword_map( files )
+def get_svn_keyword_map( *files )
+	files.flatten!
+	files.push( '.' ) if files.empty?
+
 	cmd = ['svn', 'pg', 'svn:keywords', *files]
 
 	# trace "Executing: svn pg svn:keywords " + files.join(' ')
@@ -160,6 +173,23 @@ def get_svn_diff( *targets )
 end
 
 
+### Get a subversion status as an Array of tuples of the form:
+###   [ <status>, <path> ]
+def get_svn_status( *targets )
+	targets << BASEDIR if targets.empty?
+	trace "Getting svn status for targets: %p" % [targets]
+	status = IO.read( '|-' ) or exec 'svn', 'st', '--ignore-externals', *(targets.flatten)
+	entries = status.split( /\n/ ).
+		select {|line| line !~ /^(\s*|--- .*)$/ }.
+		collect do |line|
+			flag, path = line.strip.split( /\s+/, 2 )
+			[ flag, Pathname.new(path) ]
+		end
+
+	return entries
+end
+
+
 ### Return the URL of the latest timestamp in the tags directory.
 def get_latest_release_tag
 	rooturl    = get_svn_repo_root()
@@ -280,15 +310,49 @@ end
 
 
 ### Returns a human-scannable file list by joining and truncating the list if it's too long.
-def humanize_file_list( list )
-	listtext = list[0..5].join( "\n#{FILE_INDENT}" )
+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 svn:ignore list.
+def svn_ignore_files( *pathnames )
+	pathnames.flatten!
+
+	map = pathnames.inject({}) do |map,path|
+		map[ path.dirname ] ||= []
+		map[ path.dirname ] << path.basename
+		map
+	end
+
+	trace "Ignoring %d files in %d directories." % [ pathnames.length, map.length ]
+
+	map.each do |dir, files|
+		trace "  %s: %p" % [ dir, files ]
+		io = open( '|-' ) or exec 'svn', 'pg', 'svn:ignore', dir
+		ignorelist = io.read.strip
+		ignorelist << "\n" << files.join("\n")
+		system 'svn', 'ps', 'svn:ignore', ignorelist, dir
+	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
+
 
 
 ###
@@ -315,27 +379,60 @@ namespace :svn do
 	end
 
 
+	desc "Copy the HEAD revision of the current #{SVN_TRUNK_DIR}/ to #{SVN_BRANCHES_DIR} with a " +
+	     "user-specified name."
+	task :branch, [:name] do |task, args|
+		unless args.name
+			args.name = prompt( "Branch name" ) or abort
+		end
+		
+		svninfo      = get_svn_info()
+		svntrunk     = Pathname.new( svninfo['Repository Root'] ) + SVN_TRUNK_DIR
+		svnbranchdir = Pathname.new( svninfo['Repository Root'] ) + SVN_BRANCHES_DIR
+		svnbranch    = svnbranchdir + args.name
+
+		desc = "Making a new branch: #{svnbranch}"
+		ask_for_confirmation( desc ) do
+			msg = prompt_with_default( "Commit log: ", "Making a '#{args.name}' branch" )
+			run 'svn', 'cp', '-m', msg, svntrunk, svnbranch
+			ask_for_confirmation( "Switch to the new branch?", false ) do
+				run 'svn', 'sw', svnbranch
+			end
+		end
+	end
+	
+
+	desc "Switch to the trunk if the working copy isn't there already."
+	task :trunk do
+		svninfo      = get_svn_info()
+		svntrunk     = Pathname.new( svninfo['Repository Root'] ) + SVN_TRUNK_DIR
+		
+		if svninfo['URL'] != svntrunk.to_s
+			log "Switching to #{svntrunk}"
+			run 'svn', 'sw', svntrunk
+		else
+			log "You are already on trunk (#{svntrunk})"
+		end
+	end
+	
+
 	desc "Copy the most recent tag to #{SVN_RELEASES_DIR}/#{PKG_VERSION}"
 	task :release do
 		last_tag    = get_latest_svn_timestamp_tag()
 		svninfo     = get_svn_info()
-		svnroot     = svninfo['Repository Root']
-		svntrunk    = svnroot + "/#{SVN_TRUNK_DIR}"
-		svnrel      = svnroot + "/#{SVN_RELEASES_DIR}"
+		svnroot     = Pathname.new( svninfo['Repository Root'] )
+		svntrunk    = svnroot + SVN_TRUNK_DIR
+		svnrel      = svnroot + SVN_RELEASES_DIR
 		release     = PKG_VERSION
-		svnrelease  = svnrel + '/' + release
+		svnrelease  = svnrel + release
 
-		topdirs = svn_ls( svnroot ).collect {|dir| dir.chomp('/') }
-		unless topdirs.include?( SVN_RELEASES_DIR )
-			trace "Top directories (%p) does not include %p" %
-				[ topdirs, SVN_RELEASES_DIR ]
+		unless svn_ls( svnrel.dirname ).include?( svnrel.basename.to_s + '/' )
 			log "Releases path #{svnrel} does not exist."
 			ask_for_confirmation( "To continue I'll need to create it." ) do
 				run 'svn', 'mkdir', svnrel, '-m', 'Creating releases/ directory'
 			end
 		else
-			trace "Found release dir #{SVN_RELEASES_DIR} in the top directories %p" %
-				[ topdirs ]
+			trace "Found release dir #{svnrel}"
 		end
 
 		releases = svn_ls( svnrel ).collect {|name| name.sub(%r{/$}, '') }
@@ -391,10 +488,48 @@ namespace :svn do
 	end
 
 
+	desc "Add/ignore any files that are unknown in the working copy"
+	task :newfiles do
+		log "Checking for new files..."
+		entries = get_svn_status()
+		
+		unless entries.empty?
+			files_to_add = []
+			files_to_ignore = []
+			files_to_delete = []
+
+			entries.find_all {|entry| entry[0] == '?'}.each do |entry|
+				action = prompt_with_default( "  #{entry[1]}: (a)dd, (i)gnore, (s)kip (d)elete", 's' )
+				case action
+				when 'a'
+					files_to_add << entry[1]
+				when 'i'
+					files_to_ignore << entry[1]
+				when 'd'
+					files_to_delete << entry[1]
+				end
+			end
+			
+			unless files_to_add.empty?
+				run 'svn', 'add', *files_to_add
+			end
+		
+			unless files_to_ignore.empty?
+				svn_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 in all the changes in your current working copy"
-	task :checkin => ['svn:update', 'test', 'svn:fix_keywords', COMMIT_MSG_FILE] do
+	task :checkin => ['svn:update', 'svn:newfiles', 'test', 'svn:fix_keywords', COMMIT_MSG_FILE] do
 		targets = get_target_args()
-		$deferr.puts '---', File.read( COMMIT_MSG_FILE ), '---'
+		$stderr.puts '---', File.read( COMMIT_MSG_FILE ), '---'
 		ask_for_confirmation( "Continue with checkin?" ) do
 			run 'svn', 'ci', '-F', COMMIT_MSG_FILE, targets
 			rm_f COMMIT_MSG_FILE
@@ -427,7 +562,7 @@ namespace :svn do
 		end
 		
 		unless files_needing_fixups.empty?
-			$deferr.puts "Files needing keyword fixes: ",
+			$stderr.puts "Files needing keyword fixes: ",
 				files_needing_fixups.collect {|f|
 					"  %s: %s" % [f, kwmap[f] ? kwmap[f].join(' ') : "(no keywords)"]
 				}
@@ -442,13 +577,19 @@ namespace :svn do
 	
 	task :debug_helpers do
 		methods = [
-			:make_new_tag,
+			:get_last_changed_rev,
+			:get_latest_release_tag,
+			:get_latest_svn_timestamp_tag,
+			:get_svn_diff,
+			:get_svn_filelist,
 			:get_svn_info,
+			:get_svn_keyword_map,
+			:get_svn_path,
 			:get_svn_repo_root,
+			:get_svn_rev,
+			:get_svn_status,
 			:get_svn_url,
-			:get_svn_path,
 			:svn_ls,
-			:get_latest_svn_timestamp_tag,
 		]
 		maxlen = methods.collect {|sym| sym.to_s.length }.max