darkfish-rdoc 1.1.1

data/rake/dependencies.rb

@@ -0,0 +1,62 @@
+# 
+# Dependency-checking and Installation Rake Tasks
+# $Id: dependencies.rb 10 2008-07-18 15:52:48Z deveiant $
+# 
+
+require 'rubygems/dependency_installer'
+require 'rubygems/source_index'
+require 'rubygems/requirement'
+require 'rubygems/doc_manager'
+
+### Install the specified +gems+ if they aren't already installed.
+def install_gems( *gems )
+	gems.flatten!
+	
+	defaults = Gem::DependencyInstaller::DEFAULT_OPTIONS.merge({
+		:generate_rdoc     => true,
+		:generate_ri       => true,
+		:install_dir       => Gem.dir,
+		:format_executable => false,
+		:test              => false,
+		:version           => Gem::Requirement.default,
+	  })
+    
+	# Check for root
+	if Process.euid != 0
+		$stderr.puts "This probably won't work, as you aren't root, but I'll try anyway"
+	end
+
+	gemindex = Gem::SourceIndex.from_installed_gems
+
+	gems.each do |gemname|
+		if (( specs = gemindex.search(gemname) )) && ! specs.empty?
+			log "Version %s of %s is already installed; skipping..." % 
+				[ specs.first.version, specs.first.name ]
+			next
+		end
+
+		rgv = Gem::Version.new( Gem::RubyGemsVersion )
+		installer = nil
+		
+		log "Trying to install #{gemname.inspect}..."
+		if rgv >= Gem::Version.new( '1.1.1' )
+			installer = Gem::DependencyInstaller.new
+			installer.install( gemname )
+		else
+			installer = Gem::DependencyInstaller.new( gemname )
+			installer.install
+		end
+
+		installer.installed_gems.each do |spec|
+			log "Installed: %s" % [ spec.full_name ]
+		end
+
+	end
+end
+
+
+### Task: install gems for development tasks
+task :install_dependencies do
+	install_gems( DEPENDENCIES.keys )
+end
+

data/rake/helpers.rb

