rdoc 5.0.0 → 6.3.1

data/lib/rdoc/ri/formatter.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # For RubyGems backwards compatibility
 

data/lib/rdoc/ri/paths.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: false
-require 'rdoc/ri'
+# frozen_string_literal: true
+require_relative '../rdoc'
 
 ##
 # The directories where ri data lives.  Paths can be enumerated via ::each, or
@@ -12,23 +12,9 @@ module RDoc::RI::Paths
 
   version = RbConfig::CONFIG['ruby_version']
 
-  BASE    = if RbConfig::CONFIG.key? 'ridir' then
-              File.join RbConfig::CONFIG['ridir'], version
-            else
-              File.join RbConfig::CONFIG['datadir'], 'ri', version
-            end
+  BASE    = File.join RbConfig::CONFIG['ridir'], version
 
-  homedir = begin
-              File.expand_path('~')
-            rescue ArgumentError
-            end
-
-  homedir ||= ENV['HOME'] ||
-              ENV['USERPROFILE'] || ENV['HOMEPATH'] # for 1.8 compatibility
-
-  HOMEDIR = if homedir then
-              File.join homedir, ".rdoc"
-            end
+  HOMEDIR = RDoc.home
   #:startdoc:
 
   ##

data/lib/rdoc/ri/store.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 module RDoc::RI
 
   Store = RDoc::Store # :nodoc:

data/lib/rdoc/ri/task.rb

@@ -1,10 +1,10 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 begin
   gem 'rdoc'
 rescue Gem::LoadError
 end unless defined?(RDoc)
 
-require 'rdoc/task'
+require_relative '../task'
 
 ##
 # RDoc::RI::Task creates ri data in <code>./.rdoc</code> for your project.

data/lib/rdoc/ri.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'rdoc'
 
 ##

data/lib/rdoc/rubygems_hook.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'rubygems/user_interaction'
 require 'fileutils'
 require 'rdoc'
@@ -70,7 +70,7 @@ class RDoc::RubygemsHook
   def self.load_rdoc
     return if @rdoc_version
 
-    require 'rdoc/rdoc'
+    require_relative 'rdoc'
 
     @rdoc_version = Gem::Version.new ::RDoc::VERSION
   end
@@ -158,7 +158,7 @@ class RDoc::RubygemsHook
 
     case config_args = Gem.configuration[:rdoc]
     when String then
-      args = args.concat config_args.split
+      args = args.concat config_args.split(' ')
     when Array then
       args = args.concat config_args
     end

data/lib/rdoc/servlet.rb

@@ -1,8 +1,14 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'rdoc'
+require 'erb'
 require 'time'
 require 'json'
-require 'webrick'
+
+begin
+  require 'webrick'
+rescue LoadError
+  abort "webrick is not found. You may need to `gem install webrick` to install webrick."
+end
 
 ##
 # This is a WEBrick servlet that allows you to browse ri documentation.
@@ -101,9 +107,9 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
     res.body = File.read asset_path
 
     res.content_type = case req.path
-                       when /css$/ then 'text/css'
-                       when /js$/  then 'application/javascript'
-                       else             'application/octet-stream'
+                       when /\.css\z/ then 'text/css'
+                       when /\.js\z/  then 'application/javascript'
+                       else                'application/octet-stream'
                        end
   end
 
@@ -111,7 +117,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # GET request entry point.  Fills in +res+ for the path, etc. in +req+.
 
   def do_GET req, res
