rdoc 6.3.3 → 6.6.3.1

data/lib/rdoc/rdoc.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'rdoc'
+require_relative '../rdoc'
 
 require 'find'
 require 'fileutils'
@@ -14,7 +14,7 @@ require 'time'
 # is:
 #
 #   rdoc = RDoc::RDoc.new
-#   options = rdoc.load_options # returns an RDoc::Options instance
+#   options = RDoc::Options.load_options # returns an RDoc::Options instance
 #   # set extra options
 #   rdoc.document options
 #
@@ -35,6 +35,17 @@ class RDoc::RDoc
 
   GENERATORS = {}
 
+  ##
+  # List of directory names always skipped
+
+  UNCONDITIONALLY_SKIPPED_DIRECTORIES = %w[CVS .svn .git].freeze
+
+  ##
+  # List of directory names skipped if test suites should be skipped
+
+  TEST_SUITE_DIRECTORY_NAMES = %w[spec test].freeze
+
+
   ##
   # Generator instance used for creating output
 
@@ -108,7 +119,7 @@ class RDoc::RDoc
   # +files+.
 
   def gather_files files
-    files = ["."] if files.empty?
+    files = [@options.root.to_s] if files.empty?
 
     file_list = normalized_file_list files, true, @options.exclude
 
@@ -151,34 +162,6 @@ class RDoc::RDoc
     end
   end
 
-  ##
-  # Loads options from .rdoc_options if the file exists, otherwise creates a
-  # new RDoc::Options instance.
-
-  def load_options
-    options_file = File.expand_path '.rdoc_options'
-    return RDoc::Options.new unless File.exist? options_file
-
-    RDoc.load_yaml
-
-    begin
-      options = YAML.load_file '.rdoc_options'
-    rescue Psych::SyntaxError
-    end
-
-    return RDoc::Options.new if options == false # Allow empty file.
-
-    raise RDoc::Error, "#{options_file} is not a valid rdoc options file" unless
-      RDoc::Options === options or Hash === options
-
-    if Hash === options
-      # Override the default values with the contents of YAML file.
-      options = RDoc::Options.new options
-    end
-
-    options
-  end
-
   ##
   # Create an output dir if it doesn't exist. If it does exist, but doesn't
   # contain the flag file <tt>created.rid</tt> then we refuse to use it, as
@@ -308,7 +291,10 @@ option)
           file_list[rel_file_name] = mtime
         end
       when "directory" then
-        next if rel_file_name == "CVS" || rel_file_name == ".svn"
+        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
@@ -443,9 +429,7 @@ The internal error was:
     files.reject do |file, *|
       file =~ /\.(?:class|eps|erb|scpt\.txt|svg|ttf|yml)$/i or
         (file =~ /tags$/i and
-         File.open(file, 'rb') { |io|
-           io.read(100) =~ /\A(\f\n[^,]+,\d+$|!_TAG_)/
-         })
+         /\A(\f\n[^,]+,\d+$|!_TAG_)/.match?(File.binread(file, 100)))
     end
   end
 
@@ -468,11 +452,11 @@ The internal error was:
 
     if RDoc::Options === options then
       @options = options
-      @options.finish
     else
-      @options = load_options
+      @options = RDoc::Options.load_options
       @options.parse options
     end
+    @options.finish
 
     if @options.pipe then
       handle_pipe

data/lib/rdoc/require.rb

@@ -49,4 +49,3 @@ class RDoc::Require < RDoc::CodeObject
   end
 
 end
-

data/lib/rdoc/ri/driver.rb

@@ -1,23 +1,10 @@
 # frozen_string_literal: true
-require 'abbrev'
 require 'optparse'
 
-begin
-  require 'readline'
-rescue LoadError
-end
-
-begin
-  require 'win32console'
-rescue LoadError
-end
-
-require 'rdoc'
-
-##
-# For RubyGems backwards compatibility
+require_relative '../../rdoc'
 
-require_relative 'formatter'
+require_relative 'formatter' # For RubyGems backwards compatibility
+# TODO: Fix weird documentation with `require_relative`
 
 ##
 # The RI driver implements the command-line ri tool.
@@ -47,9 +34,9 @@ class RDoc::RI::Driver
 
   class NotFoundError < Error
 
