class RDoc::Generator::Darkfish


OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
software without specific prior written permission.
contributors may be used to endorse or promote products derived from this
* Neither the name of the author/s, nor the names of the project’s
and/or other materials provided with the distribution.
this list of conditions and the following disclaimer in the documentation
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions of source code must retain the above copyright notice,
modification, are permitted provided that the following conditions are met:
Redistribution and use in source and binary forms, with or without
Copyright © 2007, 2008, Michael Granger. All rights reserved.
== License
* Eric Hodel (drbrain@segment7.net)
* Mahlon E. Smith (mahlon@martini.nu)
== Contributors
* Michael Granger (ged@FaerieMUD.org)
== Author/s
$Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $
Darkfish RDoc HTML Generator

def self::for( options )

## Standard generator factory method
def self::for( options )
	new( options )
end

def class_dir

def class_dir
	CLASS_DIR
end

def debug_msg( *msg )

## Output progress information if debugging is enabled
def debug_msg( *msg )
	return unless $DEBUG_RDOC
	$stderr.puts( *msg )
end

def file_dir

def file_dir
	FILE_DIR
end

def gen_sub_directories

## they don't already exist.
## Create the directories the generated docs will live in if
def gen_sub_directories
	@outputdir.mkpath
end

def generate( top_levels )

## the extracted information.
## based on an array of TopLevel objects containing
## Build the initial indices and output objects
def generate( top_levels )
	@outputdir = Pathname.new( @options.op_dir ).expand_path( @basedir )
	@files = top_levels.sort
	@classes = RDoc::TopLevel.all_classes_and_modules.sort
	@methods = @classes.map { |m| m.method_list }.flatten.sort
	@modsort = get_sorted_module_list( @classes )
	# Now actually write the output
	write_style_sheet
	generate_index
	generate_class_files
	generate_file_files
rescue StandardError => err
	debug_msg "%s: %s\n  %s" % [ err.class.name, err.message, err.backtrace.join("\n  ") ]
	raise
end

def generate_class_files

## Generate a documentation file for each class
def generate_class_files
	template_file = @template_dir + 'classpage.rhtml'
	return unless template_file.exist?
	debug_msg "Generating class documentation in #@outputdir"
	@classes.each do |klass|
		debug_msg "  working on %s (%s)" % [ klass.full_name, klass.path ]
		outfile    = @outputdir + klass.path
		rel_prefix = @outputdir.relative_path_from( outfile.dirname )
		svninfo    = self.get_svninfo( klass )
		debug_msg "  rendering #{outfile}"
		self.render_template( template_file, binding(), outfile )
	end
end

def generate_file_files

## Generate a documentation file for each file
def generate_file_files
	template_file = @template_dir + 'filepage.rhtml'
	return unless template_file.exist?
	debug_msg "Generating file documentation in #@outputdir"
	@files.each do |file|
		outfile     = @outputdir + file.path
		debug_msg "  working on %s (%s)" % [ file.full_name, outfile ]
		rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
		context     = binding()
		debug_msg "  rendering #{outfile}"
		self.render_template( template_file, binding(), outfile )
	end
end

def generate_index

## are documented.
## Generate an index page which lists all the classes which
def generate_index
	template_file = @template_dir + 'index.rhtml'
	return unless template_file.exist?
	debug_msg "Rendering the index page..."
	template_src = template_file.read
	template = ERB.new( template_src, nil, '<>' )
	template.filename = template_file.to_s
	context = binding()
	output = nil
	begin
		output = template.result( context )
	rescue NoMethodError => err
		raise RDoc::Error, "Error while evaluating %s: %s (at %p)" % [
			template_file,
			err.message,
			eval( "_erbout[-50,50]", context )
		], err.backtrace
	end
	outfile = @basedir + @options.op_dir + 'index.html'
	unless $DARKFISH_DRYRUN
		debug_msg "Outputting to %s" % [outfile.expand_path]
		outfile.open( 'w', 0644 ) do |fh|
			fh.print( output )
		end
	else
		debug_msg "Would have output to %s" % [outfile.expand_path]
	end
end

def get_sorted_module_list( classes )

