standup_md 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea914496579afb896f1251193f0d9787c172bb38fc2d4e7954954a07a3acde03
-  data.tar.gz: f2b5239e1e8445a782f56521c1e484d5acf4bb5570c960b6c8d1cfb81d84c36b
+  metadata.gz: 57bd78bfdaa77fe7ba0aba95d28beaa44515adfca40fb5668aea94a1164fc0ce
+  data.tar.gz: f33a68f119e7661b780be8aa19f202a0e83ed0d9a36bddfae294d697b5aa4901
 SHA512:
-  metadata.gz: 6dccea1152f691f7d4a05a41a2a0eb84871e4e516e55d278e8cb8a4800c1cbeb675126bb70149ee45b5f277678cefa66b5b6567dd0e0f1187fde194db132ac25
-  data.tar.gz: df6d4257bad9e773292483cb5a8d31beabc3eb79ad3d0242b7d96720a81fb6bd926171cde460a0babc64fc735ddd2b79a89192a8bd995f8953562ecfffb46aa7
+  metadata.gz: '08dc58ef8c87d92e13261032c8836b9555244ad22f9243e7b91732aa20a5a6c1ab6b032739bde51a92c145318d08c2f2858c16e31cfc02aaded2017988a66ba6'
+  data.tar.gz: 10f91dc30a6afcbc0b68ae1e7ea253a8292102b63de47e66877d889b640953a2fb91f9c8e249443762b6c93bc300e39b522d6ad6c9739b6d21464a87e33d8104

data/README.md

