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

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ LibraryCommand

Returns a new instance of LibraryCommand.

Since:

  • 0.6.0



51
52
53
54
 
# File 'lib/yard/server/commands/library_command.rb', line 51

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

Instance Attribute Details

#incremental ⇒ Boolean

Returns whether to reparse data.

Returns:

  • (Boolean) —

    whether to reparse data

Since:

  • 0.6.0



45
46
47
 
# File 'lib/yard/server/commands/library_command.rb', line 45

def incremental
  @incremental
end

#library ⇒ LibraryVersion

Returns the object containing library information.

Returns:

Since:

  • 0.6.0



33
34
35
 
# File 'lib/yard/server/commands/library_command.rb', line 33

def library
  @library
end

#options ⇒ LibraryOptions

Returns default options for the library.

Returns:

Since:

  • 0.6.0



36
37
38
 
# File 'lib/yard/server/commands/library_command.rb', line 36

def options
  @options
end

#serializer ⇒ Serializers::Base

Returns the serializer used to perform file linking.

Returns:

Since:

  • 0.6.0



39
40
41
 
# File 'lib/yard/server/commands/library_command.rb', line 39

def serializer
  @serializer
end

#single_library ⇒ Boolean

Returns whether router should route for multiple libraries.

Returns:

  • (Boolean) —

    whether router should route for multiple libraries

Since:

  • 0.6.0



42
43
44
 
# File 'lib/yard/server/commands/library_command.rb', line 42

def single_library
  @single_library
end

Instance Method Details

#call(request) ⇒ Object

Since:

  • 0.6.0



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/yard/server/commands/library_command.rb', line 56

def call(request)
  save_default_template_info
  self.request = request
  self.options = LibraryOptions.new
  self.options.reset_defaults
  self.options.command = self
  setup_library
  self.options.title = "Documentation for #{library.name} " +
    (library.version ? '(' + library.version + ')' : '')
  super
rescue LibraryNotPreparedError
  not_prepared
ensure
  restore_template_info
end