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

Inherits:

Base

• Object
• Base
• YARD::Server::Commands::LibraryIndexCommand

Defined in:

lib/yard/server/commands/library_index_command.rb

Overview

Returns the index of libraries served by the server.

Since:

• 0.6.0

Basic Command and Adapter Options

• #adapter ⇒ Adapter inherited from Base

  The server adapter.

• #caching ⇒ Boolean inherited from Base

  Whether to cache.

• #command_options ⇒ Hash inherited from Base

  The options passed to the command's constructor.

Attributes Set Per Request

• #body ⇒ String inherited from Base

  The response body.

• #headers ⇒ Hash{String => String} inherited from Base

  Response headers.

• #path ⇒ String inherited from Base

  The path after the command base URI.

• #request ⇒ Request inherited from Base

  Request object.

• #status ⇒ Numeric inherited from Base

  Status code.

Instance Attribute Summary

• #options ⇒ Object

Instance Method Summary

• #run ⇒ Object

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:

• (Adapter) —

  the server adapter

Since:

• 0.6.0

#body ⇒ String 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

#caching ⇒ Boolean Originally defined in class Base

Returns whether to cache

Returns:

• (Boolean) —

  whether to cache

Since:

• 0.6.0

#command_options ⇒ Hash 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

#headers ⇒ Hash{String => String} Originally defined in class Base

Returns response headers

Returns:

• (Hash{String => String}) —

  response headers

Since:

• 0.6.0

#options ⇒ Object

Since:

• 0.6.0

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

def options
  @options
end

#path ⇒ String 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

#status ⇒ Numeric 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

#run ⇒ Object

Since:

• 0.6.0

# 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