standup_md 0.3.5 → 0.3.10

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.
@@ -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,45 +57,35 @@
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
- <div id="includes-section" class="nav-section">
67
+
68
+ <div id="includes-section" class="nav-section">
71
69
  <h3>Included Modules</h3>
72
70
 
73
71
  <ul class="link-list">
74
-
75
-
76
72
  <li><span class="include">Comparable</span>
77
-
78
-
79
73
  </ul>
80
74
  </div>
81
75
 
82
76
 
83
- <!-- Method Quickref -->
77
+
78
+ <!-- Method Quickref -->
84
79
  <div id="method-list-section" class="nav-section">
85
80
  <h3>Methods</h3>
86
81
 
87
82
  <ul class="link-list" role="directory">
88
-
89
83
  <li ><a href="#method-c-config">::config</a>
90
-
91
84
  <li ><a href="#method-c-create">::create</a>
92
-
93
85
  <li ><a href="#method-c-new">::new</a>
94
-
95
86
  <li ><a href="#method-i-3C-3D-3E">#&lt;=&gt;</a>
96
-
97
87
  <li ><a href="#method-i-to_h">#to_h</a>
98
-
99
88
  <li ><a href="#method-i-to_json">#to_json</a>
100
-
101
89
  </ul>
102
90
  </div>
103
91
 
@@ -115,21 +103,15 @@
115
103
 
116
104
  </section>
117
105
 
118
-
119
106
  <section id="5Buntitled-5D" class="documentation-section">
120
-
121
107
 
122
-
123
108
 
124
-
125
109
 
126
-
127
110
  <section class="attribute-method-details" class="method-section">
128
111
  <header>
129
112
  <h3>Attributes</h3>
130
113
  </header>
131
114
 
132
-
133
115
  <div id="attribute-i-current" class="method-detail">
134
116
  <div class="method-heading attribute-method-heading">
135
117
  <span class="method-name">current</span><span
@@ -137,14 +119,11 @@
137
119
  </div>
138
120
 
139
121
  <div class="method-description">
140
-
141
122
  <p>The tasks for today.</p>
142
123
 
143
124
  <p>@return [Array]</p>
144
-
145
125
  </div>
146
126
  </div>
147
-
148
127
  <div id="attribute-i-date" class="method-detail">
149
128
  <div class="method-heading attribute-method-heading">
150
129
  <span class="method-name">date</span><span
@@ -152,16 +131,13 @@
152
131
  </div>
153
132
 
154
133
  <div class="method-description">
155
-
156
134
  <p>The date of the entry.</p>
157
135
 
158
136
  <p>@param [Date] date</p>
159
137
 
160
138
  <p>@return [Date]</p>
161
-
162
139
  </div>
163
140
  </div>
164
-
165
141
  <div id="attribute-i-impediments" class="method-detail">
166
142
  <div class="method-heading attribute-method-heading">
167
143
  <span class="method-name">impediments</span><span
@@ -169,14 +145,11 @@
169
145
  </div>
170
146
 
171
147
  <div class="method-description">
172
-
173
148
  <p>Impediments for this entry.</p>
174
149
 
175
150
  <p>@return [Array]</p>
176
-
177
151
  </div>
178
152
  </div>
179
-
180
153
  <div id="attribute-i-notes" class="method-detail">
181
154
  <div class="method-heading attribute-method-heading">
182
155
  <span class="method-name">notes</span><span
@@ -184,14 +157,11 @@
184
157
  </div>
185
158
 
186
159
  <div class="method-description">
187
-
188
160
  <p>Nnotes to add to this entry.</p>
189
161
 
190
162
  <p>@return [Array]</p>
191
-
192
163
  </div>
193
164
  </div>
194
-
195
165
  <div id="attribute-i-previous" class="method-detail">
196
166
  <div class="method-heading attribute-method-heading">
197
167
  <span class="method-name">previous</span><span
@@ -199,115 +169,79 @@
199
169
  </div>
200
170
 
201
171
  <div class="method-description">
202
-
203
172
  <p>The tasks from the previous day.</p>
204
173
 
205
174
  <p>@return [Array]</p>
206
-
207
175
  </div>
208
176
  </div>
209
-
210
177
  </section>
211
-
212
178
 
