standup_md 0.3.3 → 0.3.8

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 (38) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +11 -9
  3. data/README.md +66 -33
  4. data/Rakefile +3 -1
  5. data/doc/README_md.html +53 -53
  6. data/doc/StandupMD.html +7 -96
  7. data/doc/StandupMD/Cli.html +21 -163
  8. data/doc/StandupMD/Cli/Helpers.html +13 -34
  9. data/doc/StandupMD/Config.html +7 -44
  10. data/doc/StandupMD/Config/Cli.html +10 -78
  11. data/doc/StandupMD/Config/Entry.html +10 -66
  12. data/doc/StandupMD/Config/EntryList.html +7 -48
  13. data/doc/StandupMD/Config/File.html +14 -146
  14. data/doc/StandupMD/Entry.html +11 -120
  15. data/doc/StandupMD/EntryList.html +94 -354
  16. data/doc/StandupMD/File.html +51 -182
  17. data/doc/StandupMD/Version.html +143 -0
  18. data/doc/created.rid +15 -15
  19. data/doc/css/rdoc.css +1 -1
  20. data/doc/index.html +51 -66
  21. data/doc/js/navigation.js.gz +0 -0
  22. data/doc/js/search_index.js +1 -1
  23. data/doc/js/search_index.js.gz +0 -0
  24. data/doc/js/searcher.js.gz +0 -0
  25. data/doc/table_of_contents.html +46 -105
  26. data/lib/standup_md.rb +2 -1
  27. data/lib/standup_md/cli.rb +2 -3
  28. data/lib/standup_md/cli/helpers.rb +66 -34
  29. data/lib/standup_md/config.rb +0 -2
  30. data/lib/standup_md/config/cli.rb +2 -4
  31. data/lib/standup_md/config/entry.rb +2 -4
  32. data/lib/standup_md/entry.rb +3 -6
  33. data/lib/standup_md/entry_list.rb +20 -37
  34. data/lib/standup_md/file.rb +32 -15
  35. data/lib/standup_md/file/helpers.rb +13 -15
  36. data/lib/standup_md/version.rb +22 -4
  37. data/standup_md.gemspec +12 -16
  38. metadata +7 -6
data/doc/StandupMD/File.html CHANGED
@@ -21,8 +21,6 @@
21
21
  <link href="../css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
-
26
24
  <body id="top" role="document" class="class">
27
25
  <nav role="navigation">
28
26
  <div id="project-navigation">
@@ -59,42 +57,31 @@
59
57
 
60
58
  <div id="class-metadata">
61
59
 
62
- <div id="parent-class-section" class="nav-section">
60
+
61
+ <div id="parent-class-section" class="nav-section">
63
62
  <h3>Parent</h3>
64
63
 
65
-
66
64
  <p class="link">Object
67
-
68
65
  </div>
69
66
 
70
67
 
71
68
 
72
- <!-- Method Quickref -->
69
+
70
+ <!-- Method Quickref -->
73
71
  <div id="method-list-section" class="nav-section">
74
72
  <h3>Methods</h3>
75
73
 
76
74
  <ul class="link-list" role="directory">
77
-
78
75
  <li ><a href="#method-c-config">::config</a>
79
-
80
76
  <li ><a href="#method-c-find">::find</a>
81
-
82
77
  <li ><a href="#method-c-find_by_date">::find_by_date</a>
83
-
84
78
  <li ><a href="#method-c-load">::load</a>
85
-
86
79
  <li ><a href="#method-c-new">::new</a>
87
-
88
80
  <li ><a href="#method-i-exist-3F">#exist?</a>
89
-
90
81
  <li ><a href="#method-i-load">#load</a>
91
-
92
82
  <li ><a href="#method-i-loaded-3F">#loaded?</a>
93
-
94
83
  <li ><a href="#method-i-new-3F">#new?</a>
95
-
96
84
  <li ><a href="#method-i-write">#write</a>
97
-
98
85
  </ul>
99
86
  </div>
100
87
 
@@ -112,21 +99,15 @@
112
99
 
113
100
  </section>
114
101
 
115
-
116
102
  <section id="5Buntitled-5D" class="documentation-section">
117
-
118
103
 
119
-
120
104
 
