standup_md 0.3.6 → 0.3.11

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.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +9 -20
  4. data/doc/README_md.html +9 -22
  5. data/doc/StandupMD.html +14 -85
  6. data/doc/StandupMD/Cli.html +17 -159
  7. data/doc/StandupMD/Cli/Helpers.html +5 -27
  8. data/doc/StandupMD/Config.html +7 -44
  9. data/doc/StandupMD/Config/Cli.html +8 -76
  10. data/doc/StandupMD/Config/Entry.html +8 -64
  11. data/doc/StandupMD/Config/EntryList.html +7 -48
  12. data/doc/StandupMD/Config/File.html +11 -143
  13. data/doc/StandupMD/Entry.html +22 -133
  14. data/doc/StandupMD/EntryList.html +16 -198
  15. data/doc/StandupMD/File.html +31 -165
  16. data/doc/StandupMD/Version.html +63 -40
  17. data/doc/created.rid +9 -9
  18. data/doc/css/rdoc.css +1 -1
  19. data/doc/index.html +9 -36
  20. data/doc/js/navigation.js.gz +0 -0
  21. data/doc/js/search_index.js +1 -1
  22. data/doc/js/search_index.js.gz +0 -0
  23. data/doc/js/searcher.js.gz +0 -0
  24. data/doc/table_of_contents.html +42 -94
  25. data/lib/standup_md.rb +8 -5
  26. data/lib/standup_md/cli.rb +7 -7
  27. data/lib/standup_md/cli/helpers.rb +10 -13
  28. data/lib/standup_md/config/file.rb +3 -3
  29. data/lib/standup_md/entry.rb +7 -9
  30. data/lib/standup_md/entry_list.rb +2 -2
  31. data/lib/standup_md/version.rb +26 -4
  32. metadata +2 -2
data/doc/StandupMD/Cli/Helpers.html CHANGED
@@ -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="module">
27
25
  <nav role="navigation">
28
26
  <div id="project-navigation">
@@ -62,14 +60,13 @@
62
60
 
63
61
 
64
62
 
65
- <!-- Method Quickref -->
63
+
64
+ <!-- Method Quickref -->
66
65
  <div id="method-list-section" class="nav-section">
67
66
  <h3>Methods</h3>
68
67
 
69
68
  <ul class="link-list" role="directory">
70
-
71
69
  <li ><a href="#method-i-print">#print</a>
72
-
73
70
  </ul>
74
71
  </div>
75
72
 
@@ -87,45 +84,31 @@
87
84
 
88
85
  </section>
89
86
 
90
-
91
87
  <section id="5Buntitled-5D" class="documentation-section">
92
-
93
88
 
94
-
95
89
 
96
-
97
90
 
98
-
99
91
 
100
-
92
+
101
93
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
102
94
  <header>
103
95
  <h3>Public Instance Methods</h3>
104
96
  </header>
105
97
 
106
-
107
98
  <div id="method-i-print" class="method-detail ">
108
-
109
99
  <div class="method-heading">
110
100
  <span class="method-name">print</span><span
111
101
  class="method-args">(entry)</span>
112
-
113
102
  <span class="method-click-advice">click to toggle source</span>
114
-
115
103
  </div>
116
-
117
104
 
118
105
  <div class="method-description">
119
-
120
106
  <p>Print an entry to the command line.</p>
121
107
 
122
108
  <p>@param [StandupMD::Entry] entry</p>
123
109
 
124
110
  <p>@return [nil]</p>
125
-
126
-
127
111
 
128
-
129
112
  <div class="method-source-code" id="print-source">
130
113
  <pre><span class="ruby-comment"># File lib/standup_md/cli/helpers.rb, line 14</span>
131
114
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print</span>(<span class="ruby-identifier">entry</span>)
@@ -144,25 +127,20 @@
144
127
  <span class="ruby-identifier">puts</span>
145
128
  <span class="ruby-keyword">end</span></pre>
146
129
  </div>
147
-
148
130
  </div>
149
131
 
150
-
151
132
 
152
-
153
133
  </div>
