parsleyjs

<!DOCTYPE html> <html> <head> <title>validator.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <ul id="jump_to"> <li> <a class="large" href="javascript:void(0);">Jump To …</a> <a class="small" href="javascript:void(0);">+</a> <div id="jump_wrapper"> <div id="jump_page"><a class="source" href="../index.html"><<< back to documentation</a> <a class="source" href="abstract.html"> abstract.js </a> <a class="source" href="defaults.html"> defaults.js </a> <a class="source" href="factory.html"> factory.js </a> <a class="source" href="field.html"> field.js </a> <a class="source" href="form.html"> form.js </a> <a class="source" href="main.html"> main.js </a> <a class="source" href="multiple.html"> multiple.js </a> <a class="source" href="pubsub.html"> pubsub.js </a> <a class="source" href="remote.html"> remote.js </a> <a class="source" href="ui.html"> ui.js </a> <a class="source" href="utils.html"> utils.js </a> <a class="source" href="validator.html"> validator.js </a> <a class="source" href="validator_registry.html"> validator_registry.js </a> </div> </li> </ul> <ul class="sections"> <li id="title"> <div class="annotation"> <h1>validator.js</h1> </div> </li> <li id="section-1"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-1">¶</a> </div> </div> <div class="content"><div class='highlight'><pre><span class="hljs-keyword">import</span> $ <span class="hljs-keyword">from</span> <span class="hljs-string">'jquery'</span>; <span class="hljs-keyword">import</span> ParsleyUtils <span class="hljs-keyword">from</span> <span class="hljs-string">'./utils'</span>; <span class="hljs-keyword">var</span> requirementConverters = { <span class="hljs-attr">string</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">string</span>) </span>{ <span class="hljs-keyword">return</span> string; }, <span class="hljs-attr">integer</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">string</span>) </span>{ <span class="hljs-keyword">if</span> (<span class="hljs-built_in">isNaN</span>(string)) <span class="hljs-keyword">throw</span> <span class="hljs-string">'Requirement is not an integer: "'</span> + string + <span class="hljs-string">'"'</span>; <span class="hljs-keyword">return</span> <span class="hljs-built_in">parseInt</span>(string, <span class="hljs-number">10</span>); }, <span class="hljs-attr">number</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">string</span>) </span>{ <span class="hljs-keyword">if</span> (<span class="hljs-built_in">isNaN</span>(string)) <span class="hljs-keyword">throw</span> <span class="hljs-string">'Requirement is not a number: "'</span> + string + <span class="hljs-string">'"'</span>; <span class="hljs-keyword">return</span> <span class="hljs-built_in">parseFloat</span>(string); }, <span class="hljs-attr">reference</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">string</span>) </span>{ <span class="hljs-comment">// Unused for now</span> <span class="hljs-keyword">var</span> result = $(string); <span class="hljs-keyword">if</span> (result.length === <span class="hljs-number">0</span>) <span class="hljs-keyword">throw</span> <span class="hljs-string">'No such reference: "'</span> + string + <span class="hljs-string">'"'</span>; <span class="hljs-keyword">return</span> result; }, <span class="hljs-attr">boolean</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">string</span>) </span>{ <span class="hljs-keyword">return</span> string !== <span class="hljs-string">'false'</span>; }, <span class="hljs-attr">object</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">string</span>) </span>{ <span class="hljs-keyword">return</span> ParsleyUtils.deserializeValue(string); }, <span class="hljs-attr">regexp</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">regexp</span>) </span>{ <span class="hljs-keyword">var</span> flags = <span class="hljs-string">''</span>;</pre></div></div> </li> <li id="section-2"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-2">¶</a> </div> <p>Test if RegExp is literal, if not, nothing to be done, otherwise, we need to isolate flags and pattern</p> </div> <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> (<span class="hljs-regexp">/^\/.*\/(?:[gimy]*)$/</span>.test(regexp)) {</pre></div></div> </li> <li id="section-3"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-3">¶</a> </div> <p>Replace the regexp literal string with the first match group: ([gimy]*) If no flag is present, this will be a blank string</p> </div> <div class="content"><div class='highlight'><pre> flags = regexp.replace(<span class="hljs-regexp">/.*\/([gimy]*)$/</span>, <span class="hljs-string">'$1'</span>);</pre></div></div> </li> <li id="section-4"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-4">¶</a> </div> <p>Again, replace the regexp literal string with the first match group: everything excluding the opening and closing slashes and the flags</p> </div> <div class="content"><div class='highlight'><pre> regexp = regexp.replace(<span class="hljs-keyword">new</span> <span class="hljs-built_in">RegExp</span>(<span class="hljs-string">'^/(.*?)/'</span> + flags + <span class="hljs-string">'$'</span>), <span class="hljs-string">'$1'</span>); } <span class="hljs-keyword">else</span> {</pre></div></div> </li> <li id="section-5"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-5">¶</a> </div> <p>Anchor regexp:</p> </div> <div class="content"><div class='highlight'><pre> regexp = <span class="hljs-string">'^'</span> + regexp + <span class="hljs-string">'$'</span>; } <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> <span class="hljs-built_in">RegExp</span>(regexp, flags); } }; <span class="hljs-keyword">var</span> convertArrayRequirement = <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">string, length</span>) </span>{ <span class="hljs-keyword">var</span> m = string.match(<span class="hljs-regexp">/^\s*\[(.*)\]\s*$/</span>); <span class="hljs-keyword">if</span> (!m) <span class="hljs-keyword">throw</span> <span class="hljs-string">'Requirement is not an array: "'</span> + string + <span class="hljs-string">'"'</span>; <span class="hljs-keyword">var</span> values = m[<span class="hljs-number">1</span>].split(<span class="hljs-string">','</span>).map(ParsleyUtils.trimString); <span class="hljs-keyword">if</span> (values.length !== length) <span class="hljs-keyword">throw</span> <span class="hljs-string">'Requirement has '</span> + values.length + <span class="hljs-string">' values when '</span> + length + <span class="hljs-string">' are needed'</span>; <span class="hljs-keyword">return</span> values; }; <span class="hljs-keyword">var</span> convertRequirement = <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">requirementType, string</span>) </span>{ <span class="hljs-keyword">var</span> converter = requirementConverters[requirementType || <span class="hljs-string">'string'</span>]; <span class="hljs-keyword">if</span> (!converter) <span class="hljs-keyword">throw</span> <span class="hljs-string">'Unknown requirement specification: "'</span> + requirementType + <span class="hljs-string">'"'</span>; <span class="hljs-keyword">return</span> converter(string); }; <span class="hljs-keyword">var</span> convertExtraOptionRequirement = <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">requirementSpec, string, extraOptionReader</span>) </span>{ <span class="hljs-keyword">var</span> main = <span class="hljs-literal">null</span>; <span class="hljs-keyword">var</span> extra = {}; <span class="hljs-keyword">for</span> (<span class="hljs-keyword">var</span> key <span class="hljs-keyword">in</span> requirementSpec) { <span class="hljs-keyword">if</span> (key) { <span class="hljs-keyword">var</span> value = extraOptionReader(key); <span class="hljs-keyword">if</span> (<span class="hljs-string">'string'</span> === <span class="hljs-keyword">typeof</span> value) value = convertRequirement(requirementSpec[key], value); extra[key] = value; } <span class="hljs-keyword">else</span> { main = convertRequirement(requirementSpec[key], string); } } <span class="hljs-keyword">return</span> [main, extra]; };</pre></div></div> </li> <li id="section-6"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-6">¶</a> </div> <p>A Validator needs to implement the methods <code>validate</code> and <code>parseRequirements</code></p> </div> <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">var</span> ParsleyValidator = <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">spec</span>) </span>{ $.extend(<span class="hljs-literal">true</span>, <span class="hljs-keyword">this</span>, spec); }; ParsleyValidator.prototype = {</pre></div></div> </li> <li id="section-7"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-7">¶</a> </div> <p>Returns <code>true</code> iff the given <code>value</code> is valid according the given requirements.</p> </div> <div class="content"><div class='highlight'><pre> validate: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">value, requirementFirstArg</span>) </span>{ <span class="hljs-keyword">if</span> (<span class="hljs-keyword">this</span>.fn) { <span class="hljs-comment">// Legacy style validator</span> <span class="hljs-keyword">if</span> (<span class="hljs-built_in">arguments</span>.length > <span class="hljs-number">3</span>) <span class="hljs-comment">// If more args then value, requirement, instance...</span> requirementFirstArg = [].slice.call(<span class="hljs-built_in">arguments</span>, <span class="hljs-number">1</span>, <span class="hljs-number">-1</span>); <span class="hljs-comment">// Skip first arg (value) and last (instance), combining the rest</span> <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.fn(value, requirementFirstArg); } <span class="hljs-keyword">if</span> ($.isArray(value)) { <span class="hljs-keyword">if</span> (!<span class="hljs-keyword">this</span>.validateMultiple) <span class="hljs-keyword">throw</span> <span class="hljs-string">'Validator `'</span> + <span class="hljs-keyword">this</span>.name + <span class="hljs-string">'` does not handle multiple values'</span>; <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.validateMultiple(...arguments); } <span class="hljs-keyword">else</span> { <span class="hljs-keyword">if</span> (<span class="hljs-keyword">this</span>.validateNumber) { <span class="hljs-keyword">if</span> (<span class="hljs-built_in">isNaN</span>(value)) <span class="hljs-keyword">return</span> <span class="hljs-literal">false</span>; <span class="hljs-built_in">arguments</span>[<span class="hljs-number">0</span>] = <span class="hljs-built_in">parseFloat</span>(<span class="hljs-built_in">arguments</span>[<span class="hljs-number">0</span>]); <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.validateNumber(...arguments); } <span class="hljs-keyword">if</span> (<span class="hljs-keyword">this</span>.validateString) { <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.validateString(...arguments); } <span class="hljs-keyword">throw</span> <span class="hljs-string">'Validator `'</span> + <span class="hljs-keyword">this</span>.name + <span class="hljs-string">'` only handles multiple values'</span>; } },</pre></div></div> </li> <li id="section-8"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-8">¶</a> </div> <p>Parses <code>requirements</code> into an array of arguments, according to <code>this.requirementType</code></p> </div> <div class="content"><div class='highlight'><pre> parseRequirements: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">requirements, extraOptionReader</span>) </span>{ <span class="hljs-keyword">if</span> (<span class="hljs-string">'string'</span> !== <span class="hljs-keyword">typeof</span> requirements) {</pre></div></div> </li> <li id="section-9"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-9">¶</a> </div> <p>Assume requirement already parsed but make sure we return an array</p> </div> <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">return</span> $.isArray(requirements) ? requirements : [requirements]; } <span class="hljs-keyword">var</span> type = <span class="hljs-keyword">this</span>.requirementType; <span class="hljs-keyword">if</span> ($.isArray(type)) { <span class="hljs-keyword">var</span> values = convertArrayRequirement(requirements, type.length); <span class="hljs-keyword">for</span> (<span class="hljs-keyword">var</span> i = <span class="hljs-number">0</span>; i < values.length; i++) values[i] = convertRequirement(type[i], values[i]); <span class="hljs-keyword">return</span> values; } <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> ($.isPlainObject(type)) { <span class="hljs-keyword">return</span> convertExtraOptionRequirement(type, requirements, extraOptionReader); } <span class="hljs-keyword">else</span> { <span class="hljs-keyword">return</span> [convertRequirement(type, requirements)]; } },</pre></div></div> </li> <li id="section-10"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-10">¶</a> </div> <p>Defaults:</p> </div> <div class="content"><div class='highlight'><pre> requirementType: <span class="hljs-string">'string'</span>, <span class="hljs-attr">priority</span>: <span class="hljs-number">2</span> }; <span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> ParsleyValidator;</pre></div></div> </li> </ul> </div> <script type="text/javascript">var _gaq=_gaq||[];_gaq.push(["_setAccount","UA-37229467-1"]);_gaq.push(["_trackPageview"]);(function(){var e=document.createElement("script");e.type="text/javascript";e.async=true;e.src=("https:"==document.location.protocol?"https://ssl":"http://www")+".google-analytics.com/ga.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})();</script></body> </html>