bind_log_analyzer 0.1.1 → 0.2.0

data/doc/BindLogAnalyzer/Connector.html

@@ -101,7 +101,7 @@
 
   
     <h2>
-      Instance Method Summary
+      Class Method Summary
       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
     </h2>
 
@@ -110,7 +110,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#connect-instance_method" title="#connect (instance method)">- (Object) <strong>connect</strong> </a>
+      <a href="#connect-class_method" title="connect (class method)">+ (Object) <strong>connect</strong> </a>
     
 
     
@@ -133,6 +133,85 @@
         <li class="public ">
   <span class="summary_signature">
     
+      <a href="#establish_connection-class_method" title="establish_connection (class method)">+ (Object) <strong>establish_connection</strong>(database_params, log_level) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Setups the database params calling #setup_db_confs and log level calling
+#set_log_level then connects to the database.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#set_log_level-class_method" title="set_log_level (class method)">+ (Object) <strong>set_log_level</strong>(log_level) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Sets the log level.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#setup_db_confs-class_method" title="setup_db_confs (class method)">+ (Object) <strong>setup_db_confs</strong>(database_params) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Analyzes the database_params param and extracts the database parameters.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#connected%3F-instance_method" title="#connected? (instance method)">- (true, false) <strong>connected?</strong> </a>
     
 
@@ -228,14 +307,14 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
 
 
 
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
     
     
       <div class="method_details first">
-  <p class="signature first" id="connect-instance_method">
+  <p class="signature first" id="connect-class_method">
   
-    - (<tt>Object</tt>) <strong>connect</strong> 
+    + (<tt>Object</tt>) <strong>connect</strong> 
   
 
   
@@ -256,14 +335,14 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
       <pre class="lines">
 
 
-44
-45
-46</pre>
+34
+35
+36</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 44</span>
+      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 34</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_connect'>connect</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span>
   <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_establish_connection'>establish_connection</span><span class='lparen'>(</span><span class='ivar'>@database_params</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -272,7 +351,275 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
 </div>
     
       <div class="method_details ">
