<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Bovem::Shell
— Documentation by YARD 0.8.4
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> »
<span class='title'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span>
»
<span class="title">Shell</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Bovem::Shell
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Bovem::Shell</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2">Includes:</dt>
<dd class="r2"><span class='object_link'><a href="ShellMethods/Directories.html" title="Bovem::ShellMethods::Directories (module)">Bovem::ShellMethods::Directories</a></span>, <span class='object_link'><a href="ShellMethods/Execute.html" title="Bovem::ShellMethods::Execute (module)">Bovem::ShellMethods::Execute</a></span>, <span class='object_link'><a href="ShellMethods/General.html" title="Bovem::ShellMethods::General (module)">Bovem::ShellMethods::General</a></span>, <span class='object_link'><a href="ShellMethods/Read.html" title="Bovem::ShellMethods::Read (module)">Bovem::ShellMethods::Read</a></span>, <span class='object_link'><a href="ShellMethods/Write.html" title="Bovem::ShellMethods::Write (module)">Bovem::ShellMethods::Write</a></span>, Lazier::I18n</dd>
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/bovem/shell.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A utility class for most common shell operation.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#console-instance_method" title="#console (instance method)">- (Console) <strong>console</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>A console instance.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#instance-class_method" title="instance (class method)">+ (Shell) <strong>instance</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns a unique instance for Shell.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Shell) <strong>initialize</strong> </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initializes a new Shell.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ShellMethods/Directories.html" title="Bovem::ShellMethods::Directories (module)">Bovem::ShellMethods::Directories</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ShellMethods/Directories.html#create_directories-instance_method" title="Bovem::ShellMethods::Directories#create_directories (method)">#create_directories</a></span>, <span class='object_link'><a href="ShellMethods/Directories.html#within_directory-instance_method" title="Bovem::ShellMethods::Directories#within_directory (method)">#within_directory</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ShellMethods/Execute.html" title="Bovem::ShellMethods::Execute (module)">Bovem::ShellMethods::Execute</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ShellMethods/Execute.html#delete-instance_method" title="Bovem::ShellMethods::Execute#delete (method)">#delete</a></span>, <span class='object_link'><a href="ShellMethods/Execute.html#run-instance_method" title="Bovem::ShellMethods::Execute#run (method)">#run</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ShellMethods/Write.html" title="Bovem::ShellMethods::Write (module)">Bovem::ShellMethods::Write</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ShellMethods/Write.html#copy-instance_method" title="Bovem::ShellMethods::Write#copy (method)">#copy</a></span>, <span class='object_link'><a href="ShellMethods/Write.html#copy_or_move-instance_method" title="Bovem::ShellMethods::Write#copy_or_move (method)">#copy_or_move</a></span>, <span class='object_link'><a href="ShellMethods/Write.html#move-instance_method" title="Bovem::ShellMethods::Write#move (method)">#move</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ShellMethods/Read.html" title="Bovem::ShellMethods::Read (module)">Bovem::ShellMethods::Read</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ShellMethods/Read.html#check-instance_method" title="Bovem::ShellMethods::Read#check (method)">#check</a></span>, <span class='object_link'><a href="ShellMethods/Read.html#find-instance_method" title="Bovem::ShellMethods::Read#find (method)">#find</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ShellMethods/General.html" title="Bovem::ShellMethods::General (module)">Bovem::ShellMethods::General</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ShellMethods/General.html#handle_failure-instance_method" title="Bovem::ShellMethods::General#handle_failure (method)">#handle_failure</a></span>, <span class='object_link'><a href="ShellMethods/General.html#setup_error_handling-instance_method" title="Bovem::ShellMethods::General#setup_error_handling (method)">#setup_error_handling</a></span>, <span class='object_link'><a href="ShellMethods/General.html#show_general_failure-instance_method" title="Bovem::ShellMethods::General#show_general_failure (method)">#show_general_failure</a></span></p>
<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">
- (<tt><span class='object_link'><a href="" title="Bovem::Shell (class)">Shell</a></span></tt>) <strong>initialize</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes a new Shell.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
567
568
569
570</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 567</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='ivar'>@console</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_instance'>instance</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>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="console=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="console-instance_method">
- (<tt><span class='object_link'><a href="Console.html" title="Bovem::Console (class)">Console</a></span></tt>) <strong>console</strong>
</h3><div class="docstring">
<div class="discussion">
<p>A console instance.</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="Console.html" title="Bovem::Console (class)">Console</a></span></tt>)</span>
—
<div class='inline'><p>A console instance.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 549</span>
<span class='kw'>class</span> <span class='const'>Shell</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Lazier</span><span class='op'>::</span><span class='const'>I18n</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ShellMethods</span><span class='op'>::</span><span class='const'>General</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ShellMethods</span><span class='op'>::</span><span class='const'>Read</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ShellMethods</span><span class='op'>::</span><span class='const'>Write</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ShellMethods</span><span class='op'>::</span><span class='const'>Execute</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ShellMethods</span><span class='op'>::</span><span class='const'>Directories</span>
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:console</span>
<span class='comment'># Returns a unique instance for Shell.
</span> <span class='comment'>#
</span> <span class='comment'># @return [Shell] A new instance.
</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'>Shell</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='kw'>end</span>
<span class='comment'># Initializes a new Shell.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='ivar'>@console</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_instance'>instance</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>
<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="instance-class_method">
+ (<tt><span class='object_link'><a href="" title="Bovem::Shell (class)">Shell</a></span></tt>) <strong>instance</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a unique instance for Shell.</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::Shell (class)">Shell</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">
562
563
564</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 562</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'>Shell</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Feb 8 07:47:41 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.4 (ruby-1.9.3).
</div>
</body>
</html>