bovem 2.0.0 → 2.0.1

data/doc/Bovem/Shell.html

@@ -140,7 +140,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><h1>A console instance.</h1>
+    <span class="summary_desc"><div class='inline'><p>A console instance.</p>
 </div></span>
   
 </li>
@@ -303,13 +303,13 @@
       <pre class="lines">
 
 
-559
 560
 561
-562</pre>
+562
+563</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 559</span>
+      <pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 560</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
   <span class='ivar'>@console</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_instance'>instance</span>
@@ -338,7 +338,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <h1>A console instance.</h1>
+    <p>A console instance.</p>
 
 
   </div>
@@ -356,7 +356,7 @@
       
       
         &mdash;
-        <div class='inline'><p>the current value of console</p>
+        <div class='inline'><p>A console instance.</p>
 </div>
       
     </li>
@@ -369,15 +369,55 @@
       <pre class="lines">
 
 
-541
 542
-543</pre>
+543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 541</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_console'>console</span>
-  <span class='ivar'>@console</span>
+      <pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 542</span>
+
+<span class='kw'>class</span> <span class='const'>Shell</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'>ShellMethods</span><span class='op'>::</span><span class='const'>General</span>
+  <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ShellMethods</span><span class='op'>::</span><span class='const'>Read</span>
+  <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ShellMethods</span><span class='op'>::</span><span class='const'>Write</span>
+  <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ShellMethods</span><span class='op'>::</span><span class='const'>Execute</span>
+  <span class='id identifier rubyid_include'>include</span> <span class='const'>Bovem</span><span class='op'>::</span><span class='const'>ShellMethods</span><span class='op'>::</span><span class='const'>Directories</span>
+
+  <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:console</span>
+
+  <span class='comment'># Returns a unique instance for Shell.
+</span>  <span class='comment'>#
+</span>  <span class='comment'># @return [Shell] 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'>Shell</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='kw'>end</span>
+
+  <span class='comment'># Initializes a new Shell.
+</span>  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
+    <span class='ivar'>@console</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_instance'>instance</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>
@@ -433,12 +473,12 @@
       <pre class="lines">
 
 
-554
 555
-556</pre>
+556
+557</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 554</span>
+      <pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 555</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'>Shell</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
@@ -453,7 +493,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:18 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/Bovem/ShellMethods.html

@@ -116,7 +116,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/Bovem/ShellMethods/Directories.html

@@ -475,7 +475,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/Bovem/ShellMethods/Execute.html

@@ -556,7 +556,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/Bovem/ShellMethods/General.html

@@ -441,7 +441,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/Bovem/ShellMethods/Read.html

@@ -442,7 +442,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/Bovem/ShellMethods/Write.html

@@ -667,7 +667,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/Bovem/Version.html

@@ -180,7 +180,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:18 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/_index.html

@@ -346,7 +346,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/file.README.html

@@ -99,7 +99,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/index.html

@@ -99,7 +99,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/doc/method_list.html

@@ -255,17 +255,17 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Bovem/Configuration.html#initialize-instance_method" title="Bovem::Configuration#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Bovem/Console.html#initialize-instance_method" title="Bovem::Console#initialize (method)">#initialize</a></span>
     
-      <small>Bovem::Configuration</small>
+      <small>Bovem::Console</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Bovem/Shell.html#initialize-instance_method" title="Bovem::Shell#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Bovem/Configuration.html#initialize-instance_method" title="Bovem::Configuration#initialize (method)">#initialize</a></span>
     
-      <small>Bovem::Shell</small>
+      <small>Bovem::Configuration</small>
     
   </li>
   
@@ -279,25 +279,25 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Bovem/Console.html#initialize-instance_method" title="Bovem::Console#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Bovem/Shell.html#initialize-instance_method" title="Bovem::Shell#initialize (method)">#initialize</a></span>
     
-      <small>Bovem::Console</small>
+      <small>Bovem::Shell</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Bovem/Console.html#instance-class_method" title="Bovem::Console.instance (method)">instance</a></span>
+    <span class='object_link'><a href="Bovem/Shell.html#instance-class_method" title="Bovem::Shell.instance (method)">instance</a></span>
     
-      <small>Bovem::Console</small>
+      <small>Bovem::Shell</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Bovem/Shell.html#instance-class_method" title="Bovem::Shell.instance (method)">instance</a></span>
+    <span class='object_link'><a href="Bovem/Console.html#instance-class_method" title="Bovem::Console.instance (method)">instance</a></span>
     
-      <small>Bovem::Shell</small>
+      <small>Bovem::Console</small>
     
   </li>
   
