Class: YARD::Server::Commands::LibraryIndexCommand

Inherits:
Base
  • Object
show all
Defined in:
lib/yard/server/commands/library_index_command.rb

Overview

Returns the index of libraries served by the server.

Since:

Basic Command and Adapter Options (collapse)

Attributes Set Per Request (collapse)

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

This class inherits a constructor from YARD::Server::Commands::Base

Instance Attribute Details

- (Adapter) adapter Originally defined in class Base

Returns the server adapter

Returns:

Since:

  • 0.6.0

- (String) body Originally defined in class Base

Returns the response body. Defaults to empty string.

Returns:

  • (String)

    the response body. Defaults to empty string.

Since:

  • 0.6.0

- (Boolean) caching Originally defined in class Base

Returns whether to cache

Returns:

  • (Boolean)

    whether to cache

Since:

  • 0.6.0

- (Hash) command_options Originally defined in class Base

Returns the options passed to the command’s constructor

Returns:

  • (Hash)

    the options passed to the command’s constructor

Since:

  • 0.6.0

- (Hash{String => String}) headers Originally defined in class Base

Returns response headers

Returns:

Since:

  • 0.6.0

- (Object) options

Since:

  • 0.6.0



6
7
8
# File 'lib/yard/server/commands/library_index_command.rb', line 6

def options
  @options
end

- (String) path Originally defined in class Base

Returns the path after the command base URI

Returns:

  • (String)

    the path after the command base URI

Since:

  • 0.6.0

- (Request) request Originally defined in class Base

Returns request object

Returns:

  • (Request)

    request object

Since:

  • 0.6.0

- (Numeric) status Originally defined in class Base

Returns status code. Defaults to 200 per request

Returns:

  • (Numeric)

    status code. Defaults to 200 per request

Since:

  • 0.6.0

Instance Method Details

- (Object) run

Since:

  • 0.6.0



8
9
10
11
12
13
14
15
16
17
18
19
20
# File 'lib/yard/server/commands/library_index_command.rb', line 8

def run
  return unless path.empty?

  self.options = SymbolHash.new(false).update(
    :markup => :rdoc,
    :format => :html,
    :libraries => adapter.libraries,
    :adapter => adapter,
    :template => :doc_server,
    :type => :library_list
  )
  render
end