standup_md 0.3.4 → 0.3.9

Sign up to get free protection for your applications and to get access to all the features.
data/doc/StandupMD.html CHANGED
@@ -21,8 +21,6 @@
21
21
  <link href="./css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
-
26
24
  <body id="top" role="document" class="module">
27
25
  <nav role="navigation">
28
26
  <div id="project-navigation">
@@ -62,22 +60,17 @@
62
60
 
63
61
 
64
62
 
65
- <!-- Method Quickref -->
63
+
64
+ <!-- Method Quickref -->
66
65
  <div id="method-list-section" class="nav-section">
67
66
  <h3>Methods</h3>
68
67
 
69
68
  <ul class="link-list" role="directory">
70
-
71
69
  <li ><a href="#method-c-config">::config</a>
72
-
73
70
  <li ><a href="#method-c-config_file_loaded-3F">::config_file_loaded?</a>
74
-
75
71
  <li ><a href="#method-c-configure">::configure</a>
76
-
77
72
  <li ><a href="#method-c-load_config_file">::load_config_file</a>
78
-
79
73
  <li ><a href="#method-c-reset_config">::reset_config</a>
80
-
81
74
  </ul>
82
75
  </div>
83
76
 
@@ -95,230 +88,151 @@
95
88
 
96
89
  </section>
97
90
 
98
-
99
91
  <section id="5Buntitled-5D" class="documentation-section">
100
-
101
92
 
102
-
103
93
 
104
-
105
- <section class="constants-list">
106
- <header>
107
- <h3>Constants</h3>
108
- </header>
109
- <dl>
110
-
111
- <dt id="VERSION">VERSION
112
-
113
- <dd><p>The gem verision</p>
114
-
115
- <p>@return [String]</p>
116
-
117
-
118
- </dl>
119
- </section>
120
-
121
94
 
122
-
123
95
 
124
-
96
+
125
97
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
126
98
  <header>
127
99
  <h3>Public Class Methods</h3>
128
100
  </header>
129
101
 
130
-
131
102
  <div id="method-c-config" class="method-detail ">
132
-
133
103
  <div class="method-heading">
134
104
  <span class="method-name">config</span><span
135
105
  class="method-args">()</span>
136
-
137
106
  <span class="method-click-advice">click to toggle source</span>
138
-
139
107
  </div>
140
-
141
108
 
142
109
  <div class="method-description">
143
-
144
110
  <p>Method for accessing the configuration.</p>
145
111
 
146
112
  <p>@return [StanupMD::Cli]</p>
147
-
148
-
149
113
 
150
-
151
114
  <div class="method-source-code" id="config-source">
152
115
  <pre><span class="ruby-comment"># File lib/standup_md.rb, line 19</span>
153
116
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
154
- <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>
117
+ <span class="ruby-ivar">@config</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">reset_config</span>
155
118
  <span class="ruby-keyword">end</span></pre>
156
119
  </div>
157
-
158
120
  </div>
159
121
 
160
-
161
122
 
162
-
163
123
  </div>
164
124
 
165
-
166
125
  <div id="method-c-config_file_loaded-3F" class="method-detail ">
167
-
168
126
  <div class="method-heading">
169
127
  <span class="method-name">config_file_loaded?</span><span
170
128
  class="method-args">()</span>
171
-
172
129
  <span class="method-click-advice">click to toggle source</span>
173
-
174
130
  </div>
175
-
176
131
 
177
132
  <div class="method-description">
178
-
179
133
  <p>Has a config file been loaded?</p>
180
134
 
181
135
  <p>@return [Boolean]</p>
182
-
183
-
184
136
 
185
-
186
137
  <div class="method-source-code" id="config_file_loaded-3F-source">
187
138
  <pre><span class="ruby-comment"># File lib/standup_md.rb, line 44</span>
188
139
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config_file_loaded?</span>
189
140
  <span class="ruby-ivar">@config_file_loaded</span>
190
141
  <span class="ruby-keyword">end</span></pre>
191
142
  </div>