@@ -431,14 +431,6 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Bovem/Logger.html#start_time-instance_method" title="Bovem::Logger#start_time (method)">#start_time</a></span>
-    
-      <small>Bovem::Logger</small>
-    
-  </li>
-  
-
-  <li class="r2 ">
     <span class='object_link'><a href="Bovem/Logger.html#start_time-class_method" title="Bovem::Logger.start_time (method)">start_time</a></span>
     
       <small>Bovem::Logger</small>
@@ -446,7 +438,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Bovem/ConsoleMethods/Logging.html#status-instance_method" title="Bovem::ConsoleMethods::Logging#status (method)">#status</a></span>
     
       <small>Bovem::ConsoleMethods::Logging</small>
@@ -454,7 +446,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Bovem/ConsoleMethods/Interactions.html#task-instance_method" title="Bovem::ConsoleMethods::Interactions#task (method)">#task</a></span>
     
       <small>Bovem::ConsoleMethods::Interactions</small>
@@ -462,7 +454,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Bovem/ConsoleMethods/Logging.html#warn-instance_method" title="Bovem::ConsoleMethods::Logging#warn (method)">#warn</a></span>
     
       <small>Bovem::ConsoleMethods::Logging</small>
@@ -470,7 +462,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Bovem/ConsoleMethods/Output.html#with_indentation-instance_method" title="Bovem::ConsoleMethods::Output#with_indentation (method)">#with_indentation</a></span>
     
       <small>Bovem::ConsoleMethods::Output</small>
@@ -478,7 +470,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Bovem/ShellMethods/Directories.html#within_directory-instance_method" title="Bovem::ShellMethods::Directories#within_directory (method)">#within_directory</a></span>
     
       <small>Bovem::ShellMethods::Directories</small>
@@ -486,7 +478,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Bovem/ConsoleMethods/Output.html#wrap-instance_method" title="Bovem::ConsoleMethods::Output#wrap (method)">#wrap</a></span>
     
       <small>Bovem::ConsoleMethods::Output</small>
@@ -494,7 +486,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Bovem/ConsoleMethods/Logging.html#write-instance_method" title="Bovem::ConsoleMethods::Logging#write (method)">#write</a></span>
     
       <small>Bovem::ConsoleMethods::Logging</small>
@@ -502,7 +494,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Bovem/ConsoleMethods/Logging.html#write_banner_aligned-instance_method" title="Bovem::ConsoleMethods::Logging#write_banner_aligned (method)">#write_banner_aligned</a></span>
     
       <small>Bovem::ConsoleMethods::Logging</small>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Feb  1 23:40:17 2013 by
+  Generated on Sat Feb  2 09:25:37 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>

data/lib/bovem/console.rb

@@ -609,10 +609,14 @@ module Bovem
 
   # This is a text utility wrapper console I/O.
   #
-  # @attr [Fixnum] line_width The line width. Default to `80`.
-  # @attr [Fixnum] screen_width The current screen width.
-  # @attr [Fixnum] indentation Current indentation width.
-  # @attr [String] indentation_string The string used for indentation.
+  # @attribute line_width
+  #   @return [Fixnum] The line width. Default to `80`.
+  # @attribute screen_width
+  #   @return [Fixnum] The current screen width.
+  # @attribute indentation
+  #   @return [Fixnum] Current indentation width.
+  # @attribute indentation_string
+  #   @return [String] The string used for indentation.
   class Console
     attr_accessor :line_width
     attr_accessor :screen_width

data/lib/bovem/logger.rb

@@ -7,10 +7,15 @@
 module Bovem
   # A custom logger.
   #
-  # @attr [Time] start_time The start time of first line. This allows to show a `T+0.1234` information into the log.
-  # @attr [IO|String] device The file or device to log messages to.
+  # @attribute [r] device
+  #   @return [IO|String] The file or device to log messages to.
   class Logger < ::Logger
-    mattr_accessor :start_time
+    # @attribute start_time
+    #   @return [Time] The start time of first line. This allows to show a `T+0.1234` information into the log.
+    class << self
+      attr_accessor :start_time
+    end
+
     attr_reader :device
 
     # Creates a new logger.

data/lib/bovem/shell.rb

@@ -537,7 +537,8 @@ module Bovem
 
   # A utility class for most common shell operation.
   #
-  # @attr [Console] console # A console instance.
+  # @attribute console
+  #   @return [Console] A console instance.
   class Shell
     include Lazier::I18n
     include Bovem::ShellMethods::General

data/lib/bovem/version.rb

@@ -17,7 +17,7 @@ module Bovem
     MINOR = 0
 
     # The patch version.
-    PATCH = 0
+    PATCH = 1
 
     # The current version number of Bovem.
     STRING = [MAJOR, MINOR, PATCH].compact.join(".")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bovem
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors: