Class: RDoc::Servlet
- Inherits:
-
WEBrick::HTTPServlet::AbstractServlet
- Object
- WEBrick::HTTPServlet::AbstractServlet
- RDoc::Servlet
- Defined in:
- lib/rdoc/servlet.rb
Overview
This is a WEBrick servlet that allows you to browse ri documentation.
You can show documentation through either ‘ri –server` or, with RubyGems 2.0 or newer, `gem server`. For ri, the server runs on port 8214 by default. For RubyGems the server runs on port 8808 by default.
You can use this servlet in your own project by mounting it on a WEBrick server:
require 'webrick'
server = WEBrick::HTTPServer.new Port: 8000
server.mount '/', RDoc::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'
Instance Attribute Summary collapse
-
#asset_dirs ⇒ Object
readonly
Maps an asset type to its path on the filesystem.
-
#options ⇒ Object
readonly
An RDoc::Options instance used for rendering options.
Class Method Summary collapse
-
.get_instance(server, *options) ⇒ Object
Creates an instance of this servlet that shares cached data between requests.
Instance Method Summary collapse
-
#asset(generator_name, req, res) ⇒ Object
Serves the asset at the path in
req
forgenerator_name
viares
. -
#do_GET(req, res) ⇒ Object
GET request entry point.
-
#documentation_page(store, generator, path, req, res) ⇒ Object
Fills in
res
with the class, module or page forreq
fromstore
. -
#documentation_search(store, generator, req, res) ⇒ Object
Creates the JSON search index on
res
for the givenstore
. -
#documentation_source(path) ⇒ Object
Returns the RDoc::Store and path relative to
mount_path
for documentation atpath
. -
#error(exception, req, res) ⇒ Object
Generates an error page for the
exception
while handlingreq
onres
. -
#generator_for(store) ⇒ Object
Instantiates a Darkfish generator for
store
. -
#if_modified_since(req, res, path = nil) ⇒ Object
Handles the If-Modified-Since HTTP header on
req
forpath
. -
#initialize(server, stores, cache, mount_path = nil, extra_doc_dirs = []) ⇒ Servlet
constructor
Creates a new WEBrick servlet.
-
#installed_docs ⇒ Object
Returns an Array of installed documentation.
-
#not_found(generator, req, res, message = nil) ⇒ Object
Returns a 404 page built by
generator
forreq
onres
. -
#ri_paths(&block) ⇒ Object
Enumerates the ri paths.
-
#root(req, res) ⇒ Object
Generates the root page on
res
. -
#root_search(req, res) ⇒ Object
Generates a search index for the root page on
res
. -
#show_documentation(req, res) ⇒ Object
Displays documentation for
req
onres
, whether that be HTML or some asset. -
#store_for(source_name) ⇒ Object
Returns an RDoc::Store for the given
source_name
(‘ruby’ or a gem name).
Constructor Details
#initialize(server, stores, cache, mount_path = nil, extra_doc_dirs = []) ⇒ Servlet
Creates a new WEBrick servlet.
Use mount_path
when mounting the servlet somewhere other than /.
Use extra_doc_dirs
for additional documentation directories.
server
is provided automatically by WEBrick when mounting. stores
and cache
are provided automatically by the servlet.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/rdoc/servlet.rb', line 62 def initialize server, stores, cache, mount_path = nil, extra_doc_dirs = [] super server @cache = cache @mount_path = mount_path @extra_doc_dirs = extra_doc_dirs @stores = stores @options = RDoc::Options.new @options.op_dir = '.' darkfish_dir = nil # HACK dup $LOAD_PATH.each do |path| darkfish_dir = File.join path, 'rdoc/generator/template/darkfish/' next unless File.directory? darkfish_dir @options.template_dir = darkfish_dir break end @asset_dirs = { :darkfish => darkfish_dir, :json_index => File.('../generator/template/json_index/', __FILE__), } end |
Instance Attribute Details
#asset_dirs ⇒ Object (readonly)
Maps an asset type to its path on the filesystem
35 36 37 |
# File 'lib/rdoc/servlet.rb', line 35 def asset_dirs @asset_dirs end |
#options ⇒ Object (readonly)
An RDoc::Options instance used for rendering options
40 41 42 |
# File 'lib/rdoc/servlet.rb', line 40 def @options end |
Class Method Details
.get_instance(server, *options) ⇒ Object
Creates an instance of this servlet that shares cached data between requests.
46 47 48 49 50 |
# File 'lib/rdoc/servlet.rb', line 46 def self.get_instance server, * # :nodoc: stores = @server_stores[server] new server, stores, @cache, * end |
Instance Method Details
#asset(generator_name, req, res) ⇒ Object
Serves the asset at the path in req
for generator_name
via res
.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/rdoc/servlet.rb', line 93 def asset generator_name, req, res asset_dir = @asset_dirs[generator_name] asset_path = File.join asset_dir, req.path if_modified_since req, res, asset_path 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' end end |
#do_GET(req, res) ⇒ Object
GET request entry point. Fills in res
for the path, etc. in req
.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/rdoc/servlet.rb', line 112 def do_GET req, res req.path.sub!(/^#{Regexp.escape @mount_path}/o, '') if @mount_path case req.path when '/' then root req, res when '/rdoc.css', '/js/darkfish.js', '/js/jquery.js', '/js/search.js', %r%^/images/% then asset :darkfish, req, res when '/js/navigation.js', '/js/searcher.js' then asset :json_index, req, res when '/js/search_index.js' then root_search req, res else show_documentation req, res end rescue WEBrick::HTTPStatus::NotFound => e generator = generator_for RDoc::Store.new not_found generator, req, res, e. rescue WEBrick::HTTPStatus::Status raise rescue => e error e, req, res end |
#documentation_page(store, generator, path, req, res) ⇒ Object
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). generator
is used to create the page.
145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/rdoc/servlet.rb', line 145 def documentation_page store, generator, path, req, res name = path.sub(/.html$/, '').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 res.body = generator.generate_page page else not_found generator, req, res end end |
#documentation_search(store, generator, req, res) ⇒ Object
Creates the JSON search index on res
for the given store
. generator
must respond to #json_index to build. req
is ignored.
161 162 163 164 165 166 167 168 169 |
# File 'lib/rdoc/servlet.rb', line 161 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 end res.content_type = 'application/javascript' res.body = "var search_data = #{json_index}" end |
#documentation_source(path) ⇒ Object
Returns the RDoc::Store and path relative to mount_path
for documentation at path
.
175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/rdoc/servlet.rb', line 175 def documentation_source path _, source_name, path = path.split '/', 3 store = @stores[source_name] return store, path if store store = store_for source_name store.load_all @stores[source_name] = store return store, path end |
#error(exception, req, res) ⇒ Object
Generates an error page for the exception
while handling req
on res
.
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/rdoc/servlet.rb', line 193 def error exception, req, res backtrace = exception.backtrace.join "\n" res.content_type = 'text/html' res.status = 500 res.body = <<-BODY <!DOCTYPE html> <html> <head> <meta content="text/html; charset=UTF-8" http-equiv="Content-Type"> <title>Error - #{ERB::Util.html_escape exception.class}</title> <link type="text/css" media="screen" href="#{@mount_path}/rdoc.css" rel="stylesheet"> </head> <body> <h1>Error</h1> <p>While processing <code>#{ERB::Util.html_escape req.request_uri}</code> the RDoc (#{ERB::Util.html_escape RDoc::VERSION}) server has encountered a <code>#{ERB::Util.html_escape exception.class}</code> exception: <pre>#{ERB::Util.html_escape exception.}</pre> <p>Please report this to the <a href="https://github.com/rdoc/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. <p>Backtrace: <pre>#{ERB::Util.html_escape backtrace}</pre> </body> </html> BODY end |
#generator_for(store) ⇒ Object
Instantiates a Darkfish generator for store
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/rdoc/servlet.rb', line 236 def generator_for store generator = RDoc::Generator::Darkfish.new store, @options generator.file_output = false generator.asset_rel_path = '..' rdoc = RDoc::RDoc.new rdoc.store = store rdoc.generator = generator rdoc. = @options @options.main_page = store.main @options.title = store.title generator end |
#if_modified_since(req, res, path = nil) ⇒ Object
Handles the If-Modified-Since HTTP header on req
for path
. If the 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
.
257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/rdoc/servlet.rb', line 257 def if_modified_since req, res, path = nil last_modified = File.stat(path).mtime if path res['last-modified'] = last_modified.httpdate return unless ims = req['if-modified-since'] ims = Time.parse ims unless ims < last_modified then res.body = '' raise WEBrick::HTTPStatus::NotModified end end |
#installed_docs ⇒ Object
Returns an Array of installed documentation.
Each entry contains the documentation name (gem name, ‘Ruby Documentation’, etc.), the path relative to the mount point, whether the documentation exists, the type of documentation (See RDoc::RI::Paths#each) and the filesystem to the RDoc::Store for the documentation.
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/rdoc/servlet.rb', line 280 def installed_docs extra_counter = 0 ri_paths.map do |path, type| store = RDoc::Store.new path, type exists = File.exist? store.cache_path case type when :gem then gem_path = path[%r%/([^/]*)/ri$%, 1] [gem_path, "#{gem_path}/", exists, type, path] when :system then ['Ruby Documentation', 'ruby/', exists, type, path] when :site then ['Site Documentation', 'site/', exists, type, path] when :home then ['Home Documentation', 'home/', exists, type, path] when :extra then extra_counter += 1 store.load_cache if exists title = store.title || "Extra Documentation" [title, "extra-#{extra_counter}/", exists, type, path] end end end |
#not_found(generator, req, res, message = nil) ⇒ Object
Returns a 404 page built by generator
for req
on res
.
308 309 310 311 312 |
# File 'lib/rdoc/servlet.rb', line 308 def not_found generator, req, res, = nil ||= "The page <kbd>#{ERB::Util.h req.path}</kbd> was not found" res.body = generator.generate_servlet_not_found res.status = 404 end |
#ri_paths(&block) ⇒ Object
Enumerates the ri paths. See RDoc::RI::Paths#each
317 318 319 |
# File 'lib/rdoc/servlet.rb', line 317 def ri_paths &block RDoc::RI::Paths.each true, true, true, :all, *@extra_doc_dirs, &block #TODO: pass extra_dirs end |
#root(req, res) ⇒ Object
Generates the root page on res
. req
is ignored.
324 325 326 327 328 329 330 |
# File 'lib/rdoc/servlet.rb', line 324 def root req, res generator = RDoc::Generator::Darkfish.new nil, @options res.body = generator.generate_servlet_root installed_docs res.content_type = 'text/html' end |
#root_search(req, res) ⇒ Object
Generates a search index for the root page on res
. req
is ignored.
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/rdoc/servlet.rb', line 335 def root_search req, res search_index = [] info = [] installed_docs.map do |name, href, exists, type, path| next unless exists search_index << name case type when :gem gemspec = path.gsub(%r%/doc/([^/]*?)/ri$%, '/specifications/\1.gemspec') spec = Gem::Specification.load gemspec path = spec.full_name comment = spec.summary when :system then path = 'ruby' comment = 'Documentation for the Ruby standard library' when :site then path = 'site' comment = 'Documentation for non-gem libraries' when :home then path = 'home' comment = 'Documentation from your home directory' when :extra comment = name end info << [name, '', path, '', comment] end index = { :index => { :searchIndex => search_index, :longSearchIndex => search_index, :info => info, } } res.body = "var search_data = #{JSON.dump index};" res.content_type = 'application/javascript' end |
#show_documentation(req, res) ⇒ Object
Displays documentation for req
on res
, whether that be HTML or some asset.
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/rdoc/servlet.rb', line 385 def show_documentation req, res store, path = documentation_source req.path if_modified_since req, res, store.cache_path generator = generator_for store case path when nil, '', 'index.html' then res.body = generator.generate_index when 'table_of_contents.html' then res.body = generator.generate_table_of_contents when 'js/search_index.js' then documentation_search store, generator, req, res else documentation_page store, generator, path, req, res end ensure res.content_type ||= 'text/html' end |
#store_for(source_name) ⇒ Object
Returns an RDoc::Store for the given source_name
(‘ruby’ or a gem name).
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/rdoc/servlet.rb', line 409 def store_for source_name case source_name when 'home' then RDoc::Store.new RDoc::RI::Paths.home_dir, :home when 'ruby' then 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 index = $1.to_i - 1 ri_dir = installed_docs[index][4] RDoc::Store.new ri_dir, :extra else ri_dir, type = ri_paths.find do |dir, dir_type| next unless dir_type == :gem source_name == dir[%r%/([^/]*)/ri$%, 1] end raise WEBrick::HTTPStatus::NotFound, "Could not find gem \"#{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`" end end |