192
-
193
143
  </div>
194
144
 
195
-
196
145
 
197
-
198
146
  </div>
199
147
 
200
-
201
148
  <div id="method-c-configure" class="method-detail ">
202
-
203
149
  <div class="method-heading">
204
150
  <span class="method-name">configure</span><span
205
151
  class="method-args">() { |config| ... }</span>
206
-
207
152
  <span class="method-click-advice">click to toggle source</span>
208
-
209
153
  </div>
210
-
211
154
 
212
155
  <div class="method-description">
213
-
214
156
  <p>Allows for configuration via a block. Useful when making config files.</p>
215
157
 
216
158
  <p>@example</p>
217
159
 
218
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">&#39;mate&#39;</span> }
219
161
  </pre>
220
-
221
-
222
162
 
223
-
224
163
  <div class="method-source-code" id="configure-source">
225
164
  <pre><span class="ruby-comment"># File lib/standup_md.rb, line 36</span>
226
165
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">configure</span>
227
- <span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">config</span>
166
+ <span class="ruby-keyword">yield</span> <span class="ruby-identifier">config</span>
228
167
  <span class="ruby-keyword">end</span></pre>
229
168
  </div>
230
-
231
169
  </div>
232
170
 
233
-
234
171
 
235
-
236
172
  </div>
237
173
 
238
-
239
174
  <div id="method-c-load_config_file" class="method-detail ">
240
-
241
175
  <div class="method-heading">
242
176
  <span class="method-name">load_config_file</span><span
243
177
  class="method-args">(file)</span>
244
-
245
178
  <span class="method-click-advice">click to toggle source</span>
246
-
247
179
  </div>
248
-
249
180
 
250
181
  <div class="method-description">
251
-
252
182
  <p>Loads a config file.</p>
253
183
 
254
184
  <p>@param [String] file</p>
255
-
256
-
257
185
 
258
-
186
+ <p>@return [String] file</p>
187
+
259
188
  <div class="method-source-code" id="load_config_file-source">
260
- <pre><span class="ruby-comment"># File lib/standup_md.rb, line 52</span>
189
+ <pre><span class="ruby-comment"># File lib/standup_md.rb, line 54</span>
261
190
  <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>)
262
- <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>)
263
- <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{file} does not exist.&quot;</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>)
264
- <span class="ruby-ivar">@config_file_loaded</span> = <span class="ruby-keyword">true</span>
265
- <span class="ruby-identifier">load</span> <span class="ruby-identifier">file</span>
191
+ <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">file</span>).<span class="ruby-identifier">tap</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
192
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{file} does not exist.&quot;</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>)
193
+
194
+ <span class="ruby-ivar">@config_file_loaded</span> = <span class="ruby-keyword">true</span>
195
+ <span class="ruby-identifier">load</span> <span class="ruby-identifier">file</span>
196
+ <span class="ruby-keyword">end</span>
266
197
  <span class="ruby-keyword">end</span></pre>
267
198
  </div>
268
-
269
199
  </div>
270
200
 
271
-
272
201
 
273
-
274
202
  </div>
275
203
 
276
-
277
204
  <div id="method-c-reset_config" class="method-detail ">
278
-
279
205
  <div class="method-heading">
280
206
  <span class="method-name">reset_config</span><span
281
207
  class="method-args">()</span>
282
-
283
208
  <span class="method-click-advice">click to toggle source</span>
284
-
285
209
  </div>
286
-
287
210
 
288
211
  <div class="method-description">
289
-
290
212
  <p>Reset all configuration values to their defaults.</p>
291
213
 
292
214
  <p>@return [StandupMD::Config]</p>
293
-
294
-
295
215
 
296
-
297
216
  <div class="method-source-code" id="reset_config-source">
298
217
  <pre><span class="ruby-comment"># File lib/standup_md.rb, line 27</span>
299
218
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">reset_config</span>
300
219
  <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>
301
220
  <span class="ruby-keyword">end</span></pre>
302
221
  </div>
303
-
304
222
  </div>
305
223
 
