Class: RDoc::RDoc

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

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

# 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

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

attr_accessor :generator

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

attr_reader :last_modified

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

attr_accessor :options

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

attr_reader :stats

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

attr_accessor :store

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

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

# 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

# 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

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

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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

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

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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# File 'lib/rdoc/rdoc.rb', line 667

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

# 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

# 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

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

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