Merge pull request kriskbx#42 from spamsch/project-names-not-starting-with-number-no-resolved

Project names not starting with number no resolved

Author: kriskbx

Dockerfile

@@ -1,6 +1,6 @@
 FROM node:8.2.1-alpine
 
-ENV GTT_VERSION 1.6.10
+ENV GTT_VERSION 1.7.2
 
 RUN yarn global add --prefix /usr/local "gitlab-time-tracker@$GTT_VERSION"
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlab-time-tracker",
-  "version": "1.6.10",
+  "version": "1.7.2",
   "description": "A command line interface for GitLabs time tracking feature.",
   "bugs": {
     "url": "https://github.com/kriskbx/gitlab-time-tracker/issues"

readme.md

@@ -55,6 +55,7 @@ npm install -g gitlab-time-tracker
 ```
 
 Run the config command to create a config file and open it in your default editor.
+In linux terminal, you must set your preferred editor in the environment. For example, use `export EDITOR=vim` to edit the files with vim (put this in `.bashrc` or similar to have it always configured).
 If nothing happens, open the file manually: `~/.gtt/config.yml` - on Windows: `C:\Users\YourUserName\.gtt\config.yml`
 
 ```shell
@@ -484,6 +485,10 @@ token: abcdefghijklmnopqrst
 # defaults to false
 proxy: http://localhost:8080
 
+# Don't check SSL certificate
+# defaults to false
+insecure: true
+
 # Project
 # defaults to false
 project: namespace/projectname
@@ -543,15 +548,15 @@ hoursPerDay: 8
 issueColumns:
 - iid
 - title
-- estimation
+- total_estimate
 
 # Include the given columns in the merge request table
 # See --merge_request_columns option for more information
 # defaults to iid, title, spent, total_estimate
 mergeRequestColumns:
 - iid
 - title
-- estimation
+- total_estimate
 
 # Include the given columns in the time record table
 # See --record_columns option for more information
@@ -576,6 +581,16 @@ dateFormat: DD.MM.YYYY HH:mm:ss
 # defaults to "[%sign][%days>d ][%hours>h ][%minutes>m ][%seconds>s]"
 timeFormat: "[%sign][%days>d ][%hours>h ][%minutes>m ][%seconds>s]"
 
+# Time format for different parts of the report
+# Instead of specifying one global time format you can specify one for every
+# part of the report and the log command
+timeFormat:
+  log: "[%sign][%hours_overall]"
+  stats: "[%sign][%days_overall]"
+  issues: "[%sign][%hours_overall]"
+  merge_requests: "[%sign][%hours_overall]"
+  records: "[%sign][%days>d ][%hours>h ][%minutes>m ][%seconds>s]"
+
 # Output type
 # Available: csv, table, markdown, pdf
 # defaults to table
@@ -593,6 +608,12 @@ includeLabels:
 - pending
 - approved
 
+# Only works if using a local configuration file!
+# Extend the global configuration if set to true, pass a string to extend 
+# the configuration file stored at the given path
+# defaults to true
+extend: true
+
 # Change number of concurrent connections/http queries
 # Note: Handle with care, we don't want to spam GitLabs API too much
 # defaults to 10
@@ -602,11 +623,14 @@ _parallel: 20
 # defaults to 100
 _perPage: 100
 
-# Only works if using a local configuration file!
-# Extend the global configuration if set to true, pass a string to extend 
-# the configuration file stored at the given path
-# defaults to true
-extend: true
+# Verbose output
+_verbose: false
+
+# Check access token validity up front
+_checkToken: false
+
+# Skip parsing the issue/merge_request description for time records
+_skipDescriptionParsing: false
 ```
 
 ### Time format
@@ -698,6 +722,23 @@ timeFormat: "[%sign][%minutes_overall]"
 1095
 ```
 
+##### `[%hours_overall:2]`, `[%days_overall:3]`
+
+You can ceil any float value by adding the number of decimals to keep separated with a `:`.
+
+**Example config:** 
+ 
+```yaml
+timeFormat: "[%sign][%hours_overall:2]"
+```
+
+**Example outputs:**
+
+```shell
+0,51
+18,25
+```
+
 ## how to use gtt as a library
 
 Add as a dependency using yarn:
@@ -763,12 +804,6 @@ 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 `/spend [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 
@@ -789,4 +824,4 @@ or already have done so. 💜
 
 ## license
 
-GPL v2
+GPL v2

spec/include/config.spec.js

@@ -42,8 +42,33 @@ describe('The config class', () => {
         });
     });
 
+    it('returns values from objects and falls back to the default', () => {
+        let Config = new config(),
+            objectsWithDefaults = ['timeFormat'],
+            defaults = Object.assign({}, Config.data),
+            stringData = 'booze',
+            objectData = {
+                foo: 'bar',
+                baz: 'bar'
+            };
+
+        objectsWithDefaults.forEach(key => {
+            Config.set(key, objectData);
+
+            expect(Config.get(key, 'foo')).to.equal('bar');
+            expect(Config.get(key, 'baz')).to.equal('bar');
+            expect(Config.get(key, 'not_a_real_key')).to.equal(defaults[key]);
+
+            Config.set(key, stringData);
+
+            expect(Config.get(key, 'foo')).to.equal('booze');
+            expect(Config.get(key, 'baz')).to.equal('booze');
+            expect(Config.get(key, 'not_a_real_key')).to.equal('booze');
+        });
+    });
+
     it('makes durations human readable', () => {
-        let Config = new config,
+        let Config = new config(),
             humanReadable = "1d 4h 30m 10s",
             seconds = 45010;
 

src/gtt-log.js

@@ -11,16 +11,17 @@ const Tasks = require('./include/tasks');
 program
     .option('--verbose', 'show verbose output')
     .option('--hours_per_day <hours>', 'hours per day for human readable time formats')
+    .option('--time_format <time_format>', 'time format')
     .parse(process.argv);
 
 Cli.verbose = program.verbose;
 
-let config = new Config(__dirname)
-        .set('hoursPerDay', program.hours_per_day),
-    tasks = new Tasks(config);
+let config = new Config(__dirname).set('hoursPerDay', program.hours_per_day),
+    tasks = new Tasks(config),
+    timeFormat = config.set('timeFormat', program.time_format).get('timeFormat', 'log');
 
 function toHumanReadable(input) {
-    return Time.toHumanReadable(Math.ceil(input), config.get('hoursPerDay'), config.get('timeFormat'));
+    return Time.toHumanReadable(Math.ceil(input), config.get('hoursPerDay'), timeFormat);
 }
 
 tasks.log()

src/gtt-resume.js

@@ -0,0 +1,24 @@
+const program = require('commander');
+const colors = require('colors');
+const moment = require('moment');
+
+const Config = require('./include/file-config');
+const Cli = require('./include/cli');
+const Tasks = require('./include/tasks');
+
+program
+    .arguments('[project]')
+    .option('--verbose', 'show verbose output')
+    .parse(process.argv);
+
+Cli.verbose = program.verbose;
+
+let config = new Config(process.cwd()).set('project', program.args[0]),
+    tasks = new Tasks(config);
+
+if (!config.get('project'))
+    Cli.error('No project set');
+
+tasks.resume()
+    .then(frame => console.log(`Starting project ${config.get('project').magenta} ${frame.resource.type.blue} ${('#' + frame.resource.id).blue} at ${moment().format('HH:mm').green}`))
+    .catch(error => Cli.error(error));

src/gtt-start.js

@@ -9,6 +9,8 @@ const Tasks = require('./include/tasks');
 program
     .arguments('[project] [id]')
     .option('-t, --type <type>', 'specify resource type: issue, merge_request')
+    .option('-m', 'shorthand for --type=merge_request')
+    .option('-i', 'shorthand for --type=issue')
     .option('--verbose', 'show verbose output')
     .parse(process.argv);
 
@@ -20,6 +22,12 @@ let config = new Config(process.cwd()),
     id = program.args.length === 1 ? parseInt(program.args[0]) : parseInt(program.args[1]),
     project = program.args.length === 2 ? program.args[0] : null;
 
+if (program.I) {
+    type = 'issue';
+} else if (program.M) {
+    type = 'merge_request';
+}
+
 if (program.args.length < 2 && !config.get('project'))
     Cli.error('No project set');
 

src/gtt.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-const version = '1.6.10';
+const version = '1.7.2';
 const program = require('commander');
 
 program
@@ -9,6 +9,7 @@ program
     .command('create [project] [title]', 'start monitoring time for the given project and create a new issue or merge request with the given title')
     .command('status', 'shows if time monitoring is running')
     .command('stop', 'stop monitoring time')
+    .command('resume [project]', 'resume monitoring time for last stopped record')
     .command('cancel', 'cancel and discard active monitoring time')
     .command('log', 'log recorded time records')
     .command('sync', 'sync local time records to GitLab')

src/include/cli.js

@@ -241,7 +241,7 @@ class cli {
 
         if (this.data.project) return this.data.project;
 
-        let projects = _.uniq(_.filter(this.args, arg => !parseInt(arg)));
+        let projects = _.uniq(_.filter(this.args, arg => !Number.isNaN(new Number(arg))));
         this.args = _.difference(this.args, projects);
 
         return this.data.project = projects;

src/include/config.js

@@ -1,14 +1,17 @@
 const moment = require('moment');
+const _ = require('underscore');
 
 const Time = require('./../models/time');
 
 const dates = ['from', 'to'];
+const objectsWithDefaults = ['timeFormat', 'columns'];
 const defaults = {
     type: 'project',
     subgroups: false,
     url: 'https://gitlab.com/api/v4',
     token: false,
     proxy: false,
+    insecure: false,
     project: false,
     from: "1970-01-01",
     to: moment().format(),
@@ -36,7 +39,8 @@ const defaults = {
     _perPage: 100,
     _parallel: 10,
     _verbose: false,
-    _checkToken: false
+    _checkToken: false,
+    _skipDescriptionParsing: false
 };
 
 /**
@@ -47,7 +51,7 @@ class config {
      * construct
      */
     constructor() {
-        this.data = defaults;
+        this.data = _.extend({}, defaults);
     }
 
     /**
@@ -70,21 +74,27 @@ class config {
     /**
      * get a value by the given key
      * @param key
+     * @param subKey
      * @returns {*}
      */
-    get(key) {
-        if (!dates.includes(key)) return this.data[key];
+    get(key, subKey = false) {
+        if (dates.includes(key))
+            return moment(this.data[key]);
 
-        return moment(this.data[key]);
+        if (objectsWithDefaults.includes(key) && _.isObject(this.data[key]))
+            return subKey && this.data[key][subKey] ? this.data[key][subKey] : defaults[key];
+
+        return this.data[key];
     }
 
     /**
      * get a human readable version of the given time
      * @param input
+     * @param timeFormat
      * @returns {string}
      */
-    toHumanReadable(input) {
-        return Time.toHumanReadable(input, this.get('hoursPerDay'), this.get('timeFormat'));
+    toHumanReadable(input, timeFormat = false) {
+        return Time.toHumanReadable(input, this.get('hoursPerDay'), this.get('timeFormat', timeFormat));
     }
 }