standup_md 0.3.0 → 0.3.5

data/doc/StandupMD/File.html

@@ -81,6 +81,8 @@
     
     <li ><a href="#method-c-find_by_date">::find_by_date</a>
     
+    <li ><a href="#method-c-load">::load</a>
+    
     <li ><a href="#method-c-new">::new</a>
     
     <li ><a href="#method-i-exist-3F">#exist?</a>
@@ -221,7 +223,7 @@
 
           
           <div class="method-source-code" id="find-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 26</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 36</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">file_name</span>)
   <span class="ruby-identifier">file</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">entries</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>).<span class="ruby-identifier">bsearch</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">file_name</span> }
   <span class="ruby-keyword">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
@@ -260,7 +262,7 @@
 
           
           <div class="method-source-code" id="find_by_date-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 38</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 48</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">find_by_date</span>(<span class="ruby-identifier">date</span>)
   <span class="ruby-keyword">unless</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Date</span>)
     <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Argument must be a Date object&quot;</span>
@@ -274,6 +276,43 @@
         
 
         
+      </div>
+
+    
+      <div id="method-c-load" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">load</span><span
+            class="method-args">(file_name)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Convenience method for calling <a href="File.html#method-c-find"><code>File.find(file_name)</code></a>.load</p>
+
+<p>@param [String] file_name</p>
+
+<p>@return [StandupMD::File]</p>
+          
+          
+
+          
+          <div class="method-source-code" id="load-source">
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 28</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load</span>(<span class="ruby-identifier">file_name</span>)
+  <span class="ruby-identifier">new</span>(<span class="ruby-identifier">file_name</span>).<span class="ruby-identifier">load</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
       </div>
 
     
@@ -300,7 +339,7 @@
 
           
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 63</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 73</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">file_name</span>)
   <span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
   <span class="ruby-keyword">if</span> <span class="ruby-identifier">file_name</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>)
@@ -362,7 +401,7 @@
 
           
           <div class="method-source-code" id="exist-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 106</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 116</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">exist?</span>
   <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">name</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -397,7 +436,7 @@
 
           
           <div class="method-source-code" id="load-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 115</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 125</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load</span>
   <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{name} does not exist.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">name</span>)
   <span class="ruby-identifier">entry_list</span> = <span class="ruby-constant">EntryList</span>.<span class="ruby-identifier">new</span>
@@ -424,6 +463,7 @@
   <span class="ruby-identifier">entry_list</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">new_entry</span>(<span class="ruby-identifier">record</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">empty?</span>
   <span class="ruby-ivar">@loaded</span> = <span class="ruby-keyword">true</span>
   <span class="ruby-ivar">@entries</span> = <span class="ruby-identifier">entry_list</span>.<span class="ruby-identifier">sort</span>
+  <span class="ruby-keyword">self</span>
 <span class="ruby-keyword">rescue</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>
   <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File malformation: #{e}&quot;</span>
 <span class="ruby-keyword">end</span></pre>
@@ -458,7 +498,7 @@
 
           
           <div class="method-source-code" id="loaded-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 98</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 108</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">loaded?</span>
   <span class="ruby-ivar">@loaded</span>
 <span class="ruby-keyword">end</span></pre>
@@ -493,7 +533,7 @@
 
           
           <div class="method-source-code" id="new-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 90</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 100</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new?</span>
   <span class="ruby-ivar">@new</span>
 <span class="ruby-keyword">end</span></pre>
@@ -522,7 +562,7 @@
           
           <p>Writes a new entry to the file if the first entry in the file isn&#39;t today. This method is destructive; if a file for entries in the date range already exists, it will be clobbered with the entries in the range.</p>
 
-<p>@param [Hash] start_and_end_date</p>
+<p>@param [Hash] {start_date: Date, end_date: Date}</p>
 
 <p>@return [Boolean] true if successful</p>
           
@@ -530,7 +570,7 @@
 
           
           <div class="method-source-code" id="write-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 153</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 164</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">dates</span> = {})
   <span class="ruby-identifier">sorted_entries</span> = <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">sort</span>
   <span class="ruby-identifier">start_date</span> = <span class="ruby-identifier">dates</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:start_date</span>, <span class="ruby-identifier">sorted_entries</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">date</span>)
@@ -539,9 +579,9 @@
     <span class="ruby-identifier">sorted_entries</span>.<span class="ruby-identifier">filter</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>).<span class="ruby-identifier">sort_reverse</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
       <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">date</span>)
       <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">sub_header_order</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span>
-        <span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">attr</span>)
+        <span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">public_send</span>(<span class="ruby-identifier">attr</span>)
         <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">tasks</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">empty?</span>
-        <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">sub_header</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{attr}_header&quot;</span>).<span class="ruby-identifier">capitalize</span>)
+        <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">sub_header</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">public_send</span>(<span class="ruby-node">&quot;#{attr}_header&quot;</span>).<span class="ruby-identifier">capitalize</span>)
         <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">bullet_character</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39; &#39;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">task</span> }
       <span class="ruby-keyword">end</span>
       <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span>

data/doc/created.rid

