Module: YARD::Templates::Helpers::BaseHelper

Defined in:
lib/yard/templates/helpers/base_helper.rb

Overview

The base helper module included in all templates.

Instance Attribute Summary (collapse)

Managing Global Template State (collapse)

Running the Verifier (collapse)

Escaping Text (collapse)

Linking Objects and URLs (collapse)

Formatting Object Attributes (collapse)

Instance Attribute Details

- (Object) object

Returns the value of attribute object



4
5
6
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 4

def object
  @object
end

- (Object) serializer

Returns the value of attribute serializer



4
5
6
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 4

def serializer
  @serializer
end

Instance Method Details

- (String) format_object_title(object)

The page title name for a given object

Examples:

s = format_object_title ModuleObject.new(:root, :MyModuleName)
s # => "Module: MyModuleName"

Parameters:

Returns:

  • (String) —

    the page title name for a given object



154
155
156
157
158
159
160
161
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 154

def format_object_title(object)
  case object
  when YARD::CodeObjects::RootObject
    "Top Level Namespace"
  else
    format_object_type(object) + ": " + object.path
  end
end

- (String) format_object_type(object)

The human-readable formatted #type for the object

Examples:

Formatted type of an exception class

o = ClassObject.new(:root, :MyError)
o.superclass = P('RuntimeError')
format_object_type(o) # => "Exception"

Formatted type of a method

o = MethodObject.new(:root, :to_s)
format_object_type(o) # => "Method"

Parameters:

Returns:

  • (String) —

    the human-readable formatted #type for the object



140
141
142
143
144
145
146
147
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 140

def format_object_type(object)
  case object
  when YARD::CodeObjects::ClassObject
    object.is_exception? ? "Exception" : "Class"
  else
    object.type.to_s.capitalize
  end
end

- (String) format_source(value)

Indents and formats source code

Parameters:

  • value (String) —

    the input source code

Returns:

  • (String) —

    formatted source code



167
168
169
170
171
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 167

def format_source(value)
  sp = value.split("\n").last[/^(\s+)/, 1]
  num = sp ? sp.size : 0
  value.gsub(/^\s{#{num}}/, '')
end

- (String) format_types(list, brackets = true)

Formats a list of return types for output and links each type.

Examples:

Formatting types

format_types(['String', 'Array']) #=> "(String, Array)"

Formatting types without surrounding brackets

format_types(['String', 'Array'], false) #=> "String, Array"

Parameters:

  • list (Array<String>) —

    a list of types

  • brackets (Boolean) (defaults to: true) —

    whether to surround the types in brackets

Returns:

  • (String) —

    the formatted list of Ruby types



126
127
128
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 126

def format_types(list, brackets = true)
  list.nil? || list.empty? ? "" : (brackets ? "(#{list.join(", ")})" : list.join(", "))
end

- (OpenStruct) globals

An object that keeps track of global state throughout the entire template rendering process (including any sub-templates).

Returns:

  • (OpenStruct) —

    a struct object that stores state

Since:

  • 0.6.0



13
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 13

def globals; options[:__globals] end

- (Object) h(text)

Escapes text. This is used a lot by the HtmlHelper and there should be some helper to "clean up" text for whatever, this is it.



31
32
33
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 31

def h(text)
  text
end

- (String) link_file(filename, title = nil, anchor = nil)

Links to an extra file

Parameters:

  • filename (String) —

    the filename to link to

  • title (String) (defaults to: nil) —

    the title of the link

  • anchor (String) (defaults to: nil) —

    optional anchor

Returns:

  • (String) —

    the link to the file

Since:

  • 0.5.5



111
112
113
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 111

def link_file(filename, title = nil, anchor = nil)
  filename
end

- (Object) link_include_object(object)

Includes an object's docstring into output.

Since:

  • 0.6.0



72
73
74
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 72

def link_include_object(object)
  object.docstring
end

- (String) link_object(object, title = nil)

Links to an object with an optional title

Parameters:

  • object (CodeObjects::Base) —

    the object to link to

  • title (String) (defaults to: nil) —

    the title to use for the link

Returns:

  • (String) —

    the linked object



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 81

def link_object(object, title = nil)
  return title if title
  
  case object
  when YARD::CodeObjects::Base, YARD::CodeObjects::Proxy
    object.path
  when String, Symbol
    P(object).path
  else
    object
  end
end

- (String) link_url(url, title = nil, params = nil)

Links to a URL

Parameters:

  • url (String) —

    the URL to link to

  • title (String) (defaults to: nil) —

    the optional title to display the link as

  • params (Hash) (defaults to: nil) —

    optional parameters for the link

Returns:



100
101
102
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 100

def link_url(url, title = nil, params = nil)
  url
end

- (Object) linkify(*args)

Links objects or URLs. This method will delegate to the correct link_ method depending on the arguments passed in.

Examples:

Linking a URL

linkify('http://example.com')

Including docstring contents of an object

linkify('include:YARD::Docstring')

Linking to an extra file

linkify('file:README')

Linking an object by path

linkify('YARD::Docstring')


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 48

def linkify(*args) 
  if args.first.is_a?(String)
    case args.first
    when %r{://}, /^mailto:/
      link_url(args[0], args[1], {:target => '_parent'}.merge(args[2]||{}))
    when /^include:(\S+)/
      path = $1
      if obj = YARD::Registry.resolve(object.namespace, path)
        link_include_object(obj)
      else
        log.warn "Cannot find object at `#{path}' for inclusion"
      end
    when /^file:(\S+?)(?:#(\S+))?$/
      link_file($1, args[1] ? args[1] : $1, $2)
    else
      link_object(*args)
    end
  else
    link_object(*args)
  end
end

- (Array<CodeObjects::Base>) run_verifier(list)

Runs a list of objects against the Verifier object passed into the template and returns the subset of verified objects.

Parameters:

Returns:

  • (Array<CodeObjects::Base>) —

    a list of code objects that match the verifier. If no verifier is supplied, all objects are returned.



23
24
25
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 23

def run_verifier(list)
  options[:verifier] ? options[:verifier].run(list) : list
end