--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Module: MCollective::Validator</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Module</strong></td>
+ <td class="class-name-in-header">MCollective::Validator</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/lib/mcollective/validator_rb.html">
+ lib/mcollective/validator.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000217">[]</a>
+ <a href="#M000219">has_validator?</a>
+ <a href="#M000216">load_validators</a>
+ <a href="#M000221">load_validators?</a>
+ <a href="#M000218">method_missing</a>
+ <a href="#M000222">validate</a>
+ <a href="#M000220">validator_class</a>
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000217" class="method-detail">
+ <a name="M000217"></a>
+
+ <div class="method-heading">
+ <a href="#M000217" class="method-signature">
+ <span class="method-name">[]</span><span class="method-args">(klass)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns and instance of the Plugin class from which objects can be created.
+Valid plugin names are
+</p>
+<pre>
+ :valplugin
+ "valplugin"
+ "ValpluginValidator"
+</pre>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000217-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000217-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 18</span>
+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>)
+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>)
+20: <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">klass</span>)
+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>))
+22: <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">klass</span>)
+23: <span class="ruby-keyword kw">end</span>
+24:
+25: <span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">klass</span>)
+26: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000219" class="method-detail">
+ <a name="M000219"></a>
+
+ <div class="method-heading">
+ <a href="#M000219" class="method-signature">
+ <span class="method-name">has_validator?</span><span class="method-args">(validator)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000219-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000219-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 37</span>
+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>)
+38: <span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">validator</span>))
+39: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000216" class="method-detail">
+ <a name="M000216"></a>
+
+ <div class="method-heading">
+ <a href="#M000216" class="method-signature">
+ <span class="method-name">load_validators</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Loads the validator plugins. Validators will only be loaded every 5 minutes
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000216-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000216-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 6</span>
+ 6: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_validators</span>
+ 7: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">load_validators?</span>
+ 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>
+ 9: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-value str">"validator"</span>)
+10: <span class="ruby-keyword kw">end</span>
+11: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000221" class="method-detail">
+ <a name="M000221"></a>
+
+ <div class="method-heading">
+ <a href="#M000221" class="method-signature">
+ <span class="method-name">load_validators?</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000221-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000221-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 45</span>
+45: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_validators?</span>
+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>
+47:
+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">></span> <span class="ruby-value">300</span>
+49: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000218" class="method-detail">
+ <a name="M000218"></a>
+
+ <div class="method-heading">
+ <a href="#M000218" class="method-signature">
+ <span class="method-name">method_missing</span><span class="method-args">(method, *args, &block)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Allows validation plugins to be called like module methods : <a
+href="Validator.html#M000222">Validator.validate</a>()
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000218-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000218-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 29</span>
+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">&</span><span class="ruby-identifier">block</span>)
+30: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">has_validator?</span>(<span class="ruby-identifier">method</span>)
+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>)
+32: <span class="ruby-keyword kw">else</span>
+33: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ValidatorError</span>, <span class="ruby-node">"Unknown validator: '#{method}'."</span>
+34: <span class="ruby-keyword kw">end</span>
+35: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000222" class="method-detail">
+ <a name="M000222"></a>
+
+ <div class="method-heading">
+ <a href="#M000222" class="method-signature">
+ <span class="method-name">validate</span><span class="method-args">(validator, validation)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Generic <a href="Validator.html#M000222">validate</a> method that will call
+the correct validator plugin based on the type of the validation parameter
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000222-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000222-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 53</span>
+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>)
+54: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">load_validators</span>
+55:
+56: <span class="ruby-keyword kw">begin</span>
+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>)
+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>)
+59:
+60: <span class="ruby-keyword kw">else</span>
+61: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">validation</span>
+62: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Regexp</span>,<span class="ruby-constant">String</span>
+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>)
+64:
+65: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Symbol</span>
+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>)
+67:
+68: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Array</span>
+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>)
+70:
+71: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Class</span>
+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>)
+73: <span class="ruby-keyword kw">end</span>
+74: <span class="ruby-keyword kw">end</span>
+75: <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+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>
+77: <span class="ruby-keyword kw">end</span>
+78: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000220" class="method-detail">
+ <a name="M000220"></a>
+
+ <div class="method-heading">
+ <a href="#M000220" class="method-signature">
+ <span class="method-name">validator_class</span><span class="method-args">(validator)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000220-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000220-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 41</span>
+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>)
+42: <span class="ruby-node">"#{validator.to_s.capitalize}Validator"</span>
+43: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file