306
-
307
224
 
308
-
309
225
  </div>
310
226
 
311
-
312
227
  </section>
313
-
314
- </section>
315
228
 
229
+ </section>
316
230
  </main>
317
231
 
318
232
 
319
233
  <footer id="validator-badges" role="contentinfo">
320
234
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
321
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
235
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
322
236
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
323
237
  </footer>
324
238
 
@@ -21,8 +21,6 @@
21
21
  <link href="../css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
-
26
24
  <body id="top" role="document" class="class">
27
25
  <nav role="navigation">
28
26
  <div id="project-navigation">
@@ -59,51 +57,38 @@
59
57
 
60
58
  <div id="class-metadata">
61
59
 
62
- <div id="parent-class-section" class="nav-section">
60
+
61
+ <div id="parent-class-section" class="nav-section">
63
62
  <h3>Parent</h3>
64
63
 
65
-
66
64
  <p class="link">Object
67
-
68
65
  </div>
69
66
 
70
- <div id="includes-section" class="nav-section">
67
+
68
+ <div id="includes-section" class="nav-section">
71
69
  <h3>Included Modules</h3>
72
70
 
73
71
  <ul class="link-list">
74
-
75
-
76
72
  <li><a class="include" href="Cli/Helpers.html">StandupMD::Cli::Helpers</a>
77
-
78
-
79
73
  </ul>
80
74
  </div>
81
75
 
82
76
 
83
- <!-- Method Quickref -->
77
+
78
+ <!-- Method Quickref -->
84
79
  <div id="method-list-section" class="nav-section">
85
80
  <h3>Methods</h3>
86
81
 
87
82
  <ul class="link-list" role="directory">
88
-
89
83
  <li ><a href="#method-c-config">::config</a>
90
-
91
84
  <li ><a href="#method-c-echo">::echo</a>
92
-
93
85
  <li ><a href="#method-c-execute">::execute</a>
94
-
95
86
  <li ><a href="#method-c-new">::new</a>
96
-
97
87
  <li ><a href="#method-i-echo">#echo</a>
98
-
99
88
  <li ><a href="#method-i-edit">#edit</a>
100
-
101
89
  <li ><a href="#method-i-load_preferences">#load_preferences</a>
102
-
103
90
  <li ><a href="#method-i-preference_file_loaded-3F">#preference_file_loaded?</a>
104
-
105
91
  <li ><a href="#method-i-write_file">#write_file</a>
106
-
107
92
  </ul>
108
93
  </div>
109
94
 
@@ -121,21 +106,15 @@
121
106
 
122
107
  </section>
123
108
 
124
-
125
109
  <section id="5Buntitled-5D" class="documentation-section">
126
-
127
110
 
128
-
129
111
 
130
-
131
112
 
132
-
133
113
  <section class="attribute-method-details" class="method-section">
134
114
  <header>
135
115
  <h3>Attributes</h3>
136
116
  </header>
137
117
 
138
-
139
118
  <div id="attribute-i-entry" class="method-detail">
140
119
  <div class="method-heading attribute-method-heading">
141
120
  <span class="method-name">entry</span><span
@@ -143,14 +122,11 @@
143
122
  </div>
144
123
 
145
124
  <div class="method-description">
146
-
147
125
  <p>The entry searched for, usually today.</p>
148
126
 
149
127
  <p>@return [StandupMD::Entry]</p>
150
-
151
128
  </div>
152
129
  </div>
153
-
154
130
  <div id="attribute-i-file" class="method-detail">
155
131
  <div class="method-heading attribute-method-heading">
156
132
  <span class="method-name">file</span><span
@@ -158,14 +134,11 @@
158
134
  </div>
159
135
 
160
136
  <div class="method-description">
161
-
162
137
  <p>The file loaded.</p>
163
138
 
164
139
  <p>@return [StandupMD::File]</p>
165
-
166
140
  </div>
167
141
  </div>
168
-
169
142
  <div id="attribute-i-options" class="method-detail">
170
143
  <div class="method-heading attribute-method-heading">
