File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Dependency.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Dependency - 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="../Gem/Dependency.html">Gem::Dependency</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-current_env-3F">#current_env?</a>
<li ><a href="#method-i-current_platform-3F">#current_platform?</a>
<li ><a href="#method-i-expanded_platforms">#expanded_platforms</a>
<li ><a href="#method-i-gem_platforms">#gem_platforms</a>
<li ><a href="#method-i-should_include-3F">#should_include?</a>
<li class="calls-super" ><a href="#method-i-specific-3F">#specific?</a>
<li class="calls-super" ><a href="#method-i-to_lock">#to_lock</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Dependency">
<h1 id="class-Bundler::Dependency" class="class">
class Bundler::Dependency
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="PLATFORM_MAP">PLATFORM_MAP
<dd>
<dt id="REVERSE_PLATFORM_MAP">REVERSE_PLATFORM_MAP
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-autorequire" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">autorequire</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-branch" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">branch</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-gemfile" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">gemfile</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-git" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">git</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-groups" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">groups</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-platforms" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">platforms</span><span
class="attribute-access-type">[R]</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(name, version, options = {}, &blk)</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="../Gem/Dependency.html#method-c-new"><code>Gem::Dependency::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/dependency.rb, line 86</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">version</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
<span class="ruby-identifier">type</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">"type"</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:runtime</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">type</span>)
<span class="ruby-ivar">@autorequire</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@groups</span> = <span class="ruby-constant">Array</span>(<span class="ruby-identifier">options</span>[<span class="ruby-string">"group"</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:default</span>).<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_sym</span>)
<span class="ruby-ivar">@source</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">"source"</span>]
<span class="ruby-ivar">@git</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">"git"</span>]
<span class="ruby-ivar">@branch</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">"branch"</span>]
<span class="ruby-ivar">@platforms</span> = <span class="ruby-constant">Array</span>(<span class="ruby-identifier">options</span>[<span class="ruby-string">"platforms"</span>])
<span class="ruby-ivar">@env</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">"env"</span>]
<span class="ruby-ivar">@should_include</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">"should_include"</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-ivar">@gemfile</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">"gemfile"</span>]
<span class="ruby-ivar">@autorequire</span> = <span class="ruby-constant">Array</span>(<span class="ruby-identifier">options</span>[<span class="ruby-string">"require"</span>] <span class="ruby-operator">||</span> []) <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">"require"</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-current_env-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">current_env?</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="current_env-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/dependency.rb, line 121</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">current_env?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@env</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@env</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-ivar">@env</span>.<span class="ruby-identifier">all?</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
<span class="ruby-constant">ENV</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] <span class="ruby-operator">&&</span> (<span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">ENV</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">val</span> <span class="ruby-operator">:</span> <span class="ruby-constant">ENV</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] <span class="ruby-operator">=~</span> <span class="ruby-identifier">val</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">ENV</span>[<span class="ruby-ivar">@env</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-current_platform-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">current_platform?</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="current_platform-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/dependency.rb, line 132</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">current_platform?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@platforms</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-ivar">@platforms</span>.<span class="ruby-identifier">any?</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">current_ruby</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">"#{p}?"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-expanded_platforms" class="method-detail ">
<div class="method-heading">
<span class="method-name">expanded_platforms</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="expanded_platforms-source">
<pre><span class="ruby-comment"># File lib/bundler/dependency.rb, line 113</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">expanded_platforms</span>
<span class="ruby-ivar">@platforms</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">pl</span><span class="ruby-operator">|</span> <span class="ruby-constant">PLATFORM_MAP</span>[<span class="ruby-identifier">pl</span>] }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_platforms" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_platforms</span><span
class="method-args">(valid_platforms)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the platforms this dependency is valid for, in the same order as passed in the `valid_platforms` parameter</p>
<div class="method-source-code" id="gem_platforms-source">
<pre><span class="ruby-comment"># File lib/bundler/dependency.rb, line 105</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_platforms</span>(<span class="ruby-identifier">valid_platforms</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">valid_platforms</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@platforms</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-ivar">@gem_platforms</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">expanded_platforms</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">uniq</span>
<span class="ruby-identifier">valid_platforms</span> <span class="ruby-operator">&</span> <span class="ruby-ivar">@gem_platforms</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-should_include-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">should_include?</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="should_include-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/dependency.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">should_include?</span>
<span class="ruby-ivar">@should_include</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">current_env?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">current_platform?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-specific-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">specific?</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="../Gem/Dependency.html#method-i-specific-3F"><code>Gem::Dependency#specific?</code></a>
</div>
<div class="method-source-code" id="specific-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/dependency.rb, line 145</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">specific?</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NoMethodError</span>
<span class="ruby-identifier">requirement</span> <span class="ruby-operator">!=</span> <span class="ruby-string">">= 0"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_lock" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_lock</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="../Gem/Dependency.html#method-i-to_lock"><code>Gem::Dependency#to_lock</code></a>
</div>
<div class="method-source-code" id="to_lock-source">
<pre><span class="ruby-comment"># File lib/bundler/dependency.rb, line 139</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_lock</span>
<span class="ruby-identifier">out</span> = <span class="ruby-keyword">super</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"!"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">source</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</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>