-    def initialize(klass, suggestions = nil) # :nodoc:
+    def initialize(klass, suggestion_proc = nil) # :nodoc:
       @klass = klass
-      @suggestions = suggestions
+      @suggestion_proc = suggestion_proc
     end
 
     ##
@@ -61,8 +48,9 @@ class RDoc::RI::Driver
 
     def message # :nodoc:
       str = "Nothing known about #{@klass}"
-      if @suggestions and !@suggestions.empty?
-        str += "\nDid you mean?  #{@suggestions.join("\n               ")}"
+      suggestions = @suggestion_proc&.call
+      if suggestions and !suggestions.empty?
+        str += "\nDid you mean?  #{suggestions.join("\n               ")}"
       end
       str
     end
@@ -142,6 +130,8 @@ Where name can be:
 
   gem_name: | gem_name:README | gem_name:History
 
+  ruby: | ruby:NEWS | ruby:globals
+
 All class names may be abbreviated to their minimum unambiguous form.
 If a name is ambiguous, all valid options will be listed.
 
@@ -153,6 +143,10 @@ they're contained in.  If the gem name is followed by a ':' all files in the
 gem will be shown.  The file name extension may be omitted where it is
 unambiguous.
 
+'ruby' can be used as a pseudo gem name to display files from the Ruby
+core documentation. Use 'ruby:' by itself to get a list of all available
+core documentation files.
+
 For example:
 
     #{opt.program_name} Fil
@@ -160,6 +154,7 @@ For example:
     #{opt.program_name} File.new
     #{opt.program_name} zip
     #{opt.program_name} rdoc:README
+    #{opt.program_name} ruby:comments
 
 Note that shell quoting or escaping may be required for method names
 containing punctuation:
@@ -426,9 +421,6 @@ or the PAGER environment variable.
     @use_stdout  = options[:use_stdout]
     @show_all    = options[:show_all]
     @width       = options[:width]
-
-    # pager process for jruby
-    @jruby_pager_process = nil
   end
 
   ##
@@ -609,11 +601,11 @@ or the PAGER environment variable.
 
       stores = classes[current]
 
-      break unless stores and not stores.empty?
+      next unless stores and not stores.empty?
 
-      klasses = stores.map do |store|
-        store.ancestors[current]
-      end.flatten.uniq
+      klasses = stores.flat_map do |store|
+        store.ancestors[current] || []
+      end.uniq
 
       klasses = klasses - seen
 
@@ -957,8 +949,8 @@ or the PAGER environment variable.
     ary = class_names.grep(Regexp.new("\\A#{klass.gsub(/(?=::|\z)/, '[^:]*')}\\z"))
     if ary.length != 1 && ary.first != klass
       if check_did_you_mean
-        suggestions = DidYouMean::SpellChecker.new(dictionary: class_names).correct(klass)
-        raise NotFoundError.new(klass, suggestions)
+        suggestion_proc = -> { DidYouMean::SpellChecker.new(dictionary: class_names).correct(klass) }
+        raise NotFoundError.new(klass, suggestion_proc)
       else
         raise NotFoundError, klass
       end
@@ -1044,36 +1036,6 @@ or the PAGER environment variable.
     self
   end
 
-  ##
-  # Finds the given +pager+ for jruby.  Returns an IO if +pager+ was found.
-  #
-  # Returns false if +pager+ does not exist.
-  #
-  # Returns nil if the jruby JVM doesn't support ProcessBuilder redirection
-  # (1.6 and older).
-
-  def find_pager_jruby pager
-    require 'java'
-    require 'shellwords'
-
-    return nil unless java.lang.ProcessBuilder.constants.include? :Redirect
-
-    pager = Shellwords.split pager
-
-    pb = java.lang.ProcessBuilder.new(*pager)
-    pb = pb.redirect_output java.lang.ProcessBuilder::Redirect::INHERIT
-
-    @jruby_pager_process = pb.start
-
-    input = @jruby_pager_process.output_stream
-
-    io = input.to_io
-    io.sync = true
-    io
-  rescue java.io.IOException
-    false
-  end
-
   ##
   # Finds a store that matches +name+ which can be the name of a gem, "ruby",
   # "home" or "site".
@@ -1113,6 +1075,10 @@ or the PAGER environment variable.
   def interactive
     puts "\nEnter the method name you want to look up."
 
