<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::Plugins
— Documentation by YARD 0.9.28
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Doing::Plugins";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">Plugins</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Doing::Plugins
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/plugin_manager.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Plugin handling</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#available_plugins-class_method" title="available_plugins (class method)">.<strong>available_plugins</strong>(type: :export) ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return array of available plugin names.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#list_plugins-class_method" title="list_plugins (class method)">.<strong>list_plugins</strong>(options = {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>List available plugins to stdout.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#load_plugins-class_method" title="load_plugins (class method)">.<strong>load_plugins</strong>(add_dir = nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Load plugins from plugins folder.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#plugin_names-class_method" title="plugin_names (class method)">.<strong>plugin_names</strong>(type: :export, separator: '|') ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return string version of plugin names.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#plugin_regex-class_method" title="plugin_regex (class method)">.<strong>plugin_regex</strong>(type: :export) ⇒ Regexp </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return a regular expression of all plugin triggers for type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#plugin_templates-class_method" title="plugin_templates (class method)">.<strong>plugin_templates</strong>(type: :export) ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return array of available template names.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#plugins-class_method" title="plugins (class method)">.<strong>plugins</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'><p>Storage for registered plugins.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#plugins_path-class_method" title="plugins_path (class method)">.<strong>plugins_path</strong>(add_dir = nil) ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Setup the plugin search path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#register-class_method" title="register (class method)">.<strong>register</strong>(title, type, klass) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Register a plugin.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#template_for_trigger-class_method" title="template_for_trigger (class method)">.<strong>template_for_trigger</strong>(trigger, type: :export, save_to: nil) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Find and return the appropriate template for a trigger string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#template_regex-class_method" title="template_regex (class method)">.<strong>template_regex</strong>(type: :export) ⇒ Regexp </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return a regular expression of all template triggers for type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_home-class_method" title="user_home (class method)">.<strong>user_home</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return the user's home directory.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#valid_type-class_method" title="valid_type (class method)">.<strong>valid_type</strong>(type, default: nil) ⇒ Symbol </a>
</span>
<span class="summary_desc"><div class='inline'><p>Converts a partial symbol to a valid plugin type, e.g.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#validate_plugin-class_method" title="validate_plugin (class method)">.<strong>validate_plugin</strong>(title, type, klass) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Verifies that a plugin is properly configured with necessary methods for its type.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="available_plugins-class_method">
.<strong>available_plugins</strong>(type: :export) ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return array of available plugin names</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:export</tt>)</em>
—
<div class='inline'><p>Plugin type (:import, :export)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>Array of plugin names (String)</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="list_plugins-class_method">
.<strong>list_plugins</strong>(options = {}) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>List available plugins to stdout</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>additional options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
<ul class="option">
<li>
<span class="name">:column</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>display results in a single column</p>
</div>
</li>
<li>
<span class="name">:type</span>
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>Plugin type: all, import, or export</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="load_plugins-class_method">
.<strong>load_plugins</strong>(add_dir = nil) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Load plugins from plugins folder</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="plugin_names-class_method">
.<strong>plugin_names</strong>(type: :export, separator: '|') ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return string version of plugin names</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>type</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>:export</tt>)</em>
—
<div class='inline'><p>Plugin type (:import, :export)</p>
</div>
</li>
<li>
<span class='name'>separator</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>'|'</tt>)</em>
—
<div class='inline'><p>The separator to join names with</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>Plugin names joined with separator</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="plugin_regex-class_method">
.<strong>plugin_regex</strong>(type: :export) ⇒ <tt>Regexp</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a regular expression of all plugin triggers
for type</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:export</tt>)</em>
—
<div class='inline'><p>The type :import or
:export</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Regexp</tt>)</span>
—
<div class='inline'><p>regular expression</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="plugin_templates-class_method">
.<strong>plugin_templates</strong>(type: :export) ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return array of available template names</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:export</tt>)</em>
—
<div class='inline'><p>Plugin type (:import,
:export)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>Array of template names (String)</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="plugins-class_method">
.<strong>plugins</strong> ⇒ <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Storage for registered plugins. Hash with :import
and :export keys containing hashes of available
plugins.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>registered plugins</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="plugins_path-class_method">
.<strong>plugins_path</strong>(add_dir = nil) ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Setup the plugin search path</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>add_dir</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>optional additional
path to include</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>Returns an Array of plugin search paths</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="register-class_method">
.<strong>register</strong>(title, type, klass) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Register a plugin</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>title</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span>|<span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>The name of the
plugin (can be an array of names)</p>
</div>
</li>
<li>
<span class='name'>type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>The plugin type
(:import, :export)</p>
</div>
</li>
<li>
<span class='name'>klass</span>
<span class='type'>(<tt>Class</tt>)</span>
—
<div class='inline'><p>The class responding to
:render or :import</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>Success boolean</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="template_for_trigger-class_method">
.<strong>template_for_trigger</strong>(trigger, type: :export, save_to: nil) ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Find and return the appropriate template for a
trigger string. Outputs a string that can be
written out to the terminal for redirection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>trigger</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The trigger to test</p>
</div>
</li>
<li>
<span class='name'>type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:export</tt>)</em>
—
<div class='inline'><p>the plugin type
(:import, :export)</p>
</div>
</li>
<li>
<span class='name'>save_to</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>if a path is
specified, write the template
to that path. Nil for STDOUT</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>string content of template for trigger</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Errors.html#InvalidArgument-constant" title="Doing::Errors::InvalidArgument (constant)">Errors::InvalidArgument</a></span></tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="template_regex-class_method">
.<strong>template_regex</strong>(type: :export) ⇒ <tt>Regexp</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a regular expression of all template
triggers for type</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:export</tt>)</em>
—
<div class='inline'><p>The type :import or
:export</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Regexp</tt>)</span>
—
<div class='inline'><p>regular expression</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="user_home-class_method">
.<strong>user_home</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the user's home directory</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="valid_type-class_method">
.<strong>valid_type</strong>(type, default: nil) ⇒ <tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Converts a partial symbol to a valid plugin type,
e.g. :imp => :import</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>the symbol to test</p>
</div>
</li>
<li>
<span class='name'>default</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>fallback value</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>:import or :export</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="validate_plugin-class_method">
.<strong>validate_plugin</strong>(title, type, klass) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Verifies that a plugin is properly configured with
necessary methods for its type. If the plugin fails
validation, a PluginUncallable exception will be
raised.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>title</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The title</p>
</div>
</li>
<li>
<span class='name'>type</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>type, :import or
:export</p>
</div>
</li>
<li>
<span class='name'>klass</span>
<span class='type'>(<tt>Class</tt>)</span>
—
<div class='inline'><p>Plugin class</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Jan 1 07:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.0.1).
</div>
</div>
</body>
</html>