standup_md 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ea914496579afb896f1251193f0d9787c172bb38fc2d4e7954954a07a3acde03
4
- data.tar.gz: f2b5239e1e8445a782f56521c1e484d5acf4bb5570c960b6c8d1cfb81d84c36b
3
+ metadata.gz: 57bd78bfdaa77fe7ba0aba95d28beaa44515adfca40fb5668aea94a1164fc0ce
4
+ data.tar.gz: f33a68f119e7661b780be8aa19f202a0e83ed0d9a36bddfae294d697b5aa4901
5
5
  SHA512:
6
- metadata.gz: 6dccea1152f691f7d4a05a41a2a0eb84871e4e516e55d278e8cb8a4800c1cbeb675126bb70149ee45b5f277678cefa66b5b6567dd0e0f1187fde194db132ac25
7
- data.tar.gz: df6d4257bad9e773292483cb5a8d31beabc3eb79ad3d0242b7d96720a81fb6bd926171cde460a0babc64fc735ddd2b79a89192a8bd995f8953562ecfffb46aa7
6
+ metadata.gz: '08dc58ef8c87d92e13261032c8836b9555244ad22f9243e7b91732aa20a5a6c1ab6b032739bde51a92c145318d08c2f2858c16e31cfc02aaded2017988a66ba6'
7
+ data.tar.gz: 10f91dc30a6afcbc0b68ae1e7ea253a8292102b63de47e66877d889b640953a2fb91f9c8e249443762b6c93bc300e39b522d6ad6c9739b6d21464a87e33d8104
data/README.md CHANGED
@@ -76,7 +76,7 @@ rake install
76
76
 
77
77
  ## Usage
78
78
  ### Command Line
79
- For the most basic usage, simplyt call the executable.
79
+ For the most basic usage, simply call the executable.
80
80
 
81
81
  ```sh
82
82
  standup
@@ -267,20 +267,20 @@ Your `~/.standuprc` should contain:
267
267
 
268
268
  ```ruby
269
269
  StandupMD.configure do |c|
270
- c.file.header_depth 2
271
- c.file.sub_header_depth 3
272
- c.file.current_header Today
273
- c.file.previous_header Yesterday
274
- c.file.impediments_header Hold-ups
275
- c.file.bullet_character '*'
276
- c.file.header_date_format '%m/%d/%Y'
277
- c.file.sub_header_order = %w[current previous impediments notes]
270
+ c.file.header_depth = 2
271
+ c.file.sub_header_depth = 3
272
+ c.file.current_header = 'Today'
273
+ c.file.previous_header = 'Yesterday'
274
+ c.file.impediments_header = 'Hold-ups'
275
+ c.file.bullet_character = '*'
276
+ c.file.header_date_format = '%m/%d/%Y'
277
+ c.file.sub_header_order = %w[current previous impediments notes]
278
278
  end
279
279
  ```
280
280
 
281
281
  ## API
282
282
  The API is fully documented in the
283
- [documentation](https://evanthegrayt.github.io/standup_md/doc/index.html).
283
+ [RDoc Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html).
284
284
 
285
285
  This was mainly written as a command line utility, but the API is ridiculously
286
286
  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:
290
290
 
291
291
  ```ruby
292
292
  require 'standup_md'
293
- require 'date'
294
293
 
295
294
  StandupMD.configure do |c|
296
295
  c.file.current_header = 'Today',
@@ -307,7 +306,6 @@ API fit together. The code can actually be simplified to the following.
307
306
 
