standup_md 0.1.1 → 0.3.0

data/doc/created.rid

@@ -1,8 +1,15 @@
-Wed, 29 Apr 2020 17:09:38 -0500
-README.md	Wed, 29 Apr 2020 16:51:59 -0500
-lib/standup_md.rb	Mon, 27 Apr 2020 22:21:05 -0500
-lib/standup_md/cli.rb	Wed, 29 Apr 2020 17:08:28 -0500
-lib/standup_md/version.rb	Mon, 27 Apr 2020 22:25:50 -0500
-test/standup_md/cli_test.rb	Wed, 29 Apr 2020 17:08:56 -0500
-test/standup_md_test.rb	Thu, 23 Apr 2020 22:53:37 -0500
-test/test_helper.rb	Wed, 29 Apr 2020 17:09:31 -0500
+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

data/doc/index.html

@@ -76,9 +76,23 @@
   
     <li><a href="./StandupMD/Cli.html">StandupMD::Cli</a>
   
-    <li><a href="./TestHelper.html">TestHelper</a>
+    <li><a href="./StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
   
-    <li><a href="./TestStandupMD.html">TestStandupMD</a>
+    <li><a href="./StandupMD/Config.html">StandupMD::Config</a>
+  
+    <li><a href="./StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
+  
+    <li><a href="./StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
+  
+    <li><a href="./StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
+  
+    <li><a href="./StandupMD/Config/File.html">StandupMD::Config::File</a>
+  
+    <li><a href="./StandupMD/Entry.html">StandupMD::Entry</a>
+  
+    <li><a href="./StandupMD/EntryList.html">StandupMD::EntryList</a>
+  
+    <li><a href="./StandupMD/File.html">StandupMD::File</a>
   
   </ul>
 </div>
@@ -91,6 +105,8 @@
 
 <h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+Standup+Doctor">&para;</a> <a href="#top">&uarr;</a></span></h1>
 
+<p><a href="https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat"></a> <a href="https://badge.fury.io/rb/standup_md"><img src="https://badge.fury.io/rb/standup_md.svg"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg"></a></p>
+
 <blockquote>
 <p>The cure for all your standup woes.</p>
 </blockquote>
@@ -111,13 +127,29 @@
 </li><li>
 <p><a href="#usage">Usage</a></p>
 </li><li>
-<p><a href="#example">Example</a></p>
+<p><a href="#command-line">Command Line</a></p>
+<ul><li>
+<p><a href="#cli-examples">CLI Examples</a></p>
+</li><li>
+<p><a href="#adding-an-entry-for-today-via-editor">Adding an entry for today via editor</a></p>
+</li><li>
+<p><a href="#copy-the-entry-for-today-to-clipboard">Copy the entry for today to clipboard</a></p>
+</li><li>
+<p><a href="#add-entry-to-file-without-opening-it">Add entry to file without opening it</a></p>
+</li><li>
+<p><a href="#find-an-entry-by-date-and-print-it">Find an entry by date and print it</a></p>
 </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></ul>
+</li><li>
 <p><a href="#api">API</a></p>
+<ul><li>
+<p><a href="#api-examples">API Examples</a></p>
 </li><li>
 <p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
+</li></ul>
 </li><li>
 <p><a href="#reporting-bugs-and-requesting-features">Reporting Bugs and Requesting Features</a></p>
 </li><li>
@@ -126,11 +158,9 @@
 
 <h2 id="label-About">About<span><a href="#label-About">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
-<p>I&#39;ve now been at two separate companies where we post our daily standups in a chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day became tedious, as I&#39;d have to look up what I did the day before, copy and paste yesterday&#39;s work into a new entry, and add today&#39;s tasks. This gem automates most of this process, along with providing means of opening the file in your editor, and displaying entries from the command line.</p>
-
-<p>I wasn&#39;t sure that others would find this useful, but then the pandemic happened, which I assume made doing standups via chat much more common.</p>
+<p>I&#39;ve now been at two separate companies where we post our daily standups in a chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day became tedious, as I&#39;d have to look up what I did the day before, copy and paste yesterday&#39;s work into a new entry, and add today&#39;s tasks. This gem automates most of this process, along with providing means of opening the file in your editor, and finding and displaying entries from the command line.</p>
 
-<p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn&#39;t exist, one will be generated, and if a previous entry exists, it will be added to today&#39;s entry as your previous day&#39;s work. See <a href="#example">example</a>. There&#39;s also an API if you&#39;d like to use this in your own code somehow.</p>
+<p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn&#39;t exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today&#39;s entry as your previous day&#39;s work. See <a href="#example">example</a>. There&#39;s also a very robust API if you&#39;d like to use this in your own code somehow.</p>
 
 <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
@@ -141,32 +171,35 @@
 <pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">standup_md</span>
 </pre>
 
-<p>If you don&#39;t have permission on your system to install ruby or gems, I recommend using <a href="http://www.rubyinside.com/rbenv-a-simple-new-ruby-version-management-tool-5302.html">rbenv</a>, or you can try the manual methods below.</p>
+<p>To include in your project, add the following to your <code>Gemfile</code>.</p>
+
+<pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-string">&#39;standup_md&#39;</span>
+</pre>
 
 <h3 id="label-Manual+Installation">Manual Installation<span><a href="#label-Manual+Installation">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
