1.1.1

.gitignore

@@ -1,6 +1,7 @@
 node_modules/
 .settings/
 .idea/
+coverage/
 
 ts/*.js
 ts/*.js.map

README.md

@@ -1,26 +1,39 @@
 # gulp-function
 accepts call to execute in gulp pipeline.
 
-### build status/Dependencies
+### Status
 [![Build Status](https://travis-ci.org/pushrocks/gulp-function.svg?branch=v0.0.2)](https://travis-ci.org/pushrocks/gulp-function)
 [![Dependency Status](https://david-dm.org/pushrocks/gulp-function.svg)](https://david-dm.org/pushrocks/gulp-function)
 [![devDependency Status](https://david-dm.org/pushrocks/gulp-function/dev-status.svg)](https://david-dm.org/pushrocks/gulp-function#info=devDependencies)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/gulp-function/badges/code.svg)](https://www.bithound.io/github/pushrocks/gulp-function)
+[![Coverage Status](https://coveralls.io/repos/github/pushrocks/gulp-function/badge.svg?branch=master)](https://coveralls.io/github/pushrocks/gulp-function?branch=master)
 
 ### Usage
 ```javascript
 var gulp = require("gulp");
 var gulpFunction = require("gulp-function");
+var Q = require("q");
 
 var myFunction = function () {
+    var done = Q.defer();
     console.log("Hello World!")
+    
+    // NOTE:
+    // you can use done.resolve as callback function
+    // of any async tasks within this function
+    done.resolve();
+    
+    return done.promise;
 }
 
 gulp.task('gulpTest',function() {
-    gulp.src('./mydir/*.something')
+    var stream = gulp.src('./mydir/*.something')
-        .pipe(gulpFunction(myFunction,'forEach'))
+        .pipe(gulpFunction(myFunction,'forEach')) //read the notes below
-        .pipe(gulp.dest("./build/"))
+        .pipe(gulp.dest("./build/"));
+    return stream; // by returning the stream gulp knows when our task has finished.
 });
 ```
 
->Note: The first argument of gulpFunction can also be an array of multiple functionnames.  
+> Note: The first argument of gulpFunction can also be an array of multiple functionnames.
->Note: the second argument can be empty (defaults to 'forEach') or 'atEnd'
+Each function can return a promise. the pipe stop will finish when every promise is fullfilled.  
+> Note: the second argument can be empty (defaults to 'forEach') or 'atEnd'

index.d.ts

@@ -1,4 +1,6 @@
 /// <reference path="ts/typings/main.d.ts" />
-declare var through: any;
+declare var plugins: {
-declare var path: any;
+    beautylog: any;
-declare var beautylog: any;
+    Q: any;
+    through: any;
+};

index.js

@@ -1,47 +1,57 @@
 #!/usr/bin/env node
 
 /// <reference path="typings/main.d.ts" />
-var through = require("through2");
+var plugins = {
-var path = require("path");
+    beautylog: require("beautylog"),
-var beautylog = require("beautylog");
+    Q: require("q"),
-module.exports = function (functionsToExecuteArg, executionModeArg, logBoolArg) {
+    through: require("through2")
+};
+module.exports = function (functionsToExecuteArg, executionModeArg) {
     if (executionModeArg === void 0) { executionModeArg = 'forEach'; }
-    if (logBoolArg === void 0) { logBoolArg = false; }
     //important vars
-    var gulpFunction = {
+    var executionMode = executionModeArg; //can be forEach or atEnd
-        executionMode: executionModeArg,
+    var functionsToExecute = functionsToExecuteArg;
-        functionsToExecute: functionsToExecuteArg,
+    var promiseArray = [];
-        logBool: logBoolArg
+    var runFunction = function (functionArg) {
-    };
+        var returnValue = functionArg();
-    var runFunctionNames = function () {
+        if (typeof returnValue !== "undefined" && typeof returnValue.then !== "undefined") {
-        if (typeof gulpFunction.functionsToExecute == "function") {
+            promiseArray.push(returnValue);
-            gulpFunction.functionsToExecute();
         }
-        else if (Array.isArray(gulpFunction.functionsToExecute)) {
+    };
-            for (var anyFunction in gulpFunction.functionsToExecute) {
+    var checkAndRunFunction = function () {
-                anyFunction();
+        if (typeof functionsToExecute === "function") {
+            runFunction(functionsToExecute);
+        }
+        else if (Array.isArray(functionsToExecute)) {
+            for (var anyFunction in functionsToExecute) {
+                runFunction(functionsToExecute[anyFunction]);
             }
         }
         else {
-            beautylog.error('gulp-callfunction: something is strange with the given arguments');
+            plugins.beautylog.error('gulp-callfunction: something is strange with the given arguments');
         }
+        return plugins.Q.all(promiseArray);
     };
     var forEach = function (file, enc, cb) {
-        if (gulpFunction.logBool)
+        if (executionMode === 'forEach') {
-            beautylog.log(gulpFunction.executionMode);
+            checkAndRunFunction().then(function () {
-        if (gulpFunction.executionMode === 'forEach') {
+                cb(null, file);
-            if (gulpFunction.logBool)
+            });
-                beautylog.log('is forEach');
+        }
-            runFunctionNames();
+        else {
+            cb(null, file);
         }
         //tell gulp that we are complete
-        return cb(null, file);
     };
     var atEnd = function (cb) {
-        if (gulpFunction.executionMode == "atEnd") {
+        if (executionMode === "atEnd") {
-            runFunctionNames();
+            checkAndRunFunction().then(function () {
+                cb();
+            });
+        }
+        else {
+            cb();
         }
-        cb();
     };
-    return through.obj(forEach, atEnd);
+    return plugins.through.obj(forEach, atEnd);
 };

npmts.json

@@ -0,0 +1,4 @@
+{
+  "mode":"default",
+  "coveralls":true
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gulp-function",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "accepts a function call as parameter to execute in gulp pipeline",
   "main": "index.js",
   "scripts": {
@@ -25,11 +25,12 @@
   },
   "homepage": "https://github.com/pushrocks/gulp-function",
   "dependencies": {
-    "beautylog": "2.0.6",
+    "beautylog": "^2.1.1",
-    "through2": "2.0.0"
+    "q": "^1.4.1",
+    "through2": "^2.0.1"
   },
   "devDependencies": {
-    "gulp": "^3.9.0",
+    "gulp": "^3.9.1",
-    "npmts": "^2.0.2"
+    "npmts": "^2.2.3"
   }
 }

test/test.d.ts

@@ -0,0 +1,8 @@
+/// <reference path="ts/typings/main.d.ts" />
+declare var gulp: any;
+declare var gulpFunction: any;
+declare var beautylog: any;
+declare var Q: any;
+declare var myFunction: () => any;
+declare var myFunction2: () => any;
+declare var myFunction3: () => any;

test/test.js

@@ -1,17 +1,45 @@
+#!/usr/bin/env node
+
 /// <reference path="typings/main.d.ts" />
 var gulp = require("gulp");
 var gulpFunction = require("../index.js");
 var beautylog = require("beautylog");
+var Q = require("q");
 var myFunction = function () {
-    beautylog.log("Mocha Test successfull!");
+    var done = Q.defer();
+    beautylog.log("Function executed");
+    done.resolve();
+    return done.promise;
+};
+var myFunction2 = function () {
+    var done = Q.defer();
+    beautylog.ok("Function2 executed");
+    done.resolve();
+    return done.promise;
+};
+var myFunction3 = function () {
+    var done = Q.defer();
+    beautylog.success("Function3 executed");
+    done.resolve();
+    return done.promise;
 };
 describe("gulpFunction", function () {
-    it("should run through smoothly", function () {
+    it("should run through smoothly with " + "'forEach'".blue, function (done) {
-        gulp.task('default', function () {
+        gulp.src('./test/*.md')
-            gulp.src('./test/test.md')
+            .pipe(gulpFunction(myFunction, 'forEach'))
-                .pipe(gulpFunction(myFunction, 'forEach'))
+            .pipe(gulp.dest("./test/result/"));
-                .pipe(gulp.dest("./test/result/"));
+        gulp.src('./test/*.md')
-        });
+            .pipe(gulpFunction([myFunction2, myFunction3], 'forEach'))
-        gulp.start.apply(gulp, ['default']);
+            .pipe(gulp.dest("./test/result/"))
+            .pipe(gulpFunction(done, "atEnd"));
+    });
+    it("should run through smoothly with " + "'atEnd'".blue, function (done) {
+        gulp.src('./test/*.md')
+            .pipe(gulpFunction(myFunction, 'atEnd'))
+            .pipe(gulp.dest("./test/result/"));
+        gulp.src('./test/*.md')
+            .pipe(gulpFunction([myFunction2, myFunction3], 'atEnd'))
+            .pipe(gulp.dest("./test/result/"))
+            .pipe(gulpFunction(done, "atEnd"));
     });
 });

test/test02.md

@@ -0,0 +1,2 @@
+# Test.md
+This is another test file for the test.js gulp pipeline

ts/index.ts

@@ -1,45 +1,60 @@
 /// <reference path="typings/main.d.ts" />
-var through = require("through2");
+
-var path = require("path");
+var plugins = {
-var beautylog = require("beautylog");
+    beautylog: require("beautylog"),
+    Q: require("q"),
+    through: require("through2")
+}
 
 
-module.exports = function (functionsToExecuteArg:any|any[],executionModeArg:string = 'forEach', logBoolArg = false) {
+
+
+module.exports = function (functionsToExecuteArg:any|any[],executionModeArg:string = 'forEach') {
     //important vars
-    var gulpFunction = {
+    var executionMode = executionModeArg; //can be forEach or atEnd
-        executionMode: executionModeArg, //can be forEach or atEnd
+    var functionsToExecute = functionsToExecuteArg;
-        functionsToExecute: functionsToExecuteArg,
+    var promiseArray = [];
-        logBool: logBoolArg
+    var runFunction = function(functionArg){
+        var returnValue = functionArg();
+        if (typeof returnValue !== "undefined" && typeof returnValue.then !== "undefined") {
+            promiseArray.push(returnValue);
+        }
     };
 
-    var runFunctionNames = function () {
+    var checkAndRunFunction = function () {
-        if (typeof gulpFunction.functionsToExecute == "function" ) {
+        if (typeof functionsToExecute === "function" ) {
-            gulpFunction.functionsToExecute();
+            runFunction(functionsToExecute);
-        } else if (Array.isArray(gulpFunction.functionsToExecute)) {
+        } else if (Array.isArray(functionsToExecute)) {
-            for (var anyFunction in gulpFunction.functionsToExecute) {
+            for (var anyFunction in functionsToExecute) {
-                anyFunction();
+                runFunction(functionsToExecute[anyFunction]);
             }
         } else {
-            beautylog.error('gulp-callfunction: something is strange with the given arguments');
+            plugins.beautylog.error('gulp-callfunction: something is strange with the given arguments');
         }
+        return plugins.Q.all(promiseArray);
     };
 
 
     var forEach = function (file, enc, cb) {
-        if (gulpFunction.logBool) beautylog.log(gulpFunction.executionMode);
+        if (executionMode === 'forEach') {
-        if (gulpFunction.executionMode === 'forEach') {
+            checkAndRunFunction().then(function(){
-            if(gulpFunction.logBool) beautylog.log('is forEach');
+                cb(null, file);
-            runFunctionNames();
+            });
+        } else {
+            cb(null, file);
         }
         //tell gulp that we are complete
-        return cb(null, file);
+
     };
 
     var atEnd = function(cb) {
-        if (gulpFunction.executionMode == "atEnd") {
+        if (executionMode === "atEnd") {
-            runFunctionNames();
+            checkAndRunFunction().then(function(){
+                cb();
+            });
+        } else {
+            cb();
         }
-        cb();
     };
-    return through.obj(forEach,atEnd);
+    return plugins.through.obj(forEach,atEnd);
 };

ts/test.ts

@@ -2,19 +2,49 @@
 var gulp = require("gulp");
 var gulpFunction = require("../index.js");
 var beautylog = require("beautylog");
+var Q = require("q");
 
 var myFunction = function () {
-    beautylog.log("Mocha Test successfull!");
+    var done = Q.defer()
+    beautylog.log("Function executed");
+    done.resolve();
+    return done.promise;
+};
+var myFunction2 = function () {
+    var done = Q.defer();
+    beautylog.ok("Function2 executed");
+    done.resolve();
+    return done.promise;
+};
+var myFunction3 = function () {
+    var done = Q.defer();
+    beautylog.success("Function3 executed");
+    done.resolve();
+    return done.promise;
 };
 
 describe("gulpFunction",function(){
-    it("should run through smoothly",function(){
+    it("should run through smoothly with " + "'forEach'".blue,function(done){
-        gulp.task('default',function() {
+        gulp.src('./test/*.md')
-            gulp.src('./test/test.md')
+            .pipe(gulpFunction(myFunction,'forEach'))
-                .pipe(gulpFunction(myFunction,'forEach'))
+            .pipe(gulp.dest("./test/result/"));
-                .pipe(gulp.dest("./test/result/"))
+
-        });
+        gulp.src('./test/*.md')
-        gulp.start.apply(gulp, ['default']);
+            .pipe(gulpFunction([myFunction2,myFunction3],'forEach'))
+            .pipe(gulp.dest("./test/result/"))
+            .pipe(gulpFunction(done,"atEnd"));
+
+    });
+
+    it("should run through smoothly with " + "'atEnd'".blue,function(done){
+        gulp.src('./test/*.md')
+            .pipe(gulpFunction(myFunction,'atEnd'))
+            .pipe(gulp.dest("./test/result/"));
+
+        gulp.src('./test/*.md')
+            .pipe(gulpFunction([myFunction2,myFunction3],'atEnd'))
+            .pipe(gulp.dest("./test/result/"))
+            .pipe(gulpFunction(done,"atEnd"));
     });
 });