+    begin
+      require 'readline'
+    rescue LoadError
+    end
     if defined? Readline then
       Readline.completion_proc = method :complete
       puts "You can use tab to autocomplete."
@@ -1141,17 +1107,6 @@ or the PAGER environment variable.
     exit
   end
 
-  ##
-  # Is +file+ in ENV['PATH']?
-
-  def in_path? file
-    return true if file =~ %r%\A/% and File.exist? file
-
-    ENV['PATH'].split(File::PATH_SEPARATOR).any? do |path|
-      File.exist? File.join(path, file)
-    end
-  end
-
   ##
   # Lists classes known to ri starting with +names+.  If +names+ is empty all
   # known classes are shown.
@@ -1283,8 +1238,8 @@ or the PAGER environment variable.
           methods.push(*store.instance_methods[klass]) if [:instance, :both].include? types
         end
         methods = methods.uniq
-        suggestions = DidYouMean::SpellChecker.new(dictionary: methods).correct(method_name)
-        raise NotFoundError.new(name, suggestions)
+        suggestion_proc = -> { DidYouMean::SpellChecker.new(dictionary: methods).correct(method_name) }
+        raise NotFoundError.new(name, suggestion_proc)
       else
         raise NotFoundError, name
       end
@@ -1346,7 +1301,6 @@ or the PAGER environment variable.
         yield pager
       ensure
         pager.close
-        @jruby_pager_process.wait_for if @jruby_pager_process
       end
     else
       yield $stdout
@@ -1514,27 +1468,14 @@ or the PAGER environment variable.
   def setup_pager
     return if @use_stdout
 
-    jruby = RUBY_ENGINE == 'jruby'
-
     pagers = [ENV['RI_PAGER'], ENV['PAGER'], 'pager', 'less', 'more']
 
+    require 'shellwords'
     pagers.compact.uniq.each do |pager|
-      next unless pager
-
-      pager_cmd = pager.split(' ').first
-
-      next unless in_path? pager_cmd
-
-      if jruby then
-        case io = find_pager_jruby(pager)
-        when nil   then break
-        when false then next
-        else            io
-        end
-      else
-        io = IO.popen(pager, 'w') rescue next
-      end
+      pager = Shellwords.split(pager)
+      next if pager.empty?
 
+      io = IO.popen(pager, 'w') rescue next
       next if $? and $?.pid == io.pid and $?.exited? # pager didn't work
 
       @paging = true

data/lib/rdoc/ri/store.rb

@@ -4,4 +4,3 @@ module RDoc::RI
   Store = RDoc::Store # :nodoc:
 
 end
-

data/lib/rdoc/ri.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'rdoc'
+require_relative '../rdoc'
 
 ##
 # Namespace for the ri command line tool's implementation.
@@ -13,9 +13,8 @@ module RDoc::RI
 
   class Error < RDoc::Error; end
 
-  autoload :Driver, 'rdoc/ri/driver'
-  autoload :Paths,  'rdoc/ri/paths'
-  autoload :Store,  'rdoc/ri/store'
+  autoload :Driver, "#{__dir__}/ri/driver"
+  autoload :Paths,  "#{__dir__}/ri/paths"
+  autoload :Store,  "#{__dir__}/ri/store"
 
 end
-

data/lib/rdoc/rubygems_hook.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'rubygems/user_interaction'
 require 'fileutils'
-require 'rdoc'
+require_relative '../rdoc'
 
 ##
 # Gem::RDoc provides methods to generate RDoc and ri data for installed gems
@@ -120,7 +120,9 @@ class RDoc::RubygemsHook
     options.exclude ||= [] # TODO maybe move to RDoc::Options#finish
     options.setup_generator generator
     options.op_dir = destination
-    options.finish
+    Dir.chdir @spec.full_gem_path do
+      options.finish
+    end
 
     generator = options.generator.new @rdoc.store, options
 

data/lib/rdoc/servlet.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'rdoc'
+require_relative '../rdoc'
 require 'erb'
 require 'time'
 require 'json'

data/lib/rdoc/single_class.rb

@@ -22,5 +22,9 @@ class RDoc::SingleClass < RDoc::ClassModule
     "class << #{full_name}"
   end
 
+  def pretty_print q # :nodoc:
+    q.group 2, "[class << #{full_name}", "]" do
+      next
+    end
+  end
 end
