standup_md 0.2.1 → 0.3.0
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/.gitignore +1 -0
- data/Gemfile.lock +7 -1
- data/README.md +142 -116
- data/bin/standup +1 -1
- data/doc/README_md.html +143 -96
- data/doc/StandupMD.html +96 -1322
- data/doc/StandupMD/Cli.html +124 -479
- data/doc/StandupMD/Cli/Helpers.html +167 -0
- data/doc/StandupMD/Config.html +230 -0
- data/doc/StandupMD/Config/Cli.html +355 -0
- data/doc/StandupMD/Config/Entry.html +284 -0
- data/doc/StandupMD/Config/EntryList.html +197 -0
- data/doc/StandupMD/Config/File.html +609 -0
- data/doc/StandupMD/Entry.html +478 -0
- data/doc/StandupMD/EntryList.html +759 -0
- data/doc/StandupMD/File.html +574 -0
- data/doc/created.rid +15 -5
- data/doc/index.html +153 -94
- data/doc/js/search_index.js +1 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/table_of_contents.html +221 -72
- data/lib/standup_md.rb +27 -544
- data/lib/standup_md/cli.rb +63 -246
- data/lib/standup_md/cli/helpers.rb +165 -0
- data/lib/standup_md/config.rb +45 -0
- data/lib/standup_md/config/cli.rb +106 -0
- data/lib/standup_md/config/entry.rb +61 -0
- data/lib/standup_md/config/entry_list.rb +26 -0
- data/lib/standup_md/config/file.rb +199 -0
- data/lib/standup_md/entry.rb +121 -0
- data/lib/standup_md/entry_list.rb +166 -0
- data/lib/standup_md/file.rb +172 -0
- data/lib/standup_md/file/helpers.rb +62 -0
- data/lib/standup_md/version.rb +5 -3
- data/standup_md.gemspec +1 -0
- metadata +35 -2
|
@@ -0,0 +1,284 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class StandupMD::Config::Entry - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../../";
|
|
11
|
+
var index_rel_prefix = "../../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../../js/search.js" defer></script>
|
|
16
|
+
<script src="../../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
<body id="top" role="document" class="class">
|
|
27
|
+
<nav role="navigation">
|
|
28
|
+
<div id="project-navigation">
|
|
29
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
30
|
+
<h2>
|
|
31
|
+
<a href="../../index.html" rel="home">Home</a>
|
|
32
|
+
</h2>
|
|
33
|
+
|
|
34
|
+
<div id="table-of-contents-navigation">
|
|
35
|
+
<a href="../../table_of_contents.html#pages">Pages</a>
|
|
36
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
37
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
42
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
43
|
+
<div id="search-field-wrapper">
|
|
44
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
45
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
46
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
47
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<ul id="search-results" aria-label="Search Results"
|
|
51
|
+
aria-busy="false" aria-expanded="false"
|
|
52
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
53
|
+
</form>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<div id="class-metadata">
|
|
61
|
+
|
|
62
|
+
<div id="parent-class-section" class="nav-section">
|
|
63
|
+
<h3>Parent</h3>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<p class="link">Object
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<!-- Method Quickref -->
|
|
73
|
+
<div id="method-list-section" class="nav-section">
|
|
74
|
+
<h3>Methods</h3>
|
|
75
|
+
|
|
76
|
+
<ul class="link-list" role="directory">
|
|
77
|
+
|
|
78
|
+
<li ><a href="#method-c-new">::new</a>
|
|
79
|
+
|
|
80
|
+
<li ><a href="#method-i-reset_values">#reset_values</a>
|
|
81
|
+
|
|
82
|
+
</ul>
|
|
83
|
+
</div>
|
|
84
|
+
|
|
85
|
+
</div>
|
|
86
|
+
</nav>
|
|
87
|
+
|
|
88
|
+
<main role="main" aria-labelledby="class-StandupMD::Config::Entry">
|
|
89
|
+
<h1 id="class-StandupMD::Config::Entry" class="class">
|
|
90
|
+
class StandupMD::Config::Entry
|
|
91
|
+
</h1>
|
|
92
|
+
|
|
93
|
+
<section class="description">
|
|
94
|
+
|
|
95
|
+
<p>The configuration class for <a href="../Entry.html"><code>StandupMD::Entry</code></a></p>
|
|
96
|
+
|
|
97
|
+
</section>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<section class="attribute-method-details" class="method-section">
|
|
109
|
+
<header>
|
|
110
|
+
<h3>Attributes</h3>
|
|
111
|
+
</header>
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<div id="attribute-i-current" class="method-detail">
|
|
115
|
+
<div class="method-heading attribute-method-heading">
|
|
116
|
+
<span class="method-name">current</span><span
|
|
117
|
+
class="attribute-access-type">[RW]</span>
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
<div class="method-description">
|
|
121
|
+
|
|
122
|
+
<p>Tasks for “Current” section.</p>
|
|
123
|
+
|
|
124
|
+
<p>@param [Array] current</p>
|
|
125
|
+
|
|
126
|
+
<p>@return [Array]</p>
|
|
127
|
+
|
|
128
|
+
</div>
|
|
129
|
+
</div>
|
|
130
|
+
|
|
131
|
+
<div id="attribute-i-impediments" class="method-detail">
|
|
132
|
+
<div class="method-heading attribute-method-heading">
|
|
133
|
+
<span class="method-name">impediments</span><span
|
|
134
|
+
class="attribute-access-type">[RW]</span>
|
|
135
|
+
</div>
|
|
136
|
+
|
|
137
|
+
<div class="method-description">
|
|
138
|
+
|
|
139
|
+
<p>Impediments for this entry.</p>
|
|
140
|
+
|
|
141
|
+
<p>@param [Array] impediments</p>
|
|
142
|
+
|
|
143
|
+
<p>@return [Array]</p>
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
|
|
148
|
+
<div id="attribute-i-notes" class="method-detail">
|
|
149
|
+
<div class="method-heading attribute-method-heading">
|
|
150
|
+
<span class="method-name">notes</span><span
|
|
151
|
+
class="attribute-access-type">[RW]</span>
|
|
152
|
+
</div>
|
|
153
|
+
|
|
154
|
+
<div class="method-description">
|
|
155
|
+
|
|
156
|
+
<p>Notes for this entry.</p>
|
|
157
|
+
|
|
158
|
+
<p>@param [Array] notes</p>
|
|
159
|
+
|
|
160
|
+
<p>@return [Array]</p>
|
|
161
|
+
|
|
162
|
+
</div>
|
|
163
|
+
</div>
|
|
164
|
+
|
|
165
|
+
<div id="attribute-i-previous" class="method-detail">
|
|
166
|
+
<div class="method-heading attribute-method-heading">
|
|
167
|
+
<span class="method-name">previous</span><span
|
|
168
|
+
class="attribute-access-type">[RW]</span>
|
|
169
|
+
</div>
|
|
170
|
+
|
|
171
|
+
<div class="method-description">
|
|
172
|
+
|
|
173
|
+
<p>Tasks for “Previous” section.</p>
|
|
174
|
+
|
|
175
|
+
<p>@param [Array] previous</p>
|
|
176
|
+
|
|
177
|
+
<p>@return [Array]</p>
|
|
178
|
+
|
|
179
|
+
</div>
|
|
180
|
+
</div>
|
|
181
|
+
|
|
182
|
+
</section>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
187
|
+
<header>
|
|
188
|
+
<h3>Public Class Methods</h3>
|
|
189
|
+
</header>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<div id="method-c-new" class="method-detail ">
|
|
193
|
+
|
|
194
|
+
<div class="method-heading">
|
|
195
|
+
<span class="method-name">new</span><span
|
|
196
|
+
class="method-args">()</span>
|
|
197
|
+
|
|
198
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
199
|
+
|
|
200
|
+
</div>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<div class="method-description">
|
|
204
|
+
|
|
205
|
+
<p>Initializes the config with default values.</p>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<div class="method-source-code" id="new-source">
|
|
211
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 44</span>
|
|
212
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
|
|
213
|
+
<span class="ruby-identifier">reset_values</span>
|
|
214
|
+
<span class="ruby-keyword">end</span></pre>
|
|
215
|
+
</div>
|
|
216
|
+
|
|
217
|
+
</div>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
</div>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
</section>
|
|
226
|
+
|
|
227
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
228
|
+
<header>
|
|
229
|
+
<h3>Public Instance Methods</h3>
|
|
230
|
+
</header>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<div id="method-i-reset_values" class="method-detail ">
|
|
234
|
+
|
|
235
|
+
<div class="method-heading">
|
|
236
|
+
<span class="method-name">reset_values</span><span
|
|
237
|
+
class="method-args">()</span>
|
|
238
|
+
|
|
239
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
240
|
+
|
|
241
|
+
</div>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<div class="method-description">
|
|
245
|
+
|
|
246
|
+
<p>Sets all config values back to their defaults.</p>
|
|
247
|
+
|
|
248
|
+
<p>@return [Boolean] true if successful</p>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<div class="method-source-code" id="reset_values-source">
|
|
254
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 52</span>
|
|
255
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
|
|
256
|
+
<span class="ruby-ivar">@current</span> = [<span class="ruby-string">"<!-- ADD TODAY'S WORK HERE -->"</span>]
|
|
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>
|
|
261
|
+
<span class="ruby-keyword">end</span></pre>
|
|
262
|
+
</div>
|
|
263
|
+
|
|
264
|
+
</div>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
</div>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
</section>
|
|
273
|
+
|
|
274
|
+
</section>
|
|
275
|
+
|
|
276
|
+
</main>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<footer id="validator-badges" role="contentinfo">
|
|
280
|
+
<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.2.1.
|
|
282
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
283
|
+
</footer>
|
|
284
|
+
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class StandupMD::Config::EntryList - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../../";
|
|
11
|
+
var index_rel_prefix = "../../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../../js/search.js" defer></script>
|
|
16
|
+
<script src="../../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
<body id="top" role="document" class="class">
|
|
27
|
+
<nav role="navigation">
|
|
28
|
+
<div id="project-navigation">
|
|
29
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
30
|
+
<h2>
|
|
31
|
+
<a href="../../index.html" rel="home">Home</a>
|
|
32
|
+
</h2>
|
|
33
|
+
|
|
34
|
+
<div id="table-of-contents-navigation">
|
|
35
|
+
<a href="../../table_of_contents.html#pages">Pages</a>
|
|
36
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
37
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
42
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
43
|
+
<div id="search-field-wrapper">
|
|
44
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
45
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
46
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
47
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<ul id="search-results" aria-label="Search Results"
|
|
51
|
+
aria-busy="false" aria-expanded="false"
|
|
52
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
53
|
+
</form>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<div id="class-metadata">
|
|
61
|
+
|
|
62
|
+
<div id="parent-class-section" class="nav-section">
|
|
63
|
+
<h3>Parent</h3>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<p class="link">Object
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<!-- Method Quickref -->
|
|
73
|
+
<div id="method-list-section" class="nav-section">
|
|
74
|
+
<h3>Methods</h3>
|
|
75
|
+
|
|
76
|
+
<ul class="link-list" role="directory">
|
|
77
|
+
|
|
78
|
+
<li ><a href="#method-i-initalize">#initalize</a>
|
|
79
|
+
|
|
80
|
+
<li ><a href="#method-i-reset_values">#reset_values</a>
|
|
81
|
+
|
|
82
|
+
</ul>
|
|
83
|
+
</div>
|
|
84
|
+
|
|
85
|
+
</div>
|
|
86
|
+
</nav>
|
|
87
|
+
|
|
88
|
+
<main role="main" aria-labelledby="class-StandupMD::Config::EntryList">
|
|
89
|
+
<h1 id="class-StandupMD::Config::EntryList" class="class">
|
|
90
|
+
class StandupMD::Config::EntryList
|
|
91
|
+
</h1>
|
|
92
|
+
|
|
93
|
+
<section class="description">
|
|
94
|
+
|
|
95
|
+
<p>The configuration class for <a href="../EntryList.html"><code>StandupMD::EntryList</code></a></p>
|
|
96
|
+
|
|
97
|
+
</section>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
111
|
+
<header>
|
|
112
|
+
<h3>Public Instance Methods</h3>
|
|
113
|
+
</header>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<div id="method-i-initalize" class="method-detail ">
|
|
117
|
+
|
|
118
|
+
<div class="method-heading">
|
|
119
|
+
<span class="method-name">initalize</span><span
|
|
120
|
+
class="method-args">()</span>
|
|
121
|
+
|
|
122
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
123
|
+
|
|
124
|
+
</div>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
<div class="method-description">
|
|
128
|
+
|
|
129
|
+
<p>Initializes the config with default values.</p>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<div class="method-source-code" id="initalize-source">
|
|
135
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 12</span>
|
|
136
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initalize</span>
|
|
137
|
+
<span class="ruby-identifier">reset_values</span>
|
|
138
|
+
<span class="ruby-keyword">end</span></pre>
|
|
139
|
+
</div>
|
|
140
|
+
|
|
141
|
+
</div>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</div>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<div id="method-i-reset_values" class="method-detail ">
|
|
150
|
+
|
|
151
|
+
<div class="method-heading">
|
|
152
|
+
<span class="method-name">reset_values</span><span
|
|
153
|
+
class="method-args">()</span>
|
|
154
|
+
|
|
155
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
156
|
+
|
|
157
|
+
</div>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<div class="method-description">
|
|
161
|
+
|
|
162
|
+
<p>Sets all config values back to their defaults.</p>
|
|
163
|
+
|
|
164
|
+
<p>@return [Boolean] true if successful</p>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<div class="method-source-code" id="reset_values-source">
|
|
170
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 20</span>
|
|
171
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
|
|
172
|
+
<span class="ruby-comment"># TODO add order ascending or decending.</span>
|
|
173
|
+
<span class="ruby-keyword">true</span>
|
|
174
|
+
<span class="ruby-keyword">end</span></pre>
|
|
175
|
+
</div>
|
|
176
|
+
|
|
177
|
+
</div>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
</div>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</section>
|
|
186
|
+
|
|
187
|
+
</section>
|
|
188
|
+
|
|
189
|
+
</main>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<footer id="validator-badges" role="contentinfo">
|
|
193
|
+
<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.2.1.
|
|
195
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
196
|
+
</footer>
|
|
197
|
+
|