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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -2
- data/COPYING +3 -3
- data/README.md +51 -16
- data/Rakefile +6 -0
- data/doc/TermUtils/AP/Article.html +57 -55
- data/doc/TermUtils/AP/ArticleResult.html +584 -0
- data/doc/TermUtils/AP/Flag.html +295 -78
- data/doc/TermUtils/AP/Parameter.html +891 -103
- data/doc/TermUtils/AP/ParameterResult.html +980 -0
- data/doc/TermUtils/{FF/Cursor/Context.html → AP/ParameterWalkerHooks.html} +60 -60
- data/doc/TermUtils/AP/ParseError.html +651 -19
- data/doc/TermUtils/AP/Parser.html +181 -121
- data/doc/TermUtils/AP/Result.html +201 -528
- data/doc/TermUtils/AP/Syntax.html +103 -393
- data/doc/TermUtils/AP/SyntaxError.html +9 -91
- data/doc/TermUtils/AP/Walker.html +686 -0
- data/doc/TermUtils/AP.html +49 -160
- data/doc/TermUtils/FF/Config.html +203 -35
- data/doc/TermUtils/FF/Context.html +585 -0
- data/doc/TermUtils/FF/Entry.html +626 -0
- data/doc/TermUtils/FF/Finder.html +850 -0
- data/doc/TermUtils/FF/{Cursor.html → FinderEntry.html} +473 -211
- data/doc/TermUtils/FF/FinderQuery.html +946 -0
- data/doc/TermUtils/FF/Query.html +402 -70
- data/doc/TermUtils/FF.html +135 -11
- data/doc/TermUtils/PropertyTreeNode.html +304 -190
- data/doc/TermUtils/Tab/Column.html +98 -96
- data/doc/TermUtils/Tab/Header.html +30 -30
- data/doc/TermUtils/Tab/Holder.html +81 -81
- data/doc/TermUtils/Tab/Printer.html +43 -43
- data/doc/TermUtils/Tab/Table.html +124 -128
- data/doc/TermUtils/Tab/TableError.html +7 -89
- data/doc/TermUtils/Tab.html +93 -86
- data/doc/TermUtils.html +10 -10
- data/doc/_index.html +62 -42
- data/doc/class_list.html +3 -3
- data/doc/css/style.css +3 -2
- data/doc/file.README.html +63 -26
- data/doc/file_list.html +2 -2
- data/doc/frames.html +2 -2
- data/doc/index.html +63 -26
- data/doc/js/app.js +14 -3
- data/doc/method_list.html +708 -236
- data/doc/top-level-namespace.html +7 -7
- data/lib/term_utils/ap/article.rb +15 -9
- data/lib/term_utils/ap/flag.rb +37 -20
- data/lib/term_utils/ap/parameter.rb +88 -19
- data/lib/term_utils/ap/parser.rb +143 -116
- data/lib/term_utils/ap/result.rb +208 -161
- data/lib/term_utils/ap/syntax.rb +53 -69
- data/lib/term_utils/ap.rb +79 -24
- data/lib/term_utils/ff/config.rb +22 -10
- data/lib/term_utils/{ap/no_such_value_error.rb → ff/entry.rb} +26 -8
- data/lib/term_utils/ff/finder.rb +255 -0
- data/lib/term_utils/ff/query.rb +94 -17
- data/lib/term_utils/ff.rb +12 -2
- data/lib/term_utils/property_tree_node.rb +47 -19
- data/lib/term_utils/tab.rb +106 -61
- data/lib/term_utils.rb +8 -1
- data/term_utils.gemspec +4 -4
- metadata +18 -17
- data/doc/TermUtils/AP/Element.html +0 -1025
- data/doc/TermUtils/AP/Level.html +0 -638
- data/doc/TermUtils/AP/NoSuchValueError.html +0 -217
- data/lib/term_utils/ap/element.rb +0 -78
- data/lib/term_utils/ap/level.rb +0 -57
- data/lib/term_utils/ap/parse_error.rb +0 -27
- data/lib/term_utils/ap/syntax_error.rb +0 -27
- data/lib/term_utils/ff/cursor.rb +0 -153
@@ -0,0 +1,946 @@
|
|
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::FinderQuery
|
8
|
+
|
9
|
+
— 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::FF::FinderQuery";
|
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 (F)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span> » <span class='title'><span class='object_link'><a href="../FF.html" title="TermUtils::FF (module)">FF</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">FinderQuery</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::FinderQuery
|
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::FinderQuery</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/finder.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
|
105
|
+
<p>Represents a Query.</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="#entry_kind-instance_method" title="#entry_kind (instance method)">#<strong>entry_kind</strong> ⇒ String, ... </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="#max_depth-instance_method" title="#max_depth (instance method)">#<strong>max_depth</strong> ⇒ Integer<sup>?</sup> </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="#min_depth-instance_method" title="#min_depth (instance method)">#<strong>min_depth</strong> ⇒ Integer </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
|
+
<li class="public ">
|
196
|
+
<span class="summary_signature">
|
197
|
+
|
198
|
+
<a href="#use_stat-instance_method" title="#use_stat (instance method)">#<strong>use_stat</strong> ⇒ Boolean </a>
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
</span>
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
216
|
+
|
217
|
+
</li>
|
218
|
+
|
219
|
+
|
220
|
+
</ul>
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
<h2>
|
227
|
+
Instance Method Summary
|
228
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
229
|
+
</h2>
|
230
|
+
|
231
|
+
<ul class="summary">
|
232
|
+
|
233
|
+
<li class="public ">
|
234
|
+
<span class="summary_signature">
|
235
|
+
|
236
|
+
<a href="#each_filter-instance_method" title="#each_filter (instance method)">#<strong>each_filter</strong>(&block) ⇒ Object </a>
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
</span>
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
251
|
+
|
252
|
+
</li>
|
253
|
+
|
254
|
+
|
255
|
+
<li class="public ">
|
256
|
+
<span class="summary_signature">
|
257
|
+
|
258
|
+
<a href="#enter_directory-instance_method" title="#enter_directory (instance method)">#<strong>enter_directory</strong>(&block) ⇒ Object </a>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
</span>
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
273
|
+
<p>Wether to enter a directory.</p>
|
274
|
+
</div></span>
|
275
|
+
|
276
|
+
</li>
|
277
|
+
|
278
|
+
|
279
|
+
<li class="public ">
|
280
|
+
<span class="summary_signature">
|
281
|
+
|
282
|
+
<a href="#exclude_entry-instance_method" title="#exclude_entry (instance method)">#<strong>exclude_entry</strong>(&block) ⇒ Object </a>
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
</span>
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
297
|
+
<p>Wether to exclue an entry from the results.</p>
|
298
|
+
</div></span>
|
299
|
+
|
300
|
+
</li>
|
301
|
+
|
302
|
+
|
303
|
+
<li class="public ">
|
304
|
+
<span class="summary_signature">
|
305
|
+
|
306
|
+
<a href="#filter-instance_method" title="#filter (instance method)">#<strong>filter</strong>(kind, &block) ⇒ Object </a>
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
</span>
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
321
|
+
|
322
|
+
</li>
|
323
|
+
|
324
|
+
|
325
|
+
<li class="public ">
|
326
|
+
<span class="summary_signature">
|
327
|
+
|
328
|
+
<a href="#include_entry-instance_method" title="#include_entry (instance method)">#<strong>include_entry</strong>(&block) ⇒ Object </a>
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
</span>
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
<span class="summary_desc"><div class='inline'>
|
343
|
+
<p>Wether to include an entry into the results.</p>
|
344
|
+
</div></span>
|
345
|
+
|
346
|
+
</li>
|
347
|
+
|
348
|
+
|
349
|
+
<li class="public ">
|
350
|
+
<span class="summary_signature">
|
351
|
+
|
352
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ FinderQuery </a>
|
353
|
+
|
354
|
+
|
355
|
+
|
356
|
+
</span>
|
357
|
+
|
358
|
+
|
359
|
+
<span class="note title constructor">constructor</span>
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
369
|
+
<p>A new instance of FinderQuery.</p>
|
370
|
+
</div></span>
|
371
|
+
|
372
|
+
</li>
|
373
|
+
|
374
|
+
|
375
|
+
<li class="public ">
|
376
|
+
<span class="summary_signature">
|
377
|
+
|
378
|
+
<a href="#skip_directory-instance_method" title="#skip_directory (instance method)">#<strong>skip_directory</strong>(&block) ⇒ Object </a>
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
</span>
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
<span class="summary_desc"><div class='inline'>
|
393
|
+
<p>Wether not to enter a directory.</p>
|
394
|
+
</div></span>
|
395
|
+
|
396
|
+
</li>
|
397
|
+
|
398
|
+
|
399
|
+
</ul>
|
400
|
+
|
401
|
+
|
402
|
+
<div id="constructor_details" class="method_details_list">
|
403
|
+
<h2>Constructor Details</h2>
|
404
|
+
|
405
|
+
<div class="method_details first">
|
406
|
+
<h3 class="signature first" id="initialize-instance_method">
|
407
|
+
|
408
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="TermUtils::FF::FinderQuery (class)">FinderQuery</a></span></tt>
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
</h3><div class="docstring">
|
415
|
+
<div class="discussion">
|
416
|
+
|
417
|
+
<p>Returns a new instance of FinderQuery.</p>
|
418
|
+
|
419
|
+
|
420
|
+
</div>
|
421
|
+
</div>
|
422
|
+
<div class="tags">
|
423
|
+
|
424
|
+
|
425
|
+
</div><table class="source_code">
|
426
|
+
<tr>
|
427
|
+
<td>
|
428
|
+
<pre class="lines">
|
429
|
+
|
430
|
+
|
431
|
+
83
|
432
|
+
84
|
433
|
+
85
|
434
|
+
86
|
435
|
+
87
|
436
|
+
88
|
437
|
+
89</pre>
|
438
|
+
</td>
|
439
|
+
<td>
|
440
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 83</span>
|
441
|
+
|
442
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
443
|
+
<span class='ivar'>@min_depth</span> <span class='op'>=</span> <span class='int'>0</span>
|
444
|
+
<span class='ivar'>@max_depth</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
445
|
+
<span class='ivar'>@use_stat</span> <span class='op'>=</span> <span class='kw'>false</span>
|
446
|
+
<span class='ivar'>@entry_kind</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
447
|
+
<span class='ivar'>@filters</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
448
|
+
<span class='kw'>end</span></pre>
|
449
|
+
</td>
|
450
|
+
</tr>
|
451
|
+
</table>
|
452
|
+
</div>
|
453
|
+
|
454
|
+
</div>
|
455
|
+
|
456
|
+
<div id="instance_attr_details" class="attr_details">
|
457
|
+
<h2>Instance Attribute Details</h2>
|
458
|
+
|
459
|
+
|
460
|
+
<span id="entry_kind=-instance_method"></span>
|
461
|
+
<div class="method_details first">
|
462
|
+
<h3 class="signature first" id="entry_kind-instance_method">
|
463
|
+
|
464
|
+
#<strong>entry_kind</strong> ⇒ <tt>String</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>String</tt>, <tt>Array<String></tt>, <tt>nil</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
|
+
81
|
499
|
+
82
|
500
|
+
83</pre>
|
501
|
+
</td>
|
502
|
+
<td>
|
503
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 81</span>
|
504
|
+
|
505
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_entry_kind'>entry_kind</span>
|
506
|
+
<span class='ivar'>@entry_kind</span>
|
507
|
+
<span class='kw'>end</span></pre>
|
508
|
+
</td>
|
509
|
+
</tr>
|
510
|
+
</table>
|
511
|
+
</div>
|
512
|
+
|
513
|
+
|
514
|
+
<span id="max_depth=-instance_method"></span>
|
515
|
+
<div class="method_details ">
|
516
|
+
<h3 class="signature " id="max_depth-instance_method">
|
517
|
+
|
518
|
+
#<strong>max_depth</strong> ⇒ <tt>Integer</tt><sup>?</sup>
|
519
|
+
|
520
|
+
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
</h3><div class="docstring">
|
525
|
+
<div class="discussion">
|
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>Integer</tt>, <tt>nil</tt>)</span>
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
</li>
|
543
|
+
|
544
|
+
</ul>
|
545
|
+
|
546
|
+
</div><table class="source_code">
|
547
|
+
<tr>
|
548
|
+
<td>
|
549
|
+
<pre class="lines">
|
550
|
+
|
551
|
+
|
552
|
+
77
|
553
|
+
78
|
554
|
+
79</pre>
|
555
|
+
</td>
|
556
|
+
<td>
|
557
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 77</span>
|
558
|
+
|
559
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_max_depth'>max_depth</span>
|
560
|
+
<span class='ivar'>@max_depth</span>
|
561
|
+
<span class='kw'>end</span></pre>
|
562
|
+
</td>
|
563
|
+
</tr>
|
564
|
+
</table>
|
565
|
+
</div>
|
566
|
+
|
567
|
+
|
568
|
+
<span id="min_depth=-instance_method"></span>
|
569
|
+
<div class="method_details ">
|
570
|
+
<h3 class="signature " id="min_depth-instance_method">
|
571
|
+
|
572
|
+
#<strong>min_depth</strong> ⇒ <tt>Integer</tt>
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
|
577
|
+
|
578
|
+
</h3><div class="docstring">
|
579
|
+
<div class="discussion">
|
580
|
+
|
581
|
+
|
582
|
+
</div>
|
583
|
+
</div>
|
584
|
+
<div class="tags">
|
585
|
+
|
586
|
+
<p class="tag_title">Returns:</p>
|
587
|
+
<ul class="return">
|
588
|
+
|
589
|
+
<li>
|
590
|
+
|
591
|
+
|
592
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
593
|
+
|
594
|
+
|
595
|
+
|
596
|
+
</li>
|
597
|
+
|
598
|
+
</ul>
|
599
|
+
|
600
|
+
</div><table class="source_code">
|
601
|
+
<tr>
|
602
|
+
<td>
|
603
|
+
<pre class="lines">
|
604
|
+
|
605
|
+
|
606
|
+
75
|
607
|
+
76
|
608
|
+
77</pre>
|
609
|
+
</td>
|
610
|
+
<td>
|
611
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 75</span>
|
612
|
+
|
613
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_min_depth'>min_depth</span>
|
614
|
+
<span class='ivar'>@min_depth</span>
|
615
|
+
<span class='kw'>end</span></pre>
|
616
|
+
</td>
|
617
|
+
</tr>
|
618
|
+
</table>
|
619
|
+
</div>
|
620
|
+
|
621
|
+
|
622
|
+
<span id="use_stat=-instance_method"></span>
|
623
|
+
<div class="method_details ">
|
624
|
+
<h3 class="signature " id="use_stat-instance_method">
|
625
|
+
|
626
|
+
#<strong>use_stat</strong> ⇒ <tt>Boolean</tt>
|
627
|
+
|
628
|
+
|
629
|
+
|
630
|
+
|
631
|
+
|
632
|
+
</h3><div class="docstring">
|
633
|
+
<div class="discussion">
|
634
|
+
|
635
|
+
|
636
|
+
</div>
|
637
|
+
</div>
|
638
|
+
<div class="tags">
|
639
|
+
|
640
|
+
<p class="tag_title">Returns:</p>
|
641
|
+
<ul class="return">
|
642
|
+
|
643
|
+
<li>
|
644
|
+
|
645
|
+
|
646
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
</li>
|
651
|
+
|
652
|
+
</ul>
|
653
|
+
|
654
|
+
</div><table class="source_code">
|
655
|
+
<tr>
|
656
|
+
<td>
|
657
|
+
<pre class="lines">
|
658
|
+
|
659
|
+
|
660
|
+
79
|
661
|
+
80
|
662
|
+
81</pre>
|
663
|
+
</td>
|
664
|
+
<td>
|
665
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 79</span>
|
666
|
+
|
667
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_use_stat'>use_stat</span>
|
668
|
+
<span class='ivar'>@use_stat</span>
|
669
|
+
<span class='kw'>end</span></pre>
|
670
|
+
</td>
|
671
|
+
</tr>
|
672
|
+
</table>
|
673
|
+
</div>
|
674
|
+
|
675
|
+
</div>
|
676
|
+
|
677
|
+
|
678
|
+
<div id="instance_method_details" class="method_details_list">
|
679
|
+
<h2>Instance Method Details</h2>
|
680
|
+
|
681
|
+
|
682
|
+
<div class="method_details first">
|
683
|
+
<h3 class="signature first" id="each_filter-instance_method">
|
684
|
+
|
685
|
+
#<strong>each_filter</strong>(&block) ⇒ <tt>Object</tt>
|
686
|
+
|
687
|
+
|
688
|
+
|
689
|
+
|
690
|
+
|
691
|
+
</h3><table class="source_code">
|
692
|
+
<tr>
|
693
|
+
<td>
|
694
|
+
<pre class="lines">
|
695
|
+
|
696
|
+
|
697
|
+
118
|
698
|
+
119
|
699
|
+
120</pre>
|
700
|
+
</td>
|
701
|
+
<td>
|
702
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 118</span>
|
703
|
+
|
704
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_each_filter'>each_filter</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
705
|
+
<span class='ivar'>@filters</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
706
|
+
<span class='kw'>end</span></pre>
|
707
|
+
</td>
|
708
|
+
</tr>
|
709
|
+
</table>
|
710
|
+
</div>
|
711
|
+
|
712
|
+
<div class="method_details ">
|
713
|
+
<h3 class="signature " id="enter_directory-instance_method">
|
714
|
+
|
715
|
+
#<strong>enter_directory</strong>(&block) ⇒ <tt>Object</tt>
|
716
|
+
|
717
|
+
|
718
|
+
|
719
|
+
|
720
|
+
|
721
|
+
</h3><div class="docstring">
|
722
|
+
<div class="discussion">
|
723
|
+
|
724
|
+
<p>Wether to enter a directory.</p>
|
725
|
+
|
726
|
+
|
727
|
+
</div>
|
728
|
+
</div>
|
729
|
+
<div class="tags">
|
730
|
+
|
731
|
+
|
732
|
+
</div><table class="source_code">
|
733
|
+
<tr>
|
734
|
+
<td>
|
735
|
+
<pre class="lines">
|
736
|
+
|
737
|
+
|
738
|
+
99
|
739
|
+
100
|
740
|
+
101</pre>
|
741
|
+
</td>
|
742
|
+
<td>
|
743
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 99</span>
|
744
|
+
|
745
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_enter_directory'>enter_directory</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
746
|
+
<span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='symbol'>:enter</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
747
|
+
<span class='kw'>end</span></pre>
|
748
|
+
</td>
|
749
|
+
</tr>
|
750
|
+
</table>
|
751
|
+
</div>
|
752
|
+
|
753
|
+
<div class="method_details ">
|
754
|
+
<h3 class="signature " id="exclude_entry-instance_method">
|
755
|
+
|
756
|
+
#<strong>exclude_entry</strong>(&block) ⇒ <tt>Object</tt>
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
|
761
|
+
|
762
|
+
</h3><div class="docstring">
|
763
|
+
<div class="discussion">
|
764
|
+
|
765
|
+
<p>Wether to exclue an entry from the results.</p>
|
766
|
+
|
767
|
+
|
768
|
+
</div>
|
769
|
+
</div>
|
770
|
+
<div class="tags">
|
771
|
+
|
772
|
+
|
773
|
+
</div><table class="source_code">
|
774
|
+
<tr>
|
775
|
+
<td>
|
776
|
+
<pre class="lines">
|
777
|
+
|
778
|
+
|
779
|
+
114
|
780
|
+
115
|
781
|
+
116</pre>
|
782
|
+
</td>
|
783
|
+
<td>
|
784
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 114</span>
|
785
|
+
|
786
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_exclude_entry'>exclude_entry</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
787
|
+
<span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='symbol'>:exclude</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
788
|
+
<span class='kw'>end</span></pre>
|
789
|
+
</td>
|
790
|
+
</tr>
|
791
|
+
</table>
|
792
|
+
</div>
|
793
|
+
|
794
|
+
<div class="method_details ">
|
795
|
+
<h3 class="signature " id="filter-instance_method">
|
796
|
+
|
797
|
+
#<strong>filter</strong>(kind, &block) ⇒ <tt>Object</tt>
|
798
|
+
|
799
|
+
|
800
|
+
|
801
|
+
|
802
|
+
|
803
|
+
</h3><div class="docstring">
|
804
|
+
<div class="discussion">
|
805
|
+
|
806
|
+
|
807
|
+
</div>
|
808
|
+
</div>
|
809
|
+
<div class="tags">
|
810
|
+
|
811
|
+
<p class="tag_title">Raises:</p>
|
812
|
+
<ul class="raise">
|
813
|
+
|
814
|
+
<li>
|
815
|
+
|
816
|
+
|
817
|
+
<span class='type'>(<tt>StandardError</tt>)</span>
|
818
|
+
|
819
|
+
|
820
|
+
|
821
|
+
</li>
|
822
|
+
|
823
|
+
</ul>
|
824
|
+
|
825
|
+
</div><table class="source_code">
|
826
|
+
<tr>
|
827
|
+
<td>
|
828
|
+
<pre class="lines">
|
829
|
+
|
830
|
+
|
831
|
+
91
|
832
|
+
92
|
833
|
+
93
|
834
|
+
94
|
835
|
+
95
|
836
|
+
96</pre>
|
837
|
+
</td>
|
838
|
+
<td>
|
839
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 91</span>
|
840
|
+
|
841
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='id identifier rubyid_kind'>kind</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
842
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>StandardError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>wrong filter kind</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='qsymbols_beg'>%i[</span><span class='tstring_content'>enter</span><span class='words_sep'> </span><span class='tstring_content'>skip</span><span class='words_sep'> </span><span class='tstring_content'>include</span><span class='words_sep'> </span><span class='tstring_content'>exclude</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_kind'>kind</span><span class='rparen'>)</span>
|
843
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>StandardError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>missing </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_kind'>kind</span><span class='embexpr_end'>}</span><span class='tstring_content'> block</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
844
|
+
|
845
|
+
<span class='ivar'>@filters</span> <span class='op'><<</span> <span class='lbrace'>{</span> <span class='label'>kind:</span> <span class='id identifier rubyid_kind'>kind</span><span class='comma'>,</span> <span class='label'>block:</span> <span class='id identifier rubyid_block'>block</span> <span class='rbrace'>}</span>
|
846
|
+
<span class='kw'>end</span></pre>
|
847
|
+
</td>
|
848
|
+
</tr>
|
849
|
+
</table>
|
850
|
+
</div>
|
851
|
+
|
852
|
+
<div class="method_details ">
|
853
|
+
<h3 class="signature " id="include_entry-instance_method">
|
854
|
+
|
855
|
+
#<strong>include_entry</strong>(&block) ⇒ <tt>Object</tt>
|
856
|
+
|
857
|
+
|
858
|
+
|
859
|
+
|
860
|
+
|
861
|
+
</h3><div class="docstring">
|
862
|
+
<div class="discussion">
|
863
|
+
|
864
|
+
<p>Wether to include an entry into the results.</p>
|
865
|
+
|
866
|
+
|
867
|
+
</div>
|
868
|
+
</div>
|
869
|
+
<div class="tags">
|
870
|
+
|
871
|
+
|
872
|
+
</div><table class="source_code">
|
873
|
+
<tr>
|
874
|
+
<td>
|
875
|
+
<pre class="lines">
|
876
|
+
|
877
|
+
|
878
|
+
109
|
879
|
+
110
|
880
|
+
111</pre>
|
881
|
+
</td>
|
882
|
+
<td>
|
883
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 109</span>
|
884
|
+
|
885
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_include_entry'>include_entry</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
886
|
+
<span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='symbol'>:include</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
887
|
+
<span class='kw'>end</span></pre>
|
888
|
+
</td>
|
889
|
+
</tr>
|
890
|
+
</table>
|
891
|
+
</div>
|
892
|
+
|
893
|
+
<div class="method_details ">
|
894
|
+
<h3 class="signature " id="skip_directory-instance_method">
|
895
|
+
|
896
|
+
#<strong>skip_directory</strong>(&block) ⇒ <tt>Object</tt>
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
</h3><div class="docstring">
|
903
|
+
<div class="discussion">
|
904
|
+
|
905
|
+
<p>Wether not to enter a directory.</p>
|
906
|
+
|
907
|
+
|
908
|
+
</div>
|
909
|
+
</div>
|
910
|
+
<div class="tags">
|
911
|
+
|
912
|
+
|
913
|
+
</div><table class="source_code">
|
914
|
+
<tr>
|
915
|
+
<td>
|
916
|
+
<pre class="lines">
|
917
|
+
|
918
|
+
|
919
|
+
104
|
920
|
+
105
|
921
|
+
106</pre>
|
922
|
+
</td>
|
923
|
+
<td>
|
924
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 104</span>
|
925
|
+
|
926
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_skip_directory'>skip_directory</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
927
|
+
<span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='symbol'>:skip</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
928
|
+
<span class='kw'>end</span></pre>
|
929
|
+
</td>
|
930
|
+
</tr>
|
931
|
+
</table>
|
932
|
+
</div>
|
933
|
+
|
934
|
+
</div>
|
935
|
+
|
936
|
+
</div>
|
937
|
+
|
938
|
+
<div id="footer">
|
939
|
+
Generated on Wed Aug 9 17:34:27 2023 by
|
940
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
941
|
+
0.9.34 (ruby-3.2.2).
|
942
|
+
</div>
|
943
|
+
|
944
|
+
</div>
|
945
|
+
</body>
|
946
|
+
</html>
|