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.
-
#caching ⇒ Boolean
inherited
from Base
Whether to cache.
-
#command_options ⇒ Hash
inherited
from Base
The options passed to the command's constructor.
Attributes Set Per Request collapse
-
#body ⇒ String
inherited
from Base
The response body.
-
#headers ⇒ Hash{String => String}
inherited
from Base
Response headers.
-
#path ⇒ String
inherited
from Base
The path after the command base URI.
-
#request ⇒ Request
inherited
from Base
Request object.
-
#status ⇒ Numeric
inherited
from Base
Status code.
Instance Attribute Summary collapse
-
#incremental ⇒ Boolean
inherited
from LibraryCommand
Whether to reparse data.
-
#library ⇒ LibraryVersion
inherited
from LibraryCommand
The object containing library information.
-
#options ⇒ LibraryOptions
inherited
from LibraryCommand
Default options for the library.
-
#serializer ⇒ Serializers::Base
inherited
from LibraryCommand
The serializer used to perform file linking.
-
#single_library ⇒ Boolean
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
#body ⇒ String Originally defined in class Base
Returns the response body. Defaults to empty string.
#caching ⇒ Boolean Originally defined in class Base
Returns whether to cache
#command_options ⇒ Hash Originally defined in class Base
Returns the options passed to the command's constructor
#incremental ⇒ Boolean Originally defined in class LibraryCommand
Returns whether to reparse data
#library ⇒ LibraryVersion Originally defined in class LibraryCommand
Returns the object containing library information
#options ⇒ LibraryOptions Originally defined in class LibraryCommand
Returns default options for the library
#request ⇒ Request Originally defined in class Base
Returns request object
#serializer ⇒ Serializers::Base Originally defined in class LibraryCommand
Returns the serializer used to perform file linking
#single_library ⇒ Boolean Originally defined in class LibraryCommand
Returns whether router should route for multiple libraries
#status ⇒ Numeric Originally defined in class Base
Returns status code. Defaults to 200 per request
Instance Method Details
#index ⇒ Object
33 34 35 36 37 38 39 40 41 42 |
# File 'lib/yard/server/commands/display_object_command.rb', line 33 def index Registry.load_all .update( :object => '_index.html', :objects => Registry.all(:module, :class), :type => :layout ) render end |
#not_found ⇒ Object
44 45 46 47 |
# File 'lib/yard/server/commands/display_object_command.rb', line 44 def not_found super self.body = "Could not find object: #{object_path}" end |
#run ⇒ Object
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# File 'lib/yard/server/commands/display_object_command.rb', line 8 def run if path.empty? if .readme filename = .readme.filename opts = adapter..merge( :index => true, :library => library, :path => filename.sub(%r{^#{library.source_path.to_s}/}, '')) self.status, self.headers, self.body = *DisplayFileCommand.new(opts).call(request) cache(self.body) 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 |