<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Doing::Item
— 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::Item";
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 (I)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">Item</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::Item
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Doing::Item</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/item.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class describes a single WWID item</p>
</div>
</div>
<div class="tags">
</div>
<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="#date-instance_method" title="#date (instance method)">#<strong>date</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute date.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#note-instance_method" title="#note (instance method)">#<strong>note</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute note.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#section-instance_method" title="#section (instance method)">#<strong>section</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute section.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute title.</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="#calculate_end_date-instance_method" title="#calculate_end_date (instance method)">#<strong>calculate_end_date</strong>(opt) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#duration-instance_method" title="#duration (instance method)">#<strong>duration</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>If the entry doesn't have a @done date, return the elapsed time.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#end_date-instance_method" title="#end_date (instance method)">#<strong>end_date</strong> ⇒ Time </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get the value of the item's @done tag.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#equal%3F-instance_method" title="#equal? (instance method)">#<strong>equal?</strong>(other) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test for equality between items.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expand_date_tags-instance_method" title="#expand_date_tags (instance method)">#<strong>expand_date_tags</strong>(additional_tags = nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Updates the title of the Item by expanding natural language dates within configured date tags (tags whose value is expected to be a date).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Generate a hash that represents the entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ignore_case-instance_method" title="#ignore_case (instance method)">#<strong>ignore_case</strong>(search, case_type) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Determine if case should be ignored for searches.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(date, title, section, note = nil) ⇒ Item </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initialize an item with date, title, section, and optional note.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#interval-instance_method" title="#interval (instance method)">#<strong>interval</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get the difference between the item's start date and the value of its @done tag (if present).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#move_to-instance_method" title="#move_to (instance method)">#<strong>move_to</strong>(new_section, label: true, log: true) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Move item from current section to destination section.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#overlapping_time%3F-instance_method" title="#overlapping_time? (instance method)">#<strong>overlapping_time?</strong>(item_b) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if the interval between start date and @done value overlaps with another item's.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#same_time%3F-instance_method" title="#same_time? (instance method)">#<strong>same_time?</strong>(item_b) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if two items occur at the same time (same start date and equal duration).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(search, distance: nil, negate: false, case_type: nil) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if item matches search string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#should_finish%3F-instance_method" title="#should_finish? (instance method)">#<strong>should_finish?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if item is included in never_finish config and thus should not receive a @done tag.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#should_time%3F-instance_method" title="#should_time? (instance method)">#<strong>should_time?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if item is included in never_time config and thus should not receive a date on the @done tag.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tag-instance_method" title="#tag (instance method)">#<strong>tag</strong>(tags, **options) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Add (or remove) tags from the title of the item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tag_array-instance_method" title="#tag_array (instance method)">#<strong>tag_array</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>convert tags on item to an array with @ symbols removed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tag_values%3F-instance_method" title="#tag_values? (instance method)">#<strong>tag_values?</strong>(queries, bool = :and, negate: false) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if item matches tag values.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tags-instance_method" title="#tags (instance method)">#<strong>tags</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get a list of tags on the item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tags%3F-instance_method" title="#tags? (instance method)">#<strong>tags?</strong>(tags, bool = :and, negate: false) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if item contains tag(s).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>outputs item in Doing file format, including leading tab.</p>
</div></span>
</li>
</ul>
<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>(date, title, section, note = nil) ⇒ <tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initialize an item with date, title, section, and
optional note</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>date</span>
<span class='type'>(<tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>)</span>
—
<div class='inline'><p>The item's start date</p>
</div>
</li>
<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'>section</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 section to which
the item belongs</p>
</div>
</li>
<li>
<span class='name'>note</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span> or <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>The note
(optional)</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="date=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="date-instance_method">
#<strong>date</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute date.</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id="note=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="note-instance_method">
#<strong>note</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute note.</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id="section=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="section-instance_method">
#<strong>section</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute section.</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id="title=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="title-instance_method">
#<strong>title</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute title.</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="calculate_end_date-instance_method">
#<strong>calculate_end_date</strong>(opt) ⇒ <tt>Object</tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="duration-instance_method">
#<strong>duration</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>If the entry doesn't have a @done date, return the elapsed time</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="end_date-instance_method">
#<strong>end_date</strong> ⇒ <tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the value of the item's @done tag</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="../Time.html" title="Time (class)">Time</a></span></tt>)</span>
—
<div class='inline'><p>@done value</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="equal?-instance_method">
#<strong>equal?</strong>(other) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test for equality between items</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>other</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
—
<div class='inline'><p>The other item</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>is equal?</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="expand_date_tags-instance_method">
#<strong>expand_date_tags</strong>(additional_tags = nil) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Updates the title of the Item by expanding natural
language dates within configured date tags (tags
whose value is expected to be a date)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>additional_tags</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>An array of additional
tag names to consider
dates</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="id-instance_method">
#<strong>id</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>Generate a hash that represents the entry</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>entry hash</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="ignore_case-instance_method">
#<strong>ignore_case</strong>(search, case_type) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Determine if case should be ignored for searches</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>search</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 search string</p>
</div>
</li>
<li>
<span class='name'>case_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 case type</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>case should be ignored</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="interval-instance_method">
#<strong>interval</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the difference between the item's start date and
the value of its @done tag (if present)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Interval in seconds</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="move_to-instance_method">
#<strong>move_to</strong>(new_section, label: true, log: true) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Move item from current section to destination section</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>new_section</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 destination
section</p>
</div>
</li>
<li>
<span class='name'>label</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>add @from(original
section) tag</p>
</div>
</li>
<li>
<span class='name'>log</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>log this action</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>nothing</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="overlapping_time?-instance_method">
#<strong>overlapping_time?</strong>(item_b) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if the interval between start date and @done
value overlaps with another item's</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item_b</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
—
<div class='inline'><p>The item to compare</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>overlaps?</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="same_time?-instance_method">
#<strong>same_time?</strong>(item_b) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if two items occur at the same time (same start date and equal duration)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item_b</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
—
<div class='inline'><p>The item to compare</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>is equal?</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="search-instance_method">
#<strong>search</strong>(search, distance: nil, negate: false, case_type: nil) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if item matches search string</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>search</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 search string</p>
</div>
</li>
<li>
<span class='name'>negate</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>negate results</p>
</div>
</li>
<li>
<span class='name'>case_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>nil</tt>)</em>
—
<div class='inline'><p>The case-sensitivity
type (:sensitive,
:ignore, :smart)</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>matches search criteria</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="should_finish?-instance_method">
#<strong>should_finish?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if item is included in never_finish config and
thus should not receive a @done tag</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>item should receive @done tag</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="should_time?-instance_method">
#<strong>should_time?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if item is included in never_time config and
thus should not receive a date on the @done tag</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>item should receive @done date</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tag-instance_method">
#<strong>tag</strong>(tags, **options) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Add (or remove) tags from the title of the item</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>tags</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>The tags to apply</p>
</div>
</li>
<li>
<span class='name'>options</span>
<span class='type'></span>
—
<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">:date</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>Include timestamp?</p>
</div>
</li>
<li>
<span class="name">:single</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>Log as a single change?</p>
</div>
</li>
<li>
<span class="name">:value</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>A value to include as @tag(value)</p>
</div>
</li>
<li>
<span class="name">:remove</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>if true remove instead of adding</p>
</div>
</li>
<li>
<span class="name">:rename_to</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>if not nil, rename target tag to this tag name</p>
</div>
</li>
<li>
<span class="name">:regex</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>treat target tag string as regex pattern</p>
</div>
</li>
<li>
<span class="name">:force</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>with rename_to, add tag if it doesn't exist</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tag_array-instance_method">
#<strong>tag_array</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>convert tags on item to an array with @ symbols removed</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="../Array.html" 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="tag_values?-instance_method">
#<strong>tag_values?</strong>(queries, bool = :and, negate: false) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if item matches tag values</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>queries</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>The tag value queries to test</p>
</div>
</li>
<li>
<span class='name'>bool</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>:and</tt>)</em>
—
<div class='inline'><p>The boolean to use for multiple tags (:and, :or, :not)</p>
</div>
</li>
<li>
<span class='name'>negate</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>negate the result?</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>true if tag/bool combination passes</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tags-instance_method">
#<strong>tags</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get a list of tags on the item</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="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>array of tags (no values)</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tags?-instance_method">
#<strong>tags?</strong>(tags, bool = :and, negate: false) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if item contains tag(s)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>tags</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span> or <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The tags to test. Can be an array or a comma-separated string.</p>
</div>
</li>
<li>
<span class='name'>bool</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>:and</tt>)</em>
—
<div class='inline'><p>The boolean to use for multiple tags (:and, :or, :not)</p>
</div>
</li>
<li>
<span class='name'>negate</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>negate the result?</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>true if tag/bool combination passes</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
#<strong>to_s</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>outputs item in Doing file format, including leading tab</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 17 08:01:48 2022 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>