doing 2.0.9.pre → 2.0.10

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/.yardoc/checksums +20 -0
  3. data/.yardoc/complete +0 -0
  4. data/.yardoc/object_types +0 -0
  5. data/.yardoc/objects/root.dat +0 -0
  6. data/.yardoc/proxy_types +0 -0
  7. data/.yardopts +1 -0
  8. data/CHANGELOG.md +1 -1
  9. data/Gemfile.lock +30 -10
  10. data/README.md +1 -1
  11. data/Rakefile +8 -1
  12. data/bin/doing +76 -30
  13. data/doc/Array.html +135 -0
  14. data/doc/Doing/Color.html +506 -0
  15. data/doc/Doing/Configuration.html +680 -0
  16. data/doc/Doing/Errors/DoingNoTraceError.html +186 -0
  17. data/doc/Doing/Errors/DoingRuntimeError.html +186 -0
  18. data/doc/Doing/Errors/DoingStandardError.html +186 -0
  19. data/doc/Doing/Errors/EmptyInput.html +186 -0
  20. data/doc/Doing/Errors/NoResults.html +186 -0
  21. data/doc/Doing/Errors/PluginException.html +248 -0
  22. data/doc/Doing/Errors/UserCancelled.html +186 -0
  23. data/doc/Doing/Errors/WrongCommand.html +186 -0
  24. data/doc/Doing/Errors.html +191 -0
  25. data/doc/Doing/Hooks.html +364 -0
  26. data/doc/Doing/Item.html +1385 -0
  27. data/doc/Doing/Items.html +393 -0
  28. data/doc/Doing/LogAdapter.html +1650 -0
  29. data/doc/Doing/Note.html +535 -0
  30. data/doc/Doing/Pager.html +268 -0
  31. data/doc/Doing/Plugins.html +849 -0
  32. data/doc/Doing/Util.html +870 -0
  33. data/doc/Doing/WWID.html +4827 -0
  34. data/doc/Doing.html +145 -0
  35. data/doc/GLI/Commands/MarkdownDocumentListener.html +763 -0
  36. data/doc/GLI/Commands.html +115 -0
  37. data/doc/GLI.html +115 -0
  38. data/doc/Hash.html +332 -0
  39. data/doc/Status.html +292 -0
  40. data/doc/String.html +1714 -0
  41. data/doc/Symbol.html +250 -0
  42. data/doc/Time.html +182 -0
  43. data/doc/_index.html +411 -0
  44. data/doc/class_list.html +51 -0
  45. data/doc/css/common.css +1 -0
  46. data/doc/css/full_list.css +58 -0
  47. data/doc/css/style.css +497 -0
  48. data/doc/file.README.html +123 -0
  49. data/doc/file_list.html +56 -0
  50. data/doc/frames.html +17 -0
  51. data/doc/index.html +123 -0
  52. data/doc/js/app.js +314 -0
  53. data/doc/js/full_list.js +216 -0
  54. data/doc/js/jquery.js +4 -0
  55. data/doc/method_list.html +1867 -0
  56. data/doc/top-level-namespace.html +112 -0
  57. data/doing.gemspec +5 -1
  58. data/doing.rdoc +86 -16
  59. data/example_plugin.rb +6 -6
  60. data/lib/doing/array.rb +1 -1
  61. data/lib/doing/configuration.rb +14 -12
  62. data/lib/doing/hash.rb +1 -1
  63. data/lib/doing/item.rb +101 -17
  64. data/lib/doing/log_adapter.rb +123 -113
  65. data/lib/doing/note.rb +1 -1
  66. data/lib/doing/plugin_manager.rb +5 -5
  67. data/lib/doing/plugins/export/csv_export.rb +1 -1
  68. data/lib/doing/plugins/export/template_export.rb +5 -7
  69. data/lib/doing/plugins/import/calendar_import.rb +1 -1
  70. data/lib/doing/plugins/import/doing_import.rb +4 -4
  71. data/lib/doing/plugins/import/timing_import.rb +5 -3
  72. data/lib/doing/string.rb +75 -22
  73. data/lib/doing/symbol.rb +9 -5
  74. data/lib/doing/time.rb +1 -1
  75. data/lib/doing/util.rb +18 -11
  76. data/lib/doing/version.rb +1 -1
  77. data/lib/doing/wwid.rb +419 -326
  78. data/lib/doing/wwidfile.rb +5 -5
  79. data/lib/doing.rb +2 -1
  80. data/lib/examples/plugins/say_export.rb +6 -6
  81. data/rdocfixer.rb +1 -1
  82. data/yard_templates/default/method_details/setup.rb +3 -0
  83. metadata +117 -4
