bind_log_analyzer 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. data/.gitignore +1 -0
  2. data/README.md +10 -0
  3. data/doc/BindLogAnalyzer.html +166 -0
  4. data/doc/BindLogAnalyzer/Base.html +1016 -0
  5. data/doc/BindLogAnalyzer/Connector.html +558 -0
  6. data/doc/BindLogAnalyzer/DatabaseConfsNotValid.html +127 -0
  7. data/doc/Log.html +127 -0
  8. data/doc/_index.html +156 -0
  9. data/doc/class_list.html +47 -0
  10. data/doc/css/common.css +1 -0
  11. data/doc/css/full_list.css +55 -0
  12. data/doc/css/style.css +322 -0
  13. data/doc/file.README.html +215 -0
  14. data/doc/file_list.html +49 -0
  15. data/doc/frames.html +13 -0
  16. data/doc/index.html +215 -0
  17. data/doc/js/app.js +205 -0
  18. data/doc/js/full_list.js +173 -0
  19. data/doc/js/jquery.js +16 -0
  20. data/doc/method_list.html +150 -0
  21. data/doc/top-level-namespace.html +107 -0
  22. data/lib/bind_log_analyzer.rb +2 -0
  23. data/lib/bind_log_analyzer/base.rb +25 -1
  24. data/lib/bind_log_analyzer/connector.rb +12 -0
  25. data/lib/bind_log_analyzer/exceptions.rb +1 -0
  26. data/lib/bind_log_analyzer/version.rb +2 -1
  27. data/lib/models/log.rb +1 -0
  28. metadata +27 -7