@@ -76,7 +76,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
@@ -267,20 +267,20 @@ 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
@@ -290,7 +290,6 @@ to write a new entry via code could look like the following:
 
 ```ruby
 require 'standup_md'
-require 'date'
 
 StandupMD.configure do |c|
   c.file.current_header = 'Today',
@@ -307,7 +306,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',

data/doc/README_md.html

@@ -188,7 +188,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>
@@ -337,27 +337,26 @@ 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>
 
 <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 +371,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>,

data/doc/StandupMD.html

@@ -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/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>
@@ -278,7 +278,7 @@
           <div class="method-source-code" id="new-source">
             <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 78</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 +298,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>
@@ -318,9 +318,9 @@
           
 
           
-          <div class="method-source-code" id="reset_values-source">
+          <div class="method-source-code" id="reset-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-keyword">def</span> <span class="ruby-identifier ruby-title">reset</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>

data/doc/StandupMD/Config/Entry.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>
@@ -210,7 +210,7 @@
           <div class="method-source-code" id="new-source">
             <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 44</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>
           
@@ -230,10 +230,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>
@@ -250,9 +250,9 @@
           
 
           
-          <div class="method-source-code" id="reset_values-source">
+          <div class="method-source-code" id="reset-source">
             <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 52</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
   <span class="ruby-ivar">@current</span> = [<span class="ruby-string">&quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;</span>]
   <span class="ruby-ivar">@previous</span> = []
   <span class="ruby-ivar">@impediments</span> = [<span class="ruby-string">&#39;None&#39;</span>]

data/doc/StandupMD/Config/EntryList.html

@@ -77,7 +77,7 @@
     
     <li ><a href="#method-i-initalize">#initalize</a>
     
-    <li ><a href="#method-i-reset_values">#reset_values</a>
+    <li ><a href="#method-i-reset">#reset</a>
     
   </ul>
 </div>
@@ -134,7 +134,7 @@
           <div class="method-source-code" id="initalize-source">
             <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 12</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initalize</span>
-  <span class="ruby-identifier">reset_values</span>
+  <span class="ruby-identifier">reset</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
           
@@ -146,10 +146,10 @@
       </div>
 
     
-      <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>
@@ -166,9 +166,9 @@
           
 
           
-          <div class="method-source-code" id="reset_values-source">
+          <div class="method-source-code" id="reset-source">
             <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 20</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
   <span class="ruby-comment"># TODO add order ascending or decending.</span>
   <span class="ruby-keyword">true</span>
 <span class="ruby-keyword">end</span></pre>

data/doc/StandupMD/Config/File.html

@@ -83,7 +83,7 @@
     
     <li ><a href="#method-i-header_depth-3D">#header_depth=</a>
     
-    <li ><a href="#method-i-reset_values">#reset_values</a>
+    <li ><a href="#method-i-reset">#reset</a>
     
     <li ><a href="#method-i-sub_header_depth-3D">#sub_header_depth=</a>
     
@@ -366,7 +366,7 @@
           <div class="method-source-code" id="new-source">
             <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 118</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>
           
@@ -505,10 +505,10 @@
       </div>
 
     
-      <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>
@@ -525,9 +525,9 @@
           
 
           
-          <div class="method-source-code" id="reset_values-source">
+          <div class="method-source-code" id="reset-source">
             <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 126</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
   <span class="ruby-ivar">@header_date_format</span> = <span class="ruby-string">&#39;%Y-%m-%d&#39;</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>

data/doc/StandupMD/File.html

@@ -81,6 +81,8 @@
     
     <li ><a href="#method-c-find_by_date">::find_by_date</a>
     
+    <li ><a href="#method-c-load">::load</a>
+    
     <li ><a href="#method-c-new">::new</a>
     
     <li ><a href="#method-i-exist-3F">#exist?</a>
@@ -221,7 +223,7 @@
 
           
           <div class="method-source-code" id="find-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 26</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 36</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">file_name</span>)
   <span class="ruby-identifier">file</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">entries</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>).<span class="ruby-identifier">bsearch</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">file_name</span> }
   <span class="ruby-keyword">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
@@ -260,7 +262,7 @@
 
           
           <div class="method-source-code" id="find_by_date-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 38</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 48</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">find_by_date</span>(<span class="ruby-identifier">date</span>)
   <span class="ruby-keyword">unless</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Date</span>)
     <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Argument must be a Date object&quot;</span>
@@ -274,6 +276,43 @@
         
 
         
+      </div>
+
+    
+      <div id="method-c-load" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">load</span><span
+            class="method-args">(file_name)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Convenience method for calling <a href="File.html#method-c-find"><code>File.find(file_name)</code></a>.load</p>
+
+<p>@param [String] file_name</p>
+
+<p>@return [StandupMD::File]</p>
+          
+          
+
+          
+          <div class="method-source-code" id="load-source">
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 28</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load</span>(<span class="ruby-identifier">file_name</span>)
+  <span class="ruby-identifier">new</span>(<span class="ruby-identifier">file_name</span>).<span class="ruby-identifier">load</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
       </div>
 
     
@@ -300,7 +339,7 @@
 
           
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 63</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 73</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">file_name</span>)
   <span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
   <span class="ruby-keyword">if</span> <span class="ruby-identifier">file_name</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>)
@@ -362,7 +401,7 @@
 
           
           <div class="method-source-code" id="exist-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 106</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 116</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">exist?</span>
   <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">name</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -397,7 +436,7 @@
 
           
           <div class="method-source-code" id="load-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 115</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 125</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load</span>
   <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{name} does not exist.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">name</span>)
   <span class="ruby-identifier">entry_list</span> = <span class="ruby-constant">EntryList</span>.<span class="ruby-identifier">new</span>
@@ -459,7 +498,7 @@
 
           
           <div class="method-source-code" id="loaded-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 98</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 108</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">loaded?</span>
   <span class="ruby-ivar">@loaded</span>
 <span class="ruby-keyword">end</span></pre>
@@ -494,7 +533,7 @@
 
           
           <div class="method-source-code" id="new-3F-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 90</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 100</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new?</span>
   <span class="ruby-ivar">@new</span>
 <span class="ruby-keyword">end</span></pre>
@@ -531,7 +570,7 @@
 
           
           <div class="method-source-code" id="write-source">
-            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 154</span>
+            <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 164</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">dates</span> = {})
   <span class="ruby-identifier">sorted_entries</span> = <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">sort</span>
   <span class="ruby-identifier">start_date</span> = <span class="ruby-identifier">dates</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:start_date</span>, <span class="ruby-identifier">sorted_entries</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">date</span>)

data/doc/created.rid

@@ -1,15 +1,15 @@
-Wed, 10 Jun 2020 22:30:11 -0500
-README.md	Wed, 10 Jun 2020 22:23:37 -0500
-lib/standup_md.rb	Wed, 10 Jun 2020 22:23:37 -0500
+Wed, 10 Jun 2020 22:58:32 -0500
+README.md	Wed, 10 Jun 2020 22:49:25 -0500
+lib/standup_md.rb	Wed, 10 Jun 2020 22:56:15 -0500
 lib/standup_md/cli.rb	Wed, 10 Jun 2020 22:23:37 -0500
 lib/standup_md/cli/helpers.rb	Wed, 10 Jun 2020 22:23:37 -0500
 lib/standup_md/config.rb	Wed, 10 Jun 2020 22:23:37 -0500
-lib/standup_md/config/cli.rb	Wed, 10 Jun 2020 22:23:37 -0500
-lib/standup_md/config/entry.rb	Wed, 10 Jun 2020 22:23:37 -0500
-lib/standup_md/config/entry_list.rb	Wed, 10 Jun 2020 22:23:37 -0500
-lib/standup_md/config/file.rb	Wed, 10 Jun 2020 22:23:37 -0500
+lib/standup_md/config/cli.rb	Wed, 10 Jun 2020 22:57:56 -0500
+lib/standup_md/config/entry.rb	Wed, 10 Jun 2020 22:58:08 -0500
+lib/standup_md/config/entry_list.rb	Wed, 10 Jun 2020 22:58:03 -0500
+lib/standup_md/config/file.rb	Wed, 10 Jun 2020 22:58:00 -0500
 lib/standup_md/entry.rb	Wed, 10 Jun 2020 22:23:37 -0500
 lib/standup_md/entry_list.rb	Wed, 10 Jun 2020 22:23:37 -0500
-lib/standup_md/file.rb	Wed, 10 Jun 2020 22:25:24 -0500
+lib/standup_md/file.rb	Wed, 10 Jun 2020 22:42:40 -0500
 lib/standup_md/file/helpers.rb	Wed, 10 Jun 2020 22:23:37 -0500
-lib/standup_md/version.rb	Wed, 10 Jun 2020 22:30:02 -0500
+lib/standup_md/version.rb	Wed, 10 Jun 2020 22:54:17 -0500

data/doc/index.html

@@ -190,7 +190,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>
@@ -339,27 +339,26 @@ 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>
 
 <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
-<span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
 
 <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
   <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Today&#39;</span>,
@@ -374,7 +373,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>,

data/doc/js/search_index.js

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

data/doc/table_of_contents.html

@@ -150,9 +150,9 @@
 <ul>
 
   <li class="method">
-    <a href="StandupMD/Entry.html#method-c-config">::config</a>
+    <a href="StandupMD/Cli.html#method-c-config">::config</a>
     &mdash;
-    <span class="container">StandupMD::Entry</span>
+    <span class="container">StandupMD::Cli</span>
 
   <li class="method">
     <a href="StandupMD/File.html#method-c-config">::config</a>
@@ -160,19 +160,19 @@
     <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="StandupMD/Cli.html#method-c-config">::config</a>
+    <a href="StandupMD/Entry.html#method-c-config">::config</a>
     &mdash;
-    <span class="container">StandupMD::Cli</span>
+    <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-c-config">::config</a>
+    <a href="StandupMD/EntryList.html#method-c-config">::config</a>
     &mdash;
-    <span class="container">StandupMD</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
-    <a href="StandupMD/EntryList.html#method-c-config">::config</a>
+    <a href="StandupMD.html#method-c-config">::config</a>
     &mdash;
-    <span class="container">StandupMD::EntryList</span>
+    <span class="container">StandupMD</span>
 
   <li class="method">
     <a href="StandupMD.html#method-c-config_file_loaded-3F">::config_file_loaded?</a>
@@ -210,14 +210,14 @@
     <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
+    <a href="StandupMD/File.html#method-c-load">::load</a>
     &mdash;
-    <span class="container">StandupMD</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
-    <a href="StandupMD/EntryList.html#method-c-new">::new</a>
+    <a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
     &mdash;
-    <span class="container">StandupMD::EntryList</span>
+    <span class="container">StandupMD</span>
 
   <li class="method">
     <a href="StandupMD/Config/File.html#method-c-new">::new</a>
@@ -225,9 +225,9 @@
     <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
-    <a href="StandupMD/File.html#method-c-new">::new</a>
+    <a href="StandupMD/Cli.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">StandupMD::File</span>
+    <span class="container">StandupMD::Cli</span>
 
   <li class="method">
     <a href="StandupMD/Config.html#method-c-new">::new</a>
@@ -235,25 +235,30 @@
     <span class="container">StandupMD::Config</span>
 
   <li class="method">
-    <a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
+    <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">StandupMD::Config::Entry</span>
+    <span class="container">StandupMD::Config::Cli</span>
 
   <li class="method">
-    <a href="StandupMD/Cli.html#method-c-new">::new</a>
+    <a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">StandupMD::Cli</span>
+    <span class="container">StandupMD::Config::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
+    <a href="StandupMD/File.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">StandupMD::Config::Cli</span>
+    <span class="container">StandupMD::File</span>
 
   <li class="method">
     <a href="StandupMD/Entry.html#method-c-new">::new</a>
     &mdash;
     <span class="container">StandupMD::Entry</span>
 
+  <li class="method">
+    <a href="StandupMD/EntryList.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">StandupMD::EntryList</span>
+
   <li class="method">
     <a href="StandupMD.html#method-c-reset_config">::reset_config</a>
     &mdash;
@@ -370,24 +375,24 @@
     <span class="container">StandupMD::Cli::Helpers</span>
 
   <li class="method">
-    <a href="StandupMD/Config/File.html#method-i-reset_values">#reset_values</a>
+    <a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
     &mdash;
-    <span class="container">StandupMD::Config::File</span>
+    <span class="container">StandupMD::Config::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/Config/Cli.html#method-i-reset_values">#reset_values</a>
+    <a href="StandupMD/Config/Cli.html#method-i-reset">#reset</a>
     &mdash;
     <span class="container">StandupMD::Config::Cli</span>
 
   <li class="method">
-    <a href="StandupMD/Config/Entry.html#method-i-reset_values">#reset_values</a>
+    <a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
     &mdash;
-    <span class="container">StandupMD::Config::Entry</span>
+    <span class="container">StandupMD::Config::EntryList</span>
 
   <li class="method">
-    <a href="StandupMD/Config/EntryList.html#method-i-reset_values">#reset_values</a>
+    <a href="StandupMD/Config/File.html#method-i-reset">#reset</a>
     &mdash;
-    <span class="container">StandupMD::Config::EntryList</span>
+    <span class="container">StandupMD::Config::File</span>
 
   <li class="method">
     <a href="StandupMD/EntryList.html#method-i-size">#size</a>
@@ -425,14 +430,14 @@
     <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
+    <a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
     &mdash;
-    <span class="container">StandupMD::EntryList</span>
+    <span class="container">StandupMD::Entry</span>
 
   <li class="method">
-    <a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
+    <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
     &mdash;
-    <span class="container">StandupMD::Entry</span>
+    <span class="container">StandupMD::EntryList</span>
 
   <li class="method">
     <a href="StandupMD/File.html#method-i-write">#write</a>

data/lib/standup_md.rb

@@ -13,7 +13,7 @@ module StandupMD
   @config_file_loaded = false
 
   ##
-  # Shorthand for +StanupMD::Cli+
+  # Method for accessing the configuration.
   #
   # @return [StanupMD::Cli]
   def self.config

data/lib/standup_md/config/cli.rb

@@ -76,14 +76,14 @@ module StandupMD
       ##
       # Initializes the config with default values.
       def initialize
-        reset_values
+        reset
       end
 
       ##
       # Sets all config values back to their defaults.
       #
       # @return [Boolean] true if successful
-      def reset_values
+      def reset
         @date = Date.today
         @editor = set_editor
         @verbose = false

data/lib/standup_md/config/entry.rb

@@ -42,14 +42,14 @@ module StandupMD
       ##
       # Initializes the config with default values.
       def initialize
-        reset_values
+        reset
       end
 
       ##
       # Sets all config values back to their defaults.
       #
       # @return [Boolean] true if successful
-      def reset_values
+      def reset
         @current = ["<!-- ADD TODAY'S WORK HERE -->"]
         @previous = []
         @impediments = ['None']

data/lib/standup_md/config/entry_list.rb

@@ -10,14 +10,14 @@ module StandupMD
       ##
       # Initializes the config with default values.
       def initalize
-        reset_values
+        reset
       end
 
       ##
       # Sets all config values back to their defaults.
       #
       # @return [Boolean] true if successful
-      def reset_values
+      def reset
         # TODO add order ascending or decending.
         true
       end

data/lib/standup_md/config/file.rb

@@ -116,14 +116,14 @@ module StandupMD
       ##
       # Initializes the config with default values.
       def initialize
-        reset_values
+        reset
       end
 
       ##
       # Sets all config values back to their defaults.
       #
       # @return [Boolean] true if successful
-      def reset_values
+      def reset
         @header_date_format = '%Y-%m-%d'
         @header_depth = 1
         @sub_header_depth = 2

data/lib/standup_md/file.rb

@@ -19,6 +19,16 @@ module StandupMD
       @config ||= StandupMD.config.file
     end
 
+    ##
+    # Convenience method for calling File.find(file_name).load
+    #
+    # @param [String] file_name
+    #
+    # @return [StandupMD::File]
+    def self.load(file_name)
+      new(file_name).load
+    end
+
     ##
     # Find standup file in directory by file name.
     #

data/lib/standup_md/version.rb

@@ -4,8 +4,6 @@ module StandupMD
   ##
   # The gem verision
   #
-  # @example
-  #  StandupMD::VERSION
-  #  # => '0.3.0'
-  VERSION = '0.3.1'
+  # @return [String]
+  VERSION = '0.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Evan Gray