File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Commands/PristineCommand.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Commands::PristineCommand - 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="../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>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Commands::PristineCommand">
<h1 id="class-Gem::Commands::PristineCommand" class="class">
class Gem::Commands::PristineCommand
</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/pristine_command.rb, line 11</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">'pristine'</span>,
<span class="ruby-string">'Restores installed gems to pristine condition from files located in the gem cache'</span>,
<span class="ruby-value">:version</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">default</span>,
<span class="ruby-value">:extensions</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>,
<span class="ruby-value">:extensions_set</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>,
<span class="ruby-value">:all</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--all'</span>,
<span class="ruby-string">'Restore all installed gems to pristine'</span>,
<span class="ruby-string">'condition'</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">:all</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--skip=gem_name'</span>,
<span class="ruby-string">'used on --all, skip if name == gem_name'</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">:skip</span>] <span class="ruby-operator">||=</span> []
<span class="ruby-identifier">options</span>[<span class="ruby-value">:skip</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--[no-]extensions'</span>,
<span class="ruby-string">'Restore gems with extensions'</span>,
<span class="ruby-string">'in addition to regular gems'</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">:extensions_set</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:extensions</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--only-executables'</span>,
<span class="ruby-string">'Only restore executables'</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">:only_executables</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'-E'</span>, <span class="ruby-string">'--[no-]env-shebang'</span>,
<span class="ruby-string">'Rewrite executables with a shebang'</span>,
<span class="ruby-string">'of /usr/bin/env'</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">:env_shebang</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'-n'</span>, <span class="ruby-string">'--bindir DIR'</span>,
<span class="ruby-string">'Directory where executables are'</span>,
<span class="ruby-string">'located'</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">:bin_dir</span>] = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_version_option</span>(<span class="ruby-string">'restore to'</span>, <span class="ruby-string">'pristine condition'</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/pristine_command.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execute</span>
<span class="ruby-identifier">specs</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:all</span>]
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span>.<span class="ruby-identifier">map</span>
<span class="ruby-comment"># `--extensions` must be explicitly given to pristine only gems</span>
<span class="ruby-comment"># with extensions.</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:extensions_set</span>] <span class="ruby-keyword">and</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:extensions</span>] <span class="ruby-keyword">and</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:args</span>].<span class="ruby-identifier">empty?</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span>.<span class="ruby-identifier">select</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-identifier">spec</span>.<span class="ruby-identifier">extensions</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">extensions</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">get_all_gem_names</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">gem_name</span><span class="ruby-operator">|</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-identifier">gem_name</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:version</span>]).<span class="ruby-identifier">reverse</span>
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">flatten</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">specs</span> = <span class="ruby-identifier">specs</span>.<span class="ruby-identifier">select</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">spec</span><span class="ruby-operator">|</span> <span class="ruby-constant">RUBY_ENGINE</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">spec</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-identifier">local</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">platform</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">spec</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-keyword">if</span> <span class="ruby-identifier">specs</span>.<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Exception</span>,
<span class="ruby-node">"Failed to find gems #{options[:args]} #{options[:version]}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">say</span> <span class="ruby-string">"Restoring gems to pristine condition..."</span>
<span class="ruby-identifier">specs</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-keyword">if</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">default_gem?</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Skipped #{spec.full_name}, it is a default gem"</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-value">:skip</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:skip</span>].<span class="ruby-identifier">include?</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">name</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Skipped #{spec.full_name}, it was given through options"</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">extensions</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:extensions</span>] <span class="ruby-keyword">or</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:only_executables</span>]
<span class="ruby-identifier">say</span> <span class="ruby-node">"Skipped #{spec.full_name}, it needs to compile an extension"</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">gem</span> = <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">cache_file</span>
<span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-identifier">gem</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:only_executables</span>]
<span class="ruby-identifier">require</span> <span class="ruby-string">'rubygems/remote_fetcher'</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Cached gem for #{spec.full_name} not found, attempting to fetch..."</span>
<span class="ruby-identifier">dep</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Dependency</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">version</span>
<span class="ruby-identifier">found</span>, <span class="ruby-identifier">_</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">SpecFetcher</span>.<span class="ruby-identifier">fetcher</span>.<span class="ruby-identifier">spec_for_dependency</span> <span class="ruby-identifier">dep</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">found</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Skipped #{spec.full_name}, it was not found from cache and remote sources"</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">spec_candidate</span>, <span class="ruby-identifier">source</span> = <span class="ruby-identifier">found</span>.<span class="ruby-identifier">first</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">RemoteFetcher</span>.<span class="ruby-identifier">fetcher</span>.<span class="ruby-identifier">download</span> <span class="ruby-identifier">spec_candidate</span>, <span class="ruby-identifier">source</span>.<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">base_dir</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">env_shebang</span> =
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">include?</span> <span class="ruby-value">:env_shebang</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:env_shebang</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">install_defaults</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">ConfigFile</span><span class="ruby-operator">::</span><span class="ruby-constant">PLATFORM_DEFAULTS</span>[<span class="ruby-string">'install'</span>]
<span class="ruby-identifier">install_defaults</span>.<span class="ruby-identifier">to_s</span>[<span class="ruby-string">'--env-shebang'</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">bin_dir</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:bin_dir</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:bin_dir</span>]
<span class="ruby-identifier">installer_options</span> = {
<span class="ruby-value">:wrappers</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>,
<span class="ruby-value">:force</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>,
<span class="ruby-value">:install_dir</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">base_dir</span>,
<span class="ruby-value">:env_shebang</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">env_shebang</span>,
<span class="ruby-value">:build_args</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">build_args</span>,
<span class="ruby-value">:bin_dir</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">bin_dir</span>
}
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:only_executables</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">for_spec</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">installer_options</span>)
<span class="ruby-identifier">installer</span>.<span class="ruby-identifier">generate_bin</span>
<span class="ruby-keyword">else</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">installer_options</span>)
<span class="ruby-identifier">installer</span>.<span class="ruby-identifier">install</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Restored #{spec.full_name}"</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>