First working Gulp implementation based on streams

Author: Marc Rooding

.gitignore

@@ -2,4 +2,5 @@ node_modules
 npm-debug.log
 tmp
 .DS_Store
-.idea
+.idea
+output/

Gruntfile.js

@@ -1,26 +1,27 @@
-# grunt-protractor-cucumber-html-report
+# gulp-protractor-cucumber-html-report
 
 > Generate html report from JSON file returned by cucumber js json formatter
+> 
 
 ## Getting Started
-This plugin requires Grunt `~0.4.5`
+This plugin requires Grunt `~3.9.0`
 
-If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
+If you haven't used [Gulp](http://gulpjs.com/) before, be sure to check out the [Getting Started](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md) guide, as it explains how to create a Gulpfile as well as install and use Gulp plugins. Once you're familiar with that process, you may install this plugin with this command:
 
 ```shell
-npm install grunt-protractor-cucumber-html-report --save-dev
+npm install gulp-protractor-cucumber-html-report --save-dev
 ```
 
-Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
+Once the plugin has been installed, it may be enabled inside your Gulpfile with this line of JavaScript:
 
 ```js
-grunt.loadNpmTasks('grunt-protractor-cucumber-html-report');
+var reporter = require('gulp-protractor-cucumber-html-report');
 ```
 
 ## The "protractor-cucumber-html-report" task
 
 ### Overview
