Class: RDoc::Generator::Darkfish

Inherits:
Object
  • Object
show all
Includes:
ERB::Util
Defined in:
lib/rdoc/generator/darkfish.rb

Overview

Darkfish RDoc HTML Generator

$Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $

Author/s

Contributors

License

Copyright © 2007, 2008, Michael Granger. All rights reserved.

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.

Constant Summary collapse

GENERATOR_DIR =

Path to this file’s parent directory. Used to find templates and other resources.

File.join 'rdoc', 'generator'
VERSION =

Release Version

'3'
DESCRIPTION =

Description of this generator

'HTML generator, written by Michael Granger'
SVNID_PATTERN =

%q$Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $“

/
  \$Id:\s
  (\S+)\s                # filename
  (\d+)\s                # rev
  (\d{4}-\d{2}-\d{2})\s  # Date (YYYY-MM-DD)
  (\d{2}:\d{2}:\d{2}Z)\s # Time (HH:MM:SSZ)
  (\w+)\s                # committer
  \$$
/x

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(store, options) ⇒ Darkfish

Initialize a few instance variables before we start



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/rdoc/generator/darkfish.rb', line 138

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

Instance Attribute Details

#asset_rel_path ⇒ Object

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



80
81
82
 
# File 'lib/rdoc/generator/darkfish.rb', line 80

def asset_rel_path
  @asset_rel_path
end

#base_dir ⇒ Object (readonly)

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



86
87
88
 
# File 'lib/rdoc/generator/darkfish.rb', line 86

def base_dir
  @base_dir
end

#classes ⇒ Object (readonly)

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



92
93
94
 
# File 'lib/rdoc/generator/darkfish.rb', line 92

def classes
  @classes
end

#dry_run ⇒ Object

No files will be written when dry_run is true.



97
98
99
 
# File 'lib/rdoc/generator/darkfish.rb', line 97

def dry_run
  @dry_run
end

#file_output ⇒ Object

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



103
104
105
 
# File 'lib/rdoc/generator/darkfish.rb', line 103

def file_output
  @file_output
end

#files ⇒ Object (readonly)

Files to be displayed by this generator



108
109
110
 
# File 'lib/rdoc/generator/darkfish.rb', line 108

def files
  @files
end

#json_index ⇒ Object (readonly)

The JSON index generator for this Darkfish generator



113
114
115
 
# File 'lib/rdoc/generator/darkfish.rb', line 113

def json_index
  @json_index
end

#methods ⇒ Object (readonly)

Methods to be displayed by this generator



118
119
120
 
# File 'lib/rdoc/generator/darkfish.rb', line 118

def methods
  @methods
end

#modsort ⇒ Object (readonly)

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



123
124
125
 
# File 'lib/rdoc/generator/darkfish.rb', line 123

def modsort
  @modsort
end

#outputdir ⇒ Object (readonly)

The output directory



133
134
135
 
# File 'lib/rdoc/generator/darkfish.rb', line 133

def outputdir
  @outputdir
end

#store ⇒ Object (readonly)

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



128
129
130
 
# File 'lib/rdoc/generator/darkfish.rb', line 128

def store
  @store
end

Instance Method Details

#assemble_template(body_file) ⇒ Object

Creates a template from its components and the body_file.

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



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/rdoc/generator/darkfish.rb', line 607

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 ⇒ Object

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



170
171
172
 
# File 'lib/rdoc/generator/darkfish.rb', line 170

def class_dir
  nil
end

#copy_static ⇒ Object

Copies static files from the static_path into the output directory



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/rdoc/generator/darkfish.rb', line 241

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) ⇒ Object

Output progress information if debugging is enabled



161
162
163
164
 
# File 'lib/rdoc/generator/darkfish.rb', line 161

def debug_msg *msg
  return unless $DEBUG_RDOC
  $stderr.puts(*msg)
end

#file_dir ⇒ Object

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



178
179
180
 
# File 'lib/rdoc/generator/darkfish.rb', line 178

def file_dir
  nil
end

#gen_sub_directories ⇒ Object

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



186
187
188
 
# File 'lib/rdoc/generator/darkfish.rb', line 186

def gen_sub_directories
  @outputdir.mkpath
end

#generate ⇒ Object

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/rdoc/generator/darkfish.rb', line 218

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) ⇒ Object

Generates a class file for klass



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/rdoc/generator/darkfish.rb', line 309

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 ⇒ Object

Generate a documentation file for each class and module



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/rdoc/generator/darkfish.rb', line 335

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 ⇒ Object

Generate a documentation file for each file



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/rdoc/generator/darkfish.rb', line 362

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 ⇒ Object

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/rdoc/generator/darkfish.rb', line 279

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) ⇒ Object

Generate a page file for file



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/rdoc/generator/darkfish.rb', line 426

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(path) ⇒ Object

Generates the 404 page for the RDoc servlet



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/rdoc/generator/darkfish.rb', line 450

def generate_servlet_not_found path
  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) ⇒ Object

Generates the servlet root page for the RDoc servlet



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/rdoc/generator/darkfish.rb', line 479

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 ⇒ Object

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



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/rdoc/generator/darkfish.rb', line 506

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) ⇒ Object

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



270
271
272
273
274
 
# File 'lib/rdoc/generator/darkfish.rb', line 270

def get_sorted_module_list classes
  classes.select do |klass|
    klass.display?
  end.sort
end

#get_svninfo(klass) ⇒ Object

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.



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/rdoc/generator/darkfish.rb', line 584

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) ⇒ Object

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



631
632
633
634
635
636
637
638
639
 
# File 'lib/rdoc/generator/darkfish.rb', line 631

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) ⇒ Object

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.



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/rdoc/generator/darkfish.rb', line 649

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 ⇒ Object

Prepares for generation of output from the current directory



536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/rdoc/generator/darkfish.rb', line 536

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) ⇒ Object

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



696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/rdoc/generator/darkfish.rb', line 696

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) ⇒ Object

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



683
684
685
686
687
688
689
690
691
 
# File 'lib/rdoc/generator/darkfish.rb', line 683

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) ⇒ Object

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



553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/rdoc/generator/darkfish.rb', line 553

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 ⇒ Object

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/rdoc/generator/darkfish.rb', line 194

def write_style_sheet
  debug_msg "Copying static files"
  options = { :verbose => $DEBUG_RDOC, :noop => @dry_run }

  FileUtils.cp @template_dir + 'rdoc.css', '.', options

  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

    # 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