<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Bovem::ConsoleMethods::StyleHandling::ClassMethods
— Documentation by YARD 0.8.4
</title>
<link rel="stylesheet" href="../../../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../../../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../../';
framesUrl = "../../../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (C)</a> »
<span class='title'><span class='object_link'><a href="../../../Bovem.html" title="Bovem (module)">Bovem</a></span></span> » <span class='title'><span class='object_link'><a href="../../ConsoleMethods.html" title="Bovem::ConsoleMethods (module)">ConsoleMethods</a></span></span> » <span class='title'><span class='object_link'><a href="../StyleHandling.html" title="Bovem::ConsoleMethods::StyleHandling (module)">StyleHandling</a></span></span>
»
<span class="title">ClassMethods</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Bovem::ConsoleMethods::StyleHandling::ClassMethods
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/bovem/console.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Class methods for handling styles in the terminal.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#parse_style-instance_method" title="#parse_style (instance method)">- (String) <strong>parse_style</strong>(style) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Parse a style and returns terminal codes.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse_styles-instance_method" title="#parse_styles (instance method)">- (String) <strong>parse_styles</strong>(styles) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Parses a set of styles and returns terminals codes.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#replace_markers-instance_method" title="#replace_markers (instance method)">- (String) <strong>replace_markers</strong>(message, plain = false) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Replaces colors markers in a string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<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>
</span>
<span class="summary_desc"><div class='inline'><p>Replaces a terminal code.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="parse_style-instance_method">
- (<tt>String</tt>) <strong>parse_style</strong>(style)
</h3><div class="docstring">
<div class="discussion">
<p>Parse a style and returns terminal codes.</p>
<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>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>style</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The style to parse.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>A string with ANSI color codes.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30
31
32
33
34
35
36
37
38
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 28</span>
<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>
<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>
<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>
<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>
<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>
<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>
<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'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='int'>40</span><span class='rparen'>)</span> <span class='op'>||</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
<span class='kw'>else</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parse_styles-instance_method">
- (<tt>String</tt>) <strong>parse_styles</strong>(styles)
</h3><div class="docstring">
<div class="discussion">
<p>Parses a set of styles and returns terminals codes.
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>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>styles</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The styles to parse.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>A string with ANSI color codes.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 48</span>
<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>
<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'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="replace_markers-instance_method">
- (<tt>String</tt>) <strong>replace_markers</strong>(message, plain = false)
</h3><div class="docstring">
<div class="discussion">
<p>Replaces colors markers in a string.</p>
<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>
<p>Example:</p>
<p><code>ruby
Bovem::Console.new.replace_markers("{mark=bright bg_red}{mark=green}Hello world!{/mark}{/mark}")
# => "\e[1m\e[41m\e[32mHello world!\e[1m\e[41m\e[0m"
</code></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The message to analyze.</p>
</div>
</li>
<li>
<span class='name'>plain</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>If ignore (cleanify) color markers into the message.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The replaced message.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#parse_style-instance_method" title="Bovem::ConsoleMethods::StyleHandling::ClassMethods#parse_style (method)">#parse_style</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 79</span>
<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>
<span class='id identifier rubyid_stack'>stack</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<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>
<span class='kw'>if</span> <span class='backref'>$1</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>{/mark}</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='comment'># If it is a tag, pop from the latest opened.
</span> <span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span>
<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'>"</span><span class='tstring_end'>"</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>
<span class='kw'>else</span>
<span class='id identifier rubyid_styles'>styles</span> <span class='op'>=</span> <span class='backref'>$3</span>
<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'>"</span><span class='tstring_end'>"</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>
<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'>></span> <span class='int'>0</span> <span class='kw'>then</span>
<span class='id identifier rubyid_stack'>stack</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>reset</span><span class='tstring_end'>"</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>
<span class='id identifier rubyid_stack'>stack</span> <span class='op'><<</span> <span class='id identifier rubyid_styles'>styles</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_replacement'>replacement</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="replace_term_code-instance_method">
- (<tt>String|nil</tt>) <strong>replace_term_code</strong>(codes, code, modifier = 0)
</h3><div class="docstring">
<div class="discussion">
<p>Replaces a terminal code.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>codes</span>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>The valid list of codes.</p>
</div>
</li>
<li>
<span class='name'>code</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The code to lookup.</p>
</div>
</li>
<li>
<span class='name'>modifier</span>
<span class='type'>(<tt>Fixnum</tt>)</span>
<em class="default">(defaults to: <tt>0</tt>)</em>
—
<div class='inline'><p>The modifier to apply to the code.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String|nil</tt>)</span>
—
<div class='inline'><p>The terminal code or <code>nil</code> if the code was not found.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 59</span>
<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>
<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>
<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'>"</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'>"</span></span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Feb 8 07:47:40 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.4 (ruby-1.9.3).
</div>
</body>
</html>