standup_md 0.3.1 → 0.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +11 -9
- data/README.md +77 -43
- data/Rakefile +3 -1
- data/doc/README_md.html +63 -59
- data/doc/StandupMD.html +4 -23
- data/doc/StandupMD/Cli.html +11 -11
- data/doc/StandupMD/Cli/Helpers.html +8 -7
- data/doc/StandupMD/Config/Cli.html +29 -20
- data/doc/StandupMD/Config/Entry.html +26 -14
- data/doc/StandupMD/Config/EntryList.html +26 -11
- data/doc/StandupMD/Config/File.html +30 -26
- data/doc/StandupMD/Entry.html +1 -1
- data/doc/StandupMD/EntryList.html +116 -194
- data/doc/StandupMD/File.html +67 -25
- data/doc/StandupMD/Version.html +176 -0
- data/doc/created.rid +15 -15
- data/doc/index.html +62 -58
- 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 +66 -59
- data/lib/standup_md.rb +4 -3
- 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 +24 -23
- data/lib/standup_md/config/entry.rb +14 -9
- data/lib/standup_md/config/entry_list.rb +10 -5
- data/lib/standup_md/config/file.rb +26 -16
- data/lib/standup_md/entry.rb +2 -2
- data/lib/standup_md/entry_list.rb +24 -41
- data/lib/standup_md/file.rb +42 -15
- data/lib/standup_md/file/helpers.rb +13 -15
- data/lib/standup_md/version.rb +23 -6
- data/standup_md.gemspec +12 -16
- metadata +7 -6
|
@@ -0,0 +1,176 @@
|
|
|
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
|
+
|
|
25
|
+
|
|
26
|
+
<body id="top" role="document" class="module">
|
|
27
|
+
<nav role="navigation">
|
|
28
|
+
<div id="project-navigation">
|
|
29
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
30
|
+
<h2>
|
|
31
|
+
<a href="../index.html" rel="home">Home</a>
|
|
32
|
+
</h2>
|
|
33
|
+
|
|
34
|
+
<div id="table-of-contents-navigation">
|
|
35
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
36
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
37
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
42
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
43
|
+
<div id="search-field-wrapper">
|
|
44
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
45
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
46
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
47
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<ul id="search-results" aria-label="Search Results"
|
|
51
|
+
aria-busy="false" aria-expanded="false"
|
|
52
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
53
|
+
</form>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<div id="class-metadata">
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
<!-- Method Quickref -->
|
|
66
|
+
<div id="method-list-section" class="nav-section">
|
|
67
|
+
<h3>Methods</h3>
|
|
68
|
+
|
|
69
|
+
<ul class="link-list" role="directory">
|
|
70
|
+
|
|
71
|
+
<li ><a href="#method-c-to_s">::to_s</a>
|
|
72
|
+
|
|
73
|
+
</ul>
|
|
74
|
+
</div>
|
|
75
|
+
|
|
76
|
+
</div>
|
|
77
|
+
</nav>
|
|
78
|
+
|
|
79
|
+
<main role="main" aria-labelledby="module-StandupMD::Version">
|
|
80
|
+
<h1 id="module-StandupMD::Version" class="module">
|
|
81
|
+
module StandupMD::Version
|
|
82
|
+
</h1>
|
|
83
|
+
|
|
84
|
+
<section class="description">
|
|
85
|
+
|
|
86
|
+
<p>Module that contains all gem version information. Follows semantic versioning. Read: <a href="https://semver.org">semver.org</a>/</p>
|
|
87
|
+
|
|
88
|
+
</section>
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<section class="constants-list">
|
|
98
|
+
<header>
|
|
99
|
+
<h3>Constants</h3>
|
|
100
|
+
</header>
|
|
101
|
+
<dl>
|
|
102
|
+
|
|
103
|
+
<dt id="MAJOR">MAJOR
|
|
104
|
+
|
|
105
|
+
<dd><p>Major version.</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<dt id="MINOR">MINOR
|
|
109
|
+
|
|
110
|
+
<dd><p>Minor version.</p>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
<dt id="PATCH">PATCH
|
|
114
|
+
|
|
115
|
+
<dd><p>Patch version.</p>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</dl>
|
|
119
|
+
</section>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
126
|
+
<header>
|
|
127
|
+
<h3>Public Class Methods</h3>
|
|
128
|
+
</header>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<div id="method-c-to_s" class="method-detail ">
|
|
132
|
+
|
|
133
|
+
<div class="method-heading">
|
|
134
|
+
<span class="method-name">to_s</span><span
|
|
135
|
+
class="method-args">()</span>
|
|
136
|
+
|
|
137
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
138
|
+
|
|
139
|
+
</div>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<div class="method-description">
|
|
143
|
+
|
|
144
|
+
<p><a href="Version.html"><code>Version</code></a> as <code>MAJOR.MINOR.PATCH</code></p>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<div class="method-source-code" id="to_s-source">
|
|
150
|
+
<pre><span class="ruby-comment"># File lib/standup_md/version.rb, line 24</span>
|
|
151
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">to_s</span>
|
|
152
|
+
<span class="ruby-node">"#{MAJOR}.#{MINOR}.#{PATCH}"</span>
|
|
153
|
+
<span class="ruby-keyword">end</span></pre>
|
|
154
|
+
</div>
|
|
155
|
+
|
|
156
|
+
</div>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</div>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
</section>
|
|
165
|
+
|
|
166
|
+
</section>
|
|
167
|
+
|
|
168
|
+
</main>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<footer id="validator-badges" role="contentinfo">
|
|
172
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
173
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
|
|
174
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
175
|
+
</footer>
|
|
176
|
+
|
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
|
+
Mon, 12 Apr 2021 21:53:43 -0500
|
|
2
|
+
README.md Mon, 12 Apr 2021 21:53:19 -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 Tue, 13 Oct 2020 21:04:02 -0500
|
|
14
|
+
lib/standup_md/file/helpers.rb Tue, 13 Oct 2020 21:04:02 -0500
|
|
15
|
+
lib/standup_md/version.rb Thu, 25 Jun 2020 17:00:46 -0500
|
data/doc/index.html
CHANGED
|
@@ -94,6 +94,8 @@
|
|
|
94
94
|
|
|
95
95
|
<li><a href="./StandupMD/File.html">StandupMD::File</a>
|
|
96
96
|
|
|
97
|
+
<li><a href="./StandupMD/Version.html">StandupMD::Version</a>
|
|
98
|
+
|
|
97
99
|
</ul>
|
|
98
100
|
</div>
|
|
99
101
|
|
|
@@ -104,7 +106,7 @@
|
|
|
104
106
|
|
|
105
107
|
|
|
106
108
|
<h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+Standup+Doctor">¶</a> <a href="#top">↑</a></span></h1>
|
|
107
|
-
|
|
109
|
+
<!-- vi: set ts=4 sw=4 : -->
|
|
108
110
|
<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
111
|
|
|
110
112
|
<blockquote>
|
|
@@ -115,55 +117,16 @@
|
|
|
115
117
|
|
|
116
118
|
<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
119
|
|
|
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
120
|
<h2 id="label-About">About<span><a href="#label-About">¶</a> <a href="#top">↑</a></span></h2>
|
|
160
121
|
|
|
161
122
|
<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
123
|
|
|
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="#
|
|
124
|
+
<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
125
|
|
|
165
126
|
<h2 id="label-Installation">Installation<span><a href="#label-Installation">¶</a> <a href="#top">↑</a></span></h2>
|
|
166
127
|
|
|
128
|
+
<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>
|
|
129
|
+
|
|
167
130
|
<h3 id="label-Via+RubyGems">Via RubyGems<span><a href="#label-Via+RubyGems">¶</a> <a href="#top">↑</a></span></h3>
|
|
168
131
|
|
|
169
132
|
<p>Just install the gem!</p>
|
|
@@ -190,7 +153,7 @@ rake install</pre>
|
|
|
190
153
|
|
|
191
154
|
<h3 id="label-Command+Line">Command Line<span><a href="#label-Command+Line">¶</a> <a href="#top">↑</a></span></h3>
|
|
192
155
|
|
|
193
|
-
<p>For the most basic usage,
|
|
156
|
+
<p>For the most basic usage, simply call the executable.</p>
|
|
194
157
|
|
|
195
158
|
<pre class="ruby"><span class="ruby-identifier">standup</span>
|
|
196
159
|
</pre>
|
|
@@ -234,7 +197,7 @@ rake install</pre>
|
|
|
234
197
|
|
|
235
198
|
<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
199
|
|
|
237
|
-
<pre>standup --no-edit --current "Work on this thing","And another thing"
|
|
200
|
+
<pre>standup --no-edit --current "Work on this thing","And another thing"</pre>
|
|
238
201
|
|
|
239
202
|
<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
203
|
|
|
@@ -252,6 +215,8 @@ rake install</pre>
|
|
|
252
215
|
|
|
253
216
|
<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
217
|
|
|
218
|
+
<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>
|
|
219
|
+
|
|
255
220
|
<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
221
|
<span class="ruby-comment"># Defaults for how the file is formatted.</span>
|
|
257
222
|
<span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
|
|
@@ -288,8 +253,12 @@ rake install</pre>
|
|
|
288
253
|
<span class="ruby-keyword">end</span>
|
|
289
254
|
</pre>
|
|
290
255
|
|
|
256
|
+
<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>
|
|
257
|
+
|
|
291
258
|
<h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">¶</a> <a href="#top">↑</a></span></h4>
|
|
292
259
|
|
|
260
|
+
<p>Some of these options can be changed at runtime. They are as follows.</p>
|
|
261
|
+
|
|
293
262
|
<pre>--current ARRAY List of current entry's tasks
|
|
294
263
|
--previous ARRAY List of precious entry's tasks
|
|
295
264
|
--impediments ARRAY List of impediments for current entry
|
|
@@ -306,8 +275,6 @@ rake install</pre>
|
|
|
306
275
|
If DATE is passed, will print entry for DATE, if it exists.
|
|
307
276
|
DATE must be in the same format as file-name-format</pre>
|
|
308
277
|
|
|
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
278
|
<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
279
|
|
|
313
280
|
<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>
|
|
@@ -339,27 +306,28 @@ rake install</pre>
|
|
|
339
306
|
<p>Your <code>~/.standuprc</code> should contain:</p>
|
|
340
307
|
|
|
341
308
|
<pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
|
|
342
|
-
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span>
|
|
343
|
-
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_depth</span>
|
|
344
|
-
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span>
|
|
345
|
-
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span>
|
|
346
|
-
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span>
|
|
347
|
-
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span>
|
|
348
|
-
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span>
|
|
349
|
-
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span>
|
|
309
|
+
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span> = <span class="ruby-value">2</span>
|
|
310
|
+
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_depth</span> = <span class="ruby-value">3</span>
|
|
311
|
+
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">'Today'</span>
|
|
312
|
+
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">previous_header</span> = <span class="ruby-string">'Yesterday'</span>
|
|
313
|
+
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">impediments_header</span> = <span class="ruby-string">'Hold-ups'</span>
|
|
314
|
+
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span> = <span class="ruby-string">'*'</span>
|
|
315
|
+
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span> = <span class="ruby-string">'%m/%d/%Y'</span>
|
|
316
|
+
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span> = <span class="ruby-node">%w[current previous impediments notes]</span>
|
|
350
317
|
<span class="ruby-keyword">end</span>
|
|
351
318
|
</pre>
|
|
352
319
|
|
|
353
320
|
<h2 id="label-API">API<span><a href="#label-API">¶</a> <a href="#top">↑</a></span></h2>
|
|
354
321
|
|
|
355
|
-
<p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">
|
|
322
|
+
<p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">RDoc Documentation</a>.</p>
|
|
356
323
|
|
|
357
324
|
<p>This was mainly written as a command line utility, but the API is ridiculously robust, and is available for use in your own projects. A quick example of how to write a new entry via code could look like the following:</p>
|
|
358
325
|
|
|
359
326
|
<h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">¶</a> <a href="#top">↑</a></span></h3>
|
|
360
327
|
|
|
328
|
+
<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>
|
|
329
|
+
|
|
361
330
|
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
|
362
|
-
<span class="ruby-identifier">require</span> <span class="ruby-string">'date'</span>
|
|
363
331
|
|
|
364
332
|
<span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
|
|
365
333
|
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">'Today'</span>,
|
|
@@ -374,7 +342,6 @@ rake install</pre>
|
|
|
374
342
|
<p>The above example was written as such to show how the different pieces of the API fit together. The code can actually be simplified to the following.</p>
|
|
375
343
|
|
|
376
344
|
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
|
377
|
-
<span class="ruby-identifier">require</span> <span class="ruby-string">'date'</span>
|
|
378
345
|
|
|
379
346
|
<span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
|
|
380
347
|
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">current_header</span> = <span class="ruby-string">'Today'</span>,
|
|
@@ -384,6 +351,43 @@ rake install</pre>
|
|
|
384
351
|
<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>
|
|
385
352
|
</pre>
|
|
386
353
|
|
|
354
|
+
<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>
|
|
355
|
+
|
|
356
|
+
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'standup_md'</span>
|
|
357
|
+
|
|
358
|
+
<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>)
|
|
359
|
+
<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>
|
|
360
|
+
<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>)
|
|
361
|
+
</pre>
|
|
362
|
+
|
|
363
|
+
<h2 id="label-Vim">Vim<span><a href="#label-Vim">¶</a> <a href="#top">↑</a></span></h2>
|
|
364
|
+
|
|
365
|
+
<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>
|
|
366
|
+
|
|
367
|
+
<pre>if executable('standup')
|
|
368
|
+
command! -complete=custom,s:StandupCompletion -nargs=? -bang Standup
|
|
369
|
+
\ call s:OpenStandupFile(<bang>0, <f-args>)
|
|
370
|
+
endif
|
|
371
|
+
|
|
372
|
+
function! s:StandupCompletion(...) abort
|
|
373
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
|
374
|
+
if !isdirectory(l:dir) | return '' | endif
|
|
375
|
+
let l:list = glob(l:dir . '*.md', 0, 1)
|
|
376
|
+
return join(map(l:list, "substitute(v:val, l:dir, '', '')"), "\n")
|
|
377
|
+
endfunction
|
|
378
|
+
|
|
379
|
+
function! s:OpenStandupFile(split, ...)
|
|
380
|
+
let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
|
|
381
|
+
let l:file = a:0 ? a:1 : get(g:, 'standup_file', strftime('%Y_%m.md'))
|
|
382
|
+
call system('standup --no-edit')
|
|
383
|
+
execute a:split ? 'vsplit' : 'split' l:dir . l:file
|
|
384
|
+
endfunction</pre>
|
|
385
|
+
|
|
386
|
+
<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>
|
|
387
|
+
|
|
388
|
+
<pre>g:standup_dir = $HOME . '/.cache/standup_md' " the directory where your file are
|
|
389
|
+
g:standup_file = strftime('%Y_%m.md') " the file format to use</pre>
|
|
390
|
+
|
|
387
391
|
<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>
|
|
388
392
|
|
|
389
393
|
<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>
|
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_config_file()","load_preferences()","loaded?()","new()","new()","new()","new()","new()","new()","new()","new()","new?()","preference_file_loaded?()","print()","reset_config()","reset_values()","reset_values()","reset_values()","reset_values()","size()","sort()","sort!()","sort_reverse()","sub_header_depth=()","to_h()","to_h()","to_json()","to_json()","write()","write_file()","readme"],"longSearchIndex":["standupmd","standupmd::cli","standupmd::cli::helpers","standupmd::config","standupmd::config::cli","standupmd::config::entry","standupmd::config::entrylist","standupmd::config::file","standupmd::entry","standupmd::entrylist","standupmd::file","standupmd::entrylist#<<()","standupmd::entry#<=>()","standupmd::config::file#bullet_character=()","standupmd::config()","standupmd::cli::config()","standupmd::entry::config()","standupmd::entrylist::config()","standupmd::file::config()","standupmd::config_file_loaded?()","standupmd::configure()","standupmd::entry::create()","standupmd::config::file#directory=()","standupmd::entrylist#each()","standupmd::cli#echo()","standupmd::cli::echo()","standupmd::cli#edit()","standupmd::entrylist#empty?()","standupmd::cli::execute()","standupmd::file#exist?()","standupmd::entrylist#filter()","standupmd::entrylist#filter!()","standupmd::entrylist#find()","standupmd::file::find()","standupmd::file::find_by_date()","standupmd::entrylist#first()","standupmd::config::file#header_depth=()","standupmd::config::entrylist#initalize()","standupmd::entrylist#last()","standupmd::file#load()","standupmd::load_config_file()","standupmd::cli#load_preferences()","standupmd::file#loaded?()","standupmd::cli::new()","standupmd::config::new()","standupmd::config::cli::new()","standupmd::config::entry::new()","standupmd::config::file::new()","standupmd::entry::new()","standupmd::entrylist::new()","standupmd::file::new()","standupmd::file#new?()","standupmd::cli#preference_file_loaded?()","standupmd::cli::helpers#print()","standupmd::reset_config()","standupmd::config::cli#reset_values()","standupmd::config::entry#reset_values()","standupmd::config::entrylist#reset_values()","standupmd::config::file#reset_values()","standupmd::entrylist#size()","standupmd::entrylist#sort()","standupmd::entrylist#sort!()","standupmd::entrylist#sort_reverse()","standupmd::config::file#sub_header_depth=()","standupmd::entry#to_h()","standupmd::entrylist#to_h()","standupmd::entry#to_json()","standupmd::entrylist#to_json()","standupmd::file#write()","standupmd::cli#write_file()",""],"info":[["StandupMD","","StandupMD.html","","<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>Shorthand for <code>StanupMD::Cli</code>\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-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_config","StandupMD","StandupMD.html#method-c-reset_config","()","<p>Reset all configuration values to their defaults.\n<p>@return [StandupMD::Config]\n"],["reset_values","StandupMD::Config::Cli","StandupMD/Config/Cli.html#method-i-reset_values","()","<p>Sets all config values back to their defaults.\n<p>@return [Boolean] true if successful\n"],["reset_values","StandupMD::Config::Entry","StandupMD/Config/Entry.html#method-i-reset_values","()","<p>Sets all config values back to their defaults.\n<p>@return [Boolean] true if successful\n"],["reset_values","StandupMD::Config::EntryList","StandupMD/Config/EntryList.html#method-i-reset_values","()","<p>Sets all config values back to their defaults.\n<p>@return [Boolean] true if successful\n"],["reset_values","StandupMD::Config::File","StandupMD/Config/File.html#method-i-reset_values","()","<p>Sets all config values back to their defaults.\n<p>@return [Boolean] true if successful\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
|
@@ -39,8 +39,6 @@
|
|
|
39
39
|
|
|
40
40
|
<li><a href="README_md.html#label-The+Standup+Doctor">The Standup Doctor</a>
|
|
41
41
|
|
|
42
|
-
<li><a href="README_md.html#label-Table+of+Contents">Table of Contents</a>
|
|
43
|
-
|
|
44
42
|
<li><a href="README_md.html#label-About">About</a>
|
|
45
43
|
|
|
46
44
|
<li><a href="README_md.html#label-Installation">Installation</a>
|
|
@@ -75,6 +73,12 @@
|
|
|
75
73
|
|
|
76
74
|
<li><a href="README_md.html#label-API+Examples">API Examples</a>
|
|
77
75
|
|
|
76
|
+
<li><a href="README_md.html#label-Adding+an+entry+for+today">Adding an entry for today</a>
|
|
77
|
+
|
|
78
|
+
<li><a href="README_md.html#label-Finding+a+past+entry">Finding a past entry</a>
|
|
79
|
+
|
|
80
|
+
<li><a href="README_md.html#label-Vim">Vim</a>
|
|
81
|
+
|
|
78
82
|
<li><a href="README_md.html#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
|
|
79
83
|
|
|
80
84
|
<li><a href="README_md.html#label-Self-Promotion">Self-Promotion</a>
|
|
@@ -137,6 +141,14 @@
|
|
|
137
141
|
<li class="class">
|
|
138
142
|
<a href="StandupMD/EntryList.html">StandupMD::EntryList</a>
|
|
139
143
|
|
|
144
|
+
<ul>
|
|
145
|
+
|
|
146
|
+
<li><a href="StandupMD/EntryList.html#5Buntitled-5D">Top Section</a>
|
|
147
|
+
|
|
148
|
+
<li><a href="StandupMD/EntryList.html#Delegators">Delegators</a>
|
|
149
|
+
|
|
150
|
+
</ul>
|
|
151
|
+
|
|
140
152
|
</li>
|
|
141
153
|
|
|
142
154
|
<li class="class">
|
|
@@ -144,20 +156,25 @@
|
|
|
144
156
|
|
|
145
157
|
</li>
|
|
146
158
|
|
|
159
|
+
<li class="module">
|
|
160
|
+
<a href="StandupMD/Version.html">StandupMD::Version</a>
|
|
161
|
+
|
|
162
|
+
</li>
|
|
163
|
+
|
|
147
164
|
</ul>
|
|
148
165
|
|
|
149
166
|
<h2 id="methods">Methods</h2>
|
|
150
167
|
<ul>
|
|
151
168
|
|
|
152
169
|
<li class="method">
|
|
153
|
-
<a href="StandupMD/
|
|
170
|
+
<a href="StandupMD/EntryList.html#method-c-config">::config</a>
|
|
154
171
|
—
|
|
155
|
-
<span class="container">StandupMD::
|
|
172
|
+
<span class="container">StandupMD::EntryList</span>
|
|
156
173
|
|
|
157
174
|
<li class="method">
|
|
158
|
-
<a href="StandupMD/
|
|
175
|
+
<a href="StandupMD/Entry.html#method-c-config">::config</a>
|
|
159
176
|
—
|
|
160
|
-
<span class="container">StandupMD::
|
|
177
|
+
<span class="container">StandupMD::Entry</span>
|
|
161
178
|
|
|
162
179
|
<li class="method">
|
|
163
180
|
<a href="StandupMD/Cli.html#method-c-config">::config</a>
|
|
@@ -165,14 +182,14 @@
|
|
|
165
182
|
<span class="container">StandupMD::Cli</span>
|
|
166
183
|
|
|
167
184
|
<li class="method">
|
|
168
|
-
<a href="StandupMD.html#method-c-config">::config</a>
|
|
185
|
+
<a href="StandupMD/File.html#method-c-config">::config</a>
|
|
169
186
|
—
|
|
170
|
-
<span class="container">StandupMD</span>
|
|
187
|
+
<span class="container">StandupMD::File</span>
|
|
171
188
|
|
|
172
189
|
<li class="method">
|
|
173
|
-
<a href="StandupMD
|
|
190
|
+
<a href="StandupMD.html#method-c-config">::config</a>
|
|
174
191
|
—
|
|
175
|
-
<span class="container">StandupMD
|
|
192
|
+
<span class="container">StandupMD</span>
|
|
176
193
|
|
|
177
194
|
<li class="method">
|
|
178
195
|
<a href="StandupMD.html#method-c-config_file_loaded-3F">::config_file_loaded?</a>
|
|
@@ -210,29 +227,29 @@
|
|
|
210
227
|
<span class="container">StandupMD::File</span>
|
|
211
228
|
|
|
212
229
|
<li class="method">
|
|
213
|
-
<a href="StandupMD.html#method-c-
|
|
230
|
+
<a href="StandupMD/File.html#method-c-load">::load</a>
|
|
214
231
|
—
|
|
215
|
-
<span class="container">StandupMD</span>
|
|
232
|
+
<span class="container">StandupMD::File</span>
|
|
216
233
|
|
|
217
234
|
<li class="method">
|
|
218
|
-
<a href="StandupMD
|
|
235
|
+
<a href="StandupMD.html#method-c-load_config_file">::load_config_file</a>
|
|
219
236
|
—
|
|
220
|
-
<span class="container">StandupMD
|
|
237
|
+
<span class="container">StandupMD</span>
|
|
221
238
|
|
|
222
239
|
<li class="method">
|
|
223
|
-
<a href="StandupMD/Config/
|
|
240
|
+
<a href="StandupMD/Config/Cli.html#method-c-new">::new</a>
|
|
224
241
|
—
|
|
225
|
-
<span class="container">StandupMD::Config::
|
|
242
|
+
<span class="container">StandupMD::Config::Cli</span>
|
|
226
243
|
|
|
227
244
|
<li class="method">
|
|
228
|
-
<a href="StandupMD/
|
|
245
|
+
<a href="StandupMD/Config.html#method-c-new">::new</a>
|
|
229
246
|
—
|
|
230
|
-
<span class="container">StandupMD::
|
|
247
|
+
<span class="container">StandupMD::Config</span>
|
|
231
248
|
|
|
232
249
|
<li class="method">
|
|
233
|
-
<a href="StandupMD/Config.html#method-c-new">::new</a>
|
|
250
|
+
<a href="StandupMD/Config/File.html#method-c-new">::new</a>
|
|
234
251
|
—
|
|
235
|
-
<span class="container">StandupMD::Config</span>
|
|
252
|
+
<span class="container">StandupMD::Config::File</span>
|
|
236
253
|
|
|
237
254
|
<li class="method">
|
|
238
255
|
<a href="StandupMD/Config/Entry.html#method-c-new">::new</a>
|
|
@@ -240,25 +257,35 @@
|
|
|
240
257
|
<span class="container">StandupMD::Config::Entry</span>
|
|
241
258
|
|
|
242
259
|
<li class="method">
|
|
243
|
-
<a href="StandupMD/
|
|
260
|
+
<a href="StandupMD/File.html#method-c-new">::new</a>
|
|
244
261
|
—
|
|
245
|
-
<span class="container">StandupMD::
|
|
262
|
+
<span class="container">StandupMD::File</span>
|
|
246
263
|
|
|
247
264
|
<li class="method">
|
|
248
|
-
<a href="StandupMD/
|
|
265
|
+
<a href="StandupMD/Cli.html#method-c-new">::new</a>
|
|
249
266
|
—
|
|
250
|
-
<span class="container">StandupMD::
|
|
267
|
+
<span class="container">StandupMD::Cli</span>
|
|
251
268
|
|
|
252
269
|
<li class="method">
|
|
253
270
|
<a href="StandupMD/Entry.html#method-c-new">::new</a>
|
|
254
271
|
—
|
|
255
272
|
<span class="container">StandupMD::Entry</span>
|
|
256
273
|
|
|
274
|
+
<li class="method">
|
|
275
|
+
<a href="StandupMD/EntryList.html#method-c-new">::new</a>
|
|
276
|
+
—
|
|
277
|
+
<span class="container">StandupMD::EntryList</span>
|
|
278
|
+
|
|
257
279
|
<li class="method">
|
|
258
280
|
<a href="StandupMD.html#method-c-reset_config">::reset_config</a>
|
|
259
281
|
—
|
|
260
282
|
<span class="container">StandupMD</span>
|
|
261
283
|
|
|
284
|
+
<li class="method">
|
|
285
|
+
<a href="StandupMD/Version.html#method-c-to_s">::to_s</a>
|
|
286
|
+
—
|
|
287
|
+
<span class="container">StandupMD::Version</span>
|
|
288
|
+
|
|
262
289
|
<li class="method">
|
|
263
290
|
<a href="StandupMD/EntryList.html#method-i-3C-3C">#<<</a>
|
|
264
291
|
—
|
|
@@ -270,19 +297,19 @@
|
|
|
270
297
|
<span class="container">StandupMD::Entry</span>
|
|
271
298
|
|
|
272
299
|
<li class="method">
|
|
273
|
-
<a href="StandupMD/
|
|
300
|
+
<a href="StandupMD/EntryList.html#method-i-40entries">#@entries</a>
|
|
274
301
|
—
|
|
275
|
-
<span class="container">StandupMD::
|
|
302
|
+
<span class="container">StandupMD::EntryList</span>
|
|
276
303
|
|
|
277
304
|
<li class="method">
|
|
278
|
-
<a href="StandupMD/Config/File.html#method-i-
|
|
305
|
+
<a href="StandupMD/Config/File.html#method-i-bullet_character-3D">#bullet_character=</a>
|
|
279
306
|
—
|
|
280
307
|
<span class="container">StandupMD::Config::File</span>
|
|
281
308
|
|
|
282
309
|
<li class="method">
|
|
283
|
-
<a href="StandupMD/
|
|
310
|
+
<a href="StandupMD/Config/File.html#method-i-directory-3D">#directory=</a>
|
|
284
311
|
—
|
|
285
|
-
<span class="container">StandupMD::
|
|
312
|
+
<span class="container">StandupMD::Config::File</span>
|
|
286
313
|
|
|
287
314
|
<li class="method">
|
|
288
315
|
<a href="StandupMD/Cli.html#method-i-echo">#echo</a>
|
|
@@ -294,11 +321,6 @@
|
|
|
294
321
|
—
|
|
295
322
|
<span class="container">StandupMD::Cli</span>
|
|
296
323
|
|
|
297
|
-
<li class="method">
|
|
298
|
-
<a href="StandupMD/EntryList.html#method-i-empty-3F">#empty?</a>
|
|
299
|
-
—
|
|
300
|
-
<span class="container">StandupMD::EntryList</span>
|
|
301
|
-
|
|
302
324
|
<li class="method">
|
|
303
325
|
<a href="StandupMD/File.html#method-i-exist-3F">#exist?</a>
|
|
304
326
|
—
|
|
@@ -319,11 +341,6 @@
|
|
|
319
341
|
—
|
|
320
342
|
<span class="container">StandupMD::EntryList</span>
|
|
321
343
|
|
|
322
|
-
<li class="method">
|
|
323
|
-
<a href="StandupMD/EntryList.html#method-i-first">#first</a>
|
|
324
|
-
—
|
|
325
|
-
<span class="container">StandupMD::EntryList</span>
|
|
326
|
-
|
|
327
344
|
<li class="method">
|
|
328
345
|
<a href="StandupMD/Config/File.html#method-i-header_depth-3D">#header_depth=</a>
|
|
329
346
|
—
|
|
@@ -334,11 +351,6 @@
|
|
|
334
351
|
—
|
|
335
352
|
<span class="container">StandupMD::Config::EntryList</span>
|
|
336
353
|
|
|
337
|
-
<li class="method">
|
|
338
|
-
<a href="StandupMD/EntryList.html#method-i-last">#last</a>
|
|
339
|
-
—
|
|
340
|
-
<span class="container">StandupMD::EntryList</span>
|
|
341
|
-
|
|
342
354
|
<li class="method">
|
|
343
355
|
<a href="StandupMD/File.html#method-i-load">#load</a>
|
|
344
356
|
—
|
|
@@ -370,29 +382,24 @@
|
|
|
370
382
|
<span class="container">StandupMD::Cli::Helpers</span>
|
|
371
383
|
|
|
372
384
|
<li class="method">
|
|
373
|
-
<a href="StandupMD/Config/
|
|
374
|
-
—
|
|
375
|
-
<span class="container">StandupMD::Config::File</span>
|
|
376
|
-
|
|
377
|
-
<li class="method">
|
|
378
|
-
<a href="StandupMD/Config/Cli.html#method-i-reset_values">#reset_values</a>
|
|
385
|
+
<a href="StandupMD/Config/Cli.html#method-i-reset">#reset</a>
|
|
379
386
|
—
|
|
380
387
|
<span class="container">StandupMD::Config::Cli</span>
|
|
381
388
|
|
|
382
389
|
<li class="method">
|
|
383
|
-
<a href="StandupMD/Config/
|
|
390
|
+
<a href="StandupMD/Config/File.html#method-i-reset">#reset</a>
|
|
384
391
|
—
|
|
385
|
-
<span class="container">StandupMD::Config::
|
|
392
|
+
<span class="container">StandupMD::Config::File</span>
|
|
386
393
|
|
|
387
394
|
<li class="method">
|
|
388
|
-
<a href="StandupMD/Config/EntryList.html#method-i-
|
|
395
|
+
<a href="StandupMD/Config/EntryList.html#method-i-reset">#reset</a>
|
|
389
396
|
—
|
|
390
397
|
<span class="container">StandupMD::Config::EntryList</span>
|
|
391
398
|
|
|
392
399
|
<li class="method">
|
|
393
|
-
<a href="StandupMD/
|
|
400
|
+
<a href="StandupMD/Config/Entry.html#method-i-reset">#reset</a>
|
|
394
401
|
—
|
|
395
|
-
<span class="container">StandupMD::
|
|
402
|
+
<span class="container">StandupMD::Config::Entry</span>
|
|
396
403
|
|
|
397
404
|
<li class="method">
|
|
398
405
|
<a href="StandupMD/EntryList.html#method-i-sort">#sort</a>
|
|
@@ -415,14 +422,14 @@
|
|
|
415
422
|
<span class="container">StandupMD::Config::File</span>
|
|
416
423
|
|
|
417
424
|
<li class="method">
|
|
418
|
-
<a href="StandupMD/
|
|
425
|
+
<a href="StandupMD/Entry.html#method-i-to_h">#to_h</a>
|
|
419
426
|
—
|
|
420
|
-
<span class="container">StandupMD::
|
|
427
|
+
<span class="container">StandupMD::Entry</span>
|
|
421
428
|
|
|
422
429
|
<li class="method">
|
|
423
|
-
<a href="StandupMD/
|
|
430
|
+
<a href="StandupMD/EntryList.html#method-i-to_h">#to_h</a>
|
|
424
431
|
—
|
|
425
|
-
<span class="container">StandupMD::
|
|
432
|
+
<span class="container">StandupMD::EntryList</span>
|
|
426
433
|
|
|
427
434
|
<li class="method">
|
|
428
435
|
<a href="StandupMD/EntryList.html#method-i-to_json">#to_json</a>
|