Coverage badge, doc generator, dependency update & links

Author: asciidisco

Gruntfile.js

@@ -1,4 +1,5 @@
-module.exports = function(grunt) {
+/* jshint camelcase: false */
+module.exports = function (grunt) {
   'use strict';
 
   grunt.initConfig({
@@ -9,13 +10,17 @@ module.exports = function(grunt) {
     // define a src set of files for other tasks
     src: {
       lint: ['Gruntfile.js', 'index.js', 'lib/**/*.js', 'test/*.js'],
-      complexity: ['index.js', 'lib/**/*.js', 'test/*.js'],
+      complexity: ['index.js', 'lib/**/*.js'],
       test: ['test/*.js'],
       src: ['index.js']
     },
 
-    // clean coverage helper file
-    clean: ['coverage', 'report', 'report.zip'],
+    // clean automatically generated helper files & docs
+    clean: {
+      coverage: ['coverage', 'report/coverage'],
+      report: ['report/complexity', 'report/api', 'report/docs'],
+      reportZip: ['report.zip']
+    },
 
     // linting
     jshint: {
@@ -37,10 +42,18 @@ module.exports = function(grunt) {
       coverage: {
         options: {
           reporter: 'html-cov',
-          quiet: true
+          quiet: true,
+          captureFile: 'report/coverage/index.html'
         },
-        src: '<%= src.test %>',
-        dest: 'report/coverage/index.html'
+        src: '<%= src.test %>'
+      },
+      jsoncoverage: {
+        options: {
+          reporter: 'json-cov',
+          quiet: true,
+          captureFile: 'report/coverage/coverage.json'
+        },
+        src: '<%= src.test %>'
       }
     },
 
@@ -90,6 +103,19 @@ module.exports = function(grunt) {
       src: ['index.js']
     },
 
+    // add current timestamp to the html document
+    includereplace: {
+      dist: {
+        options: {
+          globals: {
+            timestamp: '<%= grunt.template.today("dddd, mmmm dS, yyyy, h:MM:ss TT") %>'
+          },
+        },
+        src: 'report/docs/*.html',
+        dest: '.'
+      }
+    },
+
     // compress artifacts
     compress: {
       main: {
@@ -104,41 +130,103 @@ module.exports = function(grunt) {
 
   });
 
-  // prepare files & folders for grunt:plato & coverage
-  grunt.registerTask('prepare', function () {
+  // prepare files & folders for grunt:plato
+  grunt.registerTask('preparePlato', function () {
     var fs = require('fs');
 
+    var dummyFolders = ['report/complexity', 'report/complexity/files', 'report/complexity/files/index_js', 'report/complexity/files/lib_levelbase_js', 'report/complexity/files/lib_loglevel_level0_js', 'report/complexity/files/lib_loglevel_level1_js', 'report/complexity/files/lib_loglevel_level2_js', 'report/complexity/files/lib_loglevel_level3_js', 'report/complexity/files/lib_loglevel_level4_js'];
+    var dummyFiles = ['report.history.json', 'files/index_js/report.history.json', 'files/lib_levelbase_js/report.history.json', 'files/lib_loglevel_level0_js/report.history.json', 'files/lib_loglevel_level1_js/report.history.json', 'files/lib_loglevel_level2_js/report.history.json', 'files/lib_loglevel_level3_js/report.history.json', 'files/lib_loglevel_level4_js/report.history.json'];
+
     // generate dirs for docs & reports
-    ['coverage', 'report', 'report/coverage',
-    'report/complexity', 'report/complexity/files',
-    'report/complexity/files/index_js',
-    'report/complexity/files/lib_levelbase_js',
-    'report/complexity/files/lib_loglevel_level0_js',
-    'report/complexity/files/lib_loglevel_level1_js',
-    'report/complexity/files/lib_loglevel_level2_js',
-    'report/complexity/files/lib_loglevel_level3_js',
-    'report/complexity/files/lib_loglevel_level4_js',
-    'report/complexity/files/test_index_TEST_js'].forEach(function (path) {
-      fs.mkdirSync(__dirname + '/' + path);
+    dummyFolders.forEach(function (path) {
+      if (!fs.existsSync(__dirname + '/' + path)) {
+        fs.mkdirSync(__dirname + '/' + path);
+      }
     });
 
     // store some dummy reports, so that grunt plato doesnt complain
-    ['report.history.json',
-    'files/test_index_TEST_js/report.history.json',
-    'files/index_js/report.history.json',
-    'files/lib_levelbase_js/report.history.json',
-    'files/lib_loglevel_level0_js/report.history.json',
-    'files/lib_loglevel_level1_js/report.history.json',
-    'files/lib_loglevel_level2_js/report.history.json',
-    'files/lib_loglevel_level3_js/report.history.json',
-    'files/lib_loglevel_level4_js/report.history.json',
-    'files/test_index_TEST_js/report.history.json'].forEach(function (file) {
-      fs.writeFileSync(__dirname + '/report/complexity/' + file, '{}');
+    dummyFiles.forEach(function (file) {
+      if (!fs.existsSync(__dirname + '/report/complexity/' + file)) {
+        fs.writeFileSync(__dirname + '/report/complexity/' + file, '{}');
+      }
+    });
+  });
+
+  // prepare files & folders for coverage
+  grunt.registerTask('prepareCoverage', function () {
+    var fs = require('fs');
+
+    // generate folders
+    ['coverage', 'report', 'report/coverage'].forEach(function (folder) {
+      if (!fs.existsSync(__dirname + '/' + folder)) {
+        fs.mkdirSync(__dirname + '/' + folder);
+      }
     });
 
     // generate code coverage helper file
-    var coverageHelper = 'require("blanket")({pattern: require("fs").realpathSync(__dirname + "/../index.js")});';
-    fs.writeFileSync(__dirname + '/coverage/blanket.js', coverageHelper);
+    var coverageHelper = 'require("blanket")({pattern: [require("fs").realpathSync(__dirname + "/../index.js"), require("fs").realpathSync(__dirname + "/../lib/")]});';
+    if (!fs.existsSync(__dirname + '/coverage/blanket.js')) {
+      fs.writeFileSync(__dirname + '/coverage/blanket.js', coverageHelper);
+    }
+  });
+
+
+  // generates a coverage badge
+  grunt.registerTask('generateCoverageBadge', function () {
+    var fs = require('fs');
+    if (fs.existsSync(__dirname + '/node_modules/coverage-badge')) {
+      if (fs.existsSync(__dirname + '/report/coverage/coverage.json')) {
+        var green = [147,188,59];
+        var yellow = [166,157,0];
+        var red = [189,0,2];
+
+        var getColor = function (coverage) {
+          if (coverage > 90) {
+            return mixColors(yellow, green, (coverage-90)/10);
+          }
+
+          if (coverage > 80) {
+            return mixColors(red, yellow, (coverage-80)/10);
+          }
+
+          return createColor(red);
+        };
+
+        var mixColors = function (from, to, ratio) {
+          var result = [], i;
+          for (i=0; i<3; i++) {
+            result[i] = Math.round(from[i] + (ratio * (to[i]-from[i])));
+          }
+          return createColor(result);
+        };
+
+        var createColor = function (values) {
+          return 'rgba('+values[0]+','+values[1]+','+values[2]+',1)';
+        };
+
+        var Badge = require(__dirname + '/node_modules/coverage-badge/lib/Badge.js');
+        var badgeFn = function(coverage) {
+          coverage = Math.floor(Number(coverage));
+          var badge = new Badge({
+            box_color: getColor(coverage),
+            box_text: coverage+'%',
+            label_text: 'cov',
+            height: 18,
+            width: 49,
+            box_width: 25,
+            rounding: 0,
+            padding: 0,
+            label_font: '7pt DejaVu Sans',
+            box_font: 'bold 7pt DejaVu Sans'
+          });
+          return badge.stream();
+        };
+
+        var coverage = JSON.parse(fs.readFileSync(__dirname + '/report/coverage/coverage.json')).coverage;
+        var file = fs.createWriteStream(__dirname + '/report/coverage/coverage.png');
+        badgeFn(coverage).pipe(file);
+      }
+    }
   });
 
   // load 3rd party tasks
@@ -150,9 +238,11 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-complexity');
   grunt.loadNpmTasks('grunt-documantix');
   grunt.loadNpmTasks('grunt-plato');
+  grunt.loadNpmTasks('grunt-include-replace');
 
   // define runner tasks
   grunt.registerTask('lint', 'jshint');
-  grunt.registerTask('test', ['clean', 'prepare', 'lint', 'mochaTest', 'complexity']);
-  grunt.registerTask('docs', ['clean', 'prepare', 'plato', 'mochaTest', 'documantix', 'yuidoc', 'compress']);
+  grunt.registerTask('test', ['clean:coverage', 'prepareCoverage', 'lint', 'mochaTest', 'generateCoverageBadge', 'complexity']);
+  grunt.registerTask('docs', ['clean:reportZip', 'clean:report', 'preparePlato', 'plato', 'documantix', 'includereplace', 'yuidoc', 'compress']);
+  grunt.registerTask('all', ['clean', 'test', 'docs']);
 };

README.md

@@ -8,14 +8,18 @@ dalek-reporter-console
 [![Dependency Status](https://david-dm.org/dalekjs/dalek-reporter-console.png)](https://david-dm.org/dalekjs/dalek-reporter-console)
 [![devDependency Status](https://david-dm.org/dalekjs/dalek-reporter-console/dev-status.png)](https://david-dm.org/dalekjs/dalek-reporter-console#info=devDependencies)
 [![NPM version](https://badge.fury.io/js/dalek-reporter-console.png)](http://badge.fury.io/js/dalek-reporter-console)
+[![Coverage](http://dalekjs.com/package/dalek-reporter-console/master/coverage/coverage.png)](http://dalekjs.com/package/dalek-reporter-console/master/coverage/index.html)
+[![unstable](https://rawgithub.com/hughsk/stability-badges/master/dist/unstable.svg)](http://github.com/hughsk/stability-badges)
+
+[![NPM](https://nodei.co/npm/dalek-reporter-console.png)](https://nodei.co/npm/dalek-reporter-console/)
 
 ## Ressources
 
 [API Documentation](http://dalekjs.com/package/dalek-reporter-console/master/api/index.html) -
 [Code coverage](http://dalekjs.com/package/dalek-reporter-console/master/coverage/index.html) -
 [Code complexity](http://dalekjs.com/package/dalek-reporter-console/master/complexity/index.html) -
 [Contributing](https://github.com/dalekjs/dalek-reporter-console/blob/master/CONTRIBUTING.md) -
-[User Docs](http://dalekjs.com/docs/master/reporter/console.html) -
+[User Docs](http://dalekjs.com/docs/console.html) -
 [Homepage](http://dalekjs.com) -
 [Twitter](http://twitter.com/dalekjs)
 
@@ -42,7 +46,7 @@ how to override that feature, browser specific problems and so on.
 
 Questions on StackOverflow often turn in to blog posts or issues.
 
-### [Github Issues](//github.com/dalekjs/dalek-internal-assertions/issues)
+### [Github Issues](//github.com/dalekjs/dalek-reporter-console/issues)
 
 Report issues with DalekJS, submit pull requests to fix problems, or to
 create summarized and documented feature requests (preferably with pull

index.js

@@ -28,8 +28,12 @@
 var reporter = null;
 
 /**
+ * Console reporter
+ *
  * @class Reporter
  * @constructor
+ * @part console
+ * @api
  */
 
 var Reporter = function (opts) {

package.json

@@ -30,14 +30,15 @@
   },
   "devDependencies": {
     "grunt": "~0.4.1",
-    "grunt-contrib-clean": "~0.4.1",
+    "grunt-contrib-clean": "~0.5.0",
     "grunt-contrib-jshint": "~0.6.0",
     "grunt-contrib-yuidoc": "~0.4.0",
     "grunt-contrib-compress": "~0.5.2",
-    "grunt-mocha-test": "~0.5.0",
+    "grunt-mocha-test": "~0.6.0",
     "grunt-complexity": "~0.1.3",
     "grunt-plato": "~0.2.0",
-    "grunt-documantix": "~0.0.1",
+    "grunt-documantix": "~0.0.3",
+    "grunt-include-replace": "~1.1.0",
     "blanket": "~1.1.5",
     "chai": "~1.7.0"
   }