--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>Class: MCollective::RPC::Progress</title>
+
+ <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
+
+ <script src="../../js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../../js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../../js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../../js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+ <div id="metadata">
+ <div id="file-metadata">
+ <div id="file-list-section" class="section">
+ <h3 class="section-header">In Files</h3>
+ <div class="section-body">
+ <ul>
+
+ <li><a href="../../lib/mcollective/rpc/progress_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/progress.rb">lib/mcollective/rpc/progress.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+ <div id="parent-class-section" class="section">
+ <h3 class="section-header">Parent</h3>
+
+ <p class="link"><a href="../../Object.html">Object</a></p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000391">::new</a></li>
+
+ <li><a href="#M000392">#twirl</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ </div>
+
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="../../COPYING.html">COPYING</a></li>
+
+ <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
+
+ <li class="file"><a href="../../README.html">README</a></li>
+
+ <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
+
+ <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
+
+ <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
+
+ <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
+
+ <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
+
+ <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
+
+ <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
+
+ <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
+
+ <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
+
+ <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
+
+ <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
+
+ <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
+
+ <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
+
+ <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
+
+ <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
+
+ <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
+
+ <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="../../images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="../../MCollective.html">MCollective</a></li>
+
+ <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
+
+ <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
+
+ <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
+
+ <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+
+ <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+
+ <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
+
+ <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
+
+ <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
+
+ <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
+
+ <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
+
+ <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
+
+ <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
+
+ <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
+
+ <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
+
+ <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
+
+ <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
+
+ <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
+
+ <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
+
+ <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
+
+ <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
+
+ <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
+
+ <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
+
+ <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
+
+ <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
+
+ <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
+
+ <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
+
+ <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
+
+ <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
+
+ <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
+
+ <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
+
+ <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
+
+ <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
+
+ <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
+
+ <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
+
+ <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
+
+ <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
+
+ <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
+
+ <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
+
+ <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
+
+ <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
+
+ <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
+
+ <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
+
+ <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
+
+ <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
+
+ <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
+
+ <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
+
+ <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
+
+ <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
+
+ <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
+
+ <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
+
+ <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
+
+ <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
+
+ <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
+
+ <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
+
+ <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
+
+ <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
+
+ <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
+
+ <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
+
+ <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
+
+ <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
+
+ <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
+
+ <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
+
+ <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
+
+ <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
+
+ <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
+
+ <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
+
+ <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
+
+ <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
+
+ <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
+
+ <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
+
+ <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
+
+ <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
+
+ <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
+
+ <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
+
+ <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
+
+ <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
+
+ <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
+
+ <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
+
+ <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
+
+ <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
+
+ <li><a href="../../Array.html">Array</a></li>
+
+ <li><a href="../../Dir.html">Dir</a></li>
+
+ <li><a href="../../Object.html">Object</a></li>
+
+ <li><a href="../../String.html">String</a></li>
+
+ <li><a href="../../Symbol.html">Symbol</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1 class="class">MCollective::RPC::Progress</h1>
+
+ <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#M000391">Progress.new</a> 100.times {|i| print
+p.twirl(i+1, 100) + “r“};puts
+</p>
+<pre>
+ * [ ==================================================> ] 100 / 100
+</pre>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000391"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(size=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="new-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>
+
+
+ </div>
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="twirl-method" class="method-detail ">
+ <a name="M000392"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">twirl</span><span
+ class="method-args">(current, total)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="twirl-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="rdoc-debugging-section-dump" class="debugging-section">
+
+ <p>Disabled; run with --debug to generate this.</p>
+
+ </div>
+
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
+
+</body>
+</html>
+
Code Review / packages / precise / mcollective.git / blobdiff