File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Resolver/ActivationRequest.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Resolver::ActivationRequest - 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-development-3F">#development?</a>
<li ><a href="#method-i-download">#download</a>
<li ><a href="#method-i-full_name">#full_name</a>
<li ><a href="#method-i-full_spec">#full_spec</a>
<li ><a href="#method-i-installed-3F">#installed?</a>
<li ><a href="#method-i-name">#name</a>
<li ><a href="#method-i-name_tuple">#name_tuple</a>
<li ><a href="#method-i-parent">#parent</a>
<li ><a href="#method-i-platform">#platform</a>
<li ><a href="#method-i-to_s">#to_s</a>
<li ><a href="#method-i-version">#version</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Resolver::ActivationRequest">
<h1 id="class-Gem::Resolver::ActivationRequest" class="class">
class Gem::Resolver::ActivationRequest
</h1>
<section class="description">
<p>Specifies a Specification object that should be activated. Also contains a dependency that was used to introduce this activation.</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-request" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">request</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The parent request for this activation request.</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 specification to be activated.</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">(spec, request)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="ActivationRequest.html"><code>ActivationRequest</code></a> that will activate <code>spec</code>. The parent <code>request</code> is used to provide diagnostics in case of conflicts.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">request</span>)
<span class="ruby-ivar">@spec</span> = <span class="ruby-identifier">spec</span>
<span class="ruby-ivar">@request</span> = <span class="ruby-identifier">request</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-development-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">development?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is this activation request for a development dependency?</p>
<div class="method-source-code" id="development-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 41</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">development?</span>
<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">development?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-download" class="method-detail ">
<div class="method-heading">
<span class="method-name">download</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Downloads a gem at <code>path</code> and returns the file path.</p>
<div class="method-source-code" id="download-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">download</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">ensure_gem_subdirectories</span> <span class="ruby-identifier">path</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:sources</span>
<span class="ruby-identifier">exception</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">path</span> = <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">sources</span>.<span class="ruby-identifier">find</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">source</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">source</span>.<span class="ruby-identifier">download</span> <span class="ruby-identifier">full_spec</span>, <span class="ruby-identifier">path</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-identifier">exception</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">path</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span>
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exception</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:source</span>
<span class="ruby-identifier">source</span> = <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">source</span>
<span class="ruby-identifier">source</span>.<span class="ruby-identifier">download</span> <span class="ruby-identifier">full_spec</span>, <span class="ruby-identifier">path</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">source</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">sources</span>.<span class="ruby-identifier">first</span>
<span class="ruby-identifier">source</span>.<span class="ruby-identifier">download</span> <span class="ruby-identifier">full_spec</span>, <span class="ruby-identifier">path</span>
<span class="ruby-keyword">end</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 full name of the specification to be activated.</p>
<div class="method-source-code" id="full_name-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_name</span>
<span class="ruby-identifier">name_tuple</span>.<span class="ruby-identifier">full_name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="ActivationRequest.html#method-i-to_s">to_s</a>
</div>
</div>
<div id="method-i-full_spec" class="method-detail ">
<div class="method-heading">
<span class="method-name">full_spec</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The <a href="../Specification.html"><code>Gem::Specification</code></a> for this activation request.</p>
<div class="method-source-code" id="full_spec-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_spec</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span> <span class="ruby-operator">===</span> <span class="ruby-ivar">@spec</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@spec</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-installed-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">installed?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>True if the requested gem has already been installed.</p>
<div class="method-source-code" id="installed-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">installed?</span>
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@spec</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Resolver</span><span class="ruby-operator">::</span><span class="ruby-constant">VendorSpecification</span> <span class="ruby-keyword">then</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">this_spec</span> = <span class="ruby-identifier">full_spec</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span>.<span class="ruby-identifier">any?</span> <span class="ruby-keyword">do</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-operator">==</span> <span class="ruby-identifier">this_spec</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-name" class="method-detail ">
<div class="method-heading">
<span class="method-name">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 of this activation request's specification</p>
<div class="method-source-code" id="name-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 113</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">name</span>
<span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parent" class="method-detail ">
<div class="method-heading">
<span class="method-name">parent</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the <a href="ActivationRequest.html"><code>ActivationRequest</code></a> that contained the dependency that we were activated for.</p>
<div class="method-source-code" id="parent-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 121</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parent</span>
<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">requester</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-platform" class="method-detail ">
<div class="method-heading">
<span class="method-name">platform</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The platform of this activation request's specification</p>
<div class="method-source-code" id="platform-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 146</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">platform</span>
<span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">platform</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="ActivationRequest.html#method-i-full_name">full_name</a>
</div>
</div>
<div id="method-i-version" class="method-detail ">
<div class="method-heading">
<span class="method-name">version</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The version of this activation request's specification</p>
<div class="method-source-code" id="version-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 139</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">version</span>
<span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">version</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-name_tuple" class="method-detail ">
<div class="method-heading">
<span class="method-name">name_tuple</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="name_tuple-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/activation_request.rb, line 152</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">name_tuple</span>
<span class="ruby-ivar">@name_tuple</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">NameTuple</span>.<span class="ruby-identifier">new</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>
</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>