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