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

Included in:
CLI::Stats, Server::Commands::ListCommand, Template
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

#serializer ⇒ Object

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

#format_object_title(object) ⇒ String

Returns 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



173
174
175
176
177
178
179
180
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 173

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

#format_object_type(object) ⇒ String

Returns 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



159
160
161
162
163
164
165
166
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 159

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

#format_source(value) ⇒ String

Indents and formats source code

Parameters:

  • value (String) —

    the input source code

Returns:

  • (String) —

    formatted source code



186
187
188
189
190
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 186

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

#format_types(list, brackets = true) ⇒ String

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



145
146
147
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 145

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

#globals ⇒ OpenStruct

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

#h(text) ⇒ Object

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

#link_file(filename, title = nil, anchor = nil) ⇒ String

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



130
131
132
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 130

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

#link_include_file(file) ⇒ String

Include a file as a docstring in output

Parameters:

  • file (String) —

    the filename to include

Returns:

  • (String) —

    the file’s contents

Since:

  • 0.7.0



91
92
93
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 91

def link_include_file(file)
  File.read(file)
end

#link_include_object(object) ⇒ String

Includes an object’s docstring into output.

Parameters:

Returns:

  • (String) —

    the object’s docstring (no tags)

Since:

  • 0.6.0



83
84
85
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 83

def link_include_object(object)
  object.docstring
end

#link_object(object, title = nil) ⇒ String

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



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 100

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

#link_url(url, title = nil, params = nil) ⇒ String

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:



119
120
121
 
# File 'lib/yard/templates/helpers/base_helper.rb', line 119

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

#linkify(*args) ⇒ Object

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
69
70
71
72
73
74
75
76
77
 
# 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:file:(\S+)/
      file = $1
      if File.file?(file)
        link_include_file(file)
      else
        log.warn "Cannot find file at `#{file}' for inclusion"
        ""
      end
    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

#run_verifier(list) ⇒ Array<CodeObjects::Base>

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