@@ -1,15 +1,15 @@
-Wed, 10 Jun 2020 22:18:21 -0500
-README.md	Wed, 10 Jun 2020 22:17:47 -0500
-lib/standup_md.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/cli.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/cli/helpers.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/config.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/config/cli.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/config/entry.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/config/entry_list.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/config/file.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/entry.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/entry_list.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/file.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/file/helpers.rb	Wed, 10 Jun 2020 22:14:30 -0500
-lib/standup_md/version.rb	Wed, 10 Jun 2020 20:28:21 -0500
+Tue, 23 Jun 2020 14:45:39 -0500
+README.md	Wed, 17 Jun 2020 21:10:35 -0500
+lib/standup_md.rb	Wed, 17 Jun 2020 08:47:50 -0500
+lib/standup_md/cli.rb	Sun, 14 Jun 2020 22:01:32 -0500
+lib/standup_md/cli/helpers.rb	Tue, 23 Jun 2020 14:44:38 -0500
+lib/standup_md/config.rb	Wed, 17 Jun 2020 08:47:50 -0500
+lib/standup_md/config/cli.rb	Wed, 17 Jun 2020 08:47:50 -0500
+lib/standup_md/config/entry.rb	Wed, 17 Jun 2020 08:47:50 -0500
+lib/standup_md/config/entry_list.rb	Wed, 17 Jun 2020 08:47:50 -0500
+lib/standup_md/config/file.rb	Wed, 17 Jun 2020 08:47:50 -0500
+lib/standup_md/entry.rb	Tue, 23 Jun 2020 14:28:00 -0500
+lib/standup_md/entry_list.rb	Thu, 18 Jun 2020 23:08:53 -0500
+lib/standup_md/file.rb	Thu, 18 Jun 2020 23:09:53 -0500
+lib/standup_md/file/helpers.rb	Sun, 14 Jun 2020 22:06:09 -0500
+lib/standup_md/version.rb	Tue, 23 Jun 2020 14:45:34 -0500

data/doc/index.html

@@ -148,6 +148,10 @@
 <ul><li>
 <p><a href="#api-examples">API Examples</a></p>
 </li><li>
+<p><a href="#adding-an-entry-for-today">Adding an entry for today</a></p>
+</li><li>
+<p><a href="#finding-a-past-entry">Finding a past entry</a></p>
+</li><li>
 <p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
 </li></ul>
 </li><li>
@@ -164,6 +168,8 @@
 
 <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
+<p>If you don&#39;t have the permissions to install system-wide gems, you&#39;re probabaly also running an older version of ruby. I recommend installing <a href="https://github.com/rbenv/rbenv#installation">rbenv</a>, and then installing an up-to-date version of ruby.</p>
+
 <h3 id="label-Via+RubyGems">Via RubyGems<span><a href="#label-Via+RubyGems">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
 <p>Just install the gem!</p>
@@ -190,7 +196,7 @@ rake install
 
 <h3 id="label-Command+Line">Command Line<span><a href="#label-Command+Line">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
-<p>For the most basic usage, simplyt call the executable.</p>
+<p>For the most basic usage, simply call the executable.</p>
 
 <pre class="ruby"><span class="ruby-identifier">standup</span>
 </pre>
@@ -234,7 +240,7 @@ rake install
 
 <h4 id="label-Add+entry+to+file+without+opening+it">Add entry to file without opening it<span><a href="#label-Add+entry+to+file+without+opening+it">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
-<pre>standup --no-edit --current &quot;Work on this thing&quot;,&quot;And another thing&quot; -p</pre>
+<pre>standup --no-edit --current &quot;Work on this thing&quot;,&quot;And another thing&quot;</pre>
 
 <h4 id="label-Find+an+entry+by+date+and+print+it.">Find an entry by date and print it.<span><a href="#label-Find+an+entry+by+date+and+print+it.">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
@@ -252,6 +258,8 @@ rake install
 
 <h4 id="label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults<span><a href="#label-Available+Config+File+Options+and+Defaults">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
+<p>For command-line usage, this file needs to be named <code>~/.standuprc</code>. To use in a rails project, create an initializer (<code>config/initializers/standup_md.rb</code>).</p>
+
 <pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
   <span class="ruby-comment"># Defaults for how the file is formatted.</span>
   <span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
@@ -288,25 +296,11 @@ rake install
 <span class="ruby-keyword">end</span>
 </pre>
 
-<h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Any options not set in this file will retain their default values. Note that if you change <code>file_name_format</code>, and don&#39;t use a month or year, there will only ever be one standup file. This could cause issues long-term, as the files will get large over time and possibly cause performance issues.</p>
 
-<pre>--current ARRAY            List of current entry&#39;s tasks
-    --previous ARRAY           List of precious entry&#39;s tasks
-    --impediments ARRAY        List of impediments for current entry
-    --notes ARRAY              List of notes for current entry
-    --sub-header-order ARRAY   The order of the sub-headers when writing the file
--f, --file-name-format STRING  Date-formattable string to use for standup file name
--E, --editor EDITOR            Editor to use for opening standup files
--d, --directory DIRECTORY      The directories where standup files are located
--w  --[no-]write               Write current entry if it doesn&#39;t exist. Default is true
--a  --[no-]auto-fill-previous  Auto-generate &#39;previous&#39; tasks for new entries
--e  --[no-]edit                Open the file in the editor. Default is true
--v, --[no-]verbose             Verbose output. Default is false.
--p, --print [DATE]             Print current entry.
-                               If DATE is passed, will print entry for DATE, if it exists.
-                               DATE must be in the same format as file-name-format</pre>
+<h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
-<p>Any options not set in this file will retain their default values. Note that if you change <code>file_name_format</code>, and don&#39;t use a month or year, there will only ever be one standup file. This could cause issues long-term, as the files will get large over time and possibly cause performance issues.</p>
+<p>Some of these options can be changed at runtime. They are as follows. <code>     --current ARRAY            List of current entry&#39;s tasks     --previous ARRAY           List of precious entry&#39;s tasks     --impediments ARRAY        List of impediments for current entry     --notes ARRAY              List of notes for current entry     --sub-header-order ARRAY   The order of the sub-headers when writing the file -f, --file-name-format STRING  Date-formattable string to use for standup file name -E, --editor EDITOR            Editor to use for opening standup files -d, --directory DIRECTORY      The directories where standup files are located -w  --[no-]write               Write current entry if it doesn&#39;t exist. Default is true -a  --[no-]auto-fill-previous  Auto-generate &#39;previous&#39; tasks for new entries -e  --[no-]edit                Open the file in the editor. Default is true -v, --[no-]verbose             Verbose output. Default is false. -p, --print [DATE]             Print current entry.                                If DATE is passed, will print entry for DATE, if it exists.                                DATE must be in the same format as file-name-format </code></p>
 
 <h4 id="label-Using+Existing+Standup+Files">Using Existing Standup Files<span><a href="#label-Using+Existing+Standup+Files">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
