Class: RDoc::RDoc

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/rdoc.rb

Overview

This is the driver for generating RDoc output. It handles file parsing and generation of output.

To use this class to generate RDoc output via the API, the recommended way is:

rdoc = RDoc::RDoc.new
options = RDoc::Options.load_options # returns an RDoc::Options instance
# set extra options
rdoc.document options

You can also generate output like the rdoc executable:

rdoc = RDoc::RDoc.new
rdoc.document argv

Where argv is an array of strings, each corresponding to an argument you’d give rdoc on the command line. See rdoc --help for details.

Constant Summary collapse

GENERATORS =

This is the list of supported output generators

{}
UNCONDITIONALLY_SKIPPED_DIRECTORIES =

List of directory names always skipped

%w[CVS .svn .git].freeze
TEST_SUITE_DIRECTORY_NAMES =

List of directory names skipped if test suites should be skipped

%w[spec test].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RDoc

Creates a new RDoc::RDoc instance. Call #document to parse files and generate documentation.



101
102
103
104
105
106
107
108
109
 
# File 'lib/rdoc/rdoc.rb', line 101

def initialize
  @current       = nil
  @generator     = nil
  @last_modified = {}
  @old_siginfo   = nil
  @options       = nil
  @stats         = nil
  @store         = nil
end

Instance Attribute Details

#generator ⇒ Object

Generator instance used for creating output



53
54
55
 
# File 'lib/rdoc/rdoc.rb', line 53

def generator
  @generator
end

#last_modified ⇒ Object (readonly)

Hash of files and their last modified times.



58
59
60
 
# File 'lib/rdoc/rdoc.rb', line 58

def last_modified
  @last_modified
end

#options ⇒ Object

RDoc options



63
64
65
 
# File 'lib/rdoc/rdoc.rb', line 63

def options
  @options
end

#stats ⇒ Object (readonly)

Accessor for statistics. Available after each call to parse_files



68
69
70
 
# File 'lib/rdoc/rdoc.rb', line 68

def stats
  @stats
end

#store ⇒ Object

The current documentation store



73
74
75
 
# File 'lib/rdoc/rdoc.rb', line 73

def store
  @store
end

Class Method Details

.add_generator(klass) ⇒ Object

Add klass that can generate output after parsing



78
79
80
81
 
# File 'lib/rdoc/rdoc.rb', line 78

def self.add_generator(klass)
  name = klass.name.sub(/^RDoc::Generator::/, '').downcase
  GENERATORS[name] = klass
end

.current ⇒ Object

Active RDoc::RDoc instance



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

def self.current
  @current
end

.current=(rdoc) ⇒ Object

Sets the active RDoc::RDoc instance



93
94
95
 
# File 'lib/rdoc/rdoc.rb', line 93

def self.current=(rdoc)
  @current = rdoc
end

.rbs_discovery_extension?(extension) ⇒ Boolean

Returns true when extension is the RBS gem’s RDoc discovery hook. Released RBS gems install their plugin through this hook, so skip it to avoid replacing the built-in parser during discovery.

Returns:

  • (Boolean) 


688
689
690
691
692
693
694
 
# File 'lib/rdoc/rdoc.rb', line 688

def self.rbs_discovery_extension?(extension) # :nodoc:
  extension = File.expand_path(extension)

  Gem::Specification.find_all_by_name('rbs').any? do |spec|
    File.expand_path('lib/rdoc/discover.rb', spec.full_gem_path) == extension
  end
end

Instance Method Details

#auto_discovered_rbs_signature_file?(file) ⇒ Boolean

