File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Graph.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Graph - 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-new">::new</a>
<li ><a href="#method-i-_groups">#_groups</a>
<li ><a href="#method-i-_make_label">#_make_label</a>
<li ><a href="#method-i-_populate_relations">#_populate_relations</a>
<li ><a href="#method-i-spec_for_dependency">#spec_for_dependency</a>
<li ><a href="#method-i-viz">#viz</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Graph">
<h1 id="class-Bundler::Graph" class="class">
class Bundler::Graph
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="GRAPH_NAME">GRAPH_NAME
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-edge_options" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">edge_options</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-node_options" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">node_options</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-output_file" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">output_file</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-output_format" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">output_format</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-relations" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">relations</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">(env, output_file, show_version = false, show_requirements = false, output_format = "png", without = [])</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/graph.rb, line 8</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">env</span>, <span class="ruby-identifier">output_file</span>, <span class="ruby-identifier">show_version</span> = <span class="ruby-keyword">false</span>, <span class="ruby-identifier">show_requirements</span> = <span class="ruby-keyword">false</span>, <span class="ruby-identifier">output_format</span> = <span class="ruby-string">"png"</span>, <span class="ruby-identifier">without</span> = [])
<span class="ruby-ivar">@env</span> = <span class="ruby-identifier">env</span>
<span class="ruby-ivar">@output_file</span> = <span class="ruby-identifier">output_file</span>
<span class="ruby-ivar">@show_version</span> = <span class="ruby-identifier">show_version</span>
<span class="ruby-ivar">@show_requirements</span> = <span class="ruby-identifier">show_requirements</span>
<span class="ruby-ivar">@output_format</span> = <span class="ruby-identifier">output_format</span>
<span class="ruby-ivar">@without_groups</span> = <span class="ruby-identifier">without</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_sym</span>)
<span class="ruby-ivar">@groups</span> = []
<span class="ruby-ivar">@relations</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">h</span>, <span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span> }
<span class="ruby-ivar">@node_options</span> = {}
<span class="ruby-ivar">@edge_options</span> = {}
<span class="ruby-identifier">_populate_relations</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-viz" class="method-detail ">
<div class="method-heading">
<span class="method-name">viz</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="viz-source">
<pre><span class="ruby-comment"># File lib/bundler/graph.rb, line 26</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">viz</span>
<span class="ruby-constant">GraphVizClient</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>).<span class="ruby-identifier">run</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-_groups" class="method-detail ">
<div class="method-heading">
<span class="method-name">_groups</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="_groups-source">
<pre><span class="ruby-comment"># File lib/bundler/graph.rb, line 52</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_groups</span>
<span class="ruby-identifier">relations</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">h</span>, <span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span> }
<span class="ruby-ivar">@env</span>.<span class="ruby-identifier">current_dependencies</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">groups</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">group</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@without_groups</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">group</span>)
<span class="ruby-identifier">relations</span>[<span class="ruby-identifier">group</span>.<span class="ruby-identifier">to_s</span>].<span class="ruby-identifier">add</span>(<span class="ruby-identifier">dependency</span>)
<span class="ruby-ivar">@relations</span>[<span class="ruby-identifier">group</span>.<span class="ruby-identifier">to_s</span>].<span class="ruby-identifier">add</span>(<span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@node_options</span>[<span class="ruby-identifier">group</span>.<span class="ruby-identifier">to_s</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">_make_label</span>(<span class="ruby-identifier">group</span>, <span class="ruby-value">:node</span>)
<span class="ruby-ivar">@edge_options</span>[<span class="ruby-node">"#{group}_#{dependency.name}"</span>] = <span class="ruby-identifier">_make_label</span>(<span class="ruby-identifier">dependency</span>, <span class="ruby-value">:edge</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@groups</span> = <span class="ruby-identifier">relations</span>.<span class="ruby-identifier">keys</span>
<span class="ruby-identifier">relations</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-_make_label" class="method-detail ">
<div class="method-heading">
<span class="method-name">_make_label</span><span
class="method-args">(symbol_or_string_or_dependency, element_type)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="_make_label-source">
<pre><span class="ruby-comment"># File lib/bundler/graph.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_make_label</span>(<span class="ruby-identifier">symbol_or_string_or_dependency</span>, <span class="ruby-identifier">element_type</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">element_type</span>.<span class="ruby-identifier">to_sym</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:node</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">symbol_or_string_or_dependency</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Dependency</span>)
<span class="ruby-identifier">label</span> = <span class="ruby-identifier">symbol_or_string_or_dependency</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">label</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"\n#{spec_for_dependency(symbol_or_string_or_dependency).version}"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@show_version</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">label</span> = <span class="ruby-identifier">symbol_or_string_or_dependency</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:edge</span>
<span class="ruby-identifier">label</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">symbol_or_string_or_dependency</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:requirements_list</span>) <span class="ruby-operator">&&</span> <span class="ruby-ivar">@show_requirements</span>
<span class="ruby-identifier">tmp</span> = <span class="ruby-identifier">symbol_or_string_or_dependency</span>.<span class="ruby-identifier">requirements_list</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">", "</span>)
<span class="ruby-identifier">label</span> = <span class="ruby-identifier">tmp</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">tmp</span> <span class="ruby-operator">!=</span> <span class="ruby-string">">= 0"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"2nd argument is invalid"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">label</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> {} <span class="ruby-operator">:</span> { <span class="ruby-value">:label</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">label</span> }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-_populate_relations" class="method-detail ">
<div class="method-heading">
<span class="method-name">_populate_relations</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="_populate_relations-source">
<pre><span class="ruby-comment"># File lib/bundler/graph.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_populate_relations</span>
<span class="ruby-identifier">parent_dependencies</span> = <span class="ruby-identifier">_groups</span>.<span class="ruby-identifier">values</span>.<span class="ruby-identifier">to_set</span>.<span class="ruby-identifier">flatten</span>
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">parent_dependencies</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">tmp</span> = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">parent_dependencies</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">child_dependencies</span> = <span class="ruby-identifier">spec_for_dependency</span>(<span class="ruby-identifier">dependency</span>).<span class="ruby-identifier">runtime_dependencies</span>.<span class="ruby-identifier">to_set</span>
<span class="ruby-ivar">@relations</span>[<span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">name</span>] <span class="ruby-operator">+=</span> <span class="ruby-identifier">child_dependencies</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:name</span>).<span class="ruby-identifier">to_set</span>
<span class="ruby-identifier">tmp</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">child_dependencies</span>
<span class="ruby-ivar">@node_options</span>[<span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">_make_label</span>(<span class="ruby-identifier">dependency</span>, <span class="ruby-value">:node</span>)
<span class="ruby-identifier">child_dependencies</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c_dependency</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@edge_options</span>[<span class="ruby-node">"#{dependency.name}_#{c_dependency.name}"</span>] = <span class="ruby-identifier">_make_label</span>(<span class="ruby-identifier">c_dependency</span>, <span class="ruby-value">:edge</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">parent_dependencies</span> = <span class="ruby-identifier">tmp</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-spec_for_dependency" class="method-detail ">
<div class="method-heading">
<span class="method-name">spec_for_dependency</span><span
class="method-args">(dependency)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="spec_for_dependency-source">
<pre><span class="ruby-comment"># File lib/bundler/graph.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spec_for_dependency</span>(<span class="ruby-identifier">dependency</span>)
<span class="ruby-ivar">@env</span>.<span class="ruby-identifier">requested_specs</span>.<span class="ruby-identifier">find</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">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">name</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>