schemacop 1.0.2 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +2 -1
- data/.rubocop.yml +59 -1
- data/CHANGELOG.md +10 -0
- data/README.md +389 -199
- data/Rakefile +2 -0
- data/VERSION +1 -1
- data/doc/Schemacop.html +41 -130
- data/doc/Schemacop/ArrayValidator.html +329 -0
- data/doc/Schemacop/BooleanValidator.html +145 -0
- data/doc/Schemacop/Collector.html +535 -0
- data/doc/Schemacop/Exceptions.html +39 -39
- data/doc/Schemacop/Exceptions/InvalidSchemaError.html +124 -0
- data/doc/Schemacop/Exceptions/ValidationError.html +124 -0
- data/doc/Schemacop/FieldNode.html +409 -0
- data/doc/Schemacop/FloatValidator.html +158 -0
- data/doc/Schemacop/HashValidator.html +263 -0
- data/doc/Schemacop/IntegerValidator.html +158 -0
- data/doc/Schemacop/NilValidator.html +145 -0
- data/doc/Schemacop/Node.html +1426 -0
- data/doc/Schemacop/NodeResolver.html +242 -0
- data/doc/Schemacop/NodeSupportingField.html +590 -0
- data/doc/Schemacop/NodeSupportingType.html +614 -0
- data/doc/Schemacop/NodeWithBlock.html +289 -0
- data/doc/Schemacop/NumberValidator.html +232 -0
- data/doc/Schemacop/ObjectValidator.html +288 -0
- data/doc/Schemacop/RootNode.html +171 -0
- data/doc/Schemacop/Schema.html +697 -0
- data/doc/Schemacop/StringValidator.html +295 -0
- data/doc/ScopedEnv.html +351 -0
- data/doc/_index.html +190 -47
- data/doc/class_list.html +24 -31
- data/doc/css/full_list.css +32 -31
- data/doc/css/style.css +244 -91
- data/doc/file.README.html +428 -232
- data/doc/file_list.html +26 -30
- data/doc/frames.html +7 -16
- data/doc/index.html +428 -232
- data/doc/inheritance.graphml +524 -0
- data/doc/inheritance.pdf +825 -0
- data/doc/js/app.js +106 -77
- data/doc/js/full_list.js +170 -135
- data/doc/method_list.html +494 -38
- data/doc/top-level-namespace.html +36 -36
- data/lib/schemacop.rb +22 -7
- data/lib/schemacop/collector.rb +34 -0
- data/lib/schemacop/exceptions.rb +2 -8
- data/lib/schemacop/field_node.rb +26 -0
- data/lib/schemacop/node.rb +127 -0
- data/lib/schemacop/node_resolver.rb +14 -0
- data/lib/schemacop/node_supporting_field.rb +62 -0
- data/lib/schemacop/node_supporting_type.rb +112 -0
- data/lib/schemacop/node_with_block.rb +16 -0
- data/lib/schemacop/root_node.rb +4 -0
- data/lib/schemacop/schema.rb +61 -0
- data/lib/schemacop/scoped_env.rb +18 -0
- data/lib/schemacop/validator/array_validator.rb +30 -0
- data/lib/schemacop/validator/boolean_validator.rb +5 -0
- data/lib/schemacop/validator/float_validator.rb +5 -0
- data/lib/schemacop/validator/hash_validator.rb +18 -0
- data/lib/schemacop/validator/integer_validator.rb +5 -0
- data/lib/schemacop/validator/nil_validator.rb +5 -0
- data/lib/schemacop/validator/number_validator.rb +19 -0
- data/lib/schemacop/validator/object_validator.rb +21 -0
- data/lib/schemacop/validator/string_validator.rb +37 -0
- data/schemacop.gemspec +7 -5
- data/test/custom_check_test.rb +86 -0
- data/test/custom_if_test.rb +95 -0
- data/test/nil_dis_allow_test.rb +41 -0
- data/test/short_forms_test.rb +316 -0
- data/test/test_helper.rb +6 -0
- data/test/types_test.rb +83 -0
- data/test/validator_array_test.rb +97 -0
- data/test/validator_boolean_test.rb +15 -0
- data/test/validator_float_test.rb +57 -0
- data/test/validator_hash_test.rb +71 -0
- data/test/validator_integer_test.rb +46 -0
- data/test/validator_nil_test.rb +13 -0
- data/test/validator_number_test.rb +60 -0
- data/test/validator_object_test.rb +87 -0
- data/test/validator_string_test.rb +76 -0
- metadata +78 -14
- data/doc/Schemacop/Exceptions/Base.html +0 -127
- data/doc/Schemacop/Exceptions/InvalidSchema.html +0 -141
- data/doc/Schemacop/Exceptions/Validation.html +0 -142
- data/doc/Schemacop/MethodValidation.html +0 -120
- data/doc/Schemacop/MethodValidation/ClassMethods.html +0 -196
- data/doc/Schemacop/Validator.html +0 -254
- data/lib/schemacop/validator.rb +0 -145
- data/test/schemacop_validator_test.rb +0 -257
|
@@ -0,0 +1,697 @@
|
|
|
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: Schemacop::Schema
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
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 = "Schemacop::Schema";
|
|
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="../Schemacop.html" title="Schemacop (module)">Schemacop</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Schema</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: Schemacop::Schema
|
|
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">Schemacop::Schema</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/schemacop/schema.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<h2>
|
|
111
|
+
Instance Method Summary
|
|
112
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
113
|
+
</h2>
|
|
114
|
+
|
|
115
|
+
<ul class="summary">
|
|
116
|
+
|
|
117
|
+
<li class="public ">
|
|
118
|
+
<span class="summary_signature">
|
|
119
|
+
|
|
120
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(*args, &block) ⇒ Schema </a>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
</span>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
<span class="note title constructor">constructor</span>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<span class="summary_desc"><div class='inline'><p>Create a new Schema.</p>
|
|
137
|
+
</div></span>
|
|
138
|
+
|
|
139
|
+
</li>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<li class="public ">
|
|
143
|
+
<span class="summary_signature">
|
|
144
|
+
|
|
145
|
+
<a href="#invalid%3F-instance_method" title="#invalid? (instance method)">#<strong>invalid?</strong>(data) ⇒ Boolean </a>
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
</span>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<span class="summary_desc"><div class='inline'><p>Query data validity.</p>
|
|
160
|
+
</div></span>
|
|
161
|
+
|
|
162
|
+
</li>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<li class="public ">
|
|
166
|
+
<span class="summary_signature">
|
|
167
|
+
|
|
168
|
+
<a href="#valid%3F-instance_method" title="#valid? (instance method)">#<strong>valid?</strong>(data) ⇒ Boolean </a>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</span>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<span class="summary_desc"><div class='inline'><p>Query data validity.</p>
|
|
183
|
+
</div></span>
|
|
184
|
+
|
|
185
|
+
</li>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<li class="public ">
|
|
189
|
+
<span class="summary_signature">
|
|
190
|
+
|
|
191
|
+
<a href="#validate-instance_method" title="#validate (instance method)">#<strong>validate</strong>(data) ⇒ Schemacop::Collector </a>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
</span>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<span class="summary_desc"><div class='inline'><p>Validate data for the defined Schema.</p>
|
|
206
|
+
</div></span>
|
|
207
|
+
|
|
208
|
+
</li>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
<li class="public ">
|
|
212
|
+
<span class="summary_signature">
|
|
213
|
+
|
|
214
|
+
<a href="#validate!-instance_method" title="#validate! (instance method)">#<strong>validate!</strong>(data) ⇒ Object </a>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
</span>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<span class="summary_desc"><div class='inline'><p>Validate data for the defined Schema.</p>
|
|
229
|
+
</div></span>
|
|
230
|
+
|
|
231
|
+
</li>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
</ul>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<div id="constructor_details" class="method_details_list">
|
|
238
|
+
<h2>Constructor Details</h2>
|
|
239
|
+
|
|
240
|
+
<div class="method_details first">
|
|
241
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
242
|
+
|
|
243
|
+
#<strong>initialize</strong>(*args, &block) ⇒ <tt><span class='object_link'><a href="" title="Schemacop::Schema (class)">Schema</a></span></tt>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
</h3><div class="docstring">
|
|
250
|
+
<div class="discussion">
|
|
251
|
+
<p>Create a new Schema</p>
|
|
252
|
+
|
|
253
|
+
<p>For detailed usage, please refer to README.md in the root of this project.</p>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
</div>
|
|
257
|
+
</div>
|
|
258
|
+
<div class="tags">
|
|
259
|
+
<p class="tag_title">Parameters:</p>
|
|
260
|
+
<ul class="param">
|
|
261
|
+
|
|
262
|
+
<li>
|
|
263
|
+
|
|
264
|
+
<span class='name'>args</span>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
—
|
|
272
|
+
<div class='inline'><p>An array of arguments to apply to the root node of the
|
|
273
|
+
Schema.</p>
|
|
274
|
+
</div>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
<li>
|
|
279
|
+
|
|
280
|
+
<span class='name'>block</span>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
<span class='type'></span>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
—
|
|
288
|
+
<div class='inline'><p>A block with further Schema specification.</p>
|
|
289
|
+
</div>
|
|
290
|
+
|
|
291
|
+
</li>
|
|
292
|
+
|
|
293
|
+
</ul>
|
|
294
|
+
|
|
295
|
+
<p class="tag_title">Raises:</p>
|
|
296
|
+
<ul class="raise">
|
|
297
|
+
|
|
298
|
+
<li>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<span class='type'>(<tt><span class='object_link'><a href="Exceptions/InvalidSchemaError.html" title="Schemacop::Exceptions::InvalidSchemaError (class)">Schemacop::Exceptions::InvalidSchemaError</a></span></tt>)</span>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
—
|
|
306
|
+
<div class='inline'><p>If the Schema defined
|
|
307
|
+
is invalid.</p>
|
|
308
|
+
</div>
|
|
309
|
+
|
|
310
|
+
</li>
|
|
311
|
+
|
|
312
|
+
</ul>
|
|
313
|
+
|
|
314
|
+
</div><table class="source_code">
|
|
315
|
+
<tr>
|
|
316
|
+
<td>
|
|
317
|
+
<pre class="lines">
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
12
|
|
321
|
+
13
|
|
322
|
+
14
|
|
323
|
+
15
|
|
324
|
+
16</pre>
|
|
325
|
+
</td>
|
|
326
|
+
<td>
|
|
327
|
+
<pre class="code"><span class="info file"># File 'lib/schemacop/schema.rb', line 12</span>
|
|
328
|
+
|
|
329
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
330
|
+
<span class='ivar'>@root</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="HashValidator.html" title="Schemacop::HashValidator (class)">HashValidator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NodeSupportingField.html#initialize-instance_method" title="Schemacop::NodeSupportingField#initialize (method)">new</a></span></span> <span class='kw'>do</span>
|
|
331
|
+
<span class='id identifier rubyid_req'>req</span> <span class='symbol'>:root</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span>
|
|
332
|
+
<span class='kw'>end</span>
|
|
333
|
+
<span class='kw'>end</span></pre>
|
|
334
|
+
</td>
|
|
335
|
+
</tr>
|
|
336
|
+
</table>
|
|
337
|
+
</div>
|
|
338
|
+
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<div id="instance_method_details" class="method_details_list">
|
|
343
|
+
<h2>Instance Method Details</h2>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<div class="method_details first">
|
|
347
|
+
<h3 class="signature first" id="invalid?-instance_method">
|
|
348
|
+
|
|
349
|
+
#<strong>invalid?</strong>(data) ⇒ <tt>Boolean</tt>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</h3><div class="docstring">
|
|
356
|
+
<div class="discussion">
|
|
357
|
+
<p>Query data validity</p>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
</div>
|
|
361
|
+
</div>
|
|
362
|
+
<div class="tags">
|
|
363
|
+
<p class="tag_title">Parameters:</p>
|
|
364
|
+
<ul class="param">
|
|
365
|
+
|
|
366
|
+
<li>
|
|
367
|
+
|
|
368
|
+
<span class='name'>data</span>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<span class='type'></span>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
—
|
|
376
|
+
<div class='inline'><p>The data to validate.</p>
|
|
377
|
+
</div>
|
|
378
|
+
|
|
379
|
+
</li>
|
|
380
|
+
|
|
381
|
+
</ul>
|
|
382
|
+
|
|
383
|
+
<p class="tag_title">Returns:</p>
|
|
384
|
+
<ul class="return">
|
|
385
|
+
|
|
386
|
+
<li>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
—
|
|
394
|
+
<div class='inline'><p>True if data is invalid, false otherwise.</p>
|
|
395
|
+
</div>
|
|
396
|
+
|
|
397
|
+
</li>
|
|
398
|
+
|
|
399
|
+
</ul>
|
|
400
|
+
|
|
401
|
+
</div><table class="source_code">
|
|
402
|
+
<tr>
|
|
403
|
+
<td>
|
|
404
|
+
<pre class="lines">
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
30
|
|
408
|
+
31
|
|
409
|
+
32</pre>
|
|
410
|
+
</td>
|
|
411
|
+
<td>
|
|
412
|
+
<pre class="code"><span class="info file"># File 'lib/schemacop/schema.rb', line 30</span>
|
|
413
|
+
|
|
414
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_invalid?'>invalid?</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
415
|
+
<span class='op'>!</span><span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
416
|
+
<span class='kw'>end</span></pre>
|
|
417
|
+
</td>
|
|
418
|
+
</tr>
|
|
419
|
+
</table>
|
|
420
|
+
</div>
|
|
421
|
+
|
|
422
|
+
<div class="method_details ">
|
|
423
|
+
<h3 class="signature " id="valid?-instance_method">
|
|
424
|
+
|
|
425
|
+
#<strong>valid?</strong>(data) ⇒ <tt>Boolean</tt>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
</h3><div class="docstring">
|
|
432
|
+
<div class="discussion">
|
|
433
|
+
<p>Query data validity</p>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
</div>
|
|
437
|
+
</div>
|
|
438
|
+
<div class="tags">
|
|
439
|
+
<p class="tag_title">Parameters:</p>
|
|
440
|
+
<ul class="param">
|
|
441
|
+
|
|
442
|
+
<li>
|
|
443
|
+
|
|
444
|
+
<span class='name'>data</span>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
<span class='type'></span>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
—
|
|
452
|
+
<div class='inline'><p>The data to validate.</p>
|
|
453
|
+
</div>
|
|
454
|
+
|
|
455
|
+
</li>
|
|
456
|
+
|
|
457
|
+
</ul>
|
|
458
|
+
|
|
459
|
+
<p class="tag_title">Returns:</p>
|
|
460
|
+
<ul class="return">
|
|
461
|
+
|
|
462
|
+
<li>
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
—
|
|
470
|
+
<div class='inline'><p>True if the data is valid, false otherwise.</p>
|
|
471
|
+
</div>
|
|
472
|
+
|
|
473
|
+
</li>
|
|
474
|
+
|
|
475
|
+
</ul>
|
|
476
|
+
|
|
477
|
+
</div><table class="source_code">
|
|
478
|
+
<tr>
|
|
479
|
+
<td>
|
|
480
|
+
<pre class="lines">
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
22
|
|
484
|
+
23
|
|
485
|
+
24</pre>
|
|
486
|
+
</td>
|
|
487
|
+
<td>
|
|
488
|
+
<pre class="code"><span class="info file"># File 'lib/schemacop/schema.rb', line 22</span>
|
|
489
|
+
|
|
490
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
491
|
+
<span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_valid?'>valid?</span>
|
|
492
|
+
<span class='kw'>end</span></pre>
|
|
493
|
+
</td>
|
|
494
|
+
</tr>
|
|
495
|
+
</table>
|
|
496
|
+
</div>
|
|
497
|
+
|
|
498
|
+
<div class="method_details ">
|
|
499
|
+
<h3 class="signature " id="validate-instance_method">
|
|
500
|
+
|
|
501
|
+
#<strong>validate</strong>(data) ⇒ <tt><span class='object_link'><a href="Collector.html" title="Schemacop::Collector (class)">Schemacop::Collector</a></span></tt>
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
</h3><div class="docstring">
|
|
508
|
+
<div class="discussion">
|
|
509
|
+
<p>Validate data for the defined Schema</p>
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
</div>
|
|
513
|
+
</div>
|
|
514
|
+
<div class="tags">
|
|
515
|
+
<p class="tag_title">Parameters:</p>
|
|
516
|
+
<ul class="param">
|
|
517
|
+
|
|
518
|
+
<li>
|
|
519
|
+
|
|
520
|
+
<span class='name'>data</span>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
<span class='type'></span>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
—
|
|
528
|
+
<div class='inline'><p>The data to validate.</p>
|
|
529
|
+
</div>
|
|
530
|
+
|
|
531
|
+
</li>
|
|
532
|
+
|
|
533
|
+
</ul>
|
|
534
|
+
|
|
535
|
+
<p class="tag_title">Returns:</p>
|
|
536
|
+
<ul class="return">
|
|
537
|
+
|
|
538
|
+
<li>
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
<span class='type'>(<tt><span class='object_link'><a href="Collector.html" title="Schemacop::Collector (class)">Schemacop::Collector</a></span></tt>)</span>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
—
|
|
546
|
+
<div class='inline'><p>The object that collected errors
|
|
547
|
+
throughout the validation.</p>
|
|
548
|
+
</div>
|
|
549
|
+
|
|
550
|
+
</li>
|
|
551
|
+
|
|
552
|
+
</ul>
|
|
553
|
+
|
|
554
|
+
</div><table class="source_code">
|
|
555
|
+
<tr>
|
|
556
|
+
<td>
|
|
557
|
+
<pre class="lines">
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
39
|
|
561
|
+
40
|
|
562
|
+
41
|
|
563
|
+
42
|
|
564
|
+
43</pre>
|
|
565
|
+
</td>
|
|
566
|
+
<td>
|
|
567
|
+
<pre class="code"><span class="info file"># File 'lib/schemacop/schema.rb', line 39</span>
|
|
568
|
+
|
|
569
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
570
|
+
<span class='id identifier rubyid_collector'>collector</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Collector.html" title="Schemacop::Collector (class)">Collector</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Collector.html#initialize-instance_method" title="Schemacop::Collector#initialize (method)">new</a></span></span>
|
|
571
|
+
<span class='ivar'>@root</span><span class='period'>.</span><span class='id identifier rubyid_fields'>fields</span><span class='lbracket'>[</span><span class='symbol'>:root</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>root:</span> <span class='id identifier rubyid_data'>data</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_collector'>collector</span><span class='rparen'>)</span>
|
|
572
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_collector'>collector</span>
|
|
573
|
+
<span class='kw'>end</span></pre>
|
|
574
|
+
</td>
|
|
575
|
+
</tr>
|
|
576
|
+
</table>
|
|
577
|
+
</div>
|
|
578
|
+
|
|
579
|
+
<div class="method_details ">
|
|
580
|
+
<h3 class="signature " id="validate!-instance_method">
|
|
581
|
+
|
|
582
|
+
#<strong>validate!</strong>(data) ⇒ <tt>Object</tt>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
</h3><div class="docstring">
|
|
589
|
+
<div class="discussion">
|
|
590
|
+
<p>Validate data for the defined Schema</p>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
</div>
|
|
594
|
+
</div>
|
|
595
|
+
<div class="tags">
|
|
596
|
+
<p class="tag_title">Parameters:</p>
|
|
597
|
+
<ul class="param">
|
|
598
|
+
|
|
599
|
+
<li>
|
|
600
|
+
|
|
601
|
+
<span class='name'>data</span>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
<span class='type'></span>
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
—
|
|
609
|
+
<div class='inline'><p>The data to validate.</p>
|
|
610
|
+
</div>
|
|
611
|
+
|
|
612
|
+
</li>
|
|
613
|
+
|
|
614
|
+
</ul>
|
|
615
|
+
|
|
616
|
+
<p class="tag_title">Returns:</p>
|
|
617
|
+
<ul class="return">
|
|
618
|
+
|
|
619
|
+
<li>
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
<span class='type'></span>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
<div class='inline'><p>nil</p>
|
|
628
|
+
</div>
|
|
629
|
+
|
|
630
|
+
</li>
|
|
631
|
+
|
|
632
|
+
</ul>
|
|
633
|
+
<p class="tag_title">Raises:</p>
|
|
634
|
+
<ul class="raise">
|
|
635
|
+
|
|
636
|
+
<li>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
<span class='type'>(<tt><span class='object_link'><a href="Exceptions/ValidationError.html" title="Schemacop::Exceptions::ValidationError (class)">Schemacop::Exceptions::ValidationError</a></span></tt>)</span>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
—
|
|
644
|
+
<div class='inline'><p>If the data is invalid,
|
|
645
|
+
this exception is thrown.</p>
|
|
646
|
+
</div>
|
|
647
|
+
|
|
648
|
+
</li>
|
|
649
|
+
|
|
650
|
+
</ul>
|
|
651
|
+
|
|
652
|
+
</div><table class="source_code">
|
|
653
|
+
<tr>
|
|
654
|
+
<td>
|
|
655
|
+
<pre class="lines">
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
51
|
|
659
|
+
52
|
|
660
|
+
53
|
|
661
|
+
54
|
|
662
|
+
55
|
|
663
|
+
56
|
|
664
|
+
57
|
|
665
|
+
58
|
|
666
|
+
59</pre>
|
|
667
|
+
</td>
|
|
668
|
+
<td>
|
|
669
|
+
<pre class="code"><span class="info file"># File 'lib/schemacop/schema.rb', line 51</span>
|
|
670
|
+
|
|
671
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_validate!'>validate!</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
672
|
+
<span class='id identifier rubyid_collector'>collector</span> <span class='op'>=</span> <span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
673
|
+
|
|
674
|
+
<span class='kw'>unless</span> <span class='id identifier rubyid_collector'>collector</span><span class='period'>.</span><span class='id identifier rubyid_valid?'>valid?</span>
|
|
675
|
+
<span class='id identifier rubyid_fail'>fail</span> <span class='const'><span class='object_link'><a href="Exceptions.html" title="Schemacop::Exceptions (module)">Exceptions</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Exceptions/ValidationError.html" title="Schemacop::Exceptions::ValidationError (class)">ValidationError</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_collector'>collector</span><span class='period'>.</span><span class='id identifier rubyid_exception_message'>exception_message</span>
|
|
676
|
+
<span class='kw'>end</span>
|
|
677
|
+
|
|
678
|
+
<span class='kw'>return</span> <span class='kw'>nil</span>
|
|
679
|
+
<span class='kw'>end</span></pre>
|
|
680
|
+
</td>
|
|
681
|
+
</tr>
|
|
682
|
+
</table>
|
|
683
|
+
</div>
|
|
684
|
+
|
|
685
|
+
</div>
|
|
686
|
+
|
|
687
|
+
</div>
|
|
688
|
+
|
|
689
|
+
<div id="footer">
|
|
690
|
+
Generated on Mon May 15 17:46:05 2017 by
|
|
691
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
692
|
+
0.9.9 (ruby-2.3.1).
|
|
693
|
+
</div>
|
|
694
|
+
|
|
695
|
+
</div>
|
|
696
|
+
</body>
|
|
697
|
+
</html>
|