Sha256: 4c519d8482fa920a74fd5ef2ae40a15c1044bb280e4febf5370f2d92903ae096

Contents?: true

Size: 1.26 KB

Versions: 63

Compression:

Stored size: 1.26 KB

Contents

# frozen_string_literal: true
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
      def initialize(_command = nil)
        super(:basepath => '', :extension => '')
      end

      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

      private

      def urlencode(name)
        if name.respond_to?(:force_encoding)
          name = name.dup.force_encoding('binary')
        end
        Templates::Helpers::HtmlHelper.urlencode(name)
      end
    end
  end
end

Version data entries

63 entries across 62 versions & 9 rubygems

Version Path
kinetic_sdk-5.0.29 gems/yard-0.9.36/lib/yard/server/doc_server_serializer.rb
kinetic_sdk-5.0.28 gems/yard-0.9.36/lib/yard/server/doc_server_serializer.rb
direct7-0.0.18 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/server/doc_server_serializer.rb
direct7-0.0.17 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/server/doc_server_serializer.rb
direct7-0.0.16 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/server/doc_server_serializer.rb
yard-0.9.37 lib/yard/server/doc_server_serializer.rb
kinetic_sdk-5.0.27 gems/yard-0.9.36/lib/yard/server/doc_server_serializer.rb
kinetic_sdk-5.0.26 gems/yard-0.9.36/lib/yard/server/doc_server_serializer.rb
kinetic_sdk-5.0.25 gems/yard-0.9.25/lib/yard/server/doc_server_serializer.rb
kinetic_sdk-5.0.24 gems/yard-0.9.25/lib/yard/server/doc_server_serializer.rb
direct7-0.0.13 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/server/doc_server_serializer.rb
yard-0.9.36 lib/yard/server/doc_server_serializer.rb
yard-0.9.35 lib/yard/server/doc_server_serializer.rb
direct7-0.0.12 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/server/doc_server_serializer.rb
kinetic_sdk-5.0.23 gems/yard-0.9.25/lib/yard/server/doc_server_serializer.rb
getargv-0.3.3-universal-darwin vendor/bundle/ruby/3.3.0/gems/yard-0.9.34/lib/yard/server/doc_server_serializer.rb
direct7-0.0.11 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/server/doc_server_serializer.rb
kinetic_sdk-5.0.22 gems/yard-0.9.25/lib/yard/server/doc_server_serializer.rb
kinetic_sdk-5.0.21 gems/yard-0.9.25/lib/yard/server/doc_server_serializer.rb
yard-0.9.34 lib/yard/server/doc_server_serializer.rb