feat(rules): Added Iterable rule

Author: ricardogobbosouza

README.md

@@ -110,6 +110,7 @@ The library can be loaded either as a standalone script, or through an [AMD](htt
 - [InstanceOf](docs/instance-of.md)
 - [IntType](docs/int-type.md)
 - [IntVal](docs/int-val.md)
+- [Iterable](docs/iterable.md)
 - [Json](docs/json.md)
 - [Label](docs/label.md)
 - [LeapDate](docs/leap-date.md)

awesome-validator.min.js

@@ -0,0 +1,23 @@
+# Iterable
+
+Validates if the input is iterable.
+
+Valid values:
+
+```js
+validator.iterable().validate([]);
+validator.iterable().validate('foo');
+validator.iterable().validate(new Set());
+validator.iterable().validate(new Map());
+```
+
+Invalid values:
+
+```js
+
+validator.iterable().validate(null);
+validator.iterable().validate(undefined);
+validator.iterable().validate(false);
+validator.iterable().validate(0);
+validator.iterable().validate({});
+```

docs/iterable.md

@@ -31,6 +31,7 @@ export * from './in';
 export * from './instance-of';
 export * from './int-type';
 export * from './int-val';
+export * from './iterable';
 export * from './json';
 export * from './label';
 export * from './leap-date';

src/rules/index.ts

@@ -0,0 +1,11 @@
+import { AbstractRule } from './abstract-rule';
+
+export class Iterable extends AbstractRule {
+
+    /**
+     * Validate.
+     */
+    public validate(input: any): boolean {
+        return Symbol.iterator in Object(input);
+    }
+}

src/rules/iterable.ts

@@ -41,6 +41,7 @@ export class Validator extends AllOf {
     public static instanceOf = (instanceName: any): Validator => new Validator(new rules.InstanceOf(instanceName));
     public static intType = (): Validator => new Validator(new rules.IntType());
     public static intVal = (): Validator => new Validator(new rules.IntVal());
+    public static iterable = (): Validator => new Validator(new rules.Iterable());
     public static json = (): Validator => new Validator(new rules.Json());
     public static label = (): Validator => new Validator(new rules.Label());
     public static leapDate = (format?: moment.MomentFormatSpecification): Validator => new Validator(new rules.LeapDate(format));
@@ -146,6 +147,7 @@ export class Validator extends AllOf {
     public instanceOf = (instanceName: any): this => this.addRule(new rules.InstanceOf(instanceName));
     public intType = (): this => this.addRule(new rules.IntType());
     public intVal = (): this => this.addRule(new rules.IntVal());
+    public iterable = (): this => this.addRule(new rules.Iterable());
     public json = (): this => this.addRule(new rules.Json());
     public label = (): this => this.addRule(new rules.Label());
     public leapDate = (format?: moment.MomentFormatSpecification): this => this.addRule(new rules.LeapDate(format));

src/validator.ts

@@ -0,0 +1,70 @@
+import { assert } from 'chai';
+
+import { AbstractRule } from '../../src/rules/abstract-rule';
+import { Iterable } from '../../src/rules/iterable';
+
+describe('Iterable', () => {
+
+    let iterable: Iterable;
+
+    beforeEach(() => {
+        iterable = new Iterable();
+    });
+
+    it('is rule', () => {
+        assert.instanceOf(iterable, AbstractRule);
+    });
+
+    it('values is valid', () => {
+        assert.isTrue(iterable.validate([]));
+        assert.isTrue(iterable.validate(new Array()));
+        assert.isTrue(iterable.validate(Array()));
+        assert.isTrue(iterable.validate([1, 2, 3]));
+        assert.isTrue(iterable.validate(new Array(1, 2, 3)));
+        assert.isTrue(iterable.validate(Array(1, 2, 3)));
+        assert.isTrue(iterable.validate(['foo', 'bar', 'foobaz']));
+        assert.isTrue(iterable.validate(new Array('foo', 'bar', 'foobaz')));
+        assert.isTrue(iterable.validate(Array('foo', 'bar', 'foobaz')));
+        assert.isTrue(iterable.validate(new Set([1, 2, 3])));
+        assert.isTrue(iterable.validate(new Set(['foo', 'bar', 'foobar'])));
+        assert.isTrue(iterable.validate(new Map().set(1, 'bar')));
+        assert.isTrue(iterable.validate(new Map().set('foo', 'bar')));
+        assert.isTrue(iterable.validate(String()));
+        assert.isTrue(iterable.validate(''));
+        assert.isTrue(iterable.validate('0'));
+        assert.isTrue(iterable.validate(' '));
+        assert.isTrue(iterable.validate('   '));
+        assert.isTrue(iterable.validate('foo'));
+        assert.isTrue(iterable.validate(String('fooBar')));
+    });
+
+    it('values is not valid', () => {
+        assert.isFalse(iterable.validate(Boolean()));
+        assert.isFalse(iterable.validate(Number()));
+        assert.isFalse(iterable.validate(null));
+        assert.isFalse(iterable.validate(undefined));
+        assert.isFalse(iterable.validate(false));
+        assert.isFalse(iterable.validate(0));
+        assert.isFalse(iterable.validate(0.0));
+        assert.isFalse(iterable.validate(-0.0));
+        assert.isFalse(iterable.validate({}));
+        assert.isFalse(iterable.validate(new Object()));
+        assert.isFalse(iterable.validate(Object.create(null)));
+        assert.isFalse(iterable.validate(Boolean(true)));
+        assert.isFalse(iterable.validate(Number(1)));
+        assert.isFalse(iterable.validate({foo: 'bar'}));
+        assert.isFalse(iterable.validate(true));
+        assert.isFalse(iterable.validate(1));
+        assert.isFalse(iterable.validate(-1));
+        assert.isFalse(iterable.validate(1.0));
+        assert.isFalse(iterable.validate(-1.0));
+        assert.isFalse(iterable.validate(1));
+        assert.isFalse(iterable.validate(1.0));
+        assert.isFalse(iterable.validate(1.1));
+        assert.isFalse(iterable.validate(new Object({foo: 'bar'})));
+
+        class Foo {}
+        assert.isFalse(iterable.validate(new Foo()));
+    });
+
+});

test/rules/iterable.ts

@@ -63,6 +63,7 @@ describe('Validator', () => {
         assert.instanceOf(V.instanceOf(Object), V);
         assert.instanceOf(V.intType(), V);
         assert.instanceOf(V.intVal(), V);
+        assert.instanceOf(V.iterable(), V);
         assert.instanceOf(V.json(), V);
         assert.instanceOf(V.label(), V);
         assert.instanceOf(V.leapDate(), V);
@@ -222,6 +223,7 @@ describe('Validator', () => {
         assert.instanceOf(v.instanceOf(Object), V);
         assert.instanceOf(v.intType(), V);
         assert.instanceOf(v.intVal(), V);
+        assert.instanceOf(v.iterable(), V);
         assert.instanceOf(v.json(), V);
         assert.instanceOf(v.label(), V);
         assert.instanceOf(v.leapDate(), V);