standup_md 0.3.0 → 0.3.5

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.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +37 -19
  4. data/doc/README_md.html +35 -30
  5. data/doc/StandupMD.html +3 -7
  6. data/doc/StandupMD/Cli/Helpers.html +4 -4
  7. data/doc/StandupMD/Config.html +1 -1
  8. data/doc/StandupMD/Config/Cli.html +29 -20
  9. data/doc/StandupMD/Config/Entry.html +26 -14
  10. data/doc/StandupMD/Config/EntryList.html +26 -11
  11. data/doc/StandupMD/Config/File.html +30 -26
  12. data/doc/StandupMD/Entry.html +7 -7
  13. data/doc/StandupMD/EntryList.html +116 -194
  14. data/doc/StandupMD/File.html +51 -11
  15. data/doc/created.rid +15 -15
  16. data/doc/index.html +33 -30
  17. data/doc/js/search_index.js +1 -1
  18. data/doc/js/search_index.js.gz +0 -0
  19. data/doc/table_of_contents.html +41 -44
  20. data/lib/standup_md.rb +2 -2
  21. data/lib/standup_md/cli/helpers.rb +29 -5
  22. data/lib/standup_md/config.rb +2 -0
  23. data/lib/standup_md/config/cli.rb +25 -22
  24. data/lib/standup_md/config/entry.rb +15 -8
  25. data/lib/standup_md/config/entry_list.rb +10 -5
  26. data/lib/standup_md/config/file.rb +26 -16
  27. data/lib/standup_md/entry.rb +2 -1
  28. data/lib/standup_md/entry_list.rb +23 -40
  29. data/lib/standup_md/file.rb +14 -3
  30. data/lib/standup_md/version.rb +2 -4
  31. metadata +2 -2
data/doc/StandupMD/Config/Entry.html CHANGED
@@ -77,7 +77,7 @@
77
77
 
78
78
  <li ><a href="#method-c-new">::new</a>
79
79
 
80
- <li ><a href="#method-i-reset_values">#reset_values</a>
80
+ <li ><a href="#method-i-reset">#reset</a>
81
81
 
82
82
  </ul>
83
83
  </div>
@@ -103,6 +103,22 @@
103
103
 
104
104
 
105
105
 
106
+ <section class="constants-list">
107
+ <header>
108
+ <h3>Constants</h3>
109
+ </header>
110
+ <dl>
111
+
112
+ <dt id="DEFAULTS">DEFAULTS
113
+
114
+ <dd><p>The default options.</p>
115
+
116
+ <p>@return [Hash]</p>
117
+
118
+
119
+ </dl>
120
+ </section>
121
+
106
122
 
107
123
 
108
124
  <section class="attribute-method-details" class="method-section">
@@ -208,9 +224,9 @@
208
224
 
209
225
 
210
226
  <div class="method-source-code" id="new-source">
211
- <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 44</span>
227
+ <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 55</span>
212
228
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
213
- <span class="ruby-identifier">reset_values</span>
229
+ <span class="ruby-identifier">reset</span>
214
230
  <span class="ruby-keyword">end</span></pre>
215
231
  </div>
216
232
 
@@ -230,10 +246,10 @@
230
246
  </header>
231
247
 
232
248
 
233
- <div id="method-i-reset_values" class="method-detail ">
249
+ <div id="method-i-reset" class="method-detail ">
234
250
 
235
251
  <div class="method-heading">
236
- <span class="method-name">reset_values</span><span
252
+ <span class="method-name">reset</span><span
237
253
  class="method-args">()</span>
238
254
 
239
255
  <span class="method-click-advice">click to toggle source</span>
@@ -245,19 +261,15 @@
245
261
 
246
262
  <p>Sets all config values back to their defaults.</p>
247
263
 
248
- <p>@return [Boolean] true if successful</p>
264
+ <p>@return [Hash]</p>
249
265
 
250
266
 
251
267
 
252
268
 
