linkparser 1.0.4 → 1.1.0

data/rake/hg.rb

@@ -0,0 +1,318 @@
+# 
+# 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
+		require './helpers.rb' unless defined?( RakefileHelpers )
+		include RakefileHelpers
+
+		###############
+		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 not of status 'clean'
+		def get_uncommitted_files
+			list = read_command_output( 'hg', 'status', '-n', '--color', 'never' )
+			list = list.split( /\n/ )
+
+			trace "Changed files: %p" % [ list ]
+			return list
+		end
+
+		### Return the list of files which are of status 'unknown'
+		def get_unknown_files
+			list = read_command_output( 'hg', 'status', '-un', '--color', 'never' )
+			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
+			uncommitted_files = get_uncommitted_files()
+			unless uncommitted_files.empty?
+				log "Uncommitted files:\n",
+				    *uncommitted_files.map {|fn| "  #{fn}\n" }
+				ask_for_confirmation( "\nRelease anyway?", true ) do
+					log "Okay, releasing with uncommitted versions."
+				end
+			end
+
+			tags = get_tags()
+			rev = get_current_rev()
+			pkg_version_tag = "v#{PKG_VERSION}"
+
+			# Look for a tag for the current release version, and if it exists abort
+			if tags.include?( pkg_version_tag )
+				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_tag}"
+			run 'hg', 'tag', pkg_version_tag
+
+			# 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 "Pull and update from the default repo"
+		task :pull do
+			paths = get_repo_paths()
+			if origin_url = paths['default']
+				ask_for_confirmation( "Pull and update from '#{origin_url}'?", false ) do
+					Rake::Task['hg:pull_without_confirmation'].invoke
+				end
+			else
+				trace "Skipping pull: No 'default' path."
+			end
+		end
+
+
+		desc "Pull and update without confirmation"
+		task :pull_without_confirmation do
+			run 'hg', 'pull', '-u'
+		end
+
+
+		desc "Update to tip"
+		task :update do
+			run 'hg', 'update'
+		end
+
+
+		desc "Clobber all changes (hg up -C)"
+		task :update_and_clobber do
+			run 'hg', 'update', '-C'
+		end
+
+
+		desc "Check the current code in if tests pass"
+		task :checkin => ['hg:pull', '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
+					Rake::Task['hg:push_without_confirmation'].invoke
+				end
+			else
+				trace "Skipping push: No 'default' path."
+			end
+		end
+
+		desc "Push to the default repo without confirmation"
+		task :push_without_confirmation do
+			run 'hg', 'push'
+		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
+
+

data/rake/manual.rb

@@ -1,6 +1,6 @@
 # 
 # Manual-generation Rake tasks and classes
-# $Id: manual.rb 95 2009-04-02 15:21:01Z deveiant $
+
 # 
 # Authors:
 # * Michael Granger <ged@FaerieMUD.org>
@@ -55,7 +55,7 @@ module Manual
 			def export_resources( output_dir )
 				# No-op by default
 			end
-			
+
 
 			### Process the +page+'s source with the filter and return the altered content.
 			def process( source, page, metadata )
@@ -69,7 +69,7 @@ module Manual
 		DEFAULT_CONFIG = {
 			'filters' => [ 'erb', 'links', 'textile' ],
 			'layout'  => 'default.page',
-			'cleanup' => true,
+			'cleanup' => false,
 		  }.freeze
 
 		# Pattern to match a source page with a YAML header
@@ -118,28 +118,28 @@ module Manual
 		######
 		public
 		######
-		
+
 		# The Manual::PageCatalog to which the page belongs
 		attr_reader :catalog
-		
+
 		# The relative path to the base directory, for prepending to page paths
 		attr_reader :basepath
-		
+
 		# The Pathname object that specifys the page source file
 		attr_reader :sourcefile
-		
+
 		# The configured layouts directory as a Pathname object.
 		attr_reader :layouts_dir
-		
+
 		# The page configuration, as read from its YAML header
 		attr_reader :config
-		
+
 		# The raw source of the page
 		attr_reader :source
-		
+
 		# The filters the page will use to render itself
 		attr_reader :filters
-		
+
 
 		### Generate HTML output from the page and return it.
 		def generate( metadata )
@@ -147,16 +147,21 @@ module Manual
 
 			layout = self.config['layout'].sub( /\.page$/, '' )
 			templatepath = @layouts_dir + "#{layout}.page"
-			template = ERB.new( templatepath.read )
-			page = self
+			template = nil
+			if Object.const_defined?( :Encoding )
+				template = ERB.new( templatepath.read(:encoding => 'UTF-8') )
+			else
+				template = ERB.new( templatepath.read )
+			end
 
+			page = self
 			html = template.result( binding() )
 
 			# Use Tidy to clean up the html if 'cleanup' is turned on, but remove the Tidy
 			# meta-generator propaganda/advertising.
 			html = self.cleanup( html ).sub( %r:<meta name="generator"[^>]*tidy[^>]*/>:im, '' ) if
 				self.config['cleanup']
-				
+
 			return html
 		end
 
@@ -165,8 +170,8 @@ module Manual
 		def title
 			return self.config['title'] || self.sourcefile.basename
 		end
-		
-		
+
+
 		### Run the various filters on the given input and return the transformed
 		### content.
 		def generate_content( input, metadata )
@@ -182,13 +187,13 @@ module Manual
 			unless source =~ PAGE_WITH_YAML_HEADER
 				return DEFAULT_CONFIG.dup, source
 			end
-			
+
 			pageconfig = YAML.load( $1 )
 			source = $2
-			
+
 			return DEFAULT_CONFIG.merge( pageconfig ), source
 		end
-		
+
 
 		### Clean up and return the given HTML +source+.
 		def cleanup( source )
@@ -208,7 +213,7 @@ module Manual
 			trace "No cleanup: " + err.message
 			return source
 		end
-		
+
 
 		### Get (singleton) instances of the filters named in +filterlist+ and return them.
 		def load_filters( filterlist )
@@ -230,7 +235,7 @@ module Manual
 					items << %Q{<div class="section">}
 					items << %Q{<h2><a href="#{self.basepath + path}/">#{title}</a></h2>}
 					items << '<ul class="index-section">'
-					
+
 				when :current_section
 					items << %Q{<div class="section current-section">}
 					items << %Q{<h2><a href="#{self.basepath + path}/">#{title}</a></h2>}
@@ -267,44 +272,44 @@ module Manual
 		def initialize( sourcedir, layoutsdir )			
 			@sourcedir = sourcedir
 			@layoutsdir = layoutsdir
-			
+
 			@pages       = []
 			@path_index  = {}
 			@uri_index   = {}
 			@title_index = {}
 			@hierarchy   = {}
-			
+
 			self.find_and_load_pages
 		end
-		
-		
+
+
 		######
 		public
 		######
 
 		# An index of the pages in the catalog by Pathname
 		attr_reader :path_index
-		
+
 		# An index of the pages in the catalog by title
 		attr_reader :title_index
-		
+
 		# An index of the pages in the catalog by the URI of their source relative to the source 
 		# directory
 		attr_reader :uri_index
-		
+
 		# The hierarchy of pages in the catalog, suitable for generating an on-page index
 		attr_reader :hierarchy
-		
+
 		# An Array of all Manual::Page objects found
 		attr_reader :pages
 
 		# The Pathname location of the .page files.
 		attr_reader :sourcedir
-		
+
 		# The Pathname location of look and feel templates.
 		attr_reader :layoutsdir
 
-		
+
 		### Traverse the catalog's #hierarchy, yielding to the given +builder+
 		### block for each entry, as well as each time a sub-hash is entered or
 		### exited, setting the +type+ appropriately. Valid values for +type+ are:
@@ -361,7 +366,7 @@ module Manual
 						trace "Using the path for the sort of directory %p" % [ subpath ]
 						subpath.to_s
 					end
-					
+
 				# Page
 				else
 					if subpath == INDEX_PATH
@@ -376,7 +381,7 @@ module Manual
 
 			end # sort_by
 		end
-		
+
 
 		INDEX_PATH = Pathname.new('index')
 
@@ -386,7 +391,7 @@ module Manual
 			from_current = false
 			trace "Section handler: path=%p, section keys=%p, from=%s" %
 				[ path, section.keys, from.sourcefile ]
-			
+
 			# Call the callback with :section -- determine the section title from
 			# the 'index.page' file underneath it, or the directory name if no 
 			# index.page exists.
@@ -401,10 +406,10 @@ module Manual
 				title = File.dirname( path ).gsub( /_/, ' ' )
 				builder.call( :section, title, path )
 			end
-			
+
 			# Recurse
 			self.traverse_hierarchy( path, section, from, &builder )
-			
+
 			# Call the callback with :section_end
 			if from_current
 				builder.call( :current_section_end, '', path )
@@ -412,8 +417,8 @@ module Manual
 				builder.call( :section_end, '', path )
 			end
 		end
-		
-		
+
+
 		### Yield the specified +page+ to the builder
 		def handle_page_callback( path, page, from=nil )
 			if from == page
@@ -422,10 +427,10 @@ module Manual
 				yield( :entry, page.title, path )
 			end
 		end
-		
+
 
 		### Find and store
-		
+
 		### Find all .page files under the configured +sourcedir+ and create a new
 		### Manual::Page object for each one.
 		def find_and_load_pages
@@ -439,7 +444,7 @@ module Manual
 				@path_index[ pagefile ]     = page
 				@title_index[ page.title ]  = page
 				@uri_index[ hierpath.to_s ] = page
-				
+
 				# Place the page in the page hierarchy by using inject to find and/or create the 
 				# necessary subhashes. The last run of inject will return the leaf hash in which
 				# the page will live
@@ -451,7 +456,7 @@ module Manual
 				section[ pagefile.basename('.page') ] = page
 			end
 		end
-		
+
 	end
 
 
@@ -463,7 +468,7 @@ module Manual
 			require 'redcloth'
 			super
 		end
-		
+
 
 		### Process the given +source+ as Textile and return the resulting HTML
 		### fragment.
@@ -493,7 +498,7 @@ module Manual
 
 	### Manual generation task library
 	class GenTask < Rake::TaskLib
-		
+
 		# Default values for task config variables
 		DEFAULT_NAME         = :manual
 		DEFAULT_BASE_DIR     = Pathname.new( 'docs/manual' )
@@ -503,7 +508,7 @@ module Manual
 		DEFAULT_RESOURCE_DIR = 'resources'
 		DEFAULT_LIB_DIR      = 'lib'
 		DEFAULT_METADATA     = OpenStruct.new
-		
+
 
 		### Define a new manual-generation task with the given +name+.
 		def initialize( name=:manual )
@@ -515,13 +520,13 @@ module Manual
 			@resource_dir	= DEFAULT_RESOURCE_DIR
 			@lib_dir	    = DEFAULT_LIB_DIR
 			@metadata		= DEFAULT_METADATA
-			
+
 			yield( self ) if block_given?
-			
+
 			self.define
 		end
-		
-		
+
+
 		######
 		public
 		######
@@ -555,7 +560,7 @@ module Manual
 
 			load_filter_libraries( libdir )
 			catalog = Manual::PageCatalog.new( sourcedir, layoutsdir )
-			
+
 			# Declare the tasks outside the namespace that point in
 			task @name => "#@name:build"
 			task "clobber_#@name" => "#@name:clobber"
@@ -563,20 +568,20 @@ module Manual
 			namespace( self.name ) do
 				setup_resource_copy_tasks( resourcedir, outputdir )
 				manual_pages = setup_page_conversion_tasks( sourcedir, outputdir, catalog )
-				
+
 				desc "Build the manual"
-				task :build => [ :rdoc, :copy_resources, :copy_apidocs, :generate_pages ]
-				
+				task :build => [ :apidocs, :copy_resources, :copy_apidocs, :generate_pages ]
+
 				task :clobber do
 					RakeFileUtils.verbose( $verbose ) do
 						rm_f manual_pages.to_a
 					end
 					remove_dir( outputdir ) if ( outputdir + '.buildtime' ).exist?
 				end
-				
+
 				desc "Remove any previously-generated parts of the manual and rebuild it"
 				task :rebuild => [ :clobber, self.name ]
-				
+
 				desc "Watch for changes to the source files and rebuild when they change"
 				task :autobuild do
 					scope = [ self.name ]
@@ -598,8 +603,8 @@ module Manual
 	        end
 
 		end # def define
-		
-		
+
+
 		### Load the filter libraries provided in the given +libdir+
 		def load_filter_libraries( libdir )
 			Pathname.glob( libdir + '*.rb' ) do |filterlib|
@@ -617,7 +622,7 @@ module Manual
 			# dependency that causes the rule to be fired for each one when the task is invoked.
 			manual_sources = FileList[ catalog.path_index.keys.map {|pn| pn.to_s} ]
 			trace "   found %d source files" % [ manual_sources.length ]
-			
+
 			# Map .page files to their equivalent .html output
 			html_pathmap = "%%{%s,%s}X.html" % [ sourcedir, outputdir ]
 			manual_pages = manual_sources.pathmap( html_pathmap )
@@ -636,33 +641,33 @@ module Manual
 					proc {|name| name.sub(/\.[^.]+$/, '.page').sub( outputdir, sourcedir) },
 					outputdir.to_s
 			 	]) do |task|
-			
+
 				source = Pathname.new( task.source )
 				target = Pathname.new( task.name )
 				log "  #{ source } -> #{ target }"
-					
+
 				page = catalog.path_index[ source ]
 				#trace "  page object is: %p" % [ page ]
-					
+
 				target.dirname.mkpath
 				target.open( File::WRONLY|File::CREAT|File::TRUNC ) do |io|
 					io.write( page.generate(metadata) )
 				end
 			end
-			
+
 			# Group all the manual page output files targets into a containing task
 			desc "Generate any pages of the manual that have changed"
 			task :generate_pages => manual_pages
 			return manual_pages
 		end
-		
-		
+
+
 		### Copy method for resources -- passed as a block to the various file tasks that copy
 		### resources to the output directory.
 		def copy_resource( task )
 			source = task.prerequisites[ 1 ]
 			target = task.name
-			
+
 			when_writing do
 				trace "  #{source} -> #{target}"
 				mkpath File.dirname( target ), :verbose => $trace unless
@@ -670,24 +675,24 @@ module Manual
 				install source, target, :mode => 0644, :verbose => $trace
 			end
 		end
-			
-		
+
+
 		### Set up a rule for copying files from the resources directory to the output dir.
 		def setup_resource_copy_tasks( resourcedir, outputdir )
-			resources = FileList[ resourcedir + '**/*.{js,css,png,gif,jpg,html}' ]
+			resources = FileList[ resourcedir + '**/*.{js,css,png,gif,jpg,html,svg,svgz,swf}' ]
 			resources.exclude( /\.svn/ )
 			target_pathmap = "%%{%s,%s}p" % [ resourcedir, outputdir ]
 			targets = resources.pathmap( target_pathmap )
 			copier = self.method( :copy_resource ).to_proc
-			
+
 			# Create a file task to copy each file to the output directory
 			resources.each_with_index do |resource, i|
 				file( targets[i] => [ outputdir.to_s, resource ], &copier )
 			end
 
 			desc "Copy API documentation to the manual output directory"
-			task :copy_apidocs => :rdoc do
-				cp_r( RDOCDIR, outputdir )
+			task :copy_apidocs => :apidocs do
+				cp_r( API_DOCSDIR, outputdir )
 			end
 
 			# Now group all the resource file tasks into a containing task
@@ -696,9 +701,9 @@ module Manual
 				log "Copying manual resources"
 			end
 		end
-		
+
 	end # class Manual::GenTask
-	
+
 end
 
 
@@ -707,13 +712,13 @@ end
 if MANUALDIR.exist?
 	MANUALOUTPUTDIR = MANUALDIR + 'output'
 	trace "Manual will be generated in: #{MANUALOUTPUTDIR}"
-	
+
 	begin
 		directory MANUALOUTPUTDIR.to_s
 
 		Manual::GenTask.new do |manual|
 			manual.metadata.version = PKG_VERSION
-			manual.metadata.api_dir = RDOCDIR
+			manual.metadata.api_dir = API_DOCSDIR
 			manual.output_dir = MANUALOUTPUTDIR
 			manual.base_dir = MANUALDIR
 			manual.source_dir = 'src'
@@ -740,14 +745,14 @@ else
 			log "No manual directory (#{MANUALDIR}) currently exists."
 			ask_for_confirmation( "Create a new manual directory tree from a template?" ) do
 				MANUALDIR.mkpath
-				
+
 				%w[layouts lib output resources src].each do |dir|
 					FileUtils.mkpath( MANUALDIR + dir, :mode => 0755, :verbose => true, :noop => $dryrun )
 				end
-				
+
 				Pathname.glob( TEMPLATEDIR + '**/*.{rb,css,png,js,erb,page}' ).each do |tmplfile|
 					trace "extname is: #{tmplfile.extname}"
-					
+
 					# Render ERB files
 					if tmplfile.extname == '.erb'
 						rname = tmplfile.basename( '.erb' )
@@ -762,7 +767,7 @@ else
 						target.open( File::WRONLY|File::CREAT|File::EXCL, 0644 ) do |fh|
 							fh.print( html )
 						end
-					
+
 					# Just copy anything else
 					else
 						target = MANUALDIR + tmplfile.relative_path_from( TEMPLATEDIR )