171
144
  <span class="method-name">options</span><span
@@ -173,277 +146,191 @@
173
146
  </div>
174
147
 
175
148
  <div class="method-description">
176
-
177
149
  <p>Arguments passed at runtime.</p>
178
150
 
179
151
  <p>@return [Array] ARGV</p>
180
-
181
152
  </div>
182
153
  </div>
183
-
184
154
  </section>
185
-
186
155
 
187
-
156
+
188
157
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
189
158
  <header>
190
159
  <h3>Public Class Methods</h3>
191
160
  </header>
192
161
 
193
-
194
162
  <div id="method-c-config" class="method-detail ">
195
-
196
163
  <div class="method-heading">
197
164
  <span class="method-name">config</span><span
198
165
  class="method-args">()</span>
199
-
200
166
  <span class="method-click-advice">click to toggle source</span>
201
-
202
167
  </div>
203
-
204
168
 
205
169
  <div class="method-description">
206
-
207
170
  <p>Access to the class&#39;s configuration.</p>
208
171
 
209
172
  <p>@return [StandupMD::Config::Cli]</p>
210
-
211
-
212
173
 
213
-
214
174
  <div class="method-source-code" id="config-source">
215
- <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 17</span>
175
+ <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 16</span>
216
176
  <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
217
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>
218
178
  <span class="ruby-keyword">end</span></pre>
219
179
  </div>
220
-
221
180
  </div>
222
181
 
223
-
224
182
 
225
-
226
183
  </div>
227
184
 
228
-
229
185
  <div id="method-c-echo" class="method-detail ">
230
-
231
186
  <div class="method-heading">
232
187
  <span class="method-name">echo</span><span
233
188
  class="method-args">(msg)</span>
234
-
235
189
  <span class="method-click-advice">click to toggle source</span>
236
-
237
190
  </div>
238
-
239
191
 
240
192
  <div class="method-description">
241
-
242
193
  <p>Prints output if <code>verbose</code> is true.</p>
243
194
 
244
195
  <p>@return [nil]</p>
245
-
246
-
247
196
 
248
-
249
197
  <div class="method-source-code" id="echo-source">
250
- <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 25</span>
198
+ <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 24</span>
251
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>)
252
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>
253
201
  <span class="ruby-keyword">end</span></pre>
254
202
  </div>
255
-
256
203
  </div>
257
204
 
258
-
259
205
 
260
-
261
206
  </div>
262
207
 
263
-
264
208
  <div id="method-c-execute" class="method-detail ">
265
-
266
209
  <div class="method-heading">
267
210
  <span class="method-name">execute</span><span
268
211
  class="method-args">(options = [])</span>
269
-
270
212
  <span class="method-click-advice">click to toggle source</span>
271
-
272
213
  </div>
273
-
274
214
 
275
215
  <div class="method-description">
276
-
277
216
  <p>Creates an instance of <code>StandupMD</code> and runs what the user requested.</p>
278
-
279
-
280
217
 
281
-
282
218
  <div class="method-source-code" id="execute-source">
283
- <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 31</span>
219
+ <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 30</span>
284
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> = [])
285
- <span class="ruby-identifier">exe</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
286
-
287
- <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>
288
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">print</span>
289
- <span class="ruby-identifier">exe</span>.<span class="ruby-identifier">print</span>(<span class="ruby-identifier">exe</span>.<span class="ruby-identifier">entry</span>)
290
- <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">edit</span>
291
- <span class="ruby-identifier">exe</span>.<span class="ruby-identifier">edit</span>
221
+ <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">tap</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">exe</span><span class="ruby-operator">|</span>
222
+ <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>
223
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">print</span>
224
+ <span class="ruby-identifier">exe</span>.<span class="ruby-identifier">print</span>(<span class="ruby-identifier">exe</span>.<span class="ruby-identifier">entry</span>)
225
+ <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">edit</span>
226
+ <span class="ruby-identifier">exe</span>.<span class="ruby-identifier">edit</span>
227
+ <span class="ruby-keyword">end</span>
292
228
  <span class="ruby-keyword">end</span>