-<p>From your terminal, clone the repository where you want it. From there, you have a couple of installation options.</p>
+<p>From your terminal, clone the repository where you want it, and use <code>rake</code> to install the gem.</p>
 
 <pre>git clone https://github.com/evanthegrayt/standup_md.git
 cd standup_md
 
 # Use rake to build and install the gem.
-rake install
-
-# OR manually link the executable somewhere. If you use this method, you cannot
-# move the repository after you link it!
-ln -s $PWD/bin/standup /usr/local/bin/standup</pre>
+rake install</pre>
 
 <h2 id="label-Usage">Usage<span><a href="#label-Usage">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
-<p>Call the executable.</p>
+<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>
 
 <pre class="ruby"><span class="ruby-identifier">standup</span>
 </pre>
 
-<p>This opens the current month&#39;s standup file. If an entry already exists for today, nothing is added. If no entry exists for today, the previous “Current” is placed in the “Previous” section of a new entry. The format of this file is very important; do not change anything, except for adding entries for today.</p>
+<p>This opens the current month&#39;s standup file. If an entry already exists for today, nothing is added. If no entry exists for today, the previous “Current” is placed in the “Previous” section of a new entry. The format of this file is very important; you may add new entries, but don&#39;t change any of the headers. Doing so will cause the parser to break. If you want to customize the headers, you can do so in the <a href="#available-config-file-options-and-defaults">configuration file</a>.</p>
+
+<h3 id="label-CLI+Examples">CLI Examples<span><a href="#label-CLI+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
-<h3 id="label-Example">Example<span><a href="#label-Example">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<h4 id="label-Adding+an+entry+for+today+via+editor">Adding an entry for today via editor<span><a href="#label-Adding+an+entry+for+today+via+editor">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
 <p>For example, if the standup entry from yesterday reads as follows:</p>
 
@@ -179,95 +212,176 @@ ln -s $PWD/bin/standup /usr/local/bin/standup
 ## Impediments
 - None</pre>
 
-<p>The following scaffolding will be added for current entry at the top of the file: <code>markdown # 2020-04-14 ## Previous - Write new feature for `standup_md` - Fix bug in `standup_md` ## Current - &lt;!-- ADD TODAY&#39;S WORK HERE --&gt; ## Impediments - None </code></p>
+<p>The following scaffolding will be added for current entry at the top of the file:</p>
+
+<pre># 2020-04-14
+## Previous
+- Write new feature for `standup_md`
+- Fix bug in `standup_md`
+## Current
+- &lt;!-- ADD TODAY&#39;S WORK HERE --&gt;
+## Impediments
+- None</pre>
+
+<h4 id="label-Copy+the+entry+for+today+to+clipboard">Copy the entry for today to clipboard<span><a href="#label-Copy+the+entry+for+today+to+clipboard">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
 <p>There are also flags that will print entries to the command line. There&#39;s a full list of features below, but as a quick example, you can copy today&#39;s entry to your clipboard without even opening your editor.</p>
 
-<pre class="ruby"><span class="ruby-identifier">standup</span> <span class="ruby-operator">-</span><span class="ruby-identifier">c</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">pbcopy</span>
+<pre class="ruby"><span class="ruby-identifier">standup</span> <span class="ruby-operator">-</span><span class="ruby-identifier">p</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">pbcopy</span>
 </pre>
 
-<h2 id="label-Customization+and+Runtime+Options">Customization and Runtime Options<span><a href="#label-Customization+and+Runtime+Options">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<p>If you wanted to add today&#39;s entry without opening your editor, and print the result to the command line, you could use the following.</p>
+
+<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>
+
+<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>
+
+<p>If you wanted to find and print the entry for March 2nd, 2020, you could use the following.</p>
 
-<p>You can create a file in your home directory called <code>~/.standup_md.yml</code>. Settings located in this file will override default behavior. This file can also have settings overwritten at runtime by the use of options. You can view <a href="https://github.com/evanthegrayt/dotfiles/blob/master/dotfiles/standup_md.yml">my config file</a> as an example. Any setting in this file can still be overridden at runtime by passing flags to the executable.</p>
+<pre>standup -p 2020-03-02</pre>
+
+<h3 id="label-Customization+and+Runtime+Options">Customization and Runtime Options<span><a href="#label-Customization+and+Runtime+Options">&para;</a> <a href="#top">&uarr;</a></span></h3>
+
+<p>You can create a file in your home directory called <code>~/.standuprc</code>. Settings located in this file will override default behavior. This file can also have settings overwritten at runtime by the use of options. You can view <a href="https://github.com/evanthegrayt/dotfiles/blob/master/dotfiles/standuprc">my config file</a> as an example. Any setting in this file can still be overridden at runtime by passing flags to the executable.</p>
 
 <p>You&#39;ll notice, a lot of settings don&#39;t have the ability to be changed at runtime when calling the executable. This is because the file structure is very important, and changing values that affect formatting will cause problems with the file parser. If you don&#39;t want to use a default, make the change in your config file before you start editing standups. There is an <a href="https://github.com/evanthegrayt/standup_md/issues/16">open issue</a> for handling this for the user, but they&#39;re not available yet.</p>
 
 <p>There are no options to change the headers at runtime because it uses the headers to detect tasks from previous entries. If changed at runtime, this would cause errors. For this reason, if you don&#39;t like the default headers, change them in your configuration file after installation, and then try to not change them again.</p>
 
