standup_md 0.3.7 → 0.3.12
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/Gemfile.lock +1 -1
- data/README.md +6 -16
- data/Rakefile +1 -1
- data/lib/standup_md.rb +8 -5
- data/lib/standup_md/cli.rb +7 -7
- data/lib/standup_md/cli/helpers.rb +10 -13
- data/lib/standup_md/config/file.rb +3 -3
- data/lib/standup_md/entry.rb +7 -9
- data/lib/standup_md/entry_list.rb +2 -2
- data/lib/standup_md/version.rb +26 -4
- data/standup_md.gemspec +1 -1
- metadata +3 -60
- data/doc/README_md.html +0 -400
- data/doc/StandupMD.html +0 -235
- data/doc/StandupMD/Cli.html +0 -406
- data/doc/StandupMD/Cli/Helpers.html +0 -146
- data/doc/StandupMD/Config.html +0 -193
- data/doc/StandupMD/Config/Cli.html +0 -296
- data/doc/StandupMD/Config/Entry.html +0 -240
- data/doc/StandupMD/Config/EntryList.html +0 -171
- data/doc/StandupMD/Config/File.html +0 -481
- data/doc/StandupMD/Entry.html +0 -369
- data/doc/StandupMD/EntryList.html +0 -499
- data/doc/StandupMD/File.html +0 -483
- data/doc/StandupMD/Version.html +0 -143
- data/doc/created.rid +0 -15
- data/doc/css/fonts.css +0 -167
- data/doc/css/rdoc.css +0 -619
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +0 -388
- data/doc/js/darkfish.js +0 -84
- data/doc/js/navigation.js +0 -105
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search.js +0 -110
- data/doc/js/search_index.js +0 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +0 -229
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +0 -402
data/doc/StandupMD.html
DELETED
|
@@ -1,235 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
|
|
3
|
-
<html>
|
|
4
|
-
<head>
|
|
5
|
-
<meta charset="UTF-8">
|
|
6
|
-
|
|
7
|
-
<title>module StandupMD - 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-config">::config</a>
|
|
70
|
-
<li ><a href="#method-c-config_file_loaded-3F">::config_file_loaded?</a>
|
|
71
|
-
<li ><a href="#method-c-configure">::configure</a>
|
|
72
|
-
<li ><a href="#method-c-load_config_file">::load_config_file</a>
|
|
73
|
-
<li ><a href="#method-c-reset_config">::reset_config</a>
|
|
74
|
-
</ul>
|
|
75
|
-
</div>
|
|
76
|
-
|
|
77
|
-
</div>
|
|
78
|
-
</nav>
|
|
79
|
-
|
|
80
|
-
<main role="main" aria-labelledby="module-StandupMD">
|
|
81
|
-
<h1 id="module-StandupMD" class="module">
|
|
82
|
-
module StandupMD
|
|
83
|
-
</h1>
|
|
84
|
-
|
|
85
|
-
<section class="description">
|
|
86
|
-
|
|
87
|
-
<p>The main module for the gem. Provides access to configuration classes.</p>
|
|
88
|
-
|
|
89
|
-
</section>
|
|
90
|
-
|
|
91
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
98
|
-
<header>
|
|
99
|
-
<h3>Public Class Methods</h3>
|
|
100
|
-
</header>
|
|
101
|
-
|
|
102
|
-
<div id="method-c-config" class="method-detail ">
|
|
103
|
-
<div class="method-heading">
|
|
104
|
-
<span class="method-name">config</span><span
|
|
105
|
-
class="method-args">()</span>
|
|
106
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
107
|
-
</div>
|
|
108
|
-
|
|
109
|
-
<div class="method-description">
|
|
110
|
-
<p>Method for accessing the configuration.</p>
|
|
111
|
-
|
|
112
|
-
<p>@return [StanupMD::Cli]</p>
|
|
113
|
-
|
|
114
|
-
<div class="method-source-code" id="config-source">
|
|
115
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 19</span>
|
|
116
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
|
|
117
|
-
<span class="ruby-ivar">@config</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>
|
|
118
|
-
<span class="ruby-keyword">end</span></pre>
|
|
119
|
-
</div>
|
|
120
|
-
</div>
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
</div>
|
|
124
|
-
|
|
125
|
-
<div id="method-c-config_file_loaded-3F" class="method-detail ">
|
|
126
|
-
<div class="method-heading">
|
|
127
|
-
<span class="method-name">config_file_loaded?</span><span
|
|
128
|
-
class="method-args">()</span>
|
|
129
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
130
|
-
</div>
|
|
131
|
-
|
|
132
|
-
<div class="method-description">
|
|
133
|
-
<p>Has a config file been loaded?</p>
|
|
134
|
-
|
|
135
|
-
<p>@return [Boolean]</p>
|
|
136
|
-
|
|
137
|
-
<div class="method-source-code" id="config_file_loaded-3F-source">
|
|
138
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 44</span>
|
|
139
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config_file_loaded?</span>
|
|
140
|
-
<span class="ruby-ivar">@config_file_loaded</span>
|
|
141
|
-
<span class="ruby-keyword">end</span></pre>
|
|
142
|
-
</div>
|
|
143
|
-
</div>
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
</div>
|
|
147
|
-
|
|
148
|
-
<div id="method-c-configure" class="method-detail ">
|
|
149
|
-
<div class="method-heading">
|
|
150
|
-
<span class="method-name">configure</span><span
|
|
151
|
-
class="method-args">() { |config| ... }</span>
|
|
152
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
153
|
-
</div>
|
|
154
|
-
|
|
155
|
-
<div class="method-description">
|
|
156
|
-
<p>Allows for configuration via a block. Useful when making config files.</p>
|
|
157
|
-
|
|
158
|
-
<p>@example</p>
|
|
159
|
-
|
|
160
|
-
<pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">editor</span> = <span class="ruby-string">'mate'</span> }
|
|
161
|
-
</pre>
|
|
162
|
-
|
|
163
|
-
<div class="method-source-code" id="configure-source">
|
|
164
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 36</span>
|
|
165
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">configure</span>
|
|
166
|
-
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">config</span>
|
|
167
|
-
<span class="ruby-keyword">end</span></pre>
|
|
168
|
-
</div>
|
|
169
|
-
</div>
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
</div>
|
|
173
|
-
|
|
174
|
-
<div id="method-c-load_config_file" class="method-detail ">
|
|
175
|
-
<div class="method-heading">
|
|
176
|
-
<span class="method-name">load_config_file</span><span
|
|
177
|
-
class="method-args">(file)</span>
|
|
178
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
179
|
-
</div>
|
|
180
|
-
|
|
181
|
-
<div class="method-description">
|
|
182
|
-
<p>Loads a config file.</p>
|
|
183
|
-
|
|
184
|
-
<p>@param [String] file</p>
|
|
185
|
-
|
|
186
|
-
<div class="method-source-code" id="load_config_file-source">
|
|
187
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 52</span>
|
|
188
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load_config_file</span>(<span class="ruby-identifier">file</span>)
|
|
189
|
-
<span class="ruby-identifier">file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">file</span>)
|
|
190
|
-
<span class="ruby-identifier">raise</span> <span class="ruby-node">"File #{file} does not exist."</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">file</span>)
|
|
191
|
-
|
|
192
|
-
<span class="ruby-ivar">@config_file_loaded</span> = <span class="ruby-keyword">true</span>
|
|
193
|
-
<span class="ruby-identifier">load</span> <span class="ruby-identifier">file</span>
|
|
194
|
-
<span class="ruby-keyword">end</span></pre>
|
|
195
|
-
</div>
|
|
196
|
-
</div>
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
</div>
|
|
200
|
-
|
|
201
|
-
<div id="method-c-reset_config" class="method-detail ">
|
|
202
|
-
<div class="method-heading">
|
|
203
|
-
<span class="method-name">reset_config</span><span
|
|
204
|
-
class="method-args">()</span>
|
|
205
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
206
|
-
</div>
|
|
207
|
-
|
|
208
|
-
<div class="method-description">
|
|
209
|
-
<p>Reset all configuration values to their defaults.</p>
|
|
210
|
-
|
|
211
|
-
<p>@return [StandupMD::Config]</p>
|
|
212
|
-
|
|
213
|
-
<div class="method-source-code" id="reset_config-source">
|
|
214
|
-
<pre><span class="ruby-comment"># File lib/standup_md.rb, line 27</span>
|
|
215
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">reset_config</span>
|
|
216
|
-
<span class="ruby-ivar">@config</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>
|
|
217
|
-
<span class="ruby-keyword">end</span></pre>
|
|
218
|
-
</div>
|
|
219
|
-
</div>
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
</div>
|
|
223
|
-
|
|
224
|
-
</section>
|
|
225
|
-
|
|
226
|
-
</section>
|
|
227
|
-
</main>
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
<footer id="validator-badges" role="contentinfo">
|
|
231
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
232
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
|
233
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
234
|
-
</footer>
|
|
235
|
-
|
data/doc/StandupMD/Cli.html
DELETED
|
@@ -1,406 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
|
|
3
|
-
<html>
|
|
4
|
-
<head>
|
|
5
|
-
<meta charset="UTF-8">
|
|
6
|
-
|
|
7
|
-
<title>class StandupMD::Cli - 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="class">
|
|
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
|
-
<div id="parent-class-section" class="nav-section">
|
|
62
|
-
<h3>Parent</h3>
|
|
63
|
-
|
|
64
|
-
<p class="link">Object
|
|
65
|
-
</div>
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
<div id="includes-section" class="nav-section">
|
|
69
|
-
<h3>Included Modules</h3>
|
|
70
|
-
|
|
71
|
-
<ul class="link-list">
|
|
72
|
-
<li><a class="include" href="Cli/Helpers.html">StandupMD::Cli::Helpers</a>
|
|
73
|
-
</ul>
|
|
74
|
-
</div>
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
<!-- Method Quickref -->
|
|
79
|
-
<div id="method-list-section" class="nav-section">
|
|
80
|
-
<h3>Methods</h3>
|
|
81
|
-
|
|
82
|
-
<ul class="link-list" role="directory">
|
|
83
|
-
<li ><a href="#method-c-config">::config</a>
|
|
84
|
-
<li ><a href="#method-c-echo">::echo</a>
|
|
85
|
-
<li ><a href="#method-c-execute">::execute</a>
|
|
86
|
-
<li ><a href="#method-c-new">::new</a>
|
|
87
|
-
<li ><a href="#method-i-echo">#echo</a>
|
|
88
|
-
<li ><a href="#method-i-edit">#edit</a>
|
|
89
|
-
<li ><a href="#method-i-load_preferences">#load_preferences</a>
|
|
90
|
-
<li ><a href="#method-i-preference_file_loaded-3F">#preference_file_loaded?</a>
|
|
91
|
-
<li ><a href="#method-i-write_file">#write_file</a>
|
|
92
|
-
</ul>
|
|
93
|
-
</div>
|
|
94
|
-
|
|
95
|
-
</div>
|
|
96
|
-
</nav>
|
|
97
|
-
|
|
98
|
-
<main role="main" aria-labelledby="class-StandupMD::Cli">
|
|
99
|
-
<h1 id="class-StandupMD::Cli" class="class">
|
|
100
|
-
class StandupMD::Cli
|
|
101
|
-
</h1>
|
|
102
|
-
|
|
103
|
-
<section class="description">
|
|
104
|
-
|
|
105
|
-
<p>Class for handing the command-line interface.</p>
|
|
106
|
-
|
|
107
|
-
</section>
|
|
108
|
-
|
|
109
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
<section class="attribute-method-details" class="method-section">
|
|
114
|
-
<header>
|
|
115
|
-
<h3>Attributes</h3>
|
|
116
|
-
</header>
|
|
117
|
-
|
|
118
|
-
<div id="attribute-i-entry" class="method-detail">
|
|
119
|
-
<div class="method-heading attribute-method-heading">
|
|
120
|
-
<span class="method-name">entry</span><span
|
|
121
|
-
class="attribute-access-type">[R]</span>
|
|
122
|
-
</div>
|
|
123
|
-
|
|
124
|
-
<div class="method-description">
|
|
125
|
-
<p>The entry searched for, usually today.</p>
|
|
126
|
-
|
|
127
|
-
<p>@return [StandupMD::Entry]</p>
|
|
128
|
-
</div>
|
|
129
|
-
</div>
|
|
130
|
-
<div id="attribute-i-file" class="method-detail">
|
|
131
|
-
<div class="method-heading attribute-method-heading">
|
|
132
|
-
<span class="method-name">file</span><span
|
|
133
|
-
class="attribute-access-type">[R]</span>
|
|
134
|
-
</div>
|
|
135
|
-
|
|
136
|
-
<div class="method-description">
|
|
137
|
-
<p>The file loaded.</p>
|
|
138
|
-
|
|
139
|
-
<p>@return [StandupMD::File]</p>
|
|
140
|
-
</div>
|
|
141
|
-
</div>
|
|
142
|
-
<div id="attribute-i-options" class="method-detail">
|
|
143
|
-
<div class="method-heading attribute-method-heading">
|
|
144
|
-
<span class="method-name">options</span><span
|
|
145
|
-
class="attribute-access-type">[R]</span>
|
|
146
|
-
</div>
|
|
147
|
-
|
|
148
|
-
<div class="method-description">
|
|
149
|
-
<p>Arguments passed at runtime.</p>
|
|
150
|
-
|
|
151
|
-
<p>@return [Array] ARGV</p>
|
|
152
|
-
</div>
|
|
153
|
-
</div>
|
|
154
|
-
</section>
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
158
|
-
<header>
|
|
159
|
-
<h3>Public Class Methods</h3>
|
|
160
|
-
</header>
|
|
161
|
-
|
|
162
|
-
<div id="method-c-config" class="method-detail ">
|
|
163
|
-
<div class="method-heading">
|
|
164
|
-
<span class="method-name">config</span><span
|
|
165
|
-
class="method-args">()</span>
|
|
166
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
167
|
-
</div>
|
|
168
|
-
|
|
169
|
-
<div class="method-description">
|
|
170
|
-
<p>Access to the class's configuration.</p>
|
|
171
|
-
|
|
172
|
-
<p>@return [StandupMD::Config::Cli]</p>
|
|
173
|
-
|
|
174
|
-
<div class="method-source-code" id="config-source">
|
|
175
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 16</span>
|
|
176
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
|
|
177
|
-
<span class="ruby-ivar">@config</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">cli</span>
|
|
178
|
-
<span class="ruby-keyword">end</span></pre>
|
|
179
|
-
</div>
|
|
180
|
-
</div>
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
</div>
|
|
184
|
-
|
|
185
|
-
<div id="method-c-echo" class="method-detail ">
|
|
186
|
-
<div class="method-heading">
|
|
187
|
-
<span class="method-name">echo</span><span
|
|
188
|
-
class="method-args">(msg)</span>
|
|
189
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
190
|
-
</div>
|
|
191
|
-
|
|
192
|
-
<div class="method-description">
|
|
193
|
-
<p>Prints output if <code>verbose</code> is true.</p>
|
|
194
|
-
|
|
195
|
-
<p>@return [nil]</p>
|
|
196
|
-
|
|
197
|
-
<div class="method-source-code" id="echo-source">
|
|
198
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 24</span>
|
|
199
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">echo</span>(<span class="ruby-identifier">msg</span>)
|
|
200
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">msg</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">verbose</span>
|
|
201
|
-
<span class="ruby-keyword">end</span></pre>
|
|
202
|
-
</div>
|
|
203
|
-
</div>
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
</div>
|
|
207
|
-
|
|
208
|
-
<div id="method-c-execute" class="method-detail ">
|
|
209
|
-
<div class="method-heading">
|
|
210
|
-
<span class="method-name">execute</span><span
|
|
211
|
-
class="method-args">(options = [])</span>
|
|
212
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
213
|
-
</div>
|
|
214
|
-
|
|
215
|
-
<div class="method-description">
|
|
216
|
-
<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.</p>
|
|
217
|
-
|
|
218
|
-
<div class="method-source-code" id="execute-source">
|
|
219
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 30</span>
|
|
220
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">execute</span>(<span class="ruby-identifier">options</span> = [])
|
|
221
|
-
<span class="ruby-identifier">exe</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
|
|
222
|
-
|
|
223
|
-
<span class="ruby-identifier">exe</span>.<span class="ruby-identifier">write_file</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">write</span>
|
|
224
|
-
<span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">print</span>
|
|
225
|
-
<span class="ruby-identifier">exe</span>.<span class="ruby-identifier">print</span>(<span class="ruby-identifier">exe</span>.<span class="ruby-identifier">entry</span>)
|
|
226
|
-
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">edit</span>
|
|
227
|
-
<span class="ruby-identifier">exe</span>.<span class="ruby-identifier">edit</span>
|
|
228
|
-
<span class="ruby-keyword">end</span>
|
|
229
|
-
<span class="ruby-keyword">end</span></pre>
|
|
230
|
-
</div>
|
|
231
|
-
</div>
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
</div>
|
|
235
|
-
|
|
236
|
-
<div id="method-c-new" class="method-detail ">
|
|
237
|
-
<div class="method-heading">
|
|
238
|
-
<span class="method-name">new</span><span
|
|
239
|
-
class="method-args">(options = [], load_config = true)</span>
|
|
240
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
241
|
-
</div>
|
|
242
|
-
|
|
243
|
-
<div class="method-description">
|
|
244
|
-
<p>Constructor. Sets defaults.</p>
|
|
245
|
-
|
|
246
|
-
<p>@param [Array] options</p>
|
|
247
|
-
|
|
248
|
-
<div class="method-source-code" id="new-source">
|
|
249
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 63</span>
|
|
250
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span> = [], <span class="ruby-identifier">load_config</span> = <span class="ruby-keyword">true</span>)
|
|
251
|
-
<span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
|
|
252
|
-
<span class="ruby-ivar">@preference_file_loaded</span> = <span class="ruby-keyword">false</span>
|
|
253
|
-
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
|
|
254
|
-
<span class="ruby-identifier">load_preferences</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">load_config</span>
|
|
255
|
-
<span class="ruby-identifier">load_runtime_preferences</span>(<span class="ruby-identifier">options</span>)
|
|
256
|
-
<span class="ruby-ivar">@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-ivar">@config</span>.<span class="ruby-identifier">date</span>)
|
|
257
|
-
<span class="ruby-ivar">@file</span>.<span class="ruby-identifier">load</span>
|
|
258
|
-
<span class="ruby-ivar">@entry</span> = <span class="ruby-identifier">new_entry</span>(<span class="ruby-ivar">@file</span>)
|
|
259
|
-
<span class="ruby-keyword">end</span></pre>
|
|
260
|
-
</div>
|
|
261
|
-
</div>
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
</div>
|
|
265
|
-
|
|
266
|
-
</section>
|
|
267
|
-
|
|
268
|
-
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
269
|
-
<header>
|
|
270
|
-
<h3>Public Instance Methods</h3>
|
|
271
|
-
</header>
|
|
272
|
-
|
|
273
|
-
<div id="method-i-echo" class="method-detail ">
|
|
274
|
-
<div class="method-heading">
|
|
275
|
-
<span class="method-name">echo</span><span
|
|
276
|
-
class="method-args">(msg)</span>
|
|
277
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
278
|
-
</div>
|
|
279
|
-
|
|
280
|
-
<div class="method-description">
|
|
281
|
-
<p>Quick access to <a href="Cli.html#method-c-echo"><code>Cli.echo</code></a>.</p>
|
|
282
|
-
|
|
283
|
-
<p>@return [nil]</p>
|
|
284
|
-
|
|
285
|
-
<div class="method-source-code" id="echo-source">
|
|
286
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 117</span>
|
|
287
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">echo</span>(<span class="ruby-identifier">msg</span>)
|
|
288
|
-
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">echo</span>(<span class="ruby-identifier">msg</span>)
|
|
289
|
-
<span class="ruby-keyword">end</span></pre>
|
|
290
|
-
</div>
|
|
291
|
-
</div>
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
</div>
|
|
295
|
-
|
|
296
|
-
<div id="method-i-edit" class="method-detail ">
|
|
297
|
-
<div class="method-heading">
|
|
298
|
-
<span class="method-name">edit</span><span
|
|
299
|
-
class="method-args">()</span>
|
|
300
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
301
|
-
</div>
|
|
302
|
-
|
|
303
|
-
<div class="method-description">
|
|
304
|
-
<p>Opens the file in an editor. Abandons the script.</p>
|
|
305
|
-
|
|
306
|
-
<p>@return [nil]</p>
|
|
307
|
-
|
|
308
|
-
<div class="method-source-code" id="edit-source">
|
|
309
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 99</span>
|
|
310
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">edit</span>
|
|
311
|
-
<span class="ruby-identifier">echo</span> <span class="ruby-node">"Opening file in #{@config.editor}"</span>
|
|
312
|
-
<span class="ruby-identifier">exec</span>(<span class="ruby-node">"#{@config.editor} #{file.name}"</span>)
|
|
313
|
-
<span class="ruby-keyword">end</span></pre>
|
|
314
|
-
</div>
|
|
315
|
-
</div>
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
</div>
|
|
319
|
-
|
|
320
|
-
<div id="method-i-load_preferences" class="method-detail ">
|
|
321
|
-
<div class="method-heading">
|
|
322
|
-
<span class="method-name">load_preferences</span><span
|
|
323
|
-
class="method-args">()</span>
|
|
324
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
325
|
-
</div>
|
|
326
|
-
|
|
327
|
-
<div class="method-description">
|
|
328
|
-
<p>Load the preference file.</p>
|
|
329
|
-
|
|
330
|
-
<p>@return [nil]</p>
|
|
331
|
-
|
|
332
|
-
<div class="method-source-code" id="load_preferences-source">
|
|
333
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 78</span>
|
|
334
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_preferences</span>
|
|
335
|
-
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">preference_file</span>)
|
|
336
|
-
<span class="ruby-operator">::</span><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load_config_file</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">preference_file</span>)
|
|
337
|
-
<span class="ruby-ivar">@preference_file_loaded</span> = <span class="ruby-keyword">true</span>
|
|
338
|
-
<span class="ruby-keyword">else</span>
|
|
339
|
-
<span class="ruby-identifier">echo</span> <span class="ruby-node">"Preference file #{@config.preference_file} does not exist."</span>
|
|
340
|
-
<span class="ruby-keyword">end</span>
|
|
341
|
-
<span class="ruby-keyword">end</span></pre>
|
|
342
|
-
</div>
|
|
343
|
-
</div>
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
</div>
|
|
347
|
-
|
|
348
|
-
<div id="method-i-preference_file_loaded-3F" class="method-detail ">
|
|
349
|
-
<div class="method-heading">
|
|
350
|
-
<span class="method-name">preference_file_loaded?</span><span
|
|
351
|
-
class="method-args">()</span>
|
|
352
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
353
|
-
</div>
|
|
354
|
-
|
|
355
|
-
<div class="method-description">
|
|
356
|
-
<p>Has the preference file been loaded?</p>
|
|
357
|
-
|
|
358
|
-
<p>@return boolean</p>
|
|
359
|
-
|
|
360
|
-
<div class="method-source-code" id="preference_file_loaded-3F-source">
|
|
361
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 91</span>
|
|
362
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">preference_file_loaded?</span>
|
|
363
|
-
<span class="ruby-ivar">@preference_file_loaded</span>
|
|
364
|
-
<span class="ruby-keyword">end</span></pre>
|
|
365
|
-
</div>
|
|
366
|
-
</div>
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
</div>
|
|
370
|
-
|
|
371
|
-
<div id="method-i-write_file" class="method-detail ">
|
|
372
|
-
<div class="method-heading">
|
|
373
|
-
<span class="method-name">write_file</span><span
|
|
374
|
-
class="method-args">()</span>
|
|
375
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
376
|
-
</div>
|
|
377
|
-
|
|
378
|
-
<div class="method-description">
|
|
379
|
-
<p>Writes entries to the file.</p>
|
|
380
|
-
|
|
381
|
-
<p>@return [Boolean] true if file was written</p>
|
|
382
|
-
|
|
383
|
-
<div class="method-source-code" id="write_file-source">
|
|
384
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 108</span>
|
|
385
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_file</span>
|
|
386
|
-
<span class="ruby-identifier">echo</span> <span class="ruby-node">"Writing file #{file.name}"</span>
|
|
387
|
-
<span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>
|
|
388
|
-
<span class="ruby-keyword">end</span></pre>
|
|
389
|
-
</div>
|
|
390
|
-
</div>
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
</div>
|
|
394
|
-
|
|
395
|
-
</section>
|
|
396
|
-
|
|
397
|
-
</section>
|
|
398
|
-
</main>
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
<footer id="validator-badges" role="contentinfo">
|
|
402
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
403
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
|
404
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
405
|
-
</footer>
|
|
406
|
-
|