File: C:/Ruby27-x64/share/doc/ruby/html/Gem/BasicSpecification.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::BasicSpecification - 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="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="Deprecate.html">Gem::Deprecate</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-default_specifications_dir">::default_specifications_dir</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-activated-3F">#activated?</a>
<li ><a href="#method-i-base_dir">#base_dir</a>
<li ><a href="#method-i-contains_requirable_file-3F">#contains_requirable_file?</a>
<li ><a href="#method-i-datadir">#datadir</a>
<li ><a href="#method-i-default_gem-3F">#default_gem?</a>
<li ><a href="#method-i-extension_dir">#extension_dir</a>
<li ><a href="#method-i-extensions_dir">#extensions_dir</a>
<li ><a href="#method-i-full_gem_path">#full_gem_path</a>
<li ><a href="#method-i-full_name">#full_name</a>
<li ><a href="#method-i-full_require_paths">#full_require_paths</a>
<li ><a href="#method-i-gem_dir">#gem_dir</a>
<li ><a href="#method-i-gems_dir">#gems_dir</a>
<li ><a href="#method-i-have_extensions-3F">#have_extensions?</a>
<li ><a href="#method-i-have_file-3F">#have_file?</a>
<li ><a href="#method-i-lib_dirs_glob">#lib_dirs_glob</a>
<li ><a href="#method-i-matches_for_glob">#matches_for_glob</a>
<li ><a href="#method-i-name">#name</a>
<li ><a href="#method-i-platform">#platform</a>
<li ><a href="#method-i-require_paths">#require_paths</a>
<li ><a href="#method-i-source_paths">#source_paths</a>
<li ><a href="#method-i-stubbed-3F">#stubbed?</a>
<li ><a href="#method-i-this">#this</a>
<li ><a href="#method-i-to_fullpath">#to_fullpath</a>
<li ><a href="#method-i-to_spec">#to_spec</a>
<li ><a href="#method-i-version">#version</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::BasicSpecification">
<h1 id="class-Gem::BasicSpecification" class="class">
class Gem::BasicSpecification
</h1>
<section class="description">
<p><a href="BasicSpecification.html"><code>BasicSpecification</code></a> is an abstract class which implements some common code used by both Specification and StubSpecification.</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-loaded_from" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">loaded_from</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The path this gemspec was loaded from. This attribute is not persisted.</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-default_specifications_dir" class="method-detail ">
<div class="method-heading">
<span class="method-name">default_specifications_dir</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="default_specifications_dir-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">default_specifications_dir</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">default_specifications_dir</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<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-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 33</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-identifier">internal_init</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-activated-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">activated?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>True when the gem has been activated</p>
<div class="method-source-code" id="activated-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 59</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">activated?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-base_dir" class="method-detail ">
<div class="method-heading">
<span class="method-name">base_dir</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the full path to the base gem directory.</p>
<p>eg: /usr/local/lib/ruby/gems/1.8</p>
<div class="method-source-code" id="base_dir-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">base_dir</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-contains_requirable_file-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">contains_requirable_file?</span><span
class="method-args">(file)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return true if this spec can require <code>file</code>.</p>
<div class="method-source-code" id="contains_requirable_file-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">contains_requirable_file?</span>(<span class="ruby-identifier">file</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@ignored</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">missing_extensions?</span>
<span class="ruby-ivar">@ignored</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">if</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-operator">==</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">platform</span>
<span class="ruby-identifier">warn</span> <span class="ruby-node">"Ignoring #{full_name} because its extensions are not built. "</span> <span class="ruby-operator">+</span>
<span class="ruby-node">"Try: gem pristine #{name} --version #{version}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">have_file?</span> <span class="ruby-identifier">file</span>, <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">suffixes</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-datadir" class="method-detail ">
<div class="method-heading">
<span class="method-name">datadir</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The path to the data directory for this gem.</p>
<div class="method-source-code" id="datadir-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 164</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">datadir</span>
<span class="ruby-comment"># TODO: drop the extra ", gem_name" which is uselessly redundant</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">gems_dir</span>, <span class="ruby-identifier">full_name</span>, <span class="ruby-string">"data"</span>, <span class="ruby-identifier">name</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>
<div id="method-i-default_gem-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">default_gem?</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="default_gem-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_gem?</span>
<span class="ruby-identifier">loaded_from</span> <span class="ruby-operator">&&</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">loaded_from</span>) <span class="ruby-operator">==</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">default_specifications_dir</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-extension_dir" class="method-detail ">
<div class="method-heading">
<span class="method-name">extension_dir</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns full path to the directory where gem's extensions are installed.</p>
<div class="method-source-code" id="extension_dir-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 100</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">extension_dir</span>
<span class="ruby-ivar">@extension_dir</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">extensions_dir</span>, <span class="ruby-identifier">full_name</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>
<div id="method-i-extensions_dir" class="method-detail ">
<div class="method-heading">
<span class="method-name">extensions_dir</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns path to the extensions directory.</p>
<div class="method-source-code" id="extensions_dir-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">extensions_dir</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">default_ext_dir_for</span>(<span class="ruby-identifier">base_dir</span>) <span class="ruby-operator">||</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">base_dir</span>, <span class="ruby-string">'extensions'</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-identifier">to_s</span>,
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">extension_api_version</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-full_gem_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">full_gem_path</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The full path to the gem (install path + full name).</p>
<div class="method-source-code" id="full_gem_path-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 125</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_gem_path</span>
<span class="ruby-comment"># TODO: This is a heavily used method by gems, so we'll need</span>
<span class="ruby-comment"># to aleast just alias it to #gem_dir rather than remove it.</span>
<span class="ruby-ivar">@full_gem_path</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">find_full_gem_path</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-full_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">full_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the full name (name-version) of this Gem. Platform information is included (name-version-platform) if it is specified and not the default Ruby platform.</p>
<div class="method-source-code" id="full_name-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 136</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_name</span>
<span class="ruby-keyword">if</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">or</span> <span class="ruby-identifier">platform</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-node">"#{name}-#{version}"</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">else</span>
<span class="ruby-node">"#{name}-#{version}-#{platform}"</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>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-full_require_paths" class="method-detail ">
<div class="method-heading">
<span class="method-name">full_require_paths</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Full paths in the gem to add to <code>$LOAD_PATH</code> when this gem is activated.</p>
<div class="method-source-code" id="full_require_paths-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 148</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_require_paths</span>
<span class="ruby-ivar">@full_require_paths</span> <span class="ruby-operator">||=</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">full_paths</span> = <span class="ruby-identifier">raw_require_paths</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-identifier">full_gem_path</span>, <span class="ruby-identifier">path</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>
<span class="ruby-identifier">full_paths</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">extension_dir</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">have_extensions?</span>
<span class="ruby-identifier">full_paths</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_dir" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_dir</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the full path to this spec's gem directory. eg: /usr/local/lib/ruby/1.8/gems/mygem-1.0</p>
<div class="method-source-code" id="gem_dir-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 195</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_dir</span>
<span class="ruby-ivar">@gem_dir</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">gems_dir</span>, <span class="ruby-identifier">full_name</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gems_dir" class="method-detail ">
<div class="method-heading">
<span class="method-name">gems_dir</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the full path to the gems directory containing this spec's gem directory. eg: /usr/local/lib/ruby/1.8/gems</p>
<div class="method-source-code" id="gems_dir-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 203</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gems_dir</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-lib_dirs_glob" class="method-detail ">
<div class="method-heading">
<span class="method-name">lib_dirs_glob</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a string usable in <a href="../Dir.html#method-c-glob"><code>Dir.glob</code></a> to match all requirable paths for this spec.</p>
<div class="method-source-code" id="lib_dirs_glob-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 287</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">lib_dirs_glob</span>
<span class="ruby-identifier">dirs</span> = <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">raw_require_paths</span>
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">raw_require_paths</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
<span class="ruby-node">"{#{self.raw_require_paths.join(',')}}"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">raw_require_paths</span>.<span class="ruby-identifier">first</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-string">"lib"</span> <span class="ruby-comment"># default value for require_paths for bundler/inline</span>
<span class="ruby-keyword">end</span>
<span class="ruby-node">"#{self.full_gem_path}/#{dirs}"</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>
<div id="method-i-matches_for_glob" class="method-detail ">
<div class="method-heading">
<span class="method-name">matches_for_glob</span><span
class="method-args">(glob)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return all files in this gem that match for <code>glob</code>.</p>
<div class="method-source-code" id="matches_for_glob-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 276</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">matches_for_glob</span>(<span class="ruby-identifier">glob</span>) <span class="ruby-comment"># TODO: rename?</span>
<span class="ruby-comment"># TODO: do we need these?? Kill it</span>
<span class="ruby-identifier">glob</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">lib_dirs_glob</span>, <span class="ruby-identifier">glob</span>)
<span class="ruby-constant">Dir</span>[<span class="ruby-identifier">glob</span>].<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</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-comment"># FIX our tests are broken, run w/ SAFE=1</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-name" class="method-detail ">
<div class="method-heading">
<span class="method-name">name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Name of the gem</p>
<div class="method-source-code" id="name-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 217</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">name</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-platform" class="method-detail ">
<div class="method-heading">
<span class="method-name">platform</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Platform of the gem</p>
<div class="method-source-code" id="platform-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 224</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">platform</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-require_paths" class="method-detail ">
<div class="method-heading">
<span class="method-name">require_paths</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Paths in the gem to add to <code>$LOAD_PATH</code> when this gem is activated.</p>
<p>See also require_paths=</p>
<p>If you have an extension you do not need to add <code>"ext"</code> to the require path, the extension build process will copy the extension files into “lib” for you.</p>
<p>The default value is <code>"lib"</code></p>
<p>Usage:</p>
<pre class="ruby"><span class="ruby-comment"># If all library files are in the root directory...</span>
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">require_path</span> = <span class="ruby-string">'.'</span>
</pre>
<div class="method-source-code" id="require_paths-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 249</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">require_paths</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">raw_require_paths</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">have_extensions?</span>
[<span class="ruby-identifier">extension_dir</span>].<span class="ruby-identifier">concat</span> <span class="ruby-identifier">raw_require_paths</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-source_paths" class="method-detail ">
<div class="method-heading">
<span class="method-name">source_paths</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the paths to the source files for use with analysis and documentation tools. These paths are relative to full_gem_path.</p>
<div class="method-source-code" id="source_paths-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 259</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">source_paths</span>
<span class="ruby-identifier">paths</span> = <span class="ruby-identifier">raw_require_paths</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">have_extensions?</span>
<span class="ruby-identifier">ext_dirs</span> = <span class="ruby-identifier">extensions</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">extension</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">extension</span>.<span class="ruby-identifier">split</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>, <span class="ruby-value">2</span>).<span class="ruby-identifier">first</span>
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">uniq</span>
<span class="ruby-identifier">paths</span>.<span class="ruby-identifier">concat</span> <span class="ruby-identifier">ext_dirs</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">paths</span>.<span class="ruby-identifier">uniq</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-stubbed-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">stubbed?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Whether this specification is stubbed - i.e. we have information about the gem from a stub line, without having to evaluate the entire gemspec file.</p>
<div class="method-source-code" id="stubbed-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 319</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stubbed?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-this" class="method-detail ">
<div class="method-heading">
<span class="method-name">this</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="this-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 323</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">this</span>; <span class="ruby-keyword">self</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_fullpath" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_fullpath</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Full path of the target library file. If the file is not in this gem, return nil.</p>
<div class="method-source-code" id="to_fullpath-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 173</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_fullpath</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">activated?</span>
<span class="ruby-ivar">@paths_map</span> <span class="ruby-operator">||=</span> {}
<span class="ruby-ivar">@paths_map</span>[<span class="ruby-identifier">path</span>] <span class="ruby-operator">||=</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">fullpath</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">suffixes</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">suffixes</span>
<span class="ruby-identifier">suffixes</span>.<span class="ruby-identifier">find</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">suf</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">full_require_paths</span>.<span class="ruby-identifier">find</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dir</span><span class="ruby-operator">|</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">fullpath</span> = <span class="ruby-node">"#{dir}/#{path}#{suf}"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">fullpath</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_spec" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_spec</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return a <a href="Specification.html"><code>Gem::Specification</code></a> from this gem</p>
<div class="method-source-code" id="to_spec-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 304</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_spec</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-version" class="method-detail ">
<div class="method-heading">
<span class="method-name">version</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Version of the gem</p>
<div class="method-source-code" id="version-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 311</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">version</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</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-have_extensions-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">have_extensions?</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="have_extensions-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 327</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">have_extensions?</span>; <span class="ruby-operator">!</span><span class="ruby-identifier">extensions</span>.<span class="ruby-identifier">empty?</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-have_file-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">have_file?</span><span
class="method-args">(file, suffixes)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="have_file-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/basic_specification.rb, line 329</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">have_file?</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">suffixes</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_require_paths</span>.<span class="ruby-identifier">any?</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">base</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">gems_dir</span>, <span class="ruby-identifier">full_name</span>, <span class="ruby-identifier">path</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-identifier">file</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-identifier">suffixes</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">suf</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span> <span class="ruby-identifier">base</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">suf</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">have_extensions?</span>
<span class="ruby-identifier">base</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-identifier">extension_dir</span>, <span class="ruby-identifier">file</span>
<span class="ruby-identifier">suffixes</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">suf</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span> <span class="ruby-identifier">base</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">suf</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">false</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>