RubyGems - standup_md - Versions diffs - 0.1.3 → 0.3.2 - Mend

standup_md 0.1.3 → 0.3.2

Files changed (43) hide show

checksums.yaml +4 -4
data/.gitignore +1 -0
data/Gemfile.lock +7 -1
data/README.md +182 -98
data/Rakefile +11 -28
data/bin/standup +1 -1
data/doc/README_md.html +183 -78
data/doc/StandupMD.html +83 -1248
data/doc/StandupMD/Cli.html +124 -474
data/doc/StandupMD/Cli/Helpers.html +167 -0
data/doc/StandupMD/Config.html +230 -0
data/doc/StandupMD/Config/Cli.html +355 -0
data/doc/StandupMD/Config/Entry.html +284 -0
data/doc/StandupMD/Config/EntryList.html +197 -0
data/doc/StandupMD/Config/File.html +609 -0
data/doc/StandupMD/Entry.html +478 -0
data/doc/StandupMD/EntryList.html +759 -0
data/doc/StandupMD/File.html +614 -0
data/doc/created.rid +15 -8
data/doc/index.html +189 -79
data/doc/js/navigation.js.gz +0 -0
data/doc/js/search_index.js +1 -1
data/doc/js/search_index.js.gz +0 -0
data/doc/js/searcher.js.gz +0 -0
data/doc/table_of_contents.html +153 -263
data/lib/standup_md.rb +29 -508
data/lib/standup_md/cli.rb +63 -242
data/lib/standup_md/cli/helpers.rb +165 -0
data/lib/standup_md/config.rb +45 -0
data/lib/standup_md/config/cli.rb +106 -0
data/lib/standup_md/config/entry.rb +61 -0
data/lib/standup_md/config/entry_list.rb +26 -0
data/lib/standup_md/config/file.rb +199 -0
data/lib/standup_md/entry.rb +121 -0
data/lib/standup_md/entry_list.rb +166 -0
data/lib/standup_md/file.rb +183 -0
data/lib/standup_md/file/helpers.rb +62 -0
data/lib/standup_md/version.rb +5 -5
data/standup_md.gemspec +1 -0
metadata +35 -5
data/doc/TestCli.html +0 -792
data/doc/TestHelper.html +0 -282
data/doc/TestStandupMD.html +0 -1354

data/bin/standup CHANGED

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require_relative '../lib/standup_md/cli'
+require_relative '../lib/standup_md'
 StandupMD::Cli.execute(ARGV)

data/doc/README_md.html CHANGED

@@ -67,11 +67,18 @@
     <li><a href="#label-Via+RubyGems">Via RubyGems</a>
     <li><a href="#label-Manual+Installation">Manual Installation</a>
     <li><a href="#label-Usage">Usage</a>
-    <li><a href="#label-Example">Example</a>
+    <li><a href="#label-Command+Line">Command Line</a>
+    <li><a href="#label-CLI+Examples">CLI Examples</a>
+    <li><a href="#label-Adding+an+entry+for+today+via+editor">Adding an entry for today via editor</a>
+    <li><a href="#label-Copy+the+entry+for+today+to+clipboard">Copy the entry for today to clipboard</a>
+    <li><a href="#label-Add+entry+to+file+without+opening+it">Add entry to file without opening it</a>
+    <li><a href="#label-Find+an+entry+by+date+and+print+it.">Find an entry by date and print it.</a>
     <li><a href="#label-Customization+and+Runtime+Options">Customization and Runtime Options</a>
-    <li><a href="#label-Available+Config+File+Keys+and+Defaults">Available Config File Keys and Defaults</a>
+    <li><a href="#label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults</a>
     <li><a href="#label-Executable+Flags">Executable Flags</a>
+    <li><a href="#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
     <li><a href="#label-API">API</a>
+    <li><a href="#label-API+Examples">API Examples</a>
     <li><a href="#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
     <li><a href="#label-Self-Promotion">Self-Promotion</a>
   </ul>
@@ -96,6 +103,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>
@@ -116,13 +125,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>
@@ -131,11 +156,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&#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>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>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>
@@ -146,32 +169,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, simply 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-Example">Example<span><a href="#label-Example">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<h3 id="label-CLI+Examples">CLI Examples<span><a href="#label-CLI+Examples">&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>
@@ -184,95 +210,174 @@ 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>
+<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>~/.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>
+<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-string">&#39;Today&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span>    = <span class="ruby-string">&#39;Yesterday&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span> = <span class="ruby-string">&#39;Hold-ups&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span>   = <span class="ruby-string">&#39;*&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span> = <span class="ruby-string">&#39;%m/%d/%Y&#39;</span>
+  <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span>   = <span class="ruby-node">%w[current previous impediments notes]</span>
+<span class="ruby-keyword">end</span>
+</pre>
 <h2 id="label-API">API<span><a href="#label-API">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p>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">RDoc 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">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">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-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-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/StandupMD.html CHANGED

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
-<title>class StandupMD - RDoc Documentation</title>
+<title>module StandupMD - RDoc Documentation</title>
 <script type="text/javascript">
   var rdoc_rel_prefix = "./";
