Sha256: c199b3d1a0a6565650b5d8977aa3673b9bb6cb13208894596fcfdf39feeca25c

Contents?: true

Size: 981 Bytes

Versions: 24

Compression:

Stored size: 981 Bytes

Contents

require 'webrick/httputils'

module YARD
  module Server
    # A custom {Serializers::Base serializer} which returns resource URLs instead of
    # static relative paths to files on disk.
    class DocServerSerializer < Serializers::FileSystemSerializer
      include WEBrick::HTTPUtils

      def initialize(command = nil)
        super(:basepath => '', :extension => '')
      end

      def serialized_path(object)
        case object
        when CodeObjects::RootObject
          "toplevel"
        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
    end
  end
end

Version data entries

24 entries across 21 versions & 2 rubygems

Version Path
challah-0.6.2 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.6.2 vendor/bundle/gems/yard-0.8.1/lib/yard/server/doc_server_serializer.rb
challah-0.6.1 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.6.1 vendor/bundle/gems/yard-0.8.1/lib/yard/server/doc_server_serializer.rb
challah-0.6.0 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.6.0 vendor/bundle/gems/yard-0.8.1/lib/yard/server/doc_server_serializer.rb
yard-0.8.1 lib/yard/server/doc_server_serializer.rb
yard-0.8.0 lib/yard/server/doc_server_serializer.rb
challah-0.5.4 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.5.3 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.5.2 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.5.1 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.5.0 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.4.1 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.4.0 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.3.5 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.3.4 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.3.3 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.3.2 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb
challah-0.3.1 vendor/bundle/gems/yard-0.7.5/lib/yard/server/doc_server_serializer.rb