213
-
179
+
214
180
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
215
181
  <header>
216
182
  <h3>Public Class Methods</h3>
217
183
  </header>
218
184
 
219
-
220
185
  <div id="method-c-config" class="method-detail ">
221
-
222
186
  <div class="method-heading">
223
187
  <span class="method-name">config</span><span
224
188
  class="method-args">()</span>
225
-
226
189
  <span class="method-click-advice">click to toggle source</span>
227
-
228
190
  </div>
229
-
230
191
 
231
192
  <div class="method-description">
232
-
233
193
  <p>Access to the class&#39;s configuration.</p>
234
194
 
235
195
  <p>@return [StandupMD::Config::Entry]</p>
236
-
237
-
238
196
 
239
-
240
197
  <div class="method-source-code" id="config-source">
241
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 17</span>
198
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 16</span>
242
199
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
243
200
  <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
201
  <span class="ruby-keyword">end</span></pre>
245
202
  </div>
246
-
247
203
  </div>
248
204
 
249
-
250
205
 
251
-
252
206
  </div>
253
207
 
254
-
255
208
  <div id="method-c-create" class="method-detail ">
256
-
257
209
  <div class="method-heading">
258
210
  <span class="method-name">create</span><span
259
- class="method-args">() { |config| ... }</span>
260
-
211
+ class="method-args">() { |entry| ... }</span>
261
212
  <span class="method-click-advice">click to toggle source</span>
262
-
263
213
  </div>
264
-
265
214
 
266
215
  <div class="method-description">
267
-
268
216
  <p>Creates a generic entry. Default values can be set via configuration. Yields the entry if a block is passed so you can change values.</p>
269
217
 
270
218
  <p>@return [StandupMD::Entry]</p>
271
-
272
-
273
219
 
274
-
275
220
  <div class="method-source-code" id="create-source">
276
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 58</span>
221
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 57</span>
277
222
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create</span>
278
- <span class="ruby-identifier">entry</span> = <span class="ruby-identifier">new</span>(
223
+ <span class="ruby-identifier">new</span>(
279
224
  <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>,
280
225
  <span class="ruby-identifier">config</span>.<span class="ruby-identifier">current</span>,
281
226
  <span class="ruby-identifier">config</span>.<span class="ruby-identifier">previous</span>,
282
227
  <span class="ruby-identifier">config</span>.<span class="ruby-identifier">impediments</span>,
283
228
  <span class="ruby-identifier">config</span>.<span class="ruby-identifier">notes</span>
284
- )
285
- <span class="ruby-keyword">yield</span> <span class="ruby-identifier">config</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
286
- <span class="ruby-identifier">entry</span>
229
+ ).<span class="ruby-identifier">tap</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">entry</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span> }
287
230
  <span class="ruby-keyword">end</span></pre>
288
231
  </div>
289
-
290
232
  </div>
291
233
 
292
-
293
234
 
294
-
295
235
  </div>
296
236
 
297
-
298
237
  <div id="method-c-new" class="method-detail ">
299
-
300
238
  <div class="method-heading">
301
239
  <span class="method-name">new</span><span
302
240
  class="method-args">(date, current, previous, impediments, notes = [])</span>
303
-
304
241
  <span class="method-click-advice">click to toggle source</span>
305
-
306
242
  </div>
307
-
308
243
 
309
244
  <div class="method-description">
310
-
311
245
  <p>Constructs instance of <code>StandupMD::Entry</code>.</p>
312
246
 
313
247
  <p>@param [Date] date</p>
@@ -319,95 +253,67 @@
319
253
  <p>@param [Array] impediments</p>
320
254
 
321
255
  <p>@param [Array] notes</p>
322
-
323
-
324
256
 
325
-
326
257
  <div class="method-source-code" id="new-source">
327
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 82</span>
258
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 79</span>
328
259
  <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
260
  <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
261
  <span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
331
262
 
