Class: RDoc::Generator::Darkfish
- Inherits:
-
Object
- Object
- RDoc::Generator::Darkfish
- 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
-
Michael Granger ([email protected])
Contributors
-
Mahlon E. Smith ([email protected])
-
Eric Hodel ([email protected])
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
- BUILTIN_STYLE_ITEMS =
Stylesheets, fonts, etc. that are included in RDoc.
%w[ css/fonts.css fonts/Lato-Light.ttf fonts/Lato-LightItalic.ttf fonts/Lato-Regular.ttf fonts/Lato-RegularItalic.ttf fonts/SourceCodePro-Bold.ttf fonts/SourceCodePro-Regular.ttf css/rdoc.css ]
- 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
-
#asset_rel_path ⇒ Object
The relative path to style sheets and javascript.
-
#base_dir ⇒ Object
readonly
The path to generate files into, combined with
--op
from the options for a full path. -
#classes ⇒ Object
readonly
Classes and modules to be used by this generator, not necessarily displayed.
-
#dry_run ⇒ Object
No files will be written when dry_run is true.
-
#file_output ⇒ Object
When false the generate methods return a String instead of writing to a file.
-
#files ⇒ Object
readonly
Files to be displayed by this generator.
-
#json_index ⇒ Object
readonly
The JSON index generator for this Darkfish generator.
-
#methods ⇒ Object
readonly
Methods to be displayed by this generator.
-
#modsort ⇒ Object
readonly
Sorted list of classes and modules to be displayed by this generator.
-
#outputdir ⇒ Object
readonly
The output directory.
-
#store ⇒ Object
readonly
The RDoc::Store that is the source of the generated content.
-
#template_dir ⇒ Object
readonly
The directory where the template files live.
Instance Method Summary collapse
-
#assemble_template(body_file) ⇒ Object
Creates a template from its components and the
body_file
. -
#class_dir ⇒ Object
Directory where generated class HTML files live relative to the output dir.
-
#copy_static ⇒ Object
Copies static files from the static_path into the output directory.
-
#debug_msg(*msg) ⇒ Object
Output progress information if debugging is enabled.
-
#file_dir ⇒ Object
Directory where generated class HTML files live relative to the output dir.
-
#gen_sub_directories ⇒ Object
Create the directories the generated docs will live in if they don’t already exist.
-
#generate ⇒ Object
Build the initial indices and output objects based on an array of TopLevel objects containing the extracted information.
-
#generate_class(klass, template_file = nil) ⇒ Object
Generates a class file for
klass
. -
#generate_class_files ⇒ Object
Generate a documentation file for each class and module.
-
#generate_file_files ⇒ Object
Generate a documentation file for each file.
-
#generate_index ⇒ Object
Generate an index page which lists all the classes which are documented.
-
#generate_page(file) ⇒ Object
Generate a page file for
file
. -
#generate_servlet_not_found(message) ⇒ Object
Generates the 404 page for the RDoc servlet.
-
#generate_servlet_root(installed) ⇒ Object
Generates the servlet root page for the RDoc servlet.
-
#generate_table_of_contents ⇒ Object
Generate an index page which lists all the classes which are documented.
-
#get_sorted_module_list(classes) ⇒ Object
Return a list of the documented modules sorted by salience first, then by name.
-
#get_svninfo(klass) ⇒ Object
Try to extract Subversion information out of the first constant whose value looks like a subversion Id tag.
-
#initialize(store, options) ⇒ Darkfish
constructor
Initialize a few instance variables before we start.
-
#install_rdoc_static_file(source, destination, options) ⇒ Object
:nodoc:.
-
#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. -
#render_template(template_file, out_file = nil) ⇒ Object
Load and render the erb template in the given
template_file
and write it out toout_file
. -
#setup ⇒ Object
Prepares for generation of output from the current directory.
-
#template_for(file, page = true, klass = ERB) ⇒ Object
Retrieves a cache template for
file
, if present, or fills the cache. -
#template_result(template, context, template_file) ⇒ Object
Creates the result for
template
withcontext
. -
#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.
-
#write_style_sheet ⇒ Object
Copy over the stylesheet into the appropriate place in the output directory.
Constructor Details
#initialize(store, options) ⇒ Darkfish
Initialize a few instance variables before we start
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/rdoc/generator/darkfish.rb', line 159 def initialize store, @store = store @options = @asset_rel_path = '' @base_dir = Pathname.pwd. @dry_run = @options.dry_run @file_output = true @template_dir = Pathname.new .template_dir @template_cache = {} @classes = nil @context = nil @files = nil @methods = nil @modsort = nil @json_index = RDoc::Generator::JsonIndex.new self, 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.
96 97 98 |
# File 'lib/rdoc/generator/darkfish.rb', line 96 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.
102 103 104 |
# File 'lib/rdoc/generator/darkfish.rb', line 102 def base_dir @base_dir end |
#classes ⇒ Object (readonly)
Classes and modules to be used by this generator, not necessarily displayed. See also #modsort
108 109 110 |
# File 'lib/rdoc/generator/darkfish.rb', line 108 def classes @classes end |
#dry_run ⇒ Object
No files will be written when dry_run is true.
113 114 115 |
# File 'lib/rdoc/generator/darkfish.rb', line 113 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.
119 120 121 |
# File 'lib/rdoc/generator/darkfish.rb', line 119 def file_output @file_output end |
#files ⇒ Object (readonly)
Files to be displayed by this generator
124 125 126 |
# File 'lib/rdoc/generator/darkfish.rb', line 124 def files @files end |
#json_index ⇒ Object (readonly)
The JSON index generator for this Darkfish generator
129 130 131 |
# File 'lib/rdoc/generator/darkfish.rb', line 129 def json_index @json_index end |
#methods ⇒ Object (readonly)
Methods to be displayed by this generator
134 135 136 |
# File 'lib/rdoc/generator/darkfish.rb', line 134 def methods @methods end |
#modsort ⇒ Object (readonly)
Sorted list of classes and modules to be displayed by this generator
139 140 141 |
# File 'lib/rdoc/generator/darkfish.rb', line 139 def modsort @modsort end |
#outputdir ⇒ Object (readonly)
The output directory
154 155 156 |
# File 'lib/rdoc/generator/darkfish.rb', line 154 def outputdir @outputdir end |
#store ⇒ Object (readonly)
The RDoc::Store that is the source of the generated content
144 145 146 |
# File 'lib/rdoc/generator/darkfish.rb', line 144 def store @store end |
#template_dir ⇒ Object (readonly)
The directory where the template files live
149 150 151 |
# File 'lib/rdoc/generator/darkfish.rb', line 149 def template_dir @template_dir 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.
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 |
# File 'lib/rdoc/generator/darkfish.rb', line 675 def assemble_template body_file body = body_file.read return body if body =~ /<html/ head_file = @template_dir + '_head.rhtml' = @template_dir + '_footer.rhtml' <<-TEMPLATE <!DOCTYPE html> <html> <head> #{head_file.read} #{body} #{.read} TEMPLATE end |
#class_dir ⇒ Object
Directory where generated class HTML files live relative to the output dir.
191 192 193 |
# File 'lib/rdoc/generator/darkfish.rb', line 191 def class_dir nil end |
#copy_static ⇒ Object
Copies static files from the static_path into the output directory
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/rdoc/generator/darkfish.rb', line 265 def copy_static return if @options.static_path.empty? = { :verbose => $DEBUG_RDOC, :noop => @dry_run } @options.static_path.each do |path| unless File.directory? path then FileUtils.install path, @outputdir, **.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, ** else FileUtils.install entry, dest_file, **.merge(:mode => 0644) end end end end end |
#debug_msg(*msg) ⇒ Object
Output progress information if debugging is enabled
182 183 184 185 |
# File 'lib/rdoc/generator/darkfish.rb', line 182 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.
199 200 201 |
# File 'lib/rdoc/generator/darkfish.rb', line 199 def file_dir nil end |
#gen_sub_directories ⇒ Object
Create the directories the generated docs will live in if they don’t already exist.
207 208 209 |
# File 'lib/rdoc/generator/darkfish.rb', line 207 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.
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/rdoc/generator/darkfish.rb', line 241 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., e.backtrace.join("\n ") ] raise end |
#generate_class(klass, template_file = nil) ⇒ Object
Generates a class file for klass
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 |
# File 'lib/rdoc/generator/darkfish.rb', line 337 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 asset_rel_prefix = rel_prefix + @asset_rel_path 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| here = binding # suppress 1.9.3 warning here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) here.local_variable_set(:svninfo, svninfo) here end end |
#generate_class_files ⇒ Object
Generate a documentation file for each class and module
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/rdoc/generator/darkfish.rb', line 368 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.} (#{e.class})" error.set_backtrace e.backtrace raise error end |
#generate_file_files ⇒ Object
Generate a documentation file for each file
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 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/rdoc/generator/darkfish.rb', line 395 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 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| here = binding # suppress 1.9.3 warning here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) here.local_variable_set(:current, current) here end end rescue => e error = RDoc::Error.new "error generating #{out_file}: #{e.} (#{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.
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/rdoc/generator/darkfish.rb', line 303 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 asset_rel_prefix = rel_prefix + @asset_rel_path @title = @options.title render_template template_file, out_file do |io| here = binding # suppress 1.9.3 warning here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) here end rescue => e error = RDoc::Error.new \ "error generating index.html: #{e.} (#{e.class})" error.set_backtrace e.backtrace raise error end |
#generate_page(file) ⇒ Object
Generate a page file for file
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 |
# File 'lib/rdoc/generator/darkfish.rb', line 464 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 current = file 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| here = binding # suppress 1.9.3 warning here.local_variable_set(:current, current) here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) here end end |
#generate_servlet_not_found(message) ⇒ Object
Generates the 404 page for the RDoc servlet
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 |
# File 'lib/rdoc/generator/darkfish.rb', line 493 def generate_servlet_not_found 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 asset_rel_prefix = '' @title = 'Not Found' render_template template_file do |io| here = binding # suppress 1.9.3 warning here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) here end rescue => e error = RDoc::Error.new \ "error generating servlet_not_found: #{e.} (#{e.class})" error.set_backtrace e.backtrace raise error end |
#generate_servlet_root(installed) ⇒ Object
Generates the servlet root page for the RDoc servlet
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
# File 'lib/rdoc/generator/darkfish.rb', line 526 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.} (#{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.
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'lib/rdoc/generator/darkfish.rb', line 553 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 asset_rel_prefix = rel_prefix + @asset_rel_path @title = "Table of Contents - #{@options.title}" render_template template_file, out_file do |io| here = binding # suppress 1.9.3 warning here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) here end rescue => e error = RDoc::Error.new \ "error generating table_of_contents.html: #{e.} (#{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.
294 295 296 297 298 |
# File 'lib/rdoc/generator/darkfish.rb', line 294 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.
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 |
# File 'lib/rdoc/generator/darkfish.rb', line 652 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 |
#install_rdoc_static_file(source, destination, options) ⇒ Object
:nodoc:
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 install_rdoc_static_file source, destination, # :nodoc: return unless source.exist? begin FileUtils.mkdir_p File.dirname(destination), ** begin FileUtils.ln source, destination, ** rescue Errno::EEXIST FileUtils.rm destination retry end rescue FileUtils.cp source, destination, ** end 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.
699 700 701 702 703 704 705 706 707 |
# File 'lib/rdoc/generator/darkfish.rb', line 699 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.
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 |
# File 'lib/rdoc/generator/darkfish.rb', line 717 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.] out_file.dirname.mkpath out_file.open 'w', 0644 do |io| io.set_encoding @options.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. ] if @dry_run output end end |
#setup ⇒ Object
Prepares for generation of output from the current directory
604 605 606 607 608 609 610 611 612 613 614 615 |
# File 'lib/rdoc/generator/darkfish.rb', line 604 def setup return if instance_variable_defined? :@outputdir @outputdir = Pathname.new(@options.op_dir). @base_dir return unless @store @classes = @store.all_classes_and_modules.sort @files = @store.all_files.sort @methods = @classes.flat_map { |m| m.method_list }.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.
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 |
# File 'lib/rdoc/generator/darkfish.rb', line 764 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 |
#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.
751 752 753 754 755 756 757 758 759 |
# File 'lib/rdoc/generator/darkfish.rb', line 751 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., e., ], 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.
621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
# File 'lib/rdoc/generator/darkfish.rb', line 621 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.
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/rdoc/generator/darkfish.rb', line 215 def write_style_sheet debug_msg "Copying static files" = { :verbose => $DEBUG_RDOC, :noop => @dry_run } BUILTIN_STYLE_ITEMS.each do |item| install_rdoc_static_file @template_dir + item, "./#{item}", end unless @options.template_stylesheets.empty? FileUtils.cp @options.template_stylesheets, '.', ** 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, end end |