data/doc/BindLogAnalyzer/Connector.html ADDED
@@ -0,0 +1,558 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: BindLogAnalyzer::Connector
8
+
9
+ &mdash; Documentation by YARD 0.7.5
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (C)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../BindLogAnalyzer.html" title="BindLogAnalyzer (module)">BindLogAnalyzer</a></span></span>
38
+ &raquo;
39
+ <span class="title">Connector</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Module: BindLogAnalyzer::Connector
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+ <dt class="r1">Included in:</dt>
74
+ <dd class="r1"><span class='object_link'><a href="Base.html" title="BindLogAnalyzer::Base (class)">Base</a></span></dd>
75
+
76
+
77
+
78
+ <dt class="r2 last">Defined in:</dt>
79
+ <dd class="r2 last">lib/bind_log_analyzer/connector.rb</dd>
80
+
81
+ </dl>
82
+ <div class="clear"></div>
83
+
84
+ <h2>Overview</h2><div class="docstring">
85
+ <div class="discussion">
86
+
87
+ <p>The module which provides connection facility</p>
88
+
89
+
90
+ </div>
91
+ </div>
92
+ <div class="tags">
93
+
94
+
95
+ </div>
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+ <h2>
104
+ Instance Method Summary
105
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
106
+ </h2>
107
+
108
+ <ul class="summary">
109
+
110
+ <li class="public ">
111
+ <span class="summary_signature">
112
+
113
+ <a href="#connect-instance_method" title="#connect (instance method)">- (Object) <strong>connect</strong> </a>
114
+
115
+
116
+
117
+ </span>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+ <span class="summary_desc"><div class='inline'>
127
+ <p>Establishes the connection to the database.</p>
128
+ </div></span>
129
+
130
+ </li>
131
+
132
+
133
+ <li class="public ">
134
+ <span class="summary_signature">
135
+
136
+ <a href="#connected%3F-instance_method" title="#connected? (instance method)">- (true, false) <strong>connected?</strong> </a>
137
+
138
+
139
+
140
+ </span>
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+ <span class="summary_desc"><div class='inline'>
150
+ <p>Shows the status of the connection to the database.</p>
151
+ </div></span>
152
+
153
+ </li>
154
+
155
+
156
+ <li class="public ">
157
+ <span class="summary_signature">
158
+
159
+ <a href="#load_environment-instance_method" title="#load_environment (instance method)">- (Object) <strong>load_environment</strong> </a>
160
+
161
+
162
+
163
+ </span>
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+ <span class="summary_desc"><div class='inline'>
173
+ <p>Loads the ActiveRecord models.</p>
174
+ </div></span>
175
+
176
+ </li>
177
+
178
+
179
+ <li class="public ">
180
+ <span class="summary_signature">
181
+
182
+ <a href="#migrate_tables-instance_method" title="#migrate_tables (instance method)">- (Object) <strong>migrate_tables</strong> </a>
183
+
184
+
185
+
186
+ </span>
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Launches ActiveRecord migrations.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#setup_db-instance_method" title="#setup_db (instance method)">- (Object) <strong>setup_db</strong>(database_params, setup_database = false, log_level = 0) </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+ <span class="summary_desc"><div class='inline'>
219
+ <p>Main connection method which connects to the database, launches migrations
220
+ if requested, loads the Log ActiveRecord model and setups the logger.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ </ul>
227
+
228
+
229
+
230
+
231
+ <div id="instance_method_details" class="method_details_list">
232
+ <h2>Instance Method Details</h2>
233
+
234
+
235
+ <div class="method_details first">
236
+ <p class="signature first" id="connect-instance_method">
237
+
238
+ - (<tt>Object</tt>) <strong>connect</strong>
239
+
240
+
241
+
242
+ </p><div class="docstring">
243
+ <div class="discussion">
244
+
245
+ <p>Establishes the connection to the database</p>
246
+
247
+
248
+ </div>
249
+ </div>
250
+ <div class="tags">
251
+
252
+
253
+ </div><table class="source_code">
254
+ <tr>
255
+ <td>
256
+ <pre class="lines">
257
+
258
+
259
+ 44
260
+ 45
261
+ 46</pre>
262
+ </td>
263
+ <td>
264
+ <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 44</span>
265
+
266
+ <span class='kw'>def</span> <span class='id identifier rubyid_connect'>connect</span>
267
+ <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>
268
+ <span class='kw'>end</span></pre>
269
+ </td>
270
+ </tr>
271
+ </table>
272
+ </div>
273
+
274
+ <div class="method_details ">
275
+ <p class="signature " id="connected?-instance_method">
276
+
277
+ - (<tt>true</tt>, <tt>false</tt>) <strong>connected?</strong>
278
+
279
+
280
+
281
+ </p><div class="docstring">
282
+ <div class="discussion">
283
+
284
+ <p>Shows the status of the connection to the database</p>
285
+
286
+
287
+ </div>
288
+ </div>
289
+ <div class="tags">
290
+
291
+ <h3>Returns:</h3>
292
+ <ul class="return">
293
+
294
+ <li>
295
+
296
+
297
+ <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
298
+
299
+
300
+
301
+ &mdash;
302
+ <div class='inline'>
303
+ <p>The status of the connection to the database</p>
304
+ </div>
305
+
306
+ </li>
307
+
308
+ </ul>
309
+
310
+ </div><table class="source_code">
311
+ <tr>
312
+ <td>
313
+ <pre class="lines">
314
+
315
+
316
+ 50
317
+ 51
318
+ 52</pre>
319
+ </td>
320
+ <td>
321
+ <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 50</span>
322
+
323
+ <span class='kw'>def</span> <span class='id identifier rubyid_connected?'>connected?</span>
324
+ <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>
325
+ <span class='kw'>end</span></pre>
326
+ </td>
327
+ </tr>
328
+ </table>
329
+ </div>
330
+
331
+ <div class="method_details ">
332
+ <p class="signature " id="load_environment-instance_method">
333
+
334
+ - (<tt>Object</tt>) <strong>load_environment</strong>
335
+
336
+
337
+
338
+ </p><div class="docstring">
339
+ <div class="discussion">
340
+
341
+ <p>Loads the ActiveRecord models</p>
342
+
343
+
344
+ </div>
345
+ </div>
346
+ <div class="tags">
347
+
348
+
349
+ </div><table class="source_code">
350
+ <tr>
351
+ <td>
352
+ <pre class="lines">
353
+
354
+
355
+ 55
356
+ 56
357
+ 57</pre>
358
+ </td>
359
+ <td>
360
+ <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 55</span>
361
+
362
+ <span class='kw'>def</span> <span class='id identifier rubyid_load_environment'>load_environment</span>
363
+ <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>
364
+ <span class='kw'>end</span></pre>
365
+ </td>
366
+ </tr>
367
+ </table>
368
+ </div>
369
+
370
+ <div class="method_details ">
371
+ <p class="signature " id="migrate_tables-instance_method">
372
+
373
+ - (<tt>Object</tt>) <strong>migrate_tables</strong>
374
+
375
+
376
+
377
+ </p><div class="docstring">
378
+ <div class="discussion">
379
+
380
+ <p>Launches ActiveRecord migrations</p>
381
+
382
+
383
+ </div>
384
+ </div>
385
+ <div class="tags">
386
+
387
+
388
+ </div><table class="source_code">
389
+ <tr>
390
+ <td>
391
+ <pre class="lines">
392
+
393
+
394
+ 37
395
+ 38
396
+ 39
397
+ 40
398
+ 41</pre>
399
+ </td>
400
+ <td>
401
+ <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 37</span>
402
+
403
+ <span class='kw'>def</span> <span class='id identifier rubyid_migrate_tables'>migrate_tables</span>
404
+ <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>
405
+ <span class='id identifier rubyid_migrations_dir'>migrations_dir</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'>..</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>..</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>db/migrate</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
406
+ <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Migrator</span><span class='period'>.</span><span class='id identifier rubyid_migrate'>migrate</span> <span class='id identifier rubyid_migrations_dir'>migrations_dir</span>
407
+ <span class='kw'>end</span></pre>
408
+ </td>
409
+ </tr>
410
+ </table>
411
+ </div>
412
+
413
+ <div class="method_details ">
414
+ <p class="signature " id="setup_db-instance_method">
415
+
416
+ - (<tt>Object</tt>) <strong>setup_db</strong>(database_params, setup_database = false, log_level = 0)
417
+
418
+
419
+
420
+ </p><div class="docstring">
421
+ <div class="discussion">
422
+
423
+ <p>Main connection method which connects to the database, launches migrations
424
+ if requested, loads the Log ActiveRecord model and setups the logger.</p>
425
+
426
+
427
+ </div>
428
+ </div>
429
+ <div class="tags">
430
+ <h3>Parameters:</h3>
431
+ <ul class="param">
432
+
433
+ <li>
434
+
435
+ <span class='name'>database_params</span>
436
+
437
+
438
+ <span class='type'>(<tt>Hash</tt>)</span>
439
+
440
+
441
+
442
+ &mdash;
443
+ <div class='inline'>
444
+ <p>The database params and credentials</p>
445
+ </div>
446
+
447
+ </li>
448
+
449
+ <li>
450
+
451
+ <span class='name'>setup_database</span>
452
+
453
+
454
+ <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
455
+
456
+
457
+ <em class="default">(defaults to: <tt>false</tt>)</em>
458
+
459
+
460
+ &mdash;
461
+ <div class='inline'>
462
+ <p>If true launches the migrations of the database</p>
463
+ </div>
464
+
465
+ </li>
466
+
467
+ <li>
468
+
469
+ <span class='name'>log_level</span>
470
+
471
+
472
+ <span class='type'>(<tt>Integer</tt>)</span>
473
+
474
+
475
+ <em class="default">(defaults to: <tt>0</tt>)</em>
476
+
477
+
478
+ &mdash;
479
+ <div class='inline'>
480
+ <p>The log level to setup the Logger</p>
481
+ </div>
482
+
483
+ </li>
484
+
485
+ </ul>
486
+
487
+
488
+ </div><table class="source_code">
489
+ <tr>
490
+ <td>
491
+ <pre class="lines">
492
+
493
+
494
+ 13
495
+ 14
496
+ 15
497
+ 16
498
+ 17
499
+ 18
500
+ 19
501
+ 20
502
+ 21
503
+ 22
504
+ 23
505
+ 24
506
+ 25
507
+ 26
508
+ 27
509
+ 28
510
+ 29
511
+ 30
512
+ 31
513
+ 32
514
+ 33
515
+ 34</pre>
516
+ </td>
517
+ <td>
518
+ <pre class="code"><span class="info file"># File 'lib/bind_log_analyzer/connector.rb', line 13</span>
519
+
520
+ <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>
521
+ <span class='ivar'>@database_params</span> <span class='op'>=</span> <span class='id identifier rubyid_database_params'>database_params</span>
522
+
523
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span>
524
+
525
+ <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>
526
+
527
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_environment'>load_environment</span>
528
+
529
+ <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>
530
+
531
+ <span class='id identifier rubyid_log_level_class'>log_level_class</span> <span class='op'>=</span> <span class='lbrace'>{</span>
532
+ <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>
533
+ <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>
534
+ <span class='int'>3</span> <span class='op'>=&gt;</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>DEBUG</span>
535
+ <span class='rbrace'>}</span>
536
+
537
+ <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>
538
+ <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>
539
+ <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>
540
+ <span class='kw'>end</span>
541
+ <span class='kw'>end</span></pre>
542
+ </td>
543
+ </tr>
544
+ </table>
545
+ </div>
546
+
547
+ </div>
548
+
549
+ </div>
550
+
551
+ <div id="footer">
552
+ Generated on Tue Apr 3 17:01:10 2012 by
553
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
554
+ 0.7.5 (ruby-1.9.3).
555
+ </div>
556
+
557
+ </body>
558
+ </html>