-<h3 id="label-Available+Config+File+Keys+and+Defaults">Available Config File Keys and Defaults<span><a href="#label-Available+Config+File+Keys+and+Defaults">&para;</a> <a href="#top">&uarr;</a></span></h3>
-
-<pre># Key:                 Default
-header_depth:          1
-header_date_format:    &#39;%Y-%m-%d&#39;
-sub_header_depth:      2
-current_header:        &#39;Current&#39;
-previous_header:       &#39;Previous&#39;
-impediments_header:    &#39;Impediments&#39;
-file_name_format:      &#39;%Y_%m.md&#39;
-bullet_character:      &#39;-&#39;        # (dash)
-directory:             &#39;~/.cache/standup_md&#39;
-editor:                # $VISUAL, $EDITOR or vim, in that order
-current_entry_tasks:
-  - &quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;
-previous_entry_tasks:  # An array of the tasks from the previous entry
-impediments:
-  - &#39;None&#39;
-notes:                 null # If not null, must be array
-sub_header_order:
-  - &#39;previous&#39;
-  - &#39;current&#39;
-  - &#39;impediments&#39;
-  - &#39;notes&#39;</pre>
-
-<h3 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">&para;</a> <a href="#top">&uarr;</a></span></h3>
-
-<pre>The Standup Doctor
-        --current-entry-tasks=ARRAY  List of current entry&#39;s tasks
-        --previous-entry-tasks=ARRAY List of yesterday&#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
-        --[no-]append-previous       Append previous tasks? Default is true
-    -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
-        --[no-]write                 Write current entry if it doesn&#39;t exist. Default is true
-        --[no-]edit                  Open the file in the editor. Default is true
-    -j, --[no-]json                  Print output as formatted json. Default is false.
-    -v, --[no-]verbose               Verbose output. Default is false.
-    -c, --current                    Print current entry. Disables editing
-    -a, --all                        Print all previous entries. Disables editing</pre>
+<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>
+
+<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>
+  <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;%Y-%m-%d&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span>       = <span class="ruby-value">1</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">2</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;Current&#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;Previous&#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;Impediments&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">notes_header</span>       = <span class="ruby-string">&#39;Notes&#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[previous current impediments notes]</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">directory</span>          = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>], <span class="ruby-string">&#39;.cache&#39;</span>, <span class="ruby-string">&#39;standup_md&#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">name_format</span>        = <span class="ruby-string">&#39;%Y_%m.md&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">create</span>             = <span class="ruby-keyword">true</span>
+
+  <span class="ruby-comment"># Defaults for entries</span>
+  <span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Entry.html</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">current</span>          = [<span class="ruby-string">&quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;</span>]
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">previous</span>         = []
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">impediments</span>      = [<span class="ruby-string">&#39;None&#39;</span>]
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">notes</span>            = []
+
+  <span class="ruby-comment"># Defaults for executable runtime behavior.</span>
+  <span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">date</span>               = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">editor</span>             = <span class="ruby-string">&#39;vim&#39;</span> <span class="ruby-comment"># Checks $VISUAL and $EDITOR first, in that order</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">verbose</span>            = <span class="ruby-keyword">false</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">edit</span>               = <span class="ruby-keyword">true</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">write</span>              = <span class="ruby-keyword">true</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">print</span>              = <span class="ruby-keyword">false</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">auto_fill_previous</span> = <span class="ruby-keyword">true</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">preference_file</span>    = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>], <span class="ruby-string">&#39;.standuprc&#39;</span>))
+<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>
+
+<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>
 
 <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>If you wanted to add some tasks at runtime, and without opening the file in an editor, you could use the following:</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>
 
-<pre>standup --no-edit --current-entry-tasks=&quot;Work on this thing&quot;,&quot;And another thing!&quot;</pre>
+<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>~/.standuprc</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>~/.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-keyword">end</span>
+</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>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 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>
 
 <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-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-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>,
+<span class="ruby-keyword">end</span>
 
-<span class="ruby-identifier">standup</span>.<span class="ruby-identifier">write</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-constant">Date</span>.<span class="ruby-identifier">today</span>)
+<span class="ruby-identifier">entry</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Entry</span>.<span class="ruby-identifier">create</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">current</span> = [<span class="ruby-string">&#39;Stuff I will do today&#39;</span>] }
+<span class="ruby-identifier">file</span>.<span class="ruby-identifier">entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">entry</span>
+<span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>
 </pre>
 
