feat(rules): Added Factor rule

Author: ricardogobbosouza

README.md

@@ -97,6 +97,7 @@ The library can be loaded either as a standalone script, or through an [AMD](htt
 - [Digit](docs/digit.md)
 - [Empty](docs/empty.md)
 - [Even](docs/even.md)
+- [Factor](docs/factor.md)
 - [FalseVal](docs/false-val.md)
 - [Fibonacci](docs/fibonacci.md)
 - [File](docs/file.md)

awesome-validator.min.js

@@ -0,0 +1,21 @@
+# Factor
+
+Validates if the input is a factor of the defined dividend.
+
+Valid values:
+
+```js
+validator.factor(1).validate('1');
+validator.factor(0).validate(5);
+validator.factor(4).validate(2);
+validator.factor(0).validate(1);
+```
+
+Invalid values:
+
+```js
+validator.factor(1).validate('.2');
+validator.factor(1).validate(1.1);
+validator.factor(4).validate(3);
+validator.factor(1).validate(0);
+```

docs/factor.md

@@ -0,0 +1,31 @@
+import { AbstractRule } from './abstract-rule';
+import { IntVal } from './int-val';
+
+export class Factor extends AbstractRule {
+
+    /**
+     * Factor.
+     */
+    public constructor(public readonly dividend: number) {
+        super();
+    }
+
+    /**
+     * Validate.
+     */
+    public validate(input: any): boolean {
+        if (this.dividend === 0) {
+            return true;
+        }
+
+        const intval: IntVal = new IntVal();
+
+        if (!intval.validate(this.dividend) || !intval.validate(input)) {
+            return false;
+        }
+
+        const n: number = Number(input);
+
+        return n !== 0 && intval.validate(Math.abs(this.dividend) / Math.abs(n));
+    }
+}

src/rules/factor.ts

@@ -18,6 +18,7 @@ export * from './date-time';
 export * from './digit';
 export * from './empty';
 export * from './even';
+export * from './factor';
 export * from './false-val';
 export * from './fibonacci';
 export * from './file';

src/rules/index.ts

@@ -0,0 +1,59 @@
+import { assert } from 'chai';
+
+import { AbstractRule } from '../../src/rules/abstract-rule';
+import { Factor } from '../../src/rules/factor';
+
+describe('Factor', () => {
+
+    it('is rule', () => {
+        assert.instanceOf(new Factor(0), AbstractRule);
+    });
+
+    it('values is valid', () => {
+        assert.isTrue(new Factor(1).validate('1'));
+        assert.isTrue(new Factor(6).validate('1'));
+        assert.isTrue(new Factor(1).validate(1));
+        assert.isTrue(new Factor(2).validate(1));
+        assert.isTrue(new Factor(2).validate(2));
+        assert.isTrue(new Factor(3).validate(1));
+        assert.isTrue(new Factor(3).validate(3));
+        assert.isTrue(new Factor(4).validate(1));
+        assert.isTrue(new Factor(4).validate(2));
+        assert.isTrue(new Factor(4).validate(4));
+        assert.isTrue(new Factor(5).validate(1));
+        assert.isTrue(new Factor(5).validate(5));
+        assert.isTrue(new Factor(6).validate(1));
+        assert.isTrue(new Factor(6).validate(2));
+        assert.isTrue(new Factor(6).validate(3));
+        assert.isTrue(new Factor(6).validate(6));
+        assert.isTrue(new Factor(0).validate(0));
+        assert.isTrue(new Factor(0).validate(1));
+    });
+
+    it('values is not valid', () => {
+        assert.isFalse(new Factor(1).validate(1.1));
+        assert.isFalse(new Factor(1).validate(-1.1));
+        assert.isFalse(new Factor(1).validate('0.2'));
+        assert.isFalse(new Factor(1).validate('.2'));
+        assert.isFalse(new Factor(1).validate('-.2'));
+        assert.isFalse(new Factor(1).validate('165.7'));
+        assert.isFalse(new Factor(1).validate(''));
+        assert.isFalse(new Factor(1).validate(null));
+        assert.isFalse(new Factor(1).validate('a'));
+        assert.isFalse(new Factor(1).validate(' '));
+        assert.isFalse(new Factor(1).validate('Foo'));
+        assert.isFalse(new Factor(3).validate(2));
+        assert.isFalse(new Factor(4).validate(3));
+        assert.isFalse(new Factor(5).validate(2));
+        assert.isFalse(new Factor(5).validate(3));
+        assert.isFalse(new Factor(5).validate(4));
+        assert.isFalse(new Factor(1).validate(0));
+        assert.isFalse(new Factor(2).validate(0));
+        assert.isFalse(new Factor(0.5).validate(null));
+        assert.isFalse(new Factor(1.5).validate(null));
+        assert.isFalse(new Factor(-0.5).validate(null));
+        assert.isFalse(new Factor(-1.5).validate(null));
+        assert.isFalse(new Factor(Number.MAX_SAFE_INTEGER + 1).validate(null));
+    });
+
+});