standup_md 0.1.2 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/Gemfile.lock +7 -1
  4. data/README.md +183 -97
  5. data/Rakefile +11 -28
  6. data/bin/standup +1 -1
  7. data/doc/README_md.html +185 -78
  8. data/doc/StandupMD.html +83 -1244
  9. data/doc/StandupMD/Cli.html +124 -474
  10. data/doc/StandupMD/Cli/Helpers.html +167 -0
  11. data/doc/StandupMD/Config.html +230 -0
  12. data/doc/StandupMD/Config/Cli.html +355 -0
  13. data/doc/StandupMD/Config/Entry.html +284 -0
  14. data/doc/StandupMD/Config/EntryList.html +197 -0
  15. data/doc/StandupMD/Config/File.html +609 -0
  16. data/doc/StandupMD/Entry.html +478 -0
  17. data/doc/StandupMD/EntryList.html +759 -0
  18. data/doc/StandupMD/File.html +575 -0
  19. data/doc/created.rid +15 -8
  20. data/doc/index.html +191 -79
  21. data/doc/js/navigation.js.gz +0 -0
  22. data/doc/js/search_index.js +1 -1
  23. data/doc/js/search_index.js.gz +0 -0
  24. data/doc/js/searcher.js.gz +0 -0
  25. data/doc/table_of_contents.html +150 -265
  26. data/lib/standup_md.rb +29 -508
  27. data/lib/standup_md/cli.rb +63 -242
  28. data/lib/standup_md/cli/helpers.rb +165 -0
  29. data/lib/standup_md/config.rb +45 -0
  30. data/lib/standup_md/config/cli.rb +106 -0
  31. data/lib/standup_md/config/entry.rb +61 -0
  32. data/lib/standup_md/config/entry_list.rb +26 -0
  33. data/lib/standup_md/config/file.rb +199 -0
  34. data/lib/standup_md/entry.rb +121 -0
  35. data/lib/standup_md/entry_list.rb +166 -0
  36. data/lib/standup_md/file.rb +173 -0
  37. data/lib/standup_md/file/helpers.rb +62 -0
  38. data/lib/standup_md/version.rb +5 -3
  39. data/standup_md.gemspec +1 -0
  40. metadata +35 -5
  41. data/doc/TestCli.html +0 -792
  42. data/doc/TestHelper.html +0 -282
  43. data/doc/TestStandupMD.html +0 -1354
data/doc/created.rid CHANGED
@@ -1,8 +1,15 @@
1
- Fri, 01 May 2020 08:41:04 -0500
2
- README.md Wed, 29 Apr 2020 20:22:26 -0500
3
- lib/standup_md.rb Fri, 01 May 2020 08:39:43 -0500
4
- lib/standup_md/cli.rb Thu, 30 Apr 2020 21:55:46 -0500
5
- lib/standup_md/version.rb Wed, 29 Apr 2020 20:22:26 -0500
6
- test/standup_md/cli_test.rb Thu, 30 Apr 2020 23:02:56 -0500
7
- test/standup_md_test.rb Thu, 23 Apr 2020 22:53:37 -0500
8
- test/test_helper.rb Wed, 29 Apr 2020 20:22:26 -0500
1
+ Wed, 10 Jun 2020 22:30:11 -0500
2
+ README.md Wed, 10 Jun 2020 22:23:37 -0500
3
+ lib/standup_md.rb Wed, 10 Jun 2020 22:23:37 -0500
4
+ lib/standup_md/cli.rb Wed, 10 Jun 2020 22:23:37 -0500
5
+ lib/standup_md/cli/helpers.rb Wed, 10 Jun 2020 22:23:37 -0500
6
+ lib/standup_md/config.rb Wed, 10 Jun 2020 22:23:37 -0500
7
+ lib/standup_md/config/cli.rb Wed, 10 Jun 2020 22:23:37 -0500
8
+ lib/standup_md/config/entry.rb Wed, 10 Jun 2020 22:23:37 -0500
9
+ lib/standup_md/config/entry_list.rb Wed, 10 Jun 2020 22:23:37 -0500
10
+ lib/standup_md/config/file.rb Wed, 10 Jun 2020 22:23:37 -0500
11
+ lib/standup_md/entry.rb Wed, 10 Jun 2020 22:23:37 -0500
12
+ lib/standup_md/entry_list.rb Wed, 10 Jun 2020 22:23:37 -0500
13
+ lib/standup_md/file.rb Wed, 10 Jun 2020 22:25:24 -0500
14
+ lib/standup_md/file/helpers.rb Wed, 10 Jun 2020 22:23:37 -0500
15
+ lib/standup_md/version.rb Wed, 10 Jun 2020 22:30:02 -0500
data/doc/index.html CHANGED
@@ -76,11 +76,23 @@
76
76
 
77
77
  <li><a href="./StandupMD/Cli.html">StandupMD::Cli</a>
78
78
 
79
- <li><a href="./TestCli.html">TestCli</a>
79
+ <li><a href="./StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
80
80
 
81
- <li><a href="./TestHelper.html">TestHelper</a>
81
+ <li><a href="./StandupMD/Config.html">StandupMD::Config</a>
82
82
 
83
- <li><a href="./TestStandupMD.html">TestStandupMD</a>
83
+ <li><a href="./StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
84
+
85
+ <li><a href="./StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
86
+
87
+ <li><a href="./StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
88
+
89
+ <li><a href="./StandupMD/Config/File.html">StandupMD::Config::File</a>
90
+
91
+ <li><a href="./StandupMD/Entry.html">StandupMD::Entry</a>
92
+
93
+ <li><a href="./StandupMD/EntryList.html">StandupMD::EntryList</a>
94
+
95
+ <li><a href="./StandupMD/File.html">StandupMD::File</a>
84
96
 
85
97
  </ul>
86
98
  </div>
@@ -93,6 +105,8 @@
93
105
 
94
106
  <h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+Standup+Doctor">&para;</a> <a href="#top">&uarr;</a></span></h1>
95
107
 
108
+ <p><a href="https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat"></a> <a href="https://badge.fury.io/rb/standup_md"><img src="https://badge.fury.io/rb/standup_md.svg"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg"></a></p>
109
+
96
110
  <blockquote>
97
111
  <p>The cure for all your standup woes.</p>
98
112
  </blockquote>
@@ -113,13 +127,29 @@
113
127
  </li><li>
114
128
  <p><a href="#usage">Usage</a></p>
115
129
  </li><li>
116
- <p><a href="#example">Example</a></p>
130
+ <p><a href="#command-line">Command Line</a></p>
131
+ <ul><li>
132
+ <p><a href="#cli-examples">CLI Examples</a></p>
133
+ </li><li>
134
+ <p><a href="#adding-an-entry-for-today-via-editor">Adding an entry for today via editor</a></p>
135
+ </li><li>
136
+ <p><a href="#copy-the-entry-for-today-to-clipboard">Copy the entry for today to clipboard</a></p>
137
+ </li><li>
138
+ <p><a href="#add-entry-to-file-without-opening-it">Add entry to file without opening it</a></p>
139
+ </li><li>
140
+ <p><a href="#find-an-entry-by-date-and-print-it">Find an entry by date and print it</a></p>
117
141
  </li><li>
118
142
  <p><a href="#customization-and-runtime-options">Customization and Runtime Options</a></p>
119
143
  </li><li>
144
+ <p><a href="#using-existing-standup-files">Using existing standup files</a></p>
145
+ </li></ul>
146
+ </li><li>
120
147
  <p><a href="#api">API</a></p>
148
+ <ul><li>
149
+ <p><a href="#api-examples">API Examples</a></p>
121
150
  </li><li>
122
151
  <p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
152
+ </li></ul>
123
153
  </li><li>
124
154
  <p><a href="#reporting-bugs-and-requesting-features">Reporting Bugs and Requesting Features</a></p>
125
155
  </li><li>
@@ -128,11 +158,9 @@
128
158
 
129
159
  <h2 id="label-About">About<span><a href="#label-About">&para;</a> <a href="#top">&uarr;</a></span></h2>
130
160
 
131
- <p>I&#39;ve now been at two separate companies where we post our daily standups in a chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day became tedious, as I&#39;d have to look up what I did the day before, copy and paste yesterday&#39;s work into a new entry, and add today&#39;s tasks. This gem automates most of this process, along with providing means of opening the file in your editor, and displaying entries from the command line.</p>
132
-
133
- <p>I wasn&#39;t sure that others would find this useful, but then the pandemic happened, which I assume made doing standups via chat much more common.</p>
161
+ <p>I&#39;ve now been at two separate companies where we post our daily standups in a chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day became tedious, as I&#39;d have to look up what I did the day before, copy and paste yesterday&#39;s work into a new entry, and add today&#39;s tasks. This gem automates most of this process, along with providing means of opening the file in your editor, and finding and displaying entries from the command line.</p>
134
162
 
135
- <p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn&#39;t exist, one will be generated, and if a previous entry exists, it will be added to today&#39;s entry as your previous day&#39;s work. See <a href="#example">example</a>. There&#39;s also an API if you&#39;d like to use this in your own code somehow.</p>
163
+ <p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn&#39;t exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today&#39;s entry as your previous day&#39;s work. See <a href="#example">example</a>. There&#39;s also a very robust API if you&#39;d like to use this in your own code somehow.</p>
136
164
 
137
165
  <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
138
166
 
@@ -143,32 +171,35 @@
143
171
  <pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">standup_md</span>
144
172
  </pre>
145
173
 
146
- <p>If you don&#39;t have permission on your system to install ruby or gems, I recommend using <a href="http://www.rubyinside.com/rbenv-a-simple-new-ruby-version-management-tool-5302.html">rbenv</a>, or you can try the manual methods below.</p>
174
+ <p>To include in your project, add the following to your <code>Gemfile</code>.</p>
175
+
176
+ <pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-string">&#39;standup_md&#39;</span>
177
+ </pre>
147
178
 
148
179
  <h3 id="label-Manual+Installation">Manual Installation<span><a href="#label-Manual+Installation">&para;</a> <a href="#top">&uarr;</a></span></h3>
149
180
 
150
- <p>From your terminal, clone the repository where you want it. From there, you have a couple of installation options.</p>
181
+ <p>From your terminal, clone the repository where you want it, and use <code>rake</code> to install the gem.</p>
151
182
 
152
183
  <pre>git clone https://github.com/evanthegrayt/standup_md.git
153
184
  cd standup_md
154
185
 
155
186
  # Use rake to build and install the gem.
156
- rake install
157
-
158
- # OR manually link the executable somewhere. If you use this method, you cannot
159
- # move the repository after you link it!
160
- ln -s $PWD/bin/standup /usr/local/bin/standup</pre>
187
+ rake install</pre>
161
188
 
162
189
  <h2 id="label-Usage">Usage<span><a href="#label-Usage">&para;</a> <a href="#top">&uarr;</a></span></h2>
