File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Thor/Shell.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Bundler::Thor::Shell - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-shell">#shell</a>
<li ><a href="#method-i-with_padding">#with_padding</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Bundler::Thor::Shell">
<h1 id="module-Bundler::Thor::Shell" class="module">
module Bundler::Thor::Shell
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="SHELL_DELEGATED_METHODS">SHELL_DELEGATED_METHODS
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-shell" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">shell</span><span
class="attribute-access-type">[W]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(args = [], options = {}, config = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add shell to initialize config values.</p>
<h4 id="method-c-new-label-Configuration">Configuration<span><a href="#method-c-new-label-Configuration">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt>shell<Object>
<dd>
<p>An instance of the shell to be used.</p>
</dd></dl>
<h4 id="method-c-new-label-Examples">Examples<span><a href="#method-c-new-label-Examples">¶</a> <a href="#top">↑</a></span></h4>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">MyScript</span> <span class="ruby-operator"><</span> <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">Thor</span>
<span class="ruby-identifier">argument</span> <span class="ruby-value">:first</span>, <span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-value">:numeric</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">MyScript</span>.<span class="ruby-identifier">new</span> [<span class="ruby-value">1.0</span>], { <span class="ruby-value">:foo</span> <span class="ruby-operator">=></span> <span class="ruby-value">:bar</span> }, <span class="ruby-value">:shell</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">Thor</span><span class="ruby-operator">::</span><span class="ruby-constant">Shell</span><span class="ruby-operator">::</span><span class="ruby-constant">Basic</span>.<span class="ruby-identifier">new</span>
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/shell.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">args</span> = [], <span class="ruby-identifier">options</span> = {}, <span class="ruby-identifier">config</span> = {})
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">shell</span> = <span class="ruby-identifier">config</span>[<span class="ruby-value">:shell</span>]
<span class="ruby-identifier">shell</span>.<span class="ruby-identifier">base</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:base</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-shell" class="method-detail ">
<div class="method-heading">
<span class="method-name">shell</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Holds the shell for the given Bundler::Thor instance. If no shell is given, it gets a default shell from <a href="Base.html#method-c-shell"><code>Bundler::Thor::Base.shell</code></a>.</p>
<div class="method-source-code" id="shell-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/shell.rb, line 52</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">shell</span>
<span class="ruby-ivar">@shell</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">Thor</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">shell</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-with_padding" class="method-detail ">
<div class="method-heading">
<span class="method-name">with_padding</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Yields the given block with padding.</p>
<div class="method-source-code" id="with_padding-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/shell.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with_padding</span>
<span class="ruby-identifier">shell</span>.<span class="ruby-identifier">padding</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">yield</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">shell</span>.<span class="ruby-identifier">padding</span> <span class="ruby-operator">-=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>