standup_md 0.3.6 → 0.3.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +9 -20
  4. data/doc/README_md.html +9 -22
  5. data/doc/StandupMD.html +14 -85
  6. data/doc/StandupMD/Cli.html +17 -159
  7. data/doc/StandupMD/Cli/Helpers.html +5 -27
  8. data/doc/StandupMD/Config.html +7 -44
  9. data/doc/StandupMD/Config/Cli.html +8 -76
  10. data/doc/StandupMD/Config/Entry.html +8 -64
  11. data/doc/StandupMD/Config/EntryList.html +7 -48
  12. data/doc/StandupMD/Config/File.html +11 -143
  13. data/doc/StandupMD/Entry.html +22 -133
  14. data/doc/StandupMD/EntryList.html +16 -198
  15. data/doc/StandupMD/File.html +31 -165
  16. data/doc/StandupMD/Version.html +63 -40
  17. data/doc/created.rid +9 -9
  18. data/doc/css/rdoc.css +1 -1
  19. data/doc/index.html +9 -36
  20. data/doc/js/navigation.js.gz +0 -0
  21. data/doc/js/search_index.js +1 -1
  22. data/doc/js/search_index.js.gz +0 -0
  23. data/doc/js/searcher.js.gz +0 -0
  24. data/doc/table_of_contents.html +42 -94
  25. data/lib/standup_md.rb +8 -5
  26. data/lib/standup_md/cli.rb +7 -7
  27. data/lib/standup_md/cli/helpers.rb +10 -13
  28. data/lib/standup_md/config/file.rb +3 -3
  29. data/lib/standup_md/entry.rb +7 -9
  30. data/lib/standup_md/entry_list.rb +2 -2
  31. data/lib/standup_md/version.rb +26 -4
  32. metadata +2 -2
data/doc/StandupMD/Version.html CHANGED
@@ -21,8 +21,6 @@
21
21
  <link href="../css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
-
26
24
  <body id="top" role="document" class="module">
27
25
  <nav role="navigation">
28
26
  <div id="project-navigation">
@@ -62,14 +60,15 @@
62
60
 
63
61
 
64
62
 
65
- <!-- Method Quickref -->
63
+
64
+ <!-- Method Quickref -->
66
65
  <div id="method-list-section" class="nav-section">
67
66
  <h3>Methods</h3>
68
67
 
69
68
  <ul class="link-list" role="directory">
70
-
69
+ <li ><a href="#method-c-to_a">::to_a</a>
70
+ <li ><a href="#method-c-to_h">::to_h</a>
71
71
  <li ><a href="#method-c-to_s">::to_s</a>
72
-
73
72
  </ul>
74
73
  </div>
75
74
 
@@ -87,90 +86,114 @@
87
86
 
88
87
  </section>
89
88
 
90
-
91
89
  <section id="5Buntitled-5D" class="documentation-section">
92
-
93
90
 
94
-
95
91
 
96
-
97
92
  <section class="constants-list">
98
93
  <header>
99
94
  <h3>Constants</h3>
100
95
  </header>
101
96
  <dl>
102
-
103
97
  <dt id="MAJOR">MAJOR
104
-
105
98
  <dd><p>Major version.</p>
106
-
107
-
99
+
100
+ <p>@return [Integer]</p>
108
101
  <dt id="MINOR">MINOR
109
-
110
102
  <dd><p>Minor version.</p>
111
-
112
-
103
+
104
+ <p>@return [Integer]</p>
113
105
  <dt id="PATCH">PATCH
114
-
115
106
  <dd><p>Patch version.</p>
116
-
117
-
107
+
108
+ <p>@return [Integer]</p>
118
109
  </dl>
119
110
  </section>
120
-
121
111
 
122
-
123
112
 
124
-
113
+
125
114
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
126
115
  <header>
127
116
  <h3>Public Class Methods</h3>
128
117
  </header>
129
118
 
130
-
119
+ <div id="method-c-to_a" class="method-detail ">
120
+ <div class="method-heading">
121
+ <span class="method-name">to_a</span><span
122
+ class="method-args">()</span>
123
+ <span class="method-click-advice">click to toggle source</span>
124
+ </div>
125
+
126
+ <div class="method-description">
127
+ <p><a href="Version.html"><code>Version</code></a> as +[MAJOR, <a href="Version.html#MINOR"><code>MINOR</code></a>, PATCH]+</p>
128
+
129
+ <p>@return [Array]</p>
130
+
131
+ <div class="method-source-code" id="to_a-source">
132
+ <pre><span class="ruby-comment"># File lib/standup_md/version.rb, line 30</span>
133
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">to_a</span>
134
+ [<span class="ruby-constant">MAJOR</span>, <span class="ruby-constant">MINOR</span>, <span class="ruby-constant">PATCH</span>]
135
+ <span class="ruby-keyword">end</span></pre>
136
+ </div>
137
+ </div>
138
+
139
+
140
+ </div>
141
+
142
+ <div id="method-c-to_h" class="method-detail ">
143
+ <div class="method-heading">
144
+ <span class="method-name">to_h</span><span
145
+ class="method-args">()</span>
146
+ <span class="method-click-advice">click to toggle source</span>
147
+ </div>
148
+
149
+ <div class="method-description">
150
+ <p><a href="Version.html"><code>Version</code></a> as +{major: <a href="Version.html#MAJOR"><code>MAJOR</code></a>, minor: <a href="Version.html#MINOR"><code>MINOR</code></a>, patch: PATCH}+</p>
151
+
152
+ <p>@return [Hash]</p>
153
+
154
+ <div class="method-source-code" id="to_h-source">
155
+ <pre><span class="ruby-comment"># File lib/standup_md/version.rb, line 46</span>
156
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">to_h</span>
157
+ <span class="ruby-constant">Hash</span>[<span class="ruby-node">%i[major minor patch]</span>.<span class="ruby-identifier">zip</span>(<span class="ruby-identifier">to_a</span>)]
158
+ <span class="ruby-keyword">end</span></pre>
159
+ </div>
160
+ </div>
161
+
162
+
163
+ </div>
164
+
131
165
  <div id="method-c-to_s" class="method-detail ">
132
-
133
166
  <div class="method-heading">
134
167
  <span class="method-name">to_s</span><span
135
168
  class="method-args">()</span>
136
-
137
169
  <span class="method-click-advice">click to toggle source</span>
138
-
139
170
  </div>
140
-
141
171
 
142
172
  <div class="method-description">
