Basic server mode support

Gemfile

@@ -11,4 +11,5 @@ group :development do
   gem 'rubocop', '>= 1.31.0'
   gem 'gettext'
   gem 'prism', '>= 0.30.0'
+  gem 'webrick'
 end

lib/rdoc.rb

@@ -162,12 +162,12 @@ def self.home
   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 :Server,         "#{__dir__}/rdoc/server"
 
   autoload :Markdown,       "#{__dir__}/rdoc/markdown"
   autoload :Markup,         "#{__dir__}/rdoc/markup"

lib/rdoc/generator/darkfish.rb

@@ -238,19 +238,21 @@ def write_style_sheet
   # Build the initial indices and output objects based on an array of TopLevel
   # objects containing the extracted information.
 
-  def generate
+  def generate(server_mode: false)
     setup
 
     write_style_sheet
     generate_index
     generate_class_files
     generate_file_files
     generate_table_of_contents
-    @json_index.generate
-    @json_index.generate_gzipped
-
-    copy_static
 
+    unless server_mode
+      # For the server, we only generate the JSON index if requested
+      @json_index.generate
+      @json_index.generate_gzipped
+      copy_static
+    end
   rescue => e
     debug_msg "%s: %s\n  %s" % [
       e.class.name, e.message, e.backtrace.join("\n  ")
@@ -608,12 +610,23 @@ def setup
 
     return unless @store
 
+    update_data_from_store
+  end
+
+  def update_data_from_store
     @classes = @store.all_classes_and_modules.sort
     @files   = @store.all_files.sort
     @methods = @classes.flat_map { |m| m.method_list }.sort
     @modsort = get_sorted_module_list @classes
   end
 
+  def clear_data
+    @classes.clear if @classes
+    @files.clear if @files
+    @methods.clear if @methods
+    @modsort.clear if @modsort
+  end
+
   ##
   # Return a string describing the amount of time in the given number of
   # seconds in terms a human can understand easily.

lib/rdoc/options.rb

@@ -340,6 +340,11 @@ class RDoc::Options
 
   attr_reader :visibility
 
+  ##
+  # The server's port to listen on. `nil` or `false` means the server is disabled.
+
+  attr_reader :server_port
+
   ##
   # Indicates if files of test suites should be skipped
   attr_accessor :skip_tests
@@ -392,6 +397,7 @@ def init_ivars # :nodoc:
     @encoding = Encoding::UTF_8
     @charset = @encoding.name
     @skip_tests = true
+    @server_port = false
   end
 
   def init_with map # :nodoc:
@@ -1116,6 +1122,15 @@ def parse argv
 
       opt.separator nil
 
+      opt.on(
+        "--server[=PORT]",
+        Integer,
+        "[Experimental] Run WEBrick server with generated documentation.",
+        "Uses port 4000 by default. Will use ./tmp for file output."
+      ) do |port|
+        @server_port = port || 4000
+      end
+
       opt.on("--help", "-h", "Display this help") do
         RDoc::RDoc::GENERATORS.each_key do |generator|
           setup_generator generator

lib/rdoc/rdoc.rb

@@ -3,6 +3,7 @@
 
 require 'find'
 require 'fileutils'
+require 'tmpdir'
 require 'pathname'
 require 'time'
 
@@ -463,7 +464,7 @@ def document options
       exit
     end
 
-    unless @options.coverage_report then
+    unless @options.coverage_report || @options.server_port
       @last_modified = setup_output_dir @options.op_dir, @options.force_update
     end
 
@@ -496,9 +497,16 @@ def document options
 
       @generator = gen_klass.new @store, @options
 
-      generate
+      if @options.server_port
+        start_server
+      else
+        generate
+      end
     end
 
+    # Don't need to run stats for server mode
+    return if @options.server_port
+
     if @stats and (@options.coverage_report or not @options.quiet) then
       puts
       puts @stats.summary.accept RDoc::Markup::ToRdoc.new
@@ -507,6 +515,30 @@ def document options
     exit @stats.fully_documented? if @options.coverage_report
   end
 
+  def start_server
+    begin
+      require 'webrick'
+    rescue LoadError
+      abort "webrick is not found. You may need to `gem install webrick` to install webrick."
+    end
+
+    tmp_dir = Dir.mktmpdir
+
+    # Change the output directory to tmp so it doesn't overwrite the current documentation
+    Dir.chdir tmp_dir do
+      server = WEBrick::HTTPServer.new Port: @options.server_port
+
+      server.mount '/', RDoc::Server, self
+
+      trap 'INT'  do server.shutdown end
+      trap 'TERM' do server.shutdown end
+
+      server.start
+    end
+  ensure
+    FileUtils.remove_entry tmp_dir
+  end
+
   ##
   # Generates documentation for +file_info+ (from #parse_files) into the
   # output dir using the generator selected

lib/rdoc/ri.rb

@@ -13,8 +13,9 @@ module RDoc::RI
 
   class Error < RDoc::Error; end
 
-  autoload :Driver, "#{__dir__}/ri/driver"
-  autoload :Paths,  "#{__dir__}/ri/paths"
-  autoload :Store,  "#{__dir__}/ri/store"
+  autoload :Driver,  "#{__dir__}/ri/driver"
+  autoload :Paths,   "#{__dir__}/ri/paths"
+  autoload :Store,   "#{__dir__}/ri/store"
+  autoload :Servlet, "#{__dir__}/ri/servlet"
 
 end

lib/rdoc/ri/driver.rb

@@ -1506,7 +1506,7 @@ def start_server
 
     extra_doc_dirs = @stores.map {|s| s.type == :extra ? s.path : nil}.compact
 
-    server.mount '/', RDoc::Servlet, nil, extra_doc_dirs
+    server.mount '/', RDoc::RI::Servlet, nil, extra_doc_dirs
 
     trap 'INT'  do server.shutdown end
     trap 'TERM' do server.shutdown end

lib/rdoc/servlet.rb → lib/rdoc/ri/servlet.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require_relative '../rdoc'
+require_relative '../../rdoc'
 require 'erb'
 require 'time'
 require 'json'
@@ -24,14 +24,14 @@
 #
 #   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]  = {} }
@@ -146,7 +146,7 @@ def do_GET req, res
   # Fills in +res+ with the class, module or page for +req+ from +store+.
   #
   # +path+ is relative to the mount_path and is used to determine the class,
-  # module or page name (/RDoc/Servlet.html becomes RDoc::Servlet).
+  # module or page name (/RDoc/RI.html becomes RDoc::RI).
   # +generator+ is used to create the page.
 
   def documentation_page store, generator, path, req, res