121
-
122
105
 
123
-
124
106
  <section class="attribute-method-details" class="method-section">
125
107
  <header>
126
108
  <h3>Attributes</h3>
127
109
  </header>
128
110
 
129
-
130
111
  <div id="attribute-i-entries" class="method-detail">
131
112
  <div class="method-heading attribute-method-heading">
132
113
  <span class="method-name">entries</span><span
@@ -134,14 +115,11 @@
134
115
  </div>
135
116
 
136
117
  <div class="method-description">
137
-
138
118
  <p>The list of entries in the file.</p>
139
119
 
140
120
  <p>@return [StandupMP::EntryList]</p>
141
-
142
121
  </div>
143
122
  </div>
144
-
145
123
  <div id="attribute-i-name" class="method-detail">
146
124
  <div class="method-heading attribute-method-heading">
147
125
  <span class="method-name">name</span><span
@@ -149,197 +127,149 @@
149
127
  </div>
150
128
 
151
129
  <div class="method-description">
152
-
153
130
  <p>The name of the file.</p>
154
131
 
155
132
  <p>@return [String]</p>
156
-
157
133
  </div>
158
134
  </div>
159
-
160
135
  </section>
161
-
162
136
 
163
-
137
+
164
138
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
165
139
  <header>
166
140
  <h3>Public Class Methods</h3>
167
141
  </header>
168
142
 
169
-
170
143
  <div id="method-c-config" class="method-detail ">
171
-
172
144
  <div class="method-heading">
173
145
  <span class="method-name">config</span><span
174
146
  class="method-args">()</span>
175
-
176
147
  <span class="method-click-advice">click to toggle source</span>
177
-
178
148
  </div>
179
-
180
149
 
181
150
  <div class="method-description">
182
-
183
151
  <p>Access to the class&#39;s configuration.</p>
184
152
 
185
153
  <p>@return [StandupMD::Config::EntryList]</p>
186
-
187
-
188
154
 
189
-
190
155
  <div class="method-source-code" id="config-source">
191
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 18</span>
156
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 17</span>
192
157
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
193
158
  <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>
194
159
  <span class="ruby-keyword">end</span></pre>
195
160
  </div>
196
-
197
161
  </div>
198
162
 
199
-
200
163
 
201
-
202
164
  </div>
203
165
 
204
-
205
166
  <div id="method-c-find" class="method-detail ">
206
-
207
167
  <div class="method-heading">
208
168
  <span class="method-name">find</span><span
209
169
  class="method-args">(file_name)</span>
210
-
211
170
  <span class="method-click-advice">click to toggle source</span>
212
-
213
171
  </div>
214
-
215
172
 
216
173
  <div class="method-description">
217
-
218
174
  <p>Find standup file in directory by file name.</p>
219
175
 
220
176
  <p>@param [String] File_naem</p>
221
-
222
-
223
177
 
224
-
225
178
  <div class="method-source-code" id="find-source">
226
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 36</span>
179
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 40</span>
227
180
  <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>)
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> }
229
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
230
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{file_name} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
181
+ <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">config</span>.<span class="ruby-identifier">directory</span>)
182
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Dir #{config.directory} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
183
+
184
+ <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>)
231
185
  <span class="ruby-keyword">end</span>
186
+ <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> }
187
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{file_name} not found.&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
188
+
232
189
  <span class="ruby-identifier">new</span>(<span class="ruby-identifier">file_name</span>)
233
190
  <span class="ruby-keyword">end</span></pre>
234
191
  </div>
235
-
236
192
  </div>
237
193
 
238
-
239
194
 
240
-
241
195
  </div>
242
196
 
243
-
244
197
  <div id="method-c-find_by_date" class="method-detail ">
245
-
246
198
  <div class="method-heading">
247
199
  <span class="method-name">find_by_date</span><span
248
200
  class="method-args">(date)</span>
249
-
250
201
  <span class="method-click-advice">click to toggle source</span>
251
-
252
202
  </div>
253
-
254
203
 
255
204
  <div class="method-description">
256
-
257
205
  <p>Find standup file in directory by Date object.</p>
258
206
 
259
207
  <p>@param [Date] date</p>
260
-
261
-
262
208
 
