Module: YARD::Templates::Helpers::HtmlHelper

Includes:
HtmlSyntaxHighlightHelper, MarkupHelper
Defined in:
lib/yard/templates/helpers/html_helper.rb

Overview

The helper module for HTML templates.

Constant Summary

Constant Summary

Constants included from MarkupHelper

MarkupHelper::MARKUP_EXTENSIONS, MarkupHelper::MARKUP_FILE_SHEBANG, MarkupHelper::MARKUP_PROVIDERS

Escaping Template Data (collapse)

Converting Markup to HTML (collapse)

Syntax Highlighting Source Code (collapse)

Linking Objects and URLs (collapse)

URL Helpers (collapse)

Formatting Objects and Attributes (collapse)

Getting the Character Encoding (collapse)

Methods included from HtmlSyntaxHighlightHelper

#html_syntax_highlight_ruby

Methods included from MarkupHelper

clear_markup_cache, #load_markup_provider, #markup_class, #markup_file_contents, #markup_for_file, #markup_provider

Instance Method Details

- (String) anchor_for(object)



290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/yard/templates/helpers/html_helper.rb', line 290

def anchor_for(object)
  case object
  when CodeObjects::MethodObject
    "#{object.name}-#{object.scope}_#{object.type}"
  when CodeObjects::ClassVariableObject
    "#{object.name.to_s.gsub('@@', '')}-#{object.type}"
  when CodeObjects::Base
    "#{object.name}-#{object.type}"
  when CodeObjects::Proxy
    object.path
  else
    object.to_s
  end
end

- (String) charset

Returns the current character set. The default value can be overridden by setting the LANG environment variable or by overriding this method. In Ruby 1.9 you can also modify this value by setting Encoding.default_external.

Since:

  • 0.5.4



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
# File 'lib/yard/templates/helpers/html_helper.rb', line 478

def charset
  if @file && RUBY19
    lang = @file.contents.encoding.to_s
  else
    return 'utf-8' unless RUBY19 || lang = ENV['LANG']
    if RUBY19
      lang = ::Encoding.default_external.name.downcase
    else
      lang = lang.downcase.split('.').last
    end
  end
  case lang
  when "ascii-8bit", "us-ascii", "ascii-7bit"; 'iso-8859-1'
  when "utf8"; 'utf-8'
  else; lang
  end
end

- (String) format_object_name_list(objects)

Formats a list of objects and links them



365
366
367
368
369
# File 'lib/yard/templates/helpers/html_helper.rb', line 365

def format_object_name_list(objects)
  objects.sort_by {|o| o.name.to_s.downcase }.map do |o|
    "<span class='name'>" + linkify(o, o.name) + "</span>"
  end.join(", ")
end

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

Formats a list of types from a tag.



383
384
385
386
387
388
389
390
391
# File 'lib/yard/templates/helpers/html_helper.rb', line 383

def format_types(typelist, brackets = true)
  return unless typelist.is_a?(Array)
  list = typelist.map do |type|
    type = type.gsub(/([<>])/) { h($1) }
    type = type.gsub(/([\w:]+)/) { $1 == "lt" || $1 == "gt" ? $1 : linkify($1, $1) }
    "<tt>" + type + "</tt>"
  end
  list.empty? ? "" : (brackets ? "(#{list.join(", ")})" : list.join(", "))
end

- (String) h(text)

Escapes HTML entities



16
17
18
# File 'lib/yard/templates/helpers/html_helper.rb', line 16

def h(text)
  CGI.escapeHTML(text.to_s)
end

- (String) html_markup_html(text)

Converts HTML to HTML

Since:

  • 0.6.0



128
129
130
# File 'lib/yard/templates/helpers/html_helper.rb', line 128

def html_markup_html(text)
  text
end

- (String) html_markup_markdown(text)

Converts Markdown to HTML

Since:

  • 0.6.0



62
63
64
65
66
67
68
69
70
71
72
# File 'lib/yard/templates/helpers/html_helper.rb', line 62

def html_markup_markdown(text)
  # TODO: other libraries might be more complex
  provider = markup_class(:markdown)
  if provider.to_s == 'RDiscount'
    provider.new(text, :autolink).to_html
  elsif provider.to_s == 'RedcarpetCompat'
    provider.new(text, :gh_blockcode, :fenced_code, :autolink).to_html
  else
    provider.new(text).to_html
  end
end

- (String) html_markup_none(text)

Returns the same text with no markup

Since:

  • 0.6.6



120
121
122
# File 'lib/yard/templates/helpers/html_helper.rb', line 120

