Merge remote-tracking branch 'origin/master'

Conflicts:
	tasks/init.js

Author: 3pchrisd

lib/config/platform.js

@@ -4,8 +4,9 @@
  * A string representing the current OS platform
  * @type {string} 'windows' or 'unix'
  */
-var PLATFORM = (['win32','win64'].indexOf(process.platform) >= 0) ? 'windows' :
-  (process.platform === 'darwin') ? 'darwin' : 'unix';
+var PLATFORM = (['win32', 'win64'].indexOf(process.platform) >= 0) ?
+  'windows' :
+  ((process.platform === 'darwin') ? 'darwin' : 'unix');
 
 /**
  * Indicates whether the current platform is windows
@@ -44,4 +45,4 @@ module.exports = {
   isMacOS          : isMacOS,
   isUnix           : isUnix,
   userHomeDirectory: userHomeDirectory
-}
+}

lib/test/karma.js

@@ -5,9 +5,12 @@ var path            = require('path');
 var gulp            = require('gulp'),
     through         = require('through2'),
     querystring     = require('querystring'),
+    lodashMerge     = require('lodash.merge'),
     childProcess    = require('child_process');
 
-var yargs           = require('../util/yargs');
+var yargs           = require('../util/yargs'),
+    streams         = require('../config/streams'),
+    platform        = require('../config/platform');
 
 /**
  * Wrap the given value in quotation marks
@@ -18,7 +21,7 @@ function quote(value) {
   return '"' + value + '"';
 }
 
-var defaultReporterName = 'angularity-karma-reporter';
+var defaultReporterName = 'karma-angularity-reporter';
 
 var filesAppendRegex = /\/\*+\s*ANGULARITY_FILE_LIST\s*\*+\// ;
 var reportersAppendRegex = /\/\*+\s*ANGULARITY_REPORTER_LIST\s*\*+\// ;
@@ -27,6 +30,10 @@ var karmaReporterMatchNameRegex = /^karma-(.+)-reporter$/ ;
 
 /**
  * Determine the `require` path for a plugin.
+ * Note that this require path must be absolute,
+ * as it will not be required within this project,
+ * but rather by the karma runner - and therefore the current directory
+ * cannot be predicted.
  *
  * @param {string} reporterName Either a package name,
  *   *OR* an absolute path, for a karma reporter.
@@ -38,29 +45,34 @@ function getKarmaReporterPluginPath(reporterName) {
     throw 'Get Karma Reporter Plugin Path: Reporter name is unspecified';
   }
 
-  if (reporterName === defaultReporterName) {
-    return defaultReporterName;
+  //Default reporter is a dependency of angularity
+  var reporterPath = (reporterName === defaultReporterName) ?
+    path.resolve(__dirname, '../../node_modules', defaultReporterName) :
+    reporterName;
+  //Specific reporters are expected to be dependencies of the local project
+  reporterPath = (path.dirname(reporterPath) === '.') ?
+    path.resolve('node_modules', 'karma-' + reporterName + '-reporter') :
+    reporterPath;
+
+  //Either way, the absolute path of the reporter is `require`d
+  //Only to determine if it is indeed `require`able,
+  //and enable fail fast if it is not.
+  try {
+    require(reporterPath);
   }
-  else {
-    var reporterPath = (path.dirname(reporterName) === '.') ?
-      path.resolve('node_modules', 'karma-' + reporterName + '-reporter') :
-      reporterName;
-    try {
-      require(reporterPath);
-    }
-    catch (ex) {
-      throw 'Get Karma Reporter Plugin Path: Attempt to require reporter from path ' +
-        reporterPath + ' with no success.';
-    }
-    reporterPath = path.normalize(reporterPath);
-    //quirk: nodejs identifies all windows (both win32 and win64) as win32
-    if (process.platform === 'win32') {
-      //replace any single backslash characters in file paths with
-      //double backslash on windows; neither path.normalize nor path.resolve do this
-      reporterPath = reporterPath.replace( /\\/g , '\\\\' );
-    }
-    return reporterPath;
+  catch (ex) {
+    throw 'Get Karma Reporter Plugin Path: Attempt to require reporter from path ' +
+      reporterPath + ' with no success.';
   }
+  reporterPath = path.normalize(reporterPath);
+
+  if (platform.isWindows()) {
+    //Sanitise path for Windows
+    //Replace any single backslash characters in file paths with
+    //double backslash on windows; neither path.normalize nor path.resolve do this
+    reporterPath = reporterPath.replace( /\\/g , '\\\\' );
+  }
+  return reporterPath;
 }
 
 /**
@@ -106,37 +118,70 @@ function karmaCreateConfig(reporters, configFileName) {
   configFileName = configFileName || 'karma.conf.js';
   var files = [];
 
-  function transformFn(file, encoding, done) {
+  function transformFn(file, encoding, transformDone) {
     if (!file || !file.path) {
       throw 'Files must have paths';
     }
-    files.push(file.path);
-    done();
+    if (path.extname(file.path) === '.js') {
+      files.push(file.path);
+    }
+    else {
+      //non-javascript files, such as source maps, should be included but not tested
+      files.push({
+        pattern: file.path,
+        included: false,
+      });
+    }
+    transformDone();
   }
 
-  function flushFn(done) {
+  function flushFn(flushDone) {
     var stream = this;
-    var filesAppend = JSON.stringify(files, null, '  ');
-    var reportersAppend = JSON.stringify(reporters.map(getKarmaReporterName), null, '  ');
-    var pluginsAppend = '[\n' + reporters.map(function(reporter) {
-      return 'require("' + getKarmaReporterPluginPath(reporter) + '")';
-    }).join(',\n  ') + '\n]';
-
-    //aggregate and append to karma.conf.js in the project root folder
-    gulp
-      .src(path.resolve(configFileName))
-      .on('data', function(karmaConfigFile) {
-        var contents = karmaConfigFile.contents.toString()
-          .replace(filesAppendRegex, filesAppend)
-          .replace(reportersAppendRegex, reportersAppend)
-          .replace(reportersAppendRegex, reportersAppend)
-          .replace(pluginsAppendRegex, pluginsAppend);
-        karmaConfigFile.contents = new Buffer(contents);
-        stream.push(karmaConfigFile);
-      })
-      .on('end', function() {
-        done();
+
+    function constructFile() {
+      var filesAppend = JSON.stringify(files, null, '  ');
+      var reportersAppend = JSON.stringify(reporters.map(getKarmaReporterName), null, '  ');
+      var pluginsAppend = '[\n' + reporters.map(function(reporter) {
+        return 'require("' + getKarmaReporterPluginPath(reporter) + '")';
+      }).join(',\n  ') + '\n]';
+
+      //aggregate and append to karma.conf.js in the project root folder
+      gulp
+        .src(path.resolve(configFileName))
+        .on('data', function(karmaConfigFile) {
+          var contents = karmaConfigFile.contents.toString()
+            .replace(filesAppendRegex, filesAppend)
+            .replace(reportersAppendRegex, reportersAppend)
+            .replace(reportersAppendRegex, reportersAppend)
+            .replace(pluginsAppendRegex, pluginsAppend);
+          karmaConfigFile.contents = new Buffer(contents);
+          stream.push(karmaConfigFile);
+        })
+        .on('end', function() {
+          flushDone();
+        });
+      }
+
+    function specTransformFn(file, encoding, specFileDone) {
+      files.push({
+        pattern: file.path,
+        included: false,
       });
+      specFileDone();
+    }
+
+    function specFlushFn(specFlushDone) {
+      //delay construction of file until all *.spec.js files have been
+      //added to the files array
+      constructFile();
+      specFlushDone();
+    }
+
+    //obtain a list of *.spec.js files (file contents skipped)
+    //and add them to the list of files, with `included: false`,
+    //prior to writing to file
+    streams.jsSpec({ read: false })
+      .pipe(through.obj(specTransformFn, specFlushFn));
   }
 
   return through.obj(transformFn, flushFn);
@@ -149,13 +194,15 @@ function karmaCreateConfig(reporters, configFileName) {
  *
  * @param {Array.<string>} [reporters] The name of the karma reporter to use
  * @param {number} [bannerWidth] The width of banner comment, zero or omitted for none
- * @returns {stream.Through} A through strconcateam that performs the operation of a gulp stream
+ * @returns {stream.Through} A through stream intended to have a gulp stream piped through it
  */
 function karmaRun(reporters, bannerWidth) {
   var options = {
     configFile: undefined
   };
-  reporters = reporters || [];
+  if (reporters.constructor !== Array || reporters.length === 0) {
+    throw new Error('No reporters specified');
+  }
 
   return through.obj(function transformFn(file, encoding, done) {
     options.configFile = file.path;
@@ -164,45 +211,20 @@ function karmaRun(reporters, bannerWidth) {
   function streamFn(done) {
     var appPath = path.join(__dirname, 'karma-background.js');
     var data    = querystring.escape(JSON.stringify(options));
-    var command = [ 'node', quote(appPath), data ].join(' ');
-
-    childProcess.exec(command, { cwd: process.cwd() }, function reporter(stderr, stdout) {
-      if (reporters.length > 0) {
-        if (stdout) {
-          process.stdout.write(stdout);
-        }
-        if (stderr) {
-          process.stderr.write(stderr);
-        }
-        done();
-        return;
-      }
 
-      //TODO @bguiz replace reporter function with a standard karma reporter,
-      //and extract it to own module
-
-      //default reporter by parsing the stdout and stderr of karma
-      var report;
-      if (stdout) {
-        report = stdout
-          .replace(/^\s+/gm, '')                                  // remove leading whitespace
-          .replace(/^(LOG.*\n$)/gm, options.silent ? '' : '$1')   // remove logging
-          .replace(/at\s+null\..*/gm, '')                         // remove file reference
-          .replace(/\n\n/gm, '\n')                                // consolidate consecutive line breaks
-          .replace(/^\n|\n$/g, '');                               // remove leading and trailing line breaks overall
-      }
-      else if (stderr) {
-        var analysis = /$Error\:\s*(.*)$/mg.exec(stderr);
-        report = analysis ? analysis[1] : stderr;
-      }
-      if (report) {
-        var width = Number(bannerWidth) || 0;
-        var hr    = new Array(width + 1);   // this is a good trick to repeat a character N times
-        var start = (width > 0) ? (hr.join('\u25BC') + '\n') : '';
-        var stop  = (width > 0) ? (hr.join('\u25B2') + '\n') : '';
-        process.stdout.write(start + '\n' + report + '\n\n' + stop);
-      }
+    var karmaBackground = childProcess.spawn('node', [appPath, data], {
+      cwd: process.cwd(),
+      stdio: [process.stdin, process.stdout, process.stderr],
+      env: lodashMerge(process.env, {
+        //NOTE this workaround is necessary, see issue:
+        //https://github.com/sindresorhus/supports-color/issues/13
+        //TODO @bguiz remove workaround when issue has been resolved
+        SUPPORTS_COLOR: true,
+      }),
+    });
+    karmaBackground.on('close', function(exitCode) {
       done();
+      return;
     });
   });
 };

npm-shrinkwrap.json

@@ -69,6 +69,7 @@
     "ide-template": "latest",
     "inquirer": "latest",
     "karma": "latest",
+    "karma-angularity-reporter": "latest",
     "karma-chrome-launcher": "latest",
     "karma-jasmine": "latest",
     "karma-spec-reporter": "latest",