[api change] Expose the 'analyse' function

Author: slyg

README.md

@@ -16,10 +16,10 @@ Command-line tool and module to generate a complexity report on file tree Javasc
 var jscomplexity = require('jscomplexity');
 
 // jscomplexity() returns a promise (using bluebird)
-jscomplexity('/path/to/js/dir').then(console.log);
+jscomplexity('/glob/pattern/to/js/*' [, globOptions]).then(console.log);
 
 // you can also use CPS style
-jscomplexity('/path/to/js/dir', function(err, result){
+jscomplexity('/glob/pattern/to/js/*', {}, function(err, result){
   if(err) {
     return console.log(err);
   }

index.js

@@ -1,6 +1,5 @@
-module.exports = function(srcDir, skippedDirectories, isVerbose, callback){
+var scan = require('./src/scan');
+var analyse = require('./src/analyse');
 
-    var scanner = require('./src/scan');
-    return scanner(srcDir, skippedDirectories, isVerbose).nodeify(callback);
-    
-}
+module.exports = scan;
+module.exports.analyse = analyse;

sample.js

@@ -10,16 +10,14 @@ jscomplexity('./src/**').then(function(data){
 }).caught(console.log);
 
 
-/**
- * Node-style version :
- *
- * jscomplexity('./src/**', function(err, data){
- *
- * if(err){
- *   return console.log(err);
- * }
- *
- * console.log(JSON.stringify(data.report, null, 6));
- *
- * });
- */
+// Node-style version
+
+// jscomplexity('./src/**', {}, function(err, data){
+
+//   if(err){
+//     return console.log(err);
+//   }
+
+//   console.log(JSON.stringify(data.report, null, 6));
+
+// });

src/analyse.js

@@ -0,0 +1,49 @@
+/*jshint -W079 */
+var Promise = require('bluebird'),
+    escomplex = require('escomplex'),
+    treeWalker = require('escomplex-ast-moz'),
+    esprima = require('esprima'),
+    fs = require('fs'),
+    readFileAsync = Promise.promisify(fs.readFile, fs);
+
+/**
+ * Promise of a complexity analysis of a single file
+ *
+ * @param {String} 'fileRef'    The file path
+ * @returns {Promise}           The fulfilled promise returns the report {Object}
+ */
+
+module.exports = function analyse (fileRef){
+
+  return readFileAsync(fileRef, 'utf8')
+
+    .then(function(fileData){
+
+      return escomplex.analyse(
+        esprima.parse(fileData, {loc : true}),
+        treeWalker
+      );
+
+    })
+
+    .then(function(report){
+
+      return {
+        path            : fileRef,
+        escapedPath     : fileRef.replace(/\\/g, '\\'), // windows use
+        complexity      : report.aggregate.cyclomatic,
+        lineNumber      : report.aggregate.sloc.logical,
+        maintainability : report.aggregate.halstead.effort,
+        halstead        : {
+          length         : report.aggregate.halstead.length,
+          vocabulary     : Math.round(report.aggregate.halstead.vocabulary),
+          difficulty     : Math.round(report.aggregate.halstead.difficulty),
+          bugs           : Math.round(report.aggregate.halstead.bugs)
+        }
+      };
+
+    })
+
+  ;
+
+};

src/lib/analyse.js

@@ -1,24 +1,21 @@
 /*jshint -W079 */
 var Promise = require('bluebird'),
-    _ = require('lodash'),
-    fs = require('fs'),
-    readFileAsync = Promise.promisify(fs.readFile, fs);
+    _ = require('lodash');
 
 var analyse = require('./analyse');
 
 /**
  * Promise of a report on a single file
  *
  * @param {String} 'fileRef'    The file's path
- * @param {Object} 'fileStats'  The informations about current file
  * @returns {Promise}           The promise shall always be fulfilled
  */
 
 module.exports = function report (fileRef) {
 
-  return readFileAsync(fileRef, 'utf8')
+  return Promise.resolve(fileRef)
 
-    .then(analyse(fileRef))
+    .then(analyse)
 
     .then(function(result){
 

src/lib/report.js renamed to src/report.js

@@ -6,18 +6,19 @@ var Promise = require('bluebird'),
     path = require('path')
 ;
 
-var reportAsync = require('./lib/report');
+var reportAsync = require('./report');
 
 /**
  * Scan a file tree seeking for js files and generates a complexity report
  *
  * @public
- * @param {String}  'pattern'             The glob pattern
- * @param {Array}   'globOptions'         The glob options
- * @returns {Promise}                     The fulfilled promise returns the final report
+ * @param {String}    'pattern'       The glob pattern
+ * @param {Array}     'globOptions'   The glob options
+ * @param {Function}  'callback'      cps callback function (optional)
+ * @returns {Promise}                 The fulfilled promise returns the final report
  */
 
-module.exports = function (pattern, globOptions){
+module.exports = function scan(pattern, globOptions, callback){
 
   return new Promise(function (resolve, reject) {
 
@@ -69,6 +70,6 @@ module.exports = function (pattern, globOptions){
 
     ;
 
-  });
+  }).nodeify(callback);
 
 };

src/scan.js

@@ -5,7 +5,9 @@ chai = require('chai')
 chaiAsPromised = require('chai-as-promised')
 should = chai.should()
 Promise = require('bluebird')
-scanner = require('../index')
+
+jscomplexity = require('../index')
+analyse = require('../index').analyse
 
 chai.use chaiAsPromised
 
@@ -18,23 +20,23 @@ EXPECTED_NO_JS_FILE_REPORT =
   fails: []
 
 
-describe 'the complexity scanner', ->
+describe 'the required jscomplexity module', ->
 
   it 'should return a Promise', ->
 
-    scanner('/*js').should.be.an.instanceof Promise
+    jscomplexity('/*js').should.be.an.instanceof Promise
 
   it 'should be rejected if (glob\'s) arguments <String:pattern> and <Object:options> are not valid', ->
 
-    scanner().should.be.rejected
-    scanner([]).should.be.rejected
-    scanner('').should.be.rejected
-    scanner('/*.js', []).should.be.rejected
+    jscomplexity().should.be.rejected
+    jscomplexity([]).should.be.rejected
+    jscomplexity('').should.be.rejected
+    jscomplexity('/*.js', []).should.be.rejected
 
 
   it 'should return an empty array when targeted folder doesn\'t contain .js files', (done) ->
 
-    scanner(TREE_WITHOUT_JS_FILE)
+    jscomplexity(TREE_WITHOUT_JS_FILE)
       .should.be.fulfilled
       .and.eventually.deep.equal(EXPECTED_NO_JS_FILE_REPORT)
       .and.notify done
@@ -43,11 +45,16 @@ describe 'the complexity scanner', ->
   it 'should return the expected complex result', (done) ->
 
     @timeout 10000
-    scanner(TREE_WITH_COMPLEX_FILES)
+    jscomplexity(TREE_WITH_COMPLEX_FILES)
       .should.be.fulfilled
       .and.eventually.deep.equal(EXPECTED_COMPLEX_FILES_REPORT)
       .and.notify done
 
+describe 'the analyse function', ->
+
+  it 'should be exposed by the module', ->
+
+    analyse.should.be.a 'function'