standup_md 0.2.0 → 0.3.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/Gemfile.lock +7 -1
  4. data/README.md +149 -119
  5. data/bin/standup +1 -1
  6. data/doc/README_md.html +158 -101
  7. data/doc/StandupMD.html +96 -1326
  8. data/doc/StandupMD/Cli.html +124 -479
  9. data/doc/StandupMD/Cli/Helpers.html +167 -0
  10. data/doc/StandupMD/Config.html +230 -0
  11. data/doc/StandupMD/Config/Cli.html +364 -0
  12. data/doc/StandupMD/Config/Entry.html +296 -0
  13. data/doc/StandupMD/Config/EntryList.html +212 -0
  14. data/doc/StandupMD/Config/File.html +613 -0
  15. data/doc/StandupMD/Entry.html +478 -0
  16. data/doc/StandupMD/EntryList.html +759 -0
  17. data/doc/StandupMD/File.html +614 -0
  18. data/doc/created.rid +15 -5
  19. data/doc/index.html +168 -99
  20. data/doc/js/search_index.js +1 -1
  21. data/doc/js/search_index.js.gz +0 -0
  22. data/doc/table_of_contents.html +226 -72
  23. data/lib/standup_md.rb +28 -546
  24. data/lib/standup_md/cli.rb +63 -246
  25. data/lib/standup_md/cli/helpers.rb +165 -0
  26. data/lib/standup_md/config.rb +47 -0
  27. data/lib/standup_md/config/cli.rb +109 -0
  28. data/lib/standup_md/config/entry.rb +68 -0
  29. data/lib/standup_md/config/entry_list.rb +31 -0
  30. data/lib/standup_md/config/file.rb +209 -0
  31. data/lib/standup_md/entry.rb +122 -0
  32. data/lib/standup_md/entry_list.rb +166 -0
  33. data/lib/standup_md/file.rb +183 -0
  34. data/lib/standup_md/file/helpers.rb +62 -0
  35. data/lib/standup_md/version.rb +5 -5
  36. data/standup_md.gemspec +1 -0
  37. metadata +35 -2
data/doc/created.rid CHANGED
@@ -1,5 +1,15 @@
1
- Sat, 02 May 2020 12:37:06 -0500
2
- README.md Sat, 02 May 2020 11:32:07 -0500
3
- lib/standup_md.rb Sat, 02 May 2020 12:26:15 -0500
4
- lib/standup_md/cli.rb Fri, 01 May 2020 23:28:15 -0500
5
- lib/standup_md/version.rb Fri, 01 May 2020 08:57:49 -0500
1
+ Sun, 14 Jun 2020 22:02:40 -0500
2
+ README.md Sun, 14 Jun 2020 22:02:07 -0500
3
+ lib/standup_md.rb Sun, 14 Jun 2020 22:01:32 -0500
4
+ lib/standup_md/cli.rb Sun, 14 Jun 2020 22:01:32 -0500
5
+ lib/standup_md/cli/helpers.rb Sun, 14 Jun 2020 22:01:32 -0500
6
+ lib/standup_md/config.rb Sun, 14 Jun 2020 22:01:32 -0500
7
+ lib/standup_md/config/cli.rb Sun, 14 Jun 2020 22:01:32 -0500
8
+ lib/standup_md/config/entry.rb Sun, 14 Jun 2020 22:01:32 -0500
9
+ lib/standup_md/config/entry_list.rb Sun, 14 Jun 2020 22:01:32 -0500
10
+ lib/standup_md/config/file.rb Sun, 14 Jun 2020 22:01:32 -0500
11
+ lib/standup_md/entry.rb Sun, 14 Jun 2020 22:01:32 -0500
12
+ lib/standup_md/entry_list.rb Sun, 14 Jun 2020 22:01:32 -0500
13
+ lib/standup_md/file.rb Sun, 14 Jun 2020 22:01:32 -0500
14
+ lib/standup_md/file/helpers.rb Sun, 14 Jun 2020 22:01:32 -0500
15
+ lib/standup_md/version.rb Sun, 14 Jun 2020 22:01:32 -0500
data/doc/index.html CHANGED
@@ -76,6 +76,24 @@
76
76
 
77
77
  <li><a href="./StandupMD/Cli.html">StandupMD::Cli</a>
78
78
 
79
+ <li><a href="./StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
80
+
81
+ <li><a href="./StandupMD/Config.html">StandupMD::Config</a>
82
+
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>
96
+
79
97
  </ul>
80
98
  </div>
81
99
 
@@ -87,6 +105,8 @@
87
105
 
