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/ANSIColor.html ADDED
@@ -0,0 +1,586 @@
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::ANSIColor
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">ANSIColor</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::ANSIColor
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::ANSIColor (module)">ANSIColor</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::ANSIColor (module)">ANSIColor</a></span></dd>
79
+
80
+
81
+
82
+ <dt class="r1 last">Defined in:</dt>
83
+ <dd class="r1 last">lib/ttycoke/ansi_color.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
+
95
+ </dt>
96
+ <dd><pre class="code"><span class='lbracket'>[</span>
97
+ <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.
98
+ </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
99
+ </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>
100
+ <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>
101
+ <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
102
+ </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>
103
+ <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
104
+ </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>
105
+ <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
106
+ </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
107
+ </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>
108
+ <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
109
+ </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>
110
+ <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>
111
+ <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>
112
+ <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>
113
+ <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>
114
+ <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>
115
+ <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>
116
+ <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>
117
+ <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>
118
+ <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>
119
+ <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>
120
+ <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>
121
+ <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>
122
+ <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>
123
+ <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>
124
+ <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>
125
+ <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)
126
+ </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>
127
+ <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>
128
+ <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>
129
+ <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>
130
+ <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>
131
+ <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>
132
+ <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>
133
+ <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)
134
+ </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>
135
+ <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>
136
+ <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>
137
+ <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>
138
+ <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>
139
+ <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>
140
+ <span class='lbracket'>[</span> <span class='symbol'>:on_intense_white</span> <span class='comma'>,</span> <span class='int'>107</span> <span class='rbracket'>]</span>
141
+ <span class='rbracket'>]</span></pre></dd>
142
+
143
+ <dt id="ATTRIBUTE_NAMES-constant" class="">ATTRIBUTE_NAMES =
144
+
145
+ </dt>
146
+ <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>
147
+
148
+ <dt id="COLORED_REGEXP-constant" class="">COLORED_REGEXP =
149
+ <div class="docstring">
150
+ <div class="discussion">
151
+
152
+ <p>Regular expression that is used to scan for ANSI-sequences while uncoloring
153
+ strings.</p>
154
+
155
+
156
+ </div>
157
+ </div>
158
+ <div class="tags">
159
+
160
+
161
+ </div>
162
+ </dt>
163
+ <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>
164
+
165
+ </dl>
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <h2>
174
+ Class Method Summary
175
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
176
+ </h2>
177
+
178
+ <ul class="summary">
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#coloring%3D-class_method" title="coloring= (class method)">+ (Object) <strong>coloring=</strong>(val) </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+ <span class="summary_desc"><div class='inline'>
197
+ <p>Turns the coloring on or off globally, so you can easily do this for
198
+ example:.</p>
199
+ </div></span>
200
+
201
+ </li>
202
+
203
+
204
+ <li class="public ">
205
+ <span class="summary_signature">
206
+
207
+ <a href="#coloring%3F-class_method" title="coloring? (class method)">+ (Boolean) <strong>coloring?</strong> </a>
208
+
209
+
210
+
211
+ </span>
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+ <span class="summary_desc"><div class='inline'>
221
+ <p>Returns true, if the coloring function of this module is switched on, false
222
+ otherwise.</p>
223
+ </div></span>
224
+
225
+ </li>
226
+
227
+
228
+ </ul>
229
+
230
+ <h2>
231
+ Instance Method Summary
232
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
233
+ </h2>
234
+
235
+ <ul class="summary">
236
+
237
+ <li class="public ">
238
+ <span class="summary_signature">
239
+
240
+ <a href="#attributes-instance_method" title="#attributes (instance method)">- (Object) <strong>attributes</strong> </a>
241
+
242
+
243
+
244
+ </span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+ <span class="summary_desc"><div class='inline'>
254
+ <p>Returns an array of all TTYCoke::ANSIColor attributes as symbols.</p>
255
+ </div></span>
256
+
257
+ </li>
258
+
259
+
260
+ <li class="public ">
261
+ <span class="summary_signature">
262
+
263
+ <a href="#support%3F-instance_method" title="#support? (instance method)">- (Boolean) <strong>support?</strong>(feature) </a>
264
+
265
+
266
+
267
+ </span>
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+ <span class="summary_desc"><div class='inline'>
277
+ <p>Returns true if TTYCoke::ANSIColor supports the <tt>feature</tt>.</p>
278
+ </div></span>
279
+
280
+ </li>
281
+
282
+
283
+ <li class="public ">
284
+ <span class="summary_signature">
285
+
286
+ <a href="#uncolored-instance_method" title="#uncolored (instance method)">- (Object) <strong>uncolored</strong>(string = nil) </a>
287
+
288
+
289
+
290
+ </span>
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+ <span class="summary_desc"><div class='inline'>
300
+ <p>Returns an uncolored version of the string, that is all ANSI-sequences are
301
+ stripped from the string.</p>
302
+ </div></span>
303
+
304
+ </li>
305
+
306
+
307
+ </ul>
308
+
309
+
310
+
311
+
312
+ <div id="class_method_details" class="method_details_list">
313
+ <h2>Class Method Details</h2>
314
+
315
+
316
+ <div class="method_details first">
317
+ <p class="signature first" id="coloring=-class_method">
318
+
319
+ + (<tt>Object</tt>) <strong>coloring=</strong>(val)
320
+
321
+
322
+
323
+ </p><div class="docstring">
324
+ <div class="discussion">
325
+
326
+ <p>Turns the coloring on or off globally, so you can easily do this for
327
+ example:</p>
328
+
329
+ <pre class="code"><span class='const'>TTYCoke</span><span class='op'>::</span><span class='const'>ANSIColor</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>
330
+
331
+
332
+ </div>
333
+ </div>
334
+ <div class="tags">
335
+
336
+
337
+ </div><table class="source_code">
338
+ <tr>
339
+ <td>
340
+ <pre class="lines">
341
+
342
+
343
+ 75
344
+ 76
345
+ 77</pre>
346
+ </td>
347
+ <td>
348
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi_color.rb', line 75</span>
349
+
350
+ <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>
351
+ <span class='ivar'>@coloring</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span>
352
+ <span class='kw'>end</span></pre>
353
+ </td>
354
+ </tr>
355
+ </table>
356
+ </div>
357
+
358
+ <div class="method_details ">
359
+ <p class="signature " id="coloring?-class_method">
360
+
361
+ + (<tt>Boolean</tt>) <strong>coloring?</strong>
362
+
363
+
364
+
365
+ </p><div class="docstring">
366
+ <div class="discussion">
367
+
368
+ <p>Returns true, if the coloring function of this module is switched on, false
369
+ otherwise.</p>
370
+
371
+
372
+ </div>
373
+ </div>
374
+ <div class="tags">
375
+
376
+ <h3>Returns:</h3>
377
+ <ul class="return">
378
+
379
+ <li>
380
+
381
+
382
+ <span class='type'>(<tt>Boolean</tt>)</span>
383
+
384
+
385
+
386
+ </li>
387
+
388
+ </ul>
389
+
390
+ </div><table class="source_code">
391
+ <tr>
392
+ <td>
393
+ <pre class="lines">
394
+
395
+
396
+ 68
397
+ 69
398
+ 70</pre>
399
+ </td>
400
+ <td>
401
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi_color.rb', line 68</span>
402
+
403
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_coloring?'>coloring?</span>
404
+ <span class='ivar'>@coloring</span>
405
+ <span class='kw'>end</span></pre>
406
+ </td>
407
+ </tr>
408
+ </table>
409
+ </div>
410
+
411
+ </div>
412
+
413
+ <div id="instance_method_details" class="method_details_list">
414
+ <h2>Instance Method Details</h2>
415
+
416
+
417
+ <div class="method_details first">
418
+ <p class="signature first" id="attributes-instance_method">
419
+
420
+ - (<tt>Object</tt>) <strong>attributes</strong>
421
+
422
+
423
+
424
+ </p><div class="docstring">
425
+ <div class="discussion">
426
+
427
+ <p>Returns an array of all TTYCoke::ANSIColor attributes as symbols.</p>
428
+
429
+
430
+ </div>
431
+ </div>
432
+ <div class="tags">
433
+
434
+
435
+ </div><table class="source_code">
436
+ <tr>
437
+ <td>
438
+ <pre class="lines">
439
+
440
+
441
+ 121
442
+ 122
443
+ 123</pre>
444
+ </td>
445
+ <td>
446
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi_color.rb', line 121</span>
447
+
448
+ <span class='kw'>def</span> <span class='id identifier rubyid_attributes'>attributes</span>
449
+ <span class='const'>ATTRIBUTE_NAMES</span>
450
+ <span class='kw'>end</span></pre>
451
+ </td>
452
+ </tr>
453
+ </table>
454
+ </div>
455
+
456
+ <div class="method_details ">
457
+ <p class="signature " id="support?-instance_method">
458
+
459
+ - (<tt>Boolean</tt>) <strong>support?</strong>(feature)
460
+
461
+
462
+
463
+ </p><div class="docstring">
464
+ <div class="discussion">
465
+
466
+ <p>Returns true if TTYCoke::ANSIColor supports the <tt>feature</tt>.</p>
467
+
468
+ <p>The feature :clear, that is mixing the clear color attribute into String,
469
+ is only supported on ruby implementations, that do <b>not</b> already
470
+ implement the String#clear method. It's better to use the reset color
471
+ attribute instead.</p>
472
+
473
+
474
+ </div>
475
+ </div>
476
+ <div class="tags">
477
+
478
+ <h3>Returns:</h3>
479
+ <ul class="return">
480
+
481
+ <li>
482
+
483
+
484
+ <span class='type'>(<tt>Boolean</tt>)</span>
485
+
486
+
487
+
488
+ </li>
489
+
490
+ </ul>
491
+
492
+ </div><table class="source_code">
493
+ <tr>
494
+ <td>
495
+ <pre class="lines">
496
+
497
+
498
+ 60
499
+ 61
500
+ 62
501
+ 63
502
+ 64
503
+ 65</pre>
504
+ </td>
505
+ <td>
506
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi_color.rb', line 60</span>
507
+
508
+ <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>
509
+ <span class='kw'>case</span> <span class='id identifier rubyid_feature'>feature</span>
510
+ <span class='kw'>when</span> <span class='symbol'>:clear</span>
511
+ <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>
512
+ <span class='kw'>end</span>
513
+ <span class='kw'>end</span></pre>
514
+ </td>
515
+ </tr>
516
+ </table>
517
+ </div>
518
+
519
+ <div class="method_details ">
520
+ <p class="signature " id="uncolored-instance_method">
521
+
522
+ - (<tt>Object</tt>) <strong>uncolored</strong>(string = nil)
523
+
524
+
525
+
526
+ </p><div class="docstring">
527
+ <div class="discussion">
528
+
529
+ <p>Returns an uncolored version of the string, that is all ANSI-sequences are
530
+ stripped from the string.</p>
531
+
532
+
533
+ </div>
534
+ </div>
535
+ <div class="tags">
536
+
537
+
538
+ </div><table class="source_code">
539
+ <tr>
540
+ <td>
541
+ <pre class="lines">
542
+
543
+
544
+ 106
545
+ 107
546
+ 108
547
+ 109
548
+ 110
549
+ 111
550
+ 112
551
+ 113
552
+ 114
553
+ 115
554
+ 116</pre>
555
+ </td>
556
+ <td>
557
+ <pre class="code"><span class="info file"># File 'lib/ttycoke/ansi_color.rb', line 106</span>
558
+
559
+ <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:
560
+ </span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
561
+ <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>
562
+ <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>
563
+ <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>
564
+ <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>
565
+ <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>
566
+ <span class='kw'>else</span>
567
+ <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
568
+ <span class='kw'>end</span>
569
+ <span class='kw'>end</span></pre>
570
+ </td>
571
+ </tr>
572
+ </table>
573
+ </div>
574
+
575
+ </div>
576
+
577
+ </div>
578
+
579
+ <div id="footer">
580
+ Generated on Wed Jan 25 14:55:49 2012 by
581
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
582
+ 0.7.4 (ruby-1.9.3).
583
+ </div>
584
+
585
+ </body>
586
+ </html>