standup_md 0.3.3 → 0.3.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +11 -9
- data/README.md +66 -33
- data/Rakefile +3 -1
- data/doc/README_md.html +53 -53
- data/doc/StandupMD.html +7 -96
- data/doc/StandupMD/Cli.html +21 -163
- data/doc/StandupMD/Cli/Helpers.html +13 -34
- data/doc/StandupMD/Config.html +7 -44
- data/doc/StandupMD/Config/Cli.html +10 -78
- data/doc/StandupMD/Config/Entry.html +10 -66
- data/doc/StandupMD/Config/EntryList.html +7 -48
- data/doc/StandupMD/Config/File.html +14 -146
- data/doc/StandupMD/Entry.html +11 -120
- data/doc/StandupMD/EntryList.html +94 -354
- data/doc/StandupMD/File.html +51 -182
- data/doc/StandupMD/Version.html +143 -0
- data/doc/created.rid +15 -15
- data/doc/css/rdoc.css +1 -1
- data/doc/index.html +51 -66
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search_index.js +1 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +46 -105
- data/lib/standup_md.rb +2 -1
- data/lib/standup_md/cli.rb +2 -3
- data/lib/standup_md/cli/helpers.rb +66 -34
- data/lib/standup_md/config.rb +0 -2
- data/lib/standup_md/config/cli.rb +2 -4
- data/lib/standup_md/config/entry.rb +2 -4
- data/lib/standup_md/entry.rb +3 -6
- data/lib/standup_md/entry_list.rb +20 -37
- data/lib/standup_md/file.rb +32 -15
- data/lib/standup_md/file/helpers.rb +13 -15
- data/lib/standup_md/version.rb +22 -4
- data/standup_md.gemspec +12 -16
- metadata +7 -6
data/doc/StandupMD/Entry.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,45 +57,35 @@
|
|
59
57
|
|
60
58
|
<div id="class-metadata">
|
61
59
|
|
62
|
-
|
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
|
+
|
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
|
-
|
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">#<=></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
|
-
<p>Iimpediments for this entry.</p>
|
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,79 +169,54 @@
|
|
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'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
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
211
|
class="method-args">() { |config| ... }</span>
|
260
|
-
|
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
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>
|
@@ -286,28 +231,19 @@
|
|
286
231
|
<span class="ruby-identifier">entry</span>
|
287
232
|
<span class="ruby-keyword">end</span></pre>
|
288
233
|
</div>
|
289
|
-
|
290
234
|
</div>
|
291
235
|
|
292
|
-
|
293
236
|
|
294
|
-
|
295
237
|
</div>
|
296
238
|
|
297
|
-
|
298
239
|
<div id="method-c-new" class="method-detail ">
|
299
|
-
|
300
240
|
<div class="method-heading">
|
301
241
|
<span class="method-name">new</span><span
|
302
242
|
class="method-args">(date, current, previous, impediments, notes = [])</span>
|
303
|
-
|
304
243
|
<span class="method-click-advice">click to toggle source</span>
|
305
|
-
|
306
244
|
</div>
|
307
|
-
|
308
245
|
|
309
246
|
<div class="method-description">
|
310
|
-
|
311
247
|
<p>Constructs instance of <code>StandupMD::Entry</code>.</p>
|
312
248
|
|
313
249
|
<p>@param [Date] date</p>
|
@@ -319,10 +255,7 @@
|
|
319
255
|
<p>@param [Array] impediments</p>
|
320
256
|
|
321
257
|
<p>@param [Array] notes</p>
|
322
|
-
|
323
|
-
|
324
258
|
|
325
|
-
|
326
259
|
<div class="method-source-code" id="new-source">
|
327
260
|
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 81</span>
|
328
261
|
<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> = [])
|
@@ -336,76 +269,51 @@
|
|
336
269
|
<span class="ruby-ivar">@notes</span> = <span class="ruby-identifier">notes</span>
|
337
270
|
<span class="ruby-keyword">end</span></pre>
|
338
271
|
</div>
|
339
|
-
|
340
272
|
</div>
|
341
273
|
|
342
|
-
|
343
274
|
|
344
|
-
|
345
275
|
</div>
|
346
276
|
|
347
|
-
|
348
277
|
</section>
|
349
|
-
|
278
|
+
|
350
279
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
351
280
|
<header>
|
352
281
|
<h3>Public Instance Methods</h3>
|
353
282
|
</header>
|
354
283
|
|
355
|
-
|
356
284
|
<div id="method-i-3C-3D-3E" class="method-detail ">
|
357
|
-
|
358
285
|
<div class="method-heading">
|
359
286
|
<span class="method-name"><=></span><span
|
360
287
|
class="method-args">(other)</span>
|
361
|
-
|
362
288
|
<span class="method-click-advice">click to toggle source</span>
|
363
|
-
|
364
289
|
</div>
|
365
|
-
|
366
290
|
|
367
291
|
<div class="method-description">
|
368
|
-
|
369
292
|
<p>Sorting method for Comparable. Entries are compared by date.</p>
|
370
|
-
|
371
|
-
|
372
293
|
|
373
|
-
|
374
294
|
<div class="method-source-code" id="3C-3D-3E-source">
|
375
295
|
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 94</span>
|
376
296
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span>(<span class="ruby-identifier">other</span>)
|
377
297
|
<span class="ruby-identifier">date</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">date</span>
|
378
298
|
<span class="ruby-keyword">end</span></pre>
|
379
299
|
</div>
|
380
|
-
|
381
300
|
</div>
|
382
301
|
|
383
|
-
|
384
302
|
|
385
|
-
|
386
303
|
</div>
|
387
304
|
|
388
|
-
|
389
305
|
<div id="method-i-to_h" class="method-detail ">
|
390
|
-
|
391
306
|
<div class="method-heading">
|
392
307
|
<span class="method-name">to_h</span><span
|
393
308
|
class="method-args">()</span>
|
394
|
-
|
395
309
|
<span class="method-click-advice">click to toggle source</span>
|
396
|
-
|
397
310
|
</div>
|
398
|
-
|
399
311
|
|
400
312
|
<div class="method-description">
|
401
|
-
|
402
313
|
<p><a href="Entry.html"><code>Entry</code></a> as a hash .</p>
|
403
314
|
|
404
315
|
<p>@return [Hash]</p>
|
405
|
-
|
406
|
-
|
407
316
|
|
408
|
-
|
409
317
|
<div class="method-source-code" id="to_h-source">
|
410
318
|
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 102</span>
|
411
319
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
|
@@ -419,60 +327,43 @@
|
|
419
327
|
}
|
420
328
|
<span class="ruby-keyword">end</span></pre>
|
421
329
|
</div>
|
422
|
-
|
423
330
|
</div>
|
424
331
|
|
425
|
-
|
426
332
|
|
427
|
-
|
428
333
|
</div>
|
429
334
|
|
430
|
-
|
431
335
|
<div id="method-i-to_json" class="method-detail ">
|
432
|
-
|
433
336
|
<div class="method-heading">
|
434
337
|
<span class="method-name">to_json</span><span
|
435
338
|
class="method-args">()</span>
|
436
|
-
|
437
339
|
<span class="method-click-advice">click to toggle source</span>
|
438
|
-
|
439
340
|
</div>
|
440
|
-
|
441
341
|
|
442
342
|
<div class="method-description">
|
443
|
-
|
444
343
|
<p><a href="Entry.html"><code>Entry</code></a> as a json object.</p>
|
445
344
|
|
446
345
|
<p>@return [String]</p>
|
447
|
-
|
448
|
-
|
449
346
|
|
450
|
-
|
451
347
|
<div class="method-source-code" id="to_json-source">
|
452
348
|
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 117</span>
|
453
349
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
|
454
350
|
<span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
|
455
351
|
<span class="ruby-keyword">end</span></pre>
|
456
352
|
</div>
|
457
|
-
|
458
353
|
</div>
|
459
354
|
|
460
|
-
|
461
355
|
|
462
|
-
|
463
356
|
</div>
|
464
357
|
|
465
|
-
|
466
358
|
</section>
|
467
|
-
|
468
|
-
</section>
|
469
359
|
|
360
|
+
</section>
|
470
361
|
</main>
|
471
362
|
|
472
363
|
|
473
364
|
<footer id="validator-badges" role="contentinfo">
|
474
365
|
<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.
|
366
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
476
367
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
477
368
|
</footer>
|
478
369
|
|
@@ -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,65 +57,58 @@
|
|
59
57
|
|
60
58
|
<div id="class-metadata">
|
61
59
|
|
62
|
-
|
60
|
+
<div id="sections-section" class="nav-section">
|
61
|
+
<h3>Sections</h3>
|
62
|
+
|
63
|
+
<ul class="link-list" role="directory">
|
64
|
+
<li><a href="#5Buntitled-5D"></a></li>
|
65
|
+
<li><a href="#Delegators">Delegators</a></li>
|
66
|
+
</ul>
|
67
|
+
</div>
|
68
|
+
|
69
|
+
|
70
|
+
<div id="parent-class-section" class="nav-section">
|
63
71
|
<h3>Parent</h3>
|
64
72
|
|
65
|
-
|
66
73
|
<p class="link">Object
|
67
|
-
|
68
74
|
</div>
|
69
75
|
|
70
|
-
|
76
|
+
|
77
|
+
<div id="includes-section" class="nav-section">
|
71
78
|
<h3>Included Modules</h3>
|
72
79
|
|
73
80
|
<ul class="link-list">
|
74
|
-
|
75
|
-
|
76
81
|
<li><span class="include">Enumerable</span>
|
77
|
-
|
78
|
-
|
79
82
|
</ul>
|
80
83
|
</div>
|
81
84
|
|
82
85
|
|
83
|
-
|
86
|
+
<div id="extends-section" class="nav-section">
|
87
|
+
<h3>Extended With Modules</h3>
|
88
|
+
|
89
|
+
<ul class="link-list">
|
90
|
+
<li><span class="extend">Forwardable</span>
|
91
|
+
</ul>
|
92
|
+
</div>
|
93
|
+
|
94
|
+
|
95
|
+
<!-- Method Quickref -->
|
84
96
|
<div id="method-list-section" class="nav-section">
|
85
97
|
<h3>Methods</h3>
|
86
98
|
|
87
99
|
<ul class="link-list" role="directory">
|
88
|
-
|
89
100
|
<li ><a href="#method-c-config">::config</a>
|
90
|
-
|
91
101
|
<li ><a href="#method-c-new">::new</a>
|
92
|
-
|
93
102
|
<li ><a href="#method-i-3C-3C">#<<</a>
|
94
|
-
|
95
|
-
<li ><a href="#method-i-each">#each</a>
|
96
|
-
|
97
|
-
<li ><a href="#method-i-empty-3F">#empty?</a>
|
98
|
-
|
103
|
+
<li ><a href="#method-i-40entries">#@entries</a>
|
99
104
|
<li ><a href="#method-i-filter">#filter</a>
|
100
|
-
|
101
105
|
<li ><a href="#method-i-filter-21">#filter!</a>
|
102
|
-
|
103
106
|
<li ><a href="#method-i-find">#find</a>
|
104
|
-
|
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
107
|
<li ><a href="#method-i-sort">#sort</a>
|
112
|
-
|
113
108
|
<li ><a href="#method-i-sort-21">#sort!</a>
|
114
|
-
|
115
109
|
<li ><a href="#method-i-sort_reverse">#sort_reverse</a>
|
116
|
-
|
117
110
|
<li ><a href="#method-i-to_h">#to_h</a>
|
118
|
-
|
119
111
|
<li ><a href="#method-i-to_json">#to_json</a>
|
120
|
-
|
121
112
|
</ul>
|
122
113
|
</div>
|
123
114
|
|
@@ -135,82 +126,56 @@
|
|
135
126
|
|
136
127
|
</section>
|
137
128
|
|
138
|
-
|
139
129
|
<section id="5Buntitled-5D" class="documentation-section">
|
140
|
-
|
141
130
|
|
142
|
-
|
143
131
|
|
144
|
-
|
145
132
|
|
146
|
-
|
147
133
|
|
148
|
-
|
134
|
+
|
149
135
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
150
136
|
<header>
|
151
137
|
<h3>Public Class Methods</h3>
|
152
138
|
</header>
|
153
139
|
|
154
|
-
|
155
140
|
<div id="method-c-config" class="method-detail ">
|
156
|
-
|
157
141
|
<div class="method-heading">
|
158
142
|
<span class="method-name">config</span><span
|
159
143
|
class="method-args">()</span>
|
160
|
-
|
161
144
|
<span class="method-click-advice">click to toggle source</span>
|
162
|
-
|
163
145
|
</div>
|
164
|
-
|
165
146
|
|
166
147
|
<div class="method-description">
|
167
|
-
|
168
148
|
<p>Access to the class's configuration.</p>
|
169
149
|
|
170
150
|
<p>@return [StandupMD::Config::EntryList]</p>
|
171
|
-
|
172
|
-
|
173
151
|
|
174
|
-
|
175
152
|
<div class="method-source-code" id="config-source">
|
176
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
153
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 16</span>
|
177
154
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
|
178
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>
|
179
156
|
<span class="ruby-keyword">end</span></pre>
|
180
157
|
</div>
|
181
|
-
|
182
158
|
</div>
|
183
159
|
|
184
|
-
|
185
160
|
|
186
|
-
|
187
161
|
</div>
|
188
162
|
|
189
|
-
|
190
163
|
<div id="method-c-new" class="method-detail ">
|
191
|
-
|
192
164
|
<div class="method-heading">
|
193
165
|
<span class="method-name">new</span><span
|
194
166
|
class="method-args">(*entries)</span>
|
195
|
-
|
196
167
|
<span class="method-click-advice">click to toggle source</span>
|
197
|
-
|
198
168
|
</div>
|
199
|
-
|
200
169
|
|
201
170
|
<div class="method-description">
|
202
|
-
|
203
171
|
<p>Contruct a list. Can pass any amount of <code>StandupMD::Entry</code> instances.</p>
|
204
172
|
|
205
173
|
<p>@param [Entry] entries</p>
|
206
174
|
|
207
175
|
<p>@return [StandupMD::EntryList]</p>
|
208
|
-
|
209
|
-
|
210
176
|
|
211
|
-
|
212
177
|
<div class="method-source-code" id="new-source">
|
213
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
178
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 26</span>
|
214
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>)
|
215
180
|
<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
181
|
<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>) }
|
@@ -219,47 +184,34 @@
|
|
219
184
|
<span class="ruby-ivar">@entries</span> = <span class="ruby-identifier">entries</span>
|
220
185
|
<span class="ruby-keyword">end</span></pre>
|
221
186
|
</div>
|
222
|
-
|
223
187
|
</div>
|
224
188
|
|
225
|
-
|
226
189
|
|
227
|
-
|
228
190
|
</div>
|
229
191
|
|
230
|
-
|
231
192
|
</section>
|
232
|
-
|
193
|
+
|
233
194
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
234
195
|
<header>
|
235
196
|
<h3>Public Instance Methods</h3>
|
236
197
|
</header>
|
237
198
|
|
238
|
-
|
239
199
|
<div id="method-i-3C-3C" class="method-detail ">
|
240
|
-
|
241
200
|
<div class="method-heading">
|
242
201
|
<span class="method-name"><<</span><span
|
243
202
|
class="method-args">(entry)</span>
|
244
|
-
|
245
203
|
<span class="method-click-advice">click to toggle source</span>
|
246
|
-
|
247
204
|
</div>
|
248
|
-
|
249
205
|
|
250
206
|
<div class="method-description">
|
251
|
-
|
252
207
|
<p>Appends entries to list.</p>
|
253
208
|
|
254
209
|
<p>@param [StandupMD::Entry] entry</p>
|
255
210
|
|
256
211
|
<p>@return [Array]</p>
|
257
|
-
|
258
|
-
|
259
212
|
|
260
|
-
|
261
213
|
<div class="method-source-code" id="3C-3C-source">
|
262
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
214
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 40</span>
|
263
215
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">entry</span>)
|
264
216
|
<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
217
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Entry must instance of StandupMD::Entry'</span>
|
@@ -267,96 +219,19 @@
|
|
267
219
|
<span class="ruby-ivar">@entries</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">entry</span>
|
268
220
|
<span class="ruby-keyword">end</span></pre>
|
269
221
|
</div>
|
270
|
-
|
271
|
-
</div>
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
</div>
|
277
|
-
|
278
|
-
|
279
|
-
<div id="method-i-each" class="method-detail ">
|
280
|
-
|
281
|
-
<div class="method-heading">
|
282
|
-
<span class="method-name">each</span><span
|
283
|
-
class="method-args">(&block)</span>
|
284
|
-
|
285
|
-
<span class="method-click-advice">click to toggle source</span>
|
286
|
-
|
287
|
-
</div>
|
288
|
-
|
289
|
-
|
290
|
-
<div class="method-description">
|
291
|
-
|
292
|
-
<p>Iterate over the list and yield each entry.</p>
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
<div class="method-source-code" id="each-source">
|
298
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 34</span>
|
299
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
300
|
-
<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
301
|
-
<span class="ruby-keyword">end</span></pre>
|
302
|
-
</div>
|
303
|
-
|
304
|
-
</div>
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
</div>
|
310
|
-
|
311
|
-
|
312
|
-
<div id="method-i-empty-3F" class="method-detail ">
|
313
|
-
|
314
|
-
<div class="method-heading">
|
315
|
-
<span class="method-name">empty?</span><span
|
316
|
-
class="method-args">()</span>
|
317
|
-
|
318
|
-
<span class="method-click-advice">click to toggle source</span>
|
319
|
-
|
320
|
-
</div>
|
321
|
-
|
322
|
-
|
323
|
-
<div class="method-description">
|
324
|
-
|
325
|
-
<p>Is the list empty?</p>
|
326
|
-
|
327
|
-
<p>@return [Boolean] true if empty</p>
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
<div class="method-source-code" id="empty-3F-source">
|
333
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 162</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
222
|
</div>
|
340
223
|
|
341
|
-
|
342
224
|
|
343
|
-
|
344
225
|
</div>
|
345
226
|
|
346
|
-
|
347
227
|
<div id="method-i-filter" class="method-detail ">
|
348
|
-
|
349
228
|
<div class="method-heading">
|
350
229
|
<span class="method-name">filter</span><span
|
351
230
|
class="method-args">(start_date, end_date)</span>
|
352
|
-
|
353
231
|
<span class="method-click-advice">click to toggle source</span>
|
354
|
-
|
355
232
|
</div>
|
356
|
-
|
357
233
|
|
358
234
|
<div class="method-description">
|
359
|
-
|
360
235
|
<p>Returns entries that are between the start and end date. This method assumes the list has already been sorted.</p>
|
361
236
|
|
362
237
|
<p>@param [Date] start_date</p>
|
@@ -364,10 +239,7 @@
|
|
364
239
|
<p>@param [Date] end_date</p>
|
365
240
|
|
366
241
|
<p>@return [Array]</p>
|
367
|
-
|
368
|
-
|
369
242
|
|
370
|
-
|
371
243
|
<div class="method-source-code" id="filter-source">
|
372
244
|
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 92</span>
|
373
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>)
|
@@ -376,28 +248,19 @@
|
|
376
248
|
)
|
377
249
|
<span class="ruby-keyword">end</span></pre>
|
378
250
|
</div>
|
379
|
-
|
380
251
|
</div>
|
381
252
|
|
382
|
-
|
383
253
|
|
384
|
-
|
385
254
|
</div>
|
386
255
|
|
387
|
-
|
388
256
|
<div id="method-i-filter-21" class="method-detail ">
|
389
|
-
|
390
257
|
<div class="method-heading">
|
391
258
|
<span class="method-name">filter!</span><span
|
392
259
|
class="method-args">(start_date, end_date)</span>
|
393
|
-
|
394
260
|
<span class="method-click-advice">click to toggle source</span>
|
395
|
-
|
396
261
|
</div>
|
397
|
-
|
398
262
|
|
399
263
|
<div class="method-description">
|
400
|
-
|
401
264
|
<p>Replaces entries with results of filter.</p>
|
402
265
|
|
403
266
|
<p>@param [Date] start_date</p>
|
@@ -405,10 +268,7 @@
|
|
405
268
|
<p>@param [Date] end_date</p>
|
406
269
|
|
407
270
|
<p>@return [Array]</p>
|
408
|
-
|
409
|
-
|
410
271
|
|
411
|
-
|
412
272
|
<div class="method-source-code" id="filter-21-source">
|
413
273
|
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 106</span>
|
414
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>)
|
@@ -416,208 +276,71 @@
|
|
416
276
|
<span class="ruby-keyword">self</span>
|
417
277
|
<span class="ruby-keyword">end</span></pre>
|
418
278
|
</div>
|
419
|
-
|
420
279
|
</div>
|
421
280
|
|
422
|
-
|
423
281
|
|
424
|
-
|
425
282
|
</div>
|
426
283
|
|
427
|
-
|
428
284
|
<div id="method-i-find" class="method-detail ">
|
429
|
-
|
430
285
|
<div class="method-heading">
|
431
286
|
<span class="method-name">find</span><span
|
432
|
-
class="method-args">(
|
433
|
-
|
287
|
+
class="method-args">(date)</span>
|
434
288
|
<span class="method-click-advice">click to toggle source</span>
|
435
|
-
|
436
289
|
</div>
|
437
|
-
|
438
290
|
|
439
291
|
<div class="method-description">
|
440
|
-
|
441
292
|
<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
|
-
|
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>
|
475
|
-
|
476
|
-
<p>@return [StandupMD::Entry]</p>
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
<div class="method-source-code" id="first-source">
|
482
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 137</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
293
|
|
507
|
-
|
508
|
-
|
509
|
-
<p>The last entry in the list. This method assumes the list has already been sorted.</p>
|
294
|
+
<p>@param [Date] date</p>
|
510
295
|
|
511
296
|
<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 146</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
297
|
|
527
|
-
|
528
|
-
|
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 154</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>
|
298
|
+
<div class="method-source-code" id="find-source">
|
299
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 54</span>
|
300
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">date</span>)
|
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> }
|
555
302
|
<span class="ruby-keyword">end</span></pre>
|
556
303
|
</div>
|
557
|
-
|
558
304
|
</div>
|
559
305
|
|
560
|
-
|
561
306
|
|
562
|
-
|
563
307
|
</div>
|
564
308
|
|
565
|
-
|
566
309
|
<div id="method-i-sort" class="method-detail ">
|
567
|
-
|
568
310
|
<div class="method-heading">
|
569
311
|
<span class="method-name">sort</span><span
|
570
312
|
class="method-args">()</span>
|
571
|
-
|
572
313
|
<span class="method-click-advice">click to toggle source</span>
|
573
|
-
|
574
314
|
</div>
|
575
|
-
|
576
315
|
|
577
316
|
<div class="method-description">
|
578
|
-
|
579
317
|
<p>Returns a copy of self sorted by date.</p>
|
580
318
|
|
581
319
|
<p>@return [StandupMD::EntryList]</p>
|
582
|
-
|
583
|
-
|
584
320
|
|
585
|
-
|
586
321
|
<div class="method-source-code" id="sort-source">
|
587
322
|
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 62</span>
|
588
323
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort</span>
|
589
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>)
|
590
325
|
<span class="ruby-keyword">end</span></pre>
|
591
326
|
</div>
|
592
|
-
|
593
327
|
</div>
|
594
328
|
|
595
|
-
|
596
329
|
|
597
|
-
|
598
330
|
</div>
|
599
331
|
|
600
|
-
|
601
332
|
<div id="method-i-sort-21" class="method-detail ">
|
602
|
-
|
603
333
|
<div class="method-heading">
|
604
334
|
<span class="method-name">sort!</span><span
|
605
335
|
class="method-args">()</span>
|
606
|
-
|
607
336
|
<span class="method-click-advice">click to toggle source</span>
|
608
|
-
|
609
337
|
</div>
|
610
|
-
|
611
338
|
|
612
339
|
<div class="method-description">
|
613
|
-
|
614
340
|
<p>Replace entries with sorted entries by date.</p>
|
615
341
|
|
616
342
|
<p>@return [StandupMD::EntryList]</p>
|
617
|
-
|
618
|
-
|
619
343
|
|
620
|
-
|
621
344
|
<div class="method-source-code" id="sort-21-source">
|
622
345
|
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 70</span>
|
623
346
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort!</span>
|
@@ -625,70 +348,46 @@
|
|
625
348
|
<span class="ruby-keyword">self</span>
|
626
349
|
<span class="ruby-keyword">end</span></pre>
|
627
350
|
</div>
|
628
|
-
|
629
351
|
</div>
|
630
352
|
|
631
|
-
|
632
353
|
|
633
|
-
|
634
354
|
</div>
|
635
355
|
|
636
|
-
|
637
356
|
<div id="method-i-sort_reverse" class="method-detail ">
|
638
|
-
|
639
357
|
<div class="method-heading">
|
640
358
|
<span class="method-name">sort_reverse</span><span
|
641
359
|
class="method-args">()</span>
|
642
|
-
|
643
360
|
<span class="method-click-advice">click to toggle source</span>
|
644
|
-
|
645
361
|
</div>
|
646
|
-
|
647
362
|
|
648
363
|
<div class="method-description">
|
649
|
-
|
650
364
|
<p>Returns a copy of self sorted by date.</p>
|
651
365
|
|
652
366
|
<p>@return [StandupMD::EntryList]</p>
|
653
|
-
|
654
|
-
|
655
367
|
|
656
|
-
|
657
368
|
<div class="method-source-code" id="sort_reverse-source">
|
658
369
|
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 79</span>
|
659
370
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort_reverse</span>
|
660
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>)
|
661
372
|
<span class="ruby-keyword">end</span></pre>
|
662
373
|
</div>
|
663
|
-
|
664
374
|
</div>
|
665
375
|
|
666
|
-
|
667
376
|
|
668
|
-
|
669
377
|
</div>
|
670
378
|
|
671
|
-
|
672
379
|
<div id="method-i-to_h" class="method-detail ">
|
673
|
-
|
674
380
|
<div class="method-heading">
|
675
381
|
<span class="method-name">to_h</span><span
|
676
382
|
class="method-args">()</span>
|
677
|
-
|
678
383
|
<span class="method-click-advice">click to toggle source</span>
|
679
|
-
|
680
384
|
</div>
|
681
|
-
|
682
385
|
|
683
386
|
<div class="method-description">
|
684
|
-
|
685
387
|
<p>The list as a hash, with the dates as keys.</p>
|
686
388
|
|
687
389
|
<p>@return [Hash]</p>
|
688
|
-
|
689
|
-
|
690
390
|
|
691
|
-
|
692
391
|
<div class="method-source-code" id="to_h-source">
|
693
392
|
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 115</span>
|
694
393
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
|
@@ -700,60 +399,101 @@
|
|
700
399
|
}]}]
|
701
400
|
<span class="ruby-keyword">end</span></pre>
|
702
401
|
</div>
|
703
|
-
|
704
402
|
</div>
|
705
403
|
|
706
|
-
|
707
404
|
|
708
|
-
|
709
405
|
</div>
|
710
406
|
|
711
|
-
|
712
407
|
<div id="method-i-to_json" class="method-detail ">
|
713
|
-
|
714
408
|
<div class="method-heading">
|
715
409
|
<span class="method-name">to_json</span><span
|
716
410
|
class="method-args">()</span>
|
717
|
-
|
718
411
|
<span class="method-click-advice">click to toggle source</span>
|
719
|
-
|
720
412
|
</div>
|
721
|
-
|
722
413
|
|
723
414
|
<div class="method-description">
|
724
|
-
|
725
415
|
<p>The entry list as a json object.</p>
|
726
416
|
|
727
417
|
<p>@return [String]</p>
|
728
|
-
|
729
|
-
|
730
418
|
|
731
|
-
|
732
419
|
<div class="method-source-code" id="to_json-source">
|
733
420
|
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 128</span>
|
734
421
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
|
735
422
|
<span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
|
736
423
|
<span class="ruby-keyword">end</span></pre>
|
737
424
|
</div>
|
738
|
-
|
739
425
|
</div>
|
740
426
|
|
741
|
-
|
742
427
|
|
743
|
-
|
744
428
|
</div>
|
745
429
|
|
746
|
-
|
747
430
|
</section>
|
748
|
-
|
431
|
+
|
749
432
|
</section>
|
433
|
+
<section id="Delegators" class="documentation-section">
|
434
|
+
<header class="documentation-section-title">
|
435
|
+
<h2>
|
436
|
+
Delegators
|
437
|
+
</h2>
|
438
|
+
<span class="section-click-top">
|
439
|
+
<a href="#top">↑ top</a>
|
440
|
+
</span>
|
441
|
+
</header>
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
|
750
446
|
|
447
|
+
<section id="public-instance-Delegators-method-details" class="method-section">
|
448
|
+
<header>
|
449
|
+
<h3>Public Instance Methods</h3>
|
450
|
+
</header>
|
451
|
+
|
452
|
+
<div id="method-i-40entries" class="method-detail ">
|
453
|
+
<div class="method-heading">
|
454
|
+
<span class="method-name">@entries</span><span
|
455
|
+
class="method-args">()</span>
|
456
|
+
<span class="method-click-advice">click to toggle source</span>
|
457
|
+
</div>
|
458
|
+
|
459
|
+
<div class="method-description">
|
460
|
+
<p>The following are forwarded to @entries, which is the underly array of entries.</p>
|
461
|
+
<dl class="rdoc-list note-list"><dt><code>each</code>
|
462
|
+
<dd>
|
463
|
+
<p>Iterate over each entry.</p>
|
464
|
+
</dd><dt><code>empty?</code>
|
465
|
+
<dd>
|
466
|
+
<p>Is the list empty?</p>
|
467
|
+
</dd><dt><code>size</code>
|
468
|
+
<dd>
|
469
|
+
<p>How many items are in the list?</p>
|
470
|
+
</dd><dt><code>first</code>
|
471
|
+
<dd>
|
472
|
+
<p>The first record in the list.</p>
|
473
|
+
</dd><dt><code>last</code>
|
474
|
+
<dd>
|
475
|
+
<p>The last record in the list.</p>
|
476
|
+
</dd></dl>
|
477
|
+
|
478
|
+
<div class="method-source-code" id="40entries-source">
|
479
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 147</span>
|
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>
|
481
|
+
</pre>
|
482
|
+
</div>
|
483
|
+
</div>
|
484
|
+
|
485
|
+
|
486
|
+
</div>
|
487
|
+
|
488
|
+
</section>
|
489
|
+
|
490
|
+
</section>
|
751
491
|
</main>
|
752
492
|
|
753
493
|
|
754
494
|
<footer id="validator-badges" role="contentinfo">
|
755
495
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
756
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.
|
496
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
757
497
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
758
498
|
</footer>
|
759
499
|
|