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,980 @@
|
|
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::ParameterResult
|
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::AP::ParameterResult";
|
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 (P)</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="../AP.html" title="TermUtils::AP (module)">AP</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">ParameterResult</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::ParameterResult
|
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::ParameterResult</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/result.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
|
105
|
+
<p>Represents a result for a parameter.</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="#parameter-instance_method" title="#parameter (instance method)">#<strong>parameter</strong> ⇒ Parameter </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="#results-instance_method" title="#results (instance method)">#<strong>results</strong> ⇒ Array<ArticleResult> </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
|
+
</ul>
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
<h2>
|
177
|
+
Instance Method Summary
|
178
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
179
|
+
</h2>
|
180
|
+
|
181
|
+
<ul class="summary">
|
182
|
+
|
183
|
+
<li class="public ">
|
184
|
+
<span class="summary_signature">
|
185
|
+
|
186
|
+
<a href="#add_result-instance_method" title="#add_result (instance method)">#<strong>add_result</strong>(result) ⇒ Object </a>
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
</span>
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
<span class="summary_desc"><div class='inline'>
|
201
|
+
<p>Adds an ArticleResult.</p>
|
202
|
+
</div></span>
|
203
|
+
|
204
|
+
</li>
|
205
|
+
|
206
|
+
|
207
|
+
<li class="public ">
|
208
|
+
<span class="summary_signature">
|
209
|
+
|
210
|
+
<a href="#find_article-instance_method" title="#find_article (instance method)">#<strong>find_article</strong>(id) ⇒ ArticleResult </a>
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
</span>
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
225
|
+
<p>Returns the first ArticleResult for a given article id.</p>
|
226
|
+
</div></span>
|
227
|
+
|
228
|
+
</li>
|
229
|
+
|
230
|
+
|
231
|
+
<li class="public ">
|
232
|
+
<span class="summary_signature">
|
233
|
+
|
234
|
+
<a href="#find_articles-instance_method" title="#find_articles (instance method)">#<strong>find_articles</strong>(id) ⇒ Array<Result> </a>
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
</span>
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
249
|
+
<p>Returns all ArticleResult(s) for a given article id.</p>
|
250
|
+
</div></span>
|
251
|
+
|
252
|
+
</li>
|
253
|
+
|
254
|
+
|
255
|
+
<li class="public ">
|
256
|
+
<span class="summary_signature">
|
257
|
+
|
258
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(parent, parameter) ⇒ ParameterResult </a>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
</span>
|
263
|
+
|
264
|
+
|
265
|
+
<span class="note title constructor">constructor</span>
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
<span class="summary_desc"><div class='inline'>
|
275
|
+
<p>Constructs a new ParameterResult.</p>
|
276
|
+
</div></span>
|
277
|
+
|
278
|
+
</li>
|
279
|
+
|
280
|
+
|
281
|
+
<li class="public ">
|
282
|
+
<span class="summary_signature">
|
283
|
+
|
284
|
+
<a href="#param_id-instance_method" title="#param_id (instance method)">#<strong>param_id</strong> ⇒ Symbol </a>
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
</span>
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
|
298
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
299
|
+
|
300
|
+
</li>
|
301
|
+
|
302
|
+
|
303
|
+
<li class="public ">
|
304
|
+
<span class="summary_signature">
|
305
|
+
|
306
|
+
<a href="#value-instance_method" title="#value (instance method)">#<strong>value</strong>(id = nil) ⇒ Object </a>
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
</span>
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
<span class="summary_desc"><div class='inline'>
|
321
|
+
<p>Returns the value of the first ArticleResult.</p>
|
322
|
+
</div></span>
|
323
|
+
|
324
|
+
</li>
|
325
|
+
|
326
|
+
|
327
|
+
<li class="public ">
|
328
|
+
<span class="summary_signature">
|
329
|
+
|
330
|
+
<a href="#values-instance_method" title="#values (instance method)">#<strong>values</strong>(id = nil) ⇒ Array<Object> </a>
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
</span>
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
<span class="summary_desc"><div class='inline'>
|
345
|
+
<p>Returns the value of all ArticleResult(s).</p>
|
346
|
+
</div></span>
|
347
|
+
|
348
|
+
</li>
|
349
|
+
|
350
|
+
|
351
|
+
</ul>
|
352
|
+
|
353
|
+
|
354
|
+
<div id="constructor_details" class="method_details_list">
|
355
|
+
<h2>Constructor Details</h2>
|
356
|
+
|
357
|
+
<div class="method_details first">
|
358
|
+
<h3 class="signature first" id="initialize-instance_method">
|
359
|
+
|
360
|
+
#<strong>initialize</strong>(parent, parameter) ⇒ <tt><span class='object_link'><a href="" title="TermUtils::AP::ParameterResult (class)">ParameterResult</a></span></tt>
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
</h3><div class="docstring">
|
367
|
+
<div class="discussion">
|
368
|
+
|
369
|
+
<p>Constructs a new ParameterResult.</p>
|
370
|
+
|
371
|
+
|
372
|
+
</div>
|
373
|
+
</div>
|
374
|
+
<div class="tags">
|
375
|
+
<p class="tag_title">Parameters:</p>
|
376
|
+
<ul class="param">
|
377
|
+
|
378
|
+
<li>
|
379
|
+
|
380
|
+
<span class='name'>parent</span>
|
381
|
+
|
382
|
+
|
383
|
+
<span class='type'>(<tt><span class='object_link'><a href="Result.html" title="TermUtils::AP::Result (class)">Result</a></span></tt>)</span>
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
</li>
|
388
|
+
|
389
|
+
<li>
|
390
|
+
|
391
|
+
<span class='name'>parameter</span>
|
392
|
+
|
393
|
+
|
394
|
+
<span class='type'>(<tt><span class='object_link'><a href="Parameter.html" title="TermUtils::AP::Parameter (class)">Parameter</a></span></tt>)</span>
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
</li>
|
399
|
+
|
400
|
+
</ul>
|
401
|
+
|
402
|
+
|
403
|
+
</div><table class="source_code">
|
404
|
+
<tr>
|
405
|
+
<td>
|
406
|
+
<pre class="lines">
|
407
|
+
|
408
|
+
|
409
|
+
82
|
410
|
+
83
|
411
|
+
84
|
412
|
+
85
|
413
|
+
86
|
414
|
+
87</pre>
|
415
|
+
</td>
|
416
|
+
<td>
|
417
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 82</span>
|
418
|
+
|
419
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_parameter'>parameter</span><span class='rparen'>)</span>
|
420
|
+
<span class='ivar'>@parent</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span>
|
421
|
+
<span class='ivar'>@parent</span><span class='period'>.</span><span class='id identifier rubyid_add_result'>add_result</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
|
422
|
+
<span class='ivar'>@parameter</span> <span class='op'>=</span> <span class='id identifier rubyid_parameter'>parameter</span>
|
423
|
+
<span class='ivar'>@results</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
424
|
+
<span class='kw'>end</span></pre>
|
425
|
+
</td>
|
426
|
+
</tr>
|
427
|
+
</table>
|
428
|
+
</div>
|
429
|
+
|
430
|
+
</div>
|
431
|
+
|
432
|
+
<div id="instance_attr_details" class="attr_details">
|
433
|
+
<h2>Instance Attribute Details</h2>
|
434
|
+
|
435
|
+
|
436
|
+
<span id="parameter=-instance_method"></span>
|
437
|
+
<div class="method_details first">
|
438
|
+
<h3 class="signature first" id="parameter-instance_method">
|
439
|
+
|
440
|
+
#<strong>parameter</strong> ⇒ <tt><span class='object_link'><a href="Parameter.html" title="TermUtils::AP::Parameter (class)">Parameter</a></span></tt>
|
441
|
+
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
|
446
|
+
</h3><div class="docstring">
|
447
|
+
<div class="discussion">
|
448
|
+
|
449
|
+
|
450
|
+
</div>
|
451
|
+
</div>
|
452
|
+
<div class="tags">
|
453
|
+
|
454
|
+
<p class="tag_title">Returns:</p>
|
455
|
+
<ul class="return">
|
456
|
+
|
457
|
+
<li>
|
458
|
+
|
459
|
+
|
460
|
+
<span class='type'>(<tt><span class='object_link'><a href="Parameter.html" title="TermUtils::AP::Parameter (class)">Parameter</a></span></tt>)</span>
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
</li>
|
465
|
+
|
466
|
+
</ul>
|
467
|
+
|
468
|
+
</div><table class="source_code">
|
469
|
+
<tr>
|
470
|
+
<td>
|
471
|
+
<pre class="lines">
|
472
|
+
|
473
|
+
|
474
|
+
75
|
475
|
+
76
|
476
|
+
77</pre>
|
477
|
+
</td>
|
478
|
+
<td>
|
479
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 75</span>
|
480
|
+
|
481
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parameter'>parameter</span>
|
482
|
+
<span class='ivar'>@parameter</span>
|
483
|
+
<span class='kw'>end</span></pre>
|
484
|
+
</td>
|
485
|
+
</tr>
|
486
|
+
</table>
|
487
|
+
</div>
|
488
|
+
|
489
|
+
|
490
|
+
<span id="results=-instance_method"></span>
|
491
|
+
<div class="method_details ">
|
492
|
+
<h3 class="signature " id="results-instance_method">
|
493
|
+
|
494
|
+
#<strong>results</strong> ⇒ <tt>Array<<span class='object_link'><a href="ArticleResult.html" title="TermUtils::AP::ArticleResult (class)">ArticleResult</a></span>></tt>
|
495
|
+
|
496
|
+
|
497
|
+
|
498
|
+
|
499
|
+
|
500
|
+
</h3><div class="docstring">
|
501
|
+
<div class="discussion">
|
502
|
+
|
503
|
+
|
504
|
+
</div>
|
505
|
+
</div>
|
506
|
+
<div class="tags">
|
507
|
+
|
508
|
+
<p class="tag_title">Returns:</p>
|
509
|
+
<ul class="return">
|
510
|
+
|
511
|
+
<li>
|
512
|
+
|
513
|
+
|
514
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="ArticleResult.html" title="TermUtils::AP::ArticleResult (class)">ArticleResult</a></span>></tt>)</span>
|
515
|
+
|
516
|
+
|
517
|
+
|
518
|
+
</li>
|
519
|
+
|
520
|
+
</ul>
|
521
|
+
|
522
|
+
</div><table class="source_code">
|
523
|
+
<tr>
|
524
|
+
<td>
|
525
|
+
<pre class="lines">
|
526
|
+
|
527
|
+
|
528
|
+
77
|
529
|
+
78
|
530
|
+
79</pre>
|
531
|
+
</td>
|
532
|
+
<td>
|
533
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 77</span>
|
534
|
+
|
535
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_results'>results</span>
|
536
|
+
<span class='ivar'>@results</span>
|
537
|
+
<span class='kw'>end</span></pre>
|
538
|
+
</td>
|
539
|
+
</tr>
|
540
|
+
</table>
|
541
|
+
</div>
|
542
|
+
|
543
|
+
</div>
|
544
|
+
|
545
|
+
|
546
|
+
<div id="instance_method_details" class="method_details_list">
|
547
|
+
<h2>Instance Method Details</h2>
|
548
|
+
|
549
|
+
|
550
|
+
<div class="method_details first">
|
551
|
+
<h3 class="signature first" id="add_result-instance_method">
|
552
|
+
|
553
|
+
#<strong>add_result</strong>(result) ⇒ <tt>Object</tt>
|
554
|
+
|
555
|
+
|
556
|
+
|
557
|
+
|
558
|
+
|
559
|
+
</h3><div class="docstring">
|
560
|
+
<div class="discussion">
|
561
|
+
|
562
|
+
<p>Adds an ArticleResult.</p>
|
563
|
+
|
564
|
+
|
565
|
+
</div>
|
566
|
+
</div>
|
567
|
+
<div class="tags">
|
568
|
+
<p class="tag_title">Parameters:</p>
|
569
|
+
<ul class="param">
|
570
|
+
|
571
|
+
<li>
|
572
|
+
|
573
|
+
<span class='name'>result</span>
|
574
|
+
|
575
|
+
|
576
|
+
<span class='type'>(<tt><span class='object_link'><a href="ArticleResult.html" title="TermUtils::AP::ArticleResult (class)">ArticleResult</a></span></tt>)</span>
|
577
|
+
|
578
|
+
|
579
|
+
|
580
|
+
</li>
|
581
|
+
|
582
|
+
</ul>
|
583
|
+
|
584
|
+
|
585
|
+
</div><table class="source_code">
|
586
|
+
<tr>
|
587
|
+
<td>
|
588
|
+
<pre class="lines">
|
589
|
+
|
590
|
+
|
591
|
+
91
|
592
|
+
92
|
593
|
+
93</pre>
|
594
|
+
</td>
|
595
|
+
<td>
|
596
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 91</span>
|
597
|
+
|
598
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_result'>add_result</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
599
|
+
<span class='ivar'>@results</span> <span class='op'><<</span> <span class='id identifier rubyid_result'>result</span>
|
600
|
+
<span class='kw'>end</span></pre>
|
601
|
+
</td>
|
602
|
+
</tr>
|
603
|
+
</table>
|
604
|
+
</div>
|
605
|
+
|
606
|
+
<div class="method_details ">
|
607
|
+
<h3 class="signature " id="find_article-instance_method">
|
608
|
+
|
609
|
+
#<strong>find_article</strong>(id) ⇒ <tt><span class='object_link'><a href="ArticleResult.html" title="TermUtils::AP::ArticleResult (class)">ArticleResult</a></span></tt>
|
610
|
+
|
611
|
+
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
</h3><div class="docstring">
|
616
|
+
<div class="discussion">
|
617
|
+
|
618
|
+
<p>Returns the first ArticleResult for a given article id.</p>
|
619
|
+
|
620
|
+
|
621
|
+
</div>
|
622
|
+
</div>
|
623
|
+
<div class="tags">
|
624
|
+
<p class="tag_title">Parameters:</p>
|
625
|
+
<ul class="param">
|
626
|
+
|
627
|
+
<li>
|
628
|
+
|
629
|
+
<span class='name'>id</span>
|
630
|
+
|
631
|
+
|
632
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
633
|
+
|
634
|
+
|
635
|
+
|
636
|
+
</li>
|
637
|
+
|
638
|
+
</ul>
|
639
|
+
|
640
|
+
<p class="tag_title">Returns:</p>
|
641
|
+
<ul class="return">
|
642
|
+
|
643
|
+
<li>
|
644
|
+
|
645
|
+
|
646
|
+
<span class='type'>(<tt><span class='object_link'><a href="ArticleResult.html" title="TermUtils::AP::ArticleResult (class)">ArticleResult</a></span></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
|
+
103
|
661
|
+
104
|
662
|
+
105</pre>
|
663
|
+
</td>
|
664
|
+
<td>
|
665
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 103</span>
|
666
|
+
|
667
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_find_article'>find_article</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
668
|
+
<span class='ivar'>@results</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_art_id'>art_id</span> <span class='op'>==</span> <span class='id identifier rubyid_id'>id</span> <span class='rbrace'>}</span>
|
669
|
+
<span class='kw'>end</span></pre>
|
670
|
+
</td>
|
671
|
+
</tr>
|
672
|
+
</table>
|
673
|
+
</div>
|
674
|
+
|
675
|
+
<div class="method_details ">
|
676
|
+
<h3 class="signature " id="find_articles-instance_method">
|
677
|
+
|
678
|
+
#<strong>find_articles</strong>(id) ⇒ <tt>Array<<span class='object_link'><a href="Result.html" title="TermUtils::AP::Result (class)">Result</a></span>></tt>
|
679
|
+
|
680
|
+
|
681
|
+
|
682
|
+
|
683
|
+
|
684
|
+
</h3><div class="docstring">
|
685
|
+
<div class="discussion">
|
686
|
+
|
687
|
+
<p>Returns all ArticleResult(s) for a given article id.</p>
|
688
|
+
|
689
|
+
|
690
|
+
</div>
|
691
|
+
</div>
|
692
|
+
<div class="tags">
|
693
|
+
<p class="tag_title">Parameters:</p>
|
694
|
+
<ul class="param">
|
695
|
+
|
696
|
+
<li>
|
697
|
+
|
698
|
+
<span class='name'>id</span>
|
699
|
+
|
700
|
+
|
701
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
702
|
+
|
703
|
+
|
704
|
+
|
705
|
+
</li>
|
706
|
+
|
707
|
+
</ul>
|
708
|
+
|
709
|
+
<p class="tag_title">Returns:</p>
|
710
|
+
<ul class="return">
|
711
|
+
|
712
|
+
<li>
|
713
|
+
|
714
|
+
|
715
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Result.html" title="TermUtils::AP::Result (class)">Result</a></span>></tt>)</span>
|
716
|
+
|
717
|
+
|
718
|
+
|
719
|
+
</li>
|
720
|
+
|
721
|
+
</ul>
|
722
|
+
|
723
|
+
</div><table class="source_code">
|
724
|
+
<tr>
|
725
|
+
<td>
|
726
|
+
<pre class="lines">
|
727
|
+
|
728
|
+
|
729
|
+
110
|
730
|
+
111
|
731
|
+
112</pre>
|
732
|
+
</td>
|
733
|
+
<td>
|
734
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 110</span>
|
735
|
+
|
736
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_find_articles'>find_articles</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
737
|
+
<span class='ivar'>@results</span><span class='period'>.</span><span class='id identifier rubyid_find_all'>find_all</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_art_id'>art_id</span> <span class='op'>==</span> <span class='id identifier rubyid_id'>id</span> <span class='rbrace'>}</span>
|
738
|
+
<span class='kw'>end</span></pre>
|
739
|
+
</td>
|
740
|
+
</tr>
|
741
|
+
</table>
|
742
|
+
</div>
|
743
|
+
|
744
|
+
<div class="method_details ">
|
745
|
+
<h3 class="signature " id="param_id-instance_method">
|
746
|
+
|
747
|
+
#<strong>param_id</strong> ⇒ <tt>Symbol</tt>
|
748
|
+
|
749
|
+
|
750
|
+
|
751
|
+
|
752
|
+
|
753
|
+
</h3><div class="docstring">
|
754
|
+
<div class="discussion">
|
755
|
+
|
756
|
+
|
757
|
+
</div>
|
758
|
+
</div>
|
759
|
+
<div class="tags">
|
760
|
+
|
761
|
+
<p class="tag_title">Returns:</p>
|
762
|
+
<ul class="return">
|
763
|
+
|
764
|
+
<li>
|
765
|
+
|
766
|
+
|
767
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
768
|
+
|
769
|
+
|
770
|
+
|
771
|
+
</li>
|
772
|
+
|
773
|
+
</ul>
|
774
|
+
|
775
|
+
</div><table class="source_code">
|
776
|
+
<tr>
|
777
|
+
<td>
|
778
|
+
<pre class="lines">
|
779
|
+
|
780
|
+
|
781
|
+
96
|
782
|
+
97
|
783
|
+
98</pre>
|
784
|
+
</td>
|
785
|
+
<td>
|
786
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 96</span>
|
787
|
+
|
788
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_param_id'>param_id</span>
|
789
|
+
<span class='ivar'>@parameter</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
|
790
|
+
<span class='kw'>end</span></pre>
|
791
|
+
</td>
|
792
|
+
</tr>
|
793
|
+
</table>
|
794
|
+
</div>
|
795
|
+
|
796
|
+
<div class="method_details ">
|
797
|
+
<h3 class="signature " id="value-instance_method">
|
798
|
+
|
799
|
+
#<strong>value</strong>(id = nil) ⇒ <tt>Object</tt>
|
800
|
+
|
801
|
+
|
802
|
+
|
803
|
+
|
804
|
+
|
805
|
+
</h3><div class="docstring">
|
806
|
+
<div class="discussion">
|
807
|
+
|
808
|
+
<p>Returns the value of the first ArticleResult.</p>
|
809
|
+
|
810
|
+
|
811
|
+
</div>
|
812
|
+
</div>
|
813
|
+
<div class="tags">
|
814
|
+
<p class="tag_title">Parameters:</p>
|
815
|
+
<ul class="param">
|
816
|
+
|
817
|
+
<li>
|
818
|
+
|
819
|
+
<span class='name'>id</span>
|
820
|
+
|
821
|
+
|
822
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
823
|
+
|
824
|
+
|
825
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
826
|
+
|
827
|
+
|
828
|
+
—
|
829
|
+
<div class='inline'>
|
830
|
+
<p>Filter of article id.</p>
|
831
|
+
</div>
|
832
|
+
|
833
|
+
</li>
|
834
|
+
|
835
|
+
</ul>
|
836
|
+
|
837
|
+
<p class="tag_title">Returns:</p>
|
838
|
+
<ul class="return">
|
839
|
+
|
840
|
+
<li>
|
841
|
+
|
842
|
+
|
843
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
844
|
+
|
845
|
+
|
846
|
+
|
847
|
+
</li>
|
848
|
+
|
849
|
+
</ul>
|
850
|
+
|
851
|
+
</div><table class="source_code">
|
852
|
+
<tr>
|
853
|
+
<td>
|
854
|
+
<pre class="lines">
|
855
|
+
|
856
|
+
|
857
|
+
117
|
858
|
+
118
|
859
|
+
119
|
860
|
+
120
|
861
|
+
121</pre>
|
862
|
+
</td>
|
863
|
+
<td>
|
864
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 117</span>
|
865
|
+
|
866
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
867
|
+
<span class='kw'>return</span> <span class='ivar'>@results</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='kw'>unless</span> <span class='id identifier rubyid_id'>id</span>
|
868
|
+
|
869
|
+
<span class='id identifier rubyid_find_article'>find_article</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_value'>value</span>
|
870
|
+
<span class='kw'>end</span></pre>
|
871
|
+
</td>
|
872
|
+
</tr>
|
873
|
+
</table>
|
874
|
+
</div>
|
875
|
+
|
876
|
+
<div class="method_details ">
|
877
|
+
<h3 class="signature " id="values-instance_method">
|
878
|
+
|
879
|
+
#<strong>values</strong>(id = nil) ⇒ <tt>Array<Object></tt>
|
880
|
+
|
881
|
+
|
882
|
+
|
883
|
+
|
884
|
+
|
885
|
+
</h3><div class="docstring">
|
886
|
+
<div class="discussion">
|
887
|
+
|
888
|
+
<p>Returns the value of all ArticleResult(s).</p>
|
889
|
+
|
890
|
+
|
891
|
+
</div>
|
892
|
+
</div>
|
893
|
+
<div class="tags">
|
894
|
+
<p class="tag_title">Parameters:</p>
|
895
|
+
<ul class="param">
|
896
|
+
|
897
|
+
<li>
|
898
|
+
|
899
|
+
<span class='name'>id</span>
|
900
|
+
|
901
|
+
|
902
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
903
|
+
|
904
|
+
|
905
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
906
|
+
|
907
|
+
|
908
|
+
—
|
909
|
+
<div class='inline'>
|
910
|
+
<p>Filter of article id.</p>
|
911
|
+
</div>
|
912
|
+
|
913
|
+
</li>
|
914
|
+
|
915
|
+
</ul>
|
916
|
+
|
917
|
+
<p class="tag_title">Returns:</p>
|
918
|
+
<ul class="return">
|
919
|
+
|
920
|
+
<li>
|
921
|
+
|
922
|
+
|
923
|
+
<span class='type'>(<tt>Array<Object></tt>)</span>
|
924
|
+
|
925
|
+
|
926
|
+
|
927
|
+
</li>
|
928
|
+
|
929
|
+
</ul>
|
930
|
+
|
931
|
+
</div><table class="source_code">
|
932
|
+
<tr>
|
933
|
+
<td>
|
934
|
+
<pre class="lines">
|
935
|
+
|
936
|
+
|
937
|
+
126
|
938
|
+
127
|
939
|
+
128
|
940
|
+
129
|
941
|
+
130
|
942
|
+
131
|
943
|
+
132
|
944
|
+
133
|
945
|
+
134
|
946
|
+
135
|
947
|
+
136</pre>
|
948
|
+
</td>
|
949
|
+
<td>
|
950
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 126</span>
|
951
|
+
|
952
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_values'>values</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
953
|
+
<span class='kw'>return</span> <span class='ivar'>@results</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:value</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_id'>id</span>
|
954
|
+
|
955
|
+
<span class='id identifier rubyid_vals'>vals</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
956
|
+
<span class='ivar'>@results</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_r'>r</span><span class='op'>|</span>
|
957
|
+
<span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_art_id'>art_id</span> <span class='op'>!=</span> <span class='id identifier rubyid_id'>id</span>
|
958
|
+
|
959
|
+
<span class='id identifier rubyid_vals'>vals</span> <span class='op'><<</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span>
|
960
|
+
<span class='kw'>end</span>
|
961
|
+
<span class='id identifier rubyid_vals'>vals</span>
|
962
|
+
<span class='kw'>end</span></pre>
|
963
|
+
</td>
|
964
|
+
</tr>
|
965
|
+
</table>
|
966
|
+
</div>
|
967
|
+
|
968
|
+
</div>
|
969
|
+
|
970
|
+
</div>
|
971
|
+
|
972
|
+
<div id="footer">
|
973
|
+
Generated on Wed Aug 9 17:34:26 2023 by
|
974
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
975
|
+
0.9.34 (ruby-3.2.2).
|
976
|
+
</div>
|
977
|
+
|
978
|
+
</div>
|
979
|
+
</body>
|
980
|
+
</html>
|