term_utils 0.2.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/COPYING +3 -3
  4. data/README.md +7 -1
  5. data/doc/TermUtils/AP/Article.html +991 -0
  6. data/doc/TermUtils/AP/Element.html +1025 -0
  7. data/doc/TermUtils/AP/Flag.html +539 -0
  8. data/doc/TermUtils/AP/Level.html +638 -0
  9. data/doc/TermUtils/AP/NoSuchValueError.html +217 -0
  10. data/doc/TermUtils/AP/Parameter.html +804 -0
  11. data/doc/TermUtils/AP/ParseError.html +217 -0
  12. data/doc/TermUtils/AP/Parser.html +572 -0
  13. data/doc/TermUtils/AP/Result.html +1029 -0
  14. data/doc/TermUtils/AP/ResultView.html +597 -0
  15. data/doc/TermUtils/AP/Syntax.html +1051 -0
  16. data/doc/TermUtils/AP/SyntaxError.html +217 -0
  17. data/doc/TermUtils/AP.html +505 -0
  18. data/doc/TermUtils/FF/Config.html +1 -1
  19. data/doc/TermUtils/FF/Cursor/Context.html +1 -1
  20. data/doc/TermUtils/FF/Cursor.html +1 -1
  21. data/doc/TermUtils/FF/Query.html +1 -1
  22. data/doc/TermUtils/FF.html +1 -1
  23. data/doc/TermUtils/PropertyTreeNode.html +1999 -0
  24. data/doc/TermUtils/Tab/Column.html +1 -1
  25. data/doc/TermUtils/Tab/Holder.html +1 -1
  26. data/doc/TermUtils/Tab/Printer.html +1 -1
  27. data/doc/TermUtils/Tab/Table.html +1 -1
  28. data/doc/TermUtils/Tab.html +1 -1
  29. data/doc/TermUtils.html +5 -3
  30. data/doc/_index.html +143 -1
  31. data/doc/class_list.html +1 -1
  32. data/doc/file.README.html +8 -2
  33. data/doc/index.html +8 -2
  34. data/doc/method_list.html +638 -22
  35. data/doc/top-level-namespace.html +1 -1
  36. data/lib/term_utils/ap/article.rb +68 -0
  37. data/lib/term_utils/ap/element.rb +78 -0
  38. data/lib/term_utils/ap/flag.rb +48 -0
  39. data/lib/term_utils/ap/level.rb +57 -0
  40. data/lib/term_utils/ap/no_such_value_error.rb +27 -0
  41. data/lib/term_utils/ap/parameter.rb +75 -0
  42. data/lib/term_utils/ap/parse_error.rb +27 -0
  43. data/lib/term_utils/ap/parser.rb +185 -0
  44. data/lib/term_utils/ap/result.rb +175 -0
  45. data/lib/term_utils/ap/syntax.rb +112 -0
  46. data/lib/term_utils/ap/syntax_error.rb +27 -0
  47. data/lib/term_utils/ap.rb +59 -0
  48. data/lib/term_utils/property_tree_node.rb +200 -0
  49. data/lib/term_utils.rb +1 -0
  50. data/term_utils.gemspec +2 -2
  51. metadata +29 -2
