File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Source/Git.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Source::Git - 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="../Source.html">Gem::Source</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-c-new">::new</a>
<li ><a href="#method-i-3C-3D-3E">#<=></a>
<li ><a href="#method-i-specs">#specs</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Source::Git">
<h1 id="class-Gem::Source::Git" class="class">
class Gem::Source::Git
</h1>
<section class="description">
<p>A git gem for use in a gem dependencies file.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">source</span> =
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">Git</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'rake'</span>, <span class="ruby-string">'git@example:rake.git'</span>, <span class="ruby-string">'rake-10.1.0'</span>, <span class="ruby-keyword">false</span>
<span class="ruby-identifier">source</span>.<span class="ruby-identifier">specs</span>
</pre>
</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-name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">name</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The name of the gem created by this git gem.</p>
</div>
</div>
<div id="attribute-i-need_submodules" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">need_submodules</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Does this repository need submodules checked out too?</p>
</div>
</div>
<div id="attribute-i-reference" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">reference</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The commit reference used for checking out this git gem.</p>
</div>
</div>
<div id="attribute-i-remote" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">remote</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>When false the cache for this repository will not be updated.</p>
</div>
</div>
<div id="attribute-i-repository" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">repository</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The git repository this gem is sourced from.</p>
</div>
</div>
<div id="attribute-i-root_dir" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">root_dir</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The directory for cache and git gem installation</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(name, repository, reference, submodules = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new git gem source for a gems from loaded from <code>repository</code> at the given <code>reference</code>. The <code>name</code> is only used to track the repository back to a gem dependencies file, it has no real significance as a git repository may contain multiple gems. If <code>submodules</code> is true, submodules will be checked out when the gem is installed.</p>
<div class="method-calls-super">
Calls superclass method
<a href="../Source.html#method-c-new"><code>Gem::Source::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/source/git.rb, line 53</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">repository</span>, <span class="ruby-identifier">reference</span>, <span class="ruby-identifier">submodules</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">super</span> <span class="ruby-identifier">repository</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-ivar">@repository</span> = <span class="ruby-identifier">repository</span>
<span class="ruby-ivar">@reference</span> = <span class="ruby-identifier">reference</span>
<span class="ruby-ivar">@need_submodules</span> = <span class="ruby-identifier">submodules</span>
<span class="ruby-ivar">@remote</span> = <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@root_dir</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">dir</span>
<span class="ruby-ivar">@git</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-string">'git'</span>] <span class="ruby-operator">||</span> <span class="ruby-string">'git'</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-3D-3E" class="method-detail ">
<div class="method-heading">
<span class="method-name"><=></span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="3C-3D-3E-source">
<pre><span class="ruby-comment"># File lib/rubygems/source/git.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span>(<span class="ruby-identifier">other</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">other</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-operator">::</span><span class="ruby-constant">Git</span> <span class="ruby-keyword">then</span>
<span class="ruby-value">0</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-operator">::</span><span class="ruby-constant">Vendor</span>,
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">Lock</span> <span class="ruby-keyword">then</span>
<span class="ruby-value">-1</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-keyword">then</span>
<span class="ruby-value">1</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-specs" class="method-detail ">
<div class="method-heading">
<span class="method-name">specs</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Loads all gemspecs in the repository</p>
<div class="method-source-code" id="specs-source">
<pre><span class="ruby-comment"># File lib/rubygems/source/git.rb, line 197</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">specs</span>
<span class="ruby-identifier">checkout</span>
<span class="ruby-keyword">return</span> [] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">install_dir</span>
<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-identifier">install_dir</span> <span class="ruby-keyword">do</span>
<span class="ruby-constant">Dir</span>[<span class="ruby-string">'{,*,*/*}.gemspec'</span>].<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">spec_file</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">directory</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span> <span class="ruby-identifier">spec_file</span>
<span class="ruby-identifier">file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span> <span class="ruby-identifier">spec_file</span>
<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-identifier">directory</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">spec</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">file</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span>
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">base_dir</span> = <span class="ruby-identifier">base_dir</span>
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">extension_dir</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-node">"#{name}-#{dir_shortref}"</span>
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">full_gem_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">loaded_from</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">compact</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>