253
- <div class="method-source-code" id="reset_values-source">
254
- <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 52</span>
255
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
256
- <span class="ruby-ivar">@current</span> = [<span class="ruby-string">&quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;</span>]
257
- <span class="ruby-ivar">@previous</span> = []
258
- <span class="ruby-ivar">@impediments</span> = [<span class="ruby-string">&#39;None&#39;</span>]
259
- <span class="ruby-ivar">@notes</span> = []
260
- <span class="ruby-keyword">true</span>
269
+ <div class="method-source-code" id="reset-source">
270
+ <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 63</span>
271
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
272
+ <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{k}&quot;</span>, <span class="ruby-identifier">v</span>) }
261
273
  <span class="ruby-keyword">end</span></pre>
262
274
  </div>
263
275
 
data/doc/StandupMD/Config/EntryList.html CHANGED
@@ -77,7 +77,7 @@
77
77
 
78
78
  <li ><a href="#method-i-initalize">#initalize</a>
79
79
 
80
- <li ><a href="#method-i-reset_values">#reset_values</a>
80
+ <li ><a href="#method-i-reset">#reset</a>
81
81
 
82
82
  </ul>
83
83
  </div>
@@ -103,6 +103,22 @@
103
103
 
104
104
 
105
105
 
106
+ <section class="constants-list">
107
+ <header>
108
+ <h3>Constants</h3>
109
+ </header>
110
+ <dl>
111
+
112
+ <dt id="DEFAULTS">DEFAULTS
113
+
114
+ <dd><p>The default options.</p>
115
+
116
+ <p>@return [Hash]</p>
117
+
118
+
119
+ </dl>
120
+ </section>
121
+
106
122
 
107
123
 
108
124
 
@@ -132,9 +148,9 @@
132
148
 
133
149
 
134
150
  <div class="method-source-code" id="initalize-source">
135
- <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 12</span>
151
+ <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 18</span>
136
152
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initalize</span>
137
- <span class="ruby-identifier">reset_values</span>
153
+ <span class="ruby-identifier">reset</span>
138
154
  <span class="ruby-keyword">end</span></pre>
139
155
  </div>
140
156
 
@@ -146,10 +162,10 @@
146
162
  </div>
147
163
 
148
164
 
149
- <div id="method-i-reset_values" class="method-detail ">
165
+ <div id="method-i-reset" class="method-detail ">
150
166
 
151
167
  <div class="method-heading">
152
- <span class="method-name">reset_values</span><span
168
+ <span class="method-name">reset</span><span
153
169
  class="method-args">()</span>
154
170
 
155
171
  <span class="method-click-advice">click to toggle source</span>
@@ -161,16 +177,15 @@
161
177
 
162
178
  <p>Sets all config values back to their defaults.</p>
163
179
 
164
- <p>@return [Boolean] true if successful</p>
180
+ <p>@return [Hash]</p>
165
181
 
166
182
 
167
183
 
168
184
 
169
- <div class="method-source-code" id="reset_values-source">
170
- <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 20</span>
171
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
172
- <span class="ruby-comment"># TODO add order ascending or decending.</span>
173
- <span class="ruby-keyword">true</span>
185
+ <div class="method-source-code" id="reset-source">
186
+ <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 26</span>
187
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
188
+ <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{k}&quot;</span>, <span class="ruby-identifier">v</span>) }
174
189
  <span class="ruby-keyword">end</span></pre>
175
190
  </div>
176
191
 
data/doc/StandupMD/Config/File.html CHANGED
@@ -83,7 +83,7 @@
83
83
 
84
84
  <li ><a href="#method-i-header_depth-3D">#header_depth=</a>
85
85
 
86
- <li ><a href="#method-i-reset_values">#reset_values</a>
86
+ <li ><a href="#method-i-reset">#reset</a>
87
87
 
88
88
  <li ><a href="#method-i-sub_header_depth-3D">#sub_header_depth=</a>
89
89
 
@@ -111,6 +111,22 @@
111
111
 
112
112
 
113
113
 
114
+ <section class="constants-list">
115
+ <header>
116
+ <h3>Constants</h3>
117
+ </header>
118
+ <dl>
119
+
120
+ <dt id="DEFAULTS">DEFAULTS
121
+
122
+ <dd><p>The default options.</p>
123
+
124
+ <p>@return [Hash]</p>
125
+
126
+
127
+ </dl>
128
+ </section>
129
+
114
130
 
