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
@@ -1,146 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
|
3
|
-
<html>
|
4
|
-
<head>
|
5
|
-
<meta charset="UTF-8">
|
6
|
-
|
7
|
-
<title>module StandupMD::Cli::Helpers - 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-i-print">#print</a>
|
70
|
-
</ul>
|
71
|
-
</div>
|
72
|
-
|
73
|
-
</div>
|
74
|
-
</nav>
|
75
|
-
|
76
|
-
<main role="main" aria-labelledby="module-StandupMD::Cli::Helpers">
|
77
|
-
<h1 id="module-StandupMD::Cli::Helpers" class="module">
|
78
|
-
module StandupMD::Cli::Helpers
|
79
|
-
</h1>
|
80
|
-
|
81
|
-
<section class="description">
|
82
|
-
|
83
|
-
<p>Module responsible for reading and writing standup files.</p>
|
84
|
-
|
85
|
-
</section>
|
86
|
-
|
87
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
94
|
-
<header>
|
95
|
-
<h3>Public Instance Methods</h3>
|
96
|
-
</header>
|
97
|
-
|
98
|
-
<div id="method-i-print" class="method-detail ">
|
99
|
-
<div class="method-heading">
|
100
|
-
<span class="method-name">print</span><span
|
101
|
-
class="method-args">(entry)</span>
|
102
|
-
<span class="method-click-advice">click to toggle source</span>
|
103
|
-
</div>
|
104
|
-
|
105
|
-
<div class="method-description">
|
106
|
-
<p>Print an entry to the command line.</p>
|
107
|
-
|
108
|
-
<p>@param [StandupMD::Entry] entry</p>
|
109
|
-
|
110
|
-
<p>@return [nil]</p>
|
111
|
-
|
112
|
-
<div class="method-source-code" id="print-source">
|
113
|
-
<pre><span class="ruby-comment"># File lib/standup_md/cli/helpers.rb, line 14</span>
|
114
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print</span>(<span class="ruby-identifier">entry</span>)
|
115
|
-
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">nil?</span>
|
116
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-node">"No record found for #{config.cli.date}"</span>
|
117
|
-
<span class="ruby-keyword">return</span>
|
118
|
-
<span class="ruby-keyword">end</span>
|
119
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-identifier">entry</span>)
|
120
|
-
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_order</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">header_type</span><span class="ruby-operator">|</span>
|
121
|
-
<span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">public_send</span>(<span class="ruby-identifier">header_type</span>)
|
122
|
-
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">tasks</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">empty?</span>
|
123
|
-
|
124
|
-
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">sub_header</span>(<span class="ruby-identifier">header_type</span>)
|
125
|
-
<span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> <span class="ruby-identifier">puts</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">bullet_character</span> <span class="ruby-operator">+</span> <span class="ruby-string">' '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">task</span> }
|
126
|
-
<span class="ruby-keyword">end</span>
|
127
|
-
<span class="ruby-identifier">puts</span>
|
128
|
-
<span class="ruby-keyword">end</span></pre>
|
129
|
-
</div>
|
130
|
-
</div>
|
131
|
-
|
132
|
-
|
133
|
-
</div>
|
134
|
-
|
135
|
-
</section>
|
136
|
-
|
137
|
-
</section>
|
138
|
-
</main>
|
139
|
-
|
140
|
-
|
141
|
-
<footer id="validator-badges" role="contentinfo">
|
142
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
143
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
144
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
145
|
-
</footer>
|
146
|
-
|
data/doc/StandupMD/Config.html
DELETED
@@ -1,193 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
|
3
|
-
<html>
|
4
|
-
<head>
|
5
|
-
<meta charset="UTF-8">
|
6
|
-
|
7
|
-
<title>class StandupMD::Config - 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
|
-
|
69
|
-
|
70
|
-
<!-- Method Quickref -->
|
71
|
-
<div id="method-list-section" class="nav-section">
|
72
|
-
<h3>Methods</h3>
|
73
|
-
|
74
|
-
<ul class="link-list" role="directory">
|
75
|
-
<li ><a href="#method-c-new">::new</a>
|
76
|
-
</ul>
|
77
|
-
</div>
|
78
|
-
|
79
|
-
</div>
|
80
|
-
</nav>
|
81
|
-
|
82
|
-
<main role="main" aria-labelledby="class-StandupMD::Config">
|
83
|
-
<h1 id="class-StandupMD::Config" class="class">
|
84
|
-
class StandupMD::Config
|
85
|
-
</h1>
|
86
|
-
|
87
|
-
<section class="description">
|
88
|
-
|
89
|
-
<p>This class provides a connector from <a href="../StandupMD.html"><code>StandupMD</code></a> to the configuration classes.</p>
|
90
|
-
|
91
|
-
</section>
|
92
|
-
|
93
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
<section class="attribute-method-details" class="method-section">
|
98
|
-
<header>
|
99
|
-
<h3>Attributes</h3>
|
100
|
-
</header>
|
101
|
-
|
102
|
-
<div id="attribute-i-cli" class="method-detail">
|
103
|
-
<div class="method-heading attribute-method-heading">
|
104
|
-
<span class="method-name">cli</span><span
|
105
|
-
class="attribute-access-type">[R]</span>
|
106
|
-
</div>
|
107
|
-
|
108
|
-
<div class="method-description">
|
109
|
-
<p>Reader for <a href="Config/Cli.html"><code>Cli</code></a> config.</p>
|
110
|
-
|
111
|
-
<p>@return [StandupMD::Config::Cli]</p>
|
112
|
-
</div>
|
113
|
-
</div>
|
114
|
-
<div id="attribute-i-entry" class="method-detail">
|
115
|
-
<div class="method-heading attribute-method-heading">
|
116
|
-
<span class="method-name">entry</span><span
|
117
|
-
class="attribute-access-type">[R]</span>
|
118
|
-
</div>
|
119
|
-
|
120
|
-
<div class="method-description">
|
121
|
-
<p>Reader for <a href="Config/Entry.html"><code>Entry</code></a> config.</p>
|
122
|
-
|
123
|
-
<p>@return [StandupMD::Config::Entry]</p>
|
124
|
-
</div>
|
125
|
-
</div>
|
126
|
-
<div id="attribute-i-entry_list" class="method-detail">
|
127
|
-
<div class="method-heading attribute-method-heading">
|
128
|
-
<span class="method-name">entry_list</span><span
|
129
|
-
class="attribute-access-type">[R]</span>
|
130
|
-
</div>
|
131
|
-
|
132
|
-
<div class="method-description">
|
133
|
-
<p>Reader for <a href="Config/EntryList.html"><code>EntryList</code></a> config.</p>
|
134
|
-
|
135
|
-
<p>@return [StandupMD::Config::EntryList]</p>
|
136
|
-
</div>
|
137
|
-
</div>
|
138
|
-
<div id="attribute-i-file" class="method-detail">
|
139
|
-
<div class="method-heading attribute-method-heading">
|
140
|
-
<span class="method-name">file</span><span
|
141
|
-
class="attribute-access-type">[R]</span>
|
142
|
-
</div>
|
143
|
-
|
144
|
-
<div class="method-description">
|
145
|
-
<p>Reader for <a href="Config/File.html"><code>File</code></a> config.</p>
|
146
|
-
|
147
|
-
<p>@return [StandupMD::Config::File]</p>
|
148
|
-
</div>
|
149
|
-
</div>
|
150
|
-
</section>
|
151
|
-
|
152
|
-
|
153
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
154
|
-
<header>
|
155
|
-
<h3>Public Class Methods</h3>
|
156
|
-
</header>
|
157
|
-
|
158
|
-
<div id="method-c-new" class="method-detail ">
|
159
|
-
<div class="method-heading">
|
160
|
-
<span class="method-name">new</span><span
|
161
|
-
class="method-args">()</span>
|
162
|
-
<span class="method-click-advice">click to toggle source</span>
|
163
|
-
</div>
|
164
|
-
|
165
|
-
<div class="method-description">
|
166
|
-
<p>Builds the links to the configuration classes.</p>
|
167
|
-
|
168
|
-
<div class="method-source-code" id="new-source">
|
169
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config.rb, line 38</span>
|
170
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
|
171
|
-
<span class="ruby-ivar">@cli</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">Cli</span>.<span class="ruby-identifier">new</span>
|
172
|
-
<span class="ruby-ivar">@file</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>
|
173
|
-
<span class="ruby-ivar">@entry</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">Entry</span>.<span class="ruby-identifier">new</span>
|
174
|
-
<span class="ruby-ivar">@entry_list</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">EntryList</span>.<span class="ruby-identifier">new</span>
|
175
|
-
<span class="ruby-keyword">end</span></pre>
|
176
|
-
</div>
|
177
|
-
</div>
|
178
|
-
|
179
|
-
|
180
|
-
</div>
|
181
|
-
|
182
|
-
</section>
|
183
|
-
|
184
|
-
</section>
|
185
|
-
</main>
|
186
|
-
|
187
|
-
|
188
|
-
<footer id="validator-badges" role="contentinfo">
|
189
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
190
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
191
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
192
|
-
</footer>
|
193
|
-
|
@@ -1,296 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
|
3
|
-
<html>
|
4
|
-
<head>
|
5
|
-
<meta charset="UTF-8">
|
6
|
-
|
7
|
-
<title>class StandupMD::Config::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
|
-
|
69
|
-
|
70
|
-
<!-- Method Quickref -->
|
71
|
-
<div id="method-list-section" class="nav-section">
|
72
|
-
<h3>Methods</h3>
|
73
|
-
|
74
|
-
<ul class="link-list" role="directory">
|
75
|
-
<li ><a href="#method-c-new">::new</a>
|
76
|
-
<li ><a href="#method-i-reset">#reset</a>
|
77
|
-
</ul>
|
78
|
-
</div>
|
79
|
-
|
80
|
-
</div>
|
81
|
-
</nav>
|
82
|
-
|
83
|
-
<main role="main" aria-labelledby="class-StandupMD::Config::Cli">
|
84
|
-
<h1 id="class-StandupMD::Config::Cli" class="class">
|
85
|
-
class StandupMD::Config::Cli
|
86
|
-
</h1>
|
87
|
-
|
88
|
-
<section class="description">
|
89
|
-
|
90
|
-
<p>The configuration class for <a href="../Cli.html"><code>StandupMD::Cli</code></a></p>
|
91
|
-
|
92
|
-
</section>
|
93
|
-
|
94
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
95
|
-
|
96
|
-
|
97
|
-
<section class="constants-list">
|
98
|
-
<header>
|
99
|
-
<h3>Constants</h3>
|
100
|
-
</header>
|
101
|
-
<dl>
|
102
|
-
<dt id="DEFAULTS">DEFAULTS
|
103
|
-
<dd><p>The default options.</p>
|
104
|
-
|
105
|
-
<p>@return [Hash]</p>
|
106
|
-
</dl>
|
107
|
-
</section>
|
108
|
-
|
109
|
-
<section class="attribute-method-details" class="method-section">
|
110
|
-
<header>
|
111
|
-
<h3>Attributes</h3>
|
112
|
-
</header>
|
113
|
-
|
114
|
-
<div id="attribute-i-auto_fill_previous" class="method-detail">
|
115
|
-
<div class="method-heading attribute-method-heading">
|
116
|
-
<span class="method-name">auto_fill_previous</span><span
|
117
|
-
class="attribute-access-type">[RW]</span>
|
118
|
-
</div>
|
119
|
-
|
120
|
-
<div class="method-description">
|
121
|
-
<p>When writing a new entry, should 'previous' be pulled from the last entry?</p>
|
122
|
-
|
123
|
-
<p>@param [Boolean] <a href="Cli.html#attribute-i-auto_fill_previous"><code>auto_fill_previous</code></a></p>
|
124
|
-
|
125
|
-
<p>@return [Boolean]</p>
|
126
|
-
</div>
|
127
|
-
</div>
|
128
|
-
<div id="attribute-i-date" class="method-detail">
|
129
|
-
<div class="method-heading attribute-method-heading">
|
130
|
-
<span class="method-name">date</span><span
|
131
|
-
class="attribute-access-type">[RW]</span>
|
132
|
-
</div>
|
133
|
-
|
134
|
-
<div class="method-description">
|
135
|
-
<p>The date to use to find the entry.</p>
|
136
|
-
|
137
|
-
<p>@param [Date] date</p>
|
138
|
-
|
139
|
-
<p>@return [Date]</p>
|
140
|
-
</div>
|
141
|
-
</div>
|
142
|
-
<div id="attribute-i-edit" class="method-detail">
|
143
|
-
<div class="method-heading attribute-method-heading">
|
144
|
-
<span class="method-name">edit</span><span
|
145
|
-
class="attribute-access-type">[RW]</span>
|
146
|
-
</div>
|
147
|
-
|
148
|
-
<div class="method-description">
|
149
|
-
<p>Should the cli edit?</p>
|
150
|
-
|
151
|
-
<p>@param [Boolean] edit</p>
|
152
|
-
|
153
|
-
<p>@return [Boolean]</p>
|
154
|
-
</div>
|
155
|
-
</div>
|
156
|
-
<div id="attribute-i-editor" class="method-detail">
|
157
|
-
<div class="method-heading attribute-method-heading">
|
158
|
-
<span class="method-name">editor</span><span
|
159
|
-
class="attribute-access-type">[RW]</span>
|
160
|
-
</div>
|
161
|
-
|
162
|
-
<div class="method-description">
|
163
|
-
<p>The editor to use when opening standup files. If one is not set, the first of $VISUAL, $EDITOR, or vim will be used, in that order.</p>
|
164
|
-
|
165
|
-
<p>@param [String] editor</p>
|
166
|
-
|
167
|
-
<p>@return [String]</p>
|
168
|
-
</div>
|
169
|
-
</div>
|
170
|
-
<div id="attribute-i-preference_file" class="method-detail">
|
171
|
-
<div class="method-heading attribute-method-heading">
|
172
|
-
<span class="method-name">preference_file</span><span
|
173
|
-
class="attribute-access-type">[RW]</span>
|
174
|
-
</div>
|
175
|
-
|
176
|
-
<div class="method-description">
|
177
|
-
<p>The preference file for <a href="Cli.html"><code>Cli</code></a>.</p>
|
178
|
-
|
179
|
-
<p>@param [String] preference</p>
|
180
|
-
|
181
|
-
<p>@return [String]</p>
|
182
|
-
</div>
|
183
|
-
</div>
|
184
|
-
<div id="attribute-i-print" class="method-detail">
|
185
|
-
<div class="method-heading attribute-method-heading">
|
186
|
-
<span class="method-name">print</span><span
|
187
|
-
class="attribute-access-type">[RW]</span>
|
188
|
-
</div>
|
189
|
-
|
190
|
-
<div class="method-description">
|
191
|
-
<p>Should the cli print the entry to the command line?</p>
|
192
|
-
|
193
|
-
<p>@param [Boolean] print</p>
|
194
|
-
|
195
|
-
<p>@return [Boolean]</p>
|
196
|
-
</div>
|
197
|
-
</div>
|
198
|
-
<div id="attribute-i-verbose" class="method-detail">
|
199
|
-
<div class="method-heading attribute-method-heading">
|
200
|
-
<span class="method-name">verbose</span><span
|
201
|
-
class="attribute-access-type">[RW]</span>
|
202
|
-
</div>
|
203
|
-
|
204
|
-
<div class="method-description">
|
205
|
-
<p>Should the cli print verbose output?</p>
|
206
|
-
|
207
|
-
<p>@param [Boolean] verbose</p>
|
208
|
-
|
209
|
-
<p>@return [Boolean]</p>
|
210
|
-
</div>
|
211
|
-
</div>
|
212
|
-
<div id="attribute-i-write" class="method-detail">
|
213
|
-
<div class="method-heading attribute-method-heading">
|
214
|
-
<span class="method-name">write</span><span
|
215
|
-
class="attribute-access-type">[RW]</span>
|
216
|
-
</div>
|
217
|
-
|
218
|
-
<div class="method-description">
|
219
|
-
<p>Should the cli automatically write the new entry to the file?</p>
|
220
|
-
|
221
|
-
<p>@param [Boolean] write</p>
|
222
|
-
|
223
|
-
<p>@return [Boolean]</p>
|
224
|
-
</div>
|
225
|
-
</div>
|
226
|
-
</section>
|
227
|
-
|
228
|
-
|
229
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
230
|
-
<header>
|
231
|
-
<h3>Public Class Methods</h3>
|
232
|
-
</header>
|
233
|
-
|
234
|
-
<div id="method-c-new" class="method-detail ">
|
235
|
-
<div class="method-heading">
|
236
|
-
<span class="method-name">new</span><span
|
237
|
-
class="method-args">()</span>
|
238
|
-
<span class="method-click-advice">click to toggle source</span>
|
239
|
-
</div>
|
240
|
-
|
241
|
-
<div class="method-description">
|
242
|
-
<p>Initializes the config with default values.</p>
|
243
|
-
|
244
|
-
<div class="method-source-code" id="new-source">
|
245
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 94</span>
|
246
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
|
247
|
-
<span class="ruby-identifier">reset</span>
|
248
|
-
<span class="ruby-keyword">end</span></pre>
|
249
|
-
</div>
|
250
|
-
</div>
|
251
|
-
|
252
|
-
|
253
|
-
</div>
|
254
|
-
|
255
|
-
</section>
|
256
|
-
|
257
|
-
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
258
|
-
<header>
|
259
|
-
<h3>Public Instance Methods</h3>
|
260
|
-
</header>
|
261
|
-
|
262
|
-
<div id="method-i-reset" class="method-detail ">
|
263
|
-
<div class="method-heading">
|
264
|
-
<span class="method-name">reset</span><span
|
265
|
-
class="method-args">()</span>
|
266
|
-
<span class="method-click-advice">click to toggle source</span>
|
267
|
-
</div>
|
268
|
-
|
269
|
-
<div class="method-description">
|
270
|
-
<p>Sets all config values back to their defaults.</p>
|
271
|
-
|
272
|
-
<p>@return [Hash]</p>
|
273
|
-
|
274
|
-
<div class="method-source-code" id="reset-source">
|
275
|
-
<pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 102</span>
|
276
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
|
277
|
-
<span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">"@#{k}"</span>, <span class="ruby-identifier">v</span>) }
|
278
|
-
<span class="ruby-keyword">end</span></pre>
|
279
|
-
</div>
|
280
|
-
</div>
|
281
|
-
|
282
|
-
|
283
|
-
</div>
|
284
|
-
|
285
|
-
</section>
|
286
|
-
|
287
|
-
</section>
|
288
|
-
</main>
|
289
|
-
|
290
|
-
|
291
|
-
<footer id="validator-badges" role="contentinfo">
|
292
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
293
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
|
294
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
295
|
-
</footer>
|
296
|
-
|