Module: Doing::Plugins

Defined in:
lib/doing/plugin_manager.rb

Overview

Plugin handling

Class Method Summary collapse

Class Method Details

.available_plugins(type: :export) ⇒ Array<String>

Return array of available plugin names

Parameters:

  • type (defaults to: :export) —

    Plugin type (:import, :export)

Returns:

.list_plugins(options = {}) ⇒ Object

List available plugins to stdout

Parameters:

  • options (type, separator) (defaults to: {})

.load_plugins(add_dir = nil) ⇒ Object

Load plugins from plugins folder

.plugin_names(type: :export, separator: '|') ⇒ String

Return string version of plugin names

Parameters:

  • type (defaults to: :export) —

    Plugin type (:import, :export)

  • separator (defaults to: '|') —

    The separator to join names with

Returns:

.plugin_regex(type: :export) ⇒ Object

Return a regular expression of all plugin triggers for type

Parameters:

  • type (defaults to: :export) —

    The type :import or :export

.plugin_templates(type: :export) ⇒ Object

.plugins ⇒ Object

.plugins_path(add_dir = nil) ⇒ Object

Public: Setup the plugin search path

Returns an Array of plugin search paths

.register(title, type, klass) ⇒ Object

Register a plugin

param: +[String|Array]+ title The name of the plugin (can be an array of names)

param: +type+ The plugin type (:import, :export)

param: +klass+ The class responding to :render or :import

returns: Success boolean

.template_for_trigger(trigger, type: :export) ⇒ Object

Raises:

.template_regex(type: :export) ⇒ Object

.user_home ⇒ Object

.valid_type(type, default: nil) ⇒ Object

.validate_plugin(title, type, klass) ⇒ Object