-    req.path.sub!(/^#{Regexp.escape @mount_path}/o, '') if @mount_path
+    req.path.sub!(/\A#{Regexp.escape @mount_path}/, '') if @mount_path
 
     case req.path
     when '/' then
@@ -144,11 +150,14 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # +generator+ is used to create the page.
 
   def documentation_page store, generator, path, req, res
-    name = path.sub(/.html$/, '').gsub '/', '::'
+    text_name = path.chomp '.html'
+    name = text_name.gsub '/', '::'
 
     if klass = store.find_class_or_module(name) then
       res.body = generator.generate_class klass
-    elsif page = store.find_text_page(name.sub(/_([^_]*)$/, '.\1')) then
+    elsif page = store.find_text_page(name.sub(/_([^_]*)\z/, '.\1')) then
+      res.body = generator.generate_page page
+    elsif page = store.find_text_page(text_name.sub(/_([^_]*)\z/, '.\1')) then
       res.body = generator.generate_page page
     else
       not_found generator, req, res
@@ -217,7 +226,7 @@ exception:
 <pre>#{ERB::Util.html_escape exception.message}</pre>
 
 <p>Please report this to the
-<a href="https://github.com/rdoc/rdoc/issues">RDoc issues tracker</a>.  Please
+<a href="https://github.com/ruby/rdoc/issues">RDoc issues tracker</a>.  Please
 include the RDoc version, the URI above and exception class, message and
 backtrace.  If you're viewing a gem's documentation, include the gem name and
 version.  If you're viewing Ruby's documentation, include the version of ruby.
@@ -415,7 +424,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
       RDoc::Store.new RDoc::RI::Paths.system_dir, :system
     when 'site' then
       RDoc::Store.new RDoc::RI::Paths.site_dir, :site
-    when /^extra-(\d+)$/ then
+    when /\Aextra-(\d+)\z/ then
       index = $1.to_i - 1
       ri_dir = installed_docs[index][4]
       RDoc::Store.new ri_dir, :extra
@@ -427,14 +436,14 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
       end
 
       raise WEBrick::HTTPStatus::NotFound,
-            "Could not find gem \"#{source_name}\". Are you sure you installed it?" unless ri_dir
+            "Could not find gem \"#{ERB::Util.html_escape(source_name)}\". Are you sure you installed it?" unless ri_dir
 
       store = RDoc::Store.new ri_dir, type
 
       return store if File.exist? store.cache_path
 
       raise WEBrick::HTTPStatus::NotFound,
-            "Could not find documentation for \"#{source_name}\". Please run `gem rdoc --ri gem_name`"
+            "Could not find documentation for \"#{ERB::Util.html_escape(source_name)}\". Please run `gem rdoc --ri gem_name`"
 
     end
   end

data/lib/rdoc/single_class.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A singleton class
 

data/lib/rdoc/stats/normal.rb

@@ -1,5 +1,10 @@
-# frozen_string_literal: false
-require 'io/console/size'
+# frozen_string_literal: true
+begin
+  require 'io/console/size'
+rescue LoadError
+  # for JRuby
+  require 'io/console'
+end
 
 ##
 # Stats printer that prints just the files being documented with a progress
@@ -21,27 +26,28 @@ class RDoc::Stats::Normal < RDoc::Stats::Quiet
                            files_so_far,
                            @num_files)
 
-    # Print a progress bar, but make sure it fits on a single line. Filename
-    # will be truncated if necessary.
-    terminal_width = IO.console_size[1].to_i.nonzero? || 80
-    max_filename_size = terminal_width - progress_bar.size
-
-    if filename.size > max_filename_size then
-      # Turn "some_long_filename.rb" to "...ong_filename.rb"
-      filename = filename[(filename.size - max_filename_size) .. -1]
-      filename[0..2] = "..."
-    end
-
-    line = "#{progress_bar}#{filename}"
     if $stdout.tty?
+      # Print a progress bar, but make sure it fits on a single line. Filename
+      # will be truncated if necessary.
+      size = IO.respond_to?(:console_size) ? IO.console_size : IO.console.winsize
+      terminal_width = size[1].to_i.nonzero? || 80
+      max_filename_size = (terminal_width - progress_bar.size) - 1
+
+      if filename.size > max_filename_size then
+        # Turn "some_long_filename.rb" to "...ong_filename.rb"
+        filename = filename[(filename.size - max_filename_size) .. -1]
+        filename[0..2] = "..."
+      end
+
       # Clean the line with whitespaces so that leftover output from the
       # previous line doesn't show up.
-      $stdout.print("\r" << (" " * @last_width) << ("\b" * @last_width) << "\r") if @last_width && @last_width > 0
-      @last_width = line.size
-      $stdout.print("#{line}\r")
+      $stdout.print("\r\e[K") if @last_width && @last_width > 0
+      @last_width = progress_bar.size + filename.size
+      term = "\r"
     else
-      $stdout.puts(line)
+      term = "\n"
     end
+    $stdout.print(progress_bar, filename, term)
     $stdout.flush
   end
 

data/lib/rdoc/stats/quiet.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Stats printer that prints nothing
 

data/lib/rdoc/stats/verbose.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Stats printer that prints everything documented, including the documented
 # status

data/lib/rdoc/stats.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # RDoc statistics collector which prints a summary and report of a project's
 # documentation totals.

data/lib/rdoc/store.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'fileutils'
 
 ##
@@ -116,6 +116,11 @@ class RDoc::Store
 
   attr_accessor :encoding
 
+  ##
+  # The lazy constants alias will be discovered in passing
+
+  attr_reader :unmatched_constant_alias
+
   ##
   # Creates a new Store of +type+ that will load or save to +path+
 
@@ -143,6 +148,7 @@ class RDoc::Store
     @classes_hash = {}
     @modules_hash = {}
     @files_hash   = {}
+    @text_files_hash = {}
 
     @c_enclosure_classes = {}
     @c_enclosure_names   = {}
@@ -152,6 +158,8 @@ class RDoc::Store
 
     @unique_classes = nil
     @unique_modules = nil
+
+    @unmatched_constant_alias = {}
   end
 
   ##
@@ -177,16 +185,24 @@ class RDoc::Store
   # Adds the file with +name+ as an RDoc::TopLevel to the store.  Returns the
   # created RDoc::TopLevel.
 
-  def add_file absolute_name, relative_name = absolute_name
+  def add_file absolute_name, relative_name: absolute_name, parser: nil
     unless top_level = @files_hash[relative_name] then
       top_level = RDoc::TopLevel.new absolute_name, relative_name
+      top_level.parser = parser if parser
       top_level.store = self
       @files_hash[relative_name] = top_level
+      @text_files_hash[relative_name] = top_level if top_level.text?
     end
 
     top_level
   end
 
+  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?
+    end
+  end
+
   ##
   # Returns all classes discovered by RDoc
 
@@ -421,8 +437,8 @@ class RDoc::Store
   # +file_name+
 
   def find_text_page file_name
-    @files_hash.each_value.find do |file|
-      file.text? and file.full_name == file_name
+    @text_files_hash.each_value.find do |file|
+      file.full_name == file_name
     end
   end
 
@@ -466,7 +482,7 @@ class RDoc::Store
     when :gem    then
       parent = File.expand_path '..', @path
       "gem #{File.basename parent}"
-    when :home   then '~/.rdoc'
+    when :home   then RDoc.home
     when :site   then 'ruby site'
     when :system then 'ruby core'
     else @path
@@ -530,6 +546,7 @@ class RDoc::Store
     @cache[:pages].each do |page_name|
       page = load_page page_name
       @files_hash[page_name] = page
+      @text_files_hash[page_name] = page if page.text?
     end
   end
 
@@ -539,7 +556,7 @@ class RDoc::Store
   def load_cache
     #orig_enc = @encoding
 
-    open cache_path, 'rb' do |io|
+    File.open cache_path, 'rb' do |io|
       @cache = Marshal.load io.read
     end
 
@@ -585,6 +602,8 @@ class RDoc::Store
     case obj
     when RDoc::NormalClass then
       @classes_hash[klass_name] = obj
+    when RDoc::SingleClass then
+      @classes_hash[klass_name] = obj
     when RDoc::NormalModule then
       @modules_hash[klass_name] = obj
     end
@@ -596,7 +615,7 @@ class RDoc::Store
   def load_class_data klass_name
     file = class_file klass_name
 
-    open file, 'rb' do |io|
+    File.open file, 'rb' do |io|
       Marshal.load io.read
     end
   rescue Errno::ENOENT => e
@@ -611,7 +630,7 @@ class RDoc::Store
   def load_method klass_name, method_name
     file = method_file klass_name, method_name
 
-    open file, 'rb' do |io|
+    File.open file, 'rb' do |io|
       obj = Marshal.load io.read
       obj.store = self
       obj.parent =
@@ -631,7 +650,7 @@ class RDoc::Store
   def load_page page_name
     file = page_file page_name
 
-    open file, 'rb' do |io|
+    File.open file, 'rb' do |io|
       obj = Marshal.load io.read
       obj.store = self
       obj
@@ -703,8 +722,8 @@ class RDoc::Store
   # Returns the RDoc::TopLevel that is a text file and has the given +name+
 
   def page name
-    @files_hash.each_value.find do |file|
-      file.text? and file.page_name == name
+    @text_files_hash.each_value.find do |file|
+      file.page_name == name or file.base_name == name
     end
   end
 
@@ -776,10 +795,8 @@ class RDoc::Store
 
     return if @dry_run
 
-    marshal = Marshal.dump @cache
-
-    open cache_path, 'wb' do |io|
-      io.write marshal
+    File.open cache_path, 'wb' do |io|
+      Marshal.dump @cache, io
     end
   end
 
@@ -852,10 +869,8 @@ class RDoc::Store
 
     FileUtils.rm_f to_delete
 
-    marshal = Marshal.dump klass
-
-    open path, 'wb' do |io|
-      io.write marshal
+    File.open path, 'wb' do |io|
+      Marshal.dump klass, io
     end
   end
 
@@ -877,10 +892,8 @@ class RDoc::Store
 
     return if @dry_run
 
-    marshal = Marshal.dump method
-
-    open method_file(full_name, method.full_name), 'wb' do |io|
-      io.write marshal
+    File.open method_file(full_name, method.full_name), 'wb' do |io|
+      Marshal.dump method, io
     end
   end
 
@@ -899,10 +912,8 @@ class RDoc::Store
 
     return if @dry_run
 
-    marshal = Marshal.dump page
-
-    open path, 'wb' do |io|
-      io.write marshal
+    File.open path, 'wb' do |io|
+      Marshal.dump page, io
     end
   end