kdict 0.1.1
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 +7 -0
- data/.gitignore +15 -0
- data/.rspec +3 -0
- data/.travis.yml +7 -0
- data/.yardopts +3 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +43 -0
- data/LICENSE.txt +21 -0
- data/README.md +301 -0
- data/Rakefile +8 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/docs/Between.html +302 -0
- data/docs/Bool.html +121 -0
- data/docs/Example1.md +195 -0
- data/docs/FalseClass.html +143 -0
- data/docs/KDict/Error.html +135 -0
- data/docs/KDict.html +128 -0
- data/docs/Kdict/Error.html +135 -0
- data/docs/Kdict.html +157 -0
- data/docs/Kdict_.html +143 -0
- data/docs/KwargDict.html +697 -0
- data/docs/KwargModel.html +638 -0
- data/docs/KwargTypes.html +988 -0
- data/docs/Numeric.html +148 -0
- data/docs/TrueClass.html +143 -0
- data/docs/_index.html +184 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.Example1.html +240 -0
- data/docs/file.README.html +370 -0
- data/docs/file_list.html +61 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +370 -0
- data/docs/js/app.js +303 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +187 -0
- data/docs/top-level-namespace.html +112 -0
- data/examples/example1.rb +90 -0
- data/kdict.gemspec +39 -0
- data/lib/kdict/kwargdict/kwargtypes/bool.rb +9 -0
- data/lib/kdict/kwargdict/kwargtypes.rb +196 -0
- data/lib/kdict/kwargdict.rb +75 -0
- data/lib/kdict/kwargmodel.rb +40 -0
- data/lib/kdict/version.rb +5 -0
- data/lib/kdict.rb +19 -0
- data/ndoc/checksums +6 -0
- data/ndoc/complete +0 -0
- data/ndoc/object_types +0 -0
- data/ndoc/objects/root.dat +0 -0
- data/ndoc/proxy_types +0 -0
- metadata +150 -0
|
@@ -0,0 +1,988 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: KwargTypes
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.19
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "KwargTypes";
|
|
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 (K)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">KwargTypes</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: KwargTypes
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
<dl>
|
|
78
|
+
<dt>Included in:</dt>
|
|
79
|
+
<dd><span class='object_link'><a href="KwargDict.html" title="KwargDict (class)">KwargDict</a></span></dd>
|
|
80
|
+
</dl>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/kdict/kwargdict/kwargtypes.rb</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
|
92
|
+
<div class="discussion">
|
|
93
|
+
|
|
94
|
+
<p>KwargTypes is a collection of generic definitions that are called as parameters from <span class='object_link'><a href="KwargDict.html" title="KwargDict (class)">KwargDict</a></span>. Each definition or <strong>typedef</strong> validates a user's input against models built in the dictionary. Every <strong>typedef</strong> receives a user's argument and an associated <strong>struct</strong>, and checks to see if that argument passes the <strong>struct</strong>'s unique conditions. All <strong>typedefs</strong> return Boolean. Some <strong>typedefs</strong> can receive a Proc that further modifies the <strong>struct</strong>'s behavior by adding to (but never overridding) its conditions for truthiness.</p>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
</div>
|
|
98
|
+
</div>
|
|
99
|
+
<div class="tags">
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>
|
|
105
|
+
Constant Summary
|
|
106
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
107
|
+
</h2>
|
|
108
|
+
|
|
109
|
+
<dl class="constants">
|
|
110
|
+
|
|
111
|
+
<dt id="types-classvariable" class="">@@types =
|
|
112
|
+
<div class="docstring">
|
|
113
|
+
<div class="discussion">
|
|
114
|
+
|
|
115
|
+
<p>Used internally. Gives <strong>typedefs</strong> access to a modified list of generic datatypes.</p>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
<div class="tags">
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
</dt>
|
|
125
|
+
<dd><pre class="code"><span class='lbracket'>[</span><span class='const'>Numeric</span><span class='comma'>,</span> <span class='const'>Float</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Hash</span><span class='comma'>,</span> <span class='const'>Array</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rbracket'>]</span></pre></dd>
|
|
126
|
+
|
|
127
|
+
<dt id="typedefs-classvariable" class="">@@typedefs =
|
|
128
|
+
<div class="docstring">
|
|
129
|
+
<div class="discussion">
|
|
130
|
+
|
|
131
|
+
<p>Used by KwargDict to check against listed definitions before accepting a new KwargModel.</p>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</div>
|
|
136
|
+
<div class="tags">
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
</div>
|
|
140
|
+
</dt>
|
|
141
|
+
<dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='symbol'>:anyof</span><span class='comma'>,</span> <span class='symbol'>:anyNof</span><span class='comma'>,</span> <span class='symbol'>:formof</span><span class='comma'>,</span> <span class='symbol'>:kwargsof</span><span class='comma'>,</span>
|
|
142
|
+
<span class='symbol'>:adv_formof</span><span class='comma'>,</span> <span class='symbol'>:and_kwargsof</span><span class='rbracket'>]</span></pre></dd>
|
|
143
|
+
|
|
144
|
+
</dl>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<h2>
|
|
155
|
+
Instance Method Summary
|
|
156
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
157
|
+
</h2>
|
|
158
|
+
|
|
159
|
+
<ul class="summary">
|
|
160
|
+
|
|
161
|
+
<li class="public ">
|
|
162
|
+
<span class="summary_signature">
|
|
163
|
+
|
|
164
|
+
<a href="#adv_formof-instance_method" title="#adv_formof (instance method)">#<strong>adv_formof</strong>(arg, struct) ⇒ Object </a>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</span>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<span class="summary_desc"><div class='inline'>
|
|
179
|
+
<h4 id="label-Your+struct+contains+an+array+of+exact+length-2C+each+of+whom-27s+elements+has+its+own+subset+of+typedef-2C+struct-2C+and+possibly+prc.">Your <strong>struct</strong> contains an array of exact length, each of whom's elements has its own subset of <strong>typedef</strong>, <strong>struct</strong>, and possibly <strong>prc</strong>.</h4>
|
|
180
|
+
</div></span>
|
|
181
|
+
|
|
182
|
+
</li>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
<li class="public ">
|
|
186
|
+
<span class="summary_signature">
|
|
187
|
+
|
|
188
|
+
<a href="#and_kwargsof-instance_method" title="#and_kwargsof (instance method)">#<strong>and_kwargsof</strong>(arg, struct) ⇒ Object </a>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
</span>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<span class="summary_desc"><div class='inline'>
|
|
203
|
+
<h4 id="label-Your+struct+is+structured+like+-3Aadv_formof+but+the+last+element+MUST+be+a+-3Akwargsof+typedef.">Your <strong>struct</strong> is structured like <strong>:adv_formof</strong> but the last element MUST be a <strong>:kwargsof</strong> <strong>typedef</strong>.</h4>
|
|
204
|
+
</div></span>
|
|
205
|
+
|
|
206
|
+
</li>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<li class="public ">
|
|
210
|
+
<span class="summary_signature">
|
|
211
|
+
|
|
212
|
+
<a href="#anyNof-instance_method" title="#anyNof (instance method)">#<strong>anyNof</strong>(arg, struct, prc = nil) ⇒ Object </a>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
</span>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<span class="summary_desc"><div class='inline'>
|
|
227
|
+
<h4 id="label-Your+struct+contains+an+element+OR+specific+datatype+in+an+array.">Your <strong>struct</strong> contains an element OR specific datatype in an array.</h4>
|
|
228
|
+
</div></span>
|
|
229
|
+
|
|
230
|
+
</li>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<li class="public ">
|
|
234
|
+
<span class="summary_signature">
|
|
235
|
+
|
|
236
|
+
<a href="#anyof-instance_method" title="#anyof (instance method)">#<strong>anyof</strong>(arg, struct) ⇒ Boolean </a>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
</span>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<span class="summary_desc"><div class='inline'>
|
|
251
|
+
<h4 id="label-Your+struct+contains+a+singular+element+that+can+be+found+in+an+array.">Your <strong>struct</strong> contains a singular element that can be found in an array.</h4>
|
|
252
|
+
</div></span>
|
|
253
|
+
|
|
254
|
+
</li>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<li class="public ">
|
|
258
|
+
<span class="summary_signature">
|
|
259
|
+
|
|
260
|
+
<a href="#arrayof-instance_method" title="#arrayof (instance method)">#<strong>arrayof</strong>(arg, struct, prc = nil) ⇒ Boolean </a>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
</span>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
<span class="summary_desc"><div class='inline'>
|
|
275
|
+
<h4 id="label-Your+struct+contains+an+array+of+any+length+but+contain+only+one+datatype.">Your <strong>struct</strong> contains an array of any length but contain only one datatype.</h4>
|
|
276
|
+
</div></span>
|
|
277
|
+
|
|
278
|
+
</li>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<li class="public ">
|
|
282
|
+
<span class="summary_signature">
|
|
283
|
+
|
|
284
|
+
<a href="#formof-instance_method" title="#formof (instance method)">#<strong>formof</strong>(arg, struct, prc = nil) ⇒ Object </a>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
</span>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<span class="summary_desc"><div class='inline'>
|
|
299
|
+
<h4 id="label-Your+struct+contains+an+array+of+exact+length-2C+you+expect+each+element+to+be+contained+in+a+specific+order+and+be+a+generic+datatype.">Your <strong>struct</strong> contains an array of exact length, you expect each element to be contained in a specific order and be a generic datatype.</h4>
|
|
300
|
+
</div></span>
|
|
301
|
+
|
|
302
|
+
</li>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<li class="public ">
|
|
306
|
+
<span class="summary_signature">
|
|
307
|
+
|
|
308
|
+
<a href="#kwargsof-instance_method" title="#kwargsof (instance method)">#<strong>kwargsof</strong>(arg, struct) ⇒ Object </a>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
</span>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<span class="summary_desc"><div class='inline'>
|
|
323
|
+
<h4 id="label-Your+struct+contains+a+hash+that+corresponds+to+another+KwargDict.">Your <strong>struct</strong> contains a hash that corresponds to another KwargDict.</h4>
|
|
324
|
+
</div></span>
|
|
325
|
+
|
|
326
|
+
</li>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
<li class="public ">
|
|
330
|
+
<span class="summary_signature">
|
|
331
|
+
|
|
332
|
+
<a href="#typeof-instance_method" title="#typeof (instance method)">#<strong>typeof</strong>(arg, struct, prc = nil) ⇒ Boolean </a>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
</span>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<span class="summary_desc"><div class='inline'>
|
|
347
|
+
<h4 id="label-Your+struct+contains+a+singular+value+of+exactly+one+datatype.">Your <strong>struct</strong> contains a singular value of exactly one datatype.</h4>
|
|
348
|
+
</div></span>
|
|
349
|
+
|
|
350
|
+
</li>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
</ul>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<div id="instance_method_details" class="method_details_list">
|
|
359
|
+
<h2>Instance Method Details</h2>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
<div class="method_details first">
|
|
363
|
+
<h3 class="signature first" id="adv_formof-instance_method">
|
|
364
|
+
|
|
365
|
+
#<strong>adv_formof</strong>(arg, struct) ⇒ <tt>Object</tt>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
</h3><div class="docstring">
|
|
372
|
+
<div class="discussion">
|
|
373
|
+
|
|
374
|
+
<h4 id="label-Your+struct+contains+an+array+of+exact+length-2C+each+of+whom-27s+elements+has+its+own+subset+of+typedef-2C+struct-2C+and+possibly+prc">Your <strong>struct</strong> contains an array of exact length, each of whom's elements has its own subset of <strong>typedef</strong>, <strong>struct</strong>, and possibly <strong>prc</strong></h4>
|
|
375
|
+
<ul><li>
|
|
376
|
+
<p><strong>structs</strong> - Must be an array of exact length, each element of which is a sub array containing <strong>typedef</strong>, <strong>struct</strong>, and an optional <strong>prc</strong>, in that order. Can accept <strong>:typeof</strong>, <strong>:arrayof</strong>, <strong>:anyof</strong>, <strong>:anyNof</strong>, <strong>:formof</strong>, and <strong>:adv_formof</strong>.</p>
|
|
377
|
+
</li><li>
|
|
378
|
+
<p>Will NOT accept <strong>:kwargsof</strong> or <strong>:and_kwargsof</strong>.</p>
|
|
379
|
+
</li><li>
|
|
380
|
+
<p>Will return false if user input appears out of order with respect to the <strong>struct</strong>.</p>
|
|
381
|
+
</li><li>
|
|
382
|
+
<p>Will not accept a Proc outside of a sub <strong>typedef</strong>. Each element in <strong>struct</strong> may have its own unique Proc, however, if allowed for that <strong>typedef</strong>.</p>
|
|
383
|
+
</li></ul>
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
</div>
|
|
387
|
+
</div>
|
|
388
|
+
<div class="tags">
|
|
389
|
+
|
|
390
|
+
<div class="examples">
|
|
391
|
+
<p class="tag_title">Examples:</p>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<p class="example_title"><div class='inline'>
|
|
395
|
+
<p>(Called From a KwargDict instance)</p>
|
|
396
|
+
</div></p>
|
|
397
|
+
|
|
398
|
+
<pre class="example code"><code><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:adv_formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
|
399
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:adv_formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>></span> <span class='int'>5</span> <span class='rbrace'>}</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
400
|
+
<span class='lbracket'>[</span><span class='symbol'>:formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Float</span><span class='rbracket'>]</span><span class='op'>*</span><span class='int'>3</span> <span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_n'>n</span><span class='op'>|</span> <span class='id identifier rubyid_n'>n</span><span class='period'>.</span><span class='id identifier rubyid_ibetween?'>ibetween?</span><span class='lparen'>(</span><span class='int'>0</span><span class='comma'>,</span><span class='int'>1</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
|
401
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>3.1</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='comma'>,</span> <span class='int'>4</span><span class='comma'>,</span> <span class='int'>5</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
402
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>3.1</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>2</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>3</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => false
|
|
403
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Longer</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>0.25</span><span class='comma'>,</span> <span class='float'>0.5</span><span class='comma'>,</span> <span class='float'>1.0</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
404
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Longer</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='op'>-</span><span class='float'>0.25</span><span class='comma'>,</span> <span class='float'>0.5</span><span class='comma'>,</span> <span class='op'>-</span><span class='float'>1.0</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => false
|
|
405
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Short</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>0.25</span><span class='comma'>,</span> <span class='float'>0.5</span><span class='comma'>,</span> <span class='float'>1.0</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => false</span></code></pre>
|
|
406
|
+
|
|
407
|
+
</div>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
</div><table class="source_code">
|
|
411
|
+
<tr>
|
|
412
|
+
<td>
|
|
413
|
+
<pre class="lines">
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
146
|
|
417
|
+
147
|
|
418
|
+
148
|
|
419
|
+
149</pre>
|
|
420
|
+
</td>
|
|
421
|
+
<td>
|
|
422
|
+
<pre class="code"><span class="info file"># File 'lib/kdict/kwargdict/kwargtypes.rb', line 146</span>
|
|
423
|
+
|
|
424
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_adv_formof'>adv_formof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='rparen'>)</span>
|
|
425
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>!=</span> <span class='id identifier rubyid_struct'>struct</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
|
|
426
|
+
<span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_zip'>zip</span><span class='lparen'>(</span><span class='id identifier rubyid_struct'>struct</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
427
|
+
<span class='kw'>end</span></pre>
|
|
428
|
+
</td>
|
|
429
|
+
</tr>
|
|
430
|
+
</table>
|
|
431
|
+
</div>
|
|
432
|
+
|
|
433
|
+
<div class="method_details ">
|
|
434
|
+
<h3 class="signature " id="and_kwargsof-instance_method">
|
|
435
|
+
|
|
436
|
+
#<strong>and_kwargsof</strong>(arg, struct) ⇒ <tt>Object</tt>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
</h3><div class="docstring">
|
|
443
|
+
<div class="discussion">
|
|
444
|
+
|
|
445
|
+
<h4 id="label-Your+struct+is+structured+like+-3Aadv_formof+but+the+last+element+MUST+be+a+-3Akwargsof+typedef">Your <strong>struct</strong> is structured like <strong>:adv_formof</strong> but the last element MUST be a <strong>:kwargsof</strong> <strong>typedef</strong></h4>
|
|
446
|
+
<ul><li>
|
|
447
|
+
<p><strong>structs</strong> - MUST be an array in the form of <strong>:adv_formof</strong>, but the last sub <strong>typedef</strong> MUST be a <strong>kwargsof</strong></p>
|
|
448
|
+
</li><li>
|
|
449
|
+
<p>Will return true if given a single value that returns true from the first sub <strong>typedef</strong> in the array.</p>
|
|
450
|
+
</li><li>
|
|
451
|
+
<p>Will return true if given an array of values in the order they appear in <strong>struct</strong>, without skipping one, and each returns true from its respective sub <strong>typedef</strong></p>
|
|
452
|
+
</li><li>
|
|
453
|
+
<p>Will return true if the previous statement is true but the given array also includes a hash that corresponds to the last sub <strong>typedef</strong> in the <strong>struct</strong>, which again must always be <strong>:kwargsof</strong>.</p>
|
|
454
|
+
</li><li>
|
|
455
|
+
<p>Will return false if only a hash is present, even if hash elements are all valid to its nested KwargDict</p>
|
|
456
|
+
</li><li>
|
|
457
|
+
<p>Each sub <strong>typedef</strong> may receive a Proc if allowed for that <strong>typedef</strong></p>
|
|
458
|
+
</li></ul>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
</div>
|
|
462
|
+
</div>
|
|
463
|
+
<div class="tags">
|
|
464
|
+
|
|
465
|
+
<div class="examples">
|
|
466
|
+
<p class="tag_title">Examples:</p>
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
<p class="example_title"><div class='inline'>
|
|
470
|
+
<p>(Called From a KwargDict instance)</p>
|
|
471
|
+
</div></p>
|
|
472
|
+
|
|
473
|
+
<pre class="example code"><code><span class='id identifier rubyid_another_dict'>another_dict</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:one</span><span class='comma'>,</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:two</span><span class='comma'>,</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
474
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:and_kwargsof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:kwargsof</span><span class='comma'>,</span> <span class='id identifier rubyid_another_dict'>another_dict</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
|
475
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>It works!</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># => true
|
|
476
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>And this.</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
477
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>This too.</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
478
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>As does this.</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>two:</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Super!</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
479
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Even this works.</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>two:</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Yep.</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>one:</span><span class='float'>3.1</span><span class='rbrace'>}</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
480
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='comment'># => false | Skips the first element of :example
|
|
481
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>It broke!</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => false | Elements appear out of order
|
|
482
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>one:</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Nope</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'># => false </span></code></pre>
|
|
483
|
+
|
|
484
|
+
</div>
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
</div><table class="source_code">
|
|
488
|
+
<tr>
|
|
489
|
+
<td>
|
|
490
|
+
<pre class="lines">
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
175
|
|
494
|
+
176
|
|
495
|
+
177
|
|
496
|
+
178
|
|
497
|
+
179
|
|
498
|
+
180
|
|
499
|
+
181
|
|
500
|
+
182
|
|
501
|
+
183
|
|
502
|
+
184
|
|
503
|
+
185
|
|
504
|
+
186
|
|
505
|
+
187
|
|
506
|
+
188
|
|
507
|
+
189
|
|
508
|
+
190</pre>
|
|
509
|
+
</td>
|
|
510
|
+
<td>
|
|
511
|
+
<pre class="code"><span class="info file"># File 'lib/kdict/kwargdict/kwargtypes.rb', line 175</span>
|
|
512
|
+
|
|
513
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_and_kwargsof'>and_kwargsof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='rparen'>)</span>
|
|
514
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
515
|
+
|
|
516
|
+
<span class='comment'># If only one arg of several are present and it's the first...
|
|
517
|
+
</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
|
|
518
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_struct'>struct</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
519
|
+
<span class='kw'>end</span>
|
|
520
|
+
|
|
521
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_arg'>arg</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
522
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_adv_formof'>adv_formof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>...</span><span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
523
|
+
<span class='kw'>else</span>
|
|
524
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_adv_formof'>adv_formof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>...</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>...</span><span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
525
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_struct'>struct</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
526
|
+
<span class='kw'>end</span>
|
|
527
|
+
|
|
528
|
+
<span class='kw'>end</span></pre>
|
|
529
|
+
</td>
|
|
530
|
+
</tr>
|
|
531
|
+
</table>
|
|
532
|
+
</div>
|
|
533
|
+
|
|
534
|
+
<div class="method_details ">
|
|
535
|
+
<h3 class="signature " id="anyNof-instance_method">
|
|
536
|
+
|
|
537
|
+
#<strong>anyNof</strong>(arg, struct, prc = nil) ⇒ <tt>Object</tt>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
</h3><div class="docstring">
|
|
544
|
+
<div class="discussion">
|
|
545
|
+
|
|
546
|
+
<h4 id="label-Your+struct+contains+an+element+OR+specific+datatype+in+an+array.">Your <strong>struct</strong> contains an element OR specific datatype in an array.</h4>
|
|
547
|
+
<ul><li>
|
|
548
|
+
<p><strong>structs</strong> - An array of any mixed things you'd like plus generic datatype keywords <strong>Numeric</strong>, <strong>Float</strong>, <strong>Integer</strong>, <strong>Bool</strong>, <strong>String</strong>, <strong>Symbol</strong></p>
|
|
549
|
+
</li><li>
|
|
550
|
+
<p>Can accept a Proc that will only operate on a given value if it's identified by a generic datatype in <strong>struct</strong> after a check for explicit existence in the array</p>
|
|
551
|
+
</li></ul>
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
</div>
|
|
555
|
+
</div>
|
|
556
|
+
<div class="tags">
|
|
557
|
+
|
|
558
|
+
<div class="examples">
|
|
559
|
+
<p class="tag_title">Examples:</p>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
<p class="example_title"><div class='inline'>
|
|
563
|
+
<p>(Called From a KwargDict instance)</p>
|
|
564
|
+
</div></p>
|
|
565
|
+
|
|
566
|
+
<pre class="example code"><code><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:anyNof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Integer</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>red</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>blue</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>magenta</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
567
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:anyNof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Float</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>green</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='float'>3.1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_n'>n</span><span class='op'>|</span> <span class='id identifier rubyid_n'>n</span> <span class='op'>></span> <span class='int'>5</span> <span class='rbrace'>}</span>
|
|
568
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>red</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># => true
|
|
569
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='int'>34</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
570
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>green</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># => true
|
|
571
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='float'>6.1</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
572
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='float'>3.1</span><span class='rparen'>)</span> <span class='comment'># => true</span></code></pre>
|
|
573
|
+
|
|
574
|
+
</div>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
</div><table class="source_code">
|
|
578
|
+
<tr>
|
|
579
|
+
<td>
|
|
580
|
+
<pre class="lines">
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
81
|
|
584
|
+
82
|
|
585
|
+
83
|
|
586
|
+
84
|
|
587
|
+
85
|
|
588
|
+
86
|
|
589
|
+
87
|
|
590
|
+
88</pre>
|
|
591
|
+
</td>
|
|
592
|
+
<td>
|
|
593
|
+
<pre class="code"><span class="info file"># File 'lib/kdict/kwargdict/kwargtypes.rb', line 81</span>
|
|
594
|
+
|
|
595
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_anyNof'>anyNof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='comma'>,</span> <span class='id identifier rubyid_prc'>prc</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
596
|
+
<span class='id identifier rubyid_prc'>prc</span> <span class='op'>||=</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span><span class='kw'>true</span><span class='rbrace'>}</span>
|
|
597
|
+
<span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_anyof'>anyof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='rparen'>)</span>
|
|
598
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_struct'>struct</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_ele'>ele</span><span class='op'>|</span> <span class='cvar'>@@types</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_ele'>ele</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_type'>type</span><span class='op'>|</span> <span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_prc'>prc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
599
|
+
<span class='kw'>return</span> <span class='kw'>true</span>
|
|
600
|
+
<span class='kw'>end</span>
|
|
601
|
+
<span class='kw'>false</span>
|
|
602
|
+
<span class='kw'>end</span></pre>
|
|
603
|
+
</td>
|
|
604
|
+
</tr>
|
|
605
|
+
</table>
|
|
606
|
+
</div>
|
|
607
|
+
|
|
608
|
+
<div class="method_details ">
|
|
609
|
+
<h3 class="signature " id="anyof-instance_method">
|
|
610
|
+
|
|
611
|
+
#<strong>anyof</strong>(arg, struct) ⇒ <tt>Boolean</tt>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
</h3><div class="docstring">
|
|
618
|
+
<div class="discussion">
|
|
619
|
+
|
|
620
|
+
<h4 id="label-Your+struct+contains+a+singular+element+that+can+be+found+in+an+array.">Your <strong>struct</strong> contains a singular element that can be found in an array.</h4>
|
|
621
|
+
<ul><li>
|
|
622
|
+
<p><strong>structs</strong> - An array of any mix of things you'd like, EXCEPT other instances of KwargModels or KwargDicts.</p>
|
|
623
|
+
</li><li>
|
|
624
|
+
<p>Will not accept a Proc and must not contain generic datatype symbols.</p>
|
|
625
|
+
</li></ul>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
</div>
|
|
629
|
+
</div>
|
|
630
|
+
<div class="tags">
|
|
631
|
+
|
|
632
|
+
<div class="examples">
|
|
633
|
+
<p class="tag_title">Examples:</p>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
<p class="example_title"><div class='inline'>
|
|
637
|
+
<p>(Called From a KwargDict instance)</p>
|
|
638
|
+
</div></p>
|
|
639
|
+
|
|
640
|
+
<pre class="example code"><code><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:anyof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xx-small</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>x-small</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>large</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='float'>3.2</span><span class='rbracket'>]</span>
|
|
641
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='float'>3.2</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
642
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xx-large</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># => false</span></code></pre>
|
|
643
|
+
|
|
644
|
+
</div>
|
|
645
|
+
|
|
646
|
+
<p class="tag_title">Returns:</p>
|
|
647
|
+
<ul class="return">
|
|
648
|
+
|
|
649
|
+
<li>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
</li>
|
|
657
|
+
|
|
658
|
+
</ul>
|
|
659
|
+
|
|
660
|
+
</div><table class="source_code">
|
|
661
|
+
<tr>
|
|
662
|
+
<td>
|
|
663
|
+
<pre class="lines">
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
63
|
|
667
|
+
64
|
|
668
|
+
65</pre>
|
|
669
|
+
</td>
|
|
670
|
+
<td>
|
|
671
|
+
<pre class="code"><span class="info file"># File 'lib/kdict/kwargdict/kwargtypes.rb', line 63</span>
|
|
672
|
+
|
|
673
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_anyof'>anyof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='rparen'>)</span>
|
|
674
|
+
<span class='id identifier rubyid_struct'>struct</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span>
|
|
675
|
+
<span class='kw'>end</span></pre>
|
|
676
|
+
</td>
|
|
677
|
+
</tr>
|
|
678
|
+
</table>
|
|
679
|
+
</div>
|
|
680
|
+
|
|
681
|
+
<div class="method_details ">
|
|
682
|
+
<h3 class="signature " id="arrayof-instance_method">
|
|
683
|
+
|
|
684
|
+
#<strong>arrayof</strong>(arg, struct, prc = nil) ⇒ <tt>Boolean</tt>
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
</h3><div class="docstring">
|
|
691
|
+
<div class="discussion">
|
|
692
|
+
|
|
693
|
+
<h4 id="label-Your+struct+contains+an+array+of+any+length+but+contain+only+one+datatype.">Your <strong>struct</strong> contains an array of any length but contain only one datatype.</h4>
|
|
694
|
+
<ul><li>
|
|
695
|
+
<p><strong>structs</strong> - Again some of Ruby's built-in types plus Bool: <strong>Numeric</strong>, <strong>Float</strong>, <strong>Integer</strong>, <strong>Bool</strong>, <strong>String</strong>, <strong>Symbol</strong></p>
|
|
696
|
+
</li><li>
|
|
697
|
+
<p>Multi-dimensional arrays will be treated as flattened and all values will still be checked against the given <strong>struct</strong></p>
|
|
698
|
+
</li><li>
|
|
699
|
+
<p>Can accept a Proc that must return true for ALL values in the array.</p>
|
|
700
|
+
</li></ul>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
</div>
|
|
704
|
+
</div>
|
|
705
|
+
<div class="tags">
|
|
706
|
+
|
|
707
|
+
<div class="examples">
|
|
708
|
+
<p class="tag_title">Examples:</p>
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
<p class="example_title"><div class='inline'>
|
|
712
|
+
<p>(Called From a KwargDict instance)</p>
|
|
713
|
+
</div></p>
|
|
714
|
+
|
|
715
|
+
<pre class="example code"><code><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>Strings</span>
|
|
716
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>Strings</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>></span> <span class='int'>2</span> <span class='rbrace'>}</span>
|
|
717
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>This</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>will</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>return</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>true</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
718
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>This</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>is</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>still</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>false</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => false</span></code></pre>
|
|
719
|
+
|
|
720
|
+
</div>
|
|
721
|
+
|
|
722
|
+
<p class="tag_title">Returns:</p>
|
|
723
|
+
<ul class="return">
|
|
724
|
+
|
|
725
|
+
<li>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
</li>
|
|
733
|
+
|
|
734
|
+
</ul>
|
|
735
|
+
|
|
736
|
+
</div><table class="source_code">
|
|
737
|
+
<tr>
|
|
738
|
+
<td>
|
|
739
|
+
<pre class="lines">
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
48
|
|
743
|
+
49
|
|
744
|
+
50
|
|
745
|
+
51
|
|
746
|
+
52</pre>
|
|
747
|
+
</td>
|
|
748
|
+
<td>
|
|
749
|
+
<pre class="code"><span class="info file"># File 'lib/kdict/kwargdict/kwargtypes.rb', line 48</span>
|
|
750
|
+
|
|
751
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_arrayof'>arrayof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='comma'>,</span> <span class='id identifier rubyid_prc'>prc</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
752
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
|
|
753
|
+
<span class='id identifier rubyid_prc'>prc</span> <span class='op'>||=</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lbrace'>{</span><span class='kw'>true</span><span class='rbrace'>}</span>
|
|
754
|
+
<span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_ele'>ele</span><span class='op'>|</span> <span class='id identifier rubyid_ele'>ele</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='id identifier rubyid_struct'>struct</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_prc'>prc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_ele'>ele</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
755
|
+
<span class='kw'>end</span></pre>
|
|
756
|
+
</td>
|
|
757
|
+
</tr>
|
|
758
|
+
</table>
|
|
759
|
+
</div>
|
|
760
|
+
|
|
761
|
+
<div class="method_details ">
|
|
762
|
+
<h3 class="signature " id="formof-instance_method">
|
|
763
|
+
|
|
764
|
+
#<strong>formof</strong>(arg, struct, prc = nil) ⇒ <tt>Object</tt>
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
</h3><div class="docstring">
|
|
771
|
+
<div class="discussion">
|
|
772
|
+
|
|
773
|
+
<h4 id="label-Your+struct+contains+an+array+of+exact+length-2C+you+expect+each+element+to+be+contained+in+a+specific+order+and+be+a+generic+datatype">Your <strong>struct</strong> contains an array of exact length, you expect each element to be contained in a specific order and be a generic datatype</h4>
|
|
774
|
+
<ul><li>
|
|
775
|
+
<p><strong>structs</strong> - An array of set length containing generic datatype keywords <strong>Numeric</strong>, <strong>Float</strong>, <strong>Integer</strong>, <strong>Bool</strong>, <strong>String</strong>, <strong>Symbol</strong>, in a specific order. Will return false if user input appears out of order with respect to the <strong>struct</strong>.</p>
|
|
776
|
+
</li><li>
|
|
777
|
+
<p>Can accept a Proc that must return true for ALL values in the array.</p>
|
|
778
|
+
</li></ul>
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
</div>
|
|
782
|
+
</div>
|
|
783
|
+
<div class="tags">
|
|
784
|
+
|
|
785
|
+
<div class="examples">
|
|
786
|
+
<p class="tag_title">Examples:</p>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
<p class="example_title"><div class='inline'>
|
|
790
|
+
<p>(Called From a KwargDict instance)</p>
|
|
791
|
+
</div></p>
|
|
792
|
+
|
|
793
|
+
<pre class="example code"><code><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span><span class='comma'>,</span> <span class='const'>Float</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span>
|
|
794
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_n'>n</span><span class='op'>|</span> <span class='id identifier rubyid_n'>n</span><span class='period'>.</span><span class='id identifier rubyid_between?'>between?</span><span class='lparen'>(</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>3</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
795
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='kw'>false</span><span class='comma'>,</span> <span class='float'>3.1</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Holly Dolly</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
796
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='kw'>false</span><span class='comma'>,</span> <span class='float'>3.1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => false
|
|
797
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Holly Dolly</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='float'>3.1</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => false
|
|
798
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='int'>2</span><span class='comma'>,</span> <span class='float'>1.1</span><span class='comma'>,</span> <span class='float'>1.2</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
799
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>1.1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='float'>1.4</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># => false</span></code></pre>
|
|
800
|
+
|
|
801
|
+
</div>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</div><table class="source_code">
|
|
805
|
+
<tr>
|
|
806
|
+
<td>
|
|
807
|
+
<pre class="lines">
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
104
|
|
811
|
+
105
|
|
812
|
+
106
|
|
813
|
+
107
|
|
814
|
+
108</pre>
|
|
815
|
+
</td>
|
|
816
|
+
<td>
|
|
817
|
+
<pre class="code"><span class="info file"># File 'lib/kdict/kwargdict/kwargtypes.rb', line 104</span>
|
|
818
|
+
|
|
819
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_formof'>formof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='comma'>,</span> <span class='id identifier rubyid_prc'>prc</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
820
|
+
<span class='id identifier rubyid_prc'>prc</span> <span class='op'>||=</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span><span class='kw'>true</span><span class='rbrace'>}</span>
|
|
821
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
|
|
822
|
+
<span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_zip'>zip</span><span class='lparen'>(</span><span class='id identifier rubyid_struct'>struct</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_prc'>prc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='op'>?</span> <span class='lparen'>(</span><span class='kw'>return</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='lparen'>(</span><span class='kw'>return</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
823
|
+
<span class='kw'>end</span></pre>
|
|
824
|
+
</td>
|
|
825
|
+
</tr>
|
|
826
|
+
</table>
|
|
827
|
+
</div>
|
|
828
|
+
|
|
829
|
+
<div class="method_details ">
|
|
830
|
+
<h3 class="signature " id="kwargsof-instance_method">
|
|
831
|
+
|
|
832
|
+
#<strong>kwargsof</strong>(arg, struct) ⇒ <tt>Object</tt>
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
</h3><div class="docstring">
|
|
839
|
+
<div class="discussion">
|
|
840
|
+
|
|
841
|
+
<h4 id="label-Your+struct+contains+a+hash+that+corresponds+to+another+KwargDict">Your <strong>struct</strong> contains a hash that corresponds to another KwargDict</h4>
|
|
842
|
+
<ul><li>
|
|
843
|
+
<p>**<strong>structs</strong>** - Can only be another KwargDict instance.</p>
|
|
844
|
+
</li><li>
|
|
845
|
+
<p>Will not accept a Proc</p>
|
|
846
|
+
</li><li>
|
|
847
|
+
<p>Input hash need not contain every <strong>kword</strong> from the nested KwargDict to return true</p>
|
|
848
|
+
</li><li>
|
|
849
|
+
<p>Will return true only if every key-arg pair in input hash is valid in nested KwargDict</p>
|
|
850
|
+
</li></ul>
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
</div>
|
|
854
|
+
</div>
|
|
855
|
+
<div class="tags">
|
|
856
|
+
|
|
857
|
+
<div class="examples">
|
|
858
|
+
<p class="tag_title">Examples:</p>
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
<p class="example_title"><div class='inline'>
|
|
862
|
+
<p>(Called From a KwargDict instance)</p>
|
|
863
|
+
</div></p>
|
|
864
|
+
|
|
865
|
+
<pre class="example code"><code><span class='id identifier rubyid_another_dict'>another_dict</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:one</span><span class='comma'>,</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:two</span><span class='comma'>,</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:three</span><span class='comma'>,</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
866
|
+
<span class='lbracket'>[</span><span class='symbol'>:and</span><span class='comma'>,</span> <span class='symbol'>:anyof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>partridge</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>in</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>pear</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tree</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
867
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:kwargsof</span><span class='comma'>,</span> <span class='id identifier rubyid_another_dict'>another_dict</span>
|
|
868
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>one:</span><span class='float'>3.1</span><span class='comma'>,</span> <span class='label'>three:</span><span class='kw'>false</span><span class='comma'>,</span> <span class='label'>and:</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>in</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
869
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>two:</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>this</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>works</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>four:</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>without this</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'># => false
|
|
870
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>two:</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>see?</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'># => true</span></code></pre>
|
|
871
|
+
|
|
872
|
+
</div>
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
</div><table class="source_code">
|
|
876
|
+
<tr>
|
|
877
|
+
<td>
|
|
878
|
+
<pre class="lines">
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
123
|
|
882
|
+
124
|
|
883
|
+
125
|
|
884
|
+
126</pre>
|
|
885
|
+
</td>
|
|
886
|
+
<td>
|
|
887
|
+
<pre class="code"><span class="info file"># File 'lib/kdict/kwargdict/kwargtypes.rb', line 123</span>
|
|
888
|
+
|
|
889
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_kwargsof'>kwargsof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='rparen'>)</span>
|
|
890
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_sub_kword'>sub_kword</span><span class='op'>|</span> <span class='id identifier rubyid_struct'>struct</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='id identifier rubyid_sub_kword'>sub_kword</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
891
|
+
<span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_sub_word'>sub_word</span><span class='comma'>,</span> <span class='id identifier rubyid_sub_arg'>sub_arg</span><span class='op'>|</span> <span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_sub_arg'>sub_arg</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_struct'>struct</span><span class='lbracket'>[</span><span class='id identifier rubyid_sub_word'>sub_word</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_splay'>splay</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
892
|
+
<span class='kw'>end</span></pre>
|
|
893
|
+
</td>
|
|
894
|
+
</tr>
|
|
895
|
+
</table>
|
|
896
|
+
</div>
|
|
897
|
+
|
|
898
|
+
<div class="method_details ">
|
|
899
|
+
<h3 class="signature " id="typeof-instance_method">
|
|
900
|
+
|
|
901
|
+
#<strong>typeof</strong>(arg, struct, prc = nil) ⇒ <tt>Boolean</tt>
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
</h3><div class="docstring">
|
|
908
|
+
<div class="discussion">
|
|
909
|
+
|
|
910
|
+
<h4 id="label-Your+struct+contains+a+singular+value+of+exactly+one+datatype.">Your <strong>struct</strong> contains a singular value of exactly one datatype.</h4>
|
|
911
|
+
<ul><li>
|
|
912
|
+
<p><strong>structs</strong> - Some of Ruby's built-in types plus <strong>Bool</strong>, an added datatype for true/false collectively. Acceptable <strong>struct</strong> arguments then, are: <strong>Numeric</strong>, <strong>Float</strong>, <strong>Integer</strong>, <strong>Bool</strong>, <strong>String</strong>, <strong>Symbol</strong></p>
|
|
913
|
+
</li><li>
|
|
914
|
+
<p>Can accept a Proc that must also return true for successful validation</p>
|
|
915
|
+
</li></ul>
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
</div>
|
|
919
|
+
</div>
|
|
920
|
+
<div class="tags">
|
|
921
|
+
|
|
922
|
+
<div class="examples">
|
|
923
|
+
<p class="tag_title">Examples:</p>
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
<p class="example_title"><div class='inline'>
|
|
927
|
+
<p>(Called From a KwargDict instance)</p>
|
|
928
|
+
</div></p>
|
|
929
|
+
|
|
930
|
+
<pre class="example code"><code><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span>
|
|
931
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>Float</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_n'>n</span><span class='op'>|</span> <span class='id identifier rubyid_n'>n</span> <span class='op'>></span> <span class='float'>5.3</span> <span class='rbrace'>}</span>
|
|
932
|
+
<span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='comment'># => true
|
|
933
|
+
</span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='float'>2.1</span><span class='rparen'>)</span> <span class='comment'># => false</span></code></pre>
|
|
934
|
+
|
|
935
|
+
</div>
|
|
936
|
+
|
|
937
|
+
<p class="tag_title">Returns:</p>
|
|
938
|
+
<ul class="return">
|
|
939
|
+
|
|
940
|
+
<li>
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
</li>
|
|
948
|
+
|
|
949
|
+
</ul>
|
|
950
|
+
|
|
951
|
+
</div><table class="source_code">
|
|
952
|
+
<tr>
|
|
953
|
+
<td>
|
|
954
|
+
<pre class="lines">
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
30
|
|
958
|
+
31
|
|
959
|
+
32
|
|
960
|
+
33
|
|
961
|
+
34</pre>
|
|
962
|
+
</td>
|
|
963
|
+
<td>
|
|
964
|
+
<pre class="code"><span class="info file"># File 'lib/kdict/kwargdict/kwargtypes.rb', line 30</span>
|
|
965
|
+
|
|
966
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_typeof'>typeof</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_struct'>struct</span><span class='comma'>,</span> <span class='id identifier rubyid_prc'>prc</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
967
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='lbracket'>[</span><span class='const'>Hash</span><span class='comma'>,</span> <span class='const'>Array</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_type'>type</span><span class='op'>|</span> <span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
968
|
+
<span class='id identifier rubyid_prc'>prc</span> <span class='op'>||=</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lbrace'>{</span><span class='kw'>true</span><span class='rbrace'>}</span>
|
|
969
|
+
<span class='id identifier rubyid_arg'>arg</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='id identifier rubyid_struct'>struct</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_prc'>prc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span>
|
|
970
|
+
<span class='kw'>end</span></pre>
|
|
971
|
+
</td>
|
|
972
|
+
</tr>
|
|
973
|
+
</table>
|
|
974
|
+
</div>
|
|
975
|
+
|
|
976
|
+
</div>
|
|
977
|
+
|
|
978
|
+
</div>
|
|
979
|
+
|
|
980
|
+
<div id="footer">
|
|
981
|
+
Generated on Thu Apr 11 21:45:30 2019 by
|
|
982
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
983
|
+
0.9.19 (ruby-2.6.2).
|
|
984
|
+
</div>
|
|
985
|
+
|
|
986
|
+
</div>
|
|
987
|
+
</body>
|
|
988
|
+
</html>
|