ttycoke 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (75) hide show
  1. data/.gitignore +16 -0
  2. data/.togglerc +10 -0
  3. data/.tork.rb +2 -0
  4. data/.travis.yml +6 -0
  5. data/LICENSE +21 -0
  6. data/README.md +150 -0
  7. data/Rakefile +25 -0
  8. data/bin/ttycoke +10 -0
  9. data/config/config.yaml +5 -0
  10. data/config/ttycoke.d/id.yaml +4 -0
  11. data/config/ttycoke.d/lsmod.yaml +3 -0
  12. data/config/ttycoke.d/tail_focus.yaml +14 -0
  13. data/config/ttycoke.d/tail_tork_logs.yaml +26 -0
  14. data/config/ttycoke.d/top.yaml +8 -0
  15. data/doc/TTYCoke/ANSI.html +598 -0
  16. data/doc/TTYCoke/ANSIColor.html +586 -0
  17. data/doc/TTYCoke/CLI.html +242 -0
  18. data/doc/TTYCoke/Config/Configuration.html +210 -0
  19. data/doc/TTYCoke/Config.html +347 -0
  20. data/doc/TTYCoke/Errors/CustomizationFailed.html +135 -0
  21. data/doc/TTYCoke/Errors/FallbackError.html +216 -0
  22. data/doc/TTYCoke/Errors/ProgramNotFoundError.html +216 -0
  23. data/doc/TTYCoke/Errors/TTYCokeError.html +206 -0
  24. data/doc/TTYCoke/Errors/TTYCokeTypeError.html +216 -0
  25. data/doc/TTYCoke/Errors/YamlSyntaxError.html +216 -0
  26. data/doc/TTYCoke/Errors.html +106 -0
  27. data/doc/TTYCoke/LineParser.html +210 -0
  28. data/doc/TTYCoke/Log.html +391 -0
  29. data/doc/TTYCoke/Parser.html +210 -0
  30. data/doc/TTYCoke/Platform.html +398 -0
  31. data/doc/TTYCoke/Run.html +198 -0
  32. data/doc/TTYCoke/TTYCokeLogFormat.html +204 -0
  33. data/doc/TTYCoke/Version.html +136 -0
  34. data/doc/TTYCoke.html +110 -0
  35. data/doc/_index.html +279 -0
  36. data/doc/class_list.html +47 -0
  37. data/doc/css/common.css +1 -0
  38. data/doc/css/full_list.css +55 -0
  39. data/doc/css/style.css +322 -0
  40. data/doc/file.README.html +153 -0
  41. data/doc/file_list.html +49 -0
  42. data/doc/frames.html +13 -0
  43. data/doc/index.html +153 -0
  44. data/doc/js/app.js +205 -0
  45. data/doc/js/full_list.js +167 -0
  46. data/doc/js/jquery.js +16 -0
  47. data/doc/method_list.html +238 -0
  48. data/doc/top-level-namespace.html +130 -0
  49. data/lib/ttycoke/ansi.rb +127 -0
  50. data/lib/ttycoke/cli.rb +33 -0
  51. data/lib/ttycoke/config.rb +39 -0
  52. data/lib/ttycoke/errors.rb +40 -0
  53. data/lib/ttycoke/import.rb +72 -0
  54. data/lib/ttycoke/log.rb +84 -0
  55. data/lib/ttycoke/parser.rb +59 -0
  56. data/lib/ttycoke/platform.rb +33 -0
  57. data/lib/ttycoke/run.rb +59 -0
  58. data/lib/ttycoke/version.rb +10 -0
  59. data/lib/ttycoke.rb +15 -0
  60. data/test/data/ansi_lines.yaml +12 -0
  61. data/test/data/config.yaml +4 -0
  62. data/test/data/syntax_error_config.yaml +6 -0
  63. data/test/data/ttycoke.d/id.yaml +4 -0
  64. data/test/data/ttycoke.d/lsmod.yaml +3 -0
  65. data/test/data/ttycoke.d/tail_focus.yaml +14 -0
  66. data/test/data/ttycoke.d/tail_tork_logs.yaml +26 -0
  67. data/test/data/ttycoke.d/top.yaml +8 -0
  68. data/test/test_helper.rb +14 -0
  69. data/test/ttycoke/test_ansi.rb +89 -0
  70. data/test/ttycoke/test_cli.rb +8 -0
  71. data/test/ttycoke/test_config.rb +23 -0
  72. data/test/ttycoke/test_log.rb +22 -0
  73. data/test/ttycoke/test_parser.rb +24 -0
  74. data/ttycoke.gemspec +16 -0
  75. metadata +120 -0
