standup_md 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e3103350380332fa4f6151271cda67398fa0e3d66ad67da96a16e21b14a2ee60
4
- data.tar.gz: 0ebadf701e13e50fd382887d71cce15a364a971aea7079637868bc5906436824
3
+ metadata.gz: 5349ff6862de6991ec55e5437eb3249d75f519abc348d64737ae6936afe0f43a
4
+ data.tar.gz: b16587755a18c42caf3b8bafbc270398db506bf60ebc069bd3281a5cbd8251e5
5
5
  SHA512:
6
- metadata.gz: 89cdf249a2924a6349a332d2d192f75e68490fefd839ea90ab66fe0a2fe4ee0e260018aab2ab1b7a14e1c5b6f1a96c0bef1e573c8fe9fd712951dc8395f6f5d1
7
- data.tar.gz: 6e3c6d0cfc9221290230127bc9afe6c46600d13b10331c9cfd467f01409d7a49899a1a678a573fde62ac34bc857c93ebfe8ecc3180c1c17fc587f788679c3c13
6
+ metadata.gz: 4845700dde4c61e9c27252e8cf1f35cc1dd7896b3c2ee01e7f30818635d13f82ea5e59be0ebad9cf0f259c0c50b9344b197abd3774ed44a40e3df02843d75a6e
7
+ data.tar.gz: '085bfef81572e551cdee0cca0260b4b9c40102696e8924a40faa961118e93a69649c5f4a41e1614d7ab29f4f5c5cbacf0bdda7616aba7d73c1228461e4ff79ca'
data/Gemfile CHANGED
@@ -5,6 +5,3 @@ source "https://rubygems.org"
5
5
  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
6
6
 
7
7
  gemspec
8
-
9
- gem "rake"
10
- gem 'test-unit'
data/Gemfile.lock CHANGED
@@ -20,4 +20,4 @@ DEPENDENCIES
20
20
  test-unit
21
21
 
22
22
  BUNDLED WITH
23
- 1.17.2
23
+ 2.1.4
data/README.md CHANGED
@@ -1,9 +1,13 @@
1
- # [The Standup Doctor](https://evanthegrayt.github.io/standup_md/)
1
+ # The Standup Doctor
2
2
  > The cure for all your standup woes.
3
3
 
4
4
  A highly customizable and automated way to keep track of daily standups in
5
5
  markdown files.
6
6
 