163
190
 
164
- <p>Call the executable.</p>
191
+ <h3 id="label-Command+Line">Command Line<span><a href="#label-Command+Line">&para;</a> <a href="#top">&uarr;</a></span></h3>
192
+
193
+ <p>For the most basic usage, simplyt call the executable.</p>
165
194
 
166
195
  <pre class="ruby"><span class="ruby-identifier">standup</span>
167
196
  </pre>
168
197
 
169
- <p>This opens the current month&#39;s standup file. If an entry already exists for today, nothing is added. If no entry exists for today, the previous “Current” is placed in the “Previous” section of a new entry. The format of this file is very important; do not change anything, except for adding entries for today.</p>
198
+ <p>This opens the current month&#39;s standup file. If an entry already exists for today, nothing is added. If no entry exists for today, the previous “Current” is placed in the “Previous” section of a new entry. The format of this file is very important; you may add new entries, but don&#39;t change any of the headers. Doing so will cause the parser to break. If you want to customize the headers, you can do so in the <a href="#available-config-file-options-and-defaults">configuration file</a>.</p>
170
199
 
171
- <h3 id="label-Example">Example<span><a href="#label-Example">&para;</a> <a href="#top">&uarr;</a></span></h3>
200
+ <h3 id="label-CLI+Examples">CLI Examples<span><a href="#label-CLI+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
201
+
202
+ <h4 id="label-Adding+an+entry+for+today+via+editor">Adding an entry for today via editor<span><a href="#label-Adding+an+entry+for+today+via+editor">&para;</a> <a href="#top">&uarr;</a></span></h4>
172
203
 
173
204
  <p>For example, if the standup entry from yesterday reads as follows:</p>
174
205
 
@@ -181,95 +212,176 @@ ln -s $PWD/bin/standup /usr/local/bin/standup
181
212
  ## Impediments
182
213
  - None</pre>
183
214
 
184
- <p>The following scaffolding will be added for current entry at the top of the file: <code>markdown # 2020-04-14 ## Previous - Write new feature for `standup_md` - Fix bug in `standup_md` ## Current - &lt;!-- ADD TODAY&#39;S WORK HERE --&gt; ## Impediments - None </code></p>
215
+ <p>The following scaffolding will be added for current entry at the top of the file:</p>
216
+
217
+ <pre># 2020-04-14
218
+ ## Previous
219
+ - Write new feature for `standup_md`
220
+ - Fix bug in `standup_md`
221
+ ## Current
222
+ - &lt;!-- ADD TODAY&#39;S WORK HERE --&gt;
223
+ ## Impediments
224
+ - None</pre>
225
+
226
+ <h4 id="label-Copy+the+entry+for+today+to+clipboard">Copy the entry for today to clipboard<span><a href="#label-Copy+the+entry+for+today+to+clipboard">&para;</a> <a href="#top">&uarr;</a></span></h4>
185
227
 
186
228
  <p>There are also flags that will print entries to the command line. There&#39;s a full list of features below, but as a quick example, you can copy today&#39;s entry to your clipboard without even opening your editor.</p>
187
229
 
188
- <pre class="ruby"><span class="ruby-identifier">standup</span> <span class="ruby-operator">-</span><span class="ruby-identifier">c</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">pbcopy</span>
230
+ <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>
189
231
  </pre>
190
232
 
191
- <h2 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></h2>
233
+ <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>
234
+
235
+ <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>
236
+
237
+ <pre>standup --no-edit --current &quot;Work on this thing&quot;,&quot;And another thing&quot; -p</pre>
238
+
239
+ <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>
240
+
241
+ <p>If you wanted to find and print the entry for March 2nd, 2020, you could use the following.</p>
192
242
 
193
- <p>You can create a file in your home directory called <code>~/.standup_md.yml</code>. Settings located in this file will override default behavior. This file can also have settings overwritten at runtime by the use of options. You can view <a href="https://github.com/evanthegrayt/dotfiles/blob/master/dotfiles/standup_md.yml">my config file</a> as an example. Any setting in this file can still be overridden at runtime by passing flags to the executable.</p>
243
+ <pre>standup -p 2020-03-02</pre>
244
+
245
+ <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>
246
+
247
+ <p>You can create a file in your home directory called <code>~/.standuprc</code>. Settings located in this file will override default behavior. This file can also have settings overwritten at runtime by the use of options. You can view <a href="https://github.com/evanthegrayt/dotfiles/blob/master/dotfiles/standuprc">my config file</a> as an example. Any setting in this file can still be overridden at runtime by passing flags to the executable.</p>
194
248
 
195
249
  <p>You&#39;ll notice, a lot of settings don&#39;t have the ability to be changed at runtime when calling the executable. This is because the file structure is very important, and changing values that affect formatting will cause problems with the file parser. If you don&#39;t want to use a default, make the change in your config file before you start editing standups. There is an <a href="https://github.com/evanthegrayt/standup_md/issues/16">open issue</a> for handling this for the user, but they&#39;re not available yet.</p>
196
250
 
197
251
  <p>There are no options to change the headers at runtime because it uses the headers to detect tasks from previous entries. If changed at runtime, this would cause errors. For this reason, if you don&#39;t like the default headers, change them in your configuration file after installation, and then try to not change them again.</p>
198
252
 
199
- <h3 id="label-Available+Config+File+Keys+and+Defaults">Available Config File Keys and Defaults<span><a href="#label-Available+Config+File+Keys+and+Defaults">&para;</a> <a href="#top">&uarr;</a></span></h3>
200
-
201
- <pre># Key: Default
202
- header_depth: 1
203
- header_date_format: &#39;%Y-%m-%d&#39;
204
- sub_header_depth: 2
205
- current_header: &#39;Current&#39;
206
- previous_header: &#39;Previous&#39;
207
- impediments_header: &#39;Impediments&#39;
208
- file_name_format: &#39;%Y_%m.md&#39;
209
- bullet_character: &#39;-&#39; # (dash)
210
- directory: &#39;~/.cache/standup_md&#39;
211
- editor: # $VISUAL, $EDITOR or vim, in that order
212
- current_entry_tasks:
213
- - &quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;
214
- previous_entry_tasks: # An array of the tasks from the previous entry
215
- impediments:
216
- - &#39;None&#39;
217
- notes: null # If not null, must be array
218
- sub_header_order:
219
- - &#39;previous&#39;
220
- - &#39;current&#39;
221
- - &#39;impediments&#39;
222
- - &#39;notes&#39;</pre>
223
-
224
- <h3 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">&para;</a> <a href="#top">&uarr;</a></span></h3>
225
-
226
- <pre>The Standup Doctor
227
- --current-entry-tasks=ARRAY List of current entry&#39;s tasks
228
- --previous-entry-tasks=ARRAY List of yesterday&#39;s tasks
229
- --impediments=ARRAY List of impediments for current entry
230
- --notes=ARRAY List of notes for current entry
231
- --sub-header-order=ARRAY The order of the sub-headers when writing the file
232
- --[no-]append-previous Append previous tasks? Default is true
233
- -f, --file-name-format=STRING Date-formattable string to use for standup file name
234
- -e, --editor=EDITOR Editor to use for opening standup files
235
- -d, --directory=DIRECTORY The directories where standup files are located
236
- --[no-]write Write current entry if it doesn&#39;t exist. Default is true
237
- --[no-]edit Open the file in the editor. Default is true
238
- -j, --[no-]json Print output as formatted json. Default is false.
239
- -v, --[no-]verbose Verbose output. Default is false.
240
- -c, --current Print current entry. Disables editing
241
- -a, --all Print all previous entries. Disables editing</pre>
253
+ <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">&para;</a> <a href="#top">&uarr;</a></span></h4>
254
+
255
+ <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>
256
+ <span class="ruby-comment"># Defaults for how the file is formatted.</span>
257
+ <span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
258
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span> = <span class="ruby-string">&#39;%Y-%m-%d&#39;</span>
259
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span> = <span class="ruby-value">1</span>
260
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_depth</span> = <span class="ruby-value">2</span>
261
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Current&#39;</span>
262
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span> = <span class="ruby-string">&#39;Previous&#39;</span>
263
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span> = <span class="ruby-string">&#39;Impediments&#39;</span>
264
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">notes_header</span> = <span class="ruby-string">&#39;Notes&#39;</span>
265
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span> = <span class="ruby-node">%w[previous current impediments notes]</span>
266
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">directory</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>], <span class="ruby-string">&#39;.cache&#39;</span>, <span class="ruby-string">&#39;standup_md&#39;</span>)
267
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span> = <span class="ruby-string">&#39;-&#39;</span>
268
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">name_format</span> = <span class="ruby-string">&#39;%Y_%m.md&#39;</span>
269
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">create</span> = <span class="ruby-keyword">true</span>
270
+
271
+ <span class="ruby-comment"># Defaults for entries</span>
272
+ <span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Entry.html</span>
273
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">current</span> = [<span class="ruby-string">&quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;</span>]
274
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">previous</span> = []
275
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">impediments</span> = [<span class="ruby-string">&#39;None&#39;</span>]
276
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">notes</span> = []
277
+
278
+ <span class="ruby-comment"># Defaults for executable runtime behavior.</span>
279
+ <span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
280
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>
281
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">editor</span> = <span class="ruby-string">&#39;vim&#39;</span> <span class="ruby-comment"># Checks $VISUAL and $EDITOR first, in that order</span>
282
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">verbose</span> = <span class="ruby-keyword">false</span>
283
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">edit</span> = <span class="ruby-keyword">true</span>
284
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">write</span> = <span class="ruby-keyword">true</span>
285
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">print</span> = <span class="ruby-keyword">false</span>
286
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">auto_fill_previous</span> = <span class="ruby-keyword">true</span>
287
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">preference_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>], <span class="ruby-string">&#39;.standuprc&#39;</span>))
288
+ <span class="ruby-keyword">end</span>
289
+ </pre>
290
+
291
+ <h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">&para;</a> <a href="#top">&uarr;</a></span></h4>
292
+
293
+ <pre>--current ARRAY List of current entry&#39;s tasks
294
+ --previous ARRAY List of precious entry&#39;s tasks
295
+ --impediments ARRAY List of impediments for current entry
296
+ --notes ARRAY List of notes for current entry
297
+ --sub-header-order ARRAY The order of the sub-headers when writing the file
298
+ -f, --file-name-format STRING Date-formattable string to use for standup file name
299
+ -E, --editor EDITOR Editor to use for opening standup files
300
+ -d, --directory DIRECTORY The directories where standup files are located
301
+ -w --[no-]write Write current entry if it doesn&#39;t exist. Default is true
302
+ -a --[no-]auto-fill-previous Auto-generate &#39;previous&#39; tasks for new entries
303
+ -e --[no-]edit Open the file in the editor. Default is true
304
+ -v, --[no-]verbose Verbose output. Default is false.
305
+ -p, --print [DATE] Print current entry.
306
+ If DATE is passed, will print entry for DATE, if it exists.
307
+ DATE must be in the same format as file-name-format</pre>
242
308
 
