standup_md 0.3.4 → 0.3.9
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 +61 -44
- data/Rakefile +3 -1
- data/doc/README_md.html +55 -62
- data/doc/StandupMD.html +16 -102
- data/doc/StandupMD/Cli.html +28 -170
- data/doc/StandupMD/Cli/Helpers.html +13 -34
- data/doc/StandupMD/Config.html +7 -44
- data/doc/StandupMD/Config/Cli.html +10 -78
- data/doc/StandupMD/Config/Entry.html +10 -66
- data/doc/StandupMD/Config/EntryList.html +7 -48
- data/doc/StandupMD/Config/File.html +17 -149
- data/doc/StandupMD/Entry.html +23 -134
- data/doc/StandupMD/EntryList.html +94 -354
- 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 +53 -74
- 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 +46 -106
- data/lib/standup_md.rb +10 -6
- data/lib/standup_md/cli.rb +9 -10
- data/lib/standup_md/cli/helpers.rb +71 -44
- data/lib/standup_md/config.rb +0 -2
- data/lib/standup_md/config/cli.rb +2 -4
- data/lib/standup_md/config/entry.rb +2 -4
- data/lib/standup_md/config/file.rb +3 -3
- data/lib/standup_md/entry.rb +8 -11
- data/lib/standup_md/entry_list.rb +20 -37
- data/lib/standup_md/file.rb +31 -14
- data/lib/standup_md/file/helpers.rb +13 -15
- data/lib/standup_md/version.rb +22 -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 23</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
|
|
10
|
-
lib/standup_md/config/file.rb
|
|
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
|
+
Sat, 08 May 2021 00:03:30 -0500
|
|
2
|
+
README.md Fri, 07 May 2021 17:33:37 -0500
|
|
3
|
+
lib/standup_md.rb Fri, 07 May 2021 23:55:13 -0500
|
|
4
|
+
lib/standup_md/cli.rb Sat, 08 May 2021 00:01:31 -0500
|
|
5
|
+
lib/standup_md/cli/helpers.rb Fri, 07 May 2021 23:53:07 -0500
|
|
6
|
+
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 Fri, 07 May 2021 23:57:01 -0500
|
|
11
|
+
lib/standup_md/entry.rb Fri, 07 May 2021 23:57:15 -0500
|
|
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 Sat, 08 May 2021 00:03:13 -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>
|
|
@@ -230,17 +177,11 @@ rake install</pre>
|
|
|
230
177
|
<pre class="ruby"><span class="ruby-identifier">standup</span> <span class="ruby-operator">-</span><span class="ruby-identifier">p</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">pbcopy</span>
|
|
231
178
|
</pre>
|
|
232
179
|
|
|
233
|
-
<p>If you wanted to add today's entry without opening your editor, and print the result to the command line, you could use the following.</p>
|
|
234
|
-
|
|
235
180
|
<h4 id="label-Add+entry+to+file+without+opening+it">Add entry to file without opening it<span><a href="#label-Add+entry+to+file+without+opening+it">¶</a> <a href="#top">↑</a></span></h4>
|
|
236
181
|
|
|
237
|
-
<
|
|
238
|
-
|
|
239
|
-
<h4 id="label-Find+an+entry+by+date+and+print+it.">Find an entry by date and print it.<span><a href="#label-Find+an+entry+by+date+and+print+it.">¶</a> <a href="#top">↑</a></span></h4>
|
|
182
|
+
<p>You can add an entry for today without even opening your editor. Note that, if you have multiple entries, you must separate them with a comma and <em>no spaces</em>.</p>
|
|
240
183
|
|
|
241
|
-
<
|
|
242
|
-
|
|
243
|
-
<pre>standup -p 2020-03-02</pre>
|
|
184
|
+
<pre>standup --no-edit --current "Work on this thing","And another thing"</pre>
|
|
244
185
|
|
|
245
186
|
<h3 id="label-Customization+and+Runtime+Options">Customization and Runtime Options<span><a href="#label-Customization+and+Runtime+Options">¶</a> <a href="#top">↑</a></span></h3>
|
|
246
187
|
|
|
@@ -252,6 +193,8 @@ rake install</pre>
|
|
|
252
193
|
|
|
253
194
|
<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
195
|
|
|
196
|
+
<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>
|
|
197
|
+
|
|
255
198
|
<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
199
|
<span class="ruby-comment"># Defaults for how the file is formatted.</span>
|
|
257
200
|
<span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
|
|
@@ -288,8 +231,12 @@ rake install</pre>
|
|
|
288
231
|
<span class="ruby-keyword">end</span>
|
|
289
232
|
</pre>
|
|
290
233
|
|
|
234
|
+
<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>
|
|
235
|
+
|
|
291
236
|
<h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">¶</a> <a href="#top">↑</a></span></h4>
|
|
292
237
|
|
|
238
|
+
<p>Some of these options can be changed at runtime. They are as follows.</p>
|
|
239
|
+
|
|
293
240
|
<pre>--current ARRAY List of current entry's tasks
|
|
294
241
|
--previous ARRAY List of precious entry's tasks
|
|
295
242
|
--impediments ARRAY List of impediments for current entry
|
|
@@ -306,8 +253,6 @@ rake install</pre>
|
|
|
306
253
|
If DATE is passed, will print entry for DATE, if it exists.
|
|
307
254
|
DATE must be in the same format as file-name-format</pre>
|
|
308
255
|
|
|
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
256
|
<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
257
|
|
|
313
258
|
<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 +299,12 @@ rake install</pre>
|
|
|
354
299
|
|
|
355
300
|
<p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">RDoc Documentation</a>.</p>
|
|
356
301
|
|
|
357
|
-
<p>This was mainly written as a command line utility, but the API is
|
|
302
|
+
<p>This was mainly written as a command line utility, but the API is very robust, and is available for use in your own projects. A quick example of how to write a new entry via code could look like the following:</p>
|
|
358
303
|
|
|
359
304
|
<h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">¶</a> <a href="#top">↑</a></span></h3>
|
|
360
305
|
|
|
306
|
+
<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>
|
|
307
|
+
|
|
361
308
|
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
|
362
309
|
|
|
363
310
|
<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 +329,40 @@ rake install</pre>
|
|
|
382
329
|
<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
330
|
</pre>
|
|
384
331
|
|
|
332
|
+
<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>
|
|
333
|
+
|
|
334
|
+
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
|
335
|
+
|
|
336
|
+
<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>)
|
|
337
|
+
<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>
|
|
338
|
+
<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>)
|
|
339
|
+
</pre>
|
|
340
|
+
|
|
341
|
+
<h2 id="label-Vim">Vim<span><a href="#label-Vim">¶</a> <a href="#top">↑</a></span></h2>
|
|
342
|
+
|
|
343
|
+
<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>
|
|
344
|
+
|
|
345
|
+
<pre>command! -complete=custom,<SID>StandupCompletion -nargs=? -bang Standup
|
|
346
|
+
\ call <SID>OpenStandupFile(<bang>0, <f-args>)
|
|
347
|
+
|
|
348
|
+
function! s:StandupCompletion(...) abort
|
|
349
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
|
350
|
+
if !isdirectory(l:dir) | return '' | endif
|
|
351
|
+
return join(map(glob(l:dir . '*.md', 0, 1), "fnamemodify(v:val, ':t')"), "\n")
|
|
352
|
+
endfunction
|
|
353
|
+
|
|
354
|
+
function! s:OpenStandupFile(split, ...)
|
|
355
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
|
356
|
+
let l:file = a:0 ? a:1 : get(g:, 'standup_file', strftime('%Y_%m.md'))
|
|
357
|
+
call system('standup --no-edit')
|
|
358
|
+
execute a:split ? 'vsplit' : 'split' l:dir . l:file
|
|
359
|
+
endfunction</pre>
|
|
360
|
+
|
|
361
|
+
<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>
|
|
362
|
+
|
|
363
|
+
<pre>g:standup_dir = $HOME . '/.cache/standup_md' " the directory where your file are
|
|
364
|
+
g:standup_file = strftime('%Y_%m.md') " the file format to use</pre>
|
|
365
|
+
|
|
385
366
|
<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
367
|
|
|
387
368
|
<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 +371,12 @@ rake install</pre>
|
|
|
390
371
|
|
|
391
372
|
<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
373
|
|
|
393
|
-
|
|
394
374
|
</main>
|
|
395
375
|
|
|
396
376
|
|
|
397
|
-
|
|
398
377
|
<footer id="validator-badges" role="contentinfo">
|
|
399
378
|
<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.
|
|
379
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
|
401
380
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
402
381
|
</footer>
|
|
403
382
|
|
data/doc/js/navigation.js.gz
CHANGED
|
Binary file
|
data/doc/js/search_index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var search_data = {"index":{"searchIndex":["standupmd","cli","helpers","config","cli","entry","entrylist","file","entry","entrylist","file","<<()","<=>()","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 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::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 [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"],["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<p>@return [String] file\n"],["load_preferences","StandupMD::Cli","StandupMD/Cli.html#method-i-load_preferences","()","<p>Load the preference file.\n<p>@return [nil]\n"],["loaded?","StandupMD::File","StandupMD/File.html#method-i-loaded-3F","()","<p>Has the file been loaded?\n<p>@return [Boolean] true if loaded\n"],["new","StandupMD::Cli","StandupMD/Cli.html#method-c-new","(options = [], load_config = true)","<p>Constructor. Sets defaults.\n<p>@param [Array] options\n"],["new","StandupMD::Config","StandupMD/Config.html#method-c-new","()","<p>Builds the links to the configuration classes.\n"],["new","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Config::File","StandupMD/Config/File.html#method-c-new","()","<p>Initializes the config with default values.\n"],["new","StandupMD::Entry","StandupMD/Entry.html#method-c-new","(date, current, previous, impediments, notes = [])","<p>Constructs instance of <code>StandupMD::Entry</code>.\n<p>@param [Date] date\n<p>@param [Array] current\n"],["new","StandupMD::EntryList","StandupMD/EntryList.html#method-c-new","(*entries)","<p>Contruct a list. Can pass any amount of <code>StandupMD::Entry</code> instances.\n<p>@param [Entry] entries\n<p>@return [StandupMD::EntryList] …\n"],["new","StandupMD::File","StandupMD/File.html#method-c-new","(file_name)","<p>Constructs the instance.\n<p>@param [String] file_name\n<p>@return [StandupMP::File]\n"],["new?","StandupMD::File","StandupMD/File.html#method-i-new-3F","()","<p>Was the file just now created?\n<p>@return [Boolean] true if new\n"],["preference_file_loaded?","StandupMD::Cli","StandupMD/Cli.html#method-i-preference_file_loaded-3F","()","<p>Has the preference file been loaded?\n<p>@return boolean\n"],["print","StandupMD::Cli::Helpers","StandupMD/Cli/Helpers.html#method-i-print","(entry)","<p>Print an entry to the command line.\n<p>@param [StandupMD::Entry] entry\n<p>@return [nil]\n"],["reset","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset","StandupMD::Config::File","StandupMD/Config/File.html#method-i-reset","()","<p>Sets all config values back to their defaults.\n<p>@return [Hash]\n"],["reset_config","StandupMD","StandupMD.html#method-c-reset_config","()","<p>Reset all configuration values to their defaults.\n<p>@return [StandupMD::Config]\n"],["sort","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sort!","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort-21","()","<p>Replace entries with sorted entries by date.\n<p>@return [StandupMD::EntryList]\n"],["sort_reverse","StandupMD::EntryList","StandupMD/EntryList.html#method-i-sort_reverse","()","<p>Returns a copy of self sorted by date.\n<p>@return [StandupMD::EntryList]\n"],["sub_header_depth=","StandupMD::Config::File","StandupMD/Config/File.html#method-i-sub_header_depth-3D","(depth)","<p>Number of octothorps (#) to use before sub headers (Current, Previous, etc).\n<p>@param [Integer] depth\n<p>@return …\n"],["to_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,109 @@
|
|
|
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
|
-
<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
45
|
<li><a href="README_md.html#label-Customization+and+Runtime+Options">Customization and Runtime Options</a>
|
|
67
|
-
|
|
68
46
|
<li><a href="README_md.html#label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults</a>
|
|
69
|
-
|
|
70
47
|
<li><a href="README_md.html#label-Executable+Flags">Executable Flags</a>
|
|
71
|
-
|
|
72
48
|
<li><a href="README_md.html#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
|
|
73
|
-
|
|
74
49
|
<li><a href="README_md.html#label-API">API</a>
|
|
75
|
-
|
|
76
50
|
<li><a href="README_md.html#label-API+Examples">API Examples</a>
|
|
77
|
-
|
|
51
|
+
<li><a href="README_md.html#label-Adding+an+entry+for+today">Adding an entry for today</a>
|
|
52
|
+
<li><a href="README_md.html#label-Finding+a+past+entry">Finding a past entry</a>
|
|
53
|
+
<li><a href="README_md.html#label-Vim">Vim</a>
|
|
78
54
|
<li><a href="README_md.html#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
|
|
79
|
-
|
|
80
55
|
<li><a href="README_md.html#label-Self-Promotion">Self-Promotion</a>
|
|
81
|
-
|
|
82
56
|
</ul>
|
|
83
|
-
|
|
84
57
|
</li>
|
|
85
|
-
|
|
86
58
|
</ul>
|
|
87
59
|
|
|
88
|
-
|
|
89
60
|
<h2 id="classes">Classes and Modules</h2>
|
|
90
61
|
<ul>
|
|
91
|
-
|
|
92
62
|
<li class="module">
|
|
93
63
|
<a href="StandupMD.html">StandupMD</a>
|
|
94
|
-
|
|
95
64
|
</li>
|
|
96
|
-
|
|
97
65
|
<li class="class">
|
|
98
66
|
<a href="StandupMD/Cli.html">StandupMD::Cli</a>
|
|
99
|
-
|
|
100
67
|
</li>
|
|
101
|
-
|
|
102
68
|
<li class="module">
|
|
103
69
|
<a href="StandupMD/Cli/Helpers.html">StandupMD::Cli::Helpers</a>
|
|
104
|
-
|
|
105
70
|
</li>
|
|
106
|
-
|
|
107
71
|
<li class="class">
|
|
108
72
|
<a href="StandupMD/Config.html">StandupMD::Config</a>
|
|
109
|
-
|
|
110
73
|
</li>
|
|
111
|
-
|
|
112
74
|
<li class="class">
|
|
113
75
|
<a href="StandupMD/Config/Cli.html">StandupMD::Config::Cli</a>
|
|
114
|
-
|
|
115
76
|
</li>
|
|
116
|
-
|
|
117
77
|
<li class="class">
|
|
118
78
|
<a href="StandupMD/Config/Entry.html">StandupMD::Config::Entry</a>
|
|
119
|
-
|
|
120
79
|
</li>
|
|
121
|
-
|
|
122
80
|
<li class="class">
|
|
123
81
|
<a href="StandupMD/Config/EntryList.html">StandupMD::Config::EntryList</a>
|
|
124
|
-
|
|
125
82
|
</li>
|
|
126
|
-
|
|
127
83
|
<li class="class">
|
|
128
84
|
<a href="StandupMD/Config/File.html">StandupMD::Config::File</a>
|
|
129
|
-
|
|
130
85
|
</li>
|
|
131
|
-
|
|
132
86
|
<li class="class">
|
|
133
87
|
<a href="StandupMD/Entry.html">StandupMD::Entry</a>
|
|
134
|
-
|
|
135
88
|
</li>
|
|
136
|
-
|
|
137
89
|
<li class="class">
|
|
138
90
|
<a href="StandupMD/EntryList.html">StandupMD::EntryList</a>
|
|
139
91
|
|
|
92
|
+
<ul>
|
|
93
|
+
<li><a href="StandupMD/EntryList.html#5Buntitled-5D">Top Section</a>
|
|
94
|
+
<li><a href="StandupMD/EntryList.html#Delegators">Delegators</a>
|
|
95
|
+
</ul>
|
|
140
96
|
</li>
|
|
141
|
-
|
|
142
97
|
<li class="class">
|
|
143
98
|
<a href="StandupMD/File.html">StandupMD::File</a>
|
|
144
|
-
|
|
145
99
|
</li>
|
|
146
|
-
|
|
100
|
+
<li class="module">
|
|
101
|
+
<a href="StandupMD/Version.html">StandupMD::Version</a>
|
|
102
|
+
</li>
|
|
147
103
|
</ul>
|
|
148
104
|
|
|
149
105
|
<h2 id="methods">Methods</h2>
|
|
150
106
|
<ul>
|
|
151
107
|
|
|
152
108
|
<li class="method">
|
|
153
|
-
<a href="StandupMD/
|
|
109
|
+
<a href="StandupMD/EntryList.html#method-c-config">::config</a>
|
|
154
110
|
—
|
|
155
|
-
<span class="container">StandupMD::
|
|
111
|
+
<span class="container">StandupMD::EntryList</span>
|
|
156
112
|
|
|
157
113
|
<li class="method">
|
|
158
|
-
<a href="StandupMD/
|
|
114
|
+
<a href="StandupMD/Entry.html#method-c-config">::config</a>
|
|
159
115
|
—
|
|
160
|
-
<span class="container">StandupMD::
|
|
116
|
+
<span class="container">StandupMD::Entry</span>
|
|
161
117
|
|
|
162
118
|
<li class="method">
|
|
163
|
-
<a href="StandupMD/
|
|
119
|
+
<a href="StandupMD/Cli.html#method-c-config">::config</a>
|
|
164
120
|
—
|
|
165
|
-
<span class="container">StandupMD::
|
|
121
|
+
<span class="container">StandupMD::Cli</span>
|
|
166
122
|
|
|
167
123
|
<li class="method">
|
|
168
|
-
<a href="StandupMD/
|
|
124
|
+
<a href="StandupMD/File.html#method-c-config">::config</a>
|
|
169
125
|
—
|
|
170
|
-
<span class="container">StandupMD::
|
|
126
|
+
<span class="container">StandupMD::File</span>
|
|
171
127
|
|
|
172
128
|
<li class="method">
|
|
173
129
|
<a href="StandupMD.html#method-c-config">::config</a>
|
|
@@ -220,14 +176,9 @@
|
|
|
220
176
|
<span class="container">StandupMD</span>
|
|
221
177
|
|
|
222
178
|
<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>
|
|
179
|
+
<a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
|
|
229
180
|
—
|
|
230
|
-
<span class="container">StandupMD::Cli</span>
|
|
181
|
+
<span class="container">StandupMD::Config::Cli</span>
|
|
231
182
|
|
|
232
183
|
<li class="method">
|
|
233
184
|
<a href="StandupMD/Config.html#method-c-new">::new</a>
|
|
@@ -235,9 +186,9 @@
|
|
|
235
186
|
<span class="container">StandupMD::Config</span>
|
|
236
187
|
|
|
237
188
|
<li class="method">
|
|
238
|
-
<a href="StandupMD/Config/
|
|
189
|
+
<a href="StandupMD/Config/File.html#method-c-new">::new</a>
|
|
239
190
|
—
|
|
240
|
-
<span class="container">StandupMD::Config::
|
|
191
|
+
<span class="container">StandupMD::Config::File</span>
|
|
241
192
|
|
|
242
193
|
<li class="method">
|
|
243
194
|
<a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
|
|
@@ -249,6 +200,11 @@
|
|
|
249
200
|
—
|
|
250
201
|
<span class="container">StandupMD::File</span>
|
|
251
202
|
|
|
203
|
+
<li class="method">
|
|
204
|
+
<a href="StandupMD/Cli.html#method-c-new">::new</a>
|
|
205
|
+
—
|
|
206
|
+
<span class="container">StandupMD::Cli</span>
|
|
207
|
+
|
|
252
208
|
<li class="method">
|
|
253
209
|
<a href="StandupMD/Entry.html#method-c-new">::new</a>
|
|
254
210
|
—
|
|
@@ -264,6 +220,11 @@
|
|
|
264
220
|
—
|
|
265
221
|
<span class="container">StandupMD</span>
|
|
266
222
|
|
|
223
|
+
<li class="method">
|
|
224
|
+
<a href="StandupMD/Version.html#method-c-to_s">::to_s</a>
|
|
225
|
+
—
|
|
226
|
+
<span class="container">StandupMD::Version</span>
|
|
227
|
+
|
|
267
228
|
<li class="method">
|
|
268
229
|
<a href="StandupMD/EntryList.html#method-i-3C-3C">#<<</a>
|
|
269
230
|
—
|
|
@@ -275,19 +236,19 @@
|
|
|
275
236
|
<span class="container">StandupMD::Entry</span>
|
|
276
237
|
|
|
277
238
|
<li class="method">
|
|
278
|
-
<a href="StandupMD/
|
|
239
|
+
<a href="StandupMD/EntryList.html#method-i-40entries">#@entries</a>
|
|
279
240
|
—
|
|
280
|
-
<span class="container">StandupMD::
|
|
241
|
+
<span class="container">StandupMD::EntryList</span>
|
|
281
242
|
|
|
282
243
|
<li class="method">
|
|
283
|
-
<a href="StandupMD/Config/File.html#method-i-
|
|
244
|
+
<a href="StandupMD/Config/File.html#method-i-bullet_character-3D">#bullet_character=</a>
|
|
284
245
|
—
|
|
285
246
|
<span class="container">StandupMD::Config::File</span>
|
|
286
247
|
|
|
287
248
|
<li class="method">
|
|
288
|
-
<a href="StandupMD/
|
|
249
|
+
<a href="StandupMD/Config/File.html#method-i-directory-3D">#directory=</a>
|
|
289
250
|
—
|
|
290
|
-
<span class="container">StandupMD::
|
|
251
|
+
<span class="container">StandupMD::Config::File</span>
|
|
291
252
|
|
|
292
253
|
<li class="method">
|
|
293
254
|
<a href="StandupMD/Cli.html#method-i-echo">#echo</a>
|
|
@@ -299,11 +260,6 @@
|
|
|
299
260
|
—
|
|
300
261
|
<span class="container">StandupMD::Cli</span>
|
|
301
262
|
|
|
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
263
|
<li class="method">
|
|
308
264
|
<a href="StandupMD/File.html#method-i-exist-3F">#exist?</a>
|
|
309
265
|
—
|
|
@@ -324,11 +280,6 @@
|
|
|
324
280
|
—
|
|
325
281
|
<span class="container">StandupMD::EntryList</span>
|
|
326
282
|
|
|
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
283
|
<li class="method">
|
|
333
284
|
<a href="StandupMD/Config/File.html#method-i-header_depth-3D">#header_depth=</a>
|
|
334
285
|
—
|
|
@@ -339,11 +290,6 @@
|
|
|
339
290
|
—
|
|
340
291
|
<span class="container">StandupMD::Config::EntryList</span>
|
|
341
292
|
|
|
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
293
|
<li class="method">
|
|
348
294
|
<a href="StandupMD/File.html#method-i-load">#load</a>
|
|
349
295
|
—
|
|
@@ -374,11 +320,6 @@
|
|
|
374
320
|
—
|
|
375
321
|
<span class="container">StandupMD::Cli::Helpers</span>
|
|
376
322
|
|
|
377
|
-
<li class="method">
|
|
378
|
-
<a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
|
|
379
|
-
—
|
|
380
|
-
<span class="container">StandupMD::Config::EntryList</span>
|
|
381
|
-
|
|
382
323
|
<li class="method">
|
|
383
324
|
<a href="StandupMD/Config/Cli.html#method-i-reset">#reset</a>
|
|
384
325
|
—
|
|
@@ -390,14 +331,14 @@
|
|
|
390
331
|
<span class="container">StandupMD::Config::File</span>
|
|
391
332
|
|
|
392
333
|
<li class="method">
|
|
393
|
-
<a href="StandupMD/Config/
|
|
334
|
+
<a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
|
|
394
335
|
—
|
|
395
|
-
<span class="container">StandupMD::Config::
|
|
336
|
+
<span class="container">StandupMD::Config::EntryList</span>
|
|
396
337
|
|
|
397
338
|
<li class="method">
|
|
398
|
-
<a href="StandupMD/
|
|
339
|
+
<a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
|
|
399
340
|
—
|
|
400
|
-
<span class="container">StandupMD::
|
|
341
|
+
<span class="container">StandupMD::Config::Entry</span>
|
|
401
342
|
|
|
402
343
|
<li class="method">
|
|
403
344
|
<a href="StandupMD/EntryList.html#method-i-sort">#sort</a>
|
|
@@ -420,14 +361,14 @@
|
|
|
420
361
|
<span class="container">StandupMD::Config::File</span>
|
|
421
362
|
|
|
422
363
|
<li class="method">
|
|
423
|
-
<a href="StandupMD/
|
|
364
|
+
<a href="StandupMD/Entry.html#method-i-to_h">#to_h</a>
|
|
424
365
|
—
|
|
425
|
-
<span class="container">StandupMD::
|
|
366
|
+
<span class="container">StandupMD::Entry</span>
|
|
426
367
|
|
|
427
368
|
<li class="method">
|
|
428
|
-
<a href="StandupMD/
|
|
369
|
+
<a href="StandupMD/EntryList.html#method-i-to_h">#to_h</a>
|
|
429
370
|
—
|
|
430
|
-
<span class="container">StandupMD::
|
|
371
|
+
<span class="container">StandupMD::EntryList</span>
|
|
431
372
|
|
|
432
373
|
<li class="method">
|
|
433
374
|
<a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
|
|
@@ -448,14 +389,13 @@
|
|
|
448
389
|
<a href="StandupMD/Cli.html#method-i-write_file">#write_file</a>
|
|
449
390
|
—
|
|
450
391
|
<span class="container">StandupMD::Cli</span>
|
|
451
|
-
|
|
452
392
|
</ul>
|
|
453
393
|
</main>
|
|
454
394
|
|
|
455
395
|
|
|
456
396
|
<footer id="validator-badges" role="contentinfo">
|
|
457
397
|
<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.
|
|
398
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
|
459
399
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
460
400
|
</footer>
|
|
461
401
|
|