rdoc 6.3.4.1 → 8.0.0

data/lib/rdoc/ri/paths.rb

@@ -30,7 +30,7 @@ module RDoc::RI::Paths
   # :extra:: ri data directory from the command line.  Yielded for each
   #          entry in +extra_dirs+
 
-  def self.each system = true, site = true, home = true, gems = :latest, *extra_dirs # :yields: directory, type
+  def self.each(system = true, site = true, home = true, gems = :latest, *extra_dirs) # :yields: directory, type
     return enum_for __method__, system, site, home, gems, *extra_dirs unless
       block_given?
 
@@ -52,7 +52,7 @@ module RDoc::RI::Paths
   ##
   # The ri directory for the gem with +gem_name+.
 
-  def self.gem_dir name, version
+  def self.gem_dir(name, version)
     req = Gem::Requirement.new "= #{version}"
 
     spec = Gem::Specification.find_by_name name, req
@@ -67,7 +67,7 @@ module RDoc::RI::Paths
   # A +filter+ :all includes all versions of gems and includes gems without
   # ri documentation.
 
-  def self.gemdirs filter = :latest
+  def self.gemdirs(filter = :latest)
     ri_paths = {}
 
     all = Gem::Specification.map do |spec|

data/lib/rdoc/{servlet.rb → ri/servlet.rb}

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'rdoc'
+require_relative '../../rdoc'
 require 'erb'
 require 'time'
 require 'json'
@@ -24,14 +24,14 @@ end
 #
 #   server = WEBrick::HTTPServer.new Port: 8000
 #
-#   server.mount '/', RDoc::Servlet
+#   server.mount '/', RDoc::RI::Servlet
 #
 # If you want to mount the servlet some other place than the root, provide the
 # base path when mounting:
 #
-#   server.mount '/rdoc', RDoc::Servlet, '/rdoc'
+#   server.mount '/rdoc', RDoc::RI::Servlet, '/rdoc'
 
-class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
+class RDoc::RI::Servlet < WEBrick::HTTPServlet::AbstractServlet
 
   @server_stores = Hash.new { |hash, server| hash[server] = {} }
   @cache         = Hash.new { |hash, store|  hash[store]  = {} }
@@ -50,7 +50,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # Creates an instance of this servlet that shares cached data between
   # requests.
 
-  def self.get_instance server, *options # :nodoc:
+  def self.get_instance(server, *options) # :nodoc:
     stores = @server_stores[server]
 
     new server, stores, @cache, *options
@@ -66,7 +66,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # +server+ is provided automatically by WEBrick when mounting.  +stores+ and
   # +cache+ are provided automatically by the servlet.
 
-  def initialize server, stores, cache, mount_path = nil, extra_doc_dirs = []
+  def initialize(server, stores, cache, mount_path = nil, extra_doc_dirs = [])
     super server
 
     @cache      = cache
@@ -97,7 +97,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   ##
   # Serves the asset at the path in +req+ for +generator_name+ via +res+.
 
-  def asset generator_name, req, res
+  def asset(generator_name, req, res)
     asset_dir = @asset_dirs[generator_name]
 
     asset_path = File.join asset_dir, req.path
