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.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHORS +1 -0
  3. data/CHANGELOG.md +19 -0
  4. data/COPYING +674 -0
  5. data/README.md +58 -0
  6. data/Rakefile +46 -0
  7. data/doc/TermUtils/FF/Config.html +606 -0
  8. data/doc/TermUtils/FF/Cursor/Context.html +409 -0
  9. data/doc/TermUtils/FF/Cursor.html +929 -0
  10. data/doc/TermUtils/FF/Query.html +749 -0
  11. data/doc/TermUtils/FF.html +128 -0
  12. data/doc/TermUtils/Tab/Column.html +1290 -0
  13. data/doc/TermUtils/Tab/Holder.html +674 -0
  14. data/doc/TermUtils/Tab/Printer.html +967 -0
  15. data/doc/TermUtils/Tab/Table.html +1414 -0
  16. data/doc/TermUtils/Tab.html +508 -0
  17. data/doc/TermUtils.html +136 -0
  18. data/doc/_index.html +217 -0
  19. data/doc/class_list.html +51 -0
  20. data/doc/css/common.css +1 -0
  21. data/doc/css/full_list.css +58 -0
  22. data/doc/css/style.css +496 -0
  23. data/doc/file.README.html +131 -0
  24. data/doc/file_list.html +56 -0
  25. data/doc/frames.html +17 -0
  26. data/doc/index.html +131 -0
  27. data/doc/js/app.js +303 -0
  28. data/doc/js/full_list.js +216 -0
  29. data/doc/js/jquery.js +4 -0
  30. data/doc/method_list.html +555 -0
  31. data/doc/top-level-namespace.html +110 -0
  32. data/lib/term_utils/ff/config.rb +43 -0
  33. data/lib/term_utils/ff/cursor.rb +153 -0
  34. data/lib/term_utils/ff/query.rb +66 -0
  35. data/lib/term_utils/ff.rb +18 -0
  36. data/lib/term_utils/tab.rb +22 -3
  37. data/lib/term_utils.rb +3 -0
  38. data/term_utils.gemspec +16 -0
  39. metadata +40 -4
