term_utils 0.1.1 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHORS +1 -0
- data/CHANGELOG.md +51 -0
- data/COPYING +674 -0
- data/README.md +99 -0
- data/Rakefile +55 -0
- data/doc/TermUtils.html +138 -0
- data/doc/TermUtils/AP.html +394 -0
- data/doc/TermUtils/AP/Article.html +993 -0
- data/doc/TermUtils/AP/ArticleResult.html +584 -0
- data/doc/TermUtils/AP/Flag.html +756 -0
- data/doc/TermUtils/AP/NoSuchValueError.html +217 -0
- data/doc/TermUtils/AP/Parameter.html +1592 -0
- data/doc/TermUtils/AP/ParameterResult.html +980 -0
- data/doc/TermUtils/AP/ParameterWalkerHooks.html +409 -0
- data/doc/TermUtils/AP/ParseError.html +217 -0
- data/doc/TermUtils/AP/Parser.html +604 -0
- data/doc/TermUtils/AP/Result.html +837 -0
- data/doc/TermUtils/AP/Syntax.html +761 -0
- data/doc/TermUtils/AP/SyntaxError.html +217 -0
- data/doc/TermUtils/AP/Walker.html +686 -0
- data/doc/TermUtils/FF.html +128 -0
- data/doc/TermUtils/FF/Config.html +774 -0
- data/doc/TermUtils/FF/Context.html +585 -0
- data/doc/TermUtils/FF/Entry.html +626 -0
- data/doc/TermUtils/FF/Query.html +1085 -0
- data/doc/TermUtils/PropertyTreeNode.html +2113 -0
- data/doc/TermUtils/Tab.html +1486 -0
- data/doc/TermUtils/Tab/Column.html +1263 -0
- data/doc/TermUtils/Tab/Header.html +536 -0
- data/doc/TermUtils/Tab/Holder.html +1210 -0
- data/doc/TermUtils/Tab/Printer.html +967 -0
- data/doc/TermUtils/Tab/Table.html +1966 -0
- data/doc/TermUtils/Tab/TableError.html +217 -0
- data/doc/_index.html +387 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +170 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +170 -0
- data/doc/js/app.js +314 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1539 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/term_utils.rb +11 -0
- data/lib/term_utils/ap.rb +70 -0
- data/lib/term_utils/ap/article.rb +74 -0
- data/lib/term_utils/ap/flag.rb +65 -0
- data/lib/term_utils/ap/parameter.rb +144 -0
- data/lib/term_utils/ap/parser.rb +211 -0
- data/lib/term_utils/ap/result.rb +244 -0
- data/lib/term_utils/ap/syntax.rb +96 -0
- data/lib/term_utils/ff.rb +27 -0
- data/lib/term_utils/ff/config.rb +55 -0
- data/lib/term_utils/ff/entry.rb +45 -0
- data/lib/term_utils/ff/query.rb +145 -0
- data/lib/term_utils/property_tree_node.rb +228 -0
- data/lib/term_utils/tab.rb +338 -88
- data/term_utils.gemspec +16 -0
- metadata +69 -7
@@ -0,0 +1,217 @@
|
|
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
|
+
Exception: TermUtils::AP::SyntaxError
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.25
|
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::SyntaxError";
|
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 (S)</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">SyntaxError</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>Exception: TermUtils::AP::SyntaxError
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
72
|
+
<span class="inheritName">StandardError</span>
|
73
|
+
|
74
|
+
<ul class="fullTree">
|
75
|
+
<li>Object</li>
|
76
|
+
|
77
|
+
<li class="next">StandardError</li>
|
78
|
+
|
79
|
+
<li class="next">TermUtils::AP::SyntaxError</li>
|
80
|
+
|
81
|
+
</ul>
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
83
|
+
|
84
|
+
</dd>
|
85
|
+
</dl>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
<dl>
|
98
|
+
<dt>Defined in:</dt>
|
99
|
+
<dd>lib/term_utils/ap.rb</dd>
|
100
|
+
</dl>
|
101
|
+
|
102
|
+
</div>
|
103
|
+
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
105
|
+
<div class="discussion">
|
106
|
+
|
107
|
+
<p>SyntaxError.</p>
|
108
|
+
|
109
|
+
|
110
|
+
</div>
|
111
|
+
</div>
|
112
|
+
<div class="tags">
|
113
|
+
|
114
|
+
|
115
|
+
</div>
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
<h2>
|
124
|
+
Instance 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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(msg) ⇒ SyntaxError </a>
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
</span>
|
138
|
+
|
139
|
+
|
140
|
+
<span class="note title constructor">constructor</span>
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
<span class="summary_desc"><div class='inline'>
|
150
|
+
<p>A new instance of SyntaxError.</p>
|
151
|
+
</div></span>
|
152
|
+
|
153
|
+
</li>
|
154
|
+
|
155
|
+
|
156
|
+
</ul>
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
<div id="constructor_details" class="method_details_list">
|
161
|
+
<h2>Constructor Details</h2>
|
162
|
+
|
163
|
+
<div class="method_details first">
|
164
|
+
<h3 class="signature first" id="initialize-instance_method">
|
165
|
+
|
166
|
+
#<strong>initialize</strong>(msg) ⇒ <tt><span class='object_link'><a href="" title="TermUtils::AP::SyntaxError (class)">SyntaxError</a></span></tt>
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
</h3><div class="docstring">
|
173
|
+
<div class="discussion">
|
174
|
+
|
175
|
+
<p>Returns a new instance of SyntaxError.</p>
|
176
|
+
|
177
|
+
|
178
|
+
</div>
|
179
|
+
</div>
|
180
|
+
<div class="tags">
|
181
|
+
|
182
|
+
|
183
|
+
</div><table class="source_code">
|
184
|
+
<tr>
|
185
|
+
<td>
|
186
|
+
<pre class="lines">
|
187
|
+
|
188
|
+
|
189
|
+
38
|
190
|
+
39
|
191
|
+
40</pre>
|
192
|
+
</td>
|
193
|
+
<td>
|
194
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 38</span>
|
195
|
+
|
196
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
|
197
|
+
<span class='kw'>super</span>
|
198
|
+
<span class='kw'>end</span></pre>
|
199
|
+
</td>
|
200
|
+
</tr>
|
201
|
+
</table>
|
202
|
+
</div>
|
203
|
+
|
204
|
+
</div>
|
205
|
+
|
206
|
+
|
207
|
+
</div>
|
208
|
+
|
209
|
+
<div id="footer">
|
210
|
+
Generated on Sun Aug 2 18:35:09 2020 by
|
211
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
212
|
+
0.9.25 (ruby-2.6.5).
|
213
|
+
</div>
|
214
|
+
|
215
|
+
</div>
|
216
|
+
</body>
|
217
|
+
</html>
|
@@ -0,0 +1,686 @@
|
|
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::Walker
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.25
|
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::Walker";
|
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 (W)</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">Walker</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::Walker
|
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::Walker</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 Walker.</p>
|
106
|
+
|
107
|
+
|
108
|
+
</div>
|
109
|
+
</div>
|
110
|
+
<div class="tags">
|
111
|
+
|
112
|
+
|
113
|
+
</div>
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
<h2>
|
122
|
+
Instance Method Summary
|
123
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
124
|
+
</h2>
|
125
|
+
|
126
|
+
<ul class="summary">
|
127
|
+
|
128
|
+
<li class="public ">
|
129
|
+
<span class="summary_signature">
|
130
|
+
|
131
|
+
<a href="#article-instance_method" title="#article (instance method)">#<strong>article</strong>(param_id = nil, art_id = nil, &block) ⇒ Object </a>
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
</span>
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
<span class="summary_desc"><div class='inline'>
|
146
|
+
<p>Registers an article hook.</p>
|
147
|
+
</div></span>
|
148
|
+
|
149
|
+
</li>
|
150
|
+
|
151
|
+
|
152
|
+
<li class="public ">
|
153
|
+
<span class="summary_signature">
|
154
|
+
|
155
|
+
<a href="#finished-instance_method" title="#finished (instance method)">#<strong>finished</strong>(&block) ⇒ Object </a>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
</span>
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
<span class="summary_desc"><div class='inline'>
|
170
|
+
<p>Registers a walk finished hook.</p>
|
171
|
+
</div></span>
|
172
|
+
|
173
|
+
</li>
|
174
|
+
|
175
|
+
|
176
|
+
<li class="public ">
|
177
|
+
<span class="summary_signature">
|
178
|
+
|
179
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Walker </a>
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
</span>
|
184
|
+
|
185
|
+
|
186
|
+
<span class="note title constructor">constructor</span>
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
<span class="summary_desc"><div class='inline'>
|
196
|
+
<p>Constructs a new Walker.</p>
|
197
|
+
</div></span>
|
198
|
+
|
199
|
+
</li>
|
200
|
+
|
201
|
+
|
202
|
+
<li class="public ">
|
203
|
+
<span class="summary_signature">
|
204
|
+
|
205
|
+
<a href="#notify_article-instance_method" title="#notify_article (instance method)">#<strong>notify_article</strong>(article) ⇒ Object </a>
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
</span>
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
<span class="summary_desc"><div class='inline'>
|
220
|
+
<p>Calls article hooks.</p>
|
221
|
+
</div></span>
|
222
|
+
|
223
|
+
</li>
|
224
|
+
|
225
|
+
|
226
|
+
<li class="public ">
|
227
|
+
<span class="summary_signature">
|
228
|
+
|
229
|
+
<a href="#notify_finished-instance_method" title="#notify_finished (instance method)">#<strong>notify_finished</strong>(remaining_arguments) ⇒ Object </a>
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
</span>
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
<span class="summary_desc"><div class='inline'>
|
244
|
+
<p>Calls finished hook.</p>
|
245
|
+
</div></span>
|
246
|
+
|
247
|
+
</li>
|
248
|
+
|
249
|
+
|
250
|
+
<li class="public ">
|
251
|
+
<span class="summary_signature">
|
252
|
+
|
253
|
+
<a href="#notify_parameter-instance_method" title="#notify_parameter (instance method)">#<strong>notify_parameter</strong>(parameter) ⇒ Object </a>
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
</span>
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
<span class="summary_desc"><div class='inline'>
|
268
|
+
<p>Calls parameter hooks.</p>
|
269
|
+
</div></span>
|
270
|
+
|
271
|
+
</li>
|
272
|
+
|
273
|
+
|
274
|
+
<li class="public ">
|
275
|
+
<span class="summary_signature">
|
276
|
+
|
277
|
+
<a href="#parameter-instance_method" title="#parameter (instance method)">#<strong>parameter</strong>(param_id = nil, &block) ⇒ Object </a>
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
</span>
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
<span class="summary_desc"><div class='inline'>
|
292
|
+
<p>Registers a parameter hook.</p>
|
293
|
+
</div></span>
|
294
|
+
|
295
|
+
</li>
|
296
|
+
|
297
|
+
|
298
|
+
</ul>
|
299
|
+
|
300
|
+
|
301
|
+
<div id="constructor_details" class="method_details_list">
|
302
|
+
<h2>Constructor Details</h2>
|
303
|
+
|
304
|
+
<div class="method_details first">
|
305
|
+
<h3 class="signature first" id="initialize-instance_method">
|
306
|
+
|
307
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="TermUtils::AP::Walker (class)">Walker</a></span></tt>
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
</h3><div class="docstring">
|
314
|
+
<div class="discussion">
|
315
|
+
|
316
|
+
<p>Constructs a new Walker.</p>
|
317
|
+
|
318
|
+
|
319
|
+
</div>
|
320
|
+
</div>
|
321
|
+
<div class="tags">
|
322
|
+
|
323
|
+
|
324
|
+
</div><table class="source_code">
|
325
|
+
<tr>
|
326
|
+
<td>
|
327
|
+
<pre class="lines">
|
328
|
+
|
329
|
+
|
330
|
+
168
|
331
|
+
169
|
332
|
+
170
|
333
|
+
171
|
334
|
+
172
|
335
|
+
173</pre>
|
336
|
+
</td>
|
337
|
+
<td>
|
338
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 168</span>
|
339
|
+
|
340
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
341
|
+
<span class='ivar'>@anonymous_parameter_hook</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
342
|
+
<span class='ivar'>@anonymous_article_hook</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
343
|
+
<span class='ivar'>@parameter_hooks</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
344
|
+
<span class='ivar'>@finished_hook</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
345
|
+
<span class='kw'>end</span></pre>
|
346
|
+
</td>
|
347
|
+
</tr>
|
348
|
+
</table>
|
349
|
+
</div>
|
350
|
+
|
351
|
+
</div>
|
352
|
+
|
353
|
+
|
354
|
+
<div id="instance_method_details" class="method_details_list">
|
355
|
+
<h2>Instance Method Details</h2>
|
356
|
+
|
357
|
+
|
358
|
+
<div class="method_details first">
|
359
|
+
<h3 class="signature first" id="article-instance_method">
|
360
|
+
|
361
|
+
#<strong>article</strong>(param_id = nil, art_id = nil, &block) ⇒ <tt>Object</tt>
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
</h3><div class="docstring">
|
368
|
+
<div class="discussion">
|
369
|
+
|
370
|
+
<p>Registers an article hook.</p>
|
371
|
+
|
372
|
+
|
373
|
+
</div>
|
374
|
+
</div>
|
375
|
+
<div class="tags">
|
376
|
+
|
377
|
+
|
378
|
+
</div><table class="source_code">
|
379
|
+
<tr>
|
380
|
+
<td>
|
381
|
+
<pre class="lines">
|
382
|
+
|
383
|
+
|
384
|
+
188
|
385
|
+
189
|
386
|
+
190
|
387
|
+
191
|
388
|
+
192
|
389
|
+
193
|
390
|
+
194
|
391
|
+
195
|
392
|
+
196
|
393
|
+
197
|
394
|
+
198
|
395
|
+
199
|
396
|
+
200
|
397
|
+
201
|
398
|
+
202
|
399
|
+
203
|
400
|
+
204
|
401
|
+
205</pre>
|
402
|
+
</td>
|
403
|
+
<td>
|
404
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 188</span>
|
405
|
+
|
406
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_article'>article</span><span class='lparen'>(</span><span class='id identifier rubyid_param_id'>param_id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_art_id'>art_id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
407
|
+
<span class='kw'>unless</span> <span class='id identifier rubyid_param_id'>param_id</span>
|
408
|
+
<span class='comment'># Anonymous article hook
|
409
|
+
</span> <span class='ivar'>@anonymous_article_hook</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
410
|
+
<span class='kw'>return</span>
|
411
|
+
<span class='kw'>end</span>
|
412
|
+
|
413
|
+
<span class='kw'>unless</span> <span class='id identifier rubyid_art_id'>art_id</span>
|
414
|
+
<span class='comment'># Anonymous article hook
|
415
|
+
</span> <span class='ivar'>@parameter_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rbracket'>]</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="ParameterWalkerHooks.html" title="TermUtils::AP::ParameterWalkerHooks (class)">ParameterWalkerHooks</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>unless</span> <span class='ivar'>@parameter_hooks</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rparen'>)</span>
|
416
|
+
<span class='ivar'>@parameter_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_anonymous_article_hook'>anonymous_article_hook</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
417
|
+
<span class='kw'>return</span>
|
418
|
+
<span class='kw'>end</span>
|
419
|
+
|
420
|
+
<span class='ivar'>@parameter_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rbracket'>]</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="ParameterWalkerHooks.html" title="TermUtils::AP::ParameterWalkerHooks (class)">ParameterWalkerHooks</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>unless</span> <span class='ivar'>@parameter_hooks</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rparen'>)</span>
|
421
|
+
<span class='ivar'>@parameter_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_article_hooks'>article_hooks</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
422
|
+
<span class='ivar'>@parameter_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_article_hooks'>article_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_art_id'>art_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
423
|
+
<span class='kw'>end</span></pre>
|
424
|
+
</td>
|
425
|
+
</tr>
|
426
|
+
</table>
|
427
|
+
</div>
|
428
|
+
|
429
|
+
<div class="method_details ">
|
430
|
+
<h3 class="signature " id="finished-instance_method">
|
431
|
+
|
432
|
+
#<strong>finished</strong>(&block) ⇒ <tt>Object</tt>
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
</h3><div class="docstring">
|
439
|
+
<div class="discussion">
|
440
|
+
|
441
|
+
<p>Registers a walk finished hook.</p>
|
442
|
+
|
443
|
+
|
444
|
+
</div>
|
445
|
+
</div>
|
446
|
+
<div class="tags">
|
447
|
+
|
448
|
+
|
449
|
+
</div><table class="source_code">
|
450
|
+
<tr>
|
451
|
+
<td>
|
452
|
+
<pre class="lines">
|
453
|
+
|
454
|
+
|
455
|
+
208
|
456
|
+
209
|
457
|
+
210</pre>
|
458
|
+
</td>
|
459
|
+
<td>
|
460
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 208</span>
|
461
|
+
|
462
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_finished'>finished</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
463
|
+
<span class='ivar'>@finished_hook</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
464
|
+
<span class='kw'>end</span></pre>
|
465
|
+
</td>
|
466
|
+
</tr>
|
467
|
+
</table>
|
468
|
+
</div>
|
469
|
+
|
470
|
+
<div class="method_details ">
|
471
|
+
<h3 class="signature " id="notify_article-instance_method">
|
472
|
+
|
473
|
+
#<strong>notify_article</strong>(article) ⇒ <tt>Object</tt>
|
474
|
+
|
475
|
+
|
476
|
+
|
477
|
+
|
478
|
+
|
479
|
+
</h3><div class="docstring">
|
480
|
+
<div class="discussion">
|
481
|
+
|
482
|
+
<p>Calls article hooks.</p>
|
483
|
+
|
484
|
+
|
485
|
+
</div>
|
486
|
+
</div>
|
487
|
+
<div class="tags">
|
488
|
+
|
489
|
+
|
490
|
+
</div><table class="source_code">
|
491
|
+
<tr>
|
492
|
+
<td>
|
493
|
+
<pre class="lines">
|
494
|
+
|
495
|
+
|
496
|
+
222
|
497
|
+
223
|
498
|
+
224
|
499
|
+
225
|
500
|
+
226
|
501
|
+
227
|
502
|
+
228
|
503
|
+
229
|
504
|
+
230
|
505
|
+
231
|
506
|
+
232
|
507
|
+
233</pre>
|
508
|
+
</td>
|
509
|
+
<td>
|
510
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 222</span>
|
511
|
+
|
512
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_notify_article'>notify_article</span><span class='lparen'>(</span><span class='id identifier rubyid_article'>article</span><span class='rparen'>)</span>
|
513
|
+
<span class='comment'># (1of2) ID article hook
|
514
|
+
</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span> <span class='op'>=</span> <span class='ivar'>@parameter_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_article'>article</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rbracket'>]</span>
|
515
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span>
|
516
|
+
<span class='comment'># ID article hook
|
517
|
+
</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span><span class='period'>.</span><span class='id identifier rubyid_article_hooks'>article_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_article'>article</span><span class='period'>.</span><span class='id identifier rubyid_art_id'>art_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_article'>article</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span><span class='period'>.</span><span class='id identifier rubyid_article_hooks'>article_hooks</span> <span class='op'>&&</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span><span class='period'>.</span><span class='id identifier rubyid_article_hooks'>article_hooks</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_article'>article</span><span class='period'>.</span><span class='id identifier rubyid_art_id'>art_id</span><span class='rparen'>)</span>
|
518
|
+
<span class='comment'># Anonymous article hook
|
519
|
+
</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span><span class='period'>.</span><span class='id identifier rubyid_anonymous_article_hook'>anonymous_article_hook</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_article'>article</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span><span class='period'>.</span><span class='id identifier rubyid_anonymous_article_hook'>anonymous_article_hook</span>
|
520
|
+
<span class='kw'>end</span>
|
521
|
+
<span class='comment'># (2of2) Anonymous article hook
|
522
|
+
</span> <span class='ivar'>@anonymous_article_hook</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_article'>article</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@anonymous_article_hook</span>
|
523
|
+
<span class='kw'>end</span></pre>
|
524
|
+
</td>
|
525
|
+
</tr>
|
526
|
+
</table>
|
527
|
+
</div>
|
528
|
+
|
529
|
+
<div class="method_details ">
|
530
|
+
<h3 class="signature " id="notify_finished-instance_method">
|
531
|
+
|
532
|
+
#<strong>notify_finished</strong>(remaining_arguments) ⇒ <tt>Object</tt>
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
|
538
|
+
</h3><div class="docstring">
|
539
|
+
<div class="discussion">
|
540
|
+
|
541
|
+
<p>Calls finished hook.</p>
|
542
|
+
|
543
|
+
|
544
|
+
</div>
|
545
|
+
</div>
|
546
|
+
<div class="tags">
|
547
|
+
|
548
|
+
|
549
|
+
</div><table class="source_code">
|
550
|
+
<tr>
|
551
|
+
<td>
|
552
|
+
<pre class="lines">
|
553
|
+
|
554
|
+
|
555
|
+
236
|
556
|
+
237
|
557
|
+
238</pre>
|
558
|
+
</td>
|
559
|
+
<td>
|
560
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 236</span>
|
561
|
+
|
562
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_notify_finished'>notify_finished</span><span class='lparen'>(</span><span class='id identifier rubyid_remaining_arguments'>remaining_arguments</span><span class='rparen'>)</span>
|
563
|
+
<span class='ivar'>@finished_hook</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_remaining_arguments'>remaining_arguments</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@finished_hook</span>
|
564
|
+
<span class='kw'>end</span></pre>
|
565
|
+
</td>
|
566
|
+
</tr>
|
567
|
+
</table>
|
568
|
+
</div>
|
569
|
+
|
570
|
+
<div class="method_details ">
|
571
|
+
<h3 class="signature " id="notify_parameter-instance_method">
|
572
|
+
|
573
|
+
#<strong>notify_parameter</strong>(parameter) ⇒ <tt>Object</tt>
|
574
|
+
|
575
|
+
|
576
|
+
|
577
|
+
|
578
|
+
|
579
|
+
</h3><div class="docstring">
|
580
|
+
<div class="discussion">
|
581
|
+
|
582
|
+
<p>Calls parameter hooks.</p>
|
583
|
+
|
584
|
+
|
585
|
+
</div>
|
586
|
+
</div>
|
587
|
+
<div class="tags">
|
588
|
+
|
589
|
+
|
590
|
+
</div><table class="source_code">
|
591
|
+
<tr>
|
592
|
+
<td>
|
593
|
+
<pre class="lines">
|
594
|
+
|
595
|
+
|
596
|
+
213
|
597
|
+
214
|
598
|
+
215
|
599
|
+
216
|
600
|
+
217
|
601
|
+
218
|
602
|
+
219</pre>
|
603
|
+
</td>
|
604
|
+
<td>
|
605
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 213</span>
|
606
|
+
|
607
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_notify_parameter'>notify_parameter</span><span class='lparen'>(</span><span class='id identifier rubyid_parameter'>parameter</span><span class='rparen'>)</span>
|
608
|
+
<span class='comment'># (1of2) ID parameter hook
|
609
|
+
</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span> <span class='op'>=</span> <span class='ivar'>@parameter_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_parameter'>parameter</span><span class='period'>.</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rbracket'>]</span>
|
610
|
+
<span class='id identifier rubyid_param_hooks'>param_hooks</span><span class='period'>.</span><span class='id identifier rubyid_hook'>hook</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_parameter'>parameter</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span> <span class='op'>&&</span> <span class='id identifier rubyid_param_hooks'>param_hooks</span><span class='period'>.</span><span class='id identifier rubyid_hook'>hook</span>
|
611
|
+
<span class='comment'># (2of2) Anonymous parameter hook
|
612
|
+
</span> <span class='ivar'>@anonymous_parameter_hook</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_parameter'>parameter</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@anonymous_parameter_hook</span>
|
613
|
+
<span class='kw'>end</span></pre>
|
614
|
+
</td>
|
615
|
+
</tr>
|
616
|
+
</table>
|
617
|
+
</div>
|
618
|
+
|
619
|
+
<div class="method_details ">
|
620
|
+
<h3 class="signature " id="parameter-instance_method">
|
621
|
+
|
622
|
+
#<strong>parameter</strong>(param_id = nil, &block) ⇒ <tt>Object</tt>
|
623
|
+
|
624
|
+
|
625
|
+
|
626
|
+
|
627
|
+
|
628
|
+
</h3><div class="docstring">
|
629
|
+
<div class="discussion">
|
630
|
+
|
631
|
+
<p>Registers a parameter hook.</p>
|
632
|
+
|
633
|
+
|
634
|
+
</div>
|
635
|
+
</div>
|
636
|
+
<div class="tags">
|
637
|
+
|
638
|
+
|
639
|
+
</div><table class="source_code">
|
640
|
+
<tr>
|
641
|
+
<td>
|
642
|
+
<pre class="lines">
|
643
|
+
|
644
|
+
|
645
|
+
176
|
646
|
+
177
|
647
|
+
178
|
648
|
+
179
|
649
|
+
180
|
650
|
+
181
|
651
|
+
182
|
652
|
+
183
|
653
|
+
184
|
654
|
+
185</pre>
|
655
|
+
</td>
|
656
|
+
<td>
|
657
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/result.rb', line 176</span>
|
658
|
+
|
659
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parameter'>parameter</span><span class='lparen'>(</span><span class='id identifier rubyid_param_id'>param_id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
660
|
+
<span class='kw'>unless</span> <span class='id identifier rubyid_param_id'>param_id</span>
|
661
|
+
<span class='comment'># Anonymous parameter hook
|
662
|
+
</span> <span class='ivar'>@anonymous_parameter_hook</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
663
|
+
<span class='kw'>return</span>
|
664
|
+
<span class='kw'>end</span>
|
665
|
+
|
666
|
+
<span class='ivar'>@parameter_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rbracket'>]</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="ParameterWalkerHooks.html" title="TermUtils::AP::ParameterWalkerHooks (class)">ParameterWalkerHooks</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>unless</span> <span class='ivar'>@parameter_hooks</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rparen'>)</span>
|
667
|
+
<span class='ivar'>@parameter_hooks</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_id'>param_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_hook'>hook</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
668
|
+
<span class='kw'>end</span></pre>
|
669
|
+
</td>
|
670
|
+
</tr>
|
671
|
+
</table>
|
672
|
+
</div>
|
673
|
+
|
674
|
+
</div>
|
675
|
+
|
676
|
+
</div>
|
677
|
+
|
678
|
+
<div id="footer">
|
679
|
+
Generated on Sun Aug 2 18:35:10 2020 by
|
680
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
681
|
+
0.9.25 (ruby-2.6.5).
|
682
|
+
</div>
|
683
|
+
|
684
|
+
</div>
|
685
|
+
</body>
|
686
|
+
</html>
|