-<p>Entries are just hashes, so you can easily transform them to <code>json</code> objects.</p>
+<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;json&#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>,
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">current</span> = [<span class="ruby-string">&#39;Stuff I will do today&#39;</span>]
+<span class="ruby-keyword">end</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-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>
 
 <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","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()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","setup()","should_append?()","should_append?()","standup()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","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_empty?()","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","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#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()","teststandupmd#setup()","standupmd::cli#should_append?()","teststandupmd#should_append?()","standupmd::cli#standup()","testhelper#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","teststandupmd#teardown()","teststandupmd#test_preference_file()","teststandupmd#test_version()","teststandupmd#test_all_previous_entries()","teststandupmd#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()","teststandupmd#test_edit?()","teststandupmd#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()","teststandupmd#test_initialize()","teststandupmd#test_json?()","teststandupmd#test_load()","teststandupmd#test_notes()","teststandupmd#test_notes_header()","teststandupmd#test_options()","teststandupmd#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()","teststandupmd#test_print_all_entries?()","teststandupmd#test_print_current_empty?()","teststandupmd#test_reload()","teststandupmd#test_self_execute()","teststandupmd#test_setting_attributes_via_block()","teststandupmd#test_standup()","teststandupmd#test_sub_header_depth()","teststandupmd#test_sub_header_order()","teststandupmd#test_verbose?()","teststandupmd#test_write()","teststandupmd#test_write?()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","The class for handing reading/writing of entries.\n@example\n\nsu = StandupMD.new\n\n"],["StandupMD::Cli","","StandupMD/Cli.html","","Class for handing the command-line interface.\n"],["TestHelper","","TestHelper.html","","Module to include in tests that provides helper functions.\n"],["TestStandupMD","","TestStandupMD.html","","The test suite for Cli.\nThe test suite for StandupMD.\n"],["append_previous?","StandupMD::Cli","StandupMD/Cli.html#method-i-append_previous-3F","()","Should `previous_entry_tasks` be appended? If false, previous_entry_tasks will be overwritten.\n@return …\n"],["append_to_previous_entry_tasks","StandupMD::Cli","StandupMD/Cli.html#method-i-append_to_previous_entry_tasks","()","Appends entries passed at runtime to existing previous entries.\n@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","Setter for bullet_character. Must be * (asterisk) or - (dash).\n@param [String] character\n@return [String] …\n"],["cli","TestHelper","TestHelper.html#method-i-cli","(options = [])","Creates instance of Cli.\n@param [Array] options Parsed by getopts\n@return [StandupMD::Cli]\n"],["create_standup_file","TestHelper","TestHelper.html#method-i-create_standup_file","(file, fixture = 'previous_entry')","Creates the standup file with entries.\n@param [String] file The name of the file to create\n@param [String] …\n"],["current_entry_tasks=","StandupMD","StandupMD.html#method-i-current_entry_tasks-3D","(tasks)","Setter for current entry tasks.\n@param [Array] tasks\n@return [Array]\n"],["directory=","StandupMD","StandupMD.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)","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"],["edit?","StandupMD::Cli","StandupMD/Cli.html#method-i-edit-3F","()","Should the standup file be opened in the editor?\n@return [Boolean] Default is true\n"],["editor","StandupMD::Cli","StandupMD/Cli.html#method-i-editor","()","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","()","Was today's entry already in the file?\n@return [boolean] true if today's entry was already in …\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","Creates an instance of StandupMD and runs what the user requested.\n"],["file_written?","StandupMD","StandupMD.html#method-i-file_written-3F","()","Has the file been written since instantiated?\n@return [boolean]\n@example\n"],["fixtures","TestHelper","TestHelper.html#method-i-fixtures","()","Reads the fixtures in as a hash.\n@return [Hash]\n"],["header_depth=","StandupMD","StandupMD.html#method-i-header_depth-3D","(depth)","Number of octothorps (#) to use before the main header.\n@param [Integer] depth\n@return [Integer]\n"],["impediments=","StandupMD","StandupMD.html#method-i-impediments-3D","(tasks)","Setter for impediments.\n@param [Array] tasks\n@return [Array]\n"],["json?","StandupMD::Cli","StandupMD/Cli.html#method-i-json-3F","()","If printing an entry, should it be printed as json?\n@return [Boolean] Default is false\n"],["load","StandupMD","StandupMD.html#method-c-load","(attributes = {})","Convenience method for calling new + load\n@param [Hash] attributes Attributes to set before loading.\n@example …\n"],["load","StandupMD","StandupMD.html#method-i-load","()","Sets internal instance variables. Called when first instantiated, or after directory is set.\n@return [self] …\n"],["new","StandupMD","StandupMD.html#method-c-new","()","Constructor. Yields the instance so you can pass a block to access setters.\n@return [self]\n@example\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options)","Constructor. Sets defaults.\n@param [Array] options\n"],["notes=","StandupMD","StandupMD.html#method-i-notes-3D","(tasks)","Setter for notes.\n@param [Array] notes\n@return [Array]\n"],["previous_entry_tasks=","StandupMD","StandupMD.html#method-i-previous_entry_tasks-3D","(tasks)","Setter for current entry tasks.\n@param [Array] tasks\n@return [Array]\n"],["print_all_entries","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries","()","Prints all entries to the command line.\n@return [nil]\n"],["print_all_entries?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries-3F","()","Should all entries be printed? If true, disables editing.\n@return [Boolean] Default is false\n"],["print_current_entry","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry","()","Prints the current entry to the command line.\n@return [nil]\n"],["print_current_entry?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry-3F","()","Should current entry be printed? If true, disables editing.\n@return [Boolean] Default is false\n"],["reload","StandupMD","StandupMD.html#method-i-reload","()","Alias of load\n@return [self]\n"],["setup","TestStandupMD","TestStandupMD.html#method-i-setup","()","Set working directory, current month's file, and last month's file, which will be created and …\n"],["should_append?","StandupMD::Cli","StandupMD/Cli.html#method-i-should_append-3F","()","Did the user pass previous_entry_tasks, and should we append?\n@return [Boolean]\n"],["should_append?","TestStandupMD","TestStandupMD.html#method-i-should_append-3F","()","True only if --no-append and --previous-entry-tasks are passed.\n"],["standup","StandupMD::Cli","StandupMD/Cli.html#method-i-standup","()","Sets up an instance of StandupMD and passes all user preferences.\n@return [StandupMD]\n"],["standup","TestHelper","TestHelper.html#method-i-standup","(directory, args = {})","Creates StandupUP instance. Directory must be passed, usually a subdirectory of test, so we don't …\n"],["sub_header_depth=","StandupMD","StandupMD.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"],["sub_header_order","StandupMD","StandupMD.html#method-i-sub_header_order","()","Return a copy of the sub-header order so the user can't modify the array.\n@return [Array]\n"],["sub_header_order=","StandupMD","StandupMD.html#method-i-sub_header_order-3D","(array)","Preferred order for sub-headers.\n@param [Array] Values must be %w[previous current impediment notes]\n@return …\n"],["teardown","TestStandupMD","TestStandupMD.html#method-i-teardown","()","Destroy the working directory and its contents.\n"],["test_PREFERENCE_FILE","TestStandupMD","TestStandupMD.html#method-i-test_PREFERENCE_FILE","()","The user's preference file is a string.\n"],["test_VERSION","TestStandupMD","TestStandupMD.html#method-i-test_VERSION","()","StandupMD::VERSION should consist of three integers separated by dots.\n"],["test_all_previous_entries","TestStandupMD","TestStandupMD.html#method-i-test_all_previous_entries","()","Should be all entries before the current entry.\n"],["test_append_previous?","TestStandupMD","TestStandupMD.html#method-i-test_append_previous-3F","()","True by default. False if flag is passed.\n"],["test_bullet_character","TestStandupMD","TestStandupMD.html#method-i-test_bullet_character","()","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","()","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","()","current_entry should be a hash. If file 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","()","Should be able to add tasks for current_entry.\n"],["test_current_header","TestStandupMD","TestStandupMD.html#method-i-test_current_header","()","Should be changeable and used as the header for current_entry\n"],["test_directory","TestStandupMD","TestStandupMD.html#method-i-test_directory","()","Directory should default be settable, and where standup files are read from.\n"],["test_edit?","TestStandupMD","TestStandupMD.html#method-i-test_edit-3F","()","True by default. False if flag is passed.\n"],["test_editor","TestStandupMD","TestStandupMD.html#method-i-test_editor","()","The editor should be set by preferences, or env, or set to 'vim'.\n"],["test_entry_previously_added?","TestStandupMD","TestStandupMD.html#method-i-test_entry_previously_added-3F","()","Should be true if current_entry was in the file at the time it was read.\n"],["test_file","TestStandupMD","TestStandupMD.html#method-i-test_file","()","The file name should equal file_name_format parsed by Date.strftime. The default is Date.today.strftime('%Y_%m.md') …\n"],["test_file_name_format","TestStandupMD","TestStandupMD.html#method-i-test_file_name_format","()","Should be changeable, and return a string parsed by strftime.\n"],["test_file_written?","TestStandupMD","TestStandupMD.html#method-i-test_file_written-3F","()","Should be false when first instantiated, true after write is called.\n"],["test_header_date_format","TestStandupMD","TestStandupMD.html#method-i-test_header_date_format","()","Should be changeable, and return a string parsed by strftime.\n"],["test_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_header_depth","()","Should be an integer between 1..5, but not higher than sub_header_depth.\n"],["test_impediments","TestStandupMD","TestStandupMD.html#method-i-test_impediments","()","Should be able to add impediments to the array.\n"],["test_impediments_header","TestStandupMD","TestStandupMD.html#method-i-test_impediments_header","()","Should be changeable and used as the header for impediments\n"],["test_initialize","TestStandupMD","TestStandupMD.html#method-i-test_initialize","()","The initialize method should accept the same parameters as exectute.\n"],["test_json?","TestStandupMD","TestStandupMD.html#method-i-test_json-3F","()","False by default. True if flag is passed.\n"],["test_load","TestStandupMD","TestStandupMD.html#method-i-test_load","()","Should load instance variables.\n"],["test_notes","TestStandupMD","TestStandupMD.html#method-i-test_notes","()","Should be able to add notes to the array.\n"],["test_notes_header","TestStandupMD","TestStandupMD.html#method-i-test_notes_header","()","Should be changeable and used as the header for notes\n"],["test_options","TestStandupMD","TestStandupMD.html#method-i-test_options","()","The options should be an array of options passed from the command line.\n"],["test_preferences","TestStandupMD","TestStandupMD.html#method-i-test_preferences","()","The preferences are the settings after options are parsed.\n"],["test_previous_entry_tasks","TestStandupMD","TestStandupMD.html#method-i-test_previous_entry_tasks","()","Should be an array of previous entry'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","()","When neither last month's file, nor this month'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","()","When last month's file exists, but this month's doesn'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","()","If there are previous entries for this month, previous file will be this month's file.\n"],["test_previous_header","TestStandupMD","TestStandupMD.html#method-i-test_previous_header","()","Should be changeable and used as the header for previous_entry\n"],["test_print_all_entries?","TestStandupMD","TestStandupMD.html#method-i-test_print_all_entries-3F","()","False by default. True if flag is passed.\n"],["test_print_current_empty?","TestStandupMD","TestStandupMD.html#method-i-test_print_current_empty-3F","()","False by default. True if flag is passed.\n"],["test_reload","TestStandupMD","TestStandupMD.html#method-i-test_reload","()","The reload method should exist, and is an alias of load.\n"],["test_self_execute","TestStandupMD","TestStandupMD.html#method-i-test_self_execute","()","The execute method is the entry point for the Cli. It'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","()","Attributes should be able to be set if you pass a block at instantiation.\n"],["test_standup","TestStandupMD","TestStandupMD.html#method-i-test_standup","()","Creates the instance of StandupMD.\n"],["test_sub_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_depth","()","Should be an integer between 2..6, but not lower than header_depth.\n"],["test_sub_header_order","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_order","()","The order of the subheaders is changeable, but all elements must exist.\n"],["test_verbose?","TestStandupMD","TestStandupMD.html#method-i-test_verbose-3F","()","False by default. True if flag is passed.\n"],["test_write","TestStandupMD","TestStandupMD.html#method-i-test_write","()","Should write the file.\n"],["test_write?","TestStandupMD","TestStandupMD.html#method-i-test_write-3F","()","True by default. False if flag is passed.\n"],["verbose?","StandupMD::Cli","StandupMD/Cli.html#method-i-verbose-3F","()","Should debug info be printed?\n@return [Boolean] Default is false\n"],["write","StandupMD","StandupMD.html#method-i-write","()","Writes a new entry to the file if the first entry in the file isn't today.\n@return [Boolean]\n"],["write?","StandupMD::Cli","StandupMD/Cli.html#method-i-write-3F","()","Should the file be written?\n@return [Boolean] Default is true\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\nThe cure for all your standup woes.\n\nA highly customizable and automated way to keep …\n"]]}}
        