data/doc/TermUtils/Tab.html ADDED
@@ -0,0 +1,508 @@
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
+ Module: TermUtils::Tab
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::Tab";
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 (T)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span>
41
+ &raquo;
42
+ <span class="title">Tab</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>Module: TermUtils::Tab
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/term_utils/tab.rb</dd>
82
+ </dl>
83
+
84
+ </div>
85
+
86
+ <h2>Overview</h2><div class="docstring">
87
+ <div class="discussion">
88
+
89
+ <p>The tab module provides a way to print formatted tables.</p>
90
+
91
+
92
+ </div>
93
+ </div>
94
+ <div class="tags">
95
+
96
+
97
+ </div><h2>Defined Under Namespace</h2>
98
+ <p class="children">
99
+
100
+
101
+
102
+
103
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Tab/Column.html" title="TermUtils::Tab::Column (class)">Column</a></span>, <span class='object_link'><a href="Tab/Holder.html" title="TermUtils::Tab::Holder (class)">Holder</a></span>, <span class='object_link'><a href="Tab/Printer.html" title="TermUtils::Tab::Printer (class)">Printer</a></span>, <span class='object_link'><a href="Tab/Table.html" title="TermUtils::Tab::Table (class)">Table</a></span>
104
+
105
+
106
+ </p>
107
+
108
+
109
+ <h2>
110
+ Constant Summary
111
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
112
+ </h2>
113
+
114
+ <dl class="constants">
115
+
116
+ <dt id="default_holder-classvariable" class="">@@default_holder =
117
+
118
+ </dt>
119
+ <dd><pre class="code"><span class='const'><span class='object_link'><a href="Tab/Holder.html" title="TermUtils::Tab::Holder (class)">Holder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Tab/Holder.html#initialize-instance_method" title="TermUtils::Tab::Holder#initialize (method)">new</a></span></span></pre></dd>
120
+
121
+ </dl>
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <h2>
132
+ Class Method Summary
133
+ <small><a href="#" class="summary_toggle">collapse</a></small>
134
+ </h2>
135
+
136
+ <ul class="summary">
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#define_table-class_method" title="define_table (class method)">.<strong>define_table</strong>(id, opts = {}, &amp;block) &#x21d2; Tab::Table </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+ <span class="summary_desc"><div class='inline'>
156
+ <p>Defines a table.</p>
157
+ </div></span>
158
+
159
+ </li>
160
+
161
+
162
+ <li class="public ">
163
+ <span class="summary_signature">
164
+
165
+ <a href="#find_table-class_method" title="find_table (class method)">.<strong>find_table</strong>(id) &#x21d2; Tab::Table<sup>?</sup> </a>
166
+
167
+
168
+
169
+ </span>
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+ <span class="summary_desc"><div class='inline'>
180
+ <p>Finds a table.</p>
181
+ </div></span>
182
+
183
+ </li>
184
+
185
+
186
+ <li class="public ">
187
+ <span class="summary_signature">
188
+
189
+ <a href="#printer-class_method" title="printer (class method)">.<strong>printer</strong>(id, io, opts = {}, &amp;block) &#x21d2; Tab::Printer </a>
190
+
191
+
192
+
193
+ </span>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+ <span class="summary_desc"><div class='inline'>
204
+ <p>Creates a new table printer.</p>
205
+ </div></span>
206
+
207
+ </li>
208
+
209
+
210
+ </ul>
211
+
212
+
213
+
214
+
215
+ <div id="class_method_details" class="method_details_list">
216
+ <h2>Class Method Details</h2>
217
+
218
+
219
+ <div class="method_details first">
220
+ <h3 class="signature first" id="define_table-class_method">
221
+
222
+ .<strong>define_table</strong>(id, opts = {}, &amp;block) &#x21d2; <tt><span class='object_link'><a href="Tab/Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt>
223
+
224
+
225
+
226
+
227
+
228
+ </h3><div class="docstring">
229
+ <div class="discussion">
230
+
231
+ <p>Defines a table.</p>
232
+
233
+
234
+ </div>
235
+ </div>
236
+ <div class="tags">
237
+ <p class="tag_title">Parameters:</p>
238
+ <ul class="param">
239
+
240
+ <li>
241
+
242
+ <span class='name'>id</span>
243
+
244
+
245
+ <span class='type'>(<tt>Symbol</tt>)</span>
246
+
247
+
248
+
249
+ </li>
250
+
251
+ <li>
252
+
253
+ <span class='name'>opts</span>
254
+
255
+
256
+ <span class='type'>(<tt>Hash</tt>)</span>
257
+
258
+
259
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
260
+
261
+
262
+ </li>
263
+
264
+ </ul>
265
+
266
+ <p class="tag_title">Returns:</p>
267
+ <ul class="return">
268
+
269
+ <li>
270
+
271
+
272
+ <span class='type'>(<tt><span class='object_link'><a href="Tab/Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt>)</span>
273
+
274
+
275
+
276
+ </li>
277
+
278
+ </ul>
279
+
280
+ </div><table class="source_code">
281
+ <tr>
282
+ <td>
283
+ <pre class="lines">
284
+
285
+
286
+ 330
287
+ 331
288
+ 332</pre>
289
+ </td>
290
+ <td>
291
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 330</span>
292
+
293
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_define_table'>define_table</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
294
+ <span class='cvar'>@@default_holder</span><span class='period'>.</span><span class='id identifier rubyid_define_table'>define_table</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
295
+ <span class='kw'>end</span></pre>
296
+ </td>
297
+ </tr>
298
+ </table>
299
+ </div>
300
+
301
+ <div class="method_details ">
302
+ <h3 class="signature " id="find_table-class_method">
303
+
304
+ .<strong>find_table</strong>(id) &#x21d2; <tt><span class='object_link'><a href="Tab/Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt><sup>?</sup>
305
+
306
+
307
+
308
+
309
+
310
+ </h3><div class="docstring">
311
+ <div class="discussion">
312
+
313
+ <p>Finds a table.</p>
314
+
315
+
316
+ </div>
317
+ </div>
318
+ <div class="tags">
319
+ <p class="tag_title">Parameters:</p>
320
+ <ul class="param">
321
+
322
+ <li>
323
+
324
+ <span class='name'>id</span>
325
+
326
+
327
+ <span class='type'>(<tt>Symbol</tt>)</span>
328
+
329
+
330
+
331
+ </li>
332
+
333
+ </ul>
334
+
335
+ <p class="tag_title">Returns:</p>
336
+ <ul class="return">
337
+
338
+ <li>
339
+
340
+
341
+ <span class='type'>(<tt><span class='object_link'><a href="Tab/Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt>, <tt>nil</tt>)</span>
342
+
343
+
344
+
345
+ </li>
346
+
347
+ </ul>
348
+
349
+ </div><table class="source_code">
350
+ <tr>
351
+ <td>
352
+ <pre class="lines">
353
+
354
+
355
+ 336
356
+ 337
357
+ 338</pre>
358
+ </td>
359
+ <td>
360
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 336</span>
361
+
362
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find_table'>find_table</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
363
+ <span class='cvar'>@@default_holder</span><span class='period'>.</span><span class='id identifier rubyid_find_table'>find_table</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
364
+ <span class='kw'>end</span></pre>
365
+ </td>
366
+ </tr>
367
+ </table>
368
+ </div>
369
+
370
+ <div class="method_details ">
371
+ <h3 class="signature " id="printer-class_method">
372
+
373
+ .<strong>printer</strong>(id, io, opts = {}, &amp;block) &#x21d2; <tt><span class='object_link'><a href="Tab/Printer.html" title="TermUtils::Tab::Printer (class)">Tab::Printer</a></span></tt>
374
+
375
+
376
+
377
+
378
+
379
+ </h3><div class="docstring">
380
+ <div class="discussion">
381
+
382
+ <p>Creates a new table printer.</p>
383
+
384
+
385
+ </div>
386
+ </div>
387
+ <div class="tags">
388
+ <p class="tag_title">Parameters:</p>
389
+ <ul class="param">
390
+
391
+ <li>
392
+
393
+ <span class='name'>id</span>
394
+
395
+
396
+ <span class='type'>(<tt>Symbol</tt>)</span>
397
+
398
+
399
+
400
+ </li>
401
+
402
+ <li>
403
+
404
+ <span class='name'>io</span>
405
+
406
+
407
+ <span class='type'>(<tt>IO</tt>)</span>
408
+
409
+
410
+
411
+ </li>
412
+
413
+ <li>
414
+
415
+ <span class='name'>opts</span>
416
+
417
+
418
+ <span class='type'>(<tt>Hash</tt>)</span>
419
+
420
+
421
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
422
+
423
+
424
+ </li>
425
+
426
+ </ul>
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+ <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
436
+ <ul class="option">
437
+
438
+ <li>
439
+ <span class="name">:offset</span>
440
+ <span class="type">(<tt>Integer</tt>)</span>
441
+ <span class="default">
442
+
443
+ </span>
444
+
445
+ </li>
446
+
447
+ <li>
448
+ <span class="name">:column_separator_width</span>
449
+ <span class="type">(<tt>Integer</tt>)</span>
450
+ <span class="default">
451
+
452
+ </span>
453
+
454
+ </li>
455
+
456
+ </ul>
457
+
458
+
459
+
460
+
461
+ <p class="tag_title">Returns:</p>
462
+ <ul class="return">
463
+
464
+ <li>
465
+
466
+
467
+ <span class='type'>(<tt><span class='object_link'><a href="Tab/Printer.html" title="TermUtils::Tab::Printer (class)">Tab::Printer</a></span></tt>)</span>
468
+
469
+
470
+
471
+ </li>
472
+
473
+ </ul>
474
+
475
+ </div><table class="source_code">
476
+ <tr>
477
+ <td>
478
+ <pre class="lines">
479
+
480
+
481
+ 346
482
+ 347
483
+ 348</pre>
484
+ </td>
485
+ <td>
486
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 346</span>
487
+
488
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_printer'>printer</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_io'>io</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
489
+ <span class='cvar'>@@default_holder</span><span class='period'>.</span><span class='id identifier rubyid_find_table'>find_table</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_printer'>printer</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
490
+ <span class='kw'>end</span></pre>
491
+ </td>
492
+ </tr>
493
+ </table>
494
+ </div>
495
+
496
+ </div>
497
+
498
+ </div>
499
+
500
+ <div id="footer">
501
+ Generated on Thu Oct 17 22:50:57 2019 by
502
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
503
+ 0.9.20 (ruby-2.6.5).
504
+ </div>
505
+
506
+ </div>
507
+ </body>
508
+ </html>
data/doc/TermUtils.html ADDED
@@ -0,0 +1,136 @@
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
+ Module: TermUtils
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";
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 (T)</a> &raquo;
40
+
41
+
42
+ <span class="title">TermUtils</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>Module: TermUtils
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/term_utils/tab.rb<span class="defines">,<br />
82
+ lib/term_utils/ff/query.rb,<br /> lib/term_utils/ff/config.rb,<br /> lib/term_utils/ff/cursor.rb</span>
83
+ </dd>
84
+ </dl>
85
+
86
+ </div>
87
+
88
+ <h2>Overview</h2><div class="docstring">
89
+ <div class="discussion">
90
+
91
+ <p>Copyright (C) 2019 Thomas Baron</p>
92
+
93
+ <p>This file is part of term_utils.</p>
94
+
95
+ <p>term_utils is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.</p>
96
+
97
+ <p>term_utils is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
98
+
99
+ <p>You should have received a copy of the GNU General Public License along with term_utils. If not, see &lt;<a href="https://www.gnu.org/licenses">www.gnu.org/licenses</a>/&gt;.</p>
100
+
101
+
102
+ </div>
103
+ </div>
104
+ <div class="tags">
105
+
106
+
107
+ </div><h2>Defined Under Namespace</h2>
108
+ <p class="children">
109
+
110
+
111
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="TermUtils/FF.html" title="TermUtils::FF (module)">FF</a></span>, <span class='object_link'><a href="TermUtils/Tab.html" title="TermUtils::Tab (module)">Tab</a></span>
112
+
113
+
114
+
115
+
116
+ </p>
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+ </div>
127
+
128
+ <div id="footer">
129
+ Generated on Thu Oct 17 22:50:57 2019 by
130
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
131
+ 0.9.20 (ruby-2.6.5).
132
+ </div>
133
+
134
+ </div>
135
+ </body>
136
+ </html>