@@ -23,7 +23,7 @@
-<body id="top" role="document" class="class">
+<body id="top" role="document" class="module">
 <nav role="navigation">
   <div id="project-navigation">
     <div id="home-section" role="region" title="Quick navigation" class="nav-section">
@@ -58,1188 +58,45 @@
   <div id="class-metadata">
-    <div id="sections-section" class="nav-section">
-  <h3>Sections</h3>
-  <ul class="link-list" role="directory">
-      <li><a href="#5Buntitled-5D"></a></li>
-      <li><a href="#Attributes+that+are+settable+by+the+user-2C+but+have+custom+setters.">Attributes that are settable by the user, but have custom setters.</a></li>
-      <li><a href="#Attributes+that+aren-27t+settable+by+user-2C+but+are+gettable.">Attributes that aren&#39;t settable by user, but are gettable.</a></li>
-      <li><a href="#Attributes+with+default+getters+and+setters.">Attributes with default getters and setters.</a></li>
-      <li><a href="#Booleans">Booleans</a></li>
-      <li><a href="#Custom+setters">Custom setters</a></li>
-      <li><a href="#Misc">Misc</a></li>
-  </ul>
-</div>
-    <div id="parent-class-section" class="nav-section">
-  <h3>Parent</h3>
-  <p class="link">Object
-</div>
-    <!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-  <ul class="link-list" role="directory">
-    <li ><a href="#method-c-load">::load</a>
-    <li ><a href="#method-c-new">::new</a>
-    <li ><a href="#method-i-bullet_character-3D">#bullet_character=</a>
-    <li ><a href="#method-i-current_entry_tasks-3D">#current_entry_tasks=</a>
-    <li ><a href="#method-i-directory-3D">#directory=</a>
-    <li ><a href="#method-i-entry_previously_added-3F">#entry_previously_added?</a>
-    <li ><a href="#method-i-file_written-3F">#file_written?</a>
-    <li ><a href="#method-i-header_depth-3D">#header_depth=</a>
-    <li ><a href="#method-i-impediments-3D">#impediments=</a>
-    <li ><a href="#method-i-load">#load</a>
-    <li ><a href="#method-i-new_month-3F">#new_month?</a>
-    <li ><a href="#method-i-notes-3D">#notes=</a>
-    <li ><a href="#method-i-previous_entry_tasks-3D">#previous_entry_tasks=</a>
-    <li ><a href="#method-i-reload">#reload</a>
-    <li ><a href="#method-i-sub_header_depth-3D">#sub_header_depth=</a>
-    <li ><a href="#method-i-sub_header_order">#sub_header_order</a>
-    <li ><a href="#method-i-sub_header_order-3D">#sub_header_order=</a>
-    <li ><a href="#method-i-write">#write</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="class-StandupMD">
-  <h1 id="class-StandupMD" class="class">
-    class StandupMD
-  </h1>
-  <section class="description">
-<p>The class for handing reading/writing of entries.</p>
-<p>@example</p>
-<pre class="ruby"><span class="ruby-identifier">su</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</span>
-</pre>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-      <div id="method-c-load" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">load</span><span
-            class="method-args">(attributes = {})</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Convenience method for calling <code>new</code> + <code>load</code></p>
-<p>@param [Hash] attributes Attributes to set before loading.</p>
-<p>@example</p>
-<pre class="ruby"><span class="ruby-identifier">su</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span>(<span class="ruby-value">bullet_character:</span> <span class="ruby-string">&#39;*&#39;</span>)
-</pre>
-          <div class="method-source-code" id="load-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 21</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load</span>(<span class="ruby-identifier">attributes</span> = {})
-  <span class="ruby-keyword">self</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">attributes</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-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">k</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>)
-    <span class="ruby-keyword">end</span>
-  <span class="ruby-keyword">end</span>.<span class="ruby-identifier">load</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-  </section>
-  <section id="Attributes+that+are+settable+by+the+user-2C+but+have+custom+setters." class="documentation-section">
-    <header class="documentation-section-title">
-      <h2>
-        Attributes that are settable by the user, but have custom setters.
-      </h2>
-      <span class="section-click-top">
-        <a href="#top">&uarr; top</a>
-      </span>
-    </header>
-    <section class="attribute-method-details" class="method-section">
-      <header>
-        <h3>Attributes</h3>
-      </header>
-      <div id="attribute-i-bullet_character" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">bullet_character</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>Character used as bullets for list entries.</p>
-<p>@return [String] either - (dash) or * (asterisk)</p>
-        </div>
-      </div>
-      <div id="attribute-i-current_entry_tasks" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">current_entry_tasks</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>Array of tasks for today. This is the work expected to be performed today. Default is an empty array, but when writing to file, the default is</p>
-<p>@return [Array]</p>
-<p>@default</p>
-<pre class="ruby">[<span class="ruby-string">&quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;</span>]
-</pre>
-        </div>
-      </div>
-      <div id="attribute-i-directory" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">directory</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The directory where the markdown files are kept.</p>
-<p>@return [String]</p>
-<p>@default</p>
-<pre class="ruby"><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>)
-</pre>
-        </div>
-      </div>
-      <div id="attribute-i-header_depth" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">header_depth</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>Number of octothorps that should preface entry headers.</p>
-<p>@return [Integer] between 1 and 5</p>
-        </div>
-      </div>
-      <div id="attribute-i-impediments" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">impediments</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>Array of impediments for today&#39;s entry.</p>
-<p>@return [Array]</p>
-        </div>
-      </div>
-      <div id="attribute-i-notes" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">notes</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>Array of notes to add to today&#39;s entry.</p>
-<p>@return [Array]</p>
-        </div>
-      </div>
-      <div id="attribute-i-previous_entry_tasks" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">previous_entry_tasks</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The tasks from the previous task&#39;s “Current” section.</p>
-<p>@return [Array]</p>
-        </div>
-      </div>
-      <div id="attribute-i-sub_header_depth" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">sub_header_depth</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>Number of octothorps that should preface sub-headers.</p>
-<p>@return [Integer] between 2 and 6</p>
-        </div>
-      </div>
-    </section>
-  </section>
-  <section id="Attributes+that+aren-27t+settable+by+user-2C+but+are+gettable." class="documentation-section">
-    <header class="documentation-section-title">
-      <h2>
-        Attributes that aren't settable by user, but are gettable.
-      </h2>
-      <span class="section-click-top">
-        <a href="#top">&uarr; top</a>
-      </span>
-    </header>
-    <section class="attribute-method-details" class="method-section">
-      <header>
-        <h3>Attributes</h3>
-      </header>
-      <div id="attribute-i-all_entries" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">all_entries</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>Current entry plus all previous entries. This will be a hash in the same format at <code>current_entry</code> and <code>all_previous_entries</code>.</p>
-<p>@return [Hash]</p>
-        </div>
-      </div>
-      <div id="attribute-i-all_previous_entries" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">all_previous_entries</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>All previous entry for the same month as today. If it&#39;s the first day of the month, <code>all_previous_entries</code> will be all of last month&#39;s entries. They will be a hash in the same format as <code>current_entry</code>.</p>
-<p>@return [Hash]</p>
-        </div>
-      </div>
-      <div id="attribute-i-current_entry" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">current_entry</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The entry for today&#39;s date as a hash. If <code>file</code> already has an entry for today, it will be read and used as <code>current_entry</code>. If there is no entry for today, one should be generated from scaffolding.</p>
-<p>@return [Hash]</p>
-<p>@example</p>
-<pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">current_entry</span>
-<span class="ruby-comment"># =&gt; {</span>
-<span class="ruby-comment">#      &#39;2020-04-02&#39; =&gt; {</span>
-<span class="ruby-comment">#        &#39;Previous&#39; =&gt; [&#39;Task from yesterday&#39;],</span>
-<span class="ruby-comment">#        &#39;Current&#39; =&gt; [&quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;],</span>
-<span class="ruby-comment">#        &#39;Impediments&#39; =&gt; [&#39;None&#39;],</span>
-<span class="ruby-comment">#        &#39;Notes&#39; =&gt; [],</span>
-<span class="ruby-comment">#      }</span>
-<span class="ruby-comment">#    }</span>
-</pre>
-        </div>
-      </div>
-      <div id="attribute-i-file" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">file</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The file name should equal <a href="StandupMD.html#attribute-i-file_name_format"><code>file_name_format</code></a> parsed by Date.strftime. The default is +Date.today.strftime(&#39;%Y_%m.md&#39;)+</p>
-<p>@return [String]</p>
-<p>@example</p>
-<pre class="ruby"><span class="ruby-identifier">su</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</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">file_name_format</span> = <span class="ruby-string">&#39;%y_%m.markdown&#39;</span> }
-<span class="ruby-identifier">su</span>.<span class="ruby-identifier">file</span>
-<span class="ruby-comment"># =&gt; Users/johnsmith/.cache/standup_md/20_04.markdown</span>
-</pre>
-        </div>
-      </div>
-      <div id="attribute-i-header" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">header</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The string that will be used for the entry headers.</p>
-<p>@return [String]</p>
-        </div>
-      </div>
-      <div id="attribute-i-previous_file" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">previous_file</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The file that contains previous entries. When last month&#39;s file exists, but this month&#39;s doesn&#39;t or is empty, <a href="StandupMD.html#attribute-i-previous_file"><code>previous_file</code></a> should equal last month&#39;s file.</p>
-<p>@return [String]</p>
-<p>@example</p>
-<pre class="ruby"><span class="ruby-comment"># Assuming the current month is April, 2020</span>
-<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">entries</span>(<span class="ruby-identifier">su</span>.<span class="ruby-identifier">directory</span>)
-<span class="ruby-comment"># =&gt; []</span>
-<span class="ruby-identifier">su</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</span>
-<span class="ruby-identifier">su</span>.<span class="ruby-identifier">previous_file</span>
-<span class="ruby-comment"># =&gt; &#39;&#39;</span>
-<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">entries</span>(<span class="ruby-identifier">su</span>.<span class="ruby-identifier">directory</span>)
-<span class="ruby-comment"># =&gt; [&#39;2020_03.md&#39;]</span>
-<span class="ruby-identifier">su</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</span>
-<span class="ruby-identifier">su</span>.<span class="ruby-identifier">previous_file</span>
-<span class="ruby-comment"># =&gt; &#39;2020_03.md&#39;</span>
-<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">entries</span>(<span class="ruby-identifier">su</span>.<span class="ruby-identifier">directory</span>)
-<span class="ruby-comment"># =&gt; [&#39;2020_03.md&#39;, &#39;2020_04.md&#39;]</span>
-<span class="ruby-identifier">su</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</span>
-<span class="ruby-identifier">su</span>.<span class="ruby-identifier">previous_file</span>
-<span class="ruby-comment"># =&gt; &#39;2020_04.md&#39;</span>
-</pre>
-        </div>
-      </div>
-    </section>
-  </section>
-  <section id="Attributes+with+default+getters+and+setters." class="documentation-section">
-    <header class="documentation-section-title">
-      <h2>
-        Attributes with default getters and setters.
-      </h2>
-      <span class="section-click-top">
-        <a href="#top">&uarr; top</a>
-      </span>
-    </header>
-    <section class="attribute-method-details" class="method-section">
-      <header>
-        <h3>Attributes</h3>
-      </header>
-      <div id="attribute-i-current_header" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">current_header</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>The header to use for the <code>Current</code> section.</p>
-<p>@param [String] <a href="StandupMD.html#attribute-i-current_header"><code>current_header</code></a></p>
-<p>@return [String]</p>
-        </div>
-      </div>
-      <div id="attribute-i-file_name_format" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">file_name_format</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>The format to use for file names. This should include a month (%m) and year (%y) so the file can rotate every month. This will prevent files from getting too large.</p>
-<p>@param [String] <a href="StandupMD.html#attribute-i-file_name_format"><code>file_name_format</code></a> Parsed by <code>strftime</code></p>
-<p>@return [String]</p>
-        </div>
-      </div>
-      <div id="attribute-i-header_date_format" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">header_date_format</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>The date format to use for entry headers.</p>
-<p>@param [String] <a href="StandupMD.html#attribute-i-header_date_format"><code>header_date_format</code></a> Parsed by <code>strftime</code></p>
-<p>@return [String]</p>
-        </div>
-      </div>
-      <div id="attribute-i-impediments_header" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">impediments_header</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>The header to use for the <code>Impediments</code> section.</p>
-<p>@param [String] <a href="StandupMD.html#attribute-i-impediments_header"><code>impediments_header</code></a></p>
-<p>@return [String]</p>
-        </div>
-      </div>
-      <div id="attribute-i-notes_header" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">notes_header</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>The header to use for the <code>Notes</code> section.</p>
-<p>@param [String] <a href="StandupMD.html#attribute-i-notes_header"><code>notes_header</code></a></p>
-<p>@return [String]</p>
-        </div>
-      </div>
-      <div id="attribute-i-previous_header" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">previous_header</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>The header to use for the <code>Previous</code> section.</p>
-<p>@param [String] <a href="StandupMD.html#attribute-i-previous_header"><code>previous_header</code></a></p>
-<p>@return [String]</p>
-        </div>
-      </div>
-    </section>
-     <section id="public-class-Attributes+with+default+getters+and+setters.-method-details" class="method-section">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-      <div id="method-c-new" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">new</span><span
-            class="method-args">() { |self| ... }</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Constructor. Yields the instance so you can pass a block to access setters.</p>
-<p>@return [self]</p>
-<p>@example</p>
-<pre class="ruby"><span class="ruby-identifier">su</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">s</span>.<span class="ruby-identifier">directory</span> = <span class="ruby-ivar">@workdir</span>
-  <span class="ruby-identifier">s</span>.<span class="ruby-identifier">file_name_format</span> = <span class="ruby-string">&#39;%y_%m.markdown&#39;</span>
-  <span class="ruby-identifier">s</span>.<span class="ruby-identifier">bullet_character</span> = <span class="ruby-string">&#39;*&#39;</span>
-<span class="ruby-keyword">end</span>
-</pre>
-          <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 233</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
-  <span class="ruby-ivar">@notes</span> = []
-  <span class="ruby-ivar">@header_depth</span> = <span class="ruby-value">1</span>
-  <span class="ruby-ivar">@sub_header_depth</span> = <span class="ruby-value">2</span>
-  <span class="ruby-ivar">@bullet_character</span> = <span class="ruby-string">&#39;-&#39;</span>
-  <span class="ruby-ivar">@current_entry_tasks</span> = [<span class="ruby-string">&quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;</span>]
-  <span class="ruby-ivar">@impediments</span> = [<span class="ruby-string">&#39;None&#39;</span>]
-  <span class="ruby-ivar">@file_name_format</span> = <span class="ruby-string">&#39;%Y_%m.md&#39;</span>
-  <span class="ruby-ivar">@directory</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-ivar">@header_date_format</span> = <span class="ruby-string">&#39;%Y-%m-%d&#39;</span>
-  <span class="ruby-ivar">@current_header</span> = <span class="ruby-string">&#39;Current&#39;</span>
-  <span class="ruby-ivar">@previous_header</span> = <span class="ruby-string">&#39;Previous&#39;</span>
-  <span class="ruby-ivar">@impediments_header</span> = <span class="ruby-string">&#39;Impediments&#39;</span>
-  <span class="ruby-ivar">@notes_header</span> = <span class="ruby-string">&#39;Notes&#39;</span>
-  <span class="ruby-ivar">@sub_header_order</span> = <span class="ruby-node">%w[previous current impediments notes]</span>
-  <span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-  </section>
-  <section id="Booleans" class="documentation-section">
-    <header class="documentation-section-title">
-      <h2>
-        Booleans
-      </h2>
-      <span class="section-click-top">
-        <a href="#top">&uarr; top</a>
-      </span>
-    </header>
-     <section id="public-instance-Booleans-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-entry_previously_added-3F" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">entry_previously_added?</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Was today&#39;s entry already in the file?</p>
-<p>@return [boolean] true if today&#39;s entry was already in the file</p>
-          <div class="method-source-code" id="entry_previously_added-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 275</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">entry_previously_added?</span>
-  <span class="ruby-ivar">@entry_previously_added</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-file_written-3F" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">file_written?</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Has the file been written since instantiated?</p>
-<p>@return [boolean]</p>
-<p>@example</p>
-<pre class="ruby"><span class="ruby-identifier">su</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</span>
-<span class="ruby-identifier">su</span>.<span class="ruby-identifier">file_written?</span>
-<span class="ruby-comment"># =&gt; false</span>
-<span class="ruby-identifier">su</span>.<span class="ruby-identifier">write</span>
-<span class="ruby-identifier">su</span>.<span class="ruby-identifier">file_written?</span>
-<span class="ruby-comment"># =&gt; true</span>
-</pre>
-          <div class="method-source-code" id="file_written-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 267</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">file_written?</span>
-  <span class="ruby-ivar">@file_written</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-  </section>
-  <section id="Custom+setters" class="documentation-section">
-    <header class="documentation-section-title">
-      <h2>
-        Custom setters
-      </h2>
-      <span class="section-click-top">
-        <a href="#top">&uarr; top</a>
-      </span>
-    </header>
-     <section id="public-instance-Custom+setters-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-bullet_character-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">bullet_character=</span><span
-            class="method-args">(character)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Setter for bullet_character. Must be * (asterisk) or - (dash).</p>
-<p>@param [String] character</p>
-<p>@return [String]</p>
-          <div class="method-source-code" id="bullet_character-3D-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 332</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bullet_character=</span>(<span class="ruby-identifier">character</span>)
-  <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Must be &quot;-&quot; or &quot;*&quot;&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-node">%w[- *]</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">character</span>)
-  <span class="ruby-ivar">@bullet_character</span> = <span class="ruby-identifier">character</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-current_entry_tasks-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">current_entry_tasks=</span><span
-            class="method-args">(tasks)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Setter for current entry tasks.</p>
-<p>@param [Array] tasks</p>
-<p>@return [Array]</p>
-          <div class="method-source-code" id="current_entry_tasks-3D-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 310</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">current_entry_tasks=</span>(<span class="ruby-identifier">tasks</span>)
-  <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Must be an Array&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
-  <span class="ruby-ivar">@current_entry_tasks</span> = <span class="ruby-identifier">tasks</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-directory-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">directory=</span><span
-            class="method-args">(directory)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn&#39;t exist, it will be created. To reset instance variables after changing the directory, you&#39;ll need to call load.</p>
-<p>@param [String] directory</p>
-<p>@return [String]</p>
-          <div class="method-source-code" id="directory-3D-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 345</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">directory=</span>(<span class="ruby-identifier">directory</span>)
-  <span class="ruby-comment"># TODO test this</span>
-  <span class="ruby-identifier">directory</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">directory</span>)
-  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">directory</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">directory</span>)
-  <span class="ruby-ivar">@directory</span> = <span class="ruby-identifier">directory</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-header_depth-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">header_depth=</span><span
-            class="method-args">(depth)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Number of octothorps (#) to use before the main header.</p>
-<p>@param [Integer] depth</p>
-<p>@return [Integer]</p>
-          <div class="method-source-code" id="header_depth-3D-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 358</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">header_depth=</span>(<span class="ruby-identifier">depth</span>)
-  <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">depth</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-value">1</span>, <span class="ruby-value">5</span>)
-    <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Header depth out of bounds (1..5)&#39;</span>
-  <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">depth</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-identifier">sub_header_depth</span>
-    <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;header_depth must be larger than sub_header_depth&#39;</span>
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-ivar">@header_depth</span> = <span class="ruby-identifier">depth</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-impediments-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">impediments=</span><span
-            class="method-args">(tasks)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Setter for impediments.</p>
-<p>@param [Array] tasks</p>
-<p>@return [Array]</p>
-          <div class="method-source-code" id="impediments-3D-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 321</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">impediments=</span>(<span class="ruby-identifier">tasks</span>)
-  <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Must be an Array&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
-  <span class="ruby-ivar">@impediments</span> = <span class="ruby-identifier">tasks</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
+    <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+  <ul class="link-list" role="directory">
-      <div id="method-i-notes-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">notes=</span><span
-            class="method-args">(tasks)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Setter for notes.</p>
-<p>@param [Array] notes</p>
-<p>@return [Array]</p>
-          <div class="method-source-code" id="notes-3D-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 299</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">notes=</span>(<span class="ruby-identifier">tasks</span>)
-  <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Must be an Array&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
-  <span class="ruby-ivar">@notes</span> = <span class="ruby-identifier">tasks</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
+    <li ><a href="#method-c-config">::config</a>
-      <div id="method-i-previous_entry_tasks-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">previous_entry_tasks=</span><span
-            class="method-args">(tasks)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Setter for current entry tasks.</p>
-<p>@param [Array] tasks</p>
-<p>@return [Array]</p>
-          <div class="method-source-code" id="previous_entry_tasks-3D-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 288</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">previous_entry_tasks=</span>(<span class="ruby-identifier">tasks</span>)
-  <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Must be an Array&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
-  <span class="ruby-ivar">@previous_entry_tasks</span> = <span class="ruby-identifier">tasks</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
+    <li ><a href="#method-c-config_file_loaded-3F">::config_file_loaded?</a>
-      <div id="method-i-sub_header_depth-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">sub_header_depth=</span><span
-            class="method-args">(depth)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).</p>
-<p>@param [Integer] depth</p>
-<p>@return [Integer]</p>
-          <div class="method-source-code" id="sub_header_depth-3D-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 373</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_depth=</span>(<span class="ruby-identifier">depth</span>)
-  <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">depth</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-value">2</span>, <span class="ruby-value">6</span>)
-    <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Sub-header depth out of bounds (2..6)&#39;</span>
-  <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">depth</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">header_depth</span>
-    <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;sub_header_depth must be smaller than header_depth&#39;</span>
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-ivar">@sub_header_depth</span> = <span class="ruby-identifier">depth</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
+    <li ><a href="#method-c-configure">::configure</a>
-      <div id="method-i-sub_header_order-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">sub_header_order=</span><span
-            class="method-args">(array)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Preferred order for sub-headers.</p>
-<p>@param [Array] Values must be %w[previous current impediment notes]</p>
-<p>@return [Array]</p>
-          <div class="method-source-code" id="sub_header_order-3D-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 388</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_order=</span>(<span class="ruby-identifier">array</span>)
-  <span class="ruby-identifier">order</span> = <span class="ruby-node">%w[previous current impediments notes]</span>
-  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Values must be #{order.join{&#39;, &#39;}}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">order</span>.<span class="ruby-identifier">sort</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">array</span>.<span class="ruby-identifier">sort</span>
-  <span class="ruby-ivar">@sub_header_order</span> = <span class="ruby-identifier">array</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
+    <li ><a href="#method-c-load_config_file">::load_config_file</a>
+    <li ><a href="#method-c-reset_config">::reset_config</a>
+  </ul>
+</div>
+  </div>
+</nav>
-      </div>
+<main role="main" aria-labelledby="module-StandupMD">
+  <h1 id="module-StandupMD" class="module">
+    module StandupMD
+  </h1>
+  <section class="description">
-    </section>
+<p>The class for handing reading/writing of entries.</p>
   </section>
