File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Resolver/Specification.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Resolver::Specification - 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-download">#download</a>
<li ><a href="#method-i-full_name">#full_name</a>
<li ><a href="#method-i-install">#install</a>
<li ><a href="#method-i-installable_platform-3F">#installable_platform?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Resolver::Specification">
<h1 id="class-Gem::Resolver::Specification" class="class">
class Gem::Resolver::Specification
</h1>
<section class="description">
<p>A Resolver::Specification contains a subset of the information contained in a <a href="../Specification.html"><code>Gem::Specification</code></a>. Only the information necessary for dependency resolution in the resolver is included.</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">[R]</span>
</div>
<div class="method-description">
<p>The dependencies of the gem for this specification</p>
</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">
<p>The name of the gem for this specification</p>
</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">
<p>The platform this gem works on.</p>
</div>
</div>
<div id="attribute-i-set" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">set</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The set this specification came from.</p>
</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">[R]</span>
</div>
<div class="method-description">
<p>The source for this specification</p>
</div>
</div>
<div id="attribute-i-spec" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">spec</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The <a href="../Specification.html"><code>Gem::Specification</code></a> for this Resolver::Specification.</p>
<p>Implementers, note that <a href="Specification.html#method-i-install"><code>install</code></a> updates @spec, so be sure to cache the <a href="../Specification.html"><code>Gem::Specification</code></a> in @spec when overriding.</p>
</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">
<p>The version of the gem for this specification.</p>
</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">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets default instance variables for the specification.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/specification.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@dependencies</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@platform</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@set</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@source</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@version</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-download" class="method-detail ">
<div class="method-heading">
<span class="method-name">download</span><span
class="method-args">(options)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="download-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/specification.rb, line 96</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">download</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-identifier">dir</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:install_dir</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">dir</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">ensure_gem_subdirectories</span> <span class="ruby-identifier">dir</span>
<span class="ruby-identifier">source</span>.<span class="ruby-identifier">download</span> <span class="ruby-identifier">spec</span>, <span class="ruby-identifier">dir</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">
<p>The name and version of the specification.</p>
<p>Unlike <a href="../Specification.html#method-i-full_name"><code>Gem::Specification#full_name</code></a>, the platform is not included.</p>
<div class="method-source-code" id="full_name-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/specification.rb, line 71</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_name</span>
<span class="ruby-node">"#{@name}-#{@version}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-install" class="method-detail ">
<div class="method-heading">
<span class="method-name">install</span><span
class="method-args">(options = {}) { |installer| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Installs this specification using the <a href="../Installer.html"><code>Gem::Installer</code></a> <code>options</code>. The install method yields a <a href="../Installer.html"><code>Gem::Installer</code></a> instance, which indicates the gem will be installed, or <code>nil</code>, which indicates the gem is already installed.</p>
<p>After installation <a href="Specification.html#attribute-i-spec"><code>spec</code></a> is updated to point to the just-installed specification.</p>
<div class="method-source-code" id="install-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/specification.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install</span>(<span class="ruby-identifier">options</span> = {})
<span class="ruby-identifier">require</span> <span class="ruby-string">'rubygems/installer'</span>
<span class="ruby-identifier">gem</span> = <span class="ruby-identifier">download</span> <span class="ruby-identifier">options</span>
<span class="ruby-identifier">installer</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Installer</span>.<span class="ruby-identifier">at</span> <span class="ruby-identifier">gem</span>, <span class="ruby-identifier">options</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">installer</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-ivar">@spec</span> = <span class="ruby-identifier">installer</span>.<span class="ruby-identifier">install</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-installable_platform-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">installable_platform?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if this specification is installable on this platform.</p>
<div class="method-source-code" id="installable_platform-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/specification.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">installable_platform?</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span>.<span class="ruby-identifier">match</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">platform</span>
<span class="ruby-keyword">end</span></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>