File: C:/Ruby27-x64/share/doc/ruby/html/Gem/TestCase/SpecFetcherSetup.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::TestCase::SpecFetcherSetup - 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-declare">::declare</a>
<li ><a href="#method-i-created_specs">#created_specs</a>
<li ><a href="#method-i-download">#download</a>
<li ><a href="#method-i-gem">#gem</a>
<li ><a href="#method-i-legacy_platform">#legacy_platform</a>
<li ><a href="#method-i-spec">#spec</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::TestCase::SpecFetcherSetup">
<h1 id="class-Gem::TestCase::SpecFetcherSetup" class="class">
class Gem::TestCase::SpecFetcherSetup
</h1>
<section class="description">
<p>The <a href="SpecFetcherSetup.html"><code>SpecFetcherSetup</code></a> allows easy setup of a remote source in RubyGems tests:</p>
<pre>spec_fetcher do |f|
f.gem 'a', 1
f.spec 'a', 2
f.gem 'b', 1' 'a' => '~> 1.0'
end</pre>
<p>The above declaration creates two gems, a-1 and b-1, with a dependency from b to a. The declaration creates an additional spec a-2, but no gem for it (so it cannot be installed).</p>
<p>After the gems are created they are removed from <a href="../../Gem.html#method-c-dir"><code>Gem.dir</code></a>.</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-declare" class="method-detail ">
<div class="method-heading">
<span class="method-name">declare</span><span
class="method-args">(test, repository) { |setup| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Executes a SpecFetcher setup block. Yields an instance then creates the gems and specifications defined in the instance.</p>
<div class="method-source-code" id="declare-source">
<pre><span class="ruby-comment"># File lib/rubygems/test_utilities.rb, line 199</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">declare</span>(<span class="ruby-identifier">test</span>, <span class="ruby-identifier">repository</span>)
<span class="ruby-identifier">setup</span> = <span class="ruby-identifier">new</span> <span class="ruby-identifier">test</span>, <span class="ruby-identifier">repository</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">setup</span>
<span class="ruby-identifier">setup</span>.<span class="ruby-identifier">execute</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-created_specs" class="method-detail ">
<div class="method-heading">
<span class="method-name">created_specs</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a <a href="../../Hash.html"><code>Hash</code></a> of created Specification full names and the corresponding Specification.</p>
<div class="method-source-code" id="created_specs-source">
<pre><span class="ruby-comment"># File lib/rubygems/test_utilities.rb, line 221</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">created_specs</span>
<span class="ruby-identifier">created</span> = {}
<span class="ruby-ivar">@gems</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</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">created</span>[<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">full_name</span>] = <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">created</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-download" class="method-detail ">
<div class="method-heading">
<span class="method-name">download</span><span
class="method-args">(name, version, dependencies = nil, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a gem with <code>name</code>, <code>version</code> and <code>deps</code>. The created gem is downloaded in to the cache directory but is not installed</p>
<p>The specification will be yielded before gem creation for customization, but only the block or the dependencies may be set, not both.</p>
<div class="method-source-code" id="download-source">
<pre><span class="ruby-comment"># File lib/rubygems/test_utilities.rb, line 287</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">download</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">dependencies</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@operations</span> <span class="ruby-operator"><<</span> [<span class="ruby-value">:download</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">dependencies</span>, <span class="ruby-identifier">block</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem</span><span
class="method-args">(name, version, dependencies = nil, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a gem with <code>name</code>, <code>version</code> and <code>deps</code>. The created gem can be downloaded and installed.</p>
<p>The specification will be yielded before gem creation for customization, but only the block or the dependencies may be set, not both.</p>
<div class="method-source-code" id="gem-source">
<pre><span class="ruby-comment"># File lib/rubygems/test_utilities.rb, line 276</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">dependencies</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@operations</span> <span class="ruby-operator"><<</span> [<span class="ruby-value">:gem</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">dependencies</span>, <span class="ruby-identifier">block</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-legacy_platform" class="method-detail ">
<div class="method-heading">
<span class="method-name">legacy_platform</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a legacy platform spec with the name 'pl' and version 1</p>
<div class="method-source-code" id="legacy_platform-source">
<pre><span class="ruby-comment"># File lib/rubygems/test_utilities.rb, line 294</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">legacy_platform</span>
<span class="ruby-identifier">spec</span> <span class="ruby-string">'pl'</span>, <span class="ruby-value">1</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">platform</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Platform</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'i386-linux'</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">instance_variable_set</span> <span class="ruby-value">:@original_platform</span>, <span class="ruby-string">'i386-linux'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-spec" class="method-detail ">
<div class="method-heading">
<span class="method-name">spec</span><span
class="method-args">(name, version, dependencies = nil, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a spec with <code>name</code>, <code>version</code> and <code>deps</code>. The created gem can be downloaded and installed.</p>
<p>The specification will be yielded before creation for customization, but only the block or the dependencies may be set, not both.</p>
<div class="method-source-code" id="spec-source">
<pre><span class="ruby-comment"># File lib/rubygems/test_utilities.rb, line 340</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spec</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">dependencies</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@operations</span> <span class="ruby-operator"><<</span> [<span class="ruby-value">:spec</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">dependencies</span>, <span class="ruby-identifier">block</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>