feat(rules): Added OneOf rule

Author: ricardogobbosouza

README.md

@@ -121,6 +121,7 @@ The library can be loaded either as a standalone script, or through an [AMD](htt
 - [ObjectTypeStrict](docs/object-type-strict.md)
 - [ObjectType](docs/object-type.md)
 - [Odd](docs/odd.md)
+- [OneOf](docs/one-of.md)
 - [PerfectSquare](docs/perfect-square.md)
 - [Pesel](docs/pesel.md)
 - [Phone](docs/phone.md)

awesome-validator.min.js

@@ -0,0 +1,23 @@
+# One Of
+
+Will validate if exactly one inner validator passes.
+
+Valid values:
+
+```js
+validator.oneOf(
+    validator.alwaysInvalid(),
+    validator.alwaysInvalid(),
+    validator.alwaysValid()
+).validate(null);
+```
+
+Invalid values:
+
+```js
+validator.oneOf(
+    validator.alwaysInvalid(),
+    validator.alwaysValid(),
+    validator.alwaysValid()
+).validate(null);
+```

docs/one-of.md

@@ -42,6 +42,7 @@ export * from './object-instance';
 export * from './object-type-strict';
 export * from './object-type';
 export * from './odd';
+export * from './one-of';
 export * from './perfect-square';
 export * from './pesel';
 export * from './phone';

src/rules/index.ts

@@ -0,0 +1,21 @@
+import { Validatable } from './../validatable';
+import { AbstractComposite } from './abstract-composite';
+
+export class OneOf extends AbstractComposite {
+
+    /**
+     * Validate.
+     */
+    public validate(input: any): boolean {
+        const rules: Validatable[] = this.getRules();
+        let rulesPassedCount: number = 0;
+
+        for (const rule of rules) {
+            if (rule.validate(input)) {
+                rulesPassedCount++;
+            }
+        }
+
+        return rulesPassedCount === 1;
+    }
+}

src/rules/one-of.ts

@@ -51,6 +51,7 @@ export class Validator extends AllOf {
     public static objectTypeStrict = (): Validator => new Validator(new rules.ObjectTypeStrict());
     public static objectType = (): Validator => new Validator(new rules.ObjectType());
     public static odd = (): Validator => new Validator(new rules.Odd());
+    public static oneOf = (...args: Validatable[]): Validator => new Validator(new rules.OneOf(...args));
     public static perfectSquare = (): Validator => new Validator(new rules.PerfectSquare());
     public static pesel = (): Validator => new Validator(new rules.Pesel());
     public static phone = (): Validator => new Validator(new rules.Phone());
@@ -130,6 +131,7 @@ export class Validator extends AllOf {
     public objectTypeStrict = (): this => this.addRule(new rules.ObjectTypeStrict());
     public objectType = (): this => this.addRule(new rules.ObjectType());
     public odd = (): this => this.addRule(new rules.Odd());
+    public oneOf = (...args: Validatable[]): this => this.addRule(new rules.OneOf(...args));
     public perfectSquare = (): this => this.addRule(new rules.PerfectSquare());
     public pesel = (): this => this.addRule(new rules.Pesel());
     public phone = (): this => this.addRule(new rules.Phone());

src/validator.ts

@@ -0,0 +1,26 @@
+import { assert } from 'chai';
+
+import { AbstractRule } from '../../src/rules/abstract-rule';
+import { AlwaysInvalid } from '../../src/rules/always-invalid';
+import { AlwaysValid } from '../../src/rules/always-valid';
+import { OneOf } from '../../src/rules/one-of';
+
+describe('OneOf', () => {
+
+    it('is rule', () => {
+        assert.instanceOf(new OneOf(), AbstractRule);
+    });
+
+    it('values is valid', () => {
+        assert.isTrue(new OneOf(new AlwaysValid()).validate(null));
+        assert.isTrue(new OneOf(new AlwaysValid(), new AlwaysInvalid()).validate(null));
+        assert.isTrue(new OneOf(new AlwaysValid(), new AlwaysInvalid(), new AlwaysInvalid()).validate(null));
+    });
+
+    it('values is not valid', () => {
+        assert.isFalse(new OneOf(new AlwaysInvalid()).validate(null));
+        assert.isFalse(new OneOf(new AlwaysInvalid(), new AlwaysInvalid()).validate(null));
+        assert.isFalse(new OneOf(new AlwaysInvalid(), new AlwaysValid(), new AlwaysValid()).validate(null));
+    });
+
+});

test/rules/one-of.ts

@@ -67,6 +67,8 @@ describe('Validator', () => {
         assert.instanceOf(V.objectTypeStrict(), V);
         assert.instanceOf(V.objectType(), V);
         assert.instanceOf(V.odd(), V);
+        assert.instanceOf(V.oneOf(), V);
+        assert.instanceOf(V.oneOf(V.alwaysValid()), V);
         assert.instanceOf(V.perfectSquare(), V);
         assert.instanceOf(V.pesel(), V);
         assert.instanceOf(V.phone(), V);
@@ -168,6 +170,8 @@ describe('Validator', () => {
         assert.instanceOf(v.objectTypeStrict(), V);
         assert.instanceOf(v.objectType(), V);
         assert.instanceOf(v.odd(), V);
+        assert.instanceOf(v.oneOf(), V);
+        assert.instanceOf(v.oneOf(V.alwaysValid()), V);
         assert.instanceOf(v.perfectSquare(), V);
         assert.instanceOf(v.pesel(), V);
         assert.instanceOf(v.phone(), V);