doing 2.0.22 → 2.1.0pre

data/doc/Doing/Items.html

@@ -96,14 +96,55 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/doing/wwidfile.rb</dd>
+    <dd>lib/doing/items.rb</dd>
   </dl>
   
 </div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Items Array</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="#sections-instance_method" title="#sections (instance method)">#<strong>sections</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute sections.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
 
 
 
@@ -119,13 +160,84 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#add_section-instance_method" title="#add_section (instance method)">#<strong>add_section</strong>(title)  &#x21d2; Object </a>
+      <a href="#add_section-instance_method" title="#add_section (instance method)">#<strong>add_section</strong>(section, log: false)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Add a new section to the sections array.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#delete_item-instance_method" title="#delete_item (instance method)">#<strong>delete_item</strong>(item, single: false)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Delete an item from the index.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#in_section-instance_method" title="#in_section (instance method)">#<strong>in_section</strong>(section)  &#x21d2; Items </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Get a new Items object containing only items in a specified section.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>  &#x21d2; Items </a>
     
 
     
   </span>
   
   
+    <span class="note title constructor">constructor</span>
+  
   
   
   
@@ -133,7 +245,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Adds a section.</p>
+    <span class="summary_desc"><div class='inline'><p>A new instance of Items.</p>
 </div></span>
   
 </li>
@@ -142,7 +254,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#from-instance_method" title="#from (instance method)">#<strong>from</strong>(path)  &#x21d2; Object </a>
+      <a href="#section%3F-instance_method" title="#section? (instance method)">#<strong>section?</strong>(section)  &#x21d2; Boolean </a>
     
 
     
@@ -156,7 +268,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>Test if section already exists.</p>
+</div></span>
   
 </li>
 
@@ -164,7 +277,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#guess_section-instance_method" title="#guess_section (instance method)">#<strong>guess_section</strong>(frag, guessed: false, suggest: false)  &#x21d2; Object </a>
+      <a href="#section_titles-instance_method" title="#section_titles (instance method)">#<strong>section_titles</strong>  &#x21d2; Array </a>
     
 
     
@@ -178,7 +291,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Attempt to match a string with an existing section.</p>
+    <span class="summary_desc"><div class='inline'><p>List sections, title only.</p>
 </div></span>
   
 </li>
@@ -187,7 +300,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#section_items-instance_method" title="#section_items (instance method)">#<strong>section_items</strong>(section)  &#x21d2; Object </a>
+      <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong>  &#x21d2; Object </a>
     
 
     
@@ -201,7 +314,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>Output sections and items in Doing file format.</p>
+</div></span>
   
 </li>
 
@@ -209,7 +323,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#section_titles-instance_method" title="#section_titles (instance method)">#<strong>section_titles</strong>  &#x21d2; Object </a>
+      <a href="#update_item-instance_method" title="#update_item (instance method)">#<strong>update_item</strong>(old_item, new_item)  &#x21d2; Object </a>
     
 
     
@@ -223,7 +337,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>Update an item in the index with a modified item.</p>
+</div></span>
   
 </li>
 
@@ -238,6 +353,66 @@
   
   
   
+  
+  
+  <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#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>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>  &#x21d2; <tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a new instance of Items.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id="sections=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="sections-instance_method">
+  
+    #<strong>sections</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the value of attribute sections.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+</div>
+    
+  </div>
+
 
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
@@ -246,7 +421,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="add_section-instance_method">
   
-    #<strong>add_section</strong>(title)  &#x21d2; <tt>Object</tt> 
+    #<strong>add_section</strong>(section, log: false)  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -254,7 +429,9 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Adds a section.</p>
+    <p>Add a new section to the sections array. Accepts
+either a Section object, or a title string that will
+be converted into a Section.</p>
 
 
   </div>
@@ -265,41 +442,108 @@
   
     <li>
       
-        <span class='name'>title</span>
+        <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>
+        <span class='type'>(<tt><span class='object_link'><a href="Section.html" title="Doing::Section (class)">Section</a></span></tt>)</span>
       
       
       
         &mdash;
-        <div class='inline'><p>The new section title</p>
+        <div class='inline'><p>The section to add. A
+String value will be converted to
+Section automatically.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>log</span>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>false</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'><p>Add a log message
+notifying the user about the
+creation of the section.</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="from-instance_method">
+  <h3 class="signature " id="delete_item-instance_method">
+  
+    #<strong>delete_item</strong>(item, single: false)  &#x21d2; <tt>Object</tt> 
   
-    #<strong>from</strong>(path)  &#x21d2; <tt>Object</tt> 
+
   
 
   
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Delete an item from the index</p>
 
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
-</h3>
+    <li>
+      
+        <span class='name'>item</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The item</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div>
 </div>
     
       <div class="method_details ">
-  <h3 class="signature " id="guess_section-instance_method">
+  <h3 class="signature " id="in_section-instance_method">
   
-    #<strong>guess_section</strong>(frag, guessed: false, suggest: false)  &#x21d2; <tt>Object</tt> 
+    #<strong>in_section</strong>(section)  &#x21d2; <tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt> 
   
 
   
@@ -307,7 +551,8 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Attempt to match a string with an existing section</p>
+    <p>Get a new Items object containing only items in a
+specified section</p>
 
 
   </div>
@@ -318,7 +563,7 @@
   
     <li>
       
-        <span class='name'>frag</span>
+        <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>
@@ -326,56 +571,220 @@
       
       
         &mdash;
-        <div class='inline'><p>The user-provided string</p>
+        <div class='inline'><p>section title</p>
 </div>
       
     </li>
   
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
     <li>
       
-        <span class='name'>guessed</span>
       
+        <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt>)</span>
       
-        <span class='type'>(<tt>Boolean</tt>)</span>
       
       
-        <em class="default">(defaults to: <tt>false</tt>)</em>
+        &mdash;
+        <div class='inline'><p>Array of items</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="section?-instance_method">
+  
+    #<strong>section?</strong>(section)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Test if section already exists</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <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>
+      
       
       
         &mdash;
-        <div class='inline'><p>already guessed and failed</p>
+        <div class='inline'><p>section title</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>true if section exists</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="section_titles-instance_method">
+  
+    #<strong>section_titles</strong>  &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>List sections, title only</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>section titles</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div>
 </div>
     
       <div class="method_details ">
-  <h3 class="signature " id="section_items-instance_method">
+  <h3 class="signature " id="to_s-instance_method">
   
-    #<strong>section_items</strong>(section)  &#x21d2; <tt>Object</tt> 
+    #<strong>to_s</strong>  &#x21d2; <tt>Object</tt> 
   
 
   
 
   
-</h3>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Output sections and items in Doing file format</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
 </div>
     
       <div class="method_details ">
-  <h3 class="signature " id="section_titles-instance_method">
+  <h3 class="signature " id="update_item-instance_method">
   
-    #<strong>section_titles</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>update_item</strong>(old_item, new_item)  &#x21d2; <tt>Object</tt> 
   
 
   
 
   
-</h3>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Update an item in the index with a modified item</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>old_item</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The old item</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>new_item</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The new item</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>ItemNotFound</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div>
 </div>
     
   </div>
@@ -383,7 +792,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 18 16:39:12 2021 by
+  Generated on Sat Nov 27 10:06:03 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-3.0.1).
 </div>