<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Bovem::ShellMethods::General
— Documentation by YARD 0.8.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">
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 (G)</a> »
<span class='title'><span class='object_link'><a href="../../Bovem.html" title="Bovem (module)">Bovem</a></span></span> » <span class='title'><span class='object_link'><a href="../ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span></span>
»
<span class="title">General</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Bovem::ShellMethods::General
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="../Shell.html" title="Bovem::Shell (class)">Bovem::Shell</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/bovem/shell.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>General methods.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#handle_failure-instance_method" title="#handle_failure (instance method)">- (Object) <strong>handle_failure</strong>(e, access_error, not_found_error, general_error, entries, fatal, show_errors) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Handles general failure of a file/directory method.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#setup_error_handling-instance_method" title="#setup_error_handling (instance method)">- (Array) <strong>setup_error_handling</strong>(entries, fatal) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Setups error handling.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#show_general_failure-instance_method" title="#show_general_failure (instance method)">- (Object) <strong>show_general_failure</strong>(e, general_error, entries, fatal) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Shows errors when a directory creation failed.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="handle_failure-instance_method">
- (<tt>Object</tt>) <strong>handle_failure</strong>(e, access_error, not_found_error, general_error, entries, fatal, show_errors)
</h3><div class="docstring">
<div class="discussion">
<p>Handles general failure of a file/directory method.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>e</span>
<span class='type'>(<tt>Exception</tt>)</span>
—
<div class='inline'><p>The occurred exception.</p>
</div>
</li>
<li>
<span class='name'>access_error</span>
<span class='type'>(<tt>String|Symbol</tt>)</span>
—
<div class='inline'><p>The message to show in case of access errors.</p>
</div>
</li>
<li>
<span class='name'>not_found_error</span>
<span class='type'>(<tt>String|Symbol</tt>)</span>
—
<div class='inline'><p>The message to show in case of a not found entry.</p>
</div>
</li>
<li>
<span class='name'>general_error</span>
<span class='type'>(<tt>String|Symbol</tt>)</span>
—
<div class='inline'><p>The message to show in case of other errors.</p>
</div>
</li>
<li>
<span class='name'>entries</span>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>The list of entries which failed.</p>
</div>
</li>
<li>
<span class='name'>fatal</span>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>If quit in case of fatal errors.</p>
</div>
</li>
<li>
<span class='name'>show_errors</span>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>Whether to show errors.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23
24
25
26
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_handle_failure'>handle_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='id identifier rubyid_access_error'>access_error</span><span class='comma'>,</span> <span class='id identifier rubyid_not_found_error'>not_found_error</span><span class='comma'>,</span> <span class='id identifier rubyid_general_error'>general_error</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='comma'>,</span> <span class='id identifier rubyid_show_errors'>show_errors</span><span class='rparen'>)</span>
<span class='id identifier rubyid_error_type'>error_type</span><span class='comma'>,</span> <span class='id identifier rubyid_locale'>locale</span><span class='comma'>,</span> <span class='id identifier rubyid_final_entries'>final_entries</span> <span class='op'>=</span> <span class='id identifier rubyid_setup_error_handling'>setup_error_handling</span><span class='lparen'>(</span><span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Errno::EACCES</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_error_type'>error_type</span><span class='comma'>,</span> <span class='id identifier rubyid_locale'>locale</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_access_error'>access_error</span><span class='comma'>,</span> <span class='id identifier rubyid_final_entries'>final_entries</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Errno::ENOENT</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_error_type'>error_type</span><span class='comma'>,</span> <span class='id identifier rubyid_locale'>locale</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_not_found_error'>not_found_error</span><span class='comma'>,</span> <span class='id identifier rubyid_final_entries'>final_entries</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>else</span> <span class='id identifier rubyid_show_general_failure'>show_general_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='id identifier rubyid_general_error'>general_error</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_show_errors'>show_errors</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="setup_error_handling-instance_method">
- (<tt>Array</tt>) <strong>setup_error_handling</strong>(entries, fatal)
</h3><div class="docstring">
<div class="discussion">
<p>Setups error handling.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>entries</span>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>The list of entries which failed.</p>
</div>
</li>
<li>
<span class='name'>fatal</span>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>If quit in case of fatal errors.</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>Variables for error handling</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_setup_error_handling'>setup_error_handling</span><span class='lparen'>(</span><span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='rparen'>)</span>
<span class='lbracket'>[</span><span class='id identifier rubyid_fatal'>fatal</span> <span class='op'>?</span> <span class='symbol'>:fatal</span> <span class='op'>:</span> <span class='symbol'>:error</span><span class='comma'>,</span> <span class='id identifier rubyid_i18n'>i18n</span><span class='period'>.</span><span class='id identifier rubyid_shell'>shell</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</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_entries'>entries</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='id identifier rubyid_entries'>entries</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="show_general_failure-instance_method">
- (<tt>Object</tt>) <strong>show_general_failure</strong>(e, general_error, entries, fatal)
</h3><div class="docstring">
<div class="discussion">
<p>Shows errors when a directory creation failed.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>e</span>
<span class='type'>(<tt>Exception</tt>)</span>
—
<div class='inline'><p>The occurred exception.</p>
</div>
</li>
<li>
<span class='name'>entries</span>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>The list of entries which failed.</p>
</div>
</li>
<li>
<span class='name'>fatal</span>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>If quit in case of fatal errors.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47
48
49
50
51
52
53
54</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_show_general_failure'>show_general_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='id identifier rubyid_general_error'>general_error</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='rparen'>)</span>
<span class='id identifier rubyid_locale'>locale</span> <span class='op'>=</span> <span class='id identifier rubyid_i18n'>i18n</span><span class='period'>.</span><span class='id identifier rubyid_shell'>shell</span>
<span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_locale'>locale</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_general_error'>general_error</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_with_indentation'>with_indentation</span><span class='lparen'>(</span><span class='int'>11</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span> <span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='rparen'>)</span> <span class='kw'>end</span>
<span class='kw'>end</span>
<span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_locale'>locale</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_e'>e</span><span class='rparen'>)</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='int'>5</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='op'>-</span><span class='int'>1</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_fatal'>fatal</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Jan 25 15:49:19 2014 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7 (ruby-2.1.0).
</div>
</body>
</html>