term_utils 0.1.1 → 0.2.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.
@@ -0,0 +1,749 @@
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::Query
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::FF::Query";
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 (Q)</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">Query</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::Query
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::FF::Query</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/ff/query.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Represents a file system query.</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="#exec-instance_method" title="#exec (instance method)">#<strong>exec</strong>(path) &#x21d2; TermUtils::FF::Cursor </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>Executes this one.</p>
147
+ </div></span>
148
+
149
+ </li>
150
+
151
+
152
+ <li class="public ">
153
+ <span class="summary_signature">
154
+
155
+ <a href="#ignore-instance_method" title="#ignore (instance method)">#<strong>ignore</strong>(regexp) &#x21d2; TermUtils::FF::Query </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>Adds a Regexp to ignore.</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> &#x21d2; Query </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>A new instance of Query.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#initialize_copy-instance_method" title="#initialize_copy (instance method)">#<strong>initialize_copy</strong>(other) &#x21d2; Object </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'></div></span>
220
+
221
+ </li>
222
+
223
+
224
+ <li class="public ">
225
+ <span class="summary_signature">
226
+
227
+ <a href="#max_depth-instance_method" title="#max_depth (instance method)">#<strong>max_depth</strong>(depth) &#x21d2; TermUtils::FF::Query </a>
228
+
229
+
230
+
231
+ </span>
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+ <span class="summary_desc"><div class='inline'>
242
+ <p>Sets a maximum depth.</p>
243
+ </div></span>
244
+
245
+ </li>
246
+
247
+
248
+ <li class="public ">
249
+ <span class="summary_signature">
250
+
251
+ <a href="#min_depth-instance_method" title="#min_depth (instance method)">#<strong>min_depth</strong>(depth) &#x21d2; TermUtils::FF::Query </a>
252
+
253
+
254
+
255
+ </span>
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+ <span class="summary_desc"><div class='inline'>
266
+ <p>Sets a minimum depth.</p>
267
+ </div></span>
268
+
269
+ </li>
270
+
271
+
272
+ <li class="public ">
273
+ <span class="summary_signature">
274
+
275
+ <a href="#sort-instance_method" title="#sort (instance method)">#<strong>sort</strong>(sorted = true) &#x21d2; TermUtils::FF::Query </a>
276
+
277
+
278
+
279
+ </span>
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+ <span class="summary_desc"><div class='inline'>
290
+ <p>Sets whether results shall be sorted.</p>
291
+ </div></span>
292
+
293
+ </li>
294
+
295
+
296
+ </ul>
297
+
298
+
299
+ <div id="constructor_details" class="method_details_list">
300
+ <h2>Constructor Details</h2>
301
+
302
+ <div class="method_details first">
303
+ <h3 class="signature first" id="initialize-instance_method">
304
+
305
+ #<strong>initialize</strong> &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></tt>
306
+
307
+
308
+
309
+
310
+
311
+ </h3><div class="docstring">
312
+ <div class="discussion">
313
+
314
+ <p>Returns a new instance of Query</p>
315
+
316
+
317
+ </div>
318
+ </div>
319
+ <div class="tags">
320
+
321
+
322
+ </div><table class="source_code">
323
+ <tr>
324
+ <td>
325
+ <pre class="lines">
326
+
327
+
328
+ 23
329
+ 24
330
+ 25</pre>
331
+ </td>
332
+ <td>
333
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 23</span>
334
+
335
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
336
+ <span class='ivar'>@config</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../FF.html" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Config.html" title="TermUtils::FF::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Config.html#initialize-instance_method" title="TermUtils::FF::Config#initialize (method)">new</a></span></span>
337
+ <span class='kw'>end</span></pre>
338
+ </td>
339
+ </tr>
340
+ </table>
341
+ </div>
342
+
343
+ </div>
344
+
345
+
346
+ <div id="instance_method_details" class="method_details_list">
347
+ <h2>Instance Method Details</h2>
348
+
349
+
350
+ <div class="method_details first">
351
+ <h3 class="signature first" id="exec-instance_method">
352
+
353
+ #<strong>exec</strong>(path) &#x21d2; <tt><span class='object_link'><a href="Cursor.html" title="TermUtils::FF::Cursor (class)">TermUtils::FF::Cursor</a></span></tt>
354
+
355
+
356
+
357
+
358
+
359
+ </h3><div class="docstring">
360
+ <div class="discussion">
361
+
362
+ <p>Executes this one.</p>
363
+
364
+
365
+ </div>
366
+ </div>
367
+ <div class="tags">
368
+ <p class="tag_title">Parameters:</p>
369
+ <ul class="param">
370
+
371
+ <li>
372
+
373
+ <span class='name'>path</span>
374
+
375
+
376
+ <span class='type'>(<tt>String</tt>)</span>
377
+
378
+
379
+
380
+ </li>
381
+
382
+ </ul>
383
+
384
+ <p class="tag_title">Returns:</p>
385
+ <ul class="return">
386
+
387
+ <li>
388
+
389
+
390
+ <span class='type'>(<tt><span class='object_link'><a href="Cursor.html" title="TermUtils::FF::Cursor (class)">TermUtils::FF::Cursor</a></span></tt>)</span>
391
+
392
+
393
+
394
+ </li>
395
+
396
+ </ul>
397
+
398
+ </div><table class="source_code">
399
+ <tr>
400
+ <td>
401
+ <pre class="lines">
402
+
403
+
404
+ 61
405
+ 62
406
+ 63</pre>
407
+ </td>
408
+ <td>
409
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 61</span>
410
+
411
+ <span class='kw'>def</span> <span class='id identifier rubyid_exec'>exec</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
412
+ <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../FF.html" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Cursor.html" title="TermUtils::FF::Cursor (class)">Cursor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Cursor.html#initialize-instance_method" title="TermUtils::FF::Cursor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_bootstrap'><span class='object_link'><a href="Cursor.html#bootstrap-instance_method" title="TermUtils::FF::Cursor#bootstrap (method)">bootstrap</a></span></span>
413
+ <span class='kw'>end</span></pre>
414
+ </td>
415
+ </tr>
416
+ </table>
417
+ </div>
418
+
419
+ <div class="method_details ">
420
+ <h3 class="signature " id="ignore-instance_method">
421
+
422
+ #<strong>ignore</strong>(regexp) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>
423
+
424
+
425
+
426
+
427
+
428
+ </h3><div class="docstring">
429
+ <div class="discussion">
430
+
431
+ <p>Adds a Regexp to ignore.</p>
432
+
433
+
434
+ </div>
435
+ </div>
436
+ <div class="tags">
437
+ <p class="tag_title">Parameters:</p>
438
+ <ul class="param">
439
+
440
+ <li>
441
+
442
+ <span class='name'>regexp</span>
443
+
444
+
445
+ <span class='type'>(<tt>Regexp</tt>)</span>
446
+
447
+
448
+
449
+ </li>
450
+
451
+ </ul>
452
+
453
+ <p class="tag_title">Returns:</p>
454
+ <ul class="return">
455
+
456
+ <li>
457
+
458
+
459
+ <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>)</span>
460
+
461
+
462
+
463
+ </li>
464
+
465
+ </ul>
466
+
467
+ </div><table class="source_code">
468
+ <tr>
469
+ <td>
470
+ <pre class="lines">
471
+
472
+
473
+ 33
474
+ 34
475
+ 35
476
+ 36</pre>
477
+ </td>
478
+ <td>
479
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 33</span>
480
+
481
+ <span class='kw'>def</span> <span class='id identifier rubyid_ignore'>ignore</span><span class='lparen'>(</span><span class='id identifier rubyid_regexp'>regexp</span><span class='rparen'>)</span>
482
+ <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_ignore_list'>ignore_list</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_regexp'>regexp</span>
483
+ <span class='kw'>self</span>
484
+ <span class='kw'>end</span></pre>
485
+ </td>
486
+ </tr>
487
+ </table>
488
+ </div>
489
+
490
+ <div class="method_details ">
491
+ <h3 class="signature " id="initialize_copy-instance_method">
492
+
493
+ #<strong>initialize_copy</strong>(other) &#x21d2; <tt>Object</tt>
494
+
495
+
496
+
497
+
498
+
499
+ </h3><table class="source_code">
500
+ <tr>
501
+ <td>
502
+ <pre class="lines">
503
+
504
+
505
+ 26
506
+ 27
507
+ 28
508
+ 29</pre>
509
+ </td>
510
+ <td>
511
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 26</span>
512
+
513
+ <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>
514
+ <span class='ivar'>@config</span> <span class='op'>=</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
515
+ <span class='kw'>super</span>
516
+ <span class='kw'>end</span></pre>
517
+ </td>
518
+ </tr>
519
+ </table>
520
+ </div>
521
+
522
+ <div class="method_details ">
523
+ <h3 class="signature " id="max_depth-instance_method">
524
+
525
+ #<strong>max_depth</strong>(depth) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>
526
+
527
+
528
+
529
+
530
+
531
+ </h3><div class="docstring">
532
+ <div class="discussion">
533
+
534
+ <p>Sets a maximum depth.</p>
535
+
536
+
537
+ </div>
538
+ </div>
539
+ <div class="tags">
540
+ <p class="tag_title">Parameters:</p>
541
+ <ul class="param">
542
+
543
+ <li>
544
+
545
+ <span class='name'>depth</span>
546
+
547
+
548
+ <span class='type'>(<tt>Integer</tt>)</span>
549
+
550
+
551
+
552
+ </li>
553
+
554
+ </ul>
555
+
556
+ <p class="tag_title">Returns:</p>
557
+ <ul class="return">
558
+
559
+ <li>
560
+
561
+
562
+ <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>)</span>
563
+
564
+
565
+
566
+ </li>
567
+
568
+ </ul>
569
+
570
+ </div><table class="source_code">
571
+ <tr>
572
+ <td>
573
+ <pre class="lines">
574
+
575
+
576
+ 47
577
+ 48
578
+ 49
579
+ 50</pre>
580
+ </td>
581
+ <td>
582
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 47</span>
583
+
584
+ <span class='kw'>def</span> <span class='id identifier rubyid_max_depth'>max_depth</span><span class='lparen'>(</span><span class='id identifier rubyid_depth'>depth</span><span class='rparen'>)</span>
585
+ <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_max_depth'>max_depth</span> <span class='op'>=</span> <span class='id identifier rubyid_depth'>depth</span>
586
+ <span class='kw'>self</span>
587
+ <span class='kw'>end</span></pre>
588
+ </td>
589
+ </tr>
590
+ </table>
591
+ </div>
592
+
593
+ <div class="method_details ">
594
+ <h3 class="signature " id="min_depth-instance_method">
595
+
596
+ #<strong>min_depth</strong>(depth) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>
597
+
598
+
599
+
600
+
601
+
602
+ </h3><div class="docstring">
603
+ <div class="discussion">
604
+
605
+ <p>Sets a minimum depth.</p>
606
+
607
+
608
+ </div>
609
+ </div>
610
+ <div class="tags">
611
+ <p class="tag_title">Parameters:</p>
612
+ <ul class="param">
613
+
614
+ <li>
615
+
616
+ <span class='name'>depth</span>
617
+
618
+
619
+ <span class='type'>(<tt>Integer</tt>)</span>
620
+
621
+
622
+
623
+ </li>
624
+
625
+ </ul>
626
+
627
+ <p class="tag_title">Returns:</p>
628
+ <ul class="return">
629
+
630
+ <li>
631
+
632
+
633
+ <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>)</span>
634
+
635
+
636
+
637
+ </li>
638
+
639
+ </ul>
640
+
641
+ </div><table class="source_code">
642
+ <tr>
643
+ <td>
644
+ <pre class="lines">
645
+
646
+
647
+ 40
648
+ 41
649
+ 42
650
+ 43</pre>
651
+ </td>
652
+ <td>
653
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 40</span>
654
+
655
+ <span class='kw'>def</span> <span class='id identifier rubyid_min_depth'>min_depth</span><span class='lparen'>(</span><span class='id identifier rubyid_depth'>depth</span><span class='rparen'>)</span>
656
+ <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_min_depth'>min_depth</span> <span class='op'>=</span> <span class='id identifier rubyid_depth'>depth</span>
657
+ <span class='kw'>self</span>
658
+ <span class='kw'>end</span></pre>
659
+ </td>
660
+ </tr>
661
+ </table>
662
+ </div>
663
+
664
+ <div class="method_details ">
665
+ <h3 class="signature " id="sort-instance_method">
666
+
667
+ #<strong>sort</strong>(sorted = true) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>
668
+
669
+
670
+
671
+
672
+
673
+ </h3><div class="docstring">
674
+ <div class="discussion">
675
+
676
+ <p>Sets whether results shall be sorted.</p>
677
+
678
+
679
+ </div>
680
+ </div>
681
+ <div class="tags">
682
+ <p class="tag_title">Parameters:</p>
683
+ <ul class="param">
684
+
685
+ <li>
686
+
687
+ <span class='name'>sorted</span>
688
+
689
+
690
+ <span class='type'>(<tt>Boolean</tt>)</span>
691
+
692
+
693
+ <em class="default">(defaults to: <tt>true</tt>)</em>
694
+
695
+
696
+ </li>
697
+
698
+ </ul>
699
+
700
+ <p class="tag_title">Returns:</p>
701
+ <ul class="return">
702
+
703
+ <li>
704
+
705
+
706
+ <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>)</span>
707
+
708
+
709
+
710
+ </li>
711
+
712
+ </ul>
713
+
714
+ </div><table class="source_code">
715
+ <tr>
716
+ <td>
717
+ <pre class="lines">
718
+
719
+
720
+ 54
721
+ 55
722
+ 56
723
+ 57</pre>
724
+ </td>
725
+ <td>
726
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 54</span>
727
+
728
+ <span class='kw'>def</span> <span class='id identifier rubyid_sort'>sort</span><span class='lparen'>(</span><span class='id identifier rubyid_sorted'>sorted</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
729
+ <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_sorted'>sorted</span> <span class='op'>=</span> <span class='id identifier rubyid_sorted'>sorted</span>
730
+ <span class='kw'>self</span>
731
+ <span class='kw'>end</span></pre>
732
+ </td>
733
+ </tr>
734
+ </table>
735
+ </div>
736
+
737
+ </div>
738
+
739
+ </div>
740
+
741
+ <div id="footer">
742
+ Generated on Thu Oct 17 22:50:58 2019 by
743
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
744
+ 0.9.20 (ruby-2.6.5).
745
+ </div>
746
+
747
+ </div>
748
+ </body>
749
+ </html>