standup_md 0.3.7 → 0.3.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +6 -16
  5. data/Rakefile +1 -1
  6. data/lib/standup_md.rb +8 -5
  7. data/lib/standup_md/cli.rb +7 -7
  8. data/lib/standup_md/cli/helpers.rb +10 -13
  9. data/lib/standup_md/config/file.rb +3 -3
  10. data/lib/standup_md/entry.rb +7 -9
  11. data/lib/standup_md/entry_list.rb +2 -2
  12. data/lib/standup_md/version.rb +26 -4
  13. data/standup_md.gemspec +1 -1
  14. metadata +3 -60
  15. data/doc/README_md.html +0 -400
  16. data/doc/StandupMD.html +0 -235
  17. data/doc/StandupMD/Cli.html +0 -406
  18. data/doc/StandupMD/Cli/Helpers.html +0 -146
  19. data/doc/StandupMD/Config.html +0 -193
  20. data/doc/StandupMD/Config/Cli.html +0 -296
  21. data/doc/StandupMD/Config/Entry.html +0 -240
  22. data/doc/StandupMD/Config/EntryList.html +0 -171
  23. data/doc/StandupMD/Config/File.html +0 -481
  24. data/doc/StandupMD/Entry.html +0 -369
  25. data/doc/StandupMD/EntryList.html +0 -499
  26. data/doc/StandupMD/File.html +0 -483
  27. data/doc/StandupMD/Version.html +0 -143
  28. data/doc/created.rid +0 -15
  29. data/doc/css/fonts.css +0 -167
  30. data/doc/css/rdoc.css +0 -619
  31. data/doc/fonts/Lato-Light.ttf +0 -0
  32. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  33. data/doc/fonts/Lato-Regular.ttf +0 -0
  34. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  35. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  36. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  37. data/doc/images/add.png +0 -0
  38. data/doc/images/arrow_up.png +0 -0
  39. data/doc/images/brick.png +0 -0
  40. data/doc/images/brick_link.png +0 -0
  41. data/doc/images/bug.png +0 -0
  42. data/doc/images/bullet_black.png +0 -0
  43. data/doc/images/bullet_toggle_minus.png +0 -0
  44. data/doc/images/bullet_toggle_plus.png +0 -0
  45. data/doc/images/date.png +0 -0
  46. data/doc/images/delete.png +0 -0
  47. data/doc/images/find.png +0 -0
  48. data/doc/images/loadingAnimation.gif +0 -0
  49. data/doc/images/macFFBgHack.png +0 -0
  50. data/doc/images/package.png +0 -0
  51. data/doc/images/page_green.png +0 -0
  52. data/doc/images/page_white_text.png +0 -0
  53. data/doc/images/page_white_width.png +0 -0
  54. data/doc/images/plugin.png +0 -0
  55. data/doc/images/ruby.png +0 -0
  56. data/doc/images/tag_blue.png +0 -0
  57. data/doc/images/tag_green.png +0 -0
  58. data/doc/images/transparent.png +0 -0
  59. data/doc/images/wrench.png +0 -0
  60. data/doc/images/wrench_orange.png +0 -0
  61. data/doc/images/zoom.png +0 -0
  62. data/doc/index.html +0 -388
  63. data/doc/js/darkfish.js +0 -84
  64. data/doc/js/navigation.js +0 -105
  65. data/doc/js/navigation.js.gz +0 -0
  66. data/doc/js/search.js +0 -110
  67. data/doc/js/search_index.js +0 -1
  68. data/doc/js/search_index.js.gz +0 -0
  69. data/doc/js/searcher.js +0 -229
  70. data/doc/js/searcher.js.gz +0 -0
  71. data/doc/table_of_contents.html +0 -402
