standup_md 0.2.0 → 0.2.1
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/README.md +14 -8
- data/doc/README_md.html +20 -8
- data/doc/StandupMD.html +12 -12
- data/doc/created.rid +5 -5
- data/doc/index.html +20 -8
- data/doc/js/search_index.js +1 -1
- data/doc/js/search_index.js.gz +0 -0
- data/lib/standup_md/cli.rb +4 -4
- data/lib/standup_md/version.rb +2 -2
- data/lib/standup_md.rb +3 -4
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 47e0efce596a788d69ac8f7faeadc54532bb1ff1995b52c56ad2e0dc707c5472
|
|
4
|
+
data.tar.gz: b3cdb0c4cef322a5b1020ce073bd325a046abee1a7926b73200f0b302ffe8703
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: dab3f3fa03a6c1635274dd7545bfb959ea961d9c8868f6062af0a4a7d2d00d760c0ccec4cc65d30bb8ca24702ed2773741da91254f3a0bdc6a57717d63ccfa05
|
|
7
|
+
data.tar.gz: a00498bcc03da2e7867c7c0bcdf1b53791f37f5f8d5707624ebd433ae3e30e8e4bc600f3593a32d9814b9e9f47229a3322aac6f854cf40abe46f969060137a57
|
data/README.md
CHANGED
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
# The Standup Doctor
|
|
2
|
+
[](https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master)
|
|
3
|
+
[](https://badge.fury.io/rb/standup_md)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
|
|
2
6
|
> The cure for all your standup woes.
|
|
3
7
|
|
|
4
8
|
A highly customizable and automated way to keep track of daily standups in
|
|
@@ -98,6 +102,7 @@ For example, if the standup entry from yesterday reads as follows:
|
|
|
98
102
|
|
|
99
103
|
The following scaffolding will be added for current entry at the top of the
|
|
100
104
|
file:
|
|
105
|
+
|
|
101
106
|
```markdown
|
|
102
107
|
# 2020-04-14
|
|
103
108
|
## Previous
|
|
@@ -224,30 +229,30 @@ For example, if you wanted the format to be as follows:
|
|
|
224
229
|
```markdown
|
|
225
230
|
## 05/01/2020
|
|
226
231
|
### Today
|
|
227
|
-
|
|
232
|
+
* task
|
|
228
233
|
### Yesterday
|
|
229
|
-
|
|
234
|
+
* task
|
|
230
235
|
### Hold-ups
|
|
231
|
-
|
|
236
|
+
* impediment
|
|
232
237
|
### Notes
|
|
233
|
-
|
|
238
|
+
* notes, if any are present
|
|
234
239
|
```
|
|
235
240
|
|
|
236
241
|
Your `~/.standup_md.yml` should contain:
|
|
237
242
|
|
|
238
243
|
```yaml
|
|
239
|
-
sub_header_depth: 3
|
|
240
244
|
header_depth: 2
|
|
245
|
+
sub_header_depth: 3
|
|
241
246
|
current_header: Today
|
|
242
247
|
previous_header: Yesterday
|
|
243
248
|
impediments_header: Hold-ups
|
|
249
|
+
bullet_character: '*'
|
|
244
250
|
header_date_format: '%m/%d/%Y'
|
|
245
251
|
sub_header_order:
|
|
246
252
|
- current
|
|
247
253
|
- previous
|
|
248
254
|
- impediments
|
|
249
255
|
- notes
|
|
250
|
-
|
|
251
256
|
```
|
|
252
257
|
|
|
253
258
|
## API
|
|
@@ -271,8 +276,9 @@ end
|
|
|
271
276
|
|
|
272
277
|
standup.write
|
|
273
278
|
```
|
|
274
|
-
|
|
275
|
-
{ ... }.
|
|
279
|
+
|
|
280
|
+
Note: `StandupMD.load { ... }` just is a quick way to call `StandupMD.new {
|
|
281
|
+
... }.load`
|
|
276
282
|
|
|
277
283
|
Entries are just hashes, so you can easily transform them to `json` objects.
|
|
278
284
|
|
data/doc/README_md.html
CHANGED
|
@@ -97,6 +97,8 @@
|
|
|
97
97
|
|
|
98
98
|
<h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+Standup+Doctor">¶</a> <a href="#top">↑</a></span></h1>
|
|
99
99
|
|
|
100
|
+
<p><a href="https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat"></a> <a href="https://badge.fury.io/rb/standup_md"><img src="https://badge.fury.io/rb/standup_md.svg"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg"></a></p>
|
|
101
|
+
|
|
100
102
|
<blockquote>
|
|
101
103
|
<p>The cure for all your standup woes.</p>
|
|
102
104
|
</blockquote>
|
|
@@ -187,7 +189,16 @@ ln -s $PWD/bin/standup /usr/local/bin/standup</pre>
|
|
|
187
189
|
## Impediments
|
|
188
190
|
- None</pre>
|
|
189
191
|
|
|
190
|
-
<p>The following scaffolding will be added for current entry at the top of the file
|
|
192
|
+
<p>The following scaffolding will be added for current entry at the top of the file:</p>
|
|
193
|
+
|
|
194
|
+
<pre># 2020-04-14
|
|
195
|
+
## Previous
|
|
196
|
+
- Write new feature for `standup_md`
|
|
197
|
+
- Fix bug in `standup_md`
|
|
198
|
+
## Current
|
|
199
|
+
- <!-- ADD TODAY'S WORK HERE -->
|
|
200
|
+
## Impediments
|
|
201
|
+
- None</pre>
|
|
191
202
|
|
|
192
203
|
<p>There are also flags that will print entries to the command line. There's a full list of features below, but as a quick example, you can copy today's entry to your clipboard without even opening your editor.</p>
|
|
193
204
|
|
|
@@ -272,21 +283,22 @@ sub_header_order:
|
|
|
272
283
|
|
|
273
284
|
<pre>## 05/01/2020
|
|
274
285
|
### Today
|
|
275
|
-
|
|
286
|
+
* task
|
|
276
287
|
### Yesterday
|
|
277
|
-
|
|
288
|
+
* task
|
|
278
289
|
### Hold-ups
|
|
279
|
-
|
|
290
|
+
* impediment
|
|
280
291
|
### Notes
|
|
281
|
-
|
|
292
|
+
* notes, if any are present</pre>
|
|
282
293
|
|
|
283
294
|
<p>Your <code>~/.standup_md.yml</code> should contain:</p>
|
|
284
295
|
|
|
285
|
-
<pre>
|
|
286
|
-
|
|
296
|
+
<pre>header_depth: 2
|
|
297
|
+
sub_header_depth: 3
|
|
287
298
|
current_header: Today
|
|
288
299
|
previous_header: Yesterday
|
|
289
300
|
impediments_header: Hold-ups
|
|
301
|
+
bullet_character: '*'
|
|
290
302
|
header_date_format: '%m/%d/%Y'
|
|
291
303
|
sub_header_order:
|
|
292
304
|
- current
|
|
@@ -311,7 +323,7 @@ sub_header_order:
|
|
|
311
323
|
<span class="ruby-identifier">standup</span>.<span class="ruby-identifier">write</span>
|
|
312
324
|
</pre>
|
|
313
325
|
|
|
314
|
-
<p>Note: <code>StandupMD
|
|
326
|
+
<p>Note: <code>StandupMD.load { ... }</code> just is a quick way to call <code>StandupMD.new { ... }.load</code></p>
|
|
315
327
|
|
|
316
328
|
<p>Entries are just hashes, so you can easily transform them to <code>json</code> objects.</p>
|
|
317
329
|
|
data/doc/StandupMD.html
CHANGED
|
@@ -596,7 +596,7 @@
|
|
|
596
596
|
<p>@example</p>
|
|
597
597
|
|
|
598
598
|
<pre class="ruby"><span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
|
|
599
|
-
<span class="ruby-comment"># => '0.
|
|
599
|
+
<span class="ruby-comment"># => '0.2.0'</span>
|
|
600
600
|
</pre>
|
|
601
601
|
|
|
602
602
|
|
|
@@ -848,7 +848,7 @@
|
|
|
848
848
|
|
|
849
849
|
<div class="method-description">
|
|
850
850
|
|
|
851
|
-
<p>Setter for
|
|
851
|
+
<p>Setter for <code>config_file</code>. Must be expanded in case the user uses `~` for home.</p>
|
|
852
852
|
|
|
853
853
|
<p>@param [String] file</p>
|
|
854
854
|
|
|
@@ -858,7 +858,7 @@
|
|
|
858
858
|
|
|
859
859
|
|
|
860
860
|
<div class="method-source-code" id="config_file-3D-source">
|
|
861
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
861
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 368</span>
|
|
862
862
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">config_file=</span>(<span class="ruby-identifier">config_file</span>)
|
|
863
863
|
<span class="ruby-ivar">@config_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">config_file</span>)
|
|
864
864
|
<span class="ruby-keyword">end</span></pre>
|
|
@@ -968,7 +968,7 @@
|
|
|
968
968
|
|
|
969
969
|
|
|
970
970
|
<div class="method-source-code" id="directory-3D-source">
|
|
971
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
971
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 380</span>
|
|
972
972
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">directory=</span>(<span class="ruby-identifier">directory</span>)
|
|
973
973
|
<span class="ruby-identifier">directory</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">directory</span>)
|
|
974
974
|
<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-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">directory</span>)
|
|
@@ -1087,7 +1087,7 @@
|
|
|
1087
1087
|
|
|
1088
1088
|
|
|
1089
1089
|
<div class="method-source-code" id="header_depth-3D-source">
|
|
1090
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
1090
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 392</span>
|
|
1091
1091
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">header_depth=</span>(<span class="ruby-identifier">depth</span>)
|
|
1092
1092
|
<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>)
|
|
1093
1093
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Header depth out of bounds (1..5)'</span>
|
|
@@ -1165,7 +1165,7 @@
|
|
|
1165
1165
|
|
|
1166
1166
|
|
|
1167
1167
|
<div class="method-source-code" id="load-source">
|
|
1168
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
1168
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 474</span>
|
|
1169
1169
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load</span>
|
|
1170
1170
|
<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-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">directory</span>)
|
|
1171
1171
|
|
|
@@ -1218,7 +1218,7 @@
|
|
|
1218
1218
|
|
|
1219
1219
|
|
|
1220
1220
|
<div class="method-source-code" id="load_config_file-source">
|
|
1221
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
1221
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 440</span>
|
|
1222
1222
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_config_file</span>
|
|
1223
1223
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">'No config file set'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">config_file</span>.<span class="ruby-identifier">nil?</span>
|
|
1224
1224
|
<span class="ruby-identifier">raise</span> <span class="ruby-node">"File #{config_file} does not exist"</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">config_file</span>)
|
|
@@ -1255,7 +1255,7 @@
|
|
|
1255
1255
|
|
|
1256
1256
|
|
|
1257
1257
|
<div class="method-source-code" id="new_month-3F-source">
|
|
1258
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
1258
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 500</span>
|
|
1259
1259
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new_month?</span>
|
|
1260
1260
|
<span class="ruby-identifier">file</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">previous_file</span>
|
|
1261
1261
|
<span class="ruby-keyword">end</span></pre>
|
|
@@ -1398,7 +1398,7 @@
|
|
|
1398
1398
|
|
|
1399
1399
|
|
|
1400
1400
|
<div class="method-source-code" id="sub_header_depth-3D-source">
|
|
1401
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
1401
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 407</span>
|
|
1402
1402
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_depth=</span>(<span class="ruby-identifier">depth</span>)
|
|
1403
1403
|
<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>)
|
|
1404
1404
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Sub-header depth out of bounds (2..6)'</span>
|
|
@@ -1438,7 +1438,7 @@
|
|
|
1438
1438
|
|
|
1439
1439
|
|
|
1440
1440
|
<div class="method-source-code" id="sub_header_order-source">
|
|
1441
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
1441
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 432</span>
|
|
1442
1442
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_order</span>
|
|
1443
1443
|
<span class="ruby-ivar">@sub_header_order</span>.<span class="ruby-identifier">dup</span>
|
|
1444
1444
|
<span class="ruby-keyword">end</span></pre>
|
|
@@ -1475,7 +1475,7 @@
|
|
|
1475
1475
|
|
|
1476
1476
|
|
|
1477
1477
|
<div class="method-source-code" id="sub_header_order-3D-source">
|
|
1478
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
1478
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 422</span>
|
|
1479
1479
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_order=</span>(<span class="ruby-identifier">array</span>)
|
|
1480
1480
|
<span class="ruby-identifier">order</span> = <span class="ruby-node">%w[previous current impediments notes]</span>
|
|
1481
1481
|
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Values must be #{order.join{', '}}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">order</span>.<span class="ruby-identifier">sort</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">array</span>.<span class="ruby-identifier">sort</span>
|
|
@@ -1512,7 +1512,7 @@
|
|
|
1512
1512
|
|
|
1513
1513
|
|
|
1514
1514
|
<div class="method-source-code" id="write-source">
|
|
1515
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line
|
|
1515
|
+
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 452</span>
|
|
1516
1516
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>
|
|
1517
1517
|
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">file</span>, <span class="ruby-string">'w'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
|
|
1518
1518
|
<span class="ruby-identifier">all_entries</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">head</span>, <span class="ruby-identifier">s_heads</span><span class="ruby-operator">|</span>
|
data/doc/created.rid
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
README.md
|
|
3
|
-
lib/standup_md.rb
|
|
4
|
-
lib/standup_md/cli.rb
|
|
5
|
-
lib/standup_md/version.rb
|
|
1
|
+
Sun, 03 May 2020 20:45:51 -0500
|
|
2
|
+
README.md Sun, 03 May 2020 15:57:48 -0500
|
|
3
|
+
lib/standup_md.rb Sun, 03 May 2020 20:45:49 -0500
|
|
4
|
+
lib/standup_md/cli.rb Sat, 02 May 2020 12:50:05 -0500
|
|
5
|
+
lib/standup_md/version.rb Sat, 02 May 2020 12:50:05 -0500
|
data/doc/index.html
CHANGED
|
@@ -87,6 +87,8 @@
|
|
|
87
87
|
|
|
88
88
|
<h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+Standup+Doctor">¶</a> <a href="#top">↑</a></span></h1>
|
|
89
89
|
|
|
90
|
+
<p><a href="https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat"></a> <a href="https://badge.fury.io/rb/standup_md"><img src="https://badge.fury.io/rb/standup_md.svg"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg"></a></p>
|
|
91
|
+
|
|
90
92
|
<blockquote>
|
|
91
93
|
<p>The cure for all your standup woes.</p>
|
|
92
94
|
</blockquote>
|
|
@@ -177,7 +179,16 @@ ln -s $PWD/bin/standup /usr/local/bin/standup</pre>
|
|
|
177
179
|
## Impediments
|
|
178
180
|
- None</pre>
|
|
179
181
|
|
|
180
|
-
<p>The following scaffolding will be added for current entry at the top of the file
|
|
182
|
+
<p>The following scaffolding will be added for current entry at the top of the file:</p>
|
|
183
|
+
|
|
184
|
+
<pre># 2020-04-14
|
|
185
|
+
## Previous
|
|
186
|
+
- Write new feature for `standup_md`
|
|
187
|
+
- Fix bug in `standup_md`
|
|
188
|
+
## Current
|
|
189
|
+
- <!-- ADD TODAY'S WORK HERE -->
|
|
190
|
+
## Impediments
|
|
191
|
+
- None</pre>
|
|
181
192
|
|
|
182
193
|
<p>There are also flags that will print entries to the command line. There's a full list of features below, but as a quick example, you can copy today's entry to your clipboard without even opening your editor.</p>
|
|
183
194
|
|
|
@@ -262,21 +273,22 @@ sub_header_order:
|
|
|
262
273
|
|
|
263
274
|
<pre>## 05/01/2020
|
|
264
275
|
### Today
|
|
265
|
-
|
|
276
|
+
* task
|
|
266
277
|
### Yesterday
|
|
267
|
-
|
|
278
|
+
* task
|
|
268
279
|
### Hold-ups
|
|
269
|
-
|
|
280
|
+
* impediment
|
|
270
281
|
### Notes
|
|
271
|
-
|
|
282
|
+
* notes, if any are present</pre>
|
|
272
283
|
|
|
273
284
|
<p>Your <code>~/.standup_md.yml</code> should contain:</p>
|
|
274
285
|
|
|
275
|
-
<pre>
|
|
276
|
-
|
|
286
|
+
<pre>header_depth: 2
|
|
287
|
+
sub_header_depth: 3
|
|
277
288
|
current_header: Today
|
|
278
289
|
previous_header: Yesterday
|
|
279
290
|
impediments_header: Hold-ups
|
|
291
|
+
bullet_character: '*'
|
|
280
292
|
header_date_format: '%m/%d/%Y'
|
|
281
293
|
sub_header_order:
|
|
282
294
|
- current
|
|
@@ -301,7 +313,7 @@ sub_header_order:
|
|
|
301
313
|
<span class="ruby-identifier">standup</span>.<span class="ruby-identifier">write</span>
|
|
302
314
|
</pre>
|
|
303
315
|
|
|
304
|
-
<p>Note: <code>StandupMD
|
|
316
|
+
<p>Note: <code>StandupMD.load { ... }</code> just is a quick way to call <code>StandupMD.new { ... }.load</code></p>
|
|
305
317
|
|
|
306
318
|
<p>Entries are just hashes, so you can easily transform them to <code>json</code> objects.</p>
|
|
307
319
|
|
data/doc/js/search_index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var search_data = {"index":{"searchIndex":["standupmd","cli","append_previous?()","append_to_previous_entry_tasks()","bullet_character=()","config_file=()","config_file_loaded?()","current_entry_tasks=()","directory=()","echo()","edit()","edit?()","editor()","entry_previously_added?()","execute()","file_written?()","header_depth=()","impediments=()","json?()","load()","load()","load_config_file()","new()","new()","new_month?()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","should_append?()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","verbose?()","write()","write?()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli#append_previous?()","standupmd::cli#append_to_previous_entry_tasks()","standupmd#bullet_character=()","standupmd#config_file=()","standupmd#config_file_loaded?()","standupmd#current_entry_tasks=()","standupmd#directory=()","standupmd::cli#echo()","standupmd::cli#edit()","standupmd::cli#edit?()","standupmd::cli#editor()","standupmd#entry_previously_added?()","standupmd::cli::execute()","standupmd#file_written?()","standupmd#header_depth=()","standupmd#impediments=()","standupmd::cli#json?()","standupmd::load()","standupmd#load()","standupmd#load_config_file()","standupmd::new()","standupmd::cli::new()","standupmd#new_month?()","standupmd#notes=()","standupmd#previous_entry_tasks=()","standupmd::cli#print_all_entries()","standupmd::cli#print_all_entries?()","standupmd::cli#print_current_entry()","standupmd::cli#print_current_entry?()","standupmd#reload()","standupmd::cli#should_append?()","standupmd::cli#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The class for handing reading/writing of entries.\n<p>@example\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">su</span> = <span class=\"ruby-constant\">StandupMD</span>.<span class=\"ruby-identifier\">new</span>\n</pre>\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["append_previous?","StandupMD::Cli","StandupMD/Cli.html#method-i-append_previous-3F","()","<p>Should `previous_entry_tasks` be appended? If false, <code>previous_entry_tasks</code> will be overwritten.\n<p>@return …\n"],["append_to_previous_entry_tasks","StandupMD::Cli","StandupMD/Cli.html#method-i-append_to_previous_entry_tasks","()","<p>Appends entries passed at runtime to existing previous entries.\n<p>@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["config_file=","StandupMD","StandupMD.html#method-i-config_file-3D","(config_file)","<p>Setter for
|
|
1
|
+
var search_data = {"index":{"searchIndex":["standupmd","cli","append_previous?()","append_to_previous_entry_tasks()","bullet_character=()","config_file=()","config_file_loaded?()","current_entry_tasks=()","directory=()","echo()","edit()","edit?()","editor()","entry_previously_added?()","execute()","file_written?()","header_depth=()","impediments=()","json?()","load()","load()","load_config_file()","new()","new()","new_month?()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","should_append?()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","verbose?()","write()","write?()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli#append_previous?()","standupmd::cli#append_to_previous_entry_tasks()","standupmd#bullet_character=()","standupmd#config_file=()","standupmd#config_file_loaded?()","standupmd#current_entry_tasks=()","standupmd#directory=()","standupmd::cli#echo()","standupmd::cli#edit()","standupmd::cli#edit?()","standupmd::cli#editor()","standupmd#entry_previously_added?()","standupmd::cli::execute()","standupmd#file_written?()","standupmd#header_depth=()","standupmd#impediments=()","standupmd::cli#json?()","standupmd::load()","standupmd#load()","standupmd#load_config_file()","standupmd::new()","standupmd::cli::new()","standupmd#new_month?()","standupmd#notes=()","standupmd#previous_entry_tasks=()","standupmd::cli#print_all_entries()","standupmd::cli#print_all_entries?()","standupmd::cli#print_current_entry()","standupmd::cli#print_current_entry?()","standupmd#reload()","standupmd::cli#should_append?()","standupmd::cli#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The class for handing reading/writing of entries.\n<p>@example\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">su</span> = <span class=\"ruby-constant\">StandupMD</span>.<span class=\"ruby-identifier\">new</span>\n</pre>\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["append_previous?","StandupMD::Cli","StandupMD/Cli.html#method-i-append_previous-3F","()","<p>Should `previous_entry_tasks` be appended? If false, <code>previous_entry_tasks</code> will be overwritten.\n<p>@return …\n"],["append_to_previous_entry_tasks","StandupMD::Cli","StandupMD/Cli.html#method-i-append_to_previous_entry_tasks","()","<p>Appends entries passed at runtime to existing previous entries.\n<p>@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["config_file=","StandupMD","StandupMD.html#method-i-config_file-3D","(config_file)","<p>Setter for <code>config_file</code>. Must be expanded in case the user uses `~` for home.\n<p>@param [String] file\n<p>@return …\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-i-config_file_loaded-3F","()","<p>Has a config file been loaded?\n<p>@return [Boolean]\n"],["current_entry_tasks=","StandupMD","StandupMD.html#method-i-current_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["directory=","StandupMD","StandupMD.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Prints output if <code>verbose</code> is true.\n<p>@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","<p>Opens the file in an editor. Abandons the script.\n"],["edit?","StandupMD::Cli","StandupMD/Cli.html#method-i-edit-3F","()","<p>Should the standup file be opened in the editor?\n<p>@return [Boolean] Default is true\n"],["editor","StandupMD::Cli","StandupMD/Cli.html#method-i-editor","()","<p>Tries to determine the editor, first by checking if the user has one set in their preferences. If not, …\n"],["entry_previously_added?","StandupMD","StandupMD.html#method-i-entry_previously_added-3F","()","<p>Was today's entry already in the file?\n<p>@return [boolean] true if today's entry was already in …\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n"],["file_written?","StandupMD","StandupMD.html#method-i-file_written-3F","()","<p>Has the file been written since instantiated?\n<p>@return [boolean]\n<p>@example\n"],["header_depth=","StandupMD","StandupMD.html#method-i-header_depth-3D","(depth)","<p>Number of octothorps (#) to use before the main header.\n<p>@param [Integer] depth\n<p>@return [Integer]\n"],["impediments=","StandupMD","StandupMD.html#method-i-impediments-3D","(tasks)","<p>Setter for impediments.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["json?","StandupMD::Cli","StandupMD/Cli.html#method-i-json-3F","()","<p>If printing an entry, should it be printed as json?\n<p>@return [Boolean] Default is false\n"],["load","StandupMD","StandupMD.html#method-c-load","(config_file = nil)","<p>Convenience method for calling <code>new</code> + <code>load</code>. Accepts a <code>YAML</code> config file as an argument, and yields the …\n"],["load","StandupMD","StandupMD.html#method-i-load","()","<p>Sets internal instance variables. Called when first instantiated, or after directory is set.\n<p>@return [self] …\n"],["load_config_file","StandupMD","StandupMD.html#method-i-load_config_file","()","<p>Loads the config file\n<p>@return [Hash] The config options\n"],["new","StandupMD","StandupMD.html#method-c-new","(config_file = nil)","<p>Constructor. Takes a path to a <code>YAML</code> configuration file as an argument. If passed, settings from the config …\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new_month?","StandupMD","StandupMD.html#method-i-new_month-3F","()","<p>Is today a different month than the previous entry?\n"],["notes=","StandupMD","StandupMD.html#method-i-notes-3D","(tasks)","<p>Setter for notes.\n<p>@param [Array] notes\n<p>@return [Array]\n"],["previous_entry_tasks=","StandupMD","StandupMD.html#method-i-previous_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["print_all_entries","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries","()","<p>Prints all entries to the command line.\n<p>@return [nil]\n"],["print_all_entries?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries-3F","()","<p>Should all entries be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["print_current_entry","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry","()","<p>Prints the current entry to the command line.\n<p>@return [nil]\n"],["print_current_entry?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry-3F","()","<p>Should current entry be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["reload","StandupMD","StandupMD.html#method-i-reload","()","<p>Alias of <code>load</code>\n<p>@return [self]\n"],["should_append?","StandupMD::Cli","StandupMD/Cli.html#method-i-should_append-3F","()","<p>Did the user pass <code>previous_entry_tasks</code>, and should we append?\n<p>@return [Boolean]\n"],["standup","StandupMD::Cli","StandupMD/Cli.html#method-i-standup","()","<p>Sets up an instance of <code>StandupMD</code> and passes all user preferences.\n<p>@return [StandupMD]\n"],["sub_header_depth=","StandupMD","StandupMD.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["sub_header_order","StandupMD","StandupMD.html#method-i-sub_header_order","()","<p>Return a copy of the sub-header order so the user can't modify the array.\n<p>@return [Array]\n"],["sub_header_order=","StandupMD","StandupMD.html#method-i-sub_header_order-3D","(array)","<p>Preferred order for sub-headers.\n<p>@param [Array] Values must be %w[previous current impediment notes]\n<p>@return …\n"],["verbose?","StandupMD::Cli","StandupMD/Cli.html#method-i-verbose-3F","()","<p>Should debug info be printed?\n<p>@return [Boolean] Default is false\n"],["write","StandupMD","StandupMD.html#method-i-write","()","<p>Writes a new entry to the file if the first entry in the file isn't today.\n<p>@return [Boolean]\n"],["write?","StandupMD::Cli","StandupMD/Cli.html#method-i-write-3F","()","<p>Should the file be written?\n<p>@return [Boolean] Default is true\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","<p>Writes entries to the file.\n<p>@return [Boolean] true if file was written\n"],["README","","README_md.html","","<p>The Standup Doctor\n<p><img src=\"https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat\"> …\n\n<blockquote>"]]}}
|
data/doc/js/search_index.js.gz
CHANGED
|
Binary file
|
data/lib/standup_md/cli.rb
CHANGED
|
@@ -79,9 +79,9 @@ class StandupMD
|
|
|
79
79
|
# @return [String] The editor
|
|
80
80
|
def editor
|
|
81
81
|
@editor ||=
|
|
82
|
-
if
|
|
83
|
-
echo "Editor set to [#{
|
|
84
|
-
|
|
82
|
+
if standup.config.key?('editor')
|
|
83
|
+
echo "Editor set to [#{standup.config['editor']}] via preferences"
|
|
84
|
+
standup.config['editor']
|
|
85
85
|
elsif ENV['VISUAL']
|
|
86
86
|
echo "Editor set to [#{ENV['VISUAL']}] (ENV['VISUAL'])"
|
|
87
87
|
ENV['VISUAL']
|
|
@@ -270,7 +270,7 @@ class StandupMD
|
|
|
270
270
|
prefs['file_name_format'] = v
|
|
271
271
|
end
|
|
272
272
|
opts.on('-e', '--editor=EDITOR', 'Editor to use for opening standup files') do |v|
|
|
273
|
-
|
|
273
|
+
@editor = v
|
|
274
274
|
end
|
|
275
275
|
opts.on('-d', '--directory=DIRECTORY', 'The directories where standup files are located') do |v|
|
|
276
276
|
prefs['directory'] = v
|
data/lib/standup_md/version.rb
CHANGED
data/lib/standup_md.rb
CHANGED
|
@@ -359,9 +359,8 @@ class StandupMD
|
|
|
359
359
|
end
|
|
360
360
|
|
|
361
361
|
##
|
|
362
|
-
# Setter for
|
|
363
|
-
#
|
|
364
|
-
# variables after changing the directory, you'll need to call load.
|
|
362
|
+
# Setter for +config_file+. Must be expanded in case the user uses `~` for
|
|
363
|
+
# home.
|
|
365
364
|
#
|
|
366
365
|
# @param [String] file
|
|
367
366
|
#
|
|
@@ -443,7 +442,7 @@ class StandupMD
|
|
|
443
442
|
raise "File #{config_file} does not exist" unless File.file?(config_file)
|
|
444
443
|
@config = YAML::load_file(config_file)
|
|
445
444
|
@config_file_loaded = true
|
|
446
|
-
@config.each { |k, v| send("#{k}=", v) }
|
|
445
|
+
@config.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=")}
|
|
447
446
|
end
|
|
448
447
|
|
|
449
448
|
##
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: standup_md
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.
|
|
4
|
+
version: 0.2.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Evan Gray
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-05-
|
|
11
|
+
date: 2020-05-03 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rake
|