@@ -339,27 +333,28 @@ rake install
 <p>Your <code>~/.standuprc</code> should contain:</p>
 
 <pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span>        <span class="ruby-value">2</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_depth</span>    <span class="ruby-value">3</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span>      <span class="ruby-constant">Today</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span>     <span class="ruby-constant">Yesterday</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span>  <span class="ruby-constant">Hold</span><span class="ruby-operator">-</span><span class="ruby-identifier">ups</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span>    <span class="ruby-string">&#39;*&#39;</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span>  <span class="ruby-string">&#39;%m/%d/%Y&#39;</span>
-  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span> = <span class="ruby-node">%w[current previous impediments notes]</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span>       = <span class="ruby-value">2</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_depth</span>   = <span class="ruby-value">3</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span>     = <span class="ruby-string">&#39;Today&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span>    = <span class="ruby-string">&#39;Yesterday&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span> = <span class="ruby-string">&#39;Hold-ups&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span>   = <span class="ruby-string">&#39;*&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span> = <span class="ruby-string">&#39;%m/%d/%Y&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span>   = <span class="ruby-node">%w[current previous impediments notes]</span>
 <span class="ruby-keyword">end</span>
 </pre>
 
 <h2 id="label-API">API<span><a href="#label-API">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
-<p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">documentation</a>.</p>
+<p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">RDoc Documentation</a>.</p>
 
 <p>This was mainly written as a command line utility, but the API is ridiculously robust, and is available for use in your own projects. A quick example of how to write a new entry via code could look like the following:</p>
 
 <h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
+<h4 id="label-Adding+an+entry+for+today">Adding an entry for today<span><a href="#label-Adding+an+entry+for+today">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
 <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
-<span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
 
 <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
   <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Today&#39;</span>,
@@ -374,7 +369,6 @@ rake install
 <p>The above example was written as such to show how the different pieces of the API fit together. The code can actually be simplified to the following.</p>
 
 <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
-<span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
 
 <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
   <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Today&#39;</span>,
@@ -384,6 +378,15 @@ rake install
 <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">find_by_date</span>(<span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>).<span class="ruby-identifier">load</span>.<span class="ruby-identifier">write</span>
 </pre>
 
