bovem 1.2.6 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. data/.travis.yml +1 -1
  2. data/Gemfile +1 -1
  3. data/README.md +5 -2
  4. data/bovem.gemspec +11 -9
  5. data/doc/Bovem.html +7 -25
  6. data/doc/Bovem/Configuration.html +30 -43
  7. data/doc/Bovem/Console.html +225 -4360
  8. data/doc/Bovem/ConsoleMethods.html +125 -0
  9. data/doc/Bovem/ConsoleMethods/Interactions.html +575 -0
  10. data/doc/Bovem/ConsoleMethods/Interactions/ClassMethods.html +231 -0
  11. data/doc/Bovem/ConsoleMethods/Logging.html +2218 -0
  12. data/doc/Bovem/ConsoleMethods/Logging/ClassMethods.html +212 -0
  13. data/doc/Bovem/ConsoleMethods/Output.html +1213 -0
  14. data/doc/Bovem/ConsoleMethods/StyleHandling.html +274 -0
  15. data/doc/Bovem/ConsoleMethods/StyleHandling/ClassMethods.html +653 -0
  16. data/doc/Bovem/Errors.html +3 -3
  17. data/doc/Bovem/Errors/InvalidConfiguration.html +3 -3
  18. data/doc/Bovem/Errors/InvalidLogger.html +3 -3
  19. data/doc/Bovem/Logger.html +112 -12
  20. data/doc/Bovem/Shell.html +58 -1888
  21. data/doc/Bovem/ShellMethods.html +125 -0
  22. data/doc/Bovem/ShellMethods/Directories.html +484 -0
  23. data/doc/Bovem/ShellMethods/Execute.html +565 -0
  24. data/doc/Bovem/ShellMethods/General.html +450 -0
  25. data/doc/Bovem/ShellMethods/Read.html +451 -0
  26. data/doc/Bovem/ShellMethods/Write.html +676 -0
  27. data/doc/Bovem/Version.html +6 -6
  28. data/doc/_index.html +145 -4
  29. data/doc/class_list.html +1 -1
  30. data/doc/file.README.html +10 -7
  31. data/doc/frames.html +1 -1
  32. data/doc/index.html +10 -7
  33. data/doc/method_list.html +119 -79
  34. data/doc/top-level-namespace.html +3 -3
  35. data/lib/bovem.rb +1 -1
  36. data/lib/bovem/configuration.rb +24 -13
  37. data/lib/bovem/console.rb +566 -497
  38. data/lib/bovem/errors.rb +1 -1
  39. data/lib/bovem/logger.rb +4 -4
  40. data/lib/bovem/shell.rb +482 -305
  41. data/lib/bovem/version.rb +4 -4
  42. data/locales/en.yml +43 -0
  43. data/locales/it.yml +43 -0
  44. data/spec/bovem/configuration_spec.rb +3 -3
  45. data/spec/bovem/console_spec.rb +17 -10
  46. data/spec/bovem/logger_spec.rb +1 -1
  47. data/spec/bovem/shell_spec.rb +9 -5
  48. data/spec/coverage_helper.rb +1 -1
  49. data/spec/spec_helper.rb +1 -1
  50. metadata +32 -22
