standup_md 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 242a29dbf1c80aad455f52db138b1a8bae0f04d3d2fa7274800ec69d8b5b9b74
-  data.tar.gz: dbe432dfa8b42deb98d03bd3131bfdd8a79df77fd162a6a04af4f0c99837524b
+  metadata.gz: dd735414b7813027d5cf22c4296befd4f0f2b5d7e0276c9aa875d913bd69f560
+  data.tar.gz: 5c5bdf62d893c182d5137b46634841f0d576e2798baa918b84b1344d8232890f
 SHA512:
-  metadata.gz: 7d3014ead364eea9aa5584207fd1a3cf8ae099b18b0f7b0afef3642adb20565c4741d010b92d104d191405fc7b05a929f05d0af089d0a9544325f490b0f74277
-  data.tar.gz: 63f257db8bd154170580ee1379dbe2942c412438fce6879b685cd3d236b9fee3edb6df985499284dd2000bc712ae81305712d20f9ec50dc1b8d1567e1698a2b6
+  metadata.gz: 1793f0a0b80bcc58ed60c7be24409609aa0b9ccc6f7c1dd26237f1a6b9584219c933b87c60fb1c3c32a2c40aa3e2ba480b1b01541b6a2b91dff8f25c058abd13
+  data.tar.gz: 688cbf9c52807916da3f9320fff8665a2eec816ca86480cd491619541514f858f14a46d365bf99cbadf52dc355d44d8c3915b21303249b87a207958da4cd875c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standup_md (0.3.0)
+    standup_md (0.3.4)
 
 GEM
   remote: https://rubygems.org/
@@ -13,7 +13,7 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
-    test-unit (3.3.5)
+    test-unit (3.3.6)
       power_assert
 
 PLATFORMS

data/README.md

