mirror of
https://github.com/ruby/ruby.git
synced 2025-08-23 21:14:23 +02:00
Sync RDoc 6.14.0
This commit is contained in:
Stan Lo
Takashi Kokubun
parent
ca1ea95784
commit
03eb777c69
185 changed files with 2008 additions and 1655 deletions
|
|
@ -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
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue