doc/Bauxite/Loggers/TerminalLogger.html in bauxite-0.6.18 vs doc/Bauxite/Loggers/TerminalLogger.html in bauxite-0.6.19

- old
+ new

@@ -4,25 +4,22 @@ <head> <meta charset="UTF-8"> <title>class Bauxite::Loggers::TerminalLogger - RDoc Documentation</title> -<link href="../../fonts.css" rel="stylesheet"> -<link href="../../rdoc.css" rel="stylesheet"> - <script type="text/javascript"> var rdoc_rel_prefix = "../../"; </script> <script src="../../js/jquery.js"></script> -<script src="../../js/navigation.js"></script> -<script src="../../js/search_index.js"></script> -<script src="../../js/search.js"></script> -<script src="../../js/searcher.js"></script> <script src="../../js/darkfish.js"></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> @@ -156,13 +153,13 @@ <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 30</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span>) - <span class="ruby-keyword">super</span>(<span class="ruby-identifier">options</span>) - <span class="ruby-ivar">@max_cmd_size</span> = <span class="ruby-constant">Bauxite</span><span class="ruby-operator">::</span><span class="ruby-constant">Context</span><span class="ruby-operator">::</span><span class="ruby-identifier">max_action_name_size</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span>) + <span class="ruby-keyword">super</span>(<span class="ruby-identifier">options</span>) + <span class="ruby-ivar">@max_cmd_size</span> = <span class="ruby-constant">Bauxite</span><span class="ruby-operator">::</span><span class="ruby-constant">Context</span><span class="ruby-operator">::</span><span class="ruby-identifier">max_action_name_size</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -203,12 +200,12 @@ <div class="method-source-code" id="debug_prompt-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 69</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">debug_prompt</span> - <span class="ruby-identifier">_fmt</span>(<span class="ruby-value">:white</span>, <span class="ruby-keyword">super</span>) +<span class="ruby-keyword">def</span> <span class="ruby-identifier">debug_prompt</span> + <span class="ruby-identifier">_fmt</span>(<span class="ruby-value">:white</span>, <span class="ruby-keyword">super</span>) <span class="ruby-keyword">end</span></pre> </div> </div> @@ -243,21 +240,21 @@ <div class="method-source-code" id="log-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 85</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">type</span> = <span class="ruby-value">:info</span>) - <span class="ruby-identifier">color</span> = <span class="ruby-value">:gray</span> - <span class="ruby-keyword">case</span> <span class="ruby-identifier">type</span> - <span class="ruby-keyword">when</span> <span class="ruby-value">:error</span> - <span class="ruby-identifier">color</span> = <span class="ruby-value">:red</span> - <span class="ruby-keyword">when</span> <span class="ruby-value">:warning</span> - <span class="ruby-identifier">color</span> = <span class="ruby-value">:yellow</span> - <span class="ruby-keyword">when</span> <span class="ruby-value">:debug</span> - <span class="ruby-identifier">color</span> = <span class="ruby-value">:purple</span> - <span class="ruby-keyword">end</span> - <span class="ruby-keyword">super</span> <span class="ruby-identifier">_fmt</span>(<span class="ruby-identifier">color</span>, <span class="ruby-identifier">s</span>), <span class="ruby-identifier">type</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">type</span> = <span class="ruby-value">:info</span>) + <span class="ruby-identifier">color</span> = <span class="ruby-value">:gray</span> + <span class="ruby-keyword">case</span> <span class="ruby-identifier">type</span> + <span class="ruby-keyword">when</span> <span class="ruby-value">:error</span> + <span class="ruby-identifier">color</span> = <span class="ruby-value">:red</span> + <span class="ruby-keyword">when</span> <span class="ruby-value">:warning</span> + <span class="ruby-identifier">color</span> = <span class="ruby-value">:yellow</span> + <span class="ruby-keyword">when</span> <span class="ruby-value">:debug</span> + <span class="ruby-identifier">color</span> = <span class="ruby-value">:purple</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">super</span> <span class="ruby-identifier">_fmt</span>(<span class="ruby-identifier">color</span>, <span class="ruby-identifier">s</span>), <span class="ruby-identifier">type</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -285,40 +282,40 @@ <div class="method-source-code" id="log_cmd-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 36</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">log_cmd</span>(<span class="ruby-identifier">action</span>) - <span class="ruby-identifier">width</span> = <span class="ruby-identifier">_screen_width</span> - <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">action</span>.<span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">downcase</span> - <span class="ruby-identifier">color</span> = <span class="ruby-identifier">_cmd_color</span>(<span class="ruby-identifier">cmd</span>) - <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-ivar">@max_cmd_size</span>) - <span class="ruby-identifier">max_args_size</span> = <span class="ruby-identifier">width</span><span class="ruby-operator">-</span><span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">size</span><span class="ruby-operator">-</span><span class="ruby-value">1</span><span class="ruby-operator">-</span><span class="ruby-value">6</span><span class="ruby-operator">-</span><span class="ruby-value">1</span><span class="ruby-operator">-</span><span class="ruby-value">1</span> - - <span class="ruby-identifier">print</span> <span class="ruby-node">&quot;#{_fmt(color, cmd)} &quot;</span> - <span class="ruby-identifier">s</span> = <span class="ruby-identifier">action</span>.<span class="ruby-identifier">args</span>(<span class="ruby-keyword">true</span>).<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39; &#39;</span>) - <span class="ruby-identifier">s</span> = <span class="ruby-identifier">s</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">max_args_size</span><span class="ruby-operator">-</span><span class="ruby-value">3</span>]<span class="ruby-operator">+</span><span class="ruby-string">&#39;...&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">max_args_size</span> - <span class="ruby-identifier">print</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-identifier">max_args_size</span>) - <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">flush</span> - - <span class="ruby-identifier">_save_cursor</span> - <span class="ruby-identifier">color</span> = <span class="ruby-value">:green</span> - <span class="ruby-identifier">text</span> = <span class="ruby-string">&#39;OK&#39;</span> - <span class="ruby-identifier">ret</span> = <span class="ruby-keyword">yield</span> - <span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">ret</span> - <span class="ruby-identifier">color</span> = <span class="ruby-value">:yellow</span> - <span class="ruby-identifier">text</span> = <span class="ruby-string">&#39;SKIP&#39;</span> - <span class="ruby-keyword">end</span> - <span class="ruby-identifier">_restore_cursor</span> - <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot; #{_block(color, text, 5)}&quot;</span> - <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">flush</span> - <span class="ruby-identifier">ret</span> -<span class="ruby-keyword">rescue</span> - <span class="ruby-identifier">_restore_cursor</span> - <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot; #{_block(:red, &#39;ERROR&#39;, 5)}&quot;</span> - <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">flush</span> - <span class="ruby-identifier">raise</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">log_cmd</span>(<span class="ruby-identifier">action</span>) + <span class="ruby-identifier">width</span> = <span class="ruby-identifier">_screen_width</span> + <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">action</span>.<span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">downcase</span> + <span class="ruby-identifier">color</span> = <span class="ruby-identifier">_cmd_color</span>(<span class="ruby-identifier">cmd</span>) + <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-ivar">@max_cmd_size</span>) + <span class="ruby-identifier">max_args_size</span> = <span class="ruby-identifier">width</span><span class="ruby-operator">-</span><span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">size</span><span class="ruby-operator">-</span><span class="ruby-value">1</span><span class="ruby-operator">-</span><span class="ruby-value">6</span><span class="ruby-operator">-</span><span class="ruby-value">1</span><span class="ruby-operator">-</span><span class="ruby-value">1</span> + + <span class="ruby-identifier">print</span> <span class="ruby-node">&quot;#{_fmt(color, cmd)} &quot;</span> + <span class="ruby-identifier">s</span> = <span class="ruby-identifier">action</span>.<span class="ruby-identifier">args</span>(<span class="ruby-keyword">true</span>).<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39; &#39;</span>) + <span class="ruby-identifier">s</span> = <span class="ruby-identifier">s</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">max_args_size</span><span class="ruby-operator">-</span><span class="ruby-value">3</span>]<span class="ruby-operator">+</span><span class="ruby-string">&#39;...&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">max_args_size</span> + <span class="ruby-identifier">print</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-identifier">max_args_size</span>) + <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">flush</span> + + <span class="ruby-identifier">_save_cursor</span> + <span class="ruby-identifier">color</span> = <span class="ruby-value">:green</span> + <span class="ruby-identifier">text</span> = <span class="ruby-string">&#39;OK&#39;</span> + <span class="ruby-identifier">ret</span> = <span class="ruby-keyword">yield</span> + <span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">ret</span> + <span class="ruby-identifier">color</span> = <span class="ruby-value">:yellow</span> + <span class="ruby-identifier">text</span> = <span class="ruby-string">&#39;SKIP&#39;</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">_restore_cursor</span> + <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot; #{_block(color, text, 5)}&quot;</span> + <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">flush</span> + <span class="ruby-identifier">ret</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-identifier">_restore_cursor</span> + <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot; #{_block(:red, &#39;ERROR&#39;, 5)}&quot;</span> + <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">flush</span> + <span class="ruby-identifier">raise</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -346,15 +343,15 @@ <div class="method-source-code" id="progress-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 74</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">progress</span>(<span class="ruby-identifier">value</span>) - <span class="ruby-keyword">if</span> <span class="ruby-identifier">_restore_cursor</span> - <span class="ruby-identifier">print</span> <span class="ruby-node">&quot; #{_block(:gray, value.to_s, 5)}&quot;</span> - <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">flush</span> - <span class="ruby-keyword">end</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">progress</span>(<span class="ruby-identifier">value</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">_restore_cursor</span> + <span class="ruby-identifier">print</span> <span class="ruby-node">&quot; #{_block(:gray, value.to_s, 5)}&quot;</span> + <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">flush</span> + <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -390,12 +387,12 @@ <div class="method-source-code" id="_block-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 115</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">_block</span>(<span class="ruby-identifier">color</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">size</span>) - <span class="ruby-node">&quot;#{_fmt(:white, &#39;[&#39;)}#{_fmt(color, text, size)}#{_fmt(:white, &#39;]&#39;)}&quot;</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">_block</span>(<span class="ruby-identifier">color</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">size</span>) + <span class="ruby-node">&quot;#{_fmt(:white, &#39;[&#39;)}#{_fmt(color, text, size)}#{_fmt(:white, &#39;]&#39;)}&quot;</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -423,19 +420,19 @@ <div class="method-source-code" id="_cmd_color-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 120</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">_cmd_color</span>(<span class="ruby-identifier">cmd</span>) - <span class="ruby-keyword">case</span> <span class="ruby-identifier">cmd</span> - <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;load&#39;</span> - <span class="ruby-keyword">return</span> <span class="ruby-value">:cyan</span> - <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;test&#39;</span> - <span class="ruby-keyword">return</span> <span class="ruby-value">:purple</span> - <span class="ruby-keyword">else</span> - <span class="ruby-keyword">return</span> <span class="ruby-value">:blue</span> - <span class="ruby-keyword">end</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">_cmd_color</span>(<span class="ruby-identifier">cmd</span>) + <span class="ruby-keyword">case</span> <span class="ruby-identifier">cmd</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;load&#39;</span> + <span class="ruby-keyword">return</span> <span class="ruby-value">:cyan</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;test&#39;</span> + <span class="ruby-keyword">return</span> <span class="ruby-value">:purple</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">return</span> <span class="ruby-value">:blue</span> + <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -463,12 +460,12 @@ <div class="method-source-code" id="_fmt-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 100</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">_fmt</span>(<span class="ruby-identifier">color</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">size</span> = <span class="ruby-value">0</span>) - <span class="ruby-identifier">text</span>.<span class="ruby-identifier">center</span>(<span class="ruby-identifier">size</span>) +<span class="ruby-keyword">def</span> <span class="ruby-identifier">_fmt</span>(<span class="ruby-identifier">color</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">size</span> = <span class="ruby-value">0</span>) + <span class="ruby-identifier">text</span>.<span class="ruby-identifier">center</span>(<span class="ruby-identifier">size</span>) <span class="ruby-keyword">end</span></pre> </div> </div> @@ -496,12 +493,12 @@ <div class="method-source-code" id="_restore_cursor-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 110</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">_restore_cursor</span> - <span class="ruby-keyword">false</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">_restore_cursor</span> + <span class="ruby-keyword">false</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -529,12 +526,12 @@ <div class="method-source-code" id="_save_cursor-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 105</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">_save_cursor</span> - <span class="ruby-keyword">false</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">_save_cursor</span> + <span class="ruby-keyword">false</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -562,12 +559,12 @@ <div class="method-source-code" id="_screen_width-source"> <pre><span class="ruby-comment"># File lib/bauxite/loggers/terminal.rb, line 132</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">_screen_width</span> - <span class="ruby-value">80</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">_screen_width</span> + <span class="ruby-value">80</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -583,9 +580,9 @@ </main> <footer id="validator-badges" role="contentinfo"> <p><a href="http://validator.w3.org/check/referer">Validate</a> - <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.2. - <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. </footer>