Display total time spent for uncommitted work in the status bar

Author: mschenk42

README.md

@@ -3,9 +3,72 @@
 
 Git Time Metrics (GTM) is a tool to automatically track time spent reading and working on code that you store in a Git repository. By installing GTM and using supported plug-ins for your favorite editors, you can immediately realize better insight into how you are spending your time and on what files.
 
-### Installation
+# Installation
 
 Installing GTM is a two step process.  First, it's recommended you install the GTM executable that the plug-in integrates with and then install the Sublime 3 GTM plug-in.  Please submit an issue if you have any problems and/or questions.
 
-1. Follow the [Getting Started](https://github.com/git-time-metric/gtm/blob/master/README.md) section to install the GTM executable for your operating system. 
+1. Follow the [Getting Started](https://github.com/git-time-metric/gtm/blob/master/README.md) section to install the GTM executable for your operating system.
 2. Install the plug-in via [Package Control](https://packagecontrol.io).
+
+# Features
+
+### Status Bar
+
+In the status bar see your total time spent for in-process work (uncommitted).
+
+![](https://cloud.githubusercontent.com/assets/630550/16570803/e25a7980-4212-11e6-9e7a-a6eff4be118c.png)
+
+This can be disabled by setting `gtm_status_bar: false` in gtm.sublime-settings.
+
+*Note* - the time shown is based on the file's path and the Git repository it belongs to. You can have several files open that belong to different Git repositories. The status bar will display the time for the current file's Git repository.  Also keep in mind, a Git repository must be initialized for time tracking in order to track time.
+
+Consult the [README](https://github.com/git-time-metric/gtm/blob/master/README.md) and [Wiki](https://github.com/git-time-metric/gtm/wiki) for more information.
+
+### Command Line Inteface
+
+Use the command line to report on time logged for your commits.
+
+Here are some examples of insights GTM can provide you.
+
+**Git commits with time spent**
+
+```
+9361c18 Rename packages
+Sun Jun 19 09:56:40 2016 -0500 Michael Schenk  34m 30s
+
+341bd77 Vagrant file for testing on Linux
+Sun Jun 19 09:43:47 2016 -0500 Michael Schenk  1h 16m  0s
+
+792ba19 Require a 40 char SHA commit hash
+Thu Jun 16 22:28:45 2016 -0500 Michael Schenk  1h  1m  0s
+```
+
+**Git commits with detailed time spent by file**
+
+```
+b2d16c8 Refactor discovering of paths when recording events
+Thu Jun 16 11:08:47 2016 -0500 Michael Schenk
+
+       30m 18s  [m] event/event.go
+       12m 31s  [m] event/manager.go
+        3m 14s  [m] project/project.go
+        1m 12s  [r] .git/COMMIT_EDITMSG
+        1m  0s  [r] .git/index
+           25s  [r] event/manager_test.go
+           20s  [r] metric/manager.go
+       49m  0s
+```
+
+**Timeline of time spent by day**
+
+```
+           0123456789012345678901234
+Fri Jun 24 *                              22m  0s
+Sat Jun 25 **                          1h 28m  0s
+Sun Jun 26 ****                        3h 28m  0s
+Mon Jun 27 *                               4m  0s
+Tue Jun 28 **                          1h 36m  0s
+                                       6h 58m  0s
+```
+
+Consult the [README](https://github.com/git-time-metric/gtm/blob/master/README.md) and [Wiki](https://github.com/git-time-metric/gtm/wiki) for more information.

gtm-plugin.py

@@ -5,6 +5,8 @@
 import os
 import subprocess
 
+gtm_settings = {}
+
 def find_gtm_path():
     if sys.platform == 'win32':
         exe = 'gtm.exe'
@@ -30,25 +32,56 @@ def find_gtm_path():
 
     return None
 
+def plugin_loaded():
+    global gtm_settings
+    gtm_settings = sublime.load_settings('gtm.sublime-settings')
+    gtm_settings.add_on_change('gtm_status_bar', set_status_bar)
+    set_status_bar()
+
+def set_status_bar():
+    if GTM.status_option_found and gtm_settings.get('gtm_status_bar', True):
+        GTM.status_option = '--status'
+        print("Enabling reporting time in status bar")
+    else:
+        GTM.status_option = ''
+        print("Disabling reporting time in status bar")
+
 class GTM(sublime_plugin.EventListener):
     update_interval = 30
-    last_update = 0.0
+    last_update = 0
     last_path = None
+    status_option = ""
 
-    gtm_path = find_gtm_path()
-    
-    no_gtm_err = ("GTM executable not found\n"
-                  "Install GTM and/or update your system path\n"
-                  "Make sure to restart Sublime after install\n"
+    no_gtm_err = ("GTM executable not found. "
+                  "Install GTM and/or update your system path. "
+                  "Make sure to restart Sublime after install. \n\n"
                   "See https://www.github.com/git-time-metric/gtm")
 
-    record_err = ("GTM error saving time\n"
-                  "Install GTM and/or update your system path\n"
-                  "Make sure to restart Sublime after install\n"
+    record_err = ("GTM error saving time. "
+                  "Install GTM and/or update your system path. "
+                  "Make sure to restart Sublime after install.\n\n"
                   "See https://www.github.com/git-time-metric/gtm")
 
+    ver_warn = ("GTM executable does not support all required features. "
+                "Please install the latest GTM version and restart Sublime.\n\n"
+                "See https://www.github.com/git-time-metric/gtm")
+
+    gtm_path = find_gtm_path()
+
     if not gtm_path:
         sublime.error_message(no_gtm_err)
+    else:
+        # check support for [gtm record --status] feature
+        p = subprocess.Popen("{0} record --help".format(gtm_path),
+                             shell=True,
+                             stdin=subprocess.PIPE,
+                             stdout=subprocess.PIPE,
+                             stderr=subprocess.STDOUT,
+                             close_fds=True)
+        output = p.stdout.read()
+        status_option_found = '-status' in output.decode('utf-8')
+        if not status_option_found:
+            sublime.error_message(ver_warn)
 
     def on_post_save_async(self, view):
         self.record(view, view.file_name())
@@ -71,8 +104,15 @@ def record(self, view, path):
             GTM.last_update = time.time()
             GTM.last_path = path
 
-            cmd = '{0} record "{1}"'.format(GTM.gtm_path, path)
-            return_code = subprocess.call(cmd, shell=True)
-
-            if return_code != 0:
+            cmd = '{0} record {1} "{2}"'.format(GTM.gtm_path,
+                                                GTM.status_option,
+                                                path)
+
+            try:
+                cmd_output = subprocess.check_output(cmd, shell=True)
+                if GTM.status_option != "":
+                    view.set_status("gtm-statusbar", cmd_output.decode('utf-8'))
+                else:
+                    view.erase_status("gtm-statusbar")
+            except subprocess.CalledProcessError as e:
                 sublime.error_message(GTM.record_err)

gtm.sublime-settings

@@ -0,0 +1,4 @@
+{
+  // enable time reporting in status bar
+  "gtm_status_bar": true
+}