tests + documentation.

Author: vitaly-t

README.md

@@ -20,12 +20,14 @@ $ npm install spex
 ## Usage
 
 * For any [Promises/A+] library: [Promise], [Bluebird], [When], [Q], [RSVP], etc.
-```javascript
+
+```js
 var promise = require('bluebird');
 var spex = require('spex')(promise);
 ```
+
 * For ES6 Promise:
-```javascript
+```js
 var spex = require('spex')(Promise);
 ```
 

jsdoc/fixLinks.js

@@ -17,7 +17,7 @@ var links = {
 
 function fixLinks(source) {
     return source.replace(/\$\[[a-z0-9\s/+-.]+\]/gi, function (name) {
-        var sln = name.replace(/\$\[|\]/g, ''); // stripped link name;
+        var sln = name.replace(/\$\[|]/g, ''); // stripped link name;
         if (sln in links) {
             return '<a href="' + links[sln] + '">' + sln + '</a>';
         }

jsdoc/tutorials/batch.md

@@ -28,7 +28,7 @@ And this is where method [batch] helps:
 
 Let's start with a positive example, and throw in a few combinations of [mixed values].
 
-```javascript
+```js
 var spex = require('spex')(Promise);
 
 // function that returns a promise;
@@ -102,4 +102,5 @@ ERROR: [ 'World' ]
 This is just to simplify quick access to the list of errors that occurred.
 
 [batch]:http://vitaly-t.github.io/spex/global.html#batch
-[mixed values]:https://github.com/vitaly-t/spex/wiki/Mixed-Values
+[mixed values]:http://vitaly-t.github.io/spex/tutorial-mixed.html
+

jsdoc/tutorials/sequencing.md

@@ -52,7 +52,7 @@ Result: [ 2, 3, 5, 7, 11, 13, 17, 19, 23, 29 ]
 
 Now let's create the same sequence using spex:
 
-```javascript
+```js
 function source(index, data) {
     return nextPrime(data);
 }
@@ -83,13 +83,16 @@ Let's see how the [sequence] performs compared to the direct calculation as we i
 
 * `direct` - direct sequence calculation;
 * `number` - using [sequence] with the `source` that returns numbers:
-```javascript
+
+```js
 function source(index, data) {
     return nextPrime(data);
 }
 ```
+
 * `promise` - using [sequence] with the `source` that returns promises:
-```javascript
+
+```js
 function source(index, data) {
     return Promise.resolve(nextPrime(data));
 }
@@ -98,6 +101,6 @@ function source(index, data) {
 * Two measurements for the [sequence]: ES6 Promise / Bluebird
 * Measured under NodeJS 4.1.1, 64-bit, with i7-4770 @ 3.85GHz
 
-[mixed value]:https://github.com/vitaly-t/spex/wiki/Mixed-Values
+[mixed value]:http://vitaly-t.github.io/spex/tutorial-mixed.html
 [sequence]:http://vitaly-t.github.io/spex/global.html#sequence
 [Bluebird]:https://github.com/petkaantonov/bluebird

jsdoc/tutorials/streaming.md

@@ -56,7 +56,7 @@ DATA: [ 'zero', 'one', 'two', 'three' ]
 And if we run the same sequence without tracking (default):
 
 ```js
-spex.sequence(source, dest)
+spex.sequence(source, {dest: dest})
     .then(function (data) {
         console.log('DATA:', data); // print result;
     });

jsdoc/tutorials/throttling.md

@@ -82,7 +82,7 @@ function dest(index, data, delay) {
     });
 }
 
-spex.sequence(source, dest)
+spex.sequence(source, {dest: dest})
     .then(function (data) {
         console.log('DATA:', data);
     });

test/ext/stream/readSpec.js

@@ -113,7 +113,7 @@ describe('Stream/Read - positive', function () {
     var stm;
 
     beforeEach(function () {
-        stm = fs.createReadStream(__filename);
+        stm = fs.createReadStream(__filename, {encoding: 'utf8'});
     });
 
     afterEach(function () {
@@ -128,6 +128,7 @@ describe('Stream/Read - positive', function () {
                     result = data;
                     done();
                 });
+
             function receiver() {
                 return promise.resolve();
             }
@@ -145,6 +146,7 @@ describe('Stream/Read - positive', function () {
                     result = data;
                     done();
                 });
+
             function receiver() {
                 return promise.resolve();
             }
@@ -170,6 +172,7 @@ describe('Stream/Read - positive', function () {
                 .then(function () {
                     done();
                 });
+
             function receiver(index, data, delay) {
                 r = {
                     index: index,
@@ -187,4 +190,22 @@ describe('Stream/Read - positive', function () {
         });
     });
 
+    describe('chunk read', function () {
+        var result;
+        beforeEach(function (done) {
+            spex.stream.read(stm, receiver, {readChunks: true})
+                .then(function () {
+                    done();
+                });
+
+            function receiver(index, data, delay) {
+                result = data;
+            }
+        });
+        it('must receive all the data', function () {
+            expect(Array.isArray(result)).toBe(true);
+            expect(result.length).toBe(1);
+            expect(result[0].length).toBeGreaterThan(500);
+        });
+    });
 });