class Asciidoctor::Extensions::Registry

Public: The primary entry point into the extension system.

Registry holds the extensions which have been registered and activated, has methods for registering or defining a processor and looks up extensions stored in the registry during parsing.

Attributes

document[R]

Public: Returns the {Asciidoctor::Document} on which the extensions in this registry are being used.

groups[R]

Public: Returns the Array of {Group} classes, instances and/or Procs that have been registered.

Public Class Methods

new(groups = {}) click to toggle source
# File lib/asciidoctor/extensions.rb, line 518
def initialize groups = {}
  @groups = groups
  @preprocessor_extensions = @treeprocessor_extensions = @postprocessor_extensions = @include_processor_extensions = @docinfo_processor_extensions =nil
  @block_extensions = @block_macro_extensions = @inline_macro_extensions = nil
  @document = nil
end

Public Instance Methods

activate(document) click to toggle source

Public: Activates all the global extension {Group}s and the extension {Group}s associated with this registry.

document - the {Asciidoctor::Document} on which the extensions are to be used.

Returns the instance of this [Registry].

# File lib/asciidoctor/extensions.rb, line 531
def activate document
  @document = document
  (Extensions.groups.values + @groups.values).each do |group|
    case group
    when ::Proc
      case group.arity
      when 0, -1
        instance_exec(&group)
      when 1
        group.call self
      end
    when ::Class
      group.new.activate self
    else
      group.activate self
    end
  end
  self
end
block(*args, &block) click to toggle source

Public: Registers a {BlockProcessor} with the extension registry to process the block content (i.e., delimited block or paragraph) in the AsciiDoc source annotated with the specified block name (i.e., style).

The BlockProcessor may be one of four types:

Unless the BlockProcessor is passed as the method block, it must be the first argument to this method. The second argument is the name (coersed to a Symbol) of the AsciiDoc block content (i.e., delimited block or paragraph) that this processor is registered to handle. If a block name is not passed as an argument, it gets read from the name property of the BlockProcessor instance. If a name still cannot be determined, an error is raised.

Examples

# as a BlockProcessor subclass
block ShoutBlock

# as a BlockProcessor subclass with an explicit block name
block ShoutBlock, :shout

# as an instance of a BlockProcessor subclass
block ShoutBlock.new

# as an instance of a BlockProcessor subclass with an explicit block name
block ShoutBlock.new, :shout

# as a name of a BlockProcessor subclass
block 'ShoutBlock'

# as a name of a BlockProcessor subclass with an explicit block name
block 'ShoutBlock', :shout

# as a method block
block do
  named :shout
  process |parent, reader, attrs|
    ...
  end
end

# as a method block with an explicit block name
block :shout do
  process |parent, reader, attrs|
    ...
  end
end

Returns an instance of the [Extension] proxy object that is stored in the registry and manages the instance of this BlockProcessor.

# File lib/asciidoctor/extensions.rb, line 888
def block *args, &block
  add_syntax_processor :block, args, &block
end
block_macro(*args, &block) click to toggle source

Public: Registers a {BlockMacroProcessor} with the extension registry to process a block macro with the specified name.

The BlockMacroProcessor may be one of four types:

Unless the BlockMacroProcessor is passed as the method block, it must be the first argument to this method. The second argument is the name (coersed to a Symbol) of the AsciiDoc block macro that this processor is registered to handle. If a block macro name is not passed as an argument, it gets read from the name property of the BlockMacroProcessor instance. If a name still cannot be determined, an error is raised.

Examples

# as a BlockMacroProcessor subclass
block_macro GistBlockMacro

# as a BlockMacroProcessor subclass with an explicit macro name
block_macro GistBlockMacro, :gist

# as an instance of a BlockMacroProcessor subclass
block_macro GistBlockMacro.new

# as an instance of a BlockMacroProcessor subclass with an explicit macro name
block_macro GistBlockMacro.new, :gist

# as a name of a BlockMacroProcessor subclass
block_macro 'GistBlockMacro'

# as a name of a BlockMacroProcessor subclass with an explicit macro name
block_macro 'GistBlockMacro', :gist

# as a method block
block_macro do
  named :gist
  process |parent, target, attrs|
    ...
  end
end

# as a method block with an explicit macro name
block_macro :gist do
  process |parent, target, attrs|
    ...
  end
end

Returns an instance of the [Extension] proxy object that is stored in the registry and manages the instance of this BlockMacroProcessor.

# File lib/asciidoctor/extensions.rb, line 977
def block_macro *args, &block
  add_syntax_processor :block_macro, args, &block
