class RDoc::Generator::Darkfish

Darkfish RDoc HTML Generator

$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.
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

outputdir [R]

The output directory

store [R]

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

Public Class Methods

new (store, options)

Source

# File lib/rdoc/generator/darkfish.rb, line 149
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

  @json_index = RDoc::Generator::JsonIndex.new self, options
end

Initialize a few instance variables before we start

Public Instance Methods

assemble_template (body_file)

Source

# File lib/rdoc/generator/darkfish.rb, line 565
  def assemble_template body_file
    body = body_file.read
    return body if body =~ /<html/

    head_file = @template_dir + '_head.rhtml'

    <<-TEMPLATE
<!DOCTYPE html>

<html>
<head>
#{head_file.read}

#{body}
    TEMPLATE
  end

Creates a template from its components and the body_file.

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

class_dir ()

Source

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

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

copy_static ()

Source

# File lib/rdoc/generator/darkfish.rb, line 253
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

Copies static files from the static_path into the output directory

debug_msg (*msg)

Source

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

Output progress information if debugging is enabled

excerpt (comment)

Source

# File lib/rdoc/generator/darkfish.rb, line 676
def excerpt(comment)
  text = case comment
  when RDoc::Comment
    comment.text
  else
    comment
  end

  # Match from a capital letter to the first period, discarding any links, so
  # that we don't end up matching badges in the README
  first_paragraph_match = text.match(/[A-Z][^\.:\/]+\./)
  return text[0...150].gsub(/\n/, " ").squeeze(" ") unless first_paragraph_match

  extracted_text = first_paragraph_match[0]
  second_paragraph = first_paragraph_match.post_match.match(/[A-Z][^\.:\/]+\./)
  extracted_text << " " << second_paragraph[0] if second_paragraph

  extracted_text[0...150].gsub(/\n/, " ").squeeze(" ")
end

Returns an excerpt of the comment for usage in meta description tags

file_dir ()

Source

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

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

gen_sub_directories ()

Source

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

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

generate ()

Source

# File lib/rdoc/generator/darkfish.rb, line 229
def generate
  setup

  write_style_sheet
  generate_index
  generate_class_files
  generate_file_files
  generate_table_of_contents
  @json_index.generate
  @json_index.generate_gzipped

  copy_static

rescue => e
  debug_msg "%s: %s\n  %s" % [
    e.class.name, e.message, e.backtrace.join("\n  ")
  ]

  raise
end

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

generate_ancestor_list (ancestors, klass)

Source

# File lib/rdoc/generator/darkfish.rb, line 707
def generate_ancestor_list(ancestors, klass)
  return '' if ancestors.empty?

  ancestor = ancestors.shift
  content = +'<ul><li>'

  if ancestor.is_a?(RDoc::NormalClass)
    content << "<a href=\"#{klass.aref_to ancestor.path}\">#{ancestor.full_name}</a>"
  else
    content << ancestor.to_s
  end

  # Recursively call the method for the remaining ancestors
  content << generate_ancestor_list(ancestors, klass)

  content << '</li></ul>'
end

generate_class (klass, template_file = nil)

Source

# File lib/rdoc/generator/darkfish.rb, line 309
def generate_class klass, template_file = nil
  target = 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

  breadcrumb = generate_nesting_namespaces_breadcrumb(target, rel_prefix)

  @title = "#{klass.type} #{klass.full_name} - #{@options.title}"

  klass_class_methods = klass.class_method_list.sort
  klass_instance_methods = klass.instance_methods.sort
  klass_extends = klass.extends
  klass_includes = klass.includes
  klass_sections = klass.sort_sections

  debug_msg "  rendering #{out_file}"
  render_template template_file, out_file: out_file, locals: {
    asset_rel_prefix: rel_prefix + @asset_rel_path,
    rel_prefix: rel_prefix,
    target: target,
    klass: klass,
    breadcrumb: breadcrumb,
    klass_class_methods: klass_class_methods,
    klass_instance_methods: klass_instance_methods,
    klass_extends: klass_extends,
    klass_includes: klass_includes,
    klass_sections: klass_sections,
  }
end

Generates a class file for klass

generate_class_files ()

Source

# File lib/rdoc/generator/darkfish.rb, line 346
def generate_class_files
  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}"

  target = nil

  @classes.each do |klass|
    target = klass

    generate_class klass, template_file
  end
