File: C:/Ruby27-x64/share/doc/ruby/html/Gem/SourceList.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::SourceList - 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="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../Enumerable.html">Enumerable</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-from">::from</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-3C-3C">#<<</a>
<li ><a href="#method-i-clear">#clear</a>
<li ><a href="#method-i-delete">#delete</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-each_source">#each_source</a>
<li ><a href="#method-i-empty-3F">#empty?</a>
<li ><a href="#method-i-first">#first</a>
<li ><a href="#method-i-include-3F">#include?</a>
<li ><a href="#method-i-replace">#replace</a>
<li ><a href="#method-i-to_a">#to_a</a>
<li ><a href="#method-i-to_ary">#to_ary</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::SourceList">
<h1 id="class-Gem::SourceList" class="class">
class Gem::SourceList
</h1>
<section class="description">
<p>The <a href="SourceList.html"><code>SourceList</code></a> represents the sources rubygems has been configured to use. A source may be created from an array of sources:</p>
<pre class="ruby"><span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">SourceList</span>.<span class="ruby-identifier">from</span> <span class="ruby-node">%w[https://rubygems.example https://internal.example]</span>
</pre>
<p>Or by adding them:</p>
<pre class="ruby"><span class="ruby-identifier">sources</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">SourceList</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">sources</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'https://rubygems.example'</span>
</pre>
<p>The most common way to get a <a href="SourceList.html"><code>SourceList</code></a> is <a href="../Gem.html#method-c-sources"><code>Gem.sources</code></a>.</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-sources" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">sources</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The sources in this list</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-from" class="method-detail ">
<div class="method-heading">
<span class="method-name">from</span><span
class="method-args">(ary)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="SourceList.html"><code>SourceList</code></a> from an array of sources.</p>
<div class="method-source-code" id="from-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">from</span>(<span class="ruby-identifier">ary</span>)
<span class="ruby-identifier">list</span> = <span class="ruby-identifier">new</span>
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">replace</span> <span class="ruby-identifier">ary</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">list</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">
<p>Creates a new <a href="SourceList.html"><code>SourceList</code></a></p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 24</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@sources</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-3C-3C" class="method-detail ">
<div class="method-heading">
<span class="method-name"><<</span><span
class="method-args">(obj)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Appends <code>obj</code> to the source list which may be a <a href="Source.html"><code>Gem::Source</code></a>, <a href="../URI.html"><code>URI</code></a> or <a href="../URI.html"><code>URI</code></a> <a href="../String.html"><code>String</code></a>.</p>
<div class="method-source-code" id="3C-3C-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 52</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-identifier">require</span> <span class="ruby-string">"uri"</span>
<span class="ruby-identifier">src</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">obj</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">URI</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span>
<span class="ruby-identifier">obj</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">obj</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@sources</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">src</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">src</span>)
<span class="ruby-identifier">src</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-clear" class="method-detail ">
<div class="method-heading">
<span class="method-name">clear</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes all sources from the <a href="SourceList.html"><code>SourceList</code></a>.</p>
<div class="method-source-code" id="clear-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 85</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clear</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">(source)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes <code>source</code> from the source list which may be a <a href="Source.html"><code>Gem::Source</code></a> or a <a href="../URI.html"><code>URI</code></a>.</p>
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 145</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">source</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">source</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">delete_if</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">to_s</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">() { |uri.to_s| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Yields each source <a href="../URI.html"><code>URI</code></a> in the list.</p>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span> }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each_source" class="method-detail ">
<div class="method-heading">
<span class="method-name">each_source</span><span
class="method-args">(&b)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Yields each source in the list.</p>
<div class="method-source-code" id="each_source-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 99</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each_source</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-empty-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">empty?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if there are no sources in this <a href="SourceList.html"><code>SourceList</code></a>.</p>
<div class="method-source-code" id="empty-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-first" class="method-detail ">
<div class="method-heading">
<span class="method-name">first</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the first source in the list.</p>
<div class="method-source-code" id="first-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 126</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">first</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">first</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-include-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">include?</span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if this source list includes <code>other</code> which may be a <a href="Source.html"><code>Gem::Source</code></a> or a source <a href="../URI.html"><code>URI</code></a>.</p>
<div class="method-source-code" id="include-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 134</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">include?</span>(<span class="ruby-identifier">other</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">other</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_s</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-replace" class="method-detail ">
<div class="method-heading">
<span class="method-name">replace</span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Replaces this <a href="SourceList.html"><code>SourceList</code></a> with the sources in <code>other</code> See <a href="SourceList.html#method-i-3C-3C"><code><<</code></a> for acceptable items in <code>other</code>.</p>
<div class="method-source-code" id="replace-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 72</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">replace</span>(<span class="ruby-identifier">other</span>)
<span class="ruby-identifier">clear</span>
<span class="ruby-identifier">other</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">self</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">x</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_a" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_a</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an <a href="../Array.html"><code>Array</code></a> of source <a href="../URI.html"><code>URI</code></a> Strings.</p>
<div class="method-source-code" id="to_a-source">
<pre><span class="ruby-comment"># File lib/rubygems/source_list.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_a</span>
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span> }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="SourceList.html#method-i-to_ary">to_ary</a>
</div>
</div>
<div id="method-i-to_ary" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_ary</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="SourceList.html#method-i-to_a">to_a</a>
</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>