@@ -0,0 +1,597 @@
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: TermUtils::AP::ResultView
8
+
9
+ &mdash; Documentation by YARD 0.9.20
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "TermUtils::AP::ResultView";
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 (R)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../AP.html" title="TermUtils::AP (module)">AP</a></span></span>
41
+ &raquo;
42
+ <span class="title">ResultView</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: TermUtils::AP::ResultView
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">TermUtils::AP::ResultView</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/term_utils/ap/result_view.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Represents an argument parsing Result View.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+ <h2>
122
+ Instance Method Summary
123
+ <small><a href="#" class="summary_toggle">collapse</a></small>
124
+ </h2>
125
+
126
+ <ul class="summary">
127
+
128
+ <li class="public ">
129
+ <span class="summary_signature">
130
+
131
+ <a href="#eval_occurs-instance_method" title="#eval_occurs (instance method)">#<strong>eval_occurs</strong>(id) &#x21d2; Integer </a>
132
+
133
+
134
+
135
+ </span>
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+ <span class="summary_desc"><div class='inline'>
146
+ <p>Evaluates the number of occurs of a given level, parameter or article.</p>
147
+ </div></span>
148
+
149
+ </li>
150
+
151
+
152
+ <li class="public ">
153
+ <span class="summary_signature">
154
+
155
+ <a href="#fetch_value-instance_method" title="#fetch_value (instance method)">#<strong>fetch_value</strong>(id, opts = {}) &#x21d2; Object </a>
156
+
157
+
158
+
159
+ </span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+ <span class="summary_desc"><div class='inline'>
170
+ <p>Fetches a value.</p>
171
+ </div></span>
172
+
173
+ </li>
174
+
175
+
176
+ <li class="public ">
177
+ <span class="summary_signature">
178
+
179
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(result, id) &#x21d2; ResultView </a>
180
+
181
+
182
+
183
+ </span>
184
+
185
+
186
+ <span class="note title constructor">constructor</span>
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Constructs a new ResultView.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#present%3F-instance_method" title="#present? (instance method)">#<strong>present?</strong>(id) &#x21d2; Boolean </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'>
220
+ <p>Tests whether a given article is present.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ </ul>
227
+
228
+
229
+ <div id="constructor_details" class="method_details_list">
230
+ <h2>Constructor Details</h2>
231
+
232
+ <div class="method_details first">
233
+ <h3 class="signature first" id="initialize-instance_method">
234
+
235
+ #<strong>initialize</strong>(result, id) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::AP::ResultView (class)">ResultView</a></span></tt>
236
+
237
+
238
+
239
+
240
+
241
+ </h3><div class="docstring">
242
+ <div class="discussion">
243
+
244
+ <p>Constructs a new ResultView.</p>
245
+
246
+
247
+ </div>
248
+ </div>
249
+ <div class="tags">
250
+ <p class="tag_title">Parameters:</p>
251
+ <ul class="param">
252
+
253
+ <li>
254
+
255
+ <span class='name'>result</span>
256
+
257
+
258
+ <span class='type'>(<tt><span class='object_link'><a href="Result.html" title="TermUtils::AP::Result (class)">TermUtils::AP::Result</a></span></tt>)</span>
259
+
260
+
261
+
262
+ </li>
263
+
264
+ <li>
265
+
266
+ <span class='name'>id</span>
267
+
268
+
269
+ <span class='type'>(<tt>Array&lt;Symbol&gt;</tt>)</span>
270
+
271
+
272
+
273
+ </li>
274
+
275
+ </ul>
276
+
277
+
278
+ </div><table class="source_code">
279
+ <tr>
280
+ <td>
281
+ <pre class="lines">
282
+
283
+
284
+ 25
285
+ 26
286
+ 27
287
+ 28</pre>
288
+ </td>
289
+ <td>
290
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ap/result_view.rb', line 25</span>
291
+
292
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
293
+ <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
294
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
295
+ <span class='kw'>end</span></pre>
296
+ </td>
297
+ </tr>
298
+ </table>
299
+ </div>
300
+
301
+ </div>
302
+
303
+
304
+ <div id="instance_method_details" class="method_details_list">
305
+ <h2>Instance Method Details</h2>
306
+
307
+
308
+ <div class="method_details first">
309
+ <h3 class="signature first" id="eval_occurs-instance_method">
310
+
311
+ #<strong>eval_occurs</strong>(id) &#x21d2; <tt>Integer</tt>
312
+
313
+
314
+
315
+
316
+
317
+ </h3><div class="docstring">
318
+ <div class="discussion">
319
+
320
+ <p>Evaluates the number of occurs of a given level, parameter or article.</p>
321
+
322
+
323
+ </div>
324
+ </div>
325
+ <div class="tags">
326
+ <p class="tag_title">Parameters:</p>
327
+ <ul class="param">
328
+
329
+ <li>
330
+
331
+ <span class='name'>id</span>
332
+
333
+
334
+ <span class='type'>(<tt>Symbol</tt>, <tt>Array&lt;Symbol&gt;</tt>)</span>
335
+
336
+
337
+
338
+ </li>
339
+
340
+ </ul>
341
+
342
+ <p class="tag_title">Returns:</p>
343
+ <ul class="return">
344
+
345
+ <li>
346
+
347
+
348
+ <span class='type'>(<tt>Integer</tt>)</span>
349
+
350
+
351
+
352
+ </li>
353
+
354
+ </ul>
355
+
356
+ </div><table class="source_code">
357
+ <tr>
358
+ <td>
359
+ <pre class="lines">
360
+
361
+
362
+ 39
363
+ 40
364
+ 41
365
+ 42</pre>
366
+ </td>
367
+ <td>
368
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ap/result_view.rb', line 39</span>
369
+
370
+ <span class='kw'>def</span> <span class='id identifier rubyid_eval_occurs'>eval_occurs</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
371
+ <span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Symbol</span>
372
+ <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_eval_occurs'>eval_occurs</span><span class='lparen'>(</span><span class='ivar'>@id</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='rparen'>)</span>
373
+ <span class='kw'>end</span></pre>
374
+ </td>
375
+ </tr>
376
+ </table>
377
+ </div>
378
+
379
+ <div class="method_details ">
380
+ <h3 class="signature " id="fetch_value-instance_method">
381
+
382
+ #<strong>fetch_value</strong>(id, opts = {}) &#x21d2; <tt>Object</tt>
383
+
384
+
385
+
386
+
387
+
388
+ </h3><div class="docstring">
389
+ <div class="discussion">
390
+
391
+ <p>Fetches a value.</p>
392
+
393
+
394
+ </div>
395
+ </div>
396
+ <div class="tags">
397
+ <p class="tag_title">Parameters:</p>
398
+ <ul class="param">
399
+
400
+ <li>
401
+
402
+ <span class='name'>id</span>
403
+
404
+
405
+ <span class='type'>(<tt>Symbol</tt>, <tt>Array&lt;Symbol&gt;</tt>)</span>
406
+
407
+
408
+
409
+ </li>
410
+
411
+ <li>
412
+
413
+ <span class='name'>opts</span>
414
+
415
+
416
+ <span class='type'>(<tt>Hash</tt>)</span>
417
+
418
+
419
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
420
+
421
+
422
+ &mdash;
423
+ <div class='inline'>
424
+ <p>`:index`, `:multi`.</p>
425
+ </div>
426
+
427
+ </li>
428
+
429
+ </ul>
430
+
431
+
432
+
433
+
434
+
435
+
436
+ <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
437
+ <ul class="option">
438
+
439
+ <li>
440
+ <span class="name">:index</span>
441
+ <span class="type">(<tt>Integer</tt>)</span>
442
+ <span class="default">
443
+
444
+ </span>
445
+
446
+ </li>
447
+
448
+ <li>
449
+ <span class="name">:multi</span>
450
+ <span class="type">(<tt>Boolean</tt>)</span>
451
+ <span class="default">
452
+
453
+ </span>
454
+
455
+ &mdash; <div class='inline'>
456
+ <p>Whether an array of values shall be returned instead of a single value.</p>
457
+ </div>
458
+
459
+ </li>
460
+
461
+ </ul>
462
+
463
+
464
+ <p class="tag_title">Returns:</p>
465
+ <ul class="return">
466
+
467
+ <li>
468
+
469
+
470
+ <span class='type'>(<tt>Object</tt>)</span>
471
+
472
+
473
+
474
+ </li>
475
+
476
+ </ul>
477
+ <p class="tag_title">Raises:</p>
478
+ <ul class="raise">
479
+
480
+ <li>
481
+
482
+
483
+ <span class='type'>(<tt><span class='object_link'><a href="NoSuchValueError.html" title="TermUtils::AP::NoSuchValueError (class)">TermUtils::AP::NoSuchValueError</a></span></tt>)</span>
484
+
485
+
486
+
487
+ </li>
488
+
489
+ </ul>
490
+
491
+ </div><table class="source_code">
492
+ <tr>
493
+ <td>
494
+ <pre class="lines">
495
+
496
+
497
+ 50
498
+ 51
499
+ 52
500
+ 53</pre>
501
+ </td>
502
+ <td>
503
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ap/result_view.rb', line 50</span>
504
+
505
+ <span class='kw'>def</span> <span class='id identifier rubyid_fetch_value'>fetch_value</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
506
+ <span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Symbol</span>
507
+ <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_fetch_value'>fetch_value</span><span class='lparen'>(</span><span class='ivar'>@id</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
508
+ <span class='kw'>end</span></pre>
509
+ </td>
510
+ </tr>
511
+ </table>
512
+ </div>
513
+
514
+ <div class="method_details ">
515
+ <h3 class="signature " id="present?-instance_method">
516
+
517
+ #<strong>present?</strong>(id) &#x21d2; <tt>Boolean</tt>
518
+
519
+
520
+
521
+
522
+
523
+ </h3><div class="docstring">
524
+ <div class="discussion">
525
+
526
+ <p>Tests whether a given article is present.</p>
527
+
528
+
529
+ </div>
530
+ </div>
531
+ <div class="tags">
532
+ <p class="tag_title">Parameters:</p>
533
+ <ul class="param">
534
+
535
+ <li>
536
+
537
+ <span class='name'>id</span>
538
+
539
+
540
+ <span class='type'>(<tt>Symbol</tt>, <tt>Array&lt;Symbol&gt;</tt>)</span>
541
+
542
+
543
+
544
+ </li>
545
+
546
+ </ul>
547
+
548
+ <p class="tag_title">Returns:</p>
549
+ <ul class="return">
550
+
551
+ <li>
552
+
553
+
554
+ <span class='type'>(<tt>Boolean</tt>)</span>
555
+
556
+
557
+
558
+ </li>
559
+
560
+ </ul>
561
+
562
+ </div><table class="source_code">
563
+ <tr>
564
+ <td>
565
+ <pre class="lines">
566
+
567
+
568
+ 32
569
+ 33
570
+ 34
571
+ 35</pre>
572
+ </td>
573
+ <td>
574
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ap/result_view.rb', line 32</span>
575
+
576
+ <span class='kw'>def</span> <span class='id identifier rubyid_present?'>present?</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
577
+ <span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Symbol</span>
578
+ <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span><span class='lparen'>(</span><span class='ivar'>@id</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='rparen'>)</span>
579
+ <span class='kw'>end</span></pre>
580
+ </td>
581
+ </tr>
582
+ </table>
583
+ </div>
584
+
585
+ </div>
586
+
587
+ </div>
588
+
589
+ <div id="footer">
590
+ Generated on Sun Nov 10 15:38:59 2019 by
591
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
592
+ 0.9.20 (ruby-2.6.5).
593
+ </div>
594
+
595
+ </div>
596
+ </body>
597
+ </html>