293
229
  <span class="ruby-keyword">end</span></pre>
294
230
  </div>
295
-
296
231
  </div>
297
232
 
298
-
299
233
 
300
-
301
234
  </div>
302
235
 
303
-
304
236
  <div id="method-c-new" class="method-detail ">
305
-
306
237
  <div class="method-heading">
307
238
  <span class="method-name">new</span><span
308
239
  class="method-args">(options = [], load_config = true)</span>
309
-
310
240
  <span class="method-click-advice">click to toggle source</span>
311
-
312
241
  </div>
313
-
314
242
 
315
243
  <div class="method-description">
316
-
317
244
  <p>Constructor. Sets defaults.</p>
318
245
 
319
246
  <p>@param [Array] options</p>
320
-
321
-
322
247
 
323
-
324
248
  <div class="method-source-code" id="new-source">
325
- <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 64</span>
249
+ <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 63</span>
326
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>)
327
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>
328
252
  <span class="ruby-ivar">@preference_file_loaded</span> = <span class="ruby-keyword">false</span>
329
253
  <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
330
254
  <span class="ruby-identifier">load_preferences</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">load_config</span>
331
- <span class="ruby-identifier">set_preferences</span>(<span class="ruby-identifier">options</span>)
255
+ <span class="ruby-identifier">load_runtime_preferences</span>(<span class="ruby-identifier">options</span>)
332
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>)
333
257
  <span class="ruby-ivar">@file</span>.<span class="ruby-identifier">load</span>
334
- <span class="ruby-ivar">@entry</span> = <span class="ruby-identifier">set_entry</span>(<span class="ruby-ivar">@file</span>)
258
+ <span class="ruby-ivar">@entry</span> = <span class="ruby-identifier">new_entry</span>(<span class="ruby-ivar">@file</span>)
335
259
  <span class="ruby-keyword">end</span></pre>
336
260
  </div>
337
-
338
261
  </div>
339
262
 
340
-
341
263
 
342
-
343
264
  </div>
344
265
 
345
-
346
266
  </section>
347
-
267
+
348
268
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
349
269
  <header>
350
270
  <h3>Public Instance Methods</h3>
351
271
  </header>
352
272
 
353
-
354
273
  <div id="method-i-echo" class="method-detail ">
355
-
356
274
  <div class="method-heading">
357
275
  <span class="method-name">echo</span><span
358
276
  class="method-args">(msg)</span>
359
-
360
277
  <span class="method-click-advice">click to toggle source</span>
361
-
362
278
  </div>
363
-
364
279
 
365
280
  <div class="method-description">
366
-
367
281
  <p>Quick access to <a href="Cli.html#method-c-echo"><code>Cli.echo</code></a>.</p>
368
282
 
369
283
  <p>@return [nil]</p>
370
-
371
-
372
284
 
373
-
374
285
  <div class="method-source-code" id="echo-source">
375
- <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 118</span>
286
+ <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 117</span>
376
287
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">echo</span>(<span class="ruby-identifier">msg</span>)
377
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>)
378
289
  <span class="ruby-keyword">end</span></pre>
379
290
  </div>
380
-
381
291
  </div>
382
292
 
383
-
384
293
 
385
-
386
294
  </div>
387
295
 
388
-
389
296
  <div id="method-i-edit" class="method-detail ">
390
-
391
297
  <div class="method-heading">
392
298
  <span class="method-name">edit</span><span
393
299
  class="method-args">()</span>
394
-
395
300
  <span class="method-click-advice">click to toggle source</span>
396
-
397
301
  </div>
398
-
399
302
 
400
303
  <div class="method-description">
401
-
402
304
  <p>Opens the file in an editor. Abandons the script.</p>
403
305
 
404
306
  <p>@return [nil]</p>
405
-
406
-
407
307
 
408
-
409
308
  <div class="method-source-code" id="edit-source">