+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"]]}}
        

data/doc/table_of_contents.html

@@ -51,16 +51,30 @@
 
       <li><a href="README_md.html#label-Usage">Usage</a>
 
-      <li><a href="README_md.html#label-Example">Example</a>
+      <li><a href="README_md.html#label-Command+Line">Command Line</a>
+
+      <li><a href="README_md.html#label-CLI+Examples">CLI Examples</a>
+
+      <li><a href="README_md.html#label-Adding+an+entry+for+today+via+editor">Adding an entry for today via editor</a>
+
+      <li><a href="README_md.html#label-Copy+the+entry+for+today+to+clipboard">Copy the entry for today to clipboard</a>
+
+      <li><a href="README_md.html#label-Add+entry+to+file+without+opening+it">Add entry to file without opening it</a>
+
+      <li><a href="README_md.html#label-Find+an+entry+by+date+and+print+it.">Find an entry by date and print it.</a>
 
       <li><a href="README_md.html#label-Customization+and+Runtime+Options">Customization and Runtime Options</a>
 
-      <li><a href="README_md.html#label-Available+Config+File+Keys+and+Defaults">Available Config File Keys and Defaults</a>
+      <li><a href="README_md.html#label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults</a>
 
       <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-API+Examples">API Examples</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>
@@ -75,23 +89,9 @@
 <h2 id="classes">Classes and Modules</h2>
 <ul>
 
