standup_md 0.1.3 → 0.2.0

data/doc/StandupMD/Cli.html

@@ -216,7 +216,7 @@
 
           
           <div class="method-source-code" id="execute-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 18</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 17</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">execute</span>(<span class="ruby-identifier">options</span> = [])
   <span class="ruby-identifier">exe</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
   <span class="ruby-identifier">exe</span>.<span class="ruby-identifier">append_to_previous_entry_tasks</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exe</span>.<span class="ruby-identifier">should_append?</span>
@@ -257,7 +257,7 @@
 
           
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 44</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 43</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span>)
   <span class="ruby-ivar">@edit</span>                = <span class="ruby-keyword">true</span>
   <span class="ruby-ivar">@write</span>               = <span class="ruby-keyword">true</span>
@@ -308,7 +308,7 @@
 
           
           <div class="method-source-code" id="append_previous-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 203</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 207</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">append_previous?</span>
   <span class="ruby-ivar">@append_previous</span>
 <span class="ruby-keyword">end</span></pre>
@@ -343,7 +343,7 @@
 
           
           <div class="method-source-code" id="append_to_previous_entry_tasks-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 128</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 132</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">append_to_previous_entry_tasks</span>
   <span class="ruby-identifier">echo</span> <span class="ruby-string">&#39;Appending previous entry tasks&#39;</span>
   <span class="ruby-identifier">additions</span> = <span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">&#39;previous_entry_tasks&#39;</span>)
@@ -380,7 +380,7 @@
 
           
           <div class="method-source-code" id="echo-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 219</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 223</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">echo</span>(<span class="ruby-identifier">msg</span>)
   <span class="ruby-identifier">puts</span> <span class="ruby-identifier">msg</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">verbose?</span>
 <span class="ruby-keyword">end</span></pre>
@@ -413,9 +413,9 @@
 
           
           <div class="method-source-code" id="edit-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 136</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 140</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">edit</span>
-  <span class="ruby-identifier">echo</span> <span class="ruby-node">&quot;  Opening file in #{editor}&quot;</span>
+  <span class="ruby-identifier">echo</span> <span class="ruby-node">&quot;Opening file in #{editor}&quot;</span>
   <span class="ruby-identifier">exec</span>(<span class="ruby-node">&quot;#{editor} #{standup.file}&quot;</span>)
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -449,7 +449,7 @@
 
           
           <div class="method-source-code" id="edit-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 194</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 198</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">edit?</span>
   <span class="ruby-ivar">@edit</span>
 <span class="ruby-keyword">end</span></pre>
@@ -484,7 +484,7 @@
 
           
           <div class="method-source-code" id="editor-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 76</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 80</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">editor</span>
   <span class="ruby-ivar">@editor</span> <span class="ruby-operator">||=</span>
     <span class="ruby-keyword">if</span> <span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">&#39;editor&#39;</span>)
@@ -532,7 +532,7 @@
 
           
           <div class="method-source-code" id="json-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 162</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 166</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">json?</span>
   <span class="ruby-ivar">@json</span>
 <span class="ruby-keyword">end</span></pre>
@@ -567,7 +567,7 @@
 
           
           <div class="method-source-code" id="print_all_entries-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 97</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 101</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_all_entries</span>
   <span class="ruby-identifier">echo</span> <span class="ruby-string">&#39;Display all entries&#39;</span>
   <span class="ruby-keyword">unless</span> <span class="ruby-identifier">json?</span>
@@ -610,7 +610,7 @@
 
           
           <div class="method-source-code" id="print_all_entries-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 170</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 174</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_all_entries?</span>
   <span class="ruby-ivar">@print_all_entries</span>
 <span class="ruby-keyword">end</span></pre>
@@ -645,7 +645,7 @@
 
           
           <div class="method-source-code" id="print_current_entry-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 113</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 117</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_current_entry</span>
   <span class="ruby-identifier">echo</span> <span class="ruby-string">&#39;Print current entry&#39;</span>
   <span class="ruby-keyword">unless</span> <span class="ruby-identifier">json?</span>
@@ -687,7 +687,7 @@
 
           
           <div class="method-source-code" id="print_current_entry-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 154</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 158</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_current_entry?</span>
   <span class="ruby-ivar">@print_current_entry</span>
 <span class="ruby-keyword">end</span></pre>
@@ -722,7 +722,7 @@
 
           
           <div class="method-source-code" id="should_append-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 211</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 215</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">should_append?</span>
   <span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">&#39;previous_entry_tasks&#39;</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">append_previous?</span>
 <span class="ruby-keyword">end</span></pre>
@@ -757,10 +757,15 @@
 
           
           <div class="method-source-code" id="standup-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 60</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 59</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">standup</span>
-  <span class="ruby-ivar">@standup</span> <span class="ruby-operator">||=</span> <span class="ruby-operator">::</span><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
-    <span class="ruby-identifier">echo</span> <span class="ruby-string">&#39;Runtime options:&#39;</span>
+  <span class="ruby-identifier">cf</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-constant">PREFERENCE_FILE</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">PREFERENCE_FILE</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
+  <span class="ruby-ivar">@standup</span> <span class="ruby-operator">||=</span> <span class="ruby-operator">::</span><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">cf</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">any?</span>
+      <span class="ruby-identifier">echo</span> <span class="ruby-string">&#39;Config options:&#39;</span>
+      <span class="ruby-identifier">s</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">echo</span> <span class="ruby-node">&quot;  #{k} = #{v}&quot;</span> }
+    <span class="ruby-keyword">end</span>
+    <span class="ruby-identifier">echo</span> <span class="ruby-string">&#39;Runtime options:&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">any?</span>
     <span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
       <span class="ruby-identifier">echo</span> <span class="ruby-node">&quot;  #{k} = #{v}&quot;</span>
       <span class="ruby-identifier">s</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{k}=&quot;</span>, <span class="ruby-identifier">v</span>)
