flogger 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,531 +0,0 @@
1
- <?xml version="1.0" encoding="utf-8"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
- <head>
6
- <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
-
8
- <title>Class: FLogger::Log</title>
9
-
10
- <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
-
12
- <script src="../js/jquery.js" type="text/javascript"
13
- charset="utf-8"></script>
14
- <script src="../js/thickbox-compressed.js" type="text/javascript"
15
- charset="utf-8"></script>
16
- <script src="../js/quicksearch.js" type="text/javascript"
17
- charset="utf-8"></script>
18
- <script src="../js/darkfish.js" type="text/javascript"
19
- charset="utf-8"></script>
20
-
21
- </head>
22
- <body class="class">
23
-
24
- <div id="metadata">
25
- <div id="home-metadata">
26
- <div id="home-section" class="section">
27
- <h3 class="section-header">
28
- <a href="../index.html">Home</a>
29
- <a href="../index.html#classes">Classes</a>
30
- <a href="../index.html#methods">Methods</a>
31
- </h3>
32
- </div>
33
- </div>
34
-
35
- <div id="file-metadata">
36
- <div id="file-list-section" class="section">
37
- <h3 class="section-header">In Files</h3>
38
- <div class="section-body">
39
- <ul>
40
-
41
- <li><a href="../lib/flogger/log_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
- class="thickbox" title="lib/flogger/log.rb">lib/flogger/log.rb</a></li>
43
-
44
- </ul>
45
- </div>
46
- </div>
47
-
48
-
49
- </div>
50
-
51
- <div id="class-metadata">
52
-
53
- <!-- Parent Class -->
54
-
55
- <div id="parent-class-section" class="section">
56
- <h3 class="section-header">Parent</h3>
57
-
58
- <p class="link">Object</p>
59
-
60
- </div>
61
-
62
-
63
- <!-- Namespace Contents -->
64
-
65
-
66
- <!-- Method Quickref -->
67
-
68
- <div id="method-list-section" class="section">
69
- <h3 class="section-header">Methods</h3>
70
- <ul class="link-list">
71
-
72
- <li><a href="#method-c-new">::new</a></li>
73
-
74
- <li><a href="#method-i-configure">#configure</a></li>
75
-
76
- <li><a href="#method-i-debug">#debug</a></li>
77
-
78
- <li><a href="#method-i-error">#error</a></li>
79
-
80
- <li><a href="#method-i-notice">#notice</a></li>
81
-
82
- <li><a href="#method-i-open">#open</a></li>
83
-
84
- <li><a href="#method-i-output">#output</a></li>
85
-
86
- <li><a href="#method-i-puts">#puts</a></li>
87
-
88
- <li><a href="#method-i-warning">#warning</a></li>
89
-
90
- </ul>
91
- </div>
92
-
93
-
94
- <!-- Included Modules -->
95
-
96
- </div>
97
-
98
- <div id="project-metadata">
99
-
100
-
101
- <div id="fileindex-section" class="section project-section">
102
- <h3 class="section-header">Files</h3>
103
- <ul>
104
-
105
- <li class="file"><a href="../CHANGELOG_rdoc.html">CHANGELOG.rdoc</a></li>
106
-
107
- <li class="file"><a href="../README_rdoc.html">README.rdoc</a></li>
108
-
109
- </ul>
110
- </div>
111
-
112
-
113
- <div id="classindex-section" class="section project-section">
114
- <h3 class="section-header">Class Index
115
- <span class="search-toggle"><img src="../images/find.png"
116
- height="16" width="16" alt="[+]"
117
- title="show/hide quicksearch" /></span></h3>
118
- <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
119
- <fieldset>
120
- <legend>Quicksearch</legend>
121
- <input type="text" name="quicksearch" value=""
122
- class="quicksearch-field" />
123
- </fieldset>
124
- </form>
125
-
126
- <ul class="link-list">
127
-
128
- <li><a href="../FLogger.html">FLogger</a></li>
129
-
130
- <li><a href="../FLogger/Log.html">FLogger::Log</a></li>
131
-
132
- </ul>
133
- <div id="no-class-search-results" style="display: none;">No matching classes.</div>
134
- </div>
135
-
136
-
137
- </div>
138
- </div>
139
-
140
- <div id="documentation">
141
- <h1 class="class">FLogger::Log</h1>
142
-
143
- <div id="description">
144
-
145
- </div>
146
-
147
- <!-- Constants -->
148
-
149
-
150
- <!-- Attributes -->
151
-
152
- <div id="attribute-method-details" class="method-section section">
153
- <h3 class="section-header">Attributes</h3>
154
-
155
-
156
- <div id="logs-attribute-method" class="method-detail">
157
- <a name="logs"></a>
158
-
159
- <div class="method-heading attribute-method-heading">
160
- <span class="method-name">logs</span><span
161
- class="attribute-access-type">[R]</span>
162
- </div>
163
-
164
- <div class="method-description">
165
-
166
-
167
-
168
- </div>
169
- </div>
170
-
171
- </div>
172
-
173
-
174
- <!-- Methods -->
175
-
176
- <div id="public-class-method-details" class="method-section section">
177
- <h3 class="section-header">Public Class Methods</h3>
178
-
179
-
180
- <div id="new-method" class="method-detail ">
181
- <a name="method-c-new"></a>
182
-
183
- <div class="method-heading">
184
-
185
- <span class="method-name">new</span><span
186
- class="method-args">()</span>
187
- <span class="method-click-advice">click to toggle source</span>
188
-
189
- </div>
190
-
191
- <div class="method-description">
192
-
193
-
194
-
195
-
196
-
197
- <div class="method-source-code"
198
- id="new-source">
199
- <pre>
200
- <span class="ruby-comment cmt"># File lib/flogger/log.rb, line 8</span>
201
- 8: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
202
- 9: <span class="ruby-ivar">@logs</span> = <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>(
203
- 10: <span class="ruby-value">:debug</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">'log/debug.txt'</span>,
204
- 11: <span class="ruby-value">:error</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">'log/error.txt'</span>,
205
- 12: <span class="ruby-value">:warning</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">'log/warning.txt'</span>,
206
- 13: <span class="ruby-value">:notice</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">'log/notice.txt'</span>,
207
- 14: <span class="ruby-value">:default</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">'log/logs.txt'</span>
208
- 15: )
209
- 16: <span class="ruby-keyword kw">end</span></pre>
210
- </div>
211
-
212
- </div>
213
-
214
-
215
-
216
-
217
- </div>
218
-
219
-
220
- </div>
221
-
222
- <div id="public-instance-method-details" class="method-section section">
223
- <h3 class="section-header">Public Instance Methods</h3>
224
-
225
-
226
- <div id="configure-method" class="method-detail ">
227
- <a name="method-i-configure"></a>
228
-
229
- <div class="method-heading">
230
-
231
- <span class="method-name">configure</span><span
232
- class="method-args">(&block)</span>
233
- <span class="method-click-advice">click to toggle source</span>
234
-
235
- </div>
236
-
237
- <div class="method-description">
238
-
239
-
240
-
241
-
242
-
243
- <div class="method-source-code"
244
- id="configure-source">
245
- <pre>
246
- <span class="ruby-comment cmt"># File lib/flogger/log.rb, line 18</span>
247
- 18: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>(&amp;<span class="ruby-identifier">block</span>)
248
- 19: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-ivar">@logs</span>)
249
- 20: <span class="ruby-keyword kw">end</span></pre>
250
- </div>
251
-
252
- </div>
253
-
254
-
255
-
256
-
257
- </div>
258
-
259
-
260
- <div id="debug-method" class="method-detail ">
261
- <a name="method-i-debug"></a>
262
-
263
- <div class="method-heading">
264
-
265
- <span class="method-name">debug</span><span
266
- class="method-args">(msg)</span>
267
- <span class="method-click-advice">click to toggle source</span>
268
-
269
- </div>
270
-
271
- <div class="method-description">
272
-
273
-
274
-
275
-
276
-
277
- <div class="method-source-code"
278
- id="debug-source">
279
- <pre>
280
- <span class="ruby-comment cmt"># File lib/flogger/log.rb, line 22</span>
281
- 22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug</span>(<span class="ruby-identifier">msg</span>)
282
- 23: <span class="ruby-identifier">output</span> <span class="ruby-identifier">open</span>(<span class="ruby-ivar">@logs</span>.<span class="ruby-identifier">debug</span>), <span class="ruby-identifier">msg</span>
283
- 24: <span class="ruby-keyword kw">end</span></pre>
284
- </div>
285
-
286
- </div>
287
-
288
-
289
-
290
-
291
- </div>
292
-
293
-
294
- <div id="error-method" class="method-detail ">
295
- <a name="method-i-error"></a>
296
-
297
- <div class="method-heading">
298
-
299
- <span class="method-name">error</span><span
300
- class="method-args">(msg)</span>
301
- <span class="method-click-advice">click to toggle source</span>
302
-
303
- </div>
304
-
305
- <div class="method-description">
306
-
307
-
308
-
309
-
310
-
311
- <div class="method-source-code"
312
- id="error-source">
313
- <pre>
314
- <span class="ruby-comment cmt"># File lib/flogger/log.rb, line 26</span>
315
- 26: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">msg</span>)
316
- 27: <span class="ruby-identifier">output</span> <span class="ruby-identifier">open</span>(<span class="ruby-ivar">@logs</span>.<span class="ruby-identifier">error</span>), <span class="ruby-identifier">msg</span>
317
- 28: <span class="ruby-keyword kw">end</span></pre>
318
- </div>
319
-
320
- </div>
321
-
322
-
323
-
324
-
325
- </div>
326
-
327
-
328
- <div id="notice-method" class="method-detail ">
329
- <a name="method-i-notice"></a>
330
-
331
- <div class="method-heading">
332
-
333
- <span class="method-name">notice</span><span
334
- class="method-args">(msg)</span>
335
- <span class="method-click-advice">click to toggle source</span>
336
-
337
- </div>
338
-
339
- <div class="method-description">
340
-
341
-
342
-
343
-
344
-
345
- <div class="method-source-code"
346
- id="notice-source">
347
- <pre>
348
- <span class="ruby-comment cmt"># File lib/flogger/log.rb, line 34</span>
349
- 34: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">notice</span>(<span class="ruby-identifier">msg</span>)
350
- 35: <span class="ruby-identifier">output</span> <span class="ruby-identifier">open</span>(<span class="ruby-ivar">@logs</span>.<span class="ruby-identifier">notice</span>), <span class="ruby-identifier">msg</span>
351
- 36: <span class="ruby-keyword kw">end</span></pre>
352
- </div>
353
-
354
- </div>
355
-
356
-
357
-
358
-
359
- </div>
360
-
361
-
362
- <div id="puts-method" class="method-detail ">
363
- <a name="method-i-puts"></a>
364
-
365
- <div class="method-heading">
366
-
367
- <span class="method-name">puts</span><span
368
- class="method-args">(msg)</span>
369
- <span class="method-click-advice">click to toggle source</span>
370
-
371
- </div>
372
-
373
- <div class="method-description">
374
-
375
-
376
-
377
-
378
-
379
- <div class="method-source-code"
380
- id="puts-source">
381
- <pre>
382
- <span class="ruby-comment cmt"># File lib/flogger/log.rb, line 38</span>
383
- 38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">puts</span>(<span class="ruby-identifier">msg</span>)
384
- 39: <span class="ruby-identifier">output</span> <span class="ruby-identifier">open</span>(<span class="ruby-ivar">@logs</span>.<span class="ruby-identifier">default</span>), <span class="ruby-identifier">msg</span>
385
- 40: <span class="ruby-keyword kw">end</span></pre>
386
- </div>
387
-
388
- </div>
389
-
390
-
391
-
392
-
393
- </div>
394
-
395
-
396
- <div id="warning-method" class="method-detail ">
397
- <a name="method-i-warning"></a>
398
-
399
- <div class="method-heading">
400
-
401
- <span class="method-name">warning</span><span
402
- class="method-args">(msg)</span>
403
- <span class="method-click-advice">click to toggle source</span>
404
-
405
- </div>
406
-
407
- <div class="method-description">
408
-
409
-
410
-
411
-
412
-
413
- <div class="method-source-code"
414
- id="warning-source">
415
- <pre>
416
- <span class="ruby-comment cmt"># File lib/flogger/log.rb, line 30</span>
417
- 30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">warning</span>(<span class="ruby-identifier">msg</span>)
418
- 31: <span class="ruby-identifier">output</span> <span class="ruby-identifier">open</span>(<span class="ruby-ivar">@logs</span>.<span class="ruby-identifier">warning</span>), <span class="ruby-identifier">msg</span>
419
- 32: <span class="ruby-keyword kw">end</span></pre>
420
- </div>
421
-
422
- </div>
423
-
424
-
425
-
426
-
427
- </div>
428
-
429
-
430
- </div>
431
-
432
- <div id="private-instance-method-details" class="method-section section">
433
- <h3 class="section-header">Private Instance Methods</h3>
434
-
435
-
436
- <div id="open-method" class="method-detail ">
437
- <a name="method-i-open"></a>
438
-
439
- <div class="method-heading">
440
-
441
- <span class="method-name">open</span><span
442
- class="method-args">(log_file)</span>
443
- <span class="method-click-advice">click to toggle source</span>
444
-
445
- </div>
446
-
447
- <div class="method-description">
448
-
449
- <p>
450
- access the needed log file
451
- </p>
452
-
453
-
454
-
455
- <div class="method-source-code"
456
- id="open-source">
457
- <pre>
458
- <span class="ruby-comment cmt"># File lib/flogger/log.rb, line 45</span>
459
- 45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open</span>(<span class="ruby-identifier">log_file</span>)
460
- 46: <span class="ruby-identifier">log_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">log_file</span>)
461
- 47: <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">log_path</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span> <span class="ruby-identifier">log_file</span>
462
- 48: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">log_file</span>, <span class="ruby-value str">'a'</span>)
463
- 49: <span class="ruby-keyword kw">end</span></pre>
464
- </div>
465
-
466
- </div>
467
-
468
-
469
-
470
-
471
- </div>
472
-
473
-
474
- <div id="output-method" class="method-detail ">
475
- <a name="method-i-output"></a>
476
-
477
- <div class="method-heading">
478
-
479
- <span class="method-name">output</span><span
480
- class="method-args">(log, msg)</span>
481
- <span class="method-click-advice">click to toggle source</span>
482
-
483
- </div>
484
-
485
- <div class="method-description">
486
-
487
- <p>
488
- output message into log file
489
- </p>
490
-
491
-
492
-
493
- <div class="method-source-code"
494
- id="output-source">
495
- <pre>
496
- <span class="ruby-comment cmt"># File lib/flogger/log.rb, line 52</span>
497
- 52: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">output</span>(<span class="ruby-identifier">log</span>, <span class="ruby-identifier">msg</span>)
498
- 53: <span class="ruby-identifier">log</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;[#{Time.now.asctime}] #{msg}&quot;</span>
499
- 54: <span class="ruby-identifier">log</span>.<span class="ruby-identifier">close</span>
500
- 55: <span class="ruby-keyword kw">end</span></pre>
501
- </div>
502
-
503
- </div>
504
-
505
-
506
-
507
-
508
- </div>
509
-
510
-
511
- </div>
512
-
513
-
514
- </div>
515
-
516
-
517
- <div id="rdoc-debugging-section-dump" class="debugging-section">
518
-
519
- <p>Disabled; run with --debug to generate this.</p>
520
-
521
- </div>
522
-
523
- <div id="validator-badges">
524
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
525
- <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
526
- Rdoc Generator</a> 1.1.6</small>.</p>
527
- </div>
528
-
529
- </body>
530
- </html>
531
-