File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Thor/Base.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Bundler::Thor::Base - 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">
<div id="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="Base/ClassMethods.html">Bundler::Thor::Base::ClassMethods</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-shell">::shell</a>
<li ><a href="#method-c-subclass_files">::subclass_files</a>
<li ><a href="#method-c-subclasses">::subclasses</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Bundler::Thor::Base">
<h1 id="module-Bundler::Thor::Base" class="module">
module Bundler::Thor::Base
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-c-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>
<div id="attribute-i-args" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">args</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-options" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">options</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-parent_options" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">parent_options</span><span
class="attribute-access-type">[RW]</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 = [], local_options = {}, config = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>It receives arguments in an <a href="../../Array.html"><code>Array</code></a> and two hashes, one for options and other for configuration.</p>
<p>Notice that it does not check if all required arguments were supplied. It should be done by the parser.</p>
<h4 id="method-c-new-label-Parameters">Parameters<span><a href="#method-c-new-label-Parameters">¶</a> <a href="#top">↑</a></span></h4>
<dl class="rdoc-list note-list"><dt><a href="Object">args<Array</a>>
<dd>
<p>An array of objects. The objects are applied to their respective accessors declared with <code>argument</code>.</p>
</dd><dt>options<Hash>
<dd>
<p>An options hash that will be available as self.options. The hash given is converted to a hash with indifferent access, magic predicates (options.skip?) and then frozen.</p>
</dd><dt>config<Hash>
<dd>
<p>Configuration for this Bundler::Thor class.</p>
</dd></dl>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/base.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">local_options</span> = {}, <span class="ruby-identifier">config</span> = {})
<span class="ruby-identifier">parse_options</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">class_options</span>
<span class="ruby-comment"># The start method splits inbound arguments at the first argument</span>
<span class="ruby-comment"># that looks like an option (starts with - or --). It then calls</span>
<span class="ruby-comment"># new, passing in the two halves of the arguments Array as the</span>
<span class="ruby-comment"># first two parameters.</span>
<span class="ruby-identifier">command_options</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:command_options</span>) <span class="ruby-comment"># hook for start</span>
<span class="ruby-identifier">parse_options</span> = <span class="ruby-identifier">parse_options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">command_options</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">command_options</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">local_options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
<span class="ruby-identifier">array_options</span> = <span class="ruby-identifier">local_options</span>
<span class="ruby-identifier">hash_options</span> = {}
<span class="ruby-keyword">else</span>
<span class="ruby-comment"># Handle the case where the class was explicitly instantiated</span>
<span class="ruby-comment"># with pre-parsed options.</span>
<span class="ruby-identifier">array_options</span> = []
<span class="ruby-identifier">hash_options</span> = <span class="ruby-identifier">local_options</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># Let Bundler::Thor::Options parse the options first, so it can remove</span>
<span class="ruby-comment"># declared options from the array. This will leave us with</span>
<span class="ruby-comment"># a list of arguments that weren't declared.</span>
<span class="ruby-identifier">stop_on_unknown</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">stop_on_unknown_option?</span> <span class="ruby-identifier">config</span>[<span class="ruby-value">:current_command</span>]
<span class="ruby-identifier">disable_required_check</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">disable_required_check?</span> <span class="ruby-identifier">config</span>[<span class="ruby-value">:current_command</span>]
<span class="ruby-identifier">opts</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">Options</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">parse_options</span>, <span class="ruby-identifier">hash_options</span>, <span class="ruby-identifier">stop_on_unknown</span>, <span class="ruby-identifier">disable_required_check</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">options</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">array_options</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">options</span> = <span class="ruby-identifier">config</span>[<span class="ruby-value">:class_options</span>].<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>[<span class="ruby-value">:class_options</span>]
<span class="ruby-comment"># If unknown options are disallowed, make sure that none of the</span>
<span class="ruby-comment"># remaining arguments looks like an option.</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">check_unknown!</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">check_unknown_options?</span>(<span class="ruby-identifier">config</span>)
<span class="ruby-comment"># Add the remaining arguments from the options parser to the</span>
<span class="ruby-comment"># arguments passed in to initialize. Then remove any positional</span>
<span class="ruby-comment"># arguments declared using #argument (this is primarily used</span>
<span class="ruby-comment"># by Bundler::Thor::Group). Tis will leave us with the remaining</span>
<span class="ruby-comment"># positional arguments.</span>
<span class="ruby-identifier">to_parse</span> = <span class="ruby-identifier">args</span>
<span class="ruby-identifier">to_parse</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">remaining</span> <span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">strict_args_position?</span>(<span class="ruby-identifier">config</span>)
<span class="ruby-identifier">thor_args</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">Arguments</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">arguments</span>)
<span class="ruby-identifier">thor_args</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">to_parse</span>).<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">__send__</span>(<span class="ruby-node">"#{k}="</span>, <span class="ruby-identifier">v</span>) }
<span class="ruby-ivar">@args</span> = <span class="ruby-identifier">thor_args</span>.<span class="ruby-identifier">remaining</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-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>Returns the shell used in all Bundler::Thor classes. If you are in a Unix platform it will use a colored log, otherwise it will use a basic one without color.</p>
<div class="method-source-code" id="shell-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/shell.rb, line 11</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-keyword">if</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">"THOR_SHELL"</span>] <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-constant">ENV</span>[<span class="ruby-string">"THOR_SHELL"</span>].<span class="ruby-identifier">empty?</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-identifier">const_get</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">"THOR_SHELL"</span>])
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-string">"host_os"</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">/mswin|mingw/</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-constant">ENV</span>[<span class="ruby-string">"ANSICON"</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-keyword">else</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">Color</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-subclass_files" class="method-detail ">
<div class="method-heading">
<span class="method-name">subclass_files</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the files where the subclasses are kept.</p>
<h4 id="method-c-subclass_files-label-Returns">Returns<span><a href="#method-c-subclass_files-label-Returns">¶</a> <a href="#top">↑</a></span></h4>
<p>Hash[path<String> => Class]</p>
<div class="method-source-code" id="subclass_files-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/base.rb, line 112</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subclass_files</span>
<span class="ruby-ivar">@subclass_files</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">h</span>, <span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>] = [] }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-subclasses" class="method-detail ">
<div class="method-heading">
<span class="method-name">subclasses</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the classes that inherits from Bundler::Thor or <a href="Group.html"><code>Bundler::Thor::Group</code></a>.</p>
<h4 id="method-c-subclasses-label-Returns">Returns<span><a href="#method-c-subclasses-label-Returns">¶</a> <a href="#top">↑</a></span></h4>
<p><a href="Class">Array</a></p>
<div class="method-source-code" id="subclasses-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/base.rb, line 103</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subclasses</span>
<span class="ruby-ivar">@subclasses</span> <span class="ruby-operator">||=</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>