standup_md 0.3.4 → 0.3.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +17 -5
- data/doc/README_md.html +24 -17
- data/doc/StandupMD/Cli/Helpers.html +4 -4
- data/doc/StandupMD/Config.html +1 -1
- data/doc/StandupMD/Config/Cli.html +2 -2
- data/doc/StandupMD/Config/File.html +6 -6
- data/doc/StandupMD/Entry.html +7 -7
- data/doc/StandupMD/EntryList.html +109 -187
- data/doc/StandupMD/File.html +3 -3
- data/doc/created.rid +14 -14
- data/doc/index.html +22 -17
- data/doc/js/search_index.js +1 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/table_of_contents.html +49 -57
- data/lib/standup_md/cli/helpers.rb +26 -4
- data/lib/standup_md/entry.rb +1 -1
- data/lib/standup_md/entry_list.rb +19 -36
- data/lib/standup_md/file.rb +2 -2
- data/lib/standup_md/version.rb +1 -1
- 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: dd735414b7813027d5cf22c4296befd4f0f2b5d7e0276c9aa875d913bd69f560
|
4
|
+
data.tar.gz: 5c5bdf62d893c182d5137b46634841f0d576e2798baa918b84b1344d8232890f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1793f0a0b80bcc58ed60c7be24409609aa0b9ccc6f7c1dd26237f1a6b9584219c933b87c60fb1c3c32a2c40aa3e2ba480b1b01541b6a2b91dff8f25c058abd13
|
7
|
+
data.tar.gz: 688cbf9c52807916da3f9320fff8665a2eec816ca86480cd491619541514f858f14a46d365bf99cbadf52dc355d44d8c3915b21303249b87a207958da4cd875c
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -29,6 +29,7 @@ View on: [Github](https://github.com/evanthegrayt/standup_md) |
|
|
29
29
|
- [API](#api)
|
30
30
|
- [API Examples](#api-examples)
|
31
31
|
- [Adding an entry for today](#adding-an-entry-for-today)
|
32
|
+
- [Finding a past entry](#finding-a-past-entry)
|
32
33
|
- [Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html)
|
33
34
|
- [Reporting Bugs and Requesting Features](#reporting-bugs-and-requesting-features)
|
34
35
|
- [Self-Promotion](#self-promotion)
|
@@ -213,7 +214,14 @@ StandupMD.configure do |c|
|
|
213
214
|
end
|
214
215
|
```
|
215
216
|
|
217
|
+
Any options not set in this file will retain their default values. Note that if
|
218
|
+
you change `file_name_format`, and don't use a month or year, there will only
|
219
|
+
ever be one standup file. This could cause issues long-term, as the files will
|
220
|
+
get large over time and possibly cause performance issues.
|
221
|
+
|
222
|
+
|
216
223
|
#### Executable Flags
|
224
|
+
Some of these options can be changed at runtime. They are as follows.
|
217
225
|
```
|
218
226
|
--current ARRAY List of current entry's tasks
|
219
227
|
--previous ARRAY List of precious entry's tasks
|
@@ -232,11 +240,6 @@ end
|
|
232
240
|
DATE must be in the same format as file-name-format
|
233
241
|
```
|
234
242
|
|
235
|
-
Any options not set in this file will retain their default values. Note that if
|
236
|
-
you change `file_name_format`, and don't use a month or year, there will only
|
237
|
-
ever be one standup file. This could cause issues long-term, as the files will
|
238
|
-
get large over time and possibly cause performance issues.
|
239
|
-
|
240
243
|
#### Using Existing Standup Files
|
241
244
|
If you already have a directory of existing standup files, you can use them, but
|
242
245
|
they must be in a format that the parser can understand. The default is:
|
@@ -323,6 +326,15 @@ end
|
|
323
326
|
StandupMD::File.find_by_date(Date.today).load.write
|
324
327
|
```
|
325
328
|
|
329
|
+
#### Finding a past entry
|
330
|
+
```ruby
|
331
|
+
require 'standup_md'
|
332
|
+
|
333
|
+
date = Date.new(2020, 04, 15)
|
334
|
+
file = StandupMD::File.find_by_date(date).load
|
335
|
+
entry = file.entries.find(date)
|
336
|
+
```
|
337
|
+
|
326
338
|
## Reporting Bugs and Requesting Features
|
327
339
|
If you have an idea or find a bug, please [create an
|
328
340
|
issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure the topic
|
data/doc/README_md.html
CHANGED
@@ -79,6 +79,8 @@
|
|
79
79
|
<li><a href="#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
|
80
80
|
<li><a href="#label-API">API</a>
|
81
81
|
<li><a href="#label-API+Examples">API Examples</a>
|
82
|
+
<li><a href="#label-Adding+an+entry+for+today">Adding an entry for today</a>
|
83
|
+
<li><a href="#label-Finding+a+past+entry">Finding a past entry</a>
|
82
84
|
<li><a href="#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
|
83
85
|
<li><a href="#label-Self-Promotion">Self-Promotion</a>
|
84
86
|
</ul>
|
@@ -146,6 +148,10 @@
|
|
146
148
|
<ul><li>
|
147
149
|
<p><a href="#api-examples">API Examples</a></p>
|
148
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>
|
149
155
|
<p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
|
150
156
|
</li></ul>
|
151
157
|
</li><li>
|
@@ -162,6 +168,8 @@
|
|
162
168
|
|
163
169
|
<h2 id="label-Installation">Installation<span><a href="#label-Installation">¶</a> <a href="#top">↑</a></span></h2>
|
164
170
|
|
171
|
+
<p>If you don't have the permissions to install system-wide gems, you're probabaly also running an older version of ruby. I recommend installing <a href="https://github.com/rbenv/rbenv#installation">rbenv</a>, and then installing an up-to-date version of ruby.</p>
|
172
|
+
|
165
173
|
<h3 id="label-Via+RubyGems">Via RubyGems<span><a href="#label-Via+RubyGems">¶</a> <a href="#top">↑</a></span></h3>
|
166
174
|
|
167
175
|
<p>Just install the gem!</p>
|
@@ -250,6 +258,8 @@ rake install
|
|
250
258
|
|
251
259
|
<h4 id="label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults<span><a href="#label-Available+Config+File+Options+and+Defaults">¶</a> <a href="#top">↑</a></span></h4>
|
252
260
|
|
261
|
+
<p>For command-line usage, this file needs to be named <code>~/.standuprc</code>. To use in a rails project, create an initializer (<code>config/initializers/standup_md.rb</code>).</p>
|
262
|
+
|
253
263
|
<pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
|
254
264
|
<span class="ruby-comment"># Defaults for how the file is formatted.</span>
|
255
265
|
<span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
|
@@ -286,25 +296,11 @@ rake install
|
|
286
296
|
<span class="ruby-keyword">end</span>
|
287
297
|
</pre>
|
288
298
|
|
289
|
-
<
|
299
|
+
<p>Any options not set in this file will retain their default values. Note that if you change <code>file_name_format</code>, and don't use a month or year, there will only ever be one standup file. This could cause issues long-term, as the files will get large over time and possibly cause performance issues.</p>
|
290
300
|
|
291
|
-
<
|
292
|
-
--previous ARRAY List of precious entry's tasks
|
293
|
-
--impediments ARRAY List of impediments for current entry
|
294
|
-
--notes ARRAY List of notes for current entry
|
295
|
-
--sub-header-order ARRAY The order of the sub-headers when writing the file
|
296
|
-
-f, --file-name-format STRING Date-formattable string to use for standup file name
|
297
|
-
-E, --editor EDITOR Editor to use for opening standup files
|
298
|
-
-d, --directory DIRECTORY The directories where standup files are located
|
299
|
-
-w --[no-]write Write current entry if it doesn't exist. Default is true
|
300
|
-
-a --[no-]auto-fill-previous Auto-generate 'previous' tasks for new entries
|
301
|
-
-e --[no-]edit Open the file in the editor. Default is true
|
302
|
-
-v, --[no-]verbose Verbose output. Default is false.
|
303
|
-
-p, --print [DATE] Print current entry.
|
304
|
-
If DATE is passed, will print entry for DATE, if it exists.
|
305
|
-
DATE must be in the same format as file-name-format</pre>
|
301
|
+
<h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">¶</a> <a href="#top">↑</a></span></h4>
|
306
302
|
|
307
|
-
<p>
|
303
|
+
<p>Some of these options can be changed at runtime. They are as follows. <code> --current ARRAY List of current entry's tasks --previous ARRAY List of precious entry's tasks --impediments ARRAY List of impediments for current entry --notes ARRAY List of notes for current entry --sub-header-order ARRAY The order of the sub-headers when writing the file -f, --file-name-format STRING Date-formattable string to use for standup file name -E, --editor EDITOR Editor to use for opening standup files -d, --directory DIRECTORY The directories where standup files are located -w --[no-]write Write current entry if it doesn't exist. Default is true -a --[no-]auto-fill-previous Auto-generate 'previous' tasks for new entries -e --[no-]edit Open the file in the editor. Default is true -v, --[no-]verbose Verbose output. Default is false. -p, --print [DATE] Print current entry. If DATE is passed, will print entry for DATE, if it exists. DATE must be in the same format as file-name-format </code></p>
|
308
304
|
|
309
305
|
<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>
|
310
306
|
|
@@ -356,6 +352,8 @@ rake install
|
|
356
352
|
|
357
353
|
<h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">¶</a> <a href="#top">↑</a></span></h3>
|
358
354
|
|
355
|
+
<h4 id="label-Adding+an+entry+for+today">Adding an entry for today<span><a href="#label-Adding+an+entry+for+today">¶</a> <a href="#top">↑</a></span></h4>
|
356
|
+
|
359
357
|
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
360
358
|
|
361
359
|
<span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
|
@@ -380,6 +378,15 @@ rake install
|
|
380
378
|
<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-constant">Date</span>.<span class="ruby-identifier">today</span>).<span class="ruby-identifier">load</span>.<span class="ruby-identifier">write</span>
|
381
379
|
</pre>
|
382
380
|
|
381
|
+
<h4 id="label-Finding+a+past+entry">Finding a past entry<span><a href="#label-Finding+a+past+entry">¶</a> <a href="#top">↑</a></span></h4>
|
382
|
+
|
383
|
+
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
384
|
+
|
385
|
+
<span class="ruby-identifier">date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">2020</span>, <span class="ruby-value">04</span>, <span class="ruby-value">15</span>)
|
386
|
+
<span class="ruby-identifier">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-identifier">date</span>).<span class="ruby-identifier">load</span>
|
387
|
+
<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
|
+
</pre>
|
389
|
+
|
383
390
|
<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>
|
384
391
|
|
385
392
|
<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>
|
@@ -133,11 +133,11 @@
|
|
133
133
|
<span class="ruby-identifier">puts</span> <span class="ruby-node">"No record found for #{StandupMD.config.cli.date}"</span>
|
134
134
|
<span class="ruby-keyword">return</span>
|
135
135
|
<span class="ruby-keyword">end</span>
|
136
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-
|
137
|
-
<span class="ruby-constant">StandupMD</span>.<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">
|
138
|
-
<span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">
|
136
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-identifier">entry</span>)
|
137
|
+
<span class="ruby-constant">StandupMD</span>.<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
|
+
<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
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-
|
140
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">sub_header</span>(<span class="ruby-identifier">header_type</span>)
|
141
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-constant">StandupMD</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
142
|
<span class="ruby-keyword">end</span>
|
143
143
|
<span class="ruby-identifier">puts</span>
|
data/doc/StandupMD/Config.html
CHANGED
@@ -198,7 +198,7 @@
|
|
198
198
|
|
199
199
|
|
200
200
|
<div class="method-source-code" id="new-source">
|
201
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config.rb, line
|
201
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config.rb, line 40</span>
|
202
202
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
|
203
203
|
<span class="ruby-ivar">@cli</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">Cli</span>.<span class="ruby-identifier">new</span>
|
204
204
|
<span class="ruby-ivar">@file</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">File</span>.<span class="ruby-identifier">new</span>
|
@@ -292,7 +292,7 @@
|
|
292
292
|
|
293
293
|
|
294
294
|
<div class="method-source-code" id="new-source">
|
295
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line
|
295
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 96</span>
|
296
296
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
|
297
297
|
<span class="ruby-identifier">reset</span>
|
298
298
|
<span class="ruby-keyword">end</span></pre>
|
@@ -335,7 +335,7 @@
|
|
335
335
|
|
336
336
|
|
337
337
|
<div class="method-source-code" id="reset-source">
|
338
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line
|
338
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 104</span>
|
339
339
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
|
340
340
|
<span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">"@#{k}"</span>, <span class="ruby-identifier">v</span>) }
|
341
341
|
<span class="ruby-keyword">end</span></pre>
|
@@ -380,7 +380,7 @@
|
|
380
380
|
|
381
381
|
|
382
382
|
<div class="method-source-code" id="new-source">
|
383
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line
|
383
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 140</span>
|
384
384
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
|
385
385
|
<span class="ruby-identifier">reset</span>
|
386
386
|
<span class="ruby-keyword">end</span></pre>
|
@@ -425,7 +425,7 @@
|
|
425
425
|
|
426
426
|
|
427
427
|
<div class="method-source-code" id="bullet_character-3D-source">
|
428
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line
|
428
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 189</span>
|
429
429
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bullet_character=</span>(<span class="ruby-identifier">char</span>)
|
430
430
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Must be "-" or "*"'</span> <span class="ruby-keyword">unless</span> <span class="ruby-node">%w[- *]</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">char</span>)
|
431
431
|
<span class="ruby-ivar">@bullet_character</span> = <span class="ruby-identifier">char</span>
|
@@ -463,7 +463,7 @@
|
|
463
463
|
|
464
464
|
|
465
465
|
<div class="method-source-code" id="directory-3D-source">
|
466
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line
|
466
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 202</span>
|
467
467
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">directory=</span>(<span class="ruby-identifier">directory</span>)
|
468
468
|
<span class="ruby-identifier">directory</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">directory</span>)
|
469
469
|
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">directory</span>) <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">directory</span>)
|
@@ -502,7 +502,7 @@
|
|
502
502
|
|
503
503
|
|
504
504
|
<div class="method-source-code" id="header_depth-3D-source">
|
505
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line
|
505
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 158</span>
|
506
506
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">header_depth=</span>(<span class="ruby-identifier">depth</span>)
|
507
507
|
<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>)
|
508
508
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Header depth out of bounds (1..5)'</span>
|
@@ -542,7 +542,7 @@
|
|
542
542
|
|
543
543
|
|
544
544
|
<div class="method-source-code" id="reset-source">
|
545
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line
|
545
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 148</span>
|
546
546
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
|
547
547
|
<span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">"@#{k}"</span>, <span class="ruby-identifier">v</span>) }
|
548
548
|
<span class="ruby-keyword">end</span></pre>
|
@@ -579,7 +579,7 @@
|
|
579
579
|
|
580
580
|
|
581
581
|
<div class="method-source-code" id="sub_header_depth-3D-source">
|
582
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line
|
582
|
+
<pre><span class="ruby-comment"># File lib/standup_md/config/file.rb, line 174</span>
|
583
583
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sub_header_depth=</span>(<span class="ruby-identifier">depth</span>)
|
584
584
|
<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>)
|
585
585
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Sub-header depth out of bounds (2..6)'</span>
|
data/doc/StandupMD/Entry.html
CHANGED
@@ -170,7 +170,7 @@
|
|
170
170
|
|
171
171
|
<div class="method-description">
|
172
172
|
|
173
|
-
<p>
|
173
|
+
<p>Impediments for this entry.</p>
|
174
174
|
|
175
175
|
<p>@return [Array]</p>
|
176
176
|
|
@@ -238,7 +238,7 @@
|
|
238
238
|
|
239
239
|
|
240
240
|
<div class="method-source-code" id="config-source">
|
241
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line
|
241
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 17</span>
|
242
242
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
|
243
243
|
<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">entry</span>
|
244
244
|
<span class="ruby-keyword">end</span></pre>
|
@@ -273,7 +273,7 @@
|
|
273
273
|
|
274
274
|
|
275
275
|
<div class="method-source-code" id="create-source">
|
276
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line
|
276
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 58</span>
|
277
277
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create</span>
|
278
278
|
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">new</span>(
|
279
279
|
<span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>,
|
@@ -324,7 +324,7 @@
|
|
324
324
|
|
325
325
|
|
326
326
|
<div class="method-source-code" id="new-source">
|
327
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line
|
327
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 82</span>
|
328
328
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">date</span>, <span class="ruby-identifier">current</span>, <span class="ruby-identifier">previous</span>, <span class="ruby-identifier">impediments</span>, <span class="ruby-identifier">notes</span> = [])
|
329
329
|
<span class="ruby-identifier">raise</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Date</span>)
|
330
330
|
<span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
|
@@ -372,7 +372,7 @@
|
|
372
372
|
|
373
373
|
|
374
374
|
<div class="method-source-code" id="3C-3D-3E-source">
|
375
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line
|
375
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 95</span>
|
376
376
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span>(<span class="ruby-identifier">other</span>)
|
377
377
|
<span class="ruby-identifier">date</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">date</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="to_h-source">
|
410
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line
|
410
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 103</span>
|
411
411
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
|
412
412
|
{
|
413
413
|
<span class="ruby-identifier">date</span> <span class="ruby-operator">=></span> {
|
@@ -449,7 +449,7 @@
|
|
449
449
|
|
450
450
|
|
451
451
|
<div class="method-source-code" id="to_json-source">
|
452
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line
|
452
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry.rb, line 118</span>
|
453
453
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
|
454
454
|
<span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
|
455
455
|
<span class="ruby-keyword">end</span></pre>
|
@@ -58,7 +58,18 @@
|
|
58
58
|
|
59
59
|
|
60
60
|
<div id="class-metadata">
|
61
|
+
<div id="sections-section" class="nav-section">
|
62
|
+
<h3>Sections</h3>
|
63
|
+
|
64
|
+
<ul class="link-list" role="directory">
|
65
|
+
|
66
|
+
<li><a href="#5Buntitled-5D"></a></li>
|
67
|
+
|
68
|
+
<li><a href="#Delegators">Delegators</a></li>
|
61
69
|
|
70
|
+
</ul>
|
71
|
+
</div>
|
72
|
+
|
62
73
|
<div id="parent-class-section" class="nav-section">
|
63
74
|
<h3>Parent</h3>
|
64
75
|
|
@@ -79,7 +90,18 @@
|
|
79
90
|
</ul>
|
80
91
|
</div>
|
81
92
|
|
93
|
+
<div id="extends-section" class="nav-section">
|
94
|
+
<h3>Extended With Modules</h3>
|
95
|
+
|
96
|
+
<ul class="link-list">
|
82
97
|
|
98
|
+
|
99
|
+
<li><span class="extend">Forwardable</span>
|
100
|
+
|
101
|
+
|
102
|
+
</ul>
|
103
|
+
</div>
|
104
|
+
|
83
105
|
<!-- Method Quickref -->
|
84
106
|
<div id="method-list-section" class="nav-section">
|
85
107
|
<h3>Methods</h3>
|
@@ -92,9 +114,7 @@
|
|
92
114
|
|
93
115
|
<li ><a href="#method-i-3C-3C">#<<</a>
|
94
116
|
|
95
|
-
<li ><a href="#method-i-
|
96
|
-
|
97
|
-
<li ><a href="#method-i-empty-3F">#empty?</a>
|
117
|
+
<li ><a href="#method-i-40entries">#@entries</a>
|
98
118
|
|
99
119
|
<li ><a href="#method-i-filter">#filter</a>
|
100
120
|
|
@@ -102,12 +122,6 @@
|
|
102
122
|
|
103
123
|
<li ><a href="#method-i-find">#find</a>
|
104
124
|
|
105
|
-
<li ><a href="#method-i-first">#first</a>
|
106
|
-
|
107
|
-
<li ><a href="#method-i-last">#last</a>
|
108
|
-
|
109
|
-
<li ><a href="#method-i-size">#size</a>
|
110
|
-
|
111
125
|
<li ><a href="#method-i-sort">#sort</a>
|
112
126
|
|
113
127
|
<li ><a href="#method-i-sort-21">#sort!</a>
|
@@ -173,7 +187,7 @@
|
|
173
187
|
|
174
188
|
|
175
189
|
<div class="method-source-code" id="config-source">
|
176
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
190
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 16</span>
|
177
191
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
|
178
192
|
<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">entry_list</span>
|
179
193
|
<span class="ruby-keyword">end</span></pre>
|
@@ -210,7 +224,7 @@
|
|
210
224
|
|
211
225
|
|
212
226
|
<div class="method-source-code" id="new-source">
|
213
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
227
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 26</span>
|
214
228
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">entries</span>)
|
215
229
|
<span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
|
216
230
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Entry</span>) }
|
@@ -259,7 +273,7 @@
|
|
259
273
|
|
260
274
|
|
261
275
|
<div class="method-source-code" id="3C-3C-source">
|
262
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
276
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 40</span>
|
263
277
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">entry</span>)
|
264
278
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Entry</span>)
|
265
279
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Entry must instance of StandupMD::Entry'</span>
|
@@ -273,74 +287,6 @@
|
|
273
287
|
|
274
288
|
|
275
289
|
|
276
|
-
</div>
|
277
|
-
|
278
|
-
|
279
|
-
<div id="method-i-each" class="method-detail ">
|
280
|
-
|
281
|
-
<div class="method-heading">
|
282
|
-
<span class="method-name">each</span><span
|
283
|
-
class="method-args">(&block)</span>
|
284
|
-
|
285
|
-
<span class="method-click-advice">click to toggle source</span>
|
286
|
-
|
287
|
-
</div>
|
288
|
-
|
289
|
-
|
290
|
-
<div class="method-description">
|
291
|
-
|
292
|
-
<p>Iterate over the list and yield each entry.</p>
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
<div class="method-source-code" id="each-source">
|
298
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 34</span>
|
299
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
300
|
-
<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
301
|
-
<span class="ruby-keyword">end</span></pre>
|
302
|
-
</div>
|
303
|
-
|
304
|
-
</div>
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
</div>
|
310
|
-
|
311
|
-
|
312
|
-
<div id="method-i-empty-3F" class="method-detail ">
|
313
|
-
|
314
|
-
<div class="method-heading">
|
315
|
-
<span class="method-name">empty?</span><span
|
316
|
-
class="method-args">()</span>
|
317
|
-
|
318
|
-
<span class="method-click-advice">click to toggle source</span>
|
319
|
-
|
320
|
-
</div>
|
321
|
-
|
322
|
-
|
323
|
-
<div class="method-description">
|
324
|
-
|
325
|
-
<p>Is the list empty?</p>
|
326
|
-
|
327
|
-
<p>@return [Boolean] true if empty</p>
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
<div class="method-source-code" id="empty-3F-source">
|
333
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 162</span>
|
334
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
|
335
|
-
<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">empty?</span>
|
336
|
-
<span class="ruby-keyword">end</span></pre>
|
337
|
-
</div>
|
338
|
-
|
339
|
-
</div>
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
290
|
</div>
|
345
291
|
|
346
292
|
|
@@ -429,7 +375,7 @@
|
|
429
375
|
|
430
376
|
<div class="method-heading">
|
431
377
|
<span class="method-name">find</span><span
|
432
|
-
class="method-args">(
|
378
|
+
class="method-args">(date)</span>
|
433
379
|
|
434
380
|
<span class="method-click-advice">click to toggle source</span>
|
435
381
|
|
@@ -439,119 +385,18 @@
|
|
439
385
|
<div class="method-description">
|
440
386
|
|
441
387
|
<p>Finds an entry based on date. This method assumes the list has already been sorted.</p>
|
442
|
-
|
443
|
-
|
444
388
|
|
445
|
-
|
446
|
-
<div class="method-source-code" id="find-source">
|
447
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 54</span>
|
448
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">key</span>)
|
449
|
-
<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">bsearch</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">key</span> }
|
450
|
-
<span class="ruby-keyword">end</span></pre>
|
451
|
-
</div>
|
452
|
-
|
453
|
-
</div>
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
</div>
|
459
|
-
|
460
|
-
|
461
|
-
<div id="method-i-first" class="method-detail ">
|
462
|
-
|
463
|
-
<div class="method-heading">
|
464
|
-
<span class="method-name">first</span><span
|
465
|
-
class="method-args">()</span>
|
466
|
-
|
467
|
-
<span class="method-click-advice">click to toggle source</span>
|
468
|
-
|
469
|
-
</div>
|
470
|
-
|
471
|
-
|
472
|
-
<div class="method-description">
|
473
|
-
|
474
|
-
<p>The first entry in the list. This method assumes the list has already been sorted.</p>
|
389
|
+
<p>@param [Date] date</p>
|
475
390
|
|
476
391
|
<p>@return [StandupMD::Entry]</p>
|
477
392
|
|
478
393
|
|
479
394
|
|
480
395
|
|
481
|
-
<div class="method-source-code" id="
|
482
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line
|
483
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">
|
484
|
-
<span class="ruby-identifier">
|
485
|
-
<span class="ruby-keyword">end</span></pre>
|
486
|
-
</div>
|
487
|
-
|
488
|
-
</div>
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
</div>
|
494
|
-
|
495
|
-
|
496
|
-
<div id="method-i-last" class="method-detail ">
|
497
|
-
|
498
|
-
<div class="method-heading">
|
499
|
-
<span class="method-name">last</span><span
|
500
|
-
class="method-args">()</span>
|
501
|
-
|
502
|
-
<span class="method-click-advice">click to toggle source</span>
|
503
|
-
|
504
|
-
</div>
|
505
|
-
|
506
|
-
|
507
|
-
<div class="method-description">
|
508
|
-
|
509
|
-
<p>The last entry in the list. This method assumes the list has already been sorted.</p>
|
510
|
-
|
511
|
-
<p>@return [StandupMD::Entry]</p>
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
<div class="method-source-code" id="last-source">
|
517
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 146</span>
|
518
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">last</span>
|
519
|
-
<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">last</span>
|
520
|
-
<span class="ruby-keyword">end</span></pre>
|
521
|
-
</div>
|
522
|
-
|
523
|
-
</div>
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
</div>
|
529
|
-
|
530
|
-
|
531
|
-
<div id="method-i-size" class="method-detail ">
|
532
|
-
|
533
|
-
<div class="method-heading">
|
534
|
-
<span class="method-name">size</span><span
|
535
|
-
class="method-args">()</span>
|
536
|
-
|
537
|
-
<span class="method-click-advice">click to toggle source</span>
|
538
|
-
|
539
|
-
</div>
|
540
|
-
|
541
|
-
|
542
|
-
<div class="method-description">
|
543
|
-
|
544
|
-
<p>How many entries are in the list.</p>
|
545
|
-
|
546
|
-
<p>@return [Integer]</p>
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
<div class="method-source-code" id="size-source">
|
552
|
-
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 154</span>
|
553
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
|
554
|
-
<span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">size</span>
|
396
|
+
<div class="method-source-code" id="find-source">
|
397
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 54</span>
|
398
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">date</span>)
|
399
|
+
<span class="ruby-identifier">entries</span>.<span class="ruby-identifier">bsearch</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">date</span> }
|
555
400
|
<span class="ruby-keyword">end</span></pre>
|
556
401
|
</div>
|
557
402
|
|
@@ -741,6 +586,83 @@
|
|
741
586
|
|
742
587
|
|
743
588
|
|
589
|
+
</div>
|
590
|
+
|
591
|
+
|
592
|
+
</section>
|
593
|
+
|
594
|
+
</section>
|
595
|
+
|
596
|
+
<section id="Delegators" class="documentation-section">
|
597
|
+
|
598
|
+
<header class="documentation-section-title">
|
599
|
+
<h2>
|
600
|
+
Delegators
|
601
|
+
</h2>
|
602
|
+
<span class="section-click-top">
|
603
|
+
<a href="#top">↑ top</a>
|
604
|
+
</span>
|
605
|
+
</header>
|
606
|
+
|
607
|
+
|
608
|
+
|
609
|
+
|
610
|
+
|
611
|
+
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
<section id="public-instance-Delegators-method-details" class="method-section">
|
616
|
+
<header>
|
617
|
+
<h3>Public Instance Methods</h3>
|
618
|
+
</header>
|
619
|
+
|
620
|
+
|
621
|
+
<div id="method-i-40entries" class="method-detail ">
|
622
|
+
|
623
|
+
<div class="method-heading">
|
624
|
+
<span class="method-name">@entries</span><span
|
625
|
+
class="method-args">()</span>
|
626
|
+
|
627
|
+
<span class="method-click-advice">click to toggle source</span>
|
628
|
+
|
629
|
+
</div>
|
630
|
+
|
631
|
+
|
632
|
+
<div class="method-description">
|
633
|
+
|
634
|
+
<p>The following are forwarded to @entries, which is the underly array of entries.</p>
|
635
|
+
<dl class="rdoc-list note-list"><dt><code>each</code>
|
636
|
+
<dd>
|
637
|
+
<p>Iterate over each entry.</p>
|
638
|
+
</dd><dt><code>empty?</code>
|
639
|
+
<dd>
|
640
|
+
<p>Is the list empty?</p>
|
641
|
+
</dd><dt><code>size</code>
|
642
|
+
<dd>
|
643
|
+
<p>How many items are in the list?</p>
|
644
|
+
</dd><dt><code>first</code>
|
645
|
+
<dd>
|
646
|
+
<p>The first record in the list.</p>
|
647
|
+
</dd><dt><code>last</code>
|
648
|
+
<dd>
|
649
|
+
<p>The last record in the list.</p>
|
650
|
+
</dd></dl>
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
|
655
|
+
<div class="method-source-code" id="40entries-source">
|
656
|
+
<pre><span class="ruby-comment"># File lib/standup_md/entry_list.rb, line 147</span>
|
657
|
+
<span class="ruby-identifier">def_delegators</span> <span class="ruby-value">:@entries</span>, <span class="ruby-value">:each</span>, <span class="ruby-value">:empty?</span>, <span class="ruby-value">:size</span>, <span class="ruby-value">:first</span>, <span class="ruby-value">:last</span>
|
658
|
+
</pre>
|
659
|
+
</div>
|
660
|
+
|
661
|
+
</div>
|
662
|
+
|
663
|
+
|
664
|
+
|
665
|
+
|
744
666
|
</div>
|
745
667
|
|
746
668
|
|