@@ -28,6 +28,8 @@ View on: [Github](https://github.com/evanthegrayt/standup_md) |
     - [Using existing standup files](#using-existing-standup-files)
   - [API](#api)
     - [API Examples](#api-examples)
+      - [Adding an entry for today](#adding-an-entry-for-today)
+      - [Finding a past entry](#finding-a-past-entry)
     - [Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html)
 - [Reporting Bugs and Requesting Features](#reporting-bugs-and-requesting-features)
 - [Self-Promotion](#self-promotion)
@@ -49,6 +51,11 @@ entry exists, it will be added to today's entry as your previous day's work. See
 in your own code somehow.
 
 ## Installation
+If you don't have the permissions to install system-wide gems, you're probabaly
+also running an older version of ruby. I recommend installing
+[rbenv](https://github.com/rbenv/rbenv#installation), and then installing an
+up-to-date version of ruby.
+
 ### Via RubyGems
 Just install the gem!
 
@@ -76,7 +83,7 @@ rake install
 
 ## Usage
 ### Command Line
-For the most basic usage, simplyt call the executable.
+For the most basic usage, simply call the executable.
 
 ```sh
 standup
@@ -132,7 +139,7 @@ result to the command line, you could use the following.
 
 #### Add entry to file without opening it
 ```sh
-standup --no-edit --current "Work on this thing","And another thing" -p
+standup --no-edit --current "Work on this thing","And another thing"
 ```
 
 #### Find an entry by date and print it.
@@ -167,6 +174,8 @@ them again.
 
 
 #### Available Config File Options and Defaults
+For command-line usage, this file needs to be named `~/.standuprc`. To use in a
+rails project, create an initializer (`config/initializers/standup_md.rb`).
 
 ```ruby
 StandupMD.configure do |c|
@@ -205,7 +214,14 @@ StandupMD.configure do |c|
 end
 ```
 
+Any options not set in this file will retain their default values. Note that if
+you change `file_name_format`, and don'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.
+
+
 #### Executable Flags
+Some of these options can be changed at runtime. They are as follows.
 ```
     --current ARRAY            List of current entry's tasks
     --previous ARRAY           List of precious entry's tasks
@@ -224,11 +240,6 @@ end
                                DATE must be in the same format as file-name-format
 ```
 
-Any options not set in this file will retain their default values. Note that if
-you change `file_name_format`, and don'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.
-
 #### Using Existing Standup Files
 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:
@@ -267,30 +278,29 @@ Your `~/.standuprc` should contain:
 
 ```ruby
 StandupMD.configure do |c|
-  c.file.header_depth        2
-  c.file.sub_header_depth    3
-  c.file.current_header      Today
-  c.file.previous_header     Yesterday
-  c.file.impediments_header  Hold-ups
-  c.file.bullet_character    '*'
-  c.file.header_date_format  '%m/%d/%Y'
-  c.file.sub_header_order = %w[current previous impediments notes]
+  c.file.header_depth       = 2
+  c.file.sub_header_depth   = 3
+  c.file.current_header     = 'Today'
+  c.file.previous_header    = 'Yesterday'
+  c.file.impediments_header = 'Hold-ups'
+  c.file.bullet_character   = '*'
+  c.file.header_date_format = '%m/%d/%Y'
+  c.file.sub_header_order   = %w[current previous impediments notes]
 end
 ```
 
 ## API
 The API is fully documented in the
-[documentation](https://evanthegrayt.github.io/standup_md/doc/index.html).
+[RDoc Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html).
 
 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:
 
 ### API Examples
-
+#### Adding an entry for today
 ```ruby
 require 'standup_md'
-require 'date'
 
 StandupMD.configure do |c|
   c.file.current_header = 'Today',
@@ -307,7 +317,6 @@ API fit together. The code can actually be simplified to the following.
 
 ```ruby
 require 'standup_md'
-require 'date'
 
 StandupMD.configure do |c|
   c.file.current_header = 'Today',
@@ -317,6 +326,15 @@ end
 StandupMD::File.find_by_date(Date.today).load.write
 ```
 
+#### Finding a past entry
+```ruby
+require 'standup_md'
+
+date = Date.new(2020, 04, 15)
+file = StandupMD::File.find_by_date(date).load
+entry = file.entries.find(date)
+```
+
 ## Reporting Bugs and Requesting Features
 If you have an idea or find a bug, please [create an
 issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure the topic

data/doc/README_md.html

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

data/doc/StandupMD.html

@@ -91,7 +91,7 @@
 
   <section class="description">
     
-<p>The class for handing reading/writing of entries.</p>
+<p>The main module for the gem. Provides access to configuration classes.</p>
 
   </section>
 
@@ -112,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.3.0&#39;</span>
-</pre>
+<p>@return [String]</p>
         
       
       </dl>
@@ -145,7 +141,7 @@
 
         <div class="method-description">
           
-          <p>Shorthand for <code>StanupMD::Cli</code></p>
+          <p>Method for accessing the configuration.</p>
 
 <p>@return [StanupMD::Cli]</p>
           

data/doc/StandupMD/Cli/Helpers.html

@@ -133,11 +133,11 @@
     <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;No record found for #{StandupMD.config.cli.date}&quot;</span>
     <span class="ruby-keyword">return</span>
   <span class="ruby-keyword">end</span>
-  <span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;#&#39;</span> <span class="ruby-operator">*</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</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">entry</span>.<span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span>)
-  <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span>
-    <span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">attr</span>)
+  <span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-identifier">entry</span>)
+  <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">header_type</span><span class="ruby-operator">|</span>
+    <span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">public_send</span>(<span class="ruby-identifier">header_type</span>)
     <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">tasks</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">empty?</span>
-    <span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;#&#39;</span> <span class="ruby-operator">*</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</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-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{attr}_header&quot;</span>).<span class="ruby-identifier">capitalize</span>
+    <span class="ruby-identifier">puts</span> <span class="ruby-identifier">sub_header</span>(<span class="ruby-identifier">header_type</span>)
     <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> <span class="ruby-identifier">puts</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</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">puts</span>

data/doc/StandupMD/Config.html

@@ -198,7 +198,7 @@
 
           
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/config.rb, line 38</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/config.rb, line 40</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
   <span class="ruby-ivar">@cli</span>        = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">Cli</span>.<span class="ruby-identifier">new</span>
   <span class="ruby-ivar">@file</span>       = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>

data/doc/StandupMD/Config/Cli.html

@@ -77,7 +77,7 @@
     
     <li ><a href="#method-c-new">::new</a>
     
-    <li ><a href="#method-i-reset_values">#reset_values</a>
+    <li ><a href="#method-i-reset">#reset</a>
     
   </ul>
 </div>
@@ -103,6 +103,22 @@
     
 
     
+    <section class="constants-list">
+      <header>
+        <h3>Constants</h3>
+      </header>
+      <dl>
+      
+        <dt id="DEFAULTS">DEFAULTS
+        
+        <dd><p>The default options.</p>
+
+<p>@return [Hash]</p>
+        
+      
+      </dl>
+    </section>
+    
 
     
     <section class="attribute-method-details" class="method-section">
@@ -136,7 +152,7 @@
 
         <div class="method-description">
         
-        <p>The date to use to find the file.</p>
+        <p>The date to use to find the entry.</p>
 
 <p>@param [Date] date</p>
 
@@ -204,7 +220,7 @@
 
         <div class="method-description">
         
-        <p>Should the cli print the entry?</p>
+        <p>Should the cli print the entry to the command line?</p>
 
 <p>@param [Boolean] print</p>
 
@@ -238,7 +254,7 @@
 
         <div class="method-description">
         
-        <p>Should the cli write the file?</p>
+        <p>Should the cli automatically write the new entry to the file?</p>
 
 <p>@param [Boolean] write</p>
 
@@ -276,9 +292,9 @@
 
           
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 78</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 96</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
-  <span class="ruby-identifier">reset_values</span>
+  <span class="ruby-identifier">reset</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
           
@@ -298,10 +314,10 @@
        </header>
 
     
-      <div id="method-i-reset_values" class="method-detail ">
+      <div id="method-i-reset" class="method-detail ">
         
         <div class="method-heading">
-          <span class="method-name">reset_values</span><span
+          <span class="method-name">reset</span><span
             class="method-args">()</span>
           
           <span class="method-click-advice">click to toggle source</span>
@@ -313,22 +329,15 @@
           
           <p>Sets all config values back to their defaults.</p>
 
-<p>@return [Boolean] true if successful</p>
+<p>@return [Hash]</p>
           
           
 
           
-          <div class="method-source-code" id="reset_values-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 86</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
-  <span class="ruby-ivar">@date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>
-  <span class="ruby-ivar">@editor</span> = <span class="ruby-identifier">set_editor</span>
-  <span class="ruby-ivar">@verbose</span> = <span class="ruby-keyword">false</span>
-  <span class="ruby-ivar">@edit</span> = <span class="ruby-keyword">true</span>
-  <span class="ruby-ivar">@write</span> = <span class="ruby-keyword">true</span>
-  <span class="ruby-ivar">@print</span> = <span class="ruby-keyword">false</span>
-  <span class="ruby-ivar">@auto_fill_previous</span> = <span class="ruby-keyword">true</span>
-  <span class="ruby-ivar">@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>))
+          <div class="method-source-code" id="reset-source">
+            <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 104</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
+  <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{k}&quot;</span>, <span class="ruby-identifier">v</span>) }
 <span class="ruby-keyword">end</span></pre>
           </div>