-

data/lib/rdoc/stats/quiet.rb

@@ -57,4 +57,3 @@ class RDoc::Stats::Quiet
   def done_adding(*) end
 
 end
-

data/lib/rdoc/stats/verbose.rb

@@ -42,5 +42,3 @@ class RDoc::Stats::Verbose < RDoc::Stats::Normal
   end
 
 end
-
-

data/lib/rdoc/stats.rb

@@ -454,9 +454,8 @@ class RDoc::Stats
     [params.length, undoc]
   end
 
-  autoload :Quiet,   'rdoc/stats/quiet'
-  autoload :Normal,  'rdoc/stats/normal'
-  autoload :Verbose, 'rdoc/stats/verbose'
+  autoload :Quiet,   "#{__dir__}/stats/quiet"
+  autoload :Normal,  "#{__dir__}/stats/normal"
+  autoload :Verbose, "#{__dir__}/stats/verbose"
 
 end
-

data/lib/rdoc/store.rb

@@ -197,6 +197,9 @@ class RDoc::Store
     top_level
   end
 
+  ##
+  # Sets the parser of +absolute_name+, unless it from a source code file.
+
   def update_parser_of_file(absolute_name, parser)
     if top_level = @files_hash[absolute_name] then
       @text_files_hash[absolute_name] = top_level if top_level.text?
@@ -556,9 +559,7 @@ class RDoc::Store
   def load_cache
     #orig_enc = @encoding
 
-    File.open cache_path, 'rb' do |io|
-      @cache = Marshal.load io.read
-    end
+    @cache = marshal_load(cache_path)
 
     load_enc = @cache[:encoding]
 
@@ -615,9 +616,7 @@ class RDoc::Store
   def load_class_data klass_name
     file = class_file klass_name
 
-    File.open file, 'rb' do |io|
-      Marshal.load io.read
-    end
+    marshal_load(file)
   rescue Errno::ENOENT => e
     error = MissingFileError.new(self, file, klass_name)
     error.set_backtrace e.backtrace
@@ -630,14 +629,10 @@ class RDoc::Store
   def load_method klass_name, method_name
     file = method_file klass_name, method_name
 
-    File.open file, 'rb' do |io|
-      obj = Marshal.load io.read
-      obj.store = self
-      obj.parent =
-        find_class_or_module(klass_name) || load_class(klass_name) unless
-          obj.parent
-      obj
-    end
+    obj = marshal_load(file)
+    obj.store = self
+    obj.parent ||= find_class_or_module(klass_name) || load_class(klass_name)
+    obj
   rescue Errno::ENOENT => e
     error = MissingFileError.new(self, file, klass_name + method_name)
     error.set_backtrace e.backtrace
@@ -650,11 +645,9 @@ class RDoc::Store
   def load_page page_name
     file = page_file page_name
 
-    File.open file, 'rb' do |io|
-      obj = Marshal.load io.read
-      obj.store = self
-      obj
-    end
+    obj = marshal_load(file)
+    obj.store = self
+    obj
   rescue Errno::ENOENT => e
     error = MissingFileError.new(self, file, page_name)
     error.set_backtrace e.backtrace
@@ -976,4 +969,21 @@ class RDoc::Store
     @unique_modules
   end
 
+  private
+  def marshal_load(file)
+    File.open(file, 'rb') {|io| Marshal.load(io, MarshalFilter)}
+  end
+
+  MarshalFilter = proc do |obj|
+    case obj
+    when true, false, nil, Array, Class, Encoding, Hash, Integer, String, Symbol, RDoc::Text
+    else
+      unless obj.class.name.start_with?("RDoc::")
+        raise TypeError, "not permitted class: #{obj.class.name}"
+      end
+    end
+    obj
+  end
+  private_constant :MarshalFilter
+
 end

data/lib/rdoc/task.rb

@@ -32,7 +32,7 @@ begin
 rescue Gem::LoadError
 end unless defined?(Rake)
 
-require 'rdoc'
+require_relative '../rdoc'
 require 'rake'
 require 'rake/tasklib'
 
@@ -50,6 +50,9 @@ require 'rake/tasklib'
 # [rerdoc]
 #   Rebuild the rdoc files from scratch, even if they are not out of date.
 #
