my_help 1.2.2 → 1.2.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,542 +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::Org2Hash
8
-
9
- &mdash; Documentation by YARD 0.9.28
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::Org2Hash";
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 (O)</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">Org2Hash</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::Org2Hash
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::Org2Hash</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/org2hash.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
-
105
- <p>get org and trans it to hash by FSM</p>
106
-
107
-
108
- </div>
109
- </div>
110
- <div class="tags">
111
-
112
-
113
- </div>
114
-
115
- <h2>
116
- Constant Summary
117
- <small><a href="#" class="constants_summary_toggle">collapse</a></small>
118
- </h2>
119
-
120
- <dl class="constants">
121
-
122
- <dt id="TRANSITIONS-constant" class="">TRANSITIONS =
123
- <div class="docstring">
124
- <div class="discussion">
125
-
126
- <p>current_state =&gt; [ new_state, action ]</p>
127
-
128
-
129
- </div>
130
- </div>
131
- <div class="tags">
132
-
133
-
134
- </div>
135
- </dt>
136
- <dd><pre class="code"><span class='lbrace'>{</span>
137
- <span class='symbol'>:header_read</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
138
- <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>* </span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='symbol'>:contents_read</span><span class='comma'>,</span> <span class='symbol'>:start_new_item</span><span class='rbracket'>]</span><span class='comma'>,</span>
139
- <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='symbol'>:header_read</span><span class='comma'>,</span> <span class='symbol'>:ignore</span><span class='rbracket'>]</span><span class='comma'>,</span>
140
- <span class='rbrace'>}</span><span class='comma'>,</span>
141
- <span class='symbol'>:contents_read</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
142
- <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>* </span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='symbol'>:contents_read</span><span class='comma'>,</span> <span class='symbol'>:start_new_item</span><span class='rbracket'>]</span><span class='comma'>,</span>
143
- <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='symbol'>:contents_read</span><span class='comma'>,</span> <span class='symbol'>:add_contents</span><span class='rbracket'>]</span><span class='comma'>,</span>
144
- <span class='rbrace'>}</span><span class='comma'>,</span>
145
- <span class='rbrace'>}</span></pre></dd>
146
-
147
- </dl>
148
-
149
-
150
-
151
-
152
-
153
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
154
- <ul class="summary">
155
-
156
- <li class="public ">
157
- <span class="summary_signature">
158
-
159
- <a href="#contents-instance_method" title="#contents (instance method)">#<strong>contents</strong> &#x21d2; Object </a>
160
-
161
-
162
-
163
- </span>
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
- <span class="summary_desc"><div class='inline'>
177
- <p>Returns the value of attribute contents.</p>
178
- </div></span>
179
-
180
- </li>
181
-
182
-
183
- <li class="public ">
184
- <span class="summary_signature">
185
-
186
- <a href="#text-instance_method" title="#text (instance method)">#<strong>text</strong> &#x21d2; Object </a>
187
-
188
-
189
-
190
- </span>
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
- <span class="summary_desc"><div class='inline'>
204
- <p>Returns the value of attribute text.</p>
205
- </div></span>
206
-
207
- </li>
208
-
209
-
210
- </ul>
211
-
212
-
213
-
214
-
215
-
216
- <h2>
217
- Instance Method Summary
218
- <small><a href="#" class="summary_toggle">collapse</a></small>
219
- </h2>
220
-
221
- <ul class="summary">
222
-
223
- <li class="public ">
224
- <span class="summary_signature">
225
-
226
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(org_text) &#x21d2; Org2Hash </a>
227
-
228
-
229
-
230
- </span>
231
-
232
-
233
- <span class="note title constructor">constructor</span>
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
- <span class="summary_desc"><div class='inline'>
243
- <p>A new instance of Org2Hash.</p>
244
- </div></span>
245
-
246
- </li>
247
-
248
-
249
- <li class="public ">
250
- <span class="summary_signature">
251
-
252
- <a href="#read_item-instance_method" title="#read_item (instance method)">#<strong>read_item</strong>(line) &#x21d2; Object </a>
253
-
254
-
255
-
256
- </span>
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
- <span class="summary_desc"><div class='inline'></div></span>
267
-
268
- </li>
269
-
270
-
271
- <li class="public ">
272
- <span class="summary_signature">
273
-
274
- <a href="#simple_fsm-instance_method" title="#simple_fsm (instance method)">#<strong>simple_fsm</strong> &#x21d2; Object </a>
275
-
276
-
277
-
278
- </span>
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
-
287
-
288
- <span class="summary_desc"><div class='inline'></div></span>
289
-
290
- </li>
291
-
292
-
293
- </ul>
294
-
295
-
296
- <div id="constructor_details" class="method_details_list">
297
- <h2>Constructor Details</h2>
298
-
299
- <div class="method_details first">
300
- <h3 class="signature first" id="initialize-instance_method">
301
-
302
- #<strong>initialize</strong>(org_text) &#x21d2; <tt><span class='object_link'><a href="" title="MyHelp::Org2Hash (class)">Org2Hash</a></span></tt>
303
-
304
-
305
-
306
-
307
-
308
- </h3><div class="docstring">
309
- <div class="discussion">
310
-
311
- <p>Returns a new instance of Org2Hash.</p>
312
-
313
-
314
- </div>
315
- </div>
316
- <div class="tags">
317
-
318
-
319
- </div><table class="source_code">
320
- <tr>
321
- <td>
322
- <pre class="lines">
323
-
324
-
325
- 17
326
- 18
327
- 19
328
- 20
329
- 21</pre>
330
- </td>
331
- <td>
332
- <pre class="code"><span class="info file"># File 'lib/my_help/org2hash.rb', line 17</span>
333
-
334
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_org_text'>org_text</span><span class='rparen'>)</span>
335
- <span class='ivar'>@text</span> <span class='op'>=</span> <span class='id identifier rubyid_org_text'>org_text</span>
336
- <span class='ivar'>@contents</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
337
- <span class='id identifier rubyid_simple_fsm'>simple_fsm</span><span class='lparen'>(</span><span class='rparen'>)</span>
338
- <span class='kw'>end</span></pre>
339
- </td>
340
- </tr>
341
- </table>
342
- </div>
343
-
344
- </div>
345
-
346
- <div id="instance_attr_details" class="attr_details">
347
- <h2>Instance Attribute Details</h2>
348
-
349
-
350
- <span id="contents=-instance_method"></span>
351
- <div class="method_details first">
352
- <h3 class="signature first" id="contents-instance_method">
353
-
354
- #<strong>contents</strong> &#x21d2; <tt>Object</tt>
355
-
356
-
357
-
358
-
359
-
360
- </h3><div class="docstring">
361
- <div class="discussion">
362
-
363
- <p>Returns the value of attribute contents.</p>
364
-
365
-
366
- </div>
367
- </div>
368
- <div class="tags">
369
-
370
-
371
- </div><table class="source_code">
372
- <tr>
373
- <td>
374
- <pre class="lines">
375
-
376
-
377
- 4
378
- 5
379
- 6</pre>
380
- </td>
381
- <td>
382
- <pre class="code"><span class="info file"># File 'lib/my_help/org2hash.rb', line 4</span>
383
-
384
- <span class='kw'>def</span> <span class='id identifier rubyid_contents'>contents</span>
385
- <span class='ivar'>@contents</span>
386
- <span class='kw'>end</span></pre>
387
- </td>
388
- </tr>
389
- </table>
390
- </div>
391
-
392
-
393
- <span id="text=-instance_method"></span>
394
- <div class="method_details ">
395
- <h3 class="signature " id="text-instance_method">
396
-
397
- #<strong>text</strong> &#x21d2; <tt>Object</tt>
398
-
399
-
400
-
401
-
402
-
403
- </h3><div class="docstring">
404
- <div class="discussion">
405
-
406
- <p>Returns the value of attribute text.</p>
407
-
408
-
409
- </div>
410
- </div>
411
- <div class="tags">
412
-
413
-
414
- </div><table class="source_code">
415
- <tr>
416
- <td>
417
- <pre class="lines">
418
-
419
-
420
- 4
421
- 5
422
- 6</pre>
423
- </td>
424
- <td>
425
- <pre class="code"><span class="info file"># File 'lib/my_help/org2hash.rb', line 4</span>
426
-
427
- <span class='kw'>def</span> <span class='id identifier rubyid_text'>text</span>
428
- <span class='ivar'>@text</span>
429
- <span class='kw'>end</span></pre>
430
- </td>
431
- </tr>
432
- </table>
433
- </div>
434
-
435
- </div>
436
-
437
-
438
- <div id="instance_method_details" class="method_details_list">
439
- <h2>Instance Method Details</h2>
440
-
441
-
442
- <div class="method_details first">
443
- <h3 class="signature first" id="read_item-instance_method">
444
-
445
- #<strong>read_item</strong>(line) &#x21d2; <tt>Object</tt>
446
-
447
-
448
-
449
-
450
-
451
- </h3><table class="source_code">
452
- <tr>
453
- <td>
454
- <pre class="lines">
455
-
456
-
457
- 41
458
- 42
459
- 43</pre>
460
- </td>
461
- <td>
462
- <pre class="code"><span class="info file"># File 'lib/my_help/org2hash.rb', line 41</span>
463
-
464
- <span class='kw'>def</span> <span class='id identifier rubyid_read_item'>read_item</span><span class='lparen'>(</span><span class='id identifier rubyid_line'>line</span><span class='rparen'>)</span>
465
- <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\* (.+)</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
466
- <span class='kw'>end</span></pre>
467
- </td>
468
- </tr>
469
- </table>
470
- </div>
471
-
472
- <div class="method_details ">
473
- <h3 class="signature " id="simple_fsm-instance_method">
474
-
475
- #<strong>simple_fsm</strong> &#x21d2; <tt>Object</tt>
476
-
477
-
478
-
479
-
480
-
481
- </h3><table class="source_code">
482
- <tr>
483
- <td>
484
- <pre class="lines">
485
-
486
-
487
- 23
488
- 24
489
- 25
490
- 26
491
- 27
492
- 28
493
- 29
494
- 30
495
- 31
496
- 32
497
- 33
498
- 34
499
- 35
500
- 36
501
- 37
502
- 38
503
- 39</pre>
504
- </td>
505
- <td>
506
- <pre class="code"><span class="info file"># File 'lib/my_help/org2hash.rb', line 23</span>
507
-
508
- <span class='kw'>def</span> <span class='id identifier rubyid_simple_fsm'>simple_fsm</span><span class='lparen'>(</span><span class='rparen'>)</span>
509
- <span class='id identifier rubyid_state'>state</span> <span class='op'>=</span> <span class='symbol'>:header_read</span>
510
- <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
511
- <span class='ivar'>@text</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</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_line'>line</span><span class='op'>|</span>
512
- <span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>&lt;</span> <span class='int'>1</span>
513
- <span class='id identifier rubyid_state'>state</span><span class='comma'>,</span> <span class='id identifier rubyid_action'>action</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#TRANSITIONS-constant" title="MyHelp::Org2Hash::TRANSITIONS (constant)">TRANSITIONS</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_state'>state</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_line'>line</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>||</span>
514
- <span class='const'><span class='object_link'><a href="#TRANSITIONS-constant" title="MyHelp::Org2Hash::TRANSITIONS (constant)">TRANSITIONS</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_state'>state</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:default</span><span class='rbracket'>]</span>
515
- <span class='kw'>case</span> <span class='id identifier rubyid_action'>action</span>
516
- <span class='kw'>when</span> <span class='symbol'>:ignore</span>
517
- <span class='kw'>when</span> <span class='symbol'>:start_new_item</span>
518
- <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='id identifier rubyid_read_item'>read_item</span><span class='lparen'>(</span><span class='id identifier rubyid_line'>line</span><span class='rparen'>)</span>
519
- <span class='ivar'>@contents</span><span class='lbracket'>[</span><span class='id identifier rubyid_item'>item</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
520
- <span class='kw'>when</span> <span class='symbol'>:add_contents</span>
521
- <span class='ivar'>@contents</span><span class='lbracket'>[</span><span class='id identifier rubyid_item'>item</span><span class='rbracket'>]</span> <span class='op'>+=</span> <span class='id identifier rubyid_line'>line</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
522
- <span class='kw'>end</span>
523
- <span class='kw'>end</span>
524
- <span class='kw'>end</span></pre>
525
- </td>
526
- </tr>
527
- </table>
528
- </div>
529
-
530
- </div>
531
-
532
- </div>
533
-
534
- <div id="footer">
535
- Generated on Fri Jan 6 13:07:57 2023 by
536
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
537
- 0.9.28 (ruby-3.0.2).
538
- </div>
539
-
540
- </div>
541
- </body>
542
- </html>
data/doc/MyHelp.html DELETED
@@ -1,135 +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
- Module: MyHelp
8
-
9
- &mdash; Documentation by YARD 0.9.28
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";
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 (M)</a> &raquo;
40
-
41
-
42
- <span class="title">MyHelp</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: MyHelp
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
- <dl>
80
- <dt>Defined in:</dt>
81
- <dd>lib/my_help.rb<span class="defines">,<br />
82
- lib/my_help/cli.rb,<br /> lib/my_help/init.rb,<br /> lib/my_help/list.rb,<br /> lib/my_help/config.rb,<br /> lib/my_help/modify.rb,<br /> lib/my_help/git_cli.rb,<br /> lib/my_help/md2hash.rb,<br /> lib/my_help/version.rb,<br /> lib/my_help/org2hash.rb</span>
83
- </dd>
84
- </dl>
85
-
86
- </div>
87
-
88
- <h2>Defined Under Namespace</h2>
89
- <p class="children">
90
-
91
-
92
- <strong class="modules">Modules:</strong> <span class='object_link'><a href="MyHelp/GetConfig.html" title="MyHelp::GetConfig (module)">GetConfig</a></span>
93
-
94
-
95
-
96
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="MyHelp/CLI.html" title="MyHelp::CLI (class)">CLI</a></span>, <span class='object_link'><a href="MyHelp/Config.html" title="MyHelp::Config (class)">Config</a></span>, <span class='object_link'><a href="MyHelp/Error.html" title="MyHelp::Error (class)">Error</a></span>, <span class='object_link'><a href="MyHelp/Git.html" title="MyHelp::Git (class)">Git</a></span>, <span class='object_link'><a href="MyHelp/Init.html" title="MyHelp::Init (class)">Init</a></span>, <span class='object_link'><a href="MyHelp/List.html" title="MyHelp::List (class)">List</a></span>, <span class='object_link'><a href="MyHelp/Md2Hash.html" title="MyHelp::Md2Hash (class)">Md2Hash</a></span>, <span class='object_link'><a href="MyHelp/Modify.html" title="MyHelp::Modify (class)">Modify</a></span>, <span class='object_link'><a href="MyHelp/Org2Hash.html" title="MyHelp::Org2Hash (class)">Org2Hash</a></span>
97
-
98
-
99
- </p>
100
-
101
-
102
- <h2>
103
- Constant Summary
104
- <small><a href="#" class="constants_summary_toggle">collapse</a></small>
105
- </h2>
106
-
107
- <dl class="constants">
108
-
109
- <dt id="VERSION-constant" class="">VERSION =
110
-
111
- </dt>
112
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.1a</span><span class='tstring_end'>&quot;</span></span></pre></dd>
113
-
114
- </dl>
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
- </div>
126
-
127
- <div id="footer">
128
- Generated on Fri Jan 6 13:07:57 2023 by
129
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
130
- 0.9.28 (ruby-3.0.2).
131
- </div>
132
-
133
- </div>
134
- </body>
135
- </html>