154
134
 
155
-
156
135
  </section>
157
-
158
- </section>
159
136
 
137
+ </section>
160
138
  </main>
161
139
 
162
140
 
163
141
  <footer id="validator-badges" role="contentinfo">
164
142
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
165
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
143
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
166
144
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
167
145
  </footer>
168
146
 
data/doc/StandupMD/Config.html CHANGED
@@ -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,24 +57,22 @@
59
57
 
60
58
  <div id="class-metadata">
61
59
 
62
- <div id="parent-class-section" class="nav-section">
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
- <!-- Method Quickref -->
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
  </ul>
81
77
  </div>
82
78
 
@@ -94,21 +90,15 @@
94
90
 
95
91
  </section>
96
92
 
97
-
98
93
  <section id="5Buntitled-5D" class="documentation-section">
99
-
100
94
 
101
-
102
95
 
103
-
104
96
 
105
-
106
97
  <section class="attribute-method-details" class="method-section">
107
98
  <header>
108
99
  <h3>Attributes</h3>
109
100
  </header>
110
101
 
111
-
112
102
  <div id="attribute-i-cli" class="method-detail">
113
103
  <div class="method-heading attribute-method-heading">
114
104
  <span class="method-name">cli</span><span
@@ -116,14 +106,11 @@
116
106
  </div>
117
107
 
118
108
  <div class="method-description">
119
-
120
109
  <p>Reader for <a href="Config/Cli.html"><code>Cli</code></a> config.</p>
121
110
 
122
111
  <p>@return [StandupMD::Config::Cli]</p>
123
-
124
112
  </div>
125
113
  </div>
126
-
127
114
  <div id="attribute-i-entry" class="method-detail">
128
115
  <div class="method-heading attribute-method-heading">
129
116
  <span class="method-name">entry</span><span
@@ -131,14 +118,11 @@
131
118
  </div>
132
119
 
133
120
  <div class="method-description">
134
-
135
121
  <p>Reader for <a href="Config/Entry.html"><code>Entry</code></a> config.</p>
136
122
 
137
123
  <p>@return [StandupMD::Config::Entry]</p>
138
-
139
124
  </div>
140
125
  </div>
141
-
142
126
  <div id="attribute-i-entry_list" class="method-detail">
143
127
  <div class="method-heading attribute-method-heading">
144
128
  <span class="method-name">entry_list</span><span
@@ -146,14 +130,11 @@
146
130
  </div>
147
131
 
148
132
  <div class="method-description">
149
-
150
133
  <p>Reader for <a href="Config/EntryList.html"><code>EntryList</code></a> config.</p>
151
134
 
152
135
  <p>@return [StandupMD::Config::EntryList]</p>
153
-
154
136
  </div>
155
137
  </div>
156
-
157
138
  <div id="attribute-i-file" class="method-detail">
158
139
  <div class="method-heading attribute-method-heading">
159
140
  <span class="method-name">file</span><span
@@ -161,42 +142,29 @@
161
142
  </div>
162
143
 
163
144
  <div class="method-description">
164
-
165
145
  <p>Reader for <a href="Config/File.html"><code>File</code></a> config.</p>
166
146
 
167
147
  <p>@return [StandupMD::Config::File]</p>
168
-
169
148
  </div>
170
149
  </div>
171
-
172
150
  </section>
173
-
174
151
 
175
-
152
+
176
153
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
177
154
  <header>
178
155
  <h3>Public Class Methods</h3>
179
156
  </header>
180
157
 
181
-
182
158
  <div id="method-c-new" class="method-detail ">
183
-
184
159
  <div class="method-heading">
185
160
  <span class="method-name">new</span><span
186
161
  class="method-args">()</span>
187
-
188
162
  <span class="method-click-advice">click to toggle source</span>
189
-
190
163
  </div>
191
-
192
164
 
193
165
  <div class="method-description">
194
-
195
166
  <p>Builds the links to the configuration classes.</p>
196
-
197
-
198
167
 
199
-
200
168
  <div class="method-source-code" id="new-source">