+<h4 id="label-Finding+a+past+entry">Finding a past entry<span><a href="#label-Finding+a+past+entry">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
+
+<span class="ruby-identifier">date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">2020</span>, <span class="ruby-value">04</span>, <span class="ruby-value">15</span>)
+<span class="ruby-identifier">file</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">find_by_date</span>(<span class="ruby-identifier">date</span>).<span class="ruby-identifier">load</span>
+<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">file</span>.<span class="ruby-identifier">entries</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">date</span>)
+</pre>
+
 <h2 id="label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features<span><a href="#label-Reporting+Bugs+and+Requesting+Features">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>If you have an idea or find a bug, please <a href="https://github.com/evanthegrayt/standup_md/issues/new">create an issue</a>. Just make sure the topic doesn&#39;t already exist. Better yet, you can always submit a Pull Request.</p>

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["standupmd","cli","helpers","config","cli","entry","entrylist","file","entry","entrylist","file","<<()","<=>()","bullet_character=()","config()","config()","config()","config()","config()","config_file_loaded?()","configure()","create()","directory=()","each()","echo()","echo()","edit()","empty?()","execute()","exist?()","filter()","filter!()","find()","find()","find_by_date()","first()","header_depth=()","initalize()","last()","load()","load_config_file()","load_preferences()","loaded?()","new()","new()","new()","new()","new()","new()","new()","new()","new?()","preference_file_loaded?()","print()","reset_config()","reset_values()","reset_values()","reset_values()","reset_values()","size()","sort()","sort!()","sort_reverse()","sub_header_depth=()","to_h()","to_h()","to_json()","to_json()","write()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli::helpers","standupmd::config","standupmd::config::cli","standupmd::config::entry","standupmd::config::entrylist","standupmd::config::file","standupmd::entry","standupmd::entrylist","standupmd::file","standupmd::entrylist#<<()","standupmd::entry#<=>()","standupmd::config::file#bullet_character=()","standupmd::config()","standupmd::cli::config()","standupmd::entry::config()","standupmd::entrylist::config()","standupmd::file::config()","standupmd::config_file_loaded?()","standupmd::configure()","standupmd::entry::create()","standupmd::config::file#directory=()","standupmd::entrylist#each()","standupmd::cli#echo()","standupmd::cli::echo()","standupmd::cli#edit()","standupmd::entrylist#empty?()","standupmd::cli::execute()","standupmd::file#exist?()","standupmd::entrylist#filter()","standupmd::entrylist#filter!()","standupmd::entrylist#find()","standupmd::file::find()","standupmd::file::find_by_date()","standupmd::entrylist#first()","standupmd::config::file#header_depth=()","standupmd::config::entrylist#initalize()","standupmd::entrylist#last()","standupmd::file#load()","standupmd::load_config_file()","standupmd::cli#load_preferences()","standupmd::file#loaded?()","standupmd::cli::new()","standupmd::config::new()","standupmd::config::cli::new()","standupmd::config::entry::new()","standupmd::config::file::new()","standupmd::entry::new()","standupmd::entrylist::new()","standupmd::file::new()","standupmd::file#new?()","standupmd::cli#preference_file_loaded?()","standupmd::cli::helpers#print()","standupmd::reset_config()","standupmd::config::cli#reset_values()","standupmd::config::entry#reset_values()","standupmd::config::entrylist#reset_values()","standupmd::config::file#reset_values()","standupmd::entrylist#size()","standupmd::entrylist#sort()","standupmd::entrylist#sort!()","standupmd::entrylist#sort_reverse()","standupmd::config::file#sub_header_depth=()","standupmd::entry#to_h()","standupmd::entrylist#to_h()","standupmd::entry#to_json()","standupmd::entrylist#to_json()","standupmd::file#write()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","The class for handing reading/writing of entries.\n"],["StandupMD::Cli","","StandupMD/Cli.html","","Class for handing the command-line interface.\n"],["StandupMD::Cli::Helpers","","StandupMD/Cli/Helpers.html","","Module responsible for reading and writing standup files.\n"],["StandupMD::Config","","StandupMD/Config.html","","This class provides a connector from StandupMD to the configuration classes.\n"],["StandupMD::Config::Cli","","StandupMD/Config/Cli.html","","The configuration class for StandupMD::Cli\n"],["StandupMD::Config::Entry","","StandupMD/Config/Entry.html","","The configuration class for StandupMD::Entry\n"],["StandupMD::Config::EntryList","","StandupMD/Config/EntryList.html","","The configuration class for StandupMD::EntryList\n"],["StandupMD::Config::File","","StandupMD/Config/File.html","","The configuration class for StandupMD::File\n"],["StandupMD::Entry","","StandupMD/Entry.html","","Class for handling single entries. Includes the comparable module, and compares by date.\n"],["StandupMD::EntryList","","StandupMD/EntryList.html","","Enumerable list of entries.\n"],["StandupMD::File","","StandupMD/File.html","","Class for handling reading and writing standup files.\n"],["<<","StandupMD::EntryList","StandupMD/EntryList.html#method-i-3C-3C","(entry)","Appends entries to list.\n@param [StandupMD::Entry] entry\n@return [Array]\n"],["<=>","StandupMD::Entry","StandupMD/Entry.html#method-i-3C-3D-3E","(other)","Sorting method for Comparable. Entries are compared by date.\n"],["bullet_character=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-bullet_character-3D","(char)","Setter for bullet_character. Must be * (asterisk) or - (dash).\n@param [String] character\n@return [String] …\n"],["config","StandupMD","StandupMD.html#method-c-config","()","Shorthand for StanupMD::Cli\n@return [StanupMD::Cli]\n"],["config","StandupMD::Cli","StandupMD/Cli.html#method-c-config","()","Access to the class's configuration.\n@return [StandupMD::Config::Cli]\n"],["config","StandupMD::Entry","StandupMD/Entry.html#method-c-config","()","Access to the class's configuration.\n@return [StandupMD::Config::Entry]\n"],["config","StandupMD::EntryList","StandupMD/EntryList.html#method-c-config","()","Access to the class's configuration.\n@return [StandupMD::Config::EntryList]\n"],["config","StandupMD::File","StandupMD/File.html#method-c-config","()","Access to the class's configuration.\n@return [StandupMD::Config::EntryList]\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-c-config_file_loaded-3F","()","Has a config file been loaded?\n@return [Boolean]\n"],["configure","StandupMD","StandupMD.html#method-c-configure","()","Allows for configuration via a block. Useful when making config files.\n@example\n\nStandupMD.configure { |s| ...\n"],["create","StandupMD::Entry","StandupMD/Entry.html#method-c-create","()","Creates a generic entry. Default values can be set via configuration. Yields the entry if a block is …\n"],["directory=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-directory-3D","(directory)","Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["each","StandupMD::EntryList","StandupMD/EntryList.html#method-i-each","(&block)","Iterate over the list and yield each entry.\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","Quick access to Cli.echo.\n@return [nil]\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-c-echo","(msg)","Prints output if verbose is true.\n@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","Opens the file in an editor. Abandons the script.\n@return [nil]\n"],["empty?","StandupMD::EntryList","StandupMD/EntryList.html#method-i-empty-3F","()","Is the list empty?\n@return [Boolean] true if empty\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","Creates an instance of StandupMD and runs what the user requested.\n"],["exist?","StandupMD::File","StandupMD/File.html#method-i-exist-3F","()","Does the file exist?\n@return [Boolean] true if exists\n"],["filter","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter","(start_date, end_date)","Returns entries that are between the start and end date. This method assumes the list has already been …\n"],["filter!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter-21","(start_date, end_date)","Replaces entries with results of filter.\n@param [Date] start_date\n@param [Date] end_date\n"],["find","StandupMD::EntryList","StandupMD/EntryList.html#method-i-find","(key)","Finds an entry based on date. This method assumes the list has already been sorted.\n"],["find","StandupMD::File","StandupMD/File.html#method-c-find","(file_name)","Find standup file in directory by file name.\n@param [String] File_naem\n"],["find_by_date","StandupMD::File","StandupMD/File.html#method-c-find_by_date","(date)","Find standup file in directory by Date object.\n@param [Date] date\n"],["first","StandupMD::EntryList","StandupMD/EntryList.html#method-i-first","()","The first entry in the list. This method assumes the list has already been sorted.\n@return [StandupMD::Entry] …\n"],["header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-header_depth-3D","(depth)","Number of octothorps (#) to use before the main header.\n@param [Integer] depth\n@return [Integer]\n"],["initalize","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-initalize","()","Initializes the config with default values.\n"],["last","StandupMD::EntryList","StandupMD/EntryList.html#method-i-last","()","The last entry in the list. This method assumes the list has already been sorted.\n@return [StandupMD::Entry] …\n"],["load","StandupMD::File","StandupMD/File.html#method-i-load","()","Loads the file's contents. TODO clean up this method.\n@return [StandupMD::FileList]\n"],["load_config_file","StandupMD","StandupMD.html#method-c-load_config_file","(file)","Loads a config file.\n@param [String] file\n"],["load_preferences","StandupMD::Cli","StandupMD/Cli.html#method-i-load_preferences","()","Load the preference file.\n@return [nil]\n"],["loaded?","StandupMD::File","StandupMD/File.html#method-i-loaded-3F","()","Has the file been loaded?\n@return [Boolean] true if loaded\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options = [], load_config = true)","Constructor. Sets defaults.\n@param [Array] options\n"],["new","StandupMD::Config","StandupMD/Config.html#method-c-new","()","Builds the links to the configuration classes.\n"],["new","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-c-new","()","Initializes the config with default values.\n"],["new","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-c-new","()","Initializes the config with default values.\n"],["new","StandupMD::Config::File","StandupMD/Config/File.html#method-c-new","()","Initializes the config with default values.\n"],["new","StandupMD::Entry","StandupMD/Entry.html#method-c-new","(date, current, previous, impediments, notes = [])","Constructs instance of StandupMD::Entry.\n@param [Date] date\n@param [Array] current\n"],["new","StandupMD::EntryList","StandupMD/EntryList.html#method-c-new","(*entries)","Contruct a list. Can pass any amount of StandupMD::Entry instances.\n@param [Entry] entries\n@return [StandupMD::EntryList] …\n"],["new","StandupMD::File","StandupMD/File.html#method-c-new","(file_name)","Constructs the instance.\n@param [String] file_name\n@return [StandupMP::File]\n"],["new?","StandupMD::File","StandupMD/File.html#method-i-new-3F","()","Was the file just now created?\n@return [Boolean] true if new\n"],["preference_file_loaded?","StandupMD::Cli","StandupMD/Cli.html#method-i-preference_file_loaded-3F","()","Has the preference file been loaded?\n@return boolean\n"],["print","StandupMD::Cli::Helpers","StandupMD/Cli/Helpers.html#method-i-print","(entry)","Print an entry to the command line.\n@param [StandupMD::Entry] entry\n@return [nil]\n"],["reset_config","StandupMD","StandupMD.html#method-c-reset_config","()","Reset all configuration values to their defaults.\n@return [StandupMD::Config]\n"],["reset_values","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset_values","()","Sets all config values back to their defaults.\n@return [Boolean] true if successful\n"],["reset_values","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-i-reset_values","()","Sets all config values back to their defaults.\n@return [Boolean] true if successful\n"],["reset_values","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-reset_values","()","Sets all config values back to their defaults.\n@return [Boolean] true if successful\n"],["reset_values","StandupMD::Config::File","StandupMD/Config/File.html#method-i-reset_values","()","Sets all config values back to their defaults.\n@return [Boolean] true if successful\n"],["size","StandupMD::EntryList","StandupMD/EntryList.html#method-i-size","()","How many entries are in the list.\n@return [Integer]\n"],["sort","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort","()","Returns a copy of self sorted by date.\n@return [StandupMD::EntryList]\n"],["sort!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort-21","()","Replace entries with sorted entries by date.\n@return [StandupMD::EntryList]\n"],["sort_reverse","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort_reverse","()","Returns a copy of self sorted by date.\n@return [StandupMD::EntryList]\n"],["sub_header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-sub_header_depth-3D","(depth)","Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n@param [Integer] depth\n@return …\n"],["to_h","StandupMD::Entry","StandupMD/Entry.html#method-i-to_h","()","Entry as a hash .\n@return [Hash]\n"],["to_h","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_h","()","The list as a hash, with the dates as keys.\n@return [Hash]\n"],["to_json","StandupMD::Entry","StandupMD/Entry.html#method-i-to_json","()","Entry as a json object.\n@return [String]\n"],["to_json","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_json","()","The entry list as a json object.\n@return [String]\n"],["write","StandupMD::File","StandupMD/File.html#method-i-write","(dates = {})","Writes a new entry to the file if the first entry in the file isn't today. This method is destructive; …\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","Writes entries to the file.\n@return [Boolean] true if file was written\n"],["README","","README_md.html","","The Standup Doctor\n …\n\n"]]}}
        
+var search_data = {"index":{"searchIndex":["standupmd","cli","helpers","config","cli","entry","entrylist","file","entry","entrylist","file","<<()","<=>()","@entries()","bullet_character=()","config()","config()","config()","config()","config()","config_file_loaded?()","configure()","create()","directory=()","echo()","echo()","edit()","execute()","exist?()","filter()","filter!()","find()","find()","find_by_date()","header_depth=()","initalize()","load()","load()","load_config_file()","load_preferences()","loaded?()","new()","new()","new()","new()","new()","new()","new()","new()","new?()","preference_file_loaded?()","print()","reset()","reset()","reset()","reset()","reset_config()","sort()","sort!()","sort_reverse()","sub_header_depth=()","to_h()","to_h()","to_json()","to_json()","write()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli::helpers","standupmd::config","standupmd::config::cli","standupmd::config::entry","standupmd::config::entrylist","standupmd::config::file","standupmd::entry","standupmd::entrylist","standupmd::file","standupmd::entrylist#<<()","standupmd::entry#<=>()","standupmd::entrylist#@entries()","standupmd::config::file#bullet_character=()","standupmd::config()","standupmd::cli::config()","standupmd::entry::config()","standupmd::entrylist::config()","standupmd::file::config()","standupmd::config_file_loaded?()","standupmd::configure()","standupmd::entry::create()","standupmd::config::file#directory=()","standupmd::cli#echo()","standupmd::cli::echo()","standupmd::cli#edit()","standupmd::cli::execute()","standupmd::file#exist?()","standupmd::entrylist#filter()","standupmd::entrylist#filter!()","standupmd::entrylist#find()","standupmd::file::find()","standupmd::file::find_by_date()","standupmd::config::file#header_depth=()","standupmd::config::entrylist#initalize()","standupmd::file::load()","standupmd::file#load()","standupmd::load_config_file()","standupmd::cli#load_preferences()","standupmd::file#loaded?()","standupmd::cli::new()","standupmd::config::new()","standupmd::config::cli::new()","standupmd::config::entry::new()","standupmd::config::file::new()","standupmd::entry::new()","standupmd::entrylist::new()","standupmd::file::new()","standupmd::file#new?()","standupmd::cli#preference_file_loaded?()","standupmd::cli::helpers#print()","standupmd::config::cli#reset()","standupmd::config::entry#reset()","standupmd::config::entrylist#reset()","standupmd::config::file#reset()","standupmd::reset_config()","standupmd::entrylist#sort()","standupmd::entrylist#sort!()","standupmd::entrylist#sort_reverse()","standupmd::config::file#sub_header_depth=()","standupmd::entry#to_h()","standupmd::entrylist#to_h()","standupmd::entry#to_json()","standupmd::entrylist#to_json()","standupmd::file#write()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","The main module for the gem. Provides access to configuration classes.\n"],["StandupMD::Cli","","StandupMD/Cli.html","","Class for handing the command-line interface.\n"],["StandupMD::Cli::Helpers","","StandupMD/Cli/Helpers.html","","Module responsible for reading and writing standup files.\n"],["StandupMD::Config","","StandupMD/Config.html","","This class provides a connector from StandupMD to the configuration classes.\n"],["StandupMD::Config::Cli","","StandupMD/Config/Cli.html","","The configuration class for StandupMD::Cli\n"],["StandupMD::Config::Entry","","StandupMD/Config/Entry.html","","The configuration class for StandupMD::Entry\n"],["StandupMD::Config::EntryList","","StandupMD/Config/EntryList.html","","The configuration class for StandupMD::EntryList\n"],["StandupMD::Config::File","","StandupMD/Config/File.html","","The configuration class for StandupMD::File\n"],["StandupMD::Entry","","StandupMD/Entry.html","","Class for handling single entries. Includes the comparable module, and compares by date.\n"],["StandupMD::EntryList","","StandupMD/EntryList.html","","Enumerable list of entries.\n"],["StandupMD::File","","StandupMD/File.html","","Class for handling reading and writing standup files.\n"],["<<","StandupMD::EntryList","StandupMD/EntryList.html#method-i-3C-3C","(entry)","Appends entries to list.\n@param [StandupMD::Entry] entry\n@return [Array]\n"],["<=>","StandupMD::Entry","StandupMD/Entry.html#method-i-3C-3D-3E","(other)","Sorting method for Comparable. Entries are compared by date.\n"],["@entries","StandupMD::EntryList","StandupMD/EntryList.html#method-i-40entries","","The following are forwarded to @entries, which is the underly array of entries.\neach — Iterate over each …\n"],["bullet_character=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-bullet_character-3D","(char)","Setter for bullet_character. Must be * (asterisk) or - (dash).\n@param [String] character\n@return [String] …\n"],["config","StandupMD","StandupMD.html#method-c-config","()","Method for accessing the configuration.\n@return [StanupMD::Cli]\n"],["config","StandupMD::Cli","StandupMD/Cli.html#method-c-config","()","Access to the class's configuration.\n@return [StandupMD::Config::Cli]\n"],["config","StandupMD::Entry","StandupMD/Entry.html#method-c-config","()","Access to the class's configuration.\n@return [StandupMD::Config::Entry]\n"],["config","StandupMD::EntryList","StandupMD/EntryList.html#method-c-config","()","Access to the class's configuration.\n@return [StandupMD::Config::EntryList]\n"],["config","StandupMD::File","StandupMD/File.html#method-c-config","()","Access to the class's configuration.\n@return [StandupMD::Config::EntryList]\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-c-config_file_loaded-3F","()","Has a config file been loaded?\n@return [Boolean]\n"],["configure","StandupMD","StandupMD.html#method-c-configure","()","Allows for configuration via a block. Useful when making config files.\n@example\n\nStandupMD.configure { |s| ...\n"],["create","StandupMD::Entry","StandupMD/Entry.html#method-c-create","()","Creates a generic entry. Default values can be set via configuration. Yields the entry if a block is …\n"],["directory=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-directory-3D","(directory)","Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","Quick access to Cli.echo.\n@return [nil]\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-c-echo","(msg)","Prints output if verbose is true.\n@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","Opens the file in an editor. Abandons the script.\n@return [nil]\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","Creates an instance of StandupMD and runs what the user requested.\n"],["exist?","StandupMD::File","StandupMD/File.html#method-i-exist-3F","()","Does the file exist?\n@return [Boolean] true if exists\n"],["filter","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter","(start_date, end_date)","Returns entries that are between the start and end date. This method assumes the list has already been …\n"],["filter!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter-21","(start_date, end_date)","Replaces entries with results of filter.\n@param [Date] start_date\n@param [Date] end_date\n"],["find","StandupMD::EntryList","StandupMD/EntryList.html#method-i-find","(date)","Finds an entry based on date. This method assumes the list has already been sorted.\n@param [Date] date …\n"],["find","StandupMD::File","StandupMD/File.html#method-c-find","(file_name)","Find standup file in directory by file name.\n@param [String] File_naem\n"],["find_by_date","StandupMD::File","StandupMD/File.html#method-c-find_by_date","(date)","Find standup file in directory by Date object.\n@param [Date] date\n"],["header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-header_depth-3D","(depth)","Number of octothorps (#) to use before the main header.\n@param [Integer] depth\n@return [Integer]\n"],["initalize","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-initalize","()","Initializes the config with default values.\n"],["load","StandupMD::File","StandupMD/File.html#method-c-load","(file_name)","Convenience method for calling File.find(file_name).load\n@param [String] file_name\n@return [StandupMD::File] …\n"],["load","StandupMD::File","StandupMD/File.html#method-i-load","()","Loads the file's contents. TODO clean up this method.\n@return [StandupMD::FileList]\n"],["load_config_file","StandupMD","StandupMD.html#method-c-load_config_file","(file)","Loads a config file.\n@param [String] file\n"],["load_preferences","StandupMD::Cli","StandupMD/Cli.html#method-i-load_preferences","()","Load the preference file.\n@return [nil]\n"],["loaded?","StandupMD::File","StandupMD/File.html#method-i-loaded-3F","()","Has the file been loaded?\n@return [Boolean] true if loaded\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options = [], load_config = true)","Constructor. Sets defaults.\n@param [Array] options\n"],["new","StandupMD::Config","StandupMD/Config.html#method-c-new","()","Builds the links to the configuration classes.\n"],["new","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-c-new","()","Initializes the config with default values.\n"],["new","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-c-new","()","Initializes the config with default values.\n"],["new","StandupMD::Config::File","StandupMD/Config/File.html#method-c-new","()","Initializes the config with default values.\n"],["new","StandupMD::Entry","StandupMD/Entry.html#method-c-new","(date, current, previous, impediments, notes = [])","Constructs instance of StandupMD::Entry.\n@param [Date] date\n@param [Array] current\n"],["new","StandupMD::EntryList","StandupMD/EntryList.html#method-c-new","(*entries)","Contruct a list. Can pass any amount of StandupMD::Entry instances.\n@param [Entry] entries\n@return [StandupMD::EntryList] …\n"],["new","StandupMD::File","StandupMD/File.html#method-c-new","(file_name)","Constructs the instance.\n@param [String] file_name\n@return [StandupMP::File]\n"],["new?","StandupMD::File","StandupMD/File.html#method-i-new-3F","()","Was the file just now created?\n@return [Boolean] true if new\n"],["preference_file_loaded?","StandupMD::Cli","StandupMD/Cli.html#method-i-preference_file_loaded-3F","()","Has the preference file been loaded?\n@return boolean\n"],["print","StandupMD::Cli::Helpers","StandupMD/Cli/Helpers.html#method-i-print","(entry)","Print an entry to the command line.\n@param [StandupMD::Entry] entry\n@return [nil]\n"],["reset","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset","()","Sets all config values back to their defaults.\n@return [Hash]\n"],["reset","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-i-reset","()","Sets all config values back to their defaults.\n@return [Hash]\n"],["reset","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-reset","()","Sets all config values back to their defaults.\n@return [Hash]\n"],["reset","StandupMD::Config::File","StandupMD/Config/File.html#method-i-reset","()","Sets all config values back to their defaults.\n@return [Hash]\n"],["reset_config","StandupMD","StandupMD.html#method-c-reset_config","()","Reset all configuration values to their defaults.\n@return [StandupMD::Config]\n"],["sort","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort","()","Returns a copy of self sorted by date.\n@return [StandupMD::EntryList]\n"],["sort!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort-21","()","Replace entries with sorted entries by date.\n@return [StandupMD::EntryList]\n"],["sort_reverse","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort_reverse","()","Returns a copy of self sorted by date.\n@return [StandupMD::EntryList]\n"],["sub_header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-sub_header_depth-3D","(depth)","Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n@param [Integer] depth\n@return …\n"],["to_h","StandupMD::Entry","StandupMD/Entry.html#method-i-to_h","()","Entry as a hash .\n@return [Hash]\n"],["to_h","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_h","()","The list as a hash, with the dates as keys.\n@return [Hash]\n"],["to_json","StandupMD::Entry","StandupMD/Entry.html#method-i-to_json","()","Entry as a json object.\n@return [String]\n"],["to_json","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_json","()","The entry list as a json object.\n@return [String]\n"],["write","StandupMD::File","StandupMD/File.html#method-i-write","(dates = {})","Writes a new entry to the file if the first entry in the file isn't today. This method is destructive; …\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","Writes entries to the file.\n@return [Boolean] true if file was written\n"],["README","","README_md.html","","The Standup Doctor\n …\n\n"]]}}
        