410
- <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 100</span>
309
+ <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 99</span>
411
310
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">edit</span>
412
311
  <span class="ruby-identifier">echo</span> <span class="ruby-node">&quot;Opening file in #{@config.editor}&quot;</span>
413
312
  <span class="ruby-identifier">exec</span>(<span class="ruby-node">&quot;#{@config.editor} #{file.name}&quot;</span>)
414
313
  <span class="ruby-keyword">end</span></pre>
415
314
  </div>
416
-
417
315
  </div>
418
316
 
419
-
420
317
 
421
-
422
318
  </div>
423
319
 
424
-
425
320
  <div id="method-i-load_preferences" class="method-detail ">
426
-
427
321
  <div class="method-heading">
428
322
  <span class="method-name">load_preferences</span><span
429
323
  class="method-args">()</span>
430
-
431
324
  <span class="method-click-advice">click to toggle source</span>
432
-
433
325
  </div>
434
-
435
326
 
436
327
  <div class="method-description">
437
-
438
328
  <p>Load the preference file.</p>
439
329
 
440
330
  <p>@return [nil]</p>
441
-
442
-
443
331
 
444
-
445
332
  <div class="method-source-code" id="load_preferences-source">
446
- <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 79</span>
333
+ <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 78</span>
447
334
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_preferences</span>
448
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>)
449
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>)
@@ -453,96 +340,67 @@
453
340
  <span class="ruby-keyword">end</span>
454
341
  <span class="ruby-keyword">end</span></pre>
455
342
  </div>
456
-
457
343
  </div>
458
344
 
459
-
460
345
 
461
-
462
346
  </div>
463
347
 
464
-
465
348
  <div id="method-i-preference_file_loaded-3F" class="method-detail ">
466
-
467
349
  <div class="method-heading">
468
350
  <span class="method-name">preference_file_loaded?</span><span
469
351
  class="method-args">()</span>
470
-
471
352
  <span class="method-click-advice">click to toggle source</span>
472
-
473
353
  </div>
474
-
475
354
 
476
355
  <div class="method-description">
477
-
478
356
  <p>Has the preference file been loaded?</p>
479
357
 
480
358
  <p>@return boolean</p>
481
-
482
-
483
359
 
484
-
485
360
  <div class="method-source-code" id="preference_file_loaded-3F-source">
486
- <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 92</span>
361
+ <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 91</span>
487
362
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">preference_file_loaded?</span>
488
363
  <span class="ruby-ivar">@preference_file_loaded</span>
489
364
  <span class="ruby-keyword">end</span></pre>
490
365
  </div>
491
-
492
366
  </div>
493
367
 
494
-
495
368
 
496
-
497
369
  </div>
498
370
 
499
-
500
371
  <div id="method-i-write_file" class="method-detail ">
501
-
502
372
  <div class="method-heading">
503
373
  <span class="method-name">write_file</span><span
504
374
  class="method-args">()</span>
505
-
506
375
  <span class="method-click-advice">click to toggle source</span>
507
-
508
376
  </div>
509
-
510
377
 
511
378
  <div class="method-description">
512
-
513
379
  <p>Writes entries to the file.</p>
514
380
 
515
381
  <p>@return [Boolean] true if file was written</p>
516
-
517
-
518
382
 
519
-
520
383
  <div class="method-source-code" id="write_file-source">
521
- <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 109</span>
384
+ <pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 108</span>
522
385
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_file</span>
523
386
  <span class="ruby-identifier">echo</span> <span class="ruby-node">&quot;Writing file #{file.name}&quot;</span>
524
387
  <span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>
525
388
  <span class="ruby-keyword">end</span></pre>
526
389
  </div>
527
-
528
390
  </div>
529
391
 
530
-
531
392
 
532
-
533
393
  </div>
534
394
 
535
-
536
395
  </section>
537
-
538
- </section>
539
396
 
397
+ </section>
540
398
  </main>
541
399
 
542
400
 
543
401
  <footer id="validator-badges" role="contentinfo">
544
402
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
545
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
403
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
546
404
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
547
405
  </footer>
548
406