243
309
  <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&#39;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>
244
310
 
245
- <p>If you wanted to add some tasks at runtime, and without opening the file in an editor, you could use the following:</p>
311
+ <h4 id="label-Using+Existing+Standup+Files">Using Existing Standup Files<span><a href="#label-Using+Existing+Standup+Files">&para;</a> <a href="#top">&uarr;</a></span></h4>
246
312
 
247
- <pre>standup --no-edit --current-entry-tasks=&quot;Work on this thing&quot;,&quot;And another thing!&quot;</pre>
313
+ <p>If you already have a directory of existing standup files, you can use them, but they must be in a format that the parser can understand. The default is:</p>
314
+
315
+ <pre># 2020-05-01
316
+ ## Previous
317
+ - task
318
+ ## Current
319
+ - task
320
+ ## Impediments
321
+ - impediment
322
+ ## Notes
323
+ - notes, if any are present</pre>
324
+
325
+ <p>The order, words, date format, and header level are all customizable, but the overall format must be the same. If customization is necessary, this must be done in <code>~/.standuprc</code> before execution, or else the parser will error.</p>
326
+
327
+ <p>For example, if you wanted the format to be as follows:</p>
328
+
329
+ <pre>## 05/01/2020
330
+ ### Today
331
+ * task
332
+ ### Yesterday
333
+ * task
334
+ ### Hold-ups
335
+ * impediment
336
+ ### Notes
337
+ * notes, if any are present</pre>
338
+
339
+ <p>Your <code>~/.standuprc</code> should contain:</p>
340
+
341
+ <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>
342
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span> <span class="ruby-value">2</span>
343
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_depth</span> <span class="ruby-value">3</span>
344
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> <span class="ruby-constant">Today</span>
345
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span> <span class="ruby-constant">Yesterday</span>
346
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span> <span class="ruby-constant">Hold</span><span class="ruby-operator">-</span><span class="ruby-identifier">ups</span>
347
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span> <span class="ruby-string">&#39;*&#39;</span>
348
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span> <span class="ruby-string">&#39;%m/%d/%Y&#39;</span>
349
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span> = <span class="ruby-node">%w[current previous impediments notes]</span>
350
+ <span class="ruby-keyword">end</span>
351
+ </pre>
248
352
 
249
353
  <h2 id="label-API">API<span><a href="#label-API">&para;</a> <a href="#top">&uarr;</a></span></h2>
250
354
 
251
- <p>Below are some quick examples, but the API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">documentation</a>.</p>
355
+ <p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">documentation</a>.</p>
252
356
 
253
- <p>This was mainly written as a command line utility, but I made the API available for scripting. There are attribute accessors for most of the settings in the <a href="#customization-and-runtime-options">customization table</a> above. To view all available methods, read the comments in the <a href="lib/standup_md.rb">source</a>. A quick-and-dirty example of how to write a new entry via code could look like the following:</p>
357
+ <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>
358
+
359
+ <h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
254
360
 
255
361
  <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
362
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
256
363
 
