class YARD::Server::DocServerSerializer
A custom {Serializers::Base serializer} which returns resource URLs instead of static relative paths to files on disk.
Public Class Methods
Source
# File lib/yard/server/doc_server_serializer.rb, line 7 def initialize(_command = nil) super(:basepath => '', :extension => '') end
Calls superclass method
YARD::Serializers::FileSystemSerializer::new
Public Instance Methods
Source
# File lib/yard/server/doc_server_serializer.rb, line 11 def serialized_path(object) case object when CodeObjects::RootObject "toplevel" when CodeObjects::ExtendedMethodObject serialized_path(object.namespace) + ':' + urlencode(object.name.to_s) when CodeObjects::MethodObject serialized_path(object.namespace) + (object.scope == :instance ? ":" : ".") + urlencode(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
Calls superclass method
YARD::Serializers::FileSystemSerializer#serialized_path
Private Instance Methods
Source
# File lib/yard/server/doc_server_serializer.rb, line 31 def urlencode(name) if name.respond_to?(:force_encoding) name = name.dup.force_encoding('binary') end Templates::Helpers::HtmlHelper.urlencode(name) end