88
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>
89
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
+
90
110
  <blockquote>
91
111
  <p>The cure for all your standup woes.</p>
92
112
  </blockquote>
@@ -107,15 +127,29 @@
107
127
  </li><li>
108
128
  <p><a href="#usage">Usage</a></p>
109
129
  </li><li>
110
- <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>
111
141
  </li><li>
112
142
  <p><a href="#customization-and-runtime-options">Customization and Runtime Options</a></p>
113
143
  </li><li>
114
144
  <p><a href="#using-existing-standup-files">Using existing standup files</a></p>
145
+ </li></ul>
115
146
  </li><li>
116
147
  <p><a href="#api">API</a></p>
148
+ <ul><li>
149
+ <p><a href="#api-examples">API Examples</a></p>
117
150
  </li><li>
118
151
  <p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
152
+ </li></ul>
119
153
  </li><li>
120
154
  <p><a href="#reporting-bugs-and-requesting-features">Reporting Bugs and Requesting Features</a></p>
121
155
  </li><li>
@@ -124,11 +158,9 @@
124
158
 
125
159
  <h2 id="label-About">About<span><a href="#label-About">&para;</a> <a href="#top">&uarr;</a></span></h2>
126
160
 
127
- <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>
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>
128
162
 
129
- <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>
130
-
131
- <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>
132
164
 
133
165
  <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
134
166
 
@@ -139,32 +171,35 @@
139
171
  <pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">standup_md</span>
140
172
  </pre>
141
173
 
142
- <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>
143
178
 
144
179
  <h3 id="label-Manual+Installation">Manual Installation<span><a href="#label-Manual+Installation">&para;</a> <a href="#top">&uarr;</a></span></h3>
145
180
 
146
- <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>
147
182
 
148
183
  <pre>git clone https://github.com/evanthegrayt/standup_md.git
149
184
  cd standup_md
150
185
 
151
186
  # Use rake to build and install the gem.
152
- rake install
153
-
154
- # OR manually link the executable somewhere. If you use this method, you cannot
155
- # move the repository after you link it!
156
- ln -s $PWD/bin/standup /usr/local/bin/standup</pre>
187
+ rake install</pre>
157
188
 
158
189
  <h2 id="label-Usage">Usage<span><a href="#label-Usage">&para;</a> <a href="#top">&uarr;</a></span></h2>
159
190
 
160
- <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, simply call the executable.</p>
161
194
 
162
195
  <pre class="ruby"><span class="ruby-identifier">standup</span>
163
196
  </pre>
164
197
 
165
- <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>
199
+
200
+ <h3 id="label-CLI+Examples">CLI Examples<span><a href="#label-CLI+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
166
201
 
167
- <h3 id="label-Example">Example<span><a href="#label-Example">&para;</a> <a href="#top">&uarr;</a></span></h3>
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>
168
203
 
169
204
  <p>For example, if the standup entry from yesterday reads as follows:</p>
170
205
 
@@ -177,72 +212,103 @@ ln -s $PWD/bin/standup /usr/local/bin/standup
177
212
  ## Impediments
178
213
  - None</pre>
179
214
 
180
- <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>
181
227
 
182
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>
183
229
 
184
- <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>
185
231
  </pre>
186
232
 
187
- <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;</pre>
188
238
 
189
- <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>
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>
242
+
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>
190
248
 
191
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>
192
250
 
193
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>
194
252
 
195
- <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>
196
-
197
- <pre># Key: Default
198
- header_depth: 1
199
- header_date_format: &#39;%Y-%m-%d&#39;
200
- sub_header_depth: 2
201
- current_header: &#39;Current&#39;
202
- previous_header: &#39;Previous&#39;
203
- impediments_header: &#39;Impediments&#39;
204
- file_name_format: &#39;%Y_%m.md&#39;
205
- bullet_character: &#39;-&#39; # (dash)
206
- directory: &#39;~/.cache/standup_md&#39;
207
- editor: # $VISUAL, $EDITOR or vim, in that order
208
- current_entry_tasks:
209
- - &quot;&lt;!-- ADD TODAY&#39;S WORK HERE --&gt;&quot;
210
- previous_entry_tasks: # An array of the tasks from the previous entry
211
- impediments:
212
- - &#39;None&#39;
213
- notes: null # If not null, must be array
214
- sub_header_order:
215
- - &#39;previous&#39;
216
- - &#39;current&#39;
217
- - &#39;impediments&#39;
218
- - &#39;notes&#39;</pre>
219
-
220
- <h3 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">&para;</a> <a href="#top">&uarr;</a></span></h3>
221
-
222
- <pre>The Standup Doctor
223
- --current-entry-tasks=ARRAY List of current entry&#39;s tasks
224
- --previous-entry-tasks=ARRAY List of yesterday&#39;s tasks
225
- --impediments=ARRAY List of impediments for current entry
226
- --notes=ARRAY List of notes for current entry
227
- --sub-header-order=ARRAY The order of the sub-headers when writing the file
228
- --[no-]append-previous Append previous tasks? Default is true
229
- -f, --file-name-format=STRING Date-formattable string to use for standup file name
230
- -e, --editor=EDITOR Editor to use for opening standup files
231
- -d, --directory=DIRECTORY The directories where standup files are located
232
- --[no-]write Write current entry if it doesn&#39;t exist. Default is true
233
- --[no-]edit Open the file in the editor. Default is true
234
- -j, --[no-]json Print output as formatted json. Default is false.
235
- -v, --[no-]verbose Verbose output. Default is false.
236
- -c, --current Print current entry. Disables editing
237
- -a, --all Print all previous entries. Disables editing</pre>
238
-
239
- <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>
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>
240
290
 