115
131
 
116
132
  <section class="attribute-method-details" class="method-section">
@@ -364,9 +380,9 @@
364
380
 
365
381
 
366
382
  <div class="method-source-code" id="new-source">
367
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 118</span>
383
+ <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 140</span>
368
384
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
369
- <span class="ruby-identifier">reset_values</span>
385
+ <span class="ruby-identifier">reset</span>
370
386
  <span class="ruby-keyword">end</span></pre>
371
387
  </div>
372
388
 
@@ -409,7 +425,7 @@
409
425
 
410
426
 
411
427
  <div class="method-source-code" id="bullet_character-3D-source">
412
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 179</span>
428
+ <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 189</span>
413
429
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bullet_character=</span>(<span class="ruby-identifier">char</span>)
414
430
  <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Must be &quot;-&quot; or &quot;*&quot;&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-node">%w[- *]</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">char</span>)
415
431
  <span class="ruby-ivar">@bullet_character</span> = <span class="ruby-identifier">char</span>
@@ -447,7 +463,7 @@
447
463
 
448
464
 
449
465
  <div class="method-source-code" id="directory-3D-source">
450
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 192</span>
466
+ <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 202</span>
451
467
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">directory=</span>(<span class="ruby-identifier">directory</span>)
452
468
  <span class="ruby-identifier">directory</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">directory</span>)
453
469
  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">directory</span>) <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-identifier">directory</span>)
@@ -486,7 +502,7 @@
486
502
 
487
503
 
488
504
  <div class="method-source-code" id="header_depth-3D-source">
489
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 148</span>
505
+ <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 158</span>
490
506
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">header_depth=</span>(<span class="ruby-identifier">depth</span>)
491
507
  <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">depth</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-value">1</span>, <span class="ruby-value">5</span>)
492
508
  <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Header depth out of bounds (1..5)&#39;</span>
@@ -505,10 +521,10 @@
505
521
  </div>
506
522
 
507
523
 
508
- <div id="method-i-reset_values" class="method-detail ">
524
+ <div id="method-i-reset" class="method-detail ">
509
525
 
510
526
  <div class="method-heading">
511
- <span class="method-name">reset_values</span><span
527
+ <span class="method-name">reset</span><span
512
528
  class="method-args">()</span>
513
529
 
514
530
  <span class="method-click-advice">click to toggle source</span>
@@ -520,27 +536,15 @@
520
536
 
521
537
  <p>Sets all config values back to their defaults.</p>
522
538
 
523
- <p>@return [Boolean] true if successful</p>
539
+ <p>@return [Hash]</p>
524
540
 
525
541
 
526
542
 
527
543
 
528
- <div class="method-source-code" id="reset_values-source">
529
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 126</span>
530
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
531
- <span class="ruby-ivar">@header_date_format</span> = <span class="ruby-string">&#39;%Y-%m-%d&#39;</span>
532
- <span class="ruby-ivar">@header_depth</span> = <span class="ruby-value">1</span>
533
- <span class="ruby-ivar">@sub_header_depth</span> = <span class="ruby-value">2</span>
534
- <span class="ruby-ivar">@current_header</span> = <span class="ruby-string">&#39;Current&#39;</span>
535
- <span class="ruby-ivar">@previous_header</span> = <span class="ruby-string">&#39;Previous&#39;</span>
536
- <span class="ruby-ivar">@impediments_header</span> = <span class="ruby-string">&#39;Impediments&#39;</span>
537
- <span class="ruby-ivar">@notes_header</span> = <span class="ruby-string">&#39;Notes&#39;</span>
538
- <span class="ruby-ivar">@sub_header_order</span> = <span class="ruby-node">%w[previous current impediments notes]</span>
539
- <span class="ruby-ivar">@directory</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>], <span class="ruby-string">&#39;.cache&#39;</span>, <span class="ruby-string">&#39;standup_md&#39;</span>)
540
- <span class="ruby-ivar">@bullet_character</span> = <span class="ruby-string">&#39;-&#39;</span>
541
- <span class="ruby-ivar">@name_format</span> = <span class="ruby-string">&#39;%Y_%m.md&#39;</span>
542
- <span class="ruby-ivar">@create</span> = <span class="ruby-keyword">true</span>
543
- <span class="ruby-keyword">true</span>
544
+ <div class="method-source-code" id="reset-source">
545
+ <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 148</span>
546
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
547
+ <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{k}&quot;</span>, <span class="ruby-identifier">v</span>) }
544
548
  <span class="ruby-keyword">end</span></pre>