332
- <span class="ruby-ivar">@date</span> = <span class="ruby-identifier">date</span>
333
- <span class="ruby-ivar">@current</span> = <span class="ruby-identifier">current</span>
334
- <span class="ruby-ivar">@previous</span> = <span class="ruby-identifier">previous</span>
335
- <span class="ruby-ivar">@impediments</span> = <span class="ruby-identifier">impediments</span>
336
- <span class="ruby-ivar">@notes</span> = <span class="ruby-identifier">notes</span>
263
+ <span class="ruby-ivar">@date</span> = <span class="ruby-identifier">date</span>
264
+ <span class="ruby-ivar">@current</span> = <span class="ruby-identifier">current</span>
265
+ <span class="ruby-ivar">@previous</span> = <span class="ruby-identifier">previous</span>
266
+ <span class="ruby-ivar">@impediments</span> = <span class="ruby-identifier">impediments</span>
267
+ <span class="ruby-ivar">@notes</span> = <span class="ruby-identifier">notes</span>
337
268
  <span class="ruby-keyword">end</span></pre>
338
269
  </div>
339
-
340
270
  </div>
341
271
 
342
-
343
272
 
344
-
345
273
  </div>
346
274
 
347
-
348
275
  </section>
349
-
276
+
350
277
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
351
278
  <header>
352
279
  <h3>Public Instance Methods</h3>
353
280
  </header>
354
281
 
355
-
356
282
  <div id="method-i-3C-3D-3E" class="method-detail ">
357
-
358
283
  <div class="method-heading">
359
284
  <span class="method-name">&lt;=&gt;</span><span
360
285
  class="method-args">(other)</span>
361
-
362
286
  <span class="method-click-advice">click to toggle source</span>
363
-
364
287
  </div>
365
-
366
288
 
367
289
  <div class="method-description">
368
-
369
290
  <p>Sorting method for Comparable. Entries are compared by date.</p>
370
-
371
-
372
291
 
373
-
374
292
  <div class="method-source-code" id="3C-3D-3E-source">
375
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 95</span>
293
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 92</span>
376
294
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">&lt;=&gt;</span>(<span class="ruby-identifier">other</span>)
377
295
  <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
296
  <span class="ruby-keyword">end</span></pre>
379
297
  </div>
380
-
381
298
  </div>
382
299
 
383
-
384
300
 
385
-
386
301
  </div>
387
302
 
388
-
389
303
  <div id="method-i-to_h" class="method-detail ">
390
-
391
304
  <div class="method-heading">
392
305
  <span class="method-name">to_h</span><span
393
306
  class="method-args">()</span>
394
-
395
307
  <span class="method-click-advice">click to toggle source</span>
396
-
397
308
  </div>
398
-
399
309
 
400
310
  <div class="method-description">
401
-
402
311
  <p><a href="Entry.html"><code>Entry</code></a> as a hash .</p>
403
312
 
404
313
  <p>@return [Hash]</p>
405
-
406
-
407
314
 
408
-
409
315
  <div class="method-source-code" id="to_h-source">
