File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Resolver/InstallerSet.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Resolver::InstallerSet - 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="Set.html">Gem::Resolver::Set</a>
</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-add_always_install">#add_always_install</a>
<li ><a href="#method-i-add_local">#add_local</a>
<li ><a href="#method-i-errors">#errors</a>
<li ><a href="#method-i-find_all">#find_all</a>
<li ><a href="#method-i-prefetch">#prefetch</a>
<li class="calls-super" ><a href="#method-i-prerelease-3D">#prerelease=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Resolver::InstallerSet">
<h1 id="class-Gem::Resolver::InstallerSet" class="class">
class Gem::Resolver::InstallerSet
</h1>
<section class="description">
<p>A set of gems for installation sourced from remote sources and local .gem files</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">(domain)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="InstallerSet.html"><code>InstallerSet</code></a> that will look for gems in <code>domain</code>.</p>
<div class="method-calls-super">
Calls superclass method
<a href="../../BasicObject.html#method-c-new"><code>BasicObject::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/installer_set.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">domain</span>)
<span class="ruby-keyword">super</span>()
<span class="ruby-ivar">@domain</span> = <span class="ruby-identifier">domain</span>
<span class="ruby-ivar">@remote</span> = <span class="ruby-identifier">consider_remote?</span>
<span class="ruby-ivar">@f</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">SpecFetcher</span>.<span class="ruby-identifier">fetcher</span>
<span class="ruby-ivar">@always_install</span> = []
<span class="ruby-ivar">@ignore_dependencies</span> = <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@ignore_installed</span> = <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@local</span> = {}
<span class="ruby-ivar">@local_source</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">Local</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@remote_set</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Resolver</span><span class="ruby-operator">::</span><span class="ruby-constant">BestSet</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@specs</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-add_always_install" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_always_install</span><span
class="method-args">(dependency)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Looks up the latest specification for <code>dependency</code> and adds it to the always_install list.</p>
<div class="method-source-code" id="add_always_install-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/installer_set.rb, line 53</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_always_install</span>(<span class="ruby-identifier">dependency</span>)
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Resolver</span><span class="ruby-operator">::</span><span class="ruby-constant">DependencyRequest</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">dependency</span>, <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">found</span> = <span class="ruby-identifier">find_all</span> <span class="ruby-identifier">request</span>
<span class="ruby-identifier">found</span>.<span class="ruby-identifier">delete_if</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">version</span>.<span class="ruby-identifier">prerelease?</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">local?</span>
<span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">prerelease?</span>
<span class="ruby-identifier">found</span> = <span class="ruby-identifier">found</span>.<span class="ruby-identifier">select</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">SpecificFile</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">source</span> <span class="ruby-keyword">or</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span><span class="ruby-operator">::</span><span class="ruby-constant">RUBY</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">platform</span> <span class="ruby-keyword">or</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span>.<span class="ruby-identifier">local</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">platform</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">found</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">exc</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">UnsatisfiableDependencyError</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">request</span>
<span class="ruby-identifier">exc</span>.<span class="ruby-identifier">errors</span> = <span class="ruby-identifier">errors</span>
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">exc</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">newest</span> = <span class="ruby-identifier">found</span>.<span class="ruby-identifier">max_by</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
[<span class="ruby-identifier">s</span>.<span class="ruby-identifier">version</span>, <span class="ruby-identifier">s</span>.<span class="ruby-identifier">platform</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span><span class="ruby-operator">::</span><span class="ruby-constant">RUBY</span> <span class="ruby-operator">?</span> <span class="ruby-value">-1</span> <span class="ruby-operator">:</span> <span class="ruby-value">1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@always_install</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">newest</span>.<span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_local" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_local</span><span
class="method-args">(dep_name, spec, source)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds a local gem requested using <code>dep_name</code> with the given <code>spec</code> that can be loaded and installed using the <code>source</code>.</p>
<div class="method-source-code" id="add_local-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/installer_set.rb, line 86</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_local</span>(<span class="ruby-identifier">dep_name</span>, <span class="ruby-identifier">spec</span>, <span class="ruby-identifier">source</span>)
<span class="ruby-ivar">@local</span>[<span class="ruby-identifier">dep_name</span>] = [<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">source</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-errors" class="method-detail ">
<div class="method-heading">
<span class="method-name">errors</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Errors encountered while resolving gems</p>
<div class="method-source-code" id="errors-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/installer_set.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">errors</span>
<span class="ruby-ivar">@errors</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@remote_set</span>.<span class="ruby-identifier">errors</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-find_all" class="method-detail ">
<div class="method-heading">
<span class="method-name">find_all</span><span
class="method-args">(req)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an array of IndexSpecification objects matching DependencyRequest <code>req</code>.</p>
<div class="method-source-code" id="find_all-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/installer_set.rb, line 115</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_all</span>(<span class="ruby-identifier">req</span>)
<span class="ruby-identifier">res</span> = []
<span class="ruby-identifier">dep</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">dependency</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">res</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@ignore_dependencies</span> <span class="ruby-keyword">and</span>
<span class="ruby-ivar">@always_install</span>.<span class="ruby-identifier">none?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">spec</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">match?</span> <span class="ruby-identifier">spec</span> }
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">name</span>
<span class="ruby-identifier">dep</span>.<span class="ruby-identifier">matching_specs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">gemspec</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@always_install</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">spec</span><span class="ruby-operator">|</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">gemspec</span>.<span class="ruby-identifier">name</span> }
<span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Resolver</span><span class="ruby-operator">::</span><span class="ruby-constant">InstalledSpecification</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">gemspec</span>)
<span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@ignore_installed</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">consider_local?</span>
<span class="ruby-identifier">matching_local</span> = <span class="ruby-ivar">@local</span>.<span class="ruby-identifier">values</span>.<span class="ruby-identifier">select</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">spec</span>, <span class="ruby-identifier">_</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">match?</span> <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">spec</span>, <span class="ruby-identifier">source</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Resolver</span><span class="ruby-operator">::</span><span class="ruby-constant">LocalSpecification</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">self</span>, <span class="ruby-identifier">spec</span>, <span class="ruby-identifier">source</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">concat</span> <span class="ruby-identifier">matching_local</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">local_spec</span> = <span class="ruby-ivar">@local_source</span>.<span class="ruby-identifier">find_gem</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">requirement</span>)
<span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Resolver</span><span class="ruby-operator">::</span><span class="ruby-constant">IndexSpecification</span>.<span class="ruby-identifier">new</span>(
<span class="ruby-keyword">self</span>, <span class="ruby-identifier">local_spec</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">local_spec</span>.<span class="ruby-identifier">version</span>,
<span class="ruby-ivar">@local_source</span>, <span class="ruby-identifier">local_spec</span>.<span class="ruby-identifier">platform</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span><span class="ruby-operator">::</span><span class="ruby-constant">FormatError</span>
<span class="ruby-comment"># ignore</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">delete_if</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">spec</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">version</span>.<span class="ruby-identifier">prerelease?</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">prerelease?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">concat</span> <span class="ruby-ivar">@remote_set</span>.<span class="ruby-identifier">find_all</span> <span class="ruby-identifier">req</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">consider_remote?</span>
<span class="ruby-identifier">res</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-prefetch" class="method-detail ">
<div class="method-heading">
<span class="method-name">prefetch</span><span
class="method-args">(reqs)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="prefetch-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/installer_set.rb, line 160</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prefetch</span>(<span class="ruby-identifier">reqs</span>)
<span class="ruby-ivar">@remote_set</span>.<span class="ruby-identifier">prefetch</span>(<span class="ruby-identifier">reqs</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">consider_remote?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-prerelease-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">prerelease=</span><span
class="method-args">(allow_prerelease)</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="prerelease-3D-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/installer_set.rb, line 164</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prerelease=</span>(<span class="ruby-identifier">allow_prerelease</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-ivar">@remote_set</span>.<span class="ruby-identifier">prerelease</span> = <span class="ruby-identifier">allow_prerelease</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>