data/doc/table_of_contents.html

@@ -75,6 +75,10 @@
 
       <li><a href="README_md.html#label-API+Examples">API Examples</a>
 
+      <li><a href="README_md.html#label-Adding+an+entry+for+today">Adding an entry for today</a>
+
+      <li><a href="README_md.html#label-Finding+a+past+entry">Finding a past entry</a>
+
       <li><a href="README_md.html#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
 
       <li><a href="README_md.html#label-Self-Promotion">Self-Promotion</a>
@@ -137,6 +141,14 @@
   <li class="class">
     <a href="StandupMD/EntryList.html">StandupMD::EntryList</a>
 
+    <ul>
+
+      <li><a href="StandupMD/EntryList.html#5Buntitled-5D">Top Section</a>
+
+      <li><a href="StandupMD/EntryList.html#Delegators">Delegators</a>
+
+    </ul>
+
   </li>
 
   <li class="class">
@@ -155,9 +167,9 @@
     <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/File.html#method-c-config">::config</a>
+    <a href="StandupMD/EntryList.html#method-c-config">::config</a>
     &mdash;
-    <span class="container">StandupMD::File</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
     <a href="StandupMD/Cli.html#method-c-config">::config</a>
@@ -170,9 +182,9 @@
     <span class="container">StandupMD</span>
 
   <li class="method">
