File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Molinillo/UI.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Bundler::Molinillo::UI - 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="module">
<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">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-after_resolution">#after_resolution</a>
<li ><a href="#method-i-before_resolution">#before_resolution</a>
<li ><a href="#method-i-debug">#debug</a>
<li ><a href="#method-i-debug-3F">#debug?</a>
<li ><a href="#method-i-indicate_progress">#indicate_progress</a>
<li ><a href="#method-i-output">#output</a>
<li ><a href="#method-i-progress_rate">#progress_rate</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Bundler::Molinillo::UI">
<h1 id="module-Bundler::Molinillo::UI" class="module">
module Bundler::Molinillo::UI
</h1>
<section class="description">
<p>Conveys information about the resolution process to a user.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-after_resolution" class="method-detail ">
<div class="method-heading">
<span class="method-name">after_resolution</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Called after resolution ends (either successfully or with an error). By default, prints a newline.</p>
<p>@return [void]</p>
<div class="method-source-code" id="after_resolution-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/molinillo/lib/molinillo/modules/ui.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">after_resolution</span>
<span class="ruby-identifier">output</span>.<span class="ruby-identifier">puts</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-before_resolution" class="method-detail ">
<div class="method-heading">
<span class="method-name">before_resolution</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Called before resolution begins.</p>
<p>@return [void]</p>
<div class="method-source-code" id="before_resolution-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/molinillo/lib/molinillo/modules/ui.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">before_resolution</span>
<span class="ruby-identifier">output</span>.<span class="ruby-identifier">print</span> <span class="ruby-string">'Resolving dependencies...'</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-debug" class="method-detail ">
<div class="method-heading">
<span class="method-name">debug</span><span
class="method-args">(depth = 0) { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Conveys debug information to the user.</p>
<p>@param [Integer] depth the current depth of the resolution process. @return [void]</p>
<div class="method-source-code" id="debug-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/molinillo/lib/molinillo/modules/ui.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">debug</span>(<span class="ruby-identifier">depth</span> = <span class="ruby-value">0</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">debug?</span>
<span class="ruby-identifier">debug_info</span> = <span class="ruby-keyword">yield</span>
<span class="ruby-identifier">debug_info</span> = <span class="ruby-identifier">debug_info</span>.<span class="ruby-identifier">inspect</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">debug_info</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">debug_info</span> = <span class="ruby-identifier">debug_info</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"\n"</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-node">":#{depth.to_s.rjust 4}: #{s}"</span> }
<span class="ruby-identifier">output</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">debug_info</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-debug-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">debug?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Whether or not debug messages should be printed. By default, whether or not the `MOLINILLO_DEBUG` environment variable is set.</p>
<p>@return [Boolean]</p>
<div class="method-source-code" id="debug-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/molinillo/lib/molinillo/modules/ui.rb, line 62</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">debug?</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@debug_mode</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@debug_mode</span>)
<span class="ruby-ivar">@debug_mode</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-string">'MOLINILLO_DEBUG'</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-indicate_progress" class="method-detail ">
<div class="method-heading">
<span class="method-name">indicate_progress</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Called roughly every {#progress_rate}, this method should convey progress to the user.</p>
<p>@return [void]</p>
<div class="method-source-code" id="indicate_progress-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/molinillo/lib/molinillo/modules/ui.rb, line 17</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">indicate_progress</span>
<span class="ruby-identifier">output</span>.<span class="ruby-identifier">print</span> <span class="ruby-string">'.'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">debug?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-output" class="method-detail ">
<div class="method-heading">
<span class="method-name">output</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The {IO} object that should be used to print output. `STDOUT`, by default.</p>
<p>@return [IO]</p>
<div class="method-source-code" id="output-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/molinillo/lib/molinillo/modules/ui.rb, line 9</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">output</span>
<span class="ruby-constant">STDOUT</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-progress_rate" class="method-detail ">
<div class="method-heading">
<span class="method-name">progress_rate</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>How often progress should be conveyed to the user via {#indicate_progress}, in seconds. A third of a second, by default.</p>
<p>@return [Float]</p>
<div class="method-source-code" id="progress_rate-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/molinillo/lib/molinillo/modules/ui.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">progress_rate</span>
<span class="ruby-value">0.33</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>