standup_md 0.3.10 → 0.3.14

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +2 -4
  5. data/Rakefile +1 -1
  6. data/lib/standup_md/cli/helpers.rb +3 -8
  7. data/lib/standup_md/config/cli.rb +3 -2
  8. data/lib/standup_md/config/entry_list.rb +0 -2
  9. data/lib/standup_md/config/file.rb +11 -15
  10. data/lib/standup_md/entry.rb +1 -1
  11. data/lib/standup_md/entry_list.rb +12 -6
  12. data/lib/standup_md/file/helpers.rb +7 -2
  13. data/lib/standup_md/version.rb +3 -1
  14. data/standup_md.gemspec +2 -2
  15. metadata +3 -60
  16. data/doc/README_md.html +0 -393
  17. data/doc/StandupMD/Cli/Helpers.html +0 -146
  18. data/doc/StandupMD/Cli.html +0 -406
  19. data/doc/StandupMD/Config/Cli.html +0 -296
  20. data/doc/StandupMD/Config/Entry.html +0 -240
  21. data/doc/StandupMD/Config/EntryList.html +0 -171
  22. data/doc/StandupMD/Config/File.html +0 -481
  23. data/doc/StandupMD/Config.html +0 -193
  24. data/doc/StandupMD/Entry.html +0 -367
  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/StandupMD.html +0 -238
  29. data/doc/created.rid +0 -15
  30. data/doc/css/fonts.css +0 -167
  31. data/doc/css/rdoc.css +0 -619
  32. data/doc/fonts/Lato-Light.ttf +0 -0
  33. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  34. data/doc/fonts/Lato-Regular.ttf +0 -0
  35. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  36. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  37. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  38. data/doc/images/add.png +0 -0
  39. data/doc/images/arrow_up.png +0 -0
  40. data/doc/images/brick.png +0 -0
  41. data/doc/images/brick_link.png +0 -0
  42. data/doc/images/bug.png +0 -0
  43. data/doc/images/bullet_black.png +0 -0
  44. data/doc/images/bullet_toggle_minus.png +0 -0
  45. data/doc/images/bullet_toggle_plus.png +0 -0
  46. data/doc/images/date.png +0 -0
  47. data/doc/images/delete.png +0 -0
  48. data/doc/images/find.png +0 -0
  49. data/doc/images/loadingAnimation.gif +0 -0
  50. data/doc/images/macFFBgHack.png +0 -0
  51. data/doc/images/package.png +0 -0
  52. data/doc/images/page_green.png +0 -0
  53. data/doc/images/page_white_text.png +0 -0
  54. data/doc/images/page_white_width.png +0 -0
  55. data/doc/images/plugin.png +0 -0
  56. data/doc/images/ruby.png +0 -0
  57. data/doc/images/tag_blue.png +0 -0
  58. data/doc/images/tag_green.png +0 -0
  59. data/doc/images/transparent.png +0 -0
  60. data/doc/images/wrench.png +0 -0
  61. data/doc/images/wrench_orange.png +0 -0
  62. data/doc/images/zoom.png +0 -0
  63. data/doc/index.html +0 -382
  64. data/doc/js/darkfish.js +0 -84
  65. data/doc/js/navigation.js +0 -105
  66. data/doc/js/navigation.js.gz +0 -0
  67. data/doc/js/search.js +0 -110
  68. data/doc/js/search_index.js +0 -1
  69. data/doc/js/search_index.js.gz +0 -0
  70. data/doc/js/searcher.js +0 -229
  71. data/doc/js/searcher.js.gz +0 -0
  72. data/doc/table_of_contents.html +0 -401
