doc/Bovem/Console.html in bovem-2.0.0 vs doc/Bovem/Console.html in bovem-2.0.1

- old
+ new

@@ -371,20 +371,20 @@ <tr> <td> <pre class="lines"> -636 -637 -638 -639 640 641 -642</pre> +642 +643 +644 +645 +646</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 636</span> + <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 640</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='ivar'>@line_width</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_screen_width'>get_screen_width</span> <span class='ivar'>@indentation</span> <span class='op'>=</span> <span class='int'>0</span> <span class='ivar'>@indentation_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span> @@ -430,11 +430,11 @@ <span class='type'>(<tt>Fixnum</tt>)</span> &mdash; - <div class='inline'><p>the current value of indentation</p> + <div class='inline'><p>Current indentation width.</p> </div> </li> </ul> @@ -443,19 +443,69 @@ <tr> <td> <pre class="lines"> -616 -617 -618</pre> +620 +621 +622 +623 +624 +625 +626 +627 +628 +629 +630 +631 +632 +633 +634 +635 +636 +637 +638 +639 +640 +641 +642 +643 +644 +645 +646 +647</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 616</span> + <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 620</span> -<span class='kw'>def</span> <span class='id identifier rubyid_indentation'>indentation</span> - <span class='ivar'>@indentation</span> +<span class='kw'>class</span> <span class='const'>Console</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:line_width</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:screen_width</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:indentation</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:indentation_string</span> + + <span class='id identifier rubyid_include'>include</span> <span class='const'>Lazier</span><span class='op'>::</span><span class='const'>I18n</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>StyleHandling</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Output</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Logging</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Interactions</span> + + <span class='comment'># Returns a unique instance for Console. +</span> <span class='comment'># +</span> <span class='comment'># @return [Console] A new instance. +</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span> + <span class='ivar'>@instance</span> <span class='op'>||=</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> + <span class='kw'>end</span> + + <span class='comment'># Initializes a new Console. +</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> + <span class='ivar'>@line_width</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_screen_width'>get_screen_width</span> + <span class='ivar'>@indentation</span> <span class='op'>=</span> <span class='int'>0</span> + <span class='ivar'>@indentation_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span> + <span class='ivar'>@stty</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>which stty</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_i18n_setup'>i18n_setup</span><span class='lparen'>(</span><span class='symbol'>:bovem</span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_absolute_path'>absolute_path</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/../../locales/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> + <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -489,11 +539,11 @@ <span class='type'>(<tt>String</tt>)</span> &mdash; - <div class='inline'><p>the current value of indentation_string</p> + <div class='inline'><p>The string used for indentation.</p> </div> </li> </ul> @@ -502,19 +552,69 @@ <tr> <td> <pre class="lines"> -616 -617 -618</pre> +620 +621 +622 +623 +624 +625 +626 +627 +628 +629 +630 +631 +632 +633 +634 +635 +636 +637 +638 +639 +640 +641 +642 +643 +644 +645 +646 +647</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 616</span> + <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 620</span> -<span class='kw'>def</span> <span class='id identifier rubyid_indentation_string'>indentation_string</span> - <span class='ivar'>@indentation_string</span> +<span class='kw'>class</span> <span class='const'>Console</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:line_width</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:screen_width</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:indentation</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:indentation_string</span> + + <span class='id identifier rubyid_include'>include</span> <span class='const'>Lazier</span><span class='op'>::</span><span class='const'>I18n</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>StyleHandling</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Output</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Logging</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Interactions</span> + + <span class='comment'># Returns a unique instance for Console. +</span> <span class='comment'># +</span> <span class='comment'># @return [Console] A new instance. +</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span> + <span class='ivar'>@instance</span> <span class='op'>||=</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> + <span class='kw'>end</span> + + <span class='comment'># Initializes a new Console. +</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> + <span class='ivar'>@line_width</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_screen_width'>get_screen_width</span> + <span class='ivar'>@indentation</span> <span class='op'>=</span> <span class='int'>0</span> + <span class='ivar'>@indentation_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span> + <span class='ivar'>@stty</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>which stty</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_i18n_setup'>i18n_setup</span><span class='lparen'>(</span><span class='symbol'>:bovem</span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_absolute_path'>absolute_path</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/../../locales/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> + <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -548,11 +648,11 @@ <span class='type'>(<tt>Fixnum</tt>)</span> &mdash; - <div class='inline'><p>the current value of line_width</p> + <div class='inline'><p>The line width. Default to <code>80</code>.</p> </div> </li> </ul> @@ -561,19 +661,69 @@ <tr> <td> <pre class="lines"> -616 -617 -618</pre> +620 +621 +622 +623 +624 +625 +626 +627 +628 +629 +630 +631 +632 +633 +634 +635 +636 +637 +638 +639 +640 +641 +642 +643 +644 +645 +646 +647</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 616</span> + <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 620</span> -<span class='kw'>def</span> <span class='id identifier rubyid_line_width'>line_width</span> - <span class='ivar'>@line_width</span> +<span class='kw'>class</span> <span class='const'>Console</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:line_width</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:screen_width</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:indentation</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:indentation_string</span> + + <span class='id identifier rubyid_include'>include</span> <span class='const'>Lazier</span><span class='op'>::</span><span class='const'>I18n</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>StyleHandling</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Output</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Logging</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Interactions</span> + + <span class='comment'># Returns a unique instance for Console. +</span> <span class='comment'># +</span> <span class='comment'># @return [Console] A new instance. +</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span> + <span class='ivar'>@instance</span> <span class='op'>||=</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> + <span class='kw'>end</span> + + <span class='comment'># Initializes a new Console. +</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> + <span class='ivar'>@line_width</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_screen_width'>get_screen_width</span> + <span class='ivar'>@indentation</span> <span class='op'>=</span> <span class='int'>0</span> + <span class='ivar'>@indentation_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span> + <span class='ivar'>@stty</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>which stty</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_i18n_setup'>i18n_setup</span><span class='lparen'>(</span><span class='symbol'>:bovem</span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_absolute_path'>absolute_path</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/../../locales/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> + <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -607,11 +757,11 @@ <span class='type'>(<tt>Fixnum</tt>)</span> &mdash; - <div class='inline'><p>the current value of screen_width</p> + <div class='inline'><p>The current screen width.</p> </div> </li> </ul> @@ -620,19 +770,69 @@ <tr> <td> <pre class="lines"> -616 -617 -618</pre> +620 +621 +622 +623 +624 +625 +626 +627 +628 +629 +630 +631 +632 +633 +634 +635 +636 +637 +638 +639 +640 +641 +642 +643 +644 +645 +646 +647</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 616</span> + <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 620</span> -<span class='kw'>def</span> <span class='id identifier rubyid_screen_width'>screen_width</span> - <span class='ivar'>@screen_width</span> +<span class='kw'>class</span> <span class='const'>Console</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:line_width</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:screen_width</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:indentation</span> + <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:indentation_string</span> + + <span class='id identifier rubyid_include'>include</span> <span class='const'>Lazier</span><span class='op'>::</span><span class='const'>I18n</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>StyleHandling</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Output</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Logging</span> + <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ConsoleMethods</span><span class='op'>::</span><span class='const'>Interactions</span> + + <span class='comment'># Returns a unique instance for Console. +</span> <span class='comment'># +</span> <span class='comment'># @return [Console] A new instance. +</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span> + <span class='ivar'>@instance</span> <span class='op'>||=</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> + <span class='kw'>end</span> + + <span class='comment'># Initializes a new Console. +</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> + <span class='ivar'>@line_width</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_screen_width'>get_screen_width</span> + <span class='ivar'>@indentation</span> <span class='op'>=</span> <span class='int'>0</span> + <span class='ivar'>@indentation_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span> + <span class='ivar'>@stty</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>which stty</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_i18n_setup'>i18n_setup</span><span class='lparen'>(</span><span class='symbol'>:bovem</span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_absolute_path'>absolute_path</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/../../locales/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> + <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -684,16 +884,16 @@ <tr> <td> <pre class="lines"> -631 -632 -633</pre> +635 +636 +637</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 631</span> + <pre class="code"><span class="info file"># File 'lib/bovem/console.rb', line 635</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span> <span class='ivar'>@instance</span> <span class='op'>||=</span> <span class='op'>::</span><span class='const'>Bovem</span><span class='op'>::</span><span class='const'>Console</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>end</span></pre> </td> @@ -704,10 +904,10 @@ </div> </div> <div id="footer"> - Generated on Fri Feb 1 23:40:18 2013 by + Generated on Sat Feb 2 09:25:38 2013 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.3 (ruby-1.9.3). </div> </body> \ No newline at end of file