File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Thor/Command.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Thor::Task - 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="class">
<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">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Struct.new(:name, :description, :long_description, :usage, :options, :ancestor_name)
</div>
<!-- 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-formatted_usage">#formatted_usage</a>
<li ><a href="#method-i-handle_argument_error-3F">#handle_argument_error?</a>
<li ><a href="#method-i-handle_no_method_error-3F">#handle_no_method_error?</a>
<li ><a href="#method-i-hidden-3F">#hidden?</a>
<li ><a href="#method-i-local_method-3F">#local_method?</a>
<li ><a href="#method-i-not_debugging-3F">#not_debugging?</a>
<li ><a href="#method-i-private_method-3F">#private_method?</a>
<li ><a href="#method-i-required_arguments_for">#required_arguments_for</a>
<li ><a href="#method-i-required_options">#required_options</a>
<li ><a href="#method-i-run">#run</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Thor::Task">
<h1 id="class-Bundler::Thor::Task" class="class">
class Bundler::Thor::Task
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="FILE_REGEXP">FILE_REGEXP
<dd>
</dl>
</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">(name, description, long_description, usage, options = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<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/command.rb, line 5</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">long_description</span>, <span class="ruby-identifier">usage</span>, <span class="ruby-identifier">options</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">long_description</span>, <span class="ruby-identifier">usage</span>, <span class="ruby-identifier">options</span> <span class="ruby-operator">||</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-formatted_usage" class="method-detail ">
<div class="method-heading">
<span class="method-name">formatted_usage</span><span
class="method-args">(klass, namespace = true, subcommand = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the formatted usage by injecting given required arguments and required options into the given usage.</p>
<div class="method-source-code" id="formatted_usage-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 41</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">formatted_usage</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">namespace</span> = <span class="ruby-keyword">true</span>, <span class="ruby-identifier">subcommand</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ancestor_name</span>
<span class="ruby-identifier">formatted</span> = <span class="ruby-node">"#{ancestor_name} "</span>.<span class="ruby-identifier">dup</span> <span class="ruby-comment"># add space</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">namespace</span>
<span class="ruby-identifier">namespace</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">namespace</span>
<span class="ruby-identifier">formatted</span> = <span class="ruby-node">"#{namespace.gsub(/^(default)/, '')}:"</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">formatted</span> <span class="ruby-operator">||=</span> <span class="ruby-node">"#{klass.namespace.split(':').last} "</span>.<span class="ruby-identifier">dup</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">subcommand</span>
<span class="ruby-identifier">formatted</span> <span class="ruby-operator">||=</span> <span class="ruby-string">""</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-constant">Array</span>(<span class="ruby-identifier">usage</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">specific_usage</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">formatted_specific_usage</span> = <span class="ruby-identifier">formatted</span>
<span class="ruby-identifier">formatted_specific_usage</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">required_arguments_for</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">specific_usage</span>)
<span class="ruby-comment"># Add required options</span>
<span class="ruby-identifier">formatted_specific_usage</span> <span class="ruby-operator">+=</span> <span class="ruby-node">" #{required_options}"</span>
<span class="ruby-comment"># Strip and go!</span>
<span class="ruby-identifier">formatted_specific_usage</span>.<span class="ruby-identifier">strip</span>
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-hidden-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">hidden?</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="hidden-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 14</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">hidden?</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-run" class="method-detail ">
<div class="method-heading">
<span class="method-name">run</span><span
class="method-args">(instance, args = [])</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>By default, a command invokes a method in the thor class. You can change this implementation to create custom commands.</p>
<div class="method-source-code" id="run-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 20</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">run</span>(<span class="ruby-identifier">instance</span>, <span class="ruby-identifier">args</span> = [])
<span class="ruby-identifier">arity</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">private_method?</span>(<span class="ruby-identifier">instance</span>)
<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">handle_no_command_error</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">public_method?</span>(<span class="ruby-identifier">instance</span>)
<span class="ruby-identifier">arity</span> = <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">method</span>(<span class="ruby-identifier">name</span>).<span class="ruby-identifier">arity</span>
<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">__send__</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">local_method?</span>(<span class="ruby-identifier">instance</span>, <span class="ruby-value">:method_missing</span>)
<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">__send__</span>(<span class="ruby-value">:method_missing</span>, <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">handle_no_command_error</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">ArgumentError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">handle_argument_error?</span>(<span class="ruby-identifier">instance</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">caller</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">handle_argument_error</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">arity</span>) <span class="ruby-operator">:</span> (<span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NoMethodError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">handle_no_method_error?</span>(<span class="ruby-identifier">instance</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">caller</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">handle_no_command_error</span>(<span class="ruby-identifier">name</span>) <span class="ruby-operator">:</span> (<span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-handle_argument_error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">handle_argument_error?</span><span
class="method-args">(instance, error, caller)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="handle_argument_error-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 105</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">handle_argument_error?</span>(<span class="ruby-identifier">instance</span>, <span class="ruby-identifier">error</span>, <span class="ruby-identifier">caller</span>)
<span class="ruby-identifier">not_debugging?</span>(<span class="ruby-identifier">instance</span>) <span class="ruby-operator">&&</span> (<span class="ruby-identifier">error</span>.<span class="ruby-identifier">message</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/wrong number of arguments/</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">error</span>.<span class="ruby-identifier">message</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/given \d*, expected \d*/</span>) <span class="ruby-operator">&&</span> <span class="ruby-keyword">begin</span>
<span class="ruby-identifier">saned</span> = <span class="ruby-identifier">sans_backtrace</span>(<span class="ruby-identifier">error</span>.<span class="ruby-identifier">backtrace</span>, <span class="ruby-identifier">caller</span>)
<span class="ruby-identifier">saned</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">saned</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-handle_no_method_error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">handle_no_method_error?</span><span
class="method-args">(instance, error, caller)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="handle_no_method_error-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 112</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">handle_no_method_error?</span>(<span class="ruby-identifier">instance</span>, <span class="ruby-identifier">error</span>, <span class="ruby-identifier">caller</span>)
<span class="ruby-identifier">not_debugging?</span>(<span class="ruby-identifier">instance</span>) <span class="ruby-operator">&&</span>
<span class="ruby-identifier">error</span>.<span class="ruby-identifier">message</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^undefined method `#{name}' for #{Regexp.escape(instance.to_s)}$/</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-local_method-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">local_method?</span><span
class="method-args">(instance, name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="local_method-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 95</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">local_method?</span>(<span class="ruby-identifier">instance</span>, <span class="ruby-identifier">name</span>)
<span class="ruby-identifier">methods</span> = <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">public_methods</span>(<span class="ruby-keyword">false</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">private_methods</span>(<span class="ruby-keyword">false</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">protected_methods</span>(<span class="ruby-keyword">false</span>)
<span class="ruby-operator">!</span>(<span class="ruby-identifier">methods</span> <span class="ruby-operator">&</span> [<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>]).<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-not_debugging-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">not_debugging?</span><span
class="method-args">(instance)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="not_debugging-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">not_debugging?</span>(<span class="ruby-identifier">instance</span>)
<span class="ruby-operator">!</span>(<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:debugging</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">debugging</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-private_method-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">private_method?</span><span
class="method-args">(instance)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="private_method-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">private_method?</span>(<span class="ruby-identifier">instance</span>)
<span class="ruby-operator">!</span>(<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">private_methods</span> <span class="ruby-operator">&</span> [<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>]).<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-required_arguments_for" class="method-detail ">
<div class="method-heading">
<span class="method-name">required_arguments_for</span><span
class="method-args">(klass, usage)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add usage with required arguments</p>
<div class="method-source-code" id="required_arguments_for-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">required_arguments_for</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">usage</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">klass</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">klass</span>.<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">usage</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^#{name}/</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">match</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:usage</span>).<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">usage</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-required_options" class="method-detail ">
<div class="method-heading">
<span class="method-name">required_options</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="required_options-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/command.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">required_options</span>
<span class="ruby-ivar">@required_options</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">_</span>, <span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">usage</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">required?</span> }.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</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>