410
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 103</span>
316
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 100</span>
411
317
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
412
318
  {
413
319
  <span class="ruby-identifier">date</span> <span class="ruby-operator">=&gt;</span> {
@@ -419,60 +325,43 @@
419
325
  }
420
326
  <span class="ruby-keyword">end</span></pre>
421
327
  </div>
422
-
423
328
  </div>
424
329
 
425
-
426
330
 
427
-
428
331
  </div>
429
332
 
430
-
431
333
  <div id="method-i-to_json" class="method-detail ">
432
-
433
334
  <div class="method-heading">
434
335
  <span class="method-name">to_json</span><span
435
336
  class="method-args">()</span>
436
-
437
337
  <span class="method-click-advice">click to toggle source</span>
438
-
439
338
  </div>
440
-
441
339
 
442
340
  <div class="method-description">
443
-
444
341
  <p><a href="Entry.html"><code>Entry</code></a> as a json object.</p>
445
342
 
446
343
  <p>@return [String]</p>
447
-
448
-
449
344
 
450
-
451
345
  <div class="method-source-code" id="to_json-source">
452
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 118</span>
346
+ <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 115</span>
453
347
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
454
348
  <span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
455
349
  <span class="ruby-keyword">end</span></pre>
456
350
  </div>
457
-
458
351
  </div>
459
352
 
460
-
461
353
 
462
-
463
354
  </div>
464
355
 
465
-
466
356
  </section>
467
-
468
- </section>
469
357
 
358
+ </section>
470
359
  </main>
471
360
 
472
361
 
473
362
  <footer id="validator-badges" role="contentinfo">
474
363
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
475
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
364
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
476
365
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
477
366
  </footer>
478
367
 
@@ -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">
@@ -58,80 +56,59 @@
58
56
 
59
57
 
60
58
  <div id="class-metadata">
61
- <div id="sections-section" class="nav-section">
59
+
60
+ <div id="sections-section" class="nav-section">
62
61
  <h3>Sections</h3>
63
62
 
64
63
  <ul class="link-list" role="directory">
65
-
66
64
  <li><a href="#5Buntitled-5D"></a></li>
67
-
68
65
  <li><a href="#Delegators">Delegators</a></li>
69
-
70
66
  </ul>
71
67
  </div>
72
68
 
73
- <div id="parent-class-section" class="nav-section">
69
+
70
+ <div id="parent-class-section" class="nav-section">
74
71
  <h3>Parent</h3>
75
72
 
76
-
77
73
  <p class="link">Object
78
-
79
74
  </div>
80
75
 
81
- <div id="includes-section" class="nav-section">
76
+
77
+ <div id="includes-section" class="nav-section">
82
78
  <h3>Included Modules</h3>
83
79
 
84
80
  <ul class="link-list">
85
-
86
-
87
81
  <li><span class="include">Enumerable</span>
88
-
89
-
90
82
  </ul>
91
83
  </div>
92
84
 
93
- <div id="extends-section" class="nav-section">
85
+
86
+ <div id="extends-section" class="nav-section">
94
87
  <h3>Extended With Modules</h3>
95
88
 
96
89
  <ul class="link-list">
97
-
98
-
99
90
  <li><span class="extend">Forwardable</span>
100
-
101
-
102
91
  </ul>
103
92
  </div>
104
93
 
105
- <!-- Method Quickref -->
94
+
95
+ <!-- Method Quickref -->
106
96
  <div id="method-list-section" class="nav-section">
107
97
  <h3>Methods</h3>
108
98
 
109
99
  <ul class="link-list" role="directory">
110
-
111
100
  <li ><a href="#method-c-config">::config</a>
112
-
113
101
  <li ><a href="#method-c-new">::new</a>
114
-
115
102
  <li ><a href="#method-i-3C-3C">#&lt;&lt;</a>
116
-
117
103
  <li ><a href="#method-i-40entries">#@entries</a>
118
-
119
104
  <li ><a href="#method-i-filter">#filter</a>
120
-
121
105
  <li ><a href="#method-i-filter-21">#filter!</a>
122
-
123
106
  <li ><a href="#method-i-find">#find</a>
124
-
125
107
  <li ><a href="#method-i-sort">#sort</a>
126
-
127
108
  <li ><a href="#method-i-sort-21">#sort!</a>
128
-
129
109
  <li ><a href="#method-i-sort_reverse">#sort_reverse</a>
130
-
131
110
  <li ><a href="#method-i-to_h">#to_h</a>
132
-
133
111
  <li ><a href="#method-i-to_json">#to_json</a>
134
-
135
112
  </ul>
136
113
  </div>
137
114
 
@@ -149,80 +126,54 @@
149
126
 
150
127
  </section>
151
128
 
152
-
153
129
  <section id="5Buntitled-5D" class="documentation-section">
154
-
155
130
 
156
-
157
131
 
158
-
159
132
 
160
-
161
133
 
162
-
134
+
163
135
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
164
136
  <header>
165
137
  <h3>Public Class Methods</h3>
166
138
  </header>
167
139
 
168
-
169
140
  <div id="method-c-config" class="method-detail ">
170
-
171
141
  <div class="method-heading">
172
142
  <span class="method-name">config</span><span
173
143
  class="method-args">()</span>
174
-
175
144
  <span class="method-click-advice">click to toggle source</span>
176
-
177
145
  </div>
178
-
179
146
 
180
147
  <div class="method-description">
181
-
182
148
  <p>Access to the class&#39;s configuration.</p>
183
149
 
184
150
  <p>@return [StandupMD::Config::EntryList]</p>
185
-
186
-
187
151
 
188
-
189
152
  <div class="method-source-code" id="config-source">
190
153
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 16</span>
191
154
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
192
155
  <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>
193
156
  <span class="ruby-keyword">end</span></pre>
194
157
  </div>
195
-
196
158
  </div>
197
159
 
198
-
199
160
 
200
-
201
161
  </div>
202
162
 
203
-
204
163
  <div id="method-c-new" class="method-detail ">
205
-
206
164
  <div class="method-heading">
207
165
  <span class="method-name">new</span><span
208
166
  class="method-args">(*entries)</span>
209
-
210
167
  <span class="method-click-advice">click to toggle source</span>
211
-
212
168
  </div>
213
-
214
169
 
215
170
  <div class="method-description">
216
-
217
171
  <p>Contruct a list. Can pass any amount of <code>StandupMD::Entry</code> instances.</p>
218
172
 
219
173
  <p>@param [Entry] entries</p>
220
174
 
221
175
  <p>@return [StandupMD::EntryList]</p>
222
-
223
-
224
176
 
225
-
226
177
  <div class="method-source-code" id="new-source">
227
178
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 26</span>
228
179
  <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>)
