add csv and file output

Author: kriskbx

gtt-report.js

@@ -1,12 +1,14 @@
 const _ = require('underscore');
+const fs = require('fs');
 const program = require('commander');
 
 const Cli = require('./include/cli');
 const Config = require('./include/file-config');
 const Report = require('./models/report');
 
 const Output = {
-    table: require('./output/table')
+    table: require('./output/table'),
+    csv: require('./output/csv')
 };
 
 // this collects options
@@ -28,7 +30,7 @@ program
     .option('-q --query <query>', 'query the given data types: issues, merge_requests', collect, null)
     .option('-r --report <report>', 'include in the report: stats, issues, merge_requests, records', collect, null)
     .option('-o --output <output>', 'use the given output', collect, null)
-    .option('-l --file <file>', 'save report to the given file', collect, null)
+    .option('-l --file <file>', 'save report to the given file')
     .option('--include_by_labels <labels>', 'only include issues that have the given labels', collect, null)
     .option('--exclude_by_labels <labels>', 'exclude issues that have the given labels', collect, null)
     .option('--include_labels <labels>', 'only include the given labels in the report', collect, null)
@@ -41,6 +43,7 @@ program
     .option('--issue_columns <columns>', 'include the given columns in the issue part of the report', collect, null)
     .option('--merge_request_columns <columns>', 'include the given columns in the merge request part of the report', collect, null)
     .option('--user_columns', 'include user columns in the report')
+    .option('--quiet', 'only output report')
     .parse(process.argv);
 
 // init helpers
@@ -71,8 +74,11 @@ config
     .set('mergeRequestColumns', program.merge_request_columns)
     .set('noHeadlines', program.no_headlines)
     .set('noWarnings', program.no_warnings)
+    .set('quiet', program.quiet)
     .set('userColumns', program.user_columns);
 
