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
data/term_utils.gemspec CHANGED
@@ -1,10 +1,10 @@
1
1
  Gem::Specification.new do |s|
2
2
  s.name = "term_utils"
3
- s.version = "0.3.2"
4
- s.date = "2020-02-07"
5
- s.summary = "Terminal utilities."
3
+ s.version = "0.4.0"
4
+ s.date = "2020-08-02"
5
+ s.summary = "Utilities for terminal application."
6
6
  s.description = <<-EOS
7
- Provides terminal utilities like table formatting.
7
+ Utilities for terminal application like argument parsing, table formatting and file finding.
8
8
  EOS
9
9
  s.authors = ["Thomas Baron"]
10
10
  s.email = "tvbaron at gmail dot com"
metadata CHANGED
@@ -1,16 +1,17 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: term_utils
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.2
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Thomas Baron
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-02-07 00:00:00.000000000 Z
11
+ date: 2020-08-02 00:00:00.000000000 Z
12
12
  dependencies: []
13
- description: 'Provides terminal utilities like table formatting.
13
+ description: 'Utilities for terminal application like argument parsing, table formatting
14
+ and file finding.
14
15
 
15
16
  '
16
17
  email: tvbaron at gmail dot com
@@ -26,20 +27,22 @@ files:
26
27
  - doc/TermUtils.html
27
28
  - doc/TermUtils/AP.html
28
29
  - doc/TermUtils/AP/Article.html
29
- - doc/TermUtils/AP/Element.html
30
+ - doc/TermUtils/AP/ArticleResult.html
30
31
  - doc/TermUtils/AP/Flag.html
31
- - doc/TermUtils/AP/Level.html
32
32
  - doc/TermUtils/AP/NoSuchValueError.html
33
33
  - doc/TermUtils/AP/Parameter.html
34
+ - doc/TermUtils/AP/ParameterResult.html
35
+ - doc/TermUtils/AP/ParameterWalkerHooks.html
34
36
  - doc/TermUtils/AP/ParseError.html
35
37
  - doc/TermUtils/AP/Parser.html
36
38
  - doc/TermUtils/AP/Result.html
37
39
  - doc/TermUtils/AP/Syntax.html
38
40
  - doc/TermUtils/AP/SyntaxError.html
41
+ - doc/TermUtils/AP/Walker.html
39
42
  - doc/TermUtils/FF.html
40
43
  - doc/TermUtils/FF/Config.html
41
- - doc/TermUtils/FF/Cursor.html
42
- - doc/TermUtils/FF/Cursor/Context.html
44
+ - doc/TermUtils/FF/Context.html
45
+ - doc/TermUtils/FF/Entry.html
43
46
  - doc/TermUtils/FF/Query.html
44
47
  - doc/TermUtils/PropertyTreeNode.html
45
48
  - doc/TermUtils/Tab.html
@@ -66,19 +69,14 @@ files:
66
69
  - lib/term_utils.rb
67
70
  - lib/term_utils/ap.rb
68
71
  - lib/term_utils/ap/article.rb
69
- - lib/term_utils/ap/element.rb
70
72
  - lib/term_utils/ap/flag.rb
71
- - lib/term_utils/ap/level.rb
72
- - lib/term_utils/ap/no_such_value_error.rb
73
73
  - lib/term_utils/ap/parameter.rb
74
- - lib/term_utils/ap/parse_error.rb
75
74
  - lib/term_utils/ap/parser.rb
76
75
  - lib/term_utils/ap/result.rb
77
76
  - lib/term_utils/ap/syntax.rb
78
- - lib/term_utils/ap/syntax_error.rb
79
77
  - lib/term_utils/ff.rb
80
78
  - lib/term_utils/ff/config.rb
81
- - lib/term_utils/ff/cursor.rb
79
+ - lib/term_utils/ff/entry.rb
82
80
  - lib/term_utils/ff/query.rb
83
81
  - lib/term_utils/property_tree_node.rb
84
82
  - lib/term_utils/tab.rb
@@ -106,5 +104,5 @@ requirements: []
106
104
  rubygems_version: 3.0.3
107
105
  signing_key:
108
106
  specification_version: 4
109
- summary: Terminal utilities.
107
+ summary: Utilities for terminal application.
110
108
  test_files: []
