Class: RDoc::Servlet

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, WEBrick::HTTPServlet::AbstractServlet
Instance Chain: self, WEBrick::HTTPServlet::AbstractServlet
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'

Class Method Summary

.new(server, stores, cache, mount_path = nil, extra_doc_dirs = []) ⇒ Servlet constructor

Creates a new WEBrick servlet.
.get_instance(server, *options) Internal use only

Creates an instance of this servlet that shares cached data between requests.

Instance Attribute Summary

#asset_dirs readonly

Maps an asset type to its path on the filesystem.
#options readonly

An Options instance used for rendering options.

Instance Method Summary

#asset(generator_name, req, res)

Serves the asset at the path in req for generator_name via res.
#do_GET(req, res)

GET request entry point.
#documentation_page(store, generator, path, req, res)

Fills in res with the class, module or page for req from store.
#documentation_search(store, generator, req, res)

Creates the JSON search index on res for the given store.
#documentation_source(path)

Returns the Store and path relative to mount_path for documentation at path.
#error(exception, req, res)

Generates an error page for the exception while handling req on res.
#generator_for(store)

Instantiates a Darkfish generator for store
#if_modified_since(req, res, path = nil)

Handles the If-Modified-Since HTTP header on req for path.
#installed_docs

Returns an Array of installed documentation.
#not_found(generator, req, res, message = nil)

Returns a 404 page built by generator for req on res.
#ri_paths(&block)

Enumerates the ri paths.
#root(req, res)

Generates the root page on res.
#root_search(req, res)

Generates a search index for the root page on res.
#show_documentation(req, res)

Displays documentation for req on res, whether that be HTML or some asset.
#store_for(source_name)

Returns an Store for the given source_name (‘ruby’ or a gem name).

Constructor Details

.new(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.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 64


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.expand_path('../generator/template/json_index/', __FILE__),
  }
end

Class Method Details

.get_instance(server, *options)

This method is for internal use only.

Creates an instance of this servlet that shares cached data between requests.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 48


def self.get_instance server, *options # :nodoc:
  stores = @server_stores[server]

  new server, stores, @cache, *options
end

Instance Attribute Details

#asset_dirs (readonly)

Maps an asset type to its path on the filesystem

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 37


attr_reader :asset_dirs

#options (readonly)

An Options instance used for rendering options

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 42


attr_reader :options

Instance Method Details

#asset(generator_name, req, res)

Serves the asset at the path in req for generator_name via res.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 95


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\z/ then 'text/css'
                     when /\.js\z/  then 'application/javascript'
                     else                'application/octet-stream'
                     end
end

#do_GET(req, res)

GET request entry point. Fills in res for the path, etc. in req.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 114


def do_GET req, res
  req.path.sub!(/\A#{Regexp.escape @mount_path}/, '') if @mount_path

  case req.path
  when '/' then
    root req, res
  when '/js/darkfish.js', '/js/jquery.js', '/js/search.js',
       %r%^/css/%, %r%^/images/%, %r%^/fonts/% 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.message
rescue WEBrick::HTTPStatus::Status
  raise
rescue => e
  error e, req, res
end

#documentation_page(store, generator, path, 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 Servlet). generator is used to create the page.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 147


def documentation_page store, generator, path, req, res
  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(/_([^_]*)\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
  end
end

#documentation_search(store, generator, req, res)

Creates the JSON search index on res for the given store. generator must respond to #json_index to build. req is ignored.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 166


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)

Returns the Store and path relative to mount_path for documentation at path.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 180


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)

Generates an error page for the exception while handling req on res.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 198


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}/css/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.message}</pre>

<p>Please report this to the
<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.

<p>Backtrace:

<pre>#{ERB::Util.html_escape backtrace}</pre>

</body>
</html>
  BODY
end

#generator_for(store)

Instantiates a Darkfish generator for store

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 241


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

  @options.main_page = store.main
  @options.title     = store.title

  generator
end

#if_modified_since(req, res, path = nil)

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.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 262


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

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 Store for the documentation.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 285


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)

Returns a 404 page built by generator for req on res.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 313


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
end

#ri_paths(&block)

Enumerates the ri paths. See RDoc::RI::Paths#each

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 322


def ri_paths &block
  RDoc::RI::Paths.each true, true, true, :all, *@extra_doc_dirs, &block #TODO: pass extra_dirs
end

#root(req, res)

Generates the root page on res. req is ignored.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 329


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)

Generates a search index for the root page on res. req is ignored.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 340


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)

Displays documentation for req on res, whether that be HTML or some asset.

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 390


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)

Returns an Store for the given source_name (‘ruby’ or a gem name).

[ GitHub ]

# File 'lib/rdoc/servlet.rb', line 414


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 /\Aextra-(\d+)\z/ 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 \"#{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 \"#{ERB::Util.html_escape(source_name)}\". Please run `gem rdoc --ri gem_name`"

  end
end

Class: RDoc::Servlet

Overview

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(server, stores, cache, mount_path = nil, extra_doc_dirs = []) ⇒ Servlet

Class Method Details

.get_instance(server, *options)

Instance Attribute Details

#asset_dirs (readonly)

#options (readonly)

Instance Method Details

#asset(generator_name, req, res)

#do_GET(req, res)

#documentation_page(store, generator, path, req, res)

#documentation_search(store, generator, req, res)

#documentation_source(path)

#error(exception, req, res)

#generator_for(store)

#if_modified_since(req, res, path = nil)

#installed_docs

#not_found(generator, req, res, message = nil)

#ri_paths(&block)

#root(req, res)

#root_search(req, res)

#show_documentation(req, res)

#store_for(source_name)

.new(server, stores, cache, mount_path = nil, extra_doc_dirs = []) ⇒ `Servlet`