rdoc 6.4.0 → 6.6.0

data/lib/rdoc/rd/block_parser.ry

@@ -230,8 +230,6 @@ end
 
 # :stopdoc:
 
-TMPFILE = ["rdtmp", $$, 0]
-
 MARK_TO_LEVEL = {
   '='    => 1,
   '=='   => 2,
@@ -341,15 +339,19 @@ def next_token # :nodoc:
     # non-RD part begin
     when /^=begin\s+(\w+)/
       part = $1
+=begin # not imported to RDoc
       if @in_part # if in non-RD part
         @part_content.push(line)
       else
         @in_part = part if @tree.filter[part] # if filter exists
 #  p "BEGIN_PART: #{@in_part}" # DEBUG
       end
+=end
+      @in_part = part
     # non-RD part end
-    when /^=end/
+    when /^=end(?:$|[\s\0\C-d\C-z])/
       if @in_part # if in non-RD part
+=begin # not imported to RDoc
 #  p "END_PART: #{@in_part}" # DEBUG
         # make Part-in object
         part = RDoc::RD::Part.new(@part_content.join(""), @tree, "r")
@@ -360,20 +362,22 @@ def next_token # :nodoc:
         if @tree.filter[@in_part].mode == :rd # if output is RD formatted
           subtree = parse_subtree(part_out.to_a)
         else # if output is target formatted
-          basename = TMPFILE.join('.')
-          TMPFILE[-1] += 1
-          tmpfile = open(@tree.tmp_dir + "/" + basename + ".#{@in_part}", "w")
-          tmpfile.print(part_out)
-          tmpfile.close
+          basename = Tempfile.create(["rdtmp", ".#{@in_part}"], @tree.tmp_dir) do |tmpfile|
+            tmpfile.print(part_out)
+            File.basename(tmpfile.path)
+          end
           subtree = parse_subtree(["=begin\n", "<<< #{basename}\n", "=end\n"])
         end
         @in_part = nil
         return [:SUBTREE, subtree]
+=end
       end
     else
+=begin # not imported to RDoc
       if @in_part # if in non-RD part
         @part_content.push(line)
       end
+=end
     end
   end
 
@@ -568,7 +572,7 @@ def get_included(file)
     file_name = File.join dir, file
 
     if File.exist? file_name then
-      included = IO.readlines file_name
+      included = File.readlines file_name
       break
     end
   end

data/lib/rdoc/rd/inline.rb

@@ -69,4 +69,3 @@ class RDoc::RD::Inline
   alias to_s rdoc # :nodoc:
 
 end
-

data/lib/rdoc/rd/inline_parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.5.2
+# This file is automatically generated by Racc 1.7.1
 # from Racc grammar file "".
 #
 
@@ -652,6 +652,7 @@ Racc_arg = [
   racc_shift_n,
   racc_reduce_n,
   racc_use_result_var ]
+Ractor.make_shareable(Racc_arg) if defined?(Ractor)
 
 Racc_token_to_s_table = [
   "$end",
@@ -723,6 +724,7 @@ Racc_token_to_s_table = [
   "normal_strings",
   "verb_string",
   "verb_normal_string" ]
+Ractor.make_shareable(Racc_token_to_s_table) if defined?(Ractor)
 
 Racc_debug_parser = false
 

data/lib/rdoc/rd.rb

@@ -92,9 +92,8 @@ class RDoc::RD
     document
   end
 
-  autoload :BlockParser,  'rdoc/rd/block_parser'
-  autoload :InlineParser, 'rdoc/rd/inline_parser'
-  autoload :Inline,       'rdoc/rd/inline'
+  autoload :BlockParser,  "#{__dir__}/rd/block_parser"
+  autoload :InlineParser, "#{__dir__}/rd/inline_parser"
+  autoload :Inline,       "#{__dir__}/rd/inline"
 
 end
-

data/lib/rdoc/rdoc.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'rdoc'
+require_relative '../rdoc'
 
 require 'find'
 require 'fileutils'
@@ -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
 
@@ -280,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
@@ -415,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
 
@@ -440,11 +452,11 @@ The internal error was:
 
     if RDoc::Options === options then
       @options = options
-      @options.finish
     else
       @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
@@ -433,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
 
   ##
@@ -964,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
@@ -1051,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".
@@ -1120,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."
@@ -1148,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.
@@ -1290,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
@@ -1353,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
@@ -1521,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

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

@@ -557,7 +557,7 @@ class RDoc::Store
     #orig_enc = @encoding
 
     File.open cache_path, 'rb' do |io|
-      @cache = Marshal.load io.read
+      @cache = Marshal.load io
     end
 
     load_enc = @cache[:encoding]
@@ -616,7 +616,7 @@ class RDoc::Store
     file = class_file klass_name
 
     File.open file, 'rb' do |io|
-      Marshal.load io.read
+      Marshal.load io
     end
   rescue Errno::ENOENT => e
     error = MissingFileError.new(self, file, klass_name)
@@ -631,7 +631,7 @@ class RDoc::Store
     file = method_file klass_name, method_name
 
     File.open file, 'rb' do |io|
-      obj = Marshal.load io.read
+      obj = Marshal.load io
       obj.store = self
       obj.parent =
         find_class_or_module(klass_name) || load_class(klass_name) unless
@@ -651,7 +651,7 @@ class RDoc::Store
     file = page_file page_name
 
     File.open file, 'rb' do |io|
-      obj = Marshal.load io.read
+      obj = Marshal.load io
       obj.store = self
       obj
     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/token_stream.rb

@@ -116,4 +116,3 @@ module RDoc::TokenStream
   end
 
 end
-

data/lib/rdoc/top_level.rb

@@ -286,4 +286,3 @@ class RDoc::TopLevel < RDoc::Context
   end
 
 end
-

data/lib/rdoc/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module RDoc
 
   ##
   # RDoc version you are using
 
-  VERSION = '6.4.0'
+  VERSION = '6.6.0'
 
 end