<!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.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::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"><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">Doing::Item</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>, <span class='object_link'><a href="ItemDates.html" title="Doing::ItemDates (module)">ItemDates</a></span>, <span class='object_link'><a href="ItemQuery.html" title="Doing::ItemQuery (module)">ItemQuery</a></span>, <span class='object_link'><a href="ItemState.html" title="Doing::ItemState (module)">ItemState</a></span>, <span class='object_link'><a href="ItemTags.html" title="Doing::ItemTags (module)">ItemTags</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/item/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>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>, <span class='object_link'><a href="Color.html#ESCAPE_REGEX-constant" title="Doing::Color::ESCAPE_REGEX (constant)">Color::ESCAPE_REGEX</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="#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="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute id.</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="#clone-instance_method" title="#clone (instance method)">#<strong>clone</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#equal%3F-instance_method" title="#equal? (instance method)">#<strong>equal?</strong>(other, match_section: false) ⇒ 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="#gen_id-instance_method" title="#gen_id (instance method)">#<strong>gen_id</strong> ⇒ 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>(date, title, section, note = nil, id = 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="#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="#to_pretty-instance_method" title="#to_pretty (instance method)">#<strong>to_pretty</strong>(elements: %i[date title section]) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>outputs a colored string with relative date and highlighted tags.</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>
<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-instance_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#rgb-instance_method" title="Doing::Color#rgb (method)">#rgb</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#template-class_method" title="Doing::Color.template (method)">template</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 included from <span class='object_link'><a href="ItemTags.html" title="Doing::ItemTags (module)">ItemTags</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ItemTags.html#tag-instance_method" title="Doing::ItemTags#tag (method)">#tag</a></span>, <span class='object_link'><a href="ItemTags.html#tag_array-instance_method" title="Doing::ItemTags#tag_array (method)">#tag_array</a></span>, <span class='object_link'><a href="ItemTags.html#tags-instance_method" title="Doing::ItemTags#tags (method)">#tags</a></span>, <span class='object_link'><a href="ItemTags.html#tags_with_values-instance_method" title="Doing::ItemTags#tags_with_values (method)">#tags_with_values</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ItemState.html" title="Doing::ItemState (module)">ItemState</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ItemState.html#finished%3F-instance_method" title="Doing::ItemState#finished? (method)">#finished?</a></span>, <span class='object_link'><a href="ItemState.html#should_finish%3F-instance_method" title="Doing::ItemState#should_finish? (method)">#should_finish?</a></span>, <span class='object_link'><a href="ItemState.html#should_time%3F-instance_method" title="Doing::ItemState#should_time? (method)">#should_time?</a></span>, <span class='object_link'><a href="ItemState.html#unfinished%3F-instance_method" title="Doing::ItemState#unfinished? (method)">#unfinished?</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ItemQuery.html" title="Doing::ItemQuery (module)">ItemQuery</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ItemQuery.html#highlight_search-instance_method" title="Doing::ItemQuery#highlight_search (method)">#highlight_search</a></span>, <span class='object_link'><a href="ItemQuery.html#ignore_case-instance_method" title="Doing::ItemQuery#ignore_case (method)">#ignore_case</a></span>, <span class='object_link'><a href="ItemQuery.html#keep_item%3F-instance_method" title="Doing::ItemQuery#keep_item? (method)">#keep_item?</a></span>, <span class='object_link'><a href="ItemQuery.html#search-instance_method" title="Doing::ItemQuery#search (method)">#search</a></span>, <span class='object_link'><a href="ItemQuery.html#tag_values%3F-instance_method" title="Doing::ItemQuery#tag_values? (method)">#tag_values?</a></span>, <span class='object_link'><a href="ItemQuery.html#tags%3F-instance_method" title="Doing::ItemQuery#tags? (method)">#tags?</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ItemDates.html" title="Doing::ItemDates (module)">ItemDates</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ItemDates.html#calculate_end_date-instance_method" title="Doing::ItemDates#calculate_end_date (method)">#calculate_end_date</a></span>, <span class='object_link'><a href="ItemDates.html#duration-instance_method" title="Doing::ItemDates#duration (method)">#duration</a></span>, <span class='object_link'><a href="ItemDates.html#end_date-instance_method" title="Doing::ItemDates#end_date (method)">#end_date</a></span>, <span class='object_link'><a href="ItemDates.html#expand_date_tags-instance_method" title="Doing::ItemDates#expand_date_tags (method)">#expand_date_tags</a></span>, <span class='object_link'><a href="ItemDates.html#interval-instance_method" title="Doing::ItemDates#interval (method)">#interval</a></span>, <span class='object_link'><a href="ItemDates.html#overlapping_time%3F-instance_method" title="Doing::ItemDates#overlapping_time? (method)">#overlapping_time?</a></span>, <span class='object_link'><a href="ItemDates.html#same_time%3F-instance_method" title="Doing::ItemDates#same_time? (method)">#same_time?</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>(date, title, section, note = nil, id = 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>
<li>
<span class='name'>id</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>MD5 identifier</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><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></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="id=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="id-instance_method">
#<strong>id</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>Returns the value of attribute id.</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><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></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><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></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><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></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="clone-instance_method">
#<strong>clone</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="equal?-instance_method">
#<strong>equal?</strong>(other, match_section: false) ⇒ <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>
<li>
<span class='name'>match_section</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>If true, require item sections to match</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="gen_id-instance_method">
#<strong>gen_id</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="move_to-instance_method">
#<strong>move_to</strong>(new_section, label: true, log: true) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></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="to_pretty-instance_method">
#<strong>to_pretty</strong>(elements: %i[date title section]) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>outputs a colored string with relative date and highlighted tags</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Pretty representation of the object.</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
#<strong>to_s</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>outputs item in Doing file format, including leading tab</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Mar 10 15:19:58 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>