<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Doing::TemplateString
— Documentation by YARD 0.9.26
</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::TemplateString";
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 (T)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">TemplateString</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>Class: Doing::TemplateString
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></li>
<li class="next">Doing::TemplateString</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/template_string.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Template string formatting</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Color.html#ATTRIBUTES-constant" title="Doing::Color::ATTRIBUTES (constant)">Color::ATTRIBUTES</a></span>, <span class='object_link'><a href="Color.html#ATTRIBUTE_NAMES-constant" title="Doing::Color::ATTRIBUTE_NAMES (constant)">Color::ATTRIBUTE_NAMES</a></span>, <span class='object_link'><a href="Color.html#COLORED_REGEXP-constant" title="Doing::Color::COLORED_REGEXP (constant)">Color::COLORED_REGEXP</a></span></p>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#original-instance_method" title="#original (instance method)">#<strong>original</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute original.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#apply_colors-instance_method" title="#apply_colors (instance method)">#<strong>apply_colors</strong>(color_array) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Apply a color array to a string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#colored-instance_method" title="#colored (instance method)">#<strong>colored</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return string with %colors replaced with escape codes.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#colors%3F-instance_method" title="#colors? (instance method)">#<strong>colors?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if string contains any valid %colors.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fill-instance_method" title="#fill (instance method)">#<strong>fill</strong>(placeholder, value, wrap_width: 0, color: '', tags_color: '', reset: '') ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(string, placeholders: {}, force_color: false, wrap_width: 0, color: '', tags_color: '', reset: '') ⇒ TemplateString </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of TemplateString.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse_colors-instance_method" title="#parse_colors (instance method)">#<strong>parse_colors</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'><p>Parse a template string for %colors and return a hash of colors and string locations.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parsed_colors-instance_method" title="#parsed_colors (instance method)">#<strong>parsed_colors</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#raw-instance_method" title="#raw (instance method)">#<strong>raw</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Remove all valid %colors from string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reparse-instance_method" title="#reparse (instance method)">#<strong>reparse</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Color.html#attributes-class_method" title="Doing::Color.attributes (method)">attributes</a></span>, <span class='object_link'><a href="Color.html#coloring%3F-class_method" title="Doing::Color.coloring? (method)">coloring?</a></span>, <span class='object_link'><a href="Color.html#support%3F-instance_method" title="Doing::Color#support? (method)">#support?</a></span>, <span class='object_link'><a href="Color.html#uncolor-instance_method" title="Doing::Color#uncolor (method)">#uncolor</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../String.html#add_at-instance_method" title="String#add_at (method)">#add_at</a></span>, <span class='object_link'><a href="../String.html#add_tags-instance_method" title="String#add_tags (method)">#add_tags</a></span>, <span class='object_link'><a href="../String.html#add_tags!-instance_method" title="String#add_tags! (method)">#add_tags!</a></span>, <span class='object_link'><a href="../String.html#cap_first-instance_method" title="String#cap_first (method)">#cap_first</a></span>, <span class='object_link'><a href="../String.html#chronify-instance_method" title="String#chronify (method)">#chronify</a></span>, <span class='object_link'><a href="../String.html#chronify_qty-instance_method" title="String#chronify_qty (method)">#chronify_qty</a></span>, <span class='object_link'><a href="../String.html#clean_unlinked_urls-instance_method" title="String#clean_unlinked_urls (method)">#clean_unlinked_urls</a></span>, <span class='object_link'><a href="../String.html#compress-instance_method" title="String#compress (method)">#compress</a></span>, <span class='object_link'><a href="../String.html#compress!-instance_method" title="String#compress! (method)">#compress!</a></span>, <span class='object_link'><a href="../String.html#dedup_tags-instance_method" title="String#dedup_tags (method)">#dedup_tags</a></span>, <span class='object_link'><a href="../String.html#dedup_tags!-instance_method" title="String#dedup_tags! (method)">#dedup_tags!</a></span>, <span class='object_link'><a href="../String.html#highlight_tags-instance_method" title="String#highlight_tags (method)">#highlight_tags</a></span>, <span class='object_link'><a href="../String.html#highlight_tags!-instance_method" title="String#highlight_tags! (method)">#highlight_tags!</a></span>, <span class='object_link'><a href="../String.html#ignore%3F-instance_method" title="String#ignore? (method)">#ignore?</a></span>, <span class='object_link'><a href="../String.html#is_rx%3F-instance_method" title="String#is_rx? (method)">#is_rx?</a></span>, <span class='object_link'><a href="../String.html#last_color-instance_method" title="String#last_color (method)">#last_color</a></span>, <span class='object_link'><a href="../String.html#link_urls-instance_method" title="String#link_urls (method)">#link_urls</a></span>, <span class='object_link'><a href="../String.html#link_urls!-instance_method" title="String#link_urls! (method)">#link_urls!</a></span>, <span class='object_link'><a href="../String.html#normalize_bool-instance_method" title="String#normalize_bool (method)">#normalize_bool</a></span>, <span class='object_link'><a href="../String.html#normalize_bool!-instance_method" title="String#normalize_bool! (method)">#normalize_bool!</a></span>, <span class='object_link'><a href="../String.html#normalize_case-instance_method" title="String#normalize_case (method)">#normalize_case</a></span>, <span class='object_link'><a href="../String.html#normalize_case!-instance_method" title="String#normalize_case! (method)">#normalize_case!</a></span>, <span class='object_link'><a href="../String.html#normalize_matching-instance_method" title="String#normalize_matching (method)">#normalize_matching</a></span>, <span class='object_link'><a href="../String.html#normalize_matching!-instance_method" title="String#normalize_matching! (method)">#normalize_matching!</a></span>, <span class='object_link'><a href="../String.html#normalize_order-instance_method" title="String#normalize_order (method)">#normalize_order</a></span>, <span class='object_link'><a href="../String.html#normalize_order!-instance_method" title="String#normalize_order! (method)">#normalize_order!</a></span>, <span class='object_link'><a href="../String.html#normalize_trigger-instance_method" title="String#normalize_trigger (method)">#normalize_trigger</a></span>, <span class='object_link'><a href="../String.html#normalize_trigger!-instance_method" title="String#normalize_trigger! (method)">#normalize_trigger!</a></span>, <span class='object_link'><a href="../String.html#pluralize-instance_method" title="String#pluralize (method)">#pluralize</a></span>, <span class='object_link'><a href="../String.html#remove_self_links-instance_method" title="String#remove_self_links (method)">#remove_self_links</a></span>, <span class='object_link'><a href="../String.html#replace_qualified_urls-instance_method" title="String#replace_qualified_urls (method)">#replace_qualified_urls</a></span>, <span class='object_link'><a href="../String.html#set_type-instance_method" title="String#set_type (method)">#set_type</a></span>, <span class='object_link'><a href="../String.html#simple_wrap-instance_method" title="String#simple_wrap (method)">#simple_wrap</a></span>, <span class='object_link'><a href="../String.html#tag-instance_method" title="String#tag (method)">#tag</a></span>, <span class='object_link'><a href="../String.html#tag!-instance_method" title="String#tag! (method)">#tag!</a></span>, <span class='object_link'><a href="../String.html#to_rx-instance_method" title="String#to_rx (method)">#to_rx</a></span>, <span class='object_link'><a href="../String.html#to_tags-instance_method" title="String#to_tags (method)">#to_tags</a></span>, <span class='object_link'><a href="../String.html#truncate-instance_method" title="String#truncate (method)">#truncate</a></span>, <span class='object_link'><a href="../String.html#truncate!-instance_method" title="String#truncate! (method)">#truncate!</a></span>, <span class='object_link'><a href="../String.html#truncmiddle-instance_method" title="String#truncmiddle (method)">#truncmiddle</a></span>, <span class='object_link'><a href="../String.html#truncmiddle!-instance_method" title="String#truncmiddle! (method)">#truncmiddle!</a></span>, <span class='object_link'><a href="../String.html#truthy%3F-instance_method" title="String#truthy? (method)">#truthy?</a></span>, <span class='object_link'><a href="../String.html#uncolor-instance_method" title="String#uncolor (method)">#uncolor</a></span>, <span class='object_link'><a href="../String.html#uncolor!-instance_method" title="String#uncolor! (method)">#uncolor!</a></span>, <span class='object_link'><a href="../String.html#validate_color-instance_method" title="String#validate_color (method)">#validate_color</a></span>, <span class='object_link'><a href="../String.html#wildcard_to_rx-instance_method" title="String#wildcard_to_rx (method)">#wildcard_to_rx</a></span>, <span class='object_link'><a href="../String.html#wrap-instance_method" title="String#wrap (method)">#wrap</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(string, placeholders: {}, force_color: false, wrap_width: 0, color: '', tags_color: '', reset: '') ⇒ <tt><span class='object_link'><a href="" title="Doing::TemplateString (class)">TemplateString</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of TemplateString.</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="original-instance_method">
#<strong>original</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute original.</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="apply_colors-instance_method">
#<strong>apply_colors</strong>(color_array) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Apply a color array to a string</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>color_array</span>
<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 hashes
containing :name, :color,
:index</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="colored-instance_method">
#<strong>colored</strong> ⇒ <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 with %colors replaced with escape codes</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="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>colorized string</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="colors?-instance_method">
#<strong>colors?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if string contains any valid %colors</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>True if colors, False otherwise.</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="fill-instance_method">
#<strong>fill</strong>(placeholder, value, wrap_width: 0, color: '', tags_color: '', reset: '') ⇒ <tt>Object</tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="parse_colors-instance_method">
#<strong>parse_colors</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>Parse a template string for %colors and return a hash
of colors and string locations</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>Uncolored string and array of colors and locations</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="parsed_colors-instance_method">
#<strong>parsed_colors</strong> ⇒ <tt>Object</tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="raw-instance_method">
#<strong>raw</strong> ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Remove all valid %colors from string</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="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>cleaned string</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="reparse-instance_method">
#<strong>reparse</strong> ⇒ <tt>Object</tt>
</h3>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Dec 20 16:24:44 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.1).
</div>
</div>
</body>
</html>