263
-
264
209
  <div class="method-source-code" id="find_by_date-source">
265
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 48</span>
210
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 56</span>
266
211
  <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>)
267
- <span class="ruby-keyword">unless</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Date</span>)
268
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Argument must be a Date object&quot;</span>
212
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&#39;Must be a Date object&#39;</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>)
213
+
214
+ <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">config</span>.<span class="ruby-identifier">directory</span>)
215
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Dir #{config.directory} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
216
+
217
+ <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>)
269
218
  <span class="ruby-keyword">end</span>
270
219
  <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>))
271
220
  <span class="ruby-keyword">end</span></pre>
272
221
  </div>
273
-
274
222
  </div>
275
223
 
276
-
277
224
 
278
-
279
225
  </div>
280
226
 
281
-
282
227
  <div id="method-c-load" class="method-detail ">
283
-
284
228
  <div class="method-heading">
285
229
  <span class="method-name">load</span><span
286
230
  class="method-args">(file_name)</span>
287
-
288
231
  <span class="method-click-advice">click to toggle source</span>
289
-
290
232
  </div>
291
-
292
233
 
293
234
  <div class="method-description">
294
-
295
235
  <p>Convenience method for calling <a href="File.html#method-c-find"><code>File.find(file_name)</code></a>.load</p>
296
236
 
297
237
  <p>@param [String] file_name</p>
298
238
 
299
239
  <p>@return [StandupMD::File]</p>
300
-
301
-
302
240
 
303
-
304
241
  <div class="method-source-code" id="load-source">
305
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 28</span>
242
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 27</span>
306
243
  <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>)
244
+ <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">config</span>.<span class="ruby-identifier">directory</span>)
245
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Dir #{config.directory} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
246
+
247
+ <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>)
248
+ <span class="ruby-keyword">end</span>
307
249
  <span class="ruby-identifier">new</span>(<span class="ruby-identifier">file_name</span>).<span class="ruby-identifier">load</span>
308
250
  <span class="ruby-keyword">end</span></pre>
309
251
  </div>
310
-
311
252
  </div>
312
253
 
313
-
314
254
 
315
-
316
255
  </div>
317
256
 
318
-
319
257
  <div id="method-c-new" class="method-detail ">
320
-
321
258
  <div class="method-heading">
322
259
  <span class="method-name">new</span><span
323
260
  class="method-args">(file_name)</span>
324
-
325
261
  <span class="method-click-advice">click to toggle source</span>
326
-
327
262
  </div>
328
-
329
263
 
330
264
  <div class="method-description">
331
-
332
265
  <p>Constructs the instance.</p>
333
266
 
334
267
  <p>@param [String] file_name</p>
335
268
 
336
269
  <p>@return [StandupMP::File]</p>
337
-
338
-
339
270
 
340
-
341
271
  <div class="method-source-code" id="new-source">
342
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 73</span>
272
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 85</span>
343
273
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">file_name</span>)
344
274
  <span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
345
275
  <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>)
@@ -349,6 +279,7 @@
349
279
 
350
280
  <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>)
351
281
  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Dir #{@config.directory} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">create</span>
282
+
352
283
  <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>)
353
284
  <span class="ruby-keyword">end</span>
354
285
 
@@ -356,6 +287,7 @@
356
287
 
357
288
  <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>)
358
289
  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{@name} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">create</span>
290
+
359
291
  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">touch</span>(<span class="ruby-ivar">@name</span>)
360
292
  <span class="ruby-keyword">end</span>
361
293
 
@@ -363,97 +295,74 @@
363
295
  <span class="ruby-ivar">@loaded</span> = <span class="ruby-keyword">false</span>
364
296
  <span class="ruby-keyword">end</span></pre>
365
297
  </div>
366
-
367
298
  </div>
368
299
 
369
-
370
300
 
371
-
372
301
  </div>
373
302
 
374
-
375
303
  </section>
376
-
304
+
377
305
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
378
306
  <header>
379
307
  <h3>Public Instance Methods</h3>
380
308
  </header>
381
309
 
382
-
383
310
  <div id="method-i-exist-3F" class="method-detail ">
384
-
385
311
  <div class="method-heading">
