File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/StubSpecification.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::StubSpecification - 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="RemoteSpecification.html">Bundler::RemoteSpecification</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-from_stub">::from_stub</a>
<li ><a href="#method-i-_remote_specification">#_remote_specification</a>
<li ><a href="#method-i-activated">#activated</a>
<li ><a href="#method-i-activated-3D">#activated=</a>
<li ><a href="#method-i-default_gem">#default_gem</a>
<li ><a href="#method-i-full_gem_path">#full_gem_path</a>
<li ><a href="#method-i-full_require_paths">#full_require_paths</a>
<li ><a href="#method-i-load_paths">#load_paths</a>
<li ><a href="#method-i-loaded_from">#loaded_from</a>
<li ><a href="#method-i-matches_for_glob">#matches_for_glob</a>
<li ><a href="#method-i-missing_extensions-3F">#missing_extensions?</a>
<li ><a href="#method-i-raw_require_paths">#raw_require_paths</a>
<li class="calls-super" ><a href="#method-i-source-3D">#source=</a>
<li ><a href="#method-i-to_yaml">#to_yaml</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::StubSpecification">
<h1 id="class-Bundler::StubSpecification" class="class">
class Bundler::StubSpecification
</h1>
<section class="description">
</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-ignored" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">ignored</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-stub" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">stub</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</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-from_stub" class="method-detail ">
<div class="method-heading">
<span class="method-name">from_stub</span><span
class="method-args">(stub)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="from_stub-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 7</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">from_stub</span>(<span class="ruby-identifier">stub</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">stub</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">stub</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">StubSpecification</span>)
<span class="ruby-identifier">spec</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">stub</span>.<span class="ruby-identifier">version</span>, <span class="ruby-identifier">stub</span>.<span class="ruby-identifier">platform</span>, <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">stub</span> = <span class="ruby-identifier">stub</span>
<span class="ruby-identifier">spec</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" 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">
<div class="method-source-code" id="activated-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">activated</span>
<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">activated</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-activated-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">activated=</span><span
class="method-args">(activated)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="activated-3D-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">activated=</span>(<span class="ruby-identifier">activated</span>)
<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-value">:@activated</span>, <span class="ruby-identifier">activated</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-default_gem" 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-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_gem</span>
<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">default_gem</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">
<div class="method-source-code" id="full_gem_path-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_gem_path</span>
<span class="ruby-comment"># deleted gems can have their stubs return nil, so in that case grab the</span>
<span class="ruby-comment"># expired path from the full spec</span>
<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">full_gem_path</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-value">:full_gem_path</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">
<div class="method-source-code" id="full_require_paths-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 54</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_require_paths</span>
<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">full_require_paths</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-load_paths" class="method-detail ">
<div class="method-heading">
<span class="method-name">load_paths</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="load_paths-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 58</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_paths</span>
<span class="ruby-identifier">full_require_paths</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-loaded_from" class="method-detail ">
<div class="method-heading">
<span class="method-name">loaded_from</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="loaded_from-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 62</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">loaded_from</span>
<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">loaded_from</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">
<div class="method-source-code" id="matches_for_glob-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 66</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-identifier">stub</span>.<span class="ruby-identifier">matches_for_glob</span>(<span class="ruby-identifier">glob</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-missing_extensions-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">missing_extensions?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>This is defined directly to avoid having to load every installed spec</p>
<div class="method-source-code" id="missing_extensions-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">missing_extensions?</span>
<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">missing_extensions?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-raw_require_paths" class="method-detail ">
<div class="method-heading">
<span class="method-name">raw_require_paths</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="raw_require_paths-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">raw_require_paths</span>
<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">raw_require_paths</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-source-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">source=</span><span
class="method-args">(source)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="source-3D-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">source=</span>(<span class="ruby-identifier">source</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-comment"># Stub has no concept of source, which means that extension_dir may be wrong</span>
<span class="ruby-comment"># This is the case for git-based gems. So, instead manually assign the extension dir</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:extension_dir_name</span>)
<span class="ruby-identifier">path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">extensions_dir</span>, <span class="ruby-identifier">source</span>.<span class="ruby-identifier">extension_dir_name</span>)
<span class="ruby-identifier">stub</span>.<span class="ruby-identifier">extension_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_yaml" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_yaml</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="to_yaml-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_yaml</span>
<span class="ruby-identifier">_remote_specification</span>.<span class="ruby-identifier">to_yaml</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-_remote_specification" class="method-detail ">
<div class="method-heading">
<span class="method-name">_remote_specification</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="_remote_specification-source">
<pre><span class="ruby-comment"># File lib/bundler/stub_specification.rb, line 76</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_remote_specification</span>
<span class="ruby-ivar">@_remote_specification</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span>
<span class="ruby-identifier">rs</span> = <span class="ruby-identifier">stub</span>.<span class="ruby-identifier">to_spec</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">rs</span>.<span class="ruby-identifier">equal?</span>(<span class="ruby-keyword">self</span>) <span class="ruby-comment"># happens when to_spec gets the spec from Gem.loaded_specs</span>
<span class="ruby-identifier">rs</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">loaded_from</span>)
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">rubygems</span>.<span class="ruby-identifier">stub_set_spec</span>(<span class="ruby-identifier">stub</span>, <span class="ruby-identifier">rs</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">rs</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">GemspecError</span>, <span class="ruby-node">"The gemspec for #{full_name} at #{loaded_from}"</span> \
<span class="ruby-node">" was missing or broken. Try running `gem pristine #{name} -v #{version}`"</span> \
<span class="ruby-string">" to fix the cached spec."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">rs</span>.<span class="ruby-identifier">source</span> = <span class="ruby-identifier">source</span>
<span class="ruby-identifier">rs</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>