class RDoc::Generator::Darkfish

$Id: darkfish.rb 52 2009年01月07日 02:08:11Z deveiant $

Author/s¶ ↑

Michael Granger (ged@FaerieMUD.org)

Contributors¶ ↑

Mahlon E. Smith (mahlon@martini.nu)
Eric Hodel (drbrain@segment7.net)

License¶ ↑

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the author/s, nor the names of the project's contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Attributions¶ ↑

Darkfish uses the Silk Icons set by Mark James.

Constants

DESCRIPTION: Description of this generator
GENERATOR_DIR: Path to this file's parent directory. Used to find templates and other resources.
SVNID_PATTERN: %q$Id: darkfish.rb 52 2009年01月07日 02:08:11Z deveiant $"
VERSION: Release Version

Attributes

asset_rel_path[RW]

The relative path to style sheets and javascript. By default this is set the same as the rel_prefix.

base_dir[R]

The path to generate files into, combined with --op from the options for a full path.

classes[R]

Classes and modules to be used by this generator, not necessarily displayed. See also modsort

dry_run[RW]

No files will be written when #dry_run is true.

file_output[RW]

When false the generate methods return a String instead of writing to a file. The default is true.

files[R]

Files to be displayed by this generator

json_index[R]

The JSON index generator for this Darkfish generator

methods[R]

Methods to be displayed by this generator

modsort[R]

Sorted list of classes and modules to be displayed by this generator

outputdir[R]

The output directory

store[R]

The RDoc::Store that is the source of the generated content

Public Class Methods

new(store, options) click to toggle source

Initialize a few instance variables before we start

# File lib/rdoc/generator/darkfish.rb, line 157
def initialize store, options
 @store = store
 @options = options
 @asset_rel_path = ''
 @base_dir = Pathname.pwd.expand_path
 @dry_run = @options.dry_run
 @file_output = true
 @template_dir = Pathname.new options.template_dir
 @template_cache = {}
 @classes = nil
 @context = nil
 @files = nil
 @methods = nil
 @modsort = nil
 @json_index = RDoc::Generator::JsonIndex.new self, options
end

Public Instance Methods

assemble_template(body_file) click to toggle source

Creates a template from its components and the body_file.

For backwards compatibility, if body_file contains "<html" the body is used directly.

# File lib/rdoc/generator/darkfish.rb, line 645
 def assemble_template body_file
 body = body_file.read
 return body if body =~ /<html/
 head_file = @template_dir + '_head.rhtml'
 footer_file = @template_dir + '_footer.rhtml'
 <<-TEMPLATE
<!DOCTYPE html>
<html>
<head>
#{head_file.read}
#{body}
#{footer_file.read}
 TEMPLATE
 end

class_dir() click to toggle source

Directory where generated class HTML files live relative to the output dir.

# File lib/rdoc/generator/darkfish.rb, line 189
def class_dir
 nil
end

copy_static() click to toggle source

Copies static files from the static_path into the output directory

# File lib/rdoc/generator/darkfish.rb, line 262
def copy_static
 return if @options.static_path.empty?
 fu_options = { :verbose => $DEBUG_RDOC, :noop => @dry_run }
 @options.static_path.each do |path|
 unless File.directory? path then
 FileUtils.install path, @outputdir, fu_options.merge(:mode => 0644)
 next
 end
 Dir.chdir path do
 Dir[File.join('**', '*')].each do |entry|
 dest_file = @outputdir + entry
 if File.directory? entry then
 FileUtils.mkdir_p entry, fu_options
 else
 FileUtils.install entry, dest_file, fu_options.merge(:mode => 0644)
 end
 end
 end
 end
end

debug_msg(*msg) click to toggle source

Output progress information if debugging is enabled

# File lib/rdoc/generator/darkfish.rb, line 180
def debug_msg *msg
 return unless $DEBUG_RDOC
 $stderr.puts(*msg)
end

file_dir() click to toggle source

Directory where generated class HTML files live relative to the output dir.

# File lib/rdoc/generator/darkfish.rb, line 197
def file_dir
 nil
end

gen_sub_directories() click to toggle source

Create the directories the generated docs will live in if they don't already exist.

# File lib/rdoc/generator/darkfish.rb, line 205
def gen_sub_directories
 @outputdir.mkpath
end

generate() click to toggle source