@@ -233,45 +184,32 @@
233
184
  <span class="ruby-ivar">@entries</span> = <span class="ruby-identifier">entries</span>
234
185
  <span class="ruby-keyword">end</span></pre>
235
186
  </div>
236
-
237
187
  </div>
238
188
 
239
-
240
189
 
241
-
242
190
  </div>
243
191
 
244
-
245
192
  </section>
246
-
193
+
247
194
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
248
195
  <header>
249
196
  <h3>Public Instance Methods</h3>
250
197
  </header>
251
198
 
252
-
253
199
  <div id="method-i-3C-3C" class="method-detail ">
254
-
255
200
  <div class="method-heading">
256
201
  <span class="method-name">&lt;&lt;</span><span
257
202
  class="method-args">(entry)</span>
258
-
259
203
  <span class="method-click-advice">click to toggle source</span>
260
-
261
204
  </div>
262
-
263
205
 
264
206
  <div class="method-description">
265
-
266
207
  <p>Appends entries to list.</p>
267
208
 
268
209
  <p>@param [StandupMD::Entry] entry</p>
269
210
 
270
211
  <p>@return [Array]</p>
271
-
272
-
273
212
 
274
-
275
213
  <div class="method-source-code" id="3C-3C-source">
276
214
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 40</span>
277
215
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">&lt;&lt;</span>(<span class="ruby-identifier">entry</span>)
@@ -281,28 +219,19 @@
281
219
  <span class="ruby-ivar">@entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">entry</span>
282
220
  <span class="ruby-keyword">end</span></pre>
283
221
  </div>
284
-
285
222
  </div>
286
223
 
287
-
288
224
 
289
-
290
225
  </div>
291
226
 
292
-
293
227
  <div id="method-i-filter" class="method-detail ">
294
-
295
228
  <div class="method-heading">
296
229
  <span class="method-name">filter</span><span
297
230
  class="method-args">(start_date, end_date)</span>
298
-
299
231
  <span class="method-click-advice">click to toggle source</span>
300
-
301
232
  </div>
302
-
303
233
 
304
234
  <div class="method-description">
305
-
306
235
  <p>Returns entries that are between the start and end date. This method assumes the list has already been sorted.</p>
307
236
 
308
237
  <p>@param [Date] start_date</p>
@@ -310,10 +239,7 @@
310
239
  <p>@param [Date] end_date</p>
311
240
 
312
241
  <p>@return [Array]</p>
313
-
314
-
315
242
 
316
-
317
243
  <div class="method-source-code" id="filter-source">
318
244
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 92</span>
319
245
  <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>)
@@ -322,28 +248,19 @@
322
248
  )
323
249
  <span class="ruby-keyword">end</span></pre>
324
250
  </div>
325
-
326
251
  </div>
327
252
 
328
-
329
253
 
330
-
331
254
  </div>
332
255
 
333
-
334
256
  <div id="method-i-filter-21" class="method-detail ">
335
-
336
257
  <div class="method-heading">
337
258
  <span class="method-name">filter!</span><span
338
259
  class="method-args">(start_date, end_date)</span>
339
-
340
260
  <span class="method-click-advice">click to toggle source</span>
341
-
342
261
  </div>
343
-
344
262
 
345
263
  <div class="method-description">
346
-
347
264
  <p>Replaces entries with results of filter.</p>
