module YARD::Templates::Helpers::MarkupHelper

Helper methods for loading and managing markup types.

Constants

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

MARKUP_FILE_SHEBANG

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

MARKUP_PROVIDERS

The default list of markup providers for each markup type

Attributes

markup_cache[RW]

@return [Hash{Symbol=>{(:provider,:class)=>Object}}] the cached markup providers @private @since 0.6.4

Public Class Methods

clear_markup_cache() click to toggle source

Clears the markup provider cache information. Mainly used for testing. @return [void]

# File lib/yard/templates/helpers/markup_helper.rb, line 10
def clear_markup_cache
  self.markup_cache = {}
end

Public Instance Methods

load_markup_provider(type = options.markup) click to toggle source

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 provider.

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

@return [Boolean] whether the markup provider was successfully loaded.

# File lib/yard/templates/helpers/markup_helper.rb, line 81
def load_markup_provider(type = options.markup)
  return true if MarkupHelper.markup_cache[type]
  MarkupHelper.markup_cache[type] ||= {}

  providers = MARKUP_PROVIDERS[type.to_sym]
  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 " +
      "(#{options.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 if provider[:lib]
    begin klass = eval("::" + provider[:const]); rescue NameError; next end
    MarkupHelper.markup_cache[type][:provider] = provider[:lib] # Cache the provider
    MarkupHelper.markup_cache[type][:class] = klass
    return true
  end

  # Show error message telling user to install first potential provider
  name, lib = *[providers.first[:const], providers.first[:lib] || type]
  log.error "Missing '#{lib}' gem for #{type.to_s.capitalize} formatting. Install it with `gem install #{lib}`"
  false
end
markup_class(type = options.markup) click to toggle source

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

@param [Symbol] type the markup type (:rdoc, :markdown, etc.) @return [Class] the markup class

# File lib/yard/templates/helpers/markup_helper.rb, line 154
def markup_class(type = options.markup)
  load_markup_provider(type)
  MarkupHelper.markup_cache[type][:class]
end
markup_file_contents(contents) click to toggle source

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

@deprecated Use {CodeObjects::ExtraFileObject#contents} instead @return [String] the file contents minus any preprocessing tags @since 0.6.0

# File lib/yard/templates/helpers/markup_helper.rb, line 145
def markup_file_contents(contents)
  contents =~ MARKUP_FILE_SHEBANG ? $' : contents
end
markup_for_file(contents, filename) click to toggle source

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

@param [String] contents Unused. Was necessary prior to 0.7.0.

Newer versions of YARD use {CodeObjects::ExtraFileObject#contents}

@return [Symbol] the markup type recognized for the file @see MARKUP_EXTENSIONS @since 0.6.0

# File lib/yard/templates/helpers/markup_helper.rb, line 127
def markup_for_file(contents, filename)
  if contents && 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 = options.markup) click to toggle source

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

@param [Symbol] type the markup type (:rdoc, :markdown, etc.) @return [Symbol] the markup provider name (usually the gem name of the library)

# File lib/yard/templates/helpers/markup_helper.rb, line 164
def markup_provider(type = options.markup)
  MarkupHelper.markup_cache[type][:provider]
end