0.1.2

README.md

@@ -1,5 +1,5 @@
 # taskbuffer
-Flexible task organization for gulp.
+Flexible task organization for gulp. TypeScript ready!
 
 ## Status
 [![Coverage Status](https://coveralls.io/repos/github/pushrocks/taskbuffer/badge.svg?branch=master)](https://coveralls.io/github/pushrocks/taskbuffer?branch=master)
@@ -12,7 +12,7 @@ npm install taskbuffer --save
 
 ## Concepts 
 
-#### Task
+### class `Task`
 * A Task in its most simple form is a function that is executed when the task runs.
 * A Task can have a **preTask** and an **afterTask**
   (those are run before or after the main function whenever the task is called)
@@ -27,6 +27,30 @@ npm install taskbuffer --save
 * Task.triggered() is an Observable stream that emits events every time a task call is called and every time a call is completed.
 * Task is compatible to gulp streams.
 
-#### Taskchain
-* Multiple Tasks can be combined in a bigger task using a Taskchain. Taskchain extends Task.
+### class `TaskChain`
+* TaskChain extends Task.
+* Multiple Tasks can be combined in a bigger task using a TaskChain.
+* While the tasks are async in themselve, TaskChain **runs Tasks serialized** (one after the other)
+* that means that tasks can rely on each other and 
 
+### class `TaskParallel`
+* TaskParallel extends Task.
+* like TaskChain, however **tasks run in parallel**
+* Tasks cannot rely on each other.
+
+### Usage
+We highly recommend TypeScript as this module supports **TypeScript intellisense**.
+```
+import * as taskbuffer from "taskbuffer";
+
+myTask = new taskbuffer.Task({
+  preTask: someOtherTask // optional, don't worry loops are prevented
+  afterTask: someOtherTask // optional, don't worry loops are prevented
+  name:"myTask1",
+  taskFunction:() => {
+    // do some stuff and return promise
+    // pass on any data through promise resolution
+    // Use TypeScript for better understanding and code completion
+  }
+})
+```

dist/index.d.ts

@@ -1,2 +1,5 @@
-export * from "./taskbuffer.classes";
+export { Task } from "./taskbuffer.classes.task";
+export { Taskchain } from "./taskbuffer.classes.taskchain";
+export { Taskparallel } from "./taskbuffer.classes.taskparallel";
+export { Taskspace } from "./taskbuffer.classes.taskspace";
 import "./taskbuffer.classes.helpers";

dist/index.js

@@ -1,10 +1,14 @@
 "use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
 /// <reference path="./typings/main.d.ts" />
-__export(require("./taskbuffer.classes"));
+var taskbuffer_classes_task_1 = require("./taskbuffer.classes.task");
+exports.Task = taskbuffer_classes_task_1.Task;
+var taskbuffer_classes_taskchain_1 = require("./taskbuffer.classes.taskchain");
+exports.Taskchain = taskbuffer_classes_taskchain_1.Taskchain;
+var taskbuffer_classes_taskparallel_1 = require("./taskbuffer.classes.taskparallel");
+exports.Taskparallel = taskbuffer_classes_taskparallel_1.Taskparallel;
+var taskbuffer_classes_taskspace_1 = require("./taskbuffer.classes.taskspace");
+exports.Taskspace = taskbuffer_classes_taskspace_1.Taskspace;
 // import for naming only
 require("./taskbuffer.classes.helpers");
 
-//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7QUFBQSw0Q0FBNEM7QUFDNUMsaUJBQWMsc0JBQXNCLENBQUMsRUFBQTtBQUVyQyx5QkFBeUI7QUFDekIsUUFBTyw4QkFBOEIsQ0FBQyxDQUFEIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxyXG5leHBvcnQgKiBmcm9tIFwiLi90YXNrYnVmZmVyLmNsYXNzZXNcIjtcclxuXHJcbi8vIGltcG9ydCBmb3IgbmFtaW5nIG9ubHlcclxuaW1wb3J0IFwiLi90YXNrYnVmZmVyLmNsYXNzZXMuaGVscGVyc1wiIl19
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSw0Q0FBNEM7QUFDNUMsd0NBQW1CLDJCQUEyQixDQUFDO0FBQXZDLDhDQUF1QztBQUMvQyw2Q0FBd0IsZ0NBQWdDLENBQUM7QUFBakQsNkRBQWlEO0FBQ3pELGdEQUEyQixtQ0FBbUMsQ0FBQztBQUF2RCxzRUFBdUQ7QUFDL0QsNkNBQXdCLGdDQUFnQyxDQUFDO0FBQWpELDZEQUFpRDtBQUV6RCx5QkFBeUI7QUFDekIsUUFBTyw4QkFBOEIsQ0FBQyxDQUFEIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxyXG5leHBvcnQge1Rhc2t9IGZyb20gXCIuL3Rhc2tidWZmZXIuY2xhc3Nlcy50YXNrXCI7XHJcbmV4cG9ydCB7VGFza2NoYWlufSBmcm9tIFwiLi90YXNrYnVmZmVyLmNsYXNzZXMudGFza2NoYWluXCI7XHJcbmV4cG9ydCB7VGFza3BhcmFsbGVsfSBmcm9tIFwiLi90YXNrYnVmZmVyLmNsYXNzZXMudGFza3BhcmFsbGVsXCI7XHJcbmV4cG9ydCB7VGFza3NwYWNlfSBmcm9tIFwiLi90YXNrYnVmZmVyLmNsYXNzZXMudGFza3NwYWNlXCI7XHJcblxyXG4vLyBpbXBvcnQgZm9yIG5hbWluZyBvbmx5XHJcbmltcG9ydCBcIi4vdGFza2J1ZmZlci5jbGFzc2VzLmhlbHBlcnNcIiJdfQ==

dist/taskbuffer.classes.d.ts

@@ -1,2 +0,0 @@
-export * from "./taskbuffer.classes.task";
-export * from "./taskbuffer.classes.taskchain";

dist/taskbuffer.classes.helpers.d.ts

@@ -1,4 +1,4 @@
-import { Task } from "./taskbuffer.classes";
+import { Task } from "./taskbuffer.classes.task";
 export declare let emptyTaskFunction: () => any;
 export declare let isTask: (taskArg: any) => boolean;
 export declare let isTaskTouched: (taskArg: Task, touchedTasksArray: Task[]) => boolean;

dist/taskbuffer.classes.js

@@ -1,8 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-__export(require("./taskbuffer.classes.task"));
-__export(require("./taskbuffer.classes.taskchain"));
-
-//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRhc2tidWZmZXIuY2xhc3Nlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBQUEsaUJBQWMsMkJBQ2QsQ0FBQyxFQUR3QztBQUN6QyxpQkFBYyxnQ0FDZCxDQUFDLEVBRDZDIiwiZmlsZSI6InRhc2tidWZmZXIuY2xhc3Nlcy5qcyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gXCIuL3Rhc2tidWZmZXIuY2xhc3Nlcy50YXNrXCJcclxuZXhwb3J0ICogZnJvbSBcIi4vdGFza2J1ZmZlci5jbGFzc2VzLnRhc2tjaGFpblwiXHJcbiJdfQ==

dist/taskbuffer.classes.taskchain.d.ts

@@ -1,4 +1,4 @@
-import { Task } from "./taskbuffer.classes";
+import { Task } from "./taskbuffer.classes.task";
 export declare class Taskchain extends Task {
     taskArray: Task[];
     private _oraObject;

dist/taskbuffer.classes.taskparallel.d.ts

@@ -0,0 +1,7 @@
+import { Task } from "./taskbuffer.classes.task";
+export declare class Taskparallel extends Task {
+    taskArray: Task[];
+    constructor(optionsArg: {
+        taskArray: Task[];
+    });
+}

dist/taskbuffer.classes.taskparallel.js

@@ -0,0 +1,32 @@
+"use strict";
+var __extends = (this && this.__extends) || function (d, b) {
+    for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p];
+    function __() { this.constructor = d; }
+    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+};
+/// <reference path="./typings/main.d.ts" />
+var plugins = require("./taskbuffer.plugins");
+var taskbuffer_classes_task_1 = require("./taskbuffer.classes.task");
+var Taskparallel = (function (_super) {
+    __extends(Taskparallel, _super);
+    function Taskparallel(optionsArg) {
+        var _this = this;
+        var options = plugins.lodash.assign(optionsArg, {
+            taskFunction: function () {
+                var done = plugins.Q.defer();
+                var promiseArray; // stores promises of all tasks, since they run in parallel
+                _this.taskArray.forEach(function (taskArg) {
+                    promiseArray.push(taskArg.trigger());
+                });
+                plugins.Q.all(promiseArray)
+                    .then(done.resolve);
+                return done.promise;
+            }
+        });
+        _super.call(this, options);
+    }
+    return Taskparallel;
+}(taskbuffer_classes_task_1.Task));
+exports.Taskparallel = Taskparallel;
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRhc2tidWZmZXIuY2xhc3Nlcy50YXNrcGFyYWxsZWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsNENBQTRDO0FBQzVDLElBQVksT0FBTyxXQUFNLHNCQUN6QixDQUFDLENBRDhDO0FBRS9DLHdDQUFtQiwyQkFFbkIsQ0FBQyxDQUY2QztBQUU5QztJQUFrQyxnQ0FBSTtJQUVsQyxzQkFBWSxVQUVYO1FBSkwsaUJBc0JDO1FBakJPLElBQUksT0FBTyxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUMvQixVQUFVLEVBQ1Y7WUFDSSxZQUFZLEVBQUM7Z0JBQ1QsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztnQkFDN0IsSUFBSSxZQUFZLENBQUMsQ0FBQywyREFBMkQ7Z0JBQzdFLEtBQUksQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLFVBQVMsT0FBWTtvQkFDeEMsWUFBWSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQztnQkFDekMsQ0FBQyxDQUFDLENBQUE7Z0JBQ0YsT0FBTyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDO3FCQUN0QixJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO2dCQUN4QixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztZQUN4QixDQUFDO1NBQ0osQ0FDSixDQUFBO1FBQ0Qsa0JBQU0sT0FBTyxDQUFDLENBQUM7SUFDbkIsQ0FBQztJQUNMLG1CQUFDO0FBQUQsQ0F0QkEsQUFzQkMsQ0F0QmlDLDhCQUFJLEdBc0JyQztBQXRCWSxvQkFBWSxlQXNCeEIsQ0FBQSIsImZpbGUiOiJ0YXNrYnVmZmVyLmNsYXNzZXMudGFza3BhcmFsbGVsLmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxyXG5pbXBvcnQgKiBhcyBwbHVnaW5zIGZyb20gXCIuL3Rhc2tidWZmZXIucGx1Z2luc1wiXHJcbmltcG9ydCAqIGFzIGhlbHBlcnMgZnJvbSBcIi4vdGFza2J1ZmZlci5jbGFzc2VzLmhlbHBlcnNcIlxyXG5pbXBvcnQge1Rhc2t9IGZyb20gXCIuL3Rhc2tidWZmZXIuY2xhc3Nlcy50YXNrXCJcclxuXHJcbmV4cG9ydCBjbGFzcyBUYXNrcGFyYWxsZWwgZXh0ZW5kcyBUYXNrIHtcclxuICAgIHRhc2tBcnJheTpUYXNrW107XHJcbiAgICBjb25zdHJ1Y3RvcihvcHRpb25zQXJnOntcclxuICAgICAgICB0YXNrQXJyYXk6VGFza1tdXHJcbiAgICB9KXtcclxuICAgICAgICBsZXQgb3B0aW9ucyA9IHBsdWdpbnMubG9kYXNoLmFzc2lnbihcclxuICAgICAgICAgICAgb3B0aW9uc0FyZyxcclxuICAgICAgICAgICAge1xyXG4gICAgICAgICAgICAgICAgdGFza0Z1bmN0aW9uOigpID0+IHtcclxuICAgICAgICAgICAgICAgICAgICBsZXQgZG9uZSA9IHBsdWdpbnMuUS5kZWZlcigpO1xyXG4gICAgICAgICAgICAgICAgICAgIGxldCBwcm9taXNlQXJyYXk7IC8vIHN0b3JlcyBwcm9taXNlcyBvZiBhbGwgdGFza3MsIHNpbmNlIHRoZXkgcnVuIGluIHBhcmFsbGVsXHJcbiAgICAgICAgICAgICAgICAgICAgdGhpcy50YXNrQXJyYXkuZm9yRWFjaChmdW5jdGlvbih0YXNrQXJnOlRhc2spe1xyXG4gICAgICAgICAgICAgICAgICAgICAgICBwcm9taXNlQXJyYXkucHVzaCh0YXNrQXJnLnRyaWdnZXIoKSk7XHJcbiAgICAgICAgICAgICAgICAgICAgfSlcclxuICAgICAgICAgICAgICAgICAgICBwbHVnaW5zLlEuYWxsKHByb21pc2VBcnJheSlcclxuICAgICAgICAgICAgICAgICAgICAgICAgLnRoZW4oZG9uZS5yZXNvbHZlKTtcclxuICAgICAgICAgICAgICAgICAgICByZXR1cm4gZG9uZS5wcm9taXNlO1xyXG4gICAgICAgICAgICAgICAgfVxyXG4gICAgICAgICAgICB9XHJcbiAgICAgICAgKVxyXG4gICAgICAgIHN1cGVyKG9wdGlvbnMpO1xyXG4gICAgfVxyXG59XHJcblxyXG4iXX0=

dist/taskbuffer.classes.taskspace.d.ts

@@ -0,0 +1,2 @@
+export declare class Taskspace {
+}

dist/taskbuffer.classes.taskspace.js

@@ -1,3 +1,9 @@
+"use strict";
+var Taskspace = (function () {
+    function Taskspace() {
+    }
+    return Taskspace;
+}());
+exports.Taskspace = Taskspace;
 
-
-//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsImZpbGUiOiJ0YXNrYnVmZmVyLmNsYXNzZXMudGFza3NwYWNlLmpzIiwic291cmNlc0NvbnRlbnQiOltdfQ==
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRhc2tidWZmZXIuY2xhc3Nlcy50YXNrc3BhY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUlBO0lBQUE7SUFFQSxDQUFDO0lBQUQsZ0JBQUM7QUFBRCxDQUZBLEFBRUMsSUFBQTtBQUZZLGlCQUFTLFlBRXJCLENBQUEiLCJmaWxlIjoidGFza2J1ZmZlci5jbGFzc2VzLnRhc2tzcGFjZS5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vLyA8cmVmZXJlbmNlIHBhdGg9XCIuL3R5cGluZ3MvbWFpbi5kLnRzXCIgLz5cclxuaW1wb3J0ICogYXMgcGx1Z2lucyBmcm9tIFwiLi90YXNrYnVmZmVyLnBsdWdpbnNcIlxyXG5pbXBvcnQgKiBhcyBoZWxwZXJzIGZyb20gXCIuL3Rhc2tidWZmZXIuY2xhc3Nlcy5oZWxwZXJzXCJcclxuXHJcbmV4cG9ydCBjbGFzcyBUYXNrc3BhY2Uge1xyXG4gICAgXHJcbn0iXX0=

package.json

@@ -1,7 +1,7 @@
 {
   "name": "taskbuffer",
-  "version": "0.1.0",
-  "description": "manage triggers and execution of tasks with promises",
+  "version": "0.1.2",
+  "description": "Flexible task organization for gulp. TypeScript ready!",
   "main": "dist/index.js",
   "scripts": {
     "test": "(npmts)"

test/test.ts

@@ -57,8 +57,7 @@ describe("taskbuffer",function(){
                 name:"task1",
                 taskFunction:function(){
                     let done = plugins.q.defer();
-                    console.log("Task1 run");
-                    done.resolve();
+                    setTimeout(done.resolve,2000);
                     return done.promise;
                 }
             }),
@@ -66,13 +65,13 @@ describe("taskbuffer",function(){
                 name:"task2",
                 taskFunction: function(){
                     let done = plugins.q.defer();
-                    console.log("Task2 run");
-                    done.resolve();
+                    setTimeout(done.resolve,2000);
                     return done.promise;
                 }
             }),
         ];
         it("should run tasks in sequence",function(done){
+            this.timeout(5000);
             testTaskchain = new taskbuffer.Taskchain({
                 name:"Taskchain1",
                 taskArray:testTaskArray

ts/index.ts

@@ -1,5 +1,8 @@
 /// <reference path="./typings/main.d.ts" />
-export * from "./taskbuffer.classes";
+export {Task} from "./taskbuffer.classes.task";
+export {Taskchain} from "./taskbuffer.classes.taskchain";
+export {Taskparallel} from "./taskbuffer.classes.taskparallel";
+export {Taskspace} from "./taskbuffer.classes.taskspace";
 
 // import for naming only
 import "./taskbuffer.classes.helpers"

ts/taskbuffer.classes.helpers.ts

@@ -1,6 +1,6 @@
 /// <reference path="./typings/main.d.ts" />
 import plugins = require("./taskbuffer.plugins");
-import {Task} from "./taskbuffer.classes"
+import {Task} from "./taskbuffer.classes.task";
 
 export let emptyTaskFunction = function(){
     let done = plugins.Q.defer();

ts/taskbuffer.classes.taskchain.ts

@@ -1,11 +1,11 @@
 /// <reference path="./typings/main.d.ts" />
 import * as plugins from "./taskbuffer.plugins";
-import {Task} from "./taskbuffer.classes";
+import {Task} from "./taskbuffer.classes.task";
 import helpers = require("./taskbuffer.classes.helpers");
 
 export class Taskchain extends Task {
     taskArray:Task[];
-    private _oraObject;
+    private _oraObject:plugins.beautylog.Ora;
     constructor(optionsArg:{
         name?:string,
         log?:boolean,
@@ -13,23 +13,25 @@ export class Taskchain extends Task {
     }){
         let options = plugins.lodash.assign(
             {
-                name:"unnamed Task",
+                name:"unnamed Taskchain",
                 log:false
             },
             optionsArg,
             {
                 taskFunction: () => { // this is the function that gets executed when TaskChain is triggered
-                    console.log("running taskchain function");
                     let done = plugins.Q.defer(); // this is the starting Deferred object 
                     let taskCounter = 0;
                     let iterateTasks = () => {
                         if(typeof this.taskArray[taskCounter] != "undefined"){
+                            this._oraObject.text(this.name + " running: Task" + this.taskArray[taskCounter].name);
                             this.taskArray[taskCounter].trigger()
                                 .then(()=>{
+                                    this._oraObject.log(this.taskArray[taskCounter].name,"ok");
                                     taskCounter++;
                                     iterateTasks();
                                 });     
                         } else {
+                            this._oraObject.endOk("Taskchain \"" + this.name +  "\" completed successfully");
                             done.resolve();
                         }
                     };
@@ -55,14 +57,4 @@ export class Taskchain extends Task {
         this._oraObject.start(this.name + " running...");
         return helpers.runTask(this);
     }
-};
-
-let myTask = new Taskchain(
-    {
-        taskArray: [
-            new Task({
-                taskFunction:function(){}
-            })
-        ]
-    }
-);
+};

ts/taskbuffer.classes.taskparallel.ts

@@ -0,0 +1,29 @@
+/// <reference path="./typings/main.d.ts" />
+import * as plugins from "./taskbuffer.plugins"
+import * as helpers from "./taskbuffer.classes.helpers"
+import {Task} from "./taskbuffer.classes.task"
+
+export class Taskparallel extends Task {
+    taskArray:Task[];
+    constructor(optionsArg:{
+        taskArray:Task[]
+    }){
+        let options = plugins.lodash.assign(
+            optionsArg,
+            {
+                taskFunction:() => {
+                    let done = plugins.Q.defer();
+                    let promiseArray; // stores promises of all tasks, since they run in parallel
+                    this.taskArray.forEach(function(taskArg:Task){
+                        promiseArray.push(taskArg.trigger());
+                    })
+                    plugins.Q.all(promiseArray)
+                        .then(done.resolve);
+                    return done.promise;
+                }
+            }
+        )
+        super(options);
+    }
+}
+

ts/taskbuffer.classes.taskspace.ts

@@ -0,0 +1,7 @@
+/// <reference path="./typings/main.d.ts" />
+import * as plugins from "./taskbuffer.plugins"
+import * as helpers from "./taskbuffer.classes.helpers"
+
+export class Taskspace {
+    
+}

ts/taskbuffer.classes.ts

@@ -1,2 +0,0 @@
-export * from "./taskbuffer.classes.task"
-export * from "./taskbuffer.classes.taskchain"