-  <li class="class">
+  <li class="module">
     <a href="StandupMD.html">StandupMD</a>
 
-    <ul>
-
-      <li><a href="StandupMD.html#5Buntitled-5D">Top Section</a>
-
-      <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>
 
   <li class="class">
@@ -100,439 +100,344 @@
   </li>
 
   <li class="module">
-    <a href="TestHelper.html">TestHelper</a>
+    <a href="StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
 
   </li>
 
   <li class="class">
-    <a href="TestStandupMD.html">TestStandupMD</a>
+    <a href="StandupMD/Config.html">StandupMD::Config</a>
 
   </li>
 
-</ul>
-
-<h2 id="methods">Methods</h2>
-<ul>
-
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-c-execute">::execute</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
-
-  <li class="method">
-    <a href="StandupMD.html#method-c-load">::load</a>
-    &mdash;
-    <span class="container">StandupMD</span>
-
-  <li class="method">
-    <a href="StandupMD.html#method-c-new">::new</a>
-    &mdash;
-    <span class="container">StandupMD</span>
+  <li class="class">
+    <a href="StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
 
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-c-new">::new</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
+  </li>
 
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-i-append_previous-3F">#append_previous?</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
+  <li class="class">
+    <a href="StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
 
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-i-append_to_previous_entry_tasks">#append_to_previous_entry_tasks</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
+  </li>
 
-  <li class="method">
-    <a href="StandupMD.html#method-i-bullet_character-3D">#bullet_character=</a>
-    &mdash;
-    <span class="container">StandupMD</span>
+  <li class="class">
+    <a href="StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
 
