doing 2.1.40 → 2.1.41

data/docs/doc/Doing/Items.html

@@ -96,7 +96,9 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/doing/items.rb</dd>
+    <dd>lib/doing/items/items.rb<span class="defines">,<br />
+  lib/doing/items/util.rb,<br /> lib/doing/items/filter.rb,<br /> lib/doing/items/modify.rb,<br /> lib/doing/items/sections.rb</span>
+</dd>
   </dl>
   
 </div>
@@ -183,7 +185,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#all_tags-instance_method" title="#all_tags (instance method)">#<strong>all_tags</strong>  &#x21d2; Object </a>
+      <a href="#all_tags-instance_method" title="#all_tags (instance method)">#<strong>all_tags</strong>  &#x21d2; Array </a>
     
 
     
@@ -197,7 +199,31 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>Get all tags on Items in self.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#between_dates-instance_method" title="#between_dates (instance method)">#<strong>between_dates</strong>(start, finish)  &#x21d2; Items </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Filter Items by date.</p>
+</div></span>
   
 </li>
 
@@ -244,6 +270,29 @@
   
     <span class="summary_desc"><div class='inline'></div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(item)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><h1 id="create-a-deep-copy-of-items-def-clone-marshal-load-marshal-dump-self-end">Create a deep copy of Items def clone   Marshal.load(Marshal.dump(self)) end.</h1>
+</div></span>
+  
 </li>
 
       
@@ -378,7 +427,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>Test if self includes Item.</p>
+</div></span>
   
 </li>
 
@@ -405,6 +455,29 @@
     <span class="summary_desc"><div class='inline'><p>A new instance of Items.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(query, case_type: :smart)  &#x21d2; Items </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Search Items for a string (title and note).</p>
+</div></span>
+  
 </li>
 
       
@@ -451,6 +524,29 @@
     <span class="summary_desc"><div class='inline'><p>List sections, title only.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#tagged-instance_method" title="#tagged (instance method)">#<strong>tagged</strong>(tags, bool: :and)  &#x21d2; Items </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Search items by tags.</p>
+</div></span>
+  
 </li>
 
       
@@ -513,8 +609,21 @@
   
   
   <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#good%3F-instance_method" title="Array#good? (method)">#good?</a></span></p>
-<div id="constructor_details" class="method_details_list">
+  <p class="inherited"><span class='object_link'><a href="../Array.html#good%3F-instance_method" title="Array#good? (method)">#good?</a></span>, <span class='object_link'><a href="../Array.html#utf8-instance_method" title="Array#utf8 (method)">#utf8</a></span></p>
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="ChronifyArray.html" title="Doing::ChronifyArray (module)">ChronifyArray</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="ChronifyArray.html#time_string-instance_method" title="Doing::ChronifyArray#time_string (method)">#time_string</a></span>, <span class='object_link'><a href="ChronifyArray.html#to_abbr-instance_method" title="Doing::ChronifyArray#to_abbr (method)">#to_abbr</a></span>, <span class='object_link'><a href="ChronifyArray.html#to_natural-instance_method" title="Doing::ChronifyArray#to_natural (method)">#to_natural</a></span>, <span class='object_link'><a href="ChronifyArray.html#to_years-instance_method" title="Doing::ChronifyArray#to_years (method)">#to_years</a></span></p>
+
+  
+  <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
   
     <div class="method_details first">
@@ -659,13 +768,117 @@ creation of the section.</p>
       <div class="method_details ">
   <h3 class="signature " id="all_tags-instance_method">
   
-    #<strong>all_tags</strong>  &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> 
+    #<strong>all_tags</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>Get all tags on Items in self</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 ">
+  <h3 class="signature " id="between_dates-instance_method">
+  
+    #<strong>between_dates</strong>(start, finish)  &#x21d2; <tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Filter Items by date. String arguments will be
+chronified</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>start</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>, <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Filter items after
+this date</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>finish</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>, <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Filter items before
+this date</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>array of items with dates between
+targets</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
 </div>
     
       <div class="method_details ">
@@ -716,7 +929,49 @@ creation of the section.</p>
   
 
   
-</h3>
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="#dedup-instance_method" title="Doing::Items#dedup (method)">#dedup</a></span></li>
+    
+  </ul>
+
+</div>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="delete-instance_method">
+  
+    #<strong>delete</strong>(item)  &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <h1 id="create-a-deep-copy-of-items">Create a deep copy of Items</h1>
+
+<p>def clone
+  Marshal.load(Marshal.dump(self))
+end</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
 </div>
     
       <div class="method_details ">
@@ -998,12 +1253,49 @@ specified section</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    
+    <p>Test if self includes Item</p>
+
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>item</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The item to search for</p>
+</div>
+      
+    </li>
   
+    <li>
+      
+        <span class='name'>match_section</span>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>true</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'><p>Section must match</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 <p class="tag_title">Returns:</p>
 <ul class="return">
   
@@ -1014,6 +1306,86 @@ specified section</p>
       
       
       
+        &mdash;
+        <div class='inline'><p>True if Item exists</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="search-instance_method">
+  
+    #<strong>search</strong>(query, case_type: :smart)  &#x21d2; <tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Search Items for a string (title and note)</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>query</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 query</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>:smart</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'><p>The case type
+(:smart, :sensitive, :ignore)</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>array of items matching search</p>
+</div>
+      
     </li>
   
 </ul>
@@ -1115,6 +1487,83 @@ specified section</p>
   
 </ul>
 
+</div>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="tagged-instance_method">
+  
+    #<strong>tagged</strong>(tags, bool: :and)  &#x21d2; <tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Search items by tags</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>, <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The tags by which to
+filter</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>
+      
+      
+        &mdash;
+        <div class='inline'><p>The bool with which to
+combine multiple tags</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>array of items matching tag filter</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 </div>
 </div>
     
@@ -1214,7 +1663,7 @@ specified section</p>
 </div>
 
       <div id="footer">
-  Generated on Tue Mar 15 11:14:29 2022 by
+  Generated on Wed Mar 16 09:42:15 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>