File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/LockfileGenerator.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::LockfileGenerator - 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-generate">::generate</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-add_bundled_with">#add_bundled_with</a>
<li ><a href="#method-i-add_dependencies">#add_dependencies</a>
<li ><a href="#method-i-add_locked_ruby_version">#add_locked_ruby_version</a>
<li ><a href="#method-i-add_platforms">#add_platforms</a>
<li ><a href="#method-i-add_section">#add_section</a>
<li ><a href="#method-i-add_sources">#add_sources</a>
<li ><a href="#method-i-add_specs">#add_specs</a>
<li ><a href="#method-i-generate-21">#generate!</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::LockfileGenerator">
<h1 id="class-Bundler::LockfileGenerator" class="class">
class Bundler::LockfileGenerator
</h1>
<section class="description">
</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-definition" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">definition</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-out" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">out</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-generate" class="method-detail ">
<div class="method-heading">
<span class="method-name">generate</span><span
class="method-args">(definition)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="generate-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 14</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">generate</span>(<span class="ruby-identifier">definition</span>)
<span class="ruby-identifier">new</span>(<span class="ruby-identifier">definition</span>).<span class="ruby-identifier">generate!</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">(definition)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@private</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 9</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">definition</span>)
<span class="ruby-ivar">@definition</span> = <span class="ruby-identifier">definition</span>
<span class="ruby-ivar">@out</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">new</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-generate-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">generate!</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="generate-21-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">generate!</span>
<span class="ruby-identifier">add_sources</span>
<span class="ruby-identifier">add_platforms</span>
<span class="ruby-identifier">add_dependencies</span>
<span class="ruby-identifier">add_locked_ruby_version</span>
<span class="ruby-identifier">add_bundled_with</span>
<span class="ruby-identifier">out</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-add_bundled_with" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_bundled_with</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="add_bundled_with-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_bundled_with</span>
<span class="ruby-identifier">add_section</span>(<span class="ruby-string">"BUNDLED WITH"</span>, <span class="ruby-identifier">definition</span>.<span class="ruby-identifier">locked_bundler_version</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_dependencies" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_dependencies</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="add_dependencies-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 57</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_dependencies</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\nDEPENDENCIES\n"</span>
<span class="ruby-identifier">handled</span> = []
<span class="ruby-identifier">definition</span>.<span class="ruby-identifier">dependencies</span>.<span class="ruby-identifier">sort_by</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_s</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">handled</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">dep</span>.<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_lock</span>
<span class="ruby-identifier">handled</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_locked_ruby_version" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_locked_ruby_version</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="add_locked_ruby_version-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_locked_ruby_version</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">locked_ruby_version</span> = <span class="ruby-identifier">definition</span>.<span class="ruby-identifier">locked_ruby_version</span>
<span class="ruby-identifier">add_section</span>(<span class="ruby-string">"RUBY VERSION"</span>, <span class="ruby-identifier">locked_ruby_version</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_platforms" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_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="add_platforms-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 53</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_platforms</span>
<span class="ruby-identifier">add_section</span>(<span class="ruby-string">"PLATFORMS"</span>, <span class="ruby-identifier">definition</span>.<span class="ruby-identifier">platforms</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_section" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_section</span><span
class="method-args">(name, value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="add_section-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_section</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>)
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"\n#{name}\n"</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_s</span>).<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" #{val}\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">sort_by</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">_</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_s</span> }.<span class="ruby-identifier">each</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-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" #{key}: #{val}\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" #{value}\n"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"#{value.inspect} can't be serialized in a lockfile"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_sources" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_sources</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="add_sources-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_sources</span>
<span class="ruby-identifier">definition</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:sources</span>).<span class="ruby-identifier">lock_sources</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">source</span>, <span class="ruby-identifier">idx</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">idx</span>.<span class="ruby-identifier">zero?</span>
<span class="ruby-comment"># Add the source header</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">to_lock</span>
<span class="ruby-comment"># Find all specs for this source</span>
<span class="ruby-identifier">specs</span> = <span class="ruby-identifier">definition</span>.<span class="ruby-identifier">resolve</span>.<span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">can_lock?</span>(<span class="ruby-identifier">s</span>) }
<span class="ruby-identifier">add_specs</span>(<span class="ruby-identifier">specs</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_specs" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_specs</span><span
class="method-args">(specs)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="add_specs-source">
<pre><span class="ruby-comment"># File lib/bundler/lockfile_generator.rb, line 43</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_specs</span>(<span class="ruby-identifier">specs</span>)
<span class="ruby-comment"># This needs to be sorted by full name so that</span>
<span class="ruby-comment"># gems with the same name, but different platform</span>
<span class="ruby-comment"># are ordered consistently</span>
<span class="ruby-identifier">specs</span>.<span class="ruby-identifier">sort_by</span>(<span class="ruby-operator">&</span><span class="ruby-value">:full_name</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-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"bundler"</span>.<span class="ruby-identifier">freeze</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">to_lock</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>