Returns true for project RBS files that are auto-discovered for signature loading. RDoc parses any selected .rbs file as documentation input, but only sig/*/.rbs files are loaded through RBS::EnvironmentLoader for type signature merging and live-reload bookkeeping.

Returns:

  • (Boolean) 


642
643
644
645
646
647
648
649
650
651
 
# File 'lib/rdoc/rdoc.rb', line 642

def auto_discovered_rbs_signature_file?(file) # :nodoc:
  return false unless File.extname(file) == '.rbs'

  root = Pathname(@options.root.to_s).expand_path
  relative_path = Pathname(file).expand_path.relative_path_from root
  relative_path.each_filename.first == 'sig'
rescue ArgumentError
  # file and root may be on different drives on Windows
  false
end

#auto_discovered_rbs_signature_files ⇒ Object

Returns RBS files that RDoc auto-discovers for signature loading.



600
601
602
 
# File 'lib/rdoc/rdoc.rb', line 600

def auto_discovered_rbs_signature_files
  Dir[File.join(@options.root.to_s, 'sig', '**', '*.rbs')].sort
end

#auto_discovered_rbs_signature_mtimes ⇒ Object

Returns mtimes for auto-discovered RBS signature files.



656
657
658
659
660
661
 
# File 'lib/rdoc/rdoc.rb', line 656

def auto_discovered_rbs_signature_mtimes # :nodoc:
  auto_discovered_rbs_signature_files.each_with_object({}) do |file, mtimes|
    mtime = RDoc.safe_mtime(file)
    mtimes[file] = mtime if mtime
  end
end

#auto_discovered_rbs_signatures_changed? ⇒ Boolean

Returns true if any auto-discovered RBS signature file has changed since the last run.

Returns:

  • (Boolean) 


608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/rdoc/rdoc.rb', line 608

def auto_discovered_rbs_signatures_changed?
  current = auto_discovered_rbs_signature_mtimes
  previous = @last_modified.select { |file, _| auto_discovered_rbs_signature_file?(file) }

  return true unless (previous.keys - current.keys).empty?

  current.any? do |file, mtime|
    last_modified = @last_modified[file]
    last_modified.nil? || mtime.to_i > last_modified.to_i
  end
end

#document(options) ⇒ Object

Generates documentation or a coverage report depending upon the settings in options.

options can be either an RDoc::Options instance or an array of strings equivalent to the strings that would be passed on the command line like %w[-q -o doc -t My\ Doc\ Title]. #document will automatically call RDoc::Options#finish if an options instance was given.

For a list of options, see either RDoc::Options or rdoc --help.

By default, output will be stored in a directory called “doc” below the current directory, so make sure you’re somewhere writable before invoking.



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/rdoc/rdoc.rb', line 475

def document(options)
  if RDoc::Options === options then
    @options = options
  else
    @options = RDoc::Options.load_options
    @options.parse options
  end
  @options.finish

  @store = RDoc::Store.new(@options)

  if @options.pipe then
    handle_pipe
    exit
  end

  if @options.server_port
    @store.load_cache

    parse_files @options.files
    record_auto_discovered_rbs_signature_mtimes

    @options.default_title = "RDoc Documentation"

    load_auto_discovered_rbs_signatures
    @store.complete @options.visibility

    start_server
    exit
  end

  unless @options.coverage_report then
    @last_modified = setup_output_dir @options.op_dir, @options.force_update
  end

  @start_time = Time.now

  @store.load_cache

  auto_discovered_rbs_signatures_changed = auto_discovered_rbs_signatures_changed?
  # When only auto-discovered RBS signatures changed, no Ruby file would be
  # reparsed under normal mtime checks.  The store cache holds class metadata
  # but not live RDoc::Context objects, so the generator would have nothing
  # to iterate.  Force a full reparse so updated signatures show up in the
  # rendered output.
  @last_modified.clear if auto_discovered_rbs_signatures_changed

  file_info = parse_files @options.files
  record_auto_discovered_rbs_signature_mtimes

  @options.default_title = "RDoc Documentation"

  load_auto_discovered_rbs_signatures

  @store.complete @options.visibility

  @stats.coverage_level = @options.coverage_report

  if @options.coverage_report then
    puts

    puts @stats.report
  elsif file_info.empty? && !auto_discovered_rbs_signatures_changed then
    $stderr.puts "\nNo newer files." unless @options.quiet
  else
    gen_klass = @options.generator

    @generator = gen_klass.new @store, @options

    generate
  end

  if @stats and (@options.coverage_report or not @options.quiet) then
    puts
    puts @stats.summary
  end

  exit @stats.fully_documented? if @options.coverage_report
end

#error(msg) ⇒ Object

Report an error message and exit

Raises:



114
115
116
 
# File 'lib/rdoc/rdoc.rb', line 114

def error(msg)
  raise RDoc::Error, msg
end

#gather_files(files) ⇒ Object

Gathers a set of parseable files from the files and directories listed in files.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/rdoc/rdoc.rb', line 122

def gather_files(files)
  files = [@options.root.to_s] if files.empty?

  file_list = normalized_file_list files, true, @options.exclude

  file_list = remove_unparseable(file_list)

  if file_list.count {|name, mtime|
       file_list[name] = @last_modified[name] unless mtime
       mtime
     } > 0
    @last_modified.replace file_list
    file_list.keys.sort
  else
    []
  end
end

#generate ⇒ Object

Generates documentation for file_info (from #parse_files) into the output dir using the generator selected by the RDoc options



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/rdoc/rdoc.rb', line 560

def generate
  if @options.dry_run then
    # do nothing
    @generator.generate
  else
    Dir.chdir @options.op_dir do
      unless @options.quiet then
        $stderr.puts "\nGenerating #{@generator.class.name.sub(/^.*::/, '')} format into #{Dir.pwd}..."
        uri = "file://#{Dir.pwd}/index.html"
        ref = $stderr.tty? ? "\e]8;;#{uri}\e\\#{uri}\e]8;;\e\\" : uri
        $stderr.puts "\nYou can visit the home page at: #{ref}"
      end

      @generator.generate
      update_output_dir '.', @start_time, @last_modified
    end
  end
end

#handle_pipe ⇒ Object

Turns RDoc from stdin into HTML



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/rdoc/rdoc.rb', line 143

def handle_pipe
  @html = RDoc::Markup::ToHtml.new(pipe: @options.pipe, output_decoration: @options.output_decoration)

  parser = RDoc::Text::MARKUP_FORMAT[@options.markup]

  document = parser.parse $stdin.read

  out = @html.convert document

  $stdout.write out
end

#install_siginfo_handler ⇒ Object

Installs a siginfo handler that prints the current filename.



158
159
160
161
162
163
164
 
# File 'lib/rdoc/rdoc.rb', line 158

def install_siginfo_handler
  return unless Signal.list.include? 'INFO'

  @old_siginfo = trap 'INFO' do
    puts @current if @current
  end
end

#list_files_in_directory(dir) ⇒ Object

Return a list of the files to be processed in a directory. We know that this directory doesn’t have a .document file, so we’re looking for real files. However we may well contain subdirectories which must be tested for .document files.



315
316
317
318
319
 
# File 'lib/rdoc/rdoc.rb', line 315

def list_files_in_directory(dir)
  files = Dir.glob File.join(dir, "*")

  normalized_file_list files, false, @options.exclude
end

#load_auto_discovered_rbs_signatures ⇒ Object

Loads RBS type signatures from the project’s sig directory and RBS stdlib, then merges them into the store’s code objects.



583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/rdoc/rdoc.rb', line 583

def load_auto_discovered_rbs_signatures
  sig_dirs = []
  sig_dir = File.join(@options.root.to_s, 'sig')
  sig_dirs << sig_dir if File.directory?(sig_dir)
  signatures = RDoc::RbsHelper.load_signatures(*sig_dirs)
  @store.merge_rbs_signatures(signatures)
rescue RBS::BaseError, Errno::ENOENT, LoadError => e
  # In server mode, a previous successful load may have populated the store;
  # drop those signatures so a now-broken sig file doesn't keep showing
  # stale types alongside the warning.
  @store.clear_rbs_signatures
  @options.warn "Failed to load RBS type signatures: #{e.message}"
end

#normalized_file_list(relative_files, force_doc = false, exclude_pattern = nil) ⇒ Object

Given a list of files and directories, create a list of all the Ruby files they contain.

If force_doc is true we always add the given files, if false, only add files that we guarantee we can parse. It is true when looking at files given on the command line, false when recursing through subdirectories.

The effect of this is that if you want a file with a non-standard extension parsed, you must name it explicitly.



267
268
269
270
271
272
273
274
275
276
277
278
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
305
306
307
 
# File 'lib/rdoc/rdoc.rb', line 267

def normalized_file_list(relative_files, force_doc = false,
                         exclude_pattern = nil)
  file_list = {}

  relative_files.each do |rel_file_name|
    rel_file_name = rel_file_name.sub(/^\.\//, '')
    next if rel_file_name.end_with? 'created.rid'
    next if exclude_pattern && exclude_pattern =~ rel_file_name
    stat = File.stat rel_file_name rescue next

    case type = stat.ftype
    when "file" then
      mtime = (stat.mtime unless (last_modified = @last_modified[rel_file_name] and
                                  stat.mtime.to_i <= last_modified.to_i))

      if force_doc or RDoc::Parser.can_parse(rel_file_name) then
        file_list[rel_file_name] = mtime
      end
    when "directory" then
      next if UNCONDITIONALLY_SKIPPED_DIRECTORIES.include?(rel_file_name)

      basename = File.basename(rel_file_name)
      next if options.skip_tests && TEST_SUITE_DIRECTORY_NAMES.include?(basename)

      created_rid = File.join rel_file_name, "created.rid"
      next if File.file? created_rid

      dot_doc = File.join rel_file_name, RDoc::DOT_DOC_FILENAME

      if File.file? dot_doc then
        file_list.update(parse_dot_doc_file(rel_file_name, dot_doc))
      else
        file_list.update(list_files_in_directory(rel_file_name))
      end
    else
      warn "rdoc can't parse the #{type} #{rel_file_name}"
    end
  end

  file_list
end

#output_flag_file(op_dir) ⇒ Object

Return the path name of the flag file in an output directory.



232
233
234
 
# File 'lib/rdoc/rdoc.rb', line 232

def output_flag_file(op_dir)
  File.join op_dir, "created.rid"
end

#parse_dot_doc_file(in_dir, filename) ⇒ Object

The .document file contains a list of file and directory name patterns, representing candidates for documentation. It may also contain comments (starting with ‘#’)



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/rdoc/rdoc.rb', line 241

def parse_dot_doc_file(in_dir, filename)
  # read and strip comments
  patterns = File.read(filename).gsub(/#.*/, '')

  result = {}

  patterns.split(' ').each do |patt|
    candidates = Dir.glob(File.join(in_dir, patt))
    result.update normalized_file_list(candidates, false, @options.exclude)
  end

  result