Build the initial indices and output objects based on an array of TopLevel objects containing the extracted information.

# File lib/rdoc/generator/darkfish.rb, line 239
def generate
 setup
 write_style_sheet
 generate_index
 generate_class_files
 generate_file_files
 generate_table_of_contents
 @json_index.generate
 copy_static
rescue => e
 debug_msg "%s: %s\n %s" % [
 e.class.name, e.message, e.backtrace.join("\n ")
 ]
 raise
end

generate_class(klass, template_file = nil) click to toggle source

Generates a class file for klass

# File lib/rdoc/generator/darkfish.rb, line 330
def generate_class klass, template_file = nil
 setup
 current = klass
 template_file ||= @template_dir + 'class.rhtml'
 debug_msg " working on %s (%s)" % [klass.full_name, klass.path]
 out_file = @outputdir + klass.path
 rel_prefix = @outputdir.relative_path_from out_file.dirname
 search_index_rel_prefix = rel_prefix
 search_index_rel_prefix += @asset_rel_path if @file_output
 # suppress 1.9.3 warning
 asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
 svninfo = svninfo = get_svninfo(current)
 @title = "#{klass.type} #{klass.full_name} - #{@options.title}"
 debug_msg " rendering #{out_file}"
 render_template template_file, out_file do |io| binding end
end

generate_class_files() click to toggle source

Generate a documentation file for each class and module

# File lib/rdoc/generator/darkfish.rb, line 356
def generate_class_files
 setup
 template_file = @template_dir + 'class.rhtml'
 template_file = @template_dir + 'classpage.rhtml' unless
 template_file.exist?
 return unless template_file.exist?
 debug_msg "Generating class documentation in #{@outputdir}"
 current = nil
 @classes.each do |klass|
 current = klass
 generate_class klass, template_file
 end
rescue => e
 error = RDoc::Error.new "error generating #{current.path}: #{e.message} (#{e.class})"
 error.set_backtrace e.backtrace
 raise error
end

generate_file_files() click to toggle source

Generate a documentation file for each file

# File lib/rdoc/generator/darkfish.rb, line 383
def generate_file_files
 setup
 page_file = @template_dir + 'page.rhtml'
 fileinfo_file = @template_dir + 'fileinfo.rhtml'
 # for legacy templates
 filepage_file = @template_dir + 'filepage.rhtml' unless
 page_file.exist? or fileinfo_file.exist?
 return unless
 page_file.exist? or fileinfo_file.exist? or filepage_file.exist?
 debug_msg "Generating file documentation in #{@outputdir}"
 out_file = nil
 current = nil
 @files.each do |file|
 current = file
 if file.text? and page_file.exist? then
 generate_page file
 next
 end
 template_file = nil
 out_file = @outputdir + file.path
 debug_msg " working on %s (%s)" % [file.full_name, out_file]
 rel_prefix = @outputdir.relative_path_from out_file.dirname
 search_index_rel_prefix = rel_prefix
 search_index_rel_prefix += @asset_rel_path if @file_output
 # suppress 1.9.3 warning
 asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
 unless filepage_file then
 if file.text? then
 next unless page_file.exist?
 template_file = page_file
 @title = file.page_name
 else
 next unless fileinfo_file.exist?
 template_file = fileinfo_file
 @title = "File: #{file.base_name}"
 end
 end
 @title += " - #{@options.title}"
 template_file ||= filepage_file
 render_template template_file, out_file do |io| binding end
 end
rescue => e
 error =
 RDoc::Error.new "error generating #{out_file}: #{e.message} (#{e.class})"
 error.set_backtrace e.backtrace
 raise error
end

generate_index() click to toggle source

Generate an index page which lists all the classes which are documented.

# File lib/rdoc/generator/darkfish.rb, line 300
def generate_index
 setup
 template_file = @template_dir + 'index.rhtml'
 return unless template_file.exist?
 debug_msg "Rendering the index page..."
 out_file = @base_dir + @options.op_dir + 'index.html'
 rel_prefix = @outputdir.relative_path_from out_file.dirname
 search_index_rel_prefix = rel_prefix
 search_index_rel_prefix += @asset_rel_path if @file_output
 # suppress 1.9.3 warning
 asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
 @title = @options.title
 render_template template_file, out_file do |io| binding end
rescue => e
 error = RDoc::Error.new "error generating index.html: #{e.message} (#{e.class})"
 error.set_backtrace e.backtrace
 raise error
