Change jsdoc to Docco

gulpfile.babel.js

@@ -10,7 +10,7 @@ const nodemon = require('gulp-nodemon');
 
 const Cache = require('gulp-file-cache');
 
-const jsdoc = require('gulp-jsdoc3');
+const docco = require('gulp-docco');
 
 const cache = new Cache();
 
@@ -38,12 +38,14 @@ function compile() {
 
 gulp.task('build', compile);
 
-gulp.task('doc', (cb) => {
-    let config = require('./jsdoc.json');
-    gulp.src(['README.md', './src/**/*.js'], {read: false})
-        .pipe(jsdoc(config, cb));
+gulp.task('docco', () => {
+    gulp.src('./src/**/*.js')
+        .pipe(docco())
+        .pipe(gulp.dest('./docs'));
 });
 
+gulp.task('doc', ['docco']);
+
 gulp.task('test', () => {
   gulp.src('test/test.js', {read: false})
     .pipe(mocha())

package.json

@@ -48,6 +48,7 @@
     "gulp": "^3.9.1",
     "gulp-babel": "^6.1.2",
     "gulp-cli": "^1.2.2",
+    "gulp-docco": "0.0.4",
     "gulp-eslint": "^3.0.1",
     "gulp-file-cache": "0.0.1",
     "gulp-jsdoc3": "^0.3.0",

src/libs/app.js

@@ -18,25 +18,30 @@ const mongoose = require('./db/mongoose');
 
 const db = mongoose();
 
+// Set default node environment
 process.env.NODE_ENV = process.env.NODE_ENV || 'development';
 
+// Parse json received in requests
 app.use(bodyParser.json());
 app.use(bodyParser.urlencoded({ extended: false }));
 app.use(cookieParser());
+// Enable Cross-Origin Resource Sharing (CORS)
 app.use(cors());
 app.use(methodOverride());
+// Enable cache for 1 day
 app.use(cache('1 day'));
+// Enable maximum compression
 app.use(compression(9));
 app.use(api);
 
-// catch 404 and forward to error handler
+// Catch 404 and forward to error handler
 app.use((req, res, next) => {
     res.status(404);
     log.debug('%s %d %s', req.method, res.statusCode, req.url);
     res.json({ error: 'Not found' }).end();
 });
 
-// error handlers
+// Error handlers
 app.use((err, req, res, next) => {
     res.status(err.status || 500);
     log.error('%s %d %s', req.method, res.statusCode, err.message);

src/libs/config.js

 const nconf = require('nconf');
 
+// Exports the config.json as an object with get functions
 nconf.argv()
     .env()
     .file({ file: `${process.cwd()}/config.json` });

src/libs/db/monet.js

@@ -4,10 +4,12 @@ const libs = `${process.cwd()}/libs`;
 
 const config = require(`${libs}/config`);
 
+// Connection options
 const poolOptions = {
     nrConnections: config.get('monetdb:nrConnections'),
 };
 
+// Configuration options
 const options = {
     host: config.get('monetdb:host'),
     port: config.get('monetdb:port'),
@@ -16,6 +18,7 @@ const options = {
     password: config.get('monetdb:password'),
 };
 
+// Connection singleton
 const conn = new MonetDBPool(poolOptions, options);
 conn.connect();
 

src/libs/db/mongoose.js

@@ -7,8 +7,10 @@ const log = require(`${libs}/log`)(module);
 const mongoose = require('mongoose');
 
 module.exports = () => {
+    // Get mongodb URI (ip and port) in config file
     const mongoUri = config.get('mongodb:uri');
     log.debug(`Connecting to MongDB on URI ${mongoUri}`);
+    // Connection singleton
     const db = mongoose.connect(mongoUri);
 
     mongoose.connection.once('open', () => { log.info("MongoDB connected"); });

src/libs/db/query_exec.js

+
 const libs = `${process.cwd()}/libs`;
 
 const log = require(`${libs}/log`)(module);
 
 const conn = require(`${libs}/db/monet`);
 
-/**
- * Promise that executes an SQL query with optional parameters
- *
- * Examples:
- *   Query with no parameters:
- *     execSqlQuery('SELECT * FROM people');
- *   Query with one parameter:
- *     execSqlQuery('SELECT name, age FROM people WHERE id = ?', [1]);
- *   Query with more than one parameter:
- *     execSqlQuery('SELECT name, age FROM people WHERE city = ? AND age > ?', ['São Paulo', 35]);
- *
- * @param {string} sqlQuery       - SQL query to be executed by the Promise
- * @param {array}  sqlQueryParams - SQL query parameters
- */
+ // Promise that executes an SQL query with optional parameters
+ // ```
+ // Examples:
+ //   Query with no parameters:
+ //     execSqlQuery('SELECT * FROM people');
+ //   Query with one parameter:
+ //     execSqlQuery('SELECT name, age FROM people WHERE id = ?', [1]);
+ //   Query with more than one parameter:
+ //     execSqlQuery('SELECT name, age FROM people WHERE city = ? AND age > ?', ['São Paulo', 35]);
+ // ```
 function execSqlQuery(sqlQuery, sqlQueryParams = []) {
     log.debug(`Executing SQL query '${sqlQuery}' with params '${sqlQueryParams}'`);
     return new Promise((resolve, reject) => {
+        // Prepare statement
         conn.prepare(sqlQuery, true).then(
             (dbQuery) => {
+                // Execute query
                 dbQuery.exec(sqlQueryParams).then(
+                    // Success
                     (dbResult) => {
                         log.debug(`Query result: ${dbResult.data}`);
                         log.debug(dbResult.data);
                         resolve(dbResult.data);
                     },
+                    // Error
                     (dbError) => {
                         log.error(`SQL query execution error: ${dbError.message}`);
                         reject(new Error(dbError.message));
                     }
                 );
-                // release resources allocated for prepared statement
+                // Release resources allocated for prepared statement
                 conn.release();
             }
         );

src/libs/middlewares/dimensions.js

-/**
-* Dimensions middleware
-*
-* EXAMPLE:
-* Use it with no parameters to get all the dimensions specified
-* app.get('/', dimensions(), function(req, res, next){})
-*
-* Use it with an array of accepted values
-* app.get('/', dimensions(['year', 'location']), function(req, res, next){})
-*
-* Use it globally
-* app.use(dimensions())
-*/
 
-/**
- * This function returns the intersection of two arrays
- * @param  {array} a [description]
- * @param  {array} b [description]
- * @return {array}   [description]
- */
+// This function returns the intersection of two arrays
 function intersect(a, b) {
     let t;
     if (b.length > a.length) {
@@ -26,23 +8,35 @@ function intersect(a, b) {
     return a.filter((e) => b.indexOf(e) !== -1);
 }
 
+// Dimensions middleware
+// ```
+// EXAMPLE:
+// Use it with no parameters to get all the dimensions specified
+// app.get('/', dimensions(), function(req, res, next){})
+//
+// Use it with an array of accepted values
+// app.get('/', dimensions(['year', 'location']), function(req, res, next){})
+//
+// Use it globally
+// app.use(dimensions())
+// ```
 function dimensions(dims) {
     return (req, res, next) => {
         req.dims = {};
         if (req.query.dims) {
+            // Split the string and get all dimensions.
+            // Example string: 'state:41,year:2013,urban'
             const params = req.query.dims.split(',');
             const dimObj = {};
+            // For each dimension in the array see if there is a value associated
             for (const param of params) {
                 const kv = param.split(':');
                 dimObj[kv[0]] = (typeof kv[1] === 'undefined') ? null : kv[1];
             }
-            // for(let i=0; i<params.length; ++i) {
-            //     let kv = params[i].split(':');
-            //     dimObj[kv[0]] = (typeof kv[1] === 'undefined') ? null : kv[1];
-            // }
 
             // If the dims array exists and is not empty
             if (typeof dims !== 'undefined' && dims.length > 0) {
+                // Intersect the two arrays
                 const intersection = intersect(dims, Object.keys(dimObj));
                 for (let i = 0; i < intersection.length; ++i) {
                     req.dims[intersection[i]] = dimObj[intersection[i]];

src/libs/middlewares/query.js

@@ -2,12 +2,7 @@ const libs = `${process.cwd()}/libs`;
 const log = require(`${libs}/log`)(module);
 const execQuery = require(`${libs}/db/query_exec`);
 
-/**
- * Middleware that executes a query defined by a squel object in req.sql
- * @param  {Object}   req  [description]
- * @param  {Object}   res  [description]
- * @param  {Function} next [description]
- */
+ // Middleware that executes a query defined by a squel object in req.sql
 function query(req, res, next) {
     log.debug(req.sql);
     execQuery(req.sql.text, req.sql.values).then((result) => {

src/libs/middlewares/response.js

@@ -3,10 +3,8 @@ const log = require(`${libs}/log`)(module);
 const xml = require('js2xmlparser');
 const csv = require('csv-express');
 
-/**
- * Custom generic middleware used to send api responses
- * @param  {string} value text to be used in the xml response
- */
+ // Custom generic middleware used respond requests.
+ // The function reads the req.query.format param and respond in json, xml or csv
 function response(value) {
     return (req, res, next) => {
         log.debug(req.query.format);

src/libs/routes/api.js

@@ -12,11 +12,11 @@ const city = require('./city');
 
 const school = require('./school');
 
+// API status route
 api.get('/api/v1', (req, res) => {
     res.json({ msg: 'SimCAQ API is running' });
 });
 
-// mount API routes
 api.use('/api/v1/enrollment', enrollment);
 api.use('/api/v1/state', state);
 api.use('/api/v1/region', region);

src/libs/routes/city.js

@@ -10,23 +10,27 @@ const query = require(`${libs}/middlewares/query`);
 
 const response = require(`${libs}/middlewares/response`);
 
+// Return all cities
 cityApp.get('/', (req, res, next) => {
     req.sql = squel.select().from('municipios').toParam();
     next();
 }, query, response('city'));
 
+// Return a specific city by it's id
 cityApp.get('/:id', (req, res, next) => {
     req.sql = squel.select().from('municipios').where('pk_municipio_id = ?',
         parseInt(req.params.id, 10)).toParam();
     next();
 }, query, response('city'));
 
+// Return a specific city by it's IBGE code
 cityApp.get('/ibge/:id', (req, res, next) => {
     req.sql = squel.select().from('municipios').where('codigo_ibge = ?',
         req.params.id).toParam();
     next();
 }, query, response('city'));
 
+// Return all the cities from a specific state
 cityApp.get('/state/:id', (req, res, next) => {
     req.sql = squel.select().from('municipios').where('fk_estado_id = ?',
         parseInt(req.params.id, 10)).toParam();

src/libs/routes/enrollment.js

@@ -35,11 +35,8 @@ function filter(req, q) {
     }
 }
 
-/**
- * Complete range of the enrollments dataset
- *
- * Returns a tuple of start and ending years of the complete enrollments dataset.
- */
+// Complete range of the enrollments dataset.
+// Returns a tuple of start and ending years of the complete enrollments dataset.
 enrollmentApp.get('/year_range', (req, res, next) => {
     req.sql = squel.select()
     .from('turmas')
@@ -50,10 +47,7 @@ enrollmentApp.get('/year_range', (req, res, next) => {
     next();
 }, query, response('range'));
 
-/**
- * Returns all educational levels avaible
- *
- */
+// Returns all educational levels avaible
 enrollmentApp.get('/education_level', (req, res, next) => {
     req.sql = squel.select()
     .from('etapa_ensino')
@@ -64,10 +58,7 @@ enrollmentApp.get('/education_level', (req, res, next) => {
     next();
 }, query, response('education_level'));
 
-/**
- * Returns all adm dependency
- *
- */
+// Returns all adm dependencies
 enrollmentApp.get('/adm_dependency', (req, res, next) => {
     req.sql = squel.select()
     .from('dependencia_adms')
@@ -216,27 +207,4 @@ enrollmentApp.get('/', (req, res, next) => {
     next();
 }, query, response('enrollments'));
 
-// enrollmentApp.get('/', (req, res, next) => {
-//     log.debug(`Request parameters: ${req}`);
-//     if (typeof req.sqlQuery === 'undefined') {
-//         // Should only happen if there is a bug in the chaining of the
-//         // '/enrollments' route, since when no +aggregate+ parameter is given,
-//         // it defaults to use the query for the whole country.
-//         log.error('BUG -- No SQL query was found to be executed!');
-//         next('Internal error, request could not be satisfied at this moment. Please, '
-//             + 'try again later');
-//     } else {
-//         log.debug('SQL query: ${ req.sqlQuery }?');
-//         log.debug(req.sqlQuery);
-//         dbQuery(req.sqlQuery).then((result) => {
-//             req.result = result;
-//             return response(req, res);
-//         }, (error) => {
-//             log.error(`[${req.originalUrl}] SQL query error: ${error}`);
-//             next('Internal error, request could not be satisfied at this moment. Please, '
-//                 + 'try again later');
-//         });
-//     }
-// });
-
 module.exports = enrollmentApp;

src/libs/routes/region.js

@@ -10,11 +10,13 @@ const query = require(`${libs}/middlewares/query`);
 
 const response = require(`${libs}/middlewares/response`);
 
+// Get all regions
 regionApp.get('/', (req, res, next) => {
     req.sql = squel.select().from('regioes').toParam();
     next();
 }, query, response('region'));
 
+// Get a region by it's id
 regionApp.get('/:id', (req, res, next) => {
     req.sql = squel.select().from('regioes').where('pk_regiao_id = ?',
         parseInt(req.params.id, 10)).toParam();

src/libs/routes/school.js

@@ -16,23 +16,26 @@ const response = require(`${libs}/middlewares/response`);
  * A api fica sobrecarregada
  * Pense na cena do elevador de driver mas o elevador é uma bomba de fusão e demora mais que uma luta do DBz
  */
-// schoolApp.get('/', (req, res, next) => {
-//     req.sql = squel.select().from('escolas')
-//         .field('pk_escola_id')
-//         .field('nome_entidade', 'name')
-//         .field('ano_censo', 'year')
-//         .field('fk_cod_estado')
-//         .field('fk_cod_municipio')
-//         .toParam();
-//     next();
-// }, query, response('school'));
+/* schoolApp.get('/', (req, res, next) => {
+*     req.sql = squel.select().from('escolas')
+*         .field('pk_escola_id')
+*         .field('nome_entidade', 'name')
+*         .field('ano_censo', 'year')
+*         .field('fk_cod_estado')
+*         .field('fk_cod_municipio')
+*         .toParam();
+*     next();
+* }, query, response('school'));
+*/
 
+// Get a school by it's id
 schoolApp.get('/:id', (req, res, next) => {
     req.sql = squel.select().from('escolas').where('pk_escola_id = ?',
         parseInt(req.params.id, 10)).toParam();
     next();
 }, query, response('school'));
 
+// Get all schools from a state
 schoolApp.get('/state/:id', (req, res, next) => {
     req.sql = squel.select().from('escolas')
         .field('pk_escola_id')
@@ -46,6 +49,7 @@ schoolApp.get('/state/:id', (req, res, next) => {
     next();
 }, query, response('school'));
 
+// Get all schools from a city
 schoolApp.get('/city/:id', (req, res, next) => {
     req.sql = squel.select().from('escolas')
         .field('pk_escola_id')

src/libs/routes/state.js

@@ -10,17 +10,20 @@ const query = require(`${libs}/middlewares/query`);
 
 const response = require(`${libs}/middlewares/response`);
 
+// Get all states
 stateApp.get('/', (req, res, next) => {
     req.sql = squel.select().from('estados').toParam();
     next();
 }, query, response('state'));
 
+// Get a state
 stateApp.get('/:id', (req, res, next) => {
     req.sql = squel.select().from('estados').where('pk_estado_id = ?',
         parseInt(req.params.id, 10)).toParam();
     next();
 }, query, response('state'));
 
+// Get all states from a region
 stateApp.get('/region/:id', (req, res, next) => {
     req.sql = squel.select().from('estados').where('fk_regiao_id = ?',
         parseInt(req.params.id, 10)).toParam();

src/server.js

@@ -8,8 +8,10 @@ const log = require(`${libs}/log`)(module);
 
 const app = require(`${libs}/app`);
 
+// Set default port: first environment variable PORT, then configuration and last 3000
 app.set('port', process.env.PORT || config.get('port') || 3000);
 
+// Set default ip: first environment variable IOP, then configuration and last '127.0.0.1'
 app.set('ip', process.env.IP || config.get('ip') || '127.0.0.1');
 
 const server = app.listen(app.get('port'), () => {