standup_md 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/Gemfile.lock +7 -1
- data/README.md +142 -116
- data/bin/standup +1 -1
- data/doc/README_md.html +143 -96
- data/doc/StandupMD.html +96 -1322
- data/doc/StandupMD/Cli.html +124 -479
- data/doc/StandupMD/Cli/Helpers.html +167 -0
- data/doc/StandupMD/Config.html +230 -0
- data/doc/StandupMD/Config/Cli.html +355 -0
- data/doc/StandupMD/Config/Entry.html +284 -0
- data/doc/StandupMD/Config/EntryList.html +197 -0
- data/doc/StandupMD/Config/File.html +609 -0
- data/doc/StandupMD/Entry.html +478 -0
- data/doc/StandupMD/EntryList.html +759 -0
- data/doc/StandupMD/File.html +574 -0
- data/doc/created.rid +15 -5
- data/doc/index.html +153 -94
- data/doc/js/search_index.js +1 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/table_of_contents.html +221 -72
- data/lib/standup_md.rb +27 -544
- data/lib/standup_md/cli.rb +63 -246
- data/lib/standup_md/cli/helpers.rb +165 -0
- data/lib/standup_md/config.rb +45 -0
- data/lib/standup_md/config/cli.rb +106 -0
- data/lib/standup_md/config/entry.rb +61 -0
- data/lib/standup_md/config/entry_list.rb +26 -0
- data/lib/standup_md/config/file.rb +199 -0
- data/lib/standup_md/entry.rb +121 -0
- data/lib/standup_md/entry_list.rb +166 -0
- data/lib/standup_md/file.rb +172 -0
- data/lib/standup_md/file/helpers.rb +62 -0
- data/lib/standup_md/version.rb +5 -3
- data/standup_md.gemspec +1 -0
- metadata +35 -2
|
@@ -0,0 +1,759 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class StandupMD::EntryList - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
<body id="top" role="document" class="class">
|
|
27
|
+
<nav role="navigation">
|
|
28
|
+
<div id="project-navigation">
|
|
29
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
30
|
+
<h2>
|
|
31
|
+
<a href="../index.html" rel="home">Home</a>
|
|
32
|
+
</h2>
|
|
33
|
+
|
|
34
|
+
<div id="table-of-contents-navigation">
|
|
35
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
36
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
37
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
42
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
43
|
+
<div id="search-field-wrapper">
|
|
44
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
45
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
46
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
47
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<ul id="search-results" aria-label="Search Results"
|
|
51
|
+
aria-busy="false" aria-expanded="false"
|
|
52
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
53
|
+
</form>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<div id="class-metadata">
|
|
61
|
+
|
|
62
|
+
<div id="parent-class-section" class="nav-section">
|
|
63
|
+
<h3>Parent</h3>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<p class="link">Object
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
|
|
70
|
+
<div id="includes-section" class="nav-section">
|
|
71
|
+
<h3>Included Modules</h3>
|
|
72
|
+
|
|
73
|
+
<ul class="link-list">
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<li><span class="include">Enumerable</span>
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
</div>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
<!-- Method Quickref -->
|
|
84
|
+
<div id="method-list-section" class="nav-section">
|
|
85
|
+
<h3>Methods</h3>
|
|
86
|
+
|
|
87
|
+
<ul class="link-list" role="directory">
|
|
88
|
+
|
|
89
|
+
<li ><a href="#method-c-config">::config</a>
|
|
90
|
+
|
|
91
|
+
<li ><a href="#method-c-new">::new</a>
|
|
92
|
+
|
|
93
|
+
<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
|
+
|
|
99
|
+
<li ><a href="#method-i-filter">#filter</a>
|
|
100
|
+
|
|
101
|
+
<li ><a href="#method-i-filter-21">#filter!</a>
|
|
102
|
+
|
|
103
|
+
<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
|
+
<li ><a href="#method-i-sort">#sort</a>
|
|
112
|
+
|
|
113
|
+
<li ><a href="#method-i-sort-21">#sort!</a>
|
|
114
|
+
|
|
115
|
+
<li ><a href="#method-i-sort_reverse">#sort_reverse</a>
|
|
116
|
+
|
|
117
|
+
<li ><a href="#method-i-to_h">#to_h</a>
|
|
118
|
+
|
|
119
|
+
<li ><a href="#method-i-to_json">#to_json</a>
|
|
120
|
+
|
|
121
|
+
</ul>
|
|
122
|
+
</div>
|
|
123
|
+
|
|
124
|
+
</div>
|
|
125
|
+
</nav>
|
|
126
|
+
|
|
127
|
+
<main role="main" aria-labelledby="class-StandupMD::EntryList">
|
|
128
|
+
<h1 id="class-StandupMD::EntryList" class="class">
|
|
129
|
+
class StandupMD::EntryList
|
|
130
|
+
</h1>
|
|
131
|
+
|
|
132
|
+
<section class="description">
|
|
133
|
+
|
|
134
|
+
<p>Enumerable list of entries.</p>
|
|
135
|
+
|
|
136
|
+
</section>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
150
|
+
<header>
|
|
151
|
+
<h3>Public Class Methods</h3>
|
|
152
|
+
</header>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<div id="method-c-config" class="method-detail ">
|
|
156
|
+
|
|
157
|
+
<div class="method-heading">
|
|
158
|
+
<span class="method-name">config</span><span
|
|
159
|
+
class="method-args">()</span>
|
|
160
|
+
|
|
161
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
162
|
+
|
|
163
|
+
</div>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<div class="method-description">
|
|
167
|
+
|
|
168
|
+
<p>Access to the class's configuration.</p>
|
|
169
|
+
|
|
170
|
+
<p>@return [StandupMD::Config::EntryList]</p>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<div class="method-source-code" id="config-source">
|
|
176
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 14</span>
|
|
177
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
|
|
178
|
+
<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
|
+
<span class="ruby-keyword">end</span></pre>
|
|
180
|
+
</div>
|
|
181
|
+
|
|
182
|
+
</div>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
</div>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<div id="method-c-new" class="method-detail ">
|
|
191
|
+
|
|
192
|
+
<div class="method-heading">
|
|
193
|
+
<span class="method-name">new</span><span
|
|
194
|
+
class="method-args">(*entries)</span>
|
|
195
|
+
|
|
196
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
197
|
+
|
|
198
|
+
</div>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<div class="method-description">
|
|
202
|
+
|
|
203
|
+
<p>Contruct a list. Can pass any amount of <code>StandupMD::Entry</code> instances.</p>
|
|
204
|
+
|
|
205
|
+
<p>@param [Entry] entries</p>
|
|
206
|
+
|
|
207
|
+
<p>@return [StandupMD::EntryList]</p>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<div class="method-source-code" id="new-source">
|
|
213
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 24</span>
|
|
214
|
+
<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
|
+
<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
|
+
<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>) }
|
|
217
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Entry must instance of StandupMD::Entry'</span>
|
|
218
|
+
<span class="ruby-keyword">end</span>
|
|
219
|
+
<span class="ruby-ivar">@entries</span> = <span class="ruby-identifier">entries</span>
|
|
220
|
+
<span class="ruby-keyword">end</span></pre>
|
|
221
|
+
</div>
|
|
222
|
+
|
|
223
|
+
</div>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
</div>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</section>
|
|
232
|
+
|
|
233
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
234
|
+
<header>
|
|
235
|
+
<h3>Public Instance Methods</h3>
|
|
236
|
+
</header>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<div id="method-i-3C-3C" class="method-detail ">
|
|
240
|
+
|
|
241
|
+
<div class="method-heading">
|
|
242
|
+
<span class="method-name"><<</span><span
|
|
243
|
+
class="method-args">(entry)</span>
|
|
244
|
+
|
|
245
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
246
|
+
|
|
247
|
+
</div>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<div class="method-description">
|
|
251
|
+
|
|
252
|
+
<p>Appends entries to list.</p>
|
|
253
|
+
|
|
254
|
+
<p>@param [StandupMD::Entry] entry</p>
|
|
255
|
+
|
|
256
|
+
<p>@return [Array]</p>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<div class="method-source-code" id="3C-3C-source">
|
|
262
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 44</span>
|
|
263
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">entry</span>)
|
|
264
|
+
<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
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Entry must instance of StandupMD::Entry'</span>
|
|
266
|
+
<span class="ruby-keyword">end</span>
|
|
267
|
+
<span class="ruby-ivar">@entries</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">entry</span>
|
|
268
|
+
<span class="ruby-keyword">end</span></pre>
|
|
269
|
+
</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 70</span>
|
|
334
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
|
|
335
|
+
<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">empty?</span>
|
|
336
|
+
<span class="ruby-keyword">end</span></pre>
|
|
337
|
+
</div>
|
|
338
|
+
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
<div id="method-i-filter" class="method-detail ">
|
|
348
|
+
|
|
349
|
+
<div class="method-heading">
|
|
350
|
+
<span class="method-name">filter</span><span
|
|
351
|
+
class="method-args">(start_date, end_date)</span>
|
|
352
|
+
|
|
353
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
354
|
+
|
|
355
|
+
</div>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<div class="method-description">
|
|
359
|
+
|
|
360
|
+
<p>Returns entries that are between the start and end date. This method assumes the list has already been sorted.</p>
|
|
361
|
+
|
|
362
|
+
<p>@param [Date] start_date</p>
|
|
363
|
+
|
|
364
|
+
<p>@param [Date] end_date</p>
|
|
365
|
+
|
|
366
|
+
<p>@return [Array]</p>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<div class="method-source-code" id="filter-source">
|
|
372
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 108</span>
|
|
373
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">filter</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>)
|
|
374
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(
|
|
375
|
+
<span class="ruby-operator">*</span><span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>) }
|
|
376
|
+
)
|
|
377
|
+
<span class="ruby-keyword">end</span></pre>
|
|
378
|
+
</div>
|
|
379
|
+
|
|
380
|
+
</div>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</div>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
<div id="method-i-filter-21" class="method-detail ">
|
|
389
|
+
|
|
390
|
+
<div class="method-heading">
|
|
391
|
+
<span class="method-name">filter!</span><span
|
|
392
|
+
class="method-args">(start_date, end_date)</span>
|
|
393
|
+
|
|
394
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
395
|
+
|
|
396
|
+
</div>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<div class="method-description">
|
|
400
|
+
|
|
401
|
+
<p>Replaces entries with results of filter.</p>
|
|
402
|
+
|
|
403
|
+
<p>@param [Date] start_date</p>
|
|
404
|
+
|
|
405
|
+
<p>@param [Date] end_date</p>
|
|
406
|
+
|
|
407
|
+
<p>@return [Array]</p>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<div class="method-source-code" id="filter-21-source">
|
|
413
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 122</span>
|
|
414
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">filter!</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>)
|
|
415
|
+
<span class="ruby-ivar">@entries</span> = <span class="ruby-identifier">filter</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>)
|
|
416
|
+
<span class="ruby-keyword">self</span>
|
|
417
|
+
<span class="ruby-keyword">end</span></pre>
|
|
418
|
+
</div>
|
|
419
|
+
|
|
420
|
+
</div>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
</div>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
<div id="method-i-find" class="method-detail ">
|
|
429
|
+
|
|
430
|
+
<div class="method-heading">
|
|
431
|
+
<span class="method-name">find</span><span
|
|
432
|
+
class="method-args">(key)</span>
|
|
433
|
+
|
|
434
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
435
|
+
|
|
436
|
+
</div>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
<div class="method-description">
|
|
440
|
+
|
|
441
|
+
<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 132</span>
|
|
483
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">first</span>
|
|
484
|
+
<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">first</span>
|
|
485
|
+
<span class="ruby-keyword">end</span></pre>
|
|
486
|
+
</div>
|
|
487
|
+
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
<div id="method-i-last" class="method-detail ">
|
|
497
|
+
|
|
498
|
+
<div class="method-heading">
|
|
499
|
+
<span class="method-name">last</span><span
|
|
500
|
+
class="method-args">()</span>
|
|
501
|
+
|
|
502
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
503
|
+
|
|
504
|
+
</div>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
<div class="method-description">
|
|
508
|
+
|
|
509
|
+
<p>The last entry in the list. This method assumes the list has already been sorted.</p>
|
|
510
|
+
|
|
511
|
+
<p>@return [StandupMD::Entry]</p>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<div class="method-source-code" id="last-source">
|
|
517
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 141</span>
|
|
518
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">last</span>
|
|
519
|
+
<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">last</span>
|
|
520
|
+
<span class="ruby-keyword">end</span></pre>
|
|
521
|
+
</div>
|
|
522
|
+
|
|
523
|
+
</div>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
</div>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
<div id="method-i-size" class="method-detail ">
|
|
532
|
+
|
|
533
|
+
<div class="method-heading">
|
|
534
|
+
<span class="method-name">size</span><span
|
|
535
|
+
class="method-args">()</span>
|
|
536
|
+
|
|
537
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
538
|
+
|
|
539
|
+
</div>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
<div class="method-description">
|
|
543
|
+
|
|
544
|
+
<p>How many entries are in the list.</p>
|
|
545
|
+
|
|
546
|
+
<p>@return [Integer]</p>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<div class="method-source-code" id="size-source">
|
|
552
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 62</span>
|
|
553
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
|
|
554
|
+
<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">size</span>
|
|
555
|
+
<span class="ruby-keyword">end</span></pre>
|
|
556
|
+
</div>
|
|
557
|
+
|
|
558
|
+
</div>
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
</div>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<div id="method-i-sort" class="method-detail ">
|
|
567
|
+
|
|
568
|
+
<div class="method-heading">
|
|
569
|
+
<span class="method-name">sort</span><span
|
|
570
|
+
class="method-args">()</span>
|
|
571
|
+
|
|
572
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
573
|
+
|
|
574
|
+
</div>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
<div class="method-description">
|
|
578
|
+
|
|
579
|
+
<p>Returns a copy of self sorted by date.</p>
|
|
580
|
+
|
|
581
|
+
<p>@return [StandupMD::EntryList]</p>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
<div class="method-source-code" id="sort-source">
|
|
587
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 78</span>
|
|
588
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort</span>
|
|
589
|
+
<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
|
+
<span class="ruby-keyword">end</span></pre>
|
|
591
|
+
</div>
|
|
592
|
+
|
|
593
|
+
</div>
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
</div>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
<div id="method-i-sort-21" class="method-detail ">
|
|
602
|
+
|
|
603
|
+
<div class="method-heading">
|
|
604
|
+
<span class="method-name">sort!</span><span
|
|
605
|
+
class="method-args">()</span>
|
|
606
|
+
|
|
607
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
608
|
+
|
|
609
|
+
</div>
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
<div class="method-description">
|
|
613
|
+
|
|
614
|
+
<p>Replace entries with sorted entries by date.</p>
|
|
615
|
+
|
|
616
|
+
<p>@return [StandupMD::EntryList]</p>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
<div class="method-source-code" id="sort-21-source">
|
|
622
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 86</span>
|
|
623
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort!</span>
|
|
624
|
+
<span class="ruby-ivar">@entries</span> = <span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">sort</span>
|
|
625
|
+
<span class="ruby-keyword">self</span>
|
|
626
|
+
<span class="ruby-keyword">end</span></pre>
|
|
627
|
+
</div>
|
|
628
|
+
|
|
629
|
+
</div>
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
</div>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
<div id="method-i-sort_reverse" class="method-detail ">
|
|
638
|
+
|
|
639
|
+
<div class="method-heading">
|
|
640
|
+
<span class="method-name">sort_reverse</span><span
|
|
641
|
+
class="method-args">()</span>
|
|
642
|
+
|
|
643
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
644
|
+
|
|
645
|
+
</div>
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
<div class="method-description">
|
|
649
|
+
|
|
650
|
+
<p>Returns a copy of self sorted by date.</p>
|
|
651
|
+
|
|
652
|
+
<p>@return [StandupMD::EntryList]</p>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<div class="method-source-code" id="sort_reverse-source">
|
|
658
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 95</span>
|
|
659
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort_reverse</span>
|
|
660
|
+
<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
|
+
<span class="ruby-keyword">end</span></pre>
|
|
662
|
+
</div>
|
|
663
|
+
|
|
664
|
+
</div>
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
</div>
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
<div id="method-i-to_h" class="method-detail ">
|
|
673
|
+
|
|
674
|
+
<div class="method-heading">
|
|
675
|
+
<span class="method-name">to_h</span><span
|
|
676
|
+
class="method-args">()</span>
|
|
677
|
+
|
|
678
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
679
|
+
|
|
680
|
+
</div>
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
<div class="method-description">
|
|
684
|
+
|
|
685
|
+
<p>The list as a hash, with the dates as keys.</p>
|
|
686
|
+
|
|
687
|
+
<p>@return [Hash]</p>
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
<div class="method-source-code" id="to_h-source">
|
|
693
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 149</span>
|
|
694
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
|
|
695
|
+
<span class="ruby-constant">Hash</span>[<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span>, {
|
|
696
|
+
<span class="ruby-string">'current'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">current</span>,
|
|
697
|
+
<span class="ruby-string">'previous'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">previous</span>,
|
|
698
|
+
<span class="ruby-string">'impediments'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">impediments</span>,
|
|
699
|
+
<span class="ruby-string">'notes'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">notes</span>
|
|
700
|
+
}]}]
|
|
701
|
+
<span class="ruby-keyword">end</span></pre>
|
|
702
|
+
</div>
|
|
703
|
+
|
|
704
|
+
</div>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
</div>
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
<div id="method-i-to_json" class="method-detail ">
|
|
713
|
+
|
|
714
|
+
<div class="method-heading">
|
|
715
|
+
<span class="method-name">to_json</span><span
|
|
716
|
+
class="method-args">()</span>
|
|
717
|
+
|
|
718
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
719
|
+
|
|
720
|
+
</div>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
<div class="method-description">
|
|
724
|
+
|
|
725
|
+
<p>The entry list as a json object.</p>
|
|
726
|
+
|
|
727
|
+
<p>@return [String]</p>
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
<div class="method-source-code" id="to_json-source">
|
|
733
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 162</span>
|
|
734
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
|
|
735
|
+
<span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
|
|
736
|
+
<span class="ruby-keyword">end</span></pre>
|
|
737
|
+
</div>
|
|
738
|
+
|
|
739
|
+
</div>
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
</div>
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
</section>
|
|
748
|
+
|
|
749
|
+
</section>
|
|
750
|
+
|
|
751
|
+
</main>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
<footer id="validator-badges" role="contentinfo">
|
|
755
|
+
<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.2.1.
|
|
757
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
758
|
+
</footer>
|
|
759
|
+
|