Class: YARD::Server::Commands::ListCommand

Inherits:
LibraryCommand show all
Includes:
Templates::Helpers::BaseHelper
Defined in:
lib/yard/server/commands/list_command.rb

Overview

Returns a list of objects of a specific type

Since:

Basic Command and Adapter Options (collapse)

Attributes Set Per Request (collapse)

Instance Attribute Summary (collapse)

Attributes included from Templates::Helpers::BaseHelper

#object, #owner, #serializer

Instance Method Summary (collapse)

Methods included from Templates::Helpers::BaseHelper

#format_object_title, #format_object_type, #format_source, #format_types, #globals, #h, #link_file, #link_include_file, #link_include_object, #link_object, #link_url, #linkify, #run_verifier

Constructor Details

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

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

- (Boolean) incremental Originally defined in class LibraryCommand

Returns whether to reparse data

Returns:

  • (Boolean)

    whether to reparse data

Since:

  • 0.6.0

- (LibraryVersion) library Originally defined in class LibraryCommand

Returns the object containing library information

Returns:

Since:

  • 0.6.0

- (LibraryOptions) options Originally defined in class LibraryCommand

Returns default options for the library

Returns:

Since:

  • 0.6.0

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

- (Serializers::Base) serializer Originally defined in class LibraryCommand

Returns the serializer used to perform file linking

Returns:

Since:

  • 0.6.0

- (Boolean) single_library Originally defined in class LibraryCommand

Returns whether router should route for multiple libraries

Returns:

  • (Boolean)

    whether router should route for multiple libraries

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/list_command.rb', line 8

def run
  Registry.load_all
  options.update(:objects => run_verifier(Registry.all(:class, :module)))
  list_type = request.path.split('/').last
  meth = "generate_#{list_type}_list"
  tpl = fulldoc_template
  if tpl.respond_to?(meth)
    tpl.send(meth)
    cache(tpl.contents)
  else
    not_found
  end
end