def html_markup_none(text)
  h(text)
end

- (String) html_markup_pre(text)

Converts plaintext to pre-formatted HTML

Since:

  • 0.6.0



106
107
108
# File 'lib/yard/templates/helpers/html_helper.rb', line 106

def html_markup_pre(text)
  "<pre>" + h(text) + "</pre>"
end

- (String) html_markup_rdoc(text)

Converts RDoc formatting (SimpleMarkup) to HTML

Since:

  • 0.6.0



96
97
98
99
100
# File 'lib/yard/templates/helpers/html_helper.rb', line 96

def html_markup_rdoc(text)
  doc = markup_class(:rdoc).new(text)
  doc.from_path = url_for(object) if doc.respond_to?(:from_path=)
  doc.to_html
end

- (String) html_markup_ruby(source)

Highlights Ruby source. Similar to #html_syntax_highlight, but this method is meant to be called from #htmlify when markup is set to “ruby”.

Since:

  • 0.7.0



139
140
141
# File 'lib/yard/templates/helpers/html_helper.rb', line 139

def html_markup_ruby(source)
  '<pre class="code ruby">' + html_syntax_highlight(source, :ruby) + '</pre>'
end

- (String) html_markup_text(text)

Converts plaintext to regular HTML

Since:

  • 0.6.0



114
115
116
# File 'lib/yard/templates/helpers/html_helper.rb', line 114

def html_markup_text(text)
  h(text).gsub(/\r?\n/, '<br/>')
end

- (String) html_markup_textile(text)

Converts Textile to HTML

Since:

  • 0.6.0



78
79
80
81
82
# File 'lib/yard/templates/helpers/html_helper.rb', line 78

def html_markup_textile(text)
  doc = markup_class(:textile).new(text)
  doc.hard_breaks = false if doc.respond_to?(:hard_breaks=)
  doc.to_html
end

- (String) html_markup_textile_strict(text)

Converts plaintext to strict Textile (hard breaks)

Since:

  • 0.6.0



88
89
90
# File 'lib/yard/templates/helpers/html_helper.rb', line 88

def html_markup_textile_strict(text)
  markup_class(:textile).new(text).to_html
end

- (String) html_syntax_highlight(source, type = nil)

Note:

To support a specific language type, implement the method html_syntax_highlight_TYPE in this class.

Syntax highlights source in language type.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/yard/templates/helpers/html_helper.rb', line 159

def html_syntax_highlight(source, type = nil)
  return "" unless source
  return h(source) if options[:no_highlight]

  type ||= object.source_type || :ruby

  # handle !!!LANG prefix to send to html_syntax_highlight_LANG
  if source =~ /\A(?:[ \t]*\r?\n)?[ \t]*!!!([\w.+-]+)[ \t]*\r?\n/
    type, source = $1, $'
    source = $'
  end

  meth = "html_syntax_highlight_#{type}"
  respond_to?(meth) ? send(meth, source) : h(source)
end

- (String) html_syntax_highlight_plain(source)



176
177
178
# File 'lib/yard/templates/helpers/html_helper.rb', line 176

def html_syntax_highlight_plain(source)
  h(source)
end

- (String) htmlify(text, markup = options[:markup])

Turns text into HTML using markup style formatting.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/yard/templates/helpers/html_helper.rb', line 36

