Add .isObject() and .isArray() (and switch from underscore to lodash to do it)

Author: chilts

ReadMe.md

@@ -15,7 +15,14 @@ Advantages over JSON Schema:
 * control over error message depending on which validation fails
 * errors relate to the property name, not randomly placed in an arbitrary array
 
-Code Coverage using `c8`:
+We aim to test every part of `sound` which means we currently have over 350 tests.
+
+```
+# tests 369
+# pass  369
+```
+
+We also aim to have 100% code coverage of `sound.js` - using `c8` - which is now almost 700 lines:
 
 ```
 ----------|---------|----------|---------|---------|-------------------
@@ -128,6 +135,42 @@ check.val: {
 }
 ```
 
+## Checks ##
+
+* isString()
+* isInteger()
+* isFloat()
+* isBoolean()
+* isDate()
+* isObject()
+* isArray()
+* isUrl()
+* isDomain()
+* isEmailAddress()
+* isToken()
+* isMatch()
+* isEnum()
+* toTrim()
+* toLowerCase()
+* toUpperCase()
+* toReplace()
+* isEqual()
+* isNotEmpty()
+* isMinLen()
+* isMaxLen()
+* isMinVal()
+* isMaxVal()
+* isGreaterThan()
+* isLessThan()
+
+## Coercions ##
+
+* toString()
+* toString()
+* toInteger()
+* toFloat()
+* toBoolean()
+
 ## Unknown Params ##
 
 Only params that we know about are passed back as `check.val`.

package.json

