Class: YARD::Server::Commands::DisplayObjectCommand
- Inherits:
-
LibraryCommand
- Object
- Base
- LibraryCommand
- YARD::Server::Commands::DisplayObjectCommand
- Includes:
- DocServerHelper
- Defined in:
- lib/yard/server/commands/display_object_command.rb
Overview
Displays documentation for a specific object identified by the path
Direct Known Subclasses
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
inherited
from LibraryCommand
Whether to reparse data.
-
- (LibraryVersion) library
inherited
from LibraryCommand
The object containing library information.
-
- (LibraryOptions) options
inherited
from LibraryCommand
Default options for the library.
-
- (Serializers::Base) serializer
inherited
from LibraryCommand
The serializer used to perform file linking.
-
- (Boolean) single_library
inherited
from LibraryCommand
Whether router should route for multiple libraries.
Instance Method Summary (collapse)
Methods included from DocServerHelper
#base_path, #router, #url_for, #url_for_file, #url_for_frameset, #url_for_index, #url_for_list, #url_for_main
Constructor Details
This class inherits a constructor from YARD::Server::Commands::LibraryCommand
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 Originally defined in class LibraryCommand
Returns whether to reparse data
- (LibraryVersion) library Originally defined in class LibraryCommand
Returns the object containing library information
- (LibraryOptions) options Originally defined in class LibraryCommand
Returns default options for the library
- (Request) request Originally defined in class Base
Returns request object
- (Serializers::Base) serializer Originally defined in class LibraryCommand
Returns the serializer used to perform file linking
- (Boolean) single_library Originally defined in class LibraryCommand
Returns whether router should route for multiple libraries
- (Numeric) status Originally defined in class Base
Returns status code. Defaults to 200 per request
Instance Method Details
- (Object) index
29 30 31 32 33 34 35 36 37 38 |
# File 'lib/yard/server/commands/display_object_command.rb', line 29 def index Registry.load_all .update( :object => '_index.html', :objects => Registry.all(:module, :class), :type => :layout ) render end |
- (Object) not_found
40 41 42 43 |
# File 'lib/yard/server/commands/display_object_command.rb', line 40 def not_found super self.body = "Could not find object: #{object_path}" end |
- (Object) run
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
# File 'lib/yard/server/commands/display_object_command.rb', line 8 def run if path.empty? if .readme url = url_for_file(.readme) self.status, self.headers, self.body = *router.send(:route, url) cache(body.first) return else self.path = 'index' end end return index if path == 'index' if object = Registry.at(object_path) .update(:type => :layout) render(object) else self.status = 404 end end |