@@ -116,7 +116,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
+  def do_GET(req, res)
     req.path.sub!(/\A#{Regexp.escape @mount_path}/, '') if @mount_path
 
     case req.path
@@ -133,7 +133,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
       show_documentation req, res
     end
   rescue WEBrick::HTTPStatus::NotFound => e
-    generator = generator_for RDoc::Store.new
+    generator = generator_for RDoc::Store.new(@options)
 
     not_found generator, req, res, e.message
   rescue WEBrick::HTTPStatus::Status
@@ -149,7 +149,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # module or page name (/RDoc/Servlet.html becomes RDoc::Servlet).
   # +generator+ is used to create the page.
 
-  def documentation_page store, generator, path, req, res
+  def documentation_page(store, generator, path, req, res)
     text_name = path.chomp '.html'
     name = text_name.gsub '/', '::'
 
@@ -168,7 +168,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # Creates the JSON search index on +res+ for the given +store+.  +generator+
   # must respond to \#json_index to build.  +req+ is ignored.
 
-  def documentation_search store, generator, req, res
+  def documentation_search(store, generator, req, res)
     json_index = @cache[store].fetch :json_index do
       @cache[store][:json_index] =
         JSON.dump generator.json_index.build_index
@@ -182,7 +182,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # Returns the RDoc::Store and path relative to +mount_path+ for
   # documentation at +path+.
 
-  def documentation_source path
+  def documentation_source(path)
     _, source_name, path = path.split '/', 3
 
     store = @stores[source_name]
@@ -200,7 +200,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   ##
   # Generates an error page for the +exception+ while handling +req+ on +res+.
 
-  def error exception, req, res
+  def error(exception, req, res)
     backtrace = exception.backtrace.join "\n"
 
     res.content_type = 'text/html'
@@ -243,10 +243,11 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Instantiates a Darkfish generator for +store+
 
-  def generator_for store
+  def generator_for(store)
     generator = RDoc::Generator::Darkfish.new store, @options
     generator.file_output = false
     generator.asset_rel_path = '..'
+    generator.setup
 
     rdoc = RDoc::RDoc.new
     rdoc.store     = store
@@ -264,7 +265,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   # file has not been modified a Not Modified response is returned.  If the
   # file has been modified a Last-Modified header is added to +res+.
 
-  def if_modified_since req, res, path = nil
+  def if_modified_since(req, res, path = nil)
     last_modified = File.stat(path).mtime if path
 
     res['last-modified'] = last_modified.httpdate
@@ -290,7 +291,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   def installed_docs
     extra_counter = 0
     ri_paths.map do |path, type|
-      store = RDoc::Store.new path, type
+      store = RDoc::Store.new(@options, path: path, type: type)
       exists = File.exist? store.cache_path
 
       case type
@@ -315,7 +316,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Returns a 404 page built by +generator+ for +req+ on +res+.
 
-  def not_found generator, req, res, message = nil
+  def not_found(generator, req, res, message = nil)
     message ||= "The page <kbd>#{ERB::Util.h req.path}</kbd> was not found"
     res.body = generator.generate_servlet_not_found message
     res.status = 404
@@ -324,14 +325,14 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Enumerates the ri paths.  See RDoc::RI::Paths#each
 
-  def ri_paths &block
+  def ri_paths(&block)
     RDoc::RI::Paths.each true, true, true, :all, *@extra_doc_dirs, &block #TODO: pass extra_dirs
   end
 
   ##
   # Generates the root page on +res+.  +req+ is ignored.
 
-  def root req, res
+  def root(req, res)
     generator = RDoc::Generator::Darkfish.new nil, @options
 
     res.body = generator.generate_servlet_root installed_docs
@@ -342,7 +343,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Generates a search index for the root page on +res+.  +req+ is ignored.
 
-  def root_search req, res
+  def root_search(req, res)
     search_index = []
     info         = []
 
@@ -392,7 +393,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   # Displays documentation for +req+ on +res+, whether that be HTML or some
   # asset.
 
-  def show_documentation req, res
+  def show_documentation(req, res)
     store, path = documentation_source req.path
 
     if_modified_since req, res, store.cache_path
@@ -416,18 +417,18 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Returns an RDoc::Store for the given +source_name+ ('ruby' or a gem name).
 
-  def store_for source_name
+  def store_for(source_name)
     case source_name
     when 'home' then
-      RDoc::Store.new RDoc::RI::Paths.home_dir, :home
+      RDoc::Store.new(@options, path: RDoc::RI::Paths.home_dir, type: :home)
     when 'ruby' then
-      RDoc::Store.new RDoc::RI::Paths.system_dir, :system
+      RDoc::Store.new(@options, path: RDoc::RI::Paths.system_dir, type: :system)
     when 'site' then
-      RDoc::Store.new RDoc::RI::Paths.site_dir, :site
+      RDoc::Store.new(@options, path: RDoc::RI::Paths.site_dir, type: :site)
     when /\Aextra-(\d+)\z/ then
       index = $1.to_i - 1
       ri_dir = installed_docs[index][4]
-      RDoc::Store.new ri_dir, :extra
+      RDoc::Store.new(@options, path: ri_dir, type: :extra)
     else
       ri_dir, type = ri_paths.find do |dir, dir_type|
         next unless dir_type == :gem
@@ -438,7 +439,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
       raise WEBrick::HTTPStatus::NotFound,
             "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
+      store = RDoc::Store.new(@options, path: ri_dir, type: type)
 
       return store if File.exist? store.cache_path
 

data/lib/rdoc/ri/store.rb

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

data/lib/rdoc/ri/task.rb

@@ -26,8 +26,8 @@ require_relative '../task'
 #   require 'rdoc/ri/task'
 #
 #   RDoc::RI::Task.new do |ri|
-#     ri.main = 'README.rdoc'
-#     ri.rdoc_files.include 'README.rdoc', 'lib/**/*.rb'
+#     ri.main = 'README.md'
+#     ri.rdoc_files.include 'README.md', 'lib/**/*.rb'
 #   end
 #
 # For further configuration details see RDoc::Task.
@@ -44,7 +44,7 @@ class RDoc::RI::Task < RDoc::Task
   # Create an ri task with the given name. See RDoc::Task for documentation on
   # setting names.
 
-  def initialize name = DEFAULT_NAMES # :yield: self
+  def initialize(name = DEFAULT_NAMES) # :yield: self
     super
   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,9 @@ 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 :Servlet, "#{__dir__}/ri/servlet"
+  autoload :Store,   "#{__dir__}/ri/store"
 
 end
-

data/lib/rdoc/rubygems_hook.rb

@@ -1,15 +1,21 @@
 # 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
-# upon gem installation.
+# We define the following two similar name classes in this file:
 #
-# This file is automatically required by RubyGems 1.9 and newer.
+# - RDoc::RubyGemsHook
+# - RDoc::RubygemsHook
+#
+# RDoc::RubyGemsHook is the main class that has real logic.
+#
+# RDoc::RubygemsHook is a class that is only for
+# compatibility. RDoc::RubygemsHook is used by RubyGems directly. We
+# can remove this when all maintained RubyGems remove
+# `rubygems/rdoc.rb`.
 
-class RDoc::RubygemsHook
+class RDoc::RubyGemsHook
 
   include Gem::UserInteraction
   extend  Gem::UserInteraction
@@ -45,7 +51,7 @@ class RDoc::RubygemsHook
   # Post installs hook that generates documentation for each specification in
   # +specs+
 
-  def self.generation_hook installer, specs
+  def self.generate(installer, specs)
     start = Time.now
     types = installer.document
 
@@ -64,6 +70,10 @@ class RDoc::RubygemsHook
     say "Done installing documentation for #{names} after #{duration} seconds"
   end
 
+  def self.remove(uninstaller)
+    new(uninstaller.spec).remove
+  end
+
   ##
   # Loads the RDoc generator
 
@@ -82,7 +92,7 @@ class RDoc::RubygemsHook
   #
   # Only +generate_ri+ is enabled by default.
 
-  def initialize spec, generate_rdoc = false, generate_ri = true
+  def initialize(spec, generate_rdoc = false, generate_ri = true)
     @doc_dir   = spec.doc_dir
     @force     = false
     @rdoc      = nil
@@ -100,7 +110,7 @@ class RDoc::RubygemsHook
   #--
   # TODO move to RDoc::Options
 
-  def delete_legacy_args args
+  def delete_legacy_args(args)
     args.delete '--inline-source'
     args.delete '--promiscuous'
     args.delete '-p'
@@ -108,19 +118,21 @@ class RDoc::RubygemsHook
   end
 
   ##
-  # Generates documentation using the named +generator+ ("darkfish" or "ri")
+  # Generates documentation using the named +generator+ ("aliki" or "ri")
   # and following the given +options+.
   #
   # Documentation will be generated into +destination+
 
-  def document generator, options, destination
+  def document(generator, options, destination)
     generator_name = generator
 
     options = options.dup
     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
 
@@ -169,31 +181,28 @@ class RDoc::RubygemsHook
       options = ::RDoc::Options.new
       options.default_title = "#{@spec.full_name} Documentation"
       options.parse args
+      options.quiet = !Gem.configuration.really_verbose
     end
 
-    options.quiet = !Gem.configuration.really_verbose
-
     @rdoc = new_rdoc
-    @rdoc.options = options
-
-    store = RDoc::Store.new
-    store.encoding = options.encoding
-    store.dry_run  = options.dry_run
-    store.main     = options.main_page
-    store.title    = options.title
-
-    @rdoc.store = store
 
     say "Parsing documentation for #{@spec.full_name}"
 
     Dir.chdir @spec.full_gem_path do
-      @rdoc.parse_files options.files
+      # RDoc::Options#finish must be called before parse_files.
+      # RDoc::Options#finish is also called after ri/aliki generator setup.
+      # We need to dup the options to avoid modifying it after finish is called.
+      parse_options = options.dup
+      parse_options.finish
+      @rdoc.options = parse_options
+      @rdoc.store = RDoc::Store.new(parse_options)
+      @rdoc.parse_files parse_options.files
     end
 
     document 'ri',       options, @ri_dir if
       @generate_ri   and (@force or not File.exist? @ri_dir)
 
-    document 'darkfish', options, @rdoc_dir if
+    document 'aliki', options, @rdoc_dir if
       @generate_rdoc and (@force or not File.exist? @rdoc_dir)
   end
 
@@ -244,3 +253,75 @@ class RDoc::RubygemsHook
   end
 
 end
+
+module RDoc
+  # This class is referenced by RubyGems to create documents.
+  # All implementations are moved to the above RubyGemsHook.
+  #
+  # This class does nothing when this RDoc is installed as a normal gem
+  # or a bundled gem.
+  #
+  # This class does generate/remove documents for compatibility when
+  # this RDoc is installed as a default gem.
+  #
+  # We can remove this when all maintained RubyGems remove
+  # `rubygems/rdoc.rb`.
+  class RubygemsHook
+
+    attr_accessor :generate_rdoc, :generate_ri, :force
+
+    def self.default_gem?
+      !File.exist?(File.join(__dir__, "..", "rubygems_plugin.rb"))
+    end
+
+    def initialize(spec, generate_rdoc = false, generate_ri = true)
+      @spec = spec
+      @generate_rdoc = generate_rdoc
+      @generate_ri   = generate_ri
+      @force = false
+    end
+
+    def generate
+      # Do nothing if this is NOT a default gem.
+      return unless self.class.default_gem?
+
+      # Generate document for compatibility if this is a default gem.
+      hook = RubyGemsHook.new(@spec, @generate_rdoc, @generate_ri)
+      hook.force = @force
+      hook.generate
+    end
+
+    def remove
+      # Do nothing if this is NOT a default gem.
+      return unless self.class.default_gem?
+
+      # Remove generated document for compatibility if this is a
+      # default gem.
+      RubyGemsHook.new(@spec).remove
+    end
+
+    def self.generation_hook(installer, specs)
+      # Do nothing if this is NOT a default gem.
+      return unless default_gem?
+
+      # Generate document for compatibility if this is a default gem.
+      RubyGemsHook.generate(installer, specs)
+    end
+
+    def self.load_rdoc
+      RubyGemsHook.load_rdoc
+    end
+
+    def self.rdoc_version
+      RubyGemsHook.rdoc_version
+    end
+
+    def rdoc_installed?
+      RubyGemsHook.new(@spec).rdoc_installed?
+    end
+
+    def ri_installed?
+      RubyGemsHook.new(@spec).ri_installed?
+    end
+  end
+end