end
block_macros?() click to toggle source

Public: Checks whether any {BlockMacroProcessor} extensions have been registered.

Returns a [Boolean] indicating whether any BlockMacroProcessor extensions are registered.

# File lib/asciidoctor/extensions.rb, line 984
def block_macros?
  !!@block_macro_extensions
end
blocks?() click to toggle source

Public: Checks whether any {BlockProcessor} extensions have been registered.

Returns a [Boolean] indicating whether any BlockProcessor extensions are registered.

# File lib/asciidoctor/extensions.rb, line 895
def blocks?
  !!@block_extensions
end
docinfo_processor(*args, &block) click to toggle source

Public: Registers an {DocinfoProcessor} with the extension registry to add additionnal docinfo to the document.

The DocinfoProcessor may be one of four types:

Unless the DocinfoProcessor is passed as the method block, it must be the first argument to this method.

Examples

# as an DocinfoProcessor subclass
docinfo_processor MetaRobotsDocinfoProcessor

# as an instance of a DocinfoProcessor subclass with an explicit location
docinfo_processor JQueryDocinfoProcessor.new, :location => :footer

# as a name of a DocinfoProcessor subclass
docinfo_processor 'MetaRobotsDocinfoProcessor'

# as a method block
docinfo_processor do
  process |doc|
    at_location :footer
    'footer content'
  end
end

Returns the [Extension] stored in the registry that proxies the instance of this DocinfoProcessor.

# File lib/asciidoctor/extensions.rb, line 793
def docinfo_processor *args, &block
  add_document_processor :docinfo_processor, args, &block
end
docinfo_processors(location = nil) click to toggle source

Public: Retrieves the {Extension} proxy objects for all the DocinfoProcessor instances stored in this registry.

location - A Symbol for selecting docinfo extensions at a given location (:head or :footer) (default: nil)

Returns an [Array] of Extension proxy objects.

# File lib/asciidoctor/extensions.rb, line 820
def docinfo_processors location = nil
  if @docinfo_processor_extensions
    if location
      @docinfo_processor_extensions.select {|ext| ext.config[:location] == location }
    else
      @docinfo_processor_extensions
    end
  else
    nil
  end
end
docinfo_processors?(location = nil) click to toggle source

Public: Checks whether any {DocinfoProcessor} extensions have been registered.

location - A Symbol for selecting docinfo extensions at a given location (:head or :footer) (default: nil)

Returns a [Boolean] indicating whether any DocinfoProcessor extensions are registered.

# File lib/asciidoctor/extensions.rb, line 802
def docinfo_processors? location = nil
  if @docinfo_processor_extensions
    if location
      @docinfo_processor_extensions.any? {|ext| ext.config[:location] == location }
    else
      true
    end
  else
    false
  end
end
find_block_extension(name) click to toggle source

Public: Retrieves the {Extension} proxy object for the BlockProcessor registered to handle block content with the name.

name - the String or Symbol (coersed to a Symbol) macro name

Returns the [Extension] object stored in the registry that proxies the corresponding BlockProcessor or nil if a match is not found.

# File lib/asciidoctor/extensions.rb, line 919
def find_block_extension name
  @block_extensions[name.to_sym]
end
find_block_macro_extension(name) click to toggle source

Public: Retrieves the {Extension} proxy object for the BlockMacroProcessor registered to handle a block macro with the specified name.

name - the String or Symbol (coersed to a Symbol) macro name

Returns the [Extension] object stored in the registry that proxies the cooresponding BlockMacroProcessor or nil if a match is not found.

# File lib/asciidoctor/extensions.rb, line 1008
def find_block_macro_extension name
  @block_macro_extensions[name.to_sym]
end
find_inline_macro_extension(name) click to toggle source

Public: Retrieves the {Extension} proxy object for the InlineMacroProcessor registered to handle an inline macro with the specified name.

name - the String or Symbol (coersed to a Symbol) macro name

Returns the [Extension] object stored in the registry that proxies the cooresponding InlineMacroProcessor or nil if a match is not found.

# File lib/asciidoctor/extensions.rb, line 1095
def find_inline_macro_extension name
  @inline_macro_extensions[name.to_sym]
end
include_processor(*args, &block) click to toggle source

Public: Registers an {IncludeProcessor} with the extension registry to have a shot at handling the include directive.

The IncludeProcessor may be one of four types:

Unless the IncludeProcessor is passed as the method block, it must be the first argument to this method.

Examples

# as an IncludeProcessor subclass
include_processor GitIncludeProcessor

