Add multiplesOf validators

chetankothari · chetankothari · commit fb3246e59e68 · 2016-05-16T00:18:15.000+05:30
This validator checks if the given number is multiple of a number.
diff --git a/docs/validate.html b/docs/validate.html
@@ -1473,6 +1473,7 @@ <h1>validate.js</h1>
             equalTo:              <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(v, c)</span> </span>{ <span class="hljs-keyword">return</span> v === c; },
             lessThan:             <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(v, c)</span> </span>{ <span class="hljs-keyword">return</span> v &lt; c; },
             lessThanOrEqualTo:    <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(v, c)</span> </span>{ <span class="hljs-keyword">return</span> v &lt;= c; }
+            multiplesOf:          <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(v, c)</span> </span>{ <span class="hljs-keyword">return</span> v % c === 0; }
           };</pre></div></div>
             
         </li>
diff --git a/index.html b/index.html
@@ -1572,6 +1572,8 @@ <h2>Validators</h2>
               <dd>The input can be this value at the most. The error message is <i>must be less than or equal to %{count}</i></dd>
               <dt>lessThan</dt>
               <dd>The input has to be less than this value. The error message is <i>must be less than %{count}</i></dd>
+              <dt>multiplesOf</dt>
+              <dd>The input has to be in multiples of this value. The error message is <i>must be multiples of %{count}</i></dd>
               <dt>odd</dt>
               <dd>The input has to be odd. The error message is <i>must be odd</i></dd>
               <dt>even</dt>
@@ -1590,6 +1592,7 @@ <h2>Validators</h2>
               <li><code>notEqualTo</code></li>
               <li><code>notLessThan</code></li>
               <li><code>notLessThanOrEqualTo</code></li>
+              <li><code>notMultiplesOf</code></li>
               <li><code>notOdd</code></li>
               <li><code>notEven</code></li>
             </ul>
@@ -1612,6 +1615,9 @@ <h2>Validators</h2>
 validate({duration: "3"}, {duration: {numericality: {noStrings: true}}});
 // =&gt; {"duration": ["Duration is not a number"]}
 
+validate({duration: "7"}, {duration: {numericality: {multiplesOf: 3}}});
+// =&gt; {"duration": ["Duration must be multiples of 3"]}
+
 var constraints = {
   duration: {
     numericality: {
diff --git a/specs/validators/numericality-spec.js b/specs/validators/numericality-spec.js
@@ -193,6 +193,30 @@ describe("validators.numericality", function() {
     });
   });
 
+  describe("multiplesOf", function() {
+    it("allows multiples of a number", function() {
+      expect(numericality(0, {multiplesOf: 2})).not.toBeDefined();
+      expect(numericality(5, {multiplesOf: 5})).not.toBeDefined();
+      expect(numericality(16, {multiplesOf: 8})).not.toBeDefined();
+    });
+
+    it("doesn't allow numbers that are not multiples of given number", function() {
+      var expected = ["must be multiples of 100"];
+      expect(numericality(121, {multiplesOf: 100})).toEqual(expected);
+    });
+
+    it("allows for a default message", function() {
+      var expected = "default message";
+      validate.validators.numericality.notMultiplesOf = expected;
+      expect(numericality(161, {multiplesOf: 200})).toEqual([expected]);
+    });
+
+    it("allows for a custom message", function() {
+      var expected = "custom message";
+      expect(numericality(133, {multiplesOf: 4, notMultiplesOf: expected})).toEqual([expected]);
+    });
+  });
+
   describe("odd", function() {
     it("allows odd numbers", function() {
       expect(numericality(1, {odd: true})).not.toBeDefined();
@@ -251,11 +275,12 @@ describe("validators.numericality", function() {
       greaterThanOrEqualTo: 10,
       lessThan: 5,
       lessThanOrEqualTo: 5,
+      multiplesOf: 10,
       equalTo: 20,
       odd: true,
       even: true
     };
-    expect(numericality(7.2, options)).toHaveLength(7);
+    expect(numericality(7.2, options)).toHaveLength(8);
   });
 
   it("returns options.message only once", function() {
@@ -264,6 +289,7 @@ describe("validators.numericality", function() {
       greaterThanOrEqualTo: 10,
       lessThan: 5,
       lessThanOrEqualTo: 5,
+      multiplesOf: 10,
       equalTo: 20,
       odd: true,
       even: true,
diff --git a/validate.js b/validate.js
@@ -835,7 +835,8 @@
             greaterThanOrEqualTo: function(v, c) { return v >= c; },
             equalTo:              function(v, c) { return v === c; },
             lessThan:             function(v, c) { return v < c; },
-            lessThanOrEqualTo:    function(v, c) { return v <= c; }
+            lessThanOrEqualTo:    function(v, c) { return v <= c; },
+            multiplesOf:          function(v, c) { return v % c === 0; }
           };
 
       // Strict will check that it is a valid looking number