257
- <span class="ruby-identifier">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span>(
258
- <span class="ruby-value">current_header:</span> <span class="ruby-string">&#39;Today&#39;</span>,
259
- <span class="ruby-value">current_entry_tasks:</span> [<span class="ruby-string">&#39;Thing to do today&#39;</span>, <span class="ruby-string">&#39;Another thing to do today&#39;</span>],
260
- <span class="ruby-value">impediments:</span> [<span class="ruby-string">&#39;Not enough time in the day&#39;</span>]
261
- )
364
+ <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>
365
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Today&#39;</span>,
366
+ <span class="ruby-keyword">end</span>
262
367
 
263
- <span class="ruby-identifier">standup</span>.<span class="ruby-identifier">write</span>
368
+ <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-constant">Date</span>.<span class="ruby-identifier">today</span>)
369
+ <span class="ruby-identifier">entry</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Entry</span>.<span class="ruby-identifier">create</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">current</span> = [<span class="ruby-string">&#39;Stuff I will do today&#39;</span>] }
370
+ <span class="ruby-identifier">file</span>.<span class="ruby-identifier">entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">entry</span>
371
+ <span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>
264
372
  </pre>
265
373
 
266
- <p>Entries are just hashes, so you can easily transform them to <code>json</code> objects.</p>
374
+ <p>The above example was written as such to show how the different pieces of the API fit together. The code can actually be simplified to the following.</p>
267
375
 
268
376
  <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
269
- <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;json&#39;</span>
377
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;date&#39;</span>
378
+
379
+ <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
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Today&#39;</span>,
381
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">current</span> = [<span class="ruby-string">&#39;Stuff I will do today&#39;</span>]
382
+ <span class="ruby-keyword">end</span>
270
383
 
271
- <span class="ruby-identifier">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span>
272
- <span class="ruby-identifier">standup_entries_as_json</span> = <span class="ruby-identifier">standup</span>.<span class="ruby-identifier">all_entries</span>.<span class="ruby-identifier">to_json</span>
384
+ <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>
273
385
  </pre>
274
386
 
275
387
  <h2 id="label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features<span><a href="#label-Reporting+Bugs+and+Requesting+Features">&para;</a> <a href="#top">&uarr;</a></span></h2>
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","testcli","testhelper","teststandupmd","append_previous?()","append_to_previous_entry_tasks()","bullet_character=()","cli()","create_standup_file()","current_entry_tasks=()","directory=()","echo()","edit()","edit?()","editor()","entry_previously_added?()","execute()","file_written?()","fixtures()","header_depth=()","impediments=()","json?()","load()","load()","new()","new()","new_month?()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","setup()","setup()","should_append?()","should_append?()","standup()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","teardown()","teardown()","test_preference_file()","test_version()","test_all_previous_entries()","test_append_previous?()","test_bullet_character()","test_class_load()","test_current_entry()","test_current_entry_tasks()","test_current_header()","test_directory()","test_edit?()","test_editor()","test_entry_previously_added?()","test_file()","test_file_name_format()","test_file_written?()","test_header_date_format()","test_header_depth()","test_impediments()","test_impediments_header()","test_initialize()","test_json?()","test_load()","test_notes()","test_notes_header()","test_options()","test_preferences()","test_previous_entry_tasks()","test_previous_file_when_current_and_previous_month_do_not_exist()","test_previous_file_when_current_month_file_does_not_exist_but_previous_does()","test_previous_file_when_entry_exists_for_today()","test_previous_header()","test_print_all_entries?()","test_print_current_entry?()","test_reload()","test_self_execute()","test_setting_attributes_via_block()","test_standup()","test_sub_header_depth()","test_sub_header_order()","test_verbose?()","test_write()","test_write?()","verbose?()","write()","write?()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","testcli","testhelper","teststandupmd","standupmd::cli#append_previous?()","standupmd::cli#append_to_previous_entry_tasks()","standupmd#bullet_character=()","testhelper#cli()","testhelper#create_standup_file()","standupmd#current_entry_tasks=()","standupmd#directory=()","standupmd::cli#echo()","standupmd::cli#edit()","standupmd::cli#edit?()","standupmd::cli#editor()","standupmd#entry_previously_added?()","standupmd::cli::execute()","standupmd#file_written?()","testhelper#fixtures()","standupmd#header_depth=()","standupmd#impediments=()","standupmd::cli#json?()","standupmd#load()","standupmd::load()","standupmd::new()","standupmd::cli::new()","standupmd#new_month?()","standupmd#notes=()","standupmd#previous_entry_tasks=()","standupmd::cli#print_all_entries()","standupmd::cli#print_all_entries?()","standupmd::cli#print_current_entry()","standupmd::cli#print_current_entry?()","standupmd#reload()","testcli#setup()","teststandupmd#setup()","standupmd::cli#should_append?()","testcli#should_append?()","standupmd::cli#standup()","testhelper#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","testcli#teardown()","teststandupmd#teardown()","testcli#test_preference_file()","teststandupmd#test_version()","teststandupmd#test_all_previous_entries()","testcli#test_append_previous?()","teststandupmd#test_bullet_character()","teststandupmd#test_class_load()","teststandupmd#test_current_entry()","teststandupmd#test_current_entry_tasks()","teststandupmd#test_current_header()","teststandupmd#test_directory()","testcli#test_edit?()","testcli#test_editor()","teststandupmd#test_entry_previously_added?()","teststandupmd#test_file()","teststandupmd#test_file_name_format()","teststandupmd#test_file_written?()","teststandupmd#test_header_date_format()","teststandupmd#test_header_depth()","teststandupmd#test_impediments()","teststandupmd#test_impediments_header()","testcli#test_initialize()","testcli#test_json?()","teststandupmd#test_load()","teststandupmd#test_notes()","teststandupmd#test_notes_header()","testcli#test_options()","testcli#test_preferences()","teststandupmd#test_previous_entry_tasks()","teststandupmd#test_previous_file_when_current_and_previous_month_do_not_exist()","teststandupmd#test_previous_file_when_current_month_file_does_not_exist_but_previous_does()","teststandupmd#test_previous_file_when_entry_exists_for_today()","teststandupmd#test_previous_header()","testcli#test_print_all_entries?()","testcli#test_print_current_entry?()","teststandupmd#test_reload()","testcli#test_self_execute()","teststandupmd#test_setting_attributes_via_block()","testcli#test_standup()","teststandupmd#test_sub_header_depth()","teststandupmd#test_sub_header_order()","testcli#test_verbose?()","teststandupmd#test_write()","testcli#test_write?()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","

The class for handing reading/writing of entries.\n

@example\n\n

su = StandupMD.new\n
\n"],["StandupMD::Cli","","StandupMD/Cli.html","","

Class for handing the command-line interface.\n"],["TestCli","","TestCli.html","","

The test suite for Cli.\n"],["TestHelper","","TestHelper.html","","

Module to include in tests that provides helper functions.\n"],["TestStandupMD","","TestStandupMD.html","","

The test suite for StandupMD.\n"],["append_previous?","StandupMD::Cli","StandupMD/Cli.html#method-i-append_previous-3F","()","

Should `previous_entry_tasks` be appended? If false, previous_entry_tasks will be overwritten.\n

@return …\n"],["append_to_previous_entry_tasks","StandupMD::Cli","StandupMD/Cli.html#method-i-append_to_previous_entry_tasks","()","

Appends entries passed at runtime to existing previous entries.\n

@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","

Setter for bullet_character. Must be * (asterisk) or - (dash).\n

@param [String] character\n

@return [String] …\n"],["cli","TestHelper","TestHelper.html#method-i-cli","(options = [])","

Creates instance of Cli.\n

@param [Array] options Parsed by getopts\n

@return [StandupMD::Cli]\n"],["create_standup_file","TestHelper","TestHelper.html#method-i-create_standup_file","(file, fixture = 'previous_entry')","

Creates the standup file with entries.\n

@param [String] file The name of the file to create\n

@param [String] …\n"],["current_entry_tasks=","StandupMD","StandupMD.html#method-i-current_entry_tasks-3D","(tasks)","

Setter for current entry tasks.\n

@param [Array] tasks\n

@return [Array]\n"],["directory=","StandupMD","StandupMD.html#method-i-directory-3D","(directory)","

Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","

Prints output if verbose is true.\n

@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","

Opens the file in an editor. Abandons the script.\n"],["edit?","StandupMD::Cli","StandupMD/Cli.html#method-i-edit-3F","()","

Should the standup file be opened in the editor?\n

@return [Boolean] Default is true\n"],["editor","StandupMD::Cli","StandupMD/Cli.html#method-i-editor","()","

Tries to determine the editor, first by checking if the user has one set in their preferences. If not, …\n"],["entry_previously_added?","StandupMD","StandupMD.html#method-i-entry_previously_added-3F","()","

Was today's entry already in the file?\n

@return [boolean] true if today's entry was already in …\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","

Creates an instance of StandupMD and runs what the user requested.\n"],["file_written?","StandupMD","StandupMD.html#method-i-file_written-3F","()","

Has the file been written since instantiated?\n

@return [boolean]\n

@example\n"],["fixtures","TestHelper","TestHelper.html#method-i-fixtures","()","

Reads the fixtures in as a hash.\n

@return [Hash]\n"],["header_depth=","StandupMD","StandupMD.html#method-i-header_depth-3D","(depth)","

Number of octothorps (#) to use before the main header.\n

@param [Integer] depth\n

@return [Integer]\n"],["impediments=","StandupMD","StandupMD.html#method-i-impediments-3D","(tasks)","

Setter for impediments.\n

@param [Array] tasks\n

@return [Array]\n"],["json?","StandupMD::Cli","StandupMD/Cli.html#method-i-json-3F","()","

If printing an entry, should it be printed as json?\n

@return [Boolean] Default is false\n"],["load","StandupMD","StandupMD.html#method-i-load","()","

Sets internal instance variables. Called when first instantiated, or after directory is set.\n

@return [self] …\n"],["load","StandupMD","StandupMD.html#method-c-load","(attributes = {})","

Convenience method for calling new + load\n

@param [Hash] attributes Attributes to set before loading.\n

@example …\n"],["new","StandupMD","StandupMD.html#method-c-new","()","

Constructor. Yields the instance so you can pass a block to access setters.\n

@return [self]\n

@example\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options)","

Constructor. Sets defaults.\n

@param [Array] options\n"],["new_month?","StandupMD","StandupMD.html#method-i-new_month-3F","()","

Is today a different month than the previous entry?\n"],["notes=","StandupMD","StandupMD.html#method-i-notes-3D","(tasks)","

Setter for notes.\n

@param [Array] notes\n

@return [Array]\n"],["previous_entry_tasks=","StandupMD","StandupMD.html#method-i-previous_entry_tasks-3D","(tasks)","

Setter for current entry tasks.\n

@param [Array] tasks\n

@return [Array]\n"],["print_all_entries","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries","()","

Prints all entries to the command line.\n

@return [nil]\n"],["print_all_entries?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries-3F","()","

Should all entries be printed? If true, disables editing.\n

@return [Boolean] Default is false\n"],["print_current_entry","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry","()","

Prints the current entry to the command line.\n

@return [nil]\n"],["print_current_entry?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry-3F","()","

Should current entry be printed? If true, disables editing.\n

@return [Boolean] Default is false\n"],["reload","StandupMD","StandupMD.html#method-i-reload","()","

Alias of load\n

@return [self]\n"],["setup","TestCli","TestCli.html#method-i-setup","()","

Set working directory, current month's file, and last month's file, which will be created and …\n"],["setup","TestStandupMD","TestStandupMD.html#method-i-setup","()","

Set working directory, current month's file, and last month's file, which will be created and …\n"],["should_append?","StandupMD::Cli","StandupMD/Cli.html#method-i-should_append-3F","()","

Did the user pass previous_entry_tasks, and should we append?\n

@return [Boolean]\n"],["should_append?","TestCli","TestCli.html#method-i-should_append-3F","()","

True only if --no-append and --previous-entry-tasks are passed.\n"],["standup","StandupMD::Cli","StandupMD/Cli.html#method-i-standup","()","

Sets up an instance of StandupMD and passes all user preferences.\n

@return [StandupMD]\n"],["standup","TestHelper","TestHelper.html#method-i-standup","(directory, args = {})","

Creates StandupUP instance. Directory must be passed, usually a subdirectory of test, so we don't …\n"],["sub_header_depth=","StandupMD","StandupMD.html#method-i-sub_header_depth-3D","(depth)","

Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n

@param [Integer] depth\n

@return …\n"],["sub_header_order","StandupMD","StandupMD.html#method-i-sub_header_order","()","

Return a copy of the sub-header order so the user can't modify the array.\n

@return [Array]\n"],["sub_header_order=","StandupMD","StandupMD.html#method-i-sub_header_order-3D","(array)","

Preferred order for sub-headers.\n

@param [Array] Values must be %w[previous current impediment notes]\n

@return …\n"],["teardown","TestCli","TestCli.html#method-i-teardown","()","

Destroy the working directory and its contents.\n"],["teardown","TestStandupMD","TestStandupMD.html#method-i-teardown","()","

Destroy the working directory and its contents.\n"],["test_PREFERENCE_FILE","TestCli","TestCli.html#method-i-test_PREFERENCE_FILE","()","

The user's preference file is a string.\n"],["test_VERSION","TestStandupMD","TestStandupMD.html#method-i-test_VERSION","()","

StandupMD::VERSION should consist of three integers separated by dots.\n"],["test_all_previous_entries","TestStandupMD","TestStandupMD.html#method-i-test_all_previous_entries","()","

Should be all entries before the current entry.\n"],["test_append_previous?","TestCli","TestCli.html#method-i-test_append_previous-3F","()","

True by default. False if flag is passed.\n"],["test_bullet_character","TestStandupMD","TestStandupMD.html#method-i-test_bullet_character","()","

Should be able to change the bullet character but should raise if not * or -\n"],["test_class_load","TestStandupMD","TestStandupMD.html#method-i-test_class_load","()","

Make sure load accepts a hash of attributes, sets them, and returns an instance of itself.\n"],["test_current_entry","TestStandupMD","TestStandupMD.html#method-i-test_current_entry","()","

current_entry should be a hash. If file already has an entry for today, it will be read and used as …\n"],["test_current_entry_tasks","TestStandupMD","TestStandupMD.html#method-i-test_current_entry_tasks","()","

Should be able to add tasks for current_entry.\n"],["test_current_header","TestStandupMD","TestStandupMD.html#method-i-test_current_header","()","

Should be changeable and used as the header for current_entry\n"],["test_directory","TestStandupMD","TestStandupMD.html#method-i-test_directory","()","

Directory should default be settable, and where standup files are read from.\n"],["test_edit?","TestCli","TestCli.html#method-i-test_edit-3F","()","

True by default. False if flag is passed.\n"],["test_editor","TestCli","TestCli.html#method-i-test_editor","()","

The editor should be set by preferences, or env, or set to 'vim'.\n"],["test_entry_previously_added?","TestStandupMD","TestStandupMD.html#method-i-test_entry_previously_added-3F","()","

Should be true if current_entry was in the file at the time it was read.\n"],["test_file","TestStandupMD","TestStandupMD.html#method-i-test_file","()","

The file name should equal file_name_format parsed by Date.strftime. The default is Date.today.strftime('%Y_%m.md') …\n"],["test_file_name_format","TestStandupMD","TestStandupMD.html#method-i-test_file_name_format","()","

Should be changeable, and return a string parsed by strftime.\n"],["test_file_written?","TestStandupMD","TestStandupMD.html#method-i-test_file_written-3F","()","

Should be false when first instantiated, true after write is called.\n"],["test_header_date_format","TestStandupMD","TestStandupMD.html#method-i-test_header_date_format","()","

Should be changeable, and return a string parsed by strftime.\n"],["test_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_header_depth","()","

Should be an integer between 1..5, but not higher than sub_header_depth.\n"],["test_impediments","TestStandupMD","TestStandupMD.html#method-i-test_impediments","()","

Should be able to add impediments to the array.\n"],["test_impediments_header","TestStandupMD","TestStandupMD.html#method-i-test_impediments_header","()","

Should be changeable and used as the header for impediments\n"],["test_initialize","TestCli","TestCli.html#method-i-test_initialize","()","

The initialize method should accept the same parameters as exectute.\n"],["test_json?","TestCli","TestCli.html#method-i-test_json-3F","()","

False by default. True if flag is passed.\n"],["test_load","TestStandupMD","TestStandupMD.html#method-i-test_load","()","

Should load instance variables.\n"],["test_notes","TestStandupMD","TestStandupMD.html#method-i-test_notes","()","

Should be able to add notes to the array.\n"],["test_notes_header","TestStandupMD","TestStandupMD.html#method-i-test_notes_header","()","

Should be changeable and used as the header for notes\n"],["test_options","TestCli","TestCli.html#method-i-test_options","()","

The options should be an array of options passed from the command line.\n"],["test_preferences","TestCli","TestCli.html#method-i-test_preferences","()","

The preferences are the settings after options are parsed.\n"],["test_previous_entry_tasks","TestStandupMD","TestStandupMD.html#method-i-test_previous_entry_tasks","()","

Should be an array of previous entry's current entry.\n"],["test_previous_file_when_current_and_previous_month_do_not_exist","TestStandupMD","TestStandupMD.html#method-i-test_previous_file_when_current_and_previous_month_do_not_exist","()","

When neither last month's file, nor this month's file exist, previous_file should be an empty …\n"],["test_previous_file_when_current_month_file_does_not_exist_but_previous_does","TestStandupMD","TestStandupMD.html#method-i-test_previous_file_when_current_month_file_does_not_exist_but_previous_does","()","

When last month's file exists, but this month's doesn't or is empty, previous_file should …\n"],["test_previous_file_when_entry_exists_for_today","TestStandupMD","TestStandupMD.html#method-i-test_previous_file_when_entry_exists_for_today","()","

If there are previous entries for this month, previous file will be this month's file.\n"],["test_previous_header","TestStandupMD","TestStandupMD.html#method-i-test_previous_header","()","

Should be changeable and used as the header for previous_entry\n"],["test_print_all_entries?","TestCli","TestCli.html#method-i-test_print_all_entries-3F","()","

False by default. True if flag is passed.\n"],["test_print_current_entry?","TestCli","TestCli.html#method-i-test_print_current_entry-3F","()","

False by default. True if flag is passed.\n"],["test_reload","TestStandupMD","TestStandupMD.html#method-i-test_reload","()","

The reload method should exist, and is an alias of load.\n"],["test_self_execute","TestCli","TestCli.html#method-i-test_self_execute","()","

The execute method is the entry point for the Cli. It's parameter is an array of command-line flags …\n"],["test_setting_attributes_via_block","TestStandupMD","TestStandupMD.html#method-i-test_setting_attributes_via_block","()","

Attributes should be able to be set if you pass a block at instantiation.\n"],["test_standup","TestCli","TestCli.html#method-i-test_standup","()","

Creates the instance of StandupMD.\n"],["test_sub_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_depth","()","

Should be an integer between 2..6, but not lower than header_depth.\n"],["test_sub_header_order","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_order","()","

The order of the subheaders is changeable, but all elements must exist.\n"],["test_verbose?","TestCli","TestCli.html#method-i-test_verbose-3F","()","

False by default. True if flag is passed.\n"],["test_write","TestStandupMD","TestStandupMD.html#method-i-test_write","()","

Should write the file.\n"],["test_write?","TestCli","TestCli.html#method-i-test_write-3F","()","

True by default. False if flag is passed.\n"],["verbose?","StandupMD::Cli","StandupMD/Cli.html#method-i-verbose-3F","()","

Should debug info be printed?\n

@return [Boolean] Default is false\n"],["write","StandupMD","StandupMD.html#method-i-write","()","

Writes a new entry to the file if the first entry in the file isn't today.\n

@return [Boolean]\n"],["write?","StandupMD::Cli","StandupMD/Cli.html#method-i-write-3F","()","

Should the file be written?\n

@return [Boolean] Default is true\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","

Writes entries to the file.\n

@return [Boolean] true if file was written\n"],["README","","README_md.html","","

The Standup Doctor\n\n

The cure for all your standup woes.\n

\n

A highly customizable and automated way to keep …\n"]]}}

1
+ var search_data = {"index":{"searchIndex":["standupmd","cli","helpers","config","cli","entry","entrylist","file","entry","entrylist","file","<<()","<=>()","bullet_character=()","config()","config()","config()","config()","config()","config_file_loaded?()","configure()","create()","directory=()","each()","echo()","echo()","edit()","empty?()","execute()","exist?()","filter()","filter!()","find()","find()","find_by_date()","first()","header_depth=()","initalize()","last()","load()","load_config_file()","load_preferences()","loaded?()","new()","new()","new()","new()","new()","new()","new()","new()","new?()","preference_file_loaded?()","print()","reset_config()","reset_values()","reset_values()","reset_values()","reset_values()","size()","sort()","sort!()","sort_reverse()","sub_header_depth=()","to_h()","to_h()","to_json()","to_json()","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::entrylist#<<()","standupmd::entry#<=>()","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::entrylist#each()","standupmd::cli#echo()","standupmd::cli::echo()","standupmd::cli#edit()","standupmd::entrylist#empty?()","standupmd::cli::execute()","standupmd::file#exist?()","standupmd::entrylist#filter()","standupmd::entrylist#filter!()","standupmd::entrylist#find()","standupmd::file::find()","standupmd::file::find_by_date()","standupmd::entrylist#first()","standupmd::config::file#header_depth=()","standupmd::config::entrylist#initalize()","standupmd::entrylist#last()","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::reset_config()","standupmd::config::cli#reset_values()","standupmd::config::entry#reset_values()","standupmd::config::entrylist#reset_values()","standupmd::config::file#reset_values()","standupmd::entrylist#size()","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::file#write()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","

The class for handing reading/writing of entries.\n"],["StandupMD::Cli","","StandupMD/Cli.html","","

Class for handing the command-line interface.\n"],["StandupMD::Cli::Helpers","","StandupMD/Cli/Helpers.html","","

Module responsible for reading and writing standup files.\n"],["StandupMD::Config","","StandupMD/Config.html","","

This class provides a connector from StandupMD to the configuration classes.\n"],["StandupMD::Config::Cli","","StandupMD/Config/Cli.html","","

The configuration class for StandupMD::Cli\n"],["StandupMD::Config::Entry","","StandupMD/Config/Entry.html","","

The configuration class for StandupMD::Entry\n"],["StandupMD::Config::EntryList","","StandupMD/Config/EntryList.html","","

The configuration class for StandupMD::EntryList\n"],["StandupMD::Config::File","","StandupMD/Config/File.html","","

The configuration class for StandupMD::File\n"],["StandupMD::Entry","","StandupMD/Entry.html","","

Class for handling single entries. Includes the comparable module, and compares by date.\n"],["StandupMD::EntryList","","StandupMD/EntryList.html","","

Enumerable list of entries.\n"],["StandupMD::File","","StandupMD/File.html","","

Class for handling reading and writing standup files.\n"],["<<","StandupMD::EntryList","StandupMD/EntryList.html#method-i-3C-3C","(entry)","

Appends entries to list.\n

@param [StandupMD::Entry] entry\n

@return [Array]\n"],["<=>","StandupMD::Entry","StandupMD/Entry.html#method-i-3C-3D-3E","(other)","

Sorting method for Comparable. Entries are compared by date.\n"],["bullet_character=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-bullet_character-3D","(char)","

Setter for bullet_character. Must be * (asterisk) or - (dash).\n

@param [String] character\n

@return [String] …\n"],["config","StandupMD","StandupMD.html#method-c-config","()","

Shorthand for StanupMD::Cli\n

@return [StanupMD::Cli]\n"],["config","StandupMD::Cli","StandupMD/Cli.html#method-c-config","()","

Access to the class's configuration.\n

@return [StandupMD::Config::Cli]\n"],["config","StandupMD::Entry","StandupMD/Entry.html#method-c-config","()","

Access to the class's configuration.\n

@return [StandupMD::Config::Entry]\n"],["config","StandupMD::EntryList","StandupMD/EntryList.html#method-c-config","()","

Access to the class's configuration.\n

@return [StandupMD::Config::EntryList]\n"],["config","StandupMD::File","StandupMD/File.html#method-c-config","()","

Access to the class's configuration.\n

@return [StandupMD::Config::EntryList]\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-c-config_file_loaded-3F","()","

Has a config file been loaded?\n

@return [Boolean]\n"],["configure","StandupMD","StandupMD.html#method-c-configure","()","

Allows for configuration via a block. Useful when making config files.\n

@example\n\n

StandupMD.configure { |s| ...
\n"],["create","StandupMD::Entry","StandupMD/Entry.html#method-c-create","()","

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)","

Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["each","StandupMD::EntryList","StandupMD/EntryList.html#method-i-each","(&block)","

Iterate over the list and yield each entry.\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","

Quick access to Cli.echo.\n

@return [nil]\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-c-echo","(msg)","

Prints output if verbose is true.\n

@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","

Opens the file in an editor. Abandons the script.\n

@return [nil]\n"],["empty?","StandupMD::EntryList","StandupMD/EntryList.html#method-i-empty-3F","()","

Is the list empty?\n

@return [Boolean] true if empty\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","

Creates an instance of StandupMD and runs what the user requested.\n"],["exist?","StandupMD::File","StandupMD/File.html#method-i-exist-3F","()","

Does the file exist?\n

@return [Boolean] true if exists\n"],["filter","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter","(start_date, end_date)","

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)","

Replaces entries with results of filter.\n

@param [Date] start_date\n

@param [Date] end_date\n"],["find","StandupMD::EntryList","StandupMD/EntryList.html#method-i-find","(key)","

Finds an entry based on date. This method assumes the list has already been sorted.\n"],["find","StandupMD::File","StandupMD/File.html#method-c-find","(file_name)","

Find standup file in directory by file name.\n

@param [String] File_naem\n"],["find_by_date","StandupMD::File","StandupMD/File.html#method-c-find_by_date","(date)","

Find standup file in directory by Date object.\n

@param [Date] date\n"],["first","StandupMD::EntryList","StandupMD/EntryList.html#method-i-first","()","

The first entry in the list. This method assumes the list has already been sorted.\n

@return [StandupMD::Entry] …\n"],["header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-header_depth-3D","(depth)","

Number of octothorps (#) to use before the main header.\n

@param [Integer] depth\n

@return [Integer]\n"],["initalize","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-initalize","()","

Initializes the config with default values.\n"],["last","StandupMD::EntryList","StandupMD/EntryList.html#method-i-last","()","

The last entry in the list. This method assumes the list has already been sorted.\n

@return [StandupMD::Entry] …\n"],["load","StandupMD::File","StandupMD/File.html#method-i-load","()","

Loads the file's contents. TODO clean up this method.\n

@return [StandupMD::FileList]\n"],["load_config_file","StandupMD","StandupMD.html#method-c-load_config_file","(file)","

Loads a config file.\n

@param [String] file\n"],["load_preferences","StandupMD::Cli","StandupMD/Cli.html#method-i-load_preferences","()","

Load the preference file.\n

@return [nil]\n"],["loaded?","StandupMD::File","StandupMD/File.html#method-i-loaded-3F","()","

Has the file been loaded?\n

@return [Boolean] true if loaded\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options = [], load_config = true)","

Constructor. Sets defaults.\n

@param [Array] options\n"],["new","StandupMD::Config","StandupMD/Config.html#method-c-new","()","

Builds the links to the configuration classes.\n"],["new","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-c-new","()","

Initializes the config with default values.\n"],["new","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-c-new","()","

Initializes the config with default values.\n"],["new","StandupMD::Config::File","StandupMD/Config/File.html#method-c-new","()","

Initializes the config with default values.\n"],["new","StandupMD::Entry","StandupMD/Entry.html#method-c-new","(date, current, previous, impediments, notes = [])","

Constructs instance of StandupMD::Entry.\n

@param [Date] date\n

@param [Array] current\n"],["new","StandupMD::EntryList","StandupMD/EntryList.html#method-c-new","(*entries)","

Contruct a list. Can pass any amount of StandupMD::Entry instances.\n

@param [Entry] entries\n

@return [StandupMD::EntryList] …\n"],["new","StandupMD::File","StandupMD/File.html#method-c-new","(file_name)","

Constructs the instance.\n

@param [String] file_name\n

@return [StandupMP::File]\n"],["new?","StandupMD::File","StandupMD/File.html#method-i-new-3F","()","

Was the file just now created?\n

@return [Boolean] true if new\n"],["preference_file_loaded?","StandupMD::Cli","StandupMD/Cli.html#method-i-preference_file_loaded-3F","()","

Has the preference file been loaded?\n

@return boolean\n"],["print","StandupMD::Cli::Helpers","StandupMD/Cli/Helpers.html#method-i-print","(entry)","

Print an entry to the command line.\n

@param [StandupMD::Entry] entry\n

@return [nil]\n"],["reset_config","StandupMD","StandupMD.html#method-c-reset_config","()","

Reset all configuration values to their defaults.\n

@return [StandupMD::Config]\n"],["reset_values","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset_values","()","

Sets all config values back to their defaults.\n

@return [Boolean] true if successful\n"],["reset_values","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-i-reset_values","()","

Sets all config values back to their defaults.\n

@return [Boolean] true if successful\n"],["reset_values","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-reset_values","()","

Sets all config values back to their defaults.\n

@return [Boolean] true if successful\n"],["reset_values","StandupMD::Config::File","StandupMD/Config/File.html#method-i-reset_values","()","

Sets all config values back to their defaults.\n

@return [Boolean] true if successful\n"],["size","StandupMD::EntryList","StandupMD/EntryList.html#method-i-size","()","

How many entries are in the list.\n

@return [Integer]\n"],["sort","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort","()","

Returns a copy of self sorted by date.\n

@return [StandupMD::EntryList]\n"],["sort!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort-21","()","

Replace entries with sorted entries by date.\n

@return [StandupMD::EntryList]\n"],["sort_reverse","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort_reverse","()","

Returns a copy of self sorted by date.\n

@return [StandupMD::EntryList]\n"],["sub_header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-sub_header_depth-3D","(depth)","

Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n

@param [Integer] depth\n

@return …\n"],["to_h","StandupMD::Entry","StandupMD/Entry.html#method-i-to_h","()","

Entry as a hash .\n

@return [Hash]\n"],["to_h","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_h","()","

The list as a hash, with the dates as keys.\n

@return [Hash]\n"],["to_json","StandupMD::Entry","StandupMD/Entry.html#method-i-to_json","()","

Entry as a json object.\n

@return [String]\n"],["to_json","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_json","()","

The entry list as a json object.\n

@return [String]\n"],["write","StandupMD::File","StandupMD/File.html#method-i-write","(dates = {})","

Writes a new entry to the file if the first entry in the file isn't today. This method is destructive; …\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","

Writes entries to the file.\n

@return [Boolean] true if file was written\n"],["README","","README_md.html","","

The Standup Doctor\n

…\n\n

"]]}}
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
@@ -51,16 +51,30 @@
51
51
 
52
52
  <li><a href="README_md.html#label-Usage">Usage</a>
53
53
 
54
- <li><a href="README_md.html#label-Example">Example</a>
54
+ <li><a href="README_md.html#label-Command+Line">Command Line</a>
55
+
56
+ <li><a href="README_md.html#label-CLI+Examples">CLI Examples</a>
57
+
58
+ <li><a href="README_md.html#label-Adding+an+entry+for+today+via+editor">Adding an entry for today via editor</a>
59
+
60
+ <li><a href="README_md.html#label-Copy+the+entry+for+today+to+clipboard">Copy the entry for today to clipboard</a>
61
+
62
+ <li><a href="README_md.html#label-Add+entry+to+file+without+opening+it">Add entry to file without opening it</a>
63
+
64
+ <li><a href="README_md.html#label-Find+an+entry+by+date+and+print+it.">Find an entry by date and print it.</a>
55
65
 
56
66
  <li><a href="README_md.html#label-Customization+and+Runtime+Options">Customization and Runtime Options</a>
57
67
 
58
- <li><a href="README_md.html#label-Available+Config+File+Keys+and+Defaults">Available Config File Keys and Defaults</a>
68
+ <li><a href="README_md.html#label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults</a>
59
69
 
60
70
  <li><a href="README_md.html#label-Executable+Flags">Executable Flags</a>
61
71
 
72
+ <li><a href="README_md.html#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
73
+
62
74
  <li><a href="README_md.html#label-API">API</a>
63
75
 
76
+ <li><a href="README_md.html#label-API+Examples">API Examples</a>
77
+
64
78
  <li><a href="README_md.html#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
65
79
 
66
80
  <li><a href="README_md.html#label-Self-Promotion">Self-Promotion</a>
@@ -75,484 +89,355 @@
75
89
  <h2 id="classes">Classes and Modules</h2>
76
90
  <ul>
77
91
 
78
- <li class="class">
92
+ <li class="module">
79
93
  <a href="StandupMD.html">StandupMD</a>
80
94
 
81
- <ul>
82
-
83
- <li><a href="StandupMD.html#5Buntitled-5D">Top Section</a>
84
-
85
- <li><a href="StandupMD.html#Attributes+with+default+getters+and+setters.">Attributes with default getters and setters.</a>
86
-
87
- <li><a href="StandupMD.html#Booleans">Booleans</a>
95
+ </li>
88
96
 
89
- <li><a href="StandupMD.html#Custom+setters">Custom setters</a>
97
+ <li class="class">
98
+ <a href="StandupMD/Cli.html">StandupMD::Cli</a>
90
99
 
91
- <li><a href="StandupMD.html#Misc">Misc</a>
100
+ </li>
92
101
 
93
- </ul>
102
+ <li class="module">
103
+ <a href="StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
94
104
 
95
105
  </li>
96
106
 
97
107
  <li class="class">
98
- <a href="StandupMD/Cli.html">StandupMD::Cli</a>
108
+ <a href="StandupMD/Config.html">StandupMD::Config</a>
99
109
 
100
110
  </li>
101
111
 
102
112
  <li class="class">
103
- <a href="TestCli.html">TestCli</a>
113
+ <a href="StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
104
114
 
105
115
  </li>
106
116
 
107
- <li class="module">
108
- <a href="TestHelper.html">TestHelper</a>
117
+ <li class="class">
118
+ <a href="StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
109
119
 
110
120
  </li>
111
121
 
112
122
  <li class="class">
113
- <a href="TestStandupMD.html">TestStandupMD</a>
123
+ <a href="StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
114
124
 
115
125
  </li>
116
126
 
117
- </ul>
118
-
119
- <h2 id="methods">Methods</h2>
120
- <ul>
121
-
122
- <li class="method">
123
- <a href="StandupMD/Cli.html#method-c-execute">::execute</a>
124
- &mdash;
125
- <span class="container">StandupMD::Cli</span>
126
-
127
- <li class="method">
128
- <a href="StandupMD.html#method-c-load">::load</a>
129
- &mdash;
130
- <span class="container">StandupMD</span>
127
+ <li class="class">
128
+ <a href="StandupMD/Config/File.html">StandupMD::Config::File</a>
131
129
 
132
- <li class="method">
133
- <a href="StandupMD.html#method-c-new">::new</a>
134
- &mdash;
135
- <span class="container">StandupMD</span>
130
+ </li>
136
131
 
137
- <li class="method">
138
- <a href="StandupMD/Cli.html#method-c-new">::new</a>
139
- &mdash;
140
- <span class="container">StandupMD::Cli</span>
132
+ <li class="class">
133
+ <a href="StandupMD/Entry.html">StandupMD::Entry</a>
141
134
 
142
- <li class="method">
143
- <a href="StandupMD/Cli.html#method-i-append_previous-3F">#append_previous?</a>
144
- &mdash;
145
- <span class="container">StandupMD::Cli</span>
135
+ </li>
146
136
 
147
- <li class="method">
148
- <a href="StandupMD/Cli.html#method-i-append_to_previous_entry_tasks">#append_to_previous_entry_tasks</a>
149
- &mdash;
150
- <span class="container">StandupMD::Cli</span>
137
+ <li class="class">
138
+ <a href="StandupMD/EntryList.html">StandupMD::EntryList</a>
151
139
 
152
- <li class="method">
153
- <a href="StandupMD.html#method-i-bullet_character-3D">#bullet_character=</a>
154
- &mdash;
155
- <span class="container">StandupMD</span>
140
+ </li>
156
141
 
157
- <li class="method">
158
- <a href="TestHelper.html#method-i-cli">#cli</a>
159
- &mdash;
160
- <span class="container">TestHelper</span>
142
+ <li class="class">
143
+ <a href="StandupMD/File.html">StandupMD::File</a>
161
144
 
162
- <li class="method">
163
- <a href="TestHelper.html#method-i-create_standup_file">#create_standup_file</a>
164
- &mdash;
165
- <span class="container">TestHelper</span>
145
+ </li>
166
146
 
167
- <li class="method">
168
- <a href="StandupMD.html#method-i-current_entry_tasks-3D">#current_entry_tasks=</a>
169
- &mdash;
170
- <span class="container">StandupMD</span>
147
+ </ul>
171
148
 
172
- <li class="method">
173
- <a href="StandupMD.html#method-i-directory-3D">#directory=</a>
174
- &mdash;
175
- <span class="container">StandupMD</span>
149
+ <h2 id="methods">Methods</h2>
150
+ <ul>
176
151
 
177
152
  <li class="method">
178
- <a href="StandupMD/Cli.html#method-i-echo">#echo</a>
153
+ <a href="StandupMD/Entry.html#method-c-config">::config</a>
179
154
  &mdash;
180
- <span class="container">StandupMD::Cli</span>
155
+ <span class="container">StandupMD::Entry</span>
181
156
 
182
157
  <li class="method">
183
- <a href="StandupMD/Cli.html#method-i-edit">#edit</a>
158
+ <a href="StandupMD/File.html#method-c-config">::config</a>
184
159
  &mdash;
185
- <span class="container">StandupMD::Cli</span>
160
+ <span class="container">StandupMD::File</span>
186
161
 
187
162
  <li class="method">
188
- <a href="StandupMD/Cli.html#method-i-edit-3F">#edit?</a>
163
+ <a href="StandupMD/Cli.html#method-c-config">::config</a>
189
164
  &mdash;
190
165
  <span class="container">StandupMD::Cli</span>
191
166
 
192
167
  <li class="method">
193
- <a href="StandupMD/Cli.html#method-i-editor">#editor</a>
194
- &mdash;
195
- <span class="container">StandupMD::Cli</span>
196
-
197
- <li class="method">
198
- <a href="StandupMD.html#method-i-entry_previously_added-3F">#entry_previously_added?</a>
199
- &mdash;
200
- <span class="container">StandupMD</span>
201
-
202
- <li class="method">
203
- <a href="StandupMD.html#method-i-file_written-3F">#file_written?</a>
168
+ <a href="StandupMD.html#method-c-config">::config</a>
204
169
  &mdash;
205
170
  <span class="container">StandupMD</span>
206
171
 
207
172
  <li class="method">
208
- <a href="TestHelper.html#method-i-fixtures">#fixtures</a>
209
- &mdash;
210
- <span class="container">TestHelper</span>
211
-
212
- <li class="method">
213
- <a href="StandupMD.html#method-i-header_depth-3D">#header_depth=</a>
214
- &mdash;
215
- <span class="container">StandupMD</span>
216
-
217
- <li class="method">
218
- <a href="StandupMD.html#method-i-impediments-3D">#impediments=</a>
219
- &mdash;
220
- <span class="container">StandupMD</span>
221
-
222
- <li class="method">
223
- <a href="StandupMD/Cli.html#method-i-json-3F">#json?</a>
224
- &mdash;
225
- <span class="container">StandupMD::Cli</span>
226
-
227
- <li class="method">
228
- <a href="StandupMD.html#method-i-load">#load</a>
173
+ <a href="StandupMD/EntryList.html#method-c-config">::config</a>
229
174
  &mdash;
230
- <span class="container">StandupMD</span>
175
+ <span class="container">StandupMD::EntryList</span>
231
176
 
232
177
  <li class="method">
233
- <a href="StandupMD.html#method-i-new_month-3F">#new_month?</a>
178
+ <a href="StandupMD.html#method-c-config_file_loaded-3F">::config_file_loaded?</a>
234
179
  &mdash;
235
180
  <span class="container">StandupMD</span>
236
181
 
237
182
  <li class="method">
238
- <a href="StandupMD.html#method-i-notes-3D">#notes=</a>
183
+ <a href="StandupMD.html#method-c-configure">::configure</a>
239
184
  &mdash;
240
185
  <span class="container">StandupMD</span>
241
186
 
242
187
  <li class="method">
243
- <a href="StandupMD.html#method-i-previous_entry_tasks-3D">#previous_entry_tasks=</a>
188
+ <a href="StandupMD/Entry.html#method-c-create">::create</a>
244
189
  &mdash;
245
- <span class="container">StandupMD</span>
190
+ <span class="container">StandupMD::Entry</span>
246
191
 
247
192
  <li class="method">
248
- <a href="StandupMD/Cli.html#method-i-print_all_entries">#print_all_entries</a>
193
+ <a href="StandupMD/Cli.html#method-c-echo">::echo</a>
249
194
  &mdash;
250
195
  <span class="container">StandupMD::Cli</span>
251
196
 
252
197
  <li class="method">
253
- <a href="StandupMD/Cli.html#method-i-print_all_entries-3F">#print_all_entries?</a>
198
+ <a href="StandupMD/Cli.html#method-c-execute">::execute</a>
254
199
  &mdash;
255
200
  <span class="container">StandupMD::Cli</span>
256
201
 
257
202
  <li class="method">
258
- <a href="StandupMD/Cli.html#method-i-print_current_entry">#print_current_entry</a>
203
+ <a href="StandupMD/File.html#method-c-find">::find</a>
259
204
  &mdash;
260
- <span class="container">StandupMD::Cli</span>
205
+ <span class="container">StandupMD::File</span>
261
206
 
262
207
  <li class="method">
263
- <a href="StandupMD/Cli.html#method-i-print_current_entry-3F">#print_current_entry?</a>
208
+ <a href="StandupMD/File.html#method-c-find_by_date">::find_by_date</a>
264
209
  &mdash;
265
- <span class="container">StandupMD::Cli</span>
210
+ <span class="container">StandupMD::File</span>
266
211
 
267
212
  <li class="method">
268
- <a href="StandupMD.html#method-i-reload">#reload</a>
213
+ <a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
269
214
  &mdash;
270
215
  <span class="container">StandupMD</span>
271
216
 
272
217
  <li class="method">
273
- <a href="TestStandupMD.html#method-i-setup">#setup</a>
218
+ <a href="StandupMD/EntryList.html#method-c-new">::new</a>
274
219
  &mdash;
275
- <span class="container">TestStandupMD</span>
220
+ <span class="container">StandupMD::EntryList</span>
276
221
 
277
222
  <li class="method">
278
- <a href="TestCli.html#method-i-setup">#setup</a>
223
+ <a href="StandupMD/Config/File.html#method-c-new">::new</a>
279
224
  &mdash;
280
- <span class="container">TestCli</span>
225
+ <span class="container">StandupMD::Config::File</span>
281
226
 
282
227
  <li class="method">
283
- <a href="TestCli.html#method-i-should_append-3F">#should_append?</a>
228
+ <a href="StandupMD/File.html#method-c-new">::new</a>
284
229
  &mdash;
285
- <span class="container">TestCli</span>
230
+ <span class="container">StandupMD::File</span>
286
231
 
287
232
  <li class="method">
288
- <a href="StandupMD/Cli.html#method-i-should_append-3F">#should_append?</a>
233
+ <a href="StandupMD/Config.html#method-c-new">::new</a>
289
234
  &mdash;
290
- <span class="container">StandupMD::Cli</span>
235
+ <span class="container">StandupMD::Config</span>
291
236
 
292
237
  <li class="method">
293
- <a href="TestHelper.html#method-i-standup">#standup</a>
238
+ <a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
294
239
  &mdash;
295
- <span class="container">TestHelper</span>
240
+ <span class="container">StandupMD::Config::Entry</span>
296
241
 
297
242
  <li class="method">
298
- <a href="StandupMD/Cli.html#method-i-standup">#standup</a>
243
+ <a href="StandupMD/Cli.html#method-c-new">::new</a>
299
244
  &mdash;
300
245
  <span class="container">StandupMD::Cli</span>
301
246
 
302
247
  <li class="method">
303
- <a href="StandupMD.html#method-i-sub_header_depth-3D">#sub_header_depth=</a>
248
+ <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
304
249
  &mdash;
305
- <span class="container">StandupMD</span>
250
+ <span class="container">StandupMD::Config::Cli</span>
306
251
 
307
252
  <li class="method">
308
- <a href="StandupMD.html#method-i-sub_header_order">#sub_header_order</a>
253
+ <a href="StandupMD/Entry.html#method-c-new">::new</a>
309
254
  &mdash;
310
- <span class="container">StandupMD</span>
255
+ <span class="container">StandupMD::Entry</span>
311
256
 
312
257
  <li class="method">
313
- <a href="StandupMD.html#method-i-sub_header_order-3D">#sub_header_order=</a>
258
+ <a href="StandupMD.html#method-c-reset_config">::reset_config</a>
314
259
  &mdash;
315
260
  <span class="container">StandupMD</span>
316
261
 
317
262
  <li class="method">
318
- <a href="TestStandupMD.html#method-i-teardown">#teardown</a>
319
- &mdash;
320
- <span class="container">TestStandupMD</span>
321
-
322
- <li class="method">
323
- <a href="TestCli.html#method-i-teardown">#teardown</a>
324
- &mdash;
325
- <span class="container">TestCli</span>
326
-
327
- <li class="method">
328
- <a href="TestCli.html#method-i-test_PREFERENCE_FILE">#test_PREFERENCE_FILE</a>
329
- &mdash;
330
- <span class="container">TestCli</span>
331
-
332
- <li class="method">
333
- <a href="TestStandupMD.html#method-i-test_VERSION">#test_VERSION</a>
334
- &mdash;
335
- <span class="container">TestStandupMD</span>
336
-
337
- <li class="method">
338
- <a href="TestStandupMD.html#method-i-test_all_previous_entries">#test_all_previous_entries</a>
339
- &mdash;
340
- <span class="container">TestStandupMD</span>
341
-
342
- <li class="method">
343
- <a href="TestCli.html#method-i-test_append_previous-3F">#test_append_previous?</a>
344
- &mdash;
345
- <span class="container">TestCli</span>
346
-
347
- <li class="method">
348
- <a href="TestStandupMD.html#method-i-test_bullet_character">#test_bullet_character</a>
349
- &mdash;
350
- <span class="container">TestStandupMD</span>
351
-
352
- <li class="method">
353
- <a href="TestStandupMD.html#method-i-test_class_load">#test_class_load</a>
354
- &mdash;
355
- <span class="container">TestStandupMD</span>
356
-
357
- <li class="method">
358
- <a href="TestStandupMD.html#method-i-test_current_entry">#test_current_entry</a>
359
- &mdash;
360
- <span class="container">TestStandupMD</span>
361
-
362
- <li class="method">
363
- <a href="TestStandupMD.html#method-i-test_current_entry_tasks">#test_current_entry_tasks</a>
364
- &mdash;
365
- <span class="container">TestStandupMD</span>
366
-
367
- <li class="method">
368
- <a href="TestStandupMD.html#method-i-test_current_header">#test_current_header</a>
369
- &mdash;
370
- <span class="container">TestStandupMD</span>
371
-
372
- <li class="method">
373
- <a href="TestStandupMD.html#method-i-test_directory">#test_directory</a>
374
- &mdash;
375
- <span class="container">TestStandupMD</span>
376
-
377
- <li class="method">
378
- <a href="TestCli.html#method-i-test_edit-3F">#test_edit?</a>
263
+ <a href="StandupMD/EntryList.html#method-i-3C-3C">#&lt;&lt;</a>
379
264
  &mdash;
380
- <span class="container">TestCli</span>
265
+ <span class="container">StandupMD::EntryList</span>
381
266
 
382
267
  <li class="method">
383
- <a href="TestCli.html#method-i-test_editor">#test_editor</a>
268
+ <a href="StandupMD/Entry.html#method-i-3C-3D-3E">#&lt;=&gt;</a>
384
269
  &mdash;
385
- <span class="container">TestCli</span>
270
+ <span class="container">StandupMD::Entry</span>
386
271
 
387
272
  <li class="method">
388
- <a href="TestStandupMD.html#method-i-test_entry_previously_added-3F">#test_entry_previously_added?</a>
273
+ <a href="StandupMD/Config/File.html#method-i-bullet_character-3D">#bullet_character=</a>
389
274
  &mdash;
390
- <span class="container">TestStandupMD</span>
275
+ <span class="container">StandupMD::Config::File</span>
391
276
 
392
277
  <li class="method">
393
- <a href="TestStandupMD.html#method-i-test_file">#test_file</a>
278
+ <a href="StandupMD/Config/File.html#method-i-directory-3D">#directory=</a>
394
279
  &mdash;
395
- <span class="container">TestStandupMD</span>
280
+ <span class="container">StandupMD::Config::File</span>
396
281
 
397
282
  <li class="method">
398
- <a href="TestStandupMD.html#method-i-test_file_name_format">#test_file_name_format</a>
283
+ <a href="StandupMD/EntryList.html#method-i-each">#each</a>
399
284
  &mdash;
400
- <span class="container">TestStandupMD</span>
285
+ <span class="container">StandupMD::EntryList</span>
401
286
 
402
287
  <li class="method">
403
- <a href="TestStandupMD.html#method-i-test_file_written-3F">#test_file_written?</a>
288
+ <a href="StandupMD/Cli.html#method-i-echo">#echo</a>
404
289
  &mdash;
405
- <span class="container">TestStandupMD</span>
290
+ <span class="container">StandupMD::Cli</span>
406
291
 
407
292
  <li class="method">
408
- <a href="TestStandupMD.html#method-i-test_header_date_format">#test_header_date_format</a>
293
+ <a href="StandupMD/Cli.html#method-i-edit">#edit</a>
409
294
  &mdash;
410
- <span class="container">TestStandupMD</span>
295
+ <span class="container">StandupMD::Cli</span>
411
296
 
412
297
  <li class="method">
413
- <a href="TestStandupMD.html#method-i-test_header_depth">#test_header_depth</a>
298
+ <a href="StandupMD/EntryList.html#method-i-empty-3F">#empty?</a>
414
299
  &mdash;
415
- <span class="container">TestStandupMD</span>
300
+ <span class="container">StandupMD::EntryList</span>
416
301
 
417
302
  <li class="method">
418
- <a href="TestStandupMD.html#method-i-test_impediments">#test_impediments</a>
303
+ <a href="StandupMD/File.html#method-i-exist-3F">#exist?</a>
419
304
  &mdash;
420
- <span class="container">TestStandupMD</span>
305
+ <span class="container">StandupMD::File</span>
421
306
 
422
307
  <li class="method">
423
- <a href="TestStandupMD.html#method-i-test_impediments_header">#test_impediments_header</a>
308
+ <a href="StandupMD/EntryList.html#method-i-filter">#filter</a>
424
309
  &mdash;
425
- <span class="container">TestStandupMD</span>
310
+ <span class="container">StandupMD::EntryList</span>
426
311
 
427
312
  <li class="method">
428
- <a href="TestCli.html#method-i-test_initialize">#test_initialize</a>
313
+ <a href="StandupMD/EntryList.html#method-i-filter-21">#filter!</a>
429
314
  &mdash;
430
- <span class="container">TestCli</span>
315
+ <span class="container">StandupMD::EntryList</span>
431
316
 
432
317
  <li class="method">
433
- <a href="TestCli.html#method-i-test_json-3F">#test_json?</a>
318
+ <a href="StandupMD/EntryList.html#method-i-find">#find</a>
434
319
  &mdash;
435
- <span class="container">TestCli</span>
320
+ <span class="container">StandupMD::EntryList</span>
436
321
 
437
322
  <li class="method">
438
- <a href="TestStandupMD.html#method-i-test_load">#test_load</a>
323
+ <a href="StandupMD/EntryList.html#method-i-first">#first</a>
439
324
  &mdash;
440
- <span class="container">TestStandupMD</span>
325
+ <span class="container">StandupMD::EntryList</span>
441
326
 
442
327
  <li class="method">
443
- <a href="TestStandupMD.html#method-i-test_notes">#test_notes</a>
328
+ <a href="StandupMD/Config/File.html#method-i-header_depth-3D">#header_depth=</a>
444
329
  &mdash;
445
- <span class="container">TestStandupMD</span>
330
+ <span class="container">StandupMD::Config::File</span>
446
331
 
447
332
  <li class="method">
448
- <a href="TestStandupMD.html#method-i-test_notes_header">#test_notes_header</a>
333
+ <a href="StandupMD/Config/EntryList.html#method-i-initalize">#initalize</a>
449
334
  &mdash;
450
- <span class="container">TestStandupMD</span>
335
+ <span class="container">StandupMD::Config::EntryList</span>
451
336
 
452
337
  <li class="method">
453
- <a href="TestCli.html#method-i-test_options">#test_options</a>
338
+ <a href="StandupMD/EntryList.html#method-i-last">#last</a>
454
339
  &mdash;
455
- <span class="container">TestCli</span>
340
+ <span class="container">StandupMD::EntryList</span>
456
341
 
457
342
  <li class="method">
458
- <a href="TestCli.html#method-i-test_preferences">#test_preferences</a>
343
+ <a href="StandupMD/File.html#method-i-load">#load</a>
459
344
  &mdash;
460
- <span class="container">TestCli</span>
345
+ <span class="container">StandupMD::File</span>
461
346
 
462
347
  <li class="method">
463
- <a href="TestStandupMD.html#method-i-test_previous_entry_tasks">#test_previous_entry_tasks</a>
348
+ <a href="StandupMD/Cli.html#method-i-load_preferences">#load_preferences</a>
464
349
  &mdash;
465
- <span class="container">TestStandupMD</span>
350
+ <span class="container">StandupMD::Cli</span>
466
351
 
467
352
  <li class="method">
468
- <a href="TestStandupMD.html#method-i-test_previous_file_when_current_and_previous_month_do_not_exist">#test_previous_file_when_current_and_previous_month_do_not_exist</a>
353
+ <a href="StandupMD/File.html#method-i-loaded-3F">#loaded?</a>
469
354
  &mdash;
470
- <span class="container">TestStandupMD</span>
355
+ <span class="container">StandupMD::File</span>
471
356
 
472
357
  <li class="method">
473
- <a href="TestStandupMD.html#method-i-test_previous_file_when_current_month_file_does_not_exist_but_previous_does">#test_previous_file_when_current_month_file_does_not_exist_but_previous_does</a>
358
+ <a href="StandupMD/File.html#method-i-new-3F">#new?</a>
474
359
  &mdash;
475
- <span class="container">TestStandupMD</span>
360
+ <span class="container">StandupMD::File</span>
476
361
 
477
362
  <li class="method">
478
- <a href="TestStandupMD.html#method-i-test_previous_file_when_entry_exists_for_today">#test_previous_file_when_entry_exists_for_today</a>
363
+ <a href="StandupMD/Cli.html#method-i-preference_file_loaded-3F">#preference_file_loaded?</a>
479
364
  &mdash;
480
- <span class="container">TestStandupMD</span>
365
+ <span class="container">StandupMD::Cli</span>
481
366
 
482
367
  <li class="method">
483
- <a href="TestStandupMD.html#method-i-test_previous_header">#test_previous_header</a>
368
+ <a href="StandupMD/Cli/Helpers.html#method-i-print">#print</a>
484
369
  &mdash;
485
- <span class="container">TestStandupMD</span>
370
+ <span class="container">StandupMD::Cli::Helpers</span>
486
371
 
487
372
  <li class="method">
488
- <a href="TestCli.html#method-i-test_print_all_entries-3F">#test_print_all_entries?</a>
373
+ <a href="StandupMD/Config/File.html#method-i-reset_values">#reset_values</a>
489
374
  &mdash;
490
- <span class="container">TestCli</span>
375
+ <span class="container">StandupMD::Config::File</span>
491
376
 
492
377
  <li class="method">
493
- <a href="TestCli.html#method-i-test_print_current_entry-3F">#test_print_current_entry?</a>
378
+ <a href="StandupMD/Config/Cli.html#method-i-reset_values">#reset_values</a>
494
379
  &mdash;
495
- <span class="container">TestCli</span>
380
+ <span class="container">StandupMD::Config::Cli</span>
496
381
 
497
382
  <li class="method">
498
- <a href="TestStandupMD.html#method-i-test_reload">#test_reload</a>
383
+ <a href="StandupMD/Config/Entry.html#method-i-reset_values">#reset_values</a>
499
384
  &mdash;
500
- <span class="container">TestStandupMD</span>
385
+ <span class="container">StandupMD::Config::Entry</span>
501
386
 
502
387
  <li class="method">
503
- <a href="TestCli.html#method-i-test_self_execute">#test_self_execute</a>
388
+ <a href="StandupMD/Config/EntryList.html#method-i-reset_values">#reset_values</a>
504
389
  &mdash;
505
- <span class="container">TestCli</span>
390
+ <span class="container">StandupMD::Config::EntryList</span>
506
391
 
507
392
  <li class="method">
508
- <a href="TestStandupMD.html#method-i-test_setting_attributes_via_block">#test_setting_attributes_via_block</a>
393
+ <a href="StandupMD/EntryList.html#method-i-size">#size</a>
509
394
  &mdash;
510
- <span class="container">TestStandupMD</span>
395
+ <span class="container">StandupMD::EntryList</span>
511
396
 
512
397
  <li class="method">
513
- <a href="TestCli.html#method-i-test_standup">#test_standup</a>
398
+ <a href="StandupMD/EntryList.html#method-i-sort">#sort</a>
514
399
  &mdash;
515
- <span class="container">TestCli</span>
400
+ <span class="container">StandupMD::EntryList</span>
516
401
 
517
402
  <li class="method">
518
- <a href="TestStandupMD.html#method-i-test_sub_header_depth">#test_sub_header_depth</a>
403
+ <a href="StandupMD/EntryList.html#method-i-sort-21">#sort!</a>
519
404
  &mdash;
520
- <span class="container">TestStandupMD</span>
405
+ <span class="container">StandupMD::EntryList</span>
521
406
 
522
407
  <li class="method">
523
- <a href="TestStandupMD.html#method-i-test_sub_header_order">#test_sub_header_order</a>
408
+ <a href="StandupMD/EntryList.html#method-i-sort_reverse">#sort_reverse</a>
524
409
  &mdash;
525
- <span class="container">TestStandupMD</span>
410
+ <span class="container">StandupMD::EntryList</span>
526
411
 
527
412
  <li class="method">
528
- <a href="TestCli.html#method-i-test_verbose-3F">#test_verbose?</a>
413
+ <a href="StandupMD/Config/File.html#method-i-sub_header_depth-3D">#sub_header_depth=</a>
529
414
  &mdash;
530
- <span class="container">TestCli</span>
415
+ <span class="container">StandupMD::Config::File</span>
531
416
 
532
417
  <li class="method">
533
- <a href="TestStandupMD.html#method-i-test_write">#test_write</a>
418
+ <a href="StandupMD/EntryList.html#method-i-to_h">#to_h</a>
534
419
  &mdash;
535
- <span class="container">TestStandupMD</span>
420
+ <span class="container">StandupMD::EntryList</span>
536
421
 
537
422
  <li class="method">
538
- <a href="TestCli.html#method-i-test_write-3F">#test_write?</a>
423
+ <a href="StandupMD/Entry.html#method-i-to_h">#to_h</a>
539
424
  &mdash;
540
- <span class="container">TestCli</span>
425
+ <span class="container">StandupMD::Entry</span>
541
426
 
542
427
  <li class="method">
543
- <a href="StandupMD/Cli.html#method-i-verbose-3F">#verbose?</a>
428
+ <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
544
429
  &mdash;
545
- <span class="container">StandupMD::Cli</span>
430
+ <span class="container">StandupMD::EntryList</span>
546
431
 
547
432
  <li class="method">
548
- <a href="StandupMD.html#method-i-write">#write</a>
433
+ <a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
549
434
  &mdash;
550
- <span class="container">StandupMD</span>
435
+ <span class="container">StandupMD::Entry</span>
551
436
 
552
437
  <li class="method">
553
- <a href="StandupMD/Cli.html#method-i-write-3F">#write?</a>
438
+ <a href="StandupMD/File.html#method-i-write">#write</a>
554
439
  &mdash;
555
- <span class="container">StandupMD::Cli</span>
440
+ <span class="container">StandupMD::File</span>
556
441
 
557
442
  <li class="method">
558
443
  <a href="StandupMD/Cli.html#method-i-write_file">#write_file</a>