standup_md 0.3.11 → 0.3.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/README.md +2 -4
  4. data/Rakefile +1 -1
  5. data/lib/standup_md/version.rb +1 -1
  6. data/standup_md.gemspec +1 -1
  7. metadata +3 -60
  8. data/doc/README_md.html +0 -393
  9. data/doc/StandupMD.html +0 -238
  10. data/doc/StandupMD/Cli.html +0 -406
  11. data/doc/StandupMD/Cli/Helpers.html +0 -146
  12. data/doc/StandupMD/Config.html +0 -193
  13. data/doc/StandupMD/Config/Cli.html +0 -296
  14. data/doc/StandupMD/Config/Entry.html +0 -240
  15. data/doc/StandupMD/Config/EntryList.html +0 -171
  16. data/doc/StandupMD/Config/File.html +0 -481
  17. data/doc/StandupMD/Entry.html +0 -367
  18. data/doc/StandupMD/EntryList.html +0 -499
  19. data/doc/StandupMD/File.html +0 -483
  20. data/doc/StandupMD/Version.html +0 -199
  21. data/doc/created.rid +0 -15
  22. data/doc/css/fonts.css +0 -167
  23. data/doc/css/rdoc.css +0 -619
  24. data/doc/fonts/Lato-Light.ttf +0 -0
  25. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  26. data/doc/fonts/Lato-Regular.ttf +0 -0
  27. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  28. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  29. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  30. data/doc/images/add.png +0 -0
  31. data/doc/images/arrow_up.png +0 -0
  32. data/doc/images/brick.png +0 -0
  33. data/doc/images/brick_link.png +0 -0
  34. data/doc/images/bug.png +0 -0
  35. data/doc/images/bullet_black.png +0 -0
  36. data/doc/images/bullet_toggle_minus.png +0 -0
  37. data/doc/images/bullet_toggle_plus.png +0 -0
  38. data/doc/images/date.png +0 -0
  39. data/doc/images/delete.png +0 -0
  40. data/doc/images/find.png +0 -0
  41. data/doc/images/loadingAnimation.gif +0 -0
  42. data/doc/images/macFFBgHack.png +0 -0
  43. data/doc/images/package.png +0 -0
  44. data/doc/images/page_green.png +0 -0
  45. data/doc/images/page_white_text.png +0 -0
  46. data/doc/images/page_white_width.png +0 -0
  47. data/doc/images/plugin.png +0 -0
  48. data/doc/images/ruby.png +0 -0
  49. data/doc/images/tag_blue.png +0 -0
  50. data/doc/images/tag_green.png +0 -0
  51. data/doc/images/transparent.png +0 -0
  52. data/doc/images/wrench.png +0 -0
  53. data/doc/images/wrench_orange.png +0 -0
  54. data/doc/images/zoom.png +0 -0
  55. data/doc/index.html +0 -382
  56. data/doc/js/darkfish.js +0 -84
  57. data/doc/js/navigation.js +0 -105
  58. data/doc/js/navigation.js.gz +0 -0
  59. data/doc/js/search.js +0 -110
  60. data/doc/js/search_index.js +0 -1
  61. data/doc/js/search_index.js.gz +0 -0
  62. data/doc/js/searcher.js +0 -229
  63. data/doc/js/searcher.js.gz +0 -0
  64. data/doc/table_of_contents.html +0 -411
