my_help 1.2.10 → 1.2.14

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 (56) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -10
  3. data/Gemfile.lock +6 -91
  4. data/README.org +24 -0
  5. data/Rakefile +0 -35
  6. data/development_memo.org +4 -0
  7. data/lib/my_help/cli.rb +32 -6
  8. data/lib/my_help/config.rb +8 -3
  9. data/lib/my_help/init.rb +8 -1
  10. data/lib/my_help/list.rb +15 -20
  11. data/lib/my_help/modify.rb +9 -7
  12. data/lib/my_help/org2hash.rb +3 -3
  13. data/lib/my_help/version.rb +1 -1
  14. data/lib/templates/kick_off.md +51 -0
  15. data/lib/templates/kick_off.org +65 -0
  16. data/lib/templates/template.md +17 -0
  17. data/lib/templates/template.org +11 -1
  18. data/my_help.gemspec +3 -3
  19. metadata +6 -85
  20. data/.DS_Store +0 -0
  21. data/.dockerignore +0 -2
  22. data/.my_help/example2.org +0 -9
  23. data/.rspec +0 -3
  24. data/.rspec_status +0 -13
  25. data/.travis.yml +0 -4
  26. data/.yardoc/checksums +0 -11
  27. data/.yardoc/complete +0 -0
  28. data/.yardoc/object_types +0 -0
  29. data/.yardoc/objects/root.dat +0 -0
  30. data/.yardoc/proxy_types +0 -0
  31. data/doc/MyHelp/CLI.html +0 -895
  32. data/doc/MyHelp/Config.html +0 -759
  33. data/doc/MyHelp/Error.html +0 -124
  34. data/doc/MyHelp/GetConfig.html +0 -198
  35. data/doc/MyHelp/Git.html +0 -291
  36. data/doc/MyHelp/Init.html +0 -449
  37. data/doc/MyHelp/List.html +0 -646
  38. data/doc/MyHelp/Md2Hash.html +0 -632
  39. data/doc/MyHelp/Modify.html +0 -393
  40. data/doc/MyHelp/Org2Hash.html +0 -554
  41. data/doc/MyHelp.html +0 -135
  42. data/doc/Org2Yaml.html +0 -497
  43. data/doc/_index.html +0 -230
  44. data/doc/class_list.html +0 -54
  45. data/doc/css/common.css +0 -1
  46. data/doc/css/full_list.css +0 -58
  47. data/doc/css/style.css +0 -503
  48. data/doc/file.README.html +0 -181
  49. data/doc/file_list.html +0 -59
  50. data/doc/frames.html +0 -22
  51. data/doc/index.html +0 -181
  52. data/doc/js/app.js +0 -344
  53. data/doc/js/full_list.js +0 -242
  54. data/doc/js/jquery.js +0 -2
  55. data/doc/method_list.html +0 -486
  56. data/doc/top-level-namespace.html +0 -112