data/doc/Bovem/ConsoleMethods/StyleHandling.html ADDED
@@ -0,0 +1,274 @@
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: Bovem::ConsoleMethods::StyleHandling
8
+
9
+ &mdash; Documentation by YARD 0.8.3
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!" + escape(window.location.href);
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 (S)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../Bovem.html" title="Bovem (module)">Bovem</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../ConsoleMethods.html" title="Bovem::ConsoleMethods (module)">ConsoleMethods</a></span></span>
36
+ &raquo;
37
+ <span class="title">StyleHandling</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: Bovem::ConsoleMethods::StyleHandling
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+ <dt class="r1">Extended by:</dt>
77
+ <dd class="r1">ActiveSupport::Concern</dd>
78
+
79
+
80
+
81
+
82
+
83
+
84
+ <dt class="r2">Included in:</dt>
85
+ <dd class="r2"><span class='object_link'><a href="../Console.html" title="Bovem::Console (class)">Bovem::Console</a></span></dd>
86
+
87
+
88
+
89
+ <dt class="r1 last">Defined in:</dt>
90
+ <dd class="r1 last">lib/bovem/console.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+ <p>Methods for handling styles in the terminal.</p>
98
+
99
+
100
+ </div>
101
+ </div>
102
+ <div class="tags">
103
+
104
+
105
+ </div><h2>Defined Under Namespace</h2>
106
+ <p class="children">
107
+
108
+
109
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="StyleHandling/ClassMethods.html" title="Bovem::ConsoleMethods::StyleHandling::ClassMethods (module)">ClassMethods</a></span>
110
+
111
+
112
+
113
+
114
+ </p>
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <h2>
124
+ Instance Method Summary
125
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
126
+ </h2>
127
+
128
+ <ul class="summary">
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#replace_markers-instance_method" title="#replace_markers (instance method)">- (String) <strong>replace_markers</strong>(message, plain = false) </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'><p>Replaces colors markers in a string.</p>
148
+ </div></span>
149
+
150
+ </li>
151
+
152
+
153
+ </ul>
154
+
155
+
156
+
157
+
158
+
159
+ <div id="instance_method_details" class="method_details_list">
160
+ <h2>Instance Method Details</h2>
161
+
162
+
163
+ <div class="method_details first">
164
+ <h3 class="signature first" id="replace_markers-instance_method">
165
+
166
+ - (<tt>String</tt>) <strong>replace_markers</strong>(message, plain = false)
167
+
168
+
169
+
170
+
171
+
172
+ </h3><div class="docstring">
173
+ <div class="discussion">
174
+ <p>Replaces colors markers in a string.</p>
175
+
176
+
177
+ </div>
178
+ </div>
179
+ <div class="tags">
180
+ <p class="tag_title">Parameters:</p>
181
+ <ul class="param">
182
+
183
+ <li>
184
+
185
+ <span class='name'>message</span>
186
+
187
+
188
+ <span class='type'>(<tt>String</tt>)</span>
189
+
190
+
191
+
192
+ &mdash;
193
+ <div class='inline'><p>The message to analyze.</p>
194
+ </div>
195
+
196
+ </li>
197
+
198
+ <li>
199
+
200
+ <span class='name'>plain</span>
201
+
202
+
203
+ <span class='type'>(<tt>Boolean</tt>)</span>
204
+
205
+
206
+ <em class="default">(defaults to: <tt>false</tt>)</em>
207
+
208
+
209
+ &mdash;
210
+ <div class='inline'><p>If ignore (cleanify) color markers into the message.</p>
211
+ </div>
212
+
213
+ </li>
214
+
215
+ </ul>
216
+
217
+ <p class="tag_title">Returns:</p>
218
+ <ul class="return">
219
+
220
+ <li>
221
+
222
+
223
+ <span class='type'>(<tt>String</tt>)</span>
224
+
225
+
226
+
227
+ &mdash;
228
+ <div class='inline'><p>The replaced message.</p>
229
+ </div>
230
+
231
+ </li>
232
+
233
+ </ul>
234
+
235
+ <p class="tag_title">See Also:</p>
236
+ <ul class="see">
237
+
238
+ <li>replace_markers</li>
239
+
240
+ </ul>
241
+
242
+ </div><table class="source_code">
243
+ <tr>
244
+ <td>
245
+ <pre class="lines">
246
+
247
+
248
+ 108
249
+ 109
250
+ 110</pre>
251
+ </td>
252
+ <td>
253
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 108</span>
254
+
255
+ <span class='kw'>def</span> <span class='id identifier rubyid_replace_markers'>replace_markers</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
256
+ <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_replace_markers'>replace_markers</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='rparen'>)</span>
257
+ <span class='kw'>end</span></pre>
258
+ </td>
259
+ </tr>
260
+ </table>
261
+ </div>
262
+
263
+ </div>
264
+
265
+ </div>
266
+
267
+ <div id="footer">
268
+ Generated on Fri Feb 1 23:40:17 2013 by
269
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
270
+ 0.8.3 (ruby-1.9.3).
271
+ </div>
272
+
273
+ </body>
274
+ </html>
data/doc/Bovem/ConsoleMethods/StyleHandling/ClassMethods.html ADDED
@@ -0,0 +1,653 @@
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: Bovem::ConsoleMethods::StyleHandling::ClassMethods
8
+
9
+ &mdash; Documentation by YARD 0.8.3
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../../';
20
+ framesUrl = "../../../frames.html#!" + escape(window.location.href);
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 (C)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../../Bovem.html" title="Bovem (module)">Bovem</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../ConsoleMethods.html" title="Bovem::ConsoleMethods (module)">ConsoleMethods</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../StyleHandling.html" title="Bovem::ConsoleMethods::StyleHandling (module)">StyleHandling</a></span></span>
36
+ &raquo;
37
+ <span class="title">ClassMethods</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: Bovem::ConsoleMethods::StyleHandling::ClassMethods
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dt class="r1 last">Defined in:</dt>
82
+ <dd class="r1 last">lib/bovem/console.rb</dd>
83
+
84
+ </dl>
85
+ <div class="clear"></div>
86
+
87
+ <h2>Overview</h2><div class="docstring">
88
+ <div class="discussion">
89
+ <p>Class methods for handling styles in the terminal.</p>
90
+
91
+
92
+ </div>
93
+ </div>
94
+ <div class="tags">
95
+
96
+
97
+ </div>
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+ <h2>
106
+ Instance Method Summary
107
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
108
+ </h2>
109
+
110
+ <ul class="summary">
111
+
112
+ <li class="public ">
113
+ <span class="summary_signature">
114
+
115
+ <a href="#parse_style-instance_method" title="#parse_style (instance method)">- (String) <strong>parse_style</strong>(style) </a>
116
+
117
+
118
+
119
+ </span>
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+ <span class="summary_desc"><div class='inline'><p>Parse a style and returns terminal codes.</p>
130
+ </div></span>
131
+
132
+ </li>
133
+
134
+
135
+ <li class="public ">
136
+ <span class="summary_signature">
137
+
138
+ <a href="#parse_styles-instance_method" title="#parse_styles (instance method)">- (String) <strong>parse_styles</strong>(styles) </a>
139
+
140
+
141
+
142
+ </span>
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <span class="summary_desc"><div class='inline'><p>Parses a set of styles and returns terminals codes.</p>
153
+ </div></span>
154
+
155
+ </li>
156
+
157
+
158
+ <li class="public ">
159
+ <span class="summary_signature">
160
+
161
+ <a href="#replace_markers-instance_method" title="#replace_markers (instance method)">- (String) <strong>replace_markers</strong>(message, plain = false) </a>
162
+
163
+
164
+
165
+ </span>
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <span class="summary_desc"><div class='inline'><p>Replaces colors markers in a string.</p>
176
+ </div></span>
177
+
178
+ </li>
179
+
180
+
181
+ <li class="public ">
182
+ <span class="summary_signature">
183
+
184
+ <a href="#replace_term_code-instance_method" title="#replace_term_code (instance method)">- (String|nil) <strong>replace_term_code</strong>(codes, code, modifier = 0) </a>
185
+
186
+
187
+
188
+ </span>
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <span class="summary_desc"><div class='inline'><p>Replaces a terminal code.</p>
199
+ </div></span>
200
+
201
+ </li>
202
+
203
+
204
+ </ul>
205
+
206
+
207
+
208
+
209
+ <div id="instance_method_details" class="method_details_list">
210
+ <h2>Instance Method Details</h2>
211
+
212
+
213
+ <div class="method_details first">
214
+ <h3 class="signature first" id="parse_style-instance_method">
215
+
216
+ - (<tt>String</tt>) <strong>parse_style</strong>(style)
217
+
218
+
219
+
220
+
221
+
222
+ </h3><div class="docstring">
223
+ <div class="discussion">
224
+ <p>Parse a style and returns terminal codes.</p>
225
+
226
+ <p>Supported styles and colors are those in <span class='object_link'><a href="../../../Bovem.html#TERM_COLORS-constant" title="Bovem::TERM_COLORS (constant)">TERM_COLORS</a></span> and <span class='object_link'><a href="../../../Bovem.html#TERM_EFFECTS-constant" title="Bovem::TERM_EFFECTS (constant)">TERM_EFFECTS</a></span>. You can also prefix colors with <code>bg_</code> (like <code>bg_red</code>) for background colors.</p>
227
+
228
+
229
+ </div>
230
+ </div>
231
+ <div class="tags">
232
+ <p class="tag_title">Parameters:</p>
233
+ <ul class="param">
234
+
235
+ <li>
236
+
237
+ <span class='name'>style</span>
238
+
239
+
240
+ <span class='type'>(<tt>String</tt>)</span>
241
+
242
+
243
+
244
+ &mdash;
245
+ <div class='inline'><p>The style to parse.</p>
246
+ </div>
247
+
248
+ </li>
249
+
250
+ </ul>
251
+
252
+ <p class="tag_title">Returns:</p>
253
+ <ul class="return">
254
+
255
+ <li>
256
+
257
+
258
+ <span class='type'>(<tt>String</tt>)</span>
259
+
260
+
261
+
262
+ &mdash;
263
+ <div class='inline'><p>A string with ANSI color codes.</p>
264
+ </div>
265
+
266
+ </li>
267
+
268
+ </ul>
269
+
270
+ </div><table class="source_code">
271
+ <tr>
272
+ <td>
273
+ <pre class="lines">
274
+
275
+
276
+ 28
277
+ 29
278
+ 30
279
+ 31
280
+ 32
281
+ 33
282
+ 34
283
+ 35
284
+ 36
285
+ 37
286
+ 38
287
+ 39
288
+ 40
289
+ 41</pre>
290
+ </td>
291
+ <td>
292
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 28</span>
293
+
294
+ <span class='kw'>def</span> <span class='id identifier rubyid_parse_style'>parse_style</span><span class='lparen'>(</span><span class='id identifier rubyid_style'>style</span><span class='rparen'>)</span>
295
+ <span class='id identifier rubyid_style'>style</span> <span class='op'>=</span> <span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='period'>.</span><span class='id identifier rubyid_parameterize'>parameterize</span>
296
+
297
+ <span class='kw'>if</span> <span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='kw'>then</span>
298
+ <span class='id identifier rubyid_sym'>sym</span> <span class='op'>=</span> <span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
299
+
300
+ <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_replace_term_code'>replace_term_code</span><span class='lparen'>(</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>TERM_EFFECTS</span><span class='comma'>,</span> <span class='id identifier rubyid_style'>style</span><span class='comma'>,</span> <span class='int'>0</span><span class='rparen'>)</span> <span class='op'>||</span>
301
+ <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_replace_term_code'>replace_term_code</span><span class='lparen'>(</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>TERM_COLORS</span><span class='comma'>,</span> <span class='id identifier rubyid_style'>style</span><span class='comma'>,</span> <span class='int'>30</span><span class='rparen'>)</span> <span class='op'>||</span>
302
+ <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_replace_term_code'>replace_term_code</span><span class='lparen'>(</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>TERM_COLORS</span><span class='comma'>,</span> <span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^bg_</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='int'>40</span><span class='rparen'>)</span> <span class='op'>||</span>
303
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
304
+ <span class='kw'>else</span>
305
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
306
+ <span class='kw'>end</span>
307
+ <span class='kw'>end</span></pre>
308
+ </td>
309
+ </tr>
310
+ </table>
311
+ </div>
312
+
313
+ <div class="method_details ">
314
+ <h3 class="signature " id="parse_styles-instance_method">
315
+
316
+ - (<tt>String</tt>) <strong>parse_styles</strong>(styles)
317
+
318
+
319
+
320
+
321
+
322
+ </h3><div class="docstring">
323
+ <div class="discussion">
324
+ <p>Parses a set of styles and returns terminals codes.
325
+ Supported styles and colors are those in <span class='object_link'><a href="../../../Bovem.html#TERM_COLORS-constant" title="Bovem::TERM_COLORS (constant)">TERM_COLORS</a></span> and <span class='object_link'><a href="../../../Bovem.html#TERM_EFFECTS-constant" title="Bovem::TERM_EFFECTS (constant)">TERM_EFFECTS</a></span>. You can also prefix colors with <code>bg_</code> (like <code>bg_red</code>) for background colors.</p>
326
+
327
+
328
+ </div>
329
+ </div>
330
+ <div class="tags">
331
+ <p class="tag_title">Parameters:</p>
332
+ <ul class="param">
333
+
334
+ <li>
335
+
336
+ <span class='name'>styles</span>
337
+
338
+
339
+ <span class='type'>(<tt>String</tt>)</span>
340
+
341
+
342
+
343
+ &mdash;
344
+ <div class='inline'><p>The styles to parse.</p>
345
+ </div>
346
+
347
+ </li>
348
+
349
+ </ul>
350
+
351
+ <p class="tag_title">Returns:</p>
352
+ <ul class="return">
353
+
354
+ <li>
355
+
356
+
357
+ <span class='type'>(<tt>String</tt>)</span>
358
+
359
+
360
+
361
+ &mdash;
362
+ <div class='inline'><p>A string with ANSI color codes.</p>
363
+ </div>
364
+
365
+ </li>
366
+
367
+ </ul>
368
+
369
+ </div><table class="source_code">
370
+ <tr>
371
+ <td>
372
+ <pre class="lines">
373
+
374
+
375
+ 48
376
+ 49
377
+ 50</pre>
378
+ </td>
379
+ <td>
380
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 48</span>
381
+
382
+ <span class='kw'>def</span> <span class='id identifier rubyid_parse_styles'>parse_styles</span><span class='lparen'>(</span><span class='id identifier rubyid_styles'>styles</span><span class='rparen'>)</span>
383
+ <span class='id identifier rubyid_styles'>styles</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\s*[\s,-]\s*</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_style'>parse_style</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
384
+ <span class='kw'>end</span></pre>
385
+ </td>
386
+ </tr>
387
+ </table>
388
+ </div>
389
+
390
+ <div class="method_details ">
391
+ <h3 class="signature " id="replace_markers-instance_method">
392
+
393
+ - (<tt>String</tt>) <strong>replace_markers</strong>(message, plain = false)
394
+
395
+
396
+
397
+
398
+
399
+ </h3><div class="docstring">
400
+ <div class="discussion">
401
+ <p>Replaces colors markers in a string.</p>
402
+
403
+ <p>You can specify markers by enclosing in <code>{mark=[style]}</code> and <code>{/mark}</code> tags. Separate styles with spaces, dashes or commas. Nesting markers is supported.</p>
404
+
405
+ <p>Example:</p>
406
+
407
+ <pre class="code ruby"><code><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_replace_markers'>replace_markers</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>{mark=bright bg_red}{mark=green}Hello world!{/mark}{/mark}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
408
+ <span class='comment'># =&gt; &quot;\e[1m\e[41m\e[32mHello world!\e[1m\e[41m\e[0m&quot;
409
+ </span></code></pre>
410
+
411
+
412
+ </div>
413
+ </div>
414
+ <div class="tags">
415
+ <p class="tag_title">Parameters:</p>
416
+ <ul class="param">
417
+
418
+ <li>
419
+
420
+ <span class='name'>message</span>
421
+
422
+
423
+ <span class='type'>(<tt>String</tt>)</span>
424
+
425
+
426
+
427
+ &mdash;
428
+ <div class='inline'><p>The message to analyze.</p>
429
+ </div>
430
+
431
+ </li>
432
+
433
+ <li>
434
+
435
+ <span class='name'>plain</span>
436
+
437
+
438
+ <span class='type'>(<tt>Boolean</tt>)</span>
439
+
440
+
441
+ <em class="default">(defaults to: <tt>false</tt>)</em>
442
+
443
+
444
+ &mdash;
445
+ <div class='inline'><p>If ignore (cleanify) color markers into the message.</p>
446
+ </div>
447
+
448
+ </li>
449
+
450
+ </ul>
451
+
452
+ <p class="tag_title">Returns:</p>
453
+ <ul class="return">
454
+
455
+ <li>
456
+
457
+
458
+ <span class='type'>(<tt>String</tt>)</span>
459
+
460
+
461
+
462
+ &mdash;
463
+ <div class='inline'><p>The replaced message.</p>
464
+ </div>
465
+
466
+ </li>
467
+
468
+ </ul>
469
+
470
+ <p class="tag_title">See Also:</p>
471
+ <ul class="see">
472
+
473
+ <li><span class='object_link'><a href="#parse_style-instance_method" title="Bovem::ConsoleMethods::StyleHandling::ClassMethods#parse_style (method)">#parse_style</a></span></li>
474
+
475
+ </ul>
476
+
477
+ </div><table class="source_code">
478
+ <tr>
479
+ <td>
480
+ <pre class="lines">
481
+
482
+
483
+ 79
484
+ 80
485
+ 81
486
+ 82
487
+ 83
488
+ 84
489
+ 85
490
+ 86
491
+ 87
492
+ 88
493
+ 89
494
+ 90
495
+ 91
496
+ 92
497
+ 93
498
+ 94
499
+ 95
500
+ 96
501
+ 97
502
+ 98</pre>
503
+ </td>
504
+ <td>
505
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 79</span>
506
+
507
+ <span class='kw'>def</span> <span class='id identifier rubyid_replace_markers'>replace_markers</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
508
+ <span class='id identifier rubyid_stack'>stack</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
509
+
510
+ <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>((\{mark=([a-z\-_\s,]+)\})|(\{\/mark\}))</span><span class='regexp_end'>/mi</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
511
+ <span class='kw'>if</span> <span class='backref'>$1</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>{/mark}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>then</span> <span class='comment'># If it is a tag, pop from the latest opened.
512
+ </span> <span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span>
513
+ <span class='id identifier rubyid_plain'>plain</span> <span class='op'>||</span> <span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_parse_styles'>parse_styles</span><span class='lparen'>(</span><span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='rparen'>)</span>
514
+ <span class='kw'>else</span>
515
+ <span class='id identifier rubyid_styles'>styles</span> <span class='op'>=</span> <span class='backref'>$3</span>
516
+ <span class='id identifier rubyid_replacement'>replacement</span> <span class='op'>=</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_parse_styles'>parse_styles</span><span class='lparen'>(</span><span class='id identifier rubyid_styles'>styles</span><span class='rparen'>)</span>
517
+
518
+ <span class='kw'>if</span> <span class='id identifier rubyid_replacement'>replacement</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>0</span> <span class='kw'>then</span>
519
+ <span class='id identifier rubyid_stack'>stack</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>reset</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
520
+ <span class='id identifier rubyid_stack'>stack</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_styles'>styles</span>
521
+ <span class='kw'>end</span>
522
+
523
+ <span class='id identifier rubyid_replacement'>replacement</span>
524
+ <span class='kw'>end</span>
525
+ <span class='kw'>end</span>
526
+ <span class='kw'>end</span></pre>
527
+ </td>
528
+ </tr>
529
+ </table>
530
+ </div>
531
+
532
+ <div class="method_details ">
533
+ <h3 class="signature " id="replace_term_code-instance_method">
534
+
535
+ - (<tt>String|nil</tt>) <strong>replace_term_code</strong>(codes, code, modifier = 0)
536
+
537
+
538
+
539
+
540
+
541
+ </h3><div class="docstring">
542
+ <div class="discussion">
543
+ <p>Replaces a terminal code.</p>
544
+
545
+
546
+ </div>
547
+ </div>
548
+ <div class="tags">
549
+ <p class="tag_title">Parameters:</p>
550
+ <ul class="param">
551
+
552
+ <li>
553
+
554
+ <span class='name'>codes</span>
555
+
556
+
557
+ <span class='type'>(<tt>Array</tt>)</span>
558
+
559
+
560
+
561
+ &mdash;
562
+ <div class='inline'><p>The valid list of codes.</p>
563
+ </div>
564
+
565
+ </li>
566
+
567
+ <li>
568
+
569
+ <span class='name'>code</span>
570
+
571
+
572
+ <span class='type'>(<tt>String</tt>)</span>
573
+
574
+
575
+
576
+ &mdash;
577
+ <div class='inline'><p>The code to lookup.</p>
578
+ </div>
579
+
580
+ </li>
581
+
582
+ <li>
583
+
584
+ <span class='name'>modifier</span>
585
+
586
+
587
+ <span class='type'>(<tt>Fixnum</tt>)</span>
588
+
589
+
590
+ <em class="default">(defaults to: <tt>0</tt>)</em>
591
+
592
+
593
+ &mdash;
594
+ <div class='inline'><p>The modifier to apply to the code.</p>
595
+ </div>
596
+
597
+ </li>
598
+
599
+ </ul>
600
+
601
+ <p class="tag_title">Returns:</p>
602
+ <ul class="return">
603
+
604
+ <li>
605
+
606
+
607
+ <span class='type'>(<tt>String|nil</tt>)</span>
608
+
609
+
610
+
611
+ &mdash;
612
+ <div class='inline'><p>The terminal code or <code>nil</code> if the code was not found.</p>
613
+ </div>
614
+
615
+ </li>
616
+
617
+ </ul>
618
+
619
+ </div><table class="source_code">
620
+ <tr>
621
+ <td>
622
+ <pre class="lines">
623
+
624
+
625
+ 59
626
+ 60
627
+ 61
628
+ 62</pre>
629
+ </td>
630
+ <td>
631
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 59</span>
632
+
633
+ <span class='kw'>def</span> <span class='id identifier rubyid_replace_term_code'>replace_term_code</span><span class='lparen'>(</span><span class='id identifier rubyid_codes'>codes</span><span class='comma'>,</span> <span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_modifier'>modifier</span> <span class='op'>=</span> <span class='int'>0</span><span class='rparen'>)</span>
634
+ <span class='id identifier rubyid_sym'>sym</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
635
+ <span class='id identifier rubyid_codes'>codes</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\e[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_modifier'>modifier</span> <span class='op'>+</span> <span class='id identifier rubyid_codes'>codes</span><span class='lbracket'>[</span><span class='id identifier rubyid_sym'>sym</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>m</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='kw'>nil</span>
636
+ <span class='kw'>end</span></pre>
637
+ </td>
638
+ </tr>
639
+ </table>
640
+ </div>
641
+
642
+ </div>
643
+
644
+ </div>
645
+
646
+ <div id="footer">
647
+ Generated on Fri Feb 1 23:40:18 2013 by
648
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
649
+ 0.8.3 (ruby-1.9.3).
650
+ </div>
651
+
652
+ </body>
653
+ </html>