rdoc 6.4.0 → 6.5.0

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
 
@@ -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
@@ -440,11 +454,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/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.
@@ -433,9 +420,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
 
   ##
@@ -1051,36 +1035,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 +1074,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 +1106,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.
@@ -1353,7 +1300,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 +1467,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.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,10 @@ 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.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'
 
@@ -71,7 +71,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
@@ -323,7 +323,7 @@ module Rake
   ##
   # For backwards compatibility
 
-  RDocTask = RDoc::Task
+  RDocTask = RDoc::Task # :nodoc:
 
 end
 # :startdoc:

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.5.0'
 
 end

data/lib/rdoc.rb

@@ -62,7 +62,7 @@ module RDoc
 
   class Error < RuntimeError; end
 
-  require 'rdoc/version'
+  require_relative 'rdoc/version'
 
   ##
   # Method visibilities
@@ -141,61 +141,61 @@ module RDoc
     end
   end
 
-  autoload :RDoc,           'rdoc/rdoc'
+  autoload :RDoc,           "#{__dir__}/rdoc/rdoc"
 
-  autoload :CrossReference, 'rdoc/cross_reference'
-  autoload :ERBIO,          'rdoc/erbio'
-  autoload :ERBPartial,     'rdoc/erb_partial'
-  autoload :Encoding,       'rdoc/encoding'
-  autoload :Generator,      'rdoc/generator'
-  autoload :Options,        'rdoc/options'
-  autoload :Parser,         'rdoc/parser'
-  autoload :Servlet,        'rdoc/servlet'
-  autoload :RI,             'rdoc/ri'
-  autoload :Stats,          'rdoc/stats'
-  autoload :Store,          'rdoc/store'
-  autoload :Task,           'rdoc/task'
-  autoload :Text,           'rdoc/text'
+  autoload :CrossReference, "#{__dir__}/rdoc/cross_reference"
+  autoload :ERBIO,          "#{__dir__}/rdoc/erbio"
+  autoload :ERBPartial,     "#{__dir__}/rdoc/erb_partial"
+  autoload :Encoding,       "#{__dir__}/rdoc/encoding"
+  autoload :Generator,      "#{__dir__}/rdoc/generator"
+  autoload :Options,        "#{__dir__}/rdoc/options"
+  autoload :Parser,         "#{__dir__}/rdoc/parser"
+  autoload :Servlet,        "#{__dir__}/rdoc/servlet"
+  autoload :RI,             "#{__dir__}/rdoc/ri"
+  autoload :Stats,          "#{__dir__}/rdoc/stats"
+  autoload :Store,          "#{__dir__}/rdoc/store"
+  autoload :Task,           "#{__dir__}/rdoc/task"
+  autoload :Text,           "#{__dir__}/rdoc/text"
 
-  autoload :Markdown,       'rdoc/markdown'
-  autoload :Markup,         'rdoc/markup'
-  autoload :RD,             'rdoc/rd'
-  autoload :TomDoc,         'rdoc/tom_doc'
+  autoload :Markdown,       "#{__dir__}/rdoc/markdown"
+  autoload :Markup,         "#{__dir__}/rdoc/markup"
+  autoload :RD,             "#{__dir__}/rdoc/rd"
+  autoload :TomDoc,         "#{__dir__}/rdoc/tom_doc"
 
-  autoload :KNOWN_CLASSES,  'rdoc/known_classes'
+  autoload :KNOWN_CLASSES,  "#{__dir__}/rdoc/known_classes"
 
-  autoload :TokenStream,    'rdoc/token_stream'
+  autoload :TokenStream,    "#{__dir__}/rdoc/token_stream"
 
-  autoload :Comment,        'rdoc/comment'
+  autoload :Comment,        "#{__dir__}/rdoc/comment"
 
-  require 'rdoc/i18n'
+  require_relative 'rdoc/i18n'
 
   # code objects
   #
   # We represent the various high-level code constructs that appear in Ruby
   # programs: classes, modules, methods, and so on.
