File: C:/Ruby27-x64/share/doc/ruby/html/Gem/PathSupport.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::PathSupport - 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>
<!-- 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-default_path">#default_path</a>
<li ><a href="#method-i-expand">#expand</a>
<li ><a href="#method-i-split_gem_path">#split_gem_path</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::PathSupport">
<h1 id="class-Gem::PathSupport" class="class">
class Gem::PathSupport
</h1>
<section class="description">
<p><a href="PathSupport.html"><code>Gem::PathSupport</code></a> facilitates the GEM_HOME and GEM_PATH environment settings to the rest of RubyGems.</p>
</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-home" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">home</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The default system path for managing Gems.</p>
</div>
</div>
<div id="attribute-i-path" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">path</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p><a href="../Array.html"><code>Array</code></a> of paths to search for Gems.</p>
</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(env)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Constructor. Takes a single argument which is to be treated like a hashtable, or defaults to <a href="../ENV.html"><code>ENV</code></a>, the system environment.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/path_support.rb, line 26</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-ivar">@home</span> = <span class="ruby-identifier">env</span>[<span class="ruby-string">"GEM_HOME"</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">default_dir</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">ALT_SEPARATOR</span>
<span class="ruby-ivar">@home</span> = <span class="ruby-ivar">@home</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">ALT_SEPARATOR</span>, <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@home</span> = <span class="ruby-identifier">expand</span>(<span class="ruby-ivar">@home</span>)
<span class="ruby-ivar">@path</span> = <span class="ruby-identifier">split_gem_path</span> <span class="ruby-identifier">env</span>[<span class="ruby-string">"GEM_PATH"</span>], <span class="ruby-ivar">@home</span>
<span class="ruby-ivar">@spec_cache_dir</span> = <span class="ruby-identifier">env</span>[<span class="ruby-string">"GEM_SPEC_CACHE"</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">default_spec_cache_dir</span>
<span class="ruby-ivar">@spec_cache_dir</span> = <span class="ruby-ivar">@spec_cache_dir</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>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-default_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">default_path</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the default Gem path</p>
<div class="method-source-code" id="default_path-source">
<pre><span class="ruby-comment"># File lib/rubygems/path_support.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_path</span>
<span class="ruby-identifier">gem_path</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">default_path</span> <span class="ruby-operator">+</span> [<span class="ruby-ivar">@home</span>]
<span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">APPLE_GEM_HOME</span>)
<span class="ruby-identifier">gem_path</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">APPLE_GEM_HOME</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">gem_path</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-expand" class="method-detail ">
<div class="method-heading">
<span class="method-name">expand</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="expand-source">
<pre><span class="ruby-comment"># File lib/rubygems/path_support.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">expand</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-constant">File</span>.<span class="ruby-identifier">realpath</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">path</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-split_gem_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">split_gem_path</span><span
class="method-args">(gpaths, home)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Split the Gem search path (as reported by <a href="../Gem.html#method-c-path"><code>Gem.path</code></a>).</p>
<div class="method-source-code" id="split_gem_path-source">
<pre><span class="ruby-comment"># File lib/rubygems/path_support.rb, line 47</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">split_gem_path</span>(<span class="ruby-identifier">gpaths</span>, <span class="ruby-identifier">home</span>)
<span class="ruby-comment"># FIX: it should be [home, *path], not [*path, home]</span>
<span class="ruby-identifier">gem_path</span> = []
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gpaths</span>
<span class="ruby-identifier">gem_path</span> = <span class="ruby-identifier">gpaths</span>.<span class="ruby-identifier">split</span>(<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">path_separator</span>)
<span class="ruby-comment"># Handle the path_separator being set to a regexp, which will cause</span>
<span class="ruby-comment"># end_with? to error</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gpaths</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/#{Gem.path_separator}\z/</span>
<span class="ruby-identifier">gem_path</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">default_path</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">ALT_SEPARATOR</span>
<span class="ruby-identifier">gem_path</span>.<span class="ruby-identifier">map!</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">this_path</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">this_path</span>.<span class="ruby-identifier">gsub</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">ALT_SEPARATOR</span>, <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">gem_path</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">home</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">gem_path</span> = <span class="ruby-identifier">default_path</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">gem_path</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span> <span class="ruby-identifier">expand</span>(<span class="ruby-identifier">path</span>) }.<span class="ruby-identifier">uniq</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>