doc/Bovem/Console.html in bovem-1.2.6 vs doc/Bovem/Console.html in bovem-2.0.0
- old
+ new
@@ -4,11 +4,11 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Bovem::Console
- — Documentation by YARD 0.8.2.1
+ — Documentation by YARD 0.8.3
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
@@ -88,15 +88,19 @@
+ <dt class="r2">Includes:</dt>
+ <dd class="r2"><span class='object_link'><a href="ConsoleMethods/Interactions.html" title="Bovem::ConsoleMethods::Interactions (module)">Bovem::ConsoleMethods::Interactions</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html" title="Bovem::ConsoleMethods::Logging (module)">Bovem::ConsoleMethods::Logging</a></span>, <span class='object_link'><a href="ConsoleMethods/Output.html" title="Bovem::ConsoleMethods::Output (module)">Bovem::ConsoleMethods::Output</a></span>, <span class='object_link'><a href="ConsoleMethods/StyleHandling.html" title="Bovem::ConsoleMethods::StyleHandling (module)">Bovem::ConsoleMethods::StyleHandling</a></span>, Lazier::I18n</dd>
+
+
- <dt class="r2 last">Defined in:</dt>
- <dd class="r2 last">lib/bovem/console.rb</dd>
+ <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">
@@ -117,11 +121,11 @@
<ul class="summary">
<li class="public ">
<span class="summary_signature">
- <a href="#indentation-instance_method" title="#indentation (instance method)">- (Object) <strong>indentation</strong> </a>
+ <a href="#indentation-instance_method" title="#indentation (instance method)">- (Fixnum) <strong>indentation</strong> </a>
</span>
@@ -143,11 +147,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#indentation_string-instance_method" title="#indentation_string (instance method)">- (Object) <strong>indentation_string</strong> </a>
+ <a href="#indentation_string-instance_method" title="#indentation_string (instance method)">- (String) <strong>indentation_string</strong> </a>
</span>
@@ -169,11 +173,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#line_width-instance_method" title="#line_width (instance method)">- (Object) <strong>line_width</strong> </a>
+ <a href="#line_width-instance_method" title="#line_width (instance method)">- (Fixnum) <strong>line_width</strong> </a>
</span>
@@ -195,11 +199,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#screen_width-instance_method" title="#screen_width (instance method)">- (Object) <strong>screen_width</strong> </a>
+ <a href="#screen_width-instance_method" title="#screen_width (instance method)">- (Fixnum) <strong>screen_width</strong> </a>
</span>
@@ -234,33 +238,10 @@
<ul class="summary">
<li class="public ">
<span class="summary_signature">
- <a href="#execute-class_method" title="execute (class method)">+ (String) <strong>execute</strong>(command) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Executes a command and returns its output.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
<a href="#instance-class_method" title="instance (class method)">+ (Console) <strong>instance</strong> </a>
</span>
@@ -277,79 +258,10 @@
</div></span>
</li>
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#min_banner_length-class_method" title="min_banner_length (class method)">+ (Fixnum) <strong>min_banner_length</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Returns the minimum length of a banner, not including brackets and leading spaces.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#parse_style-class_method" title="parse_style (class 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="#replace_markers-class_method" title="replace_markers (class 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>
-
-
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
@@ -358,240 +270,10 @@
<ul class="summary">
<li class="public ">
<span class="summary_signature">
- <a href="#begin-instance_method" title="#begin (instance method)">- (Object) <strong>begin</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Writes a message prepending a green banner.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#debug-instance_method" title="#debug (instance method)">- (Object) <strong>debug</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Writes a message prepending a magenta banner.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Writes a message prepending a red banner.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#fatal-instance_method" title="#fatal (instance method)">- (Object) <strong>fatal</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, return_code = -1,, print = true) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Writes a message prepending a red banner and then quits the application.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#format-instance_method" title="#format (instance method)">- (String) <strong>format</strong>(message, suffix = "\n", indent = true, wrap = true, plain = false) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Formats a message.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#format_right-instance_method" title="#format_right (instance method)">- (String) <strong>format_right</strong>(message, width = true, go_up = true, plain = false) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Formats a message to be written right-aligned.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#get_banner-instance_method" title="#get_banner (instance method)">- (String) <strong>get_banner</strong>(label, base_color, full_colored = false, bracket_color = "blue", brackets = ["[", "]"]) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Gets a banner for the messages.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#get_screen_width-instance_method" title="#get_screen_width (instance method)">- (Fixnum) <strong>get_screen_width</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Gets the current screen width.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#indent-instance_method" title="#indent (instance method)">- (String) <strong>indent</strong>(message, width = true, newline_separator = "\n") </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Indents a message.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#info-instance_method" title="#info (instance method)">- (Object) <strong>info</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Writes a message prepending a cyan banner.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Console) <strong>initialize</strong> </a>
</span>
@@ -610,267 +292,62 @@
</div></span>
</li>
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#read-instance_method" title="#read (instance method)">- (Object) <strong>read</strong>(prompt = true, default_value = nil, validator = nil, echo = true) </a>
-
-
-
- </span>
+ </ul>
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Reads a string from the console.</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>
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ConsoleMethods/Interactions.html" title="Bovem::ConsoleMethods::Interactions (module)">Bovem::ConsoleMethods::Interactions</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="ConsoleMethods/Interactions.html#read-instance_method" title="Bovem::ConsoleMethods::Interactions#read (method)">#read</a></span>, <span class='object_link'><a href="ConsoleMethods/Interactions.html#task-instance_method" title="Bovem::ConsoleMethods::Interactions#task (method)">#task</a></span></p>
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#reset_indentation-instance_method" title="#reset_indentation (instance method)">- (Fixnum) <strong>reset_indentation</strong> </a>
-
-
-
- </span>
-
- <span class="summary_desc"><div class='inline'><p>Resets indentation width to <code>0</code>.</p>
-</div></span>
-</li>
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ConsoleMethods/Logging.html" title="Bovem::ConsoleMethods::Logging (module)">Bovem::ConsoleMethods::Logging</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="ConsoleMethods/Logging.html#begin-instance_method" title="Bovem::ConsoleMethods::Logging#begin (method)">#begin</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html#debug-instance_method" title="Bovem::ConsoleMethods::Logging#debug (method)">#debug</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html#error-instance_method" title="Bovem::ConsoleMethods::Logging#error (method)">#error</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html#fatal-instance_method" title="Bovem::ConsoleMethods::Logging#fatal (method)">#fatal</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html#get_banner-instance_method" title="Bovem::ConsoleMethods::Logging#get_banner (method)">#get_banner</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html#info-instance_method" title="Bovem::ConsoleMethods::Logging#info (method)">#info</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html#status-instance_method" title="Bovem::ConsoleMethods::Logging#status (method)">#status</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html#warn-instance_method" title="Bovem::ConsoleMethods::Logging#warn (method)">#warn</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html#write-instance_method" title="Bovem::ConsoleMethods::Logging#write (method)">#write</a></span>, <span class='object_link'><a href="ConsoleMethods/Logging.html#write_banner_aligned-instance_method" title="Bovem::ConsoleMethods::Logging#write_banner_aligned (method)">#write_banner_aligned</a></span></p>
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#set_indentation-instance_method" title="#set_indentation (instance method)">- (Fixnum) <strong>set_indentation</strong>(width, is_absolute = false) </a>
-
-
-
- </span>
-
- <span class="summary_desc"><div class='inline'><p>Sets the new indentation width.</p>
-</div></span>
-</li>
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ConsoleMethods/Output.html" title="Bovem::ConsoleMethods::Output (module)">Bovem::ConsoleMethods::Output</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="ConsoleMethods/Output.html#format-instance_method" title="Bovem::ConsoleMethods::Output#format (method)">#format</a></span>, <span class='object_link'><a href="ConsoleMethods/Output.html#format_right-instance_method" title="Bovem::ConsoleMethods::Output#format_right (method)">#format_right</a></span>, <span class='object_link'><a href="ConsoleMethods/Output.html#get_screen_width-instance_method" title="Bovem::ConsoleMethods::Output#get_screen_width (method)">#get_screen_width</a></span>, <span class='object_link'><a href="ConsoleMethods/Output.html#indent-instance_method" title="Bovem::ConsoleMethods::Output#indent (method)">#indent</a></span>, <span class='object_link'><a href="ConsoleMethods/Output.html#reset_indentation-instance_method" title="Bovem::ConsoleMethods::Output#reset_indentation (method)">#reset_indentation</a></span>, <span class='object_link'><a href="ConsoleMethods/Output.html#set_indentation-instance_method" title="Bovem::ConsoleMethods::Output#set_indentation (method)">#set_indentation</a></span>, <span class='object_link'><a href="ConsoleMethods/Output.html#with_indentation-instance_method" title="Bovem::ConsoleMethods::Output#with_indentation (method)">#with_indentation</a></span>, <span class='object_link'><a href="ConsoleMethods/Output.html#wrap-instance_method" title="Bovem::ConsoleMethods::Output#wrap (method)">#wrap</a></span></p>
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#status-instance_method" title="#status (instance method)">- (Array) <strong>status</strong>(status, plain = false, go_up = true, right = true, print = true) </a>
-
-
-
- </span>
-
- <span class="summary_desc"><div class='inline'><p>Writes a status to the output.</p>
-</div></span>
-
-</li>
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ConsoleMethods/StyleHandling.html" title="Bovem::ConsoleMethods::StyleHandling (module)">Bovem::ConsoleMethods::StyleHandling</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="ConsoleMethods/StyleHandling.html#replace_markers-instance_method" title="Bovem::ConsoleMethods::StyleHandling#replace_markers (method)">#replace_markers</a></span></p>
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#task-instance_method" title="#task (instance method)">- (Symbol) <strong>task</strong>(message = nil, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, block_indentation = 2, block_indentation_absolute = false) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Executes a block of code in a indentation region and then prints out and ending status message.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#warn-instance_method" title="#warn (instance method)">- (Object) <strong>warn</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Writes a message prepending a yellow banner.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#with_indentation-instance_method" title="#with_indentation (instance method)">- (Fixnum) <strong>with_indentation</strong>(width = 3, is_absolute = false) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Starts a indented region of text.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#wrap-instance_method" title="#wrap (instance method)">- (String) <strong>wrap</strong>(message, width = nil) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Wraps a message in fixed line width.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#write-instance_method" title="#write (instance method)">- (String) <strong>write</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, print = true) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Writes a message.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#write_banner_aligned-instance_method" title="#write_banner_aligned (instance method)">- (String) <strong>write_banner_aligned</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, print = true) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'><p>Writes a message, aligning to a call with an empty banner.</p>
-</div></span>
-
-</li>
-
-
- </ul>
-
-
-<div id="constructor_details" class="method_details_list">
+ <div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
@@ -894,23 +371,27 @@
<tr>
<td>
<pre class="lines">
-148
-149
-150
-151
-152</pre>
+636
+637
+638
+639
+640
+641
+642</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 148</span>
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 636</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='ivar'>@line_width</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_screen_width'>get_screen_width</span>
<span class='ivar'>@indentation</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='ivar'>@indentation_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span>
+ <span class='ivar'>@stty</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_execute'>execute</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>which stty</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span>
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_i18n_setup'>i18n_setup</span><span class='lparen'>(</span><span class='symbol'>:bovem</span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_absolute_path'>absolute_path</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/../../locales/</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -923,11 +404,11 @@
<span id="indentation=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="indentation-instance_method">
- - (<tt>Object</tt>) <strong>indentation</strong>
+ - (<tt>Fixnum</tt>) <strong>indentation</strong>
@@ -938,328 +419,22 @@
</div>
</div>
<div class="tags">
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-41
-42
-43</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 41</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_indentation'>indentation</span>
- <span class='ivar'>@indentation</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="indentation_string=-instance_method"></span>
- <div class="method_details ">
- <h3 class="signature " id="indentation_string-instance_method">
-
- - (<tt>Object</tt>) <strong>indentation_string</strong>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>The string used for indentation.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-44
-45
-46</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 44</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_indentation_string'>indentation_string</span>
- <span class='ivar'>@indentation_string</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="line_width=-instance_method"></span>
- <div class="method_details ">
- <h3 class="signature " id="line_width-instance_method">
-
- - (<tt>Object</tt>) <strong>line_width</strong>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>The line width. Default to <code>80</code>.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-35
-36
-37</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 35</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_line_width'>line_width</span>
- <span class='ivar'>@line_width</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="screen_width=-instance_method"></span>
- <div class="method_details ">
- <h3 class="signature " id="screen_width-instance_method">
-
- - (<tt>Object</tt>) <strong>screen_width</strong>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>The current screen width.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-38
-39
-40</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 38</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_screen_width'>screen_width</span>
- <span class='ivar'>@screen_width</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- </div>
-
-
- <div id="class_method_details" class="method_details_list">
- <h2>Class Method Details</h2>
-
-
- <div class="method_details first">
- <h3 class="signature first" id="execute-class_method">
-
- + (<tt>String</tt>) <strong>execute</strong>(command)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Executes a command and returns its output.</p>
-
-
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>command</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
-
- —
- <div class='inline'><p>The command to execute.</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 command's output.</p>
-</div>
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-143
-144
-145</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 143</span>
-
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='id identifier rubyid_command'>command</span><span class='rparen'>)</span>
- <span class='backtick'>%x{</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_command'>command</span><span class='rbrace'>}</span><span class='tstring_end'>}</span></span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="instance-class_method">
-
- + (<tt><span class='object_link'><a href="" title="Bovem::Console (class)">Console</a></span></tt>) <strong>instance</strong>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Returns a unique instance for Console.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt><span class='object_link'><a href="" title="Bovem::Console (class)">Console</a></span></tt>)</span>
-
-
-
- —
- <div class='inline'><p>A new instance.</p>
-</div>
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-58
-59
-60</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 58</span>
-
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span>
- <span class='ivar'>@instance</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_new'>new</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="min_banner_length-class_method">
-
- + (<tt>Fixnum</tt>) <strong>min_banner_length</strong>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Returns the minimum length of a banner, not including brackets and leading spaces.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
<span class='type'>(<tt>Fixnum</tt>)</span>
—
- <div class='inline'><p>The minimum length of a banner.</p>
+ <div class='inline'><p>the current value of indentation</p>
</div>
</li>
</ul>
@@ -1268,199 +443,45 @@
<tr>
<td>
<pre class="lines">
-135
-136
-137</pre>
+616
+617
+618</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 135</span>
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 616</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_min_banner_length'>min_banner_length</span>
- <span class='int'>1</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_indentation'>indentation</span>
+ <span class='ivar'>@indentation</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
- <div class="method_details ">
- <h3 class="signature " id="parse_style-class_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">
-
-
-68
-69
-70
-71
-72
-73
-74
-75
-76
-77
-78
-79
-80
-81
-82
-83
-84
-85
-86
-87</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 68</span>
-
-<span class='kw'>def</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_style'>style</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></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='op'>&&</span> <span class='id identifier rubyid_style'>style</span> <span class='op'>!~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^[,-]$</span><span class='regexp_end'>/</span></span> <span class='kw'>then</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='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='kw'>if</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>TERM_EFFECTS</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='kw'>then</span>
- <span class='id identifier rubyid_rv'>rv</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='const'>Bovem</span><span class='op'>::</span><span class='const'>TERM_EFFECTS</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='kw'>elsif</span> <span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bg_</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>==</span> <span class='int'>0</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='lbracket'>[</span><span class='int'>3</span><span class='comma'>,</span> <span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
- <span class='id identifier rubyid_rv'>rv</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='int'>40</span> <span class='op'>+</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>TERM_COLORS</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='kw'>if</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>TERM_COLORS</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='kw'>elsif</span> <span class='id identifier rubyid_style'>style</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'>then</span>
- <span class='id identifier rubyid_rv'>rv</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='int'>30</span> <span class='op'>+</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>TERM_COLORS</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='kw'>if</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>TERM_COLORS</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='kw'>end</span>
- <span class='kw'>end</span>
-
- <span class='id identifier rubyid_rv'>rv</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
+ <span id="indentation_string=-instance_method"></span>
<div class="method_details ">
- <h3 class="signature " id="replace_markers-class_method">
+ <h3 class="signature " id="indentation_string-instance_method">
- + (<tt>String</tt>) <strong>replace_markers</strong>(message, plain = false)
+ - (<tt>String</tt>) <strong>indentation_string</strong>
</h3><div class="docstring">
<div class="discussion">
- <p>Replaces colors markers in a string.</p>
+ <p>The string used for indentation.</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>
-
-<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'>"</span><span class='tstring_content'>{mark=bright bg_red}{mark=green}Hello world!{/mark}{/mark}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
-<span class='comment'># => "\e[1m\e[41m\e[32mHello world!\e[1m\e[41m\e[0m"
-</span></code></pre>
-
-
</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>
@@ -1468,1381 +489,111 @@
<span class='type'>(<tt>String</tt>)</span>
—
- <div class='inline'><p>The replaced message.</p>
+ <div class='inline'><p>the current value of indentation_string</p>
</div>
</li>
</ul>
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li>#parse_style</li>
-
- </ul>
-
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-104
-105
-106
-107
-108
-109
-110
-111
-112
-113
-114
-115
-116
-117
-118
-119
-120
-121
-122
-123
-124
-125
-126
-127
-128
-129
-130
-131</pre>
+616
+617
+618</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 104</span>
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 616</span>
-<span class='kw'>def</span> <span class='kw'>self</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='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_mark_regexp'>mark_regexp</span> <span class='op'>=</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='id identifier rubyid_split_regex'>split_regex</span> <span class='op'>=</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='id identifier rubyid_message'>message</span> <span class='op'>=</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='id identifier rubyid_mark_regexp'>mark_regexp</span><span class='rparen'>)</span> <span class='kw'>do</span>
- <span class='id identifier rubyid_tag'>tag</span> <span class='op'>=</span> <span class='backref'>$1</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='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
-
- <span class='kw'>if</span> <span class='id identifier rubyid_tag'>tag</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_styles'>styles</span> <span class='op'>=</span> <span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</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='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='id identifier rubyid_styles'>styles</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='id identifier rubyid_split_regex'>split_regex</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'>else</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='id identifier rubyid_styles'>styles</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='id identifier rubyid_split_regex'>split_regex</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'>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='kw'>end</span>
-
- <span class='id identifier rubyid_replacement'>replacement</span>
- <span class='kw'>end</span>
-
- <span class='id identifier rubyid_message'>message</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_indentation_string'>indentation_string</span>
+ <span class='ivar'>@indentation_string</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
- </div>
-
- <div id="instance_method_details" class="method_details_list">
- <h2>Instance Method Details</h2>
-
-
- <div class="method_details first">
- <h3 class="signature first" id="begin-instance_method">
-
- - (<tt>Object</tt>) <strong>begin</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Writes a message prepending a green banner.</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line for wrapped text. <code>true</code> means the current line width.</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 color markers into the message.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indented_banner</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If also the banner should be indented.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>full_colored</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the banner should be fully colored.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>print</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If <code>false</code>, the result will be returned instead of be printed.</p>
-</div>
-
- </li>
-
-</ul>
-
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#format-instance_method" title="Bovem::Console#format (method)">#format</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-408
-409
-410
-411
-412</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 408</span>
-
-<span class='kw'>def</span> <span class='kw'>begin</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_banner'>banner</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_banner'>get_banner</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bright green</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
- <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indent'>indent</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='id identifier rubyid_indent'>indent</span><span class='rparen'>)</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_banner'>banner</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
+ <span id="line_width=-instance_method"></span>
<div class="method_details ">
- <h3 class="signature " id="debug-instance_method">
+ <h3 class="signature " id="line_width-instance_method">
- - (<tt>Object</tt>) <strong>debug</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true)
+ - (<tt>Fixnum</tt>) <strong>line_width</strong>
</h3><div class="docstring">
<div class="discussion">
- <p>Writes a message prepending a magenta banner.</p>
+ <p>The line width. Default to <code>80</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line for wrapped text. <code>true</code> means the current line width.</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 color markers into the message.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indented_banner</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If also the banner should be indented.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>full_colored</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the banner should be fully colored.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>print</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If <code>false</code>, the result will be returned instead of be printed.</p>
-</div>
-
- </li>
-
-</ul>
-
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#format-instance_method" title="Bovem::Console#format (method)">#format</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-480
-481
-482
-483
-484</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 480</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_debug'>debug</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_banner'>banner</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_banner'>get_banner</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>D</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bright magenta</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indent'>indent</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='id identifier rubyid_indent'>indent</span><span class='rparen'>)</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_banner'>banner</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="error-instance_method">
-
- - (<tt>Object</tt>) <strong>error</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Writes a message prepending a red banner.</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line for wrapped text. <code>true</code> means the current line width.</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 color markers into the message.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indented_banner</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If also the banner should be indented.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>full_colored</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the banner should be fully colored.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>print</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If <code>false</code>, the result will be returned instead of be printed.</p>
-</div>
-
- </li>
-
-</ul>
-
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#format-instance_method" title="Bovem::Console#format (method)">#format</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-444
-445
-446
-447
-448</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 444</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_banner'>banner</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_banner'>get_banner</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>E</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bright red</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indent'>indent</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='id identifier rubyid_indent'>indent</span><span class='rparen'>)</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_banner'>banner</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="fatal-instance_method">
-
- - (<tt>Object</tt>) <strong>fatal</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, return_code = -1,, print = true)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Writes a message prepending a red banner and then quits the application.</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line for wrapped text. <code>true</code> means the current line width.</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 color markers into the message.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indented_banner</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If also the banner should be indented.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>full_colored</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the banner should be fully colored.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>return_code</span>
-
-
- <span class='type'>(<tt>Fixnum</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>-1,</tt>)</em>
-
-
- —
- <div class='inline'><p>The code to return to the shell.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>print</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If <code>false</code>, the result will be returned instead of be printed.</p>
-</div>
-
- </li>
-
-</ul>
-
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#format-instance_method" title="Bovem::Console#format (method)">#format</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-463
-464
-465
-466</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 463</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_return_code'>return_code</span> <span class='op'>=</span> <span class='op'>-</span><span class='int'>1</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span><span class='rparen'>)</span>
- <span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span><span class='id identifier rubyid_return_code'>return_code</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span><span class='lparen'>(</span><span class='op'>-</span><span class='int'>1</span><span class='rparen'>)</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="format-instance_method">
-
- - (<tt>String</tt>) <strong>format</strong>(message, suffix = "\n", indent = true, wrap = true, plain = false)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Formats a message.</p>
-
-<p>You can style text by using <code>{mark}</code> and <code>{/mark}</code> syntax.</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line. <code>true</code> means the current line width.</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 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 formatted message.</p>
-</div>
-
- </li>
-
-</ul>
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#replace_markers-instance_method" title="Bovem::Console#replace_markers (method)">#replace_markers</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-252
-253
-254
-255
-256
-257
-258
-259
-260
-261
-262
-263
-264
-265
-266
-267
-268
-269
-270
-271
-272
-273
-274</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 252</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>true</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_rv'>rv</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
-
- <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_replace_markers'>replace_markers</span><span class='lparen'>(</span><span class='id identifier rubyid_rv'>rv</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='rparen'>)</span> <span class='comment'># Replace markers
-</span>
- <span class='comment'># Compute the real width available for the screen, if we both indent and wrap
-</span> <span class='kw'>if</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>==</span> <span class='kw'>true</span> <span class='kw'>then</span>
- <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='ivar'>@line_width</span>
-
- <span class='kw'>if</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>==</span> <span class='kw'>true</span> <span class='kw'>then</span>
- <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>-=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indentation'>indentation</span>
- <span class='kw'>else</span>
- <span class='id identifier rubyid_indent_i'>indent_i</span> <span class='op'>=</span> <span class='id identifier rubyid_indent'>indent</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span>
- <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>-=</span> <span class='lparen'>(</span><span class='id identifier rubyid_indent_i'>indent_i</span> <span class='op'>></span> <span class='int'>0</span> <span class='op'>?</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indentation'>indentation</span> <span class='op'>:</span> <span class='int'>0</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='id identifier rubyid_indent_i'>indent_i</span>
- <span class='kw'>end</span>
- <span class='kw'>end</span>
-
- <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_wrap'>wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_rv'>rv</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='rparen'>)</span> <span class='comment'># Wrap
-</span> <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indent'>indent</span><span class='lparen'>(</span><span class='id identifier rubyid_rv'>rv</span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span><span class='rparen'>)</span> <span class='comment'># Indent
-</span>
- <span class='id identifier rubyid_rv'>rv</span> <span class='op'>+=</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span> <span class='kw'>if</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='comment'># Add the suffix
-</span> <span class='id identifier rubyid_rv'>rv</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="format_right-instance_method">
-
- - (<tt>String</tt>) <strong>format_right</strong>(message, width = true, go_up = true, plain = false)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Formats a message to be written right-aligned.</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>width</span>
-
-
<span class='type'>(<tt>Fixnum</tt>)</span>
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
—
- <div class='inline'><p>The screen width. If <code>true</code>, it is automatically computed.</p>
+ <div class='inline'><p>the current value of line_width</p>
</div>
</li>
- <li>
-
- <span class='name'>go_up</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If go up one line before formatting.</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 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 formatted message.</p>
-</div>
-
- </li>
-
-</ul>
-
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-283
-284
-285
-286
-287
-288
-289
-290
-291
-292
-293
-294
-295
-296</pre>
+616
+617
+618</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 283</span>
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 616</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_format_right'>format_right</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_width'>width</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_go_up'>go_up</span> <span class='op'>=</span> <span class='kw'>true</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_message'>message</span> <span class='op'>=</span> <span class='kw'>self</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>
-
- <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='id identifier rubyid_go_up'>go_up</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\e[A</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
-
- <span class='ivar'>@screen_width</span> <span class='op'>||=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_screen_width'>get_screen_width</span>
- <span class='id identifier rubyid_width'>width</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_width'>width</span> <span class='op'>==</span> <span class='kw'>true</span> <span class='op'>||</span> <span class='id identifier rubyid_width'>width</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span> <span class='op'><</span> <span class='int'>1</span> <span class='op'>?</span> <span class='ivar'>@screen_width</span> <span class='op'>:</span> <span class='id identifier rubyid_width'>width</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span><span class='rparen'>)</span>
-
- <span class='comment'># Get padding
-</span> <span class='id identifier rubyid_padding'>padding</span> <span class='op'>=</span> <span class='id identifier rubyid_width'>width</span> <span class='op'>-</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</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'>(\e\[[0-9]*[a-z]?)|(\\n)</span><span class='regexp_end'>/i</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='period'>.</span><span class='id identifier rubyid_length'>length</span>
-
- <span class='comment'># Return
-</span> <span class='id identifier rubyid_rv'>rv</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\e[0G\e[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_padding'>padding</span><span class='rbrace'>}</span><span class='tstring_content'>C</span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='id identifier rubyid_message'>message</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_line_width'>line_width</span>
+ <span class='ivar'>@line_width</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
- <div class="method_details ">
- <h3 class="signature " id="get_banner-instance_method">
-
- - (<tt>String</tt>) <strong>get_banner</strong>(label, base_color, full_colored = false, bracket_color = "blue", brackets = ["[", "]"])
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Gets a banner for the messages.</p>
-
-
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
- <span class='name'>label</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
-
- —
- <div class='inline'><p>The label for the banner.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>base_color</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
-
- —
- <div class='inline'><p>The color for the label.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>full_colored</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If all the message should be of the label color.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>bracket_color</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"blue"</tt>)</em>
-
-
- —
- <div class='inline'><p>The color of the brackets.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>brackets</span>
-
-
- <span class='type'>(<tt>Array</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>["[", "]"]</tt>)</em>
-
-
- —
- <div class='inline'><p>An array of dimension 2 to use for brackets.</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 banner.</p>
-</div>
-
- </li>
-
-</ul>
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#format-instance_method" title="Bovem::Console#format (method)">#format</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-371
-372
-373
-374
-375
-376</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 371</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_get_banner'>get_banner</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='comma'>,</span> <span class='id identifier rubyid_base_color'>base_color</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_bracket_color'>bracket_color</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>blue</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_brackets'>brackets</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>]</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_label'>label</span> <span class='op'>=</span> <span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_rjust'>rjust</span><span class='lparen'>(</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_min_banner_length'>min_banner_length</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
- <span class='id identifier rubyid_brackets'>brackets</span> <span class='op'>=</span> <span class='id identifier rubyid_brackets'>brackets</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
- <span class='id identifier rubyid_bracket_color'>bracket_color</span> <span class='op'>=</span> <span class='id identifier rubyid_base_color'>base_color</span> <span class='kw'>if</span> <span class='id identifier rubyid_full_colored'>full_colored</span>
- <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>{mark=%s}%s{mark=%s}%s{/mark}%s{/mark}</span><span class='tstring_end'>"</span></span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='id identifier rubyid_bracket_color'>bracket_color</span><span class='period'>.</span><span class='id identifier rubyid_parameterize'>parameterize</span><span class='comma'>,</span> <span class='id identifier rubyid_brackets'>brackets</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_base_color'>base_color</span><span class='period'>.</span><span class='id identifier rubyid_parameterize'>parameterize</span><span class='comma'>,</span> <span class='id identifier rubyid_label'>label</span><span class='comma'>,</span> <span class='id identifier rubyid_brackets'>brackets</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
+ <span id="screen_width=-instance_method"></span>
<div class="method_details ">
- <h3 class="signature " id="get_screen_width-instance_method">
+ <h3 class="signature " id="screen_width-instance_method">
- - (<tt>Fixnum</tt>) <strong>get_screen_width</strong>
+ - (<tt>Fixnum</tt>) <strong>screen_width</strong>
</h3><div class="docstring">
<div class="discussion">
- <p>Gets the current screen width.</p>
+ <p>The current screen width.</p>
</div>
</div>
<div class="tags">
@@ -2856,11 +607,11 @@
<span class='type'>(<tt>Fixnum</tt>)</span>
—
- <div class='inline'><p>The screen width.</p>
+ <div class='inline'><p>the current value of screen_width</p>
</div>
</li>
</ul>
@@ -2869,1982 +620,96 @@
<tr>
<td>
<pre class="lines">
-157
-158
-159</pre>
+616
+617
+618</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 157</span>
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 616</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_get_screen_width'>get_screen_width</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_execute'>execute</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>tput cols</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span><span class='lparen'>(</span><span class='int'>80</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_screen_width'>screen_width</span>
+ <span class='ivar'>@screen_width</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
- <div class="method_details ">
- <h3 class="signature " id="indent-instance_method">
-
- - (<tt>String</tt>) <strong>indent</strong>(message, width = true, newline_separator = "\n")
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Indents a message.</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 indent.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>width</span>
-
-
- <span class='type'>(<tt>Fixnum</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>The indentation width. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces. <code>nil</code> or <code>false</code> will skip indentation.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>newline_separator</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>The character used for newlines.</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 indentend message.</p>
-</div>
-
- </li>
-
-</ul>
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
+ <div id="class_method_details" class="method_details_list">
+ <h2>Class Method Details</h2>
-
-216
-217
-218
-219
-220
-221
-222
-223
-224
-225
-226
-227</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 216</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_indent'>indent</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_width'>width</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_newline_separator'>newline_separator</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
- <span class='kw'>if</span> <span class='id identifier rubyid_width'>width</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span> <span class='op'>!=</span> <span class='int'>0</span> <span class='kw'>then</span>
- <span class='id identifier rubyid_width'>width</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_width'>width</span> <span class='op'>==</span> <span class='kw'>true</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='id identifier rubyid_width'>width</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_width'>width</span> <span class='op'>=</span> <span class='id identifier rubyid_width'>width</span> <span class='op'><</span> <span class='int'>0</span> <span class='op'>?</span> <span class='op'>-</span><span class='id identifier rubyid_width'>width</span> <span class='op'>:</span> <span class='ivar'>@indentation</span> <span class='op'>+</span> <span class='id identifier rubyid_width'>width</span>
-
- <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='id identifier rubyid_newline_separator'>newline_separator</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_line'>line</span><span class='op'>|</span>
- <span class='lparen'>(</span><span class='ivar'>@indentation_string</span> <span class='op'>*</span> <span class='id identifier rubyid_width'>width</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='id identifier rubyid_line'>line</span>
- <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_newline_separator'>newline_separator</span><span class='rparen'>)</span>
- <span class='kw'>end</span>
-
- <span class='id identifier rubyid_message'>message</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
- <div class="method_details ">
- <h3 class="signature " id="info-instance_method">
+ <div class="method_details first">
+ <h3 class="signature first" id="instance-class_method">
- - (<tt>Object</tt>) <strong>info</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true)
+ + (<tt><span class='object_link'><a href="" title="Bovem::Console (class)">Console</a></span></tt>) <strong>instance</strong>
</h3><div class="docstring">
<div class="discussion">
- <p>Writes a message prepending a cyan banner.</p>
+ <p>Returns a unique instance for Console.</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line for wrapped text. <code>true</code> means the current line width.</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 color markers into the message.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indented_banner</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If also the banner should be indented.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>full_colored</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the banner should be fully colored.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>print</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If <code>false</code>, the result will be returned instead of be printed.</p>
-</div>
-
- </li>
-
-</ul>
-
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#format-instance_method" title="Bovem::Console#format (method)">#format</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-390
-391
-392
-393
-394</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 390</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_info'>info</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_banner'>banner</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_banner'>get_banner</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>I</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bright cyan</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indent'>indent</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='id identifier rubyid_indent'>indent</span><span class='rparen'>)</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_banner'>banner</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="read-instance_method">
-
- - (<tt>Object</tt>) <strong>read</strong>(prompt = true, default_value = nil, validator = nil, echo = true)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Reads a string from the console.</p>
-
-
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>prompt</span>
-
-
- <span class='type'>(<tt>String|Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>A prompt to show. If <code>true</code>, <code>Please insert a value:</code> will be used, if <code>nil</code> or <code>false</code> no prompt will be shown.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>default_value</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>nil</tt>)</em>
-
-
- —
- <div class='inline'><p>Default value if user simply pressed the enter key.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>validator</span>
-
-
- <span class='type'>(<tt>Array|Regexp</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>nil</tt>)</em>
-
-
- —
- <div class='inline'><p>An array of values or a Regexp to match the submitted value against.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>echo</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If to show submitted text to the user.</p>
-</div>
-
- </li>
-
-</ul>
-
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-492
-493
-494
-495
-496
-497
-498
-499
-500
-501
-502
-503
-504
-505
-506
-507
-508
-509
-510
-511
-512
-513
-514
-515
-516
-517
-518
-519
-520
-521
-522
-523
-524
-525
-526
-527
-528
-529
-530
-531
-532
-533
-534
-535
-536
-537
-538
-539
-540
-541</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 492</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_prompt'>prompt</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_default_value'>default_value</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_validator'>validator</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_echo'>echo</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='comment'># Write the prompt
-</span> <span class='id identifier rubyid_prompt'>prompt</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Please insert a value</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_prompt'>prompt</span> <span class='op'>==</span> <span class='kw'>true</span>
- <span class='id identifier rubyid_final_prompt'>final_prompt</span> <span class='op'>=</span> <span class='op'>!</span><span class='id identifier rubyid_prompt'>prompt</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_prompt'>prompt</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'>:?\s*$</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='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>: </span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='kw'>nil</span>
-
- <span class='comment'># Adjust validator
-</span> <span class='id identifier rubyid_validator'>validator</span> <span class='op'>=</span> <span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</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_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Regexp</span><span class='rparen'>)</span>
-
- <span class='comment'># Handle echo
-</span> <span class='id identifier rubyid_stty'>stty</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_execute'>execute</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>which stty</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span>
- <span class='id identifier rubyid_disable_echo'>disable_echo</span> <span class='op'>=</span> <span class='op'>!</span><span class='id identifier rubyid_echo'>echo</span> <span class='op'>&&</span> <span class='id identifier rubyid_stty'>stty</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>&&</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>-echo\b</span><span class='regexp_end'>/mix</span></span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</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_execute'>execute</span><span class='lparen'>(</span><span class='id identifier rubyid_stty'>stty</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
-
- <span class='comment'># Disable echo
-</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_execute'>execute</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_stty'>stty</span><span class='rbrace'>}</span><span class='tstring_content'> -echo</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_disable_echo'>disable_echo</span>
-
- <span class='kw'>begin</span>
- <span class='id identifier rubyid_catch'>catch</span><span class='lparen'>(</span><span class='symbol'>:reply</span><span class='rparen'>)</span> <span class='kw'>do</span>
- <span class='kw'>while</span> <span class='kw'>true</span> <span class='kw'>do</span>
- <span class='id identifier rubyid_valid'>valid</span> <span class='op'>=</span> <span class='kw'>true</span>
-
- <span class='kw'>if</span> <span class='id identifier rubyid_final_prompt'>final_prompt</span> <span class='kw'>then</span>
- <span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_print'>print</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span><span class='id identifier rubyid_final_prompt'>final_prompt</span><span class='comma'>,</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
- <span class='gvar'>$stdout</span><span class='period'>.</span><span class='id identifier rubyid_flush'>flush</span>
- <span class='kw'>end</span>
-
- <span class='id identifier rubyid_reply'>reply</span> <span class='op'>=</span> <span class='gvar'>$stdin</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_chop'>chop</span>
- <span class='id identifier rubyid_reply'>reply</span> <span class='op'>=</span> <span class='id identifier rubyid_default_value'>default_value</span> <span class='kw'>if</span> <span class='id identifier rubyid_reply'>reply</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
-
- <span class='comment'># Match against the validator
-</span> <span class='kw'>if</span> <span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='kw'>then</span>
- <span class='kw'>if</span> <span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='kw'>then</span>
- <span class='id identifier rubyid_valid'>valid</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>></span> <span class='int'>0</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_reply'>reply</span><span class='rparen'>)</span>
- <span class='kw'>elsif</span> <span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Regexp</span><span class='rparen'>)</span> <span class='kw'>then</span>
- <span class='id identifier rubyid_valid'>valid</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_reply'>reply</span><span class='rparen'>)</span>
- <span class='kw'>end</span>
- <span class='kw'>end</span>
-
- <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_valid'>valid</span> <span class='kw'>then</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Sorry, your reply was not understood. Please try again.</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
- <span class='kw'>else</span>
- <span class='id identifier rubyid_throw'>throw</span><span class='lparen'>(</span><span class='symbol'>:reply</span><span class='comma'>,</span> <span class='id identifier rubyid_reply'>reply</span><span class='rparen'>)</span>
- <span class='kw'>end</span>
- <span class='kw'>end</span>
- <span class='kw'>end</span>
- <span class='kw'>rescue</span> <span class='const'>Interrupt</span>
- <span class='id identifier rubyid_default_value'>default_value</span>
- <span class='kw'>ensure</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_execute'>execute</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_stty'>stty</span><span class='rbrace'>}</span><span class='tstring_content'> echo</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_disable_echo'>disable_echo</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_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>
-
-
- </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>
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Bovem::Console (class)">Console</a></span></tt>)</span>
—
- <div class='inline'><p>The replaced message.</p>
+ <div class='inline'><p>A new instance.</p>
</div>
</li>
</ul>
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#replace_markers-class_method" title="Bovem::Console.replace_markers (method)">replace_markers</a></span></li>
-
- </ul>
-
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-236
-237
-238</pre>
+631
+632
+633</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 236</span>
+ <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 631</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='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>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span>
+ <span class='ivar'>@instance</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_new'>new</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
- <div class="method_details ">
- <h3 class="signature " id="reset_indentation-instance_method">
-
- - (<tt>Fixnum</tt>) <strong>reset_indentation</strong>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Resets indentation width to <code>0</code>.</p>
-
-
</div>
-</div>
-<div class="tags">
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Fixnum</tt>)</span>
-
-
-
- —
- <div class='inline'><p>The new indentation width.</p>
-</div>
-
- </li>
-
-</ul>
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-174
-175
-176
-177</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 174</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_reset_indentation'>reset_indentation</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indentation'>indentation</span> <span class='op'>=</span> <span class='int'>0</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indentation'>indentation</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
</div>
-
- <div class="method_details ">
- <h3 class="signature " id="set_indentation-instance_method">
-
- - (<tt>Fixnum</tt>) <strong>set_indentation</strong>(width, is_absolute = false)
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Sets the new indentation width.</p>
-
-
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>width</span>
-
-
- <span class='type'>(<tt>Fixnum</tt>)</span>
-
-
-
- —
- <div class='inline'><p>The new width.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>is_absolute</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the new width should not be added to the current one but rather replace it.</p>
-</div>
-
- </li>
-
-</ul>
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Fixnum</tt>)</span>
-
-
-
- —
- <div class='inline'><p>The new indentation width.</p>
-</div>
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-166
-167
-168
-169</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 166</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_set_indentation'>set_indentation</span><span class='lparen'>(</span><span class='id identifier rubyid_width'>width</span><span class='comma'>,</span> <span class='id identifier rubyid_is_absolute'>is_absolute</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indentation'>indentation</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='lparen'>(</span><span class='op'>!</span><span class='id identifier rubyid_is_absolute'>is_absolute</span> <span class='op'>?</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indentation'>indentation</span> <span class='op'>:</span> <span class='int'>0</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='id identifier rubyid_width'>width</span><span class='comma'>,</span> <span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_max'>max</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indentation'>indentation</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="status-instance_method">
-
- - (<tt>Array</tt>) <strong>status</strong>(status, plain = false, go_up = true, right = true, print = true)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Writes a status to the output. Valid values are <code>:ok</code>, <code>:pass</code>, <code>:fail</code>, <code>:warn</code>.</p>
-
-
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>status</span>
-
-
- <span class='type'>(<tt>Symbol</tt>)</span>
-
-
-
- —
- <div class='inline'><p>The status to write.</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 not use colors.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>go_up</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If go up one line before formatting.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>right</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If to print results on the right.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>print</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If <code>false</code>, the result will be returned instead of be printed.</p>
-</div>
-
- </li>
-
-</ul>
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Array</tt>)</span>
-
-
-
- —
- <div class='inline'><p>An dictionary with <code>:label</code> and <code>:color</code> keys for the status.</p>
-</div>
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-338
-339
-340
-341
-342
-343
-344
-345
-346
-347
-348
-349
-350
-351
-352
-353
-354
-355
-356
-357
-358
-359
-360</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 338</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_go_up'>go_up</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_right'>right</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_statuses'>statuses</span> <span class='op'>=</span> <span class='lbrace'>{</span>
- <span class='symbol'>:ok</span> <span class='op'>=></span> <span class='lbrace'>{</span><span class='symbol'>:label</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> OK </span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bright green</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span><span class='comma'>,</span>
- <span class='symbol'>:pass</span> <span class='op'>=></span> <span class='lbrace'>{</span><span class='symbol'>:label</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PASS</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bright cyan</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span><span class='comma'>,</span>
- <span class='symbol'>:warn</span> <span class='op'>=></span> <span class='lbrace'>{</span><span class='symbol'>:label</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>WARN</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bright yellow</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span><span class='comma'>,</span>
- <span class='symbol'>:fail</span> <span class='op'>=></span> <span class='lbrace'>{</span><span class='symbol'>:label</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FAIL</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bright red</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span>
- <span class='rbrace'>}</span>
- <span class='id identifier rubyid_statuses'>statuses</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='id identifier rubyid_statuses'>statuses</span><span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='rbracket'>]</span>
-
- <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='id identifier rubyid_statuses'>statuses</span><span class='lbracket'>[</span><span class='id identifier rubyid_status'>status</span><span class='rbracket'>]</span>
-
- <span class='kw'>if</span> <span class='id identifier rubyid_print'>print</span> <span class='kw'>then</span>
- <span class='id identifier rubyid_banner'>banner</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_banner'>get_banner</span><span class='lparen'>(</span><span class='id identifier rubyid_rv'>rv</span><span class='lbracket'>[</span><span class='symbol'>:label</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_rv'>rv</span><span class='lbracket'>[</span><span class='symbol'>:color</span><span class='rbracket'>]</span><span class='rparen'>)</span>
-
- <span class='kw'>if</span> <span class='id identifier rubyid_right'>right</span> <span class='kw'>then</span>
- <span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_format_right'>format_right</span><span class='lparen'>(</span><span class='id identifier rubyid_banner'>banner</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_go_up'>go_up</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='rparen'>)</span>
- <span class='kw'>else</span>
- <span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span><span class='id identifier rubyid_banner'>banner</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='rparen'>)</span>
- <span class='kw'>end</span>
- <span class='kw'>end</span>
-
- <span class='id identifier rubyid_rv'>rv</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="task-instance_method">
-
- - (<tt>Symbol</tt>) <strong>task</strong>(message = nil, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, block_indentation = 2, block_indentation_absolute = false)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Executes a block of code in a indentation region and then prints out and ending status message.</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>
-
-
- <em class="default">(defaults to: <tt>nil</tt>)</em>
-
-
- —
- <div class='inline'><p>The message to format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line for wrapped text. <code>true</code> means the current line width.</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 color markers into the message.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indented_banner</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If also the banner should be indented.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>full_colored</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the banner should be fully colored.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>block_indentation</span>
-
-
- <span class='type'>(<tt>Fixnum</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>2</tt>)</em>
-
-
- —
- <div class='inline'><p>The new width for the indented region.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>block_indentation_absolute</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the new width should not be added to the current one but rather replace it.</p>
-</div>
-
- </li>
-
-</ul>
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Symbol</tt>)</span>
-
-
-
- —
- <div class='inline'><p>The exit status for the block.</p>
-</div>
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-555
-556
-557
-558
-559
-560
-561
-562
-563
-564
-565
-566
-567
-568
-569
-570
-571
-572
-573</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 555</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_task'>task</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_block_indentation'>block_indentation</span> <span class='op'>=</span> <span class='int'>2</span><span class='comma'>,</span> <span class='id identifier rubyid_block_indentation_absolute'>block_indentation_absolute</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='kw'>nil</span>
-
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_begin'>begin</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
-
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_with_indentation'>with_indentation</span><span class='lparen'>(</span><span class='id identifier rubyid_block_indentation'>block_indentation</span><span class='comma'>,</span> <span class='id identifier rubyid_block_indentation_absolute'>block_indentation_absolute</span><span class='rparen'>)</span> <span class='kw'>do</span>
- <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='id identifier rubyid_block_given?'>block_given?</span> <span class='op'>?</span> <span class='kw'>yield</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span> <span class='op'>:</span> <span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='rbracket'>]</span> <span class='comment'># Execute block
-</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='id identifier rubyid_rv'>rv</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='comment'># Return value
-</span>
- <span class='kw'>if</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='symbol'>:fatal</span> <span class='kw'>then</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='lparen'>(</span><span class='symbol'>:fail</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span><span class='id identifier rubyid_rv'>rv</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>></span> <span class='int'>1</span> <span class='op'>?</span> <span class='id identifier rubyid_rv'>rv</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span> <span class='op'>:</span> <span class='op'>-</span><span class='int'>1</span><span class='rparen'>)</span>
- <span class='kw'>else</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
- <span class='kw'>end</span>
- <span class='kw'>end</span>
-
- <span class='id identifier rubyid_status'>status</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="warn-instance_method">
-
- - (<tt>Object</tt>) <strong>warn</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, indented_banner = false, full_colored = false, print = true)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Writes a message prepending a yellow banner.</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line for wrapped text. <code>true</code> means the current line width.</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 color markers into the message.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indented_banner</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If also the banner should be indented.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>full_colored</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the banner should be fully colored.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>print</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If <code>false</code>, the result will be returned instead of be printed.</p>
-</div>
-
- </li>
-
-</ul>
-
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#format-instance_method" title="Bovem::Console#format (method)">#format</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-426
-427
-428
-429
-430</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 426</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_banner'>banner</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_banner'>get_banner</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>W</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bright yellow</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_full_colored'>full_colored</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indent'>indent</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='id identifier rubyid_indent'>indent</span><span class='rparen'>)</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_banner'>banner</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='comma'>,</span> <span class='id identifier rubyid_indented_banner'>indented_banner</span> <span class='op'>?</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="with_indentation-instance_method">
-
- - (<tt>Fixnum</tt>) <strong>with_indentation</strong>(width = 3, is_absolute = false)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Starts a indented region of text.</p>
-
-
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>width</span>
-
-
- <span class='type'>(<tt>Fixnum</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>3</tt>)</em>
-
-
- —
- <div class='inline'><p>The new width.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>is_absolute</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If the new width should not be added to the current one but rather replace it.</p>
-</div>
-
- </li>
-
-</ul>
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Fixnum</tt>)</span>
-
-
-
- —
- <div class='inline'><p>The new indentation width.</p>
-</div>
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-184
-185
-186
-187
-188
-189
-190
-191</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 184</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_with_indentation'>with_indentation</span><span class='lparen'>(</span><span class='id identifier rubyid_width'>width</span> <span class='op'>=</span> <span class='int'>3</span><span class='comma'>,</span> <span class='id identifier rubyid_is_absolute'>is_absolute</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_old'>old</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indentation'>indentation</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_set_indentation'>set_indentation</span><span class='lparen'>(</span><span class='id identifier rubyid_width'>width</span><span class='comma'>,</span> <span class='id identifier rubyid_is_absolute'>is_absolute</span><span class='rparen'>)</span>
- <span class='kw'>yield</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_set_indentation'>set_indentation</span><span class='lparen'>(</span><span class='id identifier rubyid_old'>old</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
-
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_indentation'>indentation</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="wrap-instance_method">
-
- - (<tt>String</tt>) <strong>wrap</strong>(message, width = nil)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Wraps a message in fixed line width.</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 wrap.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>width</span>
-
-
- <span class='type'>(<tt>Fixnum</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>nil</tt>)</em>
-
-
- —
- <div class='inline'><p>The maximum width of a line. Default to the current line width.</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 wrapped message.</p>
-</div>
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-198
-199
-200
-201
-202
-203
-204
-205
-206
-207
-208</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 198</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_width'>width</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
- <span class='kw'>if</span> <span class='id identifier rubyid_width'>width</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span> <span class='op'><=</span> <span class='int'>0</span> <span class='kw'>then</span>
- <span class='id identifier rubyid_message'>message</span>
- <span class='kw'>else</span>
- <span class='id identifier rubyid_width'>width</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_width'>width</span> <span class='op'>==</span> <span class='kw'>true</span> <span class='op'>||</span> <span class='id identifier rubyid_width'>width</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span> <span class='op'><</span> <span class='int'>0</span> <span class='op'>?</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_screen_width'>get_screen_width</span> <span class='op'>:</span> <span class='id identifier rubyid_width'>width</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span><span class='rparen'>)</span>
-
- <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_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_line'>line</span><span class='op'>|</span>
- <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>></span> <span class='id identifier rubyid_width'>width</span> <span class='op'>?</span> <span class='id identifier rubyid_line'>line</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'>(.{1,</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_width'>width</span><span class='rbrace'>}</span><span class='tstring_content'>})(\s+|$)</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\1\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span> <span class='op'>:</span> <span class='id identifier rubyid_line'>line</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_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
- <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="write-instance_method">
-
- - (<tt>String</tt>) <strong>write</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, print = true)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Writes a message.</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line for wrapped text. <code>true</code> means the current line width.</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 color markers into the message.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>print</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If <code>false</code>, the result will be returned instead of be printed.</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 printed message.</p>
-</div>
-
- </li>
-
-</ul>
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#format-instance_method" title="Bovem::Console#format (method)">#format</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-309
-310
-311
-312
-313</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 309</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='rparen'>)</span>
- <span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_rv'>rv</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_print'>print</span>
- <span class='id identifier rubyid_rv'>rv</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="write_banner_aligned-instance_method">
-
- - (<tt>String</tt>) <strong>write_banner_aligned</strong>(message, suffix = "\n", indent = true, wrap = false, plain = false, print = true)
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
- <p>Writes a message, aligning to a call with an empty banner.</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 format.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>suffix</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>"\n"</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, a suffix to add to the message. <code>true</code> means to add <code>\n</code>.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>indent</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the width to use for indentation. <code>true</code> means to use the current indentation, a negative value of <code>-x</code> will indent of <code>x</code> absolute spaces.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>wrap</span>
-
-
- <span class='type'>(<tt>Object</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>false</tt>)</em>
-
-
- —
- <div class='inline'><p>If not <code>nil</code> or <code>false</code>, the maximum length of a line for wrapped text. <code>true</code> means the current line width.</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 color markers into the message.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>print</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>true</tt>)</em>
-
-
- —
- <div class='inline'><p>If <code>false</code>, the result will be returned instead of be printed.</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 printed message.</p>
-</div>
-
- </li>
-
-</ul>
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li><span class='object_link'><a href="#format-instance_method" title="Bovem::Console#format (method)">#format</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-326
-327
-328</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 326</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_write_banner_aligned'>write_banner_aligned</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span> <span class='op'>*</span> <span class='lparen'>(</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_min_banner_length'>min_banner_length</span> <span class='op'>+</span> <span class='int'>3</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='op'>+</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='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='comma'>,</span> <span class='id identifier rubyid_indent'>indent</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='id identifier rubyid_plain'>plain</span><span class='comma'>,</span> <span class='id identifier rubyid_print'>print</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- </div>
-
-</div>
-
<div id="footer">
- Generated on Mon Oct 22 09:30:27 2012 by
+ Generated on Fri Feb 1 23:40:18 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.8.2.1 (ruby-1.9.2).
+ 0.8.3 (ruby-1.9.3).
</div>
</body>
</html>
\ No newline at end of file