545
549
  </div>
546
550
 
@@ -575,7 +579,7 @@
575
579
 
576
580
 
577
581
  <div class="method-source-code" id="sub_header_depth-3D-source">
578
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 164</span>
582
+ <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 174</span>
579
583
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_depth=</span>(<span class="ruby-identifier">depth</span>)
580
584
  <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">depth</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-value">2</span>, <span class="ruby-value">6</span>)
581
585
  <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Sub-header depth out of bounds (2..6)&#39;</span>
data/doc/StandupMD/Entry.html CHANGED
@@ -170,7 +170,7 @@
170
170
 
171
171
  <div class="method-description">
172
172
 
173
- <p>Iimpediments for this entry.</p>
173
+ <p>Impediments for this entry.</p>
174
174
 
175
175
  <p>@return [Array]</p>
176
176
 
@@ -238,7 +238,7 @@
238
238
 
239
239
 
240
240
  <div class="method-source-code" id="config-source">
241
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 16</span>
241
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 17</span>
242
242
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
243
243
  <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</span>
244
244
  <span class="ruby-keyword">end</span></pre>
@@ -273,7 +273,7 @@
273
273
 
274
274
 
275
275
  <div class="method-source-code" id="create-source">
276
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 57</span>
276
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 58</span>
277
277
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create</span>
278
278
  <span class="ruby-identifier">entry</span> = <span class="ruby-identifier">new</span>(
279
279
  <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>,
@@ -324,7 +324,7 @@
324
324
 
325
325
 
326
326
  <div class="method-source-code" id="new-source">
327
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 81</span>
327
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 82</span>
328
328
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">date</span>, <span class="ruby-identifier">current</span>, <span class="ruby-identifier">previous</span>, <span class="ruby-identifier">impediments</span>, <span class="ruby-identifier">notes</span> = [])
329
329
  <span class="ruby-identifier">raise</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>)
330
330
  <span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
@@ -372,7 +372,7 @@
372
372
 
373
373
 
374
374
  <div class="method-source-code" id="3C-3D-3E-source">
375
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 94</span>
375
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 95</span>
376
376
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">&lt;=&gt;</span>(<span class="ruby-identifier">other</span>)
377
377
  <span class="ruby-identifier">date</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">date</span>
378
378
  <span class="ruby-keyword">end</span></pre>
@@ -407,7 +407,7 @@
407
407
 
408
408
 
409
409
  <div class="method-source-code" id="to_h-source">
410
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 102</span>
410
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 103</span>
411
411
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
412
412
  {
413
413
  <span class="ruby-identifier">date</span> <span class="ruby-operator">=&gt;</span> {
@@ -449,7 +449,7 @@
449
449
 
450
450
 
451
451
  <div class="method-source-code" id="to_json-source">
452
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 117</span>
452
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 118</span>
453
453
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
454
454
  <span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
455
455
  <span class="ruby-keyword">end</span></pre>
data/doc/StandupMD/EntryList.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">#&lt;&lt;</a>
94
116
 
95
- <li ><a href="#method-i-each">#each</a>
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 14</span>
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 24</span>
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 44</span>
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">&lt;&lt;</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">&#39;Entry must instance of StandupMD::Entry&#39;</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">(&amp;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">&amp;</span><span class="ruby-identifier">block</span>)
300
- <span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&amp;</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 108</span>
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 122</span>
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">(key)</span>
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="first-source">
482
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 132</span>
483
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">first</span>
484
- <span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">first</span>
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 78</span>
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 86</span>
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 95</span>
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 149</span>
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">&#39;current&#39;</span> <span class="ruby-operator">=&gt;</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 162</span>
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">&uarr; 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