⭐ new(validator): toogle support for required validator

Closes #258

Author: kazupon

src/validators.js

@@ -7,32 +7,33 @@
  * required
  * This function validate whether the value has been filled out.
  */
-export function required (val: any): boolean {
+export function required (val: any, arg?: boolean): boolean {
+  const isRequired: boolean = arg === undefined ? true : arg
   if (Array.isArray(val)) {
     if (val.length !== 0) {
       let valid: boolean = true
       for (let i = 0, l = val.length; i < l; i++) {
-        valid = required(val[i])
-        if (!valid) {
+        valid = required(val[i], isRequired)
+        if ((isRequired && !valid) || (!isRequired && valid)) {
           break
         }
       }
       return valid
     } else {
-      return false
+      return !isRequired
     }
   } else if (typeof val === 'number' || typeof val === 'function') {
-    return true
+    return isRequired
   } else if (typeof val === 'boolean') {
-    return val
+    return val === isRequired
   } else if (typeof val === 'string') {
-    return val.length > 0
+    return isRequired ? (val.length > 0) : (val.length <= 0)
   } else if (val !== null && typeof val === 'object') {
-    return Object.keys(val).length > 0
+    return isRequired ? (Object.keys(val).length > 0) : (Object.keys(val).length <= 0)
   } else if (val === null || val === undefined) {
-    return false
+    return !isRequired
   } else {
-    return false
+    return !isRequired
   }
 }
 

test/unit/validators/required.test.js

@@ -4,7 +4,7 @@ describe('required', () => {
   describe('string', () => {
     describe('not empty', () => {
       it('should be true', () => {
-        assert(required('hello'))
+        assert(required('hello') === true)
       })
     })
 
@@ -18,7 +18,7 @@ describe('required', () => {
   describe('boolean', () => {
     describe('true', () => {
       it('should be true', () => {
-        assert(required(true))
+        assert(required(true) === true)
       })
     })
 
@@ -32,19 +32,19 @@ describe('required', () => {
   describe('numeric', () => {
     describe('integer', () => {
       it('should be true', () => {
-        assert(required(11))
+        assert(required(11) === true)
       })
     })
 
     describe('float', () => {
       it('should be true', () => {
-        assert(required(0.11))
+        assert(required(0.11) === true)
       })
     })
 
     describe('0', () => {
       it('should be true', () => {
-        assert(required(0))
+        assert(required(0) === true)
       })
     })
   })
@@ -58,7 +58,7 @@ describe('required', () => {
 
     describe('not empty', () => {
       it('should be true', () => {
-        assert(required({ foo: 'bar' }))
+        assert(required({ foo: 'bar' }) === true)
       })
     })
   })
@@ -72,7 +72,7 @@ describe('required', () => {
 
     describe('not empty', () => {
       it('should be true', () => {
-        assert(required([1, 'foo']))
+        assert(required([1, 'foo']) === true)
       })
     })
 
@@ -97,7 +97,7 @@ describe('required', () => {
 
   describe('function', () => {
     it('should be true', () => {
-      assert(required(() => {}))
+      assert(required(() => {}) === true)
     })
   })
 
@@ -112,4 +112,118 @@ describe('required', () => {
       assert(required(null) === false)
     })
   })
+
+  describe('toggle', () => {
+    describe('string', () => {
+      describe('not empty', () => {
+        it('should be false', () => {
+          assert(required('hello', false) === false)
+        })
+      })
+
+      describe('empty', () => {
+        it('should be true', () => {
+          assert(required('', false) === true)
+        })
+      })
+    })
+
+    describe('boolean', () => {
+      describe('true', () => {
+        it('should be false', () => {
+          assert(required(true, false) === false)
+        })
+      })
+
+      describe('false', () => {
+        it('should be true', () => {
+          assert(required(false, false) === true)
+        })
+      })
+    })
+
+    describe('numeric', () => {
+      describe('integer', () => {
+        it('should be false', () => {
+          assert(required(11, false) === false)
+        })
+      })
+
+      describe('float', () => {
+        it('should be false', () => {
+          assert(required(0.11, false) === false)
+        })
+      })
+
+      describe('0', () => {
+        it('should be false', () => {
+          assert(required(0, false) === false)
+        })
+      })
+    })
+
+    describe('object', () => {
+      describe('empty', () => {
+        it('should be true', () => {
+          assert(required({}, false) === true)
+        })
+      })
+
+      describe('not empty', () => {
+        it('should be false', () => {
+          assert(required({ foo: 'bar' }, false) === false)
+        })
+      })
+    })
+
+    describe('array', () => {
+      describe('empty', () => {
+        it('should be true', () => {
+          assert(required([], false) === true)
+        })
+      })
+
+      describe('not empty', () => {
+        it('should be false', () => {
+          assert(required([1, 'foo'], false) === false)
+        })
+      })
+
+      describe('include empty string', () => {
+        it('should be true', () => {
+          assert(required([1, ''], false) === true)
+        })
+      })
+
+      describe('include null', () => {
+        it('should be true', () => {
+          assert(required([1, null], false) === true)
+        })
+      })
+
+      describe('include undefined', () => {
+        it('should be true', () => {
+          assert(required([1, '2', undefined], false) === true)
+        })
+      })
+    })
+
+    describe('function', () => {
+      it('should be false', () => {
+        assert(required(() => {}, false) === false)
+      })
+    })
+
+    describe('undefined', () => {
+      it('should be true', () => {
+        assert(required(undefined, false) === true)
+      })
+    })
+
+    describe('null', () => {
+      it('should be true', () => {
+        assert(required(null, false) === true)
+      })
+    })
+  })
 })