143
-
144
173
  <p><a href="Version.html"><code>Version</code></a> as <code>MAJOR.MINOR.PATCH</code></p>
145
-
146
-
147
174
 
148
-
175
+ <p>@return [String]</p>
176
+
149
177
  <div class="method-source-code" id="to_s-source">
150
- <pre><span class="ruby-comment"># File lib/standup_md/version.rb, line 24</span>
178
+ <pre><span class="ruby-comment"># File lib/standup_md/version.rb, line 38</span>
151
179
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">to_s</span>
152
- <span class="ruby-node">&quot;#{MAJOR}.#{MINOR}.#{PATCH}&quot;</span>
180
+ <span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;.&#39;</span>)
153
181
  <span class="ruby-keyword">end</span></pre>
154
182
  </div>
155
-
156
183
  </div>
157
184
 
158
-
159
185
 
160
-
161
186
  </div>
162
187
 
163
-
164
188
  </section>
165
-
166
- </section>
167
189
 
190
+ </section>
168
191
  </main>
169
192
 
170
193
 
171
194
  <footer id="validator-badges" role="contentinfo">
172
195
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
173
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
196
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
174
197
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
175
198
  </footer>
176
199
 
data/doc/created.rid CHANGED
@@ -1,15 +1,15 @@
1
- Mon, 12 Apr 2021 21:53:43 -0500
2
- README.md Mon, 12 Apr 2021 21:53:19 -0500
3
- lib/standup_md.rb Tue, 13 Oct 2020 21:04:02 -0500
4
- lib/standup_md/cli.rb Tue, 13 Oct 2020 21:04:02 -0500
5
- lib/standup_md/cli/helpers.rb Tue, 13 Oct 2020 21:49:05 -0500
1
+ Sat, 08 May 2021 00:34:36 -0500
2
+ README.md Fri, 07 May 2021 17:33:37 -0500
3
+ lib/standup_md.rb Fri, 07 May 2021 23:55:13 -0500
4
+ lib/standup_md/cli.rb Sat, 08 May 2021 00:01:31 -0500
5
+ lib/standup_md/cli/helpers.rb Fri, 07 May 2021 23:53:07 -0500
6
6
  lib/standup_md/config.rb Tue, 13 Oct 2020 21:04:02 -0500
7
7
  lib/standup_md/config/cli.rb Tue, 13 Oct 2020 21:04:02 -0500
8
8
  lib/standup_md/config/entry.rb Tue, 13 Oct 2020 21:04:02 -0500
9
9
  lib/standup_md/config/entry_list.rb Wed, 17 Jun 2020 08:47:50 -0500
10
- lib/standup_md/config/file.rb Wed, 17 Jun 2020 08:47:50 -0500
11
- lib/standup_md/entry.rb Tue, 17 Nov 2020 11:34:44 -0600
10
+ lib/standup_md/config/file.rb Fri, 07 May 2021 23:57:01 -0500
11
+ lib/standup_md/entry.rb Fri, 07 May 2021 23:57:15 -0500
12
12
  lib/standup_md/entry_list.rb Mon, 12 Apr 2021 21:51:46 -0500
13
- lib/standup_md/file.rb Tue, 13 Oct 2020 21:04:02 -0500
13
+ lib/standup_md/file.rb Mon, 26 Apr 2021 09:04:06 -0500
14
14
  lib/standup_md/file/helpers.rb Tue, 13 Oct 2020 21:04:02 -0500
15
- lib/standup_md/version.rb Thu, 25 Jun 2020 17:00:46 -0500
15
+ lib/standup_md/version.rb Sat, 08 May 2021 00:33:30 -0500
data/doc/css/rdoc.css CHANGED
@@ -276,7 +276,7 @@ ul.link-list .type {
276
276
  -webkit-border-radius: 5px;
277
277
  }
278
278
 
