Class: YARD::Server::Commands::LibraryCommand Abstract
- Inherits:
-
Base
- Object
- Base
- YARD::Server::Commands::LibraryCommand
- Defined in:
- lib/yard/server/commands/library_command.rb
Overview
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.
Direct Known Subclasses
DisplayFileCommand, DisplayObjectCommand, ListCommand, SearchCommand
Basic Command and Adapter Options (collapse)
-
- (Adapter) adapter
inherited
from Base
The server adapter.
-
- (Boolean) caching
inherited
from Base
Whether to cache.
-
- (Hash) command_options
inherited
from Base
The options passed to the command's constructor.
Attributes Set Per Request (collapse)
-
- (String) body
inherited
from Base
The response body.
-
- (Hash{String => String}) headers
inherited
from Base
Response headers.
-
- (String) path
inherited
from Base
The path after the command base URI.
-
- (Request) request
inherited
from Base
Request object.
-
- (Numeric) status
inherited
from Base
Status code.
Instance Attribute Summary (collapse)
-
- (Boolean) incremental
Whether to reparse data.
-
- (LibraryVersion) library
The object containing library information.
-
- (LibraryOptions) options
Default options for the library.
-
- (Serializers::Base) serializer
The serializer used to perform file linking.
-
- (Boolean) single_library
Whether router should route for multiple libraries.
Instance Method Summary (collapse)
- - (Object) call(request)
-
- (LibraryCommand) initialize(opts = {})
constructor
A new instance of LibraryCommand.
Constructor Details
- (LibraryCommand) initialize(opts = {})
Returns a new instance of LibraryCommand
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
- (String) body Originally defined in class Base
Returns the response body. Defaults to empty string.
- (Boolean) caching Originally defined in class Base
Returns whether to cache
- (Hash) command_options Originally defined in class Base
Returns the options passed to the command’s constructor
- (Boolean) incremental
Returns whether to reparse data
45 46 47 |
# File 'lib/yard/server/commands/library_command.rb', line 45 def incremental @incremental end |
- (LibraryVersion) library
Returns the object containing library information
33 34 35 |
# File 'lib/yard/server/commands/library_command.rb', line 33 def library @library end |
- (LibraryOptions) options
Returns default options for the library
36 37 38 |
# File 'lib/yard/server/commands/library_command.rb', line 36 def @options end |
- (Request) request Originally defined in class Base
Returns request object
- (Serializers::Base) serializer
Returns the serializer used to perform file linking
39 40 41 |
# File 'lib/yard/server/commands/library_command.rb', line 39 def serializer @serializer end |
- (Boolean) single_library
Returns whether router should route for multiple libraries
42 43 44 |
# File 'lib/yard/server/commands/library_command.rb', line 42 def single_library @single_library end |
- (Numeric) status Originally defined in class Base
Returns status code. Defaults to 200 per request
Instance Method Details
- (Object) call(request)
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. = LibraryOptions.new self..reset_defaults self..command = self setup_library self..title = "Documentation for #{library.name} " + (library.version ? '(' + library.version + ')' : '') super rescue LibraryNotPreparedError not_prepared ensure restore_template_info end |