def htmlify(text, markup = options[:markup])
  markup_meth = "html_markup_#{markup}"
  return text unless respond_to?(markup_meth)
  return "" unless text
  return text unless markup
  html = send(markup_meth, text)
  if html.respond_to?(:encode)
    html = html.force_encoding(text.encoding) # for libs that mess with encoding
    html = html.encode(:invalid => :replace, :replace => '?')
  end
  html = resolve_links(html)
  html = html.gsub(/<pre\s*(?:lang="(.+?)")?>(?:\s*<code>)?(.+?)(?:<\/code>\s*)?<\/pre>/m) do
    language = $1
    string   = $2 
    
    string = html_syntax_highlight(CGI.unescapeHTML(string), language) unless options[:no_highlight]
    classes = ['code', language].compact.join(' ')
    %Q{<pre class="#{classes}">#{string}</pre>}
  end unless [:text, :none, :pre].include?(markup)
  html
end

- (String) htmlify_line(*args)



144
145
146
# File 'lib/yard/templates/helpers/html_helper.rb', line 144

def htmlify_line(*args)
  "<div class='inline'>" + htmlify(*args) + "</div>"
end

Links to an extra file

Since:

  • 0.5.5



228
229
230
231
232
233
234
235
236
237
# File 'lib/yard/templates/helpers/html_helper.rb', line 228

def link_file(filename, title = nil, anchor = nil)
  if CodeObjects::ExtraFileObject === filename
    file = filename
  else
    contents = File.file?(filename) ? nil : ''
    file = CodeObjects::ExtraFileObject.new(filename, contents)
  end
  return title || file.title unless serializer
  link_url(url_for_file(file, anchor), title || file.title)
end

Include a file as a docstring in output

Since:

  • 0.7.0



240
241
242
243
244
245
246
# File 'lib/yard/templates/helpers/html_helper.rb', line 240

def link_include_file(file)
  unless file.is_a?(CodeObjects::ExtraFileObject)
    file = CodeObjects::ExtraFileObject.new(file)
  end
  file.attributes[:markup] ||= markup_for_file('', file.filename)
  htmlify(file.contents, file.attributes[:markup] || options[:markup])
end

Includes an object's docstring into output.

Since:

  • 0.6.0



249
250
251
# File 'lib/yard/templates/helpers/html_helper.rb', line 249

def link_include_object(obj)
  htmlify(obj.docstring)
end

Links to an object with an optional title



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'lib/yard/templates/helpers/html_helper.rb', line 254

def link_object(obj, otitle = nil, anchor = nil, relative = true)
  return otitle if obj.nil?
  obj = Registry.resolve(object, obj, true, true) if obj.is_a?(String)
  if !otitle && obj.root?
    title = "Top Level Namespace"
  elsif otitle
    title = otitle.to_s
  elsif object.is_a?(CodeObjects::Base)
    title = h(object.relative_path(obj))
  else
    title = h(obj.to_s)
  end
  return title unless serializer
  return title if obj.is_a?(CodeObjects::Proxy)

  link = url_for(obj, anchor, relative)
  link = link ? link_url(link, title, :title => h("#{obj.path} (#{obj.type})")) : title
  "<span class='object_link'>" + link + "</span>"
end

Links to a URL



275
276
277
278
279
280
281
282
283
284
# File 'lib/yard/templates/helpers/html_helper.rb', line 275

def link_url(url, title = nil, params = {})
  title ||= url
  title.gsub!(/[\r\n]/, ' ')
  params = SymbolHash.new(false).update(
    :href => url,
    :title  => h(title)
  ).update(params)
  params[:target] ||= '_parent' if url =~ /^(\w+):\/\//
  "<a #{tag_attrs(params)}>#{title}</a>".gsub(/[\r\n]/, ' ')
end

Resolves any text in the form of {Name} to the object specified by Name. Also supports link titles in the form {Name title}.

Examples:

Linking to an instance method

resolve_links("{MyClass#method}") # => "<a href='...'>MyClass#method</a>"

Linking to a class with a title

resolve_links("{A::B::C the C class}") # => "<a href='...'>the c class</a>"


191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/yard/templates/helpers/html_helper.rb', line 191

def resolve_links(text)
  code_tags = 0
  text.gsub(/<(\/)?(pre|code|tt)|(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W<]|.+<\/|$)/m) do |str|
    closed, tag, escape, name, title, match = $1, $2, $3, $4, $5, $&
    if tag
      code_tags += (closed ? -1 : 1)
      next str
    end
    next str unless code_tags == 0

    next(match[1..-1]) if escape

    next(match) if name[0,1] == '|'
    
    if name == '<a' && title =~ /href=["'](.+?)["'].*>.*<\/a>\s*(.*)\Z/
      name, title = $1, $2
      title = nil if title.empty?
    end
    
    if object.is_a?(String)
      object
    else
      link = linkify(name, title)
      if (link == name || link == title) && (name+' '+link !~ /\A<a\s.*>/)
        match = /(.+)?(\{#{Regexp.quote name}(?:\s.*?)?\})(.+)?/.match(text)
        file = (@file ? @file.filename : object.file) || '(unknown)'
        line = (@file ? 1 : (object.docstring.line_range ? object.docstring.line_range.first : 1)) + (match ? $`.count("\n") : 0)
        log.warn "In file `#{file}':#{line}: Cannot resolve link to #{name} from text" + (match ? ":" : ".")
        log.warn((match[1] ? '...' : '') + match[2].gsub("\n","") + (match[3] ? '...' : '')) if match
      end

      link
    end
  end
end

- (String) signature(meth, link = true, show_extras = true, full_attr_name = true)

Formats the signature of method meth.



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/yard/templates/helpers/html_helper.rb', line 436

def signature(meth, link = true, show_extras = true, full_attr_name = true)
  meth = convert_method_to_overload(meth)

  type = signature_types(meth, link)
  scope = meth.scope == :class ? "+" : "-"
  name = full_attr_name ? meth.name : meth.name.to_s.gsub(/^(\w+)=$/, '\1')
  blk = format_block(meth)
  args = !full_attr_name && meth.writer? ? "" : format_args(meth)
  extras = []
  extras_text = ''
  if show_extras
    if rw = meth.attr_info
      attname = [rw[:read] ? 'read' : nil, rw[:write] ? 'write' : nil].compact
      attname = attname.size == 1 ? attname.join('') + 'only' : nil
      extras << attname if attname
    end
    extras << meth.visibility if meth.visibility != :public
    extras_text = ' <span class="extras">(' + extras.join(", ") + ')</span>' unless extras.empty?
  end
  title = "%s %s<strong>%s</strong>%s %s" % [scope, type, h(name), args, blk]
  if link
    if meth.is_a?(YARD::CodeObjects::MethodObject)
      link_title = "#{h meth.name(true)} (#{meth.scope} #{meth.type})"
    else
      link_title = "#{h name} (#{meth.type})"
    end
    obj = meth.respond_to?(:object) ? meth.object : meth
    link_url(url_for(obj), title, :title => link_title) + extras_text
  else
    title + extras_text
  end
end

- (String) signature_types(meth, link = true)

Get the return types for a method signature.

Since:

  • 0.5.3



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
# File 'lib/yard/templates/helpers/html_helper.rb', line 399

def signature_types(meth, link = true)
  meth = convert_method_to_overload(meth)
  if meth.respond_to?(:object) && !meth.has_tag?(:return)
    meth = meth.object
  end

  type = options[:default_return] || ""
  if meth.tag(:return) && meth.tag(:return).types
    types = meth.tags(:return).map {|t| t.types ? t.types : [] }.flatten.uniq
    first = link ? h(types.first) : format_types([types.first], false)
    if types.size == 2 && types.last == 'nil'
      type = first + '<sup>?</sup>'
    elsif types.size == 2 && types.last =~ /^(Array)?<#{Regexp.quote types.first}>$/
      type = first + '<sup>+</sup>'
    elsif types.size > 2
      type = [first, '...'].join(', ')
    elsif types == ['void'] && options[:hide_void_return]
      type = ""
    else
      type = link ? h(types.join(", ")) : format_types(types, false)
    end
  elsif !type.empty?
    type = link ? h(type) : format_types([type], false)
  end
  type = "(#{type}) " unless type.empty?
  type
end

- (String) url_for(obj, anchor = nil, relative = true)

Returns the URL for an object.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/yard/templates/helpers/html_helper.rb', line 311

def url_for(obj, anchor = nil, relative = true)
  link = nil
  return link unless serializer

  if obj.is_a?(CodeObjects::Base) && !obj.is_a?(CodeObjects::NamespaceObject)
    # If the obj is not a namespace obj make it the anchor.
    anchor, obj = obj, obj.namespace
  end

  objpath = serializer.serialized_path(obj)
  return link unless objpath

  if relative
    fromobj = object
    if object.is_a?(CodeObjects::Base) &&
        !object.is_a?(CodeObjects::NamespaceObject)
      fromobj = fromobj.namespace
    end

    from = serializer.serialized_path(fromobj)
    link = File.relative_path(from, objpath)
  else
    link = objpath
  end

  link + (anchor ? '#' + urlencode(anchor_for(anchor)) : '')
end

- (String) url_for_file(filename, anchor = nil)

Returns the URL for a specific file



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
# File 'lib/yard/templates/helpers/html_helper.rb', line 344

def url_for_file(filename, anchor = nil)
  return '' unless serializer
  fromobj = object
  if CodeObjects::Base === fromobj && !fromobj.is_a?(CodeObjects::NamespaceObject)
    fromobj = fromobj.namespace
  end
  from = serializer.serialized_path(fromobj)
  if filename == options[:readme]
    path = 'index.html'
  else
    path = serializer.serialized_path(filename)
  end
  link = File.relative_path(from, path)
  link += (anchor ? '#' + urlencode(anchor) : '')
  link
end

- (String) urlencode(text)

Escapes a URL



24
25
26
# File 'lib/yard/templates/helpers/html_helper.rb', line 24

def urlencode(text)
  CGI.escape(text.to_s)
end