-  autoload :CodeObject,     'rdoc/code_object'
-
-  autoload :Context,        'rdoc/context'
-  autoload :TopLevel,       'rdoc/top_level'
-
-  autoload :AnonClass,      'rdoc/anon_class'
-  autoload :ClassModule,    'rdoc/class_module'
-  autoload :NormalClass,    'rdoc/normal_class'
-  autoload :NormalModule,   'rdoc/normal_module'
-  autoload :SingleClass,    'rdoc/single_class'
-
-  autoload :Alias,          'rdoc/alias'
-  autoload :AnyMethod,      'rdoc/any_method'
-  autoload :MethodAttr,     'rdoc/method_attr'
-  autoload :GhostMethod,    'rdoc/ghost_method'
-  autoload :MetaMethod,     'rdoc/meta_method'
-  autoload :Attr,           'rdoc/attr'
-
-  autoload :Constant,       'rdoc/constant'
-  autoload :Mixin,          'rdoc/mixin'
-  autoload :Include,        'rdoc/include'
-  autoload :Extend,         'rdoc/extend'
-  autoload :Require,        'rdoc/require'
+  autoload :CodeObject,     "#{__dir__}/rdoc/code_object"
+
+  autoload :Context,        "#{__dir__}/rdoc/context"
+  autoload :TopLevel,       "#{__dir__}/rdoc/top_level"
+
+  autoload :AnonClass,      "#{__dir__}/rdoc/anon_class"
+  autoload :ClassModule,    "#{__dir__}/rdoc/class_module"
+  autoload :NormalClass,    "#{__dir__}/rdoc/normal_class"
+  autoload :NormalModule,   "#{__dir__}/rdoc/normal_module"
+  autoload :SingleClass,    "#{__dir__}/rdoc/single_class"
+
+  autoload :Alias,          "#{__dir__}/rdoc/alias"
+  autoload :AnyMethod,      "#{__dir__}/rdoc/any_method"
+  autoload :MethodAttr,     "#{__dir__}/rdoc/method_attr"
+  autoload :GhostMethod,    "#{__dir__}/rdoc/ghost_method"
+  autoload :MetaMethod,     "#{__dir__}/rdoc/meta_method"
+  autoload :Attr,           "#{__dir__}/rdoc/attr"
+
+  autoload :Constant,       "#{__dir__}/rdoc/constant"
+  autoload :Mixin,          "#{__dir__}/rdoc/mixin"
+  autoload :Include,        "#{__dir__}/rdoc/include"
+  autoload :Extend,         "#{__dir__}/rdoc/extend"
+  autoload :Require,        "#{__dir__}/rdoc/require"
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.5.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -46,8 +46,8 @@ executables:
 - ri
 extensions: []
 extra_rdoc_files:
-- CVE-2013-0256.rdoc
 - CONTRIBUTING.rdoc
+- CVE-2013-0256.rdoc
 - ExampleMarkdown.md
 - ExampleRDoc.rdoc
 - History.rdoc
@@ -61,16 +61,12 @@ files:
 - CVE-2013-0256.rdoc
 - ExampleMarkdown.md
 - ExampleRDoc.rdoc
-- Gemfile
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
 - README.rdoc
 - RI.rdoc
-- Rakefile
 - TODO.rdoc
-- bin/console
-- bin/setup
 - exe/rdoc
 - exe/ri
 - lib/rdoc.rb
@@ -250,7 +246,6 @@ files:
 - lib/rdoc/top_level.rb
 - lib/rdoc/version.rb
 - man/ri.1
-- rdoc.gemspec
 homepage: https://ruby.github.io/rdoc
 licenses:
 - Ruby
@@ -272,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects

data/Gemfile

@@ -1,12 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development do
-  gem 'rake'
-  gem 'racc', '> 1.4.10'
-  gem 'kpeg', github: 'evanphx/kpeg'
-  gem 'test-unit'
-  gem 'rubocop'
-  gem 'gettext'
-end