@@ -1,483 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>class StandupMD::File - 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
-
69
-
70
- <!-- Method Quickref -->
71
- <div id="method-list-section" class="nav-section">
72
- <h3>Methods</h3>
73
-
74
- <ul class="link-list" role="directory">
75
- <li ><a href="#method-c-config">::config</a>
76
- <li ><a href="#method-c-find">::find</a>
77
- <li ><a href="#method-c-find_by_date">::find_by_date</a>
78
- <li ><a href="#method-c-load">::load</a>
79
- <li ><a href="#method-c-new">::new</a>
80
- <li ><a href="#method-i-exist-3F">#exist?</a>
81
- <li ><a href="#method-i-load">#load</a>
82
- <li ><a href="#method-i-loaded-3F">#loaded?</a>
83
- <li ><a href="#method-i-new-3F">#new?</a>
84
- <li ><a href="#method-i-write">#write</a>
85
- </ul>
86
- </div>
87
-
88
- </div>
89
- </nav>
90
-
91
- <main role="main" aria-labelledby="class-StandupMD::File">
92
- <h1 id="class-StandupMD::File" class="class">
93
- class StandupMD::File
94
- </h1>
95
-
96
- <section class="description">
97
-
98
- <p>Class for handling reading and writing standup files.</p>
99
-
100
- </section>
101
-
102
- <section id="5Buntitled-5D" class="documentation-section">
103
-
104
-
105
-
106
- <section class="attribute-method-details" class="method-section">
107
- <header>
108
- <h3>Attributes</h3>
109
- </header>
110
-
111
- <div id="attribute-i-entries" class="method-detail">
112
- <div class="method-heading attribute-method-heading">
113
- <span class="method-name">entries</span><span
114
- class="attribute-access-type">[R]</span>
115
- </div>
116
-
117
- <div class="method-description">
118
- <p>The list of entries in the file.</p>
119
-
120
- <p>@return [StandupMP::EntryList]</p>
121
- </div>
122
- </div>
123
- <div id="attribute-i-name" class="method-detail">
124
- <div class="method-heading attribute-method-heading">
125
- <span class="method-name">name</span><span
126
- class="attribute-access-type">[R]</span>
127
- </div>
128
-
129
- <div class="method-description">
130
- <p>The name of the file.</p>
131
-
132
- <p>@return [String]</p>
133
- </div>
134
- </div>
135
- </section>
136
-
137
-
138
- <section id="public-class-5Buntitled-5D-method-details" class="method-section">
139
- <header>
140
- <h3>Public Class Methods</h3>
141
- </header>
142
-
143
- <div id="method-c-config" class="method-detail ">
144
- <div class="method-heading">
145
- <span class="method-name">config</span><span
146
- class="method-args">()</span>
147
- <span class="method-click-advice">click to toggle source</span>
148
- </div>
149
-
150
- <div class="method-description">
151
- <p>Access to the class&#39;s configuration.</p>
152
-
153
- <p>@return [StandupMD::Config::EntryList]</p>
154
-
155
- <div class="method-source-code" id="config-source">
156
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 17</span>
157
- <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
158
- <span class="ruby-ivar">@config</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>
159
- <span class="ruby-keyword">end</span></pre>
160
- </div>
161
- </div>
162
-
163
-
164
- </div>
165
-
166
- <div id="method-c-find" class="method-detail ">
167
- <div class="method-heading">
168
- <span class="method-name">find</span><span
169
- class="method-args">(file_name)</span>
170
- <span class="method-click-advice">click to toggle source</span>
171
- </div>
172
-
173
- <div class="method-description">
174
- <p>Find standup file in directory by file name.</p>
175
-
176
- <p>@param [String] File_naem</p>
177
-
178
- <div class="method-source-code" id="find-source">
179
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 40</span>
180
- <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">file_name</span>)
181
- <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>)
182
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Dir #{config.directory} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
183
-
184
- <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>)
185
- <span class="ruby-keyword">end</span>
186
- <span class="ruby-identifier">file</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">entries</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>).<span class="ruby-identifier">bsearch</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">file_name</span> }
187
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{file_name} not found.&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
188
-
189
- <span class="ruby-identifier">new</span>(<span class="ruby-identifier">file_name</span>)
190
- <span class="ruby-keyword">end</span></pre>
191
- </div>
192
- </div>
193
-
194
-
195
- </div>
196
-
197
- <div id="method-c-find_by_date" class="method-detail ">
198
- <div class="method-heading">
199
- <span class="method-name">find_by_date</span><span
200
- class="method-args">(date)</span>
201
- <span class="method-click-advice">click to toggle source</span>
202
- </div>
203
-
204
- <div class="method-description">
205
- <p>Find standup file in directory by Date object.</p>
206
-
207
- <p>@param [Date] date</p>
208
-
209
- <div class="method-source-code" id="find_by_date-source">
210
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 56</span>
211
- <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">find_by_date</span>(<span class="ruby-identifier">date</span>)
212
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&#39;Must be a Date object&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Date</span>)
213
-
214
- <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>)
215
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Dir #{config.directory} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
216
-
217
- <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>)
218
- <span class="ruby-keyword">end</span>
219
- <span class="ruby-identifier">find</span>(<span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">name_format</span>))
220
- <span class="ruby-keyword">end</span></pre>
221
- </div>
222
- </div>
223
-
224
-
225
- </div>
226
-
227
- <div id="method-c-load" class="method-detail ">
228
- <div class="method-heading">
229
- <span class="method-name">load</span><span
230
- class="method-args">(file_name)</span>
231
- <span class="method-click-advice">click to toggle source</span>
232
- </div>
233
-
234
- <div class="method-description">
235
- <p>Convenience method for calling <a href="File.html#method-c-find"><code>File.find(file_name)</code></a>.load</p>
236
-
237
- <p>@param [String] file_name</p>
238
-
239
- <p>@return [StandupMD::File]</p>
240
-
241
- <div class="method-source-code" id="load-source">
242
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 27</span>
243
- <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load</span>(<span class="ruby-identifier">file_name</span>)
244
- <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>)
245
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Dir #{config.directory} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">create</span>
246
-
247
- <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">directory</span>)
248
- <span class="ruby-keyword">end</span>
249
- <span class="ruby-identifier">new</span>(<span class="ruby-identifier">file_name</span>).<span class="ruby-identifier">load</span>
250
- <span class="ruby-keyword">end</span></pre>
251
- </div>
252
- </div>
253
-
254
-
255
- </div>
256
-
257
- <div id="method-c-new" class="method-detail ">
258
- <div class="method-heading">
259
- <span class="method-name">new</span><span
260
- class="method-args">(file_name)</span>
261
- <span class="method-click-advice">click to toggle source</span>
262
- </div>
263
-
264
- <div class="method-description">
265
- <p>Constructs the instance.</p>
266
-
267
- <p>@param [String] file_name</p>
268
-
269
- <p>@return [StandupMP::File]</p>
270
-
271
- <div class="method-source-code" id="new-source">
272
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 85</span>
273
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">file_name</span>)
274
- <span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
275
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">file_name</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>)
276
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,
277
- <span class="ruby-node">&quot;#{file_name} contains directory. Please use `StandupMD.config.file.directory=`&quot;</span>
278
- <span class="ruby-keyword">end</span>
279
-
280
- <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">directory</span>)
281
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Dir #{@config.directory} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">create</span>
282
-
283
- <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">directory</span>)
284
- <span class="ruby-keyword">end</span>
285
-
286
- <span class="ruby-ivar">@name</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">directory</span>, <span class="ruby-identifier">file_name</span>))
287
-
288
- <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-ivar">@name</span>)
289
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{@name} not found.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">create</span>
290
-
291
- <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">touch</span>(<span class="ruby-ivar">@name</span>)
292
- <span class="ruby-keyword">end</span>
293
-
294
- <span class="ruby-ivar">@new</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">zero?</span>(<span class="ruby-ivar">@name</span>)
295
- <span class="ruby-ivar">@loaded</span> = <span class="ruby-keyword">false</span>
296
- <span class="ruby-keyword">end</span></pre>
297
- </div>
298
- </div>
299
-
300
-
301
- </div>
302
-
303
- </section>
304
-
305
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
306
- <header>
307
- <h3>Public Instance Methods</h3>
308
- </header>
309
-
310
- <div id="method-i-exist-3F" class="method-detail ">
311
- <div class="method-heading">
312
- <span class="method-name">exist?</span><span
313
- class="method-args">()</span>
314
- <span class="method-click-advice">click to toggle source</span>
315
- </div>
316
-
317
- <div class="method-description">
318
- <p>Does the file exist?</p>
319
-
320
- <p>@return [Boolean] true if exists</p>
321
-
322
- <div class="method-source-code" id="exist-3F-source">
323
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 130</span>
324
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">exist?</span>
325
- <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">name</span>)
326
- <span class="ruby-keyword">end</span></pre>
327
- </div>
328
- </div>
329
-
330
-
331
- </div>
332
-
333
- <div id="method-i-load" class="method-detail ">
334
- <div class="method-heading">
335
- <span class="method-name">load</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>Loads the file&#39;s contents. TODO clean up this method.</p>
342
-
343
- <p>@return [StandupMD::FileList]</p>
344
-
345
- <div class="method-source-code" id="load-source">
346
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 139</span>
347
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load</span>
348
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{name} does not exist.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">name</span>)
349
-
350
- <span class="ruby-identifier">entry_list</span> = <span class="ruby-constant">EntryList</span>.<span class="ruby-identifier">new</span>
351
- <span class="ruby-identifier">record</span> = {}
352
- <span class="ruby-identifier">section_type</span> = <span class="ruby-string">&#39;&#39;</span>
353
- <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">foreach</span>(<span class="ruby-identifier">name</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
354
- <span class="ruby-identifier">line</span>.<span class="ruby-identifier">chomp!</span>
355
- <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">empty?</span>
356
-
357
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">header?</span>(<span class="ruby-identifier">line</span>)
358
- <span class="ruby-keyword">unless</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">empty?</span>
359
- <span class="ruby-identifier">entry_list</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">new_entry</span>(<span class="ruby-identifier">record</span>)
360
- <span class="ruby-identifier">record</span> = {}
361
- <span class="ruby-keyword">end</span>
362
- <span class="ruby-identifier">record</span>[<span class="ruby-string">&#39;header&#39;</span>] = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/^\#{#{@config.header_depth}}\s*/</span>, <span class="ruby-string">&#39;&#39;</span>)
363
- <span class="ruby-identifier">section_type</span> = <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">notes_header</span>
364
- <span class="ruby-identifier">record</span>[<span class="ruby-identifier">section_type</span>] = []
365
- <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">sub_header?</span>(<span class="ruby-identifier">line</span>)
366
- <span class="ruby-identifier">section_type</span> = <span class="ruby-identifier">determine_section_type</span>(<span class="ruby-identifier">line</span>)
367
- <span class="ruby-identifier">record</span>[<span class="ruby-identifier">section_type</span>] = []
368
- <span class="ruby-keyword">else</span>
369
- <span class="ruby-identifier">record</span>[<span class="ruby-identifier">section_type</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-identifier">bullet_character_regex</span>, <span class="ruby-string">&#39;&#39;</span>)
370
- <span class="ruby-keyword">end</span>
371
- <span class="ruby-keyword">end</span>
372
- <span class="ruby-identifier">entry_list</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">new_entry</span>(<span class="ruby-identifier">record</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">empty?</span>
373
- <span class="ruby-ivar">@loaded</span> = <span class="ruby-keyword">true</span>
374
- <span class="ruby-ivar">@entries</span> = <span class="ruby-identifier">entry_list</span>.<span class="ruby-identifier">sort</span>
375
- <span class="ruby-keyword">self</span>
376
- <span class="ruby-keyword">rescue</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>
377
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File malformation: #{e}&quot;</span>
378
- <span class="ruby-keyword">end</span></pre>
379
- </div>
380
- </div>
381
-
382
-
383
- </div>
384
-
385
- <div id="method-i-loaded-3F" class="method-detail ">
386
- <div class="method-heading">
387
- <span class="method-name">loaded?</span><span
388
- class="method-args">()</span>
389
- <span class="method-click-advice">click to toggle source</span>
390
- </div>
391
-
392
- <div class="method-description">
393
- <p>Has the file been loaded?</p>
394
-
395
- <p>@return [Boolean] true if loaded</p>
396
-
397
- <div class="method-source-code" id="loaded-3F-source">
398
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 122</span>
399
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">loaded?</span>
400
- <span class="ruby-ivar">@loaded</span>
401
- <span class="ruby-keyword">end</span></pre>
402
- </div>
403
- </div>
404
-
405
-
406
- </div>
407
-
408
- <div id="method-i-new-3F" class="method-detail ">
409
- <div class="method-heading">
410
- <span class="method-name">new?</span><span
411
- class="method-args">()</span>
412
- <span class="method-click-advice">click to toggle source</span>
413
- </div>
414
-
415
- <div class="method-description">
416
- <p>Was the file just now created?</p>
417
-
418
- <p>@return [Boolean] true if new</p>
419
-
420
- <div class="method-source-code" id="new-3F-source">
421
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 114</span>
422
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new?</span>
423
- <span class="ruby-ivar">@new</span>
424
- <span class="ruby-keyword">end</span></pre>
425
- </div>
426
- </div>
427
-
428
-
429
- </div>
430
-
431
- <div id="method-i-write" class="method-detail ">
432
- <div class="method-heading">
433
- <span class="method-name">write</span><span
434
- class="method-args">(**dates)</span>
435
- <span class="method-click-advice">click to toggle source</span>
436
- </div>
437
-
438
- <div class="method-description">
439
- <p>Writes a new entry to the file if the first entry in the file isn&#39;t today. This method is destructive; if a file for entries in the date range already exists, it will be clobbered with the entries in the range.</p>
440
-
441
- <p>@param [Hash] {start_date: Date, end_date: Date}</p>
442
-
443
- <p>@return [Boolean] true if successful</p>
444
-
445
- <div class="method-source-code" id="write-source">
446
- <pre><span class="ruby-comment"># File lib/standup_md/file.rb, line 180</span>
447
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">dates</span>)
448
- <span class="ruby-identifier">sorted_entries</span> = <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">sort</span>
449
- <span class="ruby-identifier">start_date</span> = <span class="ruby-identifier">dates</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:start_date</span>, <span class="ruby-identifier">sorted_entries</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">date</span>)
450
- <span class="ruby-identifier">end_date</span> = <span class="ruby-identifier">dates</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:end_date</span>, <span class="ruby-identifier">sorted_entries</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">date</span>)
451
- <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">name</span>, <span class="ruby-string">&#39;w&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
452
- <span class="ruby-identifier">sorted_entries</span>.<span class="ruby-identifier">filter</span>(<span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>).<span class="ruby-identifier">sort_reverse</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
453
- <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">date</span>)
454
- <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">sub_header_order</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span>
455
- <span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">public_send</span>(<span class="ruby-identifier">attr</span>)
456
- <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">tasks</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">empty?</span>
457
-
458
- <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">sub_header</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">public_send</span>(<span class="ruby-node">&quot;#{attr}_header&quot;</span>).<span class="ruby-identifier">capitalize</span>)
459
- <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">bullet_character</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39; &#39;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">task</span> }
460
- <span class="ruby-keyword">end</span>
461
- <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span>
462
- <span class="ruby-keyword">end</span>
463
- <span class="ruby-keyword">end</span>
464
- <span class="ruby-keyword">true</span>
465
- <span class="ruby-keyword">end</span></pre>
466
- </div>
467
- </div>
468
-
469
-
470
- </div>
471
-
472
- </section>
473
-
474
- </section>
475
- </main>
476
-
477
-
478
- <footer id="validator-badges" role="contentinfo">
479
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
480
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
481
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
482
- </footer>
483
-