Add support for local / personnal aliases

doc/tksrc.sample

@@ -37,6 +37,11 @@ auto_add = auto
 # empty
 # auto_fill_days = 0,1,2,3,4
 
+
+# Defines a list of local aliases that you will be able to use in your timesheets
+# but that will never be pushed to Zebra
+local_aliases = _lunch, _coffee_break
+
 # This section contains your project name <-> id mapping. The format is:
 # project_name = project_id/activity_id
 [wrmap]

taxi/commands.py

@@ -352,10 +352,16 @@ def run(self):
         r = remote.ZebraRemote(self.settings.get('site'),
                                self.settings.get('username'),
                                self.settings.get('password'))
-        entries_to_push = t.get_entries(self.options.date, exclude_ignored=True)
+        entries_to_push = t.get_entries(self.options.date, exclude_ignored=True, exclude_local=True)
         (pushed_entries, failed_entries) = r.send_entries(entries_to_push,
                                                           self._entry_pushed)
 
+        local_entries = t.get_local_entries(self.options.date)
+        local_entries_list = []
+        for (date, entries) in local_entries.iteritems():
+            local_entries_list.extend(entries)
+        t.comment_entries(local_entries_list)
+
         t.fix_entries_start_time()
         t.comment_entries(pushed_entries)
         t.save()

taxi/models.py

@@ -10,6 +10,7 @@
 from taxi.parser import DateLine, EntryLine, TextLine, ParseError
 from taxi.utils import date as date_utils
 
+
 class Entry:
     def __init__(self, date, project_name, hours, description, id=None):
         self.project_name = project_name
@@ -18,13 +19,16 @@ def __init__(self, date, project_name, hours, description, id=None):
         self.date = date
         self.pushed = False
         self.ignored = False
+        self.local = False
         self.project_id = None
         self.activity_id = None
         self.id = id
 
     def __unicode__(self):
         if self.is_ignored():
             project_name = u'%s (ignored)' % (self.project_name)
+        elif self.is_local():
+            project_name = u'%s (local)' % (self.project_name)
         else:
             project_name = u'%s (%s/%s)' % (self.project_name, self.project_id, self.activity_id)
 
@@ -33,6 +37,12 @@ def __unicode__(self):
     def is_ignored(self):
         return self.ignored or self.get_duration() == 0
 
+    def is_local(self):
+        return self.local
+
+    def is_selected(self, exclude_ignored, exclude_local):
+        return not (exclude_ignored and self.is_ignored()) and not (exclude_local and self.is_local())
+
     def get_duration(self):
         if isinstance(self.duration, tuple):
             if None in self.duration:
@@ -50,6 +60,7 @@ def get_duration(self):
 
         return self.duration
 
+
 class Project:
     STATUS_NOT_STARTED = 0
     STATUS_ACTIVE = 1
@@ -221,13 +232,15 @@ def _update_entries(self):
                 if entry.project_name in self.mappings:
                     entry.project_id = self.mappings[entry.project_name][0]
                     entry.activity_id = self.mappings[entry.project_name][1]
+                    if(entry.project_id < 0 or entry.activity_id < 0):
+                        entry.local = True
                 else:
                     if not entry.is_ignored():
                         raise UndefinedAliasError(line.get_alias())
 
                 self.entries[current_date].append(entry)
 
-    def get_entries(self, date=None, exclude_ignored=False):
+    def get_entries(self, date=None, exclude_ignored=False, exclude_local=False):
         entries_dict = {}
 
         # Date can either be a single date (only 1 day) or a tuple for a
@@ -240,14 +253,26 @@ def get_entries(self, date=None, exclude_ignored=False):
                 if entrydate not in entries_dict:
                     entries_dict[entrydate] = []
 
-                if not exclude_ignored:
-                    entries_dict[entrydate].extend(entries)
-                else:
-                    d_list = [entry for entry in entries if not entry.is_ignored()]
-                    entries_dict[entrydate].extend(d_list)
+                d_list = [entry for entry in entries if entry.is_selected(exclude_ignored, exclude_local)]
+                entries_dict[entrydate].extend(d_list)
 
         return entries_dict
 
+    def get_local_entries(self, date=None):
+        entries_dict = self.get_entries(date, False)
+        local_entries = {}
+
+        for (date, entries) in entries_dict.iteritems():
+            local_entries_list = []
+            for entry in entries:
+                if entry.is_local():
+                    local_entries_list.append(entry)
+
+            if local_entries_list:
+                local_entries[date] = local_entries_list
+
+        return local_entries
+
     def get_ignored_entries(self, date=None):
         entries_dict = self.get_entries(date, False)
         ignored_entries = {}

taxi/settings.py

@@ -45,7 +45,7 @@ def get_auto_fill_days(self):
 
         return [int(e.strip()) for e in auto_fill_days.split(',')]
 
-    def get_aliases(self, include_shared=True):
+    def get_aliases(self, include_shared=True, include_local=True):
         aliases = {}
         config_aliases = self.config.items('wrmap')
         shared_config_aliases = (self.config.items('shared_wrmap')
@@ -68,6 +68,10 @@ def get_aliases(self, include_shared=True):
                         (alias, mapping)
                     )
 
+        if include_local:
+            for(alias) in self.config.get('default', 'local_aliases').split(','):
+                aliases[alias.strip()] = (-1, -1)
+
         return aliases
 
     def get_reversed_aliases(self, include_shared=True):

taxi/ui/__init__.py

@@ -199,7 +199,8 @@ def show_status(self, entries_dict):
                      date_utils.unicode_strftime(date, '%A %d %B').capitalize())
             for entry in entries:
                 self.msg(unicode(entry))
-                subtotal_hours += entry.get_duration() or 0
+                if not entry.is_local():
+                    subtotal_hours += entry.get_duration() or 0
 
             self.msg(u'%-29s %5.2f\n' % ('', subtotal_hours))
             total_hours += subtotal_hours