doing 2.1.13 → 2.1.17

data/docs/doc/Doing/Item.html

@@ -87,6 +87,11 @@
   
   
   
+  <dl>
+      <dt>Includes:</dt>
+      <dd><span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></dd>
+  </dl>
+  
   
 
   
@@ -112,6 +117,12 @@
 </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">
@@ -236,6 +247,28 @@
         <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)  &#x21d2; 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>  &#x21d2; Object </a>
     
 
@@ -299,6 +332,51 @@
     <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)  &#x21d2; 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="#highlight_search-instance_method" title="#highlight_search (instance method)">#<strong>highlight_search</strong>(search, distance: nil, negate: false, case_type: nil)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
 </li>
 
       
@@ -328,7 +406,7 @@
         <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)  &#x21d2; Object </a>
+      <a href="#ignore_case-instance_method" title="#ignore_case (instance method)">#<strong>ignore_case</strong>(search, case_type)  &#x21d2; Boolean </a>
     
 
     
@@ -342,7 +420,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>Determine if case should be ignored for searches.</p>
+</div></span>
   
 </li>
 
@@ -504,7 +583,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></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>
 
@@ -526,7 +606,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></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>
 
@@ -557,7 +638,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#tag_array-instance_method" title="#tag_array (instance method)">#<strong>tag_array</strong>  &#x21d2; Object </a>
+      <a href="#tag_array-instance_method" title="#tag_array (instance method)">#<strong>tag_array</strong>  &#x21d2; Array </a>
     
 
     
@@ -571,7 +652,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>convert tags on item to an array with @ symbols removed.</p>
+</div></span>
   
 </li>
 
@@ -642,6 +724,29 @@
     <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_pretty-instance_method" title="#to_pretty (instance method)">#<strong>to_pretty</strong>(elements: %i[date title section])  &#x21d2; 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>
 
       
@@ -671,6 +776,17 @@
     </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>
 <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
   
@@ -874,7 +990,19 @@ the item belongs</p>
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="duration-instance_method">
+  <h3 class="signature first" id="calculate_end_date-instance_method">
+  
+    #<strong>calculate_end_date</strong>(opt)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="duration-instance_method">
   
     #<strong>duration</strong>  &#x21d2; <tt>Object</tt> 
   
@@ -990,6 +1118,65 @@ the item belongs</p>
 </ul>
 
 </div>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="expand_date_tags-instance_method">
+  
+    #<strong>expand_date_tags</strong>(additional_tags = nil)  &#x21d2; <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>
+      
+      
+        &mdash;
+        <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="highlight_search-instance_method">
+  
+    #<strong>highlight_search</strong>(search, distance: nil, negate: false, case_type: nil)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3>
 </div>
     
       <div class="method_details ">
@@ -1034,13 +1221,74 @@ the item belongs</p>
       <div class="method_details ">
   <h3 class="signature " id="ignore_case-instance_method">
   
-    #<strong>ignore_case</strong>(search, case_type)  &#x21d2; <tt>Object</tt> 
+    #<strong>ignore_case</strong>(search, case_type)  &#x21d2; <tt>Boolean</tt> 
   
 
   
 
   
-</h3>
+</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>
+      
+      
+      
+        &mdash;
+        <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>
+      
+      
+      
+        &mdash;
+        <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>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>case should be ignored</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
 </div>
     
       <div class="method_details ">