data/doc/Doing/LogAdapter.html ADDED
@@ -0,0 +1,1650 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Doing::LogAdapter
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Doing::LogAdapter";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (L)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
41
+ &raquo;
42
+ <span class="title">LogAdapter</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Doing::LogAdapter
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Doing::LogAdapter</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/doing/log_adapter.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+ <p>Log adapter</p>
105
+
106
+
107
+ </div>
108
+ </div>
109
+ <div class="tags">
110
+
111
+
112
+ </div>
113
+
114
+ <h2>
115
+ Constant Summary
116
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
117
+ </h2>
118
+
119
+ <dl class="constants">
120
+
121
+ <dt id="TOPIC_WIDTH-constant" class="">TOPIC_WIDTH =
122
+
123
+ </dt>
124
+ <dd><pre class="code"><span class='int'>12</span></pre></dd>
125
+
126
+ <dt id="LOG_LEVELS-constant" class="">LOG_LEVELS =
127
+
128
+ </dt>
129
+ <dd><pre class="code"><span class='lbrace'>{</span>
130
+ <span class='label'>debug:</span> <span class='op'>::</span><span class='const'>Logger</span><span class='op'>::</span><span class='const'>DEBUG</span><span class='comma'>,</span>
131
+ <span class='label'>info:</span> <span class='op'>::</span><span class='const'>Logger</span><span class='op'>::</span><span class='const'>INFO</span><span class='comma'>,</span>
132
+ <span class='label'>warn:</span> <span class='op'>::</span><span class='const'>Logger</span><span class='op'>::</span><span class='const'>WARN</span><span class='comma'>,</span>
133
+ <span class='label'>error:</span> <span class='op'>::</span><span class='const'>Logger</span><span class='op'>::</span><span class='const'>ERROR</span>
134
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
135
+
136
+ <dt id="COUNT_KEYS-constant" class="">COUNT_KEYS =
137
+
138
+ </dt>
139
+ <dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='words_sep'>
140
+ </span><span class='tstring_content'>added_tags</span><span class='words_sep'>
141
+ </span><span class='tstring_content'>removed_tags</span><span class='words_sep'>
142
+ </span><span class='tstring_content'>added</span><span class='words_sep'>
143
+ </span><span class='tstring_content'>updated</span><span class='words_sep'>
144
+ </span><span class='tstring_content'>deleted</span><span class='words_sep'>
145
+ </span><span class='tstring_content'>completed</span><span class='words_sep'>
146
+ </span><span class='tstring_content'>archived</span><span class='words_sep'>
147
+ </span><span class='tstring_content'>moved</span><span class='words_sep'>
148
+ </span><span class='tstring_content'>completed_archived</span><span class='words_sep'>
149
+ </span><span class='tstring_content'>skipped</span><span class='words_sep'>
150
+ </span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
151
+
152
+ </dl>
153
+
154
+
155
+
156
+
157
+
158
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
159
+ <ul class="summary">
160
+
161
+ <li class="public ">
162
+ <span class="summary_signature">
163
+
164
+ <a href="#level-instance_method" title="#level (instance method)">#<strong>level</strong> &#x21d2; Object </a>
165
+
166
+
167
+
168
+ </span>
169
+
170
+
171
+
172
+
173
+ <span class="note title readonly">readonly</span>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute level.</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#logdev=-instance_method" title="#logdev= (instance method)">#<strong>logdev</strong> &#x21d2; Object </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+ <span class="note title writeonly">writeonly</span>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'><p>Sets the attribute logdev.</p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#max_length=-instance_method" title="#max_length= (instance method)">#<strong>max_length</strong> &#x21d2; Object </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+
227
+
228
+
229
+
230
+ <span class="note title writeonly">writeonly</span>
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <span class="summary_desc"><div class='inline'><p>Sets the attribute max_length.</p>
240
+ </div></span>
241
+
242
+ </li>
243
+
244
+
245
+ <li class="public ">
246
+ <span class="summary_signature">
247
+
248
+ <a href="#messages-instance_method" title="#messages (instance method)">#<strong>messages</strong> &#x21d2; Object </a>
249
+
250
+
251
+
252
+ </span>
253
+
254
+
255
+
256
+
257
+ <span class="note title readonly">readonly</span>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute messages.</p>
268
+ </div></span>
269
+
270
+ </li>
271
+
272
+
273
+ <li class="public ">
274
+ <span class="summary_signature">
275
+
276
+ <a href="#results-instance_method" title="#results (instance method)">#<strong>results</strong> &#x21d2; Object </a>
277
+
278
+
279
+
280
+ </span>
281
+
282
+
283
+
284
+
285
+ <span class="note title readonly">readonly</span>
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute results.</p>
296
+ </div></span>
297
+
298
+ </li>
299
+
300
+
301
+ </ul>
302
+
303
+
304
+
305
+
306
+
307
+ <h2>
308
+ Instance Method Summary
309
+ <small><a href="#" class="summary_toggle">collapse</a></small>
310
+ </h2>
311
+
312
+ <ul class="summary">
313
+
314
+ <li class="public ">
315
+ <span class="summary_signature">
316
+
317
+ <a href="#abort_with-instance_method" title="#abort_with (instance method)">#<strong>abort_with</strong>(topic, message = nil, &amp;block) &#x21d2; Object </a>
318
+
319
+
320
+
321
+ </span>
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+ <span class="summary_desc"><div class='inline'><p>Print an error message and immediately abort the process.</p>
332
+ </div></span>
333
+
334
+ </li>
335
+
336
+
337
+ <li class="public ">
338
+ <span class="summary_signature">
339
+
340
+ <a href="#adjust_verbosity-instance_method" title="#adjust_verbosity (instance method)">#<strong>adjust_verbosity</strong>(options = {}) &#x21d2; Object </a>
341
+
342
+
343
+
344
+ </span>
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+ <span class="summary_desc"><div class='inline'></div></span>
355
+
356
+ </li>
357
+
358
+
359
+ <li class="public ">
360
+ <span class="summary_signature">
361
+
362
+ <a href="#count-instance_method" title="#count (instance method)">#<strong>count</strong>(key, level: :info, count: 1, tag: nil, message: nil) &#x21d2; Object </a>
363
+
364
+
365
+
366
+ </span>
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+ <span class="summary_desc"><div class='inline'></div></span>
377
+
378
+ </li>
379
+
380
+
381
+ <li class="public ">
382
+ <span class="summary_signature">
383
+
384
+ <a href="#debug-instance_method" title="#debug (instance method)">#<strong>debug</strong>(topic, message = nil, &amp;block) &#x21d2; Object </a>
385
+
386
+
387
+
388
+ </span>
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+ <span class="summary_desc"><div class='inline'><p>Print a debug message.</p>
399
+ </div></span>
400
+
401
+ </li>
402
+
403
+
404
+ <li class="public ">
405
+ <span class="summary_signature">
406
+
407
+ <a href="#error-instance_method" title="#error (instance method)">#<strong>error</strong>(topic, message = nil, &amp;block) &#x21d2; Object </a>
408
+
409
+
410
+
411
+ </span>
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+ <span class="summary_desc"><div class='inline'><p>Print an error message.</p>
422
+ </div></span>
423
+
424
+ </li>
425
+
426
+
427
+ <li class="public ">
428
+ <span class="summary_signature">
429
+
430
+ <a href="#formatted_topic-instance_method" title="#formatted_topic (instance method)">#<strong>formatted_topic</strong>(topic, colon: false) &#x21d2; Object </a>
431
+
432
+
433
+
434
+ </span>
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+ <span class="summary_desc"><div class='inline'><p>Format the topic.</p>
445
+ </div></span>
446
+
447
+ </li>
448
+
449
+
450
+ <li class="public ">
451
+ <span class="summary_signature">
452
+
453
+ <a href="#info-instance_method" title="#info (instance method)">#<strong>info</strong>(topic, message = nil, &amp;block) &#x21d2; Object </a>
454
+
455
+
456
+
457
+ </span>
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+ <span class="summary_desc"><div class='inline'><p>Print a message.</p>
468
+ </div></span>
469
+
470
+ </li>
471
+
472
+
473
+ <li class="public ">
474
+ <span class="summary_signature">
475
+
476
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(level = :info) &#x21d2; LogAdapter </a>
477
+
478
+
479
+
480
+ </span>
481
+
482
+
483
+ <span class="note title constructor">constructor</span>
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+ <span class="summary_desc"><div class='inline'><p>Create a new instance of a log writer.</p>
493
+ </div></span>
494
+
495
+ </li>
496
+
497
+
498
+ <li class="public ">
499
+ <span class="summary_signature">
500
+
501
+ <a href="#log_level=-instance_method" title="#log_level= (instance method)">#<strong>log_level=</strong>(level = &#39;info&#39;) &#x21d2; Object </a>
502
+
503
+
504
+
505
+ </span>
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+ <span class="summary_desc"><div class='inline'><p>Set the log level on the writer.</p>
516
+ </div></span>
517
+
518
+ </li>
519
+
520
+
521
+ <li class="public ">
522
+ <span class="summary_signature">
523
+
524
+ <a href="#log_now-instance_method" title="#log_now (instance method)">#<strong>log_now</strong>(level, topic, message = nil, &amp;block) &#x21d2; Object </a>
525
+
526
+
527
+
528
+ </span>
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+ <span class="summary_desc"><div class='inline'><p>Log to console immediately instead of writing messages on exit.</p>
539
+ </div></span>
540
+
541
+ </li>
542
+
543
+
544
+ <li class="public ">
545
+ <span class="summary_signature">
546
+
547
+ <a href="#output_results-instance_method" title="#output_results (instance method)">#<strong>output_results</strong> &#x21d2; Object </a>
548
+
549
+
550
+
551
+ </span>
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+ <span class="summary_desc"><div class='inline'><p>Output registers based on log level.</p>
562
+ </div></span>
563
+
564
+ </li>
565
+
566
+
567
+ <li class="public ">
568
+ <span class="summary_signature">
569
+
570
+ <a href="#warn-instance_method" title="#warn (instance method)">#<strong>warn</strong>(topic, message = nil, &amp;block) &#x21d2; Object </a>
571
+
572
+
573
+
574
+ </span>
575
+
576
+
577
+
578
+
579
+
580
+
581
+
582
+
583
+
584
+ <span class="summary_desc"><div class='inline'><p>Print a message.</p>
585
+ </div></span>
586
+
587
+ </li>
588
+
589
+
590
+ <li class="public ">
591
+ <span class="summary_signature">
592
+
593
+ <a href="#write-instance_method" title="#write (instance method)">#<strong>write</strong>(level_of_message, topic, message = nil, &amp;block) &#x21d2; Boolean </a>
594
+
595
+
596
+
597
+ </span>
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+ <span class="summary_desc"><div class='inline'><p>Log a message.</p>
608
+ </div></span>
609
+
610
+ </li>
611
+
612
+
613
+ </ul>
614
+
615
+
616
+ <div id="constructor_details" class="method_details_list">
617
+ <h2>Constructor Details</h2>
618
+
619
+ <div class="method_details first">
620
+ <h3 class="signature first" id="initialize-instance_method">
621
+
622
+ #<strong>initialize</strong>(level = :info) &#x21d2; <tt><span class='object_link'><a href="" title="Doing::LogAdapter (class)">LogAdapter</a></span></tt>
623
+
624
+
625
+
626
+
627
+
628
+ </h3><div class="docstring">
629
+ <div class="discussion">
630
+ <p>Create a new instance of a log writer</p>
631
+
632
+
633
+ </div>
634
+ </div>
635
+ <div class="tags">
636
+ <p class="tag_title">Parameters:</p>
637
+ <ul class="param">
638
+
639
+ <li>
640
+
641
+ <span class='name'>level</span>
642
+
643
+
644
+ <span class='type'>(<tt>optional</tt>, <tt>symbol</tt>)</span>
645
+
646
+
647
+ <em class="default">(defaults to: <tt>:info</tt>)</em>
648
+
649
+
650
+ &mdash;
651
+ <div class='inline'><p>the log level</p>
652
+ </div>
653
+
654
+ </li>
655
+
656
+ </ul>
657
+
658
+
659
+ </div>
660
+ </div>
661
+
662
+ </div>
663
+
664
+ <div id="instance_attr_details" class="attr_details">
665
+ <h2>Instance Attribute Details</h2>
666
+
667
+
668
+ <span id=""></span>
669
+ <div class="method_details first">
670
+ <h3 class="signature first" id="level-instance_method">
671
+
672
+ #<strong>level</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
673
+
674
+
675
+
676
+
677
+
678
+ </h3><div class="docstring">
679
+ <div class="discussion">
680
+ <p>Returns the value of attribute level.</p>
681
+
682
+
683
+ </div>
684
+ </div>
685
+ <div class="tags">
686
+
687
+
688
+ </div>
689
+ </div>
690
+
691
+
692
+ <span id=""></span>
693
+ <div class="method_details ">
694
+ <h3 class="signature " id="logdev=-instance_method">
695
+
696
+ #<strong>logdev=</strong>(value) &#x21d2; <tt>Object</tt> <span class="extras">(writeonly)</span>
697
+
698
+
699
+
700
+
701
+
702
+ </h3><div class="docstring">
703
+ <div class="discussion">
704
+ <p>Sets the attribute logdev</p>
705
+
706
+
707
+ </div>
708
+ </div>
709
+ <div class="tags">
710
+ <p class="tag_title">Parameters:</p>
711
+ <ul class="param">
712
+
713
+ <li>
714
+
715
+ <span class='name'>value</span>
716
+
717
+
718
+ <span class='type'></span>
719
+
720
+
721
+
722
+ &mdash;
723
+ <div class='inline'><p>the value to set the attribute logdev to.</p>
724
+ </div>
725
+
726
+ </li>
727
+
728
+ </ul>
729
+
730
+
731
+ </div>
732
+ </div>
733
+
734
+
735
+ <span id=""></span>
736
+ <div class="method_details ">
737
+ <h3 class="signature " id="max_length=-instance_method">
738
+
739
+ #<strong>max_length=</strong>(value) &#x21d2; <tt>Object</tt> <span class="extras">(writeonly)</span>
740
+
741
+
742
+
743
+
744
+
745
+ </h3><div class="docstring">
746
+ <div class="discussion">
747
+ <p>Sets the attribute max_length</p>
748
+
749
+
750
+ </div>
751
+ </div>
752
+ <div class="tags">
753
+ <p class="tag_title">Parameters:</p>
754
+ <ul class="param">
755
+
756
+ <li>
757
+
758
+ <span class='name'>value</span>
759
+
760
+
761
+ <span class='type'></span>
762
+
763
+
764
+
765
+ &mdash;
766
+ <div class='inline'><p>the value to set the attribute max_length to.</p>
767
+ </div>
768
+
769
+ </li>
770
+
771
+ </ul>
772
+
773
+
774
+ </div>
775
+ </div>
776
+
777
+
778
+ <span id=""></span>
779
+ <div class="method_details ">
780
+ <h3 class="signature " id="messages-instance_method">
781
+
782
+ #<strong>messages</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
783
+
784
+
785
+
786
+
787
+
788
+ </h3><div class="docstring">
789
+ <div class="discussion">
790
+ <p>Returns the value of attribute messages.</p>
791
+
792
+
793
+ </div>
794
+ </div>
795
+ <div class="tags">
796
+
797
+
798
+ </div>
799
+ </div>
800
+
801
+
802
+ <span id=""></span>
803
+ <div class="method_details ">
804
+ <h3 class="signature " id="results-instance_method">
805
+
806
+ #<strong>results</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
807
+
808
+
809
+
810
+
811
+
812
+ </h3><div class="docstring">
813
+ <div class="discussion">
814
+ <p>Returns the value of attribute results.</p>
815
+
816
+
817
+ </div>
818
+ </div>
819
+ <div class="tags">
820
+
821
+
822
+ </div>
823
+ </div>
824
+
825
+ </div>
826
+
827
+
828
+ <div id="instance_method_details" class="method_details_list">
829
+ <h2>Instance Method Details</h2>
830
+
831
+
832
+ <div class="method_details first">
833
+ <h3 class="signature first" id="abort_with-instance_method">
834
+
835
+ #<strong>abort_with</strong>(topic, message = nil, &amp;block) &#x21d2; <tt>Object</tt>
836
+
837
+
838
+
839
+
840
+
841
+ </h3><div class="docstring">
842
+ <div class="discussion">
843
+ <p>Print an error message and immediately
844
+ abort the process</p>
845
+
846
+
847
+ </div>
848
+ </div>
849
+ <div class="tags">
850
+ <p class="tag_title">Parameters:</p>
851
+ <ul class="param">
852
+
853
+ <li>
854
+
855
+ <span class='name'>topic</span>
856
+
857
+
858
+ <span class='type'></span>
859
+
860
+
861
+
862
+ &mdash;
863
+ <div class='inline'><p>the topic of the message, e.g.
864
+ &quot;Configuration file&quot;,
865
+ &quot;Deprecation&quot;, etc.</p>
866
+ </div>
867
+
868
+ </li>
869
+
870
+ <li>
871
+
872
+ <span class='name'>message</span>
873
+
874
+
875
+ <span class='type'></span>
876
+
877
+
878
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
879
+
880
+
881
+ &mdash;
882
+ <div class='inline'><p>the message detail (can be
883
+ omitted)</p>
884
+ </div>
885
+
886
+ </li>
887
+
888
+ </ul>
889
+
890
+ <p class="tag_title">Returns:</p>
891
+ <ul class="return">
892
+
893
+ <li>
894
+
895
+
896
+ <span class='type'></span>
897
+
898
+
899
+
900
+
901
+ <div class='inline'><p>nothing</p>
902
+ </div>
903
+
904
+ </li>
905
+
906
+ </ul>
907
+
908
+ </div>
909
+ </div>
910
+
911
+ <div class="method_details ">
912
+ <h3 class="signature " id="adjust_verbosity-instance_method">
913
+
914
+ #<strong>adjust_verbosity</strong>(options = {}) &#x21d2; <tt>Object</tt>
915
+
916
+
917
+
918
+
919
+
920
+ </h3>
921
+ </div>
922
+
923
+ <div class="method_details ">
924
+ <h3 class="signature " id="count-instance_method">
925
+
926
+ #<strong>count</strong>(key, level: :info, count: 1, tag: nil, message: nil) &#x21d2; <tt>Object</tt>
927
+
928
+
929
+
930
+
931
+
932
+ </h3><div class="docstring">
933
+ <div class="discussion">
934
+
935
+
936
+ </div>
937
+ </div>
938
+ <div class="tags">
939
+
940
+ <p class="tag_title">Raises:</p>
941
+ <ul class="raise">
942
+
943
+ <li>
944
+
945
+
946
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
947
+
948
+
949
+
950
+ </li>
951
+
952
+ </ul>
953
+
954
+ </div>
955
+ </div>
956
+
957
+ <div class="method_details ">
958
+ <h3 class="signature " id="debug-instance_method">
959
+
960
+ #<strong>debug</strong>(topic, message = nil, &amp;block) &#x21d2; <tt>Object</tt>
961
+
962
+
963
+
964
+
965
+
966
+ </h3><div class="docstring">
967
+ <div class="discussion">
968
+ <p>Print a debug message</p>
969
+
970
+
971
+ </div>
972
+ </div>
973
+ <div class="tags">
974
+ <p class="tag_title">Parameters:</p>
975
+ <ul class="param">
976
+
977
+ <li>
978
+
979
+ <span class='name'>topic</span>
980
+
981
+
982
+ <span class='type'></span>
983
+
984
+
985
+
986
+ &mdash;
987
+ <div class='inline'><p>the topic of the message</p>
988
+ </div>
989
+
990
+ </li>
991
+
992
+ <li>
993
+
994
+ <span class='name'>message</span>
995
+
996
+
997
+ <span class='type'></span>
998
+
999
+
1000
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1001
+
1002
+
1003
+ &mdash;
1004
+ <div class='inline'><p>the message detail</p>
1005
+ </div>
1006
+
1007
+ </li>
1008
+
1009
+ </ul>
1010
+
1011
+ <p class="tag_title">Returns:</p>
1012
+ <ul class="return">
1013
+
1014
+ <li>
1015
+
1016
+
1017
+ <span class='type'></span>
1018
+
1019
+
1020
+
1021
+
1022
+ <div class='inline'><p>nothing</p>
1023
+ </div>
1024
+
1025
+ </li>
1026
+
1027
+ </ul>
1028
+
1029
+ </div>
1030
+ </div>
1031
+
1032
+ <div class="method_details ">
1033
+ <h3 class="signature " id="error-instance_method">
1034
+
1035
+ #<strong>error</strong>(topic, message = nil, &amp;block) &#x21d2; <tt>Object</tt>
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+ </h3><div class="docstring">
1042
+ <div class="discussion">
1043
+ <p>Print an error message</p>
1044
+
1045
+
1046
+ </div>
1047
+ </div>
1048
+ <div class="tags">
1049
+ <p class="tag_title">Parameters:</p>
1050
+ <ul class="param">
1051
+
1052
+ <li>
1053
+
1054
+ <span class='name'>topic</span>
1055
+
1056
+
1057
+ <span class='type'></span>
1058
+
1059
+
1060
+
1061
+ &mdash;
1062
+ <div class='inline'><p>the topic of the message, e.g.
1063
+ &quot;Configuration file&quot;,
1064
+ &quot;Deprecation&quot;, etc.</p>
1065
+ </div>
1066
+
1067
+ </li>
1068
+
1069
+ <li>
1070
+
1071
+ <span class='name'>message</span>
1072
+
1073
+
1074
+ <span class='type'></span>
1075
+
1076
+
1077
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1078
+
1079
+
1080
+ &mdash;
1081
+ <div class='inline'><p>the message detail</p>
1082
+ </div>
1083
+
1084
+ </li>
1085
+
1086
+ </ul>
1087
+
1088
+ <p class="tag_title">Returns:</p>
1089
+ <ul class="return">
1090
+
1091
+ <li>
1092
+
1093
+
1094
+ <span class='type'></span>
1095
+
1096
+
1097
+
1098
+
1099
+ <div class='inline'><p>nothing</p>
1100
+ </div>
1101
+
1102
+ </li>
1103
+
1104
+ </ul>
1105
+
1106
+ </div>
1107
+ </div>
1108
+
1109
+ <div class="method_details ">
1110
+ <h3 class="signature " id="formatted_topic-instance_method">
1111
+
1112
+ #<strong>formatted_topic</strong>(topic, colon: false) &#x21d2; <tt>Object</tt>
1113
+
1114
+
1115
+
1116
+
1117
+
1118
+ </h3><div class="docstring">
1119
+ <div class="discussion">
1120
+ <p>Format the topic</p>
1121
+
1122
+
1123
+ </div>
1124
+ </div>
1125
+ <div class="tags">
1126
+ <p class="tag_title">Parameters:</p>
1127
+ <ul class="param">
1128
+
1129
+ <li>
1130
+
1131
+ <span class='name'>topic</span>
1132
+
1133
+
1134
+ <span class='type'></span>
1135
+
1136
+
1137
+
1138
+ &mdash;
1139
+ <div class='inline'><p>the topic of the message, e.g.
1140
+ &quot;Configuration file&quot;,
1141
+ &quot;Deprecation&quot;, etc.</p>
1142
+ </div>
1143
+
1144
+ </li>
1145
+
1146
+ <li>
1147
+
1148
+ <span class='name'>colon</span>
1149
+
1150
+
1151
+ <span class='type'></span>
1152
+
1153
+
1154
+ <em class="default">(defaults to: <tt>false</tt>)</em>
1155
+
1156
+
1157
+ &mdash;
1158
+ <div class='inline'><p>Separate with a colon?</p>
1159
+ </div>
1160
+
1161
+ </li>
1162
+
1163
+ </ul>
1164
+
1165
+ <p class="tag_title">Returns:</p>
1166
+ <ul class="return">
1167
+
1168
+ <li>
1169
+
1170
+
1171
+ <span class='type'></span>
1172
+
1173
+
1174
+
1175
+
1176
+ <div class='inline'><p>the formatted topic statement</p>
1177
+ </div>
1178
+
1179
+ </li>
1180
+
1181
+ </ul>
1182
+
1183
+ </div>
1184
+ </div>
1185
+
1186
+ <div class="method_details ">
1187
+ <h3 class="signature " id="info-instance_method">
1188
+
1189
+ #<strong>info</strong>(topic, message = nil, &amp;block) &#x21d2; <tt>Object</tt>
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+ </h3><div class="docstring">
1196
+ <div class="discussion">
1197
+ <p>Print a message</p>
1198
+
1199
+
1200
+ </div>
1201
+ </div>
1202
+ <div class="tags">
1203
+ <p class="tag_title">Parameters:</p>
1204
+ <ul class="param">
1205
+
1206
+ <li>
1207
+
1208
+ <span class='name'>topic</span>
1209
+
1210
+
1211
+ <span class='type'></span>
1212
+
1213
+
1214
+
1215
+ &mdash;
1216
+ <div class='inline'><p>the topic of the message, e.g.
1217
+ &quot;Configuration file&quot;,
1218
+ &quot;Deprecation&quot;, etc.</p>
1219
+ </div>
1220
+
1221
+ </li>
1222
+
1223
+ <li>
1224
+
1225
+ <span class='name'>message</span>
1226
+
1227
+
1228
+ <span class='type'></span>
1229
+
1230
+
1231
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1232
+
1233
+
1234
+ &mdash;
1235
+ <div class='inline'><p>the message detail</p>
1236
+ </div>
1237
+
1238
+ </li>
1239
+
1240
+ </ul>
1241
+
1242
+ <p class="tag_title">Returns:</p>
1243
+ <ul class="return">
1244
+
1245
+ <li>
1246
+
1247
+
1248
+ <span class='type'></span>
1249
+
1250
+
1251
+
1252
+
1253
+ <div class='inline'><p>nothing</p>
1254
+ </div>
1255
+
1256
+ </li>
1257
+
1258
+ </ul>
1259
+
1260
+ </div>
1261
+ </div>
1262
+
1263
+ <div class="method_details ">
1264
+ <h3 class="signature " id="log_level=-instance_method">
1265
+
1266
+ #<strong>log_level=</strong>(level = &#39;info&#39;) &#x21d2; <tt>Object</tt>
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+ </h3><div class="docstring">
1273
+ <div class="discussion">
1274
+ <p>Set the log level on the writer</p>
1275
+
1276
+
1277
+ </div>
1278
+ </div>
1279
+ <div class="tags">
1280
+ <p class="tag_title">Parameters:</p>
1281
+ <ul class="param">
1282
+
1283
+ <li>
1284
+
1285
+ <span class='name'>level</span>
1286
+
1287
+
1288
+ <span class='type'>(<tt>symbol</tt>)</span>
1289
+
1290
+
1291
+ <em class="default">(defaults to: <tt>&#39;info&#39;</tt>)</em>
1292
+
1293
+
1294
+ &mdash;
1295
+ <div class='inline'><p>the log level</p>
1296
+ </div>
1297
+
1298
+ </li>
1299
+
1300
+ </ul>
1301
+
1302
+ <p class="tag_title">Returns:</p>
1303
+ <ul class="return">
1304
+
1305
+ <li>
1306
+
1307
+
1308
+ <span class='type'></span>
1309
+
1310
+
1311
+
1312
+
1313
+ <div class='inline'><p>nothing</p>
1314
+ </div>
1315
+
1316
+ </li>
1317
+
1318
+ </ul>
1319
+
1320
+ </div>
1321
+ </div>
1322
+
1323
+ <div class="method_details ">
1324
+ <h3 class="signature " id="log_now-instance_method">
1325
+
1326
+ #<strong>log_now</strong>(level, topic, message = nil, &amp;block) &#x21d2; <tt>Object</tt>
1327
+
1328
+
1329
+
1330
+
1331
+
1332
+ </h3><div class="docstring">
1333
+ <div class="discussion">
1334
+ <p>Log to console immediately instead of writing messages on exit</p>
1335
+
1336
+
1337
+ </div>
1338
+ </div>
1339
+ <div class="tags">
1340
+ <p class="tag_title">Parameters:</p>
1341
+ <ul class="param">
1342
+
1343
+ <li>
1344
+
1345
+ <span class='name'>level</span>
1346
+
1347
+
1348
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1349
+
1350
+
1351
+
1352
+ &mdash;
1353
+ <div class='inline'><p>The level</p>
1354
+ </div>
1355
+
1356
+ </li>
1357
+
1358
+ <li>
1359
+
1360
+ <span class='name'>topic</span>
1361
+
1362
+
1363
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1364
+
1365
+
1366
+
1367
+ &mdash;
1368
+ <div class='inline'><p>The topic or full message</p>
1369
+ </div>
1370
+
1371
+ </li>
1372
+
1373
+ <li>
1374
+
1375
+ <span class='name'>message</span>
1376
+
1377
+
1378
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1379
+
1380
+
1381
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1382
+
1383
+
1384
+ &mdash;
1385
+ <div class='inline'><p>The message (optional)</p>
1386
+ </div>
1387
+
1388
+ </li>
1389
+
1390
+ <li>
1391
+
1392
+ <span class='name'>block</span>
1393
+
1394
+
1395
+ <span class='type'></span>
1396
+
1397
+
1398
+
1399
+ &mdash;
1400
+ <div class='inline'><p>a block containing the message (optional)</p>
1401
+ </div>
1402
+
1403
+ </li>
1404
+
1405
+ </ul>
1406
+
1407
+
1408
+ </div>
1409
+ </div>
1410
+
1411
+ <div class="method_details ">
1412
+ <h3 class="signature " id="output_results-instance_method">
1413
+
1414
+ #<strong>output_results</strong> &#x21d2; <tt>Object</tt>
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+ </h3><div class="docstring">
1421
+ <div class="discussion">
1422
+ <p>Output registers based on log level</p>
1423
+
1424
+
1425
+ </div>
1426
+ </div>
1427
+ <div class="tags">
1428
+
1429
+ <p class="tag_title">Returns:</p>
1430
+ <ul class="return">
1431
+
1432
+ <li>
1433
+
1434
+
1435
+ <span class='type'></span>
1436
+
1437
+
1438
+
1439
+
1440
+ <div class='inline'><p>nothing</p>
1441
+ </div>
1442
+
1443
+ </li>
1444
+
1445
+ </ul>
1446
+
1447
+ </div>
1448
+ </div>
1449
+
1450
+ <div class="method_details ">
1451
+ <h3 class="signature " id="warn-instance_method">
1452
+
1453
+ #<strong>warn</strong>(topic, message = nil, &amp;block) &#x21d2; <tt>Object</tt>
1454
+
1455
+
1456
+
1457
+
1458
+
1459
+ </h3><div class="docstring">
1460
+ <div class="discussion">
1461
+ <p>Print a message</p>
1462
+
1463
+
1464
+ </div>
1465
+ </div>
1466
+ <div class="tags">
1467
+ <p class="tag_title">Parameters:</p>
1468
+ <ul class="param">
1469
+
1470
+ <li>
1471
+
1472
+ <span class='name'>topic</span>
1473
+
1474
+
1475
+ <span class='type'></span>
1476
+
1477
+
1478
+
1479
+ &mdash;
1480
+ <div class='inline'><p>the topic of the message, e.g.
1481
+ &quot;Configuration file&quot;,
1482
+ &quot;Deprecation&quot;, etc.</p>
1483
+ </div>
1484
+
1485
+ </li>
1486
+
1487
+ <li>
1488
+
1489
+ <span class='name'>message</span>
1490
+
1491
+
1492
+ <span class='type'></span>
1493
+
1494
+
1495
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1496
+
1497
+
1498
+ &mdash;
1499
+ <div class='inline'><p>the message detail</p>
1500
+ </div>
1501
+
1502
+ </li>
1503
+
1504
+ </ul>
1505
+
1506
+ <p class="tag_title">Returns:</p>
1507
+ <ul class="return">
1508
+
1509
+ <li>
1510
+
1511
+
1512
+ <span class='type'></span>
1513
+
1514
+
1515
+
1516
+
1517
+ <div class='inline'><p>nothing</p>
1518
+ </div>
1519
+
1520
+ </li>
1521
+
1522
+ </ul>
1523
+
1524
+ </div>
1525
+ </div>
1526
+
1527
+ <div class="method_details ">
1528
+ <h3 class="signature " id="write-instance_method">
1529
+
1530
+ #<strong>write</strong>(level_of_message, topic, message = nil, &amp;block) &#x21d2; <tt>Boolean</tt>
1531
+
1532
+
1533
+
1534
+
1535
+
1536
+ </h3><div class="docstring">
1537
+ <div class="discussion">
1538
+ <p>Log a message.</p>
1539
+
1540
+
1541
+ </div>
1542
+ </div>
1543
+ <div class="tags">
1544
+ <p class="tag_title">Parameters:</p>
1545
+ <ul class="param">
1546
+
1547
+ <li>
1548
+
1549
+ <span class='name'>level_of_message</span>
1550
+
1551
+
1552
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1553
+
1554
+
1555
+
1556
+ &mdash;
1557
+ <div class='inline'><p>the Symbol
1558
+ level of message, one of
1559
+ :debug, :info, :warn,
1560
+ :error</p>
1561
+ </div>
1562
+
1563
+ </li>
1564
+
1565
+ <li>
1566
+
1567
+ <span class='name'>topic</span>
1568
+
1569
+
1570
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1571
+
1572
+
1573
+
1574
+ &mdash;
1575
+ <div class='inline'><p>the String
1576
+ topic or full message</p>
1577
+ </div>
1578
+
1579
+ </li>
1580
+
1581
+ <li>
1582
+
1583
+ <span class='name'>message</span>
1584
+
1585
+
1586
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1587
+
1588
+
1589
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1590
+
1591
+
1592
+ &mdash;
1593
+ <div class='inline'><p>the String
1594
+ message (optional)</p>
1595
+ </div>
1596
+
1597
+ </li>
1598
+
1599
+ <li>
1600
+
1601
+ <span class='name'>block</span>
1602
+
1603
+
1604
+ <span class='type'></span>
1605
+
1606
+
1607
+
1608
+ &mdash;
1609
+ <div class='inline'><p>a block containing the
1610
+ message (optional)</p>
1611
+ </div>
1612
+
1613
+ </li>
1614
+
1615
+ </ul>
1616
+
1617
+ <p class="tag_title">Returns:</p>
1618
+ <ul class="return">
1619
+
1620
+ <li>
1621
+
1622
+
1623
+ <span class='type'>(<tt>Boolean</tt>)</span>
1624
+
1625
+
1626
+
1627
+ &mdash;
1628
+ <div class='inline'><p>false if the message was not written</p>
1629
+ </div>
1630
+
1631
+ </li>
1632
+
1633
+ </ul>
1634
+
1635
+ </div>
1636
+ </div>
1637
+
1638
+ </div>
1639
+
1640
+ </div>
1641
+
1642
+ <div id="footer">
1643
+ Generated on Thu Nov 18 16:39:12 2021 by
1644
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1645
+ 0.9.26 (ruby-3.0.1).
1646
+ </div>
1647
+
1648
+ </div>
1649
+ </body>
1650
+ </html>