docs/Bovem/Shell.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Bovem::Shell
— Documentation by YARD 0.9.7
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "Bovem::Shell";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<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>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Bovem::Shell
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<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>
</dl>
<dl>
<dt>Includes:</dt>
<dd><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></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/bovem/shell.rb</dd>
</dl>
</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)">#<strong>console</strong> ⇒ Console </a>
</span>
<span class="summary_desc"><div class='inline'><p>A console instance.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#i18n-instance_method" title="#i18n (instance method)">#<strong>i18n</strong> ⇒ I18n </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A i18n helper.</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)">.<strong>instance</strong> ⇒ Shell </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)">#<strong>initialize</strong> ⇒ Shell </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#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>
<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">
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Bovem::Shell (class)">Shell</a></span></tt>
</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">
520
521
522
523</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 520</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='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Console.html" title="Bovem::Console (class)">Console</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'><span class='object_link'><a href="Console.html#instance-class_method" title="Bovem::Console.instance (method)">instance</a></span></span>
<span class='ivar'>@i18n</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="I18n.html" title="Bovem::I18n (class)">I18n</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>root:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bovem.shell</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Application.html" title="Bovem::Application (class)">Application</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Application.html#LOCALE_ROOT-constant" title="Bovem::Application::LOCALE_ROOT (constant)">LOCALE_ROOT</a></span></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">
#<strong>console</strong> ⇒ <tt><span class='object_link'><a href="Console.html" title="Bovem::Console (class)">Console</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns 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">
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 502</span>
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="Bovem::Shell (class)">Shell</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/General.html" title="Bovem::ShellMethods::General (module)">General</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/Read.html" title="Bovem::ShellMethods::Read (module)">Read</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/Write.html" title="Bovem::ShellMethods::Write (module)">Write</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/Execute.html" title="Bovem::ShellMethods::Execute (module)">Execute</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/Directories.html" title="Bovem::ShellMethods::Directories (module)">Directories</a></span></span>
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:console</span>
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:i18n</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='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Bovem::Shell (class)">Shell</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Bovem::Shell#initialize (method)">new</a></span></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='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Console.html" title="Bovem::Console (class)">Console</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'><span class='object_link'><a href="Console.html#instance-class_method" title="Bovem::Console.instance (method)">instance</a></span></span>
<span class='ivar'>@i18n</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="I18n.html" title="Bovem::I18n (class)">I18n</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>root:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bovem.shell</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Application.html" title="Bovem::Application (class)">Application</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Application.html#LOCALE_ROOT-constant" title="Bovem::Application::LOCALE_ROOT (constant)">LOCALE_ROOT</a></span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="i18n-instance_method">
#<strong>i18n</strong> ⇒ <tt><span class='object_link'><a href="I18n.html" title="Bovem::I18n (class)">I18n</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A i18n helper.</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="I18n.html" title="Bovem::I18n (class)">I18n</a></span></tt>)</span>
—
<div class='inline'><p>A i18n helper.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 502</span>
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="Bovem::Shell (class)">Shell</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/General.html" title="Bovem::ShellMethods::General (module)">General</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/Read.html" title="Bovem::ShellMethods::Read (module)">Read</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/Write.html" title="Bovem::ShellMethods::Write (module)">Write</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/Execute.html" title="Bovem::ShellMethods::Execute (module)">Execute</a></span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ShellMethods/Directories.html" title="Bovem::ShellMethods::Directories (module)">Directories</a></span></span>
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:console</span>
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:i18n</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='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Bovem::Shell (class)">Shell</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Bovem::Shell#initialize (method)">new</a></span></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='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Console.html" title="Bovem::Console (class)">Console</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'><span class='object_link'><a href="Console.html#instance-class_method" title="Bovem::Console.instance (method)">instance</a></span></span>
<span class='ivar'>@i18n</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="I18n.html" title="Bovem::I18n (class)">I18n</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>root:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bovem.shell</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Application.html" title="Bovem::Application (class)">Application</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Application.html#LOCALE_ROOT-constant" title="Bovem::Application::LOCALE_ROOT (constant)">LOCALE_ROOT</a></span></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">
.<strong>instance</strong> ⇒ <tt><span class='object_link'><a href="" title="Bovem::Shell (class)">Shell</a></span></tt>
</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">
515
516
517</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 515</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='const'><span class='object_link'><a href="../Bovem.html" title="Bovem (module)">Bovem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Bovem::Shell (class)">Shell</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Bovem::Shell#initialize (method)">new</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jan 12 16:10:58 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.7 (ruby-2.3.0).
</div>
</div>
</body>
</html>