doc/classes/MCollective/Validator.html

   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: MCollective::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>Module</strong></td>
  53           <td class="class-name-in-header">MCollective::Validator</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/mcollective/validator_rb.html">
  59                 lib/mcollective/validator.rb
  60                 </a>
  61         <br />
  62             </td>
  63         </tr>
  64
  65         </table>
  66     </div>
  67   <!-- banner header -->
  68
  69   <div id="bodyContent">
  70
  71
  72
  73   <div id="contextContent">
  74
  75
  76
  77    </div>
  78
  79     <div id="method-list">
  80       <h3 class="section-bar">Methods</h3>
  81
  82       <div class="name-list">
  83       <a href="#M000217">[]</a>&nbsp;&nbsp;
  84       <a href="#M000219">has_validator?</a>&nbsp;&nbsp;
  85       <a href="#M000216">load_validators</a>&nbsp;&nbsp;
  86       <a href="#M000221">load_validators?</a>&nbsp;&nbsp;
  87       <a href="#M000218">method_missing</a>&nbsp;&nbsp;
  88       <a href="#M000222">validate</a>&nbsp;&nbsp;
  89       <a href="#M000220">validator_class</a>&nbsp;&nbsp;
  90       </div>
  91     </div>
  92
  93   </div>
  94
  95
  96     <!-- if includes -->
  97
  98     <div id="section">
  99
 100
 101
 102
 103
 104
 105
 106
 107     <!-- if method_list -->
 108     <div id="methods">
 109       <h3 class="section-bar">Public Class methods</h3>
 110
 111       <div id="method-M000217" class="method-detail">
 112         <a name="M000217"></a>
 113
 114         <div class="method-heading">
 115           <a href="#M000217" class="method-signature">
 116           <span class="method-name">[]</span><span class="method-args">(klass)</span>
 117           </a>
 118         </div>
 119
 120         <div class="method-description">
 121           <p>
 122 Returns and instance of the Plugin class from which objects can be created.
 123 Valid plugin names are
 124 </p>
 125 <pre>
 126   :valplugin
 127   &quot;valplugin&quot;
 128   &quot;ValpluginValidator&quot;
 129 </pre>
 130           <p><a class="source-toggle" href="#"
 131             onclick="toggleCode('M000217-source');return false;">[Source]</a></p>
 132           <div class="method-source-code" id="M000217-source">
 133 <pre>
 134     <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 18</span>
 135 18:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">klass</span>)
 136 19:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>)
 137 20:         <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">klass</span>)
 138 21:       <span class="ruby-keyword kw">elsif</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/.*Validator$/</span>))
 139 22:         <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">klass</span>)
 140 23:       <span class="ruby-keyword kw">end</span>
 141 24:
 142 25:       <span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">klass</span>)
 143 26:     <span class="ruby-keyword kw">end</span>
 144 </pre>
 145           </div>
 146         </div>
 147       </div>
 148
 149       <div id="method-M000219" class="method-detail">
 150         <a name="M000219"></a>
 151
 152         <div class="method-heading">
 153           <a href="#M000219" class="method-signature">
 154           <span class="method-name">has_validator?</span><span class="method-args">(validator)</span>
 155           </a>
 156         </div>
 157
 158         <div class="method-description">
 159           <p><a class="source-toggle" href="#"
 160             onclick="toggleCode('M000219-source');return false;">[Source]</a></p>
 161           <div class="method-source-code" id="M000219-source">
 162 <pre>
 163     <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 37</span>
 164 37:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_validator?</span>(<span class="ruby-identifier">validator</span>)
 165 38:       <span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">validator</span>))
 166 39:     <span class="ruby-keyword kw">end</span>
 167 </pre>
 168           </div>
 169         </div>
 170       </div>
 171
 172       <div id="method-M000216" class="method-detail">
 173         <a name="M000216"></a>
 174
 175         <div class="method-heading">
 176           <a href="#M000216" class="method-signature">
 177           <span class="method-name">load_validators</span><span class="method-args">()</span>
 178           </a>
 179         </div>
 180
 181         <div class="method-description">
 182           <p>
 183 Loads the validator plugins. Validators will only be loaded every 5 minutes
 184 </p>
 185           <p><a class="source-toggle" href="#"
 186             onclick="toggleCode('M000216-source');return false;">[Source]</a></p>
 187           <div class="method-source-code" id="M000216-source">
 188 <pre>
 189     <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 6</span>
 190  6:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_validators</span>
 191  7:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">load_validators?</span>
 192  8:         <span class="ruby-ivar">@last_load</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
 193  9:         <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-value str">&quot;validator&quot;</span>)
 194 10:       <span class="ruby-keyword kw">end</span>
 195 11:     <span class="ruby-keyword kw">end</span>
 196 </pre>
 197           </div>
 198         </div>
 199       </div>
 200
 201       <div id="method-M000221" class="method-detail">
 202         <a name="M000221"></a>
 203
 204         <div class="method-heading">
 205           <a href="#M000221" class="method-signature">
 206           <span class="method-name">load_validators?</span><span class="method-args">()</span>
 207           </a>
 208         </div>
 209
 210         <div class="method-description">
 211           <p><a class="source-toggle" href="#"
 212             onclick="toggleCode('M000221-source');return false;">[Source]</a></p>
 213           <div class="method-source-code" id="M000221-source">
 214 <pre>
 215     <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 45</span>
 216 45:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_validators?</span>
 217 46:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@last_load</span>.<span class="ruby-identifier">nil?</span>
 218 47:
 219 48:       (<span class="ruby-ivar">@last_load</span> <span class="ruby-operator">-</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>) <span class="ruby-operator">&gt;</span> <span class="ruby-value">300</span>
 220 49:     <span class="ruby-keyword kw">end</span>
 221 </pre>
 222           </div>
 223         </div>
 224       </div>
 225
 226       <div id="method-M000218" class="method-detail">
 227         <a name="M000218"></a>
 228
 229         <div class="method-heading">
 230           <a href="#M000218" class="method-signature">
 231           <span class="method-name">method_missing</span><span class="method-args">(method, *args, &amp;block)</span>
 232           </a>
 233         </div>
 234
 235         <div class="method-description">
 236           <p>
 237 Allows validation plugins to be called like module methods : <a
 238 href="Validator.html#M000222">Validator.validate</a>()
 239 </p>
 240           <p><a class="source-toggle" href="#"
 241             onclick="toggleCode('M000218-source');return false;">[Source]</a></p>
 242           <div class="method-source-code" id="M000218-source">
 243 <pre>
 244     <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 29</span>
 245 29:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
 246 30:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">has_validator?</span>(<span class="ruby-identifier">method</span>)
 247 31:         <span class="ruby-identifier">validator</span> = <span class="ruby-constant">Validator</span>[<span class="ruby-identifier">method</span>].<span class="ruby-identifier">validate</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
 248 32:       <span class="ruby-keyword kw">else</span>
 249 33:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">ValidatorError</span>, <span class="ruby-node">&quot;Unknown validator: '#{method}'.&quot;</span>
 250 34:       <span class="ruby-keyword kw">end</span>
 251 35:     <span class="ruby-keyword kw">end</span>
 252 </pre>
 253           </div>
 254         </div>
 255       </div>
 256
 257       <div id="method-M000222" class="method-detail">
 258         <a name="M000222"></a>
 259
 260         <div class="method-heading">
 261           <a href="#M000222" class="method-signature">
 262           <span class="method-name">validate</span><span class="method-args">(validator, validation)</span>
 263           </a>
 264         </div>
 265
 266         <div class="method-description">
 267           <p>
 268 Generic <a href="Validator.html#M000222">validate</a> method that will call
 269 the correct validator plugin based on the type of the validation parameter
 270 </p>
 271           <p><a class="source-toggle" href="#"
 272             onclick="toggleCode('M000222-source');return false;">[Source]</a></p>
 273           <div class="method-source-code" id="M000222-source">
 274 <pre>
 275     <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 53</span>
 276 53:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validate</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
 277 54:       <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">load_validators</span>
 278 55:
 279 56:       <span class="ruby-keyword kw">begin</span>
 280 57:         <span class="ruby-keyword kw">if</span> [<span class="ruby-identifier">:integer</span>, <span class="ruby-identifier">:boolean</span>, <span class="ruby-identifier">:float</span>, <span class="ruby-identifier">:number</span>, <span class="ruby-identifier">:string</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">validation</span>)
 281 58:           <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">typecheck</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
 282 59:
 283 60:         <span class="ruby-keyword kw">else</span>
 284 61:           <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">validation</span>
 285 62:             <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Regexp</span>,<span class="ruby-constant">String</span>
 286 63:               <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">regex</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
 287 64:
 288 65:             <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Symbol</span>
 289 66:               <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">validation</span>, <span class="ruby-identifier">validator</span>)
 290 67:
 291 68:             <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Array</span>
 292 69:               <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
 293 70:
 294 71:             <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Class</span>
 295 72:               <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">typecheck</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
 296 73:           <span class="ruby-keyword kw">end</span>
 297 74:         <span class="ruby-keyword kw">end</span>
 298 75:       <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
 299 76:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">ValidatorError</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>
 300 77:       <span class="ruby-keyword kw">end</span>
 301 78:     <span class="ruby-keyword kw">end</span>
 302 </pre>
 303           </div>
 304         </div>
 305       </div>
 306
 307       <div id="method-M000220" class="method-detail">
 308         <a name="M000220"></a>
 309
 310         <div class="method-heading">
 311           <a href="#M000220" class="method-signature">
 312           <span class="method-name">validator_class</span><span class="method-args">(validator)</span>
 313           </a>
 314         </div>
 315
 316         <div class="method-description">
 317           <p><a class="source-toggle" href="#"
 318             onclick="toggleCode('M000220-source');return false;">[Source]</a></p>
 319           <div class="method-source-code" id="M000220-source">
 320 <pre>
 321     <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 41</span>
 322 41:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">validator</span>)
 323 42:       <span class="ruby-node">&quot;#{validator.to_s.capitalize}Validator&quot;</span>
 324 43:     <span class="ruby-keyword kw">end</span>
 325 </pre>
 326           </div>
 327         </div>
 328       </div>
 329
 330
 331     </div>
 332
 333
 334   </div>
 335
 336
 337 <div id="validator-badges">
 338   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 339 </div>
 340
 341 </body>
 342 </html>