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