term_utils 0.3.2 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
@@ -6,15 +6,15 @@
|
|
6
6
|
<title>
|
7
7
|
Exception: TermUtils::AP::ParseError
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.34
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="../../css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="../../css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
16
16
|
|
17
|
-
<script type="text/javascript"
|
17
|
+
<script type="text/javascript">
|
18
18
|
pathId = "TermUtils::AP::ParseError";
|
19
19
|
relpath = '../../';
|
20
20
|
</script>
|
@@ -96,7 +96,7 @@
|
|
96
96
|
|
97
97
|
<dl>
|
98
98
|
<dt>Defined in:</dt>
|
99
|
-
<dd>lib/term_utils/ap
|
99
|
+
<dd>lib/term_utils/ap.rb</dd>
|
100
100
|
</dl>
|
101
101
|
|
102
102
|
</div>
|
@@ -104,7 +104,7 @@
|
|
104
104
|
<h2>Overview</h2><div class="docstring">
|
105
105
|
<div class="discussion">
|
106
106
|
|
107
|
-
<p>
|
107
|
+
<p>ParseError.</p>
|
108
108
|
|
109
109
|
|
110
110
|
</div>
|
@@ -120,6 +120,39 @@
|
|
120
120
|
|
121
121
|
|
122
122
|
|
123
|
+
<h2>
|
124
|
+
Class Method Summary
|
125
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
126
|
+
</h2>
|
127
|
+
|
128
|
+
<ul class="summary">
|
129
|
+
|
130
|
+
<li class="public ">
|
131
|
+
<span class="summary_signature">
|
132
|
+
|
133
|
+
<a href="#create_message-class_method" title="create_message (class method)">.<strong>create_message</strong>(props) ⇒ String </a>
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
</span>
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
<span class="summary_desc"><div class='inline'>
|
148
|
+
<p>Creates a message based on given properties.</p>
|
149
|
+
</div></span>
|
150
|
+
|
151
|
+
</li>
|
152
|
+
|
153
|
+
|
154
|
+
</ul>
|
155
|
+
|
123
156
|
<h2>
|
124
157
|
Instance Method Summary
|
125
158
|
<small><a href="#" class="summary_toggle">collapse</a></small>
|
@@ -130,7 +163,55 @@
|
|
130
163
|
<li class="public ">
|
131
164
|
<span class="summary_signature">
|
132
165
|
|
133
|
-
<a href="#
|
166
|
+
<a href="#fault-instance_method" title="#fault (instance method)">#<strong>fault</strong> ⇒ String<sup>?</sup> </a>
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
</span>
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
<span class="summary_desc"><div class='inline'>
|
181
|
+
<p>Returns the faulty argument (if any).</p>
|
182
|
+
</div></span>
|
183
|
+
|
184
|
+
</li>
|
185
|
+
|
186
|
+
|
187
|
+
<li class="public ">
|
188
|
+
<span class="summary_signature">
|
189
|
+
|
190
|
+
<a href="#fault%3F-instance_method" title="#fault? (instance method)">#<strong>fault?</strong> ⇒ Boolean </a>
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
</span>
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
<span class="summary_desc"><div class='inline'>
|
205
|
+
<p>Tests whether this one has a faulty argument.</p>
|
206
|
+
</div></span>
|
207
|
+
|
208
|
+
</li>
|
209
|
+
|
210
|
+
|
211
|
+
<li class="public ">
|
212
|
+
<span class="summary_signature">
|
213
|
+
|
214
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(props = {}) ⇒ ParseError </a>
|
134
215
|
|
135
216
|
|
136
217
|
|
@@ -147,7 +228,103 @@
|
|
147
228
|
|
148
229
|
|
149
230
|
<span class="summary_desc"><div class='inline'>
|
150
|
-
<p>
|
231
|
+
<p>Constructs a new ParseError.</p>
|
232
|
+
</div></span>
|
233
|
+
|
234
|
+
</li>
|
235
|
+
|
236
|
+
|
237
|
+
<li class="public ">
|
238
|
+
<span class="summary_signature">
|
239
|
+
|
240
|
+
<a href="#parameter-instance_method" title="#parameter (instance method)">#<strong>parameter</strong> ⇒ Symbol<sup>?</sup> </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>Returns the syntax parameter ID (if any).</p>
|
256
|
+
</div></span>
|
257
|
+
|
258
|
+
</li>
|
259
|
+
|
260
|
+
|
261
|
+
<li class="public ">
|
262
|
+
<span class="summary_signature">
|
263
|
+
|
264
|
+
<a href="#parameter%3F-instance_method" title="#parameter? (instance method)">#<strong>parameter?</strong> ⇒ Boolean </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>Tests whether this one has a syntax parameter ID.</p>
|
280
|
+
</div></span>
|
281
|
+
|
282
|
+
</li>
|
283
|
+
|
284
|
+
|
285
|
+
<li class="public ">
|
286
|
+
<span class="summary_signature">
|
287
|
+
|
288
|
+
<a href="#props-instance_method" title="#props (instance method)">#<strong>props</strong> ⇒ Hash<Symbol, Object> </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>Returns the properties associated to this one.</p>
|
304
|
+
</div></span>
|
305
|
+
|
306
|
+
</li>
|
307
|
+
|
308
|
+
|
309
|
+
<li class="public ">
|
310
|
+
<span class="summary_signature">
|
311
|
+
|
312
|
+
<a href="#short_message-instance_method" title="#short_message (instance method)">#<strong>short_message</strong> ⇒ String </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>Returns the short message (i.e. the message without properties).</p>
|
151
328
|
</div></span>
|
152
329
|
|
153
330
|
</li>
|
@@ -163,7 +340,165 @@
|
|
163
340
|
<div class="method_details first">
|
164
341
|
<h3 class="signature first" id="initialize-instance_method">
|
165
342
|
|
166
|
-
#<strong>initialize</strong>(
|
343
|
+
#<strong>initialize</strong>(props = {}) ⇒ <tt><span class='object_link'><a href="" title="TermUtils::AP::ParseError (class)">ParseError</a></span></tt>
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
|
348
|
+
|
349
|
+
</h3><div class="docstring">
|
350
|
+
<div class="discussion">
|
351
|
+
|
352
|
+
<p>Constructs a new ParseError.</p>
|
353
|
+
|
354
|
+
|
355
|
+
</div>
|
356
|
+
</div>
|
357
|
+
<div class="tags">
|
358
|
+
<p class="tag_title">Parameters:</p>
|
359
|
+
<ul class="param">
|
360
|
+
|
361
|
+
<li>
|
362
|
+
|
363
|
+
<span class='name'>props</span>
|
364
|
+
|
365
|
+
|
366
|
+
<span class='type'>(<tt>Hash<Symbol, Object></tt>)</span>
|
367
|
+
|
368
|
+
|
369
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
370
|
+
|
371
|
+
|
372
|
+
</li>
|
373
|
+
|
374
|
+
</ul>
|
375
|
+
|
376
|
+
|
377
|
+
</div><table class="source_code">
|
378
|
+
<tr>
|
379
|
+
<td>
|
380
|
+
<pre class="lines">
|
381
|
+
|
382
|
+
|
383
|
+
33
|
384
|
+
34
|
385
|
+
35
|
386
|
+
36</pre>
|
387
|
+
</td>
|
388
|
+
<td>
|
389
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 33</span>
|
390
|
+
|
391
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_props'>props</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
392
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_create_message'>create_message</span><span class='lparen'>(</span><span class='id identifier rubyid_props'>props</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
393
|
+
<span class='ivar'>@props</span> <span class='op'>=</span> <span class='id identifier rubyid_props'>props</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
|
394
|
+
<span class='kw'>end</span></pre>
|
395
|
+
</td>
|
396
|
+
</tr>
|
397
|
+
</table>
|
398
|
+
</div>
|
399
|
+
|
400
|
+
</div>
|
401
|
+
|
402
|
+
|
403
|
+
<div id="class_method_details" class="method_details_list">
|
404
|
+
<h2>Class Method Details</h2>
|
405
|
+
|
406
|
+
|
407
|
+
<div class="method_details first">
|
408
|
+
<h3 class="signature first" id="create_message-class_method">
|
409
|
+
|
410
|
+
.<strong>create_message</strong>(props) ⇒ <tt>String</tt>
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
</h3><div class="docstring">
|
417
|
+
<div class="discussion">
|
418
|
+
|
419
|
+
<p>Creates a message based on given properties.</p>
|
420
|
+
|
421
|
+
|
422
|
+
</div>
|
423
|
+
</div>
|
424
|
+
<div class="tags">
|
425
|
+
<p class="tag_title">Parameters:</p>
|
426
|
+
<ul class="param">
|
427
|
+
|
428
|
+
<li>
|
429
|
+
|
430
|
+
<span class='name'>props</span>
|
431
|
+
|
432
|
+
|
433
|
+
<span class='type'>(<tt>Hash<Symbol, Object></tt>)</span>
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
</li>
|
438
|
+
|
439
|
+
</ul>
|
440
|
+
|
441
|
+
<p class="tag_title">Returns:</p>
|
442
|
+
<ul class="return">
|
443
|
+
|
444
|
+
<li>
|
445
|
+
|
446
|
+
|
447
|
+
<span class='type'>(<tt>String</tt>)</span>
|
448
|
+
|
449
|
+
|
450
|
+
|
451
|
+
</li>
|
452
|
+
|
453
|
+
</ul>
|
454
|
+
|
455
|
+
</div><table class="source_code">
|
456
|
+
<tr>
|
457
|
+
<td>
|
458
|
+
<pre class="lines">
|
459
|
+
|
460
|
+
|
461
|
+
77
|
462
|
+
78
|
463
|
+
79
|
464
|
+
80
|
465
|
+
81
|
466
|
+
82
|
467
|
+
83
|
468
|
+
84
|
469
|
+
85
|
470
|
+
86
|
471
|
+
87</pre>
|
472
|
+
</td>
|
473
|
+
<td>
|
474
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 77</span>
|
475
|
+
|
476
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_message'>create_message</span><span class='lparen'>(</span><span class='id identifier rubyid_props'>props</span><span class='rparen'>)</span>
|
477
|
+
<span class='id identifier rubyid_props'>props</span> <span class='op'>=</span> <span class='id identifier rubyid_props'>props</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
|
478
|
+
<span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='id identifier rubyid_props'>props</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:message</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> <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='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'> property is mandatory</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span>
|
479
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_msg'>msg</span> <span class='kw'>if</span> <span class='id identifier rubyid_props'>props</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
480
|
+
|
481
|
+
<span class='id identifier rubyid_vals'>vals</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
482
|
+
<span class='id identifier rubyid_props'>props</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_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_val'>val</span><span class='op'>|</span>
|
483
|
+
<span class='id identifier rubyid_vals'>vals</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>: \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_val'>val</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"</span><span class='tstring_end'>"</span></span>
|
484
|
+
<span class='kw'>end</span>
|
485
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_msg'>msg</span><span class='embexpr_end'>}</span><span class='tstring_content'> (</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vals'>vals</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>, </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>"</span></span>
|
486
|
+
<span class='kw'>end</span></pre>
|
487
|
+
</td>
|
488
|
+
</tr>
|
489
|
+
</table>
|
490
|
+
</div>
|
491
|
+
|
492
|
+
</div>
|
493
|
+
|
494
|
+
<div id="instance_method_details" class="method_details_list">
|
495
|
+
<h2>Instance Method Details</h2>
|
496
|
+
|
497
|
+
|
498
|
+
<div class="method_details first">
|
499
|
+
<h3 class="signature first" id="fault-instance_method">
|
500
|
+
|
501
|
+
#<strong>fault</strong> ⇒ <tt>String</tt><sup>?</sup>
|
167
502
|
|
168
503
|
|
169
504
|
|
@@ -172,13 +507,31 @@
|
|
172
507
|
</h3><div class="docstring">
|
173
508
|
<div class="discussion">
|
174
509
|
|
175
|
-
<p>Returns
|
510
|
+
<p>Returns the faulty argument (if any).</p>
|
176
511
|
|
177
512
|
|
178
513
|
</div>
|
179
514
|
</div>
|
180
515
|
<div class="tags">
|
181
516
|
|
517
|
+
<p class="tag_title">Returns:</p>
|
518
|
+
<ul class="return">
|
519
|
+
|
520
|
+
<li>
|
521
|
+
|
522
|
+
|
523
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
524
|
+
|
525
|
+
|
526
|
+
|
527
|
+
—
|
528
|
+
<div class='inline'>
|
529
|
+
<p>The faulty argument if any, ‘nil` otherwise.</p>
|
530
|
+
</div>
|
531
|
+
|
532
|
+
</li>
|
533
|
+
|
534
|
+
</ul>
|
182
535
|
|
183
536
|
</div><table class="source_code">
|
184
537
|
<tr>
|
@@ -186,30 +539,309 @@
|
|
186
539
|
<pre class="lines">
|
187
540
|
|
188
541
|
|
189
|
-
|
190
|
-
|
191
|
-
|
542
|
+
70
|
543
|
+
71
|
544
|
+
72</pre>
|
192
545
|
</td>
|
193
546
|
<td>
|
194
|
-
<pre class="code"><span class="info file"># File 'lib/term_utils/ap
|
547
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 70</span>
|
195
548
|
|
196
|
-
<span class='kw'>def</span> <span class='id identifier
|
197
|
-
<span class='kw'>
|
549
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_fault'>fault</span>
|
550
|
+
<span class='ivar'>@props</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:fault</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
198
551
|
<span class='kw'>end</span></pre>
|
199
552
|
</td>
|
200
553
|
</tr>
|
201
554
|
</table>
|
202
555
|
</div>
|
556
|
+
|
557
|
+
<div class="method_details ">
|
558
|
+
<h3 class="signature " id="fault?-instance_method">
|
203
559
|
|
560
|
+
#<strong>fault?</strong> ⇒ <tt>Boolean</tt>
|
561
|
+
|
562
|
+
|
563
|
+
|
564
|
+
|
565
|
+
|
566
|
+
</h3><div class="docstring">
|
567
|
+
<div class="discussion">
|
568
|
+
|
569
|
+
<p>Tests whether this one has a faulty argument.</p>
|
570
|
+
|
571
|
+
|
572
|
+
</div>
|
204
573
|
</div>
|
574
|
+
<div class="tags">
|
575
|
+
|
576
|
+
<p class="tag_title">Returns:</p>
|
577
|
+
<ul class="return">
|
578
|
+
|
579
|
+
<li>
|
580
|
+
|
581
|
+
|
582
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
583
|
+
|
584
|
+
|
585
|
+
|
586
|
+
</li>
|
587
|
+
|
588
|
+
</ul>
|
589
|
+
|
590
|
+
</div><table class="source_code">
|
591
|
+
<tr>
|
592
|
+
<td>
|
593
|
+
<pre class="lines">
|
594
|
+
|
595
|
+
|
596
|
+
64
|
597
|
+
65
|
598
|
+
66</pre>
|
599
|
+
</td>
|
600
|
+
<td>
|
601
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 64</span>
|
602
|
+
|
603
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_fault?'>fault?</span>
|
604
|
+
<span class='ivar'>@props</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:fault</span><span class='rparen'>)</span>
|
605
|
+
<span class='kw'>end</span></pre>
|
606
|
+
</td>
|
607
|
+
</tr>
|
608
|
+
</table>
|
609
|
+
</div>
|
610
|
+
|
611
|
+
<div class="method_details ">
|
612
|
+
<h3 class="signature " id="parameter-instance_method">
|
613
|
+
|
614
|
+
#<strong>parameter</strong> ⇒ <tt>Symbol</tt><sup>?</sup>
|
615
|
+
|
616
|
+
|
617
|
+
|
618
|
+
|
619
|
+
|
620
|
+
</h3><div class="docstring">
|
621
|
+
<div class="discussion">
|
622
|
+
|
623
|
+
<p>Returns the syntax parameter ID (if any).</p>
|
624
|
+
|
625
|
+
|
626
|
+
</div>
|
627
|
+
</div>
|
628
|
+
<div class="tags">
|
629
|
+
|
630
|
+
<p class="tag_title">Returns:</p>
|
631
|
+
<ul class="return">
|
632
|
+
|
633
|
+
<li>
|
634
|
+
|
635
|
+
|
636
|
+
<span class='type'>(<tt>Symbol</tt>, <tt>nil</tt>)</span>
|
637
|
+
|
638
|
+
|
639
|
+
|
640
|
+
—
|
641
|
+
<div class='inline'>
|
642
|
+
<p>The syntax parameter ID if any, ‘nil` otherwise.</p>
|
643
|
+
</div>
|
644
|
+
|
645
|
+
</li>
|
646
|
+
|
647
|
+
</ul>
|
648
|
+
|
649
|
+
</div><table class="source_code">
|
650
|
+
<tr>
|
651
|
+
<td>
|
652
|
+
<pre class="lines">
|
653
|
+
|
654
|
+
|
655
|
+
58
|
656
|
+
59
|
657
|
+
60</pre>
|
658
|
+
</td>
|
659
|
+
<td>
|
660
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 58</span>
|
661
|
+
|
662
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parameter'>parameter</span>
|
663
|
+
<span class='ivar'>@props</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:parameter</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
664
|
+
<span class='kw'>end</span></pre>
|
665
|
+
</td>
|
666
|
+
</tr>
|
667
|
+
</table>
|
668
|
+
</div>
|
669
|
+
|
670
|
+
<div class="method_details ">
|
671
|
+
<h3 class="signature " id="parameter?-instance_method">
|
672
|
+
|
673
|
+
#<strong>parameter?</strong> ⇒ <tt>Boolean</tt>
|
674
|
+
|
205
675
|
|
676
|
+
|
677
|
+
|
678
|
+
|
679
|
+
</h3><div class="docstring">
|
680
|
+
<div class="discussion">
|
681
|
+
|
682
|
+
<p>Tests whether this one has a syntax parameter ID.</p>
|
683
|
+
|
684
|
+
|
685
|
+
</div>
|
686
|
+
</div>
|
687
|
+
<div class="tags">
|
688
|
+
|
689
|
+
<p class="tag_title">Returns:</p>
|
690
|
+
<ul class="return">
|
691
|
+
|
692
|
+
<li>
|
693
|
+
|
694
|
+
|
695
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
696
|
+
|
697
|
+
|
698
|
+
|
699
|
+
</li>
|
700
|
+
|
701
|
+
</ul>
|
702
|
+
|
703
|
+
</div><table class="source_code">
|
704
|
+
<tr>
|
705
|
+
<td>
|
706
|
+
<pre class="lines">
|
707
|
+
|
708
|
+
|
709
|
+
52
|
710
|
+
53
|
711
|
+
54</pre>
|
712
|
+
</td>
|
713
|
+
<td>
|
714
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 52</span>
|
715
|
+
|
716
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parameter?'>parameter?</span>
|
717
|
+
<span class='ivar'>@props</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:parameter</span><span class='rparen'>)</span>
|
718
|
+
<span class='kw'>end</span></pre>
|
719
|
+
</td>
|
720
|
+
</tr>
|
721
|
+
</table>
|
722
|
+
</div>
|
723
|
+
|
724
|
+
<div class="method_details ">
|
725
|
+
<h3 class="signature " id="props-instance_method">
|
726
|
+
|
727
|
+
#<strong>props</strong> ⇒ <tt>Hash<Symbol, Object></tt>
|
728
|
+
|
729
|
+
|
730
|
+
|
731
|
+
|
732
|
+
|
733
|
+
</h3><div class="docstring">
|
734
|
+
<div class="discussion">
|
735
|
+
|
736
|
+
<p>Returns the properties associated to this one.</p>
|
737
|
+
|
738
|
+
|
739
|
+
</div>
|
740
|
+
</div>
|
741
|
+
<div class="tags">
|
742
|
+
|
743
|
+
<p class="tag_title">Returns:</p>
|
744
|
+
<ul class="return">
|
745
|
+
|
746
|
+
<li>
|
747
|
+
|
748
|
+
|
749
|
+
<span class='type'>(<tt>Hash<Symbol, Object></tt>)</span>
|
750
|
+
|
751
|
+
|
752
|
+
|
753
|
+
</li>
|
754
|
+
|
755
|
+
</ul>
|
756
|
+
|
757
|
+
</div><table class="source_code">
|
758
|
+
<tr>
|
759
|
+
<td>
|
760
|
+
<pre class="lines">
|
761
|
+
|
762
|
+
|
763
|
+
40
|
764
|
+
41
|
765
|
+
42</pre>
|
766
|
+
</td>
|
767
|
+
<td>
|
768
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 40</span>
|
769
|
+
|
770
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_props'>props</span>
|
771
|
+
<span class='ivar'>@props</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
|
772
|
+
<span class='kw'>end</span></pre>
|
773
|
+
</td>
|
774
|
+
</tr>
|
775
|
+
</table>
|
776
|
+
</div>
|
777
|
+
|
778
|
+
<div class="method_details ">
|
779
|
+
<h3 class="signature " id="short_message-instance_method">
|
780
|
+
|
781
|
+
#<strong>short_message</strong> ⇒ <tt>String</tt>
|
782
|
+
|
783
|
+
|
784
|
+
|
785
|
+
|
786
|
+
|
787
|
+
</h3><div class="docstring">
|
788
|
+
<div class="discussion">
|
789
|
+
|
790
|
+
<p>Returns the short message (i.e. the message without properties).</p>
|
791
|
+
|
792
|
+
|
793
|
+
</div>
|
794
|
+
</div>
|
795
|
+
<div class="tags">
|
796
|
+
|
797
|
+
<p class="tag_title">Returns:</p>
|
798
|
+
<ul class="return">
|
799
|
+
|
800
|
+
<li>
|
801
|
+
|
802
|
+
|
803
|
+
<span class='type'>(<tt>String</tt>)</span>
|
804
|
+
|
805
|
+
|
806
|
+
|
807
|
+
—
|
808
|
+
<div class='inline'>
|
809
|
+
<p>The short message.</p>
|
810
|
+
</div>
|
811
|
+
|
812
|
+
</li>
|
813
|
+
|
814
|
+
</ul>
|
815
|
+
|
816
|
+
</div><table class="source_code">
|
817
|
+
<tr>
|
818
|
+
<td>
|
819
|
+
<pre class="lines">
|
820
|
+
|
821
|
+
|
822
|
+
46
|
823
|
+
47
|
824
|
+
48</pre>
|
825
|
+
</td>
|
826
|
+
<td>
|
827
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 46</span>
|
828
|
+
|
829
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_short_message'>short_message</span>
|
830
|
+
<span class='ivar'>@props</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:message</span><span class='rparen'>)</span>
|
831
|
+
<span class='kw'>end</span></pre>
|
832
|
+
</td>
|
833
|
+
</tr>
|
834
|
+
</table>
|
835
|
+
</div>
|
836
|
+
|
837
|
+
</div>
|
206
838
|
|
207
839
|
</div>
|
208
840
|
|
209
841
|
<div id="footer">
|
210
|
-
Generated on
|
211
|
-
<a href="
|
212
|
-
0.9.
|
842
|
+
Generated on Wed Aug 9 17:34:25 2023 by
|
843
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
844
|
+
0.9.34 (ruby-3.2.2).
|
213
845
|
</div>
|
214
846
|
|
215
847
|
</div>
|