data/Rakefile

@@ -1,107 +0,0 @@
-$:.unshift File.expand_path 'lib'
-require 'rdoc/task'
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-task :docs    => :generate
-task :test    => [:normal_test, :rubygems_test]
-
-PARSER_FILES = %w[
-  lib/rdoc/rd/block_parser.ry
-  lib/rdoc/rd/inline_parser.ry
-  lib/rdoc/markdown.kpeg
-  lib/rdoc/markdown/literals.kpeg
-]
-
-$rdoc_rakefile = true
-
-task :default => :test
-
-RDoc::Task.new do |doc|
-  doc.main = 'README.rdoc'
-  doc.title = "rdoc #{RDoc::VERSION} Documentation"
-  doc.rdoc_dir = 'html'
-  doc.rdoc_files = FileList.new %w[lib/**/*.rb *.rdoc] - PARSER_FILES
-end
-
-task ghpages: :rdoc do
-  `git checkout gh-pages`
-  require "fileutils"
-  FileUtils.rm_rf "/tmp/html"
-  FileUtils.mv "html", "/tmp"
-  FileUtils.rm_rf "*"
-  FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
-end
-
-Rake::TestTask.new(:normal_test) do |t|
-  t.libs << "test/rdoc"
-  t.verbose = true
-  t.deps = :generate
-  t.test_files = FileList["test/**/test_*.rb"].exclude("test/rdoc/test_rdoc_rubygems_hook.rb")
-end
-
-Rake::TestTask.new(:rubygems_test) do |t|
-  t.libs << "test/rdoc"
-  t.verbose = true
-  t.deps = :generate
-  t.pattern = "test/rdoc/test_rdoc_rubygems_hook.rb"
-end
-
-path = "pkg/#{Bundler::GemHelper.gemspec.full_name}"
-
-package_parser_files = PARSER_FILES.map do |parser_file|
-  name = File.basename(parser_file, File.extname(parser_file))
-  _path = File.dirname(parser_file)
-  package_parser_file = "#{path}/#{name}.rb"
-  parsed_file = "#{_path}/#{name}.rb"
-
-  file package_parser_file => parsed_file # ensure copy runs before racc
-
-  package_parser_file
-end
-
-parsed_files = PARSER_FILES.map do |parser_file|
-  ext = File.extname(parser_file)
-  parsed_file = "#{parser_file.chomp(ext)}.rb"
-
-  file parsed_file => parser_file do |t|
-    puts "Generating #{parsed_file}..."
-    case ext
-    when '.ry' # need racc
-      racc = Gem.bin_path 'racc', 'racc'
-      rb_file = parser_file.gsub(/\.ry\z/, ".rb")
-      ruby "#{racc} -l -o #{rb_file} #{parser_file}"
-      open(rb_file, 'r+') do |f|
-        newtext = "# frozen_string_literal: true\n#{f.read}"
-        f.rewind
-        f.write newtext
-      end
-    when '.kpeg' # need kpeg
-      kpeg = Gem.bin_path 'kpeg', 'kpeg'
-      rb_file = parser_file.gsub(/\.kpeg\z/, ".rb")
-      ruby "#{kpeg} -fsv -o #{rb_file} #{parser_file}"
-    end
-  end
-
-  parsed_file
-end
-
-task "#{path}.gem" => package_parser_files
-desc "Generate all files used racc and kpeg"
-task :generate => parsed_files
-
-task :clean do
-  parsed_files.each do |path|
-    File.delete(path) if File.exist?(path)
-  end
-end
-
-begin
-  require 'rubocop/rake_task'
-rescue LoadError
-else
-  RuboCop::RakeTask.new(:rubocop) do |t|
-    t.options = [*parsed_files]
-  end
-  task :build => [:generate, "rubocop:auto_correct"]
-end

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rdoc"
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install