-  <li class="method">
-    <a href="TestHelper.html#method-i-cli">#cli</a>
-    &mdash;
-    <span class="container">TestHelper</span>
+  </li>
 
-  <li class="method">
-    <a href="TestHelper.html#method-i-create_standup_file">#create_standup_file</a>
-    &mdash;
-    <span class="container">TestHelper</span>
+  <li class="class">
+    <a href="StandupMD/Config/File.html">StandupMD::Config::File</a>
 
-  <li class="method">
-    <a href="StandupMD.html#method-i-current_entry_tasks-3D">#current_entry_tasks=</a>
-    &mdash;
-    <span class="container">StandupMD</span>
+  </li>
 
-  <li class="method">
-    <a href="StandupMD.html#method-i-directory-3D">#directory=</a>
-    &mdash;
-    <span class="container">StandupMD</span>
+  <li class="class">
+    <a href="StandupMD/Entry.html">StandupMD::Entry</a>
 
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-i-echo">#echo</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
+  </li>
 
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-i-edit">#edit</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
+  <li class="class">
+    <a href="StandupMD/EntryList.html">StandupMD::EntryList</a>
 
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-i-edit-3F">#edit?</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
+  </li>
 
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-i-editor">#editor</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
+  <li class="class">
+    <a href="StandupMD/File.html">StandupMD::File</a>
 
-  <li class="method">
-    <a href="StandupMD.html#method-i-entry_previously_added-3F">#entry_previously_added?</a>
-    &mdash;
-    <span class="container">StandupMD</span>
+  </li>
 
-  <li class="method">
-    <a href="StandupMD.html#method-i-file_written-3F">#file_written?</a>
-    &mdash;
-    <span class="container">StandupMD</span>
+</ul>
 
-  <li class="method">
-    <a href="TestHelper.html#method-i-fixtures">#fixtures</a>
-    &mdash;
-    <span class="container">TestHelper</span>
+<h2 id="methods">Methods</h2>
+<ul>
 
   <li class="method">
-    <a href="StandupMD.html#method-i-header_depth-3D">#header_depth=</a>
+    <a href="StandupMD/Entry.html#method-c-config">::config</a>
     &mdash;
-    <span class="container">StandupMD</span>
+    <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-i-impediments-3D">#impediments=</a>
+    <a href="StandupMD/File.html#method-c-config">::config</a>
     &mdash;
-    <span class="container">StandupMD</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="StandupMD/Cli.html#method-i-json-3F">#json?</a>
+    <a href="StandupMD/Cli.html#method-c-config">::config</a>
     &mdash;
     <span class="container">StandupMD::Cli</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-i-load">#load</a>
+    <a href="StandupMD.html#method-c-config">::config</a>
     &mdash;
     <span class="container">StandupMD</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-i-notes-3D">#notes=</a>
+    <a href="StandupMD/EntryList.html#method-c-config">::config</a>
     &mdash;
-    <span class="container">StandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-i-previous_entry_tasks-3D">#previous_entry_tasks=</a>
+    <a href="StandupMD.html#method-c-config_file_loaded-3F">::config_file_loaded?</a>
     &mdash;
     <span class="container">StandupMD</span>
 
   <li class="method">
-    <a href="StandupMD/Cli.html#method-i-print_all_entries">#print_all_entries</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
-
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-i-print_all_entries-3F">#print_all_entries?</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
-
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-i-print_current_entry">#print_current_entry</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
-
-  <li class="method">
-    <a href="StandupMD/Cli.html#method-i-print_current_entry-3F">#print_current_entry?</a>
-    &mdash;
-    <span class="container">StandupMD::Cli</span>
-
-  <li class="method">
-    <a href="StandupMD.html#method-i-reload">#reload</a>
+    <a href="StandupMD.html#method-c-configure">::configure</a>
     &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="TestStandupMD.html#method-i-should_append-3F">#should_append?</a>
+    <a href="StandupMD/Entry.html#method-c-create">::create</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/Cli.html#method-i-should_append-3F">#should_append?</a>
+    <a href="StandupMD/Cli.html#method-c-echo">::echo</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>
+    <a href="StandupMD/Cli.html#method-c-execute">::execute</a>
     &mdash;
     <span class="container">StandupMD::Cli</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-i-sub_header_depth-3D">#sub_header_depth=</a>
+    <a href="StandupMD/File.html#method-c-find">::find</a>
     &mdash;
-    <span class="container">StandupMD</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-i-sub_header_order">#sub_header_order</a>
+    <a href="StandupMD/File.html#method-c-find_by_date">::find_by_date</a>
     &mdash;
-    <span class="container">StandupMD</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-i-sub_header_order-3D">#sub_header_order=</a>
+    <a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
     &mdash;
     <span class="container">StandupMD</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-teardown">#teardown</a>
