standup_md 0.2.1 → 0.3.0

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.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/Gemfile.lock +7 -1
  4. data/README.md +142 -116
  5. data/bin/standup +1 -1
  6. data/doc/README_md.html +143 -96
  7. data/doc/StandupMD.html +96 -1322
  8. data/doc/StandupMD/Cli.html +124 -479
  9. data/doc/StandupMD/Cli/Helpers.html +167 -0
  10. data/doc/StandupMD/Config.html +230 -0
  11. data/doc/StandupMD/Config/Cli.html +355 -0
  12. data/doc/StandupMD/Config/Entry.html +284 -0
  13. data/doc/StandupMD/Config/EntryList.html +197 -0
  14. data/doc/StandupMD/Config/File.html +609 -0
  15. data/doc/StandupMD/Entry.html +478 -0
  16. data/doc/StandupMD/EntryList.html +759 -0
  17. data/doc/StandupMD/File.html +574 -0
  18. data/doc/created.rid +15 -5
  19. data/doc/index.html +153 -94
  20. data/doc/js/search_index.js +1 -1
  21. data/doc/js/search_index.js.gz +0 -0
  22. data/doc/table_of_contents.html +221 -72
  23. data/lib/standup_md.rb +27 -544
  24. data/lib/standup_md/cli.rb +63 -246
  25. data/lib/standup_md/cli/helpers.rb +165 -0
  26. data/lib/standup_md/config.rb +45 -0
  27. data/lib/standup_md/config/cli.rb +106 -0
  28. data/lib/standup_md/config/entry.rb +61 -0
  29. data/lib/standup_md/config/entry_list.rb +26 -0
  30. data/lib/standup_md/config/file.rb +199 -0
  31. data/lib/standup_md/entry.rb +121 -0
  32. data/lib/standup_md/entry_list.rb +166 -0
  33. data/lib/standup_md/file.rb +172 -0
  34. data/lib/standup_md/file/helpers.rb +62 -0
  35. data/lib/standup_md/version.rb +5 -3
  36. data/standup_md.gemspec +1 -0
  37. metadata +35 -2
