deprecate: clulib.async.forEach and clulib.async.forEachRight in favo…

…r of clulib.array.asyncForEach and clulib.array.asyncForEachRight

lib/array/array.js

@@ -6,4 +6,28 @@ goog.provide('clulib.array');
  */
 clulib.array.removeHoles = function (array) {
   return array.filter(e => true);
+};
+
+/**
+ * @param {Array<T>} array
+ * @param {function(T, number, Array<T>): Promise} action
+ * @returns {Promise}
+ * @template T
+ */
+clulib.array.asyncForEach = function (array, action) {
+  return array.reduce((promise, element, index, arr) => {
+    return promise.then(() => action(element, index, arr));
+  }, Promise.resolve());
+};
+
+/**
+ * @param {Array<T>} array
+ * @param {function(T, number, Array<T>): Promise} action
+ * @returns {Promise}
+ * @template T
+ */
+clulib.array.asyncForEachRight = function (array, action) {
+  return array.reduceRight((promise, element, index, arr) => {
+    return promise.then(() => action(element, index, arr));
+  }, Promise.resolve());
 };

lib/async/async.js

@@ -1,25 +1,21 @@
 goog.provide('clulib.async');
 
+goog.require('clulib.array');
+
 /**
  * @param {Array<T>} array
  * @param {function(T, number, Array<T>): Promise} action
  * @returns {Promise}
  * @template T
+ * @deprecated Use [clulib.array.asyncForEach] instead
  */
-clulib.async.forEach = function (array, action) {
-  return array.reduce((promise, element, index, arr) => {
-    return promise.then(() => action(element, index, arr));
-  }, Promise.resolve());
-};
+clulib.async.forEach = clulib.array.asyncForEach;
 
 /**
  * @param {Array<T>} array
  * @param {function(T, number, Array<T>): Promise} action
  * @returns {Promise}
  * @template T
+ * @deprecated Use [clulib.array.asyncForEachRight] instead
  */
-clulib.async.forEachRight = function (array, action) {
-  return array.reduceRight((promise, element, index, arr) => {
-    return promise.then(() => action(element, index, arr));
-  }, Promise.resolve());
-};
+clulib.async.forEachRight = clulib.array.asyncForEachRight;

lib/cm/NodeTree.js

@@ -112,7 +112,7 @@ clulib.cm.NodeTree.prototype.createTree = function (rootElement) {
    */
   const denseOrderedNodeGroups = clulib.array.removeHoles(sparseOrderedNodeGroups);
 
-  return clulib.async.forEachRight(denseOrderedNodeGroups, group => {
+  return clulib.array.asyncForEachRight(denseOrderedNodeGroups, group => {
     return Promise.all(group.map(node => node.initialize()));
   });
 };

test/array/array_spec.js

@@ -2,6 +2,8 @@ goog.provide('clulib.array.test');
 
 goog.require('clulib.array');
 
+goog.require('goog.array');
+
 clulib.array.test.main = () => {
   describe('clulib.array', () => {
     describe('removeHoles', () => {
@@ -12,5 +14,58 @@ clulib.array.test.main = () => {
         expect(a).toEqual(b);
       });
     });
+
+    describe('asyncForEach', () => {
+      it('should execute async functions for every element in an array consecutively', done => {
+        const strings = ['first', 'second', 'third'];
+        const stringsCopy = goog.array.clone(strings);
+        const delays = [500, 200, 50];
+        let result = '';
+
+        clulib.array.asyncForEach(strings, (element, index, array) => {
+          expect(array).toEqual(strings);
+          expect(element).toEqual(array[index]);
+
+          return new Promise(resolve => {
+            setTimeout(() => {
+              result += element;
+              resolve();
+            }, delays[index]);
+          });
+        }).then(() => {
+          expect(result).toEqual(strings.join(''));
+          expect(strings).toEqual(stringsCopy);
+          done();
+        });
+      });
+    });
+
+    describe('asyncForEachRight', () => {
+      it('should execute async functions for every element in an array consecutively, in reverse order', done => {
+        const strings = ['first', 'second', 'third'];
+        const stringsCopy = goog.array.clone(strings);
+        const stringsCopyReversed = goog.array.clone(strings);
+        stringsCopyReversed.reverse();
+
+        const delays = [500, 200, 50];
+        let result = '';
+
+        clulib.array.asyncForEachRight(strings, (element, index, array) => {
+          expect(array).toEqual(strings);
+          expect(element).toEqual(array[index]);
+
+          return new Promise(resolve => {
+            setTimeout(() => {
+              result += element;
+              resolve();
+            }, delays[index]);
+          });
+        }).then(() => {
+          expect(result).toEqual(stringsCopyReversed.join(''));
+          expect(strings).toEqual(stringsCopy);
+          done();
+        });
+      });
+    });
   });
 };

test_main.js

@@ -1,7 +1,5 @@
 goog.provide('test_main');
 
 goog.require('clulib.array.test');
-goog.require('clulib.async.test');
 
-clulib.array.test.main();
-clulib.async.test.main();
+clulib.array.test.main();