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