end

#parse_file(filename) ⇒ Object

Parses filename and returns an RDoc::TopLevel



324
325
326
327
328
329
330
331
332
333
334
335
336
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
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
 
# File 'lib/rdoc/rdoc.rb', line 324

def parse_file(filename)
  encoding = @options.encoding
  filename = filename.encode encoding

  @stats.add_file filename

  return if RDoc::Parser.binary? filename

  content = RDoc::Encoding.read_file filename, encoding

  return unless content

  top_level = @store.add_file filename, relative_name: relative_path_for(filename)

  parser = RDoc::Parser.for top_level, content, @options, @stats

  return unless parser

  parser.scan

  # restart documentation for the classes & modules found
  top_level.classes_or_modules.each do |cm|
    cm.done_documenting = false
  end

  top_level

rescue Errno::EACCES => e
  $stderr.puts <<-EOF
Unable to read #{filename}, #{e.message}

Please check the permissions for this file.  Perhaps you do not have access to
it or perhaps the original author's permissions are to restrictive.  If the
this is not your library please report a bug to the author.
  EOF
rescue => e
  syntax_check_command = syntax_check_command_for filename, parser&.class
  syntax_check_message = if syntax_check_command
    <<~MESSAGE
Before reporting this, could you check that the file you're documenting
has proper syntax:

#{syntax_check_command}
    MESSAGE
  else
    <<~MESSAGE
Before reporting this, could you check that the file you're documenting
has proper syntax for its language?
    MESSAGE
  end

  $stderr.puts <<-EOF
#{syntax_check_message}
RDoc's parsers are not full language parsers and may fail when fed invalid
source files.

The internal error was:

\t(#{e.class}) #{e.message}

  EOF

  $stderr.puts e.backtrace.join("\n\t") if $DEBUG_RDOC

  raise e
end

#parse_files(files) ⇒ Object

Parse each file on the command line, recursively entering directories.



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

def parse_files(files)
  file_list = gather_files files
  @stats = RDoc::Stats.new @store, file_list.length, @options.verbosity

  return [] if file_list.empty?

  # This workaround can be removed after the :main: directive is removed
  original_options = @options.dup
  @stats.begin_adding

  file_info = file_list.map do |filename|
    @current = filename
    parse_file filename
  end.compact

  @store.resolve_c_superclasses

  @stats.done_adding
  @options = original_options

  file_info
end

#record_auto_discovered_rbs_signature_mtimes ⇒ Object

Records auto-discovered RBS signature file mtimes so normal generation freshness checks and the live server watcher can see signature-only edits.



624
625
626
627
 
# File 'lib/rdoc/rdoc.rb', line 624

def record_auto_discovered_rbs_signature_mtimes
  @last_modified.reject! { |file, _| auto_discovered_rbs_signature_file?(file) }
  @last_modified.merge! auto_discovered_rbs_signature_mtimes
end

#relative_path_for(filename) ⇒ Object

Returns the relative path for filename against options.root (and options.page_dir when set). This is the key used by RDoc::Store to identify files.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/rdoc/rdoc.rb', line 406

def relative_path_for(filename)
  filename_path = Pathname(filename).expand_path
  begin
    relative_path = filename_path.relative_path_from @options.root
  rescue ArgumentError
    relative_path = filename_path
  end

  if @options.page_dir &&
     relative_path.to_s.start_with?(@options.page_dir.to_s)
    relative_path =
      relative_path.relative_path_from @options.page_dir
  end

  relative_path.to_s
end

#remove_siginfo_handler ⇒ Object

Removes a siginfo handler and replaces the previous



675
676
677
678
679
680
681
 
# File 'lib/rdoc/rdoc.rb', line 675

def remove_siginfo_handler
  return unless Signal.list.key? 'INFO'

  handler = @old_siginfo || 'DEFAULT'

  trap 'INFO', handler
end

#remove_unparseable(files) ⇒ Object

Removes file extensions known to be unparseable from files and TAGS files for emacs and vim.



453
454
455
456
457
458
459
 
# File 'lib/rdoc/rdoc.rb', line 453

def remove_unparseable(files)
  files.reject do |file, *|
    file =~ /\.(?:class|eps|erb|scpt\.txt|svg|ttf|yml)\z/i or
      (file =~ /tags\z/i and
       /\A(\f\n[^,]+,\d+$|!_TAG_)/.match?(File.binread(file, 100)))
  end
end

#setup_output_dir(dir, force) ⇒ Object

Create an output dir if it doesn’t exist. If it does exist, but doesn’t contain the flag file created.rid then we refuse to use it, as we may clobber some manually generated documentation



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/rdoc/rdoc.rb', line 171

def setup_output_dir(dir, force)
  flag_file = output_flag_file dir

  last = {}

  if @options.dry_run then
    # do nothing
  elsif File.exist? dir then
    error "#{dir} exists and is not a directory" unless File.directory? dir

    begin
      File.open flag_file do |io|
        unless force then
          Time.parse io.gets

          io.each do |line|
            file, time = line.split "\t", 2
            time = Time.parse(time) rescue next
            last[file] = time
          end
        end
      end
    rescue SystemCallError, TypeError
      error <<-ERROR

Directory #{dir} already exists, but it looks like it isn't an RDoc directory.

Because RDoc doesn't want to risk destroying any of your existing files,
you'll need to specify a different output directory name (using the --op <dir>
option)

      ERROR
    end unless @options.force_output
  else
    FileUtils.mkdir_p dir
    FileUtils.touch flag_file
  end

  last
