Module: YARD::Server::DocServerHelper

Included in:
Commands::DisplayObjectCommand, Commands::SearchCommand
Defined in:
lib/yard/server/doc_server_helper.rb

Overview

A module that is mixed into Templates::Template in order to customize certain template methods.

Since:

  • 0.6.0

Instance Method Summary collapse

Instance Method Details

#abs_url(*path_components) ⇒ String

Returns the absolute path from any mounted base URI.

Parameters:

  • path_components (Array<String>)

    components of a URL

Returns:

  • (String)

    the absolute path from any mounted base URI.

Since:

  • 0.6.0


60
61
62
# File 'lib/yard/server/doc_server_helper.rb', line 60

def abs_url(*path_components)
  File.join(router.request.script_name, *path_components)
end

#base_path(path) ⇒ String

Returns the base URI for a library with an extra path prefix.

Examples:

The base path for a library 'foo'

base_path('docs') # => 'docs/foo'

Parameters:

  • path (String)

    the path prefix for a base path URI

Returns:

  • (String)

    the base URI for a library with an extra path prefix

Since:

  • 0.6.0


68
69
70
71
# File 'lib/yard/server/doc_server_helper.rb', line 68

def base_path(path)
  libname = router.request.version_supplied ? @library.to_s : @library.name
  path + (@single_library ? '' : "/#{libname}")
end

#routerRouter

Returns convenience method for accessing the router.

Returns:

  • (Router)

    convenience method for accessing the router

Since:

  • 0.6.0


74
# File 'lib/yard/server/doc_server_helper.rb', line 74

def router; @adapter.router end

#url_for(obj, anchor = nil, relative = false) ⇒ String

Modifies Templates::Helpers::HtmlHelper#url_for to return a URL instead of a disk location.

Parameters:

  • obj (String, CodeObjects::Base)

    the object (or object path) to link to

  • anchor (String) (defaults to: nil)

    the anchor to link to

  • relative (Boolean) (defaults to: false)

    use a relative or absolute link

Returns:

  • (String)

    the URL location of the object

Since:

  • 0.6.0


10
11
12
13
14
15
16
17
# File 'lib/yard/server/doc_server_helper.rb', line 10

def url_for(obj, anchor = nil, relative = false)
  return '' if obj.nil?
  return url_for_index if obj == '_index.html'
  return abs_url(base_path(router.static_prefix), obj) if String === obj
  url = super(obj, anchor, false)
  return unless url
  abs_url(base_path(router.docs_prefix), url)
end

#url_for_file(filename, anchor = nil) ⇒ String

Modifies Templates::Helpers::HtmlHelper#url_for_file to return a URL instead of a disk location.

Parameters:

Returns:

  • (String)

    the URL pointing to the file

Since:

  • 0.6.0


23
24
25
26
27
28
29
30
# File 'lib/yard/server/doc_server_helper.rb', line 23

def url_for_file(filename, anchor = nil)
  if filename.is_a?(CodeObjects::ExtraFileObject)
    filename = filename.filename
  end
  fname = filename.sub(%r{^#{@library.source_path.to_s}/}, '')
  fname += "##{anchor}" if anchor && !anchor.empty?
  abs_url(base_path(router.docs_prefix), 'file', fname)
end

#url_for_framesetString

Returns the frames URL for the page

Returns:

  • (String)

    the URL pointing to the frames page

Since:

  • 0.6.0


42
43
44
# File 'lib/yard/server/doc_server_helper.rb', line 42

def url_for_frameset
  options.file ? url_for_file(options.file) : url_for(object)
end

#url_for_indexString

Returns the URL for the alphabetic index page

Returns:

  • (String)

    the URL pointing to the first main page the user should see.

Since:

  • 0.6.0


54
55
56
# File 'lib/yard/server/doc_server_helper.rb', line 54

def url_for_index
  abs_url(base_path(router.docs_prefix), 'index')
end

#url_for_list(type) ⇒ String

Modifies Templates::Helpers::HtmlHelper#url_for_list to return a URL based on the list prefix instead of a HTML filename.

Parameters:

  • type (String, Symbol)

    the list type to generate a URL for

Returns:

  • (String)

    the URL pointing to the list

Since:

  • 0.6.0


36
37
38
# File 'lib/yard/server/doc_server_helper.rb', line 36

def url_for_list(type)
  abs_url(base_path(router.list_prefix), type.to_s)
end

#url_for_mainString

Returns the main URL, first checking a readme and then linking to the index

Returns:

  • (String)

    the URL pointing to the first main page the user should see.

Since:

  • 0.6.0


48
49
50
# File 'lib/yard/server/doc_server_helper.rb', line 48

def url_for_main
  options.readme ? url_for_file(options.readme) : url_for_index
end