term_utils 0.3.2 → 0.5.0

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 (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/FF/Config.html CHANGED
@@ -6,15 +6,15 @@
6
6
  <title>
7
7
  Class: TermUtils::FF::Config
8
8
 
9
- &mdash; Documentation by YARD 0.9.20
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
17
+ <script type="text/javascript">
18
18
  pathId = "TermUtils::FF::Config";
19
19
  relpath = '../../';
20
20
  </script>
@@ -145,7 +145,7 @@
145
145
  <li class="public ">
146
146
  <span class="summary_signature">
147
147
 
148
- <a href="#max_depth-instance_method" title="#max_depth (instance method)">#<strong>max_depth</strong> &#x21d2; Integer </a>
148
+ <a href="#max_depth-instance_method" title="#max_depth (instance method)">#<strong>max_depth</strong> &#x21d2; Integer<sup>?</sup> </a>
149
149
 
150
150
 
151
151
 
@@ -170,7 +170,7 @@
170
170
  <li class="public ">
171
171
  <span class="summary_signature">
172
172
 
173
- <a href="#min_depth-instance_method" title="#min_depth (instance method)">#<strong>min_depth</strong> &#x21d2; Integer </a>
173
+ <a href="#min_depth-instance_method" title="#min_depth (instance method)">#<strong>min_depth</strong> &#x21d2; Integer<sup>?</sup> </a>
174
174
 
175
175
 
176
176
 
@@ -195,7 +195,7 @@
195
195
  <li class="public ">
196
196
  <span class="summary_signature">
197
197
 
198
- <a href="#sorted-instance_method" title="#sorted (instance method)">#<strong>sorted</strong> &#x21d2; Boolean </a>
198
+ <a href="#sorting_compare-instance_method" title="#sorting_compare (instance method)">#<strong>sorting_compare</strong> &#x21d2; Proc<sup>?</sup> </a>
199
199
 
200
200
 
201
201
 
@@ -214,6 +214,33 @@
214
214
 
215
215
  <span class="summary_desc"><div class='inline'></div></span>
216
216
 
217
+ </li>
218
+
219
+
220
+ <li class="public ">
221
+ <span class="summary_signature">
222
+
223
+ <a href="#sorting_mode-instance_method" title="#sorting_mode (instance method)">#<strong>sorting_mode</strong> &#x21d2; Symbol<sup>?</sup> </a>
224
+
225
+
226
+
227
+ </span>
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+ <span class="summary_desc"><div class='inline'>
241
+ <p>Either ‘:forward`, `:reverse` or `nil` (default).</p>
242
+ </div></span>
243
+
217
244
  </li>
218
245
 
219
246
 
@@ -250,7 +277,7 @@
250
277
 
251
278
 
252
279
  <span class="summary_desc"><div class='inline'>
253
- <p>A new instance of Config.</p>
280
+ <p>Constructs a new Config.</p>
254
281
  </div></span>
255
282
 
256
283
  </li>
@@ -275,6 +302,30 @@
275
302
 
276
303
  <span class="summary_desc"><div class='inline'></div></span>
277
304
 
305
+ </li>
306
+
307
+
308
+ <li class="public ">
309
+ <span class="summary_signature">
310
+
311
+ <a href="#sorted%3F-instance_method" title="#sorted? (instance method)">#<strong>sorted?</strong> &#x21d2; Boolean </a>
312
+
313
+
314
+
315
+ </span>
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+ <span class="summary_desc"><div class='inline'>
326
+ <p>Returns whether the search is ordered.</p>
327
+ </div></span>
328
+
278
329
  </li>
279
330
 
280
331
 
@@ -296,7 +347,7 @@
296
347
  </h3><div class="docstring">
297
348
  <div class="discussion">
298
349
 
299
- <p>Returns a new instance of Config</p>
350
+ <p>Constructs a new Config.</p>
300
351
 
301
352
 
302
353
  </div>
@@ -310,21 +361,23 @@
310
361
  <pre class="lines">
311
362
 
312
363
 
313
- 31
314
- 32
315
- 33
316
- 34
317
364
  35
318
- 36</pre>
365
+ 36
366
+ 37
367
+ 38
368
+ 39
369
+ 40
370
+ 41</pre>
319
371
  </td>
320
372
  <td>
321
- <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 31</span>
373
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 35</span>
322
374
 
323
375
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
324
376
  <span class='ivar'>@ignore_list</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
325
377
  <span class='ivar'>@min_depth</span> <span class='op'>=</span> <span class='kw'>nil</span>
326
378
  <span class='ivar'>@max_depth</span> <span class='op'>=</span> <span class='kw'>nil</span>
327
- <span class='ivar'>@sorted</span> <span class='op'>=</span> <span class='kw'>false</span>
379
+ <span class='ivar'>@sorting_mode</span> <span class='op'>=</span> <span class='kw'>nil</span>
380
+ <span class='ivar'>@sorting_compare</span> <span class='op'>=</span> <span class='kw'>nil</span>
328
381
  <span class='kw'>end</span></pre>
329
382
  </td>
330
383
  </tr>
@@ -395,7 +448,7 @@
395
448
  <div class="method_details ">
396
449
  <h3 class="signature " id="max_depth-instance_method">
397
450
 
398
- #<strong>max_depth</strong> &#x21d2; <tt>Integer</tt>
451
+ #<strong>max_depth</strong> &#x21d2; <tt>Integer</tt><sup>?</sup>
399
452
 
400
453
 
401
454
 
@@ -415,7 +468,7 @@
415
468
  <li>
416
469
 
417
470
 
418
- <span class='type'>(<tt>Integer</tt>)</span>
471
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
419
472
 
420
473
 
421
474
 
@@ -449,7 +502,7 @@
449
502
  <div class="method_details ">
450
503
  <h3 class="signature " id="min_depth-instance_method">
451
504
 
452
- #<strong>min_depth</strong> &#x21d2; <tt>Integer</tt>
505
+ #<strong>min_depth</strong> &#x21d2; <tt>Integer</tt><sup>?</sup>
453
506
 
454
507
 
455
508
 
@@ -469,7 +522,7 @@
469
522
  <li>
470
523
 
471
524
 
472
- <span class='type'>(<tt>Integer</tt>)</span>
525
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
473
526
 
474
527
 
475
528
 
@@ -499,11 +552,11 @@
499
552
  </div>
500
553
 
501
554
 
502
- <span id="sorted=-instance_method"></span>
555
+ <span id="sorting_compare=-instance_method"></span>
503
556
  <div class="method_details ">
504
- <h3 class="signature " id="sorted-instance_method">
557
+ <h3 class="signature " id="sorting_compare-instance_method">
505
558
 
506
- #<strong>sorted</strong> &#x21d2; <tt>Boolean</tt>
559
+ #<strong>sorting_compare</strong> &#x21d2; <tt>Proc</tt><sup>?</sup>
507
560
 
508
561
 
509
562
 
@@ -523,7 +576,7 @@
523
576
  <li>
524
577
 
525
578
 
526
- <span class='type'>(<tt>Boolean</tt>)</span>
579
+ <span class='type'>(<tt>Proc</tt>, <tt>nil</tt>)</span>
527
580
 
528
581
 
529
582
 
@@ -537,6 +590,67 @@
537
590
  <pre class="lines">
538
591
 
539
592
 
593
+ 32
594
+ 33
595
+ 34</pre>
596
+ </td>
597
+ <td>
598
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 32</span>
599
+
600
+ <span class='kw'>def</span> <span class='id identifier rubyid_sorting_compare'>sorting_compare</span>
601
+ <span class='ivar'>@sorting_compare</span>
602
+ <span class='kw'>end</span></pre>
603
+ </td>
604
+ </tr>
605
+ </table>
606
+ </div>
607
+
608
+
609
+ <span id="sorting_mode=-instance_method"></span>
610
+ <div class="method_details ">
611
+ <h3 class="signature " id="sorting_mode-instance_method">
612
+
613
+ #<strong>sorting_mode</strong> &#x21d2; <tt>Symbol</tt><sup>?</sup>
614
+
615
+
616
+
617
+
618
+
619
+ </h3><div class="docstring">
620
+ <div class="discussion">
621
+
622
+ <p>Returns Either ‘:forward`, `:reverse` or `nil` (default).</p>
623
+
624
+
625
+ </div>
626
+ </div>
627
+ <div class="tags">
628
+
629
+ <p class="tag_title">Returns:</p>
630
+ <ul class="return">
631
+
632
+ <li>
633
+
634
+
635
+ <span class='type'>(<tt>Symbol</tt>, <tt>nil</tt>)</span>
636
+
637
+
638
+
639
+ &mdash;
640
+ <div class='inline'>
641
+ <p>Either ‘:forward`, `:reverse` or `nil` (default).</p>
642
+ </div>
643
+
644
+ </li>
645
+
646
+ </ul>
647
+
648
+ </div><table class="source_code">
649
+ <tr>
650
+ <td>
651
+ <pre class="lines">
652
+
653
+
540
654
  30
541
655
  31
542
656
  32</pre>
@@ -544,8 +658,8 @@
544
658
  <td>
545
659
  <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 30</span>
546
660
 
547
- <span class='kw'>def</span> <span class='id identifier rubyid_sorted'>sorted</span>
548
- <span class='ivar'>@sorted</span>
661
+ <span class='kw'>def</span> <span class='id identifier rubyid_sorting_mode'>sorting_mode</span>
662
+ <span class='ivar'>@sorting_mode</span>
549
663
  <span class='kw'>end</span></pre>
550
664
  </td>
551
665
  </tr>
@@ -574,17 +688,71 @@
574
688
  <pre class="lines">
575
689
 
576
690
 
577
- 37
578
- 38
579
- 39
580
- 40</pre>
691
+ 49
692
+ 50
693
+ 51
694
+ 52</pre>
581
695
  </td>
582
696
  <td>
583
- <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 37</span>
697
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 49</span>
584
698
 
585
699
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize_copy'>initialize_copy</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
586
- <span class='ivar'>@ignore_list</span> <span class='op'>=</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_ignore_list'>ignore_list</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
587
700
  <span class='kw'>super</span>
701
+ <span class='ivar'>@ignore_list</span> <span class='op'>=</span> <span class='ivar'>@ignore_list</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
702
+ <span class='kw'>end</span></pre>
703
+ </td>
704
+ </tr>
705
+ </table>
706
+ </div>
707
+
708
+ <div class="method_details ">
709
+ <h3 class="signature " id="sorted?-instance_method">
710
+
711
+ #<strong>sorted?</strong> &#x21d2; <tt>Boolean</tt>
712
+
713
+
714
+
715
+
716
+
717
+ </h3><div class="docstring">
718
+ <div class="discussion">
719
+
720
+ <p>Returns whether the search is ordered.</p>
721
+
722
+
723
+ </div>
724
+ </div>
725
+ <div class="tags">
726
+
727
+ <p class="tag_title">Returns:</p>
728
+ <ul class="return">
729
+
730
+ <li>
731
+
732
+
733
+ <span class='type'>(<tt>Boolean</tt>)</span>
734
+
735
+
736
+
737
+ </li>
738
+
739
+ </ul>
740
+
741
+ </div><table class="source_code">
742
+ <tr>
743
+ <td>
744
+ <pre class="lines">
745
+
746
+
747
+ 45
748
+ 46
749
+ 47</pre>
750
+ </td>
751
+ <td>
752
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 45</span>
753
+
754
+ <span class='kw'>def</span> <span class='id identifier rubyid_sorted?'>sorted?</span>
755
+ <span class='lparen'>(</span><span class='ivar'>@sorting_mode</span> <span class='op'>==</span> <span class='symbol'>:forward</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='ivar'>@sorting_mode</span> <span class='op'>==</span> <span class='symbol'>:reverse</span><span class='rparen'>)</span>
588
756
  <span class='kw'>end</span></pre>
589
757
  </td>
590
758
  </tr>
@@ -596,9 +764,9 @@
596
764
  </div>
597
765
 
598
766
  <div id="footer">
599
- Generated on Fri Feb 7 18:54:40 2020 by
600
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
601
- 0.9.20 (ruby-2.6.5).
767
+ Generated on Wed Aug 9 17:34:27 2023 by
768
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
769
+ 0.9.34 (ruby-3.2.2).
602
770
  </div>
603
771
 
604
772
  </div>