201
169
  <pre><span class="ruby-comment"># File lib/standup_md/config.rb, line 38</span>
202
170
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
@@ -206,25 +174,20 @@
206
174
  <span class="ruby-ivar">@entry_list</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">EntryList</span>.<span class="ruby-identifier">new</span>
207
175
  <span class="ruby-keyword">end</span></pre>
208
176
  </div>
209
-
210
177
  </div>
211
178
 
212
-
213
179
 
214
-
215
180
  </div>
216
181
 
217
-
218
182
  </section>
219
-
220
- </section>
221
183
 
184
+ </section>
222
185
  </main>
223
186
 
224
187
 
225
188
  <footer id="validator-badges" role="contentinfo">
226
189
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
227
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
190
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
228
191
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
229
192
  </footer>
230
193
 
data/doc/StandupMD/Config/Cli.html CHANGED
@@ -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
- <div id="parent-class-section" class="nav-section">
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
- <!-- Method Quickref -->
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-auto_fill_previous" class="method-detail">
131
115
  <div class="method-heading attribute-method-heading">
132
116
  <span class="method-name">auto_fill_previous</span><span
@@ -134,16 +118,13 @@
134
118
  </div>
135
119
 
136
120
  <div class="method-description">
137
-
138
121
  <p>When writing a new entry, should &#39;previous&#39; be pulled from the last entry?</p>
139
122
 
140
123
  <p>@param [Boolean] <a href="Cli.html#attribute-i-auto_fill_previous"><code>auto_fill_previous</code></a></p>
141
124
 
142
125
  <p>@return [Boolean]</p>
143
-
144
126
  </div>
145
127
  </div>
146
-
147
128
  <div id="attribute-i-date" class="method-detail">
148
129
  <div class="method-heading attribute-method-heading">
149
130
  <span class="method-name">date</span><span
@@ -151,16 +132,13 @@
151
132
  </div>
152
133
 
153
134
  <div class="method-description">
154
-
155
135
  <p>The date to use to find the entry.</p>
156
136
 
157
137
  <p>@param [Date] date</p>
158
138
 
159
139
  <p>@return [Date]</p>
160
-
161
140
  </div>
162
141
  </div>
163
-
164
142
  <div id="attribute-i-edit" class="method-detail">
165
143
  <div class="method-heading attribute-method-heading">
166
144
  <span class="method-name">edit</span><span
@@ -168,16 +146,13 @@
168
146
  </div>
169
147
 
170
148
  <div class="method-description">
171
-
172
149
  <p>Should the cli edit?</p>
173
150
 
174
151
  <p>@param [Boolean] edit</p>
175
152
 
176
153
  <p>@return [Boolean]</p>
177
-
178
154
  </div>
179
155
  </div>
180
-
181
156
  <div id="attribute-i-editor" class="method-detail">
182
157
  <div class="method-heading attribute-method-heading">
183
158
  <span class="method-name">editor</span><span
@@ -185,16 +160,13 @@
185
160
  </div>
186
161
 
187
162
  <div class="method-description">
188
-
189
163
  <p>The editor to use when opening standup files. If one is not set, the first of $VISUAL, $EDITOR, or vim will be used, in that order.</p>
190
164
 
191
165
  <p>@param [String] editor</p>
192
166
 
193
167
  <p>@return [String]</p>
194
-
195
168
  </div>
196
169
  </div>
197
-
198
170
  <div id="attribute-i-preference_file" class="method-detail">
199
171
  <div class="method-heading attribute-method-heading">
200
172
  <span class="method-name">preference_file</span><span
@@ -202,16 +174,13 @@
202
174
  </div>
203
175
 
204
176
  <div class="method-description">
205
-
206
177
  <p>The preference file for <a href="Cli.html"><code>Cli</code></a>.</p>
207
178
 
208
179
  <p>@param [String] preference</p>
209
180
 
210
181
  <p>@return [String]</p>
211
-
212
182
  </div>
213
183
  </div>
214
-
215
184
  <div id="attribute-i-print" class="method-detail">
