Merge pull request #9 from codacy/1.1.0

Version 1.1.0 Updates

Author: Rodrigo Fernandes

.jscsrc

@@ -39,7 +39,6 @@
     "disallowSpacesInFunctionDeclaration": {
         "beforeOpeningRoundBrace": true
     },
-    "requireMultipleVarDecl": true,
     "requireBlocksOnNewline": 1,
     "disallowEmptyBlocks": true,
     "disallowSpacesInsideArrayBrackets": true,

.jshintrc

@@ -16,6 +16,7 @@
   "strict": true,
   "eqnull": true,
   "node": true,
+  "mocha": true,
   "predef": [
     "describe",
     "it",

.travis.yml

@@ -3,6 +3,7 @@ sudo: false
 node_js:
 - '0.10'
 - '0.11'
+- '0.12'
 matrix:
   fast_finish: true
 script: npm test

README.md

@@ -63,6 +63,9 @@ istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && c
 istanbul cover jasmine-node --captureExceptions spec/ && cat ./coverage/lcov.info | ./node_modules/codacy-coverage/bin/codacy-coverage.js && rm -rf ./coverage
 ```
 
+### [Grunt](http://gruntjs.com/)
+- Install & Configure [grunt-codacy](https://www.npmjs.com/package/grunt-codacy)
+
 ### [Poncho](https://github.com/deepsweet/poncho)
 Client-side JS code coverage using [PhantomJS](https://github.com/ariya/phantomjs), [Mocha](https://github.com/visionmedia/mocha) and [Blanket](https://github.com/alex-seville/blanket):
 - [Configure](http://visionmedia.github.io/mocha/#browser-support) Mocha for browser

bin/codacy-coverage.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
-(function (program, logger, util, lib, getGitData, Q) {
+(function (program, logger, util, lib) {
     'use strict';
     process.stdin.resume();
     process.stdin.setEncoding('utf8');
 
-    var input = '',
-        loggerImpl;
+    var input = '';
+    var loggerImpl;
 
     process.stdin.on('data', function (chunk) {
         input += chunk;
@@ -15,7 +15,7 @@
     });
 
     program
-        .version('1.0.4')
+        .version(require('../package').version)
         .usage('[options]')
         .option('-f, --format [value]', 'Coverage input format')
         .option('-t, --token [value]', 'Codacy Project API Token')
@@ -41,30 +41,12 @@
             return;
         }
 
-        var token = program.token || process.env.CODACY_REPO_TOKEN,
-            commitId = program.commit,
-            format = program.format || 'lcov',
-            pathPrefix = program.prefix || '';
-
-        if (!token) {
-            return loggerImpl.error(new Error('Token is required'));
-        }
-
-        // Parse the coverage data for the given format and retrieve the commit id if we don't have it.
-        return Q.all([lib.getParser(format).parse(pathPrefix, input), getGitData.getCommitId(commitId)]).spread(function (parsedCoverage, commitId) {
-            // Now that we've parse the coverage data to the correct format, send it to Codacy.
-            loggerImpl.trace(parsedCoverage);
-            lib.reporter({
-                endpoint: program.endpoint
-            }).sendCoverage(token, commitId, parsedCoverage).then(function () {
-                loggerImpl.debug('Successfully sent coverage');
-            }, function (err) {
-                loggerImpl.error('Error sending coverage');
-                loggerImpl.error(err);
-            });
+        return lib.handleInput(input, program).then(function () {
+            loggerImpl.debug('Successfully sent coverage');
         }, function (err) {
+            loggerImpl.error('Error sending coverage');
             loggerImpl.error(err);
         });
     });
 
-}(require('commander'), require('../lib/logger'), require('util'), require('../index'), require('../lib/getGitData'), require('q')));
+}(require('commander'), require('../lib/logger'), require('util'), require('../index')));

index.js

@@ -1,8 +1,9 @@
-(function (parser, reporter, getGitData) {
+(function (parser, reporter, getGitData, handleInput) {
     'use strict';
     module.exports = {
         getParser: parser.getParser,
         reporter: reporter,
-        getGitData: getGitData
+        getGitData: getGitData,
+        handleInput: handleInput
     };
-}(require('./lib/coverageParser'), require('./lib/reporter'), require('./lib/getGitData')));
+}(require('./lib/coverageParser'), require('./lib/reporter'), require('./lib/getGitData'), require('./lib/handleInput')));

lib/coverageParser.js

@@ -1,8 +1,9 @@
 (function (Joi, util, logger) {
     'use strict';
 
-    var validFormats = ['lcov'],
-        formatValidation = Joi.string().valid(validFormats).required();
+    var validFormats = ['lcov'];
+    var formatValidation = Joi.string().valid(validFormats).required();
+
     module.exports = {
         getParser: function getParser(coverageFormat) {
             var validFormat = Joi.validate(coverageFormat, formatValidation);

lib/getGitData.js

@@ -1,12 +1,11 @@
-(function (logger, exec, Q) {
+(function (logger, exec, Promise) {
     'use strict';
     module.exports = {
         getCommitId: function (commitId) {
-            var deferred = Q.defer();
-            process.nextTick(function () {
+            return new Promise(function (resolve, reject) {
                 if (commitId) {
                     logger.debug('Provided Commit Id: ' + commitId);
-                    return deferred.resolve(commitId);
+                    return resolve(commitId);
                 }
 
                 var gitCommit = process.env.CODACY_GIT_COMMIT ||
@@ -19,19 +18,18 @@
 
                 if (gitCommit) {
                     logger.debug('Received Commit Id: ' + gitCommit);
-                    return deferred.resolve(gitCommit);
+                    return resolve(gitCommit);
                 }
 
                 exec('git rev-parse HEAD', function (err, commitId) {
                     if (err) {
-                        return deferred.reject(err);
+                        return reject(err);
                     }
                     commitId = commitId.trim();
                     logger.debug('Got Commit Id: ' + commitId);
-                    deferred.resolve(commitId);
+                    resolve(commitId);
                 });
             });
-            return deferred.promise;
         }
     };
-}(require('./logger')(), require('child_process').exec, require('q')));
+}(require('./logger')(), require('child_process').exec, require('bluebird')));

lib/handleInput.js

@@ -0,0 +1,34 @@
+(function (parser, reporter, getGitData, logger, Promise, util) {
+    'use strict';
+    module.exports = function (input, opts) {
+        opts = opts || {};
+
+        var token = opts.token || process.env.CODACY_REPO_TOKEN;
+        var commit = opts.commit;
+        var format = opts.format || 'lcov';
+        var pathPrefix = opts.prefix || '';
+        var loggerImpl;
+
+        loggerImpl = logger({
+            verbose: opts.verbose,
+            debug: opts.debug
+        });
+
+        if (!token) {
+            return Promise.reject(new Error('Token is required'));
+        }
+
+        loggerImpl.info(util.format('Handling input for: token [%j], commitId [%j], endpoint [%j], format [%j], path prefix [%j], verbose [%j], debug [%j]',
+            token, commit, opts.endpoint, format, pathPrefix, opts.verbose, opts.debug));
+
+        // Parse the coverage data for the given format and retrieve the commit id if we don't have it.
+        return Promise.all([parser.getParser(format).parse(pathPrefix, input), getGitData.getCommitId(commit)]).spread(function (parsedCoverage, commitId) {
+            // Now that we've parse the coverage data to the correct format, send it to Codacy.
+            loggerImpl.trace(parsedCoverage);
+            loggerImpl.debug('Sending coverage');
+            return reporter({
+                endpoint: opts.endpoint
+            }).sendCoverage(token, commitId, parsedCoverage);
+        });
+    };
+}(require('./coverageParser'), require('./reporter'), require('./getGitData'), require('./logger'), require('bluebird'), require('util')));

lib/impl/lcov.js

@@ -1,37 +1,38 @@
-(function (lcovParse, Q, Joi, logger, path) {
+(function (lcovParse, Promise, Joi, logger, path) {
     'use strict';
-    var lcovStringValidation = Joi.string().required(),
-        optionsValidation = Joi.object().keys().optional();
+
+    var lcovStringValidation = Joi.string().required();
+    var optionsValidation = Joi.object().keys().optional();
+
     module.exports = {
         parse: function parseLcov(pathPrefix, lcovString, options) {
-            logger.debug('Parsing Lcov Data');
-            var deferred = Q.defer();
-            process.nextTick(function () {
-                var validLcov = Joi.validate(lcovString, lcovStringValidation),
-                    validOptions = Joi.validate(options, optionsValidation, {
+            return new Promise(function (resolve, reject) {
+                logger.debug('Parsing Lcov Data');
+                var validLcov = Joi.validate(lcovString, lcovStringValidation);
+                var validOptions = Joi.validate(options, optionsValidation, {
                         stripUnknown: true
-                    }),
-                    validationError = validLcov.error || validOptions.error;
+                    });
+                var validationError = validLcov.error || validOptions.error;
 
                 if (validationError) {
                     logger.error(validationError);
-                    return deferred.reject(validationError);
+                    return reject(validationError);
                 }
 
                 lcovParse(lcovString, function (err, data) {
                     if (err) {
                         err = new Error(err);
 
                         logger.error(err);
-                        return deferred.reject(err);
+                        return reject(err);
                     }
 
                     var result = {
                             total: 0,
                             fileReports: []
-                        },
-                        totalLines = 0,
-                        totalHits = 0;
+                        };
+                    var totalLines = 0;
+                    var totalHits = 0;
 
                     //TODO: Convert to reduce function
                     data.forEach(function (stats) {
@@ -65,10 +66,9 @@
 
                     logger.debug('Successfully Parsed Lcov Data');
 
-                    deferred.resolve(result);
+                    resolve(result);
                 });
             });
-            return deferred.promise;
         }
     };
-}(require('lcov-parse'), require('q'), require('joi'), require('../logger')(), require('path')));
+}(require('lcov-parse'), require('bluebird'), require('joi'), require('../logger')(), require('path')));