+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPC::Progress</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Progress</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/progress_rb.html">
- lib/mcollective/rpc/progress.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Class that shows a progress bar, currently only supports a twirling
-progress bar.
-</p>
-<p>
-You can specify a size for the progress bar if you want if you dont it will
-use the helper functions to figure out terminal dimensions and draw an
-appropriately sized bar
-</p>
-<p>
-p = <a href="Progress.html#M000051">Progress.new</a> 100.times {|i| print
-p.twirl(i+1, 100) + "\r"};puts
-</p>
-<pre>
- * [ ==================================================> ] 100 / 100
-</pre>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000051">new</a>
- <a href="#M000052">twirl</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000051" class="method-detail">
- <a name="M000051"></a>
-
- <div class="method-heading">
- <a href="#M000051" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(size=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000051-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000051-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/progress.rb, line 15</span>
-15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">size</span>=<span class="ruby-keyword kw">nil</span>)
-16: <span class="ruby-ivar">@twirl</span> = [<span class="ruby-value str">'|'</span>, <span class="ruby-value str">'/'</span>, <span class="ruby-value str">'-'</span>, <span class="ruby-value str">"\\"</span>, <span class="ruby-value str">'|'</span>, <span class="ruby-value str">'/'</span>, <span class="ruby-value str">'-'</span>, <span class="ruby-value str">"\\"</span>]
-17: <span class="ruby-ivar">@twirldex</span> = <span class="ruby-value">0</span>
-18:
-19: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">size</span>
-20: <span class="ruby-ivar">@size</span> = <span class="ruby-identifier">size</span>
-21: <span class="ruby-keyword kw">else</span>
-22: <span class="ruby-identifier">cols</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">terminal_dimensions</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">-</span> <span class="ruby-value">22</span>
-23:
-24: <span class="ruby-comment cmt"># Defaults back to old behavior if it</span>
-25: <span class="ruby-comment cmt"># couldn't figure out the size or if</span>
-26: <span class="ruby-comment cmt"># its more than 60 wide</span>
-27: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">cols</span> <span class="ruby-operator"><=</span> <span class="ruby-value">0</span>
-28: <span class="ruby-ivar">@size</span> = <span class="ruby-value">0</span>
-29: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">cols</span> <span class="ruby-operator">></span> <span class="ruby-value">60</span>
-30: <span class="ruby-ivar">@size</span> = <span class="ruby-value">60</span>
-31: <span class="ruby-keyword kw">else</span>
-32: <span class="ruby-ivar">@size</span> = <span class="ruby-identifier">cols</span>
-33: <span class="ruby-keyword kw">end</span>
-34: <span class="ruby-keyword kw">end</span>
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000052" class="method-detail">
- <a name="M000052"></a>
-
- <div class="method-heading">
- <a href="#M000052" class="method-signature">
- <span class="method-name">twirl</span><span class="method-args">(current, total)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000052-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000052-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/progress.rb, line 37</span>
-37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">twirl</span>(<span class="ruby-identifier">current</span>, <span class="ruby-identifier">total</span>)
-38: <span class="ruby-comment cmt"># if the size is negative there is just not enough</span>
-39: <span class="ruby-comment cmt"># space on the terminal, return a simpler version</span>
-40: <span class="ruby-keyword kw">return</span> <span class="ruby-node">"\r#{current} / #{total}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
-41:
-42: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">current</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">total</span>
-43: <span class="ruby-identifier">txt</span> = <span class="ruby-value str">"\r %s [ "</span> <span class="ruby-operator">%</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:green</span>, <span class="ruby-value str">"*"</span>)
-44: <span class="ruby-keyword kw">else</span>
-45: <span class="ruby-identifier">txt</span> = <span class="ruby-value str">"\r %s [ "</span> <span class="ruby-operator">%</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-ivar">@twirl</span>[<span class="ruby-ivar">@twirldex</span>])
-46: <span class="ruby-keyword kw">end</span>
-47:
-48: <span class="ruby-identifier">dashes</span> = ((<span class="ruby-identifier">current</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">total</span>) <span class="ruby-operator">*</span> <span class="ruby-ivar">@size</span>).<span class="ruby-identifier">round</span>
-49:
-50: <span class="ruby-identifier">dashes</span>.<span class="ruby-identifier">times</span> { <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"="</span> }
-51: <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">">"</span>
-52:
-53: (<span class="ruby-ivar">@size</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">dashes</span>).<span class="ruby-identifier">times</span> { <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" "</span> }
-54:
-55: <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" ] #{current} / #{total}"</span>
-56:
-57: <span class="ruby-ivar">@twirldex</span> <span class="ruby-operator">==</span> <span class="ruby-value">7</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@twirldex</span> = <span class="ruby-value">0</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@twirldex</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-58:
-59: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">txt</span>
-60: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file