@@ -798,7 +803,7 @@
 
           
           <div class="method-source-code" id="verbose-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 178</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 182</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verbose?</span>
   <span class="ruby-ivar">@verbose</span>
 <span class="ruby-keyword">end</span></pre>
@@ -833,7 +838,7 @@
 
           
           <div class="method-source-code" id="write-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 186</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 190</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write?</span>
   <span class="ruby-ivar">@write</span>
 <span class="ruby-keyword">end</span></pre>
@@ -868,9 +873,9 @@
 
           
           <div class="method-source-code" id="write_file-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 145</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 149</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_file</span>
-  <span class="ruby-identifier">echo</span> <span class="ruby-string">&#39;  Writing file&#39;</span>
+  <span class="ruby-identifier">echo</span> <span class="ruby-string">&#39;Writing file&#39;</span>
   <span class="ruby-identifier">standup</span>.<span class="ruby-identifier">write</span>
 <span class="ruby-keyword">end</span></pre>
           </div>

data/doc/created.rid

@@ -1,8 +1,5 @@
-Fri, 01 May 2020 08:41:04 -0500
-README.md	Wed, 29 Apr 2020 20:22:26 -0500
-lib/standup_md.rb	Fri, 01 May 2020 08:39:43 -0500
-lib/standup_md/cli.rb	Thu, 30 Apr 2020 21:55:46 -0500
-lib/standup_md/version.rb	Wed, 29 Apr 2020 20:22:26 -0500
-test/standup_md/cli_test.rb	Thu, 30 Apr 2020 23:02:56 -0500
-test/standup_md_test.rb	Thu, 23 Apr 2020 22:53:37 -0500
-test/test_helper.rb	Wed, 29 Apr 2020 20:22:26 -0500
+Sat, 02 May 2020 12:37:06 -0500
+README.md	Sat, 02 May 2020 11:32:07 -0500
+lib/standup_md.rb	Sat, 02 May 2020 12:26:15 -0500
+lib/standup_md/cli.rb	Fri, 01 May 2020 23:28:15 -0500
+lib/standup_md/version.rb	Fri, 01 May 2020 08:57:49 -0500

data/doc/index.html

@@ -76,12 +76,6 @@
   
     <li><a href="./StandupMD/Cli.html">StandupMD::Cli</a>
   
-    <li><a href="./TestCli.html">TestCli</a>
-  
-    <li><a href="./TestHelper.html">TestHelper</a>
-  
-    <li><a href="./TestStandupMD.html">TestStandupMD</a>
-  
   </ul>
 </div>
 
@@ -117,6 +111,8 @@
 </li><li>
 <p><a href="#customization-and-runtime-options">Customization and Runtime Options</a></p>
 </li><li>
+<p><a href="#using-existing-standup-files">Using existing standup files</a></p>
+</li><li>
 <p><a href="#api">API</a></p>
 </li><li>
 <p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
@@ -246,30 +242,75 @@ sub_header_order:
 
 <pre>standup --no-edit --current-entry-tasks=&quot;Work on this thing&quot;,&quot;And another thing!&quot;</pre>
 
+<h3 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></h3>
+
+<p>If you already have a directory of existing standup files, you can use them, but they must be in a format that the parser can understand. The default is:</p>
+
+<pre># 2020-05-01
+## Previous
+- task
+## Current
+- task
+## Impediments
+- impediment
+## Notes
+- notes, if any are present</pre>
+
+<p>The order, words, date format, and header level are all customizable, but the overall format must be the same. If customization is necessary, this must be done in <code>~/.standup_md.yml</code> before execution, or else the parser will error.</p>
+
+<p>For example, if you wanted the format to be as follows:</p>
+
+<pre>## 05/01/2020
+### Today
+- task
+### Yesterday
+- task
+### Hold-ups
+- impediment
+### Notes
+- notes, if any are present</pre>
+
+<p>Your <code>~/.standup_md.yml</code> should contain:</p>
+
+<pre>sub_header_depth:    3
+header_depth:        2
+current_header:      Today
+previous_header:     Yesterday
+impediments_header:  Hold-ups
+header_date_format:  &#39;%m/%d/%Y&#39;
+sub_header_order:
+  - current
+  - previous
+  - impediments
+  - notes</pre>
+
 <h2 id="label-API">API<span><a href="#label-API">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>Below are some quick examples, but the API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">documentation</a>.</p>
 
