Debian Codegraph @

doc-api/classes/Kwalify/Validator.html

raw
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <title>Class: Kwalify::Validator</title>
9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10 <meta http-equiv="Content-Script-Type" content="text/javascript" />
11 <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12 <script type="text/javascript">
13 // <![CDATA[
14
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17 }
18
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
24 else
25 return false;
26
27 elemStyle = elem.style;
28
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
31 } else {
32 elemStyle.display = "none"
33 }
34
35 return true;
36 }
37
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
41 // ]]>
42 </script>
43
44 </head>
45 <body>
46
47
48
49 <div id="classHeader">
50 <table class="header-table">
51 <tr class="top-aligned-row">
52 <td><strong>Class</strong></td>
53 <td class="class-name-in-header">Kwalify::Validator</td>
54 </tr>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
57 <td>
58 <a href="../../files/kwalify/validator_rb.html">
59 kwalify/validator.rb
60 </a>
61 <br />
62 </td>
63 </tr>
64
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
67 <td>
68 Object
69 </td>
70 </tr>
71 </table>
72 </div>
73 <!-- banner header -->
74
75 <div id="bodyContent">
76
77
78
79 <div id="contextContent">
80
81 <div id="description">
82 <p>
83 <a href="Validator.html#M000138">validate</a> YAML document
84 </p>
85 <p>
86 ex1. <a href="Validator.html#M000138">validate</a> yaml document
87 </p>
88 <pre>
89 schema = YAML.load_file('schema.yaml')
90 validator = Kwalify::Validator.new(schema)
91 document = YAML.load_file('document.yaml')
92 erros = validator.validate(document)
93 if errors &amp;&amp; !errors.empty?
94 errors.each do |err|
95 puts &quot;- [#{err.path}] #{err.message}&quot;
96 end
97 end
98 </pre>
99 <p>
100 ex2. <a href="Validator.html#M000138">validate</a> with parsing
101 </p>
102 <pre>
103 schema = YAML.load_file('schema.yaml')
104 validator = Kwalify::Validator.new(schema)
105 parser = Kwalify::Yaml::Parser.new(validator)
106 document = parser.parse(File.read('document.yaml'))
107 errors = parser.errors
108 if errors &amp;&amp; errors.empty?
109 errors.each do |e|
110 puts &quot;#{e.linenum}:#{e.column} [#{e.path}] #{e.message}&quot;
111 end
112 end
113 </pre>
114
115 </div>
116
117
118 </div>
119
120 <div id="method-list">
121 <h3 class="section-bar">Methods</h3>
122
123 <div class="name-list">
124 <a href="#M000137">_inspect</a>&nbsp;&nbsp;
125 <a href="#M000140">_validate</a>&nbsp;&nbsp;
126 <a href="#M000141">_validate_unique</a>&nbsp;&nbsp;
127 <a href="#M000136">new</a>&nbsp;&nbsp;
128 <a href="#M000138">validate</a>&nbsp;&nbsp;
129 <a href="#M000139">validate_hook</a>&nbsp;&nbsp;
130 </div>
131 </div>
132
133 </div>
134
135
136 <!-- if includes -->
137 <div id="includes">
138 <h3 class="section-bar">Included Modules</h3>
139
140 <div id="includes-list">
141 <span class="include-name"><a href="ErrorHelper.html">Kwalify::ErrorHelper</a></span>
142 </div>
143 </div>
144
145 <div id="section">
146
147
148
149
150
151 <div id="attribute-list">
152 <h3 class="section-bar">Attributes</h3>
153
154 <div class="name-list">
155 <table>
156 <tr class="top-aligned-row context-row">
157 <td class="context-item-name">rule</td>
158 <td class="context-item-value">&nbsp;[R]&nbsp;</td>
159 <td class="context-item-desc"></td>
160 </tr>
161 </table>
162 </div>
163 </div>
164
165
166
167 <!-- if method_list -->
168 <div id="methods">
169 <h3 class="section-bar">Public Class methods</h3>
170
171 <div id="method-M000136" class="method-detail">
172 <a name="M000136"></a>
173
174 <div class="method-heading">
175 <a href="#M000136" class="method-signature">
176 <span class="method-name">new</span><span class="method-args">(hash_or_rule, &amp;block)</span>
177 </a>
178 </div>
179
180 <div class="method-description">
181 <p><a class="source-toggle" href="#"
182 onclick="toggleCode('M000136-source');return false;">[Source]</a></p>
183 <div class="method-source-code" id="M000136-source">
184 <pre>
185 <span class="ruby-comment cmt"># File kwalify/validator.rb, line 44</span>
186 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">hash_or_rule</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
187 <span class="ruby-identifier">obj</span> = <span class="ruby-identifier">hash_or_rule</span>
188 <span class="ruby-ivar">@rule</span> = (<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Rule</span>)) <span class="ruby-operator">?</span> <span class="ruby-identifier">obj</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Rule</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">obj</span>)
189 <span class="ruby-ivar">@block</span> = <span class="ruby-identifier">block</span>
190 <span class="ruby-keyword kw">end</span>
191 </pre>
192 </div>
193 </div>
194 </div>
195
196 <h3 class="section-bar">Public Instance methods</h3>
197
198 <div id="method-M000137" class="method-detail">
199 <a name="M000137"></a>
200
201 <div class="method-heading">
202 <a href="#M000137" class="method-signature">
203 <span class="method-name">_inspect</span><span class="method-args">()</span>
204 </a>
205 </div>
206
207 <div class="method-description">
208 <p><a class="source-toggle" href="#"
209 onclick="toggleCode('M000137-source');return false;">[Source]</a></p>
210 <div class="method-source-code" id="M000137-source">
211 <pre>
212 <span class="ruby-comment cmt"># File kwalify/validator.rb, line 52</span>
213 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">_inspect</span>
214 <span class="ruby-ivar">@rule</span>.<span class="ruby-identifier">_inspect</span>
215 <span class="ruby-keyword kw">end</span>
216 </pre>
217 </div>
218 </div>
219 </div>
220
221 <div id="method-M000140" class="method-detail">
222 <a name="M000140"></a>
223
224 <div class="method-heading">
225 <a href="#M000140" class="method-signature">
226 <span class="method-name">_validate</span><span class="method-args">(value, rule, path, errors, done, uniq_table, recursive=true)</span>
227 </a>
228 </div>
229
230 <div class="method-description">
231 <p><a class="source-toggle" href="#"
232 onclick="toggleCode('M000140-source');return false;">[Source]</a></p>
233 <div class="method-source-code" id="M000140-source">
234 <pre>
235 <span class="ruby-comment cmt"># File kwalify/validator.rb, line 75</span>
236 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">_validate</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">errors</span>, <span class="ruby-identifier">done</span>, <span class="ruby-identifier">uniq_table</span>, <span class="ruby-identifier">recursive</span>=<span class="ruby-keyword kw">true</span>)
237 <span class="ruby-comment cmt">#if Types.collection?(value)</span>
238 <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-constant">Types</span>.<span class="ruby-identifier">scalar?</span>(<span class="ruby-identifier">value</span>)
239 <span class="ruby-comment cmt">#if done[value.__id__]</span>
240 <span class="ruby-comment cmt"># rule2 = done[value.__id__]</span>
241 <span class="ruby-comment cmt"># if rule2.is_a?(Rule)</span>
242 <span class="ruby-comment cmt"># return if rule.equal?(rule2)</span>
243 <span class="ruby-comment cmt"># done[value.__id__] = [rule2, rule]</span>
244 <span class="ruby-comment cmt"># elsif rule2.is_a?(Array)</span>
245 <span class="ruby-comment cmt"># return if rule2.any? {|r| r.equal?(rule)}</span>
246 <span class="ruby-comment cmt"># done[value.__id__] &lt;&lt; rule</span>
247 <span class="ruby-comment cmt"># else</span>
248 <span class="ruby-comment cmt"># raise &quot;unreachable&quot;</span>
249 <span class="ruby-comment cmt"># end</span>
250 <span class="ruby-comment cmt">#end</span>
251 <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">done</span>[<span class="ruby-identifier">value</span>.<span class="ruby-identifier">__id__</span>] <span class="ruby-comment cmt"># avoid infinite loop</span>
252 <span class="ruby-identifier">done</span>[<span class="ruby-identifier">value</span>.<span class="ruby-identifier">__id__</span>] = <span class="ruby-identifier">rule</span>
253 <span class="ruby-keyword kw">end</span>
254 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">required</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span>
255 <span class="ruby-comment cmt">#* key=:required_novalue msg=&quot;value required but none.&quot;</span>
256 <span class="ruby-identifier">errors</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">validate_error</span>(<span class="ruby-identifier">:required_novalue</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">value</span>)
257 <span class="ruby-keyword kw">return</span>
258 <span class="ruby-keyword kw">end</span>
259 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">type_class</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-identifier">rule</span>.<span class="ruby-identifier">type_class</span>)
260 <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">classobj</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-identifier">rule</span>.<span class="ruby-identifier">classobj</span>)
261 <span class="ruby-comment cmt">#* key=:type_unmatch msg=&quot;not a %s.&quot;</span>
262 <span class="ruby-identifier">errors</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">validate_error</span>(<span class="ruby-identifier">:type_unmatch</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">value</span>, [<span class="ruby-constant">Kwalify</span>.<span class="ruby-identifier">word</span>(<span class="ruby-identifier">rule</span>.<span class="ruby-identifier">type</span>)])
263 <span class="ruby-keyword kw">return</span>
264 <span class="ruby-keyword kw">end</span>
265 <span class="ruby-keyword kw">end</span>
266 <span class="ruby-comment cmt">#</span>
267 <span class="ruby-identifier">n</span> = <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">length</span>
268 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">sequence</span>
269 <span class="ruby-identifier">_validate_sequence</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">errors</span>, <span class="ruby-identifier">done</span>, <span class="ruby-identifier">uniq_table</span>, <span class="ruby-identifier">recursive</span>)
270 <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">mapping</span>
271 <span class="ruby-identifier">_validate_mapping</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">errors</span>, <span class="ruby-identifier">done</span>, <span class="ruby-identifier">uniq_table</span>, <span class="ruby-identifier">recursive</span>)
272 <span class="ruby-keyword kw">else</span>
273 <span class="ruby-identifier">_validate_scalar</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">errors</span>, <span class="ruby-identifier">done</span>, <span class="ruby-identifier">uniq_table</span>)
274 <span class="ruby-keyword kw">end</span>
275 <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">n</span>
276 <span class="ruby-comment cmt">#</span>
277 <span class="ruby-comment cmt">#path_str = path.is_a?(Array) ? '/'+path.join('/') : path</span>
278 <span class="ruby-comment cmt">#validate_hook(value, rule, path_str, errors)</span>
279 <span class="ruby-comment cmt">#@block.call(value, rule, path_str, errors) if @block</span>
280 <span class="ruby-identifier">validate_hook</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">errors</span>)
281 <span class="ruby-ivar">@block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">errors</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@block</span>
282 <span class="ruby-keyword kw">end</span>
283 </pre>
284 </div>
285 </div>
286 </div>
287
288 <div id="method-M000141" class="method-detail">
289 <a name="M000141"></a>
290
291 <div class="method-heading">
292 <a href="#M000141" class="method-signature">
293 <span class="method-name">_validate_unique</span><span class="method-args">(value, rule, path, errors, uniq_table)</span>
294 </a>
295 </div>
296
297 <div class="method-description">
298 <p><a class="source-toggle" href="#"
299 onclick="toggleCode('M000141-source');return false;">[Source]</a></p>
300 <div class="method-source-code" id="M000141-source">
301 <pre>
302 <span class="ruby-comment cmt"># File kwalify/validator.rb, line 188</span>
303 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">_validate_unique</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">errors</span>, <span class="ruby-identifier">uniq_table</span>)
304 <span class="ruby-identifier">assert_error</span> <span class="ruby-node">&quot;uniq_table=#{uniq_table.inspect}&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">unique</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">ident</span>
305 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">uniq_table</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">value</span>)
306 <span class="ruby-identifier">exist_at</span> = <span class="ruby-identifier">uniq_table</span>[<span class="ruby-identifier">value</span>]
307 <span class="ruby-identifier">exist_at</span> = <span class="ruby-node">&quot;/#{exist_at.join('/')}&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">exist_at</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
308 <span class="ruby-comment cmt">#* key=:value_notunique msg=&quot;is already used at '%s'.&quot;</span>
309 <span class="ruby-identifier">errors</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">validate_error</span>(<span class="ruby-identifier">:value_notunique</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">exist_at</span>)
310 <span class="ruby-keyword kw">else</span>
311 <span class="ruby-identifier">uniq_table</span>[<span class="ruby-identifier">value</span>] = <span class="ruby-identifier">path</span>.<span class="ruby-identifier">dup</span>
312 <span class="ruby-keyword kw">end</span>
313 <span class="ruby-keyword kw">end</span>
314 </pre>
315 </div>
316 </div>
317 </div>
318
319 <div id="method-M000138" class="method-detail">
320 <a name="M000138"></a>
321
322 <div class="method-heading">
323 <a href="#M000138" class="method-signature">
324 <span class="method-name">validate</span><span class="method-args">(value)</span>
325 </a>
326 </div>
327
328 <div class="method-description">
329 <p><a class="source-toggle" href="#"
330 onclick="toggleCode('M000138-source');return false;">[Source]</a></p>
331 <div class="method-source-code" id="M000138-source">
332 <pre>
333 <span class="ruby-comment cmt"># File kwalify/validator.rb, line 57</span>
334 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate</span>(<span class="ruby-identifier">value</span>)
335 <span class="ruby-identifier">path</span> = <span class="ruby-value str">''</span>; <span class="ruby-identifier">errors</span> = []; <span class="ruby-identifier">done</span> = {}; <span class="ruby-identifier">uniq_table</span> = <span class="ruby-keyword kw">nil</span>
336 <span class="ruby-identifier">_validate</span>(<span class="ruby-identifier">value</span>, <span class="ruby-ivar">@rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">errors</span>, <span class="ruby-identifier">done</span>, <span class="ruby-identifier">uniq_table</span>)
337 <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">errors</span>
338 <span class="ruby-keyword kw">end</span>
339 </pre>
340 </div>
341 </div>
342 </div>
343
344 <h3 class="section-bar">Protected Instance methods</h3>
345
346 <div id="method-M000139" class="method-detail">
347 <a name="M000139"></a>
348
349 <div class="method-heading">
350 <a href="#M000139" class="method-signature">
351 <span class="method-name">validate_hook</span><span class="method-args">(value, rule, path, errors)</span>
352 </a>
353 </div>
354
355 <div class="method-description">
356 <p><a class="source-toggle" href="#"
357 onclick="toggleCode('M000139-source');return false;">[Source]</a></p>
358 <div class="method-source-code" id="M000139-source">
359 <pre>
360 <span class="ruby-comment cmt"># File kwalify/validator.rb, line 67</span>
361 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_hook</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">errors</span>)
362 <span class="ruby-comment cmt">## may be overrided by subclass</span>
363 <span class="ruby-keyword kw">end</span>
364 </pre>
365 </div>
366 </div>
367 </div>
368
369
370 </div>
371
372
373 </div>
374
375
376 <div id="validator-badges">
377 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
378 </div>
379
380 </body>
381 </html>