end

generate_page(file) click to toggle source

Generate a page file for file

# File lib/rdoc/generator/darkfish.rb, line 447
def generate_page file
 setup
 template_file = @template_dir + 'page.rhtml'
 out_file = @outputdir + file.path
 debug_msg " working on %s (%s)" % [file.full_name, out_file]
 rel_prefix = @outputdir.relative_path_from out_file.dirname
 search_index_rel_prefix = rel_prefix
 search_index_rel_prefix += @asset_rel_path if @file_output
 # suppress 1.9.3 warning
 current = current = file
 asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
 @title = "#{file.page_name} - #{@options.title}"
 debug_msg " rendering #{out_file}"
 render_template template_file, out_file do |io| binding end
end

generate_servlet_not_found(message) click to toggle source

Generates the 404 page for the RDoc servlet

# File lib/rdoc/generator/darkfish.rb, line 471
def generate_servlet_not_found message
 setup
 template_file = @template_dir + 'servlet_not_found.rhtml'
 return unless template_file.exist?
 debug_msg "Rendering the servlet 404 Not Found page..."
 rel_prefix = rel_prefix = ''
 search_index_rel_prefix = rel_prefix
 search_index_rel_prefix += @asset_rel_path if @file_output
 # suppress 1.9.3 warning
 asset_rel_prefix = asset_rel_prefix = ''
 @title = 'Not Found'
 render_template template_file do |io| binding end
rescue => e
 error = RDoc::Error.new "error generating servlet_not_found: #{e.message} (#{e.class})"
 error.set_backtrace e.backtrace
 raise error
end

generate_servlet_root(installed) click to toggle source

Generates the servlet root page for the RDoc servlet

# File lib/rdoc/generator/darkfish.rb, line 500
def generate_servlet_root installed
 setup
 template_file = @template_dir + 'servlet_root.rhtml'
 return unless template_file.exist?
 debug_msg 'Rendering the servlet root page...'
 rel_prefix = '.'
 asset_rel_prefix = rel_prefix
 search_index_rel_prefix = asset_rel_prefix
 search_index_rel_prefix += @asset_rel_path if @file_output
 @title = 'Local RDoc Documentation'
 render_template template_file do |io| binding end
rescue => e
 error = RDoc::Error.new "error generating servlet_root: #{e.message} (#{e.class})"
 error.set_backtrace e.backtrace
 raise error
end

generate_table_of_contents() click to toggle source

Generate an index page which lists all the classes which are documented.

# File lib/rdoc/generator/darkfish.rb, line 527
def generate_table_of_contents
 setup
 template_file = @template_dir + 'table_of_contents.rhtml'
 return unless template_file.exist?
 debug_msg "Rendering the Table of Contents..."
 out_file = @outputdir + 'table_of_contents.html'
 rel_prefix = @outputdir.relative_path_from out_file.dirname
 search_index_rel_prefix = rel_prefix
 search_index_rel_prefix += @asset_rel_path if @file_output
 # suppress 1.9.3 warning
 asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
 @title = "Table of Contents - #{@options.title}"
 render_template template_file, out_file do |io| binding end
rescue => e
 error = RDoc::Error.new "error generating table_of_contents.html: #{e.message} (#{e.class})"
 error.set_backtrace e.backtrace
 raise error
end

get_sorted_module_list(classes) click to toggle source

Return a list of the documented modules sorted by salience first, then by name.

# File lib/rdoc/generator/darkfish.rb, line 291
def get_sorted_module_list classes
 classes.select do |klass|
 klass.display?
 end.sort
end

get_svninfo(klass) click to toggle source

Try to extract Subversion information out of the first constant whose value looks like a subversion Id tag. If no matching constant is found, and empty hash is returned.

# File lib/rdoc/generator/darkfish.rb, line 622
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 - commitdate),
 :committer => committer,
 }
end

render(file_name) click to toggle source

Renders the ERb contained in file_name relative to the template directory and returns the result based on the current context.

# File lib/rdoc/generator/darkfish.rb, line 669
def render file_name
 template_file = @template_dir + file_name
 template = template_for template_file, false, RDoc::ERBPartial
 template.filename = template_file.to_s
 template.result @context
end

render_template(template_file, out_file = nil) { |io| ... } click to toggle source

Load and render the erb template in the given template_file and write it out to out_file.

