File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/CompactIndexClient/Cache.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::CompactIndexClient::Cache - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-checksums">#checksums</a>
<li ><a href="#method-i-dependencies">#dependencies</a>
<li ><a href="#method-i-info_path">#info_path</a>
<li ><a href="#method-i-info_roots">#info_roots</a>
<li ><a href="#method-i-lines">#lines</a>
<li ><a href="#method-i-names">#names</a>
<li ><a href="#method-i-names_path">#names_path</a>
<li ><a href="#method-i-parse_dependency">#parse_dependency</a>
<li ><a href="#method-i-parse_gem">#parse_gem</a>
<li ><a href="#method-i-specific_dependency">#specific_dependency</a>
<li ><a href="#method-i-versions">#versions</a>
<li ><a href="#method-i-versions_path">#versions_path</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::CompactIndexClient::Cache">
<h1 id="class-Bundler::CompactIndexClient::Cache" class="class">
class Bundler::CompactIndexClient::Cache
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(directory)</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/cache.rb, line 8</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">directory</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-identifier">expand_path</span>
<span class="ruby-identifier">info_roots</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dir</span><span class="ruby-operator">|</span>
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">dir</span>) <span class="ruby-keyword">do</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">dir</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-checksums" class="method-detail ">
<div class="method-heading">
<span class="method-name">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="checksums-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">checksums</span>
<span class="ruby-identifier">checksums</span> = {}
<span class="ruby-identifier">lines</span>(<span class="ruby-identifier">versions_path</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">name</span>, <span class="ruby-identifier">_</span>, <span class="ruby-identifier">checksum</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">" "</span>, <span class="ruby-value">3</span>)
<span class="ruby-identifier">checksums</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">checksum</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">checksums</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dependencies" class="method-detail ">
<div class="method-heading">
<span class="method-name">dependencies</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="dependencies-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dependencies</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">lines</span>(<span class="ruby-identifier">info_path</span>(<span class="ruby-identifier">name</span>)).<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">parse_gem</span>(<span class="ruby-identifier">line</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-info_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">info_path</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="info_path-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">info_path</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/[^a-z0-9_-]/</span>
<span class="ruby-identifier">name</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"-#{SharedHelpers.digest(:MD5).hexdigest(name).downcase}"</span>
<span class="ruby-identifier">info_roots</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">info_roots</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">end</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/cache.rb, line 17</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">names</span>
<span class="ruby-identifier">lines</span>(<span class="ruby-identifier">names_path</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-names_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">names_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="names_path-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 21</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">names_path</span>
<span class="ruby-identifier">directory</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"names"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-specific_dependency" class="method-detail ">
<div class="method-heading">
<span class="method-name">specific_dependency</span><span
class="method-args">(name, version, platform)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="specific_dependency-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">specific_dependency</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span>)
<span class="ruby-identifier">pattern</span> = [<span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span>].<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"-"</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">gem_lines</span> = <span class="ruby-identifier">info_path</span>(<span class="ruby-identifier">name</span>).<span class="ruby-identifier">read</span>
<span class="ruby-identifier">gem_line</span> = <span class="ruby-identifier">gem_lines</span>[<span class="ruby-regexp">/^#{Regexp.escape(pattern)}\b.*/</span>, <span class="ruby-value">0</span>]
<span class="ruby-identifier">gem_line</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">parse_gem</span>(<span class="ruby-identifier">gem_line</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</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/cache.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">versions</span>
<span class="ruby-identifier">versions_by_name</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">hash</span>, <span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">key</span>] = [] }
<span class="ruby-identifier">info_checksums_by_name</span> = {}
<span class="ruby-identifier">lines</span>(<span class="ruby-identifier">versions_path</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">name</span>, <span class="ruby-identifier">versions_string</span>, <span class="ruby-identifier">info_checksum</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">" "</span>, <span class="ruby-value">3</span>)
<span class="ruby-identifier">info_checksums_by_name</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">info_checksum</span> <span class="ruby-operator">||</span> <span class="ruby-string">""</span>
<span class="ruby-identifier">versions_string</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">","</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">version</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">version</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">"-"</span>)
<span class="ruby-identifier">version</span> = <span class="ruby-identifier">version</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">"-"</span>, <span class="ruby-value">2</span>).<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">versions_by_name</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">version</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">version</span> = <span class="ruby-identifier">version</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"-"</span>, <span class="ruby-value">2</span>).<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">versions_by_name</span>[<span class="ruby-identifier">name</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">version</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
[<span class="ruby-identifier">versions_by_name</span>, <span class="ruby-identifier">info_checksums_by_name</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-versions_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">versions_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="versions_path-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 46</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">versions_path</span>
<span class="ruby-identifier">directory</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"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-info_roots" class="method-detail ">
<div class="method-heading">
<span class="method-name">info_roots</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="info_roots-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 110</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">info_roots</span>
[
<span class="ruby-identifier">directory</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"info"</span>),
<span class="ruby-identifier">directory</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"info-special-characters"</span>),
]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-lines" class="method-detail ">
<div class="method-heading">
<span class="method-name">lines</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="lines-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 88</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">lines</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">return</span> [] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">file?</span>
<span class="ruby-identifier">lines</span> = <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">path</span>, <span class="ruby-value">:read</span>, <span class="ruby-operator">&</span><span class="ruby-value">:read</span>).<span class="ruby-identifier">split</span>(<span class="ruby-string">"\n"</span>)
<span class="ruby-identifier">header</span> = <span class="ruby-identifier">lines</span>.<span class="ruby-identifier">index</span>(<span class="ruby-string">"---"</span>)
<span class="ruby-identifier">header</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">lines</span>[<span class="ruby-identifier">header</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-operator">:</span> <span class="ruby-identifier">lines</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parse_dependency" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_dependency</span><span
class="method-args">(string)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="parse_dependency-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 104</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_dependency</span>(<span class="ruby-identifier">string</span>)
<span class="ruby-identifier">dependency</span> = <span class="ruby-identifier">string</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">":"</span>)
<span class="ruby-identifier">dependency</span>[<span class="ruby-value">-1</span>] = <span class="ruby-identifier">dependency</span>[<span class="ruby-value">-1</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">"&"</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
<span class="ruby-identifier">dependency</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parse_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_gem</span><span
class="method-args">(string)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="parse_gem-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/cache.rb, line 95</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_gem</span>(<span class="ruby-identifier">string</span>)
<span class="ruby-identifier">version_and_platform</span>, <span class="ruby-identifier">rest</span> = <span class="ruby-identifier">string</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">" "</span>, <span class="ruby-value">2</span>)
<span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span> = <span class="ruby-identifier">version_and_platform</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"-"</span>, <span class="ruby-value">2</span>)
<span class="ruby-identifier">dependencies</span>, <span class="ruby-identifier">requirements</span> = <span class="ruby-identifier">rest</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"|"</span>, <span class="ruby-value">2</span>).<span class="ruby-identifier">map</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">split</span>(<span class="ruby-string">","</span>) } <span class="ruby-keyword">if</span> <span class="ruby-identifier">rest</span>
<span class="ruby-identifier">dependencies</span> = <span class="ruby-identifier">dependencies</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">dependencies</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">parse_dependency</span>(<span class="ruby-identifier">d</span>) } <span class="ruby-operator">:</span> []
<span class="ruby-identifier">requirements</span> = <span class="ruby-identifier">requirements</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">requirements</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span> <span class="ruby-identifier">parse_dependency</span>(<span class="ruby-identifier">r</span>) } <span class="ruby-operator">:</span> []
[<span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span>, <span class="ruby-identifier">dependencies</span>, <span class="ruby-identifier">requirements</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>