<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::ItemDates
— 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::ItemDates";
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">ItemDates</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::ItemDates
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/item/dates.rb</dd>
</dl>
</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="#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="#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="#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="#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>
</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="calculate_end_date-instance_method">
#<strong>calculate_end_date</strong>(opt) ⇒ <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="duration-instance_method">
#<strong>duration</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>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="expand_date_tags-instance_method">
#<strong>expand_date_tags</strong>(additional_tags = 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>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="interval-instance_method">
#<strong>interval</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>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="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="Item.html" 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="Item.html" 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>
</div>
<div id="footer">
Generated on Sun Jan 1 07:08:47 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>