@@ -0,0 +1,350 @@
+#####################################################################
+###	G L O B A L   H E L P E R   F U N C T I O N S
+#####################################################################
+
+require 'pathname'
+require 'readline'
+
+# Set some ANSI escape code constants (Shamelessly stolen from Perl's
+# Term::ANSIColor by Russ Allbery <rra@stanford.edu> and Zenin <zenin@best.com>
+ANSI_ATTRIBUTES = {
+	'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
+}
+
+
+MULTILINE_PROMPT = <<-'EOF'
+Enter one or more values for '%s'.
+A blank line finishes input.
+EOF
+
+
+CLEAR_TO_EOL       = "\e[K"
+CLEAR_CURRENT_LINE = "\e[2K"
+
+
+### Output a logging message
+def log( *msg )
+	output = colorize( msg.flatten.join(' '), 'cyan' )
+	$deferr.puts( output )
+end
+
+
+### Output a logging message if tracing is on
+def trace( *msg )
+	return unless $trace
+	output = colorize( msg.flatten.join(' '), 'yellow' )
+	$deferr.puts( output )
+end
+
+
+### Run the specified command +cmd+ with system(), failing if the execution
+### fails.
+def run( *cmd )
+	cmd.flatten!
+
+	log( cmd.collect {|part| part =~ /\s/ ? part.inspect : part} ) 
+	if $dryrun
+		$deferr.puts "(dry run mode)"
+	else
+		system( *cmd )
+		unless $?.success?
+			fail "Command failed: [%s]" % [cmd.join(' ')]
+		end
+	end
+end
+
+
+### Open a pipe to a process running the given +cmd+ and call the given block with it.
+def pipeto( *cmd )
+	$DEBUG = true
+
+	cmd.flatten!
+	log( "Opening a pipe to: ", cmd.collect {|part| part =~ /\s/ ? part.inspect : part} ) 
+	if $dryrun
+		$deferr.puts "(dry run mode)"
+	else
+		open( '|-', 'w+' ) do |io|
+		
+			# Parent
+			if io
+				yield( io )
+
+			# Child
+			else
+				exec( *cmd )
+				fail "Command failed: [%s]" % [cmd.join(' ')]
+			end
+		end
+	end
+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'
+
+	targetpath = Pathname.new( targetfile )
+
+	log "Downloading %s to %s" % [sourceuri, targetfile]
+	targetpath.open( File::WRONLY|File::TRUNC|File::CREAT, 0644 ) do |ofh|
+	
+		url = URI.parse( 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.parse( res['location'] )
+						log "...following redirection to: %s" % [ url ]
+						limit -= 1
+						sleep 0.2
+						next
+				
+					else
+						res.error!
+					end
+				end
+			end
+		end
+		
+	end
+	
+	return targetpath
+ensure
+	$defout.sync = oldsync
+end
+
+
+### Return the fully-qualified path to the specified +program+ in the PATH.
+def which( program )
+	ENV['PATH'].split(/:/).
+		collect {|dir| Pathname.new(dir) + program }.
+		find {|path| path.exist? && path.executable? }
+end
+
+
+### Create a string that contains the ANSI codes specified and return it
+def ansi_code( *attributes )
+	attributes.flatten!
+	attributes.collect! {|at| at.to_s }
+	# $deferr.puts "Returning ansicode for TERM = %p: %p" %
+	# 	[ ENV['TERM'], attributes ]
+	return '' unless /(?:vt10[03]|xterm(?:-color)?|linux|screen)/i =~ ENV['TERM']
+	attributes = ANSI_ATTRIBUTES.values_at( *attributes ).compact.join(';')
+
+	# $deferr.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, color reset, etc.
+def colorize( *args )
+	string = ''
+	
+	if block_given?
+		string = yield
+	else
+		string = args.shift
+	end
+	
+	ending = string[/(\s)$/] || ''
+	string = string.rstrip
+
+	return ansi_code( args.flatten ) + string + ansi_code( 'reset' ) + ending
+end
+
+
+### Output the specified <tt>msg</tt> as an ANSI-colored error message
+### (white on red).
+def error_message( msg, details='' )
+	$deferr.puts colorize( 'bold', 'white', 'on_red' ) { msg } + details
+end
+alias :error :error_message
+
+
+### Highlight and embed a prompt control character in the given +string+ and return it.
+def make_prompt_string( string )
+	return CLEAR_CURRENT_LINE + colorize( 'bold', 'green' ) { string + ' ' }
+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
+		prompt = make_prompt_string( prompt_string )
+		response = Readline.readline( prompt ) || ''
+		response.strip!
+		if block_given? && ! yield( response ) 
+			error_message( failure_msg + "\n\n" )
+			response = nil
+		end
+	end while response.nil?
+
+	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
+		default ||= '~'
+		response = prompt( "%s [%s]" % [ prompt_string, default ] )
+		response = default.to_s if !response.nil? && response.empty? 
+
+		trace "Validating reponse %p" % [ response ]
+
+		# the block is a validator.  We need to make sure that the user didn't
+		# enter '~', because if they did, it's nil and we should move on.  If
+		# they didn't, then call the block.
+		if block_given? && response != '~' && ! yield( response )
+			error_message( failure_msg + "\n\n" )
+			response = nil
+		end
+	end while response.nil?
+
+	return nil if response == '~'
+	return response
+end
+
+
+### Prompt for an array of values
+def prompt_for_multiple_values( label, default=nil )
+    $stderr.puts( MULTILINE_PROMPT % [label] )
+    if default
+		$stderr.puts "Enter a single blank line to keep the default:\n  %p" % [ default ]
+	end
+
+    results = []
+    result = nil
+    
+    begin
+        result = Readline.readline( make_prompt_string("> ") )
+		if result.nil? || result.empty?
+			results << default if default && results.empty?
+		else
+        	results << result 
+		end
+    end until result.nil? || result.empty?
+    
+    return results.flatten
+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 line-by-line in the specified +file+ 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_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
+			break
+		end
+	end
+
+	return rval
+end
+
+
+### Get a list of the file or files to run rspec on.
+def rspec_files
+	if ENV['class']
+		classname = ENV['class']
+		spec_file = SPECSDIR + "#{classname}_spec.rb"
+		raise "Can't find the spec file for the class '#{classname}'" unless spec_file.exist?
+		return [ spec_file ]
+	else
+		return SPEC_FILES
+	end
+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?
+		fail "Editor exited uncleanly."
+	end
+end
+
+
+### Extract all the non Rake-target arguments from ARGV and return them.
+def get_target_args
+	args = ARGV.reject {|arg| Rake::Task.task_defined?(arg) }
+	return args
+end
+
+
+

data/rake/manual.rb

@@ -0,0 +1,384 @@
+# 
+# Manual-generation Rake tasks and classes
+# $Id: manual.rb 10 2008-07-18 15:52:48Z deveiant $
+# 
+# Author: Michael Granger <ged@FaerieMUD.org>
+# 
+# This was born out of a frustration with other static HTML generation modules
+# and systems. I've tried webby, webgen, rote, staticweb, staticmatic, and
+# nanoc, but I didn't find any of them really suitable (except rote, which was
+# excellent but apparently isn't maintained and has a fundamental
+# incompatibilty with Rake because of some questionable monkeypatching.)
+# 
+# So, since nothing seemed to scratch my itch, I'm going to scratch it myself.
+# 
+
+require 'pathname'
+require 'singleton'
+require 'rake/tasklib'
+require 'erb'
+
+
+### Namespace for Manual-generation classes
+module Manual
+
+	### Manual page-generation class
+	class Page
+
+		### An abstract filter class for manual content transformation.
+		class Filter
+			include Singleton
+
+			# A list of inheriting classes, keyed by normalized name
+			@derivatives = {}
+			class << self; attr_reader :derivatives; end
+
+			### Inheritance callback -- keep track of all inheriting classes for
+			### later.
+			def self::inherited( subclass )
+				key = subclass.name.
+					sub( /^.*::/, '' ).
+					gsub( /[^[:alpha:]]+/, '_' ).
+					downcase.
+					sub( /filter$/, '' )
+
+				self.derivatives[ key ] = subclass
+				self.derivatives[ key.to_sym ] = subclass
+
+				super
+			end
+
+
+			### Process the +page+'s source with the filter and return the altered content.
+			def process( source, page, metadata )
+				raise NotImplementedError,
+					"%s does not implement the #process method" % [ self.class.name ]
+			end
+		end
+
+
+		### The default page configuration if none is specified.
+		DEFAULT_CONFIG = {
+			'filters' => [ 'textile', 'erb' ],
+			'layout'  => 'default.page',
+		  }.freeze
+
+		# Pattern to match a source page with a YAML header
+		PAGE_WITH_YAML_HEADER = /
+			\A---\s*$	# It should should start with three hyphens
+			(.*?)		# ...have some YAML stuff
+			^---\s*$	# then have another three-hyphen line,
+			(.*)\Z		# then the rest of the document
+		  /xm
+
+		# Options to pass to libtidy
+		TIDY_OPTIONS = {
+			:show_warnings     => true,
+			:indent            => false,
+			:indent_attributes => false,
+			:indent_spaces     => 4,
+			:vertical_space    => true,
+			:tab_size          => 4,
+			:wrap_attributes   => true,
+			:wrap              => 100,
+		  }
+
+
+		### Create a new page-generator for the given +sourcefile+, which will use
+		### ones of the templates in +layouts_dir+ as a wrapper.
+		def initialize( sourcefile, layouts_dir )
+			@sourcefile = Pathname.new( sourcefile )
+			@layouts_dir = Pathname.new( layouts_dir )
+
+			rawsource = @sourcefile.read
+			@config, @source = self.read_page_config( rawsource )
+			# $stderr.puts "Config is: %p" % [@config],
+			# 	"Source is: %p" % [ @source[0,100] ]
+			@filters = self.load_filters( @config['filters'] )
+
+			super()
+		end
+
+
+		######
+		public
+		######
+		
+		# 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 )
+			content = self.generate_content( @source, metadata )
+
+			# :TODO: Read config from page for layout, filters, etc.
+			templatepath = @layouts_dir + 'default.page'
+			template = ERB.new( templatepath.read )
+			page = self
+
+			html = template.result( binding() )
+
+			# return self.cleanup( html )
+			return html
+		end
+
+
+		### Run the various filters on the given input and return the transformed
+		### content.
+		def generate_content( input, metadata )
+			return @filters.inject( input ) do |source, filter|
+				filter.process( source, self, metadata )
+			end
+		end
+
+
+		### Trim the YAML header from the provided page +source+, convert it to
+		### a Ruby object, and return it.
+		def read_page_config( source )
+			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 )
+			require 'tidy'
+
+			Tidy.path = '/usr/lib/libtidy.dylib'
+			Tidy.open( TIDY_OPTIONS ) do |tidy|
+				tidy.options.output_xhtml = true
+
+				xml = tidy.clean( source )
+				puts tidy.errors
+				puts tidy.diagnostics
+				return xml
+			end
+		rescue LoadError => err
+			trace "No cleanup: " + err.message
+			return source
+		end
+		
+
+		### Get (singleton) instances of the filters named in +filterlist+ and return them.
+		def load_filters( filterlist )
+			filterlist.flatten.collect do |key|
+				raise ArgumentError, "filter '#{key}' is not loaded" unless
+					Manual::Page::Filter.derivatives.key?( key )
+				Manual::Page::Filter.derivatives[ key ].instance
+			end
+		end
+
+	end
+
+
+	### A Textile filter for the manual generation tasklib, implemented using RedCloth.
+	class TextileFilter < Manual::Page::Filter
+
+		### Load RedCloth when the filter is first created
+		def initialize( *args )
+			require 'redcloth'
+			super
+		end
+		
+
+		### Process the given +source+ as Textile and return the resulting HTML
+		### fragment.
+		def process( source, *ignored )
+			return RedCloth.new( source ).to_html
+		end
+
+	end
+
+
+	### An ERB filter for the manual generation tasklib, implemented using Erubis.
+	class ErbFilter < Manual::Page::Filter
+
+		### Process the given +source+ as ERB and return the resulting HTML
+		### fragment.
+		def process( source, page, metadata )
+			template_name = page.sourcefile.basename
+			template = ERB.new( source )
+			return template.result( binding() )
+		end
+
+	end
+
+
+	### Manual generation task library
+	class GenTask < Rake::TaskLib
+		
+		# Default values for task config variables
+		DEFAULT_NAME         = :manual
+		DEFAULT_BASE_DIR     = Pathname.new( 'docs/manual' )
+		DEFAULT_SOURCE_DIR   = 'source'
+		DEFAULT_LAYOUTS_DIR  = 'layouts'
+		DEFAULT_OUTPUT_DIR   = 'output'
+		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 )
+			@name           = name
+
+			@source_dir		= DEFAULT_SOURCE_DIR
+			@layouts_dir	= DEFAULT_LAYOUTS_DIR
+			@output_dir		= DEFAULT_OUTPUT_DIR
+			@resource_dir	= DEFAULT_RESOURCE_DIR
+			@lib_dir	    = DEFAULT_LIB_DIR
+			@metadata		= DEFAULT_METADATA
+			
+			yield( self ) if block_given?
+			
+			self.define
+		end
+		
+		
+		######
+		public
+		######
+
+		attr_accessor :base_dir,
+			:source_dir,
+			:layouts_dir,
+			:output_dir,
+			:resource_dir,
+			:lib_dir,
+			:metadata
+
+		attr_reader :name
+
+		### Load the filter libraries provided in the given +libdir+
+		def load_filter_libraries( libdir )
+			Pathname.glob( libdir + '*.rb' ) do |filterlib|
+				trace "  loading filter library #{filterlib}"
+				require( filterlib )
+			end
+		end
+
+
+		### Set up the main HTML-generation task that will convert files in the given +sourcedir+ to
+		### HTML in the +outputdir+
+		def setup_page_conversion_tasks( sourcedir, outputdir, layoutsdir )
+			source_glob = sourcedir + '**/*.page'
+			trace "Looking for sources that match: %s" % [ source_glob ]
+
+			# Find the list of source .page files
+			manual_sources = FileList[ source_glob ]
+			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 )
+			trace "Mapping sources like so: \n  %p -> %p" %
+				[ manual_sources.first, manual_pages.first ]
+
+			# Output directory task
+			directory( outputdir.to_s )
+			file outputdir.to_s do
+				touch outputdir + '.buildtime'
+			end
+
+			# Rule to generate .html files from .page files
+			rule( 
+				%r{#{outputdir}/.*\.html$} => [
+					proc {|name| name.sub(/\.[^.]+$/, '.page').sub( outputdir, sourcedir) },
+					outputdir.to_s
+			 	]) do |task|
+			
+				source = Pathname.new( task.source ).relative_path_from( Pathname.getwd )
+				target = Pathname.new( task.name ).relative_path_from( Pathname.getwd )
+				log "  #{ source } -> #{ target }"
+					
+				page = Manual::Page.new( source, layoutsdir )
+					
+				target.dirname.mkpath
+				target.open( File::WRONLY|File::CREAT|File::TRUNC ) do |io|
+					io.write( page.generate(metadata) )
+				end
+			end
+			
+			return manual_pages
+		end
+		
+		
+		### Set up a rule for copying files from the resources directory to the output dir.
+		def setup_resource_copy_tasks( resourcedir, outputdir )
+			
+			task :copy_resources => [ outputdir.to_s ] do
+				when_writing( "Copying resources" ) do
+					verbose do
+						files = FileList[ resourcedir + '*' ]
+						files.exclude( /\.svn/ )
+						unless files.empty?
+							trace "  Copying resource files: #{files}"
+							cp_r files, outputdir, :verbose => true
+						end
+					end
+				end
+			end
+		end
+		
+
+		### Set up the tasks for building the manual
+		def define
+
+			# Set up a description if the caller hasn't already defined one
+			unless Rake.application.last_comment
+				desc "Generate the manual"
+			end
+
+			# Make Pathnames of the directories relative to the base_dir
+			basedir     = Pathname.new( @base_dir )
+			sourcedir   = basedir + @source_dir
+			layoutsdir  = basedir + @layouts_dir
+			outputdir   = basedir + @output_dir
+			resourcedir = basedir + @resource_dir
+			libdir      = basedir + @lib_dir
+
+			load_filter_libraries( libdir )
+
+			# Declare the tasks outside the namespace that point in
+			task @name => "#@name:build"
+			task "clobber_#@name" => "#@name:clobber"
+
+			namespace( self.name ) do
+				setup_resource_copy_tasks( resourcedir, outputdir )
+				manual_pages = setup_page_conversion_tasks( sourcedir, outputdir, layoutsdir )
+				
+				task :build => [ :copy_resources, *manual_pages ]
+				
+				task :clobber do
+					RakeFileUtils.verbose( $verbose ) do
+						rm_f manual_pages.to_a
+					end
+					remove_dir( outputdir ) if ( outputdir + '.buildtime' ).exist?
+				end
+				task :rebuild => [ :clobber, :build ]
+	        end
+
+		end # def define
+		
+	end # class Manual::GenTask
+	
+end