-In your project's Gruntfile, add a section named `protractor-cucumber-html-report` to the data object passed into `grunt.initConfig()`.
+In your project's Gulpfile, add a section named `protractor-cucumber-html-report` to the data object passed into `grunt.initConfig()`.
 
 ```js
 grunt.initConfig({
@@ -37,17 +38,17 @@ grunt.initConfig({
 
 ### Options
 
-#### options.separator
+#### dest
 Type: `String`
-Default value: `',  '`
+Default value: `'.'`
 
-A string value that is used to do something with whatever.
+The output directory for the HTML report relative from the Gulpfile
 
-#### options.punctuation
+#### filename
 Type: `String`
-Default value: `'.'`
+Default value: `'report.html'`
 
-A string value that is used to do something else with whatever else.
+The filename for the HTML report
 
 ### Usage Examples
 
@@ -68,5 +69,9 @@ grunt.initConfig({
 ## Contributing
 In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
 
+## Copyright
+ 
+Copyright for portions of project [gulp-protractor-cucumber-html-report](https://github.com/mrooding/gulp-protractor-cucumber-html-report) are held by Robert Hilscher, 2015 as part of project [grunt-protractor-cucumber-html-report](https://github.com/robhil/grunt-protractor-cucumber-html-report). All other copyright for project [gulp-protractor-cucumber-html-report](https://github.com/mrooding/gulp-protractor-cucumber-html-report) are held by Marc Rooding, 2015.
+
 ## Release History
-_(Nothing yet)_
+_(Nothing yet)_

README.md

@@ -0,0 +1,17 @@
+'use strict';
+
+var gulp   = require('gulp'),
+jshint = require('gulp-jshint');
+
+gulp.task('develop', function() {
+    function scripts() {
+        return gulp.src('*.js')
+            .pipe(jshint())
+            .pipe(jshint.reporter('jshint-stylish'));
+    }
+
+    var watcher = gulp.watch('*.js');
+    watcher.on('change', scripts);
+
+    return scripts();
+});

gulpfile.js

@@ -0,0 +1,50 @@
+var through = require('through2'),
+gutil = require('gulp-util'),
+formatter = require('./lib/html_formatter'),
+path = require('path'),
+fs = require('fs-extra'),
+PluginError = gutil.PluginError;
+
+var PLUGIN_NAME = 'gulp-protractor-cucumber-html-reporter';
+
+function gulpProtractorCucumberHtmlReport(opts) {
+    var currentDir = __dirname;
+
+    opts = opts || {};
+    if (!opts.dest) {
+        opts.dest = '.';
+    }
+    if (!opts.filename) {
+        opts.filename = 'report.html';
+    }
+    opts.templates = {
+        featureTemplate: path.join(currentDir, './templates/feature_template.html'),
+        headerTemplate: path.join(currentDir, './templates/header_template.html'),
+        reportTemplate: path.join(currentDir, './templates/report_template.html'),
+        scenarioTemplate: path.join(currentDir, './templates/scenario_template.html'),
+        stepTemplate: path.join(currentDir, './templates/step_template.html')
+    };
+
+    return through.obj(function (file, enc, cb) {
+        if (file.isNull()) {
+            return cb(null, file);
+        }
+
+        if (file.isBuffer()) {
+            var testResults = JSON.parse(file.contents);
+
+            fs.writeFileSync(opts.dest + '/' + opts.filename, formatter.generateReport(testResults, opts.templates));
+
+            fs.copySync(currentDir + '/templates/assets', opts.dest + '/assets/');
+
+            gutil.log('File ' + opts.filename + ' has been created in \'' + opts.dest + '\' directory');
+        } else {
+            throw new PluginError(PLUGIN_NAME, '[Error] Currently only buffers are supported');
+        }
+
+        return cb(null, file);
+    });
+}
+
+// Exporting the plugin main function
+module.exports = gulpProtractorCucumberHtmlReport;

index.js

@@ -1,41 +1,50 @@
 {
-  "name": "grunt-protractor-cucumber-html-report",
+  "name": "gulp-protractor-cucumber-html-report",
   "description": "Generate html report from JSON file returned by cucumber-js json formatter",
-  "version": "0.0.8",
-  "homepage": "https://github.com/robhil/grunt-protractor-cucumber-html-report",
+  "version": "0.0.1",
+  "homepage": "https://github.com/mrooding/gulp-protractor-cucumber-html-report",
   "author": {
-    "name": "Hilscher, Robert",
-    "email": "robert.hilscher@pearson.com"
+    "name": "Rooding, Marc",
+    "email": "mrooding@xebia.com"
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/robhil/grunt-protractor-cucumber-html-report.git"
+    "url": "git://github.com/mrooding/gulp-protractor-cucumber-html-report.git"
   },
   "bugs": {
-    "url": "https://github.com/robhil/grunt-protractor-cucumber-html-report/issues"
+    "url": "https://github.com/mrooding/gulp-protractor-cucumber-html-report/issues"
   },
   "licenses": [
     {
       "type": "MIT",
-      "url": "https://github.com/roberthilscher/grunt-protractor-cucumber-html-report/blob/master/LICENSE-MIT"
+      "url": "https://github.com/mrooding/gulp-protractor-cucumber-html-report/blob/master/LICENSE-MIT"
     }
   ],
   "engines": {
     "node": ">= 0.8.0"
   },
   "scripts": {
-    "test": "grunt test"
+    "test": "mocha"
   },
-  "devDependencies": {
-    "grunt-contrib-jshint": "^0.9.2",
-    "grunt-contrib-clean": "^0.5.0",
-    "grunt-contrib-nodeunit": "^0.3.3",
-    "grunt": "~0.4.5"
+  "files": [
+    "index.js"
+  ],
+  "dependencies": {
+    "gulp-util": "^3.0.0",
+    "through2": "^0.6.1"
   },
-  "peerDependencies": {
-    "grunt": "~0.4.5"
+  "devDependencies": {
+    "chai": "^3.2.0",
+    "cucumber": "^0.5.2",
+    "event-stream": "^3.3.1",
+    "fs-extra": "^0.22.1",
+    "gulp": "^3.9.0",
+    "gulp-jshint": "^1.11.2",
+    "jshint-stylish": "^2.0.1",
+    "mocha": "^2.2.5",
+    "vinyl": "^0.5.0"
   },
   "keywords": [
-    "gruntplugin"
+    "gulpplugin"
   ]
-}
+}