standup_md 0.2.1 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- 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,609 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class StandupMD::Config::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
|
+
|
|
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
|
+
|
|
71
|
+
|
|
72
|
+
<!-- Method Quickref -->
|
|
73
|
+
<div id="method-list-section" class="nav-section">
|
|
74
|
+
<h3>Methods</h3>
|
|
75
|
+
|
|
76
|
+
<ul class="link-list" role="directory">
|
|
77
|
+
|
|
78
|
+
<li ><a href="#method-c-new">::new</a>
|
|
79
|
+
|
|
80
|
+
<li ><a href="#method-i-bullet_character-3D">#bullet_character=</a>
|
|
81
|
+
|
|
82
|
+
<li ><a href="#method-i-directory-3D">#directory=</a>
|
|
83
|
+
|
|
84
|
+
<li ><a href="#method-i-header_depth-3D">#header_depth=</a>
|
|
85
|
+
|
|
86
|
+
<li ><a href="#method-i-reset_values">#reset_values</a>
|
|
87
|
+
|
|
88
|
+
<li ><a href="#method-i-sub_header_depth-3D">#sub_header_depth=</a>
|
|
89
|
+
|
|
90
|
+
</ul>
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
</div>
|
|
94
|
+
</nav>
|
|
95
|
+
|
|
96
|
+
<main role="main" aria-labelledby="class-StandupMD::Config::File">
|
|
97
|
+
<h1 id="class-StandupMD::Config::File" class="class">
|
|
98
|
+
class StandupMD::Config::File
|
|
99
|
+
</h1>
|
|
100
|
+
|
|
101
|
+
<section class="description">
|
|
102
|
+
|
|
103
|
+
<p>The configuration class for <a href="../File.html"><code>StandupMD::File</code></a></p>
|
|
104
|
+
|
|
105
|
+
</section>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<section class="attribute-method-details" class="method-section">
|
|
117
|
+
<header>
|
|
118
|
+
<h3>Attributes</h3>
|
|
119
|
+
</header>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<div id="attribute-i-bullet_character" class="method-detail">
|
|
123
|
+
<div class="method-heading attribute-method-heading">
|
|
124
|
+
<span class="method-name">bullet_character</span><span
|
|
125
|
+
class="attribute-access-type">[R]</span>
|
|
126
|
+
</div>
|
|
127
|
+
|
|
128
|
+
<div class="method-description">
|
|
129
|
+
|
|
130
|
+
<p>Character used as bullets for list entries.</p>
|
|
131
|
+
|
|
132
|
+
<p>@return [String] either - (dash) or * (asterisk)</p>
|
|
133
|
+
|
|
134
|
+
<p>@default “-” (dash)</p>
|
|
135
|
+
|
|
136
|
+
</div>
|
|
137
|
+
</div>
|
|
138
|
+
|
|
139
|
+
<div id="attribute-i-create" class="method-detail">
|
|
140
|
+
<div class="method-heading attribute-method-heading">
|
|
141
|
+
<span class="method-name">create</span><span
|
|
142
|
+
class="attribute-access-type">[RW]</span>
|
|
143
|
+
</div>
|
|
144
|
+
|
|
145
|
+
<div class="method-description">
|
|
146
|
+
|
|
147
|
+
<p>Should the file be created if it doesn't exist?</p>
|
|
148
|
+
|
|
149
|
+
<p>@param [Boolean] create</p>
|
|
150
|
+
|
|
151
|
+
<p>@return [boolean]</p>
|
|
152
|
+
|
|
153
|
+
</div>
|
|
154
|
+
</div>
|
|
155
|
+
|
|
156
|
+
<div id="attribute-i-current_header" class="method-detail">
|
|
157
|
+
<div class="method-heading attribute-method-heading">
|
|
158
|
+
<span class="method-name">current_header</span><span
|
|
159
|
+
class="attribute-access-type">[RW]</span>
|
|
160
|
+
</div>
|
|
161
|
+
|
|
162
|
+
<div class="method-description">
|
|
163
|
+
|
|
164
|
+
<p>String to be used as “Current” header.</p>
|
|
165
|
+
|
|
166
|
+
<p>@param [String] header</p>
|
|
167
|
+
|
|
168
|
+
<p>@return [String]</p>
|
|
169
|
+
|
|
170
|
+
<p>@default “Current”</p>
|
|
171
|
+
|
|
172
|
+
</div>
|
|
173
|
+
</div>
|
|
174
|
+
|
|
175
|
+
<div id="attribute-i-directory" class="method-detail">
|
|
176
|
+
<div class="method-heading attribute-method-heading">
|
|
177
|
+
<span class="method-name">directory</span><span
|
|
178
|
+
class="attribute-access-type">[R]</span>
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
<div class="method-description">
|
|
182
|
+
|
|
183
|
+
<p>The directory in which the files are located.</p>
|
|
184
|
+
|
|
185
|
+
<p>@return [String]</p>
|
|
186
|
+
|
|
187
|
+
<p>@default “~/.cache/standup_md”</p>
|
|
188
|
+
|
|
189
|
+
</div>
|
|
190
|
+
</div>
|
|
191
|
+
|
|
192
|
+
<div id="attribute-i-header_date_format" class="method-detail">
|
|
193
|
+
<div class="method-heading attribute-method-heading">
|
|
194
|
+
<span class="method-name">header_date_format</span><span
|
|
195
|
+
class="attribute-access-type">[RW]</span>
|
|
196
|
+
</div>
|
|
197
|
+
|
|
198
|
+
<div class="method-description">
|
|
199
|
+
|
|
200
|
+
<p>The date format for entry headers. Will be parsed by <code>strftime</code>.</p>
|
|
201
|
+
|
|
202
|
+
<p>@param [String] format</p>
|
|
203
|
+
|
|
204
|
+
<p>@return [String]</p>
|
|
205
|
+
|
|
206
|
+
</div>
|
|
207
|
+
</div>
|
|
208
|
+
|
|
209
|
+
<div id="attribute-i-header_depth" class="method-detail">
|
|
210
|
+
<div class="method-heading attribute-method-heading">
|
|
211
|
+
<span class="method-name">header_depth</span><span
|
|
212
|
+
class="attribute-access-type">[R]</span>
|
|
213
|
+
</div>
|
|
214
|
+
|
|
215
|
+
<div class="method-description">
|
|
216
|
+
|
|
217
|
+
<p>Number of octothorps that should preface entry headers.</p>
|
|
218
|
+
|
|
219
|
+
<p>@return [Integer] between 1 and 5</p>
|
|
220
|
+
|
|
221
|
+
<p>@default 1</p>
|
|
222
|
+
|
|
223
|
+
</div>
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
<div id="attribute-i-impediments_header" class="method-detail">
|
|
227
|
+
<div class="method-heading attribute-method-heading">
|
|
228
|
+
<span class="method-name">impediments_header</span><span
|
|
229
|
+
class="attribute-access-type">[RW]</span>
|
|
230
|
+
</div>
|
|
231
|
+
|
|
232
|
+
<div class="method-description">
|
|
233
|
+
|
|
234
|
+
<p>String to be used as “Impediments” header.</p>
|
|
235
|
+
|
|
236
|
+
<p>@param [String] header</p>
|
|
237
|
+
|
|
238
|
+
<p>@return [String]</p>
|
|
239
|
+
|
|
240
|
+
<p>@default “Impediments”</p>
|
|
241
|
+
|
|
242
|
+
</div>
|
|
243
|
+
</div>
|
|
244
|
+
|
|
245
|
+
<div id="attribute-i-name_format" class="method-detail">
|
|
246
|
+
<div class="method-heading attribute-method-heading">
|
|
247
|
+
<span class="method-name">name_format</span><span
|
|
248
|
+
class="attribute-access-type">[RW]</span>
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
<div class="method-description">
|
|
252
|
+
|
|
253
|
+
<p>Format to be used for standup file names. Should be parse-able by strftime, and should be a monthly date.</p>
|
|
254
|
+
|
|
255
|
+
<p>@param [String] <a href="File.html#attribute-i-name_format"><code>name_format</code></a></p>
|
|
256
|
+
|
|
257
|
+
<p>@return [String]</p>
|
|
258
|
+
|
|
259
|
+
<p>@default “%Y_%m.md”</p>
|
|
260
|
+
|
|
261
|
+
</div>
|
|
262
|
+
</div>
|
|
263
|
+
|
|
264
|
+
<div id="attribute-i-notes_header" class="method-detail">
|
|
265
|
+
<div class="method-heading attribute-method-heading">
|
|
266
|
+
<span class="method-name">notes_header</span><span
|
|
267
|
+
class="attribute-access-type">[RW]</span>
|
|
268
|
+
</div>
|
|
269
|
+
|
|
270
|
+
<div class="method-description">
|
|
271
|
+
|
|
272
|
+
<p>String to be used as “Notes” header.</p>
|
|
273
|
+
|
|
274
|
+
<p>@param [String] header</p>
|
|
275
|
+
|
|
276
|
+
<p>@return [String]</p>
|
|
277
|
+
|
|
278
|
+
<p>@default “Notes”</p>
|
|
279
|
+
|
|
280
|
+
</div>
|
|
281
|
+
</div>
|
|
282
|
+
|
|
283
|
+
<div id="attribute-i-previous_header" class="method-detail">
|
|
284
|
+
<div class="method-heading attribute-method-heading">
|
|
285
|
+
<span class="method-name">previous_header</span><span
|
|
286
|
+
class="attribute-access-type">[RW]</span>
|
|
287
|
+
</div>
|
|
288
|
+
|
|
289
|
+
<div class="method-description">
|
|
290
|
+
|
|
291
|
+
<p>String to be used as “Previous” header.</p>
|
|
292
|
+
|
|
293
|
+
<p>@param [String] header</p>
|
|
294
|
+
|
|
295
|
+
<p>@return [String]</p>
|
|
296
|
+
|
|
297
|
+
<p>@default “Previous”</p>
|
|
298
|
+
|
|
299
|
+
</div>
|
|
300
|
+
</div>
|
|
301
|
+
|
|
302
|
+
<div id="attribute-i-sub_header_depth" class="method-detail">
|
|
303
|
+
<div class="method-heading attribute-method-heading">
|
|
304
|
+
<span class="method-name">sub_header_depth</span><span
|
|
305
|
+
class="attribute-access-type">[R]</span>
|
|
306
|
+
</div>
|
|
307
|
+
|
|
308
|
+
<div class="method-description">
|
|
309
|
+
|
|
310
|
+
<p>Number of octothorps that should preface sub-headers.</p>
|
|
311
|
+
|
|
312
|
+
<p>@return [Integer] between 2 and 6</p>
|
|
313
|
+
|
|
314
|
+
<p>@default 2</p>
|
|
315
|
+
|
|
316
|
+
</div>
|
|
317
|
+
</div>
|
|
318
|
+
|
|
319
|
+
<div id="attribute-i-sub_header_order" class="method-detail">
|
|
320
|
+
<div class="method-heading attribute-method-heading">
|
|
321
|
+
<span class="method-name">sub_header_order</span><span
|
|
322
|
+
class="attribute-access-type">[RW]</span>
|
|
323
|
+
</div>
|
|
324
|
+
|
|
325
|
+
<div class="method-description">
|
|
326
|
+
|
|
327
|
+
<p>Preferred order for sub-headers.</p>
|
|
328
|
+
|
|
329
|
+
<p>@param [Array] <a href="File.html#attribute-i-sub_header_order"><code>sub_header_order</code></a></p>
|
|
330
|
+
|
|
331
|
+
<p>@return [Array]</p>
|
|
332
|
+
|
|
333
|
+
<p>@default %w[previous current impediment notes]</p>
|
|
334
|
+
|
|
335
|
+
</div>
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
</section>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
343
|
+
<header>
|
|
344
|
+
<h3>Public Class Methods</h3>
|
|
345
|
+
</header>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<div id="method-c-new" class="method-detail ">
|
|
349
|
+
|
|
350
|
+
<div class="method-heading">
|
|
351
|
+
<span class="method-name">new</span><span
|
|
352
|
+
class="method-args">()</span>
|
|
353
|
+
|
|
354
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
355
|
+
|
|
356
|
+
</div>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
<div class="method-description">
|
|
360
|
+
|
|
361
|
+
<p>Initializes the config with default values.</p>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<div class="method-source-code" id="new-source">
|
|
367
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 118</span>
|
|
368
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
|
|
369
|
+
<span class="ruby-identifier">reset_values</span>
|
|
370
|
+
<span class="ruby-keyword">end</span></pre>
|
|
371
|
+
</div>
|
|
372
|
+
|
|
373
|
+
</div>
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</div>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
</section>
|
|
382
|
+
|
|
383
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
384
|
+
<header>
|
|
385
|
+
<h3>Public Instance Methods</h3>
|
|
386
|
+
</header>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
<div id="method-i-bullet_character-3D" class="method-detail ">
|
|
390
|
+
|
|
391
|
+
<div class="method-heading">
|
|
392
|
+
<span class="method-name">bullet_character=</span><span
|
|
393
|
+
class="method-args">(char)</span>
|
|
394
|
+
|
|
395
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
396
|
+
|
|
397
|
+
</div>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<div class="method-description">
|
|
401
|
+
|
|
402
|
+
<p>Setter for bullet_character. Must be * (asterisk) or - (dash).</p>
|
|
403
|
+
|
|
404
|
+
<p>@param [String] character</p>
|
|
405
|
+
|
|
406
|
+
<p>@return [String]</p>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
<div class="method-source-code" id="bullet_character-3D-source">
|
|
412
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 179</span>
|
|
413
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bullet_character=</span>(<span class="ruby-identifier">char</span>)
|
|
414
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Must be "-" or "*"'</span> <span class="ruby-keyword">unless</span> <span class="ruby-node">%w[- *]</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">char</span>)
|
|
415
|
+
<span class="ruby-ivar">@bullet_character</span> = <span class="ruby-identifier">char</span>
|
|
416
|
+
<span class="ruby-keyword">end</span></pre>
|
|
417
|
+
</div>
|
|
418
|
+
|
|
419
|
+
</div>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
</div>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
<div id="method-i-directory-3D" class="method-detail ">
|
|
428
|
+
|
|
429
|
+
<div class="method-heading">
|
|
430
|
+
<span class="method-name">directory=</span><span
|
|
431
|
+
class="method-args">(directory)</span>
|
|
432
|
+
|
|
433
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
434
|
+
|
|
435
|
+
</div>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
<div class="method-description">
|
|
439
|
+
|
|
440
|
+
<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't exist, it will be created. To reset instance variables after changing the directory, you'll need to call load.</p>
|
|
441
|
+
|
|
442
|
+
<p>@param [String] directory</p>
|
|
443
|
+
|
|
444
|
+
<p>@return [String]</p>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
<div class="method-source-code" id="directory-3D-source">
|
|
450
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 192</span>
|
|
451
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">directory=</span>(<span class="ruby-identifier">directory</span>)
|
|
452
|
+
<span class="ruby-identifier">directory</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">directory</span>)
|
|
453
|
+
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">directory</span>) <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">directory</span>)
|
|
454
|
+
<span class="ruby-ivar">@directory</span> = <span class="ruby-identifier">directory</span>
|
|
455
|
+
<span class="ruby-keyword">end</span></pre>
|
|
456
|
+
</div>
|
|
457
|
+
|
|
458
|
+
</div>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
</div>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<div id="method-i-header_depth-3D" class="method-detail ">
|
|
467
|
+
|
|
468
|
+
<div class="method-heading">
|
|
469
|
+
<span class="method-name">header_depth=</span><span
|
|
470
|
+
class="method-args">(depth)</span>
|
|
471
|
+
|
|
472
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
473
|
+
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
<div class="method-description">
|
|
478
|
+
|
|
479
|
+
<p>Number of octothorps (#) to use before the main header.</p>
|
|
480
|
+
|
|
481
|
+
<p>@param [Integer] depth</p>
|
|
482
|
+
|
|
483
|
+
<p>@return [Integer]</p>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<div class="method-source-code" id="header_depth-3D-source">
|
|
489
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 148</span>
|
|
490
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">header_depth=</span>(<span class="ruby-identifier">depth</span>)
|
|
491
|
+
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">depth</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-value">1</span>, <span class="ruby-value">5</span>)
|
|
492
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Header depth out of bounds (1..5)'</span>
|
|
493
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">depth</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">sub_header_depth</span>
|
|
494
|
+
<span class="ruby-ivar">@sub_header_depth</span> = <span class="ruby-identifier">depth</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
|
|
495
|
+
<span class="ruby-keyword">end</span>
|
|
496
|
+
<span class="ruby-ivar">@header_depth</span> = <span class="ruby-identifier">depth</span>
|
|
497
|
+
<span class="ruby-keyword">end</span></pre>
|
|
498
|
+
</div>
|
|
499
|
+
|
|
500
|
+
</div>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
</div>
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
<div id="method-i-reset_values" class="method-detail ">
|
|
509
|
+
|
|
510
|
+
<div class="method-heading">
|
|
511
|
+
<span class="method-name">reset_values</span><span
|
|
512
|
+
class="method-args">()</span>
|
|
513
|
+
|
|
514
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
515
|
+
|
|
516
|
+
</div>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
<div class="method-description">
|
|
520
|
+
|
|
521
|
+
<p>Sets all config values back to their defaults.</p>
|
|
522
|
+
|
|
523
|
+
<p>@return [Boolean] true if successful</p>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
<div class="method-source-code" id="reset_values-source">
|
|
529
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 126</span>
|
|
530
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
|
|
531
|
+
<span class="ruby-ivar">@header_date_format</span> = <span class="ruby-string">'%Y-%m-%d'</span>
|
|
532
|
+
<span class="ruby-ivar">@header_depth</span> = <span class="ruby-value">1</span>
|
|
533
|
+
<span class="ruby-ivar">@sub_header_depth</span> = <span class="ruby-value">2</span>
|
|
534
|
+
<span class="ruby-ivar">@current_header</span> = <span class="ruby-string">'Current'</span>
|
|
535
|
+
<span class="ruby-ivar">@previous_header</span> = <span class="ruby-string">'Previous'</span>
|
|
536
|
+
<span class="ruby-ivar">@impediments_header</span> = <span class="ruby-string">'Impediments'</span>
|
|
537
|
+
<span class="ruby-ivar">@notes_header</span> = <span class="ruby-string">'Notes'</span>
|
|
538
|
+
<span class="ruby-ivar">@sub_header_order</span> = <span class="ruby-node">%w[previous current impediments notes]</span>
|
|
539
|
+
<span class="ruby-ivar">@directory</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">'HOME'</span>], <span class="ruby-string">'.cache'</span>, <span class="ruby-string">'standup_md'</span>)
|
|
540
|
+
<span class="ruby-ivar">@bullet_character</span> = <span class="ruby-string">'-'</span>
|
|
541
|
+
<span class="ruby-ivar">@name_format</span> = <span class="ruby-string">'%Y_%m.md'</span>
|
|
542
|
+
<span class="ruby-ivar">@create</span> = <span class="ruby-keyword">true</span>
|
|
543
|
+
<span class="ruby-keyword">true</span>
|
|
544
|
+
<span class="ruby-keyword">end</span></pre>
|
|
545
|
+
</div>
|
|
546
|
+
|
|
547
|
+
</div>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
</div>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
<div id="method-i-sub_header_depth-3D" class="method-detail ">
|
|
556
|
+
|
|
557
|
+
<div class="method-heading">
|
|
558
|
+
<span class="method-name">sub_header_depth=</span><span
|
|
559
|
+
class="method-args">(depth)</span>
|
|
560
|
+
|
|
561
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
562
|
+
|
|
563
|
+
</div>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<div class="method-description">
|
|
567
|
+
|
|
568
|
+
<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).</p>
|
|
569
|
+
|
|
570
|
+
<p>@param [Integer] depth</p>
|
|
571
|
+
|
|
572
|
+
<p>@return [Integer]</p>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
<div class="method-source-code" id="sub_header_depth-3D-source">
|
|
578
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 164</span>
|
|
579
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_depth=</span>(<span class="ruby-identifier">depth</span>)
|
|
580
|
+
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">depth</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-value">2</span>, <span class="ruby-value">6</span>)
|
|
581
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Sub-header depth out of bounds (2..6)'</span>
|
|
582
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">depth</span> <span class="ruby-operator"><=</span> <span class="ruby-identifier">header_depth</span>
|
|
583
|
+
<span class="ruby-ivar">@header_depth</span> = <span class="ruby-identifier">depth</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
|
|
584
|
+
<span class="ruby-keyword">end</span>
|
|
585
|
+
<span class="ruby-ivar">@sub_header_depth</span> = <span class="ruby-identifier">depth</span>
|
|
586
|
+
<span class="ruby-keyword">end</span></pre>
|
|
587
|
+
</div>
|
|
588
|
+
|
|
589
|
+
</div>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
</div>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
</section>
|
|
598
|
+
|
|
599
|
+
</section>
|
|
600
|
+
|
|
601
|
+
</main>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
<footer id="validator-badges" role="contentinfo">
|
|
605
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
606
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
|
|
607
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
608
|
+
</footer>
|
|
609
|
+
|