File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/GemInstaller.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::GemInstaller - 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-failure_message">#failure_message</a>
<li ><a href="#method-i-gem_install_message">#gem_install_message</a>
<li ><a href="#method-i-generate_executable_stubs">#generate_executable_stubs</a>
<li ><a href="#method-i-install">#install</a>
<li ><a href="#method-i-install_error_message">#install_error_message</a>
<li ><a href="#method-i-install_from_spec">#install_from_spec</a>
<li ><a href="#method-i-install_with_settings">#install_with_settings</a>
<li ><a href="#method-i-out_of_space_message">#out_of_space_message</a>
<li ><a href="#method-i-spec_settings">#spec_settings</a>
<li ><a href="#method-i-specific_failure_message">#specific_failure_message</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::GemInstaller">
<h1 id="class-Bundler::GemInstaller" class="class">
class Bundler::GemInstaller
</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-i-force" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">force</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-installer" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">installer</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-spec" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">spec</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-standalone" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">standalone</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-worker" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">worker</span><span
class="attribute-access-type">[R]</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">(spec, installer, standalone = false, worker = 0, force = false)</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/bundler/installer/gem_installer.rb, line 9</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">installer</span>, <span class="ruby-identifier">standalone</span> = <span class="ruby-keyword">false</span>, <span class="ruby-identifier">worker</span> = <span class="ruby-value">0</span>, <span class="ruby-identifier">force</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-ivar">@spec</span> = <span class="ruby-identifier">spec</span>
<span class="ruby-ivar">@installer</span> = <span class="ruby-identifier">installer</span>
<span class="ruby-ivar">@standalone</span> = <span class="ruby-identifier">standalone</span>
<span class="ruby-ivar">@worker</span> = <span class="ruby-identifier">worker</span>
<span class="ruby-ivar">@force</span> = <span class="ruby-identifier">force</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-install_from_spec" class="method-detail ">
<div class="method-heading">
<span class="method-name">install_from_spec</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="install_from_spec-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 17</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install_from_spec</span>
<span class="ruby-identifier">post_install_message</span> = <span class="ruby-identifier">spec_settings</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">install_with_settings</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">install</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"#{worker}: #{spec.name} (#{spec.version}) from #{spec.loaded_from}"</span>
<span class="ruby-identifier">generate_executable_stubs</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span>, <span class="ruby-identifier">post_install_message</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">InstallHookError</span>, <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">SecurityError</span>, <span class="ruby-constant">APIResponseMismatchError</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOSPC</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>, <span class="ruby-identifier">out_of_space_message</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">StandardError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>, <span class="ruby-identifier">specific_failure_message</span>(<span class="ruby-identifier">e</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-failure_message" class="method-detail ">
<div class="method-heading">
<span class="method-name">failure_message</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="failure_message-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 39</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">failure_message</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">install_error_message</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">source</span>.<span class="ruby-identifier">options</span>[<span class="ruby-string">"git"</span>]
<span class="ruby-node">"#{install_error_message}\n#{gem_install_message}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_install_message" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_install_message</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="gem_install_message-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_install_message</span>
<span class="ruby-identifier">source</span> = <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">source</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:remotes</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">remotes</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
<span class="ruby-node">"Make sure that `gem install #{spec.name} -v '#{spec.version}' --source '#{source.remotes.first}'` succeeds before bundling."</span>
<span class="ruby-keyword">else</span>
<span class="ruby-node">"Make sure that `gem install #{spec.name} -v '#{spec.version}'` succeeds before bundling."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-generate_executable_stubs" class="method-detail ">
<div class="method-heading">
<span class="method-name">generate_executable_stubs</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="generate_executable_stubs-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">generate_executable_stubs</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">feature_flag</span>.<span class="ruby-identifier">forget_cli_options?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">settings</span>[<span class="ruby-value">:inline</span>]
<span class="ruby-keyword">if</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">settings</span>[<span class="ruby-value">:bin</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">standalone</span>
<span class="ruby-identifier">installer</span>.<span class="ruby-identifier">generate_standalone_bundler_executable_stubs</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">settings</span>[<span class="ruby-value">:bin</span>]
<span class="ruby-identifier">installer</span>.<span class="ruby-identifier">generate_bundler_executable_stubs</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-value">:force</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-install" class="method-detail ">
<div class="method-heading">
<span class="method-name">install</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="install-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install</span>
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">source</span>.<span class="ruby-identifier">install</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-value">:force</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">force</span>, <span class="ruby-value">:ensure_builtin_gems_cached</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">standalone</span>, <span class="ruby-value">:build_args</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Array</span>(<span class="ruby-identifier">spec_settings</span>))
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-install_error_message" class="method-detail ">
<div class="method-heading">
<span class="method-name">install_error_message</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="install_error_message-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install_error_message</span>
<span class="ruby-node">"An error occurred while installing #{spec.name} (#{spec.version}), and Bundler cannot continue."</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-install_with_settings" class="method-detail ">
<div class="method-heading">
<span class="method-name">install_with_settings</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="install_with_settings-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install_with_settings</span>
<span class="ruby-comment"># Build arguments are global, so this is mutexed</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">rubygems</span>.<span class="ruby-identifier">install_with_build_args</span>([<span class="ruby-identifier">spec_settings</span>]) { <span class="ruby-identifier">install</span> }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-out_of_space_message" class="method-detail ">
<div class="method-heading">
<span class="method-name">out_of_space_message</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="out_of_space_message-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">out_of_space_message</span>
<span class="ruby-node">"#{install_error_message}\nYour disk is out of space. Free some space to be able to install your bundle."</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-spec_settings" class="method-detail ">
<div class="method-heading">
<span class="method-name">spec_settings</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="spec_settings-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 59</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spec_settings</span>
<span class="ruby-comment"># Fetch the build settings, if there are any</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">settings</span> = <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">settings</span>[<span class="ruby-node">"build.#{spec.name}"</span>]
<span class="ruby-constant">Shellwords</span>.<span class="ruby-identifier">shellsplit</span>(<span class="ruby-identifier">settings</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-specific_failure_message" class="method-detail ">
<div class="method-heading">
<span class="method-name">specific_failure_message</span><span
class="method-args">(e)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="specific_failure_message-source">
<pre><span class="ruby-comment"># File lib/bundler/installer/gem_installer.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">specific_failure_message</span>(<span class="ruby-identifier">e</span>)
<span class="ruby-identifier">message</span> = <span class="ruby-node">"#{e.class}: #{e.message}\n"</span>
<span class="ruby-identifier">message</span> <span class="ruby-operator">+=</span> <span class="ruby-string">" "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n "</span>) <span class="ruby-operator">+</span> <span class="ruby-string">"\n\n"</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">debug?</span>
<span class="ruby-identifier">message</span> = <span class="ruby-identifier">message</span>.<span class="ruby-identifier">lines</span>.<span class="ruby-identifier">first</span> <span class="ruby-operator">+</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">add_color</span>(<span class="ruby-identifier">message</span>.<span class="ruby-identifier">lines</span>.<span class="ruby-identifier">drop</span>(<span class="ruby-value">1</span>).<span class="ruby-identifier">join</span>, <span class="ruby-value">:clear</span>)
<span class="ruby-identifier">message</span> <span class="ruby-operator">+</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">add_color</span>(<span class="ruby-identifier">failure_message</span>, <span class="ruby-value">:red</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>