-<p>This was mainly written as a command line utility, but I made the API available for scripting. There are attribute accessors for most of the settings in the <a href="#customization-and-runtime-options">customization table</a> above. To view all available methods, read the comments in the <a href="lib/standup_md.rb">source</a>. A quick-and-dirty example of how to write a new entry via code could look like the following:</p>
+<p>This was mainly written as a command line utility, but I made the API available for scripting. There are attribute accessors for most of the settings in the <a href="#customization-and-runtime-options">customization table</a> above. A quick example of how to write a new entry via code could look like 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">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span>(
-  <span class="ruby-value">current_header:</span> <span class="ruby-string">&#39;Today&#39;</span>,
-  <span class="ruby-value">current_entry_tasks:</span> [<span class="ruby-string">&#39;Thing to do today&#39;</span>, <span class="ruby-string">&#39;Another thing to do today&#39;</span>],
-  <span class="ruby-value">impediments:</span> [<span class="ruby-string">&#39;Not enough time in the day&#39;</span>]
-)
+<span class="ruby-identifier">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
+  <span class="ruby-identifier">s</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Today&#39;</span>,
+  <span class="ruby-identifier">s</span>.<span class="ruby-identifier">current_entry_tasks</span> = [<span class="ruby-string">&#39;Thing to do today&#39;</span>, <span class="ruby-string">&#39;Another thing to do today&#39;</span>],
+  <span class="ruby-identifier">s</span>.<span class="ruby-identifier">impediments</span> = [<span class="ruby-string">&#39;Not enough time in the day&#39;</span>]
+<span class="ruby-keyword">end</span>
 
 <span class="ruby-identifier">standup</span>.<span class="ruby-identifier">write</span>
 </pre>
 
+<p>Note: <code>StandupMD::load() { ... }</code> just is a quick way to call <code>StandupMD::new { ... }.load</code>.</p>
+
 <p>Entries are just hashes, so you can easily transform them to <code>json</code> objects.</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;json&#39;</span>
 
 <span class="ruby-identifier">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span>
-<span class="ruby-identifier">standup_entries_as_json</span> = <span class="ruby-identifier">standup</span>.<span class="ruby-identifier">all_entries</span>.<span class="ruby-identifier">to_json</span>
+
+<span class="ruby-identifier">standup_json</span> = <span class="ruby-identifier">standup</span>.<span class="ruby-identifier">all_entries</span>.<span class="ruby-identifier">to_json</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>

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["standupmd","cli","testcli","testhelper","teststandupmd","append_previous?()","append_to_previous_entry_tasks()","bullet_character=()","cli()","create_standup_file()","current_entry_tasks=()","directory=()","echo()","edit()","edit?()","editor()","entry_previously_added?()","execute()","file_written?()","fixtures()","header_depth=()","impediments=()","json?()","load()","load()","new()","new()","new_month?()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","setup()","setup()","should_append?()","should_append?()","standup()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","teardown()","teardown()","test_preference_file()","test_version()","test_all_previous_entries()","test_append_previous?()","test_bullet_character()","test_class_load()","test_current_entry()","test_current_entry_tasks()","test_current_header()","test_directory()","test_edit?()","test_editor()","test_entry_previously_added?()","test_file()","test_file_name_format()","test_file_written?()","test_header_date_format()","test_header_depth()","test_impediments()","test_impediments_header()","test_initialize()","test_json?()","test_load()","test_notes()","test_notes_header()","test_options()","test_preferences()","test_previous_entry_tasks()","test_previous_file_when_current_and_previous_month_do_not_exist()","test_previous_file_when_current_month_file_does_not_exist_but_previous_does()","test_previous_file_when_entry_exists_for_today()","test_previous_header()","test_print_all_entries?()","test_print_current_entry?()","test_reload()","test_self_execute()","test_setting_attributes_via_block()","test_standup()","test_sub_header_depth()","test_sub_header_order()","test_verbose?()","test_write()","test_write?()","verbose?()","write()","write?()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","testcli","testhelper","teststandupmd","standupmd::cli#append_previous?()","standupmd::cli#append_to_previous_entry_tasks()","standupmd#bullet_character=()","testhelper#cli()","testhelper#create_standup_file()","standupmd#current_entry_tasks=()","standupmd#directory=()","standupmd::cli#echo()","standupmd::cli#edit()","standupmd::cli#edit?()","standupmd::cli#editor()","standupmd#entry_previously_added?()","standupmd::cli::execute()","standupmd#file_written?()","testhelper#fixtures()","standupmd#header_depth=()","standupmd#impediments=()","standupmd::cli#json?()","standupmd#load()","standupmd::load()","standupmd::new()","standupmd::cli::new()","standupmd#new_month?()","standupmd#notes=()","standupmd#previous_entry_tasks=()","standupmd::cli#print_all_entries()","standupmd::cli#print_all_entries?()","standupmd::cli#print_current_entry()","standupmd::cli#print_current_entry?()","standupmd#reload()","testcli#setup()","teststandupmd#setup()","standupmd::cli#should_append?()","testcli#should_append?()","standupmd::cli#standup()","testhelper#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","testcli#teardown()","teststandupmd#teardown()","testcli#test_preference_file()","teststandupmd#test_version()","teststandupmd#test_all_previous_entries()","testcli#test_append_previous?()","teststandupmd#test_bullet_character()","teststandupmd#test_class_load()","teststandupmd#test_current_entry()","teststandupmd#test_current_entry_tasks()","teststandupmd#test_current_header()","teststandupmd#test_directory()","testcli#test_edit?()","testcli#test_editor()","teststandupmd#test_entry_previously_added?()","teststandupmd#test_file()","teststandupmd#test_file_name_format()","teststandupmd#test_file_written?()","teststandupmd#test_header_date_format()","teststandupmd#test_header_depth()","teststandupmd#test_impediments()","teststandupmd#test_impediments_header()","testcli#test_initialize()","testcli#test_json?()","teststandupmd#test_load()","teststandupmd#test_notes()","teststandupmd#test_notes_header()","testcli#test_options()","testcli#test_preferences()","teststandupmd#test_previous_entry_tasks()","teststandupmd#test_previous_file_when_current_and_previous_month_do_not_exist()","teststandupmd#test_previous_file_when_current_month_file_does_not_exist_but_previous_does()","teststandupmd#test_previous_file_when_entry_exists_for_today()","teststandupmd#test_previous_header()","testcli#test_print_all_entries?()","testcli#test_print_current_entry?()","teststandupmd#test_reload()","testcli#test_self_execute()","teststandupmd#test_setting_attributes_via_block()","testcli#test_standup()","teststandupmd#test_sub_header_depth()","teststandupmd#test_sub_header_order()","testcli#test_verbose?()","teststandupmd#test_write()","testcli#test_write?()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The class for handing reading/writing of entries.\n<p>@example\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">su</span> = <span class=\"ruby-constant\">StandupMD</span>.<span class=\"ruby-identifier\">new</span>\n</pre>\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["TestCli","","TestCli.html","","<p>The test suite for <code>Cli</code>.\n"],["TestHelper","","TestHelper.html","","<p>Module to include in tests that provides helper functions.\n"],["TestStandupMD","","TestStandupMD.html","","<p>The test suite for <code>StandupMD</code>.\n"],["append_previous?","StandupMD::Cli","StandupMD/Cli.html#method-i-append_previous-3F","()","<p>Should `previous_entry_tasks` be appended? If false, <code>previous_entry_tasks</code> will be overwritten.\n<p>@return …\n"],["append_to_previous_entry_tasks","StandupMD::Cli","StandupMD/Cli.html#method-i-append_to_previous_entry_tasks","()","<p>Appends entries passed at runtime to existing previous entries.\n<p>@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["cli","TestHelper","TestHelper.html#method-i-cli","(options = [])","<p>Creates instance of <code>Cli</code>.\n<p>@param [Array] options Parsed by <code>getopts</code>\n<p>@return [StandupMD::Cli]\n"],["create_standup_file","TestHelper","TestHelper.html#method-i-create_standup_file","(file, fixture = 'previous_entry')","<p>Creates the standup file with entries.\n<p>@param [String] file The name of the file to create\n<p>@param [String] …\n"],["current_entry_tasks=","StandupMD","StandupMD.html#method-i-current_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["directory=","StandupMD","StandupMD.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn&#39;t …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Prints output if <code>verbose</code> is true.\n<p>@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","<p>Opens the file in an editor. Abandons the script.\n"],["edit?","StandupMD::Cli","StandupMD/Cli.html#method-i-edit-3F","()","<p>Should the standup file be opened in the editor?\n<p>@return [Boolean] Default is true\n"],["editor","StandupMD::Cli","StandupMD/Cli.html#method-i-editor","()","<p>Tries to determine the editor, first by checking if the user has one set in their preferences. If not, …\n"],["entry_previously_added?","StandupMD","StandupMD.html#method-i-entry_previously_added-3F","()","<p>Was today&#39;s entry already in the file?\n<p>@return [boolean] true if today&#39;s entry was already in …\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n"],["file_written?","StandupMD","StandupMD.html#method-i-file_written-3F","()","<p>Has the file been written since instantiated?\n<p>@return [boolean]\n<p>@example\n"],["fixtures","TestHelper","TestHelper.html#method-i-fixtures","()","<p>Reads the fixtures in as a hash.\n<p>@return [Hash]\n"],["header_depth=","StandupMD","StandupMD.html#method-i-header_depth-3D","(depth)","<p>Number of octothorps (#) to use before the main header.\n<p>@param [Integer] depth\n<p>@return [Integer]\n"],["impediments=","StandupMD","StandupMD.html#method-i-impediments-3D","(tasks)","<p>Setter for impediments.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["json?","StandupMD::Cli","StandupMD/Cli.html#method-i-json-3F","()","<p>If printing an entry, should it be printed as json?\n<p>@return [Boolean] Default is false\n"],["load","StandupMD","StandupMD.html#method-i-load","()","<p>Sets internal instance variables. Called when first instantiated, or after directory is set.\n<p>@return [self] …\n"],["load","StandupMD","StandupMD.html#method-c-load","(attributes = {})","<p>Convenience method for calling <code>new</code> + <code>load</code>\n<p>@param [Hash] attributes Attributes to set before loading.\n<p>@example …\n"],["new","StandupMD","StandupMD.html#method-c-new","()","<p>Constructor. Yields the instance so you can pass a block to access setters.\n<p>@return [self]\n<p>@example\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new_month?","StandupMD","StandupMD.html#method-i-new_month-3F","()","<p>Is today a different month than the previous entry?\n"],["notes=","StandupMD","StandupMD.html#method-i-notes-3D","(tasks)","<p>Setter for notes.\n<p>@param [Array] notes\n<p>@return [Array]\n"],["previous_entry_tasks=","StandupMD","StandupMD.html#method-i-previous_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["print_all_entries","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries","()","<p>Prints all entries to the command line.\n<p>@return [nil]\n"],["print_all_entries?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries-3F","()","<p>Should all entries be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["print_current_entry","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry","()","<p>Prints the current entry to the command line.\n<p>@return [nil]\n"],["print_current_entry?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry-3F","()","<p>Should current entry be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["reload","StandupMD","StandupMD.html#method-i-reload","()","<p>Alias of <code>load</code>\n<p>@return [self]\n"],["setup","TestCli","TestCli.html#method-i-setup","()","<p>Set working directory, current month&#39;s file, and last month&#39;s file, which will be created and …\n"],["setup","TestStandupMD","TestStandupMD.html#method-i-setup","()","<p>Set working directory, current month&#39;s file, and last month&#39;s file, which will be created and …\n"],["should_append?","StandupMD::Cli","StandupMD/Cli.html#method-i-should_append-3F","()","<p>Did the user pass <code>previous_entry_tasks</code>, and should we append?\n<p>@return [Boolean]\n"],["should_append?","TestCli","TestCli.html#method-i-should_append-3F","()","<p>True only if <code>--no-append</code> and <code>--previous-entry-tasks</code> are passed.\n"],["standup","StandupMD::Cli","StandupMD/Cli.html#method-i-standup","()","<p>Sets up an instance of <code>StandupMD</code> and passes all user preferences.\n<p>@return [StandupMD]\n"],["standup","TestHelper","TestHelper.html#method-i-standup","(directory, args = {})","<p>Creates <code>StandupUP</code> instance. Directory must be passed, usually a subdirectory of <code>test</code>, so we don&#39;t …\n"],["sub_header_depth=","StandupMD","StandupMD.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["sub_header_order","StandupMD","StandupMD.html#method-i-sub_header_order","()","<p>Return a copy of the sub-header order so the user can&#39;t modify the array.\n<p>@return [Array]\n"],["sub_header_order=","StandupMD","StandupMD.html#method-i-sub_header_order-3D","(array)","<p>Preferred order for sub-headers.\n<p>@param [Array] Values must be %w[previous current impediment notes]\n<p>@return …\n"],["teardown","TestCli","TestCli.html#method-i-teardown","()","<p>Destroy the working directory and its contents.\n"],["teardown","TestStandupMD","TestStandupMD.html#method-i-teardown","()","<p>Destroy the working directory and its contents.\n"],["test_PREFERENCE_FILE","TestCli","TestCli.html#method-i-test_PREFERENCE_FILE","()","<p>The user&#39;s preference file is a string.\n"],["test_VERSION","TestStandupMD","TestStandupMD.html#method-i-test_VERSION","()","<p><code>StandupMD::VERSION</code> should consist of three integers separated by dots.\n"],["test_all_previous_entries","TestStandupMD","TestStandupMD.html#method-i-test_all_previous_entries","()","<p>Should be all entries before the current entry.\n"],["test_append_previous?","TestCli","TestCli.html#method-i-test_append_previous-3F","()","<p>True by default. False if flag is passed.\n"],["test_bullet_character","TestStandupMD","TestStandupMD.html#method-i-test_bullet_character","()","<p>Should be able to change the bullet character but should raise if not * or -\n"],["test_class_load","TestStandupMD","TestStandupMD.html#method-i-test_class_load","()","<p>Make sure load accepts a hash of attributes, sets them, and returns an instance of itself.\n"],["test_current_entry","TestStandupMD","TestStandupMD.html#method-i-test_current_entry","()","<p><code>current_entry</code> should be a hash. If <code>file</code> already has an entry for today, it will be read and used as  …\n"],["test_current_entry_tasks","TestStandupMD","TestStandupMD.html#method-i-test_current_entry_tasks","()","<p>Should be able to add tasks for current_entry.\n"],["test_current_header","TestStandupMD","TestStandupMD.html#method-i-test_current_header","()","<p>Should be changeable and used as the header for <code>current_entry</code>\n"],["test_directory","TestStandupMD","TestStandupMD.html#method-i-test_directory","()","<p>Directory should default be settable, and where standup files are read from.\n"],["test_edit?","TestCli","TestCli.html#method-i-test_edit-3F","()","<p>True by default. False if flag is passed.\n"],["test_editor","TestCli","TestCli.html#method-i-test_editor","()","<p>The editor should be set by preferences, or env, or set to &#39;vim&#39;.\n"],["test_entry_previously_added?","TestStandupMD","TestStandupMD.html#method-i-test_entry_previously_added-3F","()","<p>Should be true if <code>current_entry</code> was in the file at the time it was read.\n"],["test_file","TestStandupMD","TestStandupMD.html#method-i-test_file","()","<p>The file name should equal file_name_format parsed by Date.strftime. The default is Date.today.strftime(&#39;%Y_%m.md&#39;) …\n"],["test_file_name_format","TestStandupMD","TestStandupMD.html#method-i-test_file_name_format","()","<p>Should be changeable, and return a string parsed by <code>strftime</code>.\n"],["test_file_written?","TestStandupMD","TestStandupMD.html#method-i-test_file_written-3F","()","<p>Should be false when first instantiated, true after <code>write</code> is called.\n"],["test_header_date_format","TestStandupMD","TestStandupMD.html#method-i-test_header_date_format","()","<p>Should be changeable, and return a string parsed by <code>strftime</code>.\n"],["test_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_header_depth","()","<p>Should be an integer between <code>1..5</code>, but not higher than <code>sub_header_depth</code>.\n"],["test_impediments","TestStandupMD","TestStandupMD.html#method-i-test_impediments","()","<p>Should be able to add impediments to the array.\n"],["test_impediments_header","TestStandupMD","TestStandupMD.html#method-i-test_impediments_header","()","<p>Should be changeable and used as the header for <code>impediments</code>\n"],["test_initialize","TestCli","TestCli.html#method-i-test_initialize","()","<p>The <code>initialize</code> method should accept the same parameters as <code>exectute</code>.\n"],["test_json?","TestCli","TestCli.html#method-i-test_json-3F","()","<p>False by default. True if flag is passed.\n"],["test_load","TestStandupMD","TestStandupMD.html#method-i-test_load","()","<p>Should load instance variables.\n"],["test_notes","TestStandupMD","TestStandupMD.html#method-i-test_notes","()","<p>Should be able to add notes to the array.\n"],["test_notes_header","TestStandupMD","TestStandupMD.html#method-i-test_notes_header","()","<p>Should be changeable and used as the header for <code>notes</code>\n"],["test_options","TestCli","TestCli.html#method-i-test_options","()","<p>The <code>options</code> should be an array of options passed from the command line.\n"],["test_preferences","TestCli","TestCli.html#method-i-test_preferences","()","<p>The <code>preferences</code> are the settings after <code>options</code> are parsed.\n"],["test_previous_entry_tasks","TestStandupMD","TestStandupMD.html#method-i-test_previous_entry_tasks","()","<p>Should be an array of previous entry&#39;s current entry.\n"],["test_previous_file_when_current_and_previous_month_do_not_exist","TestStandupMD","TestStandupMD.html#method-i-test_previous_file_when_current_and_previous_month_do_not_exist","()","<p>When neither last month&#39;s file, nor this month&#39;s file exist, previous_file should be an empty …\n"],["test_previous_file_when_current_month_file_does_not_exist_but_previous_does","TestStandupMD","TestStandupMD.html#method-i-test_previous_file_when_current_month_file_does_not_exist_but_previous_does","()","<p>When last month&#39;s file exists, but this month&#39;s doesn&#39;t or is empty, previous_file should …\n"],["test_previous_file_when_entry_exists_for_today","TestStandupMD","TestStandupMD.html#method-i-test_previous_file_when_entry_exists_for_today","()","<p>If there are previous entries for this month, previous file will be this month&#39;s file.\n"],["test_previous_header","TestStandupMD","TestStandupMD.html#method-i-test_previous_header","()","<p>Should be changeable and used as the header for <code>previous_entry</code>\n"],["test_print_all_entries?","TestCli","TestCli.html#method-i-test_print_all_entries-3F","()","<p>False by default. True if flag is passed.\n"],["test_print_current_entry?","TestCli","TestCli.html#method-i-test_print_current_entry-3F","()","<p>False by default. True if flag is passed.\n"],["test_reload","TestStandupMD","TestStandupMD.html#method-i-test_reload","()","<p>The reload method should exist, and is an alias of <code>load</code>.\n"],["test_self_execute","TestCli","TestCli.html#method-i-test_self_execute","()","<p>The <code>execute</code> method is the entry point for the Cli. It&#39;s parameter is an array of command-line flags …\n"],["test_setting_attributes_via_block","TestStandupMD","TestStandupMD.html#method-i-test_setting_attributes_via_block","()","<p>Attributes should be able to be set if you pass a block at instantiation.\n"],["test_standup","TestCli","TestCli.html#method-i-test_standup","()","<p>Creates the instance of <code>StandupMD</code>.\n"],["test_sub_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_depth","()","<p>Should be an integer between <code>2..6</code>, but not lower than <code>header_depth</code>.\n"],["test_sub_header_order","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_order","()","<p>The order of the subheaders is changeable, but all elements must exist.\n"],["test_verbose?","TestCli","TestCli.html#method-i-test_verbose-3F","()","<p>False by default. True if flag is passed.\n"],["test_write","TestStandupMD","TestStandupMD.html#method-i-test_write","()","<p>Should write the file.\n"],["test_write?","TestCli","TestCli.html#method-i-test_write-3F","()","<p>True by default. False if flag is passed.\n"],["verbose?","StandupMD::Cli","StandupMD/Cli.html#method-i-verbose-3F","()","<p>Should debug info be printed?\n<p>@return [Boolean] Default is false\n"],["write","StandupMD","StandupMD.html#method-i-write","()","<p>Writes a new entry to the file if the first entry in the file isn&#39;t today.\n<p>@return [Boolean]\n"],["write?","StandupMD::Cli","StandupMD/Cli.html#method-i-write-3F","()","<p>Should the file be written?\n<p>@return [Boolean] Default is true\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","<p>Writes entries to the file.\n<p>@return [Boolean] true if file was written\n"],["README","","README_md.html","","<p>The Standup Doctor\n\n<blockquote><p>The cure for all your standup woes.\n</blockquote>\n<p>A highly customizable and automated way to keep …\n"]]}}
+var search_data = {"index":{"searchIndex":["standupmd","cli","append_previous?()","append_to_previous_entry_tasks()","bullet_character=()","config_file=()","config_file_loaded?()","current_entry_tasks=()","directory=()","echo()","edit()","edit?()","editor()","entry_previously_added?()","execute()","file_written?()","header_depth=()","impediments=()","json?()","load()","load()","load_config_file()","new()","new()","new_month?()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","should_append?()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","verbose?()","write()","write?()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli#append_previous?()","standupmd::cli#append_to_previous_entry_tasks()","standupmd#bullet_character=()","standupmd#config_file=()","standupmd#config_file_loaded?()","standupmd#current_entry_tasks=()","standupmd#directory=()","standupmd::cli#echo()","standupmd::cli#edit()","standupmd::cli#edit?()","standupmd::cli#editor()","standupmd#entry_previously_added?()","standupmd::cli::execute()","standupmd#file_written?()","standupmd#header_depth=()","standupmd#impediments=()","standupmd::cli#json?()","standupmd::load()","standupmd#load()","standupmd#load_config_file()","standupmd::new()","standupmd::cli::new()","standupmd#new_month?()","standupmd#notes=()","standupmd#previous_entry_tasks=()","standupmd::cli#print_all_entries()","standupmd::cli#print_all_entries?()","standupmd::cli#print_current_entry()","standupmd::cli#print_current_entry?()","standupmd#reload()","standupmd::cli#should_append?()","standupmd::cli#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The class for handing reading/writing of entries.\n<p>@example\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">su</span> = <span class=\"ruby-constant\">StandupMD</span>.<span class=\"ruby-identifier\">new</span>\n</pre>\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["append_previous?","StandupMD::Cli","StandupMD/Cli.html#method-i-append_previous-3F","()","<p>Should `previous_entry_tasks` be appended? If false, <code>previous_entry_tasks</code> will be overwritten.\n<p>@return …\n"],["append_to_previous_entry_tasks","StandupMD::Cli","StandupMD/Cli.html#method-i-append_to_previous_entry_tasks","()","<p>Appends entries passed at runtime to existing previous entries.\n<p>@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["config_file=","StandupMD","StandupMD.html#method-i-config_file-3D","(config_file)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn&#39;t …\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-i-config_file_loaded-3F","()","<p>Has a config file been loaded?\n<p>@return [Boolean]\n"],["current_entry_tasks=","StandupMD","StandupMD.html#method-i-current_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["directory=","StandupMD","StandupMD.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn&#39;t …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Prints output if <code>verbose</code> is true.\n<p>@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","<p>Opens the file in an editor. Abandons the script.\n"],["edit?","StandupMD::Cli","StandupMD/Cli.html#method-i-edit-3F","()","<p>Should the standup file be opened in the editor?\n<p>@return [Boolean] Default is true\n"],["editor","StandupMD::Cli","StandupMD/Cli.html#method-i-editor","()","<p>Tries to determine the editor, first by checking if the user has one set in their preferences. If not, …\n"],["entry_previously_added?","StandupMD","StandupMD.html#method-i-entry_previously_added-3F","()","<p>Was today&#39;s entry already in the file?\n<p>@return [boolean] true if today&#39;s entry was already in …\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n"],["file_written?","StandupMD","StandupMD.html#method-i-file_written-3F","()","<p>Has the file been written since instantiated?\n<p>@return [boolean]\n<p>@example\n"],["header_depth=","StandupMD","StandupMD.html#method-i-header_depth-3D","(depth)","<p>Number of octothorps (#) to use before the main header.\n<p>@param [Integer] depth\n<p>@return [Integer]\n"],["impediments=","StandupMD","StandupMD.html#method-i-impediments-3D","(tasks)","<p>Setter for impediments.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["json?","StandupMD::Cli","StandupMD/Cli.html#method-i-json-3F","()","<p>If printing an entry, should it be printed as json?\n<p>@return [Boolean] Default is false\n"],["load","StandupMD","StandupMD.html#method-c-load","(config_file = nil)","<p>Convenience method for calling <code>new</code> + <code>load</code>. Accepts a <code>YAML</code> config file as an argument, and yields the …\n"],["load","StandupMD","StandupMD.html#method-i-load","()","<p>Sets internal instance variables. Called when first instantiated, or after directory is set.\n<p>@return [self] …\n"],["load_config_file","StandupMD","StandupMD.html#method-i-load_config_file","()","<p>Loads the config file\n<p>@return [Hash] The config options\n"],["new","StandupMD","StandupMD.html#method-c-new","(config_file = nil)","<p>Constructor. Takes a path to a <code>YAML</code> configuration file as an argument. If passed, settings from the config …\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new_month?","StandupMD","StandupMD.html#method-i-new_month-3F","()","<p>Is today a different month than the previous entry?\n"],["notes=","StandupMD","StandupMD.html#method-i-notes-3D","(tasks)","<p>Setter for notes.\n<p>@param [Array] notes\n<p>@return [Array]\n"],["previous_entry_tasks=","StandupMD","StandupMD.html#method-i-previous_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["print_all_entries","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries","()","<p>Prints all entries to the command line.\n<p>@return [nil]\n"],["print_all_entries?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries-3F","()","<p>Should all entries be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["print_current_entry","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry","()","<p>Prints the current entry to the command line.\n<p>@return [nil]\n"],["print_current_entry?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry-3F","()","<p>Should current entry be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["reload","StandupMD","StandupMD.html#method-i-reload","()","<p>Alias of <code>load</code>\n<p>@return [self]\n"],["should_append?","StandupMD::Cli","StandupMD/Cli.html#method-i-should_append-3F","()","<p>Did the user pass <code>previous_entry_tasks</code>, and should we append?\n<p>@return [Boolean]\n"],["standup","StandupMD::Cli","StandupMD/Cli.html#method-i-standup","()","<p>Sets up an instance of <code>StandupMD</code> and passes all user preferences.\n<p>@return [StandupMD]\n"],["sub_header_depth=","StandupMD","StandupMD.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["sub_header_order","StandupMD","StandupMD.html#method-i-sub_header_order","()","<p>Return a copy of the sub-header order so the user can&#39;t modify the array.\n<p>@return [Array]\n"],["sub_header_order=","StandupMD","StandupMD.html#method-i-sub_header_order-3D","(array)","<p>Preferred order for sub-headers.\n<p>@param [Array] Values must be %w[previous current impediment notes]\n<p>@return …\n"],["verbose?","StandupMD::Cli","StandupMD/Cli.html#method-i-verbose-3F","()","<p>Should debug info be printed?\n<p>@return [Boolean] Default is false\n"],["write","StandupMD","StandupMD.html#method-i-write","()","<p>Writes a new entry to the file if the first entry in the file isn&#39;t today.\n<p>@return [Boolean]\n"],["write?","StandupMD::Cli","StandupMD/Cli.html#method-i-write-3F","()","<p>Should the file be written?\n<p>@return [Boolean] Default is true\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","<p>Writes entries to the file.\n<p>@return [Boolean] true if file was written\n"],["README","","README_md.html","","<p>The Standup Doctor\n\n<blockquote><p>The cure for all your standup woes.\n</blockquote>\n<p>A highly customizable and automated way to keep …\n"]]}}

data/doc/table_of_contents.html

@@ -59,6 +59,8 @@
 
       <li><a href="README_md.html#label-Executable+Flags">Executable Flags</a>
 
+      <li><a href="README_md.html#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
+
       <li><a href="README_md.html#label-API">API</a>
 
       <li><a href="README_md.html#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
@@ -84,12 +86,6 @@
 
       <li><a href="StandupMD.html#Attributes+with+default+getters+and+setters.">Attributes with default getters and setters.</a>
 
-      <li><a href="StandupMD.html#Booleans">Booleans</a>
-
-      <li><a href="StandupMD.html#Custom+setters">Custom setters</a>
-
-      <li><a href="StandupMD.html#Misc">Misc</a>
-
     </ul>
 
   </li>
@@ -99,21 +95,6 @@
 
   </li>
 
-  <li class="class">
-    <a href="TestCli.html">TestCli</a>
-
-  </li>
-
-  <li class="module">
-    <a href="TestHelper.html">TestHelper</a>
-
-  </li>
-
-  <li class="class">
-    <a href="TestStandupMD.html">TestStandupMD</a>
-
-  </li>
-
 </ul>
 
 <h2 id="methods">Methods</h2>
@@ -155,14 +136,14 @@
     <span class="container">StandupMD</span>
 
   <li class="method">
-    <a href="TestHelper.html#method-i-cli">#cli</a>
+    <a href="StandupMD.html#method-i-config_file-3D">#config_file=</a>
     &mdash;
-    <span class="container">TestHelper</span>
+    <span class="container">StandupMD</span>
 
   <li class="method">
-    <a href="TestHelper.html#method-i-create_standup_file">#create_standup_file</a>
+    <a href="StandupMD.html#method-i-config_file_loaded-3F">#config_file_loaded?</a>
     &mdash;
-    <span class="container">TestHelper</span>
+    <span class="container">StandupMD</span>
 
   <li class="method">
     <a href="StandupMD.html#method-i-current_entry_tasks-3D">#current_entry_tasks=</a>
@@ -204,11 +185,6 @@
     &mdash;
     <span class="container">StandupMD</span>
 
-  <li class="method">
-    <a href="TestHelper.html#method-i-fixtures">#fixtures</a>
-    &mdash;
-    <span class="container">TestHelper</span>
-
   <li class="method">
     <a href="StandupMD.html#method-i-header_depth-3D">#header_depth=</a>
     &mdash;
@@ -229,6 +205,11 @@
     &mdash;
     <span class="container">StandupMD</span>
 
+  <li class="method">
+    <a href="StandupMD.html#method-i-load_config_file">#load_config_file</a>
+    &mdash;
+    <span class="container">StandupMD</span>
+
   <li class="method">
     <a href="StandupMD.html#method-i-new_month-3F">#new_month?</a>
     &mdash;
@@ -269,31 +250,11 @@
     &mdash;
     <span class="container">StandupMD</span>
 
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-setup">#setup</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-setup">#setup</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-should_append-3F">#should_append?</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
   <li class="method">
     <a href="StandupMD/Cli.html#method-i-should_append-3F">#should_append?</a>
     &mdash;
     <span class="container">StandupMD::Cli</span>
 
-  <li class="method">
-    <a href="TestHelper.html#method-i-standup">#standup</a>
-    &mdash;
-    <span class="container">TestHelper</span>
-
   <li class="method">
     <a href="StandupMD/Cli.html#method-i-standup">#standup</a>
     &mdash;
@@ -314,231 +275,6 @@
     &mdash;
     <span class="container">StandupMD</span>
 
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-teardown">#teardown</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-teardown">#teardown</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_PREFERENCE_FILE">#test_PREFERENCE_FILE</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_VERSION">#test_VERSION</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_all_previous_entries">#test_all_previous_entries</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_append_previous-3F">#test_append_previous?</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_bullet_character">#test_bullet_character</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_class_load">#test_class_load</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_current_entry">#test_current_entry</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_current_entry_tasks">#test_current_entry_tasks</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_current_header">#test_current_header</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_directory">#test_directory</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_edit-3F">#test_edit?</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_editor">#test_editor</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_entry_previously_added-3F">#test_entry_previously_added?</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_file">#test_file</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_file_name_format">#test_file_name_format</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_file_written-3F">#test_file_written?</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_header_date_format">#test_header_date_format</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_header_depth">#test_header_depth</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_impediments">#test_impediments</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_impediments_header">#test_impediments_header</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_initialize">#test_initialize</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_json-3F">#test_json?</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_load">#test_load</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_notes">#test_notes</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_notes_header">#test_notes_header</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_options">#test_options</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_preferences">#test_preferences</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_previous_entry_tasks">#test_previous_entry_tasks</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_previous_file_when_current_and_previous_month_do_not_exist">#test_previous_file_when_current_and_previous_month_do_not_exist</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_previous_file_when_current_month_file_does_not_exist_but_previous_does">#test_previous_file_when_current_month_file_does_not_exist_but_previous_does</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_previous_file_when_entry_exists_for_today">#test_previous_file_when_entry_exists_for_today</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_previous_header">#test_previous_header</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_print_all_entries-3F">#test_print_all_entries?</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_print_current_entry-3F">#test_print_current_entry?</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_reload">#test_reload</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_self_execute">#test_self_execute</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_setting_attributes_via_block">#test_setting_attributes_via_block</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_standup">#test_standup</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_sub_header_depth">#test_sub_header_depth</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_sub_header_order">#test_sub_header_order</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_verbose-3F">#test_verbose?</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
-  <li class="method">
-    <a href="TestStandupMD.html#method-i-test_write">#test_write</a>
-    &mdash;
-    <span class="container">TestStandupMD</span>
-
-  <li class="method">
-    <a href="TestCli.html#method-i-test_write-3F">#test_write?</a>
-    &mdash;
-    <span class="container">TestCli</span>
-
   <li class="method">
     <a href="StandupMD/Cli.html#method-i-verbose-3F">#verbose?</a>
     &mdash;