rescue => e
  error = RDoc::Error.new \
    "error generating #{target.path}: #{e.message} (#{e.class})"
  error.set_backtrace e.backtrace

  raise error
end

Generate a documentation file for each class and module

generate_class_index_content (classes, rel_prefix)

Source

# File lib/rdoc/generator/darkfish.rb, line 733
def generate_class_index_content(classes, rel_prefix)
  grouped_classes = group_classes_by_namespace_for_sidebar(classes)
  return '' unless top = grouped_classes[nil]

  open = top.one? { |klass| klass.display? }
  traverse_classes(top, grouped_classes, rel_prefix, open)
end

generate_class_link (klass, rel_prefix)

Source

# File lib/rdoc/generator/darkfish.rb, line 725
def generate_class_link(klass, rel_prefix)
  if klass.display?
    %(<code>#{generate_sidebar_link(klass.name, klass.path, rel_prefix)}</code>)
  else
    %(<code>#{klass.name}</code>)
  end
end

generate_file_files ()

Source

# File lib/rdoc/generator/darkfish.rb, line 371
def generate_file_files
  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
  target = nil

  @files.each do |file|
    target = 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

    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: out_file, locals: {
      rel_prefix: rel_prefix,
      asset_rel_prefix: rel_prefix + @asset_rel_path,
      file: file,
      target: target,
    }
  end
rescue => e
  error =
    RDoc::Error.new "error generating #{out_file}: #{e.message} (#{e.class})"
  error.set_backtrace e.backtrace

  raise error
end

Generate a documentation file for each file

generate_index ()

Source

# File lib/rdoc/generator/darkfish.rb, line 281
def generate_index
  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

  @title = @options.title
  @main_page = @files.find { |f| f.full_name == @options.main_page }

  render_template template_file, out_file: out_file, locals: {
    rel_prefix: rel_prefix,
    asset_rel_prefix: rel_prefix + @asset_rel_path,
    target: @main_page,
  }
rescue => e
  error = RDoc::Error.new \
    "error generating index.html: #{e.message} (#{e.class})"
  error.set_backtrace e.backtrace

  raise error
end

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

generate_page (file)

Source

# File lib/rdoc/generator/darkfish.rb, line 433
def generate_page file
  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

  target = file

  @title = "#{file.page_name} - #{@options.title}"

  debug_msg "  rendering #{out_file}"
  render_template template_file, out_file: out_file, locals: {
    file: file,
    target: target,
    asset_rel_prefix: rel_prefix + @asset_rel_path,
    rel_prefix: rel_prefix,
  }
end

Generate a page file for file

generate_pages_index_content (page_files, rel_prefix, target)

Source

# File lib/rdoc/generator/darkfish.rb, line 771
def generate_pages_index_content(page_files, rel_prefix, target)
  return '' if page_files.empty?

  dir = target&.full_name&.[](/\A[^\/]+(?=\/)/) || target&.page_name
  grouped_files = page_files.group_by { |f| f.full_name[/\A[^\/]+(?=\/)/] || f.page_name }

  traverse_tree(grouped_files) do |name, files|
    f = files.shift
    # If the group has only one file, we can just link to it
    if files.empty?
      { label: generate_sidebar_link(f.page_name, f.path, rel_prefix), display: true }
    else
      label =
        # If the group has multiple files and the current file matches the group name
        # the label should be a link to the current file
        if name == f.page_name
          generate_sidebar_link(f.page_name, f.path, rel_prefix)
        # Otherwise, the label should be the group name
        else
          files.unshift(f)
          h(name)
        end
      {
        label: label,
        children: files,
        display: true,
        open: dir == name,
        child_renderer: ->(f) { { label: generate_sidebar_link(f.page_name, f.path, rel_prefix), display: true } }
      }
    end
  end
end

generate_servlet_not_found (message)

Source

# File lib/rdoc/generator/darkfish.rb, line 456
def generate_servlet_not_found message
  template_file = @template_dir + 'servlet_not_found.rhtml'
  return unless template_file.exist?

  debug_msg "Rendering the servlet 404 Not Found page..."

  @title = 'Not Found'

  render_template template_file, locals: {
    asset_rel_prefix: '',
    rel_prefix: '',
    message: message
  }
rescue => e
  error = RDoc::Error.new \
    "error generating servlet_not_found: #{e.message} (#{e.class})"
  error.set_backtrace e.backtrace

  raise error
end

Generates the 404 page for the RDoc servlet

generate_servlet_root (installed)

Source

# File lib/rdoc/generator/darkfish.rb, line 480
def generate_servlet_root installed
  template_file = @template_dir + 'servlet_root.rhtml'
  return unless template_file.exist?

  debug_msg 'Rendering the servlet root page...'

  @title = 'Local RDoc Documentation'

  render_template template_file, locals: {
    asset_rel_prefix: '.',
    rel_prefix: '.',
    installed: installed
  }
rescue => e
  error = RDoc::Error.new \
    "error generating servlet_root: #{e.message} (#{e.class})"
  error.set_backtrace e.backtrace

  raise error
end

Generates the servlet root page for the RDoc servlet

generate_sidebar_link (name, path, rel_prefix)

Source

# File lib/rdoc/generator/darkfish.rb, line 765
def generate_sidebar_link(name, path, rel_prefix)
  name = CGI.escapeHTML(name)
  path = CGI.escapeHTML(path)
  %(<a href="#{rel_prefix}/#{path}">#{name}</a>)
end

generate_table_from_target (target)

Source

# File lib/rdoc/generator/darkfish.rb, line 696
def generate_table_from_target(target)
  return '' if target.nil?
  comment =
    if target.respond_to? :comment_location then
      target.comment_location
    else
      target.comment
    end
  target.parse(comment).table_of_contents.dup
end

generate_table_of_contents ()

Source

# File lib/rdoc/generator/darkfish.rb, line 504
def generate_table_of_contents
  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

  @title = "Table of Contents - #{@options.title}"

  render_template template_file, out_file: out_file, locals: {
    rel_prefix: rel_prefix,
    asset_rel_prefix: rel_prefix + @asset_rel_path,
  }
rescue => e
  error = RDoc::Error.new \
    "error generating table_of_contents.html: #{e.message} (#{e.class})"
  error.set_backtrace e.backtrace

  raise error
end

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

group_classes_by_namespace_for_sidebar (classes)

Source

# File lib/rdoc/generator/darkfish.rb, line 754
def group_classes_by_namespace_for_sidebar(classes)
  grouped_classes = classes.group_by do |klass|
    klass.full_name[/\A[^:]++(?:::[^:]++(?=::))*+(?=::[^:]*+\z)/]
  end.select do |_, klasses|
    klasses.any?(&:display?)
  end

  grouped_classes.values.each(&:uniq!)
  grouped_classes
end

render (file_name)

Source

# File lib/rdoc/generator/darkfish.rb, line 586
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

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

render_template (template_file, out_file: nil, locals: {})

Source

# File lib/rdoc/generator/darkfish.rb, line 604
def render_template template_file, out_file: nil, locals: {}
  io_output = out_file && !@dry_run && @file_output
  erb_klass = io_output ? RDoc::ERBIO : ERB

  template = template_for template_file, true, erb_klass

  @context = binding
  locals.each do |key, value|
    @context.local_variable_set(key, value)
  end

  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
      @context.local_variable_set(:io, io)

      template_result template, @context, template_file
    end
  else
    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

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.

setup ()

Source

# File lib/rdoc/generator/darkfish.rb, line 547
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
  @page_files = @files.select { |f| f.text? }
end

Prepares for generation of output from the current directory

template_for (file, page = true, klass = ERB)

Source

# File lib/rdoc/generator/darkfish.rb, line 653
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

    file_var = File.basename(file).sub(/\..*/, '')

    erbout = "_erbout_#{file_var}"
  end

  template = klass.new template, trim_mode: '-', eoutvar: erbout
  @template_cache[file] = template
  template
end

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

template_result (template, context, template_file)

Source

# File lib/rdoc/generator/darkfish.rb, line 640
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

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

traverse_classes (klasses, grouped_classes, rel_prefix, open)

Source

# File lib/rdoc/generator/darkfish.rb, line 741
def traverse_classes(klasses, grouped_classes, rel_prefix, open)
  traverse_tree(klasses) do |index_klass|
    {
      label: generate_class_link(index_klass, rel_prefix),
      children: grouped_classes[index_klass.full_name],
      display: index_klass.display?,
      open: open
    }.tap do
      open = false
    end
  end
end

write_style_sheet ()

Source

# File lib/rdoc/generator/darkfish.rb, line 203
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

  unless @options.template_stylesheets.empty?
    FileUtils.cp @options.template_stylesheets, '.', **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

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