Class: YARD::Server::DocServerSerializer
- Inherits:
-
YARD::Serializers::FileSystemSerializer
- Object
- YARD::Serializers::Base
- YARD::Serializers::FileSystemSerializer
- YARD::Server::DocServerSerializer
- Includes:
- WEBrick::HTTPUtils
- Defined in:
- lib/yard/server/doc_server_serializer.rb
Overview
A custom serializer which returns resource URLs instead of static relative paths to files on disk.
Instance Attribute Summary (collapse)
-
- (String) basepath
inherited
from YARD::Serializers::FileSystemSerializer
The base path to write data to.
-
- (String) extension
inherited
from YARD::Serializers::FileSystemSerializer
The extension of the filename (defaults to html).
-
- (SymbolHash) options
inherited
from YARD::Serializers::Base
readonly
All serializer options are saved so they can be passed to other serializers.
Instance Method Summary (collapse)
-
- (DocServerSerializer) initialize(command = nil)
constructor
A new instance of DocServerSerializer.
- - (Object) serialized_path(object)
Constructor Details
- (DocServerSerializer) initialize(command = nil)
Returns a new instance of DocServerSerializer
10 11 12 |
# File 'lib/yard/server/doc_server_serializer.rb', line 10 def initialize(command = nil) super(:basepath => '', :extension => '') end |
Instance Attribute Details
- (String) basepath Originally defined in class YARD::Serializers::FileSystemSerializer
The base path to write data to.
- (String) extension Originally defined in class YARD::Serializers::FileSystemSerializer
The extension of the filename (defaults to html)
- (SymbolHash) options (readonly) Originally defined in class YARD::Serializers::Base
All serializer options are saved so they can be passed to other serializers.
Instance Method Details
- (Object) serialized_path(object)
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# File 'lib/yard/server/doc_server_serializer.rb', line 14 def serialized_path(object) case object when CodeObjects::RootObject "toplevel" when CodeObjects::ExtendedMethodObject serialized_path(object.namespace) + ':' + escape(object.name.to_s) when CodeObjects::MethodObject serialized_path(object.namespace) + (object.scope == :instance ? ":" : ".") + escape(object.name.to_s) when CodeObjects::ConstantObject, CodeObjects::ClassVariableObject serialized_path(object.namespace) + "##{object.name}-#{object.type}" when CodeObjects::ExtraFileObject super(object).gsub(/^file./, 'file/') else super(object) end end |