Module: YARD::Templates::Helpers::MarkupHelper

Included in:
HtmlHelper
Defined in:
lib/yard/templates/helpers/markup_helper.rb

Overview

Helper methods for loading and managing markup types.

Constant Summary collapse

MARKUP_PROVIDERS = 
{
  :markdown => [
    {:lib => :bluecloth, :const => 'BlueCloth'},
    {:lib => :maruku, :const => 'Maruku'},
    {:lib => :"rpeg-markdown", :const => "PEGMarkdown"},
    {:lib => :rdiscount, :const => "RDiscount"},
    {:lib => :kramdown, :const => "Kramdown::Document"}
  ],
  :textile => [
    {:lib => :redcloth, :const => 'RedCloth'}
  ],
  :rdoc => [],
  :text => [],
  :html => []
}
MARKUP_EXTENSIONS =

Returns a list of extensions for various markup types. To register extensions for a type, add them to the array of extensions for the type.

Since:

  • 0.6.0

{
  :html => ['htm', 'html', 'shtml'],
  :text => ['txt'],
  :textile => ['textile', 'txtile'],
  :markdown => ['markdown', 'md', 'mdown', 'mkd'],
  :rdoc => ['rdoc']
}
MARKUP_FILE_SHEBANG =

Contains the Regexp object that matches the shebang line of extra files to detect the markup type.

/\A#!(\S+)\s*$/

Instance Method Summary collapse

Instance Method Details

#load_markup_provider(type = ) ⇒ Boolean

Attempts to load the first valid markup provider in MARKUP_PROVIDERS. If a provider is specified, immediately try to load it.

On success this sets ‘@markup_provider` and `@markup_class` to the provider name and library constant class/module respectively for the loaded proider.

On failure this method will inform the user that no provider could be found and exit the program.

Returns:

  • (Boolean) —

    whether the markup provider was successfully loaded.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/yard/templates/helpers/markup_helper.rb', line 63

def load_markup_provider(type = options[:markup])
  return true if type == :rdoc || (@markup_cache && @markup_cache[type])
  @markup_cache ||= {}
  @markup_cache[type] ||= {}
  
  providers = MARKUP_PROVIDERS[type]
  return true if providers && providers.empty?
  if providers && options[:markup_provider]
    providers = providers.select {|p| p[:lib] == options[:markup_provider] }
  end
  
  if providers == nil || providers.empty?
    log.error "Invalid markup type '#{type}' or markup provider is not registered."
    return false
  end
  
  # Search for provider, return the library class name as const if found
  providers.each do |provider|
    begin require provider[:lib].to_s; rescue LoadError; next end
    @markup_cache[type][:provider] = provider[:lib] # Cache the provider
    @markup_cache[type][:class] = eval(provider[:const])
    return true
  end
  
  # Show error message telling user to install first potential provider
  name, lib = providers.first[:const], providers.first[:lib]
  log.error "Missing #{name} gem for #{options[:markup].to_s.capitalize} formatting. Install it with `gem install #{lib}`"
  false
end

#markup_class(type = ) ⇒ Class

Gets the markup provider class/module constant for a markup type Call #load_markup_provider before using this method.

Parameters:

  • the (Symbol) —

    markup type (:rdoc, :markdown, etc.)

Returns:

  • (Class) —

    the markup class



132
133
134
 
# File 'lib/yard/templates/helpers/markup_helper.rb', line 132

def markup_class(type = options[:markup])
  type == :rdoc ? SimpleMarkup : @markup_cache[type][:class]
end

#markup_file_contents(contents) ⇒ String

Strips any shebang lines on the file contents that pertain to markup or preprocessing data.

Returns:

  • (String) —

    the file contents minus any preprocessing tags

Since:

  • 0.6.0



123
124
125
 
# File 'lib/yard/templates/helpers/markup_helper.rb', line 123

def markup_file_contents(contents)
  contents =~ MARKUP_FILE_SHEBANG ? $' : contents
end

#markup_for_file(contents, filename) ⇒ Symbol

Checks for a shebang or looks at the file extension to determine the markup type for the file contents. File extensions are registered for a markup type in MARKUP_EXTENSIONS.

A shebang should be on the first line of a file and be in the form:

#!markup_type

Standard markup types are text, html, rdoc, markdown, textile

Returns:

  • (Symbol) —

    the markup type recognized for the file

See Also:

Since:

  • 0.6.0



106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/yard/templates/helpers/markup_helper.rb', line 106

def markup_for_file(contents, filename)
  if contents =~ MARKUP_FILE_SHEBANG # Shebang support
    return $1.to_sym
  end

  ext = (File.extname(filename)[1..-1] || '').downcase
  MARKUP_EXTENSIONS.each do |type, exts|
    return type if exts.include?(ext)
  end
  options[:markup]
end

#markup_provider(type = ) ⇒ Symbol

Gets the markup provider name for a markup type Call #load_markup_provider before using this method.

Parameters:

  • the (Symbol) —

    markup type (:rdoc, :markdown, etc.)

Returns:

  • (Symbol) —

    the markup provider name (usually the gem name of the library)



141
142
143
 
# File 'lib/yard/templates/helpers/markup_helper.rb', line 141

def markup_provider(type = options[:markup])
  type == :rdoc ? nil : @markup_cache[type][:provider]
end