File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/CompactIndexClient.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::CompactIndexClient - 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-debug">::debug</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-dependencies">#dependencies</a>
<li ><a href="#method-i-execution_mode">#execution_mode</a>
<li ><a href="#method-i-execution_mode-3D">#execution_mode=</a>
<li ><a href="#method-i-names">#names</a>
<li ><a href="#method-i-sequential_execution_mode-21">#sequential_execution_mode!</a>
<li ><a href="#method-i-sequentially">#sequentially</a>
<li ><a href="#method-i-spec">#spec</a>
<li ><a href="#method-i-synchronize">#synchronize</a>
<li ><a href="#method-i-update">#update</a>
<li ><a href="#method-i-update_and_parse_checksums-21">#update_and_parse_checksums!</a>
<li ><a href="#method-i-update_info">#update_info</a>
<li ><a href="#method-i-url">#url</a>
<li ><a href="#method-i-versions">#versions</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::CompactIndexClient">
<h1 id="class-Bundler::CompactIndexClient" class="class">
class Bundler::CompactIndexClient
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="DEBUG_MUTEX">DEBUG_MUTEX
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-directory" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">directory</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-debug" class="method-detail ">
<div class="method-heading">
<span class="method-name">debug</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="debug-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 9</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">debug</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">"DEBUG_COMPACT_INDEX"</span>]
<span class="ruby-constant">DEBUG_MUTEX</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-identifier">warn</span>(<span class="ruby-node">"[#{self}] #{yield}"</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">(directory, fetcher)</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/compact_index_client.rb, line 21</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">directory</span>, <span class="ruby-identifier">fetcher</span>)
<span class="ruby-ivar">@directory</span> = <span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">directory</span>)
<span class="ruby-ivar">@updater</span> = <span class="ruby-constant">Updater</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">fetcher</span>)
<span class="ruby-ivar">@cache</span> = <span class="ruby-constant">Cache</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@directory</span>)
<span class="ruby-ivar">@endpoints</span> = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@info_checksums_by_name</span> = {}
<span class="ruby-ivar">@parsed_checksums</span> = <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@mutex</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</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-dependencies" class="method-detail ">
<div class="method-heading">
<span class="method-name">dependencies</span><span
class="method-args">(names)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="dependencies-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dependencies</span>(<span class="ruby-identifier">names</span>)
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-node">"dependencies(#{names})"</span> }
<span class="ruby-identifier">execution_mode</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">names</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">update_info</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">dependencies</span>(<span class="ruby-identifier">name</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-identifier">unshift</span>(<span class="ruby-identifier">name</span>) }
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">flatten</span>(<span class="ruby-value">1</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-execution_mode" class="method-detail ">
<div class="method-heading">
<span class="method-name">execution_mode</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@return [Lambda] A lambda that takes an array of inputs and a block, and</p>
<pre>maps the inputs with the block in parallel.</pre>
<div class="method-source-code" id="execution_mode-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 41</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execution_mode</span>
<span class="ruby-ivar">@execution_mode</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">sequentially</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-execution_mode-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">execution_mode=</span><span
class="method-args">(block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="execution_mode-3D-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 31</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execution_mode=</span>(<span class="ruby-identifier">block</span>)
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-string">"execution_mode="</span> }
<span class="ruby-ivar">@endpoints</span> = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@execution_mode</span> = <span class="ruby-identifier">block</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-names" class="method-detail ">
<div class="method-heading">
<span class="method-name">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="names-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 55</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">names</span>
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-string">"/names"</span> }
<span class="ruby-identifier">update</span>(<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">names_path</span>, <span class="ruby-string">"names"</span>)
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">names</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sequential_execution_mode-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">sequential_execution_mode!</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="sequential_execution_mode-21-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 45</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sequential_execution_mode!</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">execution_mode</span> = <span class="ruby-identifier">sequentially</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sequentially" class="method-detail ">
<div class="method-heading">
<span class="method-name">sequentially</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="sequentially-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 49</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sequentially</span>
<span class="ruby-ivar">@sequentially</span> <span class="ruby-operator">||=</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">inputs</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-spec" class="method-detail ">
<div class="method-heading">
<span class="method-name">spec</span><span
class="method-args">(name, version, platform = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="spec-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 76</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spec</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-node">"spec(name = #{name}, version = #{version}, platform = #{platform})"</span> }
<span class="ruby-identifier">update_info</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">specific_dependency</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-update_and_parse_checksums-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">update_and_parse_checksums!</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="update_and_parse_checksums-21-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_and_parse_checksums!</span>
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-string">"update_and_parse_checksums!"</span> }
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@info_checksums_by_name</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@parsed_checksums</span>
<span class="ruby-identifier">update</span>(<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">versions_path</span>, <span class="ruby-string">"versions"</span>)
<span class="ruby-ivar">@info_checksums_by_name</span> = <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">checksums</span>
<span class="ruby-ivar">@parsed_checksums</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-versions" class="method-detail ">
<div class="method-heading">
<span class="method-name">versions</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="versions-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">versions</span>
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-string">"/versions"</span> }
<span class="ruby-identifier">update</span>(<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">versions_path</span>, <span class="ruby-string">"versions"</span>)
<span class="ruby-identifier">versions</span>, <span class="ruby-ivar">@info_checksums_by_name</span> = <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">versions</span>
<span class="ruby-identifier">versions</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-synchronize" class="method-detail ">
<div class="method-heading">
<span class="method-name">synchronize</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="synchronize-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 121</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">synchronize</span>
<span class="ruby-ivar">@mutex</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-keyword">yield</span> }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-update" class="method-detail ">
<div class="method-heading">
<span class="method-name">update</span><span
class="method-args">(local_path, remote_path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="update-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update</span>(<span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_path</span>)
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-node">"update(#{local_path}, #{remote_path})"</span> }
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">synchronize</span> { <span class="ruby-ivar">@endpoints</span>.<span class="ruby-identifier">add?</span>(<span class="ruby-identifier">remote_path</span>) }
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-node">"already fetched #{remote_path}"</span> }
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@updater</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">url</span>(<span class="ruby-identifier">remote_path</span>))
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-update_info" class="method-detail ">
<div class="method-heading">
<span class="method-name">update_info</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="update_info-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_info</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-node">"update_info(#{name})"</span> }
<span class="ruby-identifier">path</span> = <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">info_path</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">checksum</span> = <span class="ruby-ivar">@updater</span>.<span class="ruby-identifier">checksum_for_file</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">existing</span> = <span class="ruby-ivar">@info_checksums_by_name</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-node">"skipping updating info for #{name} since it is missing from versions"</span> }
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">checksum</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">existing</span>
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-node">"skipping updating info for #{name} since the versions checksum matches the local checksum"</span> }
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">CompactIndexClient</span>.<span class="ruby-identifier">debug</span> { <span class="ruby-node">"updating info for #{name} since the versions checksum #{existing} != the local checksum #{checksum}"</span> }
<span class="ruby-identifier">update</span>(<span class="ruby-identifier">path</span>, <span class="ruby-node">"info/#{name}"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-url" class="method-detail ">
<div class="method-heading">
<span class="method-name">url</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="url-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">url</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-identifier">path</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>