File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Fetcher/CompactIndex.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Fetcher::CompactIndex - 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="Base.html">Bundler::Fetcher::Base</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-compact_index_request">::compact_index_request</a>
<li ><a href="#method-i-api_fetcher-3F">#api_fetcher?</a>
<li ><a href="#method-i-available-3F">#available?</a>
<li ><a href="#method-i-bundle_worker">#bundle_worker</a>
<li ><a href="#method-i-cache_path">#cache_path</a>
<li ><a href="#method-i-client_fetcher">#client_fetcher</a>
<li ><a href="#method-i-compact_index_client">#compact_index_client</a>
<li ><a href="#method-i-fetch_spec">#fetch_spec</a>
<li ><a href="#method-i-parallel_compact_index_client">#parallel_compact_index_client</a>
<li ><a href="#method-i-serial_compact_index_client">#serial_compact_index_client</a>
<li ><a href="#method-i-specs">#specs</a>
<li ><a href="#method-i-specs_for_names">#specs_for_names</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Fetcher::CompactIndex">
<h1 id="class-Bundler::Fetcher::CompactIndex" class="class">
class Bundler::Fetcher::CompactIndex
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ClientFetcher">ClientFetcher
<dd>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-compact_index_request" class="method-detail ">
<div class="method-heading">
<span class="method-name">compact_index_request</span><span
class="method-args">(method_name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="compact_index_request-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 11</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">compact_index_request</span>(<span class="ruby-identifier">method_name</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-identifier">instance_method</span>(<span class="ruby-identifier">method_name</span>)
<span class="ruby-identifier">undef_method</span>(<span class="ruby-identifier">method_name</span>)
<span class="ruby-identifier">define_method</span>(<span class="ruby-identifier">method_name</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">method</span>.<span class="ruby-identifier">bind</span>(<span class="ruby-keyword">self</span>).<span class="ruby-identifier">call</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NetworkDownError</span>, <span class="ruby-constant">CompactIndexClient</span><span class="ruby-operator">::</span><span class="ruby-constant">Updater</span><span class="ruby-operator">::</span><span class="ruby-constant">MisMatchedChecksumError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPError</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">AuthenticationRequiredError</span>
<span class="ruby-comment"># Fail since we got a 401 from the server.</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">HTTPError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">trace</span>(<span class="ruby-identifier">e</span>)
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</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-api_fetcher-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">api_fetcher?</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="api_fetcher-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">api_fetcher?</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-available-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">available?</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="available-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">available?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">md5_available?</span>
<span class="ruby-identifier">user_home</span> = <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">user_home</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">user_home</span>.<span class="ruby-identifier">directory?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">user_home</span>.<span class="ruby-identifier">writable?</span>
<span class="ruby-comment"># Read info file checksums out of /versions, so we can know if gems are up to date</span>
<span class="ruby-identifier">fetch_uri</span>.<span class="ruby-identifier">scheme</span> <span class="ruby-operator">!=</span> <span class="ruby-string">"file"</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">compact_index_client</span>.<span class="ruby-identifier">update_and_parse_checksums!</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">CompactIndexClient</span><span class="ruby-operator">::</span><span class="ruby-constant">Updater</span><span class="ruby-operator">::</span><span class="ruby-constant">MisMatchedChecksumError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>)
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fetch_spec" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch_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="fetch_spec-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_spec</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-identifier">spec</span> <span class="ruby-operator">-=</span> [<span class="ruby-keyword">nil</span>, <span class="ruby-string">"ruby"</span>, <span class="ruby-string">""</span>]
<span class="ruby-identifier">contents</span> = <span class="ruby-identifier">compact_index_client</span>.<span class="ruby-identifier">spec</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">spec</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">contents</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">first</span>)
<span class="ruby-identifier">contents</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">map!</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Dependency</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">d</span>) }
<span class="ruby-constant">EndpointSpecification</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">contents</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-specs" class="method-detail ">
<div class="method-heading">
<span class="method-name">specs</span><span
class="method-args">(gem_names)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="specs-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 29</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">specs</span>(<span class="ruby-identifier">gem_names</span>)
<span class="ruby-identifier">specs_for_names</span>(<span class="ruby-identifier">gem_names</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-specs_for_names" class="method-detail ">
<div class="method-heading">
<span class="method-name">specs_for_names</span><span
class="method-args">(gem_names)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="specs_for_names-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 34</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">specs_for_names</span>(<span class="ruby-identifier">gem_names</span>)
<span class="ruby-identifier">gem_info</span> = []
<span class="ruby-identifier">complete_gems</span> = []
<span class="ruby-identifier">remaining_gems</span> = <span class="ruby-identifier">gem_names</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">until</span> <span class="ruby-identifier">remaining_gems</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">log_specs</span> <span class="ruby-node">"Looking up gems #{remaining_gems.inspect}"</span>
<span class="ruby-identifier">deps</span> = <span class="ruby-keyword">begin</span>
<span class="ruby-identifier">parallel_compact_index_client</span>.<span class="ruby-identifier">dependencies</span>(<span class="ruby-identifier">remaining_gems</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">TooManyRequestsError</span>
<span class="ruby-ivar">@bundle_worker</span>.<span class="ruby-identifier">stop</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@bundle_worker</span>
<span class="ruby-ivar">@bundle_worker</span> = <span class="ruby-keyword">nil</span> <span class="ruby-comment"># reset it. Not sure if necessary</span>
<span class="ruby-identifier">serial_compact_index_client</span>.<span class="ruby-identifier">dependencies</span>(<span class="ruby-identifier">remaining_gems</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">next_gems</span> = <span class="ruby-identifier">deps</span>.<span class="ruby-identifier">map</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-value">3</span>].<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:first</span>).<span class="ruby-identifier">flatten</span>(<span class="ruby-value">1</span>) }.<span class="ruby-identifier">flatten</span>(<span class="ruby-value">1</span>).<span class="ruby-identifier">uniq</span>
<span class="ruby-identifier">deps</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">gem_info</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dep</span> }
<span class="ruby-identifier">complete_gems</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">deps</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:first</span>)).<span class="ruby-identifier">uniq!</span>
<span class="ruby-identifier">remaining_gems</span> = <span class="ruby-identifier">next_gems</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">complete_gems</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@bundle_worker</span>.<span class="ruby-identifier">stop</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@bundle_worker</span>
<span class="ruby-ivar">@bundle_worker</span> = <span class="ruby-keyword">nil</span> <span class="ruby-comment"># reset it. Not sure if necessary</span>
<span class="ruby-identifier">gem_info</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-bundle_worker" class="method-detail ">
<div class="method-heading">
<span class="method-name">bundle_worker</span><span
class="method-args">(func = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="bundle_worker-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 111</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bundle_worker</span>(<span class="ruby-identifier">func</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@bundle_worker</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span>
<span class="ruby-identifier">worker_name</span> = <span class="ruby-node">"Compact Index (#{display_uri.host})"</span>
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">Worker</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">current_ruby</span>.<span class="ruby-identifier">rbx?</span> <span class="ruby-operator">?</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">25</span>, <span class="ruby-identifier">worker_name</span>, <span class="ruby-identifier">func</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@bundle_worker</span>.<span class="ruby-identifier">tap</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">worker</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">worker</span>.<span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-value">:@func</span>, <span class="ruby-identifier">func</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">func</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-cache_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">cache_path</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="cache_path-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 121</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cache_path</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">user_cache</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"compact_index"</span>, <span class="ruby-identifier">remote</span>.<span class="ruby-identifier">cache_slug</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-client_fetcher" class="method-detail ">
<div class="method-heading">
<span class="method-name">client_fetcher</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="client_fetcher-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 125</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">client_fetcher</span>
<span class="ruby-constant">ClientFetcher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-compact_index_client" class="method-detail ">
<div class="method-heading">
<span class="method-name">compact_index_client</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="compact_index_client-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 88</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">compact_index_client</span>
<span class="ruby-ivar">@compact_index_client</span> <span class="ruby-operator">||=</span>
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">cache_path</span>) <span class="ruby-keyword">do</span>
<span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">cache_path</span>, <span class="ruby-identifier">client_fetcher</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parallel_compact_index_client" class="method-detail ">
<div class="method-heading">
<span class="method-name">parallel_compact_index_client</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="parallel_compact_index_client-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 95</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parallel_compact_index_client</span>
<span class="ruby-identifier">compact_index_client</span>.<span class="ruby-identifier">execution_mode</span> = <span class="ruby-identifier">lambda</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">inputs</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">func</span> = <span class="ruby-identifier">lambda</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">object</span>, <span class="ruby-identifier">_index</span><span class="ruby-operator">|</span> <span class="ruby-identifier">blk</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">object</span>) }
<span class="ruby-identifier">worker</span> = <span class="ruby-identifier">bundle_worker</span>(<span class="ruby-identifier">func</span>)
<span class="ruby-identifier">inputs</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">input</span><span class="ruby-operator">|</span> <span class="ruby-identifier">worker</span>.<span class="ruby-identifier">enq</span>(<span class="ruby-identifier">input</span>) }
<span class="ruby-identifier">inputs</span>.<span class="ruby-identifier">map</span> { <span class="ruby-identifier">worker</span>.<span class="ruby-identifier">deq</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">compact_index_client</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-serial_compact_index_client" class="method-detail ">
<div class="method-heading">
<span class="method-name">serial_compact_index_client</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="serial_compact_index_client-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/compact_index.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">serial_compact_index_client</span>
<span class="ruby-identifier">compact_index_client</span>.<span class="ruby-identifier">sequential_execution_mode!</span>
<span class="ruby-identifier">compact_index_client</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>