-    <a href="StandupMD/EntryList.html#method-c-config">::config</a>
+    <a href="StandupMD/File.html#method-c-config">::config</a>
     &mdash;
-    <span class="container">StandupMD::EntryList</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
     <a href="StandupMD.html#method-c-config_file_loaded-3F">::config_file_loaded?</a>
@@ -210,14 +222,14 @@
     <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
+    <a href="StandupMD/File.html#method-c-load">::load</a>
     &mdash;
-    <span class="container">StandupMD</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="StandupMD/EntryList.html#method-c-new">::new</a>
+    <a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
     &mdash;
-    <span class="container">StandupMD::EntryList</span>
+    <span class="container">StandupMD</span>
 
   <li class="method">
     <a href="StandupMD/Config/File.html#method-c-new">::new</a>
@@ -244,6 +256,11 @@
     &mdash;
     <span class="container">StandupMD::Cli</span>
 
+  <li class="method">
+    <a href="StandupMD/EntryList.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">StandupMD::EntryList</span>
+
   <li class="method">
     <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
     &mdash;
@@ -270,19 +287,19 @@
     <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/Config/File.html#method-i-bullet_character-3D">#bullet_character=</a>
+    <a href="StandupMD/EntryList.html#method-i-40entries">#@entries</a>
     &mdash;