@@ -1399,7 +1647,9 @@ type (:sensitive,
   
 </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>
@@ -1415,6 +1665,10 @@ type (:sensitive,
       
       
       
+        &mdash;
+        <div class='inline'><p>item should receive @done tag</p>
+</div>
+      
     </li>
   
 </ul>
@@ -1433,7 +1687,9 @@ type (:sensitive,
   
 </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>
@@ -1449,6 +1705,10 @@ type (:sensitive,
       
       
       
+        &mdash;
+        <div class='inline'><p>item should receive @done date</p>
+</div>
+      
     </li>
   
 </ul>
@@ -1610,13 +1870,40 @@ type (:sensitive,
       <div class="method_details ">
   <h3 class="signature " id="tag_array-instance_method">
   
-    #<strong>tag_array</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>tag_array</strong>  &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt> 
   
 
   
 
   
-</h3>
+</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>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>array of tags</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
 </div>
     
       <div class="method_details ">
@@ -1839,6 +2126,45 @@ type (:sensitive,
   
 </ul>
 
+</div>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="to_pretty-instance_method">
+  
+    #<strong>to_pretty</strong>(elements: %i[date title section])  &#x21d2; <tt>Object</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>
     
@@ -1869,7 +2195,7 @@ type (:sensitive,
 </div>
 
       <div id="footer">
-  Generated on Fri Jan 14 21:59:14 2022 by
+  Generated on Tue Jan 18 07:38:21 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>

data/docs/doc/Doing/Items.html

@@ -401,7 +401,7 @@
   
   
   <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="../Array.html#highlight_tags-instance_method" title="Array#highlight_tags (method)">#highlight_tags</a></span>, <span class='object_link'><a href="../Array.html#log_tags-instance_method" title="Array#log_tags (method)">#log_tags</a></span>, <span class='object_link'><a href="../Array.html#nested_hash-instance_method" title="Array#nested_hash (method)">#nested_hash</a></span>, <span class='object_link'><a href="../Array.html#tags_to_array-instance_method" title="Array#tags_to_array (method)">#tags_to_array</a></span>, <span class='object_link'><a href="../Array.html#to_tags-instance_method" title="Array#to_tags (method)">#to_tags</a></span>, <span class='object_link'><a href="../Array.html#to_tags!-instance_method" title="Array#to_tags! (method)">#to_tags!</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="../Array.html#highlight_tags-instance_method" title="Array#highlight_tags (method)">#highlight_tags</a></span>, <span class='object_link'><a href="../Array.html#log_tags-instance_method" title="Array#log_tags (method)">#log_tags</a></span>, <span class='object_link'><a href="../Array.html#nested_hash-instance_method" title="Array#nested_hash (method)">#nested_hash</a></span>, <span class='object_link'><a href="../Array.html#tags_to_array-instance_method" title="Array#tags_to_array (method)">#tags_to_array</a></span>, <span class='object_link'><a href="../Array.html#time_string-instance_method" title="Array#time_string (method)">#time_string</a></span>, <span class='object_link'><a href="../Array.html#to_tags-instance_method" title="Array#to_tags (method)">#to_tags</a></span>, <span class='object_link'><a href="../Array.html#to_tags!-instance_method" title="Array#to_tags! (method)">#to_tags!</a></span></p>
 <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
   
@@ -890,7 +890,7 @@ specified section</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Jan 14 21:59:14 2022 by
+  Generated on Tue Jan 18 07:38:21 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>

data/docs/doc/Doing/LogAdapter.html

@@ -1797,7 +1797,7 @@ message (optional)</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Jan 14 21:59:14 2022 by
+  Generated on Tue Jan 18 07:38:21 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>

data/docs/doc/Doing/Note.html

@@ -323,7 +323,7 @@
   
   
   <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="../Array.html#highlight_tags-instance_method" title="Array#highlight_tags (method)">#highlight_tags</a></span>, <span class='object_link'><a href="../Array.html#log_tags-instance_method" title="Array#log_tags (method)">#log_tags</a></span>, <span class='object_link'><a href="../Array.html#nested_hash-instance_method" title="Array#nested_hash (method)">#nested_hash</a></span>, <span class='object_link'><a href="../Array.html#tags_to_array-instance_method" title="Array#tags_to_array (method)">#tags_to_array</a></span>, <span class='object_link'><a href="../Array.html#to_tags-instance_method" title="Array#to_tags (method)">#to_tags</a></span>, <span class='object_link'><a href="../Array.html#to_tags!-instance_method" title="Array#to_tags! (method)">#to_tags!</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="../Array.html#highlight_tags-instance_method" title="Array#highlight_tags (method)">#highlight_tags</a></span>, <span class='object_link'><a href="../Array.html#log_tags-instance_method" title="Array#log_tags (method)">#log_tags</a></span>, <span class='object_link'><a href="../Array.html#nested_hash-instance_method" title="Array#nested_hash (method)">#nested_hash</a></span>, <span class='object_link'><a href="../Array.html#tags_to_array-instance_method" title="Array#tags_to_array (method)">#tags_to_array</a></span>, <span class='object_link'><a href="../Array.html#time_string-instance_method" title="Array#time_string (method)">#time_string</a></span>, <span class='object_link'><a href="../Array.html#to_tags-instance_method" title="Array#to_tags (method)">#to_tags</a></span>, <span class='object_link'><a href="../Array.html#to_tags!-instance_method" title="Array#to_tags! (method)">#to_tags!</a></span></p>
 <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
   
@@ -627,7 +627,7 @@ content</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Jan 14 21:59:14 2022 by
+  Generated on Tue Jan 18 07:38:21 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>

data/docs/doc/Doing/Pager.html

@@ -296,7 +296,7 @@ STDOUT</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Jan 14 21:59:13 2022 by
+  Generated on Tue Jan 18 07:38:21 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>

data/docs/doc/Doing/Plugins.html

@@ -1235,7 +1235,7 @@ e.g. :imp =&gt; :import</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Jan 14 21:59:14 2022 by
+  Generated on Tue Jan 18 07:38:21 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>