# as an instance of a Postprocessor subclass
include_processor GitIncludeProcessor.new

# as a name of a Postprocessor subclass
include_processor 'GitIncludeProcessor'

# as a method block
include_processor do
  process |document, output|
    ...
  end
end

Returns the [Extension] stored in the registry that proxies the instance of this IncludeProcessor.

# File lib/asciidoctor/extensions.rb, line 740
def include_processor *args, &block
  add_document_processor :include_processor, args, &block
end
include_processors() click to toggle source

Public: Retrieves the {Extension} proxy objects for all the IncludeProcessor instances stored in this registry.

Returns an [Array] of Extension proxy objects.

# File lib/asciidoctor/extensions.rb, line 755
def include_processors
  @include_processor_extensions
end
include_processors?() click to toggle source

Public: Checks whether any {IncludeProcessor} extensions have been registered.

Returns a [Boolean] indicating whether any IncludeProcessor extensions are registered.

# File lib/asciidoctor/extensions.rb, line 747
def include_processors?
  !!@include_processor_extensions
end
inline_macro(*args, &block) click to toggle source

Public: Registers a {InlineMacroProcessor} with the extension registry to process an inline macro with the specified name.

The InlineMacroProcessor may be one of four types:

Unless the InlineMacroProcessor is passed as the method block, it must be the first argument to this method. The second argument is the name (coersed to a Symbol) of the AsciiDoc block macro that this processor is registered to handle. If a block macro name is not passed as an argument, it gets read from the name property of the InlineMacroProcessor instance. If a name still cannot be determined, an error is raised.

Examples

# as an InlineMacroProcessor subclass
inline_macro ChromeInlineMacro

# as an InlineMacroProcessor subclass with an explicit macro name
inline_macro ChromeInineMacro, :chrome

# as an instance of an InlineMacroProcessor subclass
inline_macro ChromeInlineMacro.new

# as an instance of an InlineMacroProcessor subclass with an explicit macro name
inline_macro ChromeInlineMacro.new, :chrome

# as a name of an InlineMacroProcessor subclass
inline_macro 'ChromeInlineMacro'

# as a name of an InlineMacroProcessor subclass with an explicit macro name
inline_macro 'ChromeInineMacro', :chrome

# as a method block
inline_macro do
  named :chrome
  process |parent, target, attrs|
    ...
  end
end

# as a method block with an explicit macro name
inline_macro :chrome do
  process |parent, target, attrs|
    ...
  end
end

Returns an instance of the [Extension] proxy object that is stored in the registry and manages the instance of this InlineMacroProcessor.

# File lib/asciidoctor/extensions.rb, line 1066
def inline_macro *args, &block
  add_syntax_processor :inline_macro, args, &block
end
inline_macros() click to toggle source

Public: Retrieves the {Extension} proxy objects for all InlineMacroProcessor instances in this registry.

Returns an [Array] of Extension proxy objects.

# File lib/asciidoctor/extensions.rb, line 1103
def inline_macros
  @inline_macro_extensions.values
end
inline_macros?() click to toggle source

Public: Checks whether any {InlineMacroProcessor} extensions have been registered.

Returns a [Boolean] indicating whether any IncludeMacroProcessor extensions are registered.

# File lib/asciidoctor/extensions.rb, line 1073
def inline_macros?
  !!@inline_macro_extensions
end
postprocessor(*args, &block) click to toggle source

Public: Registers a {Postprocessor} with the extension registry to process the output after conversion is complete.

The Postprocessor may be one of four types:

Unless the Postprocessor is passed as the method block, it must be the first argument to this method.

Examples

# as a Postprocessor subclass
postprocessor AnalyticsPostprocessor

# as an instance of a Postprocessor subclass
postprocessor AnalyticsPostprocessor.new

# as a name of a Postprocessor subclass
postprocessor 'AnalyticsPostprocessor'

# as a method block
postprocessor do
  process |document, output|
    ...
  end
end

Returns the [Extension] stored in the registry that proxies the instance of this Postprocessor.

# File lib/asciidoctor/extensions.rb, line 688
def postprocessor *args, &block
  add_document_processor :postprocessor, args, &block
end
postprocessors() click to toggle source

Public: Retrieves the {Extension} proxy objects for all Postprocessor instances in this registry.

Returns an [Array] of Extension proxy objects.

# File lib/asciidoctor/extensions.rb, line 703
def postprocessors
  @postprocessor_extensions
end
postprocessors?() click to toggle source

Public: Checks whether any {Postprocessor} extensions have been registered.