308
307
  ```ruby
309
308
  require 'standup_md'
310
- require 'date'
311
309
 
312
310
  StandupMD.configure do |c|
313
311
  c.file.current_header = 'Today',
@@ -188,7 +188,7 @@ rake install
188
188
 
189
189
  <h3 id="label-Command+Line">Command Line<span><a href="#label-Command+Line">&para;</a> <a href="#top">&uarr;</a></span></h3>
190
190
 
191
- <p>For the most basic usage, simplyt call the executable.</p>
191
+ <p>For the most basic usage, simply call the executable.</p>
192
192
 
193
193
  <pre class="ruby"><span class="ruby-identifier">standup</span>
194
194
  </pre>
@@ -337,27 +337,26 @@ rake install
337
337
  <p>Your <code>~/.standuprc</code> should contain:</p>
338
338
 
339
339
  <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>
340
- <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>
341
- <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>
342
- <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>
343
- <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>
344
- <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>
345
- <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>
346
- <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>
347
- <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>
340
+ <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>
341
+ <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>
342
+ <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>
343
+ <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>
344
+ <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>
345
+ <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>
346
+ <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>
347
+ <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>
348
348
  <span class="ruby-keyword">end</span>
349
349
  </pre>
350
350
 
351
351
  <h2 id="label-API">API<span><a href="#label-API">&para;</a> <a href="#top">&uarr;</a></span></h2>
352
352
 
353
- <p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">documentation</a>.</p>
353
+ <p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">RDoc Documentation</a>.</p>
354
354
 
355
355
  <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>
356
356
 
357
357
  <h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
358
358
 
359
359
  <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
360
- <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
361
360
 
362
361
  <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>
363
362
  <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
372
371
  <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>
373
372
 
374
373
  <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
375
- <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
376
374
 
377
375
  <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>
378
376
  <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>,
@@ -112,11 +112,7 @@
112
112
 
113
113
  <dd><p>The gem verision</p>
114
114
 
115
- <p>@example</p>
116
-
117
- <pre class="ruby"><span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
118
- <span class="ruby-comment"># =&gt; &#39;0.3.0&#39;</span>
119
- </pre>
115
+ <p>@return [String]</p>
120
116
 
121
117
 
122
118
  </dl>
@@ -145,7 +141,7 @@
145
141
 
146
142
  <div class="method-description">
147
143
 
148
- <p>Shorthand for <code>StanupMD::Cli</code></p>
144
+ <p>Method for accessing the configuration.</p>
149
145
 
150
146
  <p>@return [StanupMD::Cli]</p>
151
147
 
@@ -77,7 +77,7 @@
77
77
 
78
78
  <li ><a href="#method-c-new">::new</a>
79
79
 
80
- <li ><a href="#method-i-reset_values">#reset_values</a>
80
+ <li ><a href="#method-i-reset">#reset</a>
81
81
 
82
82
  </ul>
83
83
  </div>
@@ -278,7 +278,7 @@
278
278
  <div class="method-source-code" id="new-source">
279
279
  <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 78</span>
280
280
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
281
- <span class="ruby-identifier">reset_values</span>
281
+ <span class="ruby-identifier">reset</span>
282
282
  <span class="ruby-keyword">end</span></pre>
283
283
  </div>
284
284
 
@@ -298,10 +298,10 @@
298
298
  </header>
299
299
 
300
300
 
301
- <div id="method-i-reset_values" class="method-detail ">
301
+ <div id="method-i-reset" class="method-detail ">
302
302
 
303
303
  <div class="method-heading">
304
- <span class="method-name">reset_values</span><span
304
+ <span class="method-name">reset</span><span
305
305
  class="method-args">()</span>
306
306
 
307
307
  <span class="method-click-advice">click to toggle source</span>
@@ -318,9 +318,9 @@
318
318
 
319
319
 
320
320
 
321
- <div class="method-source-code" id="reset_values-source">
321
+ <div class="method-source-code" id="reset-source">
322
322
  <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 86</span>
323
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
323
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
324
324
  <span class="ruby-ivar">@date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>
325
325
  <span class="ruby-ivar">@editor</span> = <span class="ruby-identifier">set_editor</span>
326
326
  <span class="ruby-ivar">@verbose</span> = <span class="ruby-keyword">false</span>
@@ -77,7 +77,7 @@
77
77
 
78
78
  <li ><a href="#method-c-new">::new</a>
79
79
 
80
- <li ><a href="#method-i-reset_values">#reset_values</a>
80
+ <li ><a href="#method-i-reset">#reset</a>
81
81
 
82
82
  </ul>
83
83
  </div>
@@ -210,7 +210,7 @@
210
210
  <div class="method-source-code" id="new-source">
211
211
  <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 44</span>
212
212
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
213
- <span class="ruby-identifier">reset_values</span>
213
+ <span class="ruby-identifier">reset</span>
214
214
  <span class="ruby-keyword">end</span></pre>
215
215
  </div>
216
216
 
@@ -230,10 +230,10 @@
230
230
  </header>
231
231
 
232
232
 
233
- <div id="method-i-reset_values" class="method-detail ">
233
+ <div id="method-i-reset" class="method-detail ">
234
234
 
235
235
  <div class="method-heading">
236
- <span class="method-name">reset_values</span><span
236
+ <span class="method-name">reset</span><span
237
237
  class="method-args">()</span>
238
238
 
239
239
  <span class="method-click-advice">click to toggle source</span>
@@ -250,9 +250,9 @@
250
250
 
251
251
 
252
252
 
253
- <div class="method-source-code" id="reset_values-source">
253
+ <div class="method-source-code" id="reset-source">
254
254
  <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 52</span>
255
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
255
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
256
256
  <span class="ruby-ivar">@current</span> = [<span class="ruby-string">&quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;</span>]
257
257
  <span class="ruby-ivar">@previous</span> = []
258
258
  <span class="ruby-ivar">@impediments</span> = [<span class="ruby-string">&#39;None&#39;</span>]
@@ -77,7 +77,7 @@
77
77
 
78
78
  <li ><a href="#method-i-initalize">#initalize</a>
79
79
 
80
- <li ><a href="#method-i-reset_values">#reset_values</a>
80
+ <li ><a href="#method-i-reset">#reset</a>
81
81
 
82
82
  </ul>
83
83
  </div>
@@ -134,7 +134,7 @@
134
134
  <div class="method-source-code" id="initalize-source">
135
135
  <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 12</span>
136
136
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initalize</span>
137
- <span class="ruby-identifier">reset_values</span>
137
+ <span class="ruby-identifier">reset</span>
138
138
  <span class="ruby-keyword">end</span></pre>
139
139
  </div>
140
140
 
@@ -146,10 +146,10 @@
146
146
  </div>
147
147
 
148
148
 
149
- <div id="method-i-reset_values" class="method-detail ">
149
+ <div id="method-i-reset" class="method-detail ">
150
150
 
151
151
  <div class="method-heading">
152
- <span class="method-name">reset_values</span><span
152
+ <span class="method-name">reset</span><span
153
153
  class="method-args">()</span>
154
154
 
155
155
  <span class="method-click-advice">click to toggle source</span>
@@ -166,9 +166,9 @@
166
166
 
167
167
 
168
168
 
169
- <div class="method-source-code" id="reset_values-source">
169
+ <div class="method-source-code" id="reset-source">
170
170
  <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 20</span>
171
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
171
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
172
172
  <span class="ruby-comment"># TODO add order ascending or decending.</span>
173
173
  <span class="ruby-keyword">true</span>
174
174
  <span class="ruby-keyword">end</span></pre>
@@ -83,7 +83,7 @@
83
83
 
84
84
  <li ><a href="#method-i-header_depth-3D">#header_depth=</a>
85
85
 
86
- <li ><a href="#method-i-reset_values">#reset_values</a>
86
+ <li ><a href="#method-i-reset">#reset</a>
87
87
 
88
88
  <li ><a href="#method-i-sub_header_depth-3D">#sub_header_depth=</a>
89
89
 
@@ -366,7 +366,7 @@
366
366
  <div class="method-source-code" id="new-source">
367
367
  <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 118</span>
368
368
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
369
- <span class="ruby-identifier">reset_values</span>
369
+ <span class="ruby-identifier">reset</span>
370
370
  <span class="ruby-keyword">end</span></pre>
371
371
  </div>
372
372
 
@@ -505,10 +505,10 @@
505
505
  </div>
506
506
 
507
507
 
508
- <div id="method-i-reset_values" class="method-detail ">
508
+ <div id="method-i-reset" class="method-detail ">
509
509
 
510
510
  <div class="method-heading">
511
- <span class="method-name">reset_values</span><span
511
+ <span class="method-name">reset</span><span
512
512
  class="method-args">()</span>
513
513
 
514
514
  <span class="method-click-advice">click to toggle source</span>
@@ -525,9 +525,9 @@
525
525
 
526
526
 
527
527
 
528
- <div class="method-source-code" id="reset_values-source">
528
+ <div class="method-source-code" id="reset-source">
529
529
  <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 126</span>
530
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
530
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
531
531
  <span class="ruby-ivar">@header_date_format</span> = <span class="ruby-string">&#39;%Y-%m-%d&#39;</span>
532
532
  <span class="ruby-ivar">@header_depth</span> = <span class="ruby-value">1</span>
533
533
  <span class="ruby-ivar">@sub_header_depth</span> = <span class="ruby-value">2</span>
@@ -81,6 +81,8 @@
81
81
 
82
82
  <li ><a href="#method-c-find_by_date">::find_by_date</a>
83
83
 
84
+ <li ><a href="#method-c-load">::load</a>
85
+
84
86
  <li ><a href="#method-c-new">::new</a>
85
87
 
86
88
  <li ><a href="#method-i-exist-3F">#exist?</a>
@@ -221,7 +223,7 @@
221
223
 
222
224
 
223
225
  <div class="method-source-code" id="find-source">
224
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 26</span>
226
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 36</span>
225
227
  <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>)
226
228
  <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> }
227
229
  <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 @@
260
262
 
261
263
 
262
264
  <div class="method-source-code" id="find_by_date-source">
263
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 38</span>
265
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 48</span>
264
266
  <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>)
265
267
  <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>)
266
268
  <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 @@
274
276
 
275
277
 
276
278
 
279
+ </div>
280
+
281
+
282
+ <div id="method-c-load" class="method-detail ">
283
+
284
+ <div class="method-heading">
285
+ <span class="method-name">load</span><span
286
+ class="method-args">(file_name)</span>
287
+
288
+ <span class="method-click-advice">click to toggle source</span>
289
+
290
+ </div>
291
+
292
+
293
+ <div class="method-description">
294
+
295
+ <p>Convenience method for calling <a href="File.html#method-c-find"><code>File.find(file_name)</code></a>.load</p>
296
+
297
+ <p>@param [String] file_name</p>
298
+
299
+ <p>@return [StandupMD::File]</p>
300
+
301
+
302
+
303
+
304
+ <div class="method-source-code" id="load-source">
305
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 28</span>
306
+ <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>)
307
+ <span class="ruby-identifier">new</span>(<span class="ruby-identifier">file_name</span>).<span class="ruby-identifier">load</span>
308
+ <span class="ruby-keyword">end</span></pre>
309
+ </div>
310
+
311
+ </div>
312
+
313
+
314
+
315
+
277
316
  </div>
278
317
 
279
318
 
@@ -300,7 +339,7 @@
300
339
 
301
340
 
302
341
  <div class="method-source-code" id="new-source">
303
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 63</span>
342
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 73</span>
304
343
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">file_name</span>)
305
344
  <span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
306
345
  <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 @@
362
401
 
363
402
 
364
403
  <div class="method-source-code" id="exist-3F-source">
365
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 106</span>
404
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 116</span>
366
405
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">exist?</span>
367
406
  <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">name</span>)
368
407
  <span class="ruby-keyword">end</span></pre>
@@ -397,7 +436,7 @@
397
436
 
398
437
 
399
438
  <div class="method-source-code" id="load-source">
400
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 115</span>
439
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 125</span>
401
440
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load</span>
402
441
  <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>)
403
442
  <span class="ruby-identifier">entry_list</span> = <span class="ruby-constant">EntryList</span>.<span class="ruby-identifier">new</span>
@@ -459,7 +498,7 @@
459
498
 
460
499
 
461
500
  <div class="method-source-code" id="loaded-3F-source">
462
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 98</span>
501
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 108</span>
463
502
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">loaded?</span>
464
503
  <span class="ruby-ivar">@loaded</span>
465
504
  <span class="ruby-keyword">end</span></pre>
@@ -494,7 +533,7 @@
494
533
 
495
534
 
496
535
  <div class="method-source-code" id="new-3F-source">
497
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 90</span>
536
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 100</span>
498
537
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new?</span>
499
538
  <span class="ruby-ivar">@new</span>
500
539
  <span class="ruby-keyword">end</span></pre>
@@ -531,7 +570,7 @@
531
570
 
532
571
 
533
572
  <div class="method-source-code" id="write-source">
534
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 154</span>
573
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 164</span>
535
574
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">dates</span> = {})
536
575
  <span class="ruby-identifier">sorted_entries</span> = <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">sort</span>
537
576
  <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>)
@@ -1,15 +1,15 @@
1
- Wed, 10 Jun 2020 22:30:11 -0500
2
- README.md Wed, 10 Jun 2020 22:23:37 -0500
3
- lib/standup_md.rb Wed, 10 Jun 2020 22:23:37 -0500
1
+ Wed, 10 Jun 2020 22:58:32 -0500
2
+ README.md Wed, 10 Jun 2020 22:49:25 -0500
3
+ lib/standup_md.rb Wed, 10 Jun 2020 22:56:15 -0500
4
4
  lib/standup_md/cli.rb Wed, 10 Jun 2020 22:23:37 -0500
5
5
  lib/standup_md/cli/helpers.rb Wed, 10 Jun 2020 22:23:37 -0500
6
6
  lib/standup_md/config.rb Wed, 10 Jun 2020 22:23:37 -0500
7
- lib/standup_md/config/cli.rb Wed, 10 Jun 2020 22:23:37 -0500
8
- lib/standup_md/config/entry.rb Wed, 10 Jun 2020 22:23:37 -0500
9
- lib/standup_md/config/entry_list.rb Wed, 10 Jun 2020 22:23:37 -0500
10
- lib/standup_md/config/file.rb Wed, 10 Jun 2020 22:23:37 -0500
7
+ lib/standup_md/config/cli.rb Wed, 10 Jun 2020 22:57:56 -0500
8
+ lib/standup_md/config/entry.rb Wed, 10 Jun 2020 22:58:08 -0500
9
+ lib/standup_md/config/entry_list.rb Wed, 10 Jun 2020 22:58:03 -0500
10
+ lib/standup_md/config/file.rb Wed, 10 Jun 2020 22:58:00 -0500
11
11
  lib/standup_md/entry.rb Wed, 10 Jun 2020 22:23:37 -0500
12
12
  lib/standup_md/entry_list.rb Wed, 10 Jun 2020 22:23:37 -0500
13
- lib/standup_md/file.rb Wed, 10 Jun 2020 22:25:24 -0500
13
+ lib/standup_md/file.rb Wed, 10 Jun 2020 22:42:40 -0500
14
14
  lib/standup_md/file/helpers.rb Wed, 10 Jun 2020 22:23:37 -0500
15
- lib/standup_md/version.rb Wed, 10 Jun 2020 22:30:02 -0500
15
+ lib/standup_md/version.rb Wed, 10 Jun 2020 22:54:17 -0500
@@ -190,7 +190,7 @@ rake install
190
190
 
191
191
  <h3 id="label-Command+Line">Command Line<span><a href="#label-Command+Line">&para;</a> <a href="#top">&uarr;</a></span></h3>
192
192
 
193
- <p>For the most basic usage, simplyt call the executable.</p>
193
+ <p>For the most basic usage, simply call the executable.</p>
194
194
 
195
195
  <pre class="ruby"><span class="ruby-identifier">standup</span>
196
196
  </pre>
@@ -339,27 +339,26 @@ rake install
339
339
  <p>Your <code>~/.standuprc</code> should contain:</p>
340
340
 
341
341
  <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>
342
- <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>
343
- <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>
344
- <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>
345
- <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>
346
- <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>
347
- <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>
348
- <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>
349
- <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>
342
+ <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>
343
+ <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>
344
+ <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>
345
+ <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>
346
+ <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>
347
+ <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>
348
+ <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>
349
+ <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>
350
350
  <span class="ruby-keyword">end</span>
351
351
  </pre>
352
352
 
353
353
  <h2 id="label-API">API<span><a href="#label-API">&para;</a> <a href="#top">&uarr;</a></span></h2>
354
354
 
355
- <p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">documentation</a>.</p>
355
+ <p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">RDoc Documentation</a>.</p>
356
356
 
357
357
  <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>
358
358
 
359
359
  <h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
360
360
 
361
361
  <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
362
- <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
363
362
 
364
363
  <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>
365
364
  <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
374
373
  <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>
375
374
 
376
375
  <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
377
- <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
378
376
 
379
377
  <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>
380
378
  <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>,
@@ -1 +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\n

StandupMD.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

"]]}}
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()","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\n

StandupMD.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

"]]}}
Binary file
@@ -150,9 +150,9 @@
150
150
  <ul>
151
151
 
152
152
  <li class="method">
153
- <a href="StandupMD/Entry.html#method-c-config">::config</a>
153
+ <a href="StandupMD/Cli.html#method-c-config">::config</a>
154
154
  &mdash;
155
- <span class="container">StandupMD::Entry</span>
155
+ <span class="container">StandupMD::Cli</span>
156
156
 
157
157
  <li class="method">
158
158
  <a href="StandupMD/File.html#method-c-config">::config</a>
@@ -160,19 +160,19 @@
160
160
  <span class="container">StandupMD::File</span>
161
161
 
162
162
  <li class="method">
163
- <a href="StandupMD/Cli.html#method-c-config">::config</a>
163
+ <a href="StandupMD/Entry.html#method-c-config">::config</a>
164
164
  &mdash;
165
- <span class="container">StandupMD::Cli</span>
165
+ <span class="container">StandupMD::Entry</span>
166
166
 
167
167
  <li class="method">
168
- <a href="StandupMD.html#method-c-config">::config</a>
168
+ <a href="StandupMD/EntryList.html#method-c-config">::config</a>
169
169
  &mdash;
170
- <span class="container">StandupMD</span>
170
+ <span class="container">StandupMD::EntryList</span>
171
171
 
172
172
  <li class="method">
173
- <a href="StandupMD/EntryList.html#method-c-config">::config</a>
173
+ <a href="StandupMD.html#method-c-config">::config</a>
174
174
  &mdash;
175
- <span class="container">StandupMD::EntryList</span>
175
+ <span class="container">StandupMD</span>
176
176
 
177
177
  <li class="method">
178
178
  <a href="StandupMD.html#method-c-config_file_loaded-3F">::config_file_loaded?</a>
@@ -210,14 +210,14 @@
210
210
  <span class="container">StandupMD::File</span>
211
211
 
212
212
  <li class="method">
213
- <a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
213
+ <a href="StandupMD/File.html#method-c-load">::load</a>
214
214
  &mdash;
215
- <span class="container">StandupMD</span>
215
+ <span class="container">StandupMD::File</span>
216
216
 
217
217
  <li class="method">
218
- <a href="StandupMD/EntryList.html#method-c-new">::new</a>
218
+ <a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
219
219
  &mdash;
220
- <span class="container">StandupMD::EntryList</span>
220
+ <span class="container">StandupMD</span>
221
221
 
222
222
  <li class="method">
223
223
  <a href="StandupMD/Config/File.html#method-c-new">::new</a>
@@ -225,9 +225,9 @@
225
225
  <span class="container">StandupMD::Config::File</span>
226
226
 
227
227
  <li class="method">
228
- <a href="StandupMD/File.html#method-c-new">::new</a>
228
+ <a href="StandupMD/Cli.html#method-c-new">::new</a>
229
229
  &mdash;
230
- <span class="container">StandupMD::File</span>
230
+ <span class="container">StandupMD::Cli</span>
231
231
 
232
232
  <li class="method">
233
233
  <a href="StandupMD/Config.html#method-c-new">::new</a>
@@ -235,25 +235,30 @@
235
235
  <span class="container">StandupMD::Config</span>
236
236
 
237
237
  <li class="method">
238
- <a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
238
+ <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
239
239
  &mdash;
240
- <span class="container">StandupMD::Config::Entry</span>
240
+ <span class="container">StandupMD::Config::Cli</span>
241
241
 
242
242
  <li class="method">
243
- <a href="StandupMD/Cli.html#method-c-new">::new</a>
243
+ <a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
244
244
  &mdash;
245
- <span class="container">StandupMD::Cli</span>
245
+ <span class="container">StandupMD::Config::Entry</span>
246
246
 
247
247
  <li class="method">
248
- <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
248
+ <a href="StandupMD/File.html#method-c-new">::new</a>
249
249
  &mdash;
250
- <span class="container">StandupMD::Config::Cli</span>
250
+ <span class="container">StandupMD::File</span>
251
251
 
252
252
  <li class="method">
253
253
  <a href="StandupMD/Entry.html#method-c-new">::new</a>
254
254
  &mdash;
255
255
  <span class="container">StandupMD::Entry</span>
256
256
 
257
+ <li class="method">
258
+ <a href="StandupMD/EntryList.html#method-c-new">::new</a>
259
+ &mdash;
260
+ <span class="container">StandupMD::EntryList</span>
261
+
257
262
  <li class="method">
258
263
  <a href="StandupMD.html#method-c-reset_config">::reset_config</a>
259
264
  &mdash;
@@ -370,24 +375,24 @@
370
375
  <span class="container">StandupMD::Cli::Helpers</span>
371
376
 
372
377
  <li class="method">
373
- <a href="StandupMD/Config/File.html#method-i-reset_values">#reset_values</a>
378
+ <a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
374
379
  &mdash;
375
- <span class="container">StandupMD::Config::File</span>
380
+ <span class="container">StandupMD::Config::Entry</span>
376
381
 
377
382
  <li class="method">
378
- <a href="StandupMD/Config/Cli.html#method-i-reset_values">#reset_values</a>
383
+ <a href="StandupMD/Config/Cli.html#method-i-reset">#reset</a>
379
384
  &mdash;
380
385
  <span class="container">StandupMD::Config::Cli</span>
381
386
 
382
387
  <li class="method">
383
- <a href="StandupMD/Config/Entry.html#method-i-reset_values">#reset_values</a>
388
+ <a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
384
389
  &mdash;
385
- <span class="container">StandupMD::Config::Entry</span>
390
+ <span class="container">StandupMD::Config::EntryList</span>
386
391
 
387
392
  <li class="method">
388
- <a href="StandupMD/Config/EntryList.html#method-i-reset_values">#reset_values</a>
393
+ <a href="StandupMD/Config/File.html#method-i-reset">#reset</a>
389
394
  &mdash;
390
- <span class="container">StandupMD::Config::EntryList</span>
395
+ <span class="container">StandupMD::Config::File</span>
391
396
 
392
397
  <li class="method">
393
398
  <a href="StandupMD/EntryList.html#method-i-size">#size</a>
@@ -425,14 +430,14 @@
425
430
  <span class="container">StandupMD::Entry</span>
426
431
 
427
432
  <li class="method">
428
- <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
433
+ <a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
429
434
  &mdash;
430
- <span class="container">StandupMD::EntryList</span>
435
+ <span class="container">StandupMD::Entry</span>
431
436
 
432
437
  <li class="method">
433
- <a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
438
+ <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
434
439
  &mdash;
435
- <span class="container">StandupMD::Entry</span>
440
+ <span class="container">StandupMD::EntryList</span>
436
441
 
437
442
  <li class="method">
438
443
  <a href="StandupMD/File.html#method-i-write">#write</a>
@@ -13,7 +13,7 @@ module StandupMD
13
13
  @config_file_loaded = false
14
14
 
15
15
  ##
16
- # Shorthand for +StanupMD::Cli+
16
+ # Method for accessing the configuration.
17
17
  #
18
18
  # @return [StanupMD::Cli]
19
19
  def self.config
@@ -76,14 +76,14 @@ module StandupMD
76
76
  ##
77
77
  # Initializes the config with default values.
78
78
  def initialize
79
- reset_values
79
+ reset
80
80
  end
81
81
 
82
82
  ##
83
83
  # Sets all config values back to their defaults.
84
84
  #
85
85
  # @return [Boolean] true if successful
86
- def reset_values
86
+ def reset
87
87
  @date = Date.today
88
88
  @editor = set_editor
89
89
  @verbose = false
@@ -42,14 +42,14 @@ module StandupMD
42
42
  ##
43
43
  # Initializes the config with default values.
44
44
  def initialize
45
- reset_values
45
+ reset
46
46
  end
47
47
 
48
48
  ##
49
49
  # Sets all config values back to their defaults.
50
50
  #
51
51
  # @return [Boolean] true if successful
52
- def reset_values
52
+ def reset
53
53
  @current = ["<!-- ADD TODAY'S WORK HERE -->"]
54
54
  @previous = []
55
55
  @impediments = ['None']
@@ -10,14 +10,14 @@ module StandupMD
10
10
  ##
11
11
  # Initializes the config with default values.
12
12
  def initalize
13
- reset_values
13
+ reset
14
14
  end
15
15
 
16
16
  ##
17
17
  # Sets all config values back to their defaults.
18
18
  #
19
19
  # @return [Boolean] true if successful
20
- def reset_values
20
+ def reset
21
21
  # TODO add order ascending or decending.
22
22
  true
23
23
  end
@@ -116,14 +116,14 @@ module StandupMD
116
116
  ##
117
117
  # Initializes the config with default values.
118
118
  def initialize
119
- reset_values
119
+ reset
120
120
  end
121
121
 
122
122
  ##
123
123
  # Sets all config values back to their defaults.
124
124
  #
125
125
  # @return [Boolean] true if successful
126
- def reset_values
126
+ def reset
127
127
  @header_date_format = '%Y-%m-%d'
128
128
  @header_depth = 1
129
129
  @sub_header_depth = 2
@@ -19,6 +19,16 @@ module StandupMD
19
19
  @config ||= StandupMD.config.file
20
20
  end
21
21
 
22
+ ##
23
+ # Convenience method for calling File.find(file_name).load
24
+ #
25
+ # @param [String] file_name
26
+ #
27
+ # @return [StandupMD::File]
28
+ def self.load(file_name)
29
+ new(file_name).load
30
+ end
31
+
22
32
  ##
23
33
  # Find standup file in directory by file name.
24
34
  #
@@ -4,8 +4,6 @@ module StandupMD
4
4
  ##
5
5
  # The gem verision
6
6
  #
7
- # @example
8
- # StandupMD::VERSION
9
- # # => '0.3.0'
10
- VERSION = '0.3.1'
7
+ # @return [String]
8
+ VERSION = '0.3.2'
11
9
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: standup_md
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Evan Gray