-    <span class="container">StandupMD::Config::File</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="StandupMD/Config/File.html#method-i-directory-3D">#directory=</a>
+    <a href="StandupMD/Config/File.html#method-i-bullet_character-3D">#bullet_character=</a>
     &mdash;
     <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="StandupMD/EntryList.html#method-i-each">#each</a>
+    <a href="StandupMD/Config/File.html#method-i-directory-3D">#directory=</a>
     &mdash;
-    <span class="container">StandupMD::EntryList</span>
+    <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
     <a href="StandupMD/Cli.html#method-i-echo">#echo</a>
@@ -294,11 +311,6 @@
     &mdash;
     <span class="container">StandupMD::Cli</span>
 
-  <li class="method">
-    <a href="StandupMD/EntryList.html#method-i-empty-3F">#empty?</a>
-    &mdash;
-    <span class="container">StandupMD::EntryList</span>
-
   <li class="method">
     <a href="StandupMD/File.html#method-i-exist-3F">#exist?</a>
     &mdash;
@@ -319,11 +331,6 @@
     &mdash;
     <span class="container">StandupMD::EntryList</span>
 
-  <li class="method">
-    <a href="StandupMD/EntryList.html#method-i-first">#first</a>
-    &mdash;
-    <span class="container">StandupMD::EntryList</span>
-
   <li class="method">
     <a href="StandupMD/Config/File.html#method-i-header_depth-3D">#header_depth=</a>
     &mdash;