## by name.
## Return a list of the documented modules sorted by salience first, then
def get_sorted_module_list( classes )
	nscounts = classes.inject({}) do |counthash, klass|
		top_level = klass.full_name.gsub( /::.*/, '' )
		counthash[top_level] ||= 0
		counthash[top_level] += 1
		counthash
	end
	# Sort based on how often the top level namespace occurs, and then on the
	# name of the module -- this works for projects that put their stuff into
	# a namespace, of course, but doesn't hurt if they don't.
	classes.sort_by do |klass|
		top_level = klass.full_name.gsub( /::.*/, '' )
		[
			nscounts[ top_level ] * -1,
			klass.full_name
		]
	end.select do |klass|
		klass.document_self
	end
end

def get_svninfo( klass )

## a subversion Id tag. If no matching constant is found, and empty hash is returned.
## Try to extract Subversion information out of the first constant whose value looks like
def get_svninfo( klass )
	constants = klass.constants or return {}
	constants.find {|c| c.value =~ SVNID_PATTERN } or return {}
	filename, rev, date, time, committer = $~.captures
	commitdate = Time.parse( date + ' ' + time )
	return {
		:filename    => filename,
		:rev         => Integer( rev ),
		:commitdate  => commitdate,
		:commitdelta => time_delta_string( Time.now.to_i - commitdate.to_i ),
		:committer   => committer,
	}
end

def initialize( options )

## Initialize a few instance variables before we start
def initialize( options )
	@options = options
	template = @options.template || 'darkfish'
	template_dir = $LOAD_PATH.map do |path|
		File.join File.expand_path(path), GENERATOR_DIR, 'template', template
	end.find do |dir|
		File.directory? dir
	end
	raise RDoc::Error, "could not find template #{template.inspect}" unless
		template_dir
	@template_dir = Pathname.new File.expand_path(template_dir)
	@files      = nil
	@classes    = nil
	@basedir = Pathname.pwd.expand_path
end

def render_template( template_file, context, outfile )

def render_template( template_file, context, outfile )
	template_src = template_file.read
	template = ERB.new( template_src, nil, '<>' )
	template.filename = template_file.to_s
	output = begin
						 template.result( context )
					 rescue NoMethodError => err
						 raise RDoc::Error, "Error while evaluating %s: %s (at %p)" % [
							 template_file.to_s,
							 err.message,
							 eval( "_erbout[-50,50]", context )
						 ], err.backtrace
					 end
	unless $DARKFISH_DRYRUN
		outfile.dirname.mkpath
		outfile.open( 'w', 0644 ) do |ofh|
			ofh.print( output )
		end
	else
		debug_msg "  would have written %d bytes to %s" %
		[ output.length, outfile ]
	end
end

def time_delta_string( seconds )

## seconds in terms a human can understand easily.
## Return a string describing the amount of time in the given number of
def time_delta_string( seconds )
	return 'less than a minute' if seconds < 1.minute
	return (seconds / 1.minute).to_s + ' minute' + (seconds/60 == 1 ? '' : 's') if seconds < 50.minutes
	return 'about one hour' if seconds < 90.minutes
	return (seconds / 1.hour).to_s + ' hours' if seconds < 18.hours
	return 'one day' if seconds < 1.day
	return 'about one day' if seconds < 2.days
	return (seconds / 1.day).to_s + ' days' if seconds < 1.week
	return 'about one week' if seconds < 2.week
	return (seconds / 1.week).to_s + ' weeks' if seconds < 3.months
	return (seconds / 1.month).to_s + ' months' if seconds < 1.year
	return (seconds / 1.year).to_s + ' years'
end

def write_style_sheet

## directory.
## Copy over the stylesheet into the appropriate place in the output
def write_style_sheet
	debug_msg "Copying static files"
	options = { :verbose => $DEBUG_RDOC, :noop => $DARKFISH_DRYRUN }
	FileUtils.cp @template_dir + 'rdoc.css', '.', options
	Dir[(@template_dir + "{js,images}/**/*").to_s].each do |path|
		next if File.directory? path
		next if path =~ /#{File::SEPARATOR}\./
		dst = Pathname.new(path).relative_path_from @template_dir
		# I suck at glob
		dst_dir = dst.dirname
		FileUtils.mkdir_p dst_dir, options unless File.exist? dst_dir
		FileUtils.cp @template_dir + path, dst, options
	end
end