instiki/vendor/plugins/bundler/doc/bundler-1.0.15/rdoc/Bundler/UI/Shell.html

663 lines
20 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<title>Class: Bundler::UI::Shell</title>
<link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
<script src="../../js/jquery.js" type="text/javascript"
charset="utf-8"></script>
<script src="../../js/thickbox-compressed.js" type="text/javascript"
charset="utf-8"></script>
<script src="../../js/quicksearch.js" type="text/javascript"
charset="utf-8"></script>
<script src="../../js/darkfish.js" type="text/javascript"
charset="utf-8"></script>
</head>
<body class="class">
<div id="metadata">
<div id="home-metadata">
<div id="home-section" class="section">
<h3 class="section-header">
<a href="../../index.html">Home</a>
<a href="../../index.html#classes">Classes</a>
<a href="../../index.html#methods">Methods</a>
</h3>
</div>
</div>
<div id="file-metadata">
<div id="file-list-section" class="section">
<h3 class="section-header">In Files</h3>
<div class="section-body">
<ul>
<li><a href="../../lib/bundler/ui_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
class="thickbox" title="lib/bundler/ui.rb">lib/bundler/ui.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Parent Class -->
<div id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link"><a href="../UI.html">Bundler::UI</a></p>
</div>
<!-- Namespace Contents -->
<!-- Method Quickref -->
<div id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#method-c-new">::new</a></li>
<li><a href="#method-i-be_quiet%21">#be_quiet!</a></li>
<li><a href="#method-i-confirm">#confirm</a></li>
<li><a href="#method-i-debug">#debug</a></li>
<li><a href="#method-i-debug%21">#debug!</a></li>
<li><a href="#method-i-error">#error</a></li>
<li><a href="#method-i-info">#info</a></li>
<li><a href="#method-i-warn">#warn</a></li>
</ul>
</div>
<!-- Included Modules -->
</div>
<div id="project-metadata">
<div id="fileindex-section" class="section project-section">
<h3 class="section-header">Files</h3>
<ul>
<li class="file"><a href="../../lib/bundler/man/bundle.html">bundle</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-benchmark.html">bundle-benchmark</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-benchmark_txt.html">bundle-benchmark.txt</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-config.html">bundle-config</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-config_txt.html">bundle-config.txt</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-exec.html">bundle-exec</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-exec_txt.html">bundle-exec.txt</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-install.html">bundle-install</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-install_txt.html">bundle-install.txt</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-package.html">bundle-package</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-package_txt.html">bundle-package.txt</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-update.html">bundle-update</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle-update_txt.html">bundle-update.txt</a></li>
<li class="file"><a href="../../lib/bundler/man/bundle_txt.html">bundle.txt</a></li>
<li class="file"><a href="../../lib/bundler/man/gemfile_5_txt.html">gemfile.5.txt</a></li>
<li class="file"><a href="../../lib/bundler/templates/Gemfile.html">Gemfile</a></li>
</ul>
</div>
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class Index
<span class="search-toggle"><img src="../../images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="../../Bundler.html">Bundler</a></li>
<li><a href="../../Bundler/BundlerError.html">Bundler::BundlerError</a></li>
<li><a href="../../Bundler/CLI.html">Bundler::CLI</a></li>
<li><a href="../../Bundler/Definition.html">Bundler::Definition</a></li>
<li><a href="../../Bundler/DepProxy.html">Bundler::DepProxy</a></li>
<li><a href="../../Bundler/Dependency.html">Bundler::Dependency</a></li>
<li><a href="../../Bundler/Deployment.html">Bundler::Deployment</a></li>
<li><a href="../../Bundler/DeprecatedError.html">Bundler::DeprecatedError</a></li>
<li><a href="../../Bundler/Dsl.html">Bundler::Dsl</a></li>
<li><a href="../../Bundler/DslError.html">Bundler::DslError</a></li>
<li><a href="../../Bundler/Environment.html">Bundler::Environment</a></li>
<li><a href="../../Bundler/GemHelper.html">Bundler::GemHelper</a></li>
<li><a href="../../Bundler/GemHelpers.html">Bundler::GemHelpers</a></li>
<li><a href="../../Bundler/GemNotFound.html">Bundler::GemNotFound</a></li>
<li><a href="../../Bundler/GemfileError.html">Bundler::GemfileError</a></li>
<li><a href="../../Bundler/GemfileNotFound.html">Bundler::GemfileNotFound</a></li>
<li><a href="../../Bundler/GemspecError.html">Bundler::GemspecError</a></li>
<li><a href="../../Bundler/GitError.html">Bundler::GitError</a></li>
<li><a href="../../Bundler/Graph.html">Bundler::Graph</a></li>
<li><a href="../../Bundler/GraphNode.html">Bundler::GraphNode</a></li>
<li><a href="../../Bundler/Index.html">Bundler::Index</a></li>
<li><a href="../../Bundler/Installer.html">Bundler::Installer</a></li>
<li><a href="../../Bundler/InvalidOption.html">Bundler::InvalidOption</a></li>
<li><a href="../../Bundler/InvalidSpecSet.html">Bundler::InvalidSpecSet</a></li>
<li><a href="../../Bundler/LazySpecification.html">Bundler::LazySpecification</a></li>
<li><a href="../../Bundler/LockfileParser.html">Bundler::LockfileParser</a></li>
<li><a href="../../Bundler/MatchPlatform.html">Bundler::MatchPlatform</a></li>
<li><a href="../../Bundler/PathError.html">Bundler::PathError</a></li>
<li><a href="../../Bundler/ProductionError.html">Bundler::ProductionError</a></li>
<li><a href="../../Bundler/RemoteSpecification.html">Bundler::RemoteSpecification</a></li>
<li><a href="../../Bundler/Resolver.html">Bundler::Resolver</a></li>
<li><a href="../../Bundler/Resolver/SpecGroup.html">Bundler::Resolver::SpecGroup</a></li>
<li><a href="../../Bundler/RubygemsIntegration.html">Bundler::RubygemsIntegration</a></li>
<li><a href="../../Bundler/RubygemsIntegration/AlmostModern.html">Bundler::RubygemsIntegration::AlmostModern</a></li>
<li><a href="../../Bundler/RubygemsIntegration/Deprecate.html">Bundler::RubygemsIntegration::Deprecate</a></li>
<li><a href="../../Bundler/RubygemsIntegration/Gem.html">Bundler::RubygemsIntegration::Gem</a></li>
<li><a href="../../Bundler/RubygemsIntegration/Gem/SourceIndex.html">Bundler::RubygemsIntegration::Gem::SourceIndex</a></li>
<li><a href="../../Bundler/RubygemsIntegration/Legacy.html">Bundler::RubygemsIntegration::Legacy</a></li>
<li><a href="../../Bundler/RubygemsIntegration/Modern.html">Bundler::RubygemsIntegration::Modern</a></li>
<li><a href="../../Bundler/RubygemsIntegration/Transitional.html">Bundler::RubygemsIntegration::Transitional</a></li>
<li><a href="../../Bundler/Runtime.html">Bundler::Runtime</a></li>
<li><a href="../../Bundler/Settings.html">Bundler::Settings</a></li>
<li><a href="../../Bundler/SharedHelpers.html">Bundler::SharedHelpers</a></li>
<li><a href="../../Bundler/Source.html">Bundler::Source</a></li>
<li><a href="../../Bundler/Source/Git.html">Bundler::Source::Git</a></li>
<li><a href="../../Bundler/Source/Path.html">Bundler::Source::Path</a></li>
<li><a href="../../Bundler/Source/Path/Installer.html">Bundler::Source::Path::Installer</a></li>
<li><a href="../../Bundler/Source/Rubygems.html">Bundler::Source::Rubygems</a></li>
<li><a href="../../Bundler/SpecSet.html">Bundler::SpecSet</a></li>
<li><a href="../../Bundler/UI.html">Bundler::UI</a></li>
<li><a href="../../Bundler/UI/RGProxy.html">Bundler::UI::RGProxy</a></li>
<li><a href="../../Bundler/UI/Shell.html">Bundler::UI::Shell</a></li>
<li><a href="../../Bundler/VersionConflict.html">Bundler::VersionConflict</a></li>
<li><a href="../../Thor.html">Thor</a></li>
<li><a href="../../Thor/Actions.html">Thor::Actions</a></li>
<li><a href="../../Thor/Actions/ClassMethods.html">Thor::Actions::ClassMethods</a></li>
<li><a href="../../Thor/Base.html">Thor::Base</a></li>
<li><a href="../../Thor/Base/ClassMethods.html">Thor::Base::ClassMethods</a></li>
<li><a href="../../Thor/DynamicTask.html">Thor::DynamicTask</a></li>
<li><a href="../../Thor/Error.html">Thor::Error</a></li>
<li><a href="../../Thor/HiddenTask.html">Thor::HiddenTask</a></li>
<li><a href="../../Thor/Invocation.html">Thor::Invocation</a></li>
<li><a href="../../Thor/Invocation/ClassMethods.html">Thor::Invocation::ClassMethods</a></li>
<li><a href="../../Thor/InvocationError.html">Thor::InvocationError</a></li>
<li><a href="../../Thor/MalformattedArgumentError.html">Thor::MalformattedArgumentError</a></li>
<li><a href="../../Thor/RequiredArgumentMissingError.html">Thor::RequiredArgumentMissingError</a></li>
<li><a href="../../Thor/Shell.html">Thor::Shell</a></li>
<li><a href="../../Thor/Shell/Basic.html">Thor::Shell::Basic</a></li>
<li><a href="../../Thor/Shell/Color.html">Thor::Shell::Color</a></li>
<li><a href="../../Thor/Shell/HTML.html">Thor::Shell::HTML</a></li>
<li><a href="../../Thor/Task.html">Thor::Task</a></li>
<li><a href="../../Thor/UndefinedTaskError.html">Thor::UndefinedTaskError</a></li>
<li><a href="../../Thor/UnknownArgumentError.html">Thor::UnknownArgumentError</a></li>
<li><a href="../../Thor/Util.html">Thor::Util</a></li>
<li><a href="../../Gem.html">Gem</a></li>
<li><a href="../../Gem/Dependency.html">Gem::Dependency</a></li>
<li><a href="../../Gem/Platform.html">Gem::Platform</a></li>
<li><a href="../../Gem/Requirement.html">Gem::Requirement</a></li>
<li><a href="../../Gem/Specification.html">Gem::Specification</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1 class="class">Bundler::UI::Shell</h1>
<div id="description">
</div>
<!-- Constants -->
<!-- Attributes -->
<div id="attribute-method-details" class="method-section section">
<h3 class="section-header">Attributes</h3>
<div id="shell-attribute-method" class="method-detail">
<a name="shell"></a>
<a name="shell="></a>
<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>
</div>
<!-- Methods -->
<div id="public-class-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="new-method" class="method-detail ">
<a name="method-c-new"></a>
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(shell)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="new-source">
<pre>
<span class="ruby-comment cmt"># File lib/bundler/ui.rb, line 23</span>
23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">shell</span>)
24: <span class="ruby-ivar">@shell</span> = <span class="ruby-identifier">shell</span>
25: <span class="ruby-ivar">@quiet</span> = <span class="ruby-keyword kw">false</span>
26: <span class="ruby-ivar">@debug</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-value str">'DEBUG'</span>]
27: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
<div id="public-instance-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="be-quiet--method" class="method-detail ">
<a name="method-i-be_quiet%21"></a>
<div class="method-heading">
<span class="method-name">be_quiet!</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="be-quiet--source">
<pre>
<span class="ruby-comment cmt"># File lib/bundler/ui.rb, line 49</span>
49: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">be_quiet!</span>
50: <span class="ruby-ivar">@quiet</span> = <span class="ruby-keyword kw">true</span>
51: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="confirm-method" class="method-detail ">
<a name="method-i-confirm"></a>
<div class="method-heading">
<span class="method-name">confirm</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="confirm-source">
<pre>
<span class="ruby-comment cmt"># File lib/bundler/ui.rb, line 37</span>
37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">confirm</span>(<span class="ruby-identifier">msg</span>)
38: <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">say</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-value">:green</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@quiet</span>
39: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="debug-method" class="method-detail ">
<a name="method-i-debug"></a>
<div class="method-heading">
<span class="method-name">debug</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="debug-source">
<pre>
<span class="ruby-comment cmt"># File lib/bundler/ui.rb, line 29</span>
29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug</span>(<span class="ruby-identifier">msg</span>)
30: <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">say</span>(<span class="ruby-identifier">msg</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@debug</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@quiet</span>
31: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="debug--method" class="method-detail ">
<a name="method-i-debug%21"></a>
<div class="method-heading">
<span class="method-name">debug!</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="debug--source">
<pre>
<span class="ruby-comment cmt"># File lib/bundler/ui.rb, line 53</span>
53: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug!</span>
54: <span class="ruby-ivar">@debug</span> = <span class="ruby-keyword kw">true</span>
55: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="error-method" class="method-detail ">
<a name="method-i-error"></a>
<div class="method-heading">
<span class="method-name">error</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="error-source">
<pre>
<span class="ruby-comment cmt"># File lib/bundler/ui.rb, line 45</span>
45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">msg</span>)
46: <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">say</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-value">:red</span>)
47: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="info-method" class="method-detail ">
<a name="method-i-info"></a>
<div class="method-heading">
<span class="method-name">info</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="info-source">
<pre>
<span class="ruby-comment cmt"># File lib/bundler/ui.rb, line 33</span>
33: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">info</span>(<span class="ruby-identifier">msg</span>)
34: <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">say</span>(<span class="ruby-identifier">msg</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@quiet</span>
35: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="warn-method" class="method-detail ">
<a name="method-i-warn"></a>
<div class="method-heading">
<span class="method-name">warn</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="warn-source">
<pre>
<span class="ruby-comment cmt"># File lib/bundler/ui.rb, line 41</span>
41: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">warn</span>(<span class="ruby-identifier">msg</span>)
42: <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">say</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-value">:yellow</span>)
43: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
</div>
<div id="rdoc-debugging-section-dump" class="debugging-section">
<p>Disabled; run with --debug to generate this.</p>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 1.1.6</small>.</p>
</div>
</body>
</html>