Update docs + minor refactoring

docs/SUMMARY.md

@@ -19,6 +19,7 @@
   * [explain](docs/api/explain.md)
   * [fdef](docs/api/fdef.md)
   * [gen](docs/api/gen.md)
+  * [getSpec](docs/api/getSpec.md)
   * [intIn](docs/api/intIn.md)
   * [isIntInRange](docs/api/isIntInRange.md)
   * [isValid](docs/api/isValid.md)

docs/api-reference.md

@@ -3,11 +3,12 @@ Descriptions for the different functions where copied from the original
 
 | clojure.spec  | speculaas    |
 |:-------------:|:------------:|
-| &             | [amp](api/amp.md)          |
-| +             | [plus](api/plus.md)         |
-| *             | [star](api/star.md)         |
-| coll-of       | [collOf](api/collOf.md)       |
-| double-in     | [doubleIn](api/doubleIn.md)     |
+| &             | [amp](api/amp.md)            |
+| +             | [plus](api/plus.md)          |
+| *             | [star](api/star.md)          |
+| coll-of       | [collOf](api/collOf.md)      |
+| double-in     | [doubleIn](api/doubleIn.md)  |
+| get-spec      | [getSpec](api/getSpec.md)    |
 | int-in        | [intIn](api/intIn.md)        |
 | int-in-range? | [isIntInRange](api/isIntInRange.md) |
 | map-of        | [mapOf](api/mapOf.md)        |

docs/api/cat.md

@@ -0,0 +1,16 @@
+cat
+=====
+
+Usage: ```cat(...)```
+
+Returns a regex op that matches (all) values in sequence, returning a map
+containing the keys of each pred and the corresponding value.
+
+[Source](https://github.com/mrijk/speculaas/blob/master/lib/cat.js)
+
+Example:
+
+```js
+const s = require('speculaas');
+const {isBoolean, isString} = s.utils;
+```

docs/api/getSpec.md

@@ -0,0 +1,19 @@
+getSpec
+=====
+
+Usage: ```getSpec(k)```
+
+Returns spec registered for keyword/symbol/var k, or undefined.
+
+[Source](https://github.com/mrijk/speculaas/blob/master/lib/def.js)
+
+Example:
+
+```js
+const s = require('speculaas');
+const {isOdd} = s.utils;
+
+s.def('::odd?', isOdd);
+s.getSpec('::odd?');
+
+```

lib/def.js

@@ -35,7 +35,7 @@ function createFunctionSpec(predicate) {
 }
 
 function getSpec(p) {
-    if (_.isString(p)) {
+    if (_.isString(p) || _.isSymbol(p)) {
         return defs[p];
     } else if (_.isObject(p)) {
         return p;

test/def.js

@@ -0,0 +1,19 @@
+const {expect} = require('chai');
+
+const s = require('../lib/spec');
+const {isOdd} = s.utils;
+
+describe('Test the define function', () => {
+
+    it('should allow an array as predicate', () => {
+        const suit = [':club', ':diamond', ':heart', ':spade'];
+        s.def('::suit', suit);
+        expect(s.isValid('::suit', ':club')).to.be.true;
+    });
+
+    it('should accept a Symbol', () => {
+        const odd = Symbol();
+        s.def(odd, isOdd);
+        expect(s.isValid(odd, 13)).to.be.true;
+    });
+});

test/getSpec.js

@@ -0,0 +1,16 @@
+const {expect} = require('chai');
+
+const s = require('../lib/spec');
+const {isOdd, isInteger} = s.utils;
+
+describe('Test the getSpec function', () => {
+
+    it('should return an existing spec', () => {
+        s.def('::odd?', s.and(isInteger, isOdd));
+        expect(s.getSpec('::odd?')).to.exist;
+    });
+
+    it('should return null on an non-existing spec', () => {
+        expect(s.getSpec('::foobar?')).to.be.undefined;
+    });
+});