+    <a href="StandupMD/EntryList.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_PREFERENCE_FILE">#test_PREFERENCE_FILE</a>
+    <a href="StandupMD/Config/File.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_VERSION">#test_VERSION</a>
+    <a href="StandupMD/File.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_all_previous_entries">#test_all_previous_entries</a>
+    <a href="StandupMD/Config.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_append_previous-3F">#test_append_previous?</a>
+    <a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::Entry</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>
+    <a href="StandupMD/Cli.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Cli</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_current_entry_tasks">#test_current_entry_tasks</a>
+    <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::Cli</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_current_header">#test_current_header</a>
+    <a href="StandupMD/Entry.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_directory">#test_directory</a>
+    <a href="StandupMD.html#method-c-reset_config">::reset_config</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_edit-3F">#test_edit?</a>
+    <a href="StandupMD/EntryList.html#method-i-3C-3C">#&lt;&lt;</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_editor">#test_editor</a>
+    <a href="StandupMD/Entry.html#method-i-3C-3D-3E">#&lt;=&gt;</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_entry_previously_added-3F">#test_entry_previously_added?</a>
+    <a href="StandupMD/Config/File.html#method-i-bullet_character-3D">#bullet_character=</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_file">#test_file</a>
+    <a href="StandupMD/Config/File.html#method-i-directory-3D">#directory=</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_file_name_format">#test_file_name_format</a>
+    <a href="StandupMD/EntryList.html#method-i-each">#each</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_file_written-3F">#test_file_written?</a>
+    <a href="StandupMD/Cli.html#method-i-echo">#echo</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Cli</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_header_date_format">#test_header_date_format</a>
+    <a href="StandupMD/Cli.html#method-i-edit">#edit</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Cli</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_header_depth">#test_header_depth</a>
+    <a href="StandupMD/EntryList.html#method-i-empty-3F">#empty?</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_impediments">#test_impediments</a>
+    <a href="StandupMD/File.html#method-i-exist-3F">#exist?</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_impediments_header">#test_impediments_header</a>
+    <a href="StandupMD/EntryList.html#method-i-filter">#filter</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_initialize">#test_initialize</a>
+    <a href="StandupMD/EntryList.html#method-i-filter-21">#filter!</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_json-3F">#test_json?</a>
+    <a href="StandupMD/EntryList.html#method-i-find">#find</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_load">#test_load</a>
+    <a href="StandupMD/EntryList.html#method-i-first">#first</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_notes">#test_notes</a>
+    <a href="StandupMD/Config/File.html#method-i-header_depth-3D">#header_depth=</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_notes_header">#test_notes_header</a>
+    <a href="StandupMD/Config/EntryList.html#method-i-initalize">#initalize</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_options">#test_options</a>
+    <a href="StandupMD/EntryList.html#method-i-last">#last</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_preferences">#test_preferences</a>
+    <a href="StandupMD/File.html#method-i-load">#load</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_previous_entry_tasks">#test_previous_entry_tasks</a>
+    <a href="StandupMD/Cli.html#method-i-load_preferences">#load_preferences</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Cli</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>
+    <a href="StandupMD/File.html#method-i-loaded-3F">#loaded?</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::File</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>
+    <a href="StandupMD/File.html#method-i-new-3F">#new?</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::File</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>
+    <a href="StandupMD/Cli.html#method-i-preference_file_loaded-3F">#preference_file_loaded?</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Cli</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_previous_header">#test_previous_header</a>
+    <a href="StandupMD/Cli/Helpers.html#method-i-print">#print</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Cli::Helpers</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_print_all_entries-3F">#test_print_all_entries?</a>
+    <a href="StandupMD/Config/File.html#method-i-reset_values">#reset_values</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_print_current_empty-3F">#test_print_current_empty?</a>
+    <a href="StandupMD/Config/Cli.html#method-i-reset_values">#reset_values</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::Cli</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_reload">#test_reload</a>
+    <a href="StandupMD/Config/Entry.html#method-i-reset_values">#reset_values</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::Entry</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_self_execute">#test_self_execute</a>
+    <a href="StandupMD/Config/EntryList.html#method-i-reset_values">#reset_values</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_setting_attributes_via_block">#test_setting_attributes_via_block</a>
+    <a href="StandupMD/EntryList.html#method-i-size">#size</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_standup">#test_standup</a>
+    <a href="StandupMD/EntryList.html#method-i-sort">#sort</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_sub_header_depth">#test_sub_header_depth</a>
+    <a href="StandupMD/EntryList.html#method-i-sort-21">#sort!</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_sub_header_order">#test_sub_header_order</a>
+    <a href="StandupMD/EntryList.html#method-i-sort_reverse">#sort_reverse</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_verbose-3F">#test_verbose?</a>
+    <a href="StandupMD/Config/File.html#method-i-sub_header_depth-3D">#sub_header_depth=</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_write">#test_write</a>
+    <a href="StandupMD/EntryList.html#method-i-to_h">#to_h</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="TestStandupMD.html#method-i-test_write-3F">#test_write?</a>
+    <a href="StandupMD/Entry.html#method-i-to_h">#to_h</a>
     &mdash;
-    <span class="container">TestStandupMD</span>
+    <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/Cli.html#method-i-verbose-3F">#verbose?</a>
+    <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
     &mdash;
-    <span class="container">StandupMD::Cli</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-i-write">#write</a>
+    <a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
     &mdash;
-    <span class="container">StandupMD</span>
+    <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/Cli.html#method-i-write-3F">#write?</a>
+    <a href="StandupMD/File.html#method-i-write">#write</a>
     &mdash;
-    <span class="container">StandupMD::Cli</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
     <a href="StandupMD/Cli.html#method-i-write_file">#write_file</a>