Add support for multiple projects and/or groups

Author: kriskbx

gtt-report.js

@@ -51,6 +51,7 @@ program
     .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')
+    .option('--verbose', 'show verbose output')
     .option('--show_without_times', 'show issues/merge requests without time records')
     .option('-p --proxy <proxy>', 'use a proxy server with the given url')
     .parse(process.argv);
@@ -88,13 +89,26 @@ config
     .set('userColumns', program.user_columns)
     .set('proxy', program.proxy)
     .set('type', program.type)
-    .set('subgroups', program.subgroups);
+    .set('subgroups', program.subgroups)
+    .set('_verbose', program.verbose);
 
 Cli.quiet = config.get('quiet');
+Cli.verbose = config.get('_verbose');
+
+
+// create stuff
+let reports = new ReportCollection(config),
+    master = new Report(config),
+    projectLabels = _.isArray(config.get('project')) ? config.get('project').join('", "') : config.get('project'),
+    projects = _.isArray(config.get('project')) ? config.get('project') : [config.get('project')],
+    output;
 
 // warnings
 if (config.get('iids').length > 1 && config.get('query').length > 1) {
-    Cli.warn(`The ids argument is ignored when querying multiple data types`);
+    Cli.warn(`The ids argument is ignored when querying issues and merge requests`);
+}
+if (config.get('iids').length > 1 && (config.get('type') !== 'project' || projects.length > 1)) {
+    Cli.warn(`The ids argument is ignored when querying multiple projects`);
 }
 if ((config.get('report').includes('issues') && !config.get('query').includes('issues'))) {
     Cli.warn(`Issues are included in the report but not queried.`);
@@ -115,11 +129,6 @@ if (!config.get('to').isValid()) {
     Cli.error(`TO is not a in valid ISO date format.`);
 }
 
-// create stuff
-let reports = new ReportCollection(config),
-    master = new Report(config),
-    output;
-
 // file prompt
 new Promise(resolve => {
     if (config.get('file') && fs.existsSync(config.get('file'))) {
@@ -133,36 +142,46 @@ new Promise(resolve => {
 
 // get project(s)
     .then(() => new Promise((resolve, reject) => {
-        Cli.list(`${Cli.look}  Resolving "${config.get('project')}"`);
+        Cli.list(`${Cli.look}  Resolving "${projectLabels}"`);
         let owner = new Owner(config);
 
-        switch (config.get('type')) {
-            case 'project':
-                let report = new Report(config);
-                reports.push(report);
-                report.getProject()
-                    .then(() => resolve())
-                    .catch(e => reject(e));
-                break;
-
-            case 'group':
-                owner.getGroup()
-                    .then(() => {
-                        if (!config.get('subgroups')) return new Promise(r => r());
-                        return owner.getSubGroups();
-                    })
-                    .then(() => owner.getProjectsByGroup()
-                        .then(() => {
-                            owner.projects.forEach(project => {
-                                reports.push(new Report(config, project));
-                            });
-                            Cli.out(`\r${Cli.look}  Selected projects: ${owner.listProjects()}\n`);
-                            resolve();
-                        }))
-                    .catch(e => reject(e));
-                break;
-        }
+        owner
+            .parallel(projects, (project, done) => {
+                config.set('project', project);
+
+                switch (config.get('type')) {
+                    case 'project':
+                        let report = new Report(config);
+                        reports.push(report);
+                        report.getProject()
+                            .then(() => done())
+                            .catch(e => done(e));
+                        break;
+
+                    case 'group':
+                        owner.getGroup()
+                            .then(() => {
+                                if (!config.get('subgroups')) return new Promise(r => r());
+                                return owner.getSubGroups();
+                            })
+                            .then(() => owner.getProjectsByGroup()
+                                .then(() => {
+                                    owner.projects.forEach(project => {
+                                        reports.push(new Report(config, project));
+                                    });
+                                    done();
+                                }))
+                            .catch(e => done(e));
+                        break;
+                }
+            }, 1)
+            .catch(e => reject(e))
+            .then(() => {
+                config.set('project', projects);
+                resolve();
+            });
     }))
+    .then(() => Cli.out(`\r${Cli.look}  Selected projects: ${reports.reports.map(r => r.project.name.bold.blue).join(', ')}\n`))
 
     // get members and user columns
     .then(() => new Promise(resolve => {
@@ -185,7 +204,7 @@ new Promise(resolve => {
             .then(() => resolve());
     }))
     .then(() => Cli.mark())
-    .catch(error => Cli.x(`Could not resolve "${config.get('project')}"`, error))
+    .catch(error => Cli.x(`Could not resolve "${projectLabels}"`, error))
 
     // get issues
     .then(() => new Promise(resolve => {

include/cli.js

@@ -214,7 +214,7 @@ class cli {
         cli.resolve();
 
         cli.out(`Error: ${message.red}` + '\n');
-        if (error) console.log(error);
+        if (error && cli.verbose) console.log(error);
 
         process.exit(1);
     }
@@ -238,7 +238,10 @@ class cli {
 
         if (this.data.project) return this.data.project;
 
-        return this.data.project = this.args.splice(0, 1).toString();
+        let projects = _.uniq(_.filter(this.args, arg => !parseInt(arg)));
+        this.args = _.difference(this.args, projects);
+
+        return this.data.project = projects;
     }
 
     /**

include/config.js

@@ -34,7 +34,8 @@ const defaults = {
     quiet: false,
     showWithoutTimes: false,
     _perPage: 100,
-    _parallel: 10
+    _parallel: 10,
+    _verbose: false
 };
 
 /**

models/owner.js

@@ -1,7 +1,6 @@
 const _ = require('underscore');
 
 const Base = require('./base');
-const Color = require('colors');
 
 /**
  * owner model
@@ -14,14 +13,6 @@ class owner extends Base {
         this.users = [];
     }
 
-    /**
-     * list projects
-     * @returns {string|*}
-     */
-    listProjects() {
-        return this.projects.map(p => p.path_with_namespace.bold.blue).join(',');
-    }
-
     /**
      * query and set the group
      * @returns {Promise}
@@ -30,7 +21,7 @@ class owner extends Base {
         return new Promise((resolve, reject) => {
             this.get(`groups/?search=${encodeURIComponent(this.config.get('project'))}`)
                 .then(group => {
-                    if (group.body.length === 0) return reject();
+                    if (group.body.length === 0) return reject('Group not found');
                     let filtered = group.body.filter(u => u.path === this.config.get('project'));
                     if (filtered.length === 0) return reject();
                     this.groups = this.groups.concat(filtered);

models/project.js

@@ -43,6 +43,10 @@ class project extends Base {
         return this.data.id;
     }
 
+    get name() {
+        return this.data.path_with_namespace;
+    }
+
     get users() {
         return this.members.map(member => member.username);
     }

models/report.js

@@ -68,7 +68,7 @@ class report extends Base {
      */
     getProject() {
         let promise = this.get(`projects/${encodeURIComponent(this.config.get('project'))}`);
-        promise.then(project => this.setProject(project));
+        promise.then(project => this.setProject(project.body));
 
         return promise;
     }

readme.md

@@ -208,6 +208,17 @@ gtt report example-group --type=group --subgroups
 Query all projects from the given group and combine the data into a single report. The option `--subgroups`
 includes subgroups.
 
+#### Query multiple projects or groups and combine the data in one report
+
+```shell
+gtt report ["namespace/project"] ["namespace/project"] ...
+gtt report "kriskbx/example-project" "kriskbx/example-project-2"
+gtt report ["namespace"] ["namespace"] ... --type=group
+gtt report example-group example-group-2 --type=group
+```
+
+*Hint: use the `project_id` or `project_namespace` columns in your report.*
+
 #### Choose an output for your report
 
 ```shell
@@ -370,6 +381,12 @@ gtt report --exclude_labels=bug --exclude_labels=feature
 gtt report --proxy="http://localhost:8080"
 ```
 
+#### Output verbose debug information
+
+```shell
+gtt report --verbose
+```
+
 ## configuration
 
 The configuration uses the [yaml file format](http://www.yaml.org/spec/1.2/spec.html). 
@@ -658,6 +675,12 @@ report.mergeRequests.forEach(mergeRequest => {
 It can include times outside the queried time frame. `spent` on the other hand
 is the total amount of time spent in the given time frame.
 
+#### Why 'total spent' and 'spent' are showing different amounts.
+
+gtt can only track time records from notes/comments. If you start your 
+issue or merge request with `/spent [time]` in its description, gtt won't
+take it into consideration (for now).
+
 ## contributing
 
 I would love to integrate unit testing in this project, but unfortunately my knowledge of