348
265
 
349
266
  <p>@param [Date] start_date</p>
@@ -351,10 +268,7 @@
351
268
  <p>@param [Date] end_date</p>
352
269
 
353
270
  <p>@return [Array]</p>
354
-
355
-
356
271
 
357
-
358
272
  <div class="method-source-code" id="filter-21-source">
359
273
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 106</span>
360
274
  <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>)
@@ -362,107 +276,71 @@
362
276
  <span class="ruby-keyword">self</span>
363
277
  <span class="ruby-keyword">end</span></pre>
364
278
  </div>
365
-
366
279
  </div>
367
280
 
368
-
369
281
 
370
-
371
282
  </div>
372
283
 
373
-
374
284
  <div id="method-i-find" class="method-detail ">
375
-
376
285
  <div class="method-heading">
377
286
  <span class="method-name">find</span><span
378
287
  class="method-args">(date)</span>
379
-
380
288
  <span class="method-click-advice">click to toggle source</span>
381
-
382
289
  </div>
383
-
384
290
 
385
291
  <div class="method-description">
386
-
387
292
  <p>Finds an entry based on date. This method assumes the list has already been sorted.</p>
388
293
 
389
294
  <p>@param [Date] date</p>
390
295
 
391
296
  <p>@return [StandupMD::Entry]</p>
392
-
393
-
394
297
 
395
-
396
298
  <div class="method-source-code" id="find-source">
397
299
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 54</span>
398
300
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">date</span>)
399
301
  <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> }
400
302
  <span class="ruby-keyword">end</span></pre>
401
303
  </div>
402
-
403
304
  </div>
404
305
 
405
-
406
306
 
407
-
408
307
  </div>
409
308
 
410
-
411
309
  <div id="method-i-sort" class="method-detail ">
412
-
413
310
  <div class="method-heading">
414
311
  <span class="method-name">sort</span><span
415
312
  class="method-args">()</span>
416
-
417
313
  <span class="method-click-advice">click to toggle source</span>
418
-
419
314
  </div>
420
-
421
315
 
422
316
  <div class="method-description">
423
-
424
317
  <p>Returns a copy of self sorted by date.</p>
425
318
 
426
319
  <p>@return [StandupMD::EntryList]</p>
427
-
428
-
429
320
 
430
-
431
321
  <div class="method-source-code" id="sort-source">
432
322
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 62</span>
433
323
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort</span>
434
324
  <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>)
435
325
  <span class="ruby-keyword">end</span></pre>
436
326
  </div>
437
-
438
327
  </div>
439
328
 
440
-
441
329
 
442
-
443
330
  </div>
444
331
 
445
-
446
332
  <div id="method-i-sort-21" class="method-detail ">
447
-
448
333
  <div class="method-heading">
449
334
  <span class="method-name">sort!</span><span
450
335
  class="method-args">()</span>
451
-
452
336
  <span class="method-click-advice">click to toggle source</span>
453
-
454
337
  </div>
455
-
456
338
 
457
339
  <div class="method-description">
458
-
459
340
  <p>Replace entries with sorted entries by date.</p>
460
341
 
461
342
  <p>@return [StandupMD::EntryList]</p>
462
-
463
-
464
343
 
465
-
466
344
  <div class="method-source-code" id="sort-21-source">
467
345
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 70</span>
468
346
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort!</span>
@@ -470,70 +348,46 @@
470
348
  <span class="ruby-keyword">self</span>
471
349
  <span class="ruby-keyword">end</span></pre>
472
350
  </div>
473
-
474
351
  </div>
475
352
 
476
-
477
353
 
478
-
479
354
  </div>
480
355
 
481
-
482
356
  <div id="method-i-sort_reverse" class="method-detail ">
483
-
484
357
  <div class="method-heading">
485
358
  <span class="method-name">sort_reverse</span><span
486
359
  class="method-args">()</span>
487
-
488
360
  <span class="method-click-advice">click to toggle source</span>
489
-
490
361
  </div>
491
-
492
362
 
493
363
  <div class="method-description">
494
-
495
364
  <p>Returns a copy of self sorted by date.</p>
496
365
 
497
366
  <p>@return [StandupMD::EntryList]</p>
498
-
499
-
500
367
 
