File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Index - 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>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../Enumerable.html">Enumerable</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-build">::build</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-sort_specs">::sort_specs</a>
<li ><a href="#method-i-3C-3C">#<<</a>
<li ><a href="#method-i-3D-3D">#==</a>
<li ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-add_source">#add_source</a>
<li ><a href="#method-i-dependencies_eql-3F">#dependencies_eql?</a>
<li ><a href="#method-i-dependency_names">#dependency_names</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-empty-3F">#empty?</a>
<li ><a href="#method-i-initialize_copy">#initialize_copy</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-local_search">#local_search</a>
<li ><a href="#method-i-search">#search</a>
<li ><a href="#method-i-search_all">#search_all</a>
<li ><a href="#method-i-search_by_dependency">#search_by_dependency</a>
<li ><a href="#method-i-search_by_spec">#search_by_spec</a>
<li ><a href="#method-i-size">#size</a>
<li ><a href="#method-i-sort_specs">#sort_specs</a>
<li ><a href="#method-i-spec_names">#spec_names</a>
<li ><a href="#method-i-specs_by_name">#specs_by_name</a>
<li ><a href="#method-i-unmet_dependency_names">#unmet_dependency_names</a>
<li ><a href="#method-i-unsorted_search">#unsorted_search</a>
<li ><a href="#method-i-use">#use</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Index">
<h1 id="class-Bundler::Index" class="class">
class Bundler::Index
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="EMPTY_SEARCH">EMPTY_SEARCH
<dd>
<dt id="NULL">NULL
<dd>
<dt id="RUBY">RUBY
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-all_specs" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">all_specs</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-sources" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">sources</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-specs" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">specs</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-build" class="method-detail ">
<div class="method-heading">
<span class="method-name">build</span><span
class="method-args">() { |i| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="build-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 9</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">build</span>
<span class="ruby-identifier">i</span> = <span class="ruby-identifier">new</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">i</span>
<span class="ruby-identifier">i</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</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="new-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 21</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@sources</span> = []
<span class="ruby-ivar">@cache</span> = {}
<span class="ruby-ivar">@specs</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-ivar">@all_specs</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-constant">EMPTY_SEARCH</span> }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-sort_specs" class="method-detail ">
<div class="method-heading">
<span class="method-name">sort_specs</span><span
class="method-args">(specs)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="sort_specs-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 80</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">sort_specs</span>(<span class="ruby-identifier">specs</span>)
<span class="ruby-identifier">specs</span>.<span class="ruby-identifier">sort_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">platform_string</span> = <span class="ruby-identifier">s</span>.<span class="ruby-identifier">platform</span>.<span class="ruby-identifier">to_s</span>
[<span class="ruby-identifier">s</span>.<span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform_string</span> <span class="ruby-operator">==</span> <span class="ruby-constant">RUBY</span> <span class="ruby-operator">?</span> <span class="ruby-constant">NULL</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">platform_string</span>]
<span class="ruby-keyword">end</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-3C-3C" class="method-detail ">
<div class="method-heading">
<span class="method-name"><<</span><span
class="method-args">(spec)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="3C-3C-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 104</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-ivar">@specs</span>[<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">name</span>][<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">full_name</span>] = <span class="ruby-identifier">spec</span>
<span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-3D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">==</span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Whether all the specs in self are in other TODO: rename to <a href="../Enumerable.html#method-i-include-3F"><code>include?</code></a></p>
<div class="method-source-code" id="3D-3D-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 163</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>)
<span class="ruby-identifier">all?</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">other_spec</span> = <span class="ruby-identifier">other</span>[<span class="ruby-identifier">spec</span>].<span class="ruby-identifier">first</span>
<span class="ruby-identifier">other_spec</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">dependencies_eql?</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">other_spec</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-identifier">other_spec</span>.<span class="ruby-identifier">source</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-5B-5D" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(query, base = nil)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Index.html#method-i-search">search</a>
</div>
</div>
<div id="method-i-add_source" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_source</span><span
class="method-args">(index)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="add_source-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 176</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_source</span>(<span class="ruby-identifier">index</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Source must be an index, not #{index.class}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">index</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Index</span>)
<span class="ruby-ivar">@sources</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">index</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">uniq!</span> <span class="ruby-comment"># need to use uniq! here instead of checking for the item before adding</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dependencies_eql-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">dependencies_eql?</span><span
class="method-args">(spec, other_spec)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="dependencies_eql-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 170</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dependencies_eql?</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">other_spec</span>)
<span class="ruby-identifier">deps</span> = <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">dependencies</span>.<span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-value">:development</span> }
<span class="ruby-identifier">other_deps</span> = <span class="ruby-identifier">other_spec</span>.<span class="ruby-identifier">dependencies</span>.<span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-value">:development</span> }
<span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">deps</span>) <span class="ruby-operator">==</span> <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">other_deps</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dependency_names" class="method-detail ">
<div class="method-heading">
<span class="method-name">dependency_names</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="dependency_names-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 131</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dependency_names</span>
<span class="ruby-identifier">names</span> = []
<span class="ruby-identifier">each</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">dependencies</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">:development</span>
<span class="ruby-identifier">names</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">names</span>.<span class="ruby-identifier">uniq</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">(&blk)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 109</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-value">:each</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">blk</span>
<span class="ruby-identifier">specs</span>.<span class="ruby-identifier">values</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">spec_sets</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">spec_sets</span>.<span class="ruby-identifier">values</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">sources</span>.<span class="ruby-identifier">each</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">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>) }
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-empty-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">empty?</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="empty-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 46</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
<span class="ruby-identifier">each</span> { <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> }
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-initialize_copy" class="method-detail ">
<div class="method-heading">
<span class="method-name">initialize_copy</span><span
class="method-args">(o)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="initialize_copy-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 28</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize_copy</span>(<span class="ruby-identifier">o</span>)
<span class="ruby-ivar">@sources</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">sources</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-ivar">@cache</span> = {}
<span class="ruby-ivar">@specs</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-ivar">@all_specs</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-constant">EMPTY_SEARCH</span> }
<span class="ruby-identifier">o</span>.<span class="ruby-identifier">specs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>, <span class="ruby-identifier">hash</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@specs</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">o</span>.<span class="ruby-identifier">all_specs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>, <span class="ruby-identifier">array</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@all_specs</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">array</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect</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="inspect-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 42</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>
<span class="ruby-node">"#<#{self.class}:0x#{object_id} sources=#{sources.map(&:inspect)} specs.size=#{specs.size}>"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-local_search" class="method-detail ">
<div class="method-heading">
<span class="method-name">local_search</span><span
class="method-args">(query, base = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="local_search-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">local_search</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">base</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">query</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span>, <span class="ruby-constant">RemoteSpecification</span>, <span class="ruby-constant">LazySpecification</span>, <span class="ruby-constant">EndpointSpecification</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">search_by_spec</span>(<span class="ruby-identifier">query</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">specs_by_name</span>(<span class="ruby-identifier">query</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Dependency</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">search_by_dependency</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">base</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">DepProxy</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">search_by_dependency</span>(<span class="ruby-identifier">query</span>.<span class="ruby-identifier">dep</span>, <span class="ruby-identifier">base</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-node">"You can't search for a #{query.inspect}."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-search" class="method-detail ">
<div class="method-heading">
<span class="method-name">search</span><span
class="method-args">(query, base = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Search this index's specs, and any source indexes that this index knows about, returning all of the results.</p>
<div class="method-source-code" id="search-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">base</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">sort_specs</span>(<span class="ruby-identifier">unsorted_search</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">base</span>))
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Index.html#method-i-5B-5D">[]</a>
</div>
</div>
<div id="method-i-search_all" class="method-detail ">
<div class="method-heading">
<span class="method-name">search_all</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="search_all-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 51</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_all</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">all_matches</span> = <span class="ruby-identifier">local_search</span>(<span class="ruby-identifier">name</span>) <span class="ruby-operator">+</span> <span class="ruby-ivar">@all_specs</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">source</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">all_matches</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">source</span>.<span class="ruby-identifier">search_all</span>(<span class="ruby-identifier">name</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">all_matches</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-size" class="method-detail ">
<div class="method-heading">
<span class="method-name">size</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="size-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 155</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">inject</span>(<span class="ruby-ivar">@specs</span>.<span class="ruby-identifier">size</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">size</span>, <span class="ruby-identifier">source</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">size</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">size</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sort_specs" class="method-detail ">
<div class="method-heading">
<span class="method-name">sort_specs</span><span
class="method-args">(specs)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="sort_specs-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort_specs</span>(<span class="ruby-identifier">specs</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">sort_specs</span>(<span class="ruby-identifier">specs</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-spec_names" class="method-detail ">
<div class="method-heading">
<span class="method-name">spec_names</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_names-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spec_names</span>
<span class="ruby-identifier">names</span> = <span class="ruby-identifier">specs</span>.<span class="ruby-identifier">keys</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">sources</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:spec_names</span>)
<span class="ruby-identifier">names</span>.<span class="ruby-identifier">uniq!</span>
<span class="ruby-identifier">names</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-unmet_dependency_names" class="method-detail ">
<div class="method-heading">
<span class="method-name">unmet_dependency_names</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns a list of the dependencies</p>
<div class="method-source-code" id="unmet_dependency_names-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 125</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unmet_dependency_names</span>
<span class="ruby-identifier">dependency_names</span>.<span class="ruby-identifier">select</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">name</span> <span class="ruby-operator">!=</span> <span class="ruby-string">"bundler"</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">search</span>(<span class="ruby-identifier">name</span>).<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-use" class="method-detail ">
<div class="method-heading">
<span class="method-name">use</span><span
class="method-args">(other, override_dupes = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="use-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 142</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">use</span>(<span class="ruby-identifier">other</span>, <span class="ruby-identifier">override_dupes</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">other</span>
<span class="ruby-identifier">other</span>.<span class="ruby-identifier">each</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-keyword">if</span> (<span class="ruby-identifier">dupes</span> = <span class="ruby-identifier">search_by_spec</span>(<span class="ruby-identifier">s</span>)) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">dupes</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-comment"># safe to << since it's a new array when it has contents</span>
<span class="ruby-ivar">@all_specs</span>[<span class="ruby-identifier">s</span>.<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">dupes</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">s</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">override_dupes</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">s</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</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-unsorted_search" class="method-detail ">
<div class="method-heading">
<span class="method-name">unsorted_search</span><span
class="method-args">(query, base)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="unsorted_search-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 65</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unsorted_search</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">base</span>)
<span class="ruby-identifier">results</span> = <span class="ruby-identifier">local_search</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">base</span>)
<span class="ruby-identifier">seen</span> = <span class="ruby-identifier">results</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:full_name</span>).<span class="ruby-identifier">to_set</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">source</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">source</span>.<span class="ruby-identifier">unsorted_search</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">base</span>).<span class="ruby-identifier">each</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">results</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">spec</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">seen</span>.<span class="ruby-identifier">add?</span>(<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">full_name</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">results</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-search_by_dependency" class="method-detail ">
<div class="method-heading">
<span class="method-name">search_by_dependency</span><span
class="method-args">(dependency, base = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="search_by_dependency-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 188</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_by_dependency</span>(<span class="ruby-identifier">dependency</span>, <span class="ruby-identifier">base</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">base</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">false</span>] <span class="ruby-operator">||=</span> {}
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">base</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">false</span>][<span class="ruby-identifier">dependency</span>] <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span>
<span class="ruby-identifier">specs</span> = <span class="ruby-identifier">specs_by_name</span>(<span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">specs</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">base</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">base</span>
<span class="ruby-identifier">found</span> = <span class="ruby-identifier">specs</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-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">source</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">Gemspec</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">base</span> <span class="ruby-comment"># allow all platforms when searching from a lockfile</span>
<span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">matches_spec?</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">matches_spec?</span>(<span class="ruby-identifier">spec</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-identifier">match</span>(<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">platform</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">found</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-search_by_spec" class="method-detail ">
<div class="method-heading">
<span class="method-name">search_by_spec</span><span
class="method-args">(spec)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="search_by_spec-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 208</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_by_spec</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-identifier">spec</span> = <span class="ruby-ivar">@specs</span>[<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">name</span>][<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">full_name</span>]
<span class="ruby-identifier">spec</span> <span class="ruby-operator">?</span> [<span class="ruby-identifier">spec</span>] <span class="ruby-operator">:</span> <span class="ruby-constant">EMPTY_SEARCH</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-specs_by_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">specs_by_name</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="specs_by_name-source">
<pre><span class="ruby-comment"># File lib/bundler/index.rb, line 184</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">specs_by_name</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@specs</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">values</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>