feat(rules): Added Equals rule

Author: ricardogobbosouza

README.md

@@ -96,6 +96,7 @@ The library can be loaded either as a standalone script, or through an [AMD](htt
 - [DateTime](docs/date-time.md)
 - [Digit](docs/digit.md)
 - [Empty](docs/empty.md)
+- [Equals](docs/equals.md)
 - [Even](docs/even.md)
 - [Executable](docs/executable.md)
 - [Exists](docs/exists.md)

awesome-validator.min.js

@@ -0,0 +1,23 @@
+# Equals
+
+Validates if the input is equal to some value.
+
+Valid values:
+
+```js
+validator.equals('foo').validate('foo');
+validator.equals(1).validate('1');
+validator.equals(1).validate(1);
+validator.equals([]).validate([]);
+validator.equals([1, 2, 3]).validate([1, 2, 3]);
+validator.equals([1, 2, 3]).validate(['1', 2, 3]);
+validator.equals(null).validate(null);
+```
+
+Invalid values:
+
+```js
+validator.equals('foo').validate('foobar');
+validator.equals(null).validate('foo');
+validator.equals('foo').validate(null);
+```

docs/equals.md

@@ -58,7 +58,9 @@
     }
   },
   "dependencies": {
+    "@types/deep-equal": "^1.0.1",
     "@types/mime-types": "^2.1.0",
+    "deep-equal": "^1.0.1",
     "mime-types": "^2.1.17",
     "moment": "^2.20.1"
   },

package-lock.json

@@ -0,0 +1,26 @@
+import { AbstractRule } from './abstract-rule';
+import { ArrayVal } from './array-val';
+import { ObjectTypeStrict } from './object-type-strict';
+
+export class Equals extends AbstractRule {
+
+    /**
+     * Equals.
+     */
+    public constructor(public readonly compareTo: any) {
+        super();
+    }
+
+    /**
+     * Validate.
+     */
+    public validate(input: any): boolean {
+        if (new ObjectTypeStrict().validate(input) || new ArrayVal().validate(input)) {
+            return require('deep-equal')(input, this.compareTo);
+        }
+
+        /* tslint:disable triple-equals */
+        return input == this.compareTo;
+        /* tslint:enable triple-equals */
+    }
+}

package.json

@@ -17,6 +17,7 @@ export * from './cpf';
 export * from './date-time';
 export * from './digit';
 export * from './empty';
+export * from './equals';
 export * from './even';
 export * from './executable';
 export * from './exists';

src/rules/equals.ts

@@ -0,0 +1,41 @@
+import { assert } from 'chai';
+
+import { AbstractRule } from '../../src/rules/abstract-rule';
+import { Equals } from '../../src/rules/equals';
+
+describe('Equals', () => {
+
+    class Foo {}
+
+    it('is rule', () => {
+        assert.instanceOf(new Equals('foo'), AbstractRule);
+    });
+
+    it('values is valid', () => {
+        assert.isTrue(new Equals('foo').validate('foo'));
+        assert.isTrue(new Equals(1).validate('1'));
+        assert.isTrue(new Equals(1).validate(1));
+        assert.isTrue(new Equals([]).validate([]));
+        assert.isTrue(new Equals([1, 2, 3]).validate([1, 2, 3]));
+        assert.isTrue(new Equals([1, 2, [1, 2]]).validate([1, 2, [1, 2]]));
+        assert.isTrue(new Equals([1, 2, 3]).validate(['1', 2, 3]));
+        assert.isTrue(new Equals(null).validate(null));
+        assert.isTrue(new Equals({foo: 1}).validate({foo: 1}));
+        assert.isTrue(new Equals({foo: 1}).validate({foo: '1'}));
+
+        const s: Foo = new Foo();
+        assert.isTrue(new Equals(s).validate(s));
+    });
+
+    it('values is not valid', () => {
+        assert.isFalse(new Equals('foo').validate('foobar'));
+        assert.isFalse(new Equals(null).validate('foo'));
+        assert.isFalse(new Equals('foo').validate(null));
+        assert.isFalse(new Equals([1, 2, 3]).validate(['foo']));
+        assert.isFalse(new Equals([1, 2, [1, 2]]).validate([1, 2, [2, 1]]));
+        assert.isFalse(new Equals({foo: 'bar'}).validate({foo: 'foo'}));
+        assert.isFalse(new Equals({bar: 'foo'}).validate({foo: 'foo'}));
+        assert.isFalse(new Equals(new Foo()).validate(new Foo()));
+    });
+
+});

src/rules/index.ts

@@ -17,6 +17,7 @@ describe('Identical', () => {
         assert.isTrue(new Identical([]).validate([]));
         assert.isTrue(new Identical([1, 2, 3]).validate([1, 2, 3]));
         assert.isTrue(new Identical(null).validate(null));
+        assert.isTrue(new Identical({foo: 1}).validate({foo: 1}));
 
         const s: Foo = new Foo();
         assert.isTrue(new Identical(s).validate(s));
@@ -28,6 +29,8 @@ describe('Identical', () => {
         assert.isFalse(new Identical([1, 2, 3]).validate(['1', 2, 3]));
         assert.isFalse(new Identical(null).validate('foo'));
         assert.isFalse(new Identical('foo').validate(null));
+        assert.isFalse(new Identical({foo: 1}).validate({foo: '1'}));
+        assert.isFalse(new Identical({bar: 'foo'}).validate({foo: 'foo'}));
         assert.isFalse(new Identical(new Foo()).validate(new Foo()));
     });
 

test/rules/equals.ts

@@ -52,6 +52,10 @@
   version "4.0.10"
   resolved "https://registry.yarnpkg.com/@types/chai/-/chai-4.0.10.tgz#0eb222c7353adde8e0980bea04165d4d3b6afef3"
 
+"@types/deep-equal@^1.0.1":
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/@types/deep-equal/-/deep-equal-1.0.1.tgz#71cfabb247c22bcc16d536111f50c0ed12476b03"
+
 "@types/mime-types@^2.1.0":
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/@types/mime-types/-/mime-types-2.1.0.tgz#9ca52cda363f699c69466c2a6ccdaad913ea7a73"
@@ -1144,7 +1148,7 @@ deep-eql@^3.0.0:
   dependencies:
     type-detect "^4.0.0"
 
-deep-equal@~1.0.1:
+deep-equal@^1.0.1, deep-equal@~1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/deep-equal/-/deep-equal-1.0.1.tgz#f5d260292b660e084eff4cdbc9f08ad3247448b5"