Both template_file and out_file should be Pathname-like objects.

An io will be yielded which must be captured by binding in the caller.

# File lib/rdoc/generator/darkfish.rb, line 687
def render_template template_file, out_file = nil # :yield: io
 io_output = out_file && !@dry_run && @file_output
 erb_klass = io_output ? RDoc::ERBIO : ERB
 template = template_for template_file, true, erb_klass
 if io_output then
 debug_msg "Outputting to %s" % [out_file.expand_path]
 out_file.dirname.mkpath
 out_file.open 'w', 0644 do |io|
 io.set_encoding @options.encoding if Object.const_defined? :Encoding
 @context = yield io
 template_result template, @context, template_file
 end
 else
 @context = yield nil
 output = template_result template, @context, template_file
 debug_msg " would have written %d characters to %s" % [
 output.length, out_file.expand_path
 ] if @dry_run
 output
 end
end

setup() click to toggle source

Prepares for generation of output from the current directory

# File lib/rdoc/generator/darkfish.rb, line 574
def setup
 return if instance_variable_defined? :@outputdir
 @outputdir = Pathname.new(@options.op_dir).expand_path @base_dir
 return unless @store
 @classes = @store.all_classes_and_modules.sort
 @files = @store.all_files.sort
 @methods = @classes.map { |m| m.method_list }.flatten.sort
 @modsort = get_sorted_module_list @classes
end

template_for(file, page = true, klass = ERB) click to toggle source

Retrieves a cache template for file, if present, or fills the cache.

# File lib/rdoc/generator/darkfish.rb, line 734
def template_for file, page = true, klass = ERB
 template = @template_cache[file]
 return template if template
 if page then
 template = assemble_template file
 erbout = 'io'
 else
 template = file.read
 template = template.encode @options.encoding if
 Object.const_defined? :Encoding
 file_var = File.basename(file).sub(/\..*/, '')
 erbout = "_erbout_#{file_var}"
 end
 template = klass.new template, nil, '<>', erbout
 @template_cache[file] = template
 template
end

template_result(template, context, template_file) click to toggle source

Creates the result for template with context. If an error is raised a Pathname template_file will indicate the file where the error occurred.

# File lib/rdoc/generator/darkfish.rb, line 721
def template_result template, context, template_file
 template.filename = template_file.to_s
 template.result context
rescue NoMethodError => e
 raise RDoc::Error, "Error while evaluating %s: %s" % [
 template_file.expand_path,
 e.message,
 ], e.backtrace
end

time_delta_string(seconds) click to toggle source

Return a string describing the amount of time in the given number of seconds in terms a human can understand easily.

# File lib/rdoc/generator/darkfish.rb, line 591
def time_delta_string seconds
 return 'less than a minute' if seconds < 60
 return "#{seconds / 60} minute#{seconds / 60 == 1 ? '' : 's'}" if
 seconds < 3000 # 50 minutes
 return 'about one hour' if seconds < 5400 # 90 minutes
 return "#{seconds / 3600} hours" if seconds < 64800 # 18 hours
 return 'one day' if seconds < 86400 # 1 day
 return 'about one day' if seconds < 172800 # 2 days
 return "#{seconds / 86400} days" if seconds < 604800 # 1 week
 return 'about one week' if seconds < 1209600 # 2 week
 return "#{seconds / 604800} weeks" if seconds < 7257600 # 3 months
 return "#{seconds / 2419200} months" if seconds < 31536000 # 1 year
 return "#{seconds / 31536000} years"
end

write_style_sheet() click to toggle source

Copy over the stylesheet into the appropriate place in the output directory.

# File lib/rdoc/generator/darkfish.rb, line 213
def write_style_sheet
 debug_msg "Copying static files"
 options = { :verbose => $DEBUG_RDOC, :noop => @dry_run }
 BUILTIN_STYLE_ITEMS.each do |item|
 install_rdoc_static_file @template_dir + item, "./#{item}", options
 end
 @options.template_stylesheets.each do |stylesheet|
 FileUtils.cp stylesheet, '.', options
 end
 Dir[(@template_dir + "{js,images}/**/*").to_s].each do |path|
 next if File.directory? path
 next if File.basename(path) =~ /^\./
 dst = Pathname.new(path).relative_path_from @template_dir
 install_rdoc_static_file @template_dir + path, dst, options
 end
end