279
- dl.label-list dt {
279
+ dl.note-list dt {
280
280
  float: left;
281
281
  margin-right: 1em;
282
282
  }
data/doc/index.html CHANGED
@@ -21,8 +21,6 @@
21
21
  <link href="./css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
-
26
24
  <body id="top" role="document" class="file">
27
25
  <nav role="navigation">
28
26
  <div id="project-navigation">
@@ -57,13 +55,12 @@
57
55
  </div>
58
56
 
59
57
  <div id="project-metadata">
60
- <div id="fileindex-section" class="nav-section">
58
+
59
+ <div id="fileindex-section" class="nav-section">
61
60
  <h3>Pages</h3>
62
61
 
63
62
  <ul class="link-list">
64
-
65
63
  <li><a href="./README_md.html">README</a>
66
-
67
64
  </ul>
68
65
  </div>
69
66
 
@@ -71,31 +68,18 @@
71
68
  <h3>Class and Module Index</h3>
72
69
 
73
70
  <ul class="link-list">
74
-
75
71
  <li><a href="./StandupMD.html">StandupMD</a>
76
-
77
72
  <li><a href="./StandupMD/Cli.html">StandupMD::Cli</a>
78
-
79
73
  <li><a href="./StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
80
-
81
74
  <li><a href="./StandupMD/Config.html">StandupMD::Config</a>
82
-
83
75
  <li><a href="./StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
84
-
85
76
  <li><a href="./StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
86
-
87
77
  <li><a href="./StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
88
-
89
78
  <li><a href="./StandupMD/Config/File.html">StandupMD::Config::File</a>
90
-
91
79
  <li><a href="./StandupMD/Entry.html">StandupMD::Entry</a>
92
-
93
80
  <li><a href="./StandupMD/EntryList.html">StandupMD::EntryList</a>
94
-
95
81
  <li><a href="./StandupMD/File.html">StandupMD::File</a>
96
-
97
82
  <li><a href="./StandupMD/Version.html">StandupMD::Version</a>
98
-
99
83
  </ul>
100
84
  </div>
101
85
 
@@ -193,17 +177,11 @@ rake install</pre>
193
177
  <pre class="ruby"><span class="ruby-identifier">standup</span> <span class="ruby-operator">-</span><span class="ruby-identifier">p</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">pbcopy</span>
194
178
  </pre>
195
179
 
196
- <p>If you wanted to add today&#39;s entry without opening your editor, and print the result to the command line, you could use the following.</p>
197
-
198
180
  <h4 id="label-Add+entry+to+file+without+opening+it">Add entry to file without opening it<span><a href="#label-Add+entry+to+file+without+opening+it">&para;</a> <a href="#top">&uarr;</a></span></h4>
199
181
 
200
- <pre>standup --no-edit --current &quot;Work on this thing&quot;,&quot;And another thing&quot;</pre>
201
-
202
- <h4 id="label-Find+an+entry+by+date+and+print+it.">Find an entry by date and print it.<span><a href="#label-Find+an+entry+by+date+and+print+it.">&para;</a> <a href="#top">&uarr;</a></span></h4>
182
+ <p>You can add an entry for today without even opening your editor. Note that, if you have multiple entries, you must separate them with a comma and <em>no spaces</em>.</p>
203
183
 
204
- <p>If you wanted to find and print the entry for March 2nd, 2020, you could use the following.</p>
205
-
206
- <pre>standup -p 2020-03-02</pre>
184
+ <pre>standup --no-edit --current &quot;Work on this thing&quot;,&quot;And another thing&quot;</pre>
207
185
 
208
186
  <h3 id="label-Customization+and+Runtime+Options">Customization and Runtime Options<span><a href="#label-Customization+and+Runtime+Options">&para;</a> <a href="#top">&uarr;</a></span></h3>
209
187
 
@@ -321,7 +299,7 @@ rake install</pre>
321
299
 
322
300
  <p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">RDoc Documentation</a>.</p>
323
301
 
324
- <p>This was mainly written as a command line utility, but the API is ridiculously robust, and is available for use in your own projects. A quick example of how to write a new entry via code could look like the following:</p>
302
+ <p>This was mainly written as a command line utility, but the API is very robust, and is available for use in your own projects. A quick example of how to write a new entry via code could look like the following:</p>
325
303
 
326
304
  <h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
327
305
 
@@ -364,16 +342,13 @@ rake install</pre>
364
342
 
365
343
  <p>While there&#39;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>
366
344
 
367
- <pre>if executable(&#39;standup&#39;)
368
- command! -complete=custom,s:StandupCompletion -nargs=? -bang Standup
369
- \ call s:OpenStandupFile(&lt;bang&gt;0, &lt;f-args&gt;)
370
- endif
345
+ <pre>command! -complete=custom,&lt;SID&gt;StandupCompletion -nargs=? -bang Standup
346
+ \ call &lt;SID&gt;OpenStandupFile(&lt;bang&gt;0, &lt;f-args&gt;)
371
347
 
372
348
  function! s:StandupCompletion(...) abort
373
349
  let l:dir = get(g:, &#39;standup_dir&#39;, $HOME . &#39;/.cache/standup_md&#39;) . &#39;/&#39;
374
350
  if !isdirectory(l:dir) | return &#39;&#39; | endif
375
- let l:list = glob(l:dir . &#39;*.md&#39;, 0, 1)
376
- return join(map(l:list, &quot;substitute(v:val, l:dir, &#39;&#39;, &#39;&#39;)&quot;), &quot;\n&quot;)
351
+ return join(map(glob(l:dir . &#39;*.md&#39;, 0, 1), &quot;fnamemodify(v:val, &#39;:t&#39;)&quot;), &quot;\n&quot;)
377
352
  endfunction
378
353
 
379
354
  function! s:OpenStandupFile(split, ...)
@@ -396,14 +371,12 @@ g:standup_file = strftime(&#39;%Y_%m.md&#39;) &quot; the file format to u
396
371
 
397
372
  <p>I do these projects for fun, and I enjoy knowing that they&#39;re helpful to people. Consider starring <a href="https://github.com/evanthegrayt/standup_md">the repository</a> if you like it! If you love it, follow me <a href="https://github.com/evanthegrayt">on Github</a>!</p>
398
373
 
399
-
400
374
  </main>
401
375
 
402
376
 
403
-
404
377
  <footer id="validator-badges" role="contentinfo">
405
378
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
406
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
379
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
407
380
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
408
381
  </footer>
409
382
 
data/doc/js/navigation.js.gz CHANGED
Binary file
data/doc/js/search_index.js CHANGED
@@ -1 +1 @@
1
- var search_data = {"index":{"searchIndex":["standupmd","cli","helpers","config","cli","entry","entrylist","file","entry","entrylist","file","version","<<()","<=>()","@entries()","bullet_character=()","config()","config()","config()","config()","config()","config_file_loaded?()","configure()","create()","directory=()","echo()","echo()","edit()","execute()","exist?()","filter()","filter!()","find()","find()","find_by_date()","header_depth=()","initalize()","load()","load()","load_config_file()","load_preferences()","loaded?()","new()","new()","new()","new()","new()","new()","new()","new()","new?()","preference_file_loaded?()","print()","reset()","reset()","reset()","reset()","reset_config()","sort()","sort!()","sort_reverse()","sub_header_depth=()","to_h()","to_h()","to_json()","to_json()","to_s()","write()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli::helpers","standupmd::config","standupmd::config::cli","standupmd::config::entry","standupmd::config::entrylist","standupmd::config::file","standupmd::entry","standupmd::entrylist","standupmd::file","standupmd::version","standupmd::entrylist#<<()","standupmd::entry#<=>()","standupmd::entrylist#@entries()","standupmd::config::file#bullet_character=()","standupmd::config()","standupmd::cli::config()","standupmd::entry::config()","standupmd::entrylist::config()","standupmd::file::config()","standupmd::config_file_loaded?()","standupmd::configure()","standupmd::entry::create()","standupmd::config::file#directory=()","standupmd::cli#echo()","standupmd::cli::echo()","standupmd::cli#edit()","standupmd::cli::execute()","standupmd::file#exist?()","standupmd::entrylist#filter()","standupmd::entrylist#filter!()","standupmd::entrylist#find()","standupmd::file::find()","standupmd::file::find_by_date()","standupmd::config::file#header_depth=()","standupmd::config::entrylist#initalize()","standupmd::file#load()","standupmd::file::load()","standupmd::load_config_file()","standupmd::cli#load_preferences()","standupmd::file#loaded?()","standupmd::cli::new()","standupmd::config::new()","standupmd::config::cli::new()","standupmd::config::entry::new()","standupmd::config::file::new()","standupmd::entry::new()","standupmd::entrylist::new()","standupmd::file::new()","standupmd::file#new?()","standupmd::cli#preference_file_loaded?()","standupmd::cli::helpers#print()","standupmd::config::cli#reset()","standupmd::config::entry#reset()","standupmd::config::entrylist#reset()","standupmd::config::file#reset()","standupmd::reset_config()","standupmd::entrylist#sort()","standupmd::entrylist#sort!()","standupmd::entrylist#sort_reverse()","standupmd::config::file#sub_header_depth=()","standupmd::entry#to_h()","standupmd::entrylist#to_h()","standupmd::entry#to_json()","standupmd::entrylist#to_json()","standupmd::version::to_s()","standupmd::file#write()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The main module for the gem. Provides access to configuration classes.\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["StandupMD::Cli::Helpers","","StandupMD/Cli/Helpers.html","","<p>Module responsible for reading and writing standup files.\n"],["StandupMD::Config","","StandupMD/Config.html","","<p>This class provides a connector from StandupMD to the configuration classes.\n"],["StandupMD::Config::Cli","","StandupMD/Config/Cli.html","","<p>The configuration class for StandupMD::Cli\n"],["StandupMD::Config::Entry","","StandupMD/Config/Entry.html","","<p>The configuration class for StandupMD::Entry\n"],["StandupMD::Config::EntryList","","StandupMD/Config/EntryList.html","","<p>The configuration class for StandupMD::EntryList\n"],["StandupMD::Config::File","","StandupMD/Config/File.html","","<p>The configuration class for StandupMD::File\n"],["StandupMD::Entry","","StandupMD/Entry.html","","<p>Class for handling single entries. Includes the comparable module, and compares by date.\n"],["StandupMD::EntryList","","StandupMD/EntryList.html","","<p>Enumerable list of entries.\n"],["StandupMD::File","","StandupMD/File.html","","<p>Class for handling reading and writing standup files.\n"],["StandupMD::Version","","StandupMD/Version.html","","<p>Module that contains all gem version information. Follows semantic versioning. Read: semver.org/\n"],["<<","StandupMD::EntryList","StandupMD/EntryList.html#method-i-3C-3C","(entry)","<p>Appends entries to list.\n<p>@param [StandupMD::Entry] entry\n<p>@return [Array]\n"],["<=>","StandupMD::Entry","StandupMD/Entry.html#method-i-3C-3D-3E","(other)","<p>Sorting method for Comparable. Entries are compared by date.\n"],["@entries","StandupMD::EntryList","StandupMD/EntryList.html#method-i-40entries","","<p>The following are forwarded to @entries, which is the underly array of entries.\n<p><code>each</code> &mdash; Iterate over each …\n"],["bullet_character=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-bullet_character-3D","(char)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["config","StandupMD","StandupMD.html#method-c-config","()","<p>Method for accessing the configuration.\n<p>@return [StanupMD::Cli]\n"],["config","StandupMD::Cli","StandupMD/Cli.html#method-c-config","()","<p>Access to the class&#39;s configuration.\n<p>@return [StandupMD::Config::Cli]\n"],["config","StandupMD::Entry","StandupMD/Entry.html#method-c-config","()","<p>Access to the class&#39;s configuration.\n<p>@return [StandupMD::Config::Entry]\n"],["config","StandupMD::EntryList","StandupMD/EntryList.html#method-c-config","()","<p>Access to the class&#39;s configuration.\n<p>@return [StandupMD::Config::EntryList]\n"],["config","StandupMD::File","StandupMD/File.html#method-c-config","()","<p>Access to the class&#39;s configuration.\n<p>@return [StandupMD::Config::EntryList]\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-c-config_file_loaded-3F","()","<p>Has a config file been loaded?\n<p>@return [Boolean]\n"],["configure","StandupMD","StandupMD.html#method-c-configure","()","<p>Allows for configuration via a block. Useful when making config files.\n<p>@example\n\n<pre>StandupMD.configure { |s| ...</pre>\n"],["create","StandupMD::Entry","StandupMD/Entry.html#method-c-create","()","<p>Creates a generic entry. Default values can be set via configuration. Yields the entry if a block is …\n"],["directory=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn&#39;t …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Quick access to Cli.echo.\n<p>@return [nil]\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-c-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<p>@return [nil]\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"],["exist?","StandupMD::File","StandupMD/File.html#method-i-exist-3F","()","<p>Does the file exist?\n<p>@return [Boolean] true if exists\n"],["filter","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter","(start_date, end_date)","<p>Returns entries that are between the start and end date. This method assumes the list has already been …\n"],["filter!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter-21","(start_date, end_date)","<p>Replaces entries with results of filter.\n<p>@param [Date] start_date\n<p>@param [Date] end_date\n"],["find","StandupMD::EntryList","StandupMD/EntryList.html#method-i-find","(date)","<p>Finds an entry based on date. This method assumes the list has already been sorted.\n<p>@param [Date] date …\n"],["find","StandupMD::File","StandupMD/File.html#method-c-find","(file_name)","<p>Find standup file in directory by file name.\n<p>@param [String] File_naem\n"],["find_by_date","StandupMD::File","StandupMD/File.html#method-c-find_by_date","(date)","<p>Find standup file in directory by Date object.\n<p>@param [Date] date\n"],["header_depth=","StandupMD::Config::File","StandupMD/Config/File.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"],["initalize","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-initalize","()","<p>Initializes the config with default values.\n"],["load","StandupMD::File","StandupMD/File.html#method-i-load","()","<p>Loads the file&#39;s contents. TODO clean up this method.\n<p>@return [StandupMD::FileList]\n"],["load","StandupMD::File","StandupMD/File.html#method-c-load","(file_name)","<p>Convenience method for calling File.find(file_name).load\n<p>@param [String] file_name\n<p>@return [StandupMD::File] …\n"],["load_config_file","StandupMD","StandupMD.html#method-c-load_config_file","(file)","<p>Loads a config file.\n<p>@param [String] file\n"],["load_preferences","StandupMD::Cli","StandupMD/Cli.html#method-i-load_preferences","()","<p>Load the preference file.\n<p>@return [nil]\n"],["loaded?","StandupMD::File","StandupMD/File.html#method-i-loaded-3F","()","<p>Has the file been loaded?\n<p>@return [Boolean] true if loaded\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options = [], load_config = true)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new","StandupMD::Config","StandupMD/Config.html#method-c-new","()","<p>Builds the links to the configuration classes.\n"],["new","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::File","StandupMD/Config/File.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Entry","StandupMD/Entry.html#method-c-new","(date, current, previous, impediments, notes = [])","<p>Constructs instance of <code>StandupMD::Entry</code>.\n<p>@param [Date] date\n<p>@param [Array] current\n"],["new","StandupMD::EntryList","StandupMD/EntryList.html#method-c-new","(*entries)","<p>Contruct a list. Can pass any amount of <code>StandupMD::Entry</code> instances.\n<p>@param [Entry] entries\n<p>@return [StandupMD::EntryList] …\n"],["new","StandupMD::File","StandupMD/File.html#method-c-new","(file_name)","<p>Constructs the instance.\n<p>@param [String] file_name\n<p>@return [StandupMP::File]\n"],["new?","StandupMD::File","StandupMD/File.html#method-i-new-3F","()","<p>Was the file just now created?\n<p>@return [Boolean] true if new\n"],["preference_file_loaded?","StandupMD::Cli","StandupMD/Cli.html#method-i-preference_file_loaded-3F","()","<p>Has the preference file been loaded?\n<p>@return boolean\n"],["print","StandupMD::Cli::Helpers","StandupMD/Cli/Helpers.html#method-i-print","(entry)","<p>Print an entry to the command line.\n<p>@param [StandupMD::Entry] entry\n<p>@return [nil]\n"],["reset","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::File","StandupMD/Config/File.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset_config","StandupMD","StandupMD.html#method-c-reset_config","()","<p>Reset all configuration values to their defaults.\n<p>@return [StandupMD::Config]\n"],["sort","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sort!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort-21","()","<p>Replace entries with sorted entries by date.\n<p>@return [StandupMD::EntryList]\n"],["sort_reverse","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort_reverse","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sub_header_depth=","StandupMD::Config::File","StandupMD/Config/File.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"],["to_h","StandupMD::Entry","StandupMD/Entry.html#method-i-to_h","()","<p>Entry as a hash .\n<p>@return [Hash]\n"],["to_h","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_h","()","<p>The list as a hash, with the dates as keys.\n<p>@return [Hash]\n"],["to_json","StandupMD::Entry","StandupMD/Entry.html#method-i-to_json","()","<p>Entry as a json object.\n<p>@return [String]\n"],["to_json","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_json","()","<p>The entry list as a json object.\n<p>@return [String]\n"],["to_s","StandupMD::Version","StandupMD/Version.html#method-c-to_s","()","<p>Version as <code>MAJOR.MINOR.PATCH</code>\n"],["write","StandupMD::File","StandupMD/File.html#method-i-write","(**dates)","<p>Writes a new entry to the file if the first entry in the file isn&#39;t today. This method is destructive; …\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>"]]}}
1
+ var search_data = {"index":{"searchIndex":["standupmd","cli","helpers","config","cli","entry","entrylist","file","entry","entrylist","file","version","<<()","<=>()","@entries()","bullet_character=()","config()","config()","config()","config()","config()","config_file_loaded?()","configure()","create()","directory=()","echo()","echo()","edit()","execute()","exist?()","filter()","filter!()","find()","find()","find_by_date()","header_depth=()","initalize()","load()","load()","load_config_file()","load_preferences()","loaded?()","new()","new()","new()","new()","new()","new()","new()","new()","new?()","preference_file_loaded?()","print()","reset()","reset()","reset()","reset()","reset_config()","sort()","sort!()","sort_reverse()","sub_header_depth=()","to_a()","to_h()","to_h()","to_h()","to_json()","to_json()","to_s()","write()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli::helpers","standupmd::config","standupmd::config::cli","standupmd::config::entry","standupmd::config::entrylist","standupmd::config::file","standupmd::entry","standupmd::entrylist","standupmd::file","standupmd::version","standupmd::entrylist#<<()","standupmd::entry#<=>()","standupmd::entrylist#@entries()","standupmd::config::file#bullet_character=()","standupmd::config()","standupmd::cli::config()","standupmd::entry::config()","standupmd::entrylist::config()","standupmd::file::config()","standupmd::config_file_loaded?()","standupmd::configure()","standupmd::entry::create()","standupmd::config::file#directory=()","standupmd::cli#echo()","standupmd::cli::echo()","standupmd::cli#edit()","standupmd::cli::execute()","standupmd::file#exist?()","standupmd::entrylist#filter()","standupmd::entrylist#filter!()","standupmd::entrylist#find()","standupmd::file::find()","standupmd::file::find_by_date()","standupmd::config::file#header_depth=()","standupmd::config::entrylist#initalize()","standupmd::file::load()","standupmd::file#load()","standupmd::load_config_file()","standupmd::cli#load_preferences()","standupmd::file#loaded?()","standupmd::cli::new()","standupmd::config::new()","standupmd::config::cli::new()","standupmd::config::entry::new()","standupmd::config::file::new()","standupmd::entry::new()","standupmd::entrylist::new()","standupmd::file::new()","standupmd::file#new?()","standupmd::cli#preference_file_loaded?()","standupmd::cli::helpers#print()","standupmd::config::cli#reset()","standupmd::config::entry#reset()","standupmd::config::entrylist#reset()","standupmd::config::file#reset()","standupmd::reset_config()","standupmd::entrylist#sort()","standupmd::entrylist#sort!()","standupmd::entrylist#sort_reverse()","standupmd::config::file#sub_header_depth=()","standupmd::version::to_a()","standupmd::entry#to_h()","standupmd::entrylist#to_h()","standupmd::version::to_h()","standupmd::entry#to_json()","standupmd::entrylist#to_json()","standupmd::version::to_s()","standupmd::file#write()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The main module for the gem. Provides access to configuration classes.\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["StandupMD::Cli::Helpers","","StandupMD/Cli/Helpers.html","","<p>Module responsible for reading and writing standup files.\n"],["StandupMD::Config","","StandupMD/Config.html","","<p>This class provides a connector from StandupMD to the configuration classes.\n"],["StandupMD::Config::Cli","","StandupMD/Config/Cli.html","","<p>The configuration class for StandupMD::Cli\n"],["StandupMD::Config::Entry","","StandupMD/Config/Entry.html","","<p>The configuration class for StandupMD::Entry\n"],["StandupMD::Config::EntryList","","StandupMD/Config/EntryList.html","","<p>The configuration class for StandupMD::EntryList\n"],["StandupMD::Config::File","","StandupMD/Config/File.html","","<p>The configuration class for StandupMD::File\n"],["StandupMD::Entry","","StandupMD/Entry.html","","<p>Class for handling single entries. Includes the comparable module, and compares by date.\n"],["StandupMD::EntryList","","StandupMD/EntryList.html","","<p>Enumerable list of entries.\n"],["StandupMD::File","","StandupMD/File.html","","<p>Class for handling reading and writing standup files.\n"],["StandupMD::Version","","StandupMD/Version.html","","<p>Module that contains all gem version information. Follows semantic versioning. Read: semver.org/\n"],["<<","StandupMD::EntryList","StandupMD/EntryList.html#method-i-3C-3C","(entry)","<p>Appends entries to list.\n<p>@param [StandupMD::Entry] entry\n<p>@return [Array]\n"],["<=>","StandupMD::Entry","StandupMD/Entry.html#method-i-3C-3D-3E","(other)","<p>Sorting method for Comparable. Entries are compared by date.\n"],["@entries","StandupMD::EntryList","StandupMD/EntryList.html#method-i-40entries","","<p>The following are forwarded to @entries, which is the underly array of entries.\n<p><code>each</code> &mdash; Iterate over each …\n"],["bullet_character=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-bullet_character-3D","(char)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["config","StandupMD","StandupMD.html#method-c-config","()","<p>Method for accessing the configuration.\n<p>@return [StanupMD::Cli]\n"],["config","StandupMD::Cli","StandupMD/Cli.html#method-c-config","()","<p>Access to the class&#39;s configuration.\n<p>@return [StandupMD::Config::Cli]\n"],["config","StandupMD::Entry","StandupMD/Entry.html#method-c-config","()","<p>Access to the class&#39;s configuration.\n<p>@return [StandupMD::Config::Entry]\n"],["config","StandupMD::EntryList","StandupMD/EntryList.html#method-c-config","()","<p>Access to the class&#39;s configuration.\n<p>@return [StandupMD::Config::EntryList]\n"],["config","StandupMD::File","StandupMD/File.html#method-c-config","()","<p>Access to the class&#39;s configuration.\n<p>@return [StandupMD::Config::EntryList]\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-c-config_file_loaded-3F","()","<p>Has a config file been loaded?\n<p>@return [Boolean]\n"],["configure","StandupMD","StandupMD.html#method-c-configure","()","<p>Allows for configuration via a block. Useful when making config files.\n<p>@example\n\n<pre>StandupMD.configure { |s| ...</pre>\n"],["create","StandupMD::Entry","StandupMD/Entry.html#method-c-create","()","<p>Creates a generic entry. Default values can be set via configuration. Yields the entry if a block is …\n"],["directory=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn&#39;t …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Quick access to Cli.echo.\n<p>@return [nil]\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-c-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<p>@return [nil]\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"],["exist?","StandupMD::File","StandupMD/File.html#method-i-exist-3F","()","<p>Does the file exist?\n<p>@return [Boolean] true if exists\n"],["filter","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter","(start_date, end_date)","<p>Returns entries that are between the start and end date. This method assumes the list has already been …\n"],["filter!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter-21","(start_date, end_date)","<p>Replaces entries with results of filter.\n<p>@param [Date] start_date\n<p>@param [Date] end_date\n"],["find","StandupMD::EntryList","StandupMD/EntryList.html#method-i-find","(date)","<p>Finds an entry based on date. This method assumes the list has already been sorted.\n<p>@param [Date] date …\n"],["find","StandupMD::File","StandupMD/File.html#method-c-find","(file_name)","<p>Find standup file in directory by file name.\n<p>@param [String] File_naem\n"],["find_by_date","StandupMD::File","StandupMD/File.html#method-c-find_by_date","(date)","<p>Find standup file in directory by Date object.\n<p>@param [Date] date\n"],["header_depth=","StandupMD::Config::File","StandupMD/Config/File.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"],["initalize","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-initalize","()","<p>Initializes the config with default values.\n"],["load","StandupMD::File","StandupMD/File.html#method-c-load","(file_name)","<p>Convenience method for calling File.find(file_name).load\n<p>@param [String] file_name\n<p>@return [StandupMD::File] …\n"],["load","StandupMD::File","StandupMD/File.html#method-i-load","()","<p>Loads the file&#39;s contents. TODO clean up this method.\n<p>@return [StandupMD::FileList]\n"],["load_config_file","StandupMD","StandupMD.html#method-c-load_config_file","(file)","<p>Loads a config file.\n<p>@param [String] file\n<p>@return [String] file\n"],["load_preferences","StandupMD::Cli","StandupMD/Cli.html#method-i-load_preferences","()","<p>Load the preference file.\n<p>@return [nil]\n"],["loaded?","StandupMD::File","StandupMD/File.html#method-i-loaded-3F","()","<p>Has the file been loaded?\n<p>@return [Boolean] true if loaded\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options = [], load_config = true)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new","StandupMD::Config","StandupMD/Config.html#method-c-new","()","<p>Builds the links to the configuration classes.\n"],["new","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::File","StandupMD/Config/File.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Entry","StandupMD/Entry.html#method-c-new","(date, current, previous, impediments, notes = [])","<p>Constructs instance of <code>StandupMD::Entry</code>.\n<p>@param [Date] date\n<p>@param [Array] current\n"],["new","StandupMD::EntryList","StandupMD/EntryList.html#method-c-new","(*entries)","<p>Contruct a list. Can pass any amount of <code>StandupMD::Entry</code> instances.\n<p>@param [Entry] entries\n<p>@return [StandupMD::EntryList] …\n"],["new","StandupMD::File","StandupMD/File.html#method-c-new","(file_name)","<p>Constructs the instance.\n<p>@param [String] file_name\n<p>@return [StandupMP::File]\n"],["new?","StandupMD::File","StandupMD/File.html#method-i-new-3F","()","<p>Was the file just now created?\n<p>@return [Boolean] true if new\n"],["preference_file_loaded?","StandupMD::Cli","StandupMD/Cli.html#method-i-preference_file_loaded-3F","()","<p>Has the preference file been loaded?\n<p>@return boolean\n"],["print","StandupMD::Cli::Helpers","StandupMD/Cli/Helpers.html#method-i-print","(entry)","<p>Print an entry to the command line.\n<p>@param [StandupMD::Entry] entry\n<p>@return [nil]\n"],["reset","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::File","StandupMD/Config/File.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset_config","StandupMD","StandupMD.html#method-c-reset_config","()","<p>Reset all configuration values to their defaults.\n<p>@return [StandupMD::Config]\n"],["sort","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sort!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort-21","()","<p>Replace entries with sorted entries by date.\n<p>@return [StandupMD::EntryList]\n"],["sort_reverse","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort_reverse","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sub_header_depth=","StandupMD::Config::File","StandupMD/Config/File.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"],["to_a","StandupMD::Version","StandupMD/Version.html#method-c-to_a","()","<p>Version as +[MAJOR, MINOR, PATCH]+\n<p>@return [Array]\n"],["to_h","StandupMD::Entry","StandupMD/Entry.html#method-i-to_h","()","<p>Entry as a hash .\n<p>@return [Hash]\n"],["to_h","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_h","()","<p>The list as a hash, with the dates as keys.\n<p>@return [Hash]\n"],["to_h","StandupMD::Version","StandupMD/Version.html#method-c-to_h","()","<p>Version as +{major: MAJOR, minor: MINOR, patch: PATCH}+\n<p>@return [Hash]\n"],["to_json","StandupMD::Entry","StandupMD/Entry.html#method-i-to_json","()","<p>Entry as a json object.\n<p>@return [String]\n"],["to_json","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_json","()","<p>The entry list as a json object.\n<p>@return [String]\n"],["to_s","StandupMD::Version","StandupMD/Version.html#method-c-to_s","()","<p>Version as <code>MAJOR.MINOR.PATCH</code>\n<p>@return [String]\n"],["write","StandupMD::File","StandupMD/File.html#method-i-write","(**dates)","<p>Writes a new entry to the file if the first entry in the file isn&#39;t today. This method is destructive; …\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/doc/js/searcher.js.gz CHANGED
Binary file
data/doc/table_of_contents.html CHANGED
@@ -21,155 +21,94 @@
21
21
  <link href="./css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
-
26
24
  <body id="top" class="table-of-contents">
27
25
  <main role="main">
28
26
  <h1 class="class">Table of Contents - RDoc Documentation</h1>
29
27
 
30
-
31
-
32
28
  <h2 id="pages">Pages</h2>
33
29
  <ul>
34
-
35
30
  <li class="file">
36
31
  <a href="README_md.html">README</a>
37
32
 
38
33
  <ul>
39
-
40
34
  <li><a href="README_md.html#label-The+Standup+Doctor">The Standup Doctor</a>
41
-
42
35
  <li><a href="README_md.html#label-About">About</a>
43
-
44
36
  <li><a href="README_md.html#label-Installation">Installation</a>
45
-
46
37
  <li><a href="README_md.html#label-Via+RubyGems">Via RubyGems</a>
47
-
48
38
  <li><a href="README_md.html#label-Manual+Installation">Manual Installation</a>
49
-
50
39
  <li><a href="README_md.html#label-Usage">Usage</a>
51
-
52
40
  <li><a href="README_md.html#label-Command+Line">Command Line</a>
53
-
54
41
  <li><a href="README_md.html#label-CLI+Examples">CLI Examples</a>
55
-
56
42
  <li><a href="README_md.html#label-Adding+an+entry+for+today+via+editor">Adding an entry for today via editor</a>
57
-
58
43
  <li><a href="README_md.html#label-Copy+the+entry+for+today+to+clipboard">Copy the entry for today to clipboard</a>
59
-
60
44
  <li><a href="README_md.html#label-Add+entry+to+file+without+opening+it">Add entry to file without opening it</a>
61
-
62
- <li><a href="README_md.html#label-Find+an+entry+by+date+and+print+it.">Find an entry by date and print it.</a>
63
-
64
45
  <li><a href="README_md.html#label-Customization+and+Runtime+Options">Customization and Runtime Options</a>
65
-
66
46
  <li><a href="README_md.html#label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults</a>
67
-
68
47
  <li><a href="README_md.html#label-Executable+Flags">Executable Flags</a>
69
-
70
48
  <li><a href="README_md.html#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
71
-
72
49
  <li><a href="README_md.html#label-API">API</a>
73
-
74
50
  <li><a href="README_md.html#label-API+Examples">API Examples</a>
75
-
76
51
  <li><a href="README_md.html#label-Adding+an+entry+for+today">Adding an entry for today</a>
77
-
78
52
  <li><a href="README_md.html#label-Finding+a+past+entry">Finding a past entry</a>
79
-
80
53
  <li><a href="README_md.html#label-Vim">Vim</a>
81
-
82
54
  <li><a href="README_md.html#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
83
-
84
55
  <li><a href="README_md.html#label-Self-Promotion">Self-Promotion</a>
85
-
86
56
  </ul>
87
-
88
57
  </li>
89
-
90
58
  </ul>
91
59
 
92
-
93
60
  <h2 id="classes">Classes and Modules</h2>
94
61
  <ul>
95
-
96
62
  <li class="module">
97
63
  <a href="StandupMD.html">StandupMD</a>
98
-
99
64
  </li>
100
-
101
65
  <li class="class">
102
66
  <a href="StandupMD/Cli.html">StandupMD::Cli</a>
103
-
104
67
  </li>
105
-
106
68
  <li class="module">
107
69
  <a href="StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
108
-
109
70
  </li>
110
-
111
71
  <li class="class">
112
72
  <a href="StandupMD/Config.html">StandupMD::Config</a>
113
-
114
73
  </li>
115
-
116
74
  <li class="class">
117
75
  <a href="StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
118
-
119
76
  </li>
120
-
121
77
  <li class="class">
122
78
  <a href="StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
123
-
124
79
  </li>
125
-
126
80
  <li class="class">
127
81
  <a href="StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
128
-
129
82
  </li>
130
-
131
83
  <li class="class">
132
84
  <a href="StandupMD/Config/File.html">StandupMD::Config::File</a>
133
-
134
85
  </li>
135
-
136
86
  <li class="class">
137
87
  <a href="StandupMD/Entry.html">StandupMD::Entry</a>
138
-
139
88
  </li>
140
-
141
89
  <li class="class">
142
90
  <a href="StandupMD/EntryList.html">StandupMD::EntryList</a>
143
91
 
144
92
  <ul>
145
-
146
93
  <li><a href="StandupMD/EntryList.html#5Buntitled-5D">Top Section</a>
147
-
148
94
  <li><a href="StandupMD/EntryList.html#Delegators">Delegators</a>
149
-
150
95
  </ul>
151
-
152
96
  </li>
153
-
154
97
  <li class="class">
155
98
  <a href="StandupMD/File.html">StandupMD::File</a>
156
-
157
99
  </li>
158
-
159
100
  <li class="module">
160
101
  <a href="StandupMD/Version.html">StandupMD::Version</a>
161
-
162
102
  </li>
163
-
164
103
  </ul>
165
104
 
166
105
  <h2 id="methods">Methods</h2>
167
106
  <ul>
168
107
 
169
108
  <li class="method">
170
- <a href="StandupMD/EntryList.html#method-c-config">::config</a>
109
+ <a href="StandupMD/Cli.html#method-c-config">::config</a>
171
110
  &mdash;
172
- <span class="container">StandupMD::EntryList</span>
111
+ <span class="container">StandupMD::Cli</span>
173
112
 
174
113
  <li class="method">
175
114
  <a href="StandupMD/Entry.html#method-c-config">::config</a>
@@ -177,9 +116,9 @@
177
116
  <span class="container">StandupMD::Entry</span>
178
117
 
179
118
  <li class="method">
180
- <a href="StandupMD/Cli.html#method-c-config">::config</a>
119
+ <a href="StandupMD/EntryList.html#method-c-config">::config</a>
181
120
  &mdash;
182
- <span class="container">StandupMD::Cli</span>
121
+ <span class="container">StandupMD::EntryList</span>
183
122
 
184
123
  <li class="method">
185
124
  <a href="StandupMD/File.html#method-c-config">::config</a>
@@ -237,14 +176,9 @@
237
176
  <span class="container">StandupMD</span>
238
177
 
239
178
  <li class="method">
240
- <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
241
- &mdash;
242
- <span class="container">StandupMD::Config::Cli</span>
243
-
244
- <li class="method">
245
- <a href="StandupMD/Config.html#method-c-new">::new</a>
179
+ <a href="StandupMD/File.html#method-c-new">::new</a>
246
180
  &mdash;
247
- <span class="container">StandupMD::Config</span>
181
+ <span class="container">StandupMD::File</span>
248
182
 
249
183
  <li class="method">
250
184
  <a href="StandupMD/Config/File.html#method-c-new">::new</a>
@@ -252,19 +186,19 @@
252
186
  <span class="container">StandupMD::Config::File</span>
253
187
 
254
188
  <li class="method">
255
- <a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
189
+ <a href="StandupMD/Cli.html#method-c-new">::new</a>
256
190
  &mdash;
257
- <span class="container">StandupMD::Config::Entry</span>
191
+ <span class="container">StandupMD::Cli</span>
258
192
 
259
193
  <li class="method">
260
- <a href="StandupMD/File.html#method-c-new">::new</a>
194
+ <a href="StandupMD/EntryList.html#method-c-new">::new</a>
261
195
  &mdash;
262
- <span class="container">StandupMD::File</span>
196
+ <span class="container">StandupMD::EntryList</span>
263
197
 
264
198
  <li class="method">
265
- <a href="StandupMD/Cli.html#method-c-new">::new</a>
199
+ <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
266
200
  &mdash;
267
- <span class="container">StandupMD::Cli</span>
201
+ <span class="container">StandupMD::Config::Cli</span>
268
202
 
269
203
  <li class="method">
270
204
  <a href="StandupMD/Entry.html#method-c-new">::new</a>
@@ -272,15 +206,30 @@
272
206
  <span class="container">StandupMD::Entry</span>
273
207
 
274
208
  <li class="method">
275
- <a href="StandupMD/EntryList.html#method-c-new">::new</a>
209
+ <a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
276
210
  &mdash;
277
- <span class="container">StandupMD::EntryList</span>
211
+ <span class="container">StandupMD::Config::Entry</span>
212
+
213
+ <li class="method">
214
+ <a href="StandupMD/Config.html#method-c-new">::new</a>
215
+ &mdash;
216
+ <span class="container">StandupMD::Config</span>
278
217
 
279
218
  <li class="method">
280
219
  <a href="StandupMD.html#method-c-reset_config">::reset_config</a>
281
220
  &mdash;
282
221
  <span class="container">StandupMD</span>
283
222
 
223
+ <li class="method">
224
+ <a href="StandupMD/Version.html#method-c-to_a">::to_a</a>
225
+ &mdash;
226
+ <span class="container">StandupMD::Version</span>
227
+
228
+ <li class="method">
229
+ <a href="StandupMD/Version.html#method-c-to_h">::to_h</a>
230
+ &mdash;
231
+ <span class="container">StandupMD::Version</span>
232
+
284
233
  <li class="method">
285
234
  <a href="StandupMD/Version.html#method-c-to_s">::to_s</a>
286
235
  &mdash;
@@ -382,24 +331,24 @@
382
331
  <span class="container">StandupMD::Cli::Helpers</span>
383
332
 
384
333
  <li class="method">
385
- <a href="StandupMD/Config/Cli.html#method-i-reset">#reset</a>
334
+ <a href="StandupMD/Config/File.html#method-i-reset">#reset</a>
386
335
  &mdash;
387
- <span class="container">StandupMD::Config::Cli</span>
336
+ <span class="container">StandupMD::Config::File</span>
388
337
 
389
338
  <li class="method">
390
- <a href="StandupMD/Config/File.html#method-i-reset">#reset</a>
339
+ <a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
391
340
  &mdash;
392
- <span class="container">StandupMD::Config::File</span>
341
+ <span class="container">StandupMD::Config::Entry</span>
393
342
 
394
343
  <li class="method">
395
- <a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
344
+ <a href="StandupMD/Config/Cli.html#method-i-reset">#reset</a>
396
345
  &mdash;
397
- <span class="container">StandupMD::Config::EntryList</span>
346
+ <span class="container">StandupMD::Config::Cli</span>
398
347
 
399
348
  <li class="method">
400
- <a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
349
+ <a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
401
350
  &mdash;
402
- <span class="container">StandupMD::Config::Entry</span>
351
+ <span class="container">StandupMD::Config::EntryList</span>
403
352
 
404
353
  <li class="method">
405
354
  <a href="StandupMD/EntryList.html#method-i-sort">#sort</a>
@@ -432,14 +381,14 @@
432
381
  <span class="container">StandupMD::EntryList</span>
433
382
 
434
383
  <li class="method">
435
- <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
384
+ <a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
436
385
  &mdash;
437
- <span class="container">StandupMD::EntryList</span>
386
+ <span class="container">StandupMD::Entry</span>
438
387
 
439
388
  <li class="method">
440
- <a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
389
+ <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
441
390
  &mdash;
442
- <span class="container">StandupMD::Entry</span>
391
+ <span class="container">StandupMD::EntryList</span>
443
392
 
444
393
  <li class="method">
445
394
  <a href="StandupMD/File.html#method-i-write">#write</a>
@@ -450,14 +399,13 @@
450
399
  <a href="StandupMD/Cli.html#method-i-write_file">#write_file</a>
451
400
  &mdash;
452
401
  <span class="container">StandupMD::Cli</span>
453
-
454
402
  </ul>
455
403
  </main>
456
404
 
457
405
 
458
406
  <footer id="validator-badges" role="contentinfo">
459
407
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
460
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
408
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
461
409
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
462
410
  </footer>
463
411