Returns a [Boolean] indicating whether any Postprocessor extensions are registered.

# File lib/asciidoctor/extensions.rb, line 695
def postprocessors?
  !!@postprocessor_extensions
end
preprocessor(*args, &block) click to toggle source

Public: Registers a {Preprocessor} with the extension registry to process the AsciiDoc source before parsing begins.

The Preprocessor may be one of four types:

Unless the Preprocessor is passed as the method block, it must be the first argument to this method.

Examples

# as a Preprocessor subclass
preprocessor FrontMatterPreprocessor

# as an instance of a Preprocessor subclass
preprocessor FrontMatterPreprocessor.new

# as a name of a Preprocessor subclass
preprocessor 'FrontMatterPreprocessor'

# as a method block
preprocessor do
  process |reader, lines|
    ...
  end
end

Returns the [Extension] stored in the registry that proxies the instance of this Preprocessor.

# File lib/asciidoctor/extensions.rb, line 584
def preprocessor *args, &block
  add_document_processor :preprocessor, args, &block
end
preprocessors() click to toggle source

Public: Retrieves the {Extension} proxy objects for all Preprocessor instances in this registry.

Returns an [Array] of Extension proxy objects.

# File lib/asciidoctor/extensions.rb, line 599
def preprocessors
  @preprocessor_extensions
end
preprocessors?() click to toggle source

Public: Checks whether any {Preprocessor} extensions have been registered.

Returns a [Boolean] indicating whether any Preprocessor extensions are registered.

# File lib/asciidoctor/extensions.rb, line 591
def preprocessors?
  !!@preprocessor_extensions
end
registered_for_block?(name, context) click to toggle source

Public: Checks whether any {BlockProcessor} extensions are registered to handle the specified block name appearing on the specified context.

Returns the [Extension] proxy object for the BlockProcessor that matches the block name and context or false if no match is found.

# File lib/asciidoctor/extensions.rb, line 904
def registered_for_block? name, context
  if (ext = @block_extensions[name.to_sym])
    (ext.config[:contexts].include? context) ? ext : false
  else
    false
  end
end
registered_for_block_macro?(name) click to toggle source

Public: Checks whether any {BlockMacroProcessor} extensions are registered to handle the block macro with the specified name.

name - the String or Symbol (coersed to a Symbol) macro name

Returns the [Extension] proxy object for the BlockMacroProcessor that matches the macro name or false if no match is found.

# File lib/asciidoctor/extensions.rb, line 997
def registered_for_block_macro? name
  (ext = @block_macro_extensions[name.to_sym]) ? ext : false
end
registered_for_inline_macro?(name) click to toggle source

Public: Checks whether any {InlineMacroProcessor} extensions are registered to handle the inline macro with the specified name.

name - the String or Symbol (coersed to a Symbol) macro name

Returns the [Extension] proxy object for the InlineMacroProcessor that matches the macro name or false if no match is found.

# File lib/asciidoctor/extensions.rb, line 1084
def registered_for_inline_macro? name
  (ext = @inline_macro_extensions[name.to_sym]) ? ext : false
end
treeprocessor(*args, &block) click to toggle source

Public: Registers a {Treeprocessor} with the extension registry to process the AsciiDoc source after parsing is complete.

The Treeprocessor may be one of four types:

Unless the Treeprocessor is passed as the method block, it must be the first argument to this method.

Examples

# as a Treeprocessor subclass
treeprocessor ShellTreeprocessor

# as an instance of a Treeprocessor subclass
treeprocessor ShellTreeprocessor.new

# as a name of a Treeprocessor subclass
treeprocessor 'ShellTreeprocessor'

# as a method block
treeprocessor do
  process |document|
    ...
  end
end

Returns the [Extension] stored in the registry that proxies the instance of this Treeprocessor.

# File lib/asciidoctor/extensions.rb, line 636
def treeprocessor *args, &block
  add_document_processor :treeprocessor, args, &block
end
treeprocessors() click to toggle source

Public: Retrieves the {Extension} proxy objects for all Treeprocessor instances in this registry.

Returns an [Array] of Extension proxy objects.

# File lib/asciidoctor/extensions.rb, line 651
def treeprocessors
  @treeprocessor_extensions
end
treeprocessors?() click to toggle source

Public: Checks whether any {Treeprocessor} extensions have been registered.

Returns a [Boolean] indicating whether any Treeprocessor extensions are registered.

# File lib/asciidoctor/extensions.rb, line 643
def treeprocessors?
  !!@treeprocessor_extensions
end