end

#start_server ⇒ Object

Starts a live-reloading HTTP server for previewing documentation. Called from #document when --server is given.



667
668
669
670
 
# File 'lib/rdoc/rdoc.rb', line 667

def start_server
  server = RDoc::Server.new(self, @options.server_port)
  server.start
end

#syntax_check_command_for(filename, parser_class = RDoc::Parser.can_parse_by_name(filename)) ⇒ Object 



391
392
393
394
395
396
397
398
399
 
# File 'lib/rdoc/rdoc.rb', line 391

def syntax_check_command_for(filename, parser_class = RDoc::Parser.can_parse_by_name(filename))
  if parser_class == RDoc::Parser::Ruby
    "#{Gem.ruby} -c #{filename}"
  elsif parser_class == RDoc::Parser::C
    cc = ENV['CC']
    cc = 'cc' if cc.nil? || cc.empty?
    "#{cc} -fsyntax-only #{filename}"
  end
end

#update_output_dir(op_dir, time, last = {}) ⇒ Object

Update the flag file in an output directory.



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/rdoc/rdoc.rb', line 215

def update_output_dir(op_dir, time, last = {})
  return if @options.dry_run or not @options.update_output_dir
  unless ENV['SOURCE_DATE_EPOCH'].nil?
    time = Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime
  end

  File.open output_flag_file(op_dir), "w" do |f|
    f.puts time.rfc2822
    last.each do |n, t|
      f.puts "#{n}\t#{t.rfc2822}"
    end
  end
end

#watch_files ⇒ Object

Files watched by the live preview server.



632
633
634
 
# File 'lib/rdoc/rdoc.rb', line 632

def watch_files
  (@last_modified.keys + auto_discovered_rbs_signature_files).uniq
end