data/doc/TermUtils/AP/Element.html DELETED
@@ -1,1025 +0,0 @@
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::AP::Element
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::AP::Element";
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 (E)</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="../AP.html" title="TermUtils::AP (module)">AP</a></span></span>
41
- &raquo;
42
- <span class="title">Element</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::AP::Element
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::AP::Element</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/ap/element.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
-
105
- <p>Represents a syntax element (abstract).</p>
106
-
107
-
108
- </div>
109
- </div>
110
- <div class="tags">
111
-
112
-
113
- </div><div id="subclasses">
114
- <h2>Direct Known Subclasses</h2>
115
- <p class="children"><span class='object_link'><a href="Level.html" title="TermUtils::AP::Level (class)">Level</a></span>, <span class='object_link'><a href="Parameter.html" title="TermUtils::AP::Parameter (class)">Parameter</a></span></p>
116
- </div>
117
-
118
-
119
-
120
-
121
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
122
- <ul class="summary">
123
-
124
- <li class="public ">
125
- <span class="summary_signature">
126
-
127
- <a href="#flags-instance_method" title="#flags (instance method)">#<strong>flags</strong> &#x21d2; Array&lt;TermUtils::AP::Flag&gt; </a>
128
-
129
-
130
-
131
- </span>
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
- <span class="summary_desc"><div class='inline'></div></span>
145
-
146
- </li>
147
-
148
-
149
- <li class="public ">
150
- <span class="summary_signature">
151
-
152
- <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Symbol </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'></div></span>
170
-
171
- </li>
172
-
173
-
174
- <li class="public ">
175
- <span class="summary_signature">
176
-
177
- <a href="#max_occurs-instance_method" title="#max_occurs (instance method)">#<strong>max_occurs</strong> &#x21d2; Integer </a>
178
-
179
-
180
-
181
- </span>
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
- <span class="summary_desc"><div class='inline'></div></span>
195
-
196
- </li>
197
-
198
-
199
- <li class="public ">
200
- <span class="summary_signature">
201
-
202
- <a href="#min_occurs-instance_method" title="#min_occurs (instance method)">#<strong>min_occurs</strong> &#x21d2; Integer </a>
203
-
204
-
205
-
206
- </span>
207
-
208
-
209
-
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
- </ul>
225
-
226
-
227
-
228
-
229
-
230
- <h2>
231
- Instance Method Summary
232
- <small><a href="#" class="summary_toggle">collapse</a></small>
233
- </h2>
234
-
235
- <ul class="summary">
236
-
237
- <li class="public ">
238
- <span class="summary_signature">
239
-
240
- <a href="#define_flag-instance_method" title="#define_flag (instance method)">#<strong>define_flag</strong>(opts = {}, &amp;block) &#x21d2; TermUtils::AP::Flag </a>
241
-
242
-
243
-
244
- </span>
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
- <span class="summary_desc"><div class='inline'>
255
- <p>Adds a new Flag to this one.</p>
256
- </div></span>
257
-
258
- </li>
259
-
260
-
261
- <li class="public ">
262
- <span class="summary_signature">
263
-
264
- <a href="#finalize!-instance_method" title="#finalize! (instance method)">#<strong>finalize!</strong>(opts = {}) &#x21d2; nil </a>
265
-
266
-
267
-
268
- </span>
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
- <span class="summary_desc"><div class='inline'>
279
- <p>Finalizes this one.</p>
280
- </div></span>
281
-
282
- </li>
283
-
284
-
285
- <li class="public ">
286
- <span class="summary_signature">
287
-
288
- <a href="#flagged%3F-instance_method" title="#flagged? (instance method)">#<strong>flagged?</strong> &#x21d2; Boolean </a>
289
-
290
-
291
-
292
- </span>
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
- <span class="summary_desc"><div class='inline'>
303
- <p>Tests whether this one is flagged.</p>
304
- </div></span>
305
-
306
- </li>
307
-
308
-
309
- <li class="public ">
310
- <span class="summary_signature">
311
-
312
- <a href="#initialize_dup-instance_method" title="#initialize_dup (instance method)">#<strong>initialize_dup</strong>(other) &#x21d2; Object </a>
313
-
314
-
315
-
316
- </span>
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
- <span class="summary_desc"><div class='inline'>
327
- <p>For dup method.</p>
328
- </div></span>
329
-
330
- </li>
331
-
332
-
333
- <li class="public ">
334
- <span class="summary_signature">
335
-
336
- <a href="#multiple_occurs%3F-instance_method" title="#multiple_occurs? (instance method)">#<strong>multiple_occurs?</strong> &#x21d2; Boolean </a>
337
-
338
-
339
-
340
- </span>
341
-
342
-
343
-
344
-
345
-
346
-
347
-
348
-
349
-
350
- <span class="summary_desc"><div class='inline'>
351
- <p>Tests whether this one has mutiple occurs.</p>
352
- </div></span>
353
-
354
- </li>
355
-
356
-
357
- <li class="public ">
358
- <span class="summary_signature">
359
-
360
- <a href="#occur_bounded%3F-instance_method" title="#occur_bounded? (instance method)">#<strong>occur_bounded?</strong> &#x21d2; Boolean </a>
361
-
362
-
363
-
364
- </span>
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
- <span class="summary_desc"><div class='inline'>
375
- <p>Tests whether the number of occurs are fixed.</p>
376
- </div></span>
377
-
378
- </li>
379
-
380
-
381
- </ul>
382
-
383
-
384
-
385
- <div id="instance_attr_details" class="attr_details">
386
- <h2>Instance Attribute Details</h2>
387
-
388
-
389
- <span id="flags=-instance_method"></span>
390
- <div class="method_details first">
391
- <h3 class="signature first" id="flags-instance_method">
392
-
393
- #<strong>flags</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="Flag.html" title="TermUtils::AP::Flag (class)">TermUtils::AP::Flag</a></span>&gt;</tt>
394
-
395
-
396
-
397
-
398
-
399
- </h3><div class="docstring">
400
- <div class="discussion">
401
-
402
-
403
- </div>
404
- </div>
405
- <div class="tags">
406
-
407
- <p class="tag_title">Returns:</p>
408
- <ul class="return">
409
-
410
- <li>
411
-
412
-
413
- <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Flag.html" title="TermUtils::AP::Flag (class)">TermUtils::AP::Flag</a></span>&gt;</tt>)</span>
414
-
415
-
416
-
417
- </li>
418
-
419
- </ul>
420
-
421
- </div><table class="source_code">
422
- <tr>
423
- <td>
424
- <pre class="lines">
425
-
426
-
427
- 29
428
- 30
429
- 31</pre>
430
- </td>
431
- <td>
432
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 29</span>
433
-
434
- <span class='kw'>def</span> <span class='id identifier rubyid_flags'>flags</span>
435
- <span class='ivar'>@flags</span>
436
- <span class='kw'>end</span></pre>
437
- </td>
438
- </tr>
439
- </table>
440
- </div>
441
-
442
-
443
- <span id="id=-instance_method"></span>
444
- <div class="method_details ">
445
- <h3 class="signature " id="id-instance_method">
446
-
447
- #<strong>id</strong> &#x21d2; <tt>Symbol</tt>
448
-
449
-
450
-
451
-
452
-
453
- </h3><div class="docstring">
454
- <div class="discussion">
455
-
456
-
457
- </div>
458
- </div>
459
- <div class="tags">
460
-
461
- <p class="tag_title">Returns:</p>
462
- <ul class="return">
463
-
464
- <li>
465
-
466
-
467
- <span class='type'>(<tt>Symbol</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
- 23
482
- 24
483
- 25</pre>
484
- </td>
485
- <td>
486
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 23</span>
487
-
488
- <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
489
- <span class='ivar'>@id</span>
490
- <span class='kw'>end</span></pre>
491
- </td>
492
- </tr>
493
- </table>
494
- </div>
495
-
496
-
497
- <span id="max_occurs=-instance_method"></span>
498
- <div class="method_details ">
499
- <h3 class="signature " id="max_occurs-instance_method">
500
-
501
- #<strong>max_occurs</strong> &#x21d2; <tt>Integer</tt>
502
-
503
-
504
-
505
-
506
-
507
- </h3><div class="docstring">
508
- <div class="discussion">
509
-
510
-
511
- </div>
512
- </div>
513
- <div class="tags">
514
-
515
- <p class="tag_title">Returns:</p>
516
- <ul class="return">
517
-
518
- <li>
519
-
520
-
521
- <span class='type'>(<tt>Integer</tt>)</span>
522
-
523
-
524
-
525
- </li>
526
-
527
- </ul>
528
-
529
- </div><table class="source_code">
530
- <tr>
531
- <td>
532
- <pre class="lines">
533
-
534
-
535
- 27
536
- 28
537
- 29</pre>
538
- </td>
539
- <td>
540
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 27</span>
541
-
542
- <span class='kw'>def</span> <span class='id identifier rubyid_max_occurs'>max_occurs</span>
543
- <span class='ivar'>@max_occurs</span>
544
- <span class='kw'>end</span></pre>
545
- </td>
546
- </tr>
547
- </table>
548
- </div>
549
-
550
-
551
- <span id="min_occurs=-instance_method"></span>
552
- <div class="method_details ">
553
- <h3 class="signature " id="min_occurs-instance_method">
554
-
555
- #<strong>min_occurs</strong> &#x21d2; <tt>Integer</tt>
556
-
557
-
558
-
559
-
560
-
561
- </h3><div class="docstring">
562
- <div class="discussion">
563
-
564
-
565
- </div>
566
- </div>
567
- <div class="tags">
568
-
569
- <p class="tag_title">Returns:</p>
570
- <ul class="return">
571
-
572
- <li>
573
-
574
-
575
- <span class='type'>(<tt>Integer</tt>)</span>
576
-
577
-
578
-
579
- </li>
580
-
581
- </ul>
582
-
583
- </div><table class="source_code">
584
- <tr>
585
- <td>
586
- <pre class="lines">
587
-
588
-
589
- 25
590
- 26
591
- 27</pre>
592
- </td>
593
- <td>
594
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 25</span>
595
-
596
- <span class='kw'>def</span> <span class='id identifier rubyid_min_occurs'>min_occurs</span>
597
- <span class='ivar'>@min_occurs</span>
598
- <span class='kw'>end</span></pre>
599
- </td>
600
- </tr>
601
- </table>
602
- </div>
603
-
604
- </div>
605
-
606
-
607
- <div id="instance_method_details" class="method_details_list">
608
- <h2>Instance Method Details</h2>
609
-
610
-
611
- <div class="method_details first">
612
- <h3 class="signature first" id="define_flag-instance_method">
613
-
614
- #<strong>define_flag</strong>(opts = {}, &amp;block) &#x21d2; <tt><span class='object_link'><a href="Flag.html" title="TermUtils::AP::Flag (class)">TermUtils::AP::Flag</a></span></tt>
615
-
616
-
617
-
618
-
619
-
620
- </h3><div class="docstring">
621
- <div class="discussion">
622
-
623
- <p>Adds a new Flag to this one.</p>
624
-
625
-
626
- </div>
627
- </div>
628
- <div class="tags">
629
- <p class="tag_title">Parameters:</p>
630
- <ul class="param">
631
-
632
- <li>
633
-
634
- <span class='name'>opts</span>
635
-
636
-
637
- <span class='type'>(<tt>Hash</tt>)</span>
638
-
639
-
640
- <em class="default">(defaults to: <tt>{}</tt>)</em>
641
-
642
-
643
- </li>
644
-
645
- </ul>
646
-
647
-
648
-
649
-
650
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
651
- <ul class="option">
652
-
653
- <li>
654
- <span class="name">:label</span>
655
- <span class="type">(<tt>String</tt>)</span>
656
- <span class="default">
657
-
658
- </span>
659
-
660
- </li>
661
-
662
- <li>
663
- <span class="name">:flavor</span>
664
- <span class="type">(<tt>Symbol</tt>)</span>
665
- <span class="default">
666
-
667
- </span>
668
-
669
- &mdash; <div class='inline'>
670
- <p>`:anchor`, `:long`, `:short`.</p>
671
- </div>
672
-
673
- </li>
674
-
675
- </ul>
676
-
677
-
678
-
679
-
680
- <p class="tag_title">Returns:</p>
681
- <ul class="return">
682
-
683
- <li>
684
-
685
-
686
- <span class='type'>(<tt><span class='object_link'><a href="Flag.html" title="TermUtils::AP::Flag (class)">TermUtils::AP::Flag</a></span></tt>)</span>
687
-
688
-
689
-
690
- </li>
691
-
692
- </ul>
693
-
694
- </div><table class="source_code">
695
- <tr>
696
- <td>
697
- <pre class="lines">
698
-
699
-
700
- 70
701
- 71
702
- 72
703
- 73
704
- 74
705
- 75</pre>
706
- </td>
707
- <td>
708
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 70</span>
709
-
710
- <span class='kw'>def</span> <span class='id identifier rubyid_define_flag'>define_flag</span><span class='lparen'>(</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>
711
- <span class='id identifier rubyid_new_flag'>new_flag</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="../AP.html" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Flag.html" title="TermUtils::AP::Flag (class)">Flag</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Flag.html#initialize-instance_method" title="TermUtils::AP::Flag#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
712
- <span class='ivar'>@flags</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_new_flag'>new_flag</span>
713
- <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_new_flag'>new_flag</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span>
714
- <span class='id identifier rubyid_new_flag'>new_flag</span>
715
- <span class='kw'>end</span></pre>
716
- </td>
717
- </tr>
718
- </table>
719
- </div>
720
-
721
- <div class="method_details ">
722
- <h3 class="signature " id="finalize!-instance_method">
723
-
724
- #<strong>finalize!</strong>(opts = {}) &#x21d2; <tt>nil</tt>
725
-
726
-
727
-
728
-
729
-
730
- </h3><div class="docstring">
731
- <div class="discussion">
732
-
733
- <p>Finalizes this one. Internal use.</p>
734
-
735
-
736
- </div>
737
- </div>
738
- <div class="tags">
739
-
740
- <p class="tag_title">Returns:</p>
741
- <ul class="return">
742
-
743
- <li>
744
-
745
-
746
- <span class='type'>(<tt>nil</tt>)</span>
747
-
748
-
749
-
750
- </li>
751
-
752
- </ul>
753
- <p class="tag_title">Raises:</p>
754
- <ul class="raise">
755
-
756
- <li>
757
-
758
-
759
- <span class='type'>(<tt><span class='object_link'><a href="SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">TermUtils::AP::SyntaxError</a></span></tt>)</span>
760
-
761
-
762
-
763
- </li>
764
-
765
- </ul>
766
-
767
- </div><table class="source_code">
768
- <tr>
769
- <td>
770
- <pre class="lines">
771
-
772
-
773
- 42
774
- 43
775
- 44
776
- 45
777
- 46
778
- 47
779
- 48
780
- 49</pre>
781
- </td>
782
- <td>
783
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 42</span>
784
-
785
- <span class='kw'>def</span> <span class='id identifier rubyid_finalize!'>finalize!</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
786
- <span class='id identifier rubyid_raise'>raise</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="../AP.html" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">SyntaxError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>min_occurs must be equal or greater than 0</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='ivar'>@min_occurs</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='ivar'>@min_occurs</span> <span class='op'>&gt;=</span> <span class='int'>0</span><span class='rparen'>)</span>
787
- <span class='id identifier rubyid_raise'>raise</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="../AP.html" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">SyntaxError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>max_occurs must be equal or greater than min_occurs</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id identifier rubyid_occur_bounded?'>occur_bounded?</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='ivar'>@max_occurs</span> <span class='op'>&gt;=</span> <span class='ivar'>@min_occurs</span><span class='rparen'>)</span>
788
- <span class='kw'>unless</span> <span class='ivar'>@id</span>
789
- <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:anonymous</span><span class='rbracket'>]</span> <span class='op'>+=</span> <span class='int'>1</span>
790
- <span class='ivar'>@id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>anonymous</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:anonymous</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_intern'>intern</span>
791
- <span class='kw'>end</span>
792
- <span class='kw'>end</span></pre>
793
- </td>
794
- </tr>
795
- </table>
796
- </div>
797
-
798
- <div class="method_details ">
799
- <h3 class="signature " id="flagged?-instance_method">
800
-
801
- #<strong>flagged?</strong> &#x21d2; <tt>Boolean</tt>
802
-
803
-
804
-
805
-
806
-
807
- </h3><div class="docstring">
808
- <div class="discussion">
809
-
810
- <p>Tests whether this one is flagged.</p>
811
-
812
-
813
- </div>
814
- </div>
815
- <div class="tags">
816
-
817
- <p class="tag_title">Returns:</p>
818
- <ul class="return">
819
-
820
- <li>
821
-
822
-
823
- <span class='type'>(<tt>Boolean</tt>)</span>
824
-
825
-
826
-
827
- </li>
828
-
829
- </ul>
830
-
831
- </div><table class="source_code">
832
- <tr>
833
- <td>
834
- <pre class="lines">
835
-
836
-
837
- 62
838
- 63
839
- 64</pre>
840
- </td>
841
- <td>
842
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 62</span>
843
-
844
- <span class='kw'>def</span> <span class='id identifier rubyid_flagged?'>flagged?</span>
845
- <span class='op'>!</span><span class='ivar'>@flags</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</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="initialize_dup-instance_method">
854
-
855
- #<strong>initialize_dup</strong>(other) &#x21d2; <tt>Object</tt>
856
-
857
-
858
-
859
-
860
-
861
- </h3><div class="docstring">
862
- <div class="discussion">
863
-
864
- <p>For dup method.</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
- 31
879
- 32
880
- 33
881
- 34
882
- 35
883
- 36
884
- 37
885
- 38
886
- 39</pre>
887
- </td>
888
- <td>
889
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 31</span>
890
-
891
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize_dup'>initialize_dup</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
892
- <span class='kw'>if</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_flags'>flags</span>
893
- <span class='ivar'>@flags</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
894
- <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_flags'>flags</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span>
895
- <span class='ivar'>@flags</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
896
- <span class='kw'>end</span>
897
- <span class='kw'>end</span>
898
- <span class='kw'>super</span>
899
- <span class='kw'>end</span></pre>
900
- </td>
901
- </tr>
902
- </table>
903
- </div>
904
-
905
- <div class="method_details ">
906
- <h3 class="signature " id="multiple_occurs?-instance_method">
907
-
908
- #<strong>multiple_occurs?</strong> &#x21d2; <tt>Boolean</tt>
909
-
910
-
911
-
912
-
913
-
914
- </h3><div class="docstring">
915
- <div class="discussion">
916
-
917
- <p>Tests whether this one has mutiple occurs.</p>
918
-
919
-
920
- </div>
921
- </div>
922
- <div class="tags">
923
-
924
- <p class="tag_title">Returns:</p>
925
- <ul class="return">
926
-
927
- <li>
928
-
929
-
930
- <span class='type'>(<tt>Boolean</tt>)</span>
931
-
932
-
933
-
934
- </li>
935
-
936
- </ul>
937
-
938
- </div><table class="source_code">
939
- <tr>
940
- <td>
941
- <pre class="lines">
942
-
943
-
944
- 52
945
- 53
946
- 54</pre>
947
- </td>
948
- <td>
949
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 52</span>
950
-
951
- <span class='kw'>def</span> <span class='id identifier rubyid_multiple_occurs?'>multiple_occurs?</span>
952
- <span class='lparen'>(</span><span class='ivar'>@max_occurs</span> <span class='op'>==</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='ivar'>@max_occurs</span> <span class='op'>==</span> <span class='symbol'>:infinity</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='lparen'>(</span><span class='ivar'>@max_occurs</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='ivar'>@max_occurs</span> <span class='op'>&gt;</span> <span class='int'>1</span><span class='rparen'>)</span><span class='rparen'>)</span>
953
- <span class='kw'>end</span></pre>
954
- </td>
955
- </tr>
956
- </table>
957
- </div>
958
-
959
- <div class="method_details ">
960
- <h3 class="signature " id="occur_bounded?-instance_method">
961
-
962
- #<strong>occur_bounded?</strong> &#x21d2; <tt>Boolean</tt>
963
-
964
-
965
-
966
-
967
-
968
- </h3><div class="docstring">
969
- <div class="discussion">
970
-
971
- <p>Tests whether the number of occurs are fixed.</p>
972
-
973
-
974
- </div>
975
- </div>
976
- <div class="tags">
977
-
978
- <p class="tag_title">Returns:</p>
979
- <ul class="return">
980
-
981
- <li>
982
-
983
-
984
- <span class='type'>(<tt>Boolean</tt>)</span>
985
-
986
-
987
-
988
- </li>
989
-
990
- </ul>
991
-
992
- </div><table class="source_code">
993
- <tr>
994
- <td>
995
- <pre class="lines">
996
-
997
-
998
- 57
999
- 58
1000
- 59</pre>
1001
- </td>
1002
- <td>
1003
- <pre class="code"><span class="info file"># File 'lib/term_utils/ap/element.rb', line 57</span>
1004
-
1005
- <span class='kw'>def</span> <span class='id identifier rubyid_occur_bounded?'>occur_bounded?</span>
1006
- <span class='lparen'>(</span><span class='ivar'>@max_occurs</span> <span class='op'>!=</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='ivar'>@max_occurs</span> <span class='op'>!=</span> <span class='symbol'>:infinity</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='ivar'>@max_occurs</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Integer</span><span class='rparen'>)</span>
1007
- <span class='kw'>end</span></pre>
1008
- </td>
1009
- </tr>
1010
- </table>
1011
- </div>
1012
-
1013
- </div>
1014
-
1015
- </div>
1016
-
1017
- <div id="footer">
1018
- Generated on Fri Feb 7 18:54:41 2020 by
1019
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1020
- 0.9.20 (ruby-2.6.5).
1021
- </div>
1022
-
1023
- </div>
1024
- </body>
1025
- </html>