data/doc/StandupMD/Entry.html DELETED
@@ -1,367 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>class StandupMD::Entry - 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
- <body id="top" role="document" class="class">
25
- <nav role="navigation">
26
- <div id="project-navigation">
27
- <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
- <h2>
29
- <a href="../index.html" rel="home">Home</a>
30
- </h2>
31
-
32
- <div id="table-of-contents-navigation">
33
- <a href="../table_of_contents.html#pages">Pages</a>
34
- <a href="../table_of_contents.html#classes">Classes</a>
35
- <a href="../table_of_contents.html#methods">Methods</a>
36
- </div>
37
- </div>
38
-
39
- <div id="search-section" role="search" class="project-section initially-hidden">
40
- <form action="#" method="get" accept-charset="utf-8">
41
- <div id="search-field-wrapper">
42
- <input id="search-field" role="combobox" aria-label="Search"
43
- aria-autocomplete="list" aria-controls="search-results"
44
- type="text" name="search" placeholder="Search" spellcheck="false"
45
- title="Type to search, Up and Down to navigate, Enter to load">
46
- </div>
47
-
48
- <ul id="search-results" aria-label="Search Results"
49
- aria-busy="false" aria-expanded="false"
50
- aria-atomic="false" class="initially-hidden"></ul>
51
- </form>
52
- </div>
53
-
54
- </div>
55
-
56
-
57
-
58
- <div id="class-metadata">
59
-
60
-
61
- <div id="parent-class-section" class="nav-section">
62
- <h3>Parent</h3>
63
-
64
- <p class="link">Object
65
- </div>
66
-
67
-
68
- <div id="includes-section" class="nav-section">
69
- <h3>Included Modules</h3>
70
-
71
- <ul class="link-list">
72
- <li><span class="include">Comparable</span>
73
- </ul>
74
- </div>
75
-
76
-
77
-
78
- <!-- Method Quickref -->
79
- <div id="method-list-section" class="nav-section">
80
- <h3>Methods</h3>
81
-
82
- <ul class="link-list" role="directory">
83
- <li ><a href="#method-c-config">::config</a>
84
- <li ><a href="#method-c-create">::create</a>
85
- <li ><a href="#method-c-new">::new</a>
86
- <li ><a href="#method-i-3C-3D-3E">#&lt;=&gt;</a>
87
- <li ><a href="#method-i-to_h">#to_h</a>
88
- <li ><a href="#method-i-to_json">#to_json</a>
89
- </ul>
90
- </div>
91
-
92
- </div>
93
- </nav>
94
-
95
- <main role="main" aria-labelledby="class-StandupMD::Entry">
96
- <h1 id="class-StandupMD::Entry" class="class">
97
- class StandupMD::Entry
98
- </h1>
99
-
100
- <section class="description">
101
-
102
- <p>Class for handling single entries. Includes the comparable module, and compares by date.</p>
103
-
104
- </section>
105
-
106
- <section id="5Buntitled-5D" class="documentation-section">
107
-
108
-
109
-
110
- <section class="attribute-method-details" class="method-section">
111
- <header>
112
- <h3>Attributes</h3>
113
- </header>
114
-
115
- <div id="attribute-i-current" class="method-detail">
116
- <div class="method-heading attribute-method-heading">
117
- <span class="method-name">current</span><span
118
- class="attribute-access-type">[RW]</span>
119
- </div>
120
-
121
- <div class="method-description">
122
- <p>The tasks for today.</p>
123
-
124
- <p>@return [Array]</p>
125
- </div>
126
- </div>
127
- <div id="attribute-i-date" class="method-detail">
128
- <div class="method-heading attribute-method-heading">
129
- <span class="method-name">date</span><span
130
- class="attribute-access-type">[RW]</span>
131
- </div>
132
-
133
- <div class="method-description">
134
- <p>The date of the entry.</p>
135
-
136
- <p>@param [Date] date</p>
137
-
138
- <p>@return [Date]</p>
139
- </div>
140
- </div>
141
- <div id="attribute-i-impediments" class="method-detail">
142
- <div class="method-heading attribute-method-heading">
143
- <span class="method-name">impediments</span><span
144
- class="attribute-access-type">[RW]</span>
145
- </div>
146
-
147
- <div class="method-description">
148
- <p>Impediments for this entry.</p>
149
-
150
- <p>@return [Array]</p>
151
- </div>
152
- </div>
153
- <div id="attribute-i-notes" class="method-detail">
154
- <div class="method-heading attribute-method-heading">
155
- <span class="method-name">notes</span><span
156
- class="attribute-access-type">[RW]</span>
157
- </div>
158
-
159
- <div class="method-description">
160
- <p>Nnotes to add to this entry.</p>
161
-
162
- <p>@return [Array]</p>
163
- </div>
164
- </div>
165
- <div id="attribute-i-previous" class="method-detail">
166
- <div class="method-heading attribute-method-heading">
167
- <span class="method-name">previous</span><span
168
- class="attribute-access-type">[RW]</span>
169
- </div>
170
-
171
- <div class="method-description">
172
- <p>The tasks from the previous day.</p>
173
-
174
- <p>@return [Array]</p>
175
- </div>
176
- </div>
177
- </section>
178
-
179
-
180
- <section id="public-class-5Buntitled-5D-method-details" class="method-section">
181
- <header>
182
- <h3>Public Class Methods</h3>
183
- </header>
184
-
185
- <div id="method-c-config" class="method-detail ">
186
- <div class="method-heading">
187
- <span class="method-name">config</span><span
188
- class="method-args">()</span>
189
- <span class="method-click-advice">click to toggle source</span>
190
- </div>
191
-
192
- <div class="method-description">
193
- <p>Access to the class&#39;s configuration.</p>
194
-
195
- <p>@return [StandupMD::Config::Entry]</p>
196
-
197
- <div class="method-source-code" id="config-source">
198
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 16</span>
199
- <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
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>
201
- <span class="ruby-keyword">end</span></pre>
202
- </div>
203
- </div>
204
-
205
-
206
- </div>
207
-
208
- <div id="method-c-create" class="method-detail ">
209
- <div class="method-heading">
210
- <span class="method-name">create</span><span
211
- class="method-args">() { |entry| ... }</span>
212
- <span class="method-click-advice">click to toggle source</span>
213
- </div>
214
-
215
- <div class="method-description">
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>
217
-
218
- <p>@return [StandupMD::Entry]</p>
219
-
220
- <div class="method-source-code" id="create-source">
221
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 57</span>
222
- <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create</span>
223
- <span class="ruby-identifier">new</span>(
224
- <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>,
225
- <span class="ruby-identifier">config</span>.<span class="ruby-identifier">current</span>,
226
- <span class="ruby-identifier">config</span>.<span class="ruby-identifier">previous</span>,
227
- <span class="ruby-identifier">config</span>.<span class="ruby-identifier">impediments</span>,
228
- <span class="ruby-identifier">config</span>.<span class="ruby-identifier">notes</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> }
230
- <span class="ruby-keyword">end</span></pre>
231
- </div>
232
- </div>
233
-
234
-
235
- </div>
236
-
237
- <div id="method-c-new" class="method-detail ">
238
- <div class="method-heading">
239
- <span class="method-name">new</span><span
240
- class="method-args">(date, current, previous, impediments, notes = [])</span>
241
- <span class="method-click-advice">click to toggle source</span>
242
- </div>
243
-
244
- <div class="method-description">
245
- <p>Constructs instance of <code>StandupMD::Entry</code>.</p>
246
-
247
- <p>@param [Date] date</p>
248
-
249
- <p>@param [Array] current</p>
250
-
251
- <p>@param [Array] previous</p>
252
-
253
- <p>@param [Array] impediments</p>
254
-
255
- <p>@param [Array] notes</p>
256
-
257
- <div class="method-source-code" id="new-source">
258
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 79</span>
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> = [])
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>)
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>
262
-
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>
268
- <span class="ruby-keyword">end</span></pre>
269
- </div>
270
- </div>
271
-
272
-
273
- </div>
274
-
275
- </section>
276
-
277
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
278
- <header>
279
- <h3>Public Instance Methods</h3>
280
- </header>
281
-
282
- <div id="method-i-3C-3D-3E" class="method-detail ">
283
- <div class="method-heading">
284
- <span class="method-name">&lt;=&gt;</span><span
285
- class="method-args">(other)</span>
286
- <span class="method-click-advice">click to toggle source</span>
287
- </div>
288
-
289
- <div class="method-description">
290
- <p>Sorting method for Comparable. Entries are compared by date.</p>
291
-
292
- <div class="method-source-code" id="3C-3D-3E-source">
293
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 92</span>
294
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">&lt;=&gt;</span>(<span class="ruby-identifier">other</span>)
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>
296
- <span class="ruby-keyword">end</span></pre>
297
- </div>
298
- </div>
299
-
300
-
301
- </div>
302
-
303
- <div id="method-i-to_h" class="method-detail ">
304
- <div class="method-heading">
305
- <span class="method-name">to_h</span><span
306
- class="method-args">()</span>
307
- <span class="method-click-advice">click to toggle source</span>
308
- </div>
309
-
310
- <div class="method-description">
311
- <p><a href="Entry.html"><code>Entry</code></a> as a hash .</p>
312
-
313
- <p>@return [Hash]</p>
314
-
315
- <div class="method-source-code" id="to_h-source">
316
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 100</span>
317
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
318
- {
319
- <span class="ruby-identifier">date</span> <span class="ruby-operator">=&gt;</span> {
320
- <span class="ruby-string">&#39;current&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">current</span>,
321
- <span class="ruby-string">&#39;previous&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">previous</span>,
322
- <span class="ruby-string">&#39;impediments&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">impediments</span>,
323
- <span class="ruby-string">&#39;notes&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">notes</span>
324
- }
325
- }
326
- <span class="ruby-keyword">end</span></pre>
327
- </div>
328
- </div>
329
-
330
-
331
- </div>
332
-
333
- <div id="method-i-to_json" class="method-detail ">
334
- <div class="method-heading">
335
- <span class="method-name">to_json</span><span
336
- class="method-args">()</span>
337
- <span class="method-click-advice">click to toggle source</span>
338
- </div>
339
-
340
- <div class="method-description">
341
- <p><a href="Entry.html"><code>Entry</code></a> as a json object.</p>
342
-
343
- <p>@return [String]</p>
344
-
345
- <div class="method-source-code" id="to_json-source">
346
- <pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 115</span>
347
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
348
- <span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
349
- <span class="ruby-keyword">end</span></pre>
350
- </div>
351
- </div>
352
-
353
-
354
- </div>
355
-
356
- </section>
357
-
358
- </section>
359
- </main>
360
-
361
-
362
- <footer id="validator-badges" role="contentinfo">
363
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
364
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
365
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
366
- </footer>
367
-
data/doc/StandupMD/EntryList.html DELETED
@@ -1,499 +0,0 @@
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
- <body id="top" role="document" class="class">
25
- <nav role="navigation">
26
- <div id="project-navigation">
27
- <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
- <h2>
29
- <a href="../index.html" rel="home">Home</a>
30
- </h2>
31
-
32
- <div id="table-of-contents-navigation">
33
- <a href="../table_of_contents.html#pages">Pages</a>
34
- <a href="../table_of_contents.html#classes">Classes</a>
35
- <a href="../table_of_contents.html#methods">Methods</a>
36
- </div>
37
- </div>
38
-
39
- <div id="search-section" role="search" class="project-section initially-hidden">
40
- <form action="#" method="get" accept-charset="utf-8">
41
- <div id="search-field-wrapper">
42
- <input id="search-field" role="combobox" aria-label="Search"
43
- aria-autocomplete="list" aria-controls="search-results"
44
- type="text" name="search" placeholder="Search" spellcheck="false"
45
- title="Type to search, Up and Down to navigate, Enter to load">
46
- </div>
47
-
48
- <ul id="search-results" aria-label="Search Results"
49
- aria-busy="false" aria-expanded="false"
50
- aria-atomic="false" class="initially-hidden"></ul>
51
- </form>
52
- </div>
53
-
54
- </div>
55
-
56
-
57
-
58
- <div id="class-metadata">
59
-
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">
71
- <h3>Parent</h3>
72
-
73
- <p class="link">Object
74
- </div>
75
-
76
-
77
- <div id="includes-section" class="nav-section">
78
- <h3>Included Modules</h3>
79
-
80
- <ul class="link-list">
81
- <li><span class="include">Enumerable</span>
82
- </ul>
83
- </div>
84
-
85
-
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 -->
96
- <div id="method-list-section" class="nav-section">
97
- <h3>Methods</h3>
98
-
99
- <ul class="link-list" role="directory">
100
- <li ><a href="#method-c-config">::config</a>
101
- <li ><a href="#method-c-new">::new</a>
102
- <li ><a href="#method-i-3C-3C">#&lt;&lt;</a>
103
- <li ><a href="#method-i-40entries">#@entries</a>
104
- <li ><a href="#method-i-filter">#filter</a>
105
- <li ><a href="#method-i-filter-21">#filter!</a>
106
- <li ><a href="#method-i-find">#find</a>
107
- <li ><a href="#method-i-sort">#sort</a>
108
- <li ><a href="#method-i-sort-21">#sort!</a>
109
- <li ><a href="#method-i-sort_reverse">#sort_reverse</a>
110
- <li ><a href="#method-i-to_h">#to_h</a>
111
- <li ><a href="#method-i-to_json">#to_json</a>
112
- </ul>
113
- </div>
114
-
115
- </div>
116
- </nav>
117
-
118
- <main role="main" aria-labelledby="class-StandupMD::EntryList">
119
- <h1 id="class-StandupMD::EntryList" class="class">
120
- class StandupMD::EntryList
121
- </h1>
122
-
123
- <section class="description">
124
-
125
- <p>Enumerable list of entries.</p>
126
-
127
- </section>
128
-
129
- <section id="5Buntitled-5D" class="documentation-section">
130
-
131
-
132
-
133
-
134
-
135
- <section id="public-class-5Buntitled-5D-method-details" class="method-section">
136
- <header>
137
- <h3>Public Class Methods</h3>
138
- </header>
139
-
140
- <div id="method-c-config" class="method-detail ">
141
- <div class="method-heading">
142
- <span class="method-name">config</span><span
143
- class="method-args">()</span>
144
- <span class="method-click-advice">click to toggle source</span>
145
- </div>
146
-
147
- <div class="method-description">
148
- <p>Access to the class&#39;s configuration.</p>
149
-
150
- <p>@return [StandupMD::Config::EntryList]</p>
151
-
152
- <div class="method-source-code" id="config-source">
153
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 16</span>
154
- <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
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>
156
- <span class="ruby-keyword">end</span></pre>
157
- </div>
158
- </div>
159
-
160
-
161
- </div>
162
-
163
- <div id="method-c-new" class="method-detail ">
164
- <div class="method-heading">
165
- <span class="method-name">new</span><span
166
- class="method-args">(*entries)</span>
167
- <span class="method-click-advice">click to toggle source</span>
168
- </div>
169
-
170
- <div class="method-description">
171
- <p>Contruct a list. Can pass any amount of <code>StandupMD::Entry</code> instances.</p>
172
-
173
- <p>@param [Entry] entries</p>
174
-
175
- <p>@return [StandupMD::EntryList]</p>
176
-
177
- <div class="method-source-code" id="new-source">
178
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 26</span>
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>)
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>
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>) }
182
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&#39;Entry must instance of StandupMD::Entry&#39;</span>
183
- <span class="ruby-keyword">end</span>
184
- <span class="ruby-ivar">@entries</span> = <span class="ruby-identifier">entries</span>
185
- <span class="ruby-keyword">end</span></pre>
186
- </div>
187
- </div>
188
-
189
-
190
- </div>
191
-
192
- </section>
193
-
194
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
195
- <header>
196
- <h3>Public Instance Methods</h3>
197
- </header>
198
-
199
- <div id="method-i-3C-3C" class="method-detail ">
200
- <div class="method-heading">
201
- <span class="method-name">&lt;&lt;</span><span
202
- class="method-args">(entry)</span>
203
- <span class="method-click-advice">click to toggle source</span>
204
- </div>
205
-
206
- <div class="method-description">
207
- <p>Appends entries to list.</p>
208
-
209
- <p>@param [StandupMD::Entry] entry</p>
210
-
211
- <p>@return [Array]</p>
212
-
213
- <div class="method-source-code" id="3C-3C-source">
214
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 40</span>
215
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">&lt;&lt;</span>(<span class="ruby-identifier">entry</span>)
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>)
217
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&#39;Entry must instance of StandupMD::Entry&#39;</span>
218
- <span class="ruby-keyword">end</span>
219
- <span class="ruby-ivar">@entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">entry</span>
220
- <span class="ruby-keyword">end</span></pre>
221
- </div>
222
- </div>
223
-
224
-
225
- </div>
226
-
227
- <div id="method-i-filter" class="method-detail ">
228
- <div class="method-heading">
229
- <span class="method-name">filter</span><span
230
- class="method-args">(start_date, end_date)</span>
231
- <span class="method-click-advice">click to toggle source</span>
232
- </div>
233
-
234
- <div class="method-description">
235
- <p>Returns entries that are between the start and end date. This method assumes the list has already been sorted.</p>
236
-
237
- <p>@param [Date] start_date</p>
238
-
239
- <p>@param [Date] end_date</p>
240
-
241
- <p>@return [Array]</p>
242
-
243
- <div class="method-source-code" id="filter-source">
244
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 92</span>
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>)
246
- <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(
247
- <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>) }
248
- )
249
- <span class="ruby-keyword">end</span></pre>
250
- </div>
251
- </div>
252
-
253
-
254
- </div>
255
-
256
- <div id="method-i-filter-21" class="method-detail ">
257
- <div class="method-heading">
258
- <span class="method-name">filter!</span><span
259
- class="method-args">(start_date, end_date)</span>
260
- <span class="method-click-advice">click to toggle source</span>
261
- </div>
262
-
263
- <div class="method-description">
264
- <p>Replaces entries with results of filter.</p>
265
-
266
- <p>@param [Date] start_date</p>
267
-
268
- <p>@param [Date] end_date</p>
269
-
270
- <p>@return [Array]</p>
271
-
272
- <div class="method-source-code" id="filter-21-source">
273
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 106</span>
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>)
275
- <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>)
276
- <span class="ruby-keyword">self</span>
277
- <span class="ruby-keyword">end</span></pre>
278
- </div>
279
- </div>
280
-
281
-
282
- </div>
283
-
284
- <div id="method-i-find" class="method-detail ">
285
- <div class="method-heading">
286
- <span class="method-name">find</span><span
287
- class="method-args">(date)</span>
288
- <span class="method-click-advice">click to toggle source</span>
289
- </div>
290
-
291
- <div class="method-description">
292
- <p>Finds an entry based on date. This method assumes the list has already been sorted.</p>
293
-
294
- <p>@param [Date] date</p>
295
-
296
- <p>@return [StandupMD::Entry]</p>
297
-
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> }
302
- <span class="ruby-keyword">end</span></pre>
303
- </div>
304
- </div>
305
-
306
-
307
- </div>
308
-
309
- <div id="method-i-sort" class="method-detail ">
310
- <div class="method-heading">
311
- <span class="method-name">sort</span><span
312
- class="method-args">()</span>
313
- <span class="method-click-advice">click to toggle source</span>
314
- </div>
315
-
316
- <div class="method-description">
317
- <p>Returns a copy of self sorted by date.</p>
318
-
319
- <p>@return [StandupMD::EntryList]</p>
320
-
321
- <div class="method-source-code" id="sort-source">
322
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 62</span>
323
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort</span>
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>)
325
- <span class="ruby-keyword">end</span></pre>
326
- </div>
327
- </div>
328
-
329
-
330
- </div>
331
-
332
- <div id="method-i-sort-21" class="method-detail ">
333
- <div class="method-heading">
334
- <span class="method-name">sort!</span><span
335
- class="method-args">()</span>
336
- <span class="method-click-advice">click to toggle source</span>
337
- </div>
338
-
339
- <div class="method-description">
340
- <p>Replace entries with sorted entries by date.</p>
341
-
342
- <p>@return [StandupMD::EntryList]</p>
343
-
344
- <div class="method-source-code" id="sort-21-source">
345
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 70</span>
346
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort!</span>
347
- <span class="ruby-ivar">@entries</span> = <span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">sort</span>
348
- <span class="ruby-keyword">self</span>
349
- <span class="ruby-keyword">end</span></pre>
350
- </div>
351
- </div>
352
-
353
-
354
- </div>
355
-
356
- <div id="method-i-sort_reverse" class="method-detail ">
357
- <div class="method-heading">
358
- <span class="method-name">sort_reverse</span><span
359
- class="method-args">()</span>
360
- <span class="method-click-advice">click to toggle source</span>
361
- </div>
362
-
363
- <div class="method-description">
364
- <p>Returns a copy of self sorted by date.</p>
365
-
366
- <p>@return [StandupMD::EntryList]</p>
367
-
368
- <div class="method-source-code" id="sort_reverse-source">
369
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 79</span>
370
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort_reverse</span>
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>)
372
- <span class="ruby-keyword">end</span></pre>
373
- </div>
374
- </div>
375
-
376
-
377
- </div>
378
-
379
- <div id="method-i-to_h" class="method-detail ">
380
- <div class="method-heading">
381
- <span class="method-name">to_h</span><span
382
- class="method-args">()</span>
383
- <span class="method-click-advice">click to toggle source</span>
384
- </div>
385
-
386
- <div class="method-description">
387
- <p>The list as a hash, with the dates as keys.</p>
388
-
389
- <p>@return [Hash]</p>
390
-
391
- <div class="method-source-code" id="to_h-source">
392
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 115</span>
393
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
394
- <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>, {
395
- <span class="ruby-string">&#39;current&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">current</span>,
396
- <span class="ruby-string">&#39;previous&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">previous</span>,
397
- <span class="ruby-string">&#39;impediments&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">impediments</span>,
398
- <span class="ruby-string">&#39;notes&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">notes</span>
399
- }]}]
400
- <span class="ruby-keyword">end</span></pre>
401
- </div>
402
- </div>
403
-
404
-
405
- </div>
406
-
407
- <div id="method-i-to_json" class="method-detail ">
408
- <div class="method-heading">
409
- <span class="method-name">to_json</span><span
410
- class="method-args">()</span>
411
- <span class="method-click-advice">click to toggle source</span>
412
- </div>
413
-
414
- <div class="method-description">
415
- <p>The entry list as a json object.</p>
416
-
417
- <p>@return [String]</p>
418
-
419
- <div class="method-source-code" id="to_json-source">
420
- <pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 128</span>
421
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
422
- <span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
423
- <span class="ruby-keyword">end</span></pre>
424
- </div>
425
- </div>
426
-
427
-
428
- </div>
429
-
430
- </section>
431
-
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">&uarr; top</a>
440
- </span>
441
- </header>
442
-
443
-
444
-
445
-
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>
491
- </main>
492
-
493
-
494
- <footer id="validator-badges" role="contentinfo">
495
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
496
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
497
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
498
- </footer>
499
-