+# [rdoc:coverage]
+#   Print RDoc coverage report for all rdoc files.
+#
 # Simple Example:
 #
 #   require 'rdoc/task'
@@ -71,7 +74,7 @@ require 'rake/tasklib'
 #   require 'rdoc/task'
 #
 #   RDoc::Task.new :rdoc_dev do |rdoc|
-#     rdoc.main = "README.doc"
+#     rdoc.main = "README.rdoc"
 #     rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
 #     rdoc.options << "--all"
 #   end
@@ -90,8 +93,8 @@ require 'rake/tasklib'
 #   RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
 #                  :rerdoc => "rdoc:force")
 #
-# This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc:clean</tt> and
-# <tt>:rdoc:force</tt>.
+# This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc:clean</tt>,
+# <tt>:rdoc:force</tt>, and <tt>:rdoc:coverage</tt>.
 
 class RDoc::Task < Rake::TaskLib
 
@@ -248,6 +251,18 @@ class RDoc::Task < Rake::TaskLib
       RDoc::RDoc.new.document args
     end
 
+    namespace rdoc_task_name do
+      desc coverage_task_description
+      task coverage_task_name do
+        @before_running_rdoc.call if @before_running_rdoc
+        opts = option_list << "-C"
+        args = opts + @rdoc_files
+
+        $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
+        RDoc::RDoc.new.document args
+      end
+    end
+
     self
   end
 
@@ -288,6 +303,13 @@ class RDoc::Task < Rake::TaskLib
     "Rebuild RDoc HTML files"
   end
 
+  ##
+  # Task description for the coverage task or its renamed description
+
+  def coverage_task_description
+    "Print RDoc coverage report"
+  end
+
   private
 
   def rdoc_target
@@ -315,6 +337,10 @@ class RDoc::Task < Rake::TaskLib
     end
   end
 
+  def coverage_task_name
+    "coverage"
+  end
+
 end
 
 # :stopdoc:
@@ -323,7 +349,7 @@ module Rake
   ##
   # For backwards compatibility
 
-  RDocTask = RDoc::Task
+  RDocTask = RDoc::Task # :nodoc:
 
 end
 # :startdoc:

data/lib/rdoc/text.rb

@@ -10,6 +10,10 @@ require 'strscan'
 
 module RDoc::Text
 
+  ##
+  # The language for this text.  This affects stripping comments
+  # markers.
+
   attr_accessor :language
 
   ##
@@ -218,10 +222,10 @@ module RDoc::Text
       when s.scan(/\.\.\.(\.?)/) then
         html << s[1] << encoded[:ellipsis]
         after_word = nil
-      when s.scan(/\(c\)/) then
+      when s.scan(/\(c\)/i) then
         html << encoded[:copyright]
         after_word = nil
-      when s.scan(/\(r\)/) then
+      when s.scan(/\(r\)/i) then
         html << encoded[:trademark]
         after_word = nil
       when s.scan(/---/) then
@@ -237,10 +241,18 @@ module RDoc::Text
       when s.scan(/``/) then # backtick double quote
         html << encoded[:open_dquote]
         after_word = nil
-      when s.scan(/''/) then # tick double quote
+      when s.scan(/(?:&#39;|'){2}/) then # tick double quote
         html << encoded[:close_dquote]
         after_word = nil
-      when s.scan(/'/) then # single quote
+      when s.scan(/`/) then # backtick
+        if insquotes or after_word
+          html << '`'
+          after_word = false
+        else
+          html << encoded[:open_squote]
+          insquotes = true
+        end
+      when s.scan(/&#39;|'/) then # single quote
         if insquotes
           html << encoded[:close_squote]
           insquotes = false
@@ -301,4 +313,10 @@ module RDoc::Text
     res.join.strip
   end
 
+  ##
+  # Character class to be separated by a space when concatenating
+  # lines.
+
+  SPACE_SEPARATED_LETTER_CLASS = /[\p{Nd}\p{Lc}\p{Pc}]|[!-~&&\W]/
+
 end

data/lib/rdoc/token_stream.rb

@@ -112,8 +112,7 @@ module RDoc::TokenStream
   # Returns a string representation of the token stream
 
   def tokens_to_s
-    token_stream.compact.map { |token| token[:text] }.join ''
+    (token_stream or return '').compact.map { |token| token[:text] }.join ''
   end
 
 end
-