data/doc/TTYCoke/ANSI.html ADDED
@@ -0,0 +1,598 @@
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: TTYCoke::ANSI
8
+
9
+ &mdash; TTYCoke Documentation
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (A)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../TTYCoke.html" title="TTYCoke (module)">TTYCoke</a></span></span>
38
+ &raquo;
39
+ <span class="title">ANSI</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Module: TTYCoke::ANSI
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+ <dt class="r1">Extended by:</dt>
70
+ <dd class="r1"><span class='object_link'><a href="" title="TTYCoke::ANSI (module)">ANSI</a></span></dd>
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dt class="r2">Included in:</dt>
78
+ <dd class="r2"><span class='object_link'><a href="" title="TTYCoke::ANSI (module)">ANSI</a></span></dd>
79
+
80
+
81
+
82
+ <dt class="r1 last">Defined in:</dt>
83
+ <dd class="r1 last">lib/ttycoke/ansi.rb</dd>
84
+
85
+ </dl>
86
+ <div class="clear"></div>
87
+
88
+
89
+ <h2>Constant Summary</h2>
90
+
91
+ <dl class="constants">
92
+
93
+ <dt id="ATTRIBUTES-constant" class="">ATTRIBUTES =
94
+ <div class="docstring">
95
+ <div class="discussion">
96
+
97
+ <p>Most of this section was taken from: <a
98
+ href="https://github.com/flori/term-ansicolor">github.com/flori/term-ansicolor</a></p>
99
+
100
+
101
+ </div>
102
+ </div>
103
+ <div class="tags">
104
+
105
+
106
+ </div>
107
+ </dt>
108
+ <dd><pre class="code"><span class='lbracket'>[</span>
109
+ <span class='lbracket'>[</span> <span class='symbol'>:clear</span> <span class='comma'>,</span> <span class='int'>0</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># String#clear is already used to empty string.
110
+ </span> <span class='lbracket'>[</span> <span class='symbol'>:reset</span> <span class='comma'>,</span> <span class='int'>0</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># synonym for :clear
111
+ </span> <span class='lbracket'>[</span> <span class='symbol'>:bold</span> <span class='comma'>,</span> <span class='int'>1</span> <span class='rbracket'>]</span><span class='comma'>,</span>
112
+ <span class='lbracket'>[</span> <span class='symbol'>:dark</span> <span class='comma'>,</span> <span class='int'>2</span> <span class='rbracket'>]</span><span class='comma'>,</span>
113
+ <span class='lbracket'>[</span> <span class='symbol'>:italic</span> <span class='comma'>,</span> <span class='int'>3</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># not widely implemented
114
+ </span> <span class='lbracket'>[</span> <span class='symbol'>:underline</span> <span class='comma'>,</span> <span class='int'>4</span> <span class='rbracket'>]</span><span class='comma'>,</span>
115
+ <span class='lbracket'>[</span> <span class='symbol'>:underscore</span> <span class='comma'>,</span> <span class='int'>4</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># synonym for :underline
116
+ </span> <span class='lbracket'>[</span> <span class='symbol'>:blink</span> <span class='comma'>,</span> <span class='int'>5</span> <span class='rbracket'>]</span><span class='comma'>,</span>
117
+ <span class='lbracket'>[</span> <span class='symbol'>:rapid_blink</span> <span class='comma'>,</span> <span class='int'>6</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># not widely implemented
118
+ </span> <span class='lbracket'>[</span> <span class='symbol'>:negative</span> <span class='comma'>,</span> <span class='int'>7</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># no reverse because of String#reverse
119
+ </span> <span class='lbracket'>[</span> <span class='symbol'>:concealed</span> <span class='comma'>,</span> <span class='int'>8</span> <span class='rbracket'>]</span><span class='comma'>,</span>
120
+ <span class='lbracket'>[</span> <span class='symbol'>:strikethrough</span> <span class='comma'>,</span> <span class='int'>9</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># not widely implemented
121
+ </span> <span class='lbracket'>[</span> <span class='symbol'>:black</span> <span class='comma'>,</span> <span class='int'>30</span> <span class='rbracket'>]</span><span class='comma'>,</span>
122
+ <span class='lbracket'>[</span> <span class='symbol'>:red</span> <span class='comma'>,</span> <span class='int'>31</span> <span class='rbracket'>]</span><span class='comma'>,</span>
123
+ <span class='lbracket'>[</span> <span class='symbol'>:green</span> <span class='comma'>,</span> <span class='int'>32</span> <span class='rbracket'>]</span><span class='comma'>,</span>
124
+ <span class='lbracket'>[</span> <span class='symbol'>:yellow</span> <span class='comma'>,</span> <span class='int'>33</span> <span class='rbracket'>]</span><span class='comma'>,</span>
125
+ <span class='lbracket'>[</span> <span class='symbol'>:blue</span> <span class='comma'>,</span> <span class='int'>34</span> <span class='rbracket'>]</span><span class='comma'>,</span>
126
+ <span class='lbracket'>[</span> <span class='symbol'>:magenta</span> <span class='comma'>,</span> <span class='int'>35</span> <span class='rbracket'>]</span><span class='comma'>,</span>
127
+ <span class='lbracket'>[</span> <span class='symbol'>:cyan</span> <span class='comma'>,</span> <span class='int'>36</span> <span class='rbracket'>]</span><span class='comma'>,</span>
128
+ <span class='lbracket'>[</span> <span class='symbol'>:white</span> <span class='comma'>,</span> <span class='int'>37</span> <span class='rbracket'>]</span><span class='comma'>,</span>
129
+ <span class='lbracket'>[</span> <span class='symbol'>:on_black</span> <span class='comma'>,</span> <span class='int'>40</span> <span class='rbracket'>]</span><span class='comma'>,</span>
130
+ <span class='lbracket'>[</span> <span class='symbol'>:on_red</span> <span class='comma'>,</span> <span class='int'>41</span> <span class='rbracket'>]</span><span class='comma'>,</span>
131
+ <span class='lbracket'>[</span> <span class='symbol'>:on_green</span> <span class='comma'>,</span> <span class='int'>42</span> <span class='rbracket'>]</span><span class='comma'>,</span>
132
+ <span class='lbracket'>[</span> <span class='symbol'>:on_yellow</span> <span class='comma'>,</span> <span class='int'>43</span> <span class='rbracket'>]</span><span class='comma'>,</span>
133
+ <span class='lbracket'>[</span> <span class='symbol'>:on_blue</span> <span class='comma'>,</span> <span class='int'>44</span> <span class='rbracket'>]</span><span class='comma'>,</span>
134
+ <span class='lbracket'>[</span> <span class='symbol'>:on_magenta</span> <span class='comma'>,</span> <span class='int'>45</span> <span class='rbracket'>]</span><span class='comma'>,</span>
135
+ <span class='lbracket'>[</span> <span class='symbol'>:on_cyan</span> <span class='comma'>,</span> <span class='int'>46</span> <span class='rbracket'>]</span><span class='comma'>,</span>
136
+ <span class='lbracket'>[</span> <span class='symbol'>:on_white</span> <span class='comma'>,</span> <span class='int'>47</span> <span class='rbracket'>]</span><span class='comma'>,</span>
137
+ <span class='lbracket'>[</span> <span class='symbol'>:intense_black</span> <span class='comma'>,</span> <span class='int'>90</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># High intensity, aixterm (OS X)
138
+ </span> <span class='lbracket'>[</span> <span class='symbol'>:intense_red</span> <span class='comma'>,</span> <span class='int'>91</span> <span class='rbracket'>]</span><span class='comma'>,</span>
139
+ <span class='lbracket'>[</span> <span class='symbol'>:intense_green</span> <span class='comma'>,</span> <span class='int'>92</span> <span class='rbracket'>]</span><span class='comma'>,</span>
140
+ <span class='lbracket'>[</span> <span class='symbol'>:intense_yellow</span> <span class='comma'>,</span> <span class='int'>93</span> <span class='rbracket'>]</span><span class='comma'>,</span>
141
+ <span class='lbracket'>[</span> <span class='symbol'>:intense_blue</span> <span class='comma'>,</span> <span class='int'>94</span> <span class='rbracket'>]</span><span class='comma'>,</span>
142
+ <span class='lbracket'>[</span> <span class='symbol'>:intense_magenta</span> <span class='comma'>,</span> <span class='int'>95</span> <span class='rbracket'>]</span><span class='comma'>,</span>
143
+ <span class='lbracket'>[</span> <span class='symbol'>:intense_cyan</span> <span class='comma'>,</span> <span class='int'>96</span> <span class='rbracket'>]</span><span class='comma'>,</span>
144
+ <span class='lbracket'>[</span> <span class='symbol'>:intense_white</span> <span class='comma'>,</span> <span class='int'>97</span> <span class='rbracket'>]</span><span class='comma'>,</span>
145
+ <span class='lbracket'>[</span> <span class='symbol'>:on_intense_black</span> <span class='comma'>,</span> <span class='int'>100</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># High intensity background, aixterm (OS X)
146
+ </span> <span class='lbracket'>[</span> <span class='symbol'>:on_intense_red</span> <span class='comma'>,</span> <span class='int'>101</span> <span class='rbracket'>]</span><span class='comma'>,</span>
147
+ <span class='lbracket'>[</span> <span class='symbol'>:on_intense_green</span> <span class='comma'>,</span> <span class='int'>102</span> <span class='rbracket'>]</span><span class='comma'>,</span>
148
+ <span class='lbracket'>[</span> <span class='symbol'>:on_intense_yellow</span> <span class='comma'>,</span> <span class='int'>103</span> <span class='rbracket'>]</span><span class='comma'>,</span>
149
+ <span class='lbracket'>[</span> <span class='symbol'>:on_intense_blue</span> <span class='comma'>,</span> <span class='int'>104</span> <span class='rbracket'>]</span><span class='comma'>,</span>
150
+ <span class='lbracket'>[</span> <span class='symbol'>:on_intense_magenta</span> <span class='comma'>,</span> <span class='int'>105</span> <span class='rbracket'>]</span><span class='comma'>,</span>
151
+ <span class='lbracket'>[</span> <span class='symbol'>:on_intense_cyan</span> <span class='comma'>,</span> <span class='int'>106</span> <span class='rbracket'>]</span><span class='comma'>,</span>
152
+ <span class='lbracket'>[</span> <span class='symbol'>:on_intense_white</span> <span class='comma'>,</span> <span class='int'>107</span> <span class='rbracket'>]</span>
153
+ <span class='rbracket'>]</span></pre></dd>
154
+
155
+ <dt id="ATTRIBUTE_NAMES-constant" class="">ATTRIBUTE_NAMES =
156
+
157
+ </dt>
158
+ <dd><pre class="code"><span class='const'>ATTRIBUTES</span><span class='period'>.</span><span class='id identifier rubyid_transpose'>transpose</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span></pre></dd>
159
+
160
+ <dt id="COLORED_REGEXP-constant" class="">COLORED_REGEXP =
161
+ <div class="docstring">
162
+ <div class="discussion">
163
+
164
+ <p>Regular expression that is used to scan for ANSI-sequences while uncoloring
165
+ strings.</p>
166
+
167
+
168
+ </div>
169
+ </div>
170
+ <div class="tags">
171
+
172
+
173
+ </div>
174
+ </dt>
175
+ <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\e\[(?:(?:[349]|10)[0-7]|[0-9])?m</span><span class='regexp_end'>/</span></span></pre></dd>
176
+
177
+ </dl>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+ <h2>
186
+ Class Method Summary
187
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
188
+ </h2>
189
+
190
+ <ul class="summary">
191
+
192
+ <li class="public ">
193
+ <span class="summary_signature">
194
+
195
+ <a href="#coloring%3D-class_method" title="coloring= (class method)">+ (Object) <strong>coloring=</strong>(val) </a>
196
+
197
+
198
+
199
+ </span>
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+ <span class="summary_desc"><div class='inline'>
209
+ <p>Turns the coloring on or off globally, so you can easily do this for
210
+ example:.</p>
211
+ </div></span>
212
+
213
+ </li>
214
+
215
+
216
+ <li class="public ">
217
+ <span class="summary_signature">
218
+
219
+ <a href="#coloring%3F-class_method" title="coloring? (class method)">+ (Boolean) <strong>coloring?</strong> </a>
220
+
221
+
222
+
223
+ </span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+ <span class="summary_desc"><div class='inline'>
233
+ <p>Returns true, if the coloring function of this module is switched on, false
234
+ otherwise.</p>
235
+ </div></span>
236
+
237
+ </li>
238
+
239
+
240
+ </ul>
241
+
242
+ <h2>
243
+ Instance Method Summary
244
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
245
+ </h2>
246
+
247
+ <ul class="summary">
248
+
249
+ <li class="public ">
250
+ <span class="summary_signature">
251
+
252
+ <a href="#attributes-instance_method" title="#attributes (instance method)">- (Object) <strong>attributes</strong> </a>
253
+
254
+
255
+
256
+ </span>
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+ <span class="summary_desc"><div class='inline'>
266
+ <p>Returns an array of all TTYCoke::ANSIColor attributes as symbols.</p>
267
+ </div></span>
268
+
269
+ </li>
270
+
271
+
272
+ <li class="public ">
273
+ <span class="summary_signature">
274
+
275
+ <a href="#support%3F-instance_method" title="#support? (instance method)">- (Boolean) <strong>support?</strong>(feature) </a>
276
+
277
+
278
+
279
+ </span>
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+ <span class="summary_desc"><div class='inline'>
289
+ <p>Returns true if TTYCoke::ANSIColor supports the <tt>feature</tt>.</p>
290
+ </div></span>
291
+
292
+ </li>
293
+
294
+
295
+ <li class="public ">
296
+ <span class="summary_signature">
297
+
298
+ <a href="#uncolored-instance_method" title="#uncolored (instance method)">- (Object) <strong>uncolored</strong>(string = nil) </a>
299
+
300
+
301
+
302
+ </span>
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+ <span class="summary_desc"><div class='inline'>
312
+ <p>Returns an uncolored version of the string, that is all ANSI-sequences are
313
+ stripped from the string.</p>
314
+ </div></span>
315
+
316
+ </li>
317
+
318
+
319
+ </ul>
320
+
321
+
322
+
323
+
324
+ <div id="class_method_details" class="method_details_list">
325
+ <h2>Class Method Details</h2>
326
+
327
+
328
+ <div class="method_details first">
329
+ <p class="signature first" id="coloring=-class_method">
330
+
331
+ + (<tt>Object</tt>) <strong>coloring=</strong>(val)
332
+
333
+
334
+
335
+ </p><div class="docstring">
336
+ <div class="discussion">
337
+
338
+ <p>Turns the coloring on or off globally, so you can easily do this for
339
+ example:</p>
340
+
341
+ <pre class="code"><span class='const'>TTYCoke</span><span class='op'>::</span><span class='const'>ANSI</span><span class='op'>::</span><span class='id identifier rubyid_coloring'>coloring</span> <span class='op'>=</span> <span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_isatty'>isatty</span></pre>
342
+
343
+
344
+ </div>
345
+ </div>
346
+ <div class="tags">
347
+
348
+
349
+ </div><table class="source_code">
350
+ <tr>
351
+ <td>
352
+ <pre class="lines">
353
+
354
+
355
+ 76
356
+ 77
357
+ 78</pre>
358
+ </td>
359
+ <td>
360
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi.rb', line 76</span>
361
+
362
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_coloring='>coloring=</span><span class='lparen'>(</span><span class='id identifier rubyid_val'>val</span><span class='rparen'>)</span>
363
+ <span class='ivar'>@coloring</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span>
364
+ <span class='kw'>end</span></pre>
365
+ </td>
366
+ </tr>
367
+ </table>
368
+ </div>
369
+
370
+ <div class="method_details ">
371
+ <p class="signature " id="coloring?-class_method">
372
+
373
+ + (<tt>Boolean</tt>) <strong>coloring?</strong>
374
+
375
+
376
+
377
+ </p><div class="docstring">
378
+ <div class="discussion">
379
+
380
+ <p>Returns true, if the coloring function of this module is switched on, false
381
+ otherwise.</p>
382
+
383
+
384
+ </div>
385
+ </div>
386
+ <div class="tags">
387
+
388
+ <h3>Returns:</h3>
389
+ <ul class="return">
390
+
391
+ <li>
392
+
393
+
394
+ <span class='type'>(<tt>Boolean</tt>)</span>
395
+
396
+
397
+
398
+ </li>
399
+
400
+ </ul>
401
+
402
+ </div><table class="source_code">
403
+ <tr>
404
+ <td>
405
+ <pre class="lines">
406
+
407
+
408
+ 69
409
+ 70
410
+ 71</pre>
411
+ </td>
412
+ <td>
413
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi.rb', line 69</span>
414
+
415
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_coloring?'>coloring?</span>
416
+ <span class='ivar'>@coloring</span>
417
+ <span class='kw'>end</span></pre>
418
+ </td>
419
+ </tr>
420
+ </table>
421
+ </div>
422
+
423
+ </div>
424
+
425
+ <div id="instance_method_details" class="method_details_list">
426
+ <h2>Instance Method Details</h2>
427
+
428
+
429
+ <div class="method_details first">
430
+ <p class="signature first" id="attributes-instance_method">
431
+
432
+ - (<tt>Object</tt>) <strong>attributes</strong>
433
+
434
+
435
+
436
+ </p><div class="docstring">
437
+ <div class="discussion">
438
+
439
+ <p>Returns an array of all TTYCoke::ANSIColor attributes as symbols.</p>
440
+
441
+
442
+ </div>
443
+ </div>
444
+ <div class="tags">
445
+
446
+
447
+ </div><table class="source_code">
448
+ <tr>
449
+ <td>
450
+ <pre class="lines">
451
+
452
+
453
+ 122
454
+ 123
455
+ 124</pre>
456
+ </td>
457
+ <td>
458
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi.rb', line 122</span>
459
+
460
+ <span class='kw'>def</span> <span class='id identifier rubyid_attributes'>attributes</span>
461
+ <span class='const'>ATTRIBUTE_NAMES</span>
462
+ <span class='kw'>end</span></pre>
463
+ </td>
464
+ </tr>
465
+ </table>
466
+ </div>
467
+
468
+ <div class="method_details ">
469
+ <p class="signature " id="support?-instance_method">
470
+
471
+ - (<tt>Boolean</tt>) <strong>support?</strong>(feature)
472
+
473
+
474
+
475
+ </p><div class="docstring">
476
+ <div class="discussion">
477
+
478
+ <p>Returns true if TTYCoke::ANSIColor supports the <tt>feature</tt>.</p>
479
+
480
+ <p>The feature :clear, that is mixing the clear color attribute into String,
481
+ is only supported on ruby implementations, that do <b>not</b> already
482
+ implement the String#clear method. It's better to use the reset color
483
+ attribute instead.</p>
484
+
485
+
486
+ </div>
487
+ </div>
488
+ <div class="tags">
489
+
490
+ <h3>Returns:</h3>
491
+ <ul class="return">
492
+
493
+ <li>
494
+
495
+
496
+ <span class='type'>(<tt>Boolean</tt>)</span>
497
+
498
+
499
+
500
+ </li>
501
+
502
+ </ul>
503
+
504
+ </div><table class="source_code">
505
+ <tr>
506
+ <td>
507
+ <pre class="lines">
508
+
509
+
510
+ 61
511
+ 62
512
+ 63
513
+ 64
514
+ 65
515
+ 66</pre>
516
+ </td>
517
+ <td>
518
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi.rb', line 61</span>
519
+
520
+ <span class='kw'>def</span> <span class='id identifier rubyid_support?'>support?</span><span class='lparen'>(</span><span class='id identifier rubyid_feature'>feature</span><span class='rparen'>)</span>
521
+ <span class='kw'>case</span> <span class='id identifier rubyid_feature'>feature</span>
522
+ <span class='kw'>when</span> <span class='symbol'>:clear</span>
523
+ <span class='op'>!</span><span class='const'>String</span><span class='period'>.</span><span class='id identifier rubyid_instance_methods'>instance_methods</span><span class='lparen'>(</span><span class='kw'>false</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_sym</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:clear</span><span class='rparen'>)</span>
524
+ <span class='kw'>end</span>
525
+ <span class='kw'>end</span></pre>
526
+ </td>
527
+ </tr>
528
+ </table>
529
+ </div>
530
+
531
+ <div class="method_details ">
532
+ <p class="signature " id="uncolored-instance_method">
533
+
534
+ - (<tt>Object</tt>) <strong>uncolored</strong>(string = nil)
535
+
536
+
537
+
538
+ </p><div class="docstring">
539
+ <div class="discussion">
540
+
541
+ <p>Returns an uncolored version of the string, that is all ANSI-sequences are
542
+ stripped from the string.</p>
543
+
544
+
545
+ </div>
546
+ </div>
547
+ <div class="tags">
548
+
549
+
550
+ </div><table class="source_code">
551
+ <tr>
552
+ <td>
553
+ <pre class="lines">
554
+
555
+
556
+ 107
557
+ 108
558
+ 109
559
+ 110
560
+ 111
561
+ 112
562
+ 113
563
+ 114
564
+ 115
565
+ 116
566
+ 117</pre>
567
+ </td>
568
+ <td>
569
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi.rb', line 107</span>
570
+
571
+ <span class='kw'>def</span> <span class='id identifier rubyid_uncolored'>uncolored</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='comment'># :yields:
572
+ </span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
573
+ <span class='kw'>yield</span><span class='period'>.</span><span class='id identifier rubyid_to_str'>to_str</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='const'>COLORED_REGEXP</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
574
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:to_str</span><span class='rparen'>)</span>
575
+ <span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_to_str'>to_str</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='const'>COLORED_REGEXP</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
576
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:to_str</span><span class='rparen'>)</span>
577
+ <span class='id identifier rubyid_to_str'>to_str</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='const'>COLORED_REGEXP</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
578
+ <span class='kw'>else</span>
579
+ <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
580
+ <span class='kw'>end</span>
581
+ <span class='kw'>end</span></pre>
582
+ </td>
583
+ </tr>
584
+ </table>
585
+ </div>
586
+
587
+ </div>
588
+
589
+ </div>
590
+
591
+ <div id="footer">
592
+ Generated on Mon Jan 30 03:06:12 2012 by
593
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
594
+ 0.7.4 (ruby-1.9.3).
595
+ </div>
596
+
597
+ </body>
598
+ </html>