File: C:/Ruby27-x64/share/doc/ruby/html/Gem/GemRunner.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::GemRunner - 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"><a href="../Object.html">Object</a>
</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-i-do_configuration">#do_configuration</a>
<li ><a href="#method-i-run">#run</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::GemRunner">
<h1 id="class-Gem::GemRunner" class="class">
class Gem::GemRunner
</h1>
<section class="description">
<p>Run an instance of the gem program.</p>
<p><a href="GemRunner.html"><code>Gem::GemRunner</code></a> is only intended for internal use by RubyGems itself. It does not form any public API and may change at any time for any reason.</p>
<p>If you would like to duplicate functionality of `gem` commands, use the classes they call directly.</p>
</section>
<section id="5Buntitled-5D" class="documentation-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">(options={})</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"># File lib/rubygems/gem_runner.rb, line 29</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span>={})
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>.<span class="ruby-identifier">skip</span>
<span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">warn</span> <span class="ruby-string">"NOTE: passing options to Gem::GemRunner.new is deprecated with no replacement. It will be removed on or after 2016-10-01."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@command_manager_class</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:command_manager</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">CommandManager</span>
<span class="ruby-ivar">@config_file_class</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:config_file</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">ConfigFile</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-run" class="method-detail ">
<div class="method-heading">
<span class="method-name">run</span><span
class="method-args">(args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Run the gem command with the following arguments.</p>
<div class="method-source-code" id="run-source">
<pre><span class="ruby-comment"># File lib/rubygems/gem_runner.rb, line 41</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">run</span>(<span class="ruby-identifier">args</span>)
<span class="ruby-identifier">build_args</span> = <span class="ruby-identifier">extract_build_args</span> <span class="ruby-identifier">args</span>
<span class="ruby-identifier">do_configuration</span> <span class="ruby-identifier">args</span>
<span class="ruby-identifier">cmd</span> = <span class="ruby-ivar">@command_manager_class</span>.<span class="ruby-identifier">instance</span>
<span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">command_names</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">command_name</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">config_args</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">command_name</span>]
<span class="ruby-identifier">config_args</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">config_args</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-identifier">config_args</span>.<span class="ruby-identifier">split</span> <span class="ruby-string">' '</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">Array</span>(<span class="ruby-identifier">config_args</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Command</span>.<span class="ruby-identifier">add_specific_extra_args</span> <span class="ruby-identifier">command_name</span>, <span class="ruby-identifier">config_args</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">run</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">args</span>, <span class="ruby-identifier">build_args</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-do_configuration" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_configuration</span><span
class="method-args">(args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="do_configuration-source">
<pre><span class="ruby-comment"># File lib/rubygems/gem_runner.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_configuration</span>(<span class="ruby-identifier">args</span>)
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span> = <span class="ruby-ivar">@config_file_class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>)
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">use_paths</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>[<span class="ruby-value">:gemhome</span>], <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>[<span class="ruby-value">:gempath</span>]
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Command</span>.<span class="ruby-identifier">extra_args</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>[<span class="ruby-value">:gem</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>