386
312
  <span class="method-name">exist?</span><span
387
313
  class="method-args">()</span>
388
-
389
314
  <span class="method-click-advice">click to toggle source</span>
390
-
391
315
  </div>
392
-
393
316
 
394
317
  <div class="method-description">
395
-
396
318
  <p>Does the file exist?</p>
397
319
 
398
320
  <p>@return [Boolean] true if exists</p>
399
-
400
-
401
321
 
402
-
403
322
  <div class="method-source-code" id="exist-3F-source">
404
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 116</span>
323
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 130</span>
405
324
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">exist?</span>
406
325
  <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">name</span>)
407
326
  <span class="ruby-keyword">end</span></pre>
408
327
  </div>
409
-
410
328
  </div>
411
329
 
412
-
413
330
 
414
-
415
331
  </div>
416
332
 
417
-
418
333
  <div id="method-i-load" class="method-detail ">
419
-
420
334
  <div class="method-heading">
421
335
  <span class="method-name">load</span><span
422
336
  class="method-args">()</span>
423
-
424
337
  <span class="method-click-advice">click to toggle source</span>
425
-
426
338
  </div>
427
-
428
339
 
429
340
  <div class="method-description">
430
-
431
341
  <p>Loads the file&#39;s contents. TODO clean up this method.</p>
432
342
 
433
343
  <p>@return [StandupMD::FileList]</p>
434
-
435
-
436
344
 
437
-
438
345
  <div class="method-source-code" id="load-source">
439
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 125</span>
346
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 139</span>
440
347
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load</span>
441
348
  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{name} does not exist.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">name</span>)
349
+
442
350
  <span class="ruby-identifier">entry_list</span> = <span class="ruby-constant">EntryList</span>.<span class="ruby-identifier">new</span>
443
351
  <span class="ruby-identifier">record</span> = {}
444
352
  <span class="ruby-identifier">section_type</span> = <span class="ruby-string">&#39;&#39;</span>
445
353
  <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>
446
354
  <span class="ruby-identifier">line</span>.<span class="ruby-identifier">chomp!</span>
447
355
  <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>
448
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">is_header?</span>(<span class="ruby-identifier">line</span>)
356
+
357
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">header?</span>(<span class="ruby-identifier">line</span>)
449
358
  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">empty?</span>
450
359
  <span class="ruby-identifier">entry_list</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">new_entry</span>(<span class="ruby-identifier">record</span>)
451
360
  <span class="ruby-identifier">record</span> = {}
452
361
  <span class="ruby-keyword">end</span>