@@ -21,7 +21,7 @@
   },
   "dependencies": {
     "isemail": "^3.2.0",
-    "underscore": "^1.13.4"
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
     "c8": "^7.11.3",

sound.js

@@ -11,7 +11,7 @@
 // --------------------------------------------------------------------------------------------------------------------
 
 // npm
-import * as _ from 'underscore'
+import _ from 'lodash'
 import isemail from 'isemail'
 
 const valid = {
@@ -34,6 +34,8 @@ const T_IS_INTEGER       = 'isInteger'
 const T_IS_FLOAT         = 'isFloat'
 const T_IS_BOOLEAN       = 'isBoolean'
 const T_IS_DATE          = 'isDate'
+const T_IS_OBJECT        = 'isObject'
+const T_IS_ARRAY         = 'isArray'
 
 const T_IS_URL           = 'isUrl'
 const T_IS_DOMAIN        = 'isDomain'
@@ -131,6 +133,22 @@ Constraint.prototype.isDate = function(msg) {
   return this
 }
 
+Constraint.prototype.isObject = function(msg) {
+  this.rules.push({
+    type : T_IS_OBJECT,
+    msg  : msg,
+  })
+  return this
+}
+
+Constraint.prototype.isArray = function(msg) {
+  this.rules.push({
+    type : T_IS_ARRAY,
+    msg  : msg,
+  })
+  return this
+}
+
 Constraint.prototype.isEqual = function(value, msg) {
   this.rules.push({
     type : T_IS_EQUAL,
@@ -441,6 +459,22 @@ const validateParam = function(name, value, constraint) {
         }
       }
     }
+    else if ( r.type === T_IS_OBJECT ) {
+      if ( !_.isPlainObject(value) ) {
+        return {
+          ok  : false,
+          err : r.msg || name + ' should be an object',
+        }
+      }
+    }
+    else if ( r.type === T_IS_ARRAY ) {
+      if ( !_.isArray(value) ) {
+        return {
+          ok  : false,
+          err : r.msg || name + ' should be an array',
+        }
+      }
+    }
     else if ( r.type === T_IS_EQUAL ) {
       if ( value !== r.value ) {
         return {

test/basic.js

@@ -1,4 +1,4 @@
-import * as _ from 'underscore'
+import _ from 'lodash'
 import test from 'tape'
 import sound from '../sound.js'
 
@@ -142,7 +142,7 @@ const tests = [
       yes      : 'yes',
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
       t.end()
     },
   },
@@ -163,7 +163,7 @@ const tests = [
       usernameA : '',
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
       t.ok( _.isUndefined(err.username1), "username1 string passes")
       t.ok( _.isUndefined(err.username2), "username2 string passes")
       t.ok(!_.isUndefined(err.username3), "username3 string fails")
@@ -206,7 +206,7 @@ const tests = [
       int13 : 8,
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
       t.ok( _.isUndefined(err.int1), "integer passes")
       t.ok( _.isUndefined(err.int2), "integer passes")
       t.ok(!_.isUndefined(err.int3), "integer passes")
@@ -249,7 +249,7 @@ const tests = [
       url7 : 'http://localhost.localdomain:8000/',
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
       t.ok( _.isUndefined(err.url1), "url1 passes")
       t.ok( _.isUndefined(err.url2), "url2 passes")
       t.ok( _.isUndefined(err.url3), "url3 passes")
@@ -295,7 +295,7 @@ const tests = [
       domain24 : 'status-2345.example.com',
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
       t.ok( _.isUndefined(err.domain1), "domain1 passes")
       t.ok( _.isUndefined(err.domain2), "domain2 passes")
       t.ok( _.isUndefined(err.domain3), "domain3 passes")
@@ -341,7 +341,7 @@ const tests = [
       email8 : '[email protected]',
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
       t.ok(!_.isUndefined(err.email1), "email1 fails")
       t.ok(!_.isUndefined(err.email2), "email2 fails")
       t.ok(!_.isUndefined(err.email3), "email3 fails")
@@ -371,7 +371,7 @@ const tests = [
       tok7 : '*&%@#&',
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
       t.ok( _.isUndefined(err.tok1), "tok1 passes")
       t.ok( _.isUndefined(err.tok2), "tok2 passes")
       t.ok(!_.isUndefined(err.tok3), "tok3 fails")
@@ -394,7 +394,7 @@ const tests = [
       url   : 'http://chilts.org/',
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
 
       t.end()
     },
@@ -409,7 +409,7 @@ const tests = [
       favColour2 : 'purple',
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
 
       t.ok( _.isUndefined(err.username), "username is correct")
       t.ok( _.isUndefined(err.favColour1), "red is ok")
@@ -435,7 +435,7 @@ const tests = [
       favColour7 : '',
     },
     test : function(t, err) {
-      t.ok(_.isObject(err), "is an object")
+      t.ok(_.isPlainObject(err), "is an object")
 
       t.ok( _.isUndefined(err.username), "username is correct")
       t.ok( _.isUndefined(err.favColour1), "'red' is ok")

test/coercions.js

@@ -1,4 +1,4 @@
-import * as _ from 'underscore'
+import _ from 'lodash'
 import test from 'tape'
 import sound from '../sound.js'
 
@@ -50,8 +50,8 @@ const tests = [
       percentage5 : 'not a number',
     },
     test : function(t, err, res) {
-      t.ok(_.isObject(err), "err is an object")
-      t.ok(_.isObject(res), "res is an object")
+      t.ok(_.isPlainObject(err), "err is an object")
+      t.ok(_.isPlainObject(res), "res is an object")
 
       t.ok(!_.isUndefined(err.percentage0), "-1 fails the regex")
       t.ok(_.isUndefined(err.percentage1), "0 is ok")
@@ -88,8 +88,8 @@ const tests = [
       bool10 : 'invalid',
     },
     test : function(t, err, res) {
-      t.ok(_.isObject(err), "err is an object")
-      t.ok(_.isObject(res), "res is an object")
+      t.ok(_.isPlainObject(err), "err is an object")
+      t.ok(_.isPlainObject(res), "res is an object")
 
       t.ok( _.isUndefined(err.bool0), "0 is ok")
       t.ok( _.isUndefined(err.bool1), "1 is ok")
@@ -133,8 +133,8 @@ const tests = [
       float7 : 'invalid',
     },
     test : function(t, err, res) {
-      t.ok(_.isObject(err), "err is an object")
-      t.ok(_.isObject(res), "res is an object")
+      t.ok(_.isPlainObject(err), "err is an object")
+      t.ok(_.isPlainObject(res), "res is an object")
 
       t.ok( _.isUndefined(err.float0), "0 is ok")
       t.ok( _.isUndefined(err.float1), "1 is ok")

test/conversions.js

@@ -1,4 +1,4 @@
-import * as _ from 'underscore'
+import _ from 'lodash'
 import test from 'tape'
 import sound from '../sound.js'
 
@@ -35,8 +35,8 @@ const tests = [
       notEmpty  : ' ', // gets us past the default '' check
     },
     test : function(t, err, res) {
-      t.ok(_.isObject(err), "err is an object")
-      t.ok(_.isObject(res), "res is an object")
+      t.ok(_.isPlainObject(err), "err is an object")
+      t.ok(_.isPlainObject(res), "res is an object")
 
       t.ok(!_.isUndefined(err.username0), "string fails")
       t.ok(_.isUndefined(err.username1), "string passes")