File: C:/Ruby27-x64/share/doc/ruby/html/Gem/VersionOption.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Gem::VersionOption - 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="module">
<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">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-add_platform_option">#add_platform_option</a>
<li ><a href="#method-i-add_prerelease_option">#add_prerelease_option</a>
<li ><a href="#method-i-add_version_option">#add_version_option</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Gem::VersionOption">
<h1 id="module-Gem::VersionOption" class="module">
module Gem::VersionOption
</h1>
<section class="description">
<p>Mixin methods for –version and –platform <a href="Command.html"><code>Gem::Command</code></a> options.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-add_platform_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_platform_option</span><span
class="method-args">(task = command, *wrap)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add the –platform option to the option parser.</p>
<div class="method-source-code" id="add_platform_option-source">
<pre><span class="ruby-comment"># File lib/rubygems/version_option.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_platform_option</span>(<span class="ruby-identifier">task</span> = <span class="ruby-identifier">command</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">wrap</span>)
<span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">accept</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</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-identifier">value</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--platform PLATFORM'</span>, <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span>,
<span class="ruby-node">"Specify the platform of gem to #{task}"</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">wrap</span>) <span class="ruby-keyword">do</span>
<span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:added_platform</span>]
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">platforms</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-identifier">options</span>[<span class="ruby-value">:added_platform</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">platforms</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">value</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">platforms</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_prerelease_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_prerelease_option</span><span
class="method-args">(*wrap)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add the –prerelease option to the option parser.</p>
<div class="method-source-code" id="add_prerelease_option-source">
<pre><span class="ruby-comment"># File lib/rubygems/version_option.rb, line 42</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_prerelease_option</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">wrap</span>)
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">"--[no-]prerelease"</span>,
<span class="ruby-string">"Allow prerelease versions of a gem"</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">wrap</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:prerelease</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:explicit_prerelease</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_version_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_version_option</span><span
class="method-args">(task = command, *wrap)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add the –version option to the option parser.</p>
<div class="method-source-code" id="add_version_option-source">
<pre><span class="ruby-comment"># File lib/rubygems/version_option.rb, line 53</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_version_option</span>(<span class="ruby-identifier">task</span> = <span class="ruby-identifier">command</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">wrap</span>)
<span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">accept</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Requirement</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Requirement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">value</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\s*,\s*/</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'-v'</span>, <span class="ruby-string">'--version VERSION'</span>, <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Requirement</span>,
<span class="ruby-node">"Specify version of gem to #{task}"</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">wrap</span>) <span class="ruby-keyword">do</span>
<span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-comment"># Allow handling for multiple --version operators</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:version</span>] <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-value">:version</span>].<span class="ruby-identifier">none?</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:version</span>].<span class="ruby-identifier">concat</span>([<span class="ruby-identifier">value</span>])
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:version</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">explicit_prerelease_set</span> = <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-value">:explicit_prerelease</span>].<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:explicit_prerelease</span>] = <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">explicit_prerelease_set</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:prerelease</span>] = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">prerelease?</span> <span class="ruby-keyword">unless</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:explicit_prerelease</span>]
<span class="ruby-keyword">end</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>