<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Array
— Documentation by YARD 0.9.27
</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 = "Array";
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 (A)</a> »
<span class="title">Array</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: Array
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></span>
<ul class="fullTree">
<li><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></li>
<li class="next">Array</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/array.rb<span class="defines">,<br />
lib/doing/good.rb,<br /> lib/doing/array_chronify.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Chronify array helpers</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Doing/Items.html" title="Doing::Items (class)">Doing::Items</a></span>, <span class='object_link'><a href="Doing/Note.html" title="Doing::Note (class)">Doing::Note</a></span></p>
</div>
<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="#good%3F-instance_method" title="#good? (instance method)">#<strong>good?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Tests if object is nil or empty.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#highlight_tags-instance_method" title="#highlight_tags (instance method)">#<strong>highlight_tags</strong>(color = 'cyan') ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Hightlight @tags in string for console output.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_tags-instance_method" title="#log_tags (instance method)">#<strong>log_tags</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Tag array for logging.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#nested_hash-instance_method" title="#nested_hash (instance method)">#<strong>nested_hash</strong>(value) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert array to nested hash, setting last key to value.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tags_to_array-instance_method" title="#tags_to_array (instance method)">#<strong>tags_to_array</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert an @tags to plain strings.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#time_string-instance_method" title="#time_string (instance method)">#<strong>time_string</strong>(format: :dhm) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Format [d, h, m] as string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_tags-instance_method" title="#to_tags (instance method)">#<strong>to_tags</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert strings to @tags.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_tags!-instance_method" title="#to_tags! (instance method)">#<strong>to_tags!</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="good?-instance_method">
#<strong>good?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Tests if object is nil or empty</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 object is defined and
has content</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="highlight_tags-instance_method">
#<strong>highlight_tags</strong>(color = 'cyan') ⇒ <tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Hightlight @tags in string for console output</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>color</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>'cyan'</tt>)</em>
—
<div class='inline'><p>the color to highlight
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>string with @tags highlighted</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="log_tags-instance_method">
#<strong>log_tags</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>Tag array for logging</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>Highlighted tag array joined with comma</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="nested_hash-instance_method">
#<strong>nested_hash</strong>(value) ⇒ <tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert array to nested hash, setting last key to value</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'></span>
—
<div class='inline'><p>The value to set</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>StandardError</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tags_to_array-instance_method">
#<strong>tags_to_array</strong> ⇒ <tt><span class='object_link'><a href="" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert an @tags to plain strings</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="" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>array of strings</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="time_string-instance_method">
#<strong>time_string</strong>(format: :dhm) ⇒ <tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Format [d, h, m] as string</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>format</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>:dhm</tt>)</em>
—
<div class='inline'><p>The format, :dhm, :hm,
:m, :clock, :natural</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>formatted string</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>InvalidArgument</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_tags-instance_method">
#<strong>to_tags</strong> ⇒ <tt><span class='object_link'><a href="" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert strings to @tags</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>one</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>@two</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>three</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_tags'>to_tags</span>
<span class='comment'># => ['@one', '@two', '@three']</span></code></pre>
</div>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>Array of @tags</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_tags!-instance_method">
#<strong>to_tags!</strong> ⇒ <tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Jan 23 16:30:43 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-3.0.1).
</div>
</div>
</body>
</html>