@@ -1,759 +0,0 @@
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: MyHelp::Config
8
-
9
- &mdash; my_help
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 = "MyHelp::Config";
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 (C)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../MyHelp.html" title="MyHelp (module)">MyHelp</a></span></span>
41
- &raquo;
42
- <span class="title">Config</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: MyHelp::Config
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">MyHelp::Config</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/my_help/config.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
-
105
- <p>make @config from default and load yaml as shown <a href="https://stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem">stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem</a></p>
106
-
107
-
108
- </div>
109
- </div>
110
- <div class="tags">
111
-
112
-
113
- </div>
114
-
115
-
116
-
117
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
- <ul class="summary">
119
-
120
- <li class="public ">
121
- <span class="summary_signature">
122
-
123
- <a href="#config-instance_method" title="#config (instance method)">#<strong>config</strong> &#x21d2; Object </a>
124
-
125
-
126
-
127
- </span>
128
-
129
-
130
-
131
-
132
- <span class="note title readonly">readonly</span>
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
- <span class="summary_desc"><div class='inline'>
143
- <p>Returns the value of attribute config.</p>
144
- </div></span>
145
-
146
- </li>
147
-
148
-
149
- <li class="public ">
150
- <span class="summary_signature">
151
-
152
- <a href="#valid_config_keys-instance_method" title="#valid_config_keys (instance method)">#<strong>valid_config_keys</strong> &#x21d2; Object </a>
153
-
154
-
155
-
156
- </span>
157
-
158
-
159
-
160
-
161
- <span class="note title readonly">readonly</span>
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
- <span class="summary_desc"><div class='inline'>
172
- <p>Returns the value of attribute valid_config_keys.</p>
173
- </div></span>
174
-
175
- </li>
176
-
177
-
178
- </ul>
179
-
180
-
181
-
182
-
183
-
184
- <h2>
185
- Instance Method Summary
186
- <small><a href="#" class="summary_toggle">collapse</a></small>
187
- </h2>
188
-
189
- <ul class="summary">
190
-
191
- <li class="public ">
192
- <span class="summary_signature">
193
-
194
- <a href="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(sym) &#x21d2; Object </a>
195
-
196
-
197
-
198
- </span>
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
- <span class="summary_desc"><div class='inline'></div></span>
209
-
210
- </li>
211
-
212
-
213
- <li class="public ">
214
- <span class="summary_signature">
215
-
216
- <a href="#check_template_dir-instance_method" title="#check_template_dir (instance method)">#<strong>check_template_dir</strong> &#x21d2; Object </a>
217
-
218
-
219
-
220
- </span>
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
- <span class="summary_desc"><div class='inline'></div></span>
231
-
232
- </li>
233
-
234
-
235
- <li class="public ">
236
- <span class="summary_signature">
237
-
238
- <a href="#configure-instance_method" title="#configure (instance method)">#<strong>configure</strong>(opts = nil) &#x21d2; Object </a>
239
-
240
-
241
-
242
- </span>
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
- <span class="summary_desc"><div class='inline'>
253
- <p>Configure through hash.</p>
254
- </div></span>
255
-
256
- </li>
257
-
258
-
259
- <li class="public ">
260
- <span class="summary_signature">
261
-
262
- <a href="#configure_with-instance_method" title="#configure_with (instance method)">#<strong>configure_with</strong>(path) &#x21d2; Object </a>
263
-
264
-
265
-
266
- </span>
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
- <span class="summary_desc"><div class='inline'>
277
- <p>Configure through yaml file.</p>
278
- </div></span>
279
-
280
- </li>
281
-
282
-
283
- <li class="public ">
284
- <span class="summary_signature">
285
-
286
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(conf_path = nil) &#x21d2; Config </a>
287
-
288
-
289
-
290
- </span>
291
-
292
-
293
- <span class="note title constructor">constructor</span>
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
- <span class="summary_desc"><div class='inline'>
303
- <p>Configuration defaults.</p>
304
- </div></span>
305
-
306
- </li>
307
-
308
-
309
- <li class="public ">
310
- <span class="summary_signature">
311
-
312
- <a href="#save_config-instance_method" title="#save_config (instance method)">#<strong>save_config</strong> &#x21d2; Object </a>
313
-
314
-
315
-
316
- </span>
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
- <span class="summary_desc"><div class='inline'>
327
- <p>save config in @<a href=":conf_file">config</a>.</p>
328
- </div></span>
329
-
330
- </li>
331
-
332
-
333
- </ul>
334
-
335
-
336
- <div id="constructor_details" class="method_details_list">
337
- <h2>Constructor Details</h2>
338
-
339
- <div class="method_details first">
340
- <h3 class="signature first" id="initialize-instance_method">
341
-
342
- #<strong>initialize</strong>(conf_path = nil) &#x21d2; <tt><span class='object_link'><a href="" title="MyHelp::Config (class)">Config</a></span></tt>
343
-
344
-
345
-
346
-
347
-
348
- </h3><div class="docstring">
349
- <div class="discussion">
350
-
351
- <p>Configuration defaults</p>
352
-
353
-
354
- </div>
355
- </div>
356
- <div class="tags">
357
-
358
-
359
- </div><table class="source_code">
360
- <tr>
361
- <td>
362
- <pre class="lines">
363
-
364
-
365
- 9
366
- 10
367
- 11
368
- 12
369
- 13
370
- 14
371
- 15
372
- 16
373
- 17
374
- 18
375
- 19
376
- 20
377
- 21
378
- 22
379
- 23
380
- 24
381
- 25</pre>
382
- </td>
383
- <td>
384
- <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 9</span>
385
-
386
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_conf_path'>conf_path</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
387
- <span class='id identifier rubyid_conf_path'>conf_path</span> <span class='op'>||=</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HOME</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
388
- <span class='id identifier rubyid_local_help_dir'>local_help_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='id identifier rubyid_conf_path'>conf_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.my_help</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
389
- <span class='ivar'>@config</span> <span class='op'>=</span> <span class='lbrace'>{</span>
390
- <span class='label'>template_dir:</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>../templates</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid___dir__'>__dir__</span><span class='rparen'>)</span><span class='comma'>,</span>
391
- <span class='label'>local_help_dir:</span> <span class='id identifier rubyid_local_help_dir'>local_help_dir</span><span class='comma'>,</span>
392
- <span class='label'>conf_file:</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_conf_path'>conf_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.my_help_conf.yml</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
393
- <span class='label'>editor:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>EDITOR</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>emacs</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
394
- <span class='label'>ext:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.org</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
395
- <span class='label'>verbose:</span> <span class='kw'>false</span><span class='comma'>,</span>
396
- <span class='rbrace'>}</span>
397
- <span class='ivar'>@valid_config_keys</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
398
- <span class='id identifier rubyid_configure_with'>configure_with</span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:conf_file</span><span class='rbracket'>]</span><span class='rparen'>)</span>
399
- <span class='comment'># YAML.dump(@config, File.open(@config[:conf_file], &#39;w&#39;))
400
- </span> <span class='comment'># no good for multiple testers.
401
- </span> <span class='id identifier rubyid_check_template_dir'>check_template_dir</span>
402
- <span class='kw'>end</span></pre>
403
- </td>
404
- </tr>
405
- </table>
406
- </div>
407
-
408
- </div>
409
-
410
- <div id="instance_attr_details" class="attr_details">
411
- <h2>Instance Attribute Details</h2>
412
-
413
-
414
- <span id=""></span>
415
- <div class="method_details first">
416
- <h3 class="signature first" id="config-instance_method">
417
-
418
- #<strong>config</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
419
-
420
-
421
-
422
-
423
-
424
- </h3><div class="docstring">
425
- <div class="discussion">
426
-
427
- <p>Returns the value of attribute config.</p>
428
-
429
-
430
- </div>
431
- </div>
432
- <div class="tags">
433
-
434
-
435
- </div><table class="source_code">
436
- <tr>
437
- <td>
438
- <pre class="lines">
439
-
440
-
441
- 75
442
- 76
443
- 77</pre>
444
- </td>
445
- <td>
446
- <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 75</span>
447
-
448
- <span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
449
- <span class='ivar'>@config</span>
450
- <span class='kw'>end</span></pre>
451
- </td>
452
- </tr>
453
- </table>
454
- </div>
455
-
456
-
457
- <span id=""></span>
458
- <div class="method_details ">
459
- <h3 class="signature " id="valid_config_keys-instance_method">
460
-
461
- #<strong>valid_config_keys</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
462
-
463
-
464
-
465
-
466
-
467
- </h3><div class="docstring">
468
- <div class="discussion">
469
-
470
- <p>Returns the value of attribute valid_config_keys.</p>
471
-
472
-
473
- </div>
474
- </div>
475
- <div class="tags">
476
-
477
-
478
- </div><table class="source_code">
479
- <tr>
480
- <td>
481
- <pre class="lines">
482
-
483
-
484
- 7
485
- 8
486
- 9</pre>
487
- </td>
488
- <td>
489
- <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 7</span>
490
-
491
- <span class='kw'>def</span> <span class='id identifier rubyid_valid_config_keys'>valid_config_keys</span>
492
- <span class='ivar'>@valid_config_keys</span>
493
- <span class='kw'>end</span></pre>
494
- </td>
495
- </tr>
496
- </table>
497
- </div>
498
-
499
- </div>
500
-
501
-
502
- <div id="instance_method_details" class="method_details_list">
503
- <h2>Instance Method Details</h2>
504
-
505
-
506
- <div class="method_details first">
507
- <h3 class="signature first" id="[]-instance_method">
508
-
509
- #<strong>[]</strong>(sym) &#x21d2; <tt>Object</tt>
510
-
511
-
512
-
513
-
514
-
515
- </h3><table class="source_code">
516
- <tr>
517
- <td>
518
- <pre class="lines">
519
-
520
-
521
- 77
522
- 78
523
- 79</pre>
524
- </td>
525
- <td>
526
- <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 77</span>
527
-
528
- <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span>
529
- <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='id identifier rubyid_sym'>sym</span><span class='rbracket'>]</span>
530
- <span class='kw'>end</span></pre>
531
- </td>
532
- </tr>
533
- </table>
534
- </div>
535
-
536
- <div class="method_details ">
537
- <h3 class="signature " id="check_template_dir-instance_method">
538
-
539
- #<strong>check_template_dir</strong> &#x21d2; <tt>Object</tt>
540
-
541
-
542
-
543
-
544
-
545
- </h3><table class="source_code">
546
- <tr>
547
- <td>
548
- <pre class="lines">
549
-
550
-
551
- 28
552
- 29
553
- 30
554
- 31
555
- 32
556
- 33
557
- 34
558
- 35
559
- 36</pre>
560
- </td>
561
- <td>
562
- <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 28</span>
563
-
564
- <span class='kw'>def</span> <span class='id identifier rubyid_check_template_dir'>check_template_dir</span>
565
- <span class='id identifier rubyid_temp_path'>temp_path</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>../templates</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid___dir__'>__dir__</span><span class='rparen'>)</span>
566
-
567
- <span class='kw'>if</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:template_dir</span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='id identifier rubyid_temp_path'>temp_path</span>
568
- <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>adjust inconsistency of template_dir.\n</span><span class='tstring_end'>&quot;</span></span>
569
- <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:template_dir</span><span class='rbracket'>]</span><span class='op'>=</span> <span class='id identifier rubyid_temp_path'>temp_path</span>
570
- <span class='id identifier rubyid_save_config'>save_config</span>
571
- <span class='kw'>end</span>
572
- <span class='kw'>end</span></pre>
573
- </td>
574
- </tr>
575
- </table>
576
- </div>
577
-
578
- <div class="method_details ">
579
- <h3 class="signature " id="configure-instance_method">
580
-
581
- #<strong>configure</strong>(opts = nil) &#x21d2; <tt>Object</tt>
582
-
583
-
584
-
585
-
586
-
587
- </h3><div class="docstring">
588
- <div class="discussion">
589
-
590
- <p>Configure through hash</p>
591
-
592
-
593
- </div>
594
- </div>
595
- <div class="tags">
596
-
597
-
598
- </div><table class="source_code">
599
- <tr>
600
- <td>
601
- <pre class="lines">
602
-
603
-
604
- 38
605
- 39
606
- 40
607
- 41
608
- 42
609
- 43
610
- 44
611
- 45
612
- 46
613
- 47
614
- 48
615
- 49
616
- 50
617
- 51
618
- 52
619
- 53</pre>
620
- </td>
621
- <td>
622
- <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 38</span>
623
-
624
- <span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
625
- <span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>==</span> <span class='kw'>nil</span>
626
- <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
627
- <span class='kw'>if</span> <span class='ivar'>@valid_config_keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
628
- <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span>
629
- <span class='kw'>elsif</span> <span class='id identifier rubyid_k'>k</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
630
- <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Valid key words are follows:</span><span class='tstring_end'>&quot;</span></span>
631
- <span class='id identifier rubyid_p'>p</span> <span class='ivar'>@valid_config_keys</span>
632
- <span class='kw'>else</span>
633
- <span class='id identifier rubyid_raise'>raise</span> <span class='const'>KeyError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error: keyword &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; is invalid</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
634
- <span class='label'>receiver:</span> <span class='ivar'>@config</span><span class='comma'>,</span>
635
- <span class='label'>key:</span> <span class='id identifier rubyid_k'>k</span><span class='rparen'>)</span>
636
- <span class='kw'>end</span>
637
- <span class='kw'>end</span>
638
- <span class='ivar'>@config</span>
639
- <span class='kw'>end</span></pre>
640
- </td>
641
- </tr>
642
- </table>
643
- </div>
644
-
645
- <div class="method_details ">
646
- <h3 class="signature " id="configure_with-instance_method">
647
-
648
- #<strong>configure_with</strong>(path) &#x21d2; <tt>Object</tt>
649
-
650
-
651
-
652
-
653
-
654
- </h3><div class="docstring">
655
- <div class="discussion">
656
-
657
- <p>Configure through yaml file</p>
658
-
659
-
660
- </div>
661
- </div>
662
- <div class="tags">
663
-
664
-
665
- </div><table class="source_code">
666
- <tr>
667
- <td>
668
- <pre class="lines">
669
-
670
-
671
- 56
672
- 57
673
- 58
674
- 59
675
- 60
676
- 61
677
- 62
678
- 63
679
- 64
680
- 65
681
- 66
682
- 67
683
- 68</pre>
684
- </td>
685
- <td>
686
- <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 56</span>
687
-
688
- <span class='kw'>def</span> <span class='id identifier rubyid_configure_with'>configure_with</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
689
- <span class='kw'>begin</span>
690
- <span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_safe_load'>safe_load</span><span class='lparen'>(</span><span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span>
691
- <span class='label'>permitted_classes:</span> <span class='lbracket'>[</span><span class='const'>Symbol</span><span class='rbracket'>]</span><span class='rparen'>)</span>
692
- <span class='kw'>rescue</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>ENOENT</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
693
- <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>WARNING: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_content'>.\nUsing default conf.</span><span class='tstring_end'>&quot;</span></span>
694
- <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_message'>message</span> <span class='kw'>if</span> <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:verbose</span><span class='rbracket'>]</span>
695
- <span class='kw'>rescue</span> <span class='const'>Psych</span><span class='op'>::</span><span class='const'>SyntaxError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
696
- <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>WARNING: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_content'>.\nUsing default conf.</span><span class='tstring_end'>&quot;</span></span>
697
- <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_message'>message</span> <span class='kw'>if</span> <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:verbose</span><span class='rbracket'>]</span>
698
- <span class='kw'>end</span>
699
- <span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
700
- <span class='kw'>end</span></pre>
701
- </td>
702
- </tr>
703
- </table>
704
- </div>
705
-
706
- <div class="method_details ">
707
- <h3 class="signature " id="save_config-instance_method">
708
-
709
- #<strong>save_config</strong> &#x21d2; <tt>Object</tt>
710
-
711
-
712
-
713
-
714
-
715
- </h3><div class="docstring">
716
- <div class="discussion">
717
-
718
- <p>save config in @<a href=":conf_file">config</a></p>
719
-
720
-
721
- </div>
722
- </div>
723
- <div class="tags">
724
-
725
-
726
- </div><table class="source_code">
727
- <tr>
728
- <td>
729
- <pre class="lines">
730
-
731
-
732
- 71
733
- 72
734
- 73</pre>
735
- </td>
736
- <td>
737
- <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 71</span>
738
-
739
- <span class='kw'>def</span> <span class='id identifier rubyid_save_config'>save_config</span><span class='lparen'>(</span><span class='rparen'>)</span>
740
- <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:conf_file</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span><span class='rparen'>)</span>
741
- <span class='kw'>end</span></pre>
742
- </td>
743
- </tr>
744
- </table>
745
- </div>
746
-
747
- </div>
748
-
749
- </div>
750
-
751
- <div id="footer">
752
- Generated on Tue Oct 15 12:36:20 2024 by
753
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
754
- 0.9.37 (ruby-3.0.2).
755
- </div>
756
-
757
- </div>
758
- </body>
759
- </html>