File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Doctor.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Doctor - 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="UserInteraction.html">Gem::UserInteraction</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-new">::new</a>
<li ><a href="#method-i-doctor">#doctor</a>
<li ><a href="#method-i-gem_repository-3F">#gem_repository?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Doctor">
<h1 id="class-Gem::Doctor" class="class">
class Gem::Doctor
</h1>
<section class="description">
<p>Cleans up after a partially-failed uninstall or for an invalid <a href="Specification.html"><code>Gem::Specification</code></a>.</p>
<p>If a specification was removed by hand this will remove any remaining files.</p>
<p>If a corrupt specification was installed this will clean up warnings by removing the bogus specification.</p>
</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">(gem_repository, dry_run = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="Doctor.html"><code>Gem::Doctor</code></a> that will clean up <code>gem_repository</code>. Only one gem repository may be cleaned at a time.</p>
<p>If <code>dry_run</code> is true no files or directories will be removed.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/doctor.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">gem_repository</span>, <span class="ruby-identifier">dry_run</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-ivar">@gem_repository</span> = <span class="ruby-identifier">gem_repository</span>
<span class="ruby-ivar">@dry_run</span> = <span class="ruby-identifier">dry_run</span>
<span class="ruby-ivar">@installed_specs</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-doctor" class="method-detail ">
<div class="method-heading">
<span class="method-name">doctor</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Cleans up uninstalled files and invalid gem specifications</p>
<div class="method-source-code" id="doctor-source">
<pre><span class="ruby-comment"># File lib/rubygems/doctor.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">doctor</span>
<span class="ruby-ivar">@orig_home</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">dir</span>
<span class="ruby-ivar">@orig_path</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">path</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Checking #{@gem_repository}"</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">use_paths</span> <span class="ruby-ivar">@gem_repository</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">gem_repository?</span>
<span class="ruby-identifier">say</span> <span class="ruby-string">'This directory does not appear to be a RubyGems repository, '</span> <span class="ruby-operator">+</span>
<span class="ruby-string">'skipping'</span>
<span class="ruby-identifier">say</span>
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">doctor_children</span>
<span class="ruby-identifier">say</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">use_paths</span> <span class="ruby-ivar">@orig_home</span>, <span class="ruby-operator">*</span><span class="ruby-ivar">@orig_path</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_repository-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_repository?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Are we doctoring a gem repository?</p>
<div class="method-source-code" id="gem_repository-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/doctor.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_repository?</span>
<span class="ruby-keyword">not</span> <span class="ruby-identifier">installed_specs</span>.<span class="ruby-identifier">empty?</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>