File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/RemoteSpecification.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::RemoteSpecification - 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="MatchPlatform.html">Bundler::MatchPlatform</a>
<li><a class="include" href="../Comparable.html">Comparable</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-new">::new</a>
<li class="calls-super" ><a href="#method-i-3C-3D-3E">#<=></a>
<li ><a href="#method-i-__swap__">#__swap__</a>
<li ><a href="#method-i-_remote_specification">#_remote_specification</a>
<li ><a href="#method-i-dependencies">#dependencies</a>
<li ><a href="#method-i-fetch_platform">#fetch_platform</a>
<li ><a href="#method-i-full_name">#full_name</a>
<li ><a href="#method-i-git_version">#git_version</a>
<li ><a href="#method-i-method_missing">#method_missing</a>
<li class="calls-super" ><a href="#method-i-respond_to-3F">#respond_to?</a>
<li ><a href="#method-i-sort_obj">#sort_obj</a>
<li ><a href="#method-i-to_ary">#to_ary</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::RemoteSpecification">
<h1 id="class-Bundler::RemoteSpecification" class="class">
class Bundler::RemoteSpecification
</h1>
<section class="description">
<p>Represents a lazily loaded gem specification, where the full specification is on the source server in rubygems' “quick” index. The proxy object is to be seeded with what we're given from the source's abbreviated index - the full specification will only be fetched when necessary.</p>
</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-dependencies" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">dependencies</span><span
class="attribute-access-type">[W]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">name</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-platform" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">platform</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-remote" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">remote</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-source" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">source</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-version" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">version</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">(name, version, platform, spec_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/remote_specification.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span>, <span class="ruby-identifier">spec_fetcher</span>)
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-ivar">@version</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Version</span>.<span class="ruby-identifier">create</span> <span class="ruby-identifier">version</span>
<span class="ruby-ivar">@platform</span> = <span class="ruby-identifier">platform</span>
<span class="ruby-ivar">@spec_fetcher</span> = <span class="ruby-identifier">spec_fetcher</span>
<span class="ruby-ivar">@dependencies</span> = <span class="ruby-keyword">nil</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-3D-3E" 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>Compare this specification against another object. Using <a href="RemoteSpecification.html#method-i-sort_obj"><code>sort_obj</code></a> is compatible with <a href="../Gem/Specification.html"><code>Gem::Specification</code></a> and other <a href="../Bundler.html"><code>Bundler</code></a> or RubyGems objects. Otherwise, use the default <a href="../Object.html"><code>Object</code></a> comparison.</p>
<div class="method-calls-super">
Calls superclass method
Object#<=>
</div>
<div class="method-source-code" id="3C-3D-3E-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 41</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span>(<span class="ruby-identifier">other</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:sort_obj</span>)
<span class="ruby-identifier">sort_obj</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">sort_obj</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-__swap__" class="method-detail ">
<div class="method-heading">
<span class="method-name">__swap__</span><span
class="method-args">(spec)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Because Rubyforge cannot be trusted to provide valid specifications once the remote gem is downloaded, the backend specification will be swapped out.</p>
<div class="method-source-code" id="__swap__-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 52</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">__swap__</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">ensure_same_dependencies</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">dependencies</span>, <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">dependencies</span>)
<span class="ruby-ivar">@_remote_specification</span> = <span class="ruby-identifier">spec</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">()</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/remote_specification.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dependencies</span>
<span class="ruby-ivar">@dependencies</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span>
<span class="ruby-identifier">deps</span> = <span class="ruby-identifier">method_missing</span>(<span class="ruby-value">:dependencies</span>)
<span class="ruby-comment"># allow us to handle when the specs dependencies are an array of array of string</span>
<span class="ruby-comment"># see https://github.com/bundler/bundler/issues/5797</span>
<span class="ruby-identifier">deps</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-identifier">is_a?</span>(<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Dependency</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-identifier">deps</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fetch_platform" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch_platform</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Needed before installs, since the arch matters then and quick specs don't bother to include the arch in the platform string</p>
<div class="method-source-code" id="fetch_platform-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 26</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_platform</span>
<span class="ruby-ivar">@platform</span> = <span class="ruby-identifier">_remote_specification</span>.<span class="ruby-identifier">platform</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-full_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">full_name</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="full_name-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_name</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">platform</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span><span class="ruby-operator">::</span><span class="ruby-constant">RUBY</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">platform</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-node">"#{@name}-#{@version}"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-node">"#{@name}-#{@version}-#{platform}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-git_version" class="method-detail ">
<div class="method-heading">
<span class="method-name">git_version</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="git_version-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 86</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">git_version</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">loaded_from</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">Git</span>)
<span class="ruby-node">" #{source.revision[0..6]}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-respond_to-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">respond_to?</span><span
class="method-args">(method, include_all = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../Object.html#method-i-respond_to-3F"><code>Object#respond_to?</code></a>
</div>
<div class="method-source-code" id="respond_to-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">respond_to?</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">include_all</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">super</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">_remote_specification</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">include_all</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sort_obj" class="method-detail ">
<div class="method-heading">
<span class="method-name">sort_obj</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a delegate used for sorting. This strategy is copied from RubyGems 2.23 and ensures that Bundler's specifications can be compared and sorted with RubyGems' own specifications.</p>
<p>@see #<=> @see <a href="../Gem/Specification.html#method-i-sort_obj"><code>Gem::Specification#sort_obj</code></a></p>
<p>@return [Array] an object you can use to compare and sort this</p>
<pre class="ruby"><span class="ruby-identifier">specification</span> <span class="ruby-identifier">against</span> <span class="ruby-identifier">other</span> <span class="ruby-identifier">specifications</span>
</pre>
<div class="method-source-code" id="sort_obj-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sort_obj</span>
[<span class="ruby-ivar">@name</span>, <span class="ruby-ivar">@version</span>, <span class="ruby-ivar">@platform</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span><span class="ruby-operator">::</span><span class="ruby-constant">RUBY</span> <span class="ruby-operator">?</span> <span class="ruby-value">-1</span> <span class="ruby-operator">:</span> <span class="ruby-value">1</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</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="to_s-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-node">"#<#{self.class} name=#{name} version=#{version} platform=#{platform}>"</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-_remote_specification" class="method-detail ">
<div class="method-heading">
<span class="method-name">_remote_specification</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="_remote_specification-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_remote_specification</span>
<span class="ruby-ivar">@_remote_specification</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@spec_fetcher</span>.<span class="ruby-identifier">fetch_spec</span>([<span class="ruby-ivar">@name</span>, <span class="ruby-ivar">@version</span>, <span class="ruby-ivar">@platform</span>])
<span class="ruby-ivar">@_remote_specification</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">raise</span>(<span class="ruby-constant">GemspecError</span>, <span class="ruby-node">"Gemspec data for #{full_name} was"</span> \
<span class="ruby-string">" missing from the server! Try installing with `--full-index` as a workaround."</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-method_missing" class="method-detail ">
<div class="method-heading">
<span class="method-name">method_missing</span><span
class="method-args">(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="method_missing-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 103</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">method_missing</span>(<span class="ruby-identifier">method</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-identifier">_remote_specification</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">method</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">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_ary" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_ary</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="to_ary-source">
<pre><span class="ruby-comment"># File lib/bundler/remote_specification.rb, line 93</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_ary</span>
<span class="ruby-keyword">nil</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>