File: C:/Ruby27-x64/share/doc/ruby/html/Gem/InstallerTestCase.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::InstallerTestCase - 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="TestCase.html">Gem::TestCase</a>
</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-i-setup">#setup</a>
<li ><a href="#method-i-setup_base_gem">#setup_base_gem</a>
<li ><a href="#method-i-setup_base_installer">#setup_base_installer</a>
<li ><a href="#method-i-setup_base_spec">#setup_base_spec</a>
<li ><a href="#method-i-setup_base_user_installer">#setup_base_user_installer</a>
<li ><a href="#method-i-util_inst_bindir">#util_inst_bindir</a>
<li ><a href="#method-i-util_installer">#util_installer</a>
<li ><a href="#method-i-util_make_exec">#util_make_exec</a>
<li ><a href="#method-i-util_setup_gem">#util_setup_gem</a>
<li ><a href="#method-i-util_setup_installer">#util_setup_installer</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::InstallerTestCase">
<h1 id="class-Gem::InstallerTestCase" class="class">
class Gem::InstallerTestCase
</h1>
<section class="description">
<p>A test case for <a href="Installer.html"><code>Gem::Installer</code></a>.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-setup" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup</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="TestCase.html#method-i-setup"><code>Gem::TestCase#setup</code></a>
</div>
<div class="method-source-code" id="setup-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup</span>
<span class="ruby-keyword">super</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Installer</span>.<span class="ruby-identifier">path_warning</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setup_base_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup_base_gem</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates the following instance variables:</p>
<dl class="rdoc-list note-list"><dt>@spec
<dd>
<p>a spec named 'a', intended for regular installs</p>
</dd></dl>
<p>And returns a gem built for the @spec</p>
<div class="method-source-code" id="setup_base_gem-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 127</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_base_gem</span>
<span class="ruby-ivar">@spec</span> = <span class="ruby-identifier">setup_base_spec</span>
<span class="ruby-identifier">util_build_gem</span> <span class="ruby-ivar">@spec</span>
<span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">cache_file</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setup_base_installer" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup_base_installer</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates the following instance variables:</p>
<dl class="rdoc-list note-list"><dt>@spec
<dd>
<p>a spec named 'a', intended for regular installs</p>
</dd><dt>@gem
<dd>
<p>the path to a built gem from @spec</p>
</dd></dl>
<p>And returns a <a href="Installer.html"><code>Gem::Installer</code></a> for the @spec that installs into @gemhome</p>
<div class="method-source-code" id="setup_base_installer-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 114</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_base_installer</span>
<span class="ruby-ivar">@gem</span> = <span class="ruby-identifier">setup_base_gem</span>
<span class="ruby-identifier">util_installer</span> <span class="ruby-ivar">@spec</span>, <span class="ruby-ivar">@gemhome</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setup_base_spec" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup_base_spec</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets up a generic specification for testing the rubygems installer</p>
<p>And returns it</p>
<div class="method-source-code" id="setup_base_spec-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 138</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_base_spec</span>
<span class="ruby-identifier">quick_gem</span> <span class="ruby-string">'a'</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">util_make_exec</span> <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setup_base_user_installer" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup_base_user_installer</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates the following instance variables:</p>
<dl class="rdoc-list note-list"><dt>@spec
<dd>
<p>a spec named 'a', intended for regular installs</p>
</dd><dt>@user_spec
<dd>
<p>a spec named 'b', intended for user installs</p>
</dd><dt>@gem
<dd>
<p>the path to a built gem from @spec</p>
</dd><dt>@user_gem
<dd>
<p>the path to a built gem from @user_spec</p>
</dd></dl>
<p>And returns a <a href="Installer.html"><code>Gem::Installer</code></a> for the @user_spec that installs into <a href="../Gem.html#method-c-user_dir"><code>Gem.user_dir</code></a></p>
<div class="method-source-code" id="setup_base_user_installer-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 159</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_base_user_installer</span>
<span class="ruby-ivar">@user_spec</span> = <span class="ruby-identifier">quick_gem</span> <span class="ruby-string">'b'</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">util_make_exec</span> <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">util_build_gem</span> <span class="ruby-ivar">@user_spec</span>
<span class="ruby-ivar">@user_gem</span> = <span class="ruby-ivar">@user_spec</span>.<span class="ruby-identifier">cache_file</span>
<span class="ruby-identifier">util_installer</span> <span class="ruby-ivar">@user_spec</span>, <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">user_dir</span>, <span class="ruby-value">:user</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-util_inst_bindir" class="method-detail ">
<div class="method-heading">
<span class="method-name">util_inst_bindir</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The path where installed executables live</p>
<div class="method-source-code" id="util_inst_bindir-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">util_inst_bindir</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-ivar">@gemhome</span>, <span class="ruby-string">"bin"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-util_installer" class="method-detail ">
<div class="method-heading">
<span class="method-name">util_installer</span><span
class="method-args">(spec, gem_home, user=false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates an installer for <code>spec</code> that will install into <code>gem_home</code>. If <code>user</code> is true a user-install will be performed.</p>
<div class="method-source-code" id="util_installer-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 227</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">util_installer</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">gem_home</span>, <span class="ruby-identifier">user</span>=<span class="ruby-keyword">false</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">spec</span>.<span class="ruby-identifier">cache_file</span>,
<span class="ruby-value">:install_dir</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">gem_home</span>,
<span class="ruby-value">:user_install</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">user</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-util_make_exec" class="method-detail ">
<div class="method-heading">
<span class="method-name">util_make_exec</span><span
class="method-args">(spec = @spec, shebang = "</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds an executable named “executable” to <code>spec</code> with the given <code>shebang</code>.</p>
<p>The executable is also written to the bin dir in @tmpdir and the installed gem directory for <code>spec</code>.</p>
<div class="method-source-code" id="util_make_exec-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 88</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">util_make_exec</span>(<span class="ruby-identifier">spec</span> = <span class="ruby-ivar">@spec</span>, <span class="ruby-identifier">shebang</span> = <span class="ruby-string">"#!/usr/bin/ruby"</span>, <span class="ruby-identifier">bindir</span> = <span class="ruby-string">"bin"</span>)
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">executables</span> = <span class="ruby-node">%w[executable]</span>
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">bindir</span> = <span class="ruby-identifier">bindir</span>
<span class="ruby-identifier">exec_path</span> = <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">bin_file</span> <span class="ruby-string">"executable"</span>
<span class="ruby-identifier">write_file</span> <span class="ruby-identifier">exec_path</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">shebang</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">bin_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-ivar">@tempdir</span>, <span class="ruby-string">"bin"</span>, <span class="ruby-string">"executable"</span>
<span class="ruby-identifier">write_file</span> <span class="ruby-identifier">bin_path</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">shebang</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-util_setup_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">util_setup_gem</span><span
class="method-args">(ui = @ui) { |spec| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Builds the @spec gem and returns an installer for it. The built gem includes:</p>
<pre class="ruby"><span class="ruby-identifier">bin</span><span class="ruby-operator">/</span><span class="ruby-identifier">executable</span>
<span class="ruby-identifier">lib</span><span class="ruby-operator">/</span><span class="ruby-identifier">code</span>.<span class="ruby-identifier">rb</span>
<span class="ruby-identifier">ext</span><span class="ruby-operator">/</span><span class="ruby-identifier">a</span><span class="ruby-operator">/</span><span class="ruby-identifier">mkrf_conf</span>.<span class="ruby-identifier">rb</span>
</pre>
<div class="method-source-code" id="util_setup_gem-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 188</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">util_setup_gem</span>(<span class="ruby-identifier">ui</span> = <span class="ruby-ivar">@ui</span>)
<span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">files</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'lib'</span>, <span class="ruby-string">'code.rb'</span>)
<span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">extensions</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'ext'</span>, <span class="ruby-string">'a'</span>, <span class="ruby-string">'mkrf_conf.rb'</span>)
<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-ivar">@tempdir</span> <span class="ruby-keyword">do</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span> <span class="ruby-string">'bin'</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span> <span class="ruby-string">'lib'</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'ext'</span>, <span class="ruby-string">'a'</span>)
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'bin'</span>, <span class="ruby-string">'executable'</span>), <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</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">puts</span> <span class="ruby-string">"raise 'ran executable'"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'lib'</span>, <span class="ruby-string">'code.rb'</span>), <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</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">puts</span> <span class="ruby-string">'1'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'ext'</span>, <span class="ruby-string">'a'</span>, <span class="ruby-string">'mkrf_conf.rb'</span>), <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</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-operator"><<</span> <span class="ruby-identifier"><<-EOF</span>
<span class="ruby-value"> File.open 'Rakefile', 'w' do |rf| rf.puts "task :default" end
</span><span class="ruby-identifier"> EOF</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">yield</span> <span class="ruby-ivar">@spec</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">use_ui</span> <span class="ruby-identifier">ui</span> <span class="ruby-keyword">do</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_f</span> <span class="ruby-ivar">@gem</span>
<span class="ruby-ivar">@gem</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span>.<span class="ruby-identifier">build</span> <span class="ruby-ivar">@spec</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</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-ivar">@gem</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-util_setup_installer" class="method-detail ">
<div class="method-heading">
<span class="method-name">util_setup_installer</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets up the base @gem, builds it and returns an installer for it.</p>
<div class="method-source-code" id="util_setup_installer-source">
<pre><span class="ruby-comment"># File lib/rubygems/installer_test_case.rb, line 174</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">util_setup_installer</span>
<span class="ruby-ivar">@gem</span> = <span class="ruby-identifier">setup_base_gem</span>
<span class="ruby-identifier">util_setup_gem</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>