doing 2.0.9.pre → 2.0.10

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.
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/Util.html ADDED
@@ -0,0 +1,870 @@
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
+ Module: Doing::Util
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::Util";
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 (U)</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">Util</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>Module: Doing::Util
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+ <dl>
73
+ <dt>Extended by:</dt>
74
+ <dd><span class='object_link'><a href="" title="Doing::Util (module)">Util</a></span></dd>
75
+ </dl>
76
+
77
+
78
+
79
+
80
+
81
+
82
+ <dl>
83
+ <dt>Included in:</dt>
84
+ <dd><span class='object_link'><a href="" title="Doing::Util (module)">Util</a></span></dd>
85
+ </dl>
86
+
87
+
88
+
89
+ <dl>
90
+ <dt>Defined in:</dt>
91
+ <dd>lib/doing/util.rb</dd>
92
+ </dl>
93
+
94
+ </div>
95
+
96
+ <h2>Overview</h2><div class="docstring">
97
+ <div class="discussion">
98
+ <p>Utilities</p>
99
+
100
+
101
+ </div>
102
+ </div>
103
+ <div class="tags">
104
+
105
+
106
+ </div>
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+ <h2>
115
+ Instance Method Summary
116
+ <small><a href="#" class="summary_toggle">collapse</a></small>
117
+ </h2>
118
+
119
+ <ul class="summary">
120
+
121
+ <li class="public ">
122
+ <span class="summary_signature">
123
+
124
+ <a href="#args_for_editor-instance_method" title="#args_for_editor (instance method)">#<strong>args_for_editor</strong>(editor) &#x21d2; Object </a>
125
+
126
+
127
+
128
+ </span>
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+ <span class="summary_desc"><div class='inline'></div></span>
139
+
140
+ </li>
141
+
142
+
143
+ <li class="public ">
144
+ <span class="summary_signature">
145
+
146
+ <a href="#deep_merge_hashes-instance_method" title="#deep_merge_hashes (instance method)">#<strong>deep_merge_hashes</strong>(master_hash, other_hash) &#x21d2; Object </a>
147
+
148
+
149
+
150
+ </span>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <span class="summary_desc"><div class='inline'><p>Non-destructive version of deep_merge_hashes! See that method.</p>
161
+ </div></span>
162
+
163
+ </li>
164
+
165
+
166
+ <li class="public ">
167
+ <span class="summary_signature">
168
+
169
+ <a href="#deep_merge_hashes!-instance_method" title="#deep_merge_hashes! (instance method)">#<strong>deep_merge_hashes!</strong>(target, overwrite) &#x21d2; Object </a>
170
+
171
+
172
+
173
+ </span>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'><p>Merges a master hash with another hash, recursively.</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#default_editor-instance_method" title="#default_editor (instance method)">#<strong>default_editor</strong> &#x21d2; Object </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'></div></span>
207
+
208
+ </li>
209
+
210
+
211
+ <li class="public ">
212
+ <span class="summary_signature">
213
+
214
+ <a href="#duplicable%3F-instance_method" title="#duplicable? (instance method)">#<strong>duplicable?</strong>(obj) &#x21d2; Boolean </a>
215
+
216
+
217
+
218
+ </span>
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+ <span class="summary_desc"><div class='inline'></div></span>
229
+
230
+ </li>
231
+
232
+
233
+ <li class="public ">
234
+ <span class="summary_signature">
235
+
236
+ <a href="#duplicate_frozen_values-instance_method" title="#duplicate_frozen_values (instance method)">#<strong>duplicate_frozen_values</strong>(target) &#x21d2; Object </a>
237
+
238
+
239
+
240
+ </span>
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+ <span class="summary_desc"><div class='inline'></div></span>
251
+
252
+ </li>
253
+
254
+
255
+ <li class="public ">
256
+ <span class="summary_signature">
257
+
258
+ <a href="#editor_with_args-instance_method" title="#editor_with_args (instance method)">#<strong>editor_with_args</strong> &#x21d2; Object </a>
259
+
260
+
261
+
262
+ </span>
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+ <span class="summary_desc"><div class='inline'></div></span>
273
+
274
+ </li>
275
+
276
+
277
+ <li class="public ">
278
+ <span class="summary_signature">
279
+
280
+ <a href="#exec_available-instance_method" title="#exec_available (instance method)">#<strong>exec_available</strong>(cli) &#x21d2; Object </a>
281
+
282
+
283
+
284
+ </span>
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+ <span class="summary_desc"><div class='inline'><p>Test if command line tool is available.</p>
295
+ </div></span>
296
+
297
+ </li>
298
+
299
+
300
+ <li class="public ">
301
+ <span class="summary_signature">
302
+
303
+ <a href="#find_default_editor-instance_method" title="#find_default_editor (instance method)">#<strong>find_default_editor</strong>(editor_for = &#39;default&#39;) &#x21d2; Object </a>
304
+
305
+
306
+
307
+ </span>
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+ <span class="summary_desc"><div class='inline'></div></span>
318
+
319
+ </li>
320
+
321
+
322
+ <li class="public ">
323
+ <span class="summary_signature">
324
+
325
+ <a href="#mergable%3F-instance_method" title="#mergable? (instance method)">#<strong>mergable?</strong>(value) &#x21d2; Boolean </a>
326
+
327
+
328
+
329
+ </span>
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+ <span class="summary_desc"><div class='inline'></div></span>
340
+
341
+ </li>
342
+
343
+
344
+ <li class="public ">
345
+ <span class="summary_signature">
346
+
347
+ <a href="#merge_default_proc-instance_method" title="#merge_default_proc (instance method)">#<strong>merge_default_proc</strong>(target, overwrite) &#x21d2; Object </a>
348
+
349
+
350
+
351
+ </span>
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+ <span class="summary_desc"><div class='inline'></div></span>
362
+
363
+ </li>
364
+
365
+
366
+ <li class="public ">
367
+ <span class="summary_signature">
368
+
369
+ <a href="#merge_values-instance_method" title="#merge_values (instance method)">#<strong>merge_values</strong>(target, overwrite) &#x21d2; Object </a>
370
+
371
+
372
+
373
+ </span>
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+ <span class="summary_desc"><div class='inline'></div></span>
384
+
385
+ </li>
386
+
387
+
388
+ <li class="public ">
389
+ <span class="summary_signature">
390
+
391
+ <a href="#safe_load_file-instance_method" title="#safe_load_file (instance method)">#<strong>safe_load_file</strong>(filename) &#x21d2; Object </a>
392
+
393
+
394
+
395
+ </span>
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+ <span class="summary_desc"><div class='inline'></div></span>
406
+
407
+ </li>
408
+
409
+
410
+ <li class="public ">
411
+ <span class="summary_signature">
412
+
413
+ <a href="#user_home-instance_method" title="#user_home (instance method)">#<strong>user_home</strong> &#x21d2; Object </a>
414
+
415
+
416
+
417
+ </span>
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+ <span class="summary_desc"><div class='inline'></div></span>
428
+
429
+ </li>
430
+
431
+
432
+ <li class="public ">
433
+ <span class="summary_signature">
434
+
435
+ <a href="#write_to_file-instance_method" title="#write_to_file (instance method)">#<strong>write_to_file</strong>(file, content, backup: true) &#x21d2; Object </a>
436
+
437
+
438
+
439
+ </span>
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+ <span class="summary_desc"><div class='inline'><p>Write content to a file.</p>
450
+ </div></span>
451
+
452
+ </li>
453
+
454
+
455
+ </ul>
456
+
457
+
458
+
459
+
460
+ <div id="instance_method_details" class="method_details_list">
461
+ <h2>Instance Method Details</h2>
462
+
463
+
464
+ <div class="method_details first">
465
+ <h3 class="signature first" id="args_for_editor-instance_method">
466
+
467
+ #<strong>args_for_editor</strong>(editor) &#x21d2; <tt>Object</tt>
468
+
469
+
470
+
471
+
472
+
473
+ </h3>
474
+ </div>
475
+
476
+ <div class="method_details ">
477
+ <h3 class="signature " id="deep_merge_hashes-instance_method">
478
+
479
+ #<strong>deep_merge_hashes</strong>(master_hash, other_hash) &#x21d2; <tt>Object</tt>
480
+
481
+
482
+
483
+
484
+
485
+ </h3><div class="docstring">
486
+ <div class="discussion">
487
+ <p>Non-destructive version of deep_merge_hashes! See that
488
+ method.</p>
489
+
490
+
491
+ </div>
492
+ </div>
493
+ <div class="tags">
494
+ <p class="tag_title">Parameters:</p>
495
+ <ul class="param">
496
+
497
+ <li>
498
+
499
+ <span class='name'>master_hash</span>
500
+
501
+
502
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
503
+
504
+
505
+
506
+ &mdash;
507
+ <div class='inline'><p>The master hash</p>
508
+ </div>
509
+
510
+ </li>
511
+
512
+ <li>
513
+
514
+ <span class='name'>other_hash</span>
515
+
516
+
517
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
518
+
519
+
520
+
521
+ &mdash;
522
+ <div class='inline'><p>The other hash</p>
523
+ </div>
524
+
525
+ </li>
526
+
527
+ </ul>
528
+
529
+ <p class="tag_title">Returns:</p>
530
+ <ul class="return">
531
+
532
+ <li>
533
+
534
+
535
+ <span class='type'></span>
536
+
537
+
538
+
539
+
540
+ <div class='inline'><p>the merged hashes.</p>
541
+ </div>
542
+
543
+ </li>
544
+
545
+ </ul>
546
+
547
+ </div>
548
+ </div>
549
+
550
+ <div class="method_details ">
551
+ <h3 class="signature " id="deep_merge_hashes!-instance_method">
552
+
553
+ #<strong>deep_merge_hashes!</strong>(target, overwrite) &#x21d2; <tt>Object</tt>
554
+
555
+
556
+
557
+
558
+
559
+ </h3><div class="docstring">
560
+ <div class="discussion">
561
+ <p>Merges a master hash with another hash, recursively.</p>
562
+
563
+ <p>master_hash - the &quot;parent&quot; hash whose values will be overridden
564
+ other_hash - the other hash whose values will be persisted after the merge</p>
565
+
566
+ <p>This code was lovingly stolen from some random gem:
567
+ <a href="http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html">http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html</a></p>
568
+
569
+ <p>Thanks to whoever made it.</p>
570
+
571
+
572
+ </div>
573
+ </div>
574
+ <div class="tags">
575
+
576
+
577
+ </div>
578
+ </div>
579
+
580
+ <div class="method_details ">
581
+ <h3 class="signature " id="default_editor-instance_method">
582
+
583
+ #<strong>default_editor</strong> &#x21d2; <tt>Object</tt>
584
+
585
+
586
+
587
+
588
+
589
+ </h3>
590
+ </div>
591
+
592
+ <div class="method_details ">
593
+ <h3 class="signature " id="duplicable?-instance_method">
594
+
595
+ #<strong>duplicable?</strong>(obj) &#x21d2; <tt>Boolean</tt>
596
+
597
+
598
+
599
+
600
+
601
+ </h3><div class="docstring">
602
+ <div class="discussion">
603
+
604
+
605
+ </div>
606
+ </div>
607
+ <div class="tags">
608
+
609
+ <p class="tag_title">Returns:</p>
610
+ <ul class="return">
611
+
612
+ <li>
613
+
614
+
615
+ <span class='type'>(<tt>Boolean</tt>)</span>
616
+
617
+
618
+
619
+ </li>
620
+
621
+ </ul>
622
+
623
+ </div>
624
+ </div>
625
+
626
+ <div class="method_details ">
627
+ <h3 class="signature " id="duplicate_frozen_values-instance_method">
628
+
629
+ #<strong>duplicate_frozen_values</strong>(target) &#x21d2; <tt>Object</tt>
630
+
631
+
632
+
633
+
634
+
635
+ </h3>
636
+ </div>
637
+
638
+ <div class="method_details ">
639
+ <h3 class="signature " id="editor_with_args-instance_method">
640
+
641
+ #<strong>editor_with_args</strong> &#x21d2; <tt>Object</tt>
642
+
643
+
644
+
645
+
646
+
647
+ </h3>
648
+ </div>
649
+
650
+ <div class="method_details ">
651
+ <h3 class="signature " id="exec_available-instance_method">
652
+
653
+ #<strong>exec_available</strong>(cli) &#x21d2; <tt>Object</tt>
654
+
655
+
656
+
657
+
658
+
659
+ </h3><div class="docstring">
660
+ <div class="discussion">
661
+ <p>Test if command line tool is available</p>
662
+
663
+
664
+ </div>
665
+ </div>
666
+ <div class="tags">
667
+ <p class="tag_title">Parameters:</p>
668
+ <ul class="param">
669
+
670
+ <li>
671
+
672
+ <span class='name'>cli</span>
673
+
674
+
675
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
676
+
677
+
678
+
679
+ &mdash;
680
+ <div class='inline'><p>The name or path of the cli</p>
681
+ </div>
682
+
683
+ </li>
684
+
685
+ </ul>
686
+
687
+
688
+ </div>
689
+ </div>
690
+
691
+ <div class="method_details ">
692
+ <h3 class="signature " id="find_default_editor-instance_method">
693
+
694
+ #<strong>find_default_editor</strong>(editor_for = &#39;default&#39;) &#x21d2; <tt>Object</tt>
695
+
696
+
697
+
698
+
699
+
700
+ </h3>
701
+ </div>
702
+
703
+ <div class="method_details ">
704
+ <h3 class="signature " id="mergable?-instance_method">
705
+
706
+ #<strong>mergable?</strong>(value) &#x21d2; <tt>Boolean</tt>
707
+
708
+
709
+
710
+
711
+
712
+ </h3><div class="docstring">
713
+ <div class="discussion">
714
+
715
+
716
+ </div>
717
+ </div>
718
+ <div class="tags">
719
+
720
+ <p class="tag_title">Returns:</p>
721
+ <ul class="return">
722
+
723
+ <li>
724
+
725
+
726
+ <span class='type'>(<tt>Boolean</tt>)</span>
727
+
728
+
729
+
730
+ </li>
731
+
732
+ </ul>
733
+
734
+ </div>
735
+ </div>
736
+
737
+ <div class="method_details ">
738
+ <h3 class="signature " id="merge_default_proc-instance_method">
739
+
740
+ #<strong>merge_default_proc</strong>(target, overwrite) &#x21d2; <tt>Object</tt>
741
+
742
+
743
+
744
+
745
+
746
+ </h3>
747
+ </div>
748
+
749
+ <div class="method_details ">
750
+ <h3 class="signature " id="merge_values-instance_method">
751
+
752
+ #<strong>merge_values</strong>(target, overwrite) &#x21d2; <tt>Object</tt>
753
+
754
+
755
+
756
+
757
+
758
+ </h3>
759
+ </div>
760
+
761
+ <div class="method_details ">
762
+ <h3 class="signature " id="safe_load_file-instance_method">
763
+
764
+ #<strong>safe_load_file</strong>(filename) &#x21d2; <tt>Object</tt>
765
+
766
+
767
+
768
+
769
+
770
+ </h3>
771
+ </div>
772
+
773
+ <div class="method_details ">
774
+ <h3 class="signature " id="user_home-instance_method">
775
+
776
+ #<strong>user_home</strong> &#x21d2; <tt>Object</tt>
777
+
778
+
779
+
780
+
781
+
782
+ </h3>
783
+ </div>
784
+
785
+ <div class="method_details ">
786
+ <h3 class="signature " id="write_to_file-instance_method">
787
+
788
+ #<strong>write_to_file</strong>(file, content, backup: true) &#x21d2; <tt>Object</tt>
789
+
790
+
791
+
792
+
793
+
794
+ </h3><div class="docstring">
795
+ <div class="discussion">
796
+ <p>Write content to a file</p>
797
+
798
+
799
+ </div>
800
+ </div>
801
+ <div class="tags">
802
+ <p class="tag_title">Parameters:</p>
803
+ <ul class="param">
804
+
805
+ <li>
806
+
807
+ <span class='name'>file</span>
808
+
809
+
810
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
811
+
812
+
813
+
814
+ &mdash;
815
+ <div class='inline'><p>The path to the file to (over)write</p>
816
+ </div>
817
+
818
+ </li>
819
+
820
+ <li>
821
+
822
+ <span class='name'>content</span>
823
+
824
+
825
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
826
+
827
+
828
+
829
+ &mdash;
830
+ <div class='inline'><p>The content to write to the file</p>
831
+ </div>
832
+
833
+ </li>
834
+
835
+ <li>
836
+
837
+ <span class='name'>backup</span>
838
+
839
+
840
+ <span class='type'>(<tt>Boolean</tt>)</span>
841
+
842
+
843
+ <em class="default">(defaults to: <tt>true</tt>)</em>
844
+
845
+
846
+ &mdash;
847
+ <div class='inline'><p>create a ~ backup</p>
848
+ </div>
849
+
850
+ </li>
851
+
852
+ </ul>
853
+
854
+
855
+ </div>
856
+ </div>
857
+
858
+ </div>
859
+
860
+ </div>
861
+
862
+ <div id="footer">
863
+ Generated on Thu Nov 18 16:39:11 2021 by
864
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
865
+ 0.9.26 (ruby-3.0.1).
866
+ </div>
867
+
868
+ </div>
869
+ </body>
870
+ </html>