501
-
502
368
  <div class="method-source-code" id="sort_reverse-source">
503
369
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 79</span>
504
370
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort_reverse</span>
505
371
  <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>)
506
372
  <span class="ruby-keyword">end</span></pre>
507
373
  </div>
508
-
509
374
  </div>
510
375
 
511
-
512
376
 
513
-
514
377
  </div>
515
378
 
516
-
517
379
  <div id="method-i-to_h" class="method-detail ">
518
-
519
380
  <div class="method-heading">
520
381
  <span class="method-name">to_h</span><span
521
382
  class="method-args">()</span>
522
-
523
383
  <span class="method-click-advice">click to toggle source</span>
524
-
525
384
  </div>
526
-
527
385
 
528
386
  <div class="method-description">
529
-
530
387
  <p>The list as a hash, with the dates as keys.</p>
531
388
 
532
389
  <p>@return [Hash]</p>
533
-
534
-
535
390
 
536
-
537
391
  <div class="method-source-code" id="to_h-source">
538
392
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 115</span>
539
393
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
@@ -545,56 +399,38 @@
545
399
  }]}]
546
400
  <span class="ruby-keyword">end</span></pre>
547
401
  </div>
548
-
549
402
  </div>
550
403
 
551
-
552
404
 
553
-
554
405
  </div>
555
406
 
556
-
557
407
  <div id="method-i-to_json" class="method-detail ">
558
-
559
408
  <div class="method-heading">
560
409
  <span class="method-name">to_json</span><span
561
410
  class="method-args">()</span>
562
-
563
411
  <span class="method-click-advice">click to toggle source</span>
564
-
565
412
  </div>
566
-
567
413
 
568
414
  <div class="method-description">
569
-
570
415
  <p>The entry list as a json object.</p>
571
416
 
572
417
  <p>@return [String]</p>
573
-
574
-
575
418
 
576
-
577
419
  <div class="method-source-code" id="to_json-source">
578
420
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 128</span>
579
421
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
580
422
  <span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
581
423
  <span class="ruby-keyword">end</span></pre>
582
424
  </div>
583
-
584
425
  </div>
585
426
 
586
-
587
427
 
588
-
589
428
  </div>
590
429
 
591
-
592
430
  </section>
593
-
594
- </section>
595
431
 
432
+ </section>
596
433
  <section id="Delegators" class="documentation-section">
597
-
598
434
  <header class="documentation-section-title">
599
435
  <h2>
600
436
  Delegators
@@ -603,34 +439,24 @@
603
439
  <a href="#top">&uarr; top</a>
604
440
  </span>
605
441
  </header>
606
-
607
442
 
608
-
609
443
 
610
-
611
444
 
612
-
613
445
 
614
-
446
+
615
447
  <section id="public-instance-Delegators-method-details" class="method-section">
616
448
  <header>
617
449
  <h3>Public Instance Methods</h3>
618
450
  </header>
619
451
 
620
-
621
452
  <div id="method-i-40entries" class="method-detail ">
622
-
623
453
  <div class="method-heading">
624
454
  <span class="method-name">@entries</span><span
625
455
  class="method-args">()</span>
626
-
627
456
  <span class="method-click-advice">click to toggle source</span>
628
-
629
457
  </div>
630
-
631
458
 
632
459
  <div class="method-description">
633
-
634
460
  <p>The following are forwarded to @entries, which is the underly array of entries.</p>
635
461
  <dl class="rdoc-list note-list"><dt><code>each</code>
636
462
  <dd>
@@ -648,34 +474,26 @@
648
474
  <dd>
649
475
  <p>The last record in the list.</p>
650
476
  </dd></dl>
651
-
652
-
653
477
 
654
-
655
478
  <div class="method-source-code" id="40entries-source">
656
479
  <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 147</span>
657
480
  <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
481
  </pre>
659
482
  </div>
660
-
661
483
  </div>
662
484
 
663
-
664
485
 
665
-
666
486
  </div>
667
487
 
668
-
669
488
  </section>
670
-
671
- </section>
672
489
 
490
+ </section>
673
491
  </main>
674
492
 
675
493
 
676
494
  <footer id="validator-badges" role="contentinfo">
677
495
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
678
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
496
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
679
497
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
680
498
  </footer>
681
499