241
- <p>If you wanted to add some tasks at runtime, and without opening the file in an editor, you could use the following:</p>
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
- <pre>standup --no-edit --current-entry-tasks=&quot;Work on this thing&quot;,&quot;And another thing!&quot;</pre>
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
- <h3 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></h3>
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
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>
248
314
 
@@ -256,61 +322,64 @@ sub_header_order:
256
322
  ## Notes
257
323
  - notes, if any are present</pre>
258
324
 
259
- <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>~/.standup_md.yml</code> before execution, or else the parser will error.</p>
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>
260
326
 
261
327
  <p>For example, if you wanted the format to be as follows:</p>
262
328
 
263
329
  <pre>## 05/01/2020
264
330
  ### Today
265
- - task
331
+ * task
266
332
  ### Yesterday
267
- - task
333
+ * task
268
334
  ### Hold-ups
269
- - impediment
335
+ * impediment
270
336
  ### Notes
271
- - notes, if any are present</pre>
272
-
273
- <p>Your <code>~/.standup_md.yml</code> should contain:</p>
274
-
275
- <pre>sub_header_depth: 3
276
- header_depth: 2
277
- current_header: Today
278
- previous_header: Yesterday
279
- impediments_header: Hold-ups
280
- header_date_format: &#39;%m/%d/%Y&#39;
281
- sub_header_order:
282
- - current
283
- - previous
284
- - impediments
285
- - notes</pre>
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-string">&#39;Today&#39;</span>
345
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span> = <span class="ruby-string">&#39;Yesterday&#39;</span>
346
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span> = <span class="ruby-string">&#39;Hold-ups&#39;</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>
286
352
 
287
353
  <h2 id="label-API">API<span><a href="#label-API">&para;</a> <a href="#top">&uarr;</a></span></h2>
288
354
 
289
- <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">RDoc Documentation</a>.</p>
290
356
 
291
- <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. A quick 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>
292
360
 
293
361
  <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
294
362
 
295
- <span class="ruby-identifier">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
296
- <span class="ruby-identifier">s</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">&#39;Today&#39;</span>,
297
- <span class="ruby-identifier">s</span>.<span class="ruby-identifier">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>],
298
- <span class="ruby-identifier">s</span>.<span class="ruby-identifier">impediments</span> = [<span class="ruby-string">&#39;Not enough time in the day&#39;</span>]
363
+ <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>
364
+ <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>,
299
365
  <span class="ruby-keyword">end</span>
300
366
 
301
- <span class="ruby-identifier">standup</span>.<span class="ruby-identifier">write</span>
367
+ <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>)
368
+ <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>] }
369
+ <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>
370
+ <span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>
302
371
  </pre>
303
372
 
304
- <p>Note: <code>StandupMD::load() { ... }</code> just is a quick way to call <code>StandupMD::new { ... }.load</code>.</p>
305
-
306
- <p>Entries are just hashes, so you can easily transform them to <code>json</code> objects.</p>
373
+ <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>
307
374
 
308
375
  <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
309
- <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;json&#39;</span>
310
376
 
311
- <span class="ruby-identifier">standup</span> = <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span>
377
+ <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>
378
+ <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>,
379
+ <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>]
380
+ <span class="ruby-keyword">end</span>
312
381
 
313
- <span class="ruby-identifier">standup_json</span> = <span class="ruby-identifier">standup</span>.<span class="ruby-identifier">all_entries</span>.<span class="ruby-identifier">to_json</span>
382
+ <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>
314
383
  </pre>
