term_utils 0.3.2 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (70) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -2
  3. data/COPYING +3 -3
  4. data/README.md +51 -16
  5. data/Rakefile +6 -0
  6. data/doc/TermUtils/AP/Article.html +57 -55
  7. data/doc/TermUtils/AP/ArticleResult.html +584 -0
  8. data/doc/TermUtils/AP/Flag.html +295 -78
  9. data/doc/TermUtils/AP/Parameter.html +891 -103
  10. data/doc/TermUtils/AP/ParameterResult.html +980 -0
  11. data/doc/TermUtils/{FF/Cursor/Context.html → AP/ParameterWalkerHooks.html} +60 -60
  12. data/doc/TermUtils/AP/ParseError.html +651 -19
  13. data/doc/TermUtils/AP/Parser.html +181 -121
  14. data/doc/TermUtils/AP/Result.html +201 -528
  15. data/doc/TermUtils/AP/Syntax.html +103 -393
  16. data/doc/TermUtils/AP/SyntaxError.html +9 -91
  17. data/doc/TermUtils/AP/Walker.html +686 -0
  18. data/doc/TermUtils/AP.html +49 -160
  19. data/doc/TermUtils/FF/Config.html +203 -35
  20. data/doc/TermUtils/FF/Context.html +585 -0
  21. data/doc/TermUtils/FF/Entry.html +626 -0
  22. data/doc/TermUtils/FF/Finder.html +850 -0
  23. data/doc/TermUtils/FF/{Cursor.html → FinderEntry.html} +473 -211
  24. data/doc/TermUtils/FF/FinderQuery.html +946 -0
  25. data/doc/TermUtils/FF/Query.html +402 -70
  26. data/doc/TermUtils/FF.html +135 -11
  27. data/doc/TermUtils/PropertyTreeNode.html +304 -190
  28. data/doc/TermUtils/Tab/Column.html +98 -96
  29. data/doc/TermUtils/Tab/Header.html +30 -30
  30. data/doc/TermUtils/Tab/Holder.html +81 -81
  31. data/doc/TermUtils/Tab/Printer.html +43 -43
  32. data/doc/TermUtils/Tab/Table.html +124 -128
  33. data/doc/TermUtils/Tab/TableError.html +7 -89
  34. data/doc/TermUtils/Tab.html +93 -86
  35. data/doc/TermUtils.html +10 -10
  36. data/doc/_index.html +62 -42
  37. data/doc/class_list.html +3 -3
  38. data/doc/css/style.css +3 -2
  39. data/doc/file.README.html +63 -26
  40. data/doc/file_list.html +2 -2
  41. data/doc/frames.html +2 -2
  42. data/doc/index.html +63 -26
  43. data/doc/js/app.js +14 -3
  44. data/doc/method_list.html +708 -236
  45. data/doc/top-level-namespace.html +7 -7
  46. data/lib/term_utils/ap/article.rb +15 -9
  47. data/lib/term_utils/ap/flag.rb +37 -20
  48. data/lib/term_utils/ap/parameter.rb +88 -19
  49. data/lib/term_utils/ap/parser.rb +143 -116
  50. data/lib/term_utils/ap/result.rb +208 -161
  51. data/lib/term_utils/ap/syntax.rb +53 -69
  52. data/lib/term_utils/ap.rb +79 -24
  53. data/lib/term_utils/ff/config.rb +22 -10
  54. data/lib/term_utils/{ap/no_such_value_error.rb → ff/entry.rb} +26 -8
  55. data/lib/term_utils/ff/finder.rb +255 -0
  56. data/lib/term_utils/ff/query.rb +94 -17
  57. data/lib/term_utils/ff.rb +12 -2
  58. data/lib/term_utils/property_tree_node.rb +47 -19
  59. data/lib/term_utils/tab.rb +106 -61
  60. data/lib/term_utils.rb +8 -1
  61. data/term_utils.gemspec +4 -4
  62. metadata +18 -17
  63. data/doc/TermUtils/AP/Element.html +0 -1025
  64. data/doc/TermUtils/AP/Level.html +0 -638
  65. data/doc/TermUtils/AP/NoSuchValueError.html +0 -217
  66. data/lib/term_utils/ap/element.rb +0 -78
  67. data/lib/term_utils/ap/level.rb +0 -57
  68. data/lib/term_utils/ap/parse_error.rb +0 -27
  69. data/lib/term_utils/ap/syntax_error.rb +0 -27
  70. data/lib/term_utils/ff/cursor.rb +0 -153