data/doc/StandupMD/Cli/Helpers.html ADDED
@@ -0,0 +1,167 @@
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
+
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-i-print">#print</a>
72
+
73
+ </ul>
74
+ </div>
75
+
76
+ </div>
77
+ </nav>
78
+
79
+ <main role="main" aria-labelledby="module-StandupMD::Cli::Helpers">
80
+ <h1 id="module-StandupMD::Cli::Helpers" class="module">
81
+ module StandupMD::Cli::Helpers
82
+ </h1>
83
+
84
+ <section class="description">
85
+
86
+ <p>Module responsible for reading and writing standup files.</p>
87
+
88
+ </section>
89
+
90
+
91
+ <section id="5Buntitled-5D" class="documentation-section">
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
102
+ <header>
103
+ <h3>Public Instance Methods</h3>
104
+ </header>
105
+
106
+
107
+ <div id="method-i-print" class="method-detail ">
108
+
109
+ <div class="method-heading">
110
+ <span class="method-name">print</span><span
111
+ class="method-args">(entry)</span>
112
+
113
+ <span class="method-click-advice">click to toggle source</span>
114
+
115
+ </div>
116
+
117
+
118
+ <div class="method-description">
119
+
120
+ <p>Print an entry to the command line.</p>
121
+
122
+ <p>@param [StandupMD::Entry] entry</p>
123
+
124
+ <p>@return [nil]</p>
125
+
126
+
127
+
128
+
129
+ <div class="method-source-code" id="print-source">
130
+ <pre><span class="ruby-comment"># File lib/standup_md/cli/helpers.rb, line 16</span>
131
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print</span>(<span class="ruby-identifier">entry</span>)
132
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">nil?</span>
133
+ <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;No record found for #{StandupMD.config.cli.date}&quot;</span>
134
+ <span class="ruby-keyword">return</span>
135
+ <span class="ruby-keyword">end</span>
136
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;#&#39;</span> <span class="ruby-operator">*</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_depth</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39; &#39;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">header_date_format</span>)
137
+ <span class="ruby-constant">StandupMD</span>.<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">attr</span><span class="ruby-operator">|</span>
138
+ <span class="ruby-identifier">tasks</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">attr</span>)
139
+ <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>
140
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;#&#39;</span> <span class="ruby-operator">*</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub_header_depth</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39; &#39;</span> <span class="ruby-operator">+</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">file</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{attr}_header&quot;</span>).<span class="ruby-identifier">capitalize</span>
141
+ <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-constant">StandupMD</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">&#39; &#39;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">task</span> }
142
+ <span class="ruby-keyword">end</span>
143
+ <span class="ruby-identifier">puts</span>
144
+ <span class="ruby-keyword">end</span></pre>
145
+ </div>
146
+
147
+ </div>
148
+
149
+
150
+
151
+
152
+ </div>
153
+
154
+
155
+ </section>
156
+
157
+ </section>
158
+
159
+ </main>
160
+
161
+
162
+ <footer id="validator-badges" role="contentinfo">
163
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
164
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
165
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
166
+ </footer>
167
+
data/doc/StandupMD/Config.html ADDED
@@ -0,0 +1,230 @@
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
+
25
+
26
+ <body id="top" role="document" class="class">
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
+ <div id="parent-class-section" class="nav-section">
63
+ <h3>Parent</h3>
64
+
65
+
66
+ <p class="link">Object
67
+
68
+ </div>
69
+
70
+
71
+
72
+ <!-- Method Quickref -->
73
+ <div id="method-list-section" class="nav-section">
74
+ <h3>Methods</h3>
75
+
76
+ <ul class="link-list" role="directory">
77
+
78
+ <li ><a href="#method-c-new">::new</a>
79
+
80
+ </ul>
81
+ </div>
82
+
83
+ </div>
84
+ </nav>
85
+
86
+ <main role="main" aria-labelledby="class-StandupMD::Config">
87
+ <h1 id="class-StandupMD::Config" class="class">
88
+ class StandupMD::Config
89
+ </h1>
90
+
91
+ <section class="description">
92
+
93
+ <p>This class provides a connector from <a href="../StandupMD.html"><code>StandupMD</code></a> to the configuration classes.</p>
94
+
95
+ </section>
96
+
97
+
98
+ <section id="5Buntitled-5D" class="documentation-section">
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+ <section class="attribute-method-details" class="method-section">
107
+ <header>
108
+ <h3>Attributes</h3>
109
+ </header>
110
+
111
+
112
+ <div id="attribute-i-cli" class="method-detail">
113
+ <div class="method-heading attribute-method-heading">
114
+ <span class="method-name">cli</span><span
115
+ class="attribute-access-type">[R]</span>
116
+ </div>
117
+
118
+ <div class="method-description">
119
+
120
+ <p>Reader for <a href="Config/Cli.html"><code>Cli</code></a> config.</p>
121
+
122
+ <p>@return [StandupMD::Config::Cli]</p>
123
+
124
+ </div>
125
+ </div>
126
+
127
+ <div id="attribute-i-entry" class="method-detail">
128
+ <div class="method-heading attribute-method-heading">
129
+ <span class="method-name">entry</span><span
130
+ class="attribute-access-type">[R]</span>
131
+ </div>
132
+
133
+ <div class="method-description">
134
+
135
+ <p>Reader for <a href="Config/Entry.html"><code>Entry</code></a> config.</p>
136
+
137
+ <p>@return [StandupMD::Config::Entry]</p>
138
+
139
+ </div>
140
+ </div>
141
+
142
+ <div id="attribute-i-entry_list" class="method-detail">
143
+ <div class="method-heading attribute-method-heading">
144
+ <span class="method-name">entry_list</span><span
145
+ class="attribute-access-type">[R]</span>
146
+ </div>
147
+
148
+ <div class="method-description">
149
+
150
+ <p>Reader for <a href="Config/EntryList.html"><code>EntryList</code></a> config.</p>
151
+
152
+ <p>@return [StandupMD::Config::EntryList]</p>
153
+
154
+ </div>
155
+ </div>
156
+
157
+ <div id="attribute-i-file" class="method-detail">
158
+ <div class="method-heading attribute-method-heading">
159
+ <span class="method-name">file</span><span
160
+ class="attribute-access-type">[R]</span>
161
+ </div>
162
+
163
+ <div class="method-description">
164
+
165
+ <p>Reader for <a href="Config/File.html"><code>File</code></a> config.</p>
166
+
167
+ <p>@return [StandupMD::Config::File]</p>
168
+
169
+ </div>
170
+ </div>
171
+
172
+ </section>
173
+
174
+
175
+
176
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
177
+ <header>
178
+ <h3>Public Class Methods</h3>
179
+ </header>
180
+
181
+
182
+ <div id="method-c-new" class="method-detail ">
183
+
184
+ <div class="method-heading">
185
+ <span class="method-name">new</span><span
186
+ class="method-args">()</span>
187
+
188
+ <span class="method-click-advice">click to toggle source</span>
189
+
190
+ </div>
191
+
192
+
193
+ <div class="method-description">
194
+
195
+ <p>Builds the links to the configuration classes.</p>
196
+
197
+
198
+
199
+
200
+ <div class="method-source-code" id="new-source">
201
+ <pre><span class="ruby-comment"># File lib/standup_md/config.rb, line 38</span>
202
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
203
+ <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>
204
+ <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>
205
+ <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>
206
+ <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>
207
+ <span class="ruby-keyword">end</span></pre>
208
+ </div>
209
+
210
+ </div>
211
+
212
+
213
+
214
+
215
+ </div>
216
+
217
+
218
+ </section>
219
+
220
+ </section>
221
+
222
+ </main>
223
+
224
+
225
+ <footer id="validator-badges" role="contentinfo">
226
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
227
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
228
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
229
+ </footer>
230
+
data/doc/StandupMD/Config/Cli.html ADDED
@@ -0,0 +1,355 @@
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
+
25
+
26
+ <body id="top" role="document" class="class">
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
+ <div id="parent-class-section" class="nav-section">
63
+ <h3>Parent</h3>
64
+
65
+
66
+ <p class="link">Object
67
+
68
+ </div>
69
+
70
+
71
+
72
+ <!-- Method Quickref -->
73
+ <div id="method-list-section" class="nav-section">
74
+ <h3>Methods</h3>
75
+
76
+ <ul class="link-list" role="directory">
77
+
78
+ <li ><a href="#method-c-new">::new</a>
79
+
80
+ <li ><a href="#method-i-reset_values">#reset_values</a>
81
+
82
+ </ul>
83
+ </div>
84
+
85
+ </div>
86
+ </nav>
87
+
88
+ <main role="main" aria-labelledby="class-StandupMD::Config::Cli">
89
+ <h1 id="class-StandupMD::Config::Cli" class="class">
90
+ class StandupMD::Config::Cli
91
+ </h1>
92
+
93
+ <section class="description">
94
+
95
+ <p>The configuration class for <a href="../Cli.html"><code>StandupMD::Cli</code></a></p>
96
+
97
+ </section>
98
+
99
+
100
+ <section id="5Buntitled-5D" class="documentation-section">
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+ <section class="attribute-method-details" class="method-section">
109
+ <header>
110
+ <h3>Attributes</h3>
111
+ </header>
112
+
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
+
122
+ <p>When writing a new entry, should &#39;previous&#39; be pulled from the last entry?</p>
123
+
124
+ <p>@param [Boolean] <a href="Cli.html#attribute-i-auto_fill_previous"><code>auto_fill_previous</code></a></p>
125
+
126
+ <p>@return [Boolean]</p>
127
+
128
+ </div>
129
+ </div>
130
+
131
+ <div id="attribute-i-date" class="method-detail">
132
+ <div class="method-heading attribute-method-heading">
133
+ <span class="method-name">date</span><span
134
+ class="attribute-access-type">[RW]</span>
135
+ </div>
136
+
137
+ <div class="method-description">
138
+
139
+ <p>The date to use to find the file.</p>
140
+
141
+ <p>@param [Date] date</p>
142
+
143
+ <p>@return [Date]</p>
144
+
145
+ </div>
146
+ </div>
147
+
148
+ <div id="attribute-i-edit" class="method-detail">
149
+ <div class="method-heading attribute-method-heading">
150
+ <span class="method-name">edit</span><span
151
+ class="attribute-access-type">[RW]</span>
152
+ </div>
153
+
154
+ <div class="method-description">
155
+
156
+ <p>Should the cli edit?</p>
157
+
158
+ <p>@param [Boolean] edit</p>
159
+
160
+ <p>@return [Boolean]</p>
161
+
162
+ </div>
163
+ </div>
164
+
165
+ <div id="attribute-i-editor" class="method-detail">
166
+ <div class="method-heading attribute-method-heading">
167
+ <span class="method-name">editor</span><span
168
+ class="attribute-access-type">[RW]</span>
169
+ </div>
170
+
171
+ <div class="method-description">
172
+
173
+ <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>
174
+
175
+ <p>@param [String] editor</p>
176
+
177
+ <p>@return [String]</p>
178
+
179
+ </div>
180
+ </div>
181
+
182
+ <div id="attribute-i-preference_file" class="method-detail">
183
+ <div class="method-heading attribute-method-heading">
184
+ <span class="method-name">preference_file</span><span
185
+ class="attribute-access-type">[RW]</span>
186
+ </div>
187
+
188
+ <div class="method-description">
189
+
190
+ <p>The preference file for <a href="Cli.html"><code>Cli</code></a>.</p>
191
+
192
+ <p>@param [String] preference</p>
193
+
194
+ <p>@return [String]</p>
195
+
196
+ </div>
197
+ </div>
198
+
199
+ <div id="attribute-i-print" class="method-detail">
200
+ <div class="method-heading attribute-method-heading">
201
+ <span class="method-name">print</span><span
202
+ class="attribute-access-type">[RW]</span>
203
+ </div>
204
+
205
+ <div class="method-description">
206
+
207
+ <p>Should the cli print the entry?</p>
208
+
209
+ <p>@param [Boolean] print</p>
210
+
211
+ <p>@return [Boolean]</p>
212
+
213
+ </div>
214
+ </div>
215
+
216
+ <div id="attribute-i-verbose" class="method-detail">
217
+ <div class="method-heading attribute-method-heading">
218
+ <span class="method-name">verbose</span><span
219
+ class="attribute-access-type">[RW]</span>
220
+ </div>
221
+
222
+ <div class="method-description">
223
+
224
+ <p>Should the cli print verbose output?</p>
225
+
226
+ <p>@param [Boolean] verbose</p>
227
+
228
+ <p>@return [Boolean]</p>
229
+
230
+ </div>
231
+ </div>
232
+
233
+ <div id="attribute-i-write" class="method-detail">
234
+ <div class="method-heading attribute-method-heading">
235
+ <span class="method-name">write</span><span
236
+ class="attribute-access-type">[RW]</span>
237
+ </div>
238
+
239
+ <div class="method-description">
240
+
241
+ <p>Should the cli write the file?</p>
242
+
243
+ <p>@param [Boolean] write</p>
244
+
245
+ <p>@return [Boolean]</p>
246
+
247
+ </div>
248
+ </div>
249
+
250
+ </section>
251
+
252
+
253
+
254
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
255
+ <header>
256
+ <h3>Public Class Methods</h3>
257
+ </header>
258
+
259
+
260
+ <div id="method-c-new" class="method-detail ">
261
+
262
+ <div class="method-heading">
263
+ <span class="method-name">new</span><span
264
+ class="method-args">()</span>
265
+
266
+ <span class="method-click-advice">click to toggle source</span>
267
+
268
+ </div>
269
+
270
+
271
+ <div class="method-description">
272
+
273
+ <p>Initializes the config with default values.</p>
274
+
275
+
276
+
277
+
278
+ <div class="method-source-code" id="new-source">
279
+ <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 78</span>
280
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
281
+ <span class="ruby-identifier">reset_values</span>
282
+ <span class="ruby-keyword">end</span></pre>
283
+ </div>
284
+
285
+ </div>
286
+
287
+
288
+
289
+
290
+ </div>
291
+
292
+
293
+ </section>
294
+
295
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
296
+ <header>
297
+ <h3>Public Instance Methods</h3>
298
+ </header>
299
+
300
+
301
+ <div id="method-i-reset_values" class="method-detail ">
302
+
303
+ <div class="method-heading">
304
+ <span class="method-name">reset_values</span><span
305
+ class="method-args">()</span>
306
+
307
+ <span class="method-click-advice">click to toggle source</span>
308
+
309
+ </div>
310
+
311
+
312
+ <div class="method-description">
313
+
314
+ <p>Sets all config values back to their defaults.</p>
315
+
316
+ <p>@return [Boolean] true if successful</p>
317
+
318
+
319
+
320
+
321
+ <div class="method-source-code" id="reset_values-source">
322
+ <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 86</span>
323
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset_values</span>
324
+ <span class="ruby-ivar">@date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>
325
+ <span class="ruby-ivar">@editor</span> = <span class="ruby-identifier">set_editor</span>
326
+ <span class="ruby-ivar">@verbose</span> = <span class="ruby-keyword">false</span>
327
+ <span class="ruby-ivar">@edit</span> = <span class="ruby-keyword">true</span>
328
+ <span class="ruby-ivar">@write</span> = <span class="ruby-keyword">true</span>
329
+ <span class="ruby-ivar">@print</span> = <span class="ruby-keyword">false</span>
330
+ <span class="ruby-ivar">@auto_fill_previous</span> = <span class="ruby-keyword">true</span>
331
+ <span class="ruby-ivar">@preference_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>], <span class="ruby-string">&#39;.standuprc&#39;</span>))
332
+ <span class="ruby-keyword">end</span></pre>
333
+ </div>
334
+
335
+ </div>
336
+
337
+
338
+
339
+
340
+ </div>
341
+
342
+
343
+ </section>
344
+
345
+ </section>
346
+
347
+ </main>
348
+
349
+
350
+ <footer id="validator-badges" role="contentinfo">
351
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
352
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
353
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
354
+ </footer>
355
+