| 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>Module: Kwalify::Util</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>Module</strong></td> |
| 53 |
<td class="class-name-in-header">Kwalify::Util</td> |
| 54 |
</tr> |
| 55 |
<tr class="top-aligned-row"> |
| 56 |
<td><strong>In:</strong></td> |
| 57 |
<td> |
| 58 |
<a href="../../files/kwalify/util/hashlike_rb.html"> |
| 59 |
kwalify/util/hashlike.rb |
| 60 |
</a> |
| 61 |
<br /> |
| 62 |
<a href="../../files/kwalify/util/ordered-hash_rb.html"> |
| 63 |
kwalify/util/ordered-hash.rb |
| 64 |
</a> |
| 65 |
<br /> |
| 66 |
<a href="../../files/kwalify/util_rb.html"> |
| 67 |
kwalify/util.rb |
| 68 |
</a> |
| 69 |
<br /> |
| 70 |
<a href="../../files/kwalify_rb.html"> |
| 71 |
kwalify.rb |
| 72 |
</a> |
| 73 |
<br /> |
| 74 |
</td> |
| 75 |
</tr> |
| 76 |
|
| 77 |
</table> |
| 78 |
</div> |
| 79 |
<!-- banner header --> |
| 80 |
|
| 81 |
<div id="bodyContent"> |
| 82 |
|
| 83 |
|
| 84 |
|
| 85 |
<div id="contextContent"> |
| 86 |
|
| 87 |
|
| 88 |
|
| 89 |
</div> |
| 90 |
|
| 91 |
<div id="method-list"> |
| 92 |
<h3 class="section-bar">Methods</h3> |
| 93 |
|
| 94 |
<div class="name-list"> |
| 95 |
<a href="#M000023">create_hashtable</a> |
| 96 |
<a href="#M000022">get_class</a> |
| 97 |
<a href="#M000024">get_value</a> |
| 98 |
<a href="#M000021">traverse_rule</a> |
| 99 |
<a href="#M000020">traverse_schema</a> |
| 100 |
<a href="#M000019">untabify</a> |
| 101 |
</div> |
| 102 |
</div> |
| 103 |
|
| 104 |
</div> |
| 105 |
|
| 106 |
|
| 107 |
<!-- if includes --> |
| 108 |
|
| 109 |
<div id="section"> |
| 110 |
|
| 111 |
<div id="class-list"> |
| 112 |
<h3 class="section-bar">Classes and Modules</h3> |
| 113 |
|
| 114 |
Module <a href="Util/HashLike.html" class="link">Kwalify::Util::HashLike</a><br /> |
| 115 |
Class <a href="Util/OrderedHash.html" class="link">Kwalify::Util::OrderedHash</a><br /> |
| 116 |
|
| 117 |
</div> |
| 118 |
|
| 119 |
|
| 120 |
|
| 121 |
|
| 122 |
|
| 123 |
|
| 124 |
|
| 125 |
<!-- if method_list --> |
| 126 |
<div id="methods"> |
| 127 |
<h3 class="section-bar">Public Instance methods</h3> |
| 128 |
|
| 129 |
<div id="method-M000023" class="method-detail"> |
| 130 |
<a name="M000023"></a> |
| 131 |
|
| 132 |
<div class="method-heading"> |
| 133 |
<a href="#M000023" class="method-signature"> |
| 134 |
<span class="method-name">create_hashtable</span><span class="method-args">(hashlist, primarykey, flag_duplicate_check=true)</span> |
| 135 |
</a> |
| 136 |
</div> |
| 137 |
|
| 138 |
<div class="method-description"> |
| 139 |
<p> |
| 140 |
create a hash table from list of hash with primary key. |
| 141 |
</p> |
| 142 |
<p> |
| 143 |
ex. |
| 144 |
</p> |
| 145 |
<pre> |
| 146 |
hashlist = [ |
| 147 |
{ "name"=>"Foo", "gender"=>"M", "age"=>20, }, |
| 148 |
{ "name"=>"Bar", "gender"=>"F", "age"=>25, }, |
| 149 |
{ "name"=>"Baz", "gender"=>"M", "age"=>30, }, |
| 150 |
] |
| 151 |
hashtable = YamlHelper.create_hashtable(hashlist, "name") |
| 152 |
p hashtable |
| 153 |
# => { "Foo" => { "name"=>"Foo", "gender"=>"M", "age"=>20, }, |
| 154 |
# "Bar" => { "name"=>"Bar", "gender"=>"F", "age"=>25, }, |
| 155 |
# "Baz" => { "name"=>"Baz", "gender"=>"M", "age"=>30, }, } |
| 156 |
</pre> |
| 157 |
<p><a class="source-toggle" href="#" |
| 158 |
onclick="toggleCode('M000023-source');return false;">[Source]</a></p> |
| 159 |
<div class="method-source-code" id="M000023-source"> |
| 160 |
<pre> |
| 161 |
<span class="ruby-comment cmt"># File kwalify/util.rb, line 118</span> |
| 162 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_hashtable</span>(<span class="ruby-identifier">hashlist</span>, <span class="ruby-identifier">primarykey</span>, <span class="ruby-identifier">flag_duplicate_check</span>=<span class="ruby-keyword kw">true</span>) |
| 163 |
<span class="ruby-identifier">hashtable</span> = {} |
| 164 |
<span class="ruby-identifier">hashlist</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span><span class="ruby-operator">|</span> |
| 165 |
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">primarykey</span>] |
| 166 |
<span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">key</span> |
| 167 |
<span class="ruby-identifier">riase</span> <span class="ruby-node">"primary key '#{key}' not found."</span> |
| 168 |
<span class="ruby-keyword kw">end</span> |
| 169 |
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flag_duplicate_check</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">hashtable</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">key</span>) |
| 170 |
<span class="ruby-identifier">raise</span> <span class="ruby-node">"primary key '#{key}' duplicated (value '#{hashtable[key]}')"</span> |
| 171 |
<span class="ruby-keyword kw">end</span> |
| 172 |
<span class="ruby-identifier">hashtable</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">hash</span> |
| 173 |
<span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">hashlist</span> |
| 174 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">hashtable</span> |
| 175 |
<span class="ruby-keyword kw">end</span> |
| 176 |
</pre> |
| 177 |
</div> |
| 178 |
</div> |
| 179 |
</div> |
| 180 |
|
| 181 |
<div id="method-M000022" class="method-detail"> |
| 182 |
<a name="M000022"></a> |
| 183 |
|
| 184 |
<div class="method-heading"> |
| 185 |
<a href="#M000022" class="method-signature"> |
| 186 |
<span class="method-name">get_class</span><span class="method-args">(classname)</span> |
| 187 |
</a> |
| 188 |
</div> |
| 189 |
|
| 190 |
<div class="method-description"> |
| 191 |
<p> |
| 192 |
get class object. if not found, NameError raised. |
| 193 |
</p> |
| 194 |
<p><a class="source-toggle" href="#" |
| 195 |
onclick="toggleCode('M000022-source');return false;">[Source]</a></p> |
| 196 |
<div class="method-source-code" id="M000022-source"> |
| 197 |
<pre> |
| 198 |
<span class="ruby-comment cmt"># File kwalify/util.rb, line 94</span> |
| 199 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_class</span>(<span class="ruby-identifier">classname</span>) |
| 200 |
<span class="ruby-identifier">klass</span> = <span class="ruby-constant">Object</span> |
| 201 |
<span class="ruby-identifier">classname</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">'::'</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span> |
| 202 |
<span class="ruby-identifier">klass</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">name</span>) |
| 203 |
<span class="ruby-keyword kw">end</span> |
| 204 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">klass</span> |
| 205 |
<span class="ruby-keyword kw">end</span> |
| 206 |
</pre> |
| 207 |
</div> |
| 208 |
</div> |
| 209 |
</div> |
| 210 |
|
| 211 |
<div id="method-M000024" class="method-detail"> |
| 212 |
<a name="M000024"></a> |
| 213 |
|
| 214 |
<div class="method-heading"> |
| 215 |
<a href="#M000024" class="method-signature"> |
| 216 |
<span class="method-name">get_value</span><span class="method-args">(obj, path)</span> |
| 217 |
</a> |
| 218 |
</div> |
| 219 |
|
| 220 |
<div class="method-description"> |
| 221 |
<p> |
| 222 |
get nested value directly. |
| 223 |
</p> |
| 224 |
<p> |
| 225 |
ex. |
| 226 |
</p> |
| 227 |
<pre> |
| 228 |
val = YamlHelper.get_value(obj, ['aaa', 0, 'xxx']) |
| 229 |
</pre> |
| 230 |
<p> |
| 231 |
This is equal to the following: |
| 232 |
</p> |
| 233 |
<pre> |
| 234 |
begin |
| 235 |
val = obj['aaa'][0]['xxx'] |
| 236 |
rescue NameError |
| 237 |
val = nil |
| 238 |
end |
| 239 |
</pre> |
| 240 |
<p><a class="source-toggle" href="#" |
| 241 |
onclick="toggleCode('M000024-source');return false;">[Source]</a></p> |
| 242 |
<div class="method-source-code" id="M000024-source"> |
| 243 |
<pre> |
| 244 |
<span class="ruby-comment cmt"># File kwalify/util.rb, line 147</span> |
| 245 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_value</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-identifier">path</span>) |
| 246 |
<span class="ruby-identifier">val</span> = <span class="ruby-identifier">obj</span> |
| 247 |
<span class="ruby-identifier">path</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> |
| 248 |
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) |
| 249 |
<span class="ruby-identifier">val</span> = <span class="ruby-identifier">val</span>[<span class="ruby-identifier">key</span>] |
| 250 |
<span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">path</span> |
| 251 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">val</span> |
| 252 |
<span class="ruby-keyword kw">end</span> |
| 253 |
</pre> |
| 254 |
</div> |
| 255 |
</div> |
| 256 |
</div> |
| 257 |
|
| 258 |
<div id="method-M000021" class="method-detail"> |
| 259 |
<a name="M000021"></a> |
| 260 |
|
| 261 |
<div class="method-heading"> |
| 262 |
<a href="#M000021" class="method-signature"> |
| 263 |
<span class="method-name">traverse_rule</span><span class="method-args">(validator) {|rule| ...}</span> |
| 264 |
</a> |
| 265 |
</div> |
| 266 |
|
| 267 |
<div class="method-description"> |
| 268 |
<p> |
| 269 |
traverse rule |
| 270 |
</p> |
| 271 |
<p> |
| 272 |
ex. |
| 273 |
</p> |
| 274 |
<pre> |
| 275 |
schema = YAML.load_file('myschema.yaml') |
| 276 |
validator = Kwalify::Validator.new(schema) |
| 277 |
Kwalify::Util.traverse_rule(validator) do |rule| |
| 278 |
p rule if rule.classname |
| 279 |
end |
| 280 |
</pre> |
| 281 |
<p><a class="source-toggle" href="#" |
| 282 |
onclick="toggleCode('M000021-source');return false;">[Source]</a></p> |
| 283 |
<div class="method-source-code" id="M000021-source"> |
| 284 |
<pre> |
| 285 |
<span class="ruby-comment cmt"># File kwalify/util.rb, line 71</span> |
| 286 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">traverse_rule</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-comment cmt">#:yield: rule</span> |
| 287 |
<span class="ruby-identifier">rule</span> = <span class="ruby-identifier">validator</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Rule</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">validator</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">validator</span>.<span class="ruby-identifier">rule</span> |
| 288 |
<span class="ruby-identifier">_done</span> = {} |
| 289 |
<span class="ruby-identifier">_traverse_rule</span>(<span class="ruby-identifier">rule</span>, <span class="ruby-identifier">_done</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) |
| 290 |
<span class="ruby-keyword kw">end</span> |
| 291 |
</pre> |
| 292 |
</div> |
| 293 |
</div> |
| 294 |
</div> |
| 295 |
|
| 296 |
<div id="method-M000020" class="method-detail"> |
| 297 |
<a name="M000020"></a> |
| 298 |
|
| 299 |
<div class="method-heading"> |
| 300 |
<a href="#M000020" class="method-signature"> |
| 301 |
<span class="method-name">traverse_schema</span><span class="method-args">(schema) {|rulehash| ...}</span> |
| 302 |
</a> |
| 303 |
</div> |
| 304 |
|
| 305 |
<div class="method-description"> |
| 306 |
<p> |
| 307 |
traverse schema |
| 308 |
</p> |
| 309 |
<p> |
| 310 |
ex. |
| 311 |
</p> |
| 312 |
<pre> |
| 313 |
schema = YAML.load_file('myschema.yaml') |
| 314 |
Kwalify::Util.traverse_schema(schema) do |rulehash| |
| 315 |
## add module prefix to class name |
| 316 |
if rulehash['class'] |
| 317 |
rulehash['class'] = 'MyModule::' + rulehash['class'] |
| 318 |
end |
| 319 |
end |
| 320 |
</pre> |
| 321 |
<p><a class="source-toggle" href="#" |
| 322 |
onclick="toggleCode('M000020-source');return false;">[Source]</a></p> |
| 323 |
<div class="method-source-code" id="M000020-source"> |
| 324 |
<pre> |
| 325 |
<span class="ruby-comment cmt"># File kwalify/util.rb, line 44</span> |
| 326 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">traverse_schema</span>(<span class="ruby-identifier">schema</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-comment cmt">#:yield: rulehash</span> |
| 327 |
<span class="ruby-identifier">hash</span> = <span class="ruby-identifier">schema</span> |
| 328 |
<span class="ruby-identifier">_done</span> = {} |
| 329 |
<span class="ruby-identifier">_traverse_schema</span>(<span class="ruby-identifier">hash</span>, <span class="ruby-identifier">_done</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) |
| 330 |
<span class="ruby-keyword kw">end</span> |
| 331 |
</pre> |
| 332 |
</div> |
| 333 |
</div> |
| 334 |
</div> |
| 335 |
|
| 336 |
<div id="method-M000019" class="method-detail"> |
| 337 |
<a name="M000019"></a> |
| 338 |
|
| 339 |
<div class="method-heading"> |
| 340 |
<a href="#M000019" class="method-signature"> |
| 341 |
<span class="method-name">untabify</span><span class="method-args">(str, width=8)</span> |
| 342 |
</a> |
| 343 |
</div> |
| 344 |
|
| 345 |
<div class="method-description"> |
| 346 |
<p> |
| 347 |
expand tab character to spaces |
| 348 |
</p> |
| 349 |
<p> |
| 350 |
ex. |
| 351 |
</p> |
| 352 |
<pre> |
| 353 |
untabified_str = YamlHelper.untabify(tabbed_str) |
| 354 |
</pre> |
| 355 |
<p><a class="source-toggle" href="#" |
| 356 |
onclick="toggleCode('M000019-source');return false;">[Source]</a></p> |
| 357 |
<div class="method-source-code" id="M000019-source"> |
| 358 |
<pre> |
| 359 |
<span class="ruby-comment cmt"># File kwalify/util.rb, line 19</span> |
| 360 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">untabify</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">width</span>=<span class="ruby-value">8</span>) |
| 361 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">str</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">nil?</span> |
| 362 |
<span class="ruby-identifier">list</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/\t/</span>, <span class="ruby-value">-1</span>) <span class="ruby-comment cmt"># if 2nd arg is negative then split() doesn't remove tailing empty strings</span> |
| 363 |
<span class="ruby-identifier">last</span> = <span class="ruby-identifier">list</span>.<span class="ruby-identifier">pop</span> |
| 364 |
<span class="ruby-identifier">sb</span> = <span class="ruby-value str">''</span> |
| 365 |
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> |
| 366 |
<span class="ruby-identifier">column</span> = (<span class="ruby-identifier">n</span> = <span class="ruby-identifier">s</span>.<span class="ruby-identifier">rindex</span>(<span class="ruby-value">?\n</span>)) <span class="ruby-operator">?</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">length</span> |
| 367 |
<span class="ruby-identifier">n</span> = <span class="ruby-identifier">width</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">column</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">width</span>) |
| 368 |
<span class="ruby-identifier">sb</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">s</span> <span class="ruby-operator"><<</span> (<span class="ruby-value str">' '</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">n</span>) |
| 369 |
<span class="ruby-keyword kw">end</span> |
| 370 |
<span class="ruby-identifier">sb</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">last</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">last</span> |
| 371 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sb</span> |
| 372 |
<span class="ruby-keyword kw">end</span> |
| 373 |
</pre> |
| 374 |
</div> |
| 375 |
</div> |
| 376 |
</div> |
| 377 |
|
| 378 |
|
| 379 |
</div> |
| 380 |
|
| 381 |
|
| 382 |
</div> |
| 383 |
|
| 384 |
|
| 385 |
<div id="validator-badges"> |
| 386 |
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> |
| 387 |
</div> |
| 388 |
|
| 389 |
</body> |
| 390 |
</html> |