Class: YARD::Server::Commands::DisplayFileCommand
- Inherits:
-
LibraryCommand
- Object
- Base
- LibraryCommand
- YARD::Server::Commands::DisplayFileCommand
- Defined in:
- lib/yard/server/commands/display_file_command.rb
Overview
Implement better support for detecting binary (image) filetypes
Displays a README or extra file.
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.
- #index ⇒ Object
-
#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
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
#index ⇒ Object
8 9 10 |
# File 'lib/yard/server/commands/display_file_command.rb', line 8 def index @index end |
#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
#run ⇒ Object
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
# File 'lib/yard/server/commands/display_file_command.rb', line 10 def run ppath = library.source_path filename = File.cleanpath(File.join(library.source_path, path)) raise NotFoundError if !File.file?(filename) if filename =~ /\.(jpe?g|gif|png|bmp)$/i headers['Content-Type'] = StaticFileCommand::DefaultMimeTypes[$1.downcase] || 'text/html' render File.read_binary(filename) else file = CodeObjects::ExtraFileObject.new(filename) .update :object => Registry.root, :type => :layout, :file => file, :index => index ? true : false render end end |