7
+ View on: [Github](https://github.com/evanthegrayt/standup_md) |
8
+ [GitHub Pages](https://evanthegrayt.github.io/standup_md/) |
9
+ [RubyGems](https://rubygems.org/gems/standup_md)
10
+
7
11
  ## Table of Contents
8
12
  - [About](#about)
9
13
  - [Installation](#Installation)
@@ -32,17 +36,8 @@ In a nutshell, calling `standup` from the command line will open a standup file
32
36
  for the current month in your preferred editor. If an entry for today is already
33
37
  present, no text will be generated. If an entry for today doesn't exist, one
34
38
  will be generated, and if a previous entry exists, it will be added to today's
35
- entry as what your previous day's work. See [example](#example). There's also an
36
- API if you'd like to use this in your own code somehow.
37
-
38
- This is a new project, and I have a lot of [updates
39
- planned](https://github.com/evanthegrayt/standup_md/issues), but I won't push
40
- to `master` unless all
41
- [tests](https://github.com/evanthegrayt/standup_md/blob/master/test/standup_md_test.rb)
42
- are passing and the gem is working as expected. The first official release will
43
- be once [this milestone](https://github.com/evanthegrayt/standup_md/milestone/1)
44
- is complete. Until then, consider this gem to be in alpha, and the version will
45
- remain `< 0.1.0`.
39
+ entry as your previous day's work. See [example](#example). There's also an API
40
+ if you'd like to use this in your own code somehow.
46
41
 
47
42
  ## Installation
48
43
  ### Via RubyGems
@@ -53,7 +48,7 @@ gem install standup_md
53
48
  ```
54
49
 
55
50
  If you don't have permission on your system to install ruby or gems, I recommend
56
- using [rvm](https://rvm.io/) or
51
+ using
57
52
  [rbenv](http://www.rubyinside.com/rbenv-a-simple-new-ruby-version-management-tool-5302.html),
58
53
  or you can try the manual methods below.
59
54
 
data/bin/standup CHANGED
@@ -2,4 +2,4 @@
2
2
 
3
3
  require_relative '../lib/standup_md/cli'
4
4
 
5
- StandupMD::CLI.execute(ARGV)
5
+ StandupMD::Cli.execute(ARGV)
data/doc/README_md.html CHANGED
@@ -60,7 +60,7 @@
60
60
  <h3>Table of Contents</h3>
61
61
 
62
62
  <ul class="link-list" role="directory">
63
- <li><a href="#label-The+Standup+Doctor"><a href="https://evanthegrayt.github.io/standup_md/">The Standup Doctor</a></a>
63
+ <li><a href="#label-The+Standup+Doctor">The Standup Doctor</a>
64
64
  <li><a href="#label-Table+of+Contents">Table of Contents</a>
65
65
  <li><a href="#label-About">About</a>
66
66
  <li><a href="#label-Installation">Installation</a>
@@ -94,7 +94,7 @@
94
94
 
95
95
  <main role="main" aria-label="Page README.md">
96
96
 
97
- <h1 id="label-The+Standup+Doctor"><a href="https://evanthegrayt.github.io/standup_md/">The Standup Doctor</a><span><a href="#label-The+Standup+Doctor">&para;</a> <a href="#top">&uarr;</a></span></h1>
97
+ <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>
98
98
 
99
99
  <blockquote>
100
100
  <p>The cure for all your standup woes.</p>
@@ -102,6 +102,8 @@
102
102
 
103
103
  <p>A highly customizable and automated way to keep track of daily standups in markdown files.</p>
104
104
 
105
+ <p>View on: <a href="https://github.com/evanthegrayt/standup_md">Github</a> | <a href="https://evanthegrayt.github.io/standup_md/">GitHub Pages</a> | <a href="https://rubygems.org/gems/standup_md">RubyGems</a></p>
106
+
105
107
  <h2 id="label-Table+of+Contents">Table of Contents<span><a href="#label-Table+of+Contents">&para;</a> <a href="#top">&uarr;</a></span></h2>
106
108
  <ul><li>
107
109
  <p><a href="#about">About</a></p>
@@ -133,16 +135,19 @@
133
135
 
134
136
  <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>
135
137
 
136
- <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 what 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>
137
-
138
- <p>This is a new project, and I have a lot of <a href="https://github.com/evanthegrayt/standup_md/issues">updates planned</a>, but I won&#39;t push to <code>master</code> unless all <a href="https://github.com/evanthegrayt/standup_md/blob/master/test/standup_md_test.rb">tests</a> are passing and the gem is working as expected. The first official release will be once <a href="https://github.com/evanthegrayt/standup_md/milestone/1">this milestone</a> is complete. Until then, consider this gem to be in alpha, and the version will remain <code>&lt; 0.1.0</code>.</p>
138
+ <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>
139
139
 
140
140
  <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
141
141
 
142
142
  <h3 id="label-Via+RubyGems">Via RubyGems<span><a href="#label-Via+RubyGems">&para;</a> <a href="#top">&uarr;</a></span></h3>
143
143
 
144
- <p><em>COMING SOON. For now, please use the <a href="#manual-installation">manual installation instructions</a>. The gem will be officially released once <a href="https://github.com/evanthegrayt/standup_md/milestone/1">this milestone</a> is completed</em>.</p>
145
- <!-- Just install the gem! --><!-- ```sh --><!-- gem install standup_md --><!-- ``` --><!-- If you don't have permission on your system to install ruby or gems, I recommend --><!-- using [rvm](https://rvm.io/) or --><!-- [rbenv](http://www.rubyinside.com/rbenv-a-simple-new-ruby-version-management-tool-5302.html), --><!-- or you can try to use a manual method below. -->
144
+ <p>Just install the gem!</p>
145
+
146
+ <pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">standup_md</span>
147
+ </pre>
148
+
149
+ <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>
150
+
146
151
  <h3 id="label-Manual+Installation">Manual Installation<span><a href="#label-Manual+Installation">&para;</a> <a href="#top">&uarr;</a></span></h3>
147
152
 
148
153
  <p>From your terminal, clone the repository where you want it. From there, you have a couple of installation options.</p>
@@ -155,7 +160,7 @@ rake install
155
160
 
156
161
  # OR manually link the executable somewhere. If you use this method, you cannot
157
162
  # move the repository after you link it!
158
- ln -s $PWD/bin/standup /usr/local/bin</pre>
163
+ ln -s $PWD/bin/standup /usr/local/bin/standup</pre>
159
164
 
160
165
  <h2 id="label-Usage">Usage<span><a href="#label-Usage">&para;</a> <a href="#top">&uarr;</a></span></h2>
161
166
 
@@ -284,7 +289,7 @@ sub_header_order:
284
289
 
285
290
  <footer id="validator-badges" role="contentinfo">
286
291
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
287
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
292
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
288
293
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
289
294
  </footer>
290
295
 
@@ -4,7 +4,7 @@
4
4
  <head>
5
5
  <meta charset="UTF-8">
6
6
 
7
- <title>class StandupMD::CLI - RDoc Documentation</title>
7
+ <title>class StandupMD::Cli - RDoc Documentation</title>
8
8
 
9
9
  <script type="text/javascript">
10
10
  var rdoc_rel_prefix = "../";
@@ -117,9 +117,9 @@
117
117
  </div>
118
118
  </nav>
119
119
 
120
- <main role="main" aria-labelledby="class-StandupMD::CLI">
121
- <h1 id="class-StandupMD::CLI" class="class">
122
- class StandupMD::CLI
120
+ <main role="main" aria-labelledby="class-StandupMD::Cli">
121
+ <h1 id="class-StandupMD::Cli" class="class">
122
+ class StandupMD::Cli
123
123
  </h1>
124
124
 
125
125
  <section class="description">
@@ -892,7 +892,7 @@
892
892
 
893
893
  <footer id="validator-badges" role="contentinfo">
894
894
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
895
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
895
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
896
896
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
897
897
  </footer>
898
898
 
data/doc/StandupMD.html CHANGED
@@ -1256,7 +1256,7 @@
1256
1256
  <p>@example</p>
1257
1257
 
1258
1258
  <pre class="ruby"><span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
1259
- <span class="ruby-comment"># =&gt; &#39;0.9.0&#39;</span>
1259
+ <span class="ruby-comment"># =&gt; &#39;0.1.0&#39;</span>
1260
1260
  </pre>
1261
1261
 
1262
1262
 
@@ -1447,7 +1447,7 @@
1447
1447
 
1448
1448
  <footer id="validator-badges" role="contentinfo">
1449
1449
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
1450
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
1450
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
1451
1451
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
1452
1452
  </footer>
1453
1453
 
data/doc/TestHelper.html CHANGED
@@ -123,11 +123,11 @@
123
123
 
124
124
  <div class="method-description">
125
125
 
126
- <p>Creates instance of <code>CLI</code>.</p>
126
+ <p>Creates instance of <code>Cli</code>.</p>
127
127
 
128
128
  <p>@param [Array] options Parsed by <code>getopts</code></p>
129
129
 
130
- <p>@return [StandupMD::CLI]</p>
130
+ <p>@return [StandupMD::Cli]</p>
131
131
 
132
132
 
133
133
 
@@ -135,7 +135,7 @@
135
135
  <div class="method-source-code" id="cli-source">
136
136
  <pre><span class="ruby-comment"># File test/test_helper.rb, line 58</span>
137
137
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cli</span>(<span class="ruby-identifier">options</span> = [])
138
- <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">CLI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
138
+ <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Cli</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
139
139
  <span class="ruby-keyword">end</span></pre>
140
140
  </div>
141
141
 
@@ -276,7 +276,7 @@
276
276
 
277
277
  <footer id="validator-badges" role="contentinfo">
278
278
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
279
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
279
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
280
280
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
281
281
  </footer>
282
282
 
@@ -191,7 +191,7 @@
191
191
 
192
192
  <section class="description">
193
193
 
194
- <p>The test suite for <code>CLI</code>.</p>
194
+ <p>The test suite for <code>Cli</code>.</p>
195
195
 
196
196
  <p>The test suite for <code>StandupMD</code>.</p>
197
197
 
@@ -352,7 +352,7 @@
352
352
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_PREFERENCE_FILE</span>
353
353
  <span class="ruby-identifier">assert_equal</span>(
354
354
  <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</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;.standup_md.yml&#39;</span>)),
355
- <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">CLI</span><span class="ruby-operator">::</span><span class="ruby-constant">PREFERENCE_FILE</span>
355
+ <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Cli</span><span class="ruby-operator">::</span><span class="ruby-constant">PREFERENCE_FILE</span>
356
356
  )
357
357
  <span class="ruby-keyword">end</span></pre>
358
358
  </div>
@@ -1100,7 +1100,7 @@
1100
1100
  <div class="method-source-code" id="test_initialize-source">
1101
1101
  <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 62</span>
1102
1102
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_initialize</span>
1103
- <span class="ruby-identifier">assert_nothing_raised</span> { <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">CLI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@options</span>) }
1103
+ <span class="ruby-identifier">assert_nothing_raised</span> { <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Cli</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@options</span>) }
1104
1104
  <span class="ruby-keyword">end</span></pre>
1105
1105
  </div>
1106
1106
 
@@ -1639,7 +1639,7 @@
1639
1639
 
1640
1640
  <div class="method-description">
1641
1641
 
1642
- <p>The <code>execute</code> method is the entry point for the CLI. It&#39;s parameter is an array of command-line flags</p>
1642
+ <p>The <code>execute</code> method is the entry point for the Cli. It&#39;s parameter is an array of command-line flags</p>
1643
1643
 
1644
1644
 
1645
1645
 
@@ -1647,7 +1647,7 @@
1647
1647
  <div class="method-source-code" id="test_self_execute-source">
1648
1648
  <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 40</span>
1649
1649
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_self_execute</span>
1650
- <span class="ruby-identifier">assert_nothing_raised</span> { <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">CLI</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-ivar">@options</span>) }
1650
+ <span class="ruby-identifier">assert_nothing_raised</span> { <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Cli</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-ivar">@options</span>) }
1651
1651
  <span class="ruby-keyword">end</span></pre>
1652
1652
  </div>
1653
1653
 
@@ -1932,7 +1932,7 @@
1932
1932
 
1933
1933
  <footer id="validator-badges" role="contentinfo">
1934
1934
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
1935
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
1935
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
1936
1936
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
1937
1937
  </footer>
1938
1938
 
data/doc/created.rid CHANGED
@@ -1,8 +1,8 @@
1
- Mon, 27 Apr 2020 21:49:01 -0500
2
- README.md Fri, 24 Apr 2020 23:40:59 -0500
3
- lib/standup_md.rb Mon, 27 Apr 2020 21:43:25 -0500
4
- lib/standup_md/cli.rb Mon, 27 Apr 2020 21:43:25 -0500
5
- lib/standup_md/version.rb Mon, 27 Apr 2020 21:44:04 -0500
6
- test/standup_md/cli_test.rb Mon, 27 Apr 2020 19:48:27 -0500
1
+ Wed, 29 Apr 2020 17:09:38 -0500
2
+ README.md Wed, 29 Apr 2020 16:51:59 -0500
3
+ lib/standup_md.rb Mon, 27 Apr 2020 22:21:05 -0500
4
+ lib/standup_md/cli.rb Wed, 29 Apr 2020 17:08:28 -0500
5
+ lib/standup_md/version.rb Mon, 27 Apr 2020 22:25:50 -0500
6
+ test/standup_md/cli_test.rb Wed, 29 Apr 2020 17:08:56 -0500
7
7
  test/standup_md_test.rb Thu, 23 Apr 2020 22:53:37 -0500
8
- test/test_helper.rb Mon, 27 Apr 2020 19:39:33 -0500
8
+ test/test_helper.rb Wed, 29 Apr 2020 17:09:31 -0500
data/doc/css/rdoc.css CHANGED
@@ -74,6 +74,9 @@ h6:target {
74
74
  code,
75
75
  pre {
76
76
  font-family: "Source Code Pro", Monaco, monospace;
77
+ background-color: rgba(27,31,35,0.05);
78
+ padding: 0em 0.2em;
79
+ border-radius: 0.2em;
77
80
  }
78
81
 
79
82
  /* @group Generic Classes */
@@ -103,7 +106,7 @@ pre {
103
106
 
104
107
  .missing-docs {
105
108
  font-size: 120%;
106
- background: white url(images/wrench_orange.png) no-repeat 4px center;
109
+ background: white url(../images/wrench_orange.png) no-repeat 4px center;
107
110
  color: #ccc;
108
111
  line-height: 2em;
109
112
  border: 1px solid #d00;
@@ -147,11 +150,11 @@ pre {
147
150
  .table-of-contents li .toc-toggle {
148
151
  width: 16px;
149
152
  height: 16px;
150
- background: url(images/add.png) no-repeat;
153
+ background: url(../images/add.png) no-repeat;
151
154
  }
152
155
 
153
156
  .table-of-contents li .toc-toggle.open {
154
- background: url(images/delete.png) no-repeat;
157
+ background: url(../images/delete.png) no-repeat;
155
158
  }
156
159
 
157
160
  /* @end */
@@ -273,8 +276,13 @@ ul.link-list .type {
273
276
  -webkit-border-radius: 5px;
274
277
  }
275
278
 
279
+ dl.label-list dt {
280
+ float: left;
281
+ margin-right: 1em;
282
+ }
283
+
276
284
  .calls-super {
277
- background: url(images/arrow_up.png) no-repeat right center;
285
+ background: url(../images/arrow_up.png) no-repeat right center;
278
286
  }
279
287
 
280
288
  /* @end */
@@ -500,7 +508,7 @@ main .method-click-advice {
500
508
  visibility: hidden;
501
509
  padding-right: 20px;
502
510
  line-height: 20px;
503
- background: url(images/zoom.png) no-repeat right top;
511
+ background: url(../images/zoom.png) no-repeat right top;
504
512
  }
505
513
  main .method-heading:hover .method-click-advice {
506
514
  visibility: visible;
data/doc/index.html CHANGED
@@ -74,7 +74,7 @@
74
74
 
75
75
  <li><a href="./StandupMD.html">StandupMD</a>
76
76
 
77
- <li><a href="./StandupMD/CLI.html">StandupMD::CLI</a>
77
+ <li><a href="./StandupMD/Cli.html">StandupMD::Cli</a>
78
78
 
79
79
  <li><a href="./TestHelper.html">TestHelper</a>
80
80
 
@@ -89,7 +89,7 @@
89
89
  <main role="main">
90
90
 
91
91
 
92
- <h1 id="label-The+Standup+Doctor"><a href="https://evanthegrayt.github.io/standup_md/">The Standup Doctor</a><span><a href="#label-The+Standup+Doctor">&para;</a> <a href="#top">&uarr;</a></span></h1>
92
+ <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>
93
93
 
94
94
  <blockquote>
95
95
  <p>The cure for all your standup woes.</p>
@@ -97,6 +97,8 @@
97
97
 
98
98
  <p>A highly customizable and automated way to keep track of daily standups in markdown files.</p>
99
99
 
100
+ <p>View on: <a href="https://github.com/evanthegrayt/standup_md">Github</a> | <a href="https://evanthegrayt.github.io/standup_md/">GitHub Pages</a> | <a href="https://rubygems.org/gems/standup_md">RubyGems</a></p>
101
+
100
102
  <h2 id="label-Table+of+Contents">Table of Contents<span><a href="#label-Table+of+Contents">&para;</a> <a href="#top">&uarr;</a></span></h2>
101
103
  <ul><li>
102
104
  <p><a href="#about">About</a></p>
@@ -128,16 +130,19 @@
128
130
 
129
131
  <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
132
 
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 what 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>
132
-
133
- <p>This is a new project, and I have a lot of <a href="https://github.com/evanthegrayt/standup_md/issues">updates planned</a>, but I won&#39;t push to <code>master</code> unless all <a href="https://github.com/evanthegrayt/standup_md/blob/master/test/standup_md_test.rb">tests</a> are passing and the gem is working as expected. The first official release will be once <a href="https://github.com/evanthegrayt/standup_md/milestone/1">this milestone</a> is complete. Until then, consider this gem to be in alpha, and the version will remain <code>&lt; 0.1.0</code>.</p>
133
+ <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>
134
134
 
135
135
  <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
136
136
 
137
137
  <h3 id="label-Via+RubyGems">Via RubyGems<span><a href="#label-Via+RubyGems">&para;</a> <a href="#top">&uarr;</a></span></h3>
138
138
 
139
- <p><em>COMING SOON. For now, please use the <a href="#manual-installation">manual installation instructions</a>. The gem will be officially released once <a href="https://github.com/evanthegrayt/standup_md/milestone/1">this milestone</a> is completed</em>.</p>
140
- <!-- Just install the gem! --><!-- ```sh --><!-- gem install standup_md --><!-- ``` --><!-- If you don't have permission on your system to install ruby or gems, I recommend --><!-- using [rvm](https://rvm.io/) or --><!-- [rbenv](http://www.rubyinside.com/rbenv-a-simple-new-ruby-version-management-tool-5302.html), --><!-- or you can try to use a manual method below. -->
139
+ <p>Just install the gem!</p>
140
+
141
+ <pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">standup_md</span>
142
+ </pre>
143
+
144
+ <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>
145
+
141
146
  <h3 id="label-Manual+Installation">Manual Installation<span><a href="#label-Manual+Installation">&para;</a> <a href="#top">&uarr;</a></span></h3>
142
147
 
143
148
  <p>From your terminal, clone the repository where you want it. From there, you have a couple of installation options.</p>
@@ -150,7 +155,7 @@ rake install
150
155
 
151
156
  # OR manually link the executable somewhere. If you use this method, you cannot
152
157
  # move the repository after you link it!
153
- ln -s $PWD/bin/standup /usr/local/bin</pre>
158
+ ln -s $PWD/bin/standup /usr/local/bin/standup</pre>
154
159
 
155
160
  <h2 id="label-Usage">Usage<span><a href="#label-Usage">&para;</a> <a href="#top">&uarr;</a></span></h2>
156
161
 
@@ -280,7 +285,7 @@ sub_header_order:
280
285
 
281
286
  <footer id="validator-badges" role="contentinfo">
282
287
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
283
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
288
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
284
289
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
285
290
  </footer>
286
291
 
@@ -1 +1 @@
1
- var search_data = {"index":{"searchIndex":["standupmd","cli","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()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","setup()","should_append?()","should_append?()","standup()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","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_empty?()","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","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#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()","teststandupmd#setup()","standupmd::cli#should_append?()","teststandupmd#should_append?()","standupmd::cli#standup()","testhelper#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","teststandupmd#teardown()","teststandupmd#test_preference_file()","teststandupmd#test_version()","teststandupmd#test_all_previous_entries()","teststandupmd#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()","teststandupmd#test_edit?()","teststandupmd#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()","teststandupmd#test_initialize()","teststandupmd#test_json?()","teststandupmd#test_load()","teststandupmd#test_notes()","teststandupmd#test_notes_header()","teststandupmd#test_options()","teststandupmd#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()","teststandupmd#test_print_all_entries?()","teststandupmd#test_print_current_empty?()","teststandupmd#test_reload()","teststandupmd#test_self_execute()","teststandupmd#test_setting_attributes_via_block()","teststandupmd#test_standup()","teststandupmd#test_sub_header_depth()","teststandupmd#test_sub_header_order()","teststandupmd#test_verbose?()","teststandupmd#test_write()","teststandupmd#test_write?()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The class for handing reading/writing of entries.\n<p>@example\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">su</span> = <span class=\"ruby-constant\">StandupMD</span>.<span class=\"ruby-identifier\">new</span>\n</pre>\n"],["StandupMD::CLI","","StandupMD/CLI.html","","<p>Class for handing the command-line interface.\n"],["TestHelper","","TestHelper.html","","<p>Module to include in tests that provides helper functions.\n"],["TestStandupMD","","TestStandupMD.html","","<p>The test suite for <code>CLI</code>.\n<p>The test suite for <code>StandupMD</code>.\n"],["append_previous?","StandupMD::CLI","StandupMD/CLI.html#method-i-append_previous-3F","()","<p>Should `previous_entry_tasks` be appended? If false, <code>previous_entry_tasks</code> will be overwritten.\n<p>@return …\n"],["append_to_previous_entry_tasks","StandupMD::CLI","StandupMD/CLI.html#method-i-append_to_previous_entry_tasks","()","<p>Appends entries passed at runtime to existing previous entries.\n<p>@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["cli","TestHelper","TestHelper.html#method-i-cli","(options = [])","<p>Creates instance of <code>CLI</code>.\n<p>@param [Array] options Parsed by <code>getopts</code>\n<p>@return [StandupMD::CLI]\n"],["create_standup_file","TestHelper","TestHelper.html#method-i-create_standup_file","(file, fixture = 'previous_entry')","<p>Creates the standup file with entries.\n<p>@param [String] file The name of the file to create\n<p>@param [String] …\n"],["current_entry_tasks=","StandupMD","StandupMD.html#method-i-current_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["directory=","StandupMD","StandupMD.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn&#39;t …\n"],["echo","StandupMD::CLI","StandupMD/CLI.html#method-i-echo","(msg)","<p>Prints output if <code>verbose</code> is true.\n<p>@return [nil]\n"],["edit","StandupMD::CLI","StandupMD/CLI.html#method-i-edit","()","<p>Opens the file in an editor. Abandons the script.\n"],["edit?","StandupMD::CLI","StandupMD/CLI.html#method-i-edit-3F","()","<p>Should the standup file be opened in the editor?\n<p>@return [Boolean] Default is true\n"],["editor","StandupMD::CLI","StandupMD/CLI.html#method-i-editor","()","<p>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","()","<p>Was today&#39;s entry already in the file?\n<p>@return [boolean] true if today&#39;s entry was already in …\n"],["execute","StandupMD::CLI","StandupMD/CLI.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n"],["file_written?","StandupMD","StandupMD.html#method-i-file_written-3F","()","<p>Has the file been written since instantiated?\n<p>@return [boolean]\n<p>@example\n"],["fixtures","TestHelper","TestHelper.html#method-i-fixtures","()","<p>Reads the fixtures in as a hash.\n<p>@return [Hash]\n"],["header_depth=","StandupMD","StandupMD.html#method-i-header_depth-3D","(depth)","<p>Number of octothorps (#) to use before the main header.\n<p>@param [Integer] depth\n<p>@return [Integer]\n"],["impediments=","StandupMD","StandupMD.html#method-i-impediments-3D","(tasks)","<p>Setter for impediments.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["json?","StandupMD::CLI","StandupMD/CLI.html#method-i-json-3F","()","<p>If printing an entry, should it be printed as json?\n<p>@return [Boolean] Default is false\n"],["load","StandupMD","StandupMD.html#method-c-load","(attributes = {})","<p>Convenience method for calling <code>new</code> + <code>load</code>\n<p>@param [Hash] attributes Attributes to set before loading.\n<p>@example …\n"],["load","StandupMD","StandupMD.html#method-i-load","()","<p>Sets internal instance variables. Called when first instantiated, or after directory is set.\n<p>@return [self] …\n"],["new","StandupMD","StandupMD.html#method-c-new","()","<p>Constructor. Yields the instance so you can pass a block to access setters.\n<p>@return [self]\n<p>@example\n"],["new","StandupMD::CLI","StandupMD/CLI.html#method-c-new","(options)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["notes=","StandupMD","StandupMD.html#method-i-notes-3D","(tasks)","<p>Setter for notes.\n<p>@param [Array] notes\n<p>@return [Array]\n"],["previous_entry_tasks=","StandupMD","StandupMD.html#method-i-previous_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["print_all_entries","StandupMD::CLI","StandupMD/CLI.html#method-i-print_all_entries","()","<p>Prints all entries to the command line.\n<p>@return [nil]\n"],["print_all_entries?","StandupMD::CLI","StandupMD/CLI.html#method-i-print_all_entries-3F","()","<p>Should all entries be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["print_current_entry","StandupMD::CLI","StandupMD/CLI.html#method-i-print_current_entry","()","<p>Prints the current entry to the command line.\n<p>@return [nil]\n"],["print_current_entry?","StandupMD::CLI","StandupMD/CLI.html#method-i-print_current_entry-3F","()","<p>Should current entry be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["reload","StandupMD","StandupMD.html#method-i-reload","()","<p>Alias of <code>load</code>\n<p>@return [self]\n"],["setup","TestStandupMD","TestStandupMD.html#method-i-setup","()","<p>Set working directory, current month&#39;s file, and last month&#39;s file, which will be created and …\n"],["should_append?","StandupMD::CLI","StandupMD/CLI.html#method-i-should_append-3F","()","<p>Did the user pass <code>previous_entry_tasks</code>, and should we append?\n<p>@return [Boolean]\n"],["should_append?","TestStandupMD","TestStandupMD.html#method-i-should_append-3F","()","<p>True only if <code>--no-append</code> and <code>--previous-entry-tasks</code> are passed.\n"],["standup","StandupMD::CLI","StandupMD/CLI.html#method-i-standup","()","<p>Sets up an instance of <code>StandupMD</code> and passes all user preferences.\n<p>@return [StandupMD]\n"],["standup","TestHelper","TestHelper.html#method-i-standup","(directory, args = {})","<p>Creates <code>StandupUP</code> instance. Directory must be passed, usually a subdirectory of <code>test</code>, so we don&#39;t …\n"],["sub_header_depth=","StandupMD","StandupMD.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["sub_header_order","StandupMD","StandupMD.html#method-i-sub_header_order","()","<p>Return a copy of the sub-header order so the user can&#39;t modify the array.\n<p>@return [Array]\n"],["sub_header_order=","StandupMD","StandupMD.html#method-i-sub_header_order-3D","(array)","<p>Preferred order for sub-headers.\n<p>@param [Array] Values must be %w[previous current impediment notes]\n<p>@return …\n"],["teardown","TestStandupMD","TestStandupMD.html#method-i-teardown","()","<p>Destroy the working directory and its contents.\n"],["test_PREFERENCE_FILE","TestStandupMD","TestStandupMD.html#method-i-test_PREFERENCE_FILE","()","<p>The user&#39;s preference file is a string.\n"],["test_VERSION","TestStandupMD","TestStandupMD.html#method-i-test_VERSION","()","<p><code>StandupMD::VERSION</code> should consist of three integers separated by dots.\n"],["test_all_previous_entries","TestStandupMD","TestStandupMD.html#method-i-test_all_previous_entries","()","<p>Should be all entries before the current entry.\n"],["test_append_previous?","TestStandupMD","TestStandupMD.html#method-i-test_append_previous-3F","()","<p>True by default. False if flag is passed.\n"],["test_bullet_character","TestStandupMD","TestStandupMD.html#method-i-test_bullet_character","()","<p>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","()","<p>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","()","<p><code>current_entry</code> should be a hash. If <code>file</code> 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","()","<p>Should be able to add tasks for current_entry.\n"],["test_current_header","TestStandupMD","TestStandupMD.html#method-i-test_current_header","()","<p>Should be changeable and used as the header for <code>current_entry</code>\n"],["test_directory","TestStandupMD","TestStandupMD.html#method-i-test_directory","()","<p>Directory should default be settable, and where standup files are read from.\n"],["test_edit?","TestStandupMD","TestStandupMD.html#method-i-test_edit-3F","()","<p>True by default. False if flag is passed.\n"],["test_editor","TestStandupMD","TestStandupMD.html#method-i-test_editor","()","<p>The editor should be set by preferences, or env, or set to &#39;vim&#39;.\n"],["test_entry_previously_added?","TestStandupMD","TestStandupMD.html#method-i-test_entry_previously_added-3F","()","<p>Should be true if <code>current_entry</code> was in the file at the time it was read.\n"],["test_file","TestStandupMD","TestStandupMD.html#method-i-test_file","()","<p>The file name should equal file_name_format parsed by Date.strftime. The default is Date.today.strftime(&#39;%Y_%m.md&#39;) …\n"],["test_file_name_format","TestStandupMD","TestStandupMD.html#method-i-test_file_name_format","()","<p>Should be changeable, and return a string parsed by <code>strftime</code>.\n"],["test_file_written?","TestStandupMD","TestStandupMD.html#method-i-test_file_written-3F","()","<p>Should be false when first instantiated, true after <code>write</code> is called.\n"],["test_header_date_format","TestStandupMD","TestStandupMD.html#method-i-test_header_date_format","()","<p>Should be changeable, and return a string parsed by <code>strftime</code>.\n"],["test_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_header_depth","()","<p>Should be an integer between <code>1..5</code>, but not higher than <code>sub_header_depth</code>.\n"],["test_impediments","TestStandupMD","TestStandupMD.html#method-i-test_impediments","()","<p>Should be able to add impediments to the array.\n"],["test_impediments_header","TestStandupMD","TestStandupMD.html#method-i-test_impediments_header","()","<p>Should be changeable and used as the header for <code>impediments</code>\n"],["test_initialize","TestStandupMD","TestStandupMD.html#method-i-test_initialize","()","<p>The <code>initialize</code> method should accept the same parameters as <code>exectute</code>.\n"],["test_json?","TestStandupMD","TestStandupMD.html#method-i-test_json-3F","()","<p>False by default. True if flag is passed.\n"],["test_load","TestStandupMD","TestStandupMD.html#method-i-test_load","()","<p>Should load instance variables.\n"],["test_notes","TestStandupMD","TestStandupMD.html#method-i-test_notes","()","<p>Should be able to add notes to the array.\n"],["test_notes_header","TestStandupMD","TestStandupMD.html#method-i-test_notes_header","()","<p>Should be changeable and used as the header for <code>notes</code>\n"],["test_options","TestStandupMD","TestStandupMD.html#method-i-test_options","()","<p>The <code>options</code> should be an array of options passed from the command line.\n"],["test_preferences","TestStandupMD","TestStandupMD.html#method-i-test_preferences","()","<p>The <code>preferences</code> are the settings after <code>options</code> are parsed.\n"],["test_previous_entry_tasks","TestStandupMD","TestStandupMD.html#method-i-test_previous_entry_tasks","()","<p>Should be an array of previous entry&#39;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","()","<p>When neither last month&#39;s file, nor this month&#39;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","()","<p>When last month&#39;s file exists, but this month&#39;s doesn&#39;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","()","<p>If there are previous entries for this month, previous file will be this month&#39;s file.\n"],["test_previous_header","TestStandupMD","TestStandupMD.html#method-i-test_previous_header","()","<p>Should be changeable and used as the header for <code>previous_entry</code>\n"],["test_print_all_entries?","TestStandupMD","TestStandupMD.html#method-i-test_print_all_entries-3F","()","<p>False by default. True if flag is passed.\n"],["test_print_current_empty?","TestStandupMD","TestStandupMD.html#method-i-test_print_current_empty-3F","()","<p>False by default. True if flag is passed.\n"],["test_reload","TestStandupMD","TestStandupMD.html#method-i-test_reload","()","<p>The reload method should exist, and is an alias of <code>load</code>.\n"],["test_self_execute","TestStandupMD","TestStandupMD.html#method-i-test_self_execute","()","<p>The <code>execute</code> method is the entry point for the CLI. It&#39;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","()","<p>Attributes should be able to be set if you pass a block at instantiation.\n"],["test_standup","TestStandupMD","TestStandupMD.html#method-i-test_standup","()","<p>Creates the instance of <code>StandupMD</code>.\n"],["test_sub_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_depth","()","<p>Should be an integer between <code>2..6</code>, but not lower than <code>header_depth</code>.\n"],["test_sub_header_order","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_order","()","<p>The order of the subheaders is changeable, but all elements must exist.\n"],["test_verbose?","TestStandupMD","TestStandupMD.html#method-i-test_verbose-3F","()","<p>False by default. True if flag is passed.\n"],["test_write","TestStandupMD","TestStandupMD.html#method-i-test_write","()","<p>Should write the file.\n"],["test_write?","TestStandupMD","TestStandupMD.html#method-i-test_write-3F","()","<p>True by default. False if flag is passed.\n"],["verbose?","StandupMD::CLI","StandupMD/CLI.html#method-i-verbose-3F","()","<p>Should debug info be printed?\n<p>@return [Boolean] Default is false\n"],["write","StandupMD","StandupMD.html#method-i-write","()","<p>Writes a new entry to the file if the first entry in the file isn&#39;t today.\n<p>@return [Boolean]\n"],["write?","StandupMD::CLI","StandupMD/CLI.html#method-i-write-3F","()","<p>Should the file be written?\n<p>@return [Boolean] Default is true\n"],["write_file","StandupMD::CLI","StandupMD/CLI.html#method-i-write_file","()","<p>Writes entries to the file.\n<p>@return [Boolean] true if file was written\n"],["README","","README_md.html","","<p>The Standup Doctor\n\n<blockquote><p>The cure for all your standup woes.\n</blockquote>\n<p>A highly customizable and automated way to keep …\n"]]}}
1
+ var search_data = {"index":{"searchIndex":["standupmd","cli","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()","notes=()","previous_entry_tasks=()","print_all_entries()","print_all_entries?()","print_current_entry()","print_current_entry?()","reload()","setup()","should_append?()","should_append?()","standup()","standup()","sub_header_depth=()","sub_header_order()","sub_header_order=()","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_empty?()","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","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#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()","teststandupmd#setup()","standupmd::cli#should_append?()","teststandupmd#should_append?()","standupmd::cli#standup()","testhelper#standup()","standupmd#sub_header_depth=()","standupmd#sub_header_order()","standupmd#sub_header_order=()","teststandupmd#teardown()","teststandupmd#test_preference_file()","teststandupmd#test_version()","teststandupmd#test_all_previous_entries()","teststandupmd#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()","teststandupmd#test_edit?()","teststandupmd#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()","teststandupmd#test_initialize()","teststandupmd#test_json?()","teststandupmd#test_load()","teststandupmd#test_notes()","teststandupmd#test_notes_header()","teststandupmd#test_options()","teststandupmd#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()","teststandupmd#test_print_all_entries?()","teststandupmd#test_print_current_empty?()","teststandupmd#test_reload()","teststandupmd#test_self_execute()","teststandupmd#test_setting_attributes_via_block()","teststandupmd#test_standup()","teststandupmd#test_sub_header_depth()","teststandupmd#test_sub_header_order()","teststandupmd#test_verbose?()","teststandupmd#test_write()","teststandupmd#test_write?()","standupmd::cli#verbose?()","standupmd#write()","standupmd::cli#write?()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The class for handing reading/writing of entries.\n<p>@example\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">su</span> = <span class=\"ruby-constant\">StandupMD</span>.<span class=\"ruby-identifier\">new</span>\n</pre>\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["TestHelper","","TestHelper.html","","<p>Module to include in tests that provides helper functions.\n"],["TestStandupMD","","TestStandupMD.html","","<p>The test suite for <code>Cli</code>.\n<p>The test suite for <code>StandupMD</code>.\n"],["append_previous?","StandupMD::Cli","StandupMD/Cli.html#method-i-append_previous-3F","()","<p>Should `previous_entry_tasks` be appended? If false, <code>previous_entry_tasks</code> will be overwritten.\n<p>@return …\n"],["append_to_previous_entry_tasks","StandupMD::Cli","StandupMD/Cli.html#method-i-append_to_previous_entry_tasks","()","<p>Appends entries passed at runtime to existing previous entries.\n<p>@return [Hash]\n"],["bullet_character=","StandupMD","StandupMD.html#method-i-bullet_character-3D","(character)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["cli","TestHelper","TestHelper.html#method-i-cli","(options = [])","<p>Creates instance of <code>Cli</code>.\n<p>@param [Array] options Parsed by <code>getopts</code>\n<p>@return [StandupMD::Cli]\n"],["create_standup_file","TestHelper","TestHelper.html#method-i-create_standup_file","(file, fixture = 'previous_entry')","<p>Creates the standup file with entries.\n<p>@param [String] file The name of the file to create\n<p>@param [String] …\n"],["current_entry_tasks=","StandupMD","StandupMD.html#method-i-current_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["directory=","StandupMD","StandupMD.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn&#39;t …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Prints output if <code>verbose</code> is true.\n<p>@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","<p>Opens the file in an editor. Abandons the script.\n"],["edit?","StandupMD::Cli","StandupMD/Cli.html#method-i-edit-3F","()","<p>Should the standup file be opened in the editor?\n<p>@return [Boolean] Default is true\n"],["editor","StandupMD::Cli","StandupMD/Cli.html#method-i-editor","()","<p>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","()","<p>Was today&#39;s entry already in the file?\n<p>@return [boolean] true if today&#39;s entry was already in …\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n"],["file_written?","StandupMD","StandupMD.html#method-i-file_written-3F","()","<p>Has the file been written since instantiated?\n<p>@return [boolean]\n<p>@example\n"],["fixtures","TestHelper","TestHelper.html#method-i-fixtures","()","<p>Reads the fixtures in as a hash.\n<p>@return [Hash]\n"],["header_depth=","StandupMD","StandupMD.html#method-i-header_depth-3D","(depth)","<p>Number of octothorps (#) to use before the main header.\n<p>@param [Integer] depth\n<p>@return [Integer]\n"],["impediments=","StandupMD","StandupMD.html#method-i-impediments-3D","(tasks)","<p>Setter for impediments.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["json?","StandupMD::Cli","StandupMD/Cli.html#method-i-json-3F","()","<p>If printing an entry, should it be printed as json?\n<p>@return [Boolean] Default is false\n"],["load","StandupMD","StandupMD.html#method-c-load","(attributes = {})","<p>Convenience method for calling <code>new</code> + <code>load</code>\n<p>@param [Hash] attributes Attributes to set before loading.\n<p>@example …\n"],["load","StandupMD","StandupMD.html#method-i-load","()","<p>Sets internal instance variables. Called when first instantiated, or after directory is set.\n<p>@return [self] …\n"],["new","StandupMD","StandupMD.html#method-c-new","()","<p>Constructor. Yields the instance so you can pass a block to access setters.\n<p>@return [self]\n<p>@example\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["notes=","StandupMD","StandupMD.html#method-i-notes-3D","(tasks)","<p>Setter for notes.\n<p>@param [Array] notes\n<p>@return [Array]\n"],["previous_entry_tasks=","StandupMD","StandupMD.html#method-i-previous_entry_tasks-3D","(tasks)","<p>Setter for current entry tasks.\n<p>@param [Array] tasks\n<p>@return [Array]\n"],["print_all_entries","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries","()","<p>Prints all entries to the command line.\n<p>@return [nil]\n"],["print_all_entries?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_all_entries-3F","()","<p>Should all entries be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["print_current_entry","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry","()","<p>Prints the current entry to the command line.\n<p>@return [nil]\n"],["print_current_entry?","StandupMD::Cli","StandupMD/Cli.html#method-i-print_current_entry-3F","()","<p>Should current entry be printed? If true, disables editing.\n<p>@return [Boolean] Default is false\n"],["reload","StandupMD","StandupMD.html#method-i-reload","()","<p>Alias of <code>load</code>\n<p>@return [self]\n"],["setup","TestStandupMD","TestStandupMD.html#method-i-setup","()","<p>Set working directory, current month&#39;s file, and last month&#39;s file, which will be created and …\n"],["should_append?","StandupMD::Cli","StandupMD/Cli.html#method-i-should_append-3F","()","<p>Did the user pass <code>previous_entry_tasks</code>, and should we append?\n<p>@return [Boolean]\n"],["should_append?","TestStandupMD","TestStandupMD.html#method-i-should_append-3F","()","<p>True only if <code>--no-append</code> and <code>--previous-entry-tasks</code> are passed.\n"],["standup","StandupMD::Cli","StandupMD/Cli.html#method-i-standup","()","<p>Sets up an instance of <code>StandupMD</code> and passes all user preferences.\n<p>@return [StandupMD]\n"],["standup","TestHelper","TestHelper.html#method-i-standup","(directory, args = {})","<p>Creates <code>StandupUP</code> instance. Directory must be passed, usually a subdirectory of <code>test</code>, so we don&#39;t …\n"],["sub_header_depth=","StandupMD","StandupMD.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["sub_header_order","StandupMD","StandupMD.html#method-i-sub_header_order","()","<p>Return a copy of the sub-header order so the user can&#39;t modify the array.\n<p>@return [Array]\n"],["sub_header_order=","StandupMD","StandupMD.html#method-i-sub_header_order-3D","(array)","<p>Preferred order for sub-headers.\n<p>@param [Array] Values must be %w[previous current impediment notes]\n<p>@return …\n"],["teardown","TestStandupMD","TestStandupMD.html#method-i-teardown","()","<p>Destroy the working directory and its contents.\n"],["test_PREFERENCE_FILE","TestStandupMD","TestStandupMD.html#method-i-test_PREFERENCE_FILE","()","<p>The user&#39;s preference file is a string.\n"],["test_VERSION","TestStandupMD","TestStandupMD.html#method-i-test_VERSION","()","<p><code>StandupMD::VERSION</code> should consist of three integers separated by dots.\n"],["test_all_previous_entries","TestStandupMD","TestStandupMD.html#method-i-test_all_previous_entries","()","<p>Should be all entries before the current entry.\n"],["test_append_previous?","TestStandupMD","TestStandupMD.html#method-i-test_append_previous-3F","()","<p>True by default. False if flag is passed.\n"],["test_bullet_character","TestStandupMD","TestStandupMD.html#method-i-test_bullet_character","()","<p>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","()","<p>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","()","<p><code>current_entry</code> should be a hash. If <code>file</code> 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","()","<p>Should be able to add tasks for current_entry.\n"],["test_current_header","TestStandupMD","TestStandupMD.html#method-i-test_current_header","()","<p>Should be changeable and used as the header for <code>current_entry</code>\n"],["test_directory","TestStandupMD","TestStandupMD.html#method-i-test_directory","()","<p>Directory should default be settable, and where standup files are read from.\n"],["test_edit?","TestStandupMD","TestStandupMD.html#method-i-test_edit-3F","()","<p>True by default. False if flag is passed.\n"],["test_editor","TestStandupMD","TestStandupMD.html#method-i-test_editor","()","<p>The editor should be set by preferences, or env, or set to &#39;vim&#39;.\n"],["test_entry_previously_added?","TestStandupMD","TestStandupMD.html#method-i-test_entry_previously_added-3F","()","<p>Should be true if <code>current_entry</code> was in the file at the time it was read.\n"],["test_file","TestStandupMD","TestStandupMD.html#method-i-test_file","()","<p>The file name should equal file_name_format parsed by Date.strftime. The default is Date.today.strftime(&#39;%Y_%m.md&#39;) …\n"],["test_file_name_format","TestStandupMD","TestStandupMD.html#method-i-test_file_name_format","()","<p>Should be changeable, and return a string parsed by <code>strftime</code>.\n"],["test_file_written?","TestStandupMD","TestStandupMD.html#method-i-test_file_written-3F","()","<p>Should be false when first instantiated, true after <code>write</code> is called.\n"],["test_header_date_format","TestStandupMD","TestStandupMD.html#method-i-test_header_date_format","()","<p>Should be changeable, and return a string parsed by <code>strftime</code>.\n"],["test_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_header_depth","()","<p>Should be an integer between <code>1..5</code>, but not higher than <code>sub_header_depth</code>.\n"],["test_impediments","TestStandupMD","TestStandupMD.html#method-i-test_impediments","()","<p>Should be able to add impediments to the array.\n"],["test_impediments_header","TestStandupMD","TestStandupMD.html#method-i-test_impediments_header","()","<p>Should be changeable and used as the header for <code>impediments</code>\n"],["test_initialize","TestStandupMD","TestStandupMD.html#method-i-test_initialize","()","<p>The <code>initialize</code> method should accept the same parameters as <code>exectute</code>.\n"],["test_json?","TestStandupMD","TestStandupMD.html#method-i-test_json-3F","()","<p>False by default. True if flag is passed.\n"],["test_load","TestStandupMD","TestStandupMD.html#method-i-test_load","()","<p>Should load instance variables.\n"],["test_notes","TestStandupMD","TestStandupMD.html#method-i-test_notes","()","<p>Should be able to add notes to the array.\n"],["test_notes_header","TestStandupMD","TestStandupMD.html#method-i-test_notes_header","()","<p>Should be changeable and used as the header for <code>notes</code>\n"],["test_options","TestStandupMD","TestStandupMD.html#method-i-test_options","()","<p>The <code>options</code> should be an array of options passed from the command line.\n"],["test_preferences","TestStandupMD","TestStandupMD.html#method-i-test_preferences","()","<p>The <code>preferences</code> are the settings after <code>options</code> are parsed.\n"],["test_previous_entry_tasks","TestStandupMD","TestStandupMD.html#method-i-test_previous_entry_tasks","()","<p>Should be an array of previous entry&#39;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","()","<p>When neither last month&#39;s file, nor this month&#39;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","()","<p>When last month&#39;s file exists, but this month&#39;s doesn&#39;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","()","<p>If there are previous entries for this month, previous file will be this month&#39;s file.\n"],["test_previous_header","TestStandupMD","TestStandupMD.html#method-i-test_previous_header","()","<p>Should be changeable and used as the header for <code>previous_entry</code>\n"],["test_print_all_entries?","TestStandupMD","TestStandupMD.html#method-i-test_print_all_entries-3F","()","<p>False by default. True if flag is passed.\n"],["test_print_current_empty?","TestStandupMD","TestStandupMD.html#method-i-test_print_current_empty-3F","()","<p>False by default. True if flag is passed.\n"],["test_reload","TestStandupMD","TestStandupMD.html#method-i-test_reload","()","<p>The reload method should exist, and is an alias of <code>load</code>.\n"],["test_self_execute","TestStandupMD","TestStandupMD.html#method-i-test_self_execute","()","<p>The <code>execute</code> method is the entry point for the Cli. It&#39;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","()","<p>Attributes should be able to be set if you pass a block at instantiation.\n"],["test_standup","TestStandupMD","TestStandupMD.html#method-i-test_standup","()","<p>Creates the instance of <code>StandupMD</code>.\n"],["test_sub_header_depth","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_depth","()","<p>Should be an integer between <code>2..6</code>, but not lower than <code>header_depth</code>.\n"],["test_sub_header_order","TestStandupMD","TestStandupMD.html#method-i-test_sub_header_order","()","<p>The order of the subheaders is changeable, but all elements must exist.\n"],["test_verbose?","TestStandupMD","TestStandupMD.html#method-i-test_verbose-3F","()","<p>False by default. True if flag is passed.\n"],["test_write","TestStandupMD","TestStandupMD.html#method-i-test_write","()","<p>Should write the file.\n"],["test_write?","TestStandupMD","TestStandupMD.html#method-i-test_write-3F","()","<p>True by default. False if flag is passed.\n"],["verbose?","StandupMD::Cli","StandupMD/Cli.html#method-i-verbose-3F","()","<p>Should debug info be printed?\n<p>@return [Boolean] Default is false\n"],["write","StandupMD","StandupMD.html#method-i-write","()","<p>Writes a new entry to the file if the first entry in the file isn&#39;t today.\n<p>@return [Boolean]\n"],["write?","StandupMD::Cli","StandupMD/Cli.html#method-i-write-3F","()","<p>Should the file be written?\n<p>@return [Boolean] Default is true\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","<p>Writes entries to the file.\n<p>@return [Boolean] true if file was written\n"],["README","","README_md.html","","<p>The Standup Doctor\n\n<blockquote><p>The cure for all your standup woes.\n</blockquote>\n<p>A highly customizable and automated way to keep …\n"]]}}
Binary file
@@ -37,7 +37,7 @@
37
37
 
38
38
  <ul>
39
39
 
40
- <li><a href="README_md.html#label-The+Standup+Doctor"><a href="https://evanthegrayt.github.io/standup_md/">The Standup Doctor</a></a>
40
+ <li><a href="README_md.html#label-The+Standup+Doctor">The Standup Doctor</a>
41
41
 
42
42
  <li><a href="README_md.html#label-Table+of+Contents">Table of Contents</a>
43
43
 
@@ -95,7 +95,7 @@
95
95
  </li>
96
96
 
97
97
  <li class="class">
98
- <a href="StandupMD/CLI.html">StandupMD::CLI</a>
98
+ <a href="StandupMD/Cli.html">StandupMD::Cli</a>
99
99
 
100
100
  </li>
101
101
 
@@ -115,9 +115,9 @@
115
115
  <ul>
116
116
 
117
117
  <li class="method">
118
- <a href="StandupMD/CLI.html#method-c-execute">::execute</a>
118
+ <a href="StandupMD/Cli.html#method-c-execute">::execute</a>
119
119
  &mdash;
120
- <span class="container">StandupMD::CLI</span>
120
+ <span class="container">StandupMD::Cli</span>
121
121
 
122
122
  <li class="method">
123
123
  <a href="StandupMD.html#method-c-load">::load</a>
@@ -130,19 +130,19 @@
130
130
  <span class="container">StandupMD</span>
131
131
 
132
132
  <li class="method">
133
- <a href="StandupMD/CLI.html#method-c-new">::new</a>
133
+ <a href="StandupMD/Cli.html#method-c-new">::new</a>
134
134
  &mdash;
135
- <span class="container">StandupMD::CLI</span>
135
+ <span class="container">StandupMD::Cli</span>
136
136
 
137
137
  <li class="method">
138
- <a href="StandupMD/CLI.html#method-i-append_previous-3F">#append_previous?</a>
138
+ <a href="StandupMD/Cli.html#method-i-append_previous-3F">#append_previous?</a>
139
139
  &mdash;
140
- <span class="container">StandupMD::CLI</span>
140
+ <span class="container">StandupMD::Cli</span>
141
141
 
142
142
  <li class="method">
143
- <a href="StandupMD/CLI.html#method-i-append_to_previous_entry_tasks">#append_to_previous_entry_tasks</a>
143
+ <a href="StandupMD/Cli.html#method-i-append_to_previous_entry_tasks">#append_to_previous_entry_tasks</a>
144
144
  &mdash;
145
- <span class="container">StandupMD::CLI</span>
145
+ <span class="container">StandupMD::Cli</span>
146
146
 
147
147
  <li class="method">
148
148
  <a href="StandupMD.html#method-i-bullet_character-3D">#bullet_character=</a>
@@ -170,24 +170,24 @@
170
170
  <span class="container">StandupMD</span>
171
171
 
172
172
  <li class="method">
173
- <a href="StandupMD/CLI.html#method-i-echo">#echo</a>
173
+ <a href="StandupMD/Cli.html#method-i-echo">#echo</a>
174
174
  &mdash;
175
- <span class="container">StandupMD::CLI</span>
175
+ <span class="container">StandupMD::Cli</span>
176
176
 
177
177
  <li class="method">
178
- <a href="StandupMD/CLI.html#method-i-edit">#edit</a>
178
+ <a href="StandupMD/Cli.html#method-i-edit">#edit</a>
179
179
  &mdash;
180
- <span class="container">StandupMD::CLI</span>
180
+ <span class="container">StandupMD::Cli</span>
181
181
 
182
182
  <li class="method">
183
- <a href="StandupMD/CLI.html#method-i-edit-3F">#edit?</a>
183
+ <a href="StandupMD/Cli.html#method-i-edit-3F">#edit?</a>
184
184
  &mdash;
185
- <span class="container">StandupMD::CLI</span>
185
+ <span class="container">StandupMD::Cli</span>
186
186
 
187
187
  <li class="method">
188
- <a href="StandupMD/CLI.html#method-i-editor">#editor</a>
188
+ <a href="StandupMD/Cli.html#method-i-editor">#editor</a>
189
189
  &mdash;
190
- <span class="container">StandupMD::CLI</span>
190
+ <span class="container">StandupMD::Cli</span>
191
191
 
192
192
  <li class="method">
193
193
  <a href="StandupMD.html#method-i-entry_previously_added-3F">#entry_previously_added?</a>
@@ -215,9 +215,9 @@
215
215
  <span class="container">StandupMD</span>
216
216
 
217
217
  <li class="method">
218
- <a href="StandupMD/CLI.html#method-i-json-3F">#json?</a>
218
+ <a href="StandupMD/Cli.html#method-i-json-3F">#json?</a>
219
219
  &mdash;
220
- <span class="container">StandupMD::CLI</span>
220
+ <span class="container">StandupMD::Cli</span>
221
221
 
222
222
  <li class="method">
223
223
  <a href="StandupMD.html#method-i-load">#load</a>
@@ -235,24 +235,24 @@
235
235
  <span class="container">StandupMD</span>
236
236
 
237
237
  <li class="method">
238
- <a href="StandupMD/CLI.html#method-i-print_all_entries">#print_all_entries</a>
238
+ <a href="StandupMD/Cli.html#method-i-print_all_entries">#print_all_entries</a>
239
239
  &mdash;
240
- <span class="container">StandupMD::CLI</span>
240
+ <span class="container">StandupMD::Cli</span>
241
241
 
242
242
  <li class="method">
243
- <a href="StandupMD/CLI.html#method-i-print_all_entries-3F">#print_all_entries?</a>
243
+ <a href="StandupMD/Cli.html#method-i-print_all_entries-3F">#print_all_entries?</a>
244
244
  &mdash;
245
- <span class="container">StandupMD::CLI</span>
245
+ <span class="container">StandupMD::Cli</span>
246
246
 
247
247
  <li class="method">
248
- <a href="StandupMD/CLI.html#method-i-print_current_entry">#print_current_entry</a>
248
+ <a href="StandupMD/Cli.html#method-i-print_current_entry">#print_current_entry</a>
249
249
  &mdash;
250
- <span class="container">StandupMD::CLI</span>
250
+ <span class="container">StandupMD::Cli</span>
251
251
 
252
252
  <li class="method">
253
- <a href="StandupMD/CLI.html#method-i-print_current_entry-3F">#print_current_entry?</a>
253
+ <a href="StandupMD/Cli.html#method-i-print_current_entry-3F">#print_current_entry?</a>
254
254
  &mdash;
255
- <span class="container">StandupMD::CLI</span>
255
+ <span class="container">StandupMD::Cli</span>
256
256
 
257
257
  <li class="method">
258
258
  <a href="StandupMD.html#method-i-reload">#reload</a>
@@ -270,9 +270,9 @@
270
270
  <span class="container">TestStandupMD</span>
271
271
 
272
272
  <li class="method">
273
- <a href="StandupMD/CLI.html#method-i-should_append-3F">#should_append?</a>
273
+ <a href="StandupMD/Cli.html#method-i-should_append-3F">#should_append?</a>
274
274
  &mdash;
275
- <span class="container">StandupMD::CLI</span>
275
+ <span class="container">StandupMD::Cli</span>
276
276
 
277
277
  <li class="method">
278
278
  <a href="TestHelper.html#method-i-standup">#standup</a>
@@ -280,9 +280,9 @@
280
280
  <span class="container">TestHelper</span>
281
281
 
282
282
  <li class="method">
283
- <a href="StandupMD/CLI.html#method-i-standup">#standup</a>
283
+ <a href="StandupMD/Cli.html#method-i-standup">#standup</a>
284
284
  &mdash;
285
- <span class="container">StandupMD::CLI</span>
285
+ <span class="container">StandupMD::Cli</span>
286
286
 
287
287
  <li class="method">
288
288
  <a href="StandupMD.html#method-i-sub_header_depth-3D">#sub_header_depth=</a>
@@ -520,9 +520,9 @@
520
520
  <span class="container">TestStandupMD</span>
521
521
 
522
522
  <li class="method">
523
- <a href="StandupMD/CLI.html#method-i-verbose-3F">#verbose?</a>
523
+ <a href="StandupMD/Cli.html#method-i-verbose-3F">#verbose?</a>
524
524
  &mdash;
525
- <span class="container">StandupMD::CLI</span>
525
+ <span class="container">StandupMD::Cli</span>
526
526
 
527
527
  <li class="method">
528
528
  <a href="StandupMD.html#method-i-write">#write</a>
@@ -530,14 +530,14 @@
530
530
  <span class="container">StandupMD</span>
531
531
 
532
532
  <li class="method">
533
- <a href="StandupMD/CLI.html#method-i-write-3F">#write?</a>
533
+ <a href="StandupMD/Cli.html#method-i-write-3F">#write?</a>
534
534
  &mdash;
535
- <span class="container">StandupMD::CLI</span>
535
+ <span class="container">StandupMD::Cli</span>
536
536
 
537
537
  <li class="method">
538
- <a href="StandupMD/CLI.html#method-i-write_file">#write_file</a>
538
+ <a href="StandupMD/Cli.html#method-i-write_file">#write_file</a>
539
539
  &mdash;
540
- <span class="container">StandupMD::CLI</span>
540
+ <span class="container">StandupMD::Cli</span>
541
541
 
542
542
  </ul>
543
543
  </main>
@@ -545,7 +545,7 @@
545
545
 
546
546
  <footer id="validator-badges" role="contentinfo">
547
547
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
548
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
548
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
549
549
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
550
550
  </footer>
551
551
 
@@ -6,7 +6,7 @@ require_relative '../standup_md'
6
6
  class StandupMD
7
7
  ##
8
8
  # Class for handing the command-line interface.
9
- class CLI
9
+ class Cli
10
10
 
11
11
  ##
12
12
  # The user's preference file.
@@ -4,6 +4,6 @@ class StandupMD
4
4
  #
5
5
  # @example
6
6
  # StandupMD::VERSION
7
- # # => '0.1.0'
8
- VERSION = '0.1.0'
7
+ # # => '0.1.1'
8
+ VERSION = '0.1.1'
9
9
  end
data/standup_md.gemspec CHANGED
@@ -30,8 +30,10 @@ Gem::Specification.new do |spec|
30
30
  # spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
31
31
  # `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
32
32
  # end
33
- spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
33
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
34
34
  spec.bindir = 'bin'
35
35
  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
36
36
  spec.require_paths = ['lib']
37
+ spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
38
+ spec.add_development_dependency 'test-unit', '~> 3.3', '>= 3.3.5'
37
39
  end
metadata CHANGED
@@ -1,15 +1,55 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: standup_md
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Evan Gray
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-04-27 00:00:00.000000000 Z
12
- dependencies: []
11
+ date: 2020-04-29 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rake
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '13.0'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 13.0.1
23
+ type: :development
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - "~>"
28
+ - !ruby/object:Gem::Version
29
+ version: '13.0'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 13.0.1
33
+ - !ruby/object:Gem::Dependency
34
+ name: test-unit
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '3.3'
40
+ - - ">="
41
+ - !ruby/object:Gem::Version
42
+ version: 3.3.5
43
+ type: :development
44
+ prerelease: false
45
+ version_requirements: !ruby/object:Gem::Requirement
46
+ requirements:
47
+ - - "~>"
48
+ - !ruby/object:Gem::Version
49
+ version: '3.3'
50
+ - - ">="
51
+ - !ruby/object:Gem::Version
52
+ version: 3.3.5
13
53
  description: Generate and edit standups in markdown format
14
54
  email: evanthegrayt@vivaldi.net
15
55
  executables:
@@ -102,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
102
142
  - !ruby/object:Gem::Version
103
143
  version: '0'
104
144
  requirements: []
105
- rubygems_version: 3.0.3
145
+ rubygems_version: 3.1.2
106
146
  signing_key:
107
147
  specification_version: 4
108
148
  summary: The cure for all your standup woes