Merge pull request #2 from mrbrunelli/feature/validate-value

feature/validate-value

Author: mrbrunelli

README.md

@@ -6,8 +6,8 @@ A Javascript object validator for tiny schemas.
 
 ![Test](https://github.com/mrbrunelli/object-validator/actions/workflows/test.yml/badge.svg)
 
-
 ## Get started
+
 ```sh
  yarn add @mrbrunelli/object-validator
 ```
@@ -25,6 +25,32 @@ const objectExample = {
   }
 }
 
-const isValid = Validate.isValid(objectExample, ['foo', 'foo.bar.message'])
+const isValid = Validate.isValid(objectExample, [
+  ['foo'],
+  ['foo.bar.message', 'Hello!']
+])
 console.log(isValid) // returns true
 ```
+
+#### Why
+
+Validating multiple fields can be very tiring in old Node versions.
+
+```js
+  // Work only Node 14 or >
+  if (objectExample?.foo?.bar?.message === 'Hello!') // anything...
+```
+
+Node 12 require massive validations.
+
+```js
+  if (objectExample && objectExample.foo && objectExample.foo.bar && objectExample.foo.bar.example === 'Hello!') // anything...
+```
+
+In this case, using a validator is better and safe.
+
+```js
+  if (Validator.isValid(objectExample, [['foo.bar.example', 'Hello!']])) // anything...
+```
+
+Now imagine validating multiple fields and values ​​from a single object in a old version of Node. Very tiring and verbose.

lib/validate.js

@@ -2,9 +2,14 @@ class Validate {
   /**
    * @example
    * const object = { foo: { bar: { message: 'Hello!' } } }
-   * const isValid = Validate.isValid(object, ['foo', 'foo.bar.message'])
+   * const isValid = Validate.isValid(object, [['foo'], ['foo.bar.message']])
    * console.log(isValid) // returns true
    *
+   * @example
+   * const object = { foo: { bar: { message: 'Hello!' } } }
+   * const isValid = Validate.isValid(object, [['foo.bar.message', 'Wrong!']])
+   * console.log(isValid) // returns false
+   *
    * @param {object} object Accepts an object schema.
    * @param {string[]} fields Accepts string array. It is used to loop provided object and validate fields.
    */
@@ -14,7 +19,7 @@ class Validate {
       object && typeof object === 'object' && Object.keys(object).length > 0
     if (!hasFields || !hasObject) return false
 
-    return fields.every((field) => {
+    return fields.every(([field, value]) => {
       const splitedFields = field.split('.')
       const [splicedField] = splitedFields.splice(0, 1)
       const joinedFields = splitedFields.join('.')
@@ -23,9 +28,12 @@ class Validate {
       const existsFieldInObject = splicedField in object
 
       if (existsFieldInObject && existsMoreFields) {
-        return Validate.isValid(object[splicedField], [joinedFields])
+        return Validate.isValid(object[splicedField], [[joinedFields, value]])
       }
 
+      const isNecessaryToCompareValues = !existsMoreFields && value
+      if (isNecessaryToCompareValues) return value === object[splicedField]
+
       return existsFieldInObject && !existsMoreFields
     })
   }

lib/validate.spec.js

@@ -10,7 +10,7 @@ const makeObjectStub = () => {
       pendingPrinting: 'false',
       transactionId: '6788329C5763C2982A9537E6DD1D122D',
       responseBody: {
-        total: '1',
+        total: '0',
         entities: {
           entity: {}
         }
@@ -35,24 +35,24 @@ describe('validate', () => {
 
   test('should return true if provided fields match with object', () => {
     const isValid = sut.isValid(objectStub, [
-      'status',
-      'data.status',
-      'data.responseBody.entities.entity'
+      ['status'],
+      ['data.status'],
+      ['data.responseBody.entities.entity']
     ])
     expect(isValid).toBeTruthy()
   })
 
   test('should return true if repeated fields is provided to math with object', () => {
     const isValid = sut.isValid(objectStub, [
-      'data.status',
-      'data.status',
-      'data.status'
+      ['data.status'],
+      ['data.status'],
+      ['data.status']
     ])
     expect(isValid).toBeTruthy()
   })
 
   test('should return false if provided fields dont exists in object', () => {
-    const isValid = sut.isValid(objectStub, ['invalid', 'invalid.invalid'])
+    const isValid = sut.isValid(objectStub, [['invalid'], ['invalid.invalid']])
     expect(isValid).toBeFalsy()
   })
 
@@ -62,31 +62,54 @@ describe('validate', () => {
   })
 
   test('should return false if provided object is empty', () => {
-    const isValid = sut.isValid({}, ['any'])
+    const isValid = sut.isValid({}, [['any']])
     expect(isValid).toBeFalsy()
   })
 
   test('should return false if a unique field of provided fields not exists in object', () => {
     const isValid = sut.isValid(objectStub, [
-      'status',
-      'data.responseBody.total',
-      'invalid'
+      ['status'],
+      ['data.responseBody.total'],
+      ['invalid']
     ])
     expect(isValid).toBeFalsy()
   })
 
   test('should calls isValid 4x with correctly params', () => {
     const spy = jest.spyOn(sut, 'isValid')
     sut.isValid(objectStub, [
-      'status',
-      'data.status',
-      'data.responseBody.total'
+      ['status'],
+      ['data.status'],
+      ['data.responseBody.total']
     ])
     expect(spy).toBeCalledTimes(4)
     expect(spy).toBeCalledWith(objectStub, [
-      'status',
-      'data.status',
-      'data.responseBody.total'
+      ['status'],
+      ['data.status'],
+      ['data.responseBody.total']
     ])
   })
+
+  test('should return true if provided field value match with object value', () => {
+    const isValid = sut.isValid(objectStub, [
+      ['status', 200],
+      ['data.status', '1'],
+      ['data.responseBody.total', '0']
+    ])
+    expect(isValid).toBeTruthy()
+  })
+
+  test('should return false if provided field value dont match with object value', () => {
+    const isValid = sut.isValid(objectStub, [['status', 400]])
+    expect(isValid).toBeFalsy()
+  })
+
+  test('should return false if 1 of 3 provided field value dont match with object value', () => {
+    const isValid = sut.isValid(objectStub, [
+      ['status', 200],
+      ['data.status', '1'],
+      ['data.responseBody.total', 'wrong']
+    ])
+    expect(isValid).toBeFalsy()
+  })
 })

package.json

@@ -1,11 +1,11 @@
 {
   "name": "@mrbrunelli/object-validator",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "A simple object validator for tiny schemas",
   "main": "index.js",
   "scripts": {
     "test": "jest --runInBand --verbose --passWithNoTests",
-    "test:watch": "yarn test --watch",
+    "tdd": "yarn test --watch",
     "test:ci": "jest --runInBand --verbose --coverage",
     "prepare": "husky install"
   },
@@ -14,7 +14,7 @@
     "url": "git+https://github.com/mrbrunelli/object-validator.git"
   },
   "keywords": ["validator", "schema", "object-validator", "schema-validator"],
-  "author": "",
+  "author": "Matheus R. Brunelli <matheus.brunelli@gmail.com>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/mrbrunelli/object-validator/issues"