+Cli.quiet = config.get('quiet');
+
 // warnings
 if (config.get('iids').length > 1 && config.get('query').length > 1) {
     Cli.warn(`The ids argument is ignored when querying multiple data types`);
@@ -87,11 +93,27 @@ if (!Output[config.get('output')]) {
     Cli.error(`The output ${config.get('output')} doesn't exist`);
 }
 
+// create report
 let report = new Report(config), output;
 
-Cli.list(`${Cli.look}  Resolving project "${config.get('project')}"`);
-report
-    .project()
+// file prompt
+new Promise(resolve => {
+    if (config.get('file') && fs.existsSync(config.get('file'))) {
+        Cli.ask(`The file "${config.get('file')}" already exists. Overwrite?`)
+            .then(() => resolve())
+            .catch(error => Cli.error(`can't write file.`, error));
+    } else {
+        resolve();
+    }
+})
+
+// get project
+    .then(() => {
+        Cli.list(`${Cli.look}  Resolving project "${config.get('project')}"`);
+        return report.project();
+    })
+
+    // get members
     .then(() => new Promise((resolve, reject) => {
         if (!config.get('userColumns')) return resolve();
 
@@ -165,7 +187,11 @@ report
 
     // print report
     .then(() => new Promise(resolve => {
-        output.toStdOut();
+        if (config.get('file')) {
+            output.toFile(config.get('file'));
+        } else {
+            output.toStdOut();
+        }
         resolve();
     }))
     .catch(error => Cli.x(`could not print report.`, error))

include/cli.js

@@ -1,5 +1,6 @@
 const _ = require('underscore');
 const colors = require('colors');
+const prompt = require('prompt');
 const spinner = require('node-spinner')();
 const cursor = require('cli-cursor');
 const progress = require('progress');
@@ -38,19 +39,53 @@ class cli {
         // return '🍺';
     }
 
+    /**
+     * ask
+     * @param message
+     * @returns {Promise}
+     */
+    static ask(message) {
+        return new Promise((resolve, reject) => {
+            prompt.start();
+
+            let question = {
+                name: 'yesno',
+                message: message,
+                validator: /y[es]*|n[o]?/,
+                warning: 'Must respond yes or no',
+                default: 'yes'
+            };
+
+            prompt.get(question, function (error, result) {
+                if (error || result.yesno === 'no' || result.yesno === 'n') return reject(error);
+
+                resolve();
+            });
+        });
+    }
+
+    /**
+     * print
+     * @param string
+     */
+    static out(string) {
+        if (cli.quiet) return;
+        process.stdout.write(string);
+    }
+
     /**
      * print done message
      */
     static done() {
-        console.log(`\n${cli.party}  Finished!`.green);
+        cli.out(`\n${cli.party}  Finished!\n`.green);
     }
 
     /**
      * print a warning
      * @param message
      */
     static warn(message) {
-        console.log(` Warning: ${message} `.bgWhite.black);
+        cli.out(` Warning: ${message} `.bgWhite.black);
     }
 
     /**
@@ -62,6 +97,8 @@ class cli {
     static bar(message, total) {
         cli.resolve(false);
 
+        if (cli.quiet) return cli.promise();
+
         this.active = {
             started: new Date(),
             message: `\r${message}... `.bold.grey,
@@ -72,8 +109,8 @@ class cli {
                 renderThrottle: 100
             }),
             interval: setInterval(() => {
-                if (!this.active.bar || this.active.bar.complete) return clearInterval(this.active.interval);
-                this.tick(0);
+                if (!cli.active.bar || cli.active.bar.complete) return clearInterval(cli.active.interval);
+                cli.tick(0);
             }, 1000)
         };
 
@@ -86,19 +123,19 @@ class cli {
      * @param amount
      */
     static tick(amount = 0) {
-        if (!this.active.bar || !this.active.started) return;
+        if (!cli.active.bar || !cli.active.started) return;
 
         let left;
 
-        if(this.active.bar.curr > 0) {
-            let elapsed = Math.ceil((new Date() - this.active.started) / 1000);
-            left = ((elapsed / this.active.bar.curr) * (this.active.bar.total - this.active.bar.curr)) / 60;
+        if (cli.active.bar.curr > 0) {
+            let elapsed = Math.ceil((new Date() - cli.active.started) / 1000);
+            left = ((elapsed / cli.active.bar.curr) * (cli.active.bar.total - cli.active.bar.curr)) / 60;
             left = left < 1 ? `<1` : Math.ceil(left);
         } else {
             left = 0;
         }
 
-        this.active.bar.tick(amount, {
+        cli.active.bar.tick(amount, {
             minutes: left
         });
     }
@@ -107,7 +144,7 @@ class cli {
      * advance an existing bar
      */
     static advance() {
-        this.tick(1);
+        cli.tick(1);
     }
 
     /**
@@ -120,7 +157,7 @@ class cli {
 
         this.active = {message: `\r${message}... `.bold.grey};
         this.active.interval = setInterval(() => {
-            process.stdout.write(this.active.message + spinner.next().bold.blue);
+            cli.out(cli.active.message + spinner.next().bold.blue);
         }, 100);
 
         return cli.promise();
@@ -132,7 +169,7 @@ class cli {
      */
     static mark() {
         cli.resolve();
-        process.stdout.write(`${this.active.message}` + `✓\n`.green);
+        cli.out(`${cli.active.message}` + `✓\n`.green);
 
         return cli.promise();
     }
@@ -145,7 +182,7 @@ class cli {
      */
     static x(message = false, error = false) {
         cli.resolve();
-        process.stdout.write(`${this.active.message}` + `✗\n`.red);
+        cli.out(`${cli.active.message}` + `✗\n`.red);
 
         if (message) cli.error(message, error);
         return cli.promise();
@@ -156,7 +193,7 @@ class cli {
      */
     static resolve(show = true) {
         cursor.toggle(show);
-        if (this.active && this.active.interval) clearInterval(this.active.interval);
+        if (cli.active && cli.active.interval) clearInterval(cli.active.interval);
     }
 
     /**
@@ -168,7 +205,7 @@ class cli {
     static error(message, error) {
         cli.resolve();
 
-        console.log(` Error: ${message} `.bgRed.white);
+        cli.out(` Error: ${message} `.bgRed.white + '\n');
         if (error) console.log(error);
 
         process.exit(1);

include/config.js

@@ -28,6 +28,7 @@ const defaults = {
     report: ['stats', 'issues', 'merge_requests', 'records'],
     noHeadlines: false,
     noWarnings: false,
+    quiet: false,
     _perPage: 100,
     _parallel: 10
 };

models/issue.js

@@ -1,3 +1,4 @@
+const _ = require('underscore');
 const moment = require('moment');
 
 const hasTimes = require('./hasTimes');
@@ -35,6 +36,9 @@ class issue extends hasTimes {
     }
 
     get labels() {
+        let labels = _.difference(this.data.labels, this.config.get('excludeLabels'));
+        let include = this.config.get('includeLabels');
+        return include.length > 0 ? _.intersection(labels, include) : labels;
     }
 
     get milestone() {

models/mergeRequest.js

@@ -9,6 +9,9 @@ class mergeRequest extends hasTimes {
         this.data = data;
     }
 
+    /*
+     * properties
+     */
     get iid() {
         return this.data.iid;
     }
@@ -17,6 +20,60 @@ class mergeRequest extends hasTimes {
         return this.data.id;
     }
 
+    get title() {
+        return this.data.title;
+    }
+
+    get project_id() {
+        return this.data.project_id;
+    }
+
+    get description() {
+        return this.data.description;
+    }
+
+    get labels() {
+        let labels = _.difference(this.data.labels, this.config.get('excludeLabels'));
+        let include = this.config.get('includeLabels');
+        return include.length > 0 ? _.intersection(labels, include) : labels;
+    }
+
+    get milestone() {
+        return this.data.milestone ? this.data.milestone.title : null;
+    }
+
+    get assignee() {
+        return this.data.assignee ? this.data.assignee.username : null;
+    }
+
+    get author() {
+        return this.data.author.username;
+    }
+
+    get updated_at() {
+        return moment(this.data.updated_at);
+    }
+
+    get created_at() {
+        return moment(this.data.created_at);
+    }
+
+    get state() {
+        return this.data.state;
+    }
+
+    get spent() {
+        return this.config.toHumanReadable(this.timeSpent);
+    }
+
+    get total_spent() {
+        return this.stats ? this.config.toHumanReadable(this.stats.total_time_spent) : null;
+    }
+
+    get total_estimate() {
+        return this.stats ? this.config.toHumanReadable(this.stats.time_estimate) : null;
+    }
+
     get _type() {
         return 'merge_requests';
     }

output/base.js

@@ -1,9 +1,11 @@
 const _ = require('underscore');
+const fs = require('fs');
 const moment = require('moment');
 
 const defaultFormats = {
-    headline: h => `\n${h}\n\n`,
-    warning: w => w
+    headline: h => `${h}\n`,
+    warning: w => w,
+    write: w => `\n${w}`
 };
 
 /**
@@ -51,7 +53,7 @@ class base {
      * @returns {base}
      */
     write(string) {
-        this.out += string;
+        this.out += this.formats.write(string);
         return this;
     }
 
@@ -86,8 +88,8 @@ class base {
     /**
      * render to file
      */
-    toFile() {
-
+    toFile(file) {
+        fs.writeFileSync(file, this.out);
     }
 
     /**