Class: YARD::Server::Commands::LibraryCommand Abstract

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

Overview

This class is abstract.

This is the base command for all commands that deal directly with libraries. Some commands do not, but most (like DisplayObjectCommand) do. If your command deals with libraries directly, subclass this class instead. See Base for notes on how to subclass a command.

Since:

  • 0.6.0

Instance Attribute Summary collapse

Attributes inherited from Base

#adapter, #body, #caching, #command_options, #headers, #path, #request, #status

Instance Method Summary collapse

Methods inherited from Base

#cache, #not_found, #redirect, #render, #run

Constructor Details

#initialize(opts = {}) ⇒ LibraryCommand

Returns a new instance of LibraryCommand.

Since:

  • 0.6.0


30
31
32
33
# File 'lib/yard/server/commands/library_command.rb', line 30

def initialize(opts = {})
  super
  self.serializer = DocServerSerializer.new(self)
end

Instance Attribute Details

#incrementalBoolean

Returns whether to reparse data.

Returns:

  • (Boolean)

    whether to reparse data

Since:

  • 0.6.0


24
25
26
# File 'lib/yard/server/commands/library_command.rb', line 24

def incremental
  @incremental
end

#libraryLibraryVersion

Returns the object containing library information.

Returns:

Since:

  • 0.6.0


12
13
14
# File 'lib/yard/server/commands/library_command.rb', line 12

def library
  @library
end

#optionsHash{Symbol => Object}

Returns default options for the library.

Returns:

  • (Hash{Symbol => Object})

    default options for the library

Since:

  • 0.6.0


15
16
17
# File 'lib/yard/server/commands/library_command.rb', line 15

def options
  @options
end

#serializerSerializers::Base

Returns the serializer used to perform file linking.

Returns:

Since:

  • 0.6.0


18
19
20
# File 'lib/yard/server/commands/library_command.rb', line 18

def serializer
  @serializer
end

#single_libraryBoolean

Returns whether router should route for multiple libraries.

Returns:

  • (Boolean)

    whether router should route for multiple libraries

Since:

  • 0.6.0


21
22
23
# File 'lib/yard/server/commands/library_command.rb', line 21

def single_library
  @single_library
end

Instance Method Details

#call(request) ⇒ Object

Since:

  • 0.6.0


35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/yard/server/commands/library_command.rb', line 35

def call(request)
  self.request = request
  self.options = SymbolHash.new(false).update(
    :serialize => false,
    :serializer => serializer,
    :library => library,
    :adapter => adapter,
    :single_library => single_library,
    :markup => :rdoc,
    :format => :html
  )
  setup_library
  super
rescue LibraryNotPreparedError
  not_prepared
end