standup_md 0.3.1 → 0.3.6
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/Gemfile.lock +11 -9
- data/README.md +77 -43
- data/Rakefile +3 -1
- data/doc/README_md.html +63 -59
- data/doc/StandupMD.html +4 -23
- data/doc/StandupMD/Cli.html +11 -11
- data/doc/StandupMD/Cli/Helpers.html +8 -7
- data/doc/StandupMD/Config/Cli.html +29 -20
- data/doc/StandupMD/Config/Entry.html +26 -14
- data/doc/StandupMD/Config/EntryList.html +26 -11
- data/doc/StandupMD/Config/File.html +30 -26
- data/doc/StandupMD/Entry.html +1 -1
- data/doc/StandupMD/EntryList.html +116 -194
- data/doc/StandupMD/File.html +67 -25
- data/doc/StandupMD/Version.html +176 -0
- data/doc/created.rid +15 -15
- data/doc/index.html +62 -58
- 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 +66 -59
- data/lib/standup_md.rb +4 -3
- data/lib/standup_md/cli.rb +2 -3
- data/lib/standup_md/cli/helpers.rb +66 -34
- data/lib/standup_md/config.rb +2 -2
- data/lib/standup_md/config/cli.rb +24 -23
- data/lib/standup_md/config/entry.rb +14 -9
- data/lib/standup_md/config/entry_list.rb +10 -5
- data/lib/standup_md/config/file.rb +26 -16
- data/lib/standup_md/entry.rb +2 -2
- data/lib/standup_md/entry_list.rb +24 -41
- data/lib/standup_md/file.rb +42 -15
- data/lib/standup_md/file/helpers.rb +13 -15
- data/lib/standup_md/version.rb +23 -6
- data/standup_md.gemspec +12 -16
- metadata +7 -6
data/doc/StandupMD/Entry.html
CHANGED
@@ -58,7 +58,18 @@
|
|
58
58
|
|
59
59
|
|
60
60
|
<div id="class-metadata">
|
61
|
+
<div id="sections-section" class="nav-section">
|
62
|
+
<h3>Sections</h3>
|
63
|
+
|
64
|
+
<ul class="link-list" role="directory">
|
65
|
+
|
66
|
+
<li><a href="#5Buntitled-5D"></a></li>
|
67
|
+
|
68
|
+
<li><a href="#Delegators">Delegators</a></li>
|
61
69
|
|
70
|
+
</ul>
|
71
|
+
</div>
|
72
|
+
|
62
73
|
<div id="parent-class-section" class="nav-section">
|
63
74
|
<h3>Parent</h3>
|
64
75
|
|
@@ -79,7 +90,18 @@
|
|
79
90
|
</ul>
|
80
91
|
</div>
|
81
92
|
|
93
|
+
<div id="extends-section" class="nav-section">
|
94
|
+
<h3>Extended With Modules</h3>
|
95
|
+
|
96
|
+
<ul class="link-list">
|
82
97
|
|
98
|
+
|
99
|
+
<li><span class="extend">Forwardable</span>
|
100
|
+
|
101
|
+
|
102
|
+
</ul>
|
103
|
+
</div>
|
104
|
+
|
83
105
|
<!-- Method Quickref -->
|
84
106
|
<div id="method-list-section" class="nav-section">
|
85
107
|
<h3>Methods</h3>
|
@@ -92,9 +114,7 @@
|
|
92
114
|
|
93
115
|
<li ><a href="#method-i-3C-3C">#<<</a>
|
94
116
|
|
95
|
-
<li ><a href="#method-i-
|
96
|
-
|
97
|
-
<li ><a href="#method-i-empty-3F">#empty?</a>
|
117
|
+
<li ><a href="#method-i-40entries">#@entries</a>
|
98
118
|
|
99
119
|
<li ><a href="#method-i-filter">#filter</a>
|
100
120
|
|
@@ -102,12 +122,6 @@
|
|
102
122
|
|
103
123
|
<li ><a href="#method-i-find">#find</a>
|
104
124
|
|
105
|
-
<li ><a href="#method-i-first">#first</a>
|
106
|
-
|
107
|
-
<li ><a href="#method-i-last">#last</a>
|
108
|
-
|
109
|
-
<li ><a href="#method-i-size">#size</a>
|
110
|
-
|
111
125
|
<li ><a href="#method-i-sort">#sort</a>
|
112
126
|
|
113
127
|
<li ><a href="#method-i-sort-21">#sort!</a>
|
@@ -173,7 +187,7 @@
|
|
173
187
|
|
174
188
|
|
175
189
|
<div class="method-source-code" id="config-source">
|
176
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
190
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 16</span>
|
177
191
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
|
178
192
|
<span class="ruby-ivar">@config</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">entry_list</span>
|
179
193
|
<span class="ruby-keyword">end</span></pre>
|
@@ -210,7 +224,7 @@
|
|
210
224
|
|
211
225
|
|
212
226
|
<div class="method-source-code" id="new-source">
|
213
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
227
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 26</span>
|
214
228
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">entries</span>)
|
215
229
|
<span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
|
216
230
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Entry</span>) }
|
@@ -259,7 +273,7 @@
|
|
259
273
|
|
260
274
|
|
261
275
|
<div class="method-source-code" id="3C-3C-source">
|
262
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
276
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 40</span>
|
263
277
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">entry</span>)
|
264
278
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Entry</span>)
|
265
279
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Entry must instance of StandupMD::Entry'</span>
|
@@ -273,74 +287,6 @@
|
|
273
287
|
|
274
288
|
|
275
289
|
|
276
|
-
</div>
|
277
|
-
|
278
|
-
|
279
|
-
<div id="method-i-each" class="method-detail ">
|
280
|
-
|
281
|
-
<div class="method-heading">
|
282
|
-
<span class="method-name">each</span><span
|
283
|
-
class="method-args">(&block)</span>
|
284
|
-
|
285
|
-
<span class="method-click-advice">click to toggle source</span>
|
286
|
-
|
287
|
-
</div>
|
288
|
-
|
289
|
-
|
290
|
-
<div class="method-description">
|
291
|
-
|
292
|
-
<p>Iterate over the list and yield each entry.</p>
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
<div class="method-source-code" id="each-source">
|
298
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 34</span>
|
299
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
300
|
-
<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
301
|
-
<span class="ruby-keyword">end</span></pre>
|
302
|
-
</div>
|
303
|
-
|
304
|
-
</div>
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
</div>
|
310
|
-
|
311
|
-
|
312
|
-
<div id="method-i-empty-3F" class="method-detail ">
|
313
|
-
|
314
|
-
<div class="method-heading">
|
315
|
-
<span class="method-name">empty?</span><span
|
316
|
-
class="method-args">()</span>
|
317
|
-
|
318
|
-
<span class="method-click-advice">click to toggle source</span>
|
319
|
-
|
320
|
-
</div>
|
321
|
-
|
322
|
-
|
323
|
-
<div class="method-description">
|
324
|
-
|
325
|
-
<p>Is the list empty?</p>
|
326
|
-
|
327
|
-
<p>@return [Boolean] true if empty</p>
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
<div class="method-source-code" id="empty-3F-source">
|
333
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 70</span>
|
334
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
|
335
|
-
<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">empty?</span>
|
336
|
-
<span class="ruby-keyword">end</span></pre>
|
337
|
-
</div>
|
338
|
-
|
339
|
-
</div>
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
290
|
</div>
|
345
291
|
|
346
292
|
|
@@ -369,7 +315,7 @@
|
|
369
315
|
|
370
316
|
|
371
317
|
<div class="method-source-code" id="filter-source">
|
372
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
318
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 92</span>
|
373
319
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">filter</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>)
|
374
320
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(
|
375
321
|
<span class="ruby-operator">*</span><span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>) }
|
@@ -410,7 +356,7 @@
|
|
410
356
|
|
411
357
|
|
412
358
|
<div class="method-source-code" id="filter-21-source">
|
413
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
359
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 106</span>
|
414
360
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">filter!</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>)
|
415
361
|
<span class="ruby-ivar">@entries</span> = <span class="ruby-identifier">filter</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>)
|
416
362
|
<span class="ruby-keyword">self</span>
|
@@ -429,7 +375,7 @@
|
|
429
375
|
|
430
376
|
<div class="method-heading">
|
431
377
|
<span class="method-name">find</span><span
|
432
|
-
class="method-args">(
|
378
|
+
class="method-args">(date)</span>
|
433
379
|
|
434
380
|
<span class="method-click-advice">click to toggle source</span>
|
435
381
|
|
@@ -439,119 +385,18 @@
|
|
439
385
|
<div class="method-description">
|
440
386
|
|
441
387
|
<p>Finds an entry based on date. This method assumes the list has already been sorted.</p>
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
<div class="method-source-code" id="find-source">
|
447
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 54</span>
|
448
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">key</span>)
|
449
|
-
<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">bsearch</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">key</span> }
|
450
|
-
<span class="ruby-keyword">end</span></pre>
|
451
|
-
</div>
|
452
|
-
|
453
|
-
</div>
|
454
388
|
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
</div>
|
459
|
-
|
460
|
-
|
461
|
-
<div id="method-i-first" class="method-detail ">
|
462
|
-
|
463
|
-
<div class="method-heading">
|
464
|
-
<span class="method-name">first</span><span
|
465
|
-
class="method-args">()</span>
|
466
|
-
|
467
|
-
<span class="method-click-advice">click to toggle source</span>
|
468
|
-
|
469
|
-
</div>
|
470
|
-
|
471
|
-
|
472
|
-
<div class="method-description">
|
473
|
-
|
474
|
-
<p>The first entry in the list. This method assumes the list has already been sorted.</p>
|
389
|
+
<p>@param [Date] date</p>
|
475
390
|
|
476
391
|
<p>@return [StandupMD::Entry]</p>
|
477
392
|
|
478
393
|
|
479
394
|
|
480
395
|
|
481
|
-
<div class="method-source-code" id="
|
482
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
483
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">
|
484
|
-
<span class="ruby-identifier">
|
485
|
-
<span class="ruby-keyword">end</span></pre>
|
486
|
-
</div>
|
487
|
-
|
488
|
-
</div>
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
</div>
|
494
|
-
|
495
|
-
|
496
|
-
<div id="method-i-last" class="method-detail ">
|
497
|
-
|
498
|
-
<div class="method-heading">
|
499
|
-
<span class="method-name">last</span><span
|
500
|
-
class="method-args">()</span>
|
501
|
-
|
502
|
-
<span class="method-click-advice">click to toggle source</span>
|
503
|
-
|
504
|
-
</div>
|
505
|
-
|
506
|
-
|
507
|
-
<div class="method-description">
|
508
|
-
|
509
|
-
<p>The last entry in the list. This method assumes the list has already been sorted.</p>
|
510
|
-
|
511
|
-
<p>@return [StandupMD::Entry]</p>
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
<div class="method-source-code" id="last-source">
|
517
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 141</span>
|
518
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">last</span>
|
519
|
-
<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">last</span>
|
520
|
-
<span class="ruby-keyword">end</span></pre>
|
521
|
-
</div>
|
522
|
-
|
523
|
-
</div>
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
</div>
|
529
|
-
|
530
|
-
|
531
|
-
<div id="method-i-size" class="method-detail ">
|
532
|
-
|
533
|
-
<div class="method-heading">
|
534
|
-
<span class="method-name">size</span><span
|
535
|
-
class="method-args">()</span>
|
536
|
-
|
537
|
-
<span class="method-click-advice">click to toggle source</span>
|
538
|
-
|
539
|
-
</div>
|
540
|
-
|
541
|
-
|
542
|
-
<div class="method-description">
|
543
|
-
|
544
|
-
<p>How many entries are in the list.</p>
|
545
|
-
|
546
|
-
<p>@return [Integer]</p>
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
<div class="method-source-code" id="size-source">
|
552
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 62</span>
|
553
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
|
554
|
-
<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">size</span>
|
396
|
+
<div class="method-source-code" id="find-source">
|
397
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 54</span>
|
398
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">date</span>)
|
399
|
+
<span class="ruby-identifier">entries</span>.<span class="ruby-identifier">bsearch</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">date</span> }
|
555
400
|
<span class="ruby-keyword">end</span></pre>
|
556
401
|
</div>
|
557
402
|
|
@@ -584,7 +429,7 @@
|
|
584
429
|
|
585
430
|
|
586
431
|
<div class="method-source-code" id="sort-source">
|
587
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
432
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 62</span>
|
588
433
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort</span>
|
589
434
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">sort</span>)
|
590
435
|
<span class="ruby-keyword">end</span></pre>
|
@@ -619,7 +464,7 @@
|
|
619
464
|
|
620
465
|
|
621
466
|
<div class="method-source-code" id="sort-21-source">
|
622
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
467
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 70</span>
|
623
468
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort!</span>
|
624
469
|
<span class="ruby-ivar">@entries</span> = <span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">sort</span>
|
625
470
|
<span class="ruby-keyword">self</span>
|
@@ -655,7 +500,7 @@
|
|
655
500
|
|
656
501
|
|
657
502
|
<div class="method-source-code" id="sort_reverse-source">
|
658
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
503
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 79</span>
|
659
504
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort_reverse</span>
|
660
505
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">reverse</span>)
|
661
506
|
<span class="ruby-keyword">end</span></pre>
|
@@ -690,7 +535,7 @@
|
|
690
535
|
|
691
536
|
|
692
537
|
<div class="method-source-code" id="to_h-source">
|
693
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
538
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 115</span>
|
694
539
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
|
695
540
|
<span class="ruby-constant">Hash</span>[<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span>, {
|
696
541
|
<span class="ruby-string">'current'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">current</span>,
|
@@ -730,7 +575,7 @@
|
|
730
575
|
|
731
576
|
|
732
577
|
<div class="method-source-code" id="to_json-source">
|
733
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
578
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 128</span>
|
734
579
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
|
735
580
|
<span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
|
736
581
|
<span class="ruby-keyword">end</span></pre>
|
@@ -741,6 +586,83 @@
|
|
741
586
|
|
742
587
|
|
743
588
|
|
589
|
+
</div>
|
590
|
+
|
591
|
+
|
592
|
+
</section>
|
593
|
+
|
594
|
+
</section>
|
595
|
+
|
596
|
+
<section id="Delegators" class="documentation-section">
|
597
|
+
|
598
|
+
<header class="documentation-section-title">
|
599
|
+
<h2>
|
600
|
+
Delegators
|
601
|
+
</h2>
|
602
|
+
<span class="section-click-top">
|
603
|
+
<a href="#top">↑ top</a>
|
604
|
+
</span>
|
605
|
+
</header>
|
606
|
+
|
607
|
+
|
608
|
+
|
609
|
+
|
610
|
+
|
611
|
+
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
<section id="public-instance-Delegators-method-details" class="method-section">
|
616
|
+
<header>
|
617
|
+
<h3>Public Instance Methods</h3>
|
618
|
+
</header>
|
619
|
+
|
620
|
+
|
621
|
+
<div id="method-i-40entries" class="method-detail ">
|
622
|
+
|
623
|
+
<div class="method-heading">
|
624
|
+
<span class="method-name">@entries</span><span
|
625
|
+
class="method-args">()</span>
|
626
|
+
|
627
|
+
<span class="method-click-advice">click to toggle source</span>
|
628
|
+
|
629
|
+
</div>
|
630
|
+
|
631
|
+
|
632
|
+
<div class="method-description">
|
633
|
+
|
634
|
+
<p>The following are forwarded to @entries, which is the underly array of entries.</p>
|
635
|
+
<dl class="rdoc-list note-list"><dt><code>each</code>
|
636
|
+
<dd>
|
637
|
+
<p>Iterate over each entry.</p>
|
638
|
+
</dd><dt><code>empty?</code>
|
639
|
+
<dd>
|
640
|
+
<p>Is the list empty?</p>
|
641
|
+
</dd><dt><code>size</code>
|
642
|
+
<dd>
|
643
|
+
<p>How many items are in the list?</p>
|
644
|
+
</dd><dt><code>first</code>
|
645
|
+
<dd>
|
646
|
+
<p>The first record in the list.</p>
|
647
|
+
</dd><dt><code>last</code>
|
648
|
+
<dd>
|
649
|
+
<p>The last record in the list.</p>
|
650
|
+
</dd></dl>
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
|
655
|
+
<div class="method-source-code" id="40entries-source">
|
656
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 147</span>
|
657
|
+
<span class="ruby-identifier">def_delegators</span> <span class="ruby-value">:@entries</span>, <span class="ruby-value">:each</span>, <span class="ruby-value">:empty?</span>, <span class="ruby-value">:size</span>, <span class="ruby-value">:first</span>, <span class="ruby-value">:last</span>
|
658
|
+
</pre>
|
659
|
+
</div>
|
660
|
+
|
661
|
+
</div>
|
662
|
+
|
663
|
+
|
664
|
+
|
665
|
+
|
744
666
|
</div>
|
745
667
|
|
746
668
|
|
data/doc/StandupMD/File.html
CHANGED
@@ -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>
|
@@ -186,7 +188,7 @@
|
|
186
188
|
|
187
189
|
|
188
190
|
<div class="method-source-code" id="config-source">
|
189
|
-
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line
|
191
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 17</span>
|
190
192
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
|
191
193
|
<span class="ruby-ivar">@config</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>
|
192
194
|
<span class="ruby-keyword">end</span></pre>
|
@@ -221,12 +223,11 @@
|
|
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
|
226
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 35</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
|
-
<span class="ruby-keyword">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
|
228
|
-
|
229
|
-
<span class="ruby-keyword">end</span>
|
229
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-node">"File #{file_name} not found."</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
|
230
|
+
|
230
231
|
<span class="ruby-identifier">new</span>(<span class="ruby-identifier">file_name</span>)
|
231
232
|
<span class="ruby-keyword">end</span></pre>
|
232
233
|
</div>
|
@@ -260,11 +261,10 @@
|
|
260
261
|
|
261
262
|
|
262
263
|
<div class="method-source-code" id="find_by_date-source">
|
263
|
-
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line
|
264
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 46</span>
|
264
265
|
<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
|
-
<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
|
-
|
267
|
-
<span class="ruby-keyword">end</span>
|
266
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Must be a Date object'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Date</span>)
|
267
|
+
|
268
268
|
<span class="ruby-identifier">find</span>(<span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">name_format</span>))
|
269
269
|
<span class="ruby-keyword">end</span></pre>
|
270
270
|
</div>
|
@@ -274,6 +274,43 @@
|
|
274
274
|
|
275
275
|
|
276
276
|
|
277
|
+
</div>
|
278
|
+
|
279
|
+
|
280
|
+
<div id="method-c-load" class="method-detail ">
|
281
|
+
|
282
|
+
<div class="method-heading">
|
283
|
+
<span class="method-name">load</span><span
|
284
|
+
class="method-args">(file_name)</span>
|
285
|
+
|
286
|
+
<span class="method-click-advice">click to toggle source</span>
|
287
|
+
|
288
|
+
</div>
|
289
|
+
|
290
|
+
|
291
|
+
<div class="method-description">
|
292
|
+
|
293
|
+
<p>Convenience method for calling <a href="File.html#method-c-find"><code>File.find(file_name)</code></a>.load</p>
|
294
|
+
|
295
|
+
<p>@param [String] file_name</p>
|
296
|
+
|
297
|
+
<p>@return [StandupMD::File]</p>
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
<div class="method-source-code" id="load-source">
|
303
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 27</span>
|
304
|
+
<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>)
|
305
|
+
<span class="ruby-identifier">new</span>(<span class="ruby-identifier">file_name</span>).<span class="ruby-identifier">load</span>
|
306
|
+
<span class="ruby-keyword">end</span></pre>
|
307
|
+
</div>
|
308
|
+
|
309
|
+
</div>
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
277
314
|
</div>
|
278
315
|
|
279
316
|
|
@@ -300,7 +337,7 @@
|
|
300
337
|
|
301
338
|
|
302
339
|
<div class="method-source-code" id="new-source">
|
303
|
-
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line
|
340
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 70</span>
|
304
341
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">file_name</span>)
|
305
342
|
<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
343
|
<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>)
|
@@ -310,6 +347,7 @@
|
|
310
347
|
|
311
348
|
<span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">directory</span>)
|
312
349
|
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Dir #{@config.directory} not found."</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">create</span>
|
350
|
+
|
313
351
|
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">directory</span>)
|
314
352
|
<span class="ruby-keyword">end</span>
|
315
353
|
|
@@ -317,6 +355,7 @@
|
|
317
355
|
|
318
356
|
<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-ivar">@name</span>)
|
319
357
|
<span class="ruby-identifier">raise</span> <span class="ruby-node">"File #{@name} not found."</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">create</span>
|
358
|
+
|
320
359
|
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">touch</span>(<span class="ruby-ivar">@name</span>)
|
321
360
|
<span class="ruby-keyword">end</span>
|
322
361
|
|
@@ -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
|
404
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 115</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,24 +436,26 @@
|
|
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
|
439
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 124</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">"File #{name} does not exist."</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>)
|
442
|
+
|
403
443
|
<span class="ruby-identifier">entry_list</span> = <span class="ruby-constant">EntryList</span>.<span class="ruby-identifier">new</span>
|
404
444
|
<span class="ruby-identifier">record</span> = {}
|
405
445
|
<span class="ruby-identifier">section_type</span> = <span class="ruby-string">''</span>
|
406
446
|
<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">foreach</span>(<span class="ruby-identifier">name</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
|
407
447
|
<span class="ruby-identifier">line</span>.<span class="ruby-identifier">chomp!</span>
|
408
448
|
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">empty?</span>
|
409
|
-
|
449
|
+
|
450
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">header?</span>(<span class="ruby-identifier">line</span>)
|
410
451
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">empty?</span>
|
411
452
|
<span class="ruby-identifier">entry_list</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">new_entry</span>(<span class="ruby-identifier">record</span>)
|
412
453
|
<span class="ruby-identifier">record</span> = {}
|
413
454
|
<span class="ruby-keyword">end</span>
|
414
|
-
<span class="ruby-identifier">record</span>[<span class="ruby-string">'header'</span>] = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp"
|
415
|
-
|
416
|
-
|
417
|
-
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">
|
455
|
+
<span class="ruby-identifier">record</span>[<span class="ruby-string">'header'</span>] = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/^\#{#{@config.header_depth}}\s*/</span>, <span class="ruby-string">''</span>)
|
456
|
+
<span class="ruby-identifier">section_type</span> = <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">notes_header</span>
|
457
|
+
<span class="ruby-identifier">record</span>[<span class="ruby-identifier">section_type</span>] = []
|
458
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">sub_header?</span>(<span class="ruby-identifier">line</span>)
|
418
459
|
<span class="ruby-identifier">section_type</span> = <span class="ruby-identifier">determine_section_type</span>(<span class="ruby-identifier">line</span>)
|
419
460
|
<span class="ruby-identifier">record</span>[<span class="ruby-identifier">section_type</span>] = []
|
420
461
|
<span class="ruby-keyword">else</span>
|
@@ -459,7 +500,7 @@
|
|
459
500
|
|
460
501
|
|
461
502
|
<div class="method-source-code" id="loaded-3F-source">
|
462
|
-
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line
|
503
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 107</span>
|
463
504
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">loaded?</span>
|
464
505
|
<span class="ruby-ivar">@loaded</span>
|
465
506
|
<span class="ruby-keyword">end</span></pre>
|
@@ -494,7 +535,7 @@
|
|
494
535
|
|
495
536
|
|
496
537
|
<div class="method-source-code" id="new-3F-source">
|
497
|
-
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line
|
538
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 99</span>
|
498
539
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new?</span>
|
499
540
|
<span class="ruby-ivar">@new</span>
|
500
541
|
<span class="ruby-keyword">end</span></pre>
|
@@ -512,7 +553,7 @@
|
|
512
553
|
|
513
554
|
<div class="method-heading">
|
514
555
|
<span class="method-name">write</span><span
|
515
|
-
class="method-args">(dates
|
556
|
+
class="method-args">(**dates)</span>
|
516
557
|
|
517
558
|
<span class="method-click-advice">click to toggle source</span>
|
518
559
|
|
@@ -523,7 +564,7 @@
|
|
523
564
|
|
524
565
|
<p>Writes a new entry to the file if the first entry in the file isn't today. This method is destructive; if a file for entries in the date range already exists, it will be clobbered with the entries in the range.</p>
|
525
566
|
|
526
|
-
<p>@param [Hash]
|
567
|
+
<p>@param [Hash] {start_date: Date, end_date: Date}</p>
|
527
568
|
|
528
569
|
<p>@return [Boolean] true if successful</p>
|
529
570
|
|
@@ -531,8 +572,8 @@
|
|
531
572
|
|
532
573
|
|
533
574
|
<div class="method-source-code" id="write-source">
|
534
|
-
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line
|
535
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">dates</span>
|
575
|
+
<pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 165</span>
|
576
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">dates</span>)
|
536
577
|
<span class="ruby-identifier">sorted_entries</span> = <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">sort</span>
|
537
578
|
<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>)
|
538
579
|
<span class="ruby-identifier">end_date</span> = <span class="ruby-identifier">dates</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:end_date</span>, <span class="ruby-identifier">sorted_entries</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">date</span>)
|
@@ -540,9 +581,10 @@
|
|
540
581
|
<span class="ruby-identifier">sorted_entries</span>.<span class="ruby-identifier">filter</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>).<span class="ruby-identifier">sort_reverse</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
|
541
582
|
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">date</span>)
|
542
583
|
<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">sub_header_order</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span>
|
543
|
-
<span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">
|
584
|
+
<span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">public_send</span>(<span class="ruby-identifier">attr</span>)
|
544
585
|
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">tasks</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">empty?</span>
|
545
|
-
|
586
|
+
|
587
|
+
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">sub_header</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">public_send</span>(<span class="ruby-node">"#{attr}_header"</span>).<span class="ruby-identifier">capitalize</span>)
|
546
588
|
<span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">bullet_character</span> <span class="ruby-operator">+</span> <span class="ruby-string">' '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">task</span> }
|
547
589
|
<span class="ruby-keyword">end</span>
|
548
590
|
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span>
|