File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Commands/UpdateCommand.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Commands::UpdateCommand - 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="../Command.html">Gem::Command</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../InstallUpdateOptions.html">Gem::InstallUpdateOptions</a>
<li><a class="include" href="../LocalRemoteOptions.html">Gem::LocalRemoteOptions</a>
<li><a class="include" href="../VersionOption.html">Gem::VersionOption</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-execute">#execute</a>
<li ><a href="#method-i-rubygems_target_version">#rubygems_target_version</a>
<li ><a href="#method-i-update_gem">#update_gem</a>
<li ><a href="#method-i-update_gems">#update_gems</a>
<li ><a href="#method-i-update_rubygems">#update_rubygems</a>
<li ><a href="#method-i-which_to_update">#which_to_update</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Commands::UpdateCommand">
<h1 id="class-Gem::Commands::UpdateCommand" class="class">
class Gem::Commands::UpdateCommand
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-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">
<div class="method-calls-super">
Calls superclass method
<a href="../Command.html#method-c-new"><code>Gem::Command::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/update_command.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-keyword">super</span> <span class="ruby-string">'update'</span>, <span class="ruby-string">'Update installed gems to the latest version'</span>,
<span class="ruby-value">:document</span> <span class="ruby-operator">=></span> <span class="ruby-node">%w[rdoc ri]</span>,
<span class="ruby-value">:force</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">add_install_update_options</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">Version</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">Version</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">value</span>
<span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--system [VERSION]'</span>, <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Version</span>,
<span class="ruby-string">'Update the RubyGems system software'</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">value</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">value</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:system</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_local_remote_options</span>
<span class="ruby-identifier">add_platform_option</span>
<span class="ruby-identifier">add_prerelease_option</span> <span class="ruby-string">"as update targets"</span>
<span class="ruby-ivar">@updated</span> = []
<span class="ruby-ivar">@installer</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-execute" class="method-detail ">
<div class="method-heading">
<span class="method-name">execute</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="execute-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/update_command.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execute</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:system</span>]
<span class="ruby-identifier">update_rubygems</span>
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">hig</span> = <span class="ruby-identifier">highest_installed_gems</span>
<span class="ruby-identifier">gems_to_update</span> = <span class="ruby-identifier">which_to_update</span> <span class="ruby-identifier">hig</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:args</span>].<span class="ruby-identifier">uniq</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:explain</span>]
<span class="ruby-identifier">say</span> <span class="ruby-string">"Gems to update:"</span>
<span class="ruby-identifier">gems_to_update</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name_tuple</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">" #{name_tuple.full_name}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">say</span> <span class="ruby-string">"Updating installed gems"</span>
<span class="ruby-identifier">updated</span> = <span class="ruby-identifier">update_gems</span> <span class="ruby-identifier">gems_to_update</span>
<span class="ruby-identifier">updated_names</span> = <span class="ruby-identifier">updated</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">spec</span><span class="ruby-operator">|</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">name</span> }
<span class="ruby-identifier">not_updated_names</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:args</span>].<span class="ruby-identifier">uniq</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">updated_names</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">updated</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">say</span> <span class="ruby-string">"Nothing to update"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Gems updated: #{updated_names.join(' ')}"</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Gems already up-to-date: #{not_updated_names.join(' ')}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">not_updated_names</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rubygems_target_version" class="method-detail ">
<div class="method-heading">
<span class="method-name">rubygems_target_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="rubygems_target_version-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/update_command.rb, line 176</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rubygems_target_version</span>
<span class="ruby-identifier">version</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:system</span>]
<span class="ruby-identifier">update_latest</span> = <span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">update_latest</span>
<span class="ruby-identifier">version</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-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
<span class="ruby-identifier">requirement</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-node">">= #{Gem::VERSION}"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">version</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-identifier">version</span>
<span class="ruby-identifier">requirement</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-identifier">version</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">rubygems_update</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">rubygems_update</span>.<span class="ruby-identifier">name</span> = <span class="ruby-string">'rubygems-update'</span>
<span class="ruby-identifier">rubygems_update</span>.<span class="ruby-identifier">version</span> = <span class="ruby-identifier">version</span>
<span class="ruby-identifier">hig</span> = {
<span class="ruby-string">'rubygems-update'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">rubygems_update</span>
}
<span class="ruby-identifier">gems_to_update</span> = <span class="ruby-identifier">which_to_update</span> <span class="ruby-identifier">hig</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:args</span>], <span class="ruby-value">:system</span>
<span class="ruby-identifier">up_ver</span> = <span class="ruby-identifier">gems_to_update</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">version</span>
<span class="ruby-identifier">target</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">update_latest</span>
<span class="ruby-identifier">up_ver</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">version</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">target</span>, <span class="ruby-identifier">requirement</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-update_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">update_gem</span><span
class="method-args">(name, version = Gem::Requirement.default)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="update_gem-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/update_command.rb, line 208</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_gem</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Requirement</span>.<span class="ruby-identifier">default</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@updated</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">spec</span><span class="ruby-operator">|</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span> }
<span class="ruby-identifier">update_options</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">update_options</span>[<span class="ruby-value">:prerelease</span>] = <span class="ruby-identifier">version</span>.<span class="ruby-identifier">prerelease?</span>
<span class="ruby-ivar">@installer</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">DependencyInstaller</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">update_options</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Updating #{name}"</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@installer</span>.<span class="ruby-identifier">install</span> <span class="ruby-identifier">name</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-identifier">version</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">InstallError</span>, <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">DependencyError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">alert_error</span> <span class="ruby-node">"Error installing #{name}:\n\t#{e.message}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@installer</span>.<span class="ruby-identifier">installed_gems</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">spec</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@updated</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-update_gems" class="method-detail ">
<div class="method-heading">
<span class="method-name">update_gems</span><span
class="method-args">(gems_to_update)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="update_gems-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/update_command.rb, line 228</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_gems</span>(<span class="ruby-identifier">gems_to_update</span>)
<span class="ruby-identifier">gems_to_update</span>.<span class="ruby-identifier">uniq</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name_tuple</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">update_gem</span> <span class="ruby-identifier">name_tuple</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">name_tuple</span>.<span class="ruby-identifier">version</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@updated</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-update_rubygems" class="method-detail ">
<div class="method-heading">
<span class="method-name">update_rubygems</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Update RubyGems software to the latest version.</p>
<div class="method-source-code" id="update_rubygems-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/update_command.rb, line 239</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_rubygems</span>
<span class="ruby-identifier">check_update_arguments</span>
<span class="ruby-identifier">version</span>, <span class="ruby-identifier">requirement</span> = <span class="ruby-identifier">rubygems_target_version</span>
<span class="ruby-identifier">check_latest_rubygems</span> <span class="ruby-identifier">version</span>
<span class="ruby-identifier">update_gem</span> <span class="ruby-string">'rubygems-update'</span>, <span class="ruby-identifier">version</span>
<span class="ruby-identifier">installed_gems</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span>.<span class="ruby-identifier">find_all_by_name</span> <span class="ruby-string">'rubygems-update'</span>, <span class="ruby-identifier">requirement</span>
<span class="ruby-identifier">version</span> = <span class="ruby-identifier">installed_gems</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">version</span>
<span class="ruby-identifier">install_rubygems</span> <span class="ruby-identifier">version</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-which_to_update" class="method-detail ">
<div class="method-heading">
<span class="method-name">which_to_update</span><span
class="method-args">(highest_installed_gems, gem_names, system = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="which_to_update-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/update_command.rb, line 265</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">which_to_update</span>(<span class="ruby-identifier">highest_installed_gems</span>, <span class="ruby-identifier">gem_names</span>, <span class="ruby-identifier">system</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">result</span> = []
<span class="ruby-identifier">highest_installed_gems</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">l_name</span>, <span class="ruby-identifier">l_spec</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">gem_names</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">and</span>
<span class="ruby-identifier">gem_names</span>.<span class="ruby-identifier">none?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">l_spec</span>.<span class="ruby-identifier">name</span> }
<span class="ruby-identifier">highest_remote_tup</span> = <span class="ruby-identifier">highest_remote_name_tuple</span> <span class="ruby-identifier">l_spec</span>
<span class="ruby-identifier">highest_remote_ver</span> = <span class="ruby-identifier">highest_remote_tup</span>.<span class="ruby-identifier">version</span>
<span class="ruby-identifier">highest_installed_ver</span> = <span class="ruby-identifier">l_spec</span>.<span class="ruby-identifier">version</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">system</span> <span class="ruby-keyword">or</span> (<span class="ruby-identifier">highest_installed_ver</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">highest_remote_ver</span>)
<span class="ruby-identifier">result</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">l_spec</span>.<span class="ruby-identifier">name</span>, [<span class="ruby-identifier">highest_installed_ver</span>, <span class="ruby-identifier">highest_remote_ver</span>].<span class="ruby-identifier">max</span>, <span class="ruby-identifier">highest_remote_tup</span>.<span class="ruby-identifier">platform</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">result</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>