315
384
 
316
385
  <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/search_index.js CHANGED
@@ -1 +1 @@
1
- var search_data = {"index":{"searchIndex":["standupmd","cli","append_previous?()","append_to_previous_entry_tasks()","bullet_character=()","config_file=()","config_file_loaded?()","current_entry_tasks=()","directory=()","echo()","edit()","edit?()","editor()","entry_previously_added?()","execute()","file_written?()","header_depth=()","impediments=()","json?()","load()","load()","load_config_file()","new()","new()","new_month?()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","should_append?()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","verbose?()","write()","write?()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli#append_previous?()","standupmd::cli#append_to_previous_entry_tasks()","standupmd#bullet_character=()","standupmd#config_file=()","standupmd#config_file_loaded?()","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?()","standupmd#header_depth=()","standupmd#impediments=()","standupmd::cli#json?()","standupmd::load()","standupmd#load()","standupmd#load_config_file()","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()","standupmd::cli#should_append?()","standupmd::cli#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","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"],["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"],["config_file=","StandupMD","StandupMD.html#method-i-config_file-3D","(config_file)","

Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-i-config_file_loaded-3F","()","

Has a config file been loaded?\n

@return [Boolean]\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"],["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-c-load","(config_file = nil)","

Convenience method for calling new + load. Accepts a YAML config file as an argument, and yields the …\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_config_file","StandupMD","StandupMD.html#method-i-load_config_file","()","

Loads the config file\n

@return [Hash] The config options\n"],["new","StandupMD","StandupMD.html#method-c-new","(config_file = nil)","

Constructor. Takes a path to a YAML configuration file as an argument. If passed, settings from the config …\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"],["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"],["standup","StandupMD::Cli","StandupMD/Cli.html#method-i-standup","()","

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

@return [StandupMD]\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"],["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()","load_config_file()","load_preferences()","loaded?()","new()","new()","new()","new()","new()","new()","new()","new()","new?()","preference_file_loaded?()","print()","reset()","reset()","reset()","reset()","reset_config()","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::file#load()","standupmd::load_config_file()","standupmd::cli#load_preferences()","standupmd::file#loaded?()","standupmd::cli::new()","standupmd::config::new()","standupmd::config::cli::new()","standupmd::config::entry::new()","standupmd::config::file::new()","standupmd::entry::new()","standupmd::entrylist::new()","standupmd::file::new()","standupmd::file#new?()","standupmd::cli#preference_file_loaded?()","standupmd::cli::helpers#print()","standupmd::config::cli#reset()","standupmd::config::entry#reset()","standupmd::config::entrylist#reset()","standupmd::config::file#reset()","standupmd::reset_config()","standupmd::entrylist#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 main module for the gem. Provides access to configuration classes.\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","()","

Method for accessing the configuration.\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-c-load","(file_name)","

Convenience method for calling File.find(file_name).load\n

@param [String] file_name\n

@return [StandupMD::File] …\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","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset","()","

Sets all config values back to their defaults.\n

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

Sets all config values back to their defaults.\n

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

Sets all config values back to their defaults.\n

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

Sets all config values back to their defaults.\n

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

Reset all configuration values to their defaults.\n

@return [StandupMD::Config]\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/table_of_contents.html CHANGED
@@ -51,11 +51,21 @@
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
 
@@ -63,6 +73,8 @@
63
73
 
64
74
  <li><a href="README_md.html#label-API">API</a>
65
75
 
76
+ <li><a href="README_md.html#label-API+Examples">API Examples</a>
77
+
66
78
  <li><a href="README_md.html#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
67
79
 
68
80
  <li><a href="README_md.html#label-Self-Promotion">Self-Promotion</a>
@@ -77,21 +89,58 @@
77
89
  <h2 id="classes">Classes and Modules</h2>
78
90
  <ul>
79
91
 
80
- <li class="class">
92
+ <li class="module">
81
93
  <a href="StandupMD.html">StandupMD</a>
82
94
 
83
- <ul>
95
+ </li>
84
96
 
85
- <li><a href="StandupMD.html#5Buntitled-5D">Top Section</a>
97
+ <li class="class">
98
+ <a href="StandupMD/Cli.html">StandupMD::Cli</a>
86
99
 
87
- <li><a href="StandupMD.html#Attributes+with+default+getters+and+setters.">Attributes with default getters and setters.</a>
100
+ </li>
88
101
 
89
- </ul>
102
+ <li class="module">
103
+ <a href="StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
90
104
 
91
105
  </li>
92
106
 
93
107
  <li class="class">
94
- <a href="StandupMD/Cli.html">StandupMD::Cli</a>
108
+ <a href="StandupMD/Config.html">StandupMD::Config</a>
109
+
110
+ </li>
111
+
112
+ <li class="class">
113
+ <a href="StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
114
+
115
+ </li>
116
+
117
+ <li class="class">
118
+ <a href="StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
119
+
120
+ </li>
121
+
122
+ <li class="class">
123
+ <a href="StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
124
+
125
+ </li>
126
+
127
+ <li class="class">
128
+ <a href="StandupMD/Config/File.html">StandupMD::Config::File</a>
129
+
130
+ </li>
131
+
132
+ <li class="class">
133
+ <a href="StandupMD/Entry.html">StandupMD::Entry</a>
134
+
135
+ </li>
136
+
137
+ <li class="class">
138
+ <a href="StandupMD/EntryList.html">StandupMD::EntryList</a>
139
+
140
+ </li>
141
+
142
+ <li class="class">
143
+ <a href="StandupMD/File.html">StandupMD::File</a>
95
144
 
96
145
  </li>
97
146
 
@@ -101,60 +150,145 @@
101
150
  <ul>
102
151
 
103
152
  <li class="method">
104
- <a href="StandupMD/Cli.html#method-c-execute">::execute</a>
153
+ <a href="StandupMD/Cli.html#method-c-config">::config</a>
105
154
  &mdash;
106
155
  <span class="container">StandupMD::Cli</span>
107
156
 
108
157
  <li class="method">
109
- <a href="StandupMD.html#method-c-load">::load</a>
158
+ <a href="StandupMD/File.html#method-c-config">::config</a>
159
+ &mdash;
160
+ <span class="container">StandupMD::File</span>
161
+
162
+ <li class="method">
163
+ <a href="StandupMD/Entry.html#method-c-config">::config</a>
164
+ &mdash;
165
+ <span class="container">StandupMD::Entry</span>
166
+
167
+ <li class="method">
168
+ <a href="StandupMD/EntryList.html#method-c-config">::config</a>
169
+ &mdash;
170
+ <span class="container">StandupMD::EntryList</span>
171
+
172
+ <li class="method">
173
+ <a href="StandupMD.html#method-c-config">::config</a>
110
174
  &mdash;
111
175
  <span class="container">StandupMD</span>
112
176
 
113
177
  <li class="method">
114
- <a href="StandupMD.html#method-c-new">::new</a>
178
+ <a href="StandupMD.html#method-c-config_file_loaded-3F">::config_file_loaded?</a>
115
179
  &mdash;
116
180
  <span class="container">StandupMD</span>
117
181
 
118
182
  <li class="method">
119
- <a href="StandupMD/Cli.html#method-c-new">::new</a>
183
+ <a href="StandupMD.html#method-c-configure">::configure</a>
120
184
  &mdash;
121
- <span class="container">StandupMD::Cli</span>
185
+ <span class="container">StandupMD</span>
186
+
187
+ <li class="method">
188
+ <a href="StandupMD/Entry.html#method-c-create">::create</a>
189
+ &mdash;
190
+ <span class="container">StandupMD::Entry</span>
122
191
 
123
192
  <li class="method">
124
- <a href="StandupMD/Cli.html#method-i-append_previous-3F">#append_previous?</a>
193
+ <a href="StandupMD/Cli.html#method-c-echo">::echo</a>
125
194
  &mdash;
126
195
  <span class="container">StandupMD::Cli</span>
127
196
 
128
197
  <li class="method">
129
- <a href="StandupMD/Cli.html#method-i-append_to_previous_entry_tasks">#append_to_previous_entry_tasks</a>
198
+ <a href="StandupMD/Cli.html#method-c-execute">::execute</a>
130
199
  &mdash;
131
200
  <span class="container">StandupMD::Cli</span>
132
201
 
133
202
  <li class="method">
134
- <a href="StandupMD.html#method-i-bullet_character-3D">#bullet_character=</a>
203
+ <a href="StandupMD/File.html#method-c-find">::find</a>
135
204
  &mdash;
136
- <span class="container">StandupMD</span>
205
+ <span class="container">StandupMD::File</span>
137
206
 
138
207
  <li class="method">
139
- <a href="StandupMD.html#method-i-config_file-3D">#config_file=</a>
208
+ <a href="StandupMD/File.html#method-c-find_by_date">::find_by_date</a>
140
209
  &mdash;
141
- <span class="container">StandupMD</span>
210
+ <span class="container">StandupMD::File</span>
142
211
 
143
212
  <li class="method">
144
- <a href="StandupMD.html#method-i-config_file_loaded-3F">#config_file_loaded?</a>
213
+ <a href="StandupMD/File.html#method-c-load">::load</a>
145
214
  &mdash;
146
- <span class="container">StandupMD</span>
215
+ <span class="container">StandupMD::File</span>
147
216
 
148
217
  <li class="method">
149
- <a href="StandupMD.html#method-i-current_entry_tasks-3D">#current_entry_tasks=</a>
218
+ <a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
150
219
  &mdash;
151
220
  <span class="container">StandupMD</span>
152
221
 
153
222
  <li class="method">
154
- <a href="StandupMD.html#method-i-directory-3D">#directory=</a>
223
+ <a href="StandupMD/Config/File.html#method-c-new">::new</a>
224
+ &mdash;
225
+ <span class="container">StandupMD::Config::File</span>
226
+
227
+ <li class="method">
228
+ <a href="StandupMD/Cli.html#method-c-new">::new</a>
229
+ &mdash;
230
+ <span class="container">StandupMD::Cli</span>
231
+
232
+ <li class="method">
233
+ <a href="StandupMD/Config.html#method-c-new">::new</a>
234
+ &mdash;
235
+ <span class="container">StandupMD::Config</span>
236
+
237
+ <li class="method">
238
+ <a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
239
+ &mdash;
240
+ <span class="container">StandupMD::Config::Cli</span>
241
+
242
+ <li class="method">
243
+ <a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
244
+ &mdash;
245
+ <span class="container">StandupMD::Config::Entry</span>
246
+
247
+ <li class="method">
248
+ <a href="StandupMD/File.html#method-c-new">::new</a>
249
+ &mdash;
250
+ <span class="container">StandupMD::File</span>
251
+
252
+ <li class="method">
253
+ <a href="StandupMD/Entry.html#method-c-new">::new</a>
254
+ &mdash;
255
+ <span class="container">StandupMD::Entry</span>
256
+
257
+ <li class="method">
258
+ <a href="StandupMD/EntryList.html#method-c-new">::new</a>
259
+ &mdash;
260
+ <span class="container">StandupMD::EntryList</span>
261
+
262
+ <li class="method">
263
+ <a href="StandupMD.html#method-c-reset_config">::reset_config</a>
155
264
  &mdash;
156
265
  <span class="container">StandupMD</span>
157
266
 
267
+ <li class="method">
268
+ <a href="StandupMD/EntryList.html#method-i-3C-3C">#&lt;&lt;</a>
269
+ &mdash;
270
+ <span class="container">StandupMD::EntryList</span>
271
+
272
+ <li class="method">
273
+ <a href="StandupMD/Entry.html#method-i-3C-3D-3E">#&lt;=&gt;</a>
274
+ &mdash;
275
+ <span class="container">StandupMD::Entry</span>
276
+
277
+ <li class="method">
278
+ <a href="StandupMD/Config/File.html#method-i-bullet_character-3D">#bullet_character=</a>
279
+ &mdash;
280
+ <span class="container">StandupMD::Config::File</span>
281
+
282
+ <li class="method">
283
+ <a href="StandupMD/Config/File.html#method-i-directory-3D">#directory=</a>
284
+ &mdash;
285
+ <span class="container">StandupMD::Config::File</span>
286
+
287
+ <li class="method">
288
+ <a href="StandupMD/EntryList.html#method-i-each">#each</a>
289
+ &mdash;
290
+ <span class="container">StandupMD::EntryList</span>
291
+
158
292
  <li class="method">
159
293
  <a href="StandupMD/Cli.html#method-i-echo">#echo</a>
160
294
  &mdash;
@@ -166,129 +300,149 @@
166
300
  <span class="container">StandupMD::Cli</span>
167
301
 
168
302
  <li class="method">
169
- <a href="StandupMD/Cli.html#method-i-edit-3F">#edit?</a>
303
+ <a href="StandupMD/EntryList.html#method-i-empty-3F">#empty?</a>
170
304
  &mdash;
171
- <span class="container">StandupMD::Cli</span>
305
+ <span class="container">StandupMD::EntryList</span>
172
306
 
173
307
  <li class="method">
174
- <a href="StandupMD/Cli.html#method-i-editor">#editor</a>
308
+ <a href="StandupMD/File.html#method-i-exist-3F">#exist?</a>
175
309
  &mdash;
176
- <span class="container">StandupMD::Cli</span>
310
+ <span class="container">StandupMD::File</span>
177
311
 
178
312
  <li class="method">
179
- <a href="StandupMD.html#method-i-entry_previously_added-3F">#entry_previously_added?</a>
313
+ <a href="StandupMD/EntryList.html#method-i-filter">#filter</a>
180
314
  &mdash;
181
- <span class="container">StandupMD</span>
315
+ <span class="container">StandupMD::EntryList</span>
182
316
 
183
317
  <li class="method">
184
- <a href="StandupMD.html#method-i-file_written-3F">#file_written?</a>
318
+ <a href="StandupMD/EntryList.html#method-i-filter-21">#filter!</a>
185
319
  &mdash;
186
- <span class="container">StandupMD</span>
320
+ <span class="container">StandupMD::EntryList</span>
187
321
 
188
322
  <li class="method">
189
- <a href="StandupMD.html#method-i-header_depth-3D">#header_depth=</a>
323
+ <a href="StandupMD/EntryList.html#method-i-find">#find</a>
190
324
  &mdash;
191
- <span class="container">StandupMD</span>
325
+ <span class="container">StandupMD::EntryList</span>
192
326
 
193
327
  <li class="method">
194
- <a href="StandupMD.html#method-i-impediments-3D">#impediments=</a>
328
+ <a href="StandupMD/EntryList.html#method-i-first">#first</a>
195
329
  &mdash;
196
- <span class="container">StandupMD</span>
330
+ <span class="container">StandupMD::EntryList</span>
197
331
 
198
332
  <li class="method">
199
- <a href="StandupMD/Cli.html#method-i-json-3F">#json?</a>
333
+ <a href="StandupMD/Config/File.html#method-i-header_depth-3D">#header_depth=</a>
200
334
  &mdash;
201
- <span class="container">StandupMD::Cli</span>
335
+ <span class="container">StandupMD::Config::File</span>
202
336
 
203
337
  <li class="method">
204
- <a href="StandupMD.html#method-i-load">#load</a>
338
+ <a href="StandupMD/Config/EntryList.html#method-i-initalize">#initalize</a>
205
339
  &mdash;
206
- <span class="container">StandupMD</span>
340
+ <span class="container">StandupMD::Config::EntryList</span>
207
341
 
208
342
  <li class="method">
209
- <a href="StandupMD.html#method-i-load_config_file">#load_config_file</a>
343
+ <a href="StandupMD/EntryList.html#method-i-last">#last</a>
210
344
  &mdash;
211
- <span class="container">StandupMD</span>
345
+ <span class="container">StandupMD::EntryList</span>
212
346
 
213
347
  <li class="method">
214
- <a href="StandupMD.html#method-i-new_month-3F">#new_month?</a>
348
+ <a href="StandupMD/File.html#method-i-load">#load</a>
215
349
  &mdash;
216
- <span class="container">StandupMD</span>
350
+ <span class="container">StandupMD::File</span>
217
351
 
218
352
  <li class="method">
219
- <a href="StandupMD.html#method-i-notes-3D">#notes=</a>
353
+ <a href="StandupMD/Cli.html#method-i-load_preferences">#load_preferences</a>
220
354
  &mdash;
221
- <span class="container">StandupMD</span>
355
+ <span class="container">StandupMD::Cli</span>
222
356
 
223
357
  <li class="method">
224
- <a href="StandupMD.html#method-i-previous_entry_tasks-3D">#previous_entry_tasks=</a>
358
+ <a href="StandupMD/File.html#method-i-loaded-3F">#loaded?</a>
225
359
  &mdash;
226
- <span class="container">StandupMD</span>
360
+ <span class="container">StandupMD::File</span>
227
361
 
228
362
  <li class="method">
229
- <a href="StandupMD/Cli.html#method-i-print_all_entries">#print_all_entries</a>
363
+ <a href="StandupMD/File.html#method-i-new-3F">#new?</a>
230
364
  &mdash;
231
- <span class="container">StandupMD::Cli</span>
365
+ <span class="container">StandupMD::File</span>
232
366
 
233
367
  <li class="method">
234
- <a href="StandupMD/Cli.html#method-i-print_all_entries-3F">#print_all_entries?</a>
368
+ <a href="StandupMD/Cli.html#method-i-preference_file_loaded-3F">#preference_file_loaded?</a>
235
369
  &mdash;
236
370
  <span class="container">StandupMD::Cli</span>
237
371
 
238
372
  <li class="method">
239
- <a href="StandupMD/Cli.html#method-i-print_current_entry">#print_current_entry</a>
373
+ <a href="StandupMD/Cli/Helpers.html#method-i-print">#print</a>
240
374
  &mdash;
241
- <span class="container">StandupMD::Cli</span>
375
+ <span class="container">StandupMD::Cli::Helpers</span>
242
376
 
243
377
  <li class="method">
244
- <a href="StandupMD/Cli.html#method-i-print_current_entry-3F">#print_current_entry?</a>
378
+ <a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
245
379
  &mdash;
246
- <span class="container">StandupMD::Cli</span>
380
+ <span class="container">StandupMD::Config::EntryList</span>
247
381
 
248
382
  <li class="method">
249
- <a href="StandupMD.html#method-i-reload">#reload</a>
383
+ <a href="StandupMD/Config/Cli.html#method-i-reset">#reset</a>
250
384
  &mdash;
251
- <span class="container">StandupMD</span>
385
+ <span class="container">StandupMD::Config::Cli</span>
252
386
 
253
387
  <li class="method">
254
- <a href="StandupMD/Cli.html#method-i-should_append-3F">#should_append?</a>
388
+ <a href="StandupMD/Config/File.html#method-i-reset">#reset</a>
255
389
  &mdash;
256
- <span class="container">StandupMD::Cli</span>
390
+ <span class="container">StandupMD::Config::File</span>
257
391
 
258
392
  <li class="method">
259
- <a href="StandupMD/Cli.html#method-i-standup">#standup</a>
393
+ <a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
260
394
  &mdash;
261
- <span class="container">StandupMD::Cli</span>
395
+ <span class="container">StandupMD::Config::Entry</span>
262
396
 
263
397
  <li class="method">
264
- <a href="StandupMD.html#method-i-sub_header_depth-3D">#sub_header_depth=</a>
398
+ <a href="StandupMD/EntryList.html#method-i-size">#size</a>
265
399
  &mdash;
266
- <span class="container">StandupMD</span>
400
+ <span class="container">StandupMD::EntryList</span>
267
401
 
268
402
  <li class="method">
269
- <a href="StandupMD.html#method-i-sub_header_order">#sub_header_order</a>
403
+ <a href="StandupMD/EntryList.html#method-i-sort">#sort</a>
270
404
  &mdash;
271
- <span class="container">StandupMD</span>
405
+ <span class="container">StandupMD::EntryList</span>
272
406
 
273
407
  <li class="method">
274
- <a href="StandupMD.html#method-i-sub_header_order-3D">#sub_header_order=</a>
408
+ <a href="StandupMD/EntryList.html#method-i-sort-21">#sort!</a>
275
409
  &mdash;
276
- <span class="container">StandupMD</span>
410
+ <span class="container">StandupMD::EntryList</span>
277
411
 
278
412
  <li class="method">
279
- <a href="StandupMD/Cli.html#method-i-verbose-3F">#verbose?</a>
413
+ <a href="StandupMD/EntryList.html#method-i-sort_reverse">#sort_reverse</a>
280
414
  &mdash;
281
- <span class="container">StandupMD::Cli</span>
415
+ <span class="container">StandupMD::EntryList</span>
282
416
 
283
417
  <li class="method">
284
- <a href="StandupMD.html#method-i-write">#write</a>
418
+ <a href="StandupMD/Config/File.html#method-i-sub_header_depth-3D">#sub_header_depth=</a>
285
419
  &mdash;
286
- <span class="container">StandupMD</span>
420
+ <span class="container">StandupMD::Config::File</span>
287
421
 
288
422
  <li class="method">
289
- <a href="StandupMD/Cli.html#method-i-write-3F">#write?</a>
423
+ <a href="StandupMD/EntryList.html#method-i-to_h">#to_h</a>
290
424
  &mdash;
291
- <span class="container">StandupMD::Cli</span>
425
+ <span class="container">StandupMD::EntryList</span>
426
+
427
+ <li class="method">
428
+ <a href="StandupMD/Entry.html#method-i-to_h">#to_h</a>
429
+ &mdash;
430
+ <span class="container">StandupMD::Entry</span>
431
+
432
+ <li class="method">
433
+ <a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
434
+ &mdash;
435
+ <span class="container">StandupMD::EntryList</span>
436
+
437
+ <li class="method">
438
+ <a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
439
+ &mdash;
440
+ <span class="container">StandupMD::Entry</span>
441
+
442
+ <li class="method">
443
+ <a href="StandupMD/File.html#method-i-write">#write</a>
444
+ &mdash;
445
+ <span class="container">StandupMD::File</span>
292
446
 
293
447
  <li class="method">
294
448
  <a href="StandupMD/Cli.html#method-i-write_file">#write_file</a>