216
185
  <div class="method-heading attribute-method-heading">
217
186
  <span class="method-name">print</span><span
@@ -219,16 +188,13 @@
219
188
  </div>
220
189
 
221
190
  <div class="method-description">
222
-
223
191
  <p>Should the cli print the entry to the command line?</p>
224
192
 
225
193
  <p>@param [Boolean] print</p>
226
194
 
227
195
  <p>@return [Boolean]</p>
228
-
229
196
  </div>
230
197
  </div>
231
-
232
198
  <div id="attribute-i-verbose" class="method-detail">
233
199
  <div class="method-heading attribute-method-heading">
234
200
  <span class="method-name">verbose</span><span
@@ -236,16 +202,13 @@
236
202
  </div>
237
203
 
238
204
  <div class="method-description">
239
-
240
205
  <p>Should the cli print verbose output?</p>
241
206
 
242
207
  <p>@param [Boolean] verbose</p>
243
208
 
244
209
  <p>@return [Boolean]</p>
245
-
246
210
  </div>
247
211
  </div>
248
-
249
212
  <div id="attribute-i-write" class="method-detail">
250
213
  <div class="method-heading attribute-method-heading">
251
214
  <span class="method-name">write</span><span
@@ -253,112 +216,81 @@
253
216
  </div>
254
217
 
255
218
  <div class="method-description">
256
-
257
219
  <p>Should the cli automatically write the new entry to the file?</p>
258
220
 
259
221
  <p>@param [Boolean] write</p>
260
222
 
261
223
  <p>@return [Boolean]</p>
262
-
263
224
  </div>
264
225
  </div>
265
-
266
226
  </section>
267
-
268
227
 
269
-
228
+
270
229
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
271
230
  <header>
272
231
  <h3>Public Class Methods</h3>
273
232
  </header>
274
233
 
275
-
276
234
  <div id="method-c-new" class="method-detail ">
277
-
278
235
  <div class="method-heading">
279
236
  <span class="method-name">new</span><span
280
237
  class="method-args">()</span>
281
-
282
238
  <span class="method-click-advice">click to toggle source</span>
283
-
284
239
  </div>
285
-
286
240
 
287
241
  <div class="method-description">
288
-
289
242
  <p>Initializes the config with default values.</p>
290
-
291
-
292
243
 
293
-
294
244
  <div class="method-source-code" id="new-source">
295
245
  <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 94</span>
296
246
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
297
247
  <span class="ruby-identifier">reset</span>
298
248
  <span class="ruby-keyword">end</span></pre>
299
249
  </div>
300
-
301
250
  </div>
302
251
 
303
-
304
252
 
305
-
306
253
  </div>
307
254
 
308
-
309
255
  </section>
310
-
256
+
311
257
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
312
258
  <header>
313
259
  <h3>Public Instance Methods</h3>
314
260
  </header>
315
261
 
316
-
317
262
  <div id="method-i-reset" class="method-detail ">
318
-
319
263
  <div class="method-heading">
320
264
  <span class="method-name">reset</span><span
321
265
  class="method-args">()</span>
322
-
323
266
  <span class="method-click-advice">click to toggle source</span>
324
-
325
267
  </div>
326
-
327
268
 
328
269
  <div class="method-description">
329
-
330
270
  <p>Sets all config values back to their defaults.</p>
331
271
 
332
272
  <p>@return [Hash]</p>
333
-
334
-
335
273
 
336
-
337
274
  <div class="method-source-code" id="reset-source">
338
275
  <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 102</span>
339
276
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
340
277
  <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>) }
341
278
  <span class="ruby-keyword">end</span></pre>
342
279
  </div>
343
-
344
280
  </div>
345
281
 
346
-
347
282
 
348
-
349
283
  </div>
350
284
 
351
-
352
285
  </section>
353
-
354
- </section>
355
286
 
287
+ </section>
356
288
  </main>
357
289
 
358
290
 
359
291
  <footer id="validator-badges" role="contentinfo">
360
292
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
361
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
293
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
362
294
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
363
295
  </footer>
364
296