standup_md 0.3.5 → 0.3.6
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 +42 -26
- data/Rakefile +3 -1
- data/doc/README_md.html +48 -49
- data/doc/StandupMD.html +2 -17
- data/doc/StandupMD/Cli.html +11 -11
- data/doc/StandupMD/Cli/Helpers.html +5 -4
- data/doc/StandupMD/Config.html +1 -1
- data/doc/StandupMD/Config/Cli.html +2 -2
- data/doc/StandupMD/Config/Entry.html +2 -2
- data/doc/StandupMD/Entry.html +6 -6
- data/doc/StandupMD/File.html +26 -23
- data/doc/StandupMD/Version.html +176 -0
- data/doc/created.rid +13 -13
- data/doc/index.html +49 -48
- 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 +38 -28
- data/lib/standup_md.rb +2 -1
- data/lib/standup_md/cli.rb +2 -3
- data/lib/standup_md/cli/helpers.rb +45 -37
- 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 +0 -1
- data/lib/standup_md/entry_list.rb +1 -1
- data/lib/standup_md/file.rb +29 -12
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3778ef26e402b37d24ff4b3e7465123ffb3eb0cca19125d5bf44f21b36b92fe7
|
4
|
+
data.tar.gz: 4bef958d825346fdbfdb45c961633245f9edc172ac5877db1723d9c3501f04d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 262cee1fd957f46c19e39af445d50b89d034c925fc857a0b3e64a042e652ce7c0ebfd1addda1999cf40a8052f05b5b24ed274d443764769bd47d23e2aafea1bb
|
7
|
+
data.tar.gz: bfb62a584c6f9386e821deeade2bbf842999d8a210e225114d137701b2bd603f3934a4416a32cfd21ebf35ad5ada526a75e80dd13c2376d010b72119ce9c3960
|
data/Gemfile.lock
CHANGED
@@ -1,23 +1,25 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
standup_md (0.3.
|
4
|
+
standup_md (0.3.5)
|
5
5
|
|
6
6
|
GEM
|
7
7
|
remote: https://rubygems.org/
|
8
8
|
specs:
|
9
|
-
docile (1.3.
|
10
|
-
power_assert (
|
11
|
-
rake (13.0.
|
12
|
-
simplecov (0.
|
9
|
+
docile (1.3.5)
|
10
|
+
power_assert (2.0.0)
|
11
|
+
rake (13.0.3)
|
12
|
+
simplecov (0.21.2)
|
13
13
|
docile (~> 1.1)
|
14
14
|
simplecov-html (~> 0.11)
|
15
|
-
|
16
|
-
|
15
|
+
simplecov_json_formatter (~> 0.1)
|
16
|
+
simplecov-html (0.12.3)
|
17
|
+
simplecov_json_formatter (0.1.2)
|
18
|
+
test-unit (3.4.1)
|
17
19
|
power_assert
|
18
20
|
|
19
21
|
PLATFORMS
|
20
|
-
|
22
|
+
x86_64-darwin-20
|
21
23
|
|
22
24
|
DEPENDENCIES
|
23
25
|
rake (~> 13.0, >= 13.0.1)
|
@@ -26,4 +28,4 @@ DEPENDENCIES
|
|
26
28
|
test-unit (~> 3.3, >= 3.3.5)
|
27
29
|
|
28
30
|
BUNDLED WITH
|
29
|
-
2.
|
31
|
+
2.2.16
|
data/README.md
CHANGED
@@ -1,4 +1,5 @@
|
|
1
1
|
# The Standup Doctor
|
2
|
+
<!-- vi: set ts=4 sw=4 : -->
|
2
3
|
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master)
|
3
4
|
[![Gem Version](https://badge.fury.io/rb/standup_md.svg)](https://badge.fury.io/rb/standup_md)
|
4
5
|
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
|
@@ -12,28 +13,6 @@ View on: [Github](https://github.com/evanthegrayt/standup_md) |
|
|
12
13
|
[GitHub Pages](https://evanthegrayt.github.io/standup_md/) |
|
13
14
|
[RubyGems](https://rubygems.org/gems/standup_md)
|
14
15
|
|
15
|
-
## Table of Contents
|
16
|
-
- [About](#about)
|
17
|
-
- [Installation](#Installation)
|
18
|
-
- [Via RubyGems](#via-rubygems)
|
19
|
-
- [Manual Installation](#manual-installation)
|
20
|
-
- [Usage](#usage)
|
21
|
-
- [Command Line](#command-line)
|
22
|
-
- [CLI Examples](#cli-examples)
|
23
|
-
- [Adding an entry for today via editor](#adding-an-entry-for-today-via-editor)
|
24
|
-
- [Copy the entry for today to clipboard](#copy-the-entry-for-today-to-clipboard)
|
25
|
-
- [Add entry to file without opening it](#add-entry-to-file-without-opening-it)
|
26
|
-
- [Find an entry by date and print it](#find-an-entry-by-date-and-print-it)
|
27
|
-
- [Customization and Runtime Options](#customization-and-runtime-options)
|
28
|
-
- [Using existing standup files](#using-existing-standup-files)
|
29
|
-
- [API](#api)
|
30
|
-
- [API Examples](#api-examples)
|
31
|
-
- [Adding an entry for today](#adding-an-entry-for-today)
|
32
|
-
- [Finding a past entry](#finding-a-past-entry)
|
33
|
-
- [Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html)
|
34
|
-
- [Reporting Bugs and Requesting Features](#reporting-bugs-and-requesting-features)
|
35
|
-
- [Self-Promotion](#self-promotion)
|
36
|
-
|
37
16
|
## About
|
38
17
|
I've now been at two separate companies where we post our daily standups in a
|
39
18
|
chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day
|
@@ -47,8 +26,8 @@ for the current month in your preferred editor. If an entry for today is already
|
|
47
26
|
present, no text will be generated. If an entry for today doesn't exist, one
|
48
27
|
will be generated with your preferred values. When generating, if a previous
|
49
28
|
entry exists, it will be added to today's entry as your previous day's work. See
|
50
|
-
[example](#
|
51
|
-
in your own code somehow.
|
29
|
+
[example](#cli-examples). There's also a very robust API if you'd like to use
|
30
|
+
this in your own code somehow.
|
52
31
|
|
53
32
|
## Installation
|
54
33
|
If you don't have the permissions to install system-wide gems, you're probabaly
|
@@ -222,6 +201,7 @@ get large over time and possibly cause performance issues.
|
|
222
201
|
|
223
202
|
#### Executable Flags
|
224
203
|
Some of these options can be changed at runtime. They are as follows.
|
204
|
+
|
225
205
|
```
|
226
206
|
--current ARRAY List of current entry's tasks
|
227
207
|
--previous ARRAY List of precious entry's tasks
|
@@ -335,10 +315,46 @@ file = StandupMD::File.find_by_date(date).load
|
|
335
315
|
entry = file.entries.find(date)
|
336
316
|
```
|
337
317
|
|
318
|
+
## Vim
|
319
|
+
While there's no official support for vim, you can add this to your `vimrc`
|
320
|
+
file, or something like `~/.vim/plugin/standup.vim`.
|
321
|
+
|
322
|
+
```vim
|
323
|
+
if executable('standup')
|
324
|
+
command! -complete=custom,s:StandupCompletion -nargs=? -bang Standup
|
325
|
+
\ call s:OpenStandupFile(<bang>0, <f-args>)
|
326
|
+
endif
|
327
|
+
|
328
|
+
function! s:StandupCompletion(...) abort
|
329
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
330
|
+
if !isdirectory(l:dir) | return '' | endif
|
331
|
+
let l:list = glob(l:dir . '*.md', 0, 1)
|
332
|
+
return join(map(l:list, "substitute(v:val, l:dir, '', '')"), "\n")
|
333
|
+
endfunction
|
334
|
+
|
335
|
+
function! s:OpenStandupFile(split, ...)
|
336
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
337
|
+
let l:file = a:0 ? a:1 : get(g:, 'standup_file', strftime('%Y_%m.md'))
|
338
|
+
call system('standup --no-edit')
|
339
|
+
execute a:split ? 'vsplit' : 'split' l:dir . l:file
|
340
|
+
endfunction
|
341
|
+
```
|
342
|
+
|
343
|
+
This makes the `:Standup` command, which opens the standup file in a split,
|
344
|
+
while `:Standup!` opens it in a vertical split. If a file is passed to the
|
345
|
+
command, that file will be opened. There's tab completion for this. Lastly,
|
346
|
+
it allows for a few variables to be set for customization.
|
347
|
+
|
348
|
+
```vim
|
349
|
+
g:standup_dir = $HOME . '/.cache/standup_md' " the directory where your file are
|
350
|
+
g:standup_file = strftime('%Y_%m.md') " the file format to use
|
351
|
+
```
|
352
|
+
|
338
353
|
## Reporting Bugs and Requesting Features
|
339
354
|
If you have an idea or find a bug, please [create an
|
340
|
-
issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure
|
341
|
-
doesn't already exist. Better yet, you can always submit a Pull
|
355
|
+
issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure
|
356
|
+
the topic doesn't already exist. Better yet, you can always submit a Pull
|
357
|
+
Request.
|
342
358
|
|
343
359
|
## Self-Promotion
|
344
360
|
I do these projects for fun, and I enjoy knowing that they're helpful to people.
|
data/Rakefile
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require_relative 'lib/standup_md'
|
2
4
|
require 'bundler/gem_tasks'
|
3
5
|
require 'rdoc/task'
|
@@ -16,4 +18,4 @@ RDoc::Task.new do |rdoc|
|
|
16
18
|
rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
|
17
19
|
end
|
18
20
|
|
19
|
-
task :
|
21
|
+
task default: :test
|
data/doc/README_md.html
CHANGED
@@ -61,7 +61,6 @@
|
|
61
61
|
|
62
62
|
<ul class="link-list" role="directory">
|
63
63
|
<li><a href="#label-The+Standup+Doctor">The Standup Doctor</a>
|
64
|
-
<li><a href="#label-Table+of+Contents">Table of Contents</a>
|
65
64
|
<li><a href="#label-About">About</a>
|
66
65
|
<li><a href="#label-Installation">Installation</a>
|
67
66
|
<li><a href="#label-Via+RubyGems">Via RubyGems</a>
|
@@ -81,6 +80,7 @@
|
|
81
80
|
<li><a href="#label-API+Examples">API Examples</a>
|
82
81
|
<li><a href="#label-Adding+an+entry+for+today">Adding an entry for today</a>
|
83
82
|
<li><a href="#label-Finding+a+past+entry">Finding a past entry</a>
|
83
|
+
<li><a href="#label-Vim">Vim</a>
|
84
84
|
<li><a href="#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
|
85
85
|
<li><a href="#label-Self-Promotion">Self-Promotion</a>
|
86
86
|
</ul>
|
@@ -104,7 +104,7 @@
|
|
104
104
|
<main role="main" aria-label="Page README.md">
|
105
105
|
|
106
106
|
<h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+Standup+Doctor">¶</a> <a href="#top">↑</a></span></h1>
|
107
|
-
|
107
|
+
<!-- vi: set ts=4 sw=4 : -->
|
108
108
|
<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>
|
109
109
|
|
110
110
|
<blockquote>
|
@@ -115,56 +115,11 @@
|
|
115
115
|
|
116
116
|
<p>View on: <a href="https://github.com/evanthegrayt/standup_md">Github</a> | <a href="https://evanthegrayt.github.io/standup_md/">GitHub Pages</a> | <a href="https://rubygems.org/gems/standup_md">RubyGems</a></p>
|
117
117
|
|
118
|
-
<h2 id="label-Table+of+Contents">Table of Contents<span><a href="#label-Table+of+Contents">¶</a> <a href="#top">↑</a></span></h2>
|
119
|
-
<ul><li>
|
120
|
-
<p><a href="#about">About</a></p>
|
121
|
-
</li><li>
|
122
|
-
<p><a href="#Installation">Installation</a></p>
|
123
|
-
</li><li>
|
124
|
-
<p><a href="#via-rubygems">Via RubyGems</a></p>
|
125
|
-
</li><li>
|
126
|
-
<p><a href="#manual-installation">Manual Installation</a></p>
|
127
|
-
</li><li>
|
128
|
-
<p><a href="#usage">Usage</a></p>
|
129
|
-
</li><li>
|
130
|
-
<p><a href="#command-line">Command Line</a></p>
|
131
|
-
<ul><li>
|
132
|
-
<p><a href="#cli-examples">CLI Examples</a></p>
|
133
|
-
</li><li>
|
134
|
-
<p><a href="#adding-an-entry-for-today-via-editor">Adding an entry for today via editor</a></p>
|
135
|
-
</li><li>
|
136
|
-
<p><a href="#copy-the-entry-for-today-to-clipboard">Copy the entry for today to clipboard</a></p>
|
137
|
-
</li><li>
|
138
|
-
<p><a href="#add-entry-to-file-without-opening-it">Add entry to file without opening it</a></p>
|
139
|
-
</li><li>
|
140
|
-
<p><a href="#find-an-entry-by-date-and-print-it">Find an entry by date and print it</a></p>
|
141
|
-
</li><li>
|
142
|
-
<p><a href="#customization-and-runtime-options">Customization and Runtime Options</a></p>
|
143
|
-
</li><li>
|
144
|
-
<p><a href="#using-existing-standup-files">Using existing standup files</a></p>
|
145
|
-
</li></ul>
|
146
|
-
</li><li>
|
147
|
-
<p><a href="#api">API</a></p>
|
148
|
-
<ul><li>
|
149
|
-
<p><a href="#api-examples">API Examples</a></p>
|
150
|
-
</li><li>
|
151
|
-
<p><a href="#adding-an-entry-for-today">Adding an entry for today</a></p>
|
152
|
-
</li><li>
|
153
|
-
<p><a href="#finding-a-past-entry">Finding a past entry</a></p>
|
154
|
-
</li><li>
|
155
|
-
<p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
|
156
|
-
</li></ul>
|
157
|
-
</li><li>
|
158
|
-
<p><a href="#reporting-bugs-and-requesting-features">Reporting Bugs and Requesting Features</a></p>
|
159
|
-
</li><li>
|
160
|
-
<p><a href="#self-promotion">Self-Promotion</a></p>
|
161
|
-
</li></ul>
|
162
|
-
|
163
118
|
<h2 id="label-About">About<span><a href="#label-About">¶</a> <a href="#top">↑</a></span></h2>
|
164
119
|
|
165
120
|
<p>I've now been at two separate companies where we post our daily standups in a chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day became tedious, as I'd have to look up what I did the day before, copy and paste yesterday's work into a new entry, and add today's tasks. This gem automates most of this process, along with providing means of opening the file in your editor, and finding and displaying entries from the command line.</p>
|
166
121
|
|
167
|
-
<p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn't exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today's entry as your previous day's work. See <a href="#
|
122
|
+
<p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn't exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today's entry as your previous day's work. See <a href="#cli-examples">example</a>. There's also a very robust API if you'd like to use this in your own code somehow.</p>
|
168
123
|
|
169
124
|
<h2 id="label-Installation">Installation<span><a href="#label-Installation">¶</a> <a href="#top">↑</a></span></h2>
|
170
125
|
|
@@ -300,7 +255,23 @@ rake install</pre>
|
|
300
255
|
|
301
256
|
<h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">¶</a> <a href="#top">↑</a></span></h4>
|
302
257
|
|
303
|
-
<p>Some of these options can be changed at runtime. They are as follows
|
258
|
+
<p>Some of these options can be changed at runtime. They are as follows.</p>
|
259
|
+
|
260
|
+
<pre>--current ARRAY List of current entry's tasks
|
261
|
+
--previous ARRAY List of precious entry's tasks
|
262
|
+
--impediments ARRAY List of impediments for current entry
|
263
|
+
--notes ARRAY List of notes for current entry
|
264
|
+
--sub-header-order ARRAY The order of the sub-headers when writing the file
|
265
|
+
-f, --file-name-format STRING Date-formattable string to use for standup file name
|
266
|
+
-E, --editor EDITOR Editor to use for opening standup files
|
267
|
+
-d, --directory DIRECTORY The directories where standup files are located
|
268
|
+
-w --[no-]write Write current entry if it doesn't exist. Default is true
|
269
|
+
-a --[no-]auto-fill-previous Auto-generate 'previous' tasks for new entries
|
270
|
+
-e --[no-]edit Open the file in the editor. Default is true
|
271
|
+
-v, --[no-]verbose Verbose output. Default is false.
|
272
|
+
-p, --print [DATE] Print current entry.
|
273
|
+
If DATE is passed, will print entry for DATE, if it exists.
|
274
|
+
DATE must be in the same format as file-name-format</pre>
|
304
275
|
|
305
276
|
<h4 id="label-Using+Existing+Standup+Files">Using Existing Standup Files<span><a href="#label-Using+Existing+Standup+Files">¶</a> <a href="#top">↑</a></span></h4>
|
306
277
|
|
@@ -387,6 +358,34 @@ rake install</pre>
|
|
387
358
|
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">file</span>.<span class="ruby-identifier">entries</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">date</span>)
|
388
359
|
</pre>
|
389
360
|
|
361
|
+
<h2 id="label-Vim">Vim<span><a href="#label-Vim">¶</a> <a href="#top">↑</a></span></h2>
|
362
|
+
|
363
|
+
<p>While there's no official support for vim, you can add this to your <code>vimrc</code> file, or something like <code>~/.vim/plugin/standup.vim</code>.</p>
|
364
|
+
|
365
|
+
<pre>if executable('standup')
|
366
|
+
command! -complete=custom,s:StandupCompletion -nargs=? -bang Standup
|
367
|
+
\ call s:OpenStandupFile(<bang>0, <f-args>)
|
368
|
+
endif
|
369
|
+
|
370
|
+
function! s:StandupCompletion(...) abort
|
371
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
372
|
+
if !isdirectory(l:dir) | return '' | endif
|
373
|
+
let l:list = glob(l:dir . '*.md', 0, 1)
|
374
|
+
return join(map(l:list, "substitute(v:val, l:dir, '', '')"), "\n")
|
375
|
+
endfunction
|
376
|
+
|
377
|
+
function! s:OpenStandupFile(split, ...)
|
378
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
379
|
+
let l:file = a:0 ? a:1 : get(g:, 'standup_file', strftime('%Y_%m.md'))
|
380
|
+
call system('standup --no-edit')
|
381
|
+
execute a:split ? 'vsplit' : 'split' l:dir . l:file
|
382
|
+
endfunction</pre>
|
383
|
+
|
384
|
+
<p>This makes the <code>:Standup</code> command, which opens the standup file in a split, while <code>:Standup!</code> opens it in a vertical split. If a file is passed to the command, that file will be opened. There's tab completion for this. Lastly, it allows for a few variables to be set for customization.</p>
|
385
|
+
|
386
|
+
<pre>g:standup_dir = $HOME . '/.cache/standup_md' " the directory where your file are
|
387
|
+
g:standup_file = strftime('%Y_%m.md') " the file format to use</pre>
|
388
|
+
|
390
389
|
<h2 id="label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features<span><a href="#label-Reporting+Bugs+and+Requesting+Features">¶</a> <a href="#top">↑</a></span></h2>
|
391
390
|
|
392
391
|
<p>If you have an idea or find a bug, please <a href="https://github.com/evanthegrayt/standup_md/issues/new">create an issue</a>. Just make sure the topic doesn't already exist. Better yet, you can always submit a Pull Request.</p>
|
data/doc/StandupMD.html
CHANGED
@@ -102,22 +102,6 @@
|
|
102
102
|
|
103
103
|
|
104
104
|
|
105
|
-
<section class="constants-list">
|
106
|
-
<header>
|
107
|
-
<h3>Constants</h3>
|
108
|
-
</header>
|
109
|
-
<dl>
|
110
|
-
|
111
|
-
<dt id="VERSION">VERSION
|
112
|
-
|
113
|
-
<dd><p>The gem verision</p>
|
114
|
-
|
115
|
-
<p>@return [String]</p>
|
116
|
-
|
117
|
-
|
118
|
-
</dl>
|
119
|
-
</section>
|
120
|
-
|
121
105
|
|
122
106
|
|
123
107
|
|
@@ -224,7 +208,7 @@
|
|
224
208
|
<div class="method-source-code" id="configure-source">
|
225
209
|
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 36</span>
|
226
210
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">configure</span>
|
227
|
-
<span class="ruby-keyword">yield</span> <span class="ruby-
|
211
|
+
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">config</span>
|
228
212
|
<span class="ruby-keyword">end</span></pre>
|
229
213
|
</div>
|
230
214
|
|
@@ -261,6 +245,7 @@
|
|
261
245
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load_config_file</span>(<span class="ruby-identifier">file</span>)
|
262
246
|
<span class="ruby-identifier">file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">file</span>)
|
263
247
|
<span class="ruby-identifier">raise</span> <span class="ruby-node">"File #{file} does not exist."</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">file</span>)
|
248
|
+
|
264
249
|
<span class="ruby-ivar">@config_file_loaded</span> = <span class="ruby-keyword">true</span>
|
265
250
|
<span class="ruby-identifier">load</span> <span class="ruby-identifier">file</span>
|
266
251
|
<span class="ruby-keyword">end</span></pre>
|
data/doc/StandupMD/Cli.html
CHANGED
@@ -212,7 +212,7 @@
|
|
212
212
|
|
213
213
|
|
214
214
|
<div class="method-source-code" id="config-source">
|
215
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
215
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 16</span>
|
216
216
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
|
217
217
|
<span class="ruby-ivar">@config</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">cli</span>
|
218
218
|
<span class="ruby-keyword">end</span></pre>
|
@@ -247,7 +247,7 @@
|
|
247
247
|
|
248
248
|
|
249
249
|
<div class="method-source-code" id="echo-source">
|
250
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
250
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 24</span>
|
251
251
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">echo</span>(<span class="ruby-identifier">msg</span>)
|
252
252
|
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">msg</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">verbose</span>
|
253
253
|
<span class="ruby-keyword">end</span></pre>
|
@@ -280,7 +280,7 @@
|
|
280
280
|
|
281
281
|
|
282
282
|
<div class="method-source-code" id="execute-source">
|
283
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
283
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 30</span>
|
284
284
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">execute</span>(<span class="ruby-identifier">options</span> = [])
|
285
285
|
<span class="ruby-identifier">exe</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
|
286
286
|
|
@@ -322,16 +322,16 @@
|
|
322
322
|
|
323
323
|
|
324
324
|
<div class="method-source-code" id="new-source">
|
325
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
325
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 63</span>
|
326
326
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span> = [], <span class="ruby-identifier">load_config</span> = <span class="ruby-keyword">true</span>)
|
327
327
|
<span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
|
328
328
|
<span class="ruby-ivar">@preference_file_loaded</span> = <span class="ruby-keyword">false</span>
|
329
329
|
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
|
330
330
|
<span class="ruby-identifier">load_preferences</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">load_config</span>
|
331
|
-
<span class="ruby-identifier">
|
331
|
+
<span class="ruby-identifier">load_runtime_preferences</span>(<span class="ruby-identifier">options</span>)
|
332
332
|
<span class="ruby-ivar">@file</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">find_by_date</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">date</span>)
|
333
333
|
<span class="ruby-ivar">@file</span>.<span class="ruby-identifier">load</span>
|
334
|
-
<span class="ruby-ivar">@entry</span> = <span class="ruby-identifier">
|
334
|
+
<span class="ruby-ivar">@entry</span> = <span class="ruby-identifier">new_entry</span>(<span class="ruby-ivar">@file</span>)
|
335
335
|
<span class="ruby-keyword">end</span></pre>
|
336
336
|
</div>
|
337
337
|
|
@@ -372,7 +372,7 @@
|
|
372
372
|
|
373
373
|
|
374
374
|
<div class="method-source-code" id="echo-source">
|
375
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
375
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 117</span>
|
376
376
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">echo</span>(<span class="ruby-identifier">msg</span>)
|
377
377
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">echo</span>(<span class="ruby-identifier">msg</span>)
|
378
378
|
<span class="ruby-keyword">end</span></pre>
|
@@ -407,7 +407,7 @@
|
|
407
407
|
|
408
408
|
|
409
409
|
<div class="method-source-code" id="edit-source">
|
410
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
410
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 99</span>
|
411
411
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">edit</span>
|
412
412
|
<span class="ruby-identifier">echo</span> <span class="ruby-node">"Opening file in #{@config.editor}"</span>
|
413
413
|
<span class="ruby-identifier">exec</span>(<span class="ruby-node">"#{@config.editor} #{file.name}"</span>)
|
@@ -443,7 +443,7 @@
|
|
443
443
|
|
444
444
|
|
445
445
|
<div class="method-source-code" id="load_preferences-source">
|
446
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
446
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 78</span>
|
447
447
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_preferences</span>
|
448
448
|
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">preference_file</span>)
|
449
449
|
<span class="ruby-operator">::</span><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load_config_file</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">preference_file</span>)
|
@@ -483,7 +483,7 @@
|
|
483
483
|
|
484
484
|
|
485
485
|
<div class="method-source-code" id="preference_file_loaded-3F-source">
|
486
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
486
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 91</span>
|
487
487
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">preference_file_loaded?</span>
|
488
488
|
<span class="ruby-ivar">@preference_file_loaded</span>
|
489
489
|
<span class="ruby-keyword">end</span></pre>
|
@@ -518,7 +518,7 @@
|
|
518
518
|
|
519
519
|
|
520
520
|
<div class="method-source-code" id="write_file-source">
|
521
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line
|
521
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 108</span>
|
522
522
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_file</span>
|
523
523
|
<span class="ruby-identifier">echo</span> <span class="ruby-node">"Writing file #{file.name}"</span>
|
524
524
|
<span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>
|
@@ -127,18 +127,19 @@
|
|
127
127
|
|
128
128
|
|
129
129
|
<div class="method-source-code" id="print-source">
|
130
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli/helpers.rb, line
|
130
|
+
<pre><span class="ruby-comment"># File lib/standup_md/cli/helpers.rb, line 14</span>
|
131
131
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print</span>(<span class="ruby-identifier">entry</span>)
|
132
132
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">nil?</span>
|
133
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-node">"No record found for #{
|
133
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-node">"No record found for #{config.cli.date}"</span>
|
134
134
|
<span class="ruby-keyword">return</span>
|
135
135
|
<span class="ruby-keyword">end</span>
|
136
136
|
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-identifier">entry</span>)
|
137
|
-
<span class="ruby-
|
137
|
+
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">header_type</span><span class="ruby-operator">|</span>
|
138
138
|
<span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">public_send</span>(<span class="ruby-identifier">header_type</span>)
|
139
139
|
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">tasks</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">empty?</span>
|
140
|
+
|
140
141
|
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">sub_header</span>(<span class="ruby-identifier">header_type</span>)
|
141
|
-
<span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> <span class="ruby-identifier">puts</span> <span class="ruby-
|
142
|
+
<span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> <span class="ruby-identifier">puts</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span> <span class="ruby-operator">+</span> <span class="ruby-string">' '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">task</span> }
|
142
143
|
<span class="ruby-keyword">end</span>
|
143
144
|
<span class="ruby-identifier">puts</span>
|
144
145
|
<span class="ruby-keyword">end</span></pre>
|