cliutils 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardoc/checksums +11 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/doc/CLIUtils/Configuration.html +373 -0
- data/doc/CLIUtils/Configurator.html +873 -0
- data/doc/CLIUtils/LoggerDelegator.html +560 -0
- data/doc/CLIUtils/Messenging.html +396 -0
- data/doc/CLIUtils/Prefs.html +609 -0
- data/doc/CLIUtils/PrettyIO.html +1333 -0
- data/doc/CLIUtils.html +131 -0
- data/doc/Hash.html +672 -0
- data/doc/Logger.html +233 -0
- data/doc/String.html +562 -0
- data/doc/_index.html +207 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +415 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +415 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +178 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +389 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/cliutils/version.rb +1 -1
- metadata +29 -57
- data/.DS_Store +0 -0
- data/README.rdoc +0 -19
- data/html/CLIUtils/Configuration.html +0 -271
- data/html/CLIUtils/Configurator.html +0 -504
- data/html/CLIUtils/LoggerDelegator.html +0 -344
- data/html/CLIUtils/Messenging.html +0 -284
- data/html/CLIUtils/Prefs.html +0 -330
- data/html/CLIUtils/PrettyIO.html +0 -799
- data/html/CLIUtils.html +0 -112
- data/html/Hash.html +0 -453
- data/html/Logger.html +0 -183
- data/html/Object.html +0 -120
- data/html/README_md.html +0 -454
- data/html/String.html +0 -413
- data/html/created.rid +0 -13
- data/html/fonts/Lato-Light.ttf +0 -0
- data/html/fonts/Lato-LightItalic.ttf +0 -0
- data/html/fonts/Lato-Regular.ttf +0 -0
- data/html/fonts/Lato-RegularItalic.ttf +0 -0
- data/html/fonts/SourceCodePro-Bold.ttf +0 -0
- data/html/fonts/SourceCodePro-Regular.ttf +0 -0
- data/html/fonts.css +0 -167
- data/html/images/add.png +0 -0
- data/html/images/arrow_up.png +0 -0
- data/html/images/brick.png +0 -0
- data/html/images/brick_link.png +0 -0
- data/html/images/bug.png +0 -0
- data/html/images/bullet_black.png +0 -0
- data/html/images/bullet_toggle_minus.png +0 -0
- data/html/images/bullet_toggle_plus.png +0 -0
- data/html/images/date.png +0 -0
- data/html/images/delete.png +0 -0
- data/html/images/find.png +0 -0
- data/html/images/loadingAnimation.gif +0 -0
- data/html/images/macFFBgHack.png +0 -0
- data/html/images/package.png +0 -0
- data/html/images/page_green.png +0 -0
- data/html/images/page_white_text.png +0 -0
- data/html/images/page_white_width.png +0 -0
- data/html/images/plugin.png +0 -0
- data/html/images/ruby.png +0 -0
- data/html/images/tag_blue.png +0 -0
- data/html/images/tag_green.png +0 -0
- data/html/images/transparent.png +0 -0
- data/html/images/wrench.png +0 -0
- data/html/images/wrench_orange.png +0 -0
- data/html/images/zoom.png +0 -0
- data/html/index.html +0 -455
- data/html/js/darkfish.js +0 -140
- data/html/js/jquery.js +0 -18
- data/html/js/navigation.js +0 -142
- data/html/js/search.js +0 -109
- data/html/js/search_index.js +0 -1
- data/html/js/searcher.js +0 -228
- data/html/rdoc.css +0 -580
- data/html/table_of_contents.html +0 -399
@@ -0,0 +1,1333 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Module: CLIUtils::PrettyIO
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7.4
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '../';
|
20
|
+
framesUrl = "../frames.html#!CLIUtils/PrettyIO.html";
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="../_index.html">Index (P)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../CLIUtils.html" title="CLIUtils (module)">CLIUtils</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">PrettyIO</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
46
|
+
href="../class_list.html">
|
47
|
+
Class List
|
48
|
+
</a>
|
49
|
+
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
51
|
+
href="../method_list.html">
|
52
|
+
Method List
|
53
|
+
</a>
|
54
|
+
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
56
|
+
href="../file_list.html">
|
57
|
+
File List
|
58
|
+
</a>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
<div class="clear"></div>
|
62
|
+
</div>
|
63
|
+
|
64
|
+
<iframe id="search_frame"></iframe>
|
65
|
+
|
66
|
+
<div id="content"><h1>Module: CLIUtils::PrettyIO
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
|
80
|
+
<dt class="r1">Included in:</dt>
|
81
|
+
<dd class="r1"><span class='object_link'><a href="Messenging.html" title="CLIUtils::Messenging (module)">Messenging</a></span>, <span class='object_link'><a href="Prefs.html" title="CLIUtils::Prefs (class)">Prefs</a></span></dd>
|
82
|
+
|
83
|
+
|
84
|
+
|
85
|
+
<dt class="r2 last">Defined in:</dt>
|
86
|
+
<dd class="r2 last">lib/cliutils/pretty-io.rb</dd>
|
87
|
+
|
88
|
+
</dl>
|
89
|
+
<div class="clear"></div>
|
90
|
+
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
92
|
+
<div class="discussion">
|
93
|
+
|
94
|
+
<h6 id="label-"></h6>
|
95
|
+
|
96
|
+
<pre class="code ruby"><code class="ruby">CLIMessenger Module
|
97
|
+
Outputs color-coordinated messages to a CLI
|
98
|
+
======================================================</code></pre>
|
99
|
+
|
100
|
+
|
101
|
+
</div>
|
102
|
+
</div>
|
103
|
+
<div class="tags">
|
104
|
+
|
105
|
+
|
106
|
+
</div>
|
107
|
+
<h2>Constant Summary</h2>
|
108
|
+
|
109
|
+
<dl class="constants">
|
110
|
+
|
111
|
+
<dt id="wrap-classvariable" class="">@@wrap =
|
112
|
+
|
113
|
+
</dt>
|
114
|
+
<dd><pre class="code"><span class='kw'>true</span></pre></dd>
|
115
|
+
|
116
|
+
<dt id="wrap_char_limit-classvariable" class="">@@wrap_char_limit =
|
117
|
+
|
118
|
+
</dt>
|
119
|
+
<dd><pre class="code"><span class='int'>40</span></pre></dd>
|
120
|
+
|
121
|
+
</dl>
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
<h2>
|
132
|
+
Class Method Summary
|
133
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
134
|
+
</h2>
|
135
|
+
|
136
|
+
<ul class="summary">
|
137
|
+
|
138
|
+
<li class="public ">
|
139
|
+
<span class="summary_signature">
|
140
|
+
|
141
|
+
<a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(k) </a>
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
</span>
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
<span class="summary_desc"><div class='inline'>
|
156
|
+
<h6 id="label-Methods++%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D++++----------------------------------------------------++included+method.">Methods ==================================================== —————————————————- included method.</h6>
|
157
|
+
</div></span>
|
158
|
+
|
159
|
+
</li>
|
160
|
+
|
161
|
+
|
162
|
+
<li class="public ">
|
163
|
+
<span class="summary_signature">
|
164
|
+
|
165
|
+
<a href="#wrap-class_method" title="wrap (class method)">+ (Object) <strong>wrap</strong>(on) </a>
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
</span>
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
<span class="summary_desc"><div class='inline'>
|
180
|
+
<p>—————————————————- wrap method.</p>
|
181
|
+
</div></span>
|
182
|
+
|
183
|
+
</li>
|
184
|
+
|
185
|
+
|
186
|
+
<li class="public ">
|
187
|
+
<span class="summary_signature">
|
188
|
+
|
189
|
+
<a href="#wrap_at-class_method" title="wrap_at (class method)">+ (Object) <strong>wrap_at</strong>(chars) </a>
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
</span>
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
<span class="summary_desc"><div class='inline'>
|
204
|
+
<p>—————————————————- wrap_at method.</p>
|
205
|
+
</div></span>
|
206
|
+
|
207
|
+
</li>
|
208
|
+
|
209
|
+
|
210
|
+
<li class="public ">
|
211
|
+
<span class="summary_signature">
|
212
|
+
|
213
|
+
<a href="#wrap_limit-class_method" title="wrap_limit (class method)">+ (Object) <strong>wrap_limit</strong> </a>
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
</span>
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
<span class="summary_desc"><div class='inline'>
|
228
|
+
<p>—————————————————- wrap_limit method.</p>
|
229
|
+
</div></span>
|
230
|
+
|
231
|
+
</li>
|
232
|
+
|
233
|
+
|
234
|
+
</ul>
|
235
|
+
|
236
|
+
<h2>
|
237
|
+
Instance Method Summary
|
238
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
239
|
+
</h2>
|
240
|
+
|
241
|
+
<ul class="summary">
|
242
|
+
|
243
|
+
<li class="public ">
|
244
|
+
<span class="summary_signature">
|
245
|
+
|
246
|
+
<a href="#color_chart-instance_method" title="#color_chart (instance method)">- (Object) <strong>color_chart</strong> </a>
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
</span>
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
<span class="summary_desc"><div class='inline'>
|
261
|
+
<p>—————————————————- color_chart method.</p>
|
262
|
+
</div></span>
|
263
|
+
|
264
|
+
</li>
|
265
|
+
|
266
|
+
|
267
|
+
<li class="public ">
|
268
|
+
<span class="summary_signature">
|
269
|
+
|
270
|
+
<a href="#debug-instance_method" title="#debug (instance method)">- (Object) <strong>debug</strong>(m) </a>
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
</span>
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
<span class="summary_desc"><div class='inline'>
|
285
|
+
<p>—————————————————- debug method.</p>
|
286
|
+
</div></span>
|
287
|
+
|
288
|
+
</li>
|
289
|
+
|
290
|
+
|
291
|
+
<li class="public ">
|
292
|
+
<span class="summary_signature">
|
293
|
+
|
294
|
+
<a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong>(m) </a>
|
295
|
+
|
296
|
+
|
297
|
+
|
298
|
+
</span>
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
<span class="summary_desc"><div class='inline'>
|
309
|
+
<p>—————————————————- error method.</p>
|
310
|
+
</div></span>
|
311
|
+
|
312
|
+
</li>
|
313
|
+
|
314
|
+
|
315
|
+
<li class="public ">
|
316
|
+
<span class="summary_signature">
|
317
|
+
|
318
|
+
<a href="#info-instance_method" title="#info (instance method)">- (Object) <strong>info</strong>(m) </a>
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
</span>
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
<span class="summary_desc"><div class='inline'>
|
333
|
+
<p>—————————————————- info method.</p>
|
334
|
+
</div></span>
|
335
|
+
|
336
|
+
</li>
|
337
|
+
|
338
|
+
|
339
|
+
<li class="public ">
|
340
|
+
<span class="summary_signature">
|
341
|
+
|
342
|
+
<a href="#info_block-instance_method" title="#info_block (instance method)">- (Object) <strong>info_block</strong>(m1, m2 = 'Done.', multiline = false) </a>
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
</span>
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
|
354
|
+
|
355
|
+
|
356
|
+
<span class="summary_desc"><div class='inline'>
|
357
|
+
<p>—————————————————- info_block method.</p>
|
358
|
+
</div></span>
|
359
|
+
|
360
|
+
</li>
|
361
|
+
|
362
|
+
|
363
|
+
<li class="public ">
|
364
|
+
<span class="summary_signature">
|
365
|
+
|
366
|
+
<a href="#log-instance_method" title="#log (instance method)">- (Object) <strong>log</strong>(m) </a>
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
</span>
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
<span class="summary_desc"><div class='inline'>
|
381
|
+
<p>—————————————————- log method.</p>
|
382
|
+
</div></span>
|
383
|
+
|
384
|
+
</li>
|
385
|
+
|
386
|
+
|
387
|
+
<li class="public ">
|
388
|
+
<span class="summary_signature">
|
389
|
+
|
390
|
+
<a href="#prompt-instance_method" title="#prompt (instance method)">- (Object) <strong>prompt</strong>(prompt, default = nil, start_dir = '') </a>
|
391
|
+
|
392
|
+
|
393
|
+
|
394
|
+
</span>
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
<span class="summary_desc"><div class='inline'>
|
405
|
+
<p>—————————————————- prompt method.</p>
|
406
|
+
</div></span>
|
407
|
+
|
408
|
+
</li>
|
409
|
+
|
410
|
+
|
411
|
+
<li class="public ">
|
412
|
+
<span class="summary_signature">
|
413
|
+
|
414
|
+
<a href="#section-instance_method" title="#section (instance method)">- (Object) <strong>section</strong>(m) </a>
|
415
|
+
|
416
|
+
|
417
|
+
|
418
|
+
</span>
|
419
|
+
|
420
|
+
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
<span class="summary_desc"><div class='inline'>
|
429
|
+
<p>—————————————————- section method.</p>
|
430
|
+
</div></span>
|
431
|
+
|
432
|
+
</li>
|
433
|
+
|
434
|
+
|
435
|
+
<li class="public ">
|
436
|
+
<span class="summary_signature">
|
437
|
+
|
438
|
+
<a href="#section_block-instance_method" title="#section_block (instance method)">- (Object) <strong>section_block</strong>(m, multiline = true) </a>
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
</span>
|
443
|
+
|
444
|
+
|
445
|
+
|
446
|
+
|
447
|
+
|
448
|
+
|
449
|
+
|
450
|
+
|
451
|
+
|
452
|
+
<span class="summary_desc"><div class='inline'>
|
453
|
+
<p>—————————————————- section_block method.</p>
|
454
|
+
</div></span>
|
455
|
+
|
456
|
+
</li>
|
457
|
+
|
458
|
+
|
459
|
+
<li class="public ">
|
460
|
+
<span class="summary_signature">
|
461
|
+
|
462
|
+
<a href="#success-instance_method" title="#success (instance method)">- (Object) <strong>success</strong>(m) </a>
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
</span>
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
|
472
|
+
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
<span class="summary_desc"><div class='inline'>
|
477
|
+
<p>—————————————————- success method.</p>
|
478
|
+
</div></span>
|
479
|
+
|
480
|
+
</li>
|
481
|
+
|
482
|
+
|
483
|
+
<li class="public ">
|
484
|
+
<span class="summary_signature">
|
485
|
+
|
486
|
+
<a href="#warn-instance_method" title="#warn (instance method)">- (Object) <strong>warn</strong>(m) </a>
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
</span>
|
491
|
+
|
492
|
+
|
493
|
+
|
494
|
+
|
495
|
+
|
496
|
+
|
497
|
+
|
498
|
+
|
499
|
+
|
500
|
+
<span class="summary_desc"><div class='inline'>
|
501
|
+
<p>—————————————————- warning method.</p>
|
502
|
+
</div></span>
|
503
|
+
|
504
|
+
</li>
|
505
|
+
|
506
|
+
|
507
|
+
</ul>
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
|
512
|
+
<div id="class_method_details" class="method_details_list">
|
513
|
+
<h2>Class Method Details</h2>
|
514
|
+
|
515
|
+
|
516
|
+
<div class="method_details first">
|
517
|
+
<h3 class="signature first" id="included-class_method">
|
518
|
+
|
519
|
+
+ (<tt>Object</tt>) <strong>included</strong>(k)
|
520
|
+
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
</h3><div class="docstring">
|
526
|
+
<div class="discussion">
|
527
|
+
|
528
|
+
<h6 id="label-"></h6>
|
529
|
+
|
530
|
+
<pre class="code ruby"><code class="ruby">Methods
|
531
|
+
==================================================== ----------------------------------------------------
|
532
|
+
included method
|
533
|
+
|
534
|
+
Hook called when this module gets mixed in; extends
|
535
|
+
the includer with the methods defined here.
|
536
|
+
@param k The includer
|
537
|
+
@return Void
|
538
|
+
----------------------------------------------------
|
539
|
+
</code></pre>
|
540
|
+
|
541
|
+
|
542
|
+
</div>
|
543
|
+
</div>
|
544
|
+
<div class="tags">
|
545
|
+
|
546
|
+
|
547
|
+
</div><table class="source_code">
|
548
|
+
<tr>
|
549
|
+
<td>
|
550
|
+
<pre class="lines">
|
551
|
+
|
552
|
+
|
553
|
+
29
|
554
|
+
30
|
555
|
+
31</pre>
|
556
|
+
</td>
|
557
|
+
<td>
|
558
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 29</span>
|
559
|
+
|
560
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='rparen'>)</span>
|
561
|
+
<span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_extend'>extend</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
|
562
|
+
<span class='kw'>end</span></pre>
|
563
|
+
</td>
|
564
|
+
</tr>
|
565
|
+
</table>
|
566
|
+
</div>
|
567
|
+
|
568
|
+
<div class="method_details ">
|
569
|
+
<h3 class="signature " id="wrap-class_method">
|
570
|
+
|
571
|
+
+ (<tt>Object</tt>) <strong>wrap</strong>(on)
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
|
577
|
+
</h3><div class="docstring">
|
578
|
+
<div class="discussion">
|
579
|
+
<hr>
|
580
|
+
|
581
|
+
<pre class="code ruby"><code class="ruby">wrap method
|
582
|
+
|
583
|
+
Toggles wrapping on or off
|
584
|
+
@return Integer
|
585
|
+
----------------------------------------------------</code></pre>
|
586
|
+
|
587
|
+
|
588
|
+
</div>
|
589
|
+
</div>
|
590
|
+
<div class="tags">
|
591
|
+
|
592
|
+
|
593
|
+
</div><table class="source_code">
|
594
|
+
<tr>
|
595
|
+
<td>
|
596
|
+
<pre class="lines">
|
597
|
+
|
598
|
+
|
599
|
+
210
|
600
|
+
211
|
601
|
+
212</pre>
|
602
|
+
</td>
|
603
|
+
<td>
|
604
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 210</span>
|
605
|
+
|
606
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_wrap'>wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_on'>on</span><span class='rparen'>)</span>
|
607
|
+
<span class='cvar'>@@wrap</span> <span class='op'>=</span> <span class='id identifier rubyid_on'>on</span>
|
608
|
+
<span class='kw'>end</span></pre>
|
609
|
+
</td>
|
610
|
+
</tr>
|
611
|
+
</table>
|
612
|
+
</div>
|
613
|
+
|
614
|
+
<div class="method_details ">
|
615
|
+
<h3 class="signature " id="wrap_at-class_method">
|
616
|
+
|
617
|
+
+ (<tt>Object</tt>) <strong>wrap_at</strong>(chars)
|
618
|
+
|
619
|
+
|
620
|
+
|
621
|
+
|
622
|
+
|
623
|
+
</h3><div class="docstring">
|
624
|
+
<div class="discussion">
|
625
|
+
<hr>
|
626
|
+
|
627
|
+
<pre class="code ruby"><code class="ruby">wrap_at method
|
628
|
+
|
629
|
+
Sets the number of characters at which to wrap
|
630
|
+
@return Integer
|
631
|
+
----------------------------------------------------</code></pre>
|
632
|
+
|
633
|
+
|
634
|
+
</div>
|
635
|
+
</div>
|
636
|
+
<div class="tags">
|
637
|
+
|
638
|
+
|
639
|
+
</div><table class="source_code">
|
640
|
+
<tr>
|
641
|
+
<td>
|
642
|
+
<pre class="lines">
|
643
|
+
|
644
|
+
|
645
|
+
230
|
646
|
+
231
|
647
|
+
232</pre>
|
648
|
+
</td>
|
649
|
+
<td>
|
650
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 230</span>
|
651
|
+
|
652
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_wrap_at'>wrap_at</span><span class='lparen'>(</span><span class='id identifier rubyid_chars'>chars</span><span class='rparen'>)</span>
|
653
|
+
<span class='cvar'>@@wrap_char_limit</span> <span class='op'>=</span> <span class='id identifier rubyid_chars'>chars</span>
|
654
|
+
<span class='kw'>end</span></pre>
|
655
|
+
</td>
|
656
|
+
</tr>
|
657
|
+
</table>
|
658
|
+
</div>
|
659
|
+
|
660
|
+
<div class="method_details ">
|
661
|
+
<h3 class="signature " id="wrap_limit-class_method">
|
662
|
+
|
663
|
+
+ (<tt>Object</tt>) <strong>wrap_limit</strong>
|
664
|
+
|
665
|
+
|
666
|
+
|
667
|
+
|
668
|
+
|
669
|
+
</h3><div class="docstring">
|
670
|
+
<div class="discussion">
|
671
|
+
<hr>
|
672
|
+
|
673
|
+
<pre class="code ruby"><code class="ruby">wrap_limit method
|
674
|
+
|
675
|
+
Returns the current character wrap amount
|
676
|
+
@return Integer
|
677
|
+
----------------------------------------------------</code></pre>
|
678
|
+
|
679
|
+
|
680
|
+
</div>
|
681
|
+
</div>
|
682
|
+
<div class="tags">
|
683
|
+
|
684
|
+
|
685
|
+
</div><table class="source_code">
|
686
|
+
<tr>
|
687
|
+
<td>
|
688
|
+
<pre class="lines">
|
689
|
+
|
690
|
+
|
691
|
+
220
|
692
|
+
221
|
693
|
+
222</pre>
|
694
|
+
</td>
|
695
|
+
<td>
|
696
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 220</span>
|
697
|
+
|
698
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_wrap_limit'>wrap_limit</span>
|
699
|
+
<span class='cvar'>@@wrap_char_limit</span>
|
700
|
+
<span class='kw'>end</span></pre>
|
701
|
+
</td>
|
702
|
+
</tr>
|
703
|
+
</table>
|
704
|
+
</div>
|
705
|
+
|
706
|
+
</div>
|
707
|
+
|
708
|
+
<div id="instance_method_details" class="method_details_list">
|
709
|
+
<h2>Instance Method Details</h2>
|
710
|
+
|
711
|
+
|
712
|
+
<div class="method_details first">
|
713
|
+
<h3 class="signature first" id="color_chart-instance_method">
|
714
|
+
|
715
|
+
- (<tt>Object</tt>) <strong>color_chart</strong>
|
716
|
+
|
717
|
+
|
718
|
+
|
719
|
+
|
720
|
+
|
721
|
+
</h3><div class="docstring">
|
722
|
+
<div class="discussion">
|
723
|
+
<hr>
|
724
|
+
|
725
|
+
<pre class="code ruby"><code class="ruby">color_chart method
|
726
|
+
|
727
|
+
Displays a chart of all the possible ANSI foreground
|
728
|
+
and background color combinations.
|
729
|
+
@return Void
|
730
|
+
----------------------------------------------------</code></pre>
|
731
|
+
|
732
|
+
|
733
|
+
</div>
|
734
|
+
</div>
|
735
|
+
<div class="tags">
|
736
|
+
|
737
|
+
|
738
|
+
</div><table class="source_code">
|
739
|
+
<tr>
|
740
|
+
<td>
|
741
|
+
<pre class="lines">
|
742
|
+
|
743
|
+
|
744
|
+
40
|
745
|
+
41
|
746
|
+
42
|
747
|
+
43
|
748
|
+
44
|
749
|
+
45
|
750
|
+
46
|
751
|
+
47
|
752
|
+
48
|
753
|
+
49
|
754
|
+
50
|
755
|
+
51</pre>
|
756
|
+
</td>
|
757
|
+
<td>
|
758
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 40</span>
|
759
|
+
|
760
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_color_chart'>color_chart</span>
|
761
|
+
<span class='lbracket'>[</span><span class='int'>0</span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='int'>4</span><span class='comma'>,</span> <span class='int'>5</span><span class='comma'>,</span> <span class='int'>7</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_attr'>attr</span><span class='op'>|</span>
|
762
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>----------------------------------------------------------------</span><span class='tstring_end'>'</span></span>
|
763
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ESC[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attr'>attr</span><span class='embexpr_end'>}</span><span class='tstring_content'>;Foreground;Background</span><span class='tstring_end'>"</span></span>
|
764
|
+
<span class='int'>30</span><span class='period'>.</span><span class='id identifier rubyid_upto'>upto</span><span class='lparen'>(</span><span class='int'>37</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_fg'>fg</span><span class='op'>|</span>
|
765
|
+
<span class='int'>40</span><span class='period'>.</span><span class='id identifier rubyid_upto'>upto</span><span class='lparen'>(</span><span class='int'>47</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_bg'>bg</span><span class='op'>|</span>
|
766
|
+
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\033[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attr'>attr</span><span class='embexpr_end'>}</span><span class='tstring_content'>;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fg'>fg</span><span class='embexpr_end'>}</span><span class='tstring_content'>;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bg'>bg</span><span class='embexpr_end'>}</span><span class='tstring_content'>m </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fg'>fg</span><span class='embexpr_end'>}</span><span class='tstring_content'>;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bg'>bg</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span>
|
767
|
+
<span class='kw'>end</span>
|
768
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\033[0m</span><span class='tstring_end'>"</span></span>
|
769
|
+
<span class='kw'>end</span>
|
770
|
+
<span class='kw'>end</span>
|
771
|
+
<span class='kw'>end</span></pre>
|
772
|
+
</td>
|
773
|
+
</tr>
|
774
|
+
</table>
|
775
|
+
</div>
|
776
|
+
|
777
|
+
<div class="method_details ">
|
778
|
+
<h3 class="signature " id="debug-instance_method">
|
779
|
+
|
780
|
+
- (<tt>Object</tt>) <strong>debug</strong>(m)
|
781
|
+
|
782
|
+
|
783
|
+
|
784
|
+
|
785
|
+
|
786
|
+
</h3><div class="docstring">
|
787
|
+
<div class="discussion">
|
788
|
+
<hr>
|
789
|
+
|
790
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_debug'>debug</span> <span class='id identifier rubyid_method'>method</span>
|
791
|
+
|
792
|
+
<span class='const'>Empty</span> <span class='id identifier rubyid_method'>method</span> <span class='id identifier rubyid_so'>so</span> <span class='id identifier rubyid_that'>that</span> <span class='const'>Messenging</span> <span class='id identifier rubyid_doesn'>doesn</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>t freak
|
793
|
+
out when passed a debug message.
|
794
|
+
@return Void
|
795
|
+
</span></span></code></pre>
|
796
|
+
|
797
|
+
|
798
|
+
</div>
|
799
|
+
</div>
|
800
|
+
<div class="tags">
|
801
|
+
|
802
|
+
|
803
|
+
</div><table class="source_code">
|
804
|
+
<tr>
|
805
|
+
<td>
|
806
|
+
<pre class="lines">
|
807
|
+
|
808
|
+
|
809
|
+
60</pre>
|
810
|
+
</td>
|
811
|
+
<td>
|
812
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 60</span>
|
813
|
+
|
814
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_debug'>debug</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
815
|
+
</td>
|
816
|
+
</tr>
|
817
|
+
</table>
|
818
|
+
</div>
|
819
|
+
|
820
|
+
<div class="method_details ">
|
821
|
+
<h3 class="signature " id="error-instance_method">
|
822
|
+
|
823
|
+
- (<tt>Object</tt>) <strong>error</strong>(m)
|
824
|
+
|
825
|
+
|
826
|
+
|
827
|
+
|
828
|
+
|
829
|
+
</h3><div class="docstring">
|
830
|
+
<div class="discussion">
|
831
|
+
<hr>
|
832
|
+
|
833
|
+
<pre class="code ruby"><code class="ruby">error method
|
834
|
+
|
835
|
+
Outputs a formatted-red error message.
|
836
|
+
@param m The message to output
|
837
|
+
@return Void
|
838
|
+
----------------------------------------------------</code></pre>
|
839
|
+
|
840
|
+
|
841
|
+
</div>
|
842
|
+
</div>
|
843
|
+
<div class="tags">
|
844
|
+
|
845
|
+
|
846
|
+
</div><table class="source_code">
|
847
|
+
<tr>
|
848
|
+
<td>
|
849
|
+
<pre class="lines">
|
850
|
+
|
851
|
+
|
852
|
+
69
|
853
|
+
70
|
854
|
+
71</pre>
|
855
|
+
</td>
|
856
|
+
<td>
|
857
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 69</span>
|
858
|
+
|
859
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span>
|
860
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid__word_wrap'>_word_wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'># </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_red'>red</span>
|
861
|
+
<span class='kw'>end</span></pre>
|
862
|
+
</td>
|
863
|
+
</tr>
|
864
|
+
</table>
|
865
|
+
</div>
|
866
|
+
|
867
|
+
<div class="method_details ">
|
868
|
+
<h3 class="signature " id="info-instance_method">
|
869
|
+
|
870
|
+
- (<tt>Object</tt>) <strong>info</strong>(m)
|
871
|
+
|
872
|
+
|
873
|
+
|
874
|
+
|
875
|
+
|
876
|
+
</h3><div class="docstring">
|
877
|
+
<div class="discussion">
|
878
|
+
<hr>
|
879
|
+
|
880
|
+
<pre class="code ruby"><code class="ruby">info method
|
881
|
+
|
882
|
+
Outputs a formatted-blue informational message.
|
883
|
+
@param m The message to output
|
884
|
+
@return Void
|
885
|
+
----------------------------------------------------</code></pre>
|
886
|
+
|
887
|
+
|
888
|
+
</div>
|
889
|
+
</div>
|
890
|
+
<div class="tags">
|
891
|
+
|
892
|
+
|
893
|
+
</div><table class="source_code">
|
894
|
+
<tr>
|
895
|
+
<td>
|
896
|
+
<pre class="lines">
|
897
|
+
|
898
|
+
|
899
|
+
80
|
900
|
+
81
|
901
|
+
82</pre>
|
902
|
+
</td>
|
903
|
+
<td>
|
904
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 80</span>
|
905
|
+
|
906
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_info'>info</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span>
|
907
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid__word_wrap'>_word_wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'># </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_blue'>blue</span>
|
908
|
+
<span class='kw'>end</span></pre>
|
909
|
+
</td>
|
910
|
+
</tr>
|
911
|
+
</table>
|
912
|
+
</div>
|
913
|
+
|
914
|
+
<div class="method_details ">
|
915
|
+
<h3 class="signature " id="info_block-instance_method">
|
916
|
+
|
917
|
+
- (<tt>Object</tt>) <strong>info_block</strong>(m1, m2 = 'Done.', multiline = false)
|
918
|
+
|
919
|
+
|
920
|
+
|
921
|
+
|
922
|
+
|
923
|
+
</h3><div class="docstring">
|
924
|
+
<div class="discussion">
|
925
|
+
<hr>
|
926
|
+
|
927
|
+
<pre class="code ruby"><code class="ruby">info_block method
|
928
|
+
|
929
|
+
Wraps a block in an opening and closing info message.
|
930
|
+
@param m1 The opening message to output
|
931
|
+
@param m2 The closing message to output
|
932
|
+
@param multiline Whether the message should be multiline
|
933
|
+
@return Void
|
934
|
+
----------------------------------------------------</code></pre>
|
935
|
+
|
936
|
+
|
937
|
+
</div>
|
938
|
+
</div>
|
939
|
+
<div class="tags">
|
940
|
+
|
941
|
+
|
942
|
+
</div><table class="source_code">
|
943
|
+
<tr>
|
944
|
+
<td>
|
945
|
+
<pre class="lines">
|
946
|
+
|
947
|
+
|
948
|
+
93
|
949
|
+
94
|
950
|
+
95
|
951
|
+
96
|
952
|
+
97
|
953
|
+
98
|
954
|
+
99
|
955
|
+
100
|
956
|
+
101
|
957
|
+
102
|
958
|
+
103
|
959
|
+
104
|
960
|
+
105
|
961
|
+
106
|
962
|
+
107
|
963
|
+
108
|
964
|
+
109
|
965
|
+
110
|
966
|
+
111</pre>
|
967
|
+
</td>
|
968
|
+
<td>
|
969
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 93</span>
|
970
|
+
|
971
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_info_block'>info_block</span><span class='lparen'>(</span><span class='id identifier rubyid_m1'>m1</span><span class='comma'>,</span> <span class='id identifier rubyid_m2'>m2</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='comma'>,</span> <span class='id identifier rubyid_multiline'>multiline</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
972
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
973
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_multiline'>multiline</span>
|
974
|
+
<span class='id identifier rubyid_info'>info</span><span class='lparen'>(</span><span class='id identifier rubyid_m1'>m1</span><span class='rparen'>)</span>
|
975
|
+
<span class='kw'>else</span>
|
976
|
+
<span class='id identifier rubyid_print'>print</span> <span class='id identifier rubyid__word_wrap'>_word_wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_m1'>m1</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'># </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_blue'>blue</span>
|
977
|
+
<span class='kw'>end</span>
|
978
|
+
|
979
|
+
<span class='kw'>yield</span>
|
980
|
+
|
981
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_multiline'>multiline</span>
|
982
|
+
<span class='id identifier rubyid_info'>info</span><span class='lparen'>(</span><span class='id identifier rubyid_m2'>m2</span><span class='rparen'>)</span>
|
983
|
+
<span class='kw'>else</span>
|
984
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid__word_wrap'>_word_wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_m2'>m2</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'># </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_blue'>blue</span>
|
985
|
+
<span class='kw'>end</span>
|
986
|
+
<span class='kw'>else</span>
|
987
|
+
<span class='id identifier rubyid_fail'>fail</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Did not specify a valid block</span><span class='tstring_end'>'</span></span>
|
988
|
+
<span class='kw'>end</span>
|
989
|
+
<span class='kw'>end</span></pre>
|
990
|
+
</td>
|
991
|
+
</tr>
|
992
|
+
</table>
|
993
|
+
</div>
|
994
|
+
|
995
|
+
<div class="method_details ">
|
996
|
+
<h3 class="signature " id="log-instance_method">
|
997
|
+
|
998
|
+
- (<tt>Object</tt>) <strong>log</strong>(m)
|
999
|
+
|
1000
|
+
|
1001
|
+
|
1002
|
+
|
1003
|
+
|
1004
|
+
</h3><div class="docstring">
|
1005
|
+
<div class="discussion">
|
1006
|
+
<hr>
|
1007
|
+
|
1008
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_log'>log</span> <span class='id identifier rubyid_method'>method</span>
|
1009
|
+
|
1010
|
+
<span class='const'>Empty</span> <span class='id identifier rubyid_method'>method</span> <span class='id identifier rubyid_so'>so</span> <span class='id identifier rubyid_that'>that</span> <span class='const'>Messenging</span> <span class='id identifier rubyid_doesn'>doesn</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>t freak
|
1011
|
+
out when passed a debug message.
|
1012
|
+
@return Void
|
1013
|
+
</span></span></code></pre>
|
1014
|
+
|
1015
|
+
|
1016
|
+
</div>
|
1017
|
+
</div>
|
1018
|
+
<div class="tags">
|
1019
|
+
|
1020
|
+
|
1021
|
+
</div><table class="source_code">
|
1022
|
+
<tr>
|
1023
|
+
<td>
|
1024
|
+
<pre class="lines">
|
1025
|
+
|
1026
|
+
|
1027
|
+
120</pre>
|
1028
|
+
</td>
|
1029
|
+
<td>
|
1030
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 120</span>
|
1031
|
+
|
1032
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_log'>log</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
1033
|
+
</td>
|
1034
|
+
</tr>
|
1035
|
+
</table>
|
1036
|
+
</div>
|
1037
|
+
|
1038
|
+
<div class="method_details ">
|
1039
|
+
<h3 class="signature " id="prompt-instance_method">
|
1040
|
+
|
1041
|
+
- (<tt>Object</tt>) <strong>prompt</strong>(prompt, default = nil, start_dir = '')
|
1042
|
+
|
1043
|
+
|
1044
|
+
|
1045
|
+
|
1046
|
+
|
1047
|
+
</h3><div class="docstring">
|
1048
|
+
<div class="discussion">
|
1049
|
+
<hr>
|
1050
|
+
|
1051
|
+
<pre class="code ruby"><code class="ruby">prompt method
|
1052
|
+
|
1053
|
+
Outputs a prompt, collects the user's response, and
|
1054
|
+
returns it.
|
1055
|
+
@param prompt The prompt to output
|
1056
|
+
@param default The default option
|
1057
|
+
@return String
|
1058
|
+
----------------------------------------------------</code></pre>
|
1059
|
+
|
1060
|
+
|
1061
|
+
</div>
|
1062
|
+
</div>
|
1063
|
+
<div class="tags">
|
1064
|
+
|
1065
|
+
|
1066
|
+
</div><table class="source_code">
|
1067
|
+
<tr>
|
1068
|
+
<td>
|
1069
|
+
<pre class="lines">
|
1070
|
+
|
1071
|
+
|
1072
|
+
131
|
1073
|
+
132
|
1074
|
+
133
|
1075
|
+
134
|
1076
|
+
135
|
1077
|
+
136
|
1078
|
+
137
|
1079
|
+
138
|
1080
|
+
139
|
1081
|
+
140
|
1082
|
+
141
|
1083
|
+
142
|
1084
|
+
143
|
1085
|
+
144
|
1086
|
+
145</pre>
|
1087
|
+
</td>
|
1088
|
+
<td>
|
1089
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 131</span>
|
1090
|
+
|
1091
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_prompt'>prompt</span><span class='lparen'>(</span><span class='id identifier rubyid_prompt'>prompt</span><span class='comma'>,</span> <span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_start_dir'>start_dir</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
1092
|
+
<span class='const'>Readline</span><span class='period'>.</span><span class='id identifier rubyid_completion_append_character'>completion_append_character</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
1093
|
+
<span class='const'>Readline</span><span class='period'>.</span><span class='id identifier rubyid_completion_proc'>completion_proc</span> <span class='op'>=</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_prefix'>prefix</span><span class='op'>|</span>
|
1094
|
+
<span class='id identifier rubyid_files'>files</span> <span class='op'>=</span> <span class='const'>Dir</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_start_dir'>start_dir</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>*</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
1095
|
+
<span class='id identifier rubyid_files'>files</span><span class='period'>.</span>
|
1096
|
+
<span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='period'>.</span>
|
1097
|
+
<span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_directory?'>directory?</span><span class='lparen'>(</span><span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_f'>f</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='id identifier rubyid_f'>f</span> <span class='rbrace'>}</span>
|
1098
|
+
<span class='kw'>end</span>
|
1099
|
+
<span class='id identifier rubyid_choice'>choice</span> <span class='op'>=</span> <span class='const'>Readline</span><span class='period'>.</span><span class='id identifier rubyid_readline'>readline</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'># </span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_prompt'>prompt</span> <span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_default'>default</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> [default: </span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_default'>default</span> <span class='embexpr_end'>}</span><span class='tstring_content'>]:</span><span class='tstring_end'>"</span></span> <span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_cyan'>cyan</span><span class='rparen'>)</span>
|
1100
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_choice'>choice</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
1101
|
+
<span class='id identifier rubyid_default'>default</span>
|
1102
|
+
<span class='kw'>else</span>
|
1103
|
+
<span class='id identifier rubyid_choice'>choice</span>
|
1104
|
+
<span class='kw'>end</span>
|
1105
|
+
<span class='kw'>end</span></pre>
|
1106
|
+
</td>
|
1107
|
+
</tr>
|
1108
|
+
</table>
|
1109
|
+
</div>
|
1110
|
+
|
1111
|
+
<div class="method_details ">
|
1112
|
+
<h3 class="signature " id="section-instance_method">
|
1113
|
+
|
1114
|
+
- (<tt>Object</tt>) <strong>section</strong>(m)
|
1115
|
+
|
1116
|
+
|
1117
|
+
|
1118
|
+
|
1119
|
+
|
1120
|
+
</h3><div class="docstring">
|
1121
|
+
<div class="discussion">
|
1122
|
+
<hr>
|
1123
|
+
|
1124
|
+
<pre class="code ruby"><code class="ruby">section method
|
1125
|
+
|
1126
|
+
Outputs a formatted-purple section message.
|
1127
|
+
@param m The message to output
|
1128
|
+
@return Void
|
1129
|
+
----------------------------------------------------</code></pre>
|
1130
|
+
|
1131
|
+
|
1132
|
+
</div>
|
1133
|
+
</div>
|
1134
|
+
<div class="tags">
|
1135
|
+
|
1136
|
+
|
1137
|
+
</div><table class="source_code">
|
1138
|
+
<tr>
|
1139
|
+
<td>
|
1140
|
+
<pre class="lines">
|
1141
|
+
|
1142
|
+
|
1143
|
+
154
|
1144
|
+
155
|
1145
|
+
156</pre>
|
1146
|
+
</td>
|
1147
|
+
<td>
|
1148
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 154</span>
|
1149
|
+
|
1150
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_section'>section</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span>
|
1151
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid__word_wrap'>_word_wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>---> </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_purple'>purple</span>
|
1152
|
+
<span class='kw'>end</span></pre>
|
1153
|
+
</td>
|
1154
|
+
</tr>
|
1155
|
+
</table>
|
1156
|
+
</div>
|
1157
|
+
|
1158
|
+
<div class="method_details ">
|
1159
|
+
<h3 class="signature " id="section_block-instance_method">
|
1160
|
+
|
1161
|
+
- (<tt>Object</tt>) <strong>section_block</strong>(m, multiline = true)
|
1162
|
+
|
1163
|
+
|
1164
|
+
|
1165
|
+
|
1166
|
+
|
1167
|
+
</h3><div class="docstring">
|
1168
|
+
<div class="discussion">
|
1169
|
+
<hr>
|
1170
|
+
|
1171
|
+
<pre class="code ruby"><code class="ruby">section_block method
|
1172
|
+
|
1173
|
+
Wraps a block in an opening and closing section
|
1174
|
+
message.
|
1175
|
+
@param m1 The opening message to output
|
1176
|
+
@param m2 The closing message to output
|
1177
|
+
@param multiline A multiline message or not
|
1178
|
+
@return Void
|
1179
|
+
----------------------------------------------------</code></pre>
|
1180
|
+
|
1181
|
+
|
1182
|
+
</div>
|
1183
|
+
</div>
|
1184
|
+
<div class="tags">
|
1185
|
+
|
1186
|
+
|
1187
|
+
</div><table class="source_code">
|
1188
|
+
<tr>
|
1189
|
+
<td>
|
1190
|
+
<pre class="lines">
|
1191
|
+
|
1192
|
+
|
1193
|
+
168
|
1194
|
+
169
|
1195
|
+
170
|
1196
|
+
171
|
1197
|
+
172
|
1198
|
+
173
|
1199
|
+
174
|
1200
|
+
175
|
1201
|
+
176
|
1202
|
+
177
|
1203
|
+
178
|
1204
|
+
179
|
1205
|
+
180</pre>
|
1206
|
+
</td>
|
1207
|
+
<td>
|
1208
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 168</span>
|
1209
|
+
|
1210
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_section_block'>section_block</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='id identifier rubyid_multiline'>multiline</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1211
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
1212
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_multiline'>multiline</span>
|
1213
|
+
<span class='id identifier rubyid_section'>section</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span>
|
1214
|
+
<span class='kw'>else</span>
|
1215
|
+
<span class='id identifier rubyid_print'>print</span> <span class='id identifier rubyid__word_wrap'>_word_wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>---> </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_purple'>purple</span>
|
1216
|
+
<span class='kw'>end</span>
|
1217
|
+
|
1218
|
+
<span class='kw'>yield</span>
|
1219
|
+
<span class='kw'>else</span>
|
1220
|
+
<span class='id identifier rubyid_fail'>fail</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Did not specify a valid block</span><span class='tstring_end'>'</span></span>
|
1221
|
+
<span class='kw'>end</span>
|
1222
|
+
<span class='kw'>end</span></pre>
|
1223
|
+
</td>
|
1224
|
+
</tr>
|
1225
|
+
</table>
|
1226
|
+
</div>
|
1227
|
+
|
1228
|
+
<div class="method_details ">
|
1229
|
+
<h3 class="signature " id="success-instance_method">
|
1230
|
+
|
1231
|
+
- (<tt>Object</tt>) <strong>success</strong>(m)
|
1232
|
+
|
1233
|
+
|
1234
|
+
|
1235
|
+
|
1236
|
+
|
1237
|
+
</h3><div class="docstring">
|
1238
|
+
<div class="discussion">
|
1239
|
+
<hr>
|
1240
|
+
|
1241
|
+
<pre class="code ruby"><code class="ruby">success method
|
1242
|
+
|
1243
|
+
Outputs a formatted-green success message.
|
1244
|
+
@param m The message to output
|
1245
|
+
@return Void
|
1246
|
+
----------------------------------------------------</code></pre>
|
1247
|
+
|
1248
|
+
|
1249
|
+
</div>
|
1250
|
+
</div>
|
1251
|
+
<div class="tags">
|
1252
|
+
|
1253
|
+
|
1254
|
+
</div><table class="source_code">
|
1255
|
+
<tr>
|
1256
|
+
<td>
|
1257
|
+
<pre class="lines">
|
1258
|
+
|
1259
|
+
|
1260
|
+
189
|
1261
|
+
190
|
1262
|
+
191</pre>
|
1263
|
+
</td>
|
1264
|
+
<td>
|
1265
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 189</span>
|
1266
|
+
|
1267
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_success'>success</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span>
|
1268
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid__word_wrap'>_word_wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'># </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_green'>green</span>
|
1269
|
+
<span class='kw'>end</span></pre>
|
1270
|
+
</td>
|
1271
|
+
</tr>
|
1272
|
+
</table>
|
1273
|
+
</div>
|
1274
|
+
|
1275
|
+
<div class="method_details ">
|
1276
|
+
<h3 class="signature " id="warn-instance_method">
|
1277
|
+
|
1278
|
+
- (<tt>Object</tt>) <strong>warn</strong>(m)
|
1279
|
+
|
1280
|
+
|
1281
|
+
|
1282
|
+
|
1283
|
+
|
1284
|
+
</h3><div class="docstring">
|
1285
|
+
<div class="discussion">
|
1286
|
+
<hr>
|
1287
|
+
|
1288
|
+
<pre class="code ruby"><code class="ruby">warning method
|
1289
|
+
|
1290
|
+
Outputs a formatted-yellow warning message.
|
1291
|
+
@param m The message to output
|
1292
|
+
@return Void
|
1293
|
+
----------------------------------------------------</code></pre>
|
1294
|
+
|
1295
|
+
|
1296
|
+
</div>
|
1297
|
+
</div>
|
1298
|
+
<div class="tags">
|
1299
|
+
|
1300
|
+
|
1301
|
+
</div><table class="source_code">
|
1302
|
+
<tr>
|
1303
|
+
<td>
|
1304
|
+
<pre class="lines">
|
1305
|
+
|
1306
|
+
|
1307
|
+
200
|
1308
|
+
201
|
1309
|
+
202</pre>
|
1310
|
+
</td>
|
1311
|
+
<td>
|
1312
|
+
<pre class="code"><span class="info file"># File 'lib/cliutils/pretty-io.rb', line 200</span>
|
1313
|
+
|
1314
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span>
|
1315
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid__word_wrap'>_word_wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'># </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_yellow'>yellow</span>
|
1316
|
+
<span class='kw'>end</span></pre>
|
1317
|
+
</td>
|
1318
|
+
</tr>
|
1319
|
+
</table>
|
1320
|
+
</div>
|
1321
|
+
|
1322
|
+
</div>
|
1323
|
+
|
1324
|
+
</div>
|
1325
|
+
|
1326
|
+
<div id="footer">
|
1327
|
+
Generated on Sat Mar 29 17:22:03 2014 by
|
1328
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1329
|
+
0.8.7.4 (ruby-2.1.0).
|
1330
|
+
</div>
|
1331
|
+
|
1332
|
+
</body>
|
1333
|
+
</html>
|