standup_md 0.3.2 → 0.3.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +11 -9
- data/README.md +67 -34
- data/Rakefile +3 -1
- data/doc/README_md.html +54 -54
- data/doc/StandupMD.html +8 -97
- data/doc/StandupMD/Cli.html +21 -163
- data/doc/StandupMD/Cli/Helpers.html +13 -34
- data/doc/StandupMD/Config.html +7 -44
- data/doc/StandupMD/Config/Cli.html +26 -85
- data/doc/StandupMD/Config/Entry.html +23 -67
- data/doc/StandupMD/Config/EntryList.html +22 -48
- data/doc/StandupMD/Config/File.html +27 -155
- data/doc/StandupMD/Entry.html +11 -120
- data/doc/StandupMD/EntryList.html +101 -361
- data/doc/StandupMD/File.html +51 -182
- data/doc/StandupMD/Version.html +143 -0
- data/doc/created.rid +15 -15
- data/doc/css/rdoc.css +1 -1
- data/doc/index.html +52 -67
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search_index.js +1 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +51 -110
- data/lib/standup_md.rb +3 -2
- data/lib/standup_md/cli.rb +2 -3
- data/lib/standup_md/cli/helpers.rb +66 -34
- data/lib/standup_md/config.rb +2 -2
- data/lib/standup_md/config/cli.rb +22 -21
- data/lib/standup_md/config/entry.rb +12 -7
- data/lib/standup_md/config/entry_list.rb +8 -3
- data/lib/standup_md/config/file.rb +24 -14
- data/lib/standup_md/entry.rb +2 -2
- data/lib/standup_md/entry_list.rb +24 -41
- data/lib/standup_md/file.rb +32 -15
- data/lib/standup_md/file/helpers.rb +13 -15
- data/lib/standup_md/version.rb +23 -4
- data/standup_md.gemspec +12 -16
- metadata +7 -6
@@ -0,0 +1,143 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>module StandupMD::Version - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<script type="text/javascript">
|
10
|
+
var rdoc_rel_prefix = "../";
|
11
|
+
var index_rel_prefix = "../";
|
12
|
+
</script>
|
13
|
+
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
15
|
+
<script src="../js/search.js" defer></script>
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
19
|
+
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
22
|
+
|
23
|
+
|
24
|
+
<body id="top" role="document" class="module">
|
25
|
+
<nav role="navigation">
|
26
|
+
<div id="project-navigation">
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
28
|
+
<h2>
|
29
|
+
<a href="../index.html" rel="home">Home</a>
|
30
|
+
</h2>
|
31
|
+
|
32
|
+
<div id="table-of-contents-navigation">
|
33
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
34
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
35
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
36
|
+
</div>
|
37
|
+
</div>
|
38
|
+
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
41
|
+
<div id="search-field-wrapper">
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
44
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
46
|
+
</div>
|
47
|
+
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
49
|
+
aria-busy="false" aria-expanded="false"
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
51
|
+
</form>
|
52
|
+
</div>
|
53
|
+
|
54
|
+
</div>
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
<div id="class-metadata">
|
59
|
+
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
<!-- Method Quickref -->
|
65
|
+
<div id="method-list-section" class="nav-section">
|
66
|
+
<h3>Methods</h3>
|
67
|
+
|
68
|
+
<ul class="link-list" role="directory">
|
69
|
+
<li ><a href="#method-c-to_s">::to_s</a>
|
70
|
+
</ul>
|
71
|
+
</div>
|
72
|
+
|
73
|
+
</div>
|
74
|
+
</nav>
|
75
|
+
|
76
|
+
<main role="main" aria-labelledby="module-StandupMD::Version">
|
77
|
+
<h1 id="module-StandupMD::Version" class="module">
|
78
|
+
module StandupMD::Version
|
79
|
+
</h1>
|
80
|
+
|
81
|
+
<section class="description">
|
82
|
+
|
83
|
+
<p>Module that contains all gem version information. Follows semantic versioning. Read: <a href="https://semver.org">semver.org</a>/</p>
|
84
|
+
|
85
|
+
</section>
|
86
|
+
|
87
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
88
|
+
|
89
|
+
|
90
|
+
<section class="constants-list">
|
91
|
+
<header>
|
92
|
+
<h3>Constants</h3>
|
93
|
+
</header>
|
94
|
+
<dl>
|
95
|
+
<dt id="MAJOR">MAJOR
|
96
|
+
<dd><p>Major version.</p>
|
97
|
+
<dt id="MINOR">MINOR
|
98
|
+
<dd><p>Minor version.</p>
|
99
|
+
<dt id="PATCH">PATCH
|
100
|
+
<dd><p>Patch version.</p>
|
101
|
+
</dl>
|
102
|
+
</section>
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
107
|
+
<header>
|
108
|
+
<h3>Public Class Methods</h3>
|
109
|
+
</header>
|
110
|
+
|
111
|
+
<div id="method-c-to_s" class="method-detail ">
|
112
|
+
<div class="method-heading">
|
113
|
+
<span class="method-name">to_s</span><span
|
114
|
+
class="method-args">()</span>
|
115
|
+
<span class="method-click-advice">click to toggle source</span>
|
116
|
+
</div>
|
117
|
+
|
118
|
+
<div class="method-description">
|
119
|
+
<p><a href="Version.html"><code>Version</code></a> as <code>MAJOR.MINOR.PATCH</code></p>
|
120
|
+
|
121
|
+
<div class="method-source-code" id="to_s-source">
|
122
|
+
<pre><span class="ruby-comment"># File lib/standup_md/version.rb, line 24</span>
|
123
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">to_s</span>
|
124
|
+
<span class="ruby-node">"#{MAJOR}.#{MINOR}.#{PATCH}"</span>
|
125
|
+
<span class="ruby-keyword">end</span></pre>
|
126
|
+
</div>
|
127
|
+
</div>
|
128
|
+
|
129
|
+
|
130
|
+
</div>
|
131
|
+
|
132
|
+
</section>
|
133
|
+
|
134
|
+
</section>
|
135
|
+
</main>
|
136
|
+
|
137
|
+
|
138
|
+
<footer id="validator-badges" role="contentinfo">
|
139
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
140
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
141
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
142
|
+
</footer>
|
143
|
+
|
data/doc/created.rid
CHANGED
@@ -1,15 +1,15 @@
|
|
1
|
-
|
2
|
-
README.md
|
3
|
-
lib/standup_md.rb
|
4
|
-
lib/standup_md/cli.rb
|
5
|
-
lib/standup_md/cli/helpers.rb
|
6
|
-
lib/standup_md/config.rb
|
7
|
-
lib/standup_md/config/cli.rb
|
8
|
-
lib/standup_md/config/entry.rb
|
9
|
-
lib/standup_md/config/entry_list.rb Wed,
|
10
|
-
lib/standup_md/config/file.rb Wed,
|
11
|
-
lib/standup_md/entry.rb
|
12
|
-
lib/standup_md/entry_list.rb
|
13
|
-
lib/standup_md/file.rb
|
14
|
-
lib/standup_md/file/helpers.rb
|
15
|
-
lib/standup_md/version.rb
|
1
|
+
Fri, 30 Apr 2021 10:18:47 -0500
|
2
|
+
README.md Fri, 30 Apr 2021 10:15:18 -0500
|
3
|
+
lib/standup_md.rb Tue, 13 Oct 2020 21:04:02 -0500
|
4
|
+
lib/standup_md/cli.rb Tue, 13 Oct 2020 21:04:02 -0500
|
5
|
+
lib/standup_md/cli/helpers.rb Tue, 13 Oct 2020 21:49:05 -0500
|
6
|
+
lib/standup_md/config.rb Tue, 13 Oct 2020 21:04:02 -0500
|
7
|
+
lib/standup_md/config/cli.rb Tue, 13 Oct 2020 21:04:02 -0500
|
8
|
+
lib/standup_md/config/entry.rb Tue, 13 Oct 2020 21:04:02 -0500
|
9
|
+
lib/standup_md/config/entry_list.rb Wed, 17 Jun 2020 08:47:50 -0500
|
10
|
+
lib/standup_md/config/file.rb Wed, 17 Jun 2020 08:47:50 -0500
|
11
|
+
lib/standup_md/entry.rb Tue, 17 Nov 2020 11:34:44 -0600
|
12
|
+
lib/standup_md/entry_list.rb Mon, 12 Apr 2021 21:51:46 -0500
|
13
|
+
lib/standup_md/file.rb Mon, 26 Apr 2021 09:04:06 -0500
|
14
|
+
lib/standup_md/file/helpers.rb Tue, 13 Oct 2020 21:04:02 -0500
|
15
|
+
lib/standup_md/version.rb Fri, 30 Apr 2021 10:18:44 -0500
|
data/doc/css/rdoc.css
CHANGED
data/doc/index.html
CHANGED
@@ -21,8 +21,6 @@
|
|
21
21
|
<link href="./css/rdoc.css" rel="stylesheet">
|
22
22
|
|
23
23
|
|
24
|
-
|
25
|
-
|
26
24
|
<body id="top" role="document" class="file">
|
27
25
|
<nav role="navigation">
|
28
26
|
<div id="project-navigation">
|
@@ -57,13 +55,12 @@
|
|
57
55
|
</div>
|
58
56
|
|
59
57
|
<div id="project-metadata">
|
60
|
-
|
58
|
+
|
59
|
+
<div id="fileindex-section" class="nav-section">
|
61
60
|
<h3>Pages</h3>
|
62
61
|
|
63
62
|
<ul class="link-list">
|
64
|
-
|
65
63
|
<li><a href="./README_md.html">README</a>
|
66
|
-
|
67
64
|
</ul>
|
68
65
|
</div>
|
69
66
|
|
@@ -71,29 +68,18 @@
|
|
71
68
|
<h3>Class and Module Index</h3>
|
72
69
|
|
73
70
|
<ul class="link-list">
|
74
|
-
|
75
71
|
<li><a href="./StandupMD.html">StandupMD</a>
|
76
|
-
|
77
72
|
<li><a href="./StandupMD/Cli.html">StandupMD::Cli</a>
|
78
|
-
|
79
73
|
<li><a href="./StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
|
80
|
-
|
81
74
|
<li><a href="./StandupMD/Config.html">StandupMD::Config</a>
|
82
|
-
|
83
75
|
<li><a href="./StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
|
84
|
-
|
85
76
|
<li><a href="./StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
|
86
|
-
|
87
77
|
<li><a href="./StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
|
88
|
-
|
89
78
|
<li><a href="./StandupMD/Config/File.html">StandupMD::Config::File</a>
|
90
|
-
|
91
79
|
<li><a href="./StandupMD/Entry.html">StandupMD::Entry</a>
|
92
|
-
|
93
80
|
<li><a href="./StandupMD/EntryList.html">StandupMD::EntryList</a>
|
94
|
-
|
95
81
|
<li><a href="./StandupMD/File.html">StandupMD::File</a>
|
96
|
-
|
82
|
+
<li><a href="./StandupMD/Version.html">StandupMD::Version</a>
|
97
83
|
</ul>
|
98
84
|
</div>
|
99
85
|
|
@@ -104,7 +90,7 @@
|
|
104
90
|
|
105
91
|
|
106
92
|
<h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+Standup+Doctor">¶</a> <a href="#top">↑</a></span></h1>
|
107
|
-
|
93
|
+
<!-- vi: set ts=4 sw=4 : -->
|
108
94
|
<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
95
|
|
110
96
|
<blockquote>
|
@@ -115,55 +101,16 @@
|
|
115
101
|
|
116
102
|
<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>
|
117
103
|
|
118
|
-
<h2 id="label-Table+of+Contents">Table of Contents<span><a href="#label-Table+of+Contents">¶</a> <a href="#top">↑</a></span></h2>
|
119
|
-
<ul><li>
|
120
|
-
<p><a href="#about">About</a></p>
|
121
|
-
</li><li>
|
122
|
-
<p><a href="#Installation">Installation</a></p>
|
123
|
-
</li><li>
|
124
|
-
<p><a href="#via-rubygems">Via RubyGems</a></p>
|
125
|
-
</li><li>
|
126
|
-
<p><a href="#manual-installation">Manual Installation</a></p>
|
127
|
-
</li><li>
|
128
|
-
<p><a href="#usage">Usage</a></p>
|
129
|
-
</li><li>
|
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>
|
141
|
-
</li><li>
|
142
|
-
<p><a href="#customization-and-runtime-options">Customization and Runtime Options</a></p>
|
143
|
-
</li><li>
|
144
|
-
<p><a href="#using-existing-standup-files">Using existing standup files</a></p>
|
145
|
-
</li></ul>
|
146
|
-
</li><li>
|
147
|
-
<p><a href="#api">API</a></p>
|
148
|
-
<ul><li>
|
149
|
-
<p><a href="#api-examples">API Examples</a></p>
|
150
|
-
</li><li>
|
151
|
-
<p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
|
152
|
-
</li></ul>
|
153
|
-
</li><li>
|
154
|
-
<p><a href="#reporting-bugs-and-requesting-features">Reporting Bugs and Requesting Features</a></p>
|
155
|
-
</li><li>
|
156
|
-
<p><a href="#self-promotion">Self-Promotion</a></p>
|
157
|
-
</li></ul>
|
158
|
-
|
159
104
|
<h2 id="label-About">About<span><a href="#label-About">¶</a> <a href="#top">↑</a></span></h2>
|
160
105
|
|
161
106
|
<p>I'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'd have to look up what I did the day before, copy and paste yesterday's work into a new entry, and add today'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>
|
162
107
|
|
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't exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today's entry as your previous day's work. See <a href="#
|
108
|
+
<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't exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today's entry as your previous day's work. See <a href="#cli-examples">example</a>. There's also a very robust API if you'd like to use this in your own code somehow.</p>
|
164
109
|
|
165
110
|
<h2 id="label-Installation">Installation<span><a href="#label-Installation">¶</a> <a href="#top">↑</a></span></h2>
|
166
111
|
|
112
|
+
<p>If you don't have the permissions to install system-wide gems, you're probabaly also running an older version of ruby. I recommend installing <a href="https://github.com/rbenv/rbenv#installation">rbenv</a>, and then installing an up-to-date version of ruby.</p>
|
113
|
+
|
167
114
|
<h3 id="label-Via+RubyGems">Via RubyGems<span><a href="#label-Via+RubyGems">¶</a> <a href="#top">↑</a></span></h3>
|
168
115
|
|
169
116
|
<p>Just install the gem!</p>
|
@@ -234,7 +181,7 @@ rake install</pre>
|
|
234
181
|
|
235
182
|
<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">¶</a> <a href="#top">↑</a></span></h4>
|
236
183
|
|
237
|
-
<pre>standup --no-edit --current "Work on this thing","And another thing"
|
184
|
+
<pre>standup --no-edit --current "Work on this thing","And another thing"</pre>
|
238
185
|
|
239
186
|
<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.">¶</a> <a href="#top">↑</a></span></h4>
|
240
187
|
|
@@ -252,6 +199,8 @@ rake install</pre>
|
|
252
199
|
|
253
200
|
<h4 id="label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults<span><a href="#label-Available+Config+File+Options+and+Defaults">¶</a> <a href="#top">↑</a></span></h4>
|
254
201
|
|
202
|
+
<p>For command-line usage, this file needs to be named <code>~/.standuprc</code>. To use in a rails project, create an initializer (<code>config/initializers/standup_md.rb</code>).</p>
|
203
|
+
|
255
204
|
<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
205
|
<span class="ruby-comment"># Defaults for how the file is formatted.</span>
|
257
206
|
<span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
|
@@ -288,8 +237,12 @@ rake install</pre>
|
|
288
237
|
<span class="ruby-keyword">end</span>
|
289
238
|
</pre>
|
290
239
|
|
240
|
+
<p>Any options not set in this file will retain their default values. Note that if you change <code>file_name_format</code>, and don't use a month or year, there will only ever be one standup file. This could cause issues long-term, as the files will get large over time and possibly cause performance issues.</p>
|
241
|
+
|
291
242
|
<h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">¶</a> <a href="#top">↑</a></span></h4>
|
292
243
|
|
244
|
+
<p>Some of these options can be changed at runtime. They are as follows.</p>
|
245
|
+
|
293
246
|
<pre>--current ARRAY List of current entry's tasks
|
294
247
|
--previous ARRAY List of precious entry's tasks
|
295
248
|
--impediments ARRAY List of impediments for current entry
|
@@ -306,8 +259,6 @@ rake install</pre>
|
|
306
259
|
If DATE is passed, will print entry for DATE, if it exists.
|
307
260
|
DATE must be in the same format as file-name-format</pre>
|
308
261
|
|
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'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>
|
310
|
-
|
311
262
|
<h4 id="label-Using+Existing+Standup+Files">Using Existing Standup Files<span><a href="#label-Using+Existing+Standup+Files">¶</a> <a href="#top">↑</a></span></h4>
|
312
263
|
|
313
264
|
<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>
|
@@ -354,10 +305,12 @@ rake install</pre>
|
|
354
305
|
|
355
306
|
<p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">RDoc Documentation</a>.</p>
|
356
307
|
|
357
|
-
<p>This was mainly written as a command line utility, but the API is
|
308
|
+
<p>This was mainly written as a command line utility, but the API is very robust, and is available for use in your own projects. A quick example of how to write a new entry via code could look like the following:</p>
|
358
309
|
|
359
310
|
<h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">¶</a> <a href="#top">↑</a></span></h3>
|
360
311
|
|
312
|
+
<h4 id="label-Adding+an+entry+for+today">Adding an entry for today<span><a href="#label-Adding+an+entry+for+today">¶</a> <a href="#top">↑</a></span></h4>
|
313
|
+
|
361
314
|
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
362
315
|
|
363
316
|
<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>
|
@@ -382,6 +335,40 @@ rake install</pre>
|
|
382
335
|
<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>
|
383
336
|
</pre>
|
384
337
|
|
338
|
+
<h4 id="label-Finding+a+past+entry">Finding a past entry<span><a href="#label-Finding+a+past+entry">¶</a> <a href="#top">↑</a></span></h4>
|
339
|
+
|
340
|
+
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
341
|
+
|
342
|
+
<span class="ruby-identifier">date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">2020</span>, <span class="ruby-value">04</span>, <span class="ruby-value">15</span>)
|
343
|
+
<span class="ruby-identifier">file</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">find_by_date</span>(<span class="ruby-identifier">date</span>).<span class="ruby-identifier">load</span>
|
344
|
+
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">file</span>.<span class="ruby-identifier">entries</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">date</span>)
|
345
|
+
</pre>
|
346
|
+
|
347
|
+
<h2 id="label-Vim">Vim<span><a href="#label-Vim">¶</a> <a href="#top">↑</a></span></h2>
|
348
|
+
|
349
|
+
<p>While there's no official support for vim, you can add this to your <code>vimrc</code> file, or something like <code>~/.vim/plugin/standup.vim</code>.</p>
|
350
|
+
|
351
|
+
<pre>command! -complete=custom,<SID>StandupCompletion -nargs=? -bang Standup
|
352
|
+
\ call s:OpenStandupFile(<bang>0, <f-args>)
|
353
|
+
|
354
|
+
function! s:StandupCompletion(...) abort
|
355
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
356
|
+
if !isdirectory(l:dir) | return '' | endif
|
357
|
+
return join(map(glob(l:dir . '*.md', 0, 1), "fnamemodify(v:val, ':t')"), "\n")
|
358
|
+
endfunction
|
359
|
+
|
360
|
+
function! s:OpenStandupFile(split, ...)
|
361
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
362
|
+
let l:file = a:0 ? a:1 : get(g:, 'standup_file', strftime('%Y_%m.md'))
|
363
|
+
call system('standup --no-edit')
|
364
|
+
execute a:split ? 'vsplit' : 'split' l:dir . l:file
|
365
|
+
endfunction</pre>
|
366
|
+
|
367
|
+
<p>This makes the <code>:Standup</code> command, which opens the standup file in a split, while <code>:Standup!</code> opens it in a vertical split. If a file is passed to the command, that file will be opened. There's tab completion for this. Lastly, it allows for a few variables to be set for customization.</p>
|
368
|
+
|
369
|
+
<pre>g:standup_dir = $HOME . '/.cache/standup_md' " the directory where your file are
|
370
|
+
g:standup_file = strftime('%Y_%m.md') " the file format to use</pre>
|
371
|
+
|
385
372
|
<h2 id="label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features<span><a href="#label-Reporting+Bugs+and+Requesting+Features">¶</a> <a href="#top">↑</a></span></h2>
|
386
373
|
|
387
374
|
<p>If you have an idea or find a bug, please <a href="https://github.com/evanthegrayt/standup_md/issues/new">create an issue</a>. Just make sure the topic doesn't already exist. Better yet, you can always submit a Pull Request.</p>
|
@@ -390,14 +377,12 @@ rake install</pre>
|
|
390
377
|
|
391
378
|
<p>I do these projects for fun, and I enjoy knowing that they're helpful to people. Consider starring <a href="https://github.com/evanthegrayt/standup_md">the repository</a> if you like it! If you love it, follow me <a href="https://github.com/evanthegrayt">on Github</a>!</p>
|
392
379
|
|
393
|
-
|
394
380
|
</main>
|
395
381
|
|
396
382
|
|
397
|
-
|
398
383
|
<footer id="validator-badges" role="contentinfo">
|
399
384
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
400
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.
|
385
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
401
386
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
402
387
|
</footer>
|
403
388
|
|
data/doc/js/navigation.js.gz
CHANGED
Binary file
|
data/doc/js/search_index.js
CHANGED
@@ -1 +1 @@
|
|
1
|
-
var search_data = {"index":{"searchIndex":["standupmd","cli","helpers","config","cli","entry","entrylist","file","entry","entrylist","file","<<()","<=>()","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","","<p>The class for handing reading/writing of entries.\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["StandupMD::Cli::Helpers","","StandupMD/Cli/Helpers.html","","<p>Module responsible for reading and writing standup files.\n"],["StandupMD::Config","","StandupMD/Config.html","","<p>This class provides a connector from StandupMD to the configuration classes.\n"],["StandupMD::Config::Cli","","StandupMD/Config/Cli.html","","<p>The configuration class for StandupMD::Cli\n"],["StandupMD::Config::Entry","","StandupMD/Config/Entry.html","","<p>The configuration class for StandupMD::Entry\n"],["StandupMD::Config::EntryList","","StandupMD/Config/EntryList.html","","<p>The configuration class for StandupMD::EntryList\n"],["StandupMD::Config::File","","StandupMD/Config/File.html","","<p>The configuration class for StandupMD::File\n"],["StandupMD::Entry","","StandupMD/Entry.html","","<p>Class for handling single entries. Includes the comparable module, and compares by date.\n"],["StandupMD::EntryList","","StandupMD/EntryList.html","","<p>Enumerable list of entries.\n"],["StandupMD::File","","StandupMD/File.html","","<p>Class for handling reading and writing standup files.\n"],["<<","StandupMD::EntryList","StandupMD/EntryList.html#method-i-3C-3C","(entry)","<p>Appends entries to list.\n<p>@param [StandupMD::Entry] entry\n<p>@return [Array]\n"],["<=>","StandupMD::Entry","StandupMD/Entry.html#method-i-3C-3D-3E","(other)","<p>Sorting method for Comparable. Entries are compared by date.\n"],["bullet_character=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-bullet_character-3D","(char)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["config","StandupMD","StandupMD.html#method-c-config","()","<p>Method for accessing the configuration.\n<p>@return [StanupMD::Cli]\n"],["config","StandupMD::Cli","StandupMD/Cli.html#method-c-config","()","<p>Access to the class's configuration.\n<p>@return [StandupMD::Config::Cli]\n"],["config","StandupMD::Entry","StandupMD/Entry.html#method-c-config","()","<p>Access to the class's configuration.\n<p>@return [StandupMD::Config::Entry]\n"],["config","StandupMD::EntryList","StandupMD/EntryList.html#method-c-config","()","<p>Access to the class's configuration.\n<p>@return [StandupMD::Config::EntryList]\n"],["config","StandupMD::File","StandupMD/File.html#method-c-config","()","<p>Access to the class's configuration.\n<p>@return [StandupMD::Config::EntryList]\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-c-config_file_loaded-3F","()","<p>Has a config file been loaded?\n<p>@return [Boolean]\n"],["configure","StandupMD","StandupMD.html#method-c-configure","()","<p>Allows for configuration via a block. Useful when making config files.\n<p>@example\n\n<pre>StandupMD.configure { |s| ...</pre>\n"],["create","StandupMD::Entry","StandupMD/Entry.html#method-c-create","()","<p>Creates a generic entry. Default values can be set via configuration. Yields the entry if a block is …\n"],["directory=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["each","StandupMD::EntryList","StandupMD/EntryList.html#method-i-each","(&block)","<p>Iterate over the list and yield each entry.\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Quick access to Cli.echo.\n<p>@return [nil]\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-c-echo","(msg)","<p>Prints output if <code>verbose</code> is true.\n<p>@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","<p>Opens the file in an editor. Abandons the script.\n<p>@return [nil]\n"],["empty?","StandupMD::EntryList","StandupMD/EntryList.html#method-i-empty-3F","()","<p>Is the list empty?\n<p>@return [Boolean] true if empty\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n"],["exist?","StandupMD::File","StandupMD/File.html#method-i-exist-3F","()","<p>Does the file exist?\n<p>@return [Boolean] true if exists\n"],["filter","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter","(start_date, end_date)","<p>Returns entries that are between the start and end date. This method assumes the list has already been …\n"],["filter!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter-21","(start_date, end_date)","<p>Replaces entries with results of filter.\n<p>@param [Date] start_date\n<p>@param [Date] end_date\n"],["find","StandupMD::EntryList","StandupMD/EntryList.html#method-i-find","(key)","<p>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)","<p>Find standup file in directory by file name.\n<p>@param [String] File_naem\n"],["find_by_date","StandupMD::File","StandupMD/File.html#method-c-find_by_date","(date)","<p>Find standup file in directory by Date object.\n<p>@param [Date] date\n"],["first","StandupMD::EntryList","StandupMD/EntryList.html#method-i-first","()","<p>The first entry in the list. This method assumes the list has already been sorted.\n<p>@return [StandupMD::Entry] …\n"],["header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-header_depth-3D","(depth)","<p>Number of octothorps (#) to use before the main header.\n<p>@param [Integer] depth\n<p>@return [Integer]\n"],["initalize","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-initalize","()","<p>Initializes the config with default values.\n"],["last","StandupMD::EntryList","StandupMD/EntryList.html#method-i-last","()","<p>The last entry in the list. This method assumes the list has already been sorted.\n<p>@return [StandupMD::Entry] …\n"],["load","StandupMD::File","StandupMD/File.html#method-c-load","(file_name)","<p>Convenience method for calling File.find(file_name).load\n<p>@param [String] file_name\n<p>@return [StandupMD::File] …\n"],["load","StandupMD::File","StandupMD/File.html#method-i-load","()","<p>Loads the file's contents. TODO clean up this method.\n<p>@return [StandupMD::FileList]\n"],["load_config_file","StandupMD","StandupMD.html#method-c-load_config_file","(file)","<p>Loads a config file.\n<p>@param [String] file\n"],["load_preferences","StandupMD::Cli","StandupMD/Cli.html#method-i-load_preferences","()","<p>Load the preference file.\n<p>@return [nil]\n"],["loaded?","StandupMD::File","StandupMD/File.html#method-i-loaded-3F","()","<p>Has the file been loaded?\n<p>@return [Boolean] true if loaded\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options = [], load_config = true)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new","StandupMD::Config","StandupMD/Config.html#method-c-new","()","<p>Builds the links to the configuration classes.\n"],["new","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::File","StandupMD/Config/File.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Entry","StandupMD/Entry.html#method-c-new","(date, current, previous, impediments, notes = [])","<p>Constructs instance of <code>StandupMD::Entry</code>.\n<p>@param [Date] date\n<p>@param [Array] current\n"],["new","StandupMD::EntryList","StandupMD/EntryList.html#method-c-new","(*entries)","<p>Contruct a list. Can pass any amount of <code>StandupMD::Entry</code> instances.\n<p>@param [Entry] entries\n<p>@return [StandupMD::EntryList] …\n"],["new","StandupMD::File","StandupMD/File.html#method-c-new","(file_name)","<p>Constructs the instance.\n<p>@param [String] file_name\n<p>@return [StandupMP::File]\n"],["new?","StandupMD::File","StandupMD/File.html#method-i-new-3F","()","<p>Was the file just now created?\n<p>@return [Boolean] true if new\n"],["preference_file_loaded?","StandupMD::Cli","StandupMD/Cli.html#method-i-preference_file_loaded-3F","()","<p>Has the preference file been loaded?\n<p>@return boolean\n"],["print","StandupMD::Cli::Helpers","StandupMD/Cli/Helpers.html#method-i-print","(entry)","<p>Print an entry to the command line.\n<p>@param [StandupMD::Entry] entry\n<p>@return [nil]\n"],["reset","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Boolean] true if successful\n"],["reset","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Boolean] true if successful\n"],["reset","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Boolean] true if successful\n"],["reset","StandupMD::Config::File","StandupMD/Config/File.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Boolean] true if successful\n"],["reset_config","StandupMD","StandupMD.html#method-c-reset_config","()","<p>Reset all configuration values to their defaults.\n<p>@return [StandupMD::Config]\n"],["size","StandupMD::EntryList","StandupMD/EntryList.html#method-i-size","()","<p>How many entries are in the list.\n<p>@return [Integer]\n"],["sort","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sort!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort-21","()","<p>Replace entries with sorted entries by date.\n<p>@return [StandupMD::EntryList]\n"],["sort_reverse","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort_reverse","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sub_header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["to_h","StandupMD::Entry","StandupMD/Entry.html#method-i-to_h","()","<p>Entry as a hash .\n<p>@return [Hash]\n"],["to_h","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_h","()","<p>The list as a hash, with the dates as keys.\n<p>@return [Hash]\n"],["to_json","StandupMD::Entry","StandupMD/Entry.html#method-i-to_json","()","<p>Entry as a json object.\n<p>@return [String]\n"],["to_json","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_json","()","<p>The entry list as a json object.\n<p>@return [String]\n"],["write","StandupMD::File","StandupMD/File.html#method-i-write","(dates = {})","<p>Writes a new entry to the file if the first entry in the file isn't today. This method is destructive; …\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","<p>Writes entries to the file.\n<p>@return [Boolean] true if file was written\n"],["README","","README_md.html","","<p>The Standup Doctor\n<p><img src=\"https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat\"> …\n\n<blockquote>"]]}}
|
1
|
+
var search_data = {"index":{"searchIndex":["standupmd","cli","helpers","config","cli","entry","entrylist","file","entry","entrylist","file","version","<<()","<=>()","@entries()","bullet_character=()","config()","config()","config()","config()","config()","config_file_loaded?()","configure()","create()","directory=()","echo()","echo()","edit()","execute()","exist?()","filter()","filter!()","find()","find()","find_by_date()","header_depth=()","initalize()","load()","load()","load_config_file()","load_preferences()","loaded?()","new()","new()","new()","new()","new()","new()","new()","new()","new?()","preference_file_loaded?()","print()","reset()","reset()","reset()","reset()","reset_config()","sort()","sort!()","sort_reverse()","sub_header_depth=()","to_h()","to_h()","to_json()","to_json()","to_s()","write()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli::helpers","standupmd::config","standupmd::config::cli","standupmd::config::entry","standupmd::config::entrylist","standupmd::config::file","standupmd::entry","standupmd::entrylist","standupmd::file","standupmd::version","standupmd::entrylist#<<()","standupmd::entry#<=>()","standupmd::entrylist#@entries()","standupmd::config::file#bullet_character=()","standupmd::config()","standupmd::cli::config()","standupmd::entry::config()","standupmd::entrylist::config()","standupmd::file::config()","standupmd::config_file_loaded?()","standupmd::configure()","standupmd::entry::create()","standupmd::config::file#directory=()","standupmd::cli#echo()","standupmd::cli::echo()","standupmd::cli#edit()","standupmd::cli::execute()","standupmd::file#exist?()","standupmd::entrylist#filter()","standupmd::entrylist#filter!()","standupmd::entrylist#find()","standupmd::file::find()","standupmd::file::find_by_date()","standupmd::config::file#header_depth=()","standupmd::config::entrylist#initalize()","standupmd::file#load()","standupmd::file::load()","standupmd::load_config_file()","standupmd::cli#load_preferences()","standupmd::file#loaded?()","standupmd::cli::new()","standupmd::config::new()","standupmd::config::cli::new()","standupmd::config::entry::new()","standupmd::config::file::new()","standupmd::entry::new()","standupmd::entrylist::new()","standupmd::file::new()","standupmd::file#new?()","standupmd::cli#preference_file_loaded?()","standupmd::cli::helpers#print()","standupmd::config::cli#reset()","standupmd::config::entry#reset()","standupmd::config::entrylist#reset()","standupmd::config::file#reset()","standupmd::reset_config()","standupmd::entrylist#sort()","standupmd::entrylist#sort!()","standupmd::entrylist#sort_reverse()","standupmd::config::file#sub_header_depth=()","standupmd::entry#to_h()","standupmd::entrylist#to_h()","standupmd::entry#to_json()","standupmd::entrylist#to_json()","standupmd::version::to_s()","standupmd::file#write()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<p>The main module for the gem. Provides access to configuration classes.\n"],["StandupMD::Cli","","StandupMD/Cli.html","","<p>Class for handing the command-line interface.\n"],["StandupMD::Cli::Helpers","","StandupMD/Cli/Helpers.html","","<p>Module responsible for reading and writing standup files.\n"],["StandupMD::Config","","StandupMD/Config.html","","<p>This class provides a connector from StandupMD to the configuration classes.\n"],["StandupMD::Config::Cli","","StandupMD/Config/Cli.html","","<p>The configuration class for StandupMD::Cli\n"],["StandupMD::Config::Entry","","StandupMD/Config/Entry.html","","<p>The configuration class for StandupMD::Entry\n"],["StandupMD::Config::EntryList","","StandupMD/Config/EntryList.html","","<p>The configuration class for StandupMD::EntryList\n"],["StandupMD::Config::File","","StandupMD/Config/File.html","","<p>The configuration class for StandupMD::File\n"],["StandupMD::Entry","","StandupMD/Entry.html","","<p>Class for handling single entries. Includes the comparable module, and compares by date.\n"],["StandupMD::EntryList","","StandupMD/EntryList.html","","<p>Enumerable list of entries.\n"],["StandupMD::File","","StandupMD/File.html","","<p>Class for handling reading and writing standup files.\n"],["StandupMD::Version","","StandupMD/Version.html","","<p>Module that contains all gem version information. Follows semantic versioning. Read: semver.org/\n"],["<<","StandupMD::EntryList","StandupMD/EntryList.html#method-i-3C-3C","(entry)","<p>Appends entries to list.\n<p>@param [StandupMD::Entry] entry\n<p>@return [Array]\n"],["<=>","StandupMD::Entry","StandupMD/Entry.html#method-i-3C-3D-3E","(other)","<p>Sorting method for Comparable. Entries are compared by date.\n"],["@entries","StandupMD::EntryList","StandupMD/EntryList.html#method-i-40entries","","<p>The following are forwarded to @entries, which is the underly array of entries.\n<p><code>each</code> — Iterate over each …\n"],["bullet_character=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-bullet_character-3D","(char)","<p>Setter for bullet_character. Must be * (asterisk) or - (dash).\n<p>@param [String] character\n<p>@return [String] …\n"],["config","StandupMD","StandupMD.html#method-c-config","()","<p>Method for accessing the configuration.\n<p>@return [StanupMD::Cli]\n"],["config","StandupMD::Cli","StandupMD/Cli.html#method-c-config","()","<p>Access to the class's configuration.\n<p>@return [StandupMD::Config::Cli]\n"],["config","StandupMD::Entry","StandupMD/Entry.html#method-c-config","()","<p>Access to the class's configuration.\n<p>@return [StandupMD::Config::Entry]\n"],["config","StandupMD::EntryList","StandupMD/EntryList.html#method-c-config","()","<p>Access to the class's configuration.\n<p>@return [StandupMD::Config::EntryList]\n"],["config","StandupMD::File","StandupMD/File.html#method-c-config","()","<p>Access to the class's configuration.\n<p>@return [StandupMD::Config::EntryList]\n"],["config_file_loaded?","StandupMD","StandupMD.html#method-c-config_file_loaded-3F","()","<p>Has a config file been loaded?\n<p>@return [Boolean]\n"],["configure","StandupMD","StandupMD.html#method-c-configure","()","<p>Allows for configuration via a block. Useful when making config files.\n<p>@example\n\n<pre>StandupMD.configure { |s| ...</pre>\n"],["create","StandupMD::Entry","StandupMD/Entry.html#method-c-create","()","<p>Creates a generic entry. Default values can be set via configuration. Yields the entry if a block is …\n"],["directory=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-directory-3D","(directory)","<p>Setter for directory. Must be expanded in case the user uses `~` for home. If the directory doesn't …\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-i-echo","(msg)","<p>Quick access to Cli.echo.\n<p>@return [nil]\n"],["echo","StandupMD::Cli","StandupMD/Cli.html#method-c-echo","(msg)","<p>Prints output if <code>verbose</code> is true.\n<p>@return [nil]\n"],["edit","StandupMD::Cli","StandupMD/Cli.html#method-i-edit","()","<p>Opens the file in an editor. Abandons the script.\n<p>@return [nil]\n"],["execute","StandupMD::Cli","StandupMD/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n"],["exist?","StandupMD::File","StandupMD/File.html#method-i-exist-3F","()","<p>Does the file exist?\n<p>@return [Boolean] true if exists\n"],["filter","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter","(start_date, end_date)","<p>Returns entries that are between the start and end date. This method assumes the list has already been …\n"],["filter!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-filter-21","(start_date, end_date)","<p>Replaces entries with results of filter.\n<p>@param [Date] start_date\n<p>@param [Date] end_date\n"],["find","StandupMD::EntryList","StandupMD/EntryList.html#method-i-find","(date)","<p>Finds an entry based on date. This method assumes the list has already been sorted.\n<p>@param [Date] date …\n"],["find","StandupMD::File","StandupMD/File.html#method-c-find","(file_name)","<p>Find standup file in directory by file name.\n<p>@param [String] File_naem\n"],["find_by_date","StandupMD::File","StandupMD/File.html#method-c-find_by_date","(date)","<p>Find standup file in directory by Date object.\n<p>@param [Date] date\n"],["header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-header_depth-3D","(depth)","<p>Number of octothorps (#) to use before the main header.\n<p>@param [Integer] depth\n<p>@return [Integer]\n"],["initalize","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-initalize","()","<p>Initializes the config with default values.\n"],["load","StandupMD::File","StandupMD/File.html#method-i-load","()","<p>Loads the file's contents. TODO clean up this method.\n<p>@return [StandupMD::FileList]\n"],["load","StandupMD::File","StandupMD/File.html#method-c-load","(file_name)","<p>Convenience method for calling File.find(file_name).load\n<p>@param [String] file_name\n<p>@return [StandupMD::File] …\n"],["load_config_file","StandupMD","StandupMD.html#method-c-load_config_file","(file)","<p>Loads a config file.\n<p>@param [String] file\n"],["load_preferences","StandupMD::Cli","StandupMD/Cli.html#method-i-load_preferences","()","<p>Load the preference file.\n<p>@return [nil]\n"],["loaded?","StandupMD::File","StandupMD/File.html#method-i-loaded-3F","()","<p>Has the file been loaded?\n<p>@return [Boolean] true if loaded\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options = [], load_config = true)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new","StandupMD::Config","StandupMD/Config.html#method-c-new","()","<p>Builds the links to the configuration classes.\n"],["new","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::File","StandupMD/Config/File.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Entry","StandupMD/Entry.html#method-c-new","(date, current, previous, impediments, notes = [])","<p>Constructs instance of <code>StandupMD::Entry</code>.\n<p>@param [Date] date\n<p>@param [Array] current\n"],["new","StandupMD::EntryList","StandupMD/EntryList.html#method-c-new","(*entries)","<p>Contruct a list. Can pass any amount of <code>StandupMD::Entry</code> instances.\n<p>@param [Entry] entries\n<p>@return [StandupMD::EntryList] …\n"],["new","StandupMD::File","StandupMD/File.html#method-c-new","(file_name)","<p>Constructs the instance.\n<p>@param [String] file_name\n<p>@return [StandupMP::File]\n"],["new?","StandupMD::File","StandupMD/File.html#method-i-new-3F","()","<p>Was the file just now created?\n<p>@return [Boolean] true if new\n"],["preference_file_loaded?","StandupMD::Cli","StandupMD/Cli.html#method-i-preference_file_loaded-3F","()","<p>Has the preference file been loaded?\n<p>@return boolean\n"],["print","StandupMD::Cli::Helpers","StandupMD/Cli/Helpers.html#method-i-print","(entry)","<p>Print an entry to the command line.\n<p>@param [StandupMD::Entry] entry\n<p>@return [nil]\n"],["reset","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::File","StandupMD/Config/File.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset_config","StandupMD","StandupMD.html#method-c-reset_config","()","<p>Reset all configuration values to their defaults.\n<p>@return [StandupMD::Config]\n"],["sort","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sort!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort-21","()","<p>Replace entries with sorted entries by date.\n<p>@return [StandupMD::EntryList]\n"],["sort_reverse","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort_reverse","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sub_header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["to_h","StandupMD::Entry","StandupMD/Entry.html#method-i-to_h","()","<p>Entry as a hash .\n<p>@return [Hash]\n"],["to_h","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_h","()","<p>The list as a hash, with the dates as keys.\n<p>@return [Hash]\n"],["to_json","StandupMD::Entry","StandupMD/Entry.html#method-i-to_json","()","<p>Entry as a json object.\n<p>@return [String]\n"],["to_json","StandupMD::EntryList","StandupMD/EntryList.html#method-i-to_json","()","<p>The entry list as a json object.\n<p>@return [String]\n"],["to_s","StandupMD::Version","StandupMD/Version.html#method-c-to_s","()","<p>Version as <code>MAJOR.MINOR.PATCH</code>\n"],["write","StandupMD::File","StandupMD/File.html#method-i-write","(**dates)","<p>Writes a new entry to the file if the first entry in the file isn't today. This method is destructive; …\n"],["write_file","StandupMD::Cli","StandupMD/Cli.html#method-i-write_file","()","<p>Writes entries to the file.\n<p>@return [Boolean] true if file was written\n"],["README","","README_md.html","","<p>The Standup Doctor\n<p><img src=\"https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat\"> …\n\n<blockquote>"]]}}
|
data/doc/js/search_index.js.gz
CHANGED
Binary file
|
data/doc/js/searcher.js.gz
CHANGED
Binary file
|
data/doc/table_of_contents.html
CHANGED
@@ -21,153 +21,110 @@
|
|
21
21
|
<link href="./css/rdoc.css" rel="stylesheet">
|
22
22
|
|
23
23
|
|
24
|
-
|
25
|
-
|
26
24
|
<body id="top" class="table-of-contents">
|
27
25
|
<main role="main">
|
28
26
|
<h1 class="class">Table of Contents - RDoc Documentation</h1>
|
29
27
|
|
30
|
-
|
31
|
-
|
32
28
|
<h2 id="pages">Pages</h2>
|
33
29
|
<ul>
|
34
|
-
|
35
30
|
<li class="file">
|
36
31
|
<a href="README_md.html">README</a>
|
37
32
|
|
38
33
|
<ul>
|
39
|
-
|
40
34
|
<li><a href="README_md.html#label-The+Standup+Doctor">The Standup Doctor</a>
|
41
|
-
|
42
|
-
<li><a href="README_md.html#label-Table+of+Contents">Table of Contents</a>
|
43
|
-
|
44
35
|
<li><a href="README_md.html#label-About">About</a>
|
45
|
-
|
46
36
|
<li><a href="README_md.html#label-Installation">Installation</a>
|
47
|
-
|
48
37
|
<li><a href="README_md.html#label-Via+RubyGems">Via RubyGems</a>
|
49
|
-
|
50
38
|
<li><a href="README_md.html#label-Manual+Installation">Manual Installation</a>
|
51
|
-
|
52
39
|
<li><a href="README_md.html#label-Usage">Usage</a>
|
53
|
-
|
54
40
|
<li><a href="README_md.html#label-Command+Line">Command Line</a>
|
55
|
-
|
56
41
|
<li><a href="README_md.html#label-CLI+Examples">CLI Examples</a>
|
57
|
-
|
58
42
|
<li><a href="README_md.html#label-Adding+an+entry+for+today+via+editor">Adding an entry for today via editor</a>
|
59
|
-
|
60
43
|
<li><a href="README_md.html#label-Copy+the+entry+for+today+to+clipboard">Copy the entry for today to clipboard</a>
|
61
|
-
|
62
44
|
<li><a href="README_md.html#label-Add+entry+to+file+without+opening+it">Add entry to file without opening it</a>
|
63
|
-
|
64
45
|
<li><a href="README_md.html#label-Find+an+entry+by+date+and+print+it.">Find an entry by date and print it.</a>
|
65
|
-
|
66
46
|
<li><a href="README_md.html#label-Customization+and+Runtime+Options">Customization and Runtime Options</a>
|
67
|
-
|
68
47
|
<li><a href="README_md.html#label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults</a>
|
69
|
-
|
70
48
|
<li><a href="README_md.html#label-Executable+Flags">Executable Flags</a>
|
71
|
-
|
72
49
|
<li><a href="README_md.html#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
|
73
|
-
|
74
50
|
<li><a href="README_md.html#label-API">API</a>
|
75
|
-
|
76
51
|
<li><a href="README_md.html#label-API+Examples">API Examples</a>
|
77
|
-
|
52
|
+
<li><a href="README_md.html#label-Adding+an+entry+for+today">Adding an entry for today</a>
|
53
|
+
<li><a href="README_md.html#label-Finding+a+past+entry">Finding a past entry</a>
|
54
|
+
<li><a href="README_md.html#label-Vim">Vim</a>
|
78
55
|
<li><a href="README_md.html#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
|
79
|
-
|
80
56
|
<li><a href="README_md.html#label-Self-Promotion">Self-Promotion</a>
|
81
|
-
|
82
57
|
</ul>
|
83
|
-
|
84
58
|
</li>
|
85
|
-
|
86
59
|
</ul>
|
87
60
|
|
88
|
-
|
89
61
|
<h2 id="classes">Classes and Modules</h2>
|
90
62
|
<ul>
|
91
|
-
|
92
63
|
<li class="module">
|
93
64
|
<a href="StandupMD.html">StandupMD</a>
|
94
|
-
|
95
65
|
</li>
|
96
|
-
|
97
66
|
<li class="class">
|
98
67
|
<a href="StandupMD/Cli.html">StandupMD::Cli</a>
|
99
|
-
|
100
68
|
</li>
|
101
|
-
|
102
69
|
<li class="module">
|
103
70
|
<a href="StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
|
104
|
-
|
105
71
|
</li>
|
106
|
-
|
107
72
|
<li class="class">
|
108
73
|
<a href="StandupMD/Config.html">StandupMD::Config</a>
|
109
|
-
|
110
74
|
</li>
|
111
|
-
|
112
75
|
<li class="class">
|
113
76
|
<a href="StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
|
114
|
-
|
115
77
|
</li>
|
116
|
-
|
117
78
|
<li class="class">
|
118
79
|
<a href="StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
|
119
|
-
|
120
80
|
</li>
|
121
|
-
|
122
81
|
<li class="class">
|
123
82
|
<a href="StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
|
124
|
-
|
125
83
|
</li>
|
126
|
-
|
127
84
|
<li class="class">
|
128
85
|
<a href="StandupMD/Config/File.html">StandupMD::Config::File</a>
|
129
|
-
|
130
86
|
</li>
|
131
|
-
|
132
87
|
<li class="class">
|
133
88
|
<a href="StandupMD/Entry.html">StandupMD::Entry</a>
|
134
|
-
|
135
89
|
</li>
|
136
|
-
|
137
90
|
<li class="class">
|
138
91
|
<a href="StandupMD/EntryList.html">StandupMD::EntryList</a>
|
139
92
|
|
93
|
+
<ul>
|
94
|
+
<li><a href="StandupMD/EntryList.html#5Buntitled-5D">Top Section</a>
|
95
|
+
<li><a href="StandupMD/EntryList.html#Delegators">Delegators</a>
|
96
|
+
</ul>
|
140
97
|
</li>
|
141
|
-
|
142
98
|
<li class="class">
|
143
99
|
<a href="StandupMD/File.html">StandupMD::File</a>
|
144
|
-
|
145
100
|
</li>
|
146
|
-
|
101
|
+
<li class="module">
|
102
|
+
<a href="StandupMD/Version.html">StandupMD::Version</a>
|
103
|
+
</li>
|
147
104
|
</ul>
|
148
105
|
|
149
106
|
<h2 id="methods">Methods</h2>
|
150
107
|
<ul>
|
151
108
|
|
152
109
|
<li class="method">
|
153
|
-
<a href="StandupMD/
|
110
|
+
<a href="StandupMD/EntryList.html#method-c-config">::config</a>
|
154
111
|
—
|
155
|
-
<span class="container">StandupMD::
|
112
|
+
<span class="container">StandupMD::EntryList</span>
|
156
113
|
|
157
114
|
<li class="method">
|
158
|
-
<a href="StandupMD/
|
115
|
+
<a href="StandupMD/Entry.html#method-c-config">::config</a>
|
159
116
|
—
|
160
|
-
<span class="container">StandupMD::
|
117
|
+
<span class="container">StandupMD::Entry</span>
|
161
118
|
|
162
119
|
<li class="method">
|
163
|
-
<a href="StandupMD/
|
120
|
+
<a href="StandupMD/Cli.html#method-c-config">::config</a>
|
164
121
|
—
|
165
|
-
<span class="container">StandupMD::
|
122
|
+
<span class="container">StandupMD::Cli</span>
|
166
123
|
|
167
124
|
<li class="method">
|
168
|
-
<a href="StandupMD/
|
125
|
+
<a href="StandupMD/File.html#method-c-config">::config</a>
|
169
126
|
—
|
170
|
-
<span class="container">StandupMD::
|
127
|
+
<span class="container">StandupMD::File</span>
|
171
128
|
|
172
129
|
<li class="method">
|
173
130
|
<a href="StandupMD.html#method-c-config">::config</a>
|
@@ -220,14 +177,9 @@
|
|
220
177
|
<span class="container">StandupMD</span>
|
221
178
|
|
222
179
|
<li class="method">
|
223
|
-
<a href="StandupMD/Config/
|
224
|
-
—
|
225
|
-
<span class="container">StandupMD::Config::File</span>
|
226
|
-
|
227
|
-
<li class="method">
|
228
|
-
<a href="StandupMD/Cli.html#method-c-new">::new</a>
|
180
|
+
<a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
|
229
181
|
—
|
230
|
-
<span class="container">StandupMD::Cli</span>
|
182
|
+
<span class="container">StandupMD::Config::Cli</span>
|
231
183
|
|
232
184
|
<li class="method">
|
233
185
|
<a href="StandupMD/Config.html#method-c-new">::new</a>
|
@@ -235,9 +187,9 @@
|
|
235
187
|
<span class="container">StandupMD::Config</span>
|
236
188
|
|
237
189
|
<li class="method">
|
238
|
-
<a href="StandupMD/Config/
|
190
|
+
<a href="StandupMD/Config/File.html#method-c-new">::new</a>
|
239
191
|
—
|
240
|
-
<span class="container">StandupMD::Config::
|
192
|
+
<span class="container">StandupMD::Config::File</span>
|
241
193
|
|
242
194
|
<li class="method">
|
243
195
|
<a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
|
@@ -249,6 +201,11 @@
|
|
249
201
|
—
|
250
202
|
<span class="container">StandupMD::File</span>
|
251
203
|
|
204
|
+
<li class="method">
|
205
|
+
<a href="StandupMD/Cli.html#method-c-new">::new</a>
|
206
|
+
—
|
207
|
+
<span class="container">StandupMD::Cli</span>
|
208
|
+
|
252
209
|
<li class="method">
|
253
210
|
<a href="StandupMD/Entry.html#method-c-new">::new</a>
|
254
211
|
—
|
@@ -264,6 +221,11 @@
|
|
264
221
|
—
|
265
222
|
<span class="container">StandupMD</span>
|
266
223
|
|
224
|
+
<li class="method">
|
225
|
+
<a href="StandupMD/Version.html#method-c-to_s">::to_s</a>
|
226
|
+
—
|
227
|
+
<span class="container">StandupMD::Version</span>
|
228
|
+
|
267
229
|
<li class="method">
|
268
230
|
<a href="StandupMD/EntryList.html#method-i-3C-3C">#<<</a>
|
269
231
|
—
|
@@ -275,19 +237,19 @@
|
|
275
237
|
<span class="container">StandupMD::Entry</span>
|
276
238
|
|
277
239
|
<li class="method">
|
278
|
-
<a href="StandupMD/
|
240
|
+
<a href="StandupMD/EntryList.html#method-i-40entries">#@entries</a>
|
279
241
|
—
|
280
|
-
<span class="container">StandupMD::
|
242
|
+
<span class="container">StandupMD::EntryList</span>
|
281
243
|
|
282
244
|
<li class="method">
|
283
|
-
<a href="StandupMD/Config/File.html#method-i-
|
245
|
+
<a href="StandupMD/Config/File.html#method-i-bullet_character-3D">#bullet_character=</a>
|
284
246
|
—
|
285
247
|
<span class="container">StandupMD::Config::File</span>
|
286
248
|
|
287
249
|
<li class="method">
|
288
|
-
<a href="StandupMD/
|
250
|
+
<a href="StandupMD/Config/File.html#method-i-directory-3D">#directory=</a>
|
289
251
|
—
|
290
|
-
<span class="container">StandupMD::
|
252
|
+
<span class="container">StandupMD::Config::File</span>
|
291
253
|
|
292
254
|
<li class="method">
|
293
255
|
<a href="StandupMD/Cli.html#method-i-echo">#echo</a>
|
@@ -299,11 +261,6 @@
|
|
299
261
|
—
|
300
262
|
<span class="container">StandupMD::Cli</span>
|
301
263
|
|
302
|
-
<li class="method">
|
303
|
-
<a href="StandupMD/EntryList.html#method-i-empty-3F">#empty?</a>
|
304
|
-
—
|
305
|
-
<span class="container">StandupMD::EntryList</span>
|
306
|
-
|
307
264
|
<li class="method">
|
308
265
|
<a href="StandupMD/File.html#method-i-exist-3F">#exist?</a>
|
309
266
|
—
|
@@ -324,11 +281,6 @@
|
|
324
281
|
—
|
325
282
|
<span class="container">StandupMD::EntryList</span>
|
326
283
|
|
327
|
-
<li class="method">
|
328
|
-
<a href="StandupMD/EntryList.html#method-i-first">#first</a>
|
329
|
-
—
|
330
|
-
<span class="container">StandupMD::EntryList</span>
|
331
|
-
|
332
284
|
<li class="method">
|
333
285
|
<a href="StandupMD/Config/File.html#method-i-header_depth-3D">#header_depth=</a>
|
334
286
|
—
|
@@ -339,11 +291,6 @@
|
|
339
291
|
—
|
340
292
|
<span class="container">StandupMD::Config::EntryList</span>
|
341
293
|
|
342
|
-
<li class="method">
|
343
|
-
<a href="StandupMD/EntryList.html#method-i-last">#last</a>
|
344
|
-
—
|
345
|
-
<span class="container">StandupMD::EntryList</span>
|
346
|
-
|
347
294
|
<li class="method">
|
348
295
|
<a href="StandupMD/File.html#method-i-load">#load</a>
|
349
296
|
—
|
@@ -374,30 +321,25 @@
|
|
374
321
|
—
|
375
322
|
<span class="container">StandupMD::Cli::Helpers</span>
|
376
323
|
|
377
|
-
<li class="method">
|
378
|
-
<a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
|
379
|
-
—
|
380
|
-
<span class="container">StandupMD::Config::Entry</span>
|
381
|
-
|
382
324
|
<li class="method">
|
383
325
|
<a href="StandupMD/Config/Cli.html#method-i-reset">#reset</a>
|
384
326
|
—
|
385
327
|
<span class="container">StandupMD::Config::Cli</span>
|
386
328
|
|
387
329
|
<li class="method">
|
388
|
-
<a href="StandupMD/Config/
|
330
|
+
<a href="StandupMD/Config/File.html#method-i-reset">#reset</a>
|
389
331
|
—
|
390
|
-
<span class="container">StandupMD::Config::
|
332
|
+
<span class="container">StandupMD::Config::File</span>
|
391
333
|
|
392
334
|
<li class="method">
|
393
|
-
<a href="StandupMD/Config/
|
335
|
+
<a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
|
394
336
|
—
|
395
|
-
<span class="container">StandupMD::Config::
|
337
|
+
<span class="container">StandupMD::Config::EntryList</span>
|
396
338
|
|
397
339
|
<li class="method">
|
398
|
-
<a href="StandupMD/
|
340
|
+
<a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
|
399
341
|
—
|
400
|
-
<span class="container">StandupMD::
|
342
|
+
<span class="container">StandupMD::Config::Entry</span>
|
401
343
|
|
402
344
|
<li class="method">
|
403
345
|
<a href="StandupMD/EntryList.html#method-i-sort">#sort</a>
|
@@ -419,26 +361,26 @@
|
|
419
361
|
—
|
420
362
|
<span class="container">StandupMD::Config::File</span>
|
421
363
|
|
422
|
-
<li class="method">
|
423
|
-
<a href="StandupMD/EntryList.html#method-i-to_h">#to_h</a>
|
424
|
-
—
|
425
|
-
<span class="container">StandupMD::EntryList</span>
|
426
|
-
|
427
364
|
<li class="method">
|
428
365
|
<a href="StandupMD/Entry.html#method-i-to_h">#to_h</a>
|
429
366
|
—
|
430
367
|
<span class="container">StandupMD::Entry</span>
|
431
368
|
|
432
369
|
<li class="method">
|
433
|
-
<a href="StandupMD/
|
370
|
+
<a href="StandupMD/EntryList.html#method-i-to_h">#to_h</a>
|
434
371
|
—
|
435
|
-
<span class="container">StandupMD::
|
372
|
+
<span class="container">StandupMD::EntryList</span>
|
436
373
|
|
437
374
|
<li class="method">
|
438
375
|
<a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
|
439
376
|
—
|
440
377
|
<span class="container">StandupMD::EntryList</span>
|
441
378
|
|
379
|
+
<li class="method">
|
380
|
+
<a href="StandupMD/Entry.html#method-i-to_json">#to_json</a>
|
381
|
+
—
|
382
|
+
<span class="container">StandupMD::Entry</span>
|
383
|
+
|
442
384
|
<li class="method">
|
443
385
|
<a href="StandupMD/File.html#method-i-write">#write</a>
|
444
386
|
—
|
@@ -448,14 +390,13 @@
|
|
448
390
|
<a href="StandupMD/Cli.html#method-i-write_file">#write_file</a>
|
449
391
|
—
|
450
392
|
<span class="container">StandupMD::Cli</span>
|
451
|
-
|
452
393
|
</ul>
|
453
394
|
</main>
|
454
395
|
|
455
396
|
|
456
397
|
<footer id="validator-badges" role="contentinfo">
|
457
398
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
458
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.
|
399
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
459
400
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
460
401
|
</footer>
|
461
402
|
|