data/doc/StandupMD/Config/EntryList.html DELETED
@@ -1,171 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>class StandupMD::Config::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
-
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-i-initalize">#initalize</a>
76
- <li ><a href="#method-i-reset">#reset</a>
77
- </ul>
78
- </div>
79
-
80
- </div>
81
- </nav>
82
-
83
- <main role="main" aria-labelledby="class-StandupMD::Config::EntryList">
84
- <h1 id="class-StandupMD::Config::EntryList" class="class">
85
- class StandupMD::Config::EntryList
86
- </h1>
87
-
88
- <section class="description">
89
-
90
- <p>The configuration class for <a href="../EntryList.html"><code>StandupMD::EntryList</code></a></p>
91
-
92
- </section>
93
-
94
- <section id="5Buntitled-5D" class="documentation-section">
95
-
96
-
97
- <section class="constants-list">
98
- <header>
99
- <h3>Constants</h3>
100
- </header>
101
- <dl>
102
- <dt id="DEFAULTS">DEFAULTS
103
- <dd><p>The default options.</p>
104
-
105
- <p>@return [Hash]</p>
106
- </dl>
107
- </section>
108
-
109
-
110
-
111
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
112
- <header>
113
- <h3>Public Instance Methods</h3>
114
- </header>
115
-
116
- <div id="method-i-initalize" class="method-detail ">
117
- <div class="method-heading">
118
- <span class="method-name">initalize</span><span
119
- class="method-args">()</span>
120
- <span class="method-click-advice">click to toggle source</span>
121
- </div>
122
-
123
- <div class="method-description">
124
- <p>Initializes the config with default values.</p>
125
-
126
- <div class="method-source-code" id="initalize-source">
127
- <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 18</span>
128
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initalize</span>
129
- <span class="ruby-identifier">reset</span>
130
- <span class="ruby-keyword">end</span></pre>
131
- </div>
132
- </div>
133
-
134
-
135
- </div>
136
-
137
- <div id="method-i-reset" class="method-detail ">
138
- <div class="method-heading">
139
- <span class="method-name">reset</span><span
140
- class="method-args">()</span>
141
- <span class="method-click-advice">click to toggle source</span>
142
- </div>
143
-
144
- <div class="method-description">
145
- <p>Sets all config values back to their defaults.</p>
146
-
147
- <p>@return [Hash]</p>
148
-
149
- <div class="method-source-code" id="reset-source">
150
- <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 26</span>
151
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
152
- <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{k}&quot;</span>, <span class="ruby-identifier">v</span>) }
153
- <span class="ruby-keyword">end</span></pre>
154
- </div>
155
- </div>
156
-
157
-
158
- </div>
159
-
160
- </section>
161
-
162
- </section>
163
- </main>
164
-
165
-
166
- <footer id="validator-badges" role="contentinfo">
167
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
168
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
169
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
170
- </footer>
171
-
data/doc/StandupMD/Config/File.html DELETED
@@ -1,481 +0,0 @@
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
- <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-new">::new</a>
76
- <li ><a href="#method-i-bullet_character-3D">#bullet_character=</a>
77
- <li ><a href="#method-i-directory-3D">#directory=</a>
78
- <li ><a href="#method-i-header_depth-3D">#header_depth=</a>
79
- <li ><a href="#method-i-reset">#reset</a>
80
- <li ><a href="#method-i-sub_header_depth-3D">#sub_header_depth=</a>
81
- </ul>
82
- </div>
83
-
84
- </div>
85
- </nav>
86
-
87
- <main role="main" aria-labelledby="class-StandupMD::Config::File">
88
- <h1 id="class-StandupMD::Config::File" class="class">
89
- class StandupMD::Config::File
90
- </h1>
91
-
92
- <section class="description">
93
-
94
- <p>The configuration class for <a href="../File.html"><code>StandupMD::File</code></a></p>
95
-
96
- </section>
97
-
98
- <section id="5Buntitled-5D" class="documentation-section">
99
-
100
-
101
- <section class="constants-list">
102
- <header>
103
- <h3>Constants</h3>
104
- </header>
105
- <dl>
106
- <dt id="DEFAULTS">DEFAULTS
107
- <dd><p>The default options.</p>
108
-
109
- <p>@return [Hash]</p>
110
- </dl>
111
- </section>
112
-
113
- <section class="attribute-method-details" class="method-section">
114
- <header>
115
- <h3>Attributes</h3>
116
- </header>
117
-
118
- <div id="attribute-i-bullet_character" class="method-detail">
119
- <div class="method-heading attribute-method-heading">
120
- <span class="method-name">bullet_character</span><span
121
- class="attribute-access-type">[R]</span>
122
- </div>
123
-
124
- <div class="method-description">
125
- <p>Character used as bullets for list entries.</p>
126
-
127
- <p>@return [String] either - (dash) or * (asterisk)</p>
128
-
129
- <p>@default “-” (dash)</p>
130
- </div>
131
- </div>
132
- <div id="attribute-i-create" class="method-detail">
133
- <div class="method-heading attribute-method-heading">
134
- <span class="method-name">create</span><span
135
- class="attribute-access-type">[RW]</span>
136
- </div>
137
-
138
- <div class="method-description">
139
- <p>Should the file be created if it doesn&#39;t exist?</p>
140
-
141
- <p>@param [Boolean] create</p>
142
-
143
- <p>@return [boolean]</p>
144
- </div>
145
- </div>
146
- <div id="attribute-i-current_header" class="method-detail">
147
- <div class="method-heading attribute-method-heading">
148
- <span class="method-name">current_header</span><span
149
- class="attribute-access-type">[RW]</span>
150
- </div>
151
-
152
- <div class="method-description">
153
- <p>String to be used as “Current” header.</p>
154
-
155
- <p>@param [String] header</p>
156
-
157
- <p>@return [String]</p>
158
-
159
- <p>@default “Current”</p>
160
- </div>
161
- </div>
162
- <div id="attribute-i-directory" class="method-detail">
163
- <div class="method-heading attribute-method-heading">
164
- <span class="method-name">directory</span><span
165
- class="attribute-access-type">[R]</span>
166
- </div>
167
-
168
- <div class="method-description">
169
- <p>The directory in which the files are located.</p>
170
-
171
- <p>@return [String]</p>
172
-
173
- <p>@default “~/.cache/standup_md”</p>
174
- </div>
175
- </div>
176
- <div id="attribute-i-header_date_format" class="method-detail">
177
- <div class="method-heading attribute-method-heading">
178
- <span class="method-name">header_date_format</span><span
179
- class="attribute-access-type">[RW]</span>
180
- </div>
181
-
182
- <div class="method-description">
183
- <p>The date format for entry headers. Will be parsed by <code>strftime</code>.</p>
184
-
185
- <p>@param [String] format</p>
186
-
187
- <p>@return [String]</p>
188
- </div>
189
- </div>
190
- <div id="attribute-i-header_depth" class="method-detail">
191
- <div class="method-heading attribute-method-heading">
192
- <span class="method-name">header_depth</span><span
193
- class="attribute-access-type">[R]</span>
194
- </div>
195
-
196
- <div class="method-description">
197
- <p>Number of octothorps that should preface entry headers.</p>
198
-
199
- <p>@return [Integer] between 1 and 5</p>
200
-
201
- <p>@default 1</p>
202
- </div>
203
- </div>
204
- <div id="attribute-i-impediments_header" class="method-detail">
205
- <div class="method-heading attribute-method-heading">
206
- <span class="method-name">impediments_header</span><span
207
- class="attribute-access-type">[RW]</span>
208
- </div>
209
-
210
- <div class="method-description">
211
- <p>String to be used as “Impediments” header.</p>
212
-
213
- <p>@param [String] header</p>
214
-
215
- <p>@return [String]</p>
216
-
217
- <p>@default “Impediments”</p>
218
- </div>
219
- </div>
220
- <div id="attribute-i-name_format" class="method-detail">
221
- <div class="method-heading attribute-method-heading">
222
- <span class="method-name">name_format</span><span
223
- class="attribute-access-type">[RW]</span>
224
- </div>
225
-
226
- <div class="method-description">
227
- <p>Format to be used for standup file names. Should be parse-able by strftime, and should be a monthly date.</p>
228
-
229
- <p>@param [String] <a href="File.html#attribute-i-name_format"><code>name_format</code></a></p>
230
-
231
- <p>@return [String]</p>
232
-
233
- <p>@default “%Y_%m.md”</p>
234
- </div>
235
- </div>
236
- <div id="attribute-i-notes_header" class="method-detail">
237
- <div class="method-heading attribute-method-heading">
238
- <span class="method-name">notes_header</span><span
239
- class="attribute-access-type">[RW]</span>
240
- </div>
241
-
242
- <div class="method-description">
243
- <p>String to be used as “Notes” header.</p>
244
-
245
- <p>@param [String] header</p>
246
-
247
- <p>@return [String]</p>
248
-
249
- <p>@default “Notes”</p>
250
- </div>
251
- </div>
252
- <div id="attribute-i-previous_header" class="method-detail">
253
- <div class="method-heading attribute-method-heading">
254
- <span class="method-name">previous_header</span><span
255
- class="attribute-access-type">[RW]</span>
256
- </div>
257
-
258
- <div class="method-description">
259
- <p>String to be used as “Previous” header.</p>
260
-
261
- <p>@param [String] header</p>
262
-
263
- <p>@return [String]</p>
264
-
265
- <p>@default “Previous”</p>
266
- </div>
267
- </div>
268
- <div id="attribute-i-sub_header_depth" class="method-detail">
269
- <div class="method-heading attribute-method-heading">
270
- <span class="method-name">sub_header_depth</span><span
271
- class="attribute-access-type">[R]</span>
272
- </div>
273
-
274
- <div class="method-description">
275
- <p>Number of octothorps that should preface sub-headers.</p>
276
-
277
- <p>@return [Integer] between 2 and 6</p>
278
-
279
- <p>@default 2</p>
280
- </div>
281
- </div>
282
- <div id="attribute-i-sub_header_order" class="method-detail">
283
- <div class="method-heading attribute-method-heading">
284
- <span class="method-name">sub_header_order</span><span
285
- class="attribute-access-type">[RW]</span>
286
- </div>
287
-
288
- <div class="method-description">
289
- <p>Preferred order for sub-headers.</p>
290
-
291
- <p>@param [Array] <a href="File.html#attribute-i-sub_header_order"><code>sub_header_order</code></a></p>
292
-
293
- <p>@return [Array]</p>
294
-
295
- <p>@default %w[previous current impediment notes]</p>
296
- </div>
297
- </div>
298
- </section>
299
-
300
-
301
- <section id="public-class-5Buntitled-5D-method-details" class="method-section">
302
- <header>
303
- <h3>Public Class Methods</h3>
304
- </header>
305
-
306
- <div id="method-c-new" class="method-detail ">
307
- <div class="method-heading">
308
- <span class="method-name">new</span><span
309
- class="method-args">()</span>
310
- <span class="method-click-advice">click to toggle source</span>
311
- </div>
312
-
313
- <div class="method-description">
314
- <p>Initializes the config with default values.</p>
315
-
316
- <div class="method-source-code" id="new-source">
317
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 140</span>
318
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
319
- <span class="ruby-identifier">reset</span>
320
- <span class="ruby-keyword">end</span></pre>
321
- </div>
322
- </div>
323
-
324
-
325
- </div>
326
-
327
- </section>
328
-
329
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
330
- <header>
331
- <h3>Public Instance Methods</h3>
332
- </header>
333
-
334
- <div id="method-i-bullet_character-3D" class="method-detail ">
335
- <div class="method-heading">
336
- <span class="method-name">bullet_character=</span><span
337
- class="method-args">(char)</span>
338
- <span class="method-click-advice">click to toggle source</span>
339
- </div>
340
-
341
- <div class="method-description">
342
- <p>Setter for bullet_character. Must be * (asterisk) or - (dash).</p>
343
-
344
- <p>@param [String] character</p>
345
-
346
- <p>@return [String]</p>
347
-
348
- <div class="method-source-code" id="bullet_character-3D-source">
349
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 189</span>
350
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bullet_character=</span>(<span class="ruby-identifier">char</span>)
351
- <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Must be &quot;-&quot; or &quot;*&quot;&#39;</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>)
352
- <span class="ruby-ivar">@bullet_character</span> = <span class="ruby-identifier">char</span>
353
- <span class="ruby-keyword">end</span></pre>
354
- </div>
355
- </div>
356
-
357
-
358
- </div>
359
-
360
- <div id="method-i-directory-3D" class="method-detail ">
361
- <div class="method-heading">
362
- <span class="method-name">directory=</span><span
363
- class="method-args">(directory)</span>
364
- <span class="method-click-advice">click to toggle source</span>
365
- </div>
366
-
367
- <div class="method-description">
368
- <p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn&#39;t exist, it will be created. To reset instance variables after changing the directory, you&#39;ll need to call load.</p>
369
-
370
- <p>@param [String] directory</p>
371
-
372
- <p>@return [String]</p>
373
-
374
- <div class="method-source-code" id="directory-3D-source">
375
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 202</span>
376
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">directory=</span>(<span class="ruby-identifier">directory</span>)
377
- <span class="ruby-ivar">@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>).<span class="ruby-identifier">tap</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">directory</span><span class="ruby-operator">|</span>
378
- <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>)
379
- <span class="ruby-keyword">end</span>
380
- <span class="ruby-keyword">end</span></pre>
381
- </div>
382
- </div>
383
-
384
-
385
- </div>
386
-
387
- <div id="method-i-header_depth-3D" class="method-detail ">
388
- <div class="method-heading">
389
- <span class="method-name">header_depth=</span><span
390
- class="method-args">(depth)</span>
391
- <span class="method-click-advice">click to toggle source</span>
392
- </div>
393
-
394
- <div class="method-description">
395
- <p>Number of octothorps (#) to use before the main header.</p>
396
-
397
- <p>@param [Integer] depth</p>
398
-
399
- <p>@return [Integer]</p>
400
-
401
- <div class="method-source-code" id="header_depth-3D-source">
402
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 158</span>
403
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">header_depth=</span>(<span class="ruby-identifier">depth</span>)
404
- <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>)
405
- <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Header depth out of bounds (1..5)&#39;</span>
406
- <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">depth</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-identifier">sub_header_depth</span>
407
- <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>
408
- <span class="ruby-keyword">end</span>
409
- <span class="ruby-ivar">@header_depth</span> = <span class="ruby-identifier">depth</span>
410
- <span class="ruby-keyword">end</span></pre>
411
- </div>
412
- </div>
413
-
414
-
415
- </div>
416
-
417
- <div id="method-i-reset" class="method-detail ">
418
- <div class="method-heading">
419
- <span class="method-name">reset</span><span
420
- class="method-args">()</span>
421
- <span class="method-click-advice">click to toggle source</span>
422
- </div>
423
-
424
- <div class="method-description">
425
- <p>Sets all config values back to their defaults.</p>
426
-
427
- <p>@return [Hash]</p>
428
-
429
- <div class="method-source-code" id="reset-source">
430
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 148</span>
431
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
432
- <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{k}&quot;</span>, <span class="ruby-identifier">v</span>) }
433
- <span class="ruby-keyword">end</span></pre>
434
- </div>
435
- </div>
436
-
437
-
438
- </div>
439
-
440
- <div id="method-i-sub_header_depth-3D" class="method-detail ">
441
- <div class="method-heading">
442
- <span class="method-name">sub_header_depth=</span><span
443
- class="method-args">(depth)</span>
444
- <span class="method-click-advice">click to toggle source</span>
445
- </div>
446
-
447
- <div class="method-description">
448
- <p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).</p>
449
-
450
- <p>@param [Integer] depth</p>
451
-
452
- <p>@return [Integer]</p>
453
-
454
- <div class="method-source-code" id="sub_header_depth-3D-source">
455
- <pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 174</span>
456
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_depth=</span>(<span class="ruby-identifier">depth</span>)
457
- <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>)
458
- <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;Sub-header depth out of bounds (2..6)&#39;</span>
459
- <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">depth</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">header_depth</span>
460
- <span class="ruby-ivar">@header_depth</span> = <span class="ruby-identifier">depth</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
461
- <span class="ruby-keyword">end</span>
462
- <span class="ruby-ivar">@sub_header_depth</span> = <span class="ruby-identifier">depth</span>
463
- <span class="ruby-keyword">end</span></pre>
464
- </div>
465
- </div>
466
-
467
-
468
- </div>
469
-
470
- </section>
471
-
472
- </section>
473
- </main>
474
-
475
-
476
- <footer id="validator-badges" role="contentinfo">
477
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
478
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
479
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
480
- </footer>
481
-