@@ -334,11 +341,6 @@
     &mdash;
     <span class="container">StandupMD::Config::EntryList</span>
 
-  <li class="method">
-    <a href="StandupMD/EntryList.html#method-i-last">#last</a>
-    &mdash;
-    <span class="container">StandupMD::EntryList</span>
-
   <li class="method">
     <a href="StandupMD/File.html#method-i-load">#load</a>
     &mdash;
@@ -370,29 +372,24 @@
     <span class="container">StandupMD::Cli::Helpers</span>
 
   <li class="method">
-    <a href="StandupMD/Config/File.html#method-i-reset_values">#reset_values</a>
+    <a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
     &mdash;
-    <span class="container">StandupMD::Config::File</span>
-
-  <li class="method">
-    <a href="StandupMD/Config/Cli.html#method-i-reset_values">#reset_values</a>
-    &mdash;
-    <span class="container">StandupMD::Config::Cli</span>
+    <span class="container">StandupMD::Config::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/Config/Entry.html#method-i-reset_values">#reset_values</a>
+    <a href="StandupMD/Config/File.html#method-i-reset">#reset</a>
     &mdash;
-    <span class="container">StandupMD::Config::Entry</span>
+    <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="StandupMD/Config/EntryList.html#method-i-reset_values">#reset_values</a>
+    <a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
     &mdash;
     <span class="container">StandupMD::Config::EntryList</span>
 
   <li class="method">
-    <a href="StandupMD/EntryList.html#method-i-size">#size</a>
+    <a href="StandupMD/Config/Cli.html#method-i-reset">#reset</a>
     &mdash;
-    <span class="container">StandupMD::EntryList</span>
+    <span class="container">StandupMD::Config::Cli</span>
 
   <li class="method">
     <a href="StandupMD/EntryList.html#method-i-sort">#sort</a>
@@ -415,14 +412,14 @@
     <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="StandupMD/EntryList.html#method-i-to_h">#to_h</a>
+    <a href="StandupMD/Entry.html#method-i-to_h">#to_h</a>
     &mdash;
-    <span class="container">StandupMD::EntryList</span>
+    <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/Entry.html#method-i-to_h">#to_h</a>
+    <a href="StandupMD/EntryList.html#method-i-to_h">#to_h</a>
     &mdash;
-    <span class="container">StandupMD::Entry</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
     <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>