standup_md 0.1.3 → 0.2.0
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 +4 -4
- data/README.md +63 -9
- data/Rakefile +11 -28
- data/doc/README_md.html +55 -7
- data/doc/StandupMD.html +331 -266
- data/doc/StandupMD/Cli.html +27 -22
- data/doc/created.rid +5 -8
- data/doc/index.html +54 -13
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search_index.js +1 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +11 -275
- data/lib/standup_md.rb +71 -32
- data/lib/standup_md/cli.rb +10 -6
- data/lib/standup_md/version.rb +2 -2
- metadata +2 -5
- data/doc/TestCli.html +0 -792
- data/doc/TestHelper.html +0 -282
- data/doc/TestStandupMD.html +0 -1354
data/doc/StandupMD/Cli.html
CHANGED
@@ -216,7 +216,7 @@
|
|
216
216
|
|
217
217
|
|
218
218
|
<div class="method-source-code" id="execute-source">
|
219
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
219
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 17</span>
|
220
220
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">execute</span>(<span class="ruby-identifier">options</span> = [])
|
221
221
|
<span class="ruby-identifier">exe</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
|
222
222
|
<span class="ruby-identifier">exe</span>.<span class="ruby-identifier">append_to_previous_entry_tasks</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exe</span>.<span class="ruby-identifier">should_append?</span>
|
@@ -257,7 +257,7 @@
|
|
257
257
|
|
258
258
|
|
259
259
|
<div class="method-source-code" id="new-source">
|
260
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
260
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 43</span>
|
261
261
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span>)
|
262
262
|
<span class="ruby-ivar">@edit</span> = <span class="ruby-keyword">true</span>
|
263
263
|
<span class="ruby-ivar">@write</span> = <span class="ruby-keyword">true</span>
|
@@ -308,7 +308,7 @@
|
|
308
308
|
|
309
309
|
|
310
310
|
<div class="method-source-code" id="append_previous-3F-source">
|
311
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
311
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 207</span>
|
312
312
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">append_previous?</span>
|
313
313
|
<span class="ruby-ivar">@append_previous</span>
|
314
314
|
<span class="ruby-keyword">end</span></pre>
|
@@ -343,7 +343,7 @@
|
|
343
343
|
|
344
344
|
|
345
345
|
<div class="method-source-code" id="append_to_previous_entry_tasks-source">
|
346
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
346
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 132</span>
|
347
347
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">append_to_previous_entry_tasks</span>
|
348
348
|
<span class="ruby-identifier">echo</span> <span class="ruby-string">'Appending previous entry tasks'</span>
|
349
349
|
<span class="ruby-identifier">additions</span> = <span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">'previous_entry_tasks'</span>)
|
@@ -380,7 +380,7 @@
|
|
380
380
|
|
381
381
|
|
382
382
|
<div class="method-source-code" id="echo-source">
|
383
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
383
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 223</span>
|
384
384
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">echo</span>(<span class="ruby-identifier">msg</span>)
|
385
385
|
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">msg</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">verbose?</span>
|
386
386
|
<span class="ruby-keyword">end</span></pre>
|
@@ -413,9 +413,9 @@
|
|
413
413
|
|
414
414
|
|
415
415
|
<div class="method-source-code" id="edit-source">
|
416
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
416
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 140</span>
|
417
417
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">edit</span>
|
418
|
-
<span class="ruby-identifier">echo</span> <span class="ruby-node">"
|
418
|
+
<span class="ruby-identifier">echo</span> <span class="ruby-node">"Opening file in #{editor}"</span>
|
419
419
|
<span class="ruby-identifier">exec</span>(<span class="ruby-node">"#{editor} #{standup.file}"</span>)
|
420
420
|
<span class="ruby-keyword">end</span></pre>
|
421
421
|
</div>
|
@@ -449,7 +449,7 @@
|
|
449
449
|
|
450
450
|
|
451
451
|
<div class="method-source-code" id="edit-3F-source">
|
452
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
452
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 198</span>
|
453
453
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">edit?</span>
|
454
454
|
<span class="ruby-ivar">@edit</span>
|
455
455
|
<span class="ruby-keyword">end</span></pre>
|
@@ -484,7 +484,7 @@
|
|
484
484
|
|
485
485
|
|
486
486
|
<div class="method-source-code" id="editor-source">
|
487
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
487
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 80</span>
|
488
488
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">editor</span>
|
489
489
|
<span class="ruby-ivar">@editor</span> <span class="ruby-operator">||=</span>
|
490
490
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">'editor'</span>)
|
@@ -532,7 +532,7 @@
|
|
532
532
|
|
533
533
|
|
534
534
|
<div class="method-source-code" id="json-3F-source">
|
535
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
535
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 166</span>
|
536
536
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">json?</span>
|
537
537
|
<span class="ruby-ivar">@json</span>
|
538
538
|
<span class="ruby-keyword">end</span></pre>
|
@@ -567,7 +567,7 @@
|
|
567
567
|
|
568
568
|
|
569
569
|
<div class="method-source-code" id="print_all_entries-source">
|
570
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
570
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 101</span>
|
571
571
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_all_entries</span>
|
572
572
|
<span class="ruby-identifier">echo</span> <span class="ruby-string">'Display all entries'</span>
|
573
573
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">json?</span>
|
@@ -610,7 +610,7 @@
|
|
610
610
|
|
611
611
|
|
612
612
|
<div class="method-source-code" id="print_all_entries-3F-source">
|
613
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
613
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 174</span>
|
614
614
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_all_entries?</span>
|
615
615
|
<span class="ruby-ivar">@print_all_entries</span>
|
616
616
|
<span class="ruby-keyword">end</span></pre>
|
@@ -645,7 +645,7 @@
|
|
645
645
|
|
646
646
|
|
647
647
|
<div class="method-source-code" id="print_current_entry-source">
|
648
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
648
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 117</span>
|
649
649
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_current_entry</span>
|
650
650
|
<span class="ruby-identifier">echo</span> <span class="ruby-string">'Print current entry'</span>
|
651
651
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">json?</span>
|
@@ -687,7 +687,7 @@
|
|
687
687
|
|
688
688
|
|
689
689
|
<div class="method-source-code" id="print_current_entry-3F-source">
|
690
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
690
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 158</span>
|
691
691
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_current_entry?</span>
|
692
692
|
<span class="ruby-ivar">@print_current_entry</span>
|
693
693
|
<span class="ruby-keyword">end</span></pre>
|
@@ -722,7 +722,7 @@
|
|
722
722
|
|
723
723
|
|
724
724
|
<div class="method-source-code" id="should_append-3F-source">
|
725
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
725
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 215</span>
|
726
726
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">should_append?</span>
|
727
727
|
<span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">'previous_entry_tasks'</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">append_previous?</span>
|
728
728
|
<span class="ruby-keyword">end</span></pre>
|
@@ -757,10 +757,15 @@
|
|
757
757
|
|
758
758
|
|
759
759
|
<div class="method-source-code" id="standup-source">
|
760
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
760
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 59</span>
|
761
761
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">standup</span>
|
762
|
-
<span class="ruby-
|
763
|
-
|
762
|
+
<span class="ruby-identifier">cf</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-constant">PREFERENCE_FILE</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">PREFERENCE_FILE</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
|
763
|
+
<span class="ruby-ivar">@standup</span> <span class="ruby-operator">||=</span> <span class="ruby-operator">::</span><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">cf</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
|
764
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">any?</span>
|
765
|
+
<span class="ruby-identifier">echo</span> <span class="ruby-string">'Config options:'</span>
|
766
|
+
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">echo</span> <span class="ruby-node">" #{k} = #{v}"</span> }
|
767
|
+
<span class="ruby-keyword">end</span>
|
768
|
+
<span class="ruby-identifier">echo</span> <span class="ruby-string">'Runtime options:'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">any?</span>
|
764
769
|
<span class="ruby-identifier">preferences</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
|
765
770
|
<span class="ruby-identifier">echo</span> <span class="ruby-node">" #{k} = #{v}"</span>
|
766
771
|
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">"#{k}="</span>, <span class="ruby-identifier">v</span>)
|
@@ -798,7 +803,7 @@
|
|
798
803
|
|
799
804
|
|
800
805
|
<div class="method-source-code" id="verbose-3F-source">
|
801
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
806
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 182</span>
|
802
807
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verbose?</span>
|
803
808
|
<span class="ruby-ivar">@verbose</span>
|
804
809
|
<span class="ruby-keyword">end</span></pre>
|
@@ -833,7 +838,7 @@
|
|
833
838
|
|
834
839
|
|
835
840
|
<div class="method-source-code" id="write-3F-source">
|
836
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
841
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 190</span>
|
837
842
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write?</span>
|
838
843
|
<span class="ruby-ivar">@write</span>
|
839
844
|
<span class="ruby-keyword">end</span></pre>
|
@@ -868,9 +873,9 @@
|
|
868
873
|
|
869
874
|
|
870
875
|
<div class="method-source-code" id="write_file-source">
|
871
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
876
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 149</span>
|
872
877
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_file</span>
|
873
|
-
<span class="ruby-identifier">echo</span> <span class="ruby-string">'
|
878
|
+
<span class="ruby-identifier">echo</span> <span class="ruby-string">'Writing file'</span>
|
874
879
|
<span class="ruby-identifier">standup</span>.<span class="ruby-identifier">write</span>
|
875
880
|
<span class="ruby-keyword">end</span></pre>
|
876
881
|
</div>
|
data/doc/created.rid
CHANGED
@@ -1,8 +1,5 @@
|
|
1
|
-
|
2
|
-
README.md
|
3
|
-
lib/standup_md.rb
|
4
|
-
lib/standup_md/cli.rb
|
5
|
-
lib/standup_md/version.rb
|
6
|
-
test/standup_md/cli_test.rb Thu, 30 Apr 2020 23:02:56 -0500
|
7
|
-
test/standup_md_test.rb Thu, 23 Apr 2020 22:53:37 -0500
|
8
|
-
test/test_helper.rb Wed, 29 Apr 2020 20:22:26 -0500
|
1
|
+
Sat, 02 May 2020 12:37:06 -0500
|
2
|
+
README.md Sat, 02 May 2020 11:32:07 -0500
|
3
|
+
lib/standup_md.rb Sat, 02 May 2020 12:26:15 -0500
|
4
|
+
lib/standup_md/cli.rb Fri, 01 May 2020 23:28:15 -0500
|
5
|
+
lib/standup_md/version.rb Fri, 01 May 2020 08:57:49 -0500
|
data/doc/index.html
CHANGED
@@ -76,12 +76,6 @@
|
|
76
76
|
|
77
77
|
<li><a href="./StandupMD/Cli.html">StandupMD::Cli</a>
|
78
78
|
|
79
|
-
<li><a href="./TestCli.html">TestCli</a>
|
80
|
-
|
81
|
-
<li><a href="./TestHelper.html">TestHelper</a>
|
82
|
-
|
83
|
-
<li><a href="./TestStandupMD.html">TestStandupMD</a>
|
84
|
-
|
85
79
|
</ul>
|
86
80
|
</div>
|
87
81
|
|
@@ -117,6 +111,8 @@
|
|
117
111
|
</li><li>
|
118
112
|
<p><a href="#customization-and-runtime-options">Customization and Runtime Options</a></p>
|
119
113
|
</li><li>
|
114
|
+
<p><a href="#using-existing-standup-files">Using existing standup files</a></p>
|
115
|
+
</li><li>
|
120
116
|
<p><a href="#api">API</a></p>
|
121
117
|
</li><li>
|
122
118
|
<p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
|
@@ -246,30 +242,75 @@ sub_header_order:
|
|
246
242
|
|
247
243
|
<pre>standup --no-edit --current-entry-tasks="Work on this thing","And another thing!"</pre>
|
248
244
|
|
245
|
+
<h3 id="label-Using+Existing+Standup+Files">Using Existing Standup Files<span><a href="#label-Using+Existing+Standup+Files">¶</a> <a href="#top">↑</a></span></h3>
|
246
|
+
|
247
|
+
<p>If you already have a directory of existing standup files, you can use them, but they must be in a format that the parser can understand. The default is:</p>
|
248
|
+
|
249
|
+
<pre># 2020-05-01
|
250
|
+
## Previous
|
251
|
+
- task
|
252
|
+
## Current
|
253
|
+
- task
|
254
|
+
## Impediments
|
255
|
+
- impediment
|
256
|
+
## Notes
|
257
|
+
- notes, if any are present</pre>
|
258
|
+
|
259
|
+
<p>The order, words, date format, and header level are all customizable, but the overall format must be the same. If customization is necessary, this must be done in <code>~/.standup_md.yml</code> before execution, or else the parser will error.</p>
|
260
|
+
|
261
|
+
<p>For example, if you wanted the format to be as follows:</p>
|
262
|
+
|
263
|
+
<pre>## 05/01/2020
|
264
|
+
### Today
|
265
|
+
- task
|
266
|
+
### Yesterday
|
267
|
+
- task
|
268
|
+
### Hold-ups
|
269
|
+
- impediment
|
270
|
+
### Notes
|
271
|
+
- notes, if any are present</pre>
|
272
|
+
|
273
|
+
<p>Your <code>~/.standup_md.yml</code> should contain:</p>
|
274
|
+
|
275
|
+
<pre>sub_header_depth: 3
|
276
|
+
header_depth: 2
|
277
|
+
current_header: Today
|
278
|
+
previous_header: Yesterday
|
279
|
+
impediments_header: Hold-ups
|
280
|
+
header_date_format: '%m/%d/%Y'
|
281
|
+
sub_header_order:
|
282
|
+
- current
|
283
|
+
- previous
|
284
|
+
- impediments
|
285
|
+
- notes</pre>
|
286
|
+
|
249
287
|
<h2 id="label-API">API<span><a href="#label-API">¶</a> <a href="#top">↑</a></span></h2>
|
250
288
|
|
251
289
|
<p>Below are some quick examples, but the API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">documentation</a>.</p>
|
252
290
|
|
253
|
-
<p>This was mainly written as a command line utility, but I made the API available for scripting. There are attribute accessors for most of the settings in the <a href="#customization-and-runtime-options">customization table</a> above.
|
291
|
+
<p>This was mainly written as a command line utility, but I made the API available for scripting. There are attribute accessors for most of the settings in the <a href="#customization-and-runtime-options">customization table</a> above. A quick example of how to write a new entry via code could look like the following:</p>
|
254
292
|
|
255
293
|
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
256
294
|
|
257
|
-
<span class="ruby-identifier">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span>
|
258
|
-
<span class="ruby-
|
259
|
-
<span class="ruby-
|
260
|
-
<span class="ruby-
|
261
|
-
|
295
|
+
<span class="ruby-identifier">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
|
296
|
+
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">'Today'</span>,
|
297
|
+
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">current_entry_tasks</span> = [<span class="ruby-string">'Thing to do today'</span>, <span class="ruby-string">'Another thing to do today'</span>],
|
298
|
+
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">impediments</span> = [<span class="ruby-string">'Not enough time in the day'</span>]
|
299
|
+
<span class="ruby-keyword">end</span>
|
262
300
|
|
263
301
|
<span class="ruby-identifier">standup</span>.<span class="ruby-identifier">write</span>
|
264
302
|
</pre>
|
265
303
|
|
304
|
+
<p>Note: <code>StandupMD::load() { ... }</code> just is a quick way to call <code>StandupMD::new { ... }.load</code>.</p>
|
305
|
+
|
266
306
|
<p>Entries are just hashes, so you can easily transform them to <code>json</code> objects.</p>
|
267
307
|
|
268
308
|
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
269
309
|
<span class="ruby-identifier">require</span> <span class="ruby-string">'json'</span>
|
270
310
|
|
271
311
|
<span class="ruby-identifier">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span>
|
272
|
-
|
312
|
+
|
313
|
+
<span class="ruby-identifier">standup_json</span> = <span class="ruby-identifier">standup</span>.<span class="ruby-identifier">all_entries</span>.<span class="ruby-identifier">to_json</span>
|
273
314
|
</pre>
|
274
315
|
|
275
316
|
<h2 id="label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features<span><a href="#label-Reporting+Bugs+and+Requesting+Features">¶</a> <a href="#top">↑</a></span></h2>
|
data/doc/js/navigation.js.gz
CHANGED
Binary file
|
data/doc/js/search_index.js
CHANGED
@@ -1 +1 @@
|
|
1
|
-
var search_data = {"index":{"searchIndex":["standupmd","cli","testcli","testhelper","teststandupmd","append_previous?()","append_to_previous_entry_tasks()","bullet_character=()","cli()","create_standup_file()","current_entry_tasks=()","directory=()","echo()","edit()","edit?()","editor()","entry_previously_added?()","execute()","file_written?()","fixtures()","header_depth=()","impediments=()","json?()","load()","load()","new()","new()","new_month?()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","setup()","setup()","should_append?()","should_append?()","standup()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","teardown()","teardown()","test_preference_file()","test_version()","test_all_previous_entries()","test_append_previous?()","test_bullet_character()","test_class_load()","test_current_entry()","test_current_entry_tasks()","test_current_header()","test_directory()","test_edit?()","test_editor()","test_entry_previously_added?()","test_file()","test_file_name_format()","test_file_written?()","test_header_date_format()","test_header_depth()","test_impediments()","test_impediments_header()","test_initialize()","test_json?()","test_load()","test_notes()","test_notes_header()","test_options()","test_preferences()","test_previous_entry_tasks()","test_previous_file_when_current_and_previous_month_do_not_exist()","test_previous_file_when_current_month_file_does_not_exist_but_previous_does()","test_previous_file_when_entry_exists_for_today()","test_previous_header()","test_print_all_entries?()","test_print_current_entry?()","test_reload()","test_self_execute()","test_setting_attributes_via_block()","test_standup()","test_sub_header_depth()","test_sub_header_order()","test_verbose?()","test_write()","test_write?()","verbose?()","write()","write?()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","testcli","testhelper","teststandupmd","standupmd::cli#append_previous?()","standupmd::cli#append_to_previous_entry_tasks()","standupmd#bullet_character=()","testhelper#cli()","testhelper#create_standup_file()","standupmd#current_entry_tasks=()","standupmd#directory=()","standupmd::cli#echo()","standupmd::cli#edit()","standupmd::cli#edit?()","standupmd::cli#editor()","standupmd#entry_previously_added?()","standupmd::cli::execute()","standupmd#file_written?()","testhelper#fixtures()","standupmd#header_depth=()","standupmd#impediments=()","standupmd::cli#json?()","standupmd#load()","standupmd::load()","standupmd::new()","standupmd::cli::new()","standupmd#new_month?()","standupmd#notes=()","standupmd#previous_entry_tasks=()","standupmd::cli#print_all_entries()","standupmd::cli#print_all_entries?()","standupmd::cli#print_current_entry()","standupmd::cli#print_current_entry?()","standupmd#reload()","testcli#setup()","teststandupmd#setup()","standupmd::cli#should_append?()","testcli#should_append?()","standupmd::cli#standup()","testhelper#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","testcli#teardown()","teststandupmd#teardown()","testcli#test_preference_file()","teststandupmd#test_version()","teststandupmd#test_all_previous_entries()","testcli#test_append_previous?()","teststandupmd#test_bullet_character()","teststandupmd#test_class_load()","teststandupmd#test_current_entry()","teststandupmd#test_current_entry_tasks()","teststandupmd#test_current_header()","teststandupmd#test_directory()","testcli#test_edit?()","testcli#test_editor()","teststandupmd#test_entry_previously_added?()","teststandupmd#test_file()","teststandupmd#test_file_name_format()","teststandupmd#test_file_written?()","teststandupmd#test_header_date_format()","teststandupmd#test_header_depth()","teststandupmd#test_impediments()","teststandupmd#test_impediments_header()","testcli#test_initialize()","testcli#test_json?()","teststandupmd#test_load()","teststandupmd#test_notes()","teststandupmd#test_notes_header()","testcli#test_options()","testcli#test_preferences()","teststandupmd#test_previous_entry_tasks()","teststandupmd#test_previous_file_when_current_and_previous_month_do_not_exist()","teststandupmd#test_previous_file_when_current_month_file_does_not_exist_but_previous_does()","teststandupmd#test_previous_file_when_entry_exists_for_today()","teststandupmd#test_previous_header()","testcli#test_print_all_entries?()","testcli#test_print_current_entry?()","teststandupmd#test_reload()","testcli#test_self_execute()","teststandupmd#test_setting_attributes_via_block()","testcli#test_standup()","teststandupmd#test_sub_header_depth()","teststandupmd#test_sub_header_order()","testcli#test_verbose?()","teststandupmd#test_write()","testcli#test_write?()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The class for handing reading/writing of entries.\n<p>@example\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">su</span> = <span class=\"ruby-constant\">StandupMD</span>.<span class=\"ruby-identifier\">new</span>\n</pre>\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["TestCli","","TestCli.html","","<p>The test suite for <code>Cli</code>.\n"],["TestHelper","","TestHelper.html","","<p>Module to include in tests that provides helper functions.\n"],["TestStandupMD","","TestStandupMD.html","","<p>The test suite for <code>StandupMD</code>.\n"],["append_previous?","StandupMD::Cli","StandupMD/Cli.html#method-i-append_previous-3F","()","<p>Should `previous_entry_tasks` be appended? If false, <code>previous_entry_tasks</code> will be overwritten.\n<p>@return …\n"],["append_to_previous_entry_tasks","StandupMD::Cli","StandupMD/Cli.html#method-i-append_to_previous_entry_tasks","()","<p>Appends entries passed at runtime to existing previous entries.\n<p>@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["cli","TestHelper","TestHelper.html#method-i-cli","(options = [])","<p>Creates instance of <code>Cli</code>.\n<p>@param [Array] options Parsed by <code>getopts</code>\n<p>@return [StandupMD::Cli]\n"],["create_standup_file","TestHelper","TestHelper.html#method-i-create_standup_file","(file, fixture = 'previous_entry')","<p>Creates the standup file with entries.\n<p>@param [String] file The name of the file to create\n<p>@param [String] …\n"],["current_entry_tasks=","StandupMD","StandupMD.html#method-i-current_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["directory=","StandupMD","StandupMD.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Prints output if <code>verbose</code> is true.\n<p>@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","<p>Opens the file in an editor. Abandons the script.\n"],["edit?","StandupMD::Cli","StandupMD/Cli.html#method-i-edit-3F","()","<p>Should the standup file be opened in the editor?\n<p>@return [Boolean] Default is true\n"],["editor","StandupMD::Cli","StandupMD/Cli.html#method-i-editor","()","<p>Tries to determine the editor, first by checking if the user has one set in their preferences. If not, …\n"],["entry_previously_added?","StandupMD","StandupMD.html#method-i-entry_previously_added-3F","()","<p>Was today's entry already in the file?\n<p>@return [boolean] true if today's entry was already in …\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n"],["file_written?","StandupMD","StandupMD.html#method-i-file_written-3F","()","<p>Has the file been written since instantiated?\n<p>@return [boolean]\n<p>@example\n"],["fixtures","TestHelper","TestHelper.html#method-i-fixtures","()","<p>Reads the fixtures in as a hash.\n<p>@return [Hash]\n"],["header_depth=","StandupMD","StandupMD.html#method-i-header_depth-3D","(depth)","<p>Number of octothorps (#) to use before the main header.\n<p>@param [Integer] depth\n<p>@return [Integer]\n"],["impediments=","StandupMD","StandupMD.html#method-i-impediments-3D","(tasks)","<p>Setter for impediments.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["json?","StandupMD::Cli","StandupMD/Cli.html#method-i-json-3F","()","<p>If printing an entry, should it be printed as json?\n<p>@return [Boolean] Default is false\n"],["load","StandupMD","StandupMD.html#method-i-load","()","<p>Sets internal instance variables. Called when first instantiated, or after directory is set.\n<p>@return [self] …\n"],["load","StandupMD","StandupMD.html#method-c-load","(attributes = {})","<p>Convenience method for calling <code>new</code> + <code>load</code>\n<p>@param [Hash] attributes Attributes to set before loading.\n<p>@example …\n"],["new","StandupMD","StandupMD.html#method-c-new","()","<p>Constructor. Yields the instance so you can pass a block to access setters.\n<p>@return [self]\n<p>@example\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new_month?","StandupMD","StandupMD.html#method-i-new_month-3F","()","<p>Is today a different month than the previous entry?\n"],["notes=","StandupMD","StandupMD.html#method-i-notes-3D","(tasks)","<p>Setter for notes.\n<p>@param [Array] notes\n<p>@return [Array]\n"],["previous_entry_tasks=","StandupMD","StandupMD.html#method-i-previous_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["print_all_entries","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries","()","<p>Prints all entries to the command line.\n<p>@return [nil]\n"],["print_all_entries?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries-3F","()","<p>Should all entries be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["print_current_entry","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry","()","<p>Prints the current entry to the command line.\n<p>@return [nil]\n"],["print_current_entry?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry-3F","()","<p>Should current entry be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["reload","StandupMD","StandupMD.html#method-i-reload","()","<p>Alias of <code>load</code>\n<p>@return [self]\n"],["setup","TestCli","TestCli.html#method-i-setup","()","<p>Set working directory, current month's file, and last month's file, which will be created and …\n"],["setup","TestStandupMD","TestStandupMD.html#method-i-setup","()","<p>Set working directory, current month's file, and last month's file, which will be created and …\n"],["should_append?","StandupMD::Cli","StandupMD/Cli.html#method-i-should_append-3F","()","<p>Did the user pass <code>previous_entry_tasks</code>, and should we append?\n<p>@return [Boolean]\n"],["should_append?","TestCli","TestCli.html#method-i-should_append-3F","()","<p>True only if <code>--no-append</code> and <code>--previous-entry-tasks</code> are passed.\n"],["standup","StandupMD::Cli","StandupMD/Cli.html#method-i-standup","()","<p>Sets up an instance of <code>StandupMD</code> and passes all user preferences.\n<p>@return [StandupMD]\n"],["standup","TestHelper","TestHelper.html#method-i-standup","(directory, args = {})","<p>Creates <code>StandupUP</code> instance. Directory must be passed, usually a subdirectory of <code>test</code>, so we don't …\n"],["sub_header_depth=","StandupMD","StandupMD.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["sub_header_order","StandupMD","StandupMD.html#method-i-sub_header_order","()","<p>Return a copy of the sub-header order so the user can't modify the array.\n<p>@return [Array]\n"],["sub_header_order=","StandupMD","StandupMD.html#method-i-sub_header_order-3D","(array)","<p>Preferred order for sub-headers.\n<p>@param [Array] Values must be %w[previous current impediment notes]\n<p>@return …\n"],["teardown","TestCli","TestCli.html#method-i-teardown","()","<p>Destroy the working directory and its contents.\n"],["teardown","TestStandupMD","TestStandupMD.html#method-i-teardown","()","<p>Destroy the working directory and its contents.\n"],["test_PREFERENCE_FILE","TestCli","TestCli.html#method-i-test_PREFERENCE_FILE","()","<p>The user's preference file is a string.\n"],["test_VERSION","TestStandupMD","TestStandupMD.html#method-i-test_VERSION","()","<p><code>StandupMD::VERSION</code> should consist of three integers separated by dots.\n"],["test_all_previous_entries","TestStandupMD","TestStandupMD.html#method-i-test_all_previous_entries","()","<p>Should be all entries before the current entry.\n"],["test_append_previous?","TestCli","TestCli.html#method-i-test_append_previous-3F","()","<p>True by default. False if flag is passed.\n"],["test_bullet_character","TestStandupMD","TestStandupMD.html#method-i-test_bullet_character","()","<p>Should be able to change the bullet character but should raise if not * or -\n"],["test_class_load","TestStandupMD","TestStandupMD.html#method-i-test_class_load","()","<p>Make sure load accepts a hash of attributes, sets them, and returns an instance of itself.\n"],["test_current_entry","TestStandupMD","TestStandupMD.html#method-i-test_current_entry","()","<p><code>current_entry</code> should be a hash. If <code>file</code> already has an entry for today, it will be read and used as …\n"],["test_current_entry_tasks","TestStandupMD","TestStandupMD.html#method-i-test_current_entry_tasks","()","<p>Should be able to add tasks for current_entry.\n"],["test_current_header","TestStandupMD","TestStandupMD.html#method-i-test_current_header","()","<p>Should be changeable and used as the header for <code>current_entry</code>\n"],["test_directory","TestStandupMD","TestStandupMD.html#method-i-test_directory","()","<p>Directory should default be settable, and where standup files are read from.\n"],["test_edit?","TestCli","TestCli.html#method-i-test_edit-3F","()","<p>True by default. False if flag is passed.\n"],["test_editor","TestCli","TestCli.html#method-i-test_editor","()","<p>The editor should be set by preferences, or env, or set to 'vim'.\n"],["test_entry_previously_added?","TestStandupMD","TestStandupMD.html#method-i-test_entry_previously_added-3F","()","<p>Should be true if <code>current_entry</code> was in the file at the time it was read.\n"],["test_file","TestStandupMD","TestStandupMD.html#method-i-test_file","()","<p>The file name should equal file_name_format parsed by Date.strftime. The default is Date.today.strftime('%Y_%m.md') …\n"],["test_file_name_format","TestStandupMD","TestStandupMD.html#method-i-test_file_name_format","()","<p>Should be changeable, and return a string parsed by <code>strftime</code>.\n"],["test_file_written?","TestStandupMD","TestStandupMD.html#method-i-test_file_written-3F","()","<p>Should be false when first instantiated, true after <code>write</code> is called.\n"],["test_header_date_format","TestStandupMD","TestStandupMD.html#method-i-test_header_date_format","()","<p>Should be changeable, and return a string parsed by <code>strftime</code>.\n"],["test_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_header_depth","()","<p>Should be an integer between <code>1..5</code>, but not higher than <code>sub_header_depth</code>.\n"],["test_impediments","TestStandupMD","TestStandupMD.html#method-i-test_impediments","()","<p>Should be able to add impediments to the array.\n"],["test_impediments_header","TestStandupMD","TestStandupMD.html#method-i-test_impediments_header","()","<p>Should be changeable and used as the header for <code>impediments</code>\n"],["test_initialize","TestCli","TestCli.html#method-i-test_initialize","()","<p>The <code>initialize</code> method should accept the same parameters as <code>exectute</code>.\n"],["test_json?","TestCli","TestCli.html#method-i-test_json-3F","()","<p>False by default. True if flag is passed.\n"],["test_load","TestStandupMD","TestStandupMD.html#method-i-test_load","()","<p>Should load instance variables.\n"],["test_notes","TestStandupMD","TestStandupMD.html#method-i-test_notes","()","<p>Should be able to add notes to the array.\n"],["test_notes_header","TestStandupMD","TestStandupMD.html#method-i-test_notes_header","()","<p>Should be changeable and used as the header for <code>notes</code>\n"],["test_options","TestCli","TestCli.html#method-i-test_options","()","<p>The <code>options</code> should be an array of options passed from the command line.\n"],["test_preferences","TestCli","TestCli.html#method-i-test_preferences","()","<p>The <code>preferences</code> are the settings after <code>options</code> are parsed.\n"],["test_previous_entry_tasks","TestStandupMD","TestStandupMD.html#method-i-test_previous_entry_tasks","()","<p>Should be an array of previous entry's current entry.\n"],["test_previous_file_when_current_and_previous_month_do_not_exist","TestStandupMD","TestStandupMD.html#method-i-test_previous_file_when_current_and_previous_month_do_not_exist","()","<p>When neither last month's file, nor this month's file exist, previous_file should be an empty …\n"],["test_previous_file_when_current_month_file_does_not_exist_but_previous_does","TestStandupMD","TestStandupMD.html#method-i-test_previous_file_when_current_month_file_does_not_exist_but_previous_does","()","<p>When last month's file exists, but this month's doesn't or is empty, previous_file should …\n"],["test_previous_file_when_entry_exists_for_today","TestStandupMD","TestStandupMD.html#method-i-test_previous_file_when_entry_exists_for_today","()","<p>If there are previous entries for this month, previous file will be this month's file.\n"],["test_previous_header","TestStandupMD","TestStandupMD.html#method-i-test_previous_header","()","<p>Should be changeable and used as the header for <code>previous_entry</code>\n"],["test_print_all_entries?","TestCli","TestCli.html#method-i-test_print_all_entries-3F","()","<p>False by default. True if flag is passed.\n"],["test_print_current_entry?","TestCli","TestCli.html#method-i-test_print_current_entry-3F","()","<p>False by default. True if flag is passed.\n"],["test_reload","TestStandupMD","TestStandupMD.html#method-i-test_reload","()","<p>The reload method should exist, and is an alias of <code>load</code>.\n"],["test_self_execute","TestCli","TestCli.html#method-i-test_self_execute","()","<p>The <code>execute</code> method is the entry point for the Cli. It's parameter is an array of command-line flags …\n"],["test_setting_attributes_via_block","TestStandupMD","TestStandupMD.html#method-i-test_setting_attributes_via_block","()","<p>Attributes should be able to be set if you pass a block at instantiation.\n"],["test_standup","TestCli","TestCli.html#method-i-test_standup","()","<p>Creates the instance of <code>StandupMD</code>.\n"],["test_sub_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_depth","()","<p>Should be an integer between <code>2..6</code>, but not lower than <code>header_depth</code>.\n"],["test_sub_header_order","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_order","()","<p>The order of the subheaders is changeable, but all elements must exist.\n"],["test_verbose?","TestCli","TestCli.html#method-i-test_verbose-3F","()","<p>False by default. True if flag is passed.\n"],["test_write","TestStandupMD","TestStandupMD.html#method-i-test_write","()","<p>Should write the file.\n"],["test_write?","TestCli","TestCli.html#method-i-test_write-3F","()","<p>True by default. False if flag is passed.\n"],["verbose?","StandupMD::Cli","StandupMD/Cli.html#method-i-verbose-3F","()","<p>Should debug info be printed?\n<p>@return [Boolean] Default is false\n"],["write","StandupMD","StandupMD.html#method-i-write","()","<p>Writes a new entry to the file if the first entry in the file isn't today.\n<p>@return [Boolean]\n"],["write?","StandupMD::Cli","StandupMD/Cli.html#method-i-write-3F","()","<p>Should the file be written?\n<p>@return [Boolean] Default is true\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","<p>Writes entries to the file.\n<p>@return [Boolean] true if file was written\n"],["README","","README_md.html","","<p>The Standup Doctor\n\n<blockquote><p>The cure for all your standup woes.\n</blockquote>\n<p>A highly customizable and automated way to keep …\n"]]}}
|
1
|
+
var search_data = {"index":{"searchIndex":["standupmd","cli","append_previous?()","append_to_previous_entry_tasks()","bullet_character=()","config_file=()","config_file_loaded?()","current_entry_tasks=()","directory=()","echo()","edit()","edit?()","editor()","entry_previously_added?()","execute()","file_written?()","header_depth=()","impediments=()","json?()","load()","load()","load_config_file()","new()","new()","new_month?()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","should_append?()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","verbose?()","write()","write?()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli#append_previous?()","standupmd::cli#append_to_previous_entry_tasks()","standupmd#bullet_character=()","standupmd#config_file=()","standupmd#config_file_loaded?()","standupmd#current_entry_tasks=()","standupmd#directory=()","standupmd::cli#echo()","standupmd::cli#edit()","standupmd::cli#edit?()","standupmd::cli#editor()","standupmd#entry_previously_added?()","standupmd::cli::execute()","standupmd#file_written?()","standupmd#header_depth=()","standupmd#impediments=()","standupmd::cli#json?()","standupmd::load()","standupmd#load()","standupmd#load_config_file()","standupmd::new()","standupmd::cli::new()","standupmd#new_month?()","standupmd#notes=()","standupmd#previous_entry_tasks=()","standupmd::cli#print_all_entries()","standupmd::cli#print_all_entries?()","standupmd::cli#print_current_entry()","standupmd::cli#print_current_entry?()","standupmd#reload()","standupmd::cli#should_append?()","standupmd::cli#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The class for handing reading/writing of entries.\n<p>@example\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">su</span> = <span class=\"ruby-constant\">StandupMD</span>.<span class=\"ruby-identifier\">new</span>\n</pre>\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["append_previous?","StandupMD::Cli","StandupMD/Cli.html#method-i-append_previous-3F","()","<p>Should `previous_entry_tasks` be appended? If false, <code>previous_entry_tasks</code> will be overwritten.\n<p>@return …\n"],["append_to_previous_entry_tasks","StandupMD::Cli","StandupMD/Cli.html#method-i-append_to_previous_entry_tasks","()","<p>Appends entries passed at runtime to existing previous entries.\n<p>@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["config_file=","StandupMD","StandupMD.html#method-i-config_file-3D","(config_file)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-i-config_file_loaded-3F","()","<p>Has a config file been loaded?\n<p>@return [Boolean]\n"],["current_entry_tasks=","StandupMD","StandupMD.html#method-i-current_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["directory=","StandupMD","StandupMD.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Prints output if <code>verbose</code> is true.\n<p>@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","<p>Opens the file in an editor. Abandons the script.\n"],["edit?","StandupMD::Cli","StandupMD/Cli.html#method-i-edit-3F","()","<p>Should the standup file be opened in the editor?\n<p>@return [Boolean] Default is true\n"],["editor","StandupMD::Cli","StandupMD/Cli.html#method-i-editor","()","<p>Tries to determine the editor, first by checking if the user has one set in their preferences. If not, …\n"],["entry_previously_added?","StandupMD","StandupMD.html#method-i-entry_previously_added-3F","()","<p>Was today's entry already in the file?\n<p>@return [boolean] true if today's entry was already in …\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n"],["file_written?","StandupMD","StandupMD.html#method-i-file_written-3F","()","<p>Has the file been written since instantiated?\n<p>@return [boolean]\n<p>@example\n"],["header_depth=","StandupMD","StandupMD.html#method-i-header_depth-3D","(depth)","<p>Number of octothorps (#) to use before the main header.\n<p>@param [Integer] depth\n<p>@return [Integer]\n"],["impediments=","StandupMD","StandupMD.html#method-i-impediments-3D","(tasks)","<p>Setter for impediments.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["json?","StandupMD::Cli","StandupMD/Cli.html#method-i-json-3F","()","<p>If printing an entry, should it be printed as json?\n<p>@return [Boolean] Default is false\n"],["load","StandupMD","StandupMD.html#method-c-load","(config_file = nil)","<p>Convenience method for calling <code>new</code> + <code>load</code>. Accepts a <code>YAML</code> config file as an argument, and yields the …\n"],["load","StandupMD","StandupMD.html#method-i-load","()","<p>Sets internal instance variables. Called when first instantiated, or after directory is set.\n<p>@return [self] …\n"],["load_config_file","StandupMD","StandupMD.html#method-i-load_config_file","()","<p>Loads the config file\n<p>@return [Hash] The config options\n"],["new","StandupMD","StandupMD.html#method-c-new","(config_file = nil)","<p>Constructor. Takes a path to a <code>YAML</code> configuration file as an argument. If passed, settings from the config …\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new_month?","StandupMD","StandupMD.html#method-i-new_month-3F","()","<p>Is today a different month than the previous entry?\n"],["notes=","StandupMD","StandupMD.html#method-i-notes-3D","(tasks)","<p>Setter for notes.\n<p>@param [Array] notes\n<p>@return [Array]\n"],["previous_entry_tasks=","StandupMD","StandupMD.html#method-i-previous_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["print_all_entries","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries","()","<p>Prints all entries to the command line.\n<p>@return [nil]\n"],["print_all_entries?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries-3F","()","<p>Should all entries be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["print_current_entry","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry","()","<p>Prints the current entry to the command line.\n<p>@return [nil]\n"],["print_current_entry?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry-3F","()","<p>Should current entry be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["reload","StandupMD","StandupMD.html#method-i-reload","()","<p>Alias of <code>load</code>\n<p>@return [self]\n"],["should_append?","StandupMD::Cli","StandupMD/Cli.html#method-i-should_append-3F","()","<p>Did the user pass <code>previous_entry_tasks</code>, and should we append?\n<p>@return [Boolean]\n"],["standup","StandupMD::Cli","StandupMD/Cli.html#method-i-standup","()","<p>Sets up an instance of <code>StandupMD</code> and passes all user preferences.\n<p>@return [StandupMD]\n"],["sub_header_depth=","StandupMD","StandupMD.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["sub_header_order","StandupMD","StandupMD.html#method-i-sub_header_order","()","<p>Return a copy of the sub-header order so the user can't modify the array.\n<p>@return [Array]\n"],["sub_header_order=","StandupMD","StandupMD.html#method-i-sub_header_order-3D","(array)","<p>Preferred order for sub-headers.\n<p>@param [Array] Values must be %w[previous current impediment notes]\n<p>@return …\n"],["verbose?","StandupMD::Cli","StandupMD/Cli.html#method-i-verbose-3F","()","<p>Should debug info be printed?\n<p>@return [Boolean] Default is false\n"],["write","StandupMD","StandupMD.html#method-i-write","()","<p>Writes a new entry to the file if the first entry in the file isn't today.\n<p>@return [Boolean]\n"],["write?","StandupMD::Cli","StandupMD/Cli.html#method-i-write-3F","()","<p>Should the file be written?\n<p>@return [Boolean] Default is true\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","<p>Writes entries to the file.\n<p>@return [Boolean] true if file was written\n"],["README","","README_md.html","","<p>The Standup Doctor\n\n<blockquote><p>The cure for all your standup woes.\n</blockquote>\n<p>A highly customizable and automated way to keep …\n"]]}}
|
data/doc/js/search_index.js.gz
CHANGED
Binary file
|
data/doc/js/searcher.js.gz
CHANGED
Binary file
|
data/doc/table_of_contents.html
CHANGED
@@ -59,6 +59,8 @@
|
|
59
59
|
|
60
60
|
<li><a href="README_md.html#label-Executable+Flags">Executable Flags</a>
|
61
61
|
|
62
|
+
<li><a href="README_md.html#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
|
63
|
+
|
62
64
|
<li><a href="README_md.html#label-API">API</a>
|
63
65
|
|
64
66
|
<li><a href="README_md.html#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
|
@@ -84,12 +86,6 @@
|
|
84
86
|
|
85
87
|
<li><a href="StandupMD.html#Attributes+with+default+getters+and+setters.">Attributes with default getters and setters.</a>
|
86
88
|
|
87
|
-
<li><a href="StandupMD.html#Booleans">Booleans</a>
|
88
|
-
|
89
|
-
<li><a href="StandupMD.html#Custom+setters">Custom setters</a>
|
90
|
-
|
91
|
-
<li><a href="StandupMD.html#Misc">Misc</a>
|
92
|
-
|
93
89
|
</ul>
|
94
90
|
|
95
91
|
</li>
|
@@ -99,21 +95,6 @@
|
|
99
95
|
|
100
96
|
</li>
|
101
97
|
|
102
|
-
<li class="class">
|
103
|
-
<a href="TestCli.html">TestCli</a>
|
104
|
-
|
105
|
-
</li>
|
106
|
-
|
107
|
-
<li class="module">
|
108
|
-
<a href="TestHelper.html">TestHelper</a>
|
109
|
-
|
110
|
-
</li>
|
111
|
-
|
112
|
-
<li class="class">
|
113
|
-
<a href="TestStandupMD.html">TestStandupMD</a>
|
114
|
-
|
115
|
-
</li>
|
116
|
-
|
117
98
|
</ul>
|
118
99
|
|
119
100
|
<h2 id="methods">Methods</h2>
|
@@ -155,14 +136,14 @@
|
|
155
136
|
<span class="container">StandupMD</span>
|
156
137
|
|
157
138
|
<li class="method">
|
158
|
-
<a href="
|
139
|
+
<a href="StandupMD.html#method-i-config_file-3D">#config_file=</a>
|
159
140
|
—
|
160
|
-
<span class="container">
|
141
|
+
<span class="container">StandupMD</span>
|
161
142
|
|
162
143
|
<li class="method">
|
163
|
-
<a href="
|
144
|
+
<a href="StandupMD.html#method-i-config_file_loaded-3F">#config_file_loaded?</a>
|
164
145
|
—
|
165
|
-
<span class="container">
|
146
|
+
<span class="container">StandupMD</span>
|
166
147
|
|
167
148
|
<li class="method">
|
168
149
|
<a href="StandupMD.html#method-i-current_entry_tasks-3D">#current_entry_tasks=</a>
|
@@ -204,11 +185,6 @@
|
|
204
185
|
—
|
205
186
|
<span class="container">StandupMD</span>
|
206
187
|
|
207
|
-
<li class="method">
|
208
|
-
<a href="TestHelper.html#method-i-fixtures">#fixtures</a>
|
209
|
-
—
|
210
|
-
<span class="container">TestHelper</span>
|
211
|
-
|
212
188
|
<li class="method">
|
213
189
|
<a href="StandupMD.html#method-i-header_depth-3D">#header_depth=</a>
|
214
190
|
—
|
@@ -229,6 +205,11 @@
|
|
229
205
|
—
|
230
206
|
<span class="container">StandupMD</span>
|
231
207
|
|
208
|
+
<li class="method">
|
209
|
+
<a href="StandupMD.html#method-i-load_config_file">#load_config_file</a>
|
210
|
+
—
|
211
|
+
<span class="container">StandupMD</span>
|
212
|
+
|
232
213
|
<li class="method">
|
233
214
|
<a href="StandupMD.html#method-i-new_month-3F">#new_month?</a>
|
234
215
|
—
|
@@ -269,31 +250,11 @@
|
|
269
250
|
—
|
270
251
|
<span class="container">StandupMD</span>
|
271
252
|
|
272
|
-
<li class="method">
|
273
|
-
<a href="TestStandupMD.html#method-i-setup">#setup</a>
|
274
|
-
—
|
275
|
-
<span class="container">TestStandupMD</span>
|
276
|
-
|
277
|
-
<li class="method">
|
278
|
-
<a href="TestCli.html#method-i-setup">#setup</a>
|
279
|
-
—
|
280
|
-
<span class="container">TestCli</span>
|
281
|
-
|
282
|
-
<li class="method">
|
283
|
-
<a href="TestCli.html#method-i-should_append-3F">#should_append?</a>
|
284
|
-
—
|
285
|
-
<span class="container">TestCli</span>
|
286
|
-
|
287
253
|
<li class="method">
|
288
254
|
<a href="StandupMD/Cli.html#method-i-should_append-3F">#should_append?</a>
|
289
255
|
—
|
290
256
|
<span class="container">StandupMD::Cli</span>
|
291
257
|
|
292
|
-
<li class="method">
|
293
|
-
<a href="TestHelper.html#method-i-standup">#standup</a>
|
294
|
-
—
|
295
|
-
<span class="container">TestHelper</span>
|
296
|
-
|
297
258
|
<li class="method">
|
298
259
|
<a href="StandupMD/Cli.html#method-i-standup">#standup</a>
|
299
260
|
—
|
@@ -314,231 +275,6 @@
|
|
314
275
|
—
|
315
276
|
<span class="container">StandupMD</span>
|
316
277
|
|
317
|
-
<li class="method">
|
318
|
-
<a href="TestStandupMD.html#method-i-teardown">#teardown</a>
|
319
|
-
—
|
320
|
-
<span class="container">TestStandupMD</span>
|
321
|
-
|
322
|
-
<li class="method">
|
323
|
-
<a href="TestCli.html#method-i-teardown">#teardown</a>
|
324
|
-
—
|
325
|
-
<span class="container">TestCli</span>
|
326
|
-
|
327
|
-
<li class="method">
|
328
|
-
<a href="TestCli.html#method-i-test_PREFERENCE_FILE">#test_PREFERENCE_FILE</a>
|
329
|
-
—
|
330
|
-
<span class="container">TestCli</span>
|
331
|
-
|
332
|
-
<li class="method">
|
333
|
-
<a href="TestStandupMD.html#method-i-test_VERSION">#test_VERSION</a>
|
334
|
-
—
|
335
|
-
<span class="container">TestStandupMD</span>
|
336
|
-
|
337
|
-
<li class="method">
|
338
|
-
<a href="TestStandupMD.html#method-i-test_all_previous_entries">#test_all_previous_entries</a>
|
339
|
-
—
|
340
|
-
<span class="container">TestStandupMD</span>
|
341
|
-
|
342
|
-
<li class="method">
|
343
|
-
<a href="TestCli.html#method-i-test_append_previous-3F">#test_append_previous?</a>
|
344
|
-
—
|
345
|
-
<span class="container">TestCli</span>
|
346
|
-
|
347
|
-
<li class="method">
|
348
|
-
<a href="TestStandupMD.html#method-i-test_bullet_character">#test_bullet_character</a>
|
349
|
-
—
|
350
|
-
<span class="container">TestStandupMD</span>
|
351
|
-
|
352
|
-
<li class="method">
|
353
|
-
<a href="TestStandupMD.html#method-i-test_class_load">#test_class_load</a>
|
354
|
-
—
|
355
|
-
<span class="container">TestStandupMD</span>
|
356
|
-
|
357
|
-
<li class="method">
|
358
|
-
<a href="TestStandupMD.html#method-i-test_current_entry">#test_current_entry</a>
|
359
|
-
—
|
360
|
-
<span class="container">TestStandupMD</span>
|
361
|
-
|
362
|
-
<li class="method">
|
363
|
-
<a href="TestStandupMD.html#method-i-test_current_entry_tasks">#test_current_entry_tasks</a>
|
364
|
-
—
|
365
|
-
<span class="container">TestStandupMD</span>
|
366
|
-
|
367
|
-
<li class="method">
|
368
|
-
<a href="TestStandupMD.html#method-i-test_current_header">#test_current_header</a>
|
369
|
-
—
|
370
|
-
<span class="container">TestStandupMD</span>
|
371
|
-
|
372
|
-
<li class="method">
|
373
|
-
<a href="TestStandupMD.html#method-i-test_directory">#test_directory</a>
|
374
|
-
—
|
375
|
-
<span class="container">TestStandupMD</span>
|
376
|
-
|
377
|
-
<li class="method">
|
378
|
-
<a href="TestCli.html#method-i-test_edit-3F">#test_edit?</a>
|
379
|
-
—
|
380
|
-
<span class="container">TestCli</span>
|
381
|
-
|
382
|
-
<li class="method">
|
383
|
-
<a href="TestCli.html#method-i-test_editor">#test_editor</a>
|
384
|
-
—
|
385
|
-
<span class="container">TestCli</span>
|
386
|
-
|
387
|
-
<li class="method">
|
388
|
-
<a href="TestStandupMD.html#method-i-test_entry_previously_added-3F">#test_entry_previously_added?</a>
|
389
|
-
—
|
390
|
-
<span class="container">TestStandupMD</span>
|
391
|
-
|
392
|
-
<li class="method">
|
393
|
-
<a href="TestStandupMD.html#method-i-test_file">#test_file</a>
|
394
|
-
—
|
395
|
-
<span class="container">TestStandupMD</span>
|
396
|
-
|
397
|
-
<li class="method">
|
398
|
-
<a href="TestStandupMD.html#method-i-test_file_name_format">#test_file_name_format</a>
|
399
|
-
—
|
400
|
-
<span class="container">TestStandupMD</span>
|
401
|
-
|
402
|
-
<li class="method">
|
403
|
-
<a href="TestStandupMD.html#method-i-test_file_written-3F">#test_file_written?</a>
|
404
|
-
—
|
405
|
-
<span class="container">TestStandupMD</span>
|
406
|
-
|
407
|
-
<li class="method">
|
408
|
-
<a href="TestStandupMD.html#method-i-test_header_date_format">#test_header_date_format</a>
|
409
|
-
—
|
410
|
-
<span class="container">TestStandupMD</span>
|
411
|
-
|
412
|
-
<li class="method">
|
413
|
-
<a href="TestStandupMD.html#method-i-test_header_depth">#test_header_depth</a>
|
414
|
-
—
|
415
|
-
<span class="container">TestStandupMD</span>
|
416
|
-
|
417
|
-
<li class="method">
|
418
|
-
<a href="TestStandupMD.html#method-i-test_impediments">#test_impediments</a>
|
419
|
-
—
|
420
|
-
<span class="container">TestStandupMD</span>
|
421
|
-
|
422
|
-
<li class="method">
|
423
|
-
<a href="TestStandupMD.html#method-i-test_impediments_header">#test_impediments_header</a>
|
424
|
-
—
|
425
|
-
<span class="container">TestStandupMD</span>
|
426
|
-
|
427
|
-
<li class="method">
|
428
|
-
<a href="TestCli.html#method-i-test_initialize">#test_initialize</a>
|
429
|
-
—
|
430
|
-
<span class="container">TestCli</span>
|
431
|
-
|
432
|
-
<li class="method">
|
433
|
-
<a href="TestCli.html#method-i-test_json-3F">#test_json?</a>
|
434
|
-
—
|
435
|
-
<span class="container">TestCli</span>
|
436
|
-
|
437
|
-
<li class="method">
|
438
|
-
<a href="TestStandupMD.html#method-i-test_load">#test_load</a>
|
439
|
-
—
|
440
|
-
<span class="container">TestStandupMD</span>
|
441
|
-
|
442
|
-
<li class="method">
|
443
|
-
<a href="TestStandupMD.html#method-i-test_notes">#test_notes</a>
|
444
|
-
—
|
445
|
-
<span class="container">TestStandupMD</span>
|
446
|
-
|
447
|
-
<li class="method">
|
448
|
-
<a href="TestStandupMD.html#method-i-test_notes_header">#test_notes_header</a>
|
449
|
-
—
|
450
|
-
<span class="container">TestStandupMD</span>
|
451
|
-
|
452
|
-
<li class="method">
|
453
|
-
<a href="TestCli.html#method-i-test_options">#test_options</a>
|
454
|
-
—
|
455
|
-
<span class="container">TestCli</span>
|
456
|
-
|
457
|
-
<li class="method">
|
458
|
-
<a href="TestCli.html#method-i-test_preferences">#test_preferences</a>
|
459
|
-
—
|
460
|
-
<span class="container">TestCli</span>
|
461
|
-
|
462
|
-
<li class="method">
|
463
|
-
<a href="TestStandupMD.html#method-i-test_previous_entry_tasks">#test_previous_entry_tasks</a>
|
464
|
-
—
|
465
|
-
<span class="container">TestStandupMD</span>
|
466
|
-
|
467
|
-
<li class="method">
|
468
|
-
<a href="TestStandupMD.html#method-i-test_previous_file_when_current_and_previous_month_do_not_exist">#test_previous_file_when_current_and_previous_month_do_not_exist</a>
|
469
|
-
—
|
470
|
-
<span class="container">TestStandupMD</span>
|
471
|
-
|
472
|
-
<li class="method">
|
473
|
-
<a href="TestStandupMD.html#method-i-test_previous_file_when_current_month_file_does_not_exist_but_previous_does">#test_previous_file_when_current_month_file_does_not_exist_but_previous_does</a>
|
474
|
-
—
|
475
|
-
<span class="container">TestStandupMD</span>
|
476
|
-
|
477
|
-
<li class="method">
|
478
|
-
<a href="TestStandupMD.html#method-i-test_previous_file_when_entry_exists_for_today">#test_previous_file_when_entry_exists_for_today</a>
|
479
|
-
—
|
480
|
-
<span class="container">TestStandupMD</span>
|
481
|
-
|
482
|
-
<li class="method">
|
483
|
-
<a href="TestStandupMD.html#method-i-test_previous_header">#test_previous_header</a>
|
484
|
-
—
|
485
|
-
<span class="container">TestStandupMD</span>
|
486
|
-
|
487
|
-
<li class="method">
|
488
|
-
<a href="TestCli.html#method-i-test_print_all_entries-3F">#test_print_all_entries?</a>
|
489
|
-
—
|
490
|
-
<span class="container">TestCli</span>
|
491
|
-
|
492
|
-
<li class="method">
|
493
|
-
<a href="TestCli.html#method-i-test_print_current_entry-3F">#test_print_current_entry?</a>
|
494
|
-
—
|
495
|
-
<span class="container">TestCli</span>
|
496
|
-
|
497
|
-
<li class="method">
|
498
|
-
<a href="TestStandupMD.html#method-i-test_reload">#test_reload</a>
|
499
|
-
—
|
500
|
-
<span class="container">TestStandupMD</span>
|
501
|
-
|
502
|
-
<li class="method">
|
503
|
-
<a href="TestCli.html#method-i-test_self_execute">#test_self_execute</a>
|
504
|
-
—
|
505
|
-
<span class="container">TestCli</span>
|
506
|
-
|
507
|
-
<li class="method">
|
508
|
-
<a href="TestStandupMD.html#method-i-test_setting_attributes_via_block">#test_setting_attributes_via_block</a>
|
509
|
-
—
|
510
|
-
<span class="container">TestStandupMD</span>
|
511
|
-
|
512
|
-
<li class="method">
|
513
|
-
<a href="TestCli.html#method-i-test_standup">#test_standup</a>
|
514
|
-
—
|
515
|
-
<span class="container">TestCli</span>
|
516
|
-
|
517
|
-
<li class="method">
|
518
|
-
<a href="TestStandupMD.html#method-i-test_sub_header_depth">#test_sub_header_depth</a>
|
519
|
-
—
|
520
|
-
<span class="container">TestStandupMD</span>
|
521
|
-
|
522
|
-
<li class="method">
|
523
|
-
<a href="TestStandupMD.html#method-i-test_sub_header_order">#test_sub_header_order</a>
|
524
|
-
—
|
525
|
-
<span class="container">TestStandupMD</span>
|
526
|
-
|
527
|
-
<li class="method">
|
528
|
-
<a href="TestCli.html#method-i-test_verbose-3F">#test_verbose?</a>
|
529
|
-
—
|
530
|
-
<span class="container">TestCli</span>
|
531
|
-
|
532
|
-
<li class="method">
|
533
|
-
<a href="TestStandupMD.html#method-i-test_write">#test_write</a>
|
534
|
-
—
|
535
|
-
<span class="container">TestStandupMD</span>
|
536
|
-
|
537
|
-
<li class="method">
|
538
|
-
<a href="TestCli.html#method-i-test_write-3F">#test_write?</a>
|
539
|
-
—
|
540
|
-
<span class="container">TestCli</span>
|
541
|
-
|
542
278
|
<li class="method">
|
543
279
|
<a href="StandupMD/Cli.html#method-i-verbose-3F">#verbose?</a>
|
544
280
|
—
|