data/doc/TermUtils/AP/ArticleResult.html ADDED
@@ -0,0 +1,584 @@
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::ArticleResult
8
+
9
+ &mdash; Documentation by YARD 0.9.34
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 = "TermUtils::AP::ArticleResult";
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 (A)</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">ArticleResult</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::ArticleResult
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::ArticleResult</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.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Represents a result for an article.</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="#article-instance_method" title="#article (instance method)">#<strong>article</strong> &#x21d2; Article </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+ <span class="summary_desc"><div class='inline'></div></span>
141
+
142
+ </li>
143
+
144
+
145
+ <li class="public ">
146
+ <span class="summary_signature">
147
+
148
+ <a href="#parent-instance_method" title="#parent (instance method)">#<strong>parent</strong> &#x21d2; ParameterResult </a>
149
+
150
+
151
+
152
+ </span>
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+ <span class="summary_desc"><div class='inline'></div></span>
166
+
167
+ </li>
168
+
169
+
170
+ <li class="public ">
171
+ <span class="summary_signature">
172
+
173
+ <a href="#value-instance_method" title="#value (instance method)">#<strong>value</strong> &#x21d2; Object </a>
174
+
175
+
176
+
177
+ </span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <span class="summary_desc"><div class='inline'></div></span>
191
+
192
+ </li>
193
+
194
+
195
+ </ul>
196
+
197
+
198
+
199
+
200
+
201
+ <h2>
202
+ Instance Method Summary
203
+ <small><a href="#" class="summary_toggle">collapse</a></small>
204
+ </h2>
205
+
206
+ <ul class="summary">
207
+
208
+ <li class="public ">
209
+ <span class="summary_signature">
210
+
211
+ <a href="#art_id-instance_method" title="#art_id (instance method)">#<strong>art_id</strong> &#x21d2; Symbol </a>
212
+
213
+
214
+
215
+ </span>
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+ <span class="summary_desc"><div class='inline'></div></span>
226
+
227
+ </li>
228
+
229
+
230
+ <li class="public ">
231
+ <span class="summary_signature">
232
+
233
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(parent, article, value) &#x21d2; ArticleResult </a>
234
+
235
+
236
+
237
+ </span>
238
+
239
+
240
+ <span class="note title constructor">constructor</span>
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ <span class="summary_desc"><div class='inline'>
250
+ <p>Constructs a new ArticleResult.</p>
251
+ </div></span>
252
+
253
+ </li>
254
+
255
+
256
+ </ul>
257
+
258
+
259
+ <div id="constructor_details" class="method_details_list">
260
+ <h2>Constructor Details</h2>
261
+
262
+ <div class="method_details first">
263
+ <h3 class="signature first" id="initialize-instance_method">
264
+
265
+ #<strong>initialize</strong>(parent, article, value) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::AP::ArticleResult (class)">ArticleResult</a></span></tt>
266
+
267
+
268
+
269
+
270
+
271
+ </h3><div class="docstring">
272
+ <div class="discussion">
273
+
274
+ <p>Constructs a new ArticleResult.</p>
275
+
276
+
277
+ </div>
278
+ </div>
279
+ <div class="tags">
280
+ <p class="tag_title">Parameters:</p>
281
+ <ul class="param">
282
+
283
+ <li>
284
+
285
+ <span class='name'>parent</span>
286
+
287
+
288
+ <span class='type'>(<tt><span class='object_link'><a href="ParameterResult.html" title="TermUtils::AP::ParameterResult (class)">ParameterResult</a></span></tt>)</span>
289
+
290
+
291
+
292
+ </li>
293
+
294
+ <li>
295
+
296
+ <span class='name'>article</span>
297
+
298
+
299
+ <span class='type'>(<tt><span class='object_link'><a href="Article.html" title="TermUtils::AP::Article (class)">Article</a></span></tt>)</span>
300
+
301
+
302
+
303
+ </li>
304
+
305
+ <li>
306
+
307
+ <span class='name'>value</span>
308
+
309
+
310
+ <span class='type'>(<tt>Object</tt>)</span>
311
+
312
+
313
+
314
+ </li>
315
+
316
+ </ul>
317
+
318
+
319
+ </div><table class="source_code">
320
+ <tr>
321
+ <td>
322
+ <pre class="lines">
323
+
324
+
325
+ 152
326
+ 153
327
+ 154
328
+ 155
329
+ 156
330
+ 157</pre>
331
+ </td>
332
+ <td>
333
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 152</span>
334
+
335
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_article'>article</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
336
+ <span class='ivar'>@parent</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span>
337
+ <span class='ivar'>@parent</span><span class='period'>.</span><span class='id identifier rubyid_add_result'>add_result</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
338
+ <span class='ivar'>@article</span> <span class='op'>=</span> <span class='id identifier rubyid_article'>article</span>
339
+ <span class='ivar'>@value</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
340
+ <span class='kw'>end</span></pre>
341
+ </td>
342
+ </tr>
343
+ </table>
344
+ </div>
345
+
346
+ </div>
347
+
348
+ <div id="instance_attr_details" class="attr_details">
349
+ <h2>Instance Attribute Details</h2>
350
+
351
+
352
+ <span id="article=-instance_method"></span>
353
+ <div class="method_details first">
354
+ <h3 class="signature first" id="article-instance_method">
355
+
356
+ #<strong>article</strong> &#x21d2; <tt><span class='object_link'><a href="Article.html" title="TermUtils::AP::Article (class)">Article</a></span></tt>
357
+
358
+
359
+
360
+
361
+
362
+ </h3><div class="docstring">
363
+ <div class="discussion">
364
+
365
+
366
+ </div>
367
+ </div>
368
+ <div class="tags">
369
+
370
+ <p class="tag_title">Returns:</p>
371
+ <ul class="return">
372
+
373
+ <li>
374
+
375
+
376
+ <span class='type'>(<tt><span class='object_link'><a href="Article.html" title="TermUtils::AP::Article (class)">Article</a></span></tt>)</span>
377
+
378
+
379
+
380
+ </li>
381
+
382
+ </ul>
383
+
384
+ </div><table class="source_code">
385
+ <tr>
386
+ <td>
387
+ <pre class="lines">
388
+
389
+
390
+ 144
391
+ 145
392
+ 146</pre>
393
+ </td>
394
+ <td>
395
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 144</span>
396
+
397
+ <span class='kw'>def</span> <span class='id identifier rubyid_article'>article</span>
398
+ <span class='ivar'>@article</span>
399
+ <span class='kw'>end</span></pre>
400
+ </td>
401
+ </tr>
402
+ </table>
403
+ </div>
404
+
405
+
406
+ <span id="parent=-instance_method"></span>
407
+ <div class="method_details ">
408
+ <h3 class="signature " id="parent-instance_method">
409
+
410
+ #<strong>parent</strong> &#x21d2; <tt><span class='object_link'><a href="ParameterResult.html" title="TermUtils::AP::ParameterResult (class)">ParameterResult</a></span></tt>
411
+
412
+
413
+
414
+
415
+
416
+ </h3><div class="docstring">
417
+ <div class="discussion">
418
+
419
+
420
+ </div>
421
+ </div>
422
+ <div class="tags">
423
+
424
+ <p class="tag_title">Returns:</p>
425
+ <ul class="return">
426
+
427
+ <li>
428
+
429
+
430
+ <span class='type'>(<tt><span class='object_link'><a href="ParameterResult.html" title="TermUtils::AP::ParameterResult (class)">ParameterResult</a></span></tt>)</span>
431
+
432
+
433
+
434
+ </li>
435
+
436
+ </ul>
437
+
438
+ </div><table class="source_code">
439
+ <tr>
440
+ <td>
441
+ <pre class="lines">
442
+
443
+
444
+ 142
445
+ 143
446
+ 144</pre>
447
+ </td>
448
+ <td>
449
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 142</span>
450
+
451
+ <span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span>
452
+ <span class='ivar'>@parent</span>
453
+ <span class='kw'>end</span></pre>
454
+ </td>
455
+ </tr>
456
+ </table>
457
+ </div>
458
+
459
+
460
+ <span id="value=-instance_method"></span>
461
+ <div class="method_details ">
462
+ <h3 class="signature " id="value-instance_method">
463
+
464
+ #<strong>value</strong> &#x21d2; <tt>Object</tt>
465
+
466
+
467
+
468
+
469
+
470
+ </h3><div class="docstring">
471
+ <div class="discussion">
472
+
473
+
474
+ </div>
475
+ </div>
476
+ <div class="tags">
477
+
478
+ <p class="tag_title">Returns:</p>
479
+ <ul class="return">
480
+
481
+ <li>
482
+
483
+
484
+ <span class='type'>(<tt>Object</tt>)</span>
485
+
486
+
487
+
488
+ </li>
489
+
490
+ </ul>
491
+
492
+ </div><table class="source_code">
493
+ <tr>
494
+ <td>
495
+ <pre class="lines">
496
+
497
+
498
+ 146
499
+ 147
500
+ 148</pre>
501
+ </td>
502
+ <td>
503
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 146</span>
504
+
505
+ <span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>
506
+ <span class='ivar'>@value</span>
507
+ <span class='kw'>end</span></pre>
508
+ </td>
509
+ </tr>
510
+ </table>
511
+ </div>
512
+
513
+ </div>
514
+
515
+
516
+ <div id="instance_method_details" class="method_details_list">
517
+ <h2>Instance Method Details</h2>
518
+
519
+
520
+ <div class="method_details first">
521
+ <h3 class="signature first" id="art_id-instance_method">
522
+
523
+ #<strong>art_id</strong> &#x21d2; <tt>Symbol</tt>
524
+
525
+
526
+
527
+
528
+
529
+ </h3><div class="docstring">
530
+ <div class="discussion">
531
+
532
+
533
+ </div>
534
+ </div>
535
+ <div class="tags">
536
+
537
+ <p class="tag_title">Returns:</p>
538
+ <ul class="return">
539
+
540
+ <li>
541
+
542
+
543
+ <span class='type'>(<tt>Symbol</tt>)</span>
544
+
545
+
546
+
547
+ </li>
548
+
549
+ </ul>
550
+
551
+ </div><table class="source_code">
552
+ <tr>
553
+ <td>
554
+ <pre class="lines">
555
+
556
+
557
+ 160
558
+ 161
559
+ 162</pre>
560
+ </td>
561
+ <td>
562
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 160</span>
563
+
564
+ <span class='kw'>def</span> <span class='id identifier rubyid_art_id'>art_id</span>
565
+ <span class='ivar'>@article</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
566
+ <span class='kw'>end</span></pre>
567
+ </td>
568
+ </tr>
569
+ </table>
570
+ </div>
571
+
572
+ </div>
573
+
574
+ </div>
575
+
576
+ <div id="footer">
577
+ Generated on Wed Aug 9 17:34:26 2023 by
578
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
579
+ 0.9.34 (ruby-3.2.2).
580
+ </div>
581
+
582
+ </div>
583
+ </body>
584
+ </html>