-  <section id="Misc" class="documentation-section">
-    <header class="documentation-section-title">
-      <h2>
-        Misc
-      </h2>
-      <span class="section-click-top">
-        <a href="#top">&uarr; top</a>
-      </span>
-    </header>
+  <section id="5Buntitled-5D" class="documentation-section">
@@ -1255,11 +112,7 @@
         <dd><p>The gem verision</p>
-<p>@example</p>
-<pre class="ruby"><span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
-<span class="ruby-comment"># =&gt; &#39;0.1.1&#39;</span>
-</pre>
+<p>@return [String]</p>
       </dl>
@@ -1269,16 +122,16 @@
-     <section id="public-instance-Misc-method-details" class="method-section">
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
        <header>
-         <h3>Public Instance Methods</h3>
+         <h3>Public Class Methods</h3>
        </header>
-      <div id="method-i-load" class="method-detail ">
+      <div id="method-c-config" class="method-detail ">
         <div class="method-heading">
-          <span class="method-name">load</span><span
+          <span class="method-name">config</span><span
             class="method-args">()</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -1288,50 +141,32 @@
         <div class="method-description">
-          <p>Sets internal instance variables. Called when first instantiated, or after directory is set.</p>
+          <p>Method for accessing the configuration.</p>
-<p>@return [self]</p>
+<p>@return [StanupMD::Cli]</p>
-          <div class="method-source-code" id="load-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 431</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load</span>
-  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">directory</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">directory</span>)
-  <span class="ruby-ivar">@today</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>
-  <span class="ruby-ivar">@header</span> = <span class="ruby-identifier">today</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-identifier">header_date_format</span>)
-  <span class="ruby-ivar">@file_written</span> = <span class="ruby-keyword">false</span>
-  <span class="ruby-ivar">@file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">directory</span>, <span class="ruby-identifier">today</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-identifier">file_name_format</span>)))
-  <span class="ruby-ivar">@previous_file</span> = <span class="ruby-identifier">get_previous_file</span>
-  <span class="ruby-ivar">@all_previous_entries</span> = <span class="ruby-identifier">get_all_previous_entries</span>
-  <span class="ruby-ivar">@entry_previously_added</span> = <span class="ruby-identifier">all_previous_entries</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">header</span>)
-  <span class="ruby-ivar">@previous_entry_tasks</span> = <span class="ruby-identifier">previous_entry</span>[<span class="ruby-identifier">current_header</span>]
-  <span class="ruby-ivar">@current_entry</span> = <span class="ruby-ivar">@all_previous_entries</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">header</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">new_entry</span>
-  <span class="ruby-ivar">@all_entries</span> = {<span class="ruby-identifier">header</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">current_entry</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">all_previous_entries</span>)
-  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">touch</span>(<span class="ruby-identifier">file</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">file</span>)
-  <span class="ruby-keyword">self</span>
+          <div class="method-source-code" id="config-source">
+            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 19</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
+  <span class="ruby-ivar">@config</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
         </div>