453
- <span class="ruby-identifier">record</span>[<span class="ruby-string">&#39;header&#39;</span>] = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">%r{^\#{#{@config.header_depth}}\s*}</span>, <span class="ruby-string">&#39;&#39;</span>)
454
- <span class="ruby-identifier">section_type</span> = <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">notes_header</span>
455
- <span class="ruby-identifier">record</span>[<span class="ruby-identifier">section_type</span>] = []
456
- <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">is_sub_header?</span>(<span class="ruby-identifier">line</span>)
362
+ <span class="ruby-identifier">record</span>[<span class="ruby-string">&#39;header&#39;</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">&#39;&#39;</span>)
363
+ <span class="ruby-identifier">section_type</span> = <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">notes_header</span>
364
+ <span class="ruby-identifier">record</span>[<span class="ruby-identifier">section_type</span>] = []
365
+ <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">sub_header?</span>(<span class="ruby-identifier">line</span>)
457
366
  <span class="ruby-identifier">section_type</span> = <span class="ruby-identifier">determine_section_type</span>(<span class="ruby-identifier">line</span>)
458
367
  <span class="ruby-identifier">record</span>[<span class="ruby-identifier">section_type</span>] = []
459
368
  <span class="ruby-keyword">else</span>
@@ -468,110 +377,74 @@
468
377
  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File malformation: #{e}&quot;</span>
469
378
  <span class="ruby-keyword">end</span></pre>
470
379
  </div>
471
-
472
380
  </div>
473
381
 
474
-
475
382
 
476
-
477
383
  </div>
478
384
 
479
-
480
385
  <div id="method-i-loaded-3F" class="method-detail ">
481
-
482
386
  <div class="method-heading">
483
387
  <span class="method-name">loaded?</span><span
484
388
  class="method-args">()</span>
485
-
486
389
  <span class="method-click-advice">click to toggle source</span>
487
-
488
390
  </div>
489
-
490
391
 
491
392
  <div class="method-description">
492
-
493
393
  <p>Has the file been loaded?</p>
494
394
 
495
395
  <p>@return [Boolean] true if loaded</p>
496
-
497
-
498
396
 
499
-
500
397
  <div class="method-source-code" id="loaded-3F-source">
501
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 108</span>
398
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 122</span>
502
399
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">loaded?</span>
503
400
  <span class="ruby-ivar">@loaded</span>
504
401
  <span class="ruby-keyword">end</span></pre>
505
402
  </div>
506
-
507
403
  </div>
508
404
 
509
-
510
405
 
511
-
512
406
  </div>
513
407
 
514
-
515
408
  <div id="method-i-new-3F" class="method-detail ">
516
-
517
409
  <div class="method-heading">
518
410
  <span class="method-name">new?</span><span
519
411
  class="method-args">()</span>
520
-
521
412
  <span class="method-click-advice">click to toggle source</span>
522
-
523
413
  </div>
524
-
525
414
 
526
415
  <div class="method-description">
527
-
528
416
  <p>Was the file just now created?</p>
529
417
 
530
418
  <p>@return [Boolean] true if new</p>
531
-
532
-
533
419
 
534
-
535
420
  <div class="method-source-code" id="new-3F-source">
536
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 100</span>
421
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 114</span>
537
422
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new?</span>
538
423
  <span class="ruby-ivar">@new</span>
539
424
  <span class="ruby-keyword">end</span></pre>
540
425
  </div>
541
-
542
426
  </div>
543
427
 
544
-
545
428
 
546
-
547
429
  </div>
548
430
 
549
-
550
431
  <div id="method-i-write" class="method-detail ">
551
-
552
432
  <div class="method-heading">
553
433
  <span class="method-name">write</span><span
554
- class="method-args">(dates = {})</span>
555
-
434
+ class="method-args">(**dates)</span>
556
435
  <span class="method-click-advice">click to toggle source</span>
557
-
558
436
  </div>
559
-
560
437
 
561
438
  <div class="method-description">
562
-
563
439
  <p>Writes a new entry to the file if the first entry in the file isn&#39;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>
564
440
 
565
- <p>@param [Hash] start_and_end_date</p>
441
+ <p>@param [Hash] {start_date: Date, end_date: Date}</p>
566
442
 
567
443
  <p>@return [Boolean] true if successful</p>
568
-
569
-
570
444
 
571
-
572
445
  <div class="method-source-code" id="write-source">
573
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 164</span>
574
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">dates</span> = {})
446
+ <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 180</span>
447
+ <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>)
575
448
  <span class="ruby-identifier">sorted_entries</span> = <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">sort</span>
576
449
  <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>)
577
450
  <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>)
@@ -579,9 +452,10 @@
579
452
  <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>
580
453
  <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>)
581
454
  <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>
582
- <span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">attr</span>)
455
+ <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>)
583
456
  <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>
584
- <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">send</span>(<span class="ruby-node">&quot;#{attr}_header&quot;</span>).<span class="ruby-identifier">capitalize</span>)
457
+
458
+ <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">&quot;#{attr}_header&quot;</span>).<span class="ruby-identifier">capitalize</span>)
585
459
  <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">&#39; &#39;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">task</span> }
586
460
  <span class="ruby-keyword">end</span>
587
461
  <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span>
@@ -590,25 +464,20 @@
590
464
  <span class="ruby-keyword">true</span>
591
465
  <span class="ruby-keyword">end</span></pre>
592
466
  </div>
593
-
594
467
  </div>
595
468
 
596
-
597
469
 
598
-
599
470
  </div>
600
471
 
601
-
602
472
  </section>
603
-
604
- </section>
605
473
 
474
+ </section>
606
475
  </main>
607
476
 
608
477
 
609
478
  <footer id="validator-badges" role="contentinfo">
610
479
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
611
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
480
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
612
481
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
613
482
  </footer>
614
483