-  <p class="signature " id="connected?-instance_method">
+  <p class="signature " id="establish_connection-class_method">
+  
+    + (<tt>Object</tt>) <strong>establish_connection</strong>(database_params, log_level) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>Setups the database params calling #setup_db_confs and log level calling
+#set_log_level then connects to the database</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>database_params</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>, <tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The path to the database configurations file or a hash containing such
+informations</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>logfile</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The path to the file containing the Bind's logs to analyze</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+52
+53
+54
+55
+56</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 52</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_establish_connection'>establish_connection</span><span class='lparen'>(</span><span class='id identifier rubyid_database_params'>database_params</span><span class='comma'>,</span> <span class='id identifier rubyid_log_level'>log_level</span><span class='rparen'>)</span>
+  <span class='const'>BindLogAnalyzer</span><span class='op'>::</span><span class='const'>Connector</span><span class='period'>.</span><span class='id identifier rubyid_setup_db_confs'>setup_db_confs</span><span class='lparen'>(</span><span class='id identifier rubyid_database_params'>database_params</span><span class='rparen'>)</span>  
+  <span class='const'>BindLogAnalyzer</span><span class='op'>::</span><span class='const'>Connector</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span>
+  <span class='const'>BindLogAnalyzer</span><span class='op'>::</span><span class='const'>Connector</span><span class='period'>.</span><span class='id identifier rubyid_set_log_level'>set_log_level</span><span class='lparen'>(</span><span class='id identifier rubyid_log_level'>log_level</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="set_log_level-class_method">
+  
+    + (<tt>Object</tt>) <strong>set_log_level</strong>(log_level) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>Sets the log level</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>logfile</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The path to the file containing the Bind's logs to analyze</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 86</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_set_log_level'>set_log_level</span><span class='lparen'>(</span><span class='id identifier rubyid_log_level'>log_level</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_log_level'>log_level</span> <span class='op'>&gt;</span> <span class='int'>0</span>
+    
+    <span class='id identifier rubyid_log_level_class'>log_level_class</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+      <span class='int'>1</span> <span class='op'>=&gt;</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>WARN</span><span class='comma'>,</span>
+      <span class='int'>2</span> <span class='op'>=&gt;</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>INFO</span><span class='comma'>,</span>
+      <span class='int'>3</span> <span class='op'>=&gt;</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>DEBUG</span>
+    <span class='rbrace'>}</span>
+
+    <span class='id identifier rubyid_log'>log</span> <span class='op'>=</span> <span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='const'>STDOUT</span>
+    <span class='id identifier rubyid_log'>log</span><span class='period'>.</span><span class='id identifier rubyid_level'>level</span> <span class='op'>=</span> <span class='id identifier rubyid_log_level_class'>log_level_class</span><span class='lbracket'>[</span><span class='id identifier rubyid_log_level'>log_level</span><span class='rbracket'>]</span>
+    <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='id identifier rubyid_log'>log</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="setup_db_confs-class_method">
+  
+    + (<tt>Object</tt>) <strong>setup_db_confs</strong>(database_params) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>Analyzes the database_params param and extracts the database parameters.
+Raises BindLogAnalyzer::DatabaseConfsNotValid if it can't find any useful
+information</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>database_params</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>, <tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The path to the database configurations file or a hash containing such
+informations</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 61</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_setup_db_confs'>setup_db_confs</span><span class='lparen'>(</span><span class='id identifier rubyid_database_params'>database_params</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_database_params'>database_params</span>
+    <span class='kw'>if</span> <span class='id identifier rubyid_database_params'>database_params</span><span class='period'>.</span><span class='id identifier rubyid_instance_of?'>instance_of?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
+      <span class='ivar'>@database_params</span> <span class='op'>=</span> <span class='id identifier rubyid_database_params'>database_params</span>
+    <span class='kw'>else</span>
+      <span class='comment'># Load the yaml file
+</span>      <span class='kw'>if</span> <span class='const'>FileTest</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span><span class='lparen'>(</span><span class='id identifier rubyid_database_params'>database_params</span><span class='rparen'>)</span>
+        <span class='ivar'>@database_params</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='op'>::</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_database_params'>database_params</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>database</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
+      <span class='kw'>else</span>
+        <span class='id identifier rubyid_raise'>raise</span> <span class='const'>BindLogAnalyzer</span><span class='op'>::</span><span class='const'>DatabaseConfsNotValid</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The indicated YAML file doesn't exist or is invalid</span><span class='tstring_end'>&quot;</span></span>
+      <span class='kw'>end</span>
+    <span class='kw'>end</span>
+  <span class='kw'>else</span>
+    <span class='comment'># Tries to find the yaml file or prints an error
+</span>    <span class='id identifier rubyid_filename'>filename</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</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='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>database.yml</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+    <span class='kw'>if</span> <span class='const'>FileTest</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span>
+        <span class='ivar'>@database_params</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='op'>::</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>database</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
+    <span class='kw'>else</span>
+      <span class='id identifier rubyid_raise'>raise</span> <span class='const'>BindLogAnalyzer</span><span class='op'>::</span><span class='const'>DatabaseConfsNotValid</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Can't find valid database configurations</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="connected?-instance_method">
   
     - (<tt>true</tt>, <tt>false</tt>) <strong>connected?</strong> 
   
@@ -313,12 +660,12 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+40
+41
+42</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 40</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_connected?'>connected?</span>
   <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_connected?'>connected?</span>
@@ -352,12 +699,12 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
       <pre class="lines">
 
 
-55
-56
-57</pre>
+45
+46
+47</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 55</span>
+      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 45</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_load_environment'>load_environment</span>
   <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_glob'>glob</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>./lib/models/*</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='id identifier rubyid_require'>require</span> <span class='id identifier rubyid_r'>r</span> <span class='rbrace'>}</span>
@@ -391,14 +738,14 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
       <pre class="lines">
 
 
-37
-38
-39
-40
-41</pre>
+27
+28
+29
+30
+31</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 37</span>
+      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 27</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_migrate_tables'>migrate_tables</span>
   <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Migration</span><span class='period'>.</span><span class='id identifier rubyid_verbose'>verbose</span> <span class='op'>=</span> <span class='kw'>true</span>
@@ -491,7 +838,6 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
       <pre class="lines">
 
 
-13
 14
 15
 16
@@ -502,42 +848,21 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
 21
 22
 23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34</pre>
+24</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 14</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_setup_db'>setup_db</span><span class='lparen'>(</span><span class='id identifier rubyid_database_params'>database_params</span><span class='comma'>,</span> <span class='id identifier rubyid_setup_database'>setup_database</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_log_level'>log_level</span> <span class='op'>=</span> <span class='int'>0</span><span class='rparen'>)</span>
-  <span class='ivar'>@database_params</span> <span class='op'>=</span> <span class='id identifier rubyid_database_params'>database_params</span>
-  
-  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span>
+  <span class='const'>BindLogAnalyzer</span><span class='op'>::</span><span class='const'>Connector</span><span class='period'>.</span><span class='id identifier rubyid_setup_db_confs'>setup_db_confs</span><span class='lparen'>(</span><span class='id identifier rubyid_database_params'>database_params</span><span class='rparen'>)</span>
+
+  <span class='const'>BindLogAnalyzer</span><span class='op'>::</span><span class='const'>Connector</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span>
 
   <span class='id identifier rubyid_migrate_tables'>migrate_tables</span> <span class='kw'>if</span> <span class='id identifier rubyid_setup_database'>setup_database</span>
 
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_environment'>load_environment</span>
 
-  <span class='kw'>if</span> <span class='id identifier rubyid_log_level'>log_level</span> <span class='op'>&gt;</span> <span class='int'>0</span>
-    
-    <span class='id identifier rubyid_log_level_class'>log_level_class</span> <span class='op'>=</span> <span class='lbrace'>{</span>
-      <span class='int'>1</span> <span class='op'>=&gt;</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>WARN</span><span class='comma'>,</span>
-      <span class='int'>2</span> <span class='op'>=&gt;</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>INFO</span><span class='comma'>,</span>
-      <span class='int'>3</span> <span class='op'>=&gt;</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>DEBUG</span>
-    <span class='rbrace'>}</span>
-
-    <span class='id identifier rubyid_log'>log</span> <span class='op'>=</span> <span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='const'>STDOUT</span>
-    <span class='id identifier rubyid_log'>log</span><span class='period'>.</span><span class='id identifier rubyid_level'>level</span> <span class='op'>=</span> <span class='id identifier rubyid_log_level_class'>log_level_class</span><span class='lbracket'>[</span><span class='id identifier rubyid_log_level'>log_level</span><span class='rbracket'>]</span>
-    <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='id identifier rubyid_log'>log</span>
-  <span class='kw'>end</span>
+  <span class='const'>BindLogAnalyzer</span><span class='op'>::</span><span class='const'>Connector</span><span class='period'>.</span><span class='id identifier rubyid_set_log_level'>set_log_level</span><span class='lparen'>(</span><span class='id identifier rubyid_log_level'>log_level</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -549,7 +874,7 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
 </div>
     
     <div id="footer">
-  Generated on Tue Apr  3 17:01:10 2012 by 
+  Generated on Thu Apr  5 16:11:31 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>