-        <div class="aliases">
-          Also aliased as: <a href="StandupMD.html#method-i-reload">reload</a>
-        </div>
       </div>
-      <div id="method-i-new_month-3F" class="method-detail ">
+      <div id="method-c-config_file_loaded-3F" class="method-detail ">
         <div class="method-heading">
-          <span class="method-name">new_month?</span><span
+          <span class="method-name">config_file_loaded?</span><span
             class="method-args">()</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -1341,15 +176,17 @@
         <div class="method-description">
-          <p>Is today a different month than the previous entry?</p>
+          <p>Has a config file been loaded?</p>
+<p>@return [Boolean]</p>
-          <div class="method-source-code" id="new_month-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 457</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new_month?</span>
-  <span class="ruby-identifier">file</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">previous_file</span>
+          <div class="method-source-code" id="config_file_loaded-3F-source">
+            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 44</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config_file_loaded?</span>
+  <span class="ruby-ivar">@config_file_loaded</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -1361,41 +198,49 @@
       </div>
-      <div id="method-i-reload" class="method-detail method-alias">
+      <div id="method-c-configure" class="method-detail ">
         <div class="method-heading">
-          <span class="method-name">reload</span><span
-            class="method-args">()</span>
+          <span class="method-name">configure</span><span
+            class="method-args">() { |config| ... }</span>
+          <span class="method-click-advice">click to toggle source</span>
         </div>
         <div class="method-description">
-          <p>Alias of <code>load</code></p>
+          <p>Allows for configuration via a block. Useful when making config files.</p>
+<p>@example</p>
-<p>@return [self]</p>
+<pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</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">cli</span>.<span class="ruby-identifier">editor</span> = <span class="ruby-string">&#39;mate&#39;</span> }
+</pre>
+          <div class="method-source-code" id="configure-source">
+            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 36</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">configure</span>
+  <span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">config</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
         </div>
-        <div class="aliases">
-          Alias for: <a href="StandupMD.html#method-i-load">load</a>
-        </div>
       </div>
-      <div id="method-i-sub_header_order" class="method-detail ">
+      <div id="method-c-load_config_file" class="method-detail ">
         <div class="method-heading">
-          <span class="method-name">sub_header_order</span><span
-            class="method-args">()</span>
+          <span class="method-name">load_config_file</span><span
+            class="method-args">(file)</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -1404,17 +249,20 @@
         <div class="method-description">
-          <p>Return a copy of the sub-header order so the user can&#39;t modify the array.</p>
+          <p>Loads a config file.</p>
-<p>@return [Array]</p>
+<p>@param [String] file</p>
-          <div class="method-source-code" id="sub_header_order-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 401</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_order</span>
-  <span class="ruby-ivar">@sub_header_order</span>.<span class="ruby-identifier">dup</span>
+          <div class="method-source-code" id="load_config_file-source">
+            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 52</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load_config_file</span>(<span class="ruby-identifier">file</span>)
+  <span class="ruby-identifier">file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">file</span>)
+  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{file} does not exist.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">file</span>)
+  <span class="ruby-ivar">@config_file_loaded</span> = <span class="ruby-keyword">true</span>
+  <span class="ruby-identifier">load</span> <span class="ruby-identifier">file</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -1426,10 +274,10 @@
       </div>
-      <div id="method-i-write" class="method-detail ">
+      <div id="method-c-reset_config" class="method-detail ">
         <div class="method-heading">
-          <span class="method-name">write</span><span
+          <span class="method-name">reset_config</span><span
             class="method-args">()</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -1439,30 +287,17 @@
         <div class="method-description">
-          <p>Writes a new entry to the file if the first entry in the file isn&#39;t today.</p>
+          <p>Reset all configuration values to their defaults.</p>
-<p>@return [Boolean]</p>
+<p>@return [StandupMD::Config]</p>
-          <div class="method-source-code" id="write-source">
-            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 409</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>
-  <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">file</span>, <span class="ruby-string">&#39;w&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
-    <span class="ruby-identifier">all_entries</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">head</span>, <span class="ruby-identifier">s_heads</span><span class="ruby-operator">|</span>
-      <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;#&#39;</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">header_depth</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39; &#39;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">head</span>
-      <span class="ruby-identifier">sub_header_order</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-node">&quot;#{value}_header&quot;</span> }.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sub_head</span><span class="ruby-operator">|</span>
-        <span class="ruby-identifier">sh</span> = <span class="ruby-identifier">send</span>(<span class="ruby-identifier">sub_head</span>).<span class="ruby-identifier">capitalize</span>
-        <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">s_heads</span>[<span class="ruby-identifier">sh</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">s_heads</span>[<span class="ruby-identifier">sh</span>].<span class="ruby-identifier">empty?</span>
-        <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;#&#39;</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">sub_header_depth</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39; &#39;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">sh</span>
-        <span class="ruby-identifier">s_heads</span>[<span class="ruby-identifier">sh</span>].<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">bullet_character</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39; &#39;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">task</span> }
-      <span class="ruby-keyword">end</span>
-      <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span>
-      <span class="ruby-keyword">return</span> <span class="ruby-ivar">@file_written</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">new_month?</span>
-    <span class="ruby-keyword">end</span>
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-ivar">@file_written</span> = <span class="ruby-keyword">true</span>
+          <div class="method-source-code" id="reset_config-source">
+            <pre><span class="ruby-comment"># File lib/standup_md.rb, line 27</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">reset_config</span>
+  <span class="ruby-ivar">@config</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>
 <span class="ruby-keyword">end</span></pre>
           </div>