File: C:/Ruby27-x64/share/doc/ruby/html/Gem/NameTuple.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::NameTuple - 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="../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-from_list">::from_list</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-null">::null</a>
<li ><a href="#method-c-to_basic">::to_basic</a>
<li ><a href="#method-i-3C-3D-3E">#<=></a>
<li ><a href="#method-i-3D-3D">#==</a>
<li ><a href="#method-i-eql-3F">#eql?</a>
<li ><a href="#method-i-full_name">#full_name</a>
<li ><a href="#method-i-hash">#hash</a>
<li ><a href="#method-i-match_platform-3F">#match_platform?</a>
<li ><a href="#method-i-prerelease-3F">#prerelease?</a>
<li ><a href="#method-i-spec_name">#spec_name</a>
<li ><a href="#method-i-to_a">#to_a</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::NameTuple">
<h1 id="class-Gem::NameTuple" class="class">
class Gem::NameTuple
</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-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-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-from_list" class="method-detail ">
<div class="method-heading">
<span class="method-name">from_list</span><span
class="method-args">(list)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Turn an array of [name, version, platform] into an array of <a href="NameTuple.html"><code>NameTuple</code></a> objects.</p>
<div class="method-source-code" id="from_list-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 28</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">from_list</span>(<span class="ruby-identifier">list</span>)
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">t</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">(name, version, platform="ruby")</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/rubygems/name_tuple.rb, line 11</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-string">"ruby"</span>)
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-ivar">@version</span> = <span class="ruby-identifier">version</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">platform</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span>
<span class="ruby-identifier">platform</span> = <span class="ruby-string">"ruby"</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">platform</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">platform</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@platform</span> = <span class="ruby-identifier">platform</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-null" class="method-detail ">
<div class="method-heading">
<span class="method-name">null</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A null <a href="NameTuple.html"><code>NameTuple</code></a>, ie name=nil, version=0</p>
<div class="method-source-code" id="null-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 43</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">null</span>
<span class="ruby-identifier">new</span> <span class="ruby-keyword">nil</span>, <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Version</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">0</span>), <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-to_basic" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_basic</span><span
class="method-args">(list)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Turn an array of <a href="NameTuple.html"><code>NameTuple</code></a> objects back into an array of</p>
<dl class="rdoc-list label-list"><dt>name, version, platform
<dd>
<p>tuples.</p>
</dd></dl>
<div class="method-source-code" id="to_basic-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">to_basic</span>(<span class="ruby-identifier">list</span>)
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">to_a</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">
<div class="method-source-code" id="3C-3D-3E-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 94</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span>(<span class="ruby-identifier">other</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-operator"><=></span>
[<span class="ruby-identifier">other</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">version</span>,
<span class="ruby-identifier">other</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-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-3D-3D" 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 with <code>other</code>. Supports another <a href="NameTuple.html"><code>NameTuple</code></a> or an <a href="../Array.html"><code>Array</code></a> in the [name, version, platform] format.</p>
<div class="method-source-code" id="3D-3D-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">other</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>
<span class="ruby-ivar">@name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">name</span> <span class="ruby-keyword">and</span>
<span class="ruby-ivar">@version</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">version</span> <span class="ruby-keyword">and</span>
<span class="ruby-ivar">@platform</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">platform</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
<span class="ruby-identifier">to_a</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="NameTuple.html#method-i-eql-3F">eql?</a>
</div>
</div>
<div id="method-i-eql-3F" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">eql?</span><span
class="method-args">(other)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="NameTuple.html#method-i-3D-3D">==</a>
</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>Returns the full name (name-version) of this Gem. Platform information is included if it is not the default Ruby platform. This mimics the behavior of <a href="Specification.html#method-i-full_name"><code>Gem::Specification#full_name</code></a>.</p>
<div class="method-source-code" id="full_name-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 52</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_name</span>
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@platform</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span>, <span class="ruby-string">'ruby'</span>, <span class="ruby-string">''</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-identifier">dup</span>.<span class="ruby-identifier">tap</span>(<span class="ruby-operator">&</span><span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">UNTAINT</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-hash" class="method-detail ">
<div class="method-heading">
<span class="method-name">hash</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="hash-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 121</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">hash</span>
<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">hash</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-match_platform-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">match_platform?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Indicate if this <a href="NameTuple.html"><code>NameTuple</code></a> matches the current platform.</p>
<div class="method-source-code" id="match_platform-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">match_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-ivar">@platform</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-prerelease-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">prerelease?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Indicate if this <a href="NameTuple.html"><code>NameTuple</code></a> is for a prerelease version.</p>
<div class="method-source-code" id="prerelease-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prerelease?</span>
<span class="ruby-ivar">@version</span>.<span class="ruby-identifier">prerelease?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-spec_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">spec_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the name that the gemspec file would be</p>
<div class="method-source-code" id="spec_name-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spec_name</span>
<span class="ruby-node">"#{full_name}.gemspec"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_a" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_a</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert back to the [name, version, platform] tuple</p>
<div class="method-source-code" id="to_a-source">
<pre><span class="ruby-comment"># File lib/rubygems/name_tuple.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_a</span>
[<span class="ruby-ivar">@name</span>, <span class="ruby-ivar">@version</span>, <span class="ruby-ivar">@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>