rvvm 1.2.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +159 -5
- data/Rakefile +0 -6
- data/doc/Crayons.html +1206 -0
- data/doc/Rvvm/Error.html +148 -0
- data/doc/Rvvm.html +2258 -0
- data/doc/Templates.html +227 -0
- data/doc/Utils.html +991 -0
- data/doc/_index.html +161 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +503 -0
- data/doc/file.README.html +444 -0
- data/doc/file_list.html +59 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +444 -0
- data/doc/js/app.js +344 -0
- data/doc/js/full_list.js +242 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +334 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/rvvm/crayons.rb +8 -3
- data/lib/rvvm/utils.rb +2 -2
- data/lib/rvvm/version.rb +1 -1
- data/lib/rvvm.rb +5 -2
- data/sig/rvvm/crayons.rbs +12 -6
- data/sig/rvvm/utils.rbs +5 -5
- data/sig/rvvm.rbs +31 -5
- metadata +20 -1
data/doc/Crayons.html
ADDED
|
@@ -0,0 +1,1206 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: Crayons
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.37
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "Crayons";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (C)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Crayons</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: Crayons
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<dl>
|
|
80
|
+
<dt>Defined in:</dt>
|
|
81
|
+
<dd>lib/rvvm/crayons.rb</dd>
|
|
82
|
+
</dl>
|
|
83
|
+
|
|
84
|
+
</div>
|
|
85
|
+
|
|
86
|
+
<h2>Overview</h2><div class="docstring">
|
|
87
|
+
<div class="discussion">
|
|
88
|
+
<p>Utility module providing an API to run shell commands
|
|
89
|
+
with spinners and stdout mesage formatting.</p>
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
</div>
|
|
93
|
+
</div>
|
|
94
|
+
<div class="tags">
|
|
95
|
+
|
|
96
|
+
<div class="examples">
|
|
97
|
+
<h4 class="tag_title">Examples:</h4>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<pre class="example code"><code><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rvvm/crayons</span><span class='tstring_end'>'</span></span>
|
|
101
|
+
|
|
102
|
+
<span class='const'>Crayons</span><span class='period'>.</span><span class='id identifier rubyid_init'><span class='object_link'><a href="#init-class_method" title="Crayons.init (method)">init</a></span></span>
|
|
103
|
+
|
|
104
|
+
<span class='comment'># Runn a shell command with a spinner
|
|
105
|
+
</span><span class='const'>Crayons</span><span class='period'>.</span><span class='id identifier rubyid_command'><span class='object_link'><a href="#command-class_method" title="Crayons.command (method)">command</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Running command...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ls -aln</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
106
|
+
|
|
107
|
+
<span class='comment'># Run custom code with a spinner
|
|
108
|
+
</span><span class='const'>Crayons</span><span class='period'>.</span><span class='id identifier rubyid_spinner_start'><span class='object_link'><a href="#spinner_start-class_method" title="Crayons.spinner_start (method)">spinner_start</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>New task...</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
109
|
+
|
|
110
|
+
<span class='comment'># do stuff
|
|
111
|
+
</span>
|
|
112
|
+
<span class='const'>Crayons</span><span class='period'>.</span><span class='id identifier rubyid_spinner_log'><span class='object_link'><a href="#spinner_log-class_method" title="Crayons.spinner_log (method)">spinner_log</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Halfway done! ^^</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
113
|
+
|
|
114
|
+
<span class='comment'># do some more stuff
|
|
115
|
+
</span>
|
|
116
|
+
<span class='const'>Crayons</span><span class='period'>.</span><span class='id identifier rubyid_spinner_stop'><span class='object_link'><a href="#spinner_stop-class_method" title="Crayons.spinner_stop (method)">spinner_stop</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Completed!</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
117
|
+
<span class='const'>Crayons</span><span class='period'>.</span><span class='id identifier rubyid_log_pass'><span class='object_link'><a href="#log_pass-class_method" title="Crayons.log_pass (method)">log_pass</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Oof, im done now...</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
118
|
+
|
|
119
|
+
</div>
|
|
120
|
+
|
|
121
|
+
<p class="tag_title">Since:</p>
|
|
122
|
+
<ul class="since">
|
|
123
|
+
|
|
124
|
+
<li>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
<div class='inline'><p>1.0.0</p>
|
|
131
|
+
</div>
|
|
132
|
+
|
|
133
|
+
</li>
|
|
134
|
+
|
|
135
|
+
</ul>
|
|
136
|
+
|
|
137
|
+
</div>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<h2>
|
|
146
|
+
Class Method Summary
|
|
147
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
148
|
+
</h2>
|
|
149
|
+
|
|
150
|
+
<ul class="summary">
|
|
151
|
+
|
|
152
|
+
<li class="public ">
|
|
153
|
+
<span class="summary_signature">
|
|
154
|
+
|
|
155
|
+
<a href="#command-class_method" title="command (class method)">.<strong>command</strong>(tag, cmd, ignore_errors: false) ⇒ void </a>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</span>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class="summary_desc"><div class='inline'><p>Runs a shell command with a spinner.</p>
|
|
170
|
+
</div></span>
|
|
171
|
+
|
|
172
|
+
</li>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<li class="public ">
|
|
176
|
+
<span class="summary_signature">
|
|
177
|
+
|
|
178
|
+
<a href="#init-class_method" title="init (class method)">.<strong>init</strong> ⇒ void </a>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
</span>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<span class="summary_desc"><div class='inline'><p>Initializes Crayons module.</p>
|
|
193
|
+
</div></span>
|
|
194
|
+
|
|
195
|
+
</li>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<li class="public ">
|
|
199
|
+
<span class="summary_signature">
|
|
200
|
+
|
|
201
|
+
<a href="#log_error-class_method" title="log_error (class method)">.<strong>log_error</strong>(message) ⇒ void </a>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
</span>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<span class="summary_desc"><div class='inline'><p>Logs a red text message to stdout.</p>
|
|
216
|
+
</div></span>
|
|
217
|
+
|
|
218
|
+
</li>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<li class="public ">
|
|
222
|
+
<span class="summary_signature">
|
|
223
|
+
|
|
224
|
+
<a href="#log_pass-class_method" title="log_pass (class method)">.<strong>log_pass</strong>(message) ⇒ void </a>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
</span>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<span class="summary_desc"><div class='inline'><p>Logs a green text message to stdout.</p>
|
|
239
|
+
</div></span>
|
|
240
|
+
|
|
241
|
+
</li>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<li class="public ">
|
|
245
|
+
<span class="summary_signature">
|
|
246
|
+
|
|
247
|
+
<a href="#spinner_log-class_method" title="spinner_log (class method)">.<strong>spinner_log</strong>(message) ⇒ void </a>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
</span>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<span class="summary_desc"><div class='inline'><p>Logs a message during spinner execution removing the need to manually pause and resume spinner.</p>
|
|
262
|
+
</div></span>
|
|
263
|
+
|
|
264
|
+
</li>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<li class="public ">
|
|
268
|
+
<span class="summary_signature">
|
|
269
|
+
|
|
270
|
+
<a href="#spinner_pause-class_method" title="spinner_pause (class method)">.<strong>spinner_pause</strong> ⇒ void </a>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
</span>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<span class="summary_desc"><div class='inline'><p>Pauses spinner thread execution to enable uninterrupted stdout outputs.</p>
|
|
285
|
+
</div></span>
|
|
286
|
+
|
|
287
|
+
</li>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<li class="public ">
|
|
291
|
+
<span class="summary_signature">
|
|
292
|
+
|
|
293
|
+
<a href="#spinner_resume-class_method" title="spinner_resume (class method)">.<strong>spinner_resume</strong> ⇒ void </a>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
</span>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<span class="summary_desc"><div class='inline'><p>Resumes spinner thread execution.</p>
|
|
308
|
+
</div></span>
|
|
309
|
+
|
|
310
|
+
</li>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<li class="public ">
|
|
314
|
+
<span class="summary_signature">
|
|
315
|
+
|
|
316
|
+
<a href="#spinner_running%3F-class_method" title="spinner_running? (class method)">.<strong>spinner_running?</strong> ⇒ Boolean </a>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
</span>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
<span class="summary_desc"><div class='inline'><p>Returns spinner status.</p>
|
|
331
|
+
</div></span>
|
|
332
|
+
|
|
333
|
+
</li>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
<li class="public ">
|
|
337
|
+
<span class="summary_signature">
|
|
338
|
+
|
|
339
|
+
<a href="#spinner_start-class_method" title="spinner_start (class method)">.<strong>spinner_start</strong>(message) ⇒ void </a>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
</span>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<span class="summary_desc"><div class='inline'><p>Starts a cli spinner appending the provided message.</p>
|
|
354
|
+
</div></span>
|
|
355
|
+
|
|
356
|
+
</li>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
<li class="public ">
|
|
360
|
+
<span class="summary_signature">
|
|
361
|
+
|
|
362
|
+
<a href="#spinner_stop-class_method" title="spinner_stop (class method)">.<strong>spinner_stop</strong>(message = nil, exit) ⇒ void </a>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
</span>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
<span class="summary_desc"><div class='inline'><p>Stops spinner printing a formated status message.</p>
|
|
377
|
+
</div></span>
|
|
378
|
+
|
|
379
|
+
</li>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</ul>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
<div id="class_method_details" class="method_details_list">
|
|
388
|
+
<h2>Class Method Details</h2>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
<div class="method_details first">
|
|
392
|
+
<h3 class="signature first" id="command-class_method">
|
|
393
|
+
|
|
394
|
+
.<strong>command</strong>(tag, cmd, ignore_errors: false) ⇒ <tt>void</tt>
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
</h3><div class="docstring">
|
|
401
|
+
<div class="discussion">
|
|
402
|
+
<p class="note returns_void">This method returns an undefined value.</p><p>Runs a shell command with a spinner.</p>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
</div>
|
|
406
|
+
</div>
|
|
407
|
+
<div class="tags">
|
|
408
|
+
<p class="tag_title">Parameters:</p>
|
|
409
|
+
<ul class="param">
|
|
410
|
+
|
|
411
|
+
<li>
|
|
412
|
+
|
|
413
|
+
<span class='name'>tag</span>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
—
|
|
421
|
+
<div class='inline'><p>spinner tag</p>
|
|
422
|
+
</div>
|
|
423
|
+
|
|
424
|
+
</li>
|
|
425
|
+
|
|
426
|
+
<li>
|
|
427
|
+
|
|
428
|
+
<span class='name'>cmd</span>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
—
|
|
436
|
+
<div class='inline'><p>shell command to be run</p>
|
|
437
|
+
</div>
|
|
438
|
+
|
|
439
|
+
</li>
|
|
440
|
+
|
|
441
|
+
<li>
|
|
442
|
+
|
|
443
|
+
<span class='name'>ignore_errors</span>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
—
|
|
453
|
+
<div class='inline'><p>if false command exits on shell command failure</p>
|
|
454
|
+
</div>
|
|
455
|
+
|
|
456
|
+
</li>
|
|
457
|
+
|
|
458
|
+
</ul>
|
|
459
|
+
|
|
460
|
+
<p class="tag_title">Since:</p>
|
|
461
|
+
<ul class="since">
|
|
462
|
+
|
|
463
|
+
<li>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
<div class='inline'><p>1.1.0</p>
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
</li>
|
|
473
|
+
|
|
474
|
+
</ul>
|
|
475
|
+
|
|
476
|
+
</div><table class="source_code">
|
|
477
|
+
<tr>
|
|
478
|
+
<td>
|
|
479
|
+
<pre class="lines">
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
143
|
|
483
|
+
144
|
|
484
|
+
145
|
|
485
|
+
146
|
|
486
|
+
147
|
|
487
|
+
148
|
|
488
|
+
149
|
|
489
|
+
150
|
|
490
|
+
151
|
|
491
|
+
152
|
|
492
|
+
153
|
|
493
|
+
154
|
|
494
|
+
155
|
|
495
|
+
156
|
|
496
|
+
157
|
|
497
|
+
158
|
|
498
|
+
159</pre>
|
|
499
|
+
</td>
|
|
500
|
+
<td>
|
|
501
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 143</span>
|
|
502
|
+
|
|
503
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_command'>command</span><span class='lparen'>(</span><span class='id identifier rubyid_tag'>tag</span><span class='comma'>,</span> <span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='label'>ignore_errors:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
504
|
+
<span class='id identifier rubyid_spinner_start'>spinner_start</span><span class='lparen'>(</span><span class='id identifier rubyid_tag'>tag</span><span class='rparen'>)</span>
|
|
505
|
+
<span class='id identifier rubyid_out'>out</span> <span class='op'>=</span> <span class='ivar'>@command</span><span class='period'>.</span><span class='id identifier rubyid_run!'>run!</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
|
|
506
|
+
<span class='id identifier rubyid_spinner_log'>spinner_log</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_out'>out</span><span class='period'>.</span><span class='id identifier rubyid_out'>out</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
507
|
+
<span class='id identifier rubyid_spinner_stop'>spinner_stop</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_out'>out</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span><span class='rparen'>)</span>
|
|
508
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
509
|
+
|
|
510
|
+
<span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_out'>out</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_ignore_errors'>ignore_errors</span>
|
|
511
|
+
<span class='kw'>rescue</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>ENOENT</span>
|
|
512
|
+
<span class='id identifier rubyid_spinner_stop'>spinner_stop</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
513
|
+
<span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\nError: '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='embexpr_end'>}</span><span class='tstring_content'>' command not found!\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
514
|
+
<span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_ignore_errors'>ignore_errors</span>
|
|
515
|
+
<span class='kw'>rescue</span> <span class='const'>StandardError</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
|
516
|
+
<span class='id identifier rubyid_spinner_stop'>spinner_stop</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
517
|
+
<span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\nAn unexpected error ocurred:\n\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
518
|
+
<span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_ignore_errors'>ignore_errors</span>
|
|
519
|
+
<span class='kw'>end</span></pre>
|
|
520
|
+
</td>
|
|
521
|
+
</tr>
|
|
522
|
+
</table>
|
|
523
|
+
</div>
|
|
524
|
+
|
|
525
|
+
<div class="method_details ">
|
|
526
|
+
<h3 class="signature " id="init-class_method">
|
|
527
|
+
|
|
528
|
+
.<strong>init</strong> ⇒ <tt>void</tt>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
</h3><div class="docstring">
|
|
535
|
+
<div class="discussion">
|
|
536
|
+
<p class="note returns_void">This method returns an undefined value.</p><p>Initializes Crayons module.</p>
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
</div>
|
|
540
|
+
</div>
|
|
541
|
+
<div class="tags">
|
|
542
|
+
|
|
543
|
+
<p class="tag_title">Since:</p>
|
|
544
|
+
<ul class="since">
|
|
545
|
+
|
|
546
|
+
<li>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
<div class='inline'><p>1.1.0</p>
|
|
553
|
+
</div>
|
|
554
|
+
|
|
555
|
+
</li>
|
|
556
|
+
|
|
557
|
+
</ul>
|
|
558
|
+
|
|
559
|
+
</div><table class="source_code">
|
|
560
|
+
<tr>
|
|
561
|
+
<td>
|
|
562
|
+
<pre class="lines">
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
47
|
|
566
|
+
48
|
|
567
|
+
49</pre>
|
|
568
|
+
</td>
|
|
569
|
+
<td>
|
|
570
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 47</span>
|
|
571
|
+
|
|
572
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_init'>init</span>
|
|
573
|
+
<span class='ivar'>@command</span> <span class='op'>=</span> <span class='const'>TTY</span><span class='op'>::</span><span class='const'>Command</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>printer:</span> <span class='symbol'>:null</span><span class='rparen'>)</span>
|
|
574
|
+
<span class='kw'>end</span></pre>
|
|
575
|
+
</td>
|
|
576
|
+
</tr>
|
|
577
|
+
</table>
|
|
578
|
+
</div>
|
|
579
|
+
|
|
580
|
+
<div class="method_details ">
|
|
581
|
+
<h3 class="signature " id="log_error-class_method">
|
|
582
|
+
|
|
583
|
+
.<strong>log_error</strong>(message) ⇒ <tt>void</tt>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
</h3><div class="docstring">
|
|
590
|
+
<div class="discussion">
|
|
591
|
+
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a red text message to stdout.</p>
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
</div>
|
|
595
|
+
</div>
|
|
596
|
+
<div class="tags">
|
|
597
|
+
<p class="tag_title">Parameters:</p>
|
|
598
|
+
<ul class="param">
|
|
599
|
+
|
|
600
|
+
<li>
|
|
601
|
+
|
|
602
|
+
<span class='name'>message</span>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
—
|
|
610
|
+
<div class='inline'><p>message to print</p>
|
|
611
|
+
</div>
|
|
612
|
+
|
|
613
|
+
</li>
|
|
614
|
+
|
|
615
|
+
</ul>
|
|
616
|
+
|
|
617
|
+
<p class="tag_title">Since:</p>
|
|
618
|
+
<ul class="since">
|
|
619
|
+
|
|
620
|
+
<li>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
<div class='inline'><p>1.0.0</p>
|
|
627
|
+
</div>
|
|
628
|
+
|
|
629
|
+
</li>
|
|
630
|
+
|
|
631
|
+
</ul>
|
|
632
|
+
|
|
633
|
+
</div><table class="source_code">
|
|
634
|
+
<tr>
|
|
635
|
+
<td>
|
|
636
|
+
<pre class="lines">
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
179
|
|
640
|
+
180
|
|
641
|
+
181</pre>
|
|
642
|
+
</td>
|
|
643
|
+
<td>
|
|
644
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 179</span>
|
|
645
|
+
|
|
646
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
|
647
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_red'>red</span>
|
|
648
|
+
<span class='kw'>end</span></pre>
|
|
649
|
+
</td>
|
|
650
|
+
</tr>
|
|
651
|
+
</table>
|
|
652
|
+
</div>
|
|
653
|
+
|
|
654
|
+
<div class="method_details ">
|
|
655
|
+
<h3 class="signature " id="log_pass-class_method">
|
|
656
|
+
|
|
657
|
+
.<strong>log_pass</strong>(message) ⇒ <tt>void</tt>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
</h3><div class="docstring">
|
|
664
|
+
<div class="discussion">
|
|
665
|
+
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a green text message to stdout.</p>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
</div>
|
|
669
|
+
</div>
|
|
670
|
+
<div class="tags">
|
|
671
|
+
<p class="tag_title">Parameters:</p>
|
|
672
|
+
<ul class="param">
|
|
673
|
+
|
|
674
|
+
<li>
|
|
675
|
+
|
|
676
|
+
<span class='name'>message</span>
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
—
|
|
684
|
+
<div class='inline'><p>message to print</p>
|
|
685
|
+
</div>
|
|
686
|
+
|
|
687
|
+
</li>
|
|
688
|
+
|
|
689
|
+
</ul>
|
|
690
|
+
|
|
691
|
+
<p class="tag_title">Since:</p>
|
|
692
|
+
<ul class="since">
|
|
693
|
+
|
|
694
|
+
<li>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
<div class='inline'><p>1.0.0</p>
|
|
701
|
+
</div>
|
|
702
|
+
|
|
703
|
+
</li>
|
|
704
|
+
|
|
705
|
+
</ul>
|
|
706
|
+
|
|
707
|
+
</div><table class="source_code">
|
|
708
|
+
<tr>
|
|
709
|
+
<td>
|
|
710
|
+
<pre class="lines">
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
168
|
|
714
|
+
169
|
|
715
|
+
170</pre>
|
|
716
|
+
</td>
|
|
717
|
+
<td>
|
|
718
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 168</span>
|
|
719
|
+
|
|
720
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_pass'>log_pass</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
|
721
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_green'>green</span>
|
|
722
|
+
<span class='kw'>end</span></pre>
|
|
723
|
+
</td>
|
|
724
|
+
</tr>
|
|
725
|
+
</table>
|
|
726
|
+
</div>
|
|
727
|
+
|
|
728
|
+
<div class="method_details ">
|
|
729
|
+
<h3 class="signature " id="spinner_log-class_method">
|
|
730
|
+
|
|
731
|
+
.<strong>spinner_log</strong>(message) ⇒ <tt>void</tt>
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
</h3><div class="docstring">
|
|
738
|
+
<div class="discussion">
|
|
739
|
+
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message during spinner execution removing the need
|
|
740
|
+
to manually pause and resume spinner.</p>
|
|
741
|
+
|
|
742
|
+
<p>If a spinner is not running simply prints message.</p>
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
</div>
|
|
746
|
+
</div>
|
|
747
|
+
<div class="tags">
|
|
748
|
+
<p class="tag_title">Parameters:</p>
|
|
749
|
+
<ul class="param">
|
|
750
|
+
|
|
751
|
+
<li>
|
|
752
|
+
|
|
753
|
+
<span class='name'>message</span>
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
—
|
|
761
|
+
<div class='inline'><p>message to prin</p>
|
|
762
|
+
</div>
|
|
763
|
+
|
|
764
|
+
</li>
|
|
765
|
+
|
|
766
|
+
</ul>
|
|
767
|
+
|
|
768
|
+
<p class="tag_title">Since:</p>
|
|
769
|
+
<ul class="since">
|
|
770
|
+
|
|
771
|
+
<li>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
<div class='inline'><p>1.0.0</p>
|
|
778
|
+
</div>
|
|
779
|
+
|
|
780
|
+
</li>
|
|
781
|
+
|
|
782
|
+
</ul>
|
|
783
|
+
|
|
784
|
+
</div><table class="source_code">
|
|
785
|
+
<tr>
|
|
786
|
+
<td>
|
|
787
|
+
<pre class="lines">
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
128
|
|
791
|
+
129
|
|
792
|
+
130
|
|
793
|
+
131
|
|
794
|
+
132</pre>
|
|
795
|
+
</td>
|
|
796
|
+
<td>
|
|
797
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 128</span>
|
|
798
|
+
|
|
799
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_spinner_log'>spinner_log</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
|
800
|
+
<span class='id identifier rubyid_spinner_pause'>spinner_pause</span> <span class='kw'>if</span> <span class='ivar'>@spinner_running</span>
|
|
801
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_message'>message</span>
|
|
802
|
+
<span class='id identifier rubyid_spinner_resume'>spinner_resume</span> <span class='kw'>if</span> <span class='ivar'>@spinner_running</span>
|
|
803
|
+
<span class='kw'>end</span></pre>
|
|
804
|
+
</td>
|
|
805
|
+
</tr>
|
|
806
|
+
</table>
|
|
807
|
+
</div>
|
|
808
|
+
|
|
809
|
+
<div class="method_details ">
|
|
810
|
+
<h3 class="signature " id="spinner_pause-class_method">
|
|
811
|
+
|
|
812
|
+
.<strong>spinner_pause</strong> ⇒ <tt>void</tt>
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
</h3><div class="docstring">
|
|
819
|
+
<div class="discussion">
|
|
820
|
+
<p class="note returns_void">This method returns an undefined value.</p><p>Pauses spinner thread execution to enable uninterrupted stdout outputs.</p>
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
</div>
|
|
824
|
+
</div>
|
|
825
|
+
<div class="tags">
|
|
826
|
+
|
|
827
|
+
<p class="tag_title">Since:</p>
|
|
828
|
+
<ul class="since">
|
|
829
|
+
|
|
830
|
+
<li>
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
<div class='inline'><p>1.0.0</p>
|
|
837
|
+
</div>
|
|
838
|
+
|
|
839
|
+
</li>
|
|
840
|
+
|
|
841
|
+
</ul>
|
|
842
|
+
|
|
843
|
+
</div><table class="source_code">
|
|
844
|
+
<tr>
|
|
845
|
+
<td>
|
|
846
|
+
<pre class="lines">
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
83
|
|
850
|
+
84
|
|
851
|
+
85
|
|
852
|
+
86
|
|
853
|
+
87
|
|
854
|
+
88
|
|
855
|
+
89</pre>
|
|
856
|
+
</td>
|
|
857
|
+
<td>
|
|
858
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 83</span>
|
|
859
|
+
|
|
860
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_spinner_pause'>spinner_pause</span>
|
|
861
|
+
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@spinner_running</span>
|
|
862
|
+
|
|
863
|
+
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\r\e[K</span><span class='tstring_end'>"</span></span>
|
|
864
|
+
<span class='ivar'>@thread_paused</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
865
|
+
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\r\e[K</span><span class='tstring_end'>"</span></span>
|
|
866
|
+
<span class='kw'>end</span></pre>
|
|
867
|
+
</td>
|
|
868
|
+
</tr>
|
|
869
|
+
</table>
|
|
870
|
+
</div>
|
|
871
|
+
|
|
872
|
+
<div class="method_details ">
|
|
873
|
+
<h3 class="signature " id="spinner_resume-class_method">
|
|
874
|
+
|
|
875
|
+
.<strong>spinner_resume</strong> ⇒ <tt>void</tt>
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
</h3><div class="docstring">
|
|
882
|
+
<div class="discussion">
|
|
883
|
+
<p class="note returns_void">This method returns an undefined value.</p><p>Resumes spinner thread execution.</p>
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
</div>
|
|
887
|
+
</div>
|
|
888
|
+
<div class="tags">
|
|
889
|
+
|
|
890
|
+
<p class="tag_title">Since:</p>
|
|
891
|
+
<ul class="since">
|
|
892
|
+
|
|
893
|
+
<li>
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
<div class='inline'><p>1.0.0</p>
|
|
900
|
+
</div>
|
|
901
|
+
|
|
902
|
+
</li>
|
|
903
|
+
|
|
904
|
+
</ul>
|
|
905
|
+
|
|
906
|
+
</div><table class="source_code">
|
|
907
|
+
<tr>
|
|
908
|
+
<td>
|
|
909
|
+
<pre class="lines">
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
96
|
|
913
|
+
97
|
|
914
|
+
98</pre>
|
|
915
|
+
</td>
|
|
916
|
+
<td>
|
|
917
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 96</span>
|
|
918
|
+
|
|
919
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_spinner_resume'>spinner_resume</span>
|
|
920
|
+
<span class='ivar'>@thread_paused</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='ivar'>@spinner_running</span>
|
|
921
|
+
<span class='kw'>end</span></pre>
|
|
922
|
+
</td>
|
|
923
|
+
</tr>
|
|
924
|
+
</table>
|
|
925
|
+
</div>
|
|
926
|
+
|
|
927
|
+
<div class="method_details ">
|
|
928
|
+
<h3 class="signature " id="spinner_running?-class_method">
|
|
929
|
+
|
|
930
|
+
.<strong>spinner_running?</strong> ⇒ <tt>Boolean</tt>
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
</h3><div class="docstring">
|
|
937
|
+
<div class="discussion">
|
|
938
|
+
<p>Returns spinner status.</p>
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
</div>
|
|
942
|
+
</div>
|
|
943
|
+
<div class="tags">
|
|
944
|
+
|
|
945
|
+
<p class="tag_title">Returns:</p>
|
|
946
|
+
<ul class="return">
|
|
947
|
+
|
|
948
|
+
<li>
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
—
|
|
956
|
+
<div class='inline'><p>spinner status</p>
|
|
957
|
+
</div>
|
|
958
|
+
|
|
959
|
+
</li>
|
|
960
|
+
|
|
961
|
+
</ul>
|
|
962
|
+
<p class="tag_title">Since:</p>
|
|
963
|
+
<ul class="since">
|
|
964
|
+
|
|
965
|
+
<li>
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
<div class='inline'><p>1.0.0</p>
|
|
972
|
+
</div>
|
|
973
|
+
|
|
974
|
+
</li>
|
|
975
|
+
|
|
976
|
+
</ul>
|
|
977
|
+
|
|
978
|
+
</div><table class="source_code">
|
|
979
|
+
<tr>
|
|
980
|
+
<td>
|
|
981
|
+
<pre class="lines">
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
54
|
|
985
|
+
55
|
|
986
|
+
56</pre>
|
|
987
|
+
</td>
|
|
988
|
+
<td>
|
|
989
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 54</span>
|
|
990
|
+
|
|
991
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_spinner_running?'>spinner_running?</span>
|
|
992
|
+
<span class='ivar'>@spinner_running</span>
|
|
993
|
+
<span class='kw'>end</span></pre>
|
|
994
|
+
</td>
|
|
995
|
+
</tr>
|
|
996
|
+
</table>
|
|
997
|
+
</div>
|
|
998
|
+
|
|
999
|
+
<div class="method_details ">
|
|
1000
|
+
<h3 class="signature " id="spinner_start-class_method">
|
|
1001
|
+
|
|
1002
|
+
.<strong>spinner_start</strong>(message) ⇒ <tt>void</tt>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
</h3><div class="docstring">
|
|
1009
|
+
<div class="discussion">
|
|
1010
|
+
<p class="note returns_void">This method returns an undefined value.</p><p>Starts a cli spinner appending the provided message.</p>
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
</div>
|
|
1014
|
+
</div>
|
|
1015
|
+
<div class="tags">
|
|
1016
|
+
<p class="tag_title">Parameters:</p>
|
|
1017
|
+
<ul class="param">
|
|
1018
|
+
|
|
1019
|
+
<li>
|
|
1020
|
+
|
|
1021
|
+
<span class='name'>message</span>
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
—
|
|
1029
|
+
<div class='inline'><p>text to append to the spinner</p>
|
|
1030
|
+
</div>
|
|
1031
|
+
|
|
1032
|
+
</li>
|
|
1033
|
+
|
|
1034
|
+
</ul>
|
|
1035
|
+
|
|
1036
|
+
<p class="tag_title">Since:</p>
|
|
1037
|
+
<ul class="since">
|
|
1038
|
+
|
|
1039
|
+
<li>
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
<div class='inline'><p>1.0.0</p>
|
|
1046
|
+
</div>
|
|
1047
|
+
|
|
1048
|
+
</li>
|
|
1049
|
+
|
|
1050
|
+
</ul>
|
|
1051
|
+
|
|
1052
|
+
</div><table class="source_code">
|
|
1053
|
+
<tr>
|
|
1054
|
+
<td>
|
|
1055
|
+
<pre class="lines">
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
65
|
|
1059
|
+
66
|
|
1060
|
+
67
|
|
1061
|
+
68
|
|
1062
|
+
69
|
|
1063
|
+
70
|
|
1064
|
+
71
|
|
1065
|
+
72
|
|
1066
|
+
73
|
|
1067
|
+
74
|
|
1068
|
+
75
|
|
1069
|
+
76</pre>
|
|
1070
|
+
</td>
|
|
1071
|
+
<td>
|
|
1072
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 65</span>
|
|
1073
|
+
|
|
1074
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_spinner_start'>spinner_start</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
|
1075
|
+
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\r\e[K</span><span class='tstring_end'>"</span></span>
|
|
1076
|
+
<span class='ivar'>@spinner</span> <span class='op'>=</span> <span class='const'>TTY</span><span class='op'>::</span><span class='const'>Spinner</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[:spinner] </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>interval:</span> <span class='int'>5</span><span class='rparen'>)</span>
|
|
1077
|
+
<span class='ivar'>@spinner_running</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
1078
|
+
<span class='ivar'>@thread</span> <span class='op'>=</span> <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
|
|
1079
|
+
<span class='ivar'>@spinner</span><span class='period'>.</span><span class='id identifier rubyid_auto_spin'>auto_spin</span>
|
|
1080
|
+
<span class='kw'>while</span> <span class='ivar'>@thread_sleeping</span>
|
|
1081
|
+
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\r\e[K</span><span class='tstring_end'>"</span></span>
|
|
1082
|
+
<span class='id identifier rubyid_sleep'>sleep</span><span class='lparen'>(</span><span class='float'>0.1</span><span class='rparen'>)</span>
|
|
1083
|
+
<span class='kw'>end</span>
|
|
1084
|
+
<span class='kw'>end</span>
|
|
1085
|
+
<span class='kw'>end</span></pre>
|
|
1086
|
+
</td>
|
|
1087
|
+
</tr>
|
|
1088
|
+
</table>
|
|
1089
|
+
</div>
|
|
1090
|
+
|
|
1091
|
+
<div class="method_details ">
|
|
1092
|
+
<h3 class="signature " id="spinner_stop-class_method">
|
|
1093
|
+
|
|
1094
|
+
.<strong>spinner_stop</strong>(message = nil, exit) ⇒ <tt>void</tt>
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
</h3><div class="docstring">
|
|
1101
|
+
<div class="discussion">
|
|
1102
|
+
<p class="note returns_void">This method returns an undefined value.</p><p>Stops spinner printing a formated status message.</p>
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
</div>
|
|
1106
|
+
</div>
|
|
1107
|
+
<div class="tags">
|
|
1108
|
+
<p class="tag_title">Parameters:</p>
|
|
1109
|
+
<ul class="param">
|
|
1110
|
+
|
|
1111
|
+
<li>
|
|
1112
|
+
|
|
1113
|
+
<span class='name'>message</span>
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
—
|
|
1123
|
+
<div class='inline'><p>status message to print</p>
|
|
1124
|
+
</div>
|
|
1125
|
+
|
|
1126
|
+
</li>
|
|
1127
|
+
|
|
1128
|
+
<li>
|
|
1129
|
+
|
|
1130
|
+
<span class='name'>exit</span>
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
—
|
|
1138
|
+
<div class='inline'><p>return code (true - success, false - error)</p>
|
|
1139
|
+
</div>
|
|
1140
|
+
|
|
1141
|
+
</li>
|
|
1142
|
+
|
|
1143
|
+
</ul>
|
|
1144
|
+
|
|
1145
|
+
<p class="tag_title">Since:</p>
|
|
1146
|
+
<ul class="since">
|
|
1147
|
+
|
|
1148
|
+
<li>
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
<div class='inline'><p>1.0.0</p>
|
|
1155
|
+
</div>
|
|
1156
|
+
|
|
1157
|
+
</li>
|
|
1158
|
+
|
|
1159
|
+
</ul>
|
|
1160
|
+
|
|
1161
|
+
</div><table class="source_code">
|
|
1162
|
+
<tr>
|
|
1163
|
+
<td>
|
|
1164
|
+
<pre class="lines">
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
108
|
|
1168
|
+
109
|
|
1169
|
+
110
|
|
1170
|
+
111
|
|
1171
|
+
112
|
|
1172
|
+
113
|
|
1173
|
+
114
|
|
1174
|
+
115
|
|
1175
|
+
116</pre>
|
|
1176
|
+
</td>
|
|
1177
|
+
<td>
|
|
1178
|
+
<pre class="code"><span class="info file"># File 'lib/rvvm/crayons.rb', line 108</span>
|
|
1179
|
+
|
|
1180
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_spinner_stop'>spinner_stop</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_exit'>exit</span><span class='rparen'>)</span>
|
|
1181
|
+
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@spinner_running</span>
|
|
1182
|
+
|
|
1183
|
+
<span class='id identifier rubyid_sleep'>sleep</span><span class='lparen'>(</span><span class='float'>0.1</span><span class='rparen'>)</span>
|
|
1184
|
+
<span class='id identifier rubyid_spinner_message'>spinner_message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_exit'>exit</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Done!</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Failed!</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1185
|
+
<span class='id identifier rubyid_exit'>exit</span> <span class='op'>?</span> <span class='ivar'>@spinner</span><span class='period'>.</span><span class='id identifier rubyid_success'>success</span><span class='lparen'>(</span><span class='id identifier rubyid_spinner_message'>spinner_message</span><span class='period'>.</span><span class='id identifier rubyid_green'>green</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='ivar'>@spinner</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_spinner_message'>spinner_message</span><span class='period'>.</span><span class='id identifier rubyid_red'>red</span><span class='rparen'>)</span>
|
|
1186
|
+
<span class='ivar'>@thread</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span>
|
|
1187
|
+
<span class='ivar'>@spinner_running</span> <span class='op'>=</span> <span class='kw'>false</span>
|
|
1188
|
+
<span class='kw'>end</span></pre>
|
|
1189
|
+
</td>
|
|
1190
|
+
</tr>
|
|
1191
|
+
</table>
|
|
1192
|
+
</div>
|
|
1193
|
+
|
|
1194
|
+
</div>
|
|
1195
|
+
|
|
1196
|
+
</div>
|
|
1197
|
+
|
|
1198
|
+
<div id="footer">
|
|
1199
|
+
Generated on Thu Sep 19 20:26:42 2024 by
|
|
1200
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1201
|
+
0.9.37 (ruby-3.2.5).
|
|
1202
|
+
</div>
|
|
1203
|
+
|
|
1204
|
+
</div>
|
|
1205
|
+
</body>
|
|
1206
|
+
</html>
|