Merge pull request #28 from adamgruber/develop

1.2.2
adamgruber · Jan 19, 2016 · 9c6a1fd · 9c6a1fd
2 parents b9b86f6 + 7186625
commit 9c6a1fd
Show file tree

Hide file tree

Showing 17 changed files with 309 additions and 81 deletions.
diff --git a/README.md b/README.md
@@ -4,8 +4,10 @@ mochawesome
 
 Mochawesome is a custom reporter for use with the Javascript testing framework, [mocha](http://visionmedia.github.io/mocha/). It generates a full fledged HTML/CSS report that helps visualize your test suites.
 
-##New in 1.2.0
-- New [Option](#options): change the report title in the output
+##New in 1.2.2
+- New [Options](#options):
+  - change the report title in the output
+  - generate report with assets inlined
 
 ##Features
 - At-a-glance stats including pass percentage
@@ -95,11 +97,12 @@ With options you can specify the location where reports are saved, the filename
 $ export MOCHAWESOME_REPORTDIR=customReportDir
 $ export MOCHAWESOME_REPORTNAME=customReportName
 $ export MOCHAWESOME_REPORTTITLE=customReportTitle
+$ export MOCHAWESOME_INLINEASSETS=true
 ```
 
 ####Mocha options
 ```bash
-$ mocha test.js --reporter mochawesome --reporter-options reportDir=customReportDir,reportName=customReportName,reportTitle=customReportTitle
+$ mocha test.js --reporter mochawesome --reporter-options reportDir=customReportDir,reportName=customReportName,reportTitle=customReportTitle,inlineAssets=true
 ```
 
 ```js
@@ -108,7 +111,8 @@ var mocha = new Mocha({
     reporterOptions: {
       reportDir: 'customReportDir',
       reportName: 'customReportName',
-      reportTitle: 'customReportTitle'
+      reportTitle: 'customReportTitle',
+      inlineAssets: true
     }
 });
   ```

diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,8 @@
 #Changelog
 
+###1.2.2
+- Added option to generate report with all assets inlined. See [#26](https://github.com/adamgruber/mochawesome/issues/26)
+
 ###1.2.1
 - Reset `totalTestsRegistered` when reporter is run. [PR #21](https://github.com/adamgruber/mochawesome/pull/21)
 

diff --git a/dist/css/mochawesome-64.css b/dist/css/mochawesome-64.css
diff --git a/dist/css/mochawesome.css b/dist/css/mochawesome.css
diff --git a/dist/js/vendor.js b/dist/js/vendor.js
diff --git a/gulpfile.js b/gulpfile.js
@@ -166,13 +166,12 @@ gulp.task('test', function () {
 });
 
 gulp.task('testOpts', function () {
-  mochaOpts.reporterOptions = 'reportDir=customDir,reportName=customName,reportTitle=customTitle';
+  mochaOpts.reporterOptions = 'reportDir=customDir,reportName=customName,reportTitle=customTitle,inlineAssets=true';
   return gulp.src(testPaths.basic)
     .pipe(mocha(mochaOpts))
     .on('error', console.warn.bind(console));
 });
 
-
 // Default/Combo Tasks
 gulp.task('build', ['lint'], function () {
   return gulp.start('assemble');

diff --git a/lib/config.js b/lib/config.js
@@ -11,6 +11,7 @@ module.exports = function (options) {
   config.libDir         = __dirname;
   config.reportDir      = _getOption('reportDir', options);
   config.reportTitle    = _getOption('reportTitle', options);
+  config.inlineAssets   = _getOption('inlineAssets', options, true);
   config.nodeModulesDir = path.join(__dirname, '..', 'node_modules');
 
   // Build Directories
@@ -53,17 +54,17 @@ module.exports = function (options) {
   return config;
 };
 
-function _getOption (optToGet, options) {
+function _getOption (optToGet, options, isBool) {
   var envVar = 'MOCHAWESOME_' + optToGet.toUpperCase();
   // Order of precedence
   // 1. Config option
   // 2. Environment variable
   // 3. Base config
   if (options && typeof options[optToGet] !== 'undefined') {
-    return options[optToGet];
+    return isBool ? options[optToGet] === 'true' : options[optToGet];
   }
   if (typeof process.env[envVar] !== 'undefined') {
-    return process.env[envVar];
+    return isBool ? process.env[envVar] === 'true' : process.env[envVar];
   }
-  return config[optToGet];
+  return isBool ? config[optToGet] === 'true' : config[optToGet];
 }
diff --git a/lib/mochawesome.js b/lib/mochawesome.js
@@ -35,7 +35,7 @@ function Mochawesome (runner, options) {
   // Create/Save necessary report dirs/files
   var reporterOpts = options.reporterOptions || {},
       config = conf(reporterOpts);
-  
+
   generateReport(config);
 
   var self = this;
@@ -83,6 +83,7 @@ function Mochawesome (runner, options) {
 
         var obj = {
           reportTitle: config.reportTitle || process.cwd().split(config.splitChar).pop(),
+          inlineAssets: config.inlineAssets,
           stats: self.stats,
           suites: allSuites,
           allTests: allTests.map(cleanTest),

diff --git a/lib/reportGenerator.js b/lib/reportGenerator.js
@@ -9,11 +9,14 @@ exports.saveToFile = saveToFile;
 
 function generateReport (config) {
   console.log('[' + chalk.gray('mochawesome') + '] Generating report files...\n');
+  if (config.inlineAssets) {
+    return createDirs(config, true, _.noop);
+  }
   async.auto({
       createDirs: function(callback) {
         // console.log('createDirs');
         // async code to create directories to store files
-        createDirs(config, callback);
+        createDirs(config, null, callback);
       },
       copyStyles: ['createDirs', function(callback) {
         // after creating directories,
@@ -38,8 +41,11 @@ function generateReport (config) {
 }
 
 
-function createDirs (config, callback) {
-  var dirs = [config.reportDir, config.reportJsDir, config.reportFontsDir, config.reportCssDir];
+function createDirs (config, inline, callback) {
+  var dirs = [config.reportDir];
+  if (!inline) {
+    dirs = dirs.concat([config.reportJsDir, config.reportFontsDir, config.reportCssDir]);
+  }
   dirs.forEach(function(dir) {
     if (!fs.existsSync(dir)) {
       fs.mkdirSync(dir);