Merge lp:~justas.sadzevicius/gtimelog/recent_tasks into lp:~gtimelog-dev/gtimelog/trunk

[Marius Gedminas]

Cue 80s style commercial:

  Keep your time log activity list relevant and up to date!

  Act now and save (time)! *

  Only the best task lists brought to your doorstep by Justas'
Launchpad branch.

  * lp:~justas-pov/gtimelog/recent_tasks
  * unit tests sold separately

Cheers,
Justas

P.S.: my gtimelogrc config:

task_list_url =
recent_task_days = 14
max_recent_category_tasks = 6
max_total_recent_tasks = 14
max_top_duration = 7
max_top_recent = 7
max_top_days_worked = 6

(empty task_list_url and specified recent_task_days enable the task list)

P.P.S.:

"recent_task_days" - how many (calendar) days to aggregate

"max_recent_category_tasks" - max task entries per category

"max_total_recent_tasks" - max total of tasks in the list

Tasks are filtered by three criteria, then merged to a single list.

You can limit max amount of tasks for each filter:
"max_top_duration" - tasks you spent most time working on
"max_top_recent" - tasks you worked on most recently
"max_top_days_worked" - tasks you spend most days on

[Marius Gedminas (mgedmin)]

I want something like this.

I'm not happy that it creates a new file, mirroring the information already loaded into memory from timelog.txt. Is that really necessary?

I'd like to make the sidebar capable of displaying multiple pieces of information. Tasks and Recent Tasks could be two alternatives, selectable from a dropdown that would replace the title label.

That's a lot of new settings. And I get the impression that a lot of them are 0 and therefore disable this feature. Can we get some reasonable defaults that make it work out of the box?

[Justas Sadzevičius (justas.sadzevicius)]

> I want something like this.
>
> I'm not happy that it creates a new file, mirroring the information already
> loaded into memory from timelog.txt. Is that really necessary?

No, it was a quick hack.

> I'd like to make the sidebar capable of displaying multiple pieces of
> information. Tasks and Recent Tasks could be two alternatives, selectable
> from a dropdown that would replace the title label.

Oh, that would be nice!

> That's a lot of new settings. And I get the impression that a lot of them are
> 0 and therefore disable this feature. Can we get some reasonable defaults
> that make it work out of the box?

+1 for reasonable defaults. And I agree on too many settings.

At this point I just wanted to fiddle with them all to keep the actual list as short as possible. When displaying, say, only 15 tasks it's quite difficult to decide what makes the cut and what does not.

For now, I'd like to do some "field testing" and see what happens.

Unmerged revisions

178. By Justas Sadzevičius on 2011-01-18

Reload task list if gtimelogrc changed.

177. By Justas Sadzevičius on 2011-01-18

More filtering options.

176. By Justas Sadzevičius on 2011-01-18

Fast-and-dirty "recent" task list to pick from most recent, most worked on and most often worked on tasks.

=== modified file 'src/gtimelog/main.py'
--- src/gtimelog/main.py	2011-01-13 22:15:15 +0000
+++ src/gtimelog/main.py	2011-01-18 11:06:11 +0000
@@ -12,6 +12,7 @@
 import urllib
 import datetime
 import tempfile
+import itertools
 import ConfigParser
 
 import pygtk
@@ -694,7 +695,7 @@
         """
         mtime = self.get_mtime()
         if mtime != self.last_mtime:
-            self.load()
+            self.reload()
             return True
         else:
             return False
@@ -794,6 +795,13 @@
     task_list_url = ''
     edit_task_list_cmd = ''
 
+    recent_task_days = 0
+    max_recent_category_tasks = 15
+    max_total_recent_tasks = 50
+    max_top_recent_tasks = 0
+    max_top_duration_tasks = 0
+    max_top_days_worked_tasks = 0
+
     show_office_hours = True
     show_tray_icon = True
     prefer_app_indicator = True
@@ -816,6 +824,17 @@
                    self.virtual_midnight.strftime('%H:%M'))
         config.set('gtimelog', 'task_list_url', self.task_list_url)
         config.set('gtimelog', 'edit_task_list_cmd', self.edit_task_list_cmd)
+        config.set('gtimelog', 'recent_task_days', self.recent_task_days)
+        config.set('gtimelog', 'max_recent_category_tasks',
+                   self.max_recent_category_tasks)
+        config.set('gtimelog', 'max_total_recent_tasks',
+                   self.max_total_recent_tasks)
+        config.set('gtimelog', 'max_top_recent_tasks',
+                   self.max_top_recent_tasks)
+        config.set('gtimelog', 'max_top_duration_tasks',
+                   self.max_top_duration_tasks)
+        config.set('gtimelog', 'max_top_days_worked_tasks',
+                   self.max_top_days_worked_tasks)
         config.set('gtimelog', 'show_office_hours',
                    str(self.show_office_hours))
         config.set('gtimelog', 'show_tray_icon', str(self.show_tray_icon))
@@ -840,6 +859,18 @@
                                                       'virtual_midnight'))
         self.task_list_url = config.get('gtimelog', 'task_list_url')
         self.edit_task_list_cmd = config.get('gtimelog', 'edit_task_list_cmd')
+        self.recent_task_days = config.getint('gtimelog',
+                                              'recent_task_days')
+        self.max_recent_category_tasks = config.getint('gtimelog',
+                                                   'max_recent_category_tasks')
+        self.max_total_recent_tasks = config.getint('gtimelog',
+                                                   'max_total_recent_tasks')
+        self.max_top_recent_tasks = config.getint('gtimelog', 
+                                                  'max_top_recent_tasks')
+        self.max_top_duration_tasks = config.getint('gtimelog', 
+                                                    'max_top_duration_tasks')
+        self.max_top_days_worked_tasks = config.getint('gtimelog', 
+                                                       'max_top_days_worked_tasks')
         self.show_office_hours = config.getboolean('gtimelog',
                                                    'show_office_hours')
         self.show_tray_icon = config.getboolean('gtimelog', 'show_tray_icon')
@@ -858,6 +889,146 @@
             f.close()
 
 
+class RecentTaskList(TaskList):
+    """Task list picked out from the time log.
+
+    Keeps a cached copy of the list in a local file, so you can use it offline.
+    """
+
+    def __init__(self, cache_filename, timelog_filename,
+                 recent_days=0,
+                 max_category_tasks=0,
+                 max_total_tasks=0,
+                 max_top_recent=0,
+                 max_top_duration=0,
+                 max_top_days_worked=0,
+                 virtual_midnight=datetime.time(0, 0)):
+        self.timelog_filename = timelog_filename
+        self.max_category_tasks=max_category_tasks
+        self.max_total_tasks=max_total_tasks
+        self.max_top_recent=max_top_recent
+        self.max_top_duration=max_top_duration
+        self.max_top_days_worked=max_top_days_worked
+        self.recent_days=recent_days
+        self.virtual_midnight=virtual_midnight
+        TaskList.__init__(self, cache_filename)
+        self.first_time = True
+
+    def get_mtime(self):
+        """Return mtime tuple of (self.filename, self.timelog_filename),
+        or None if the one of them doesn't exist.
+        """
+        try:
+            return max(os.stat(self.filename).st_mtime,
+                       os.stat(self.timelog_filename).st_mtime)
+        except OSError:
+            return None
+
+    def check_reload(self):
+        if self.first_time:
+            self.first_time = False
+            if not os.path.exists(self.filename):
+                self.generate()
+                self.load()
+                return True
+        return TaskList.check_reload(self)
+
+    def top_recent(self, entries):
+        result = []
+        for start, stop, duration, entry in entries:
+            if entry in result:
+                result.remove(entry)
+            result.insert(0, entry)
+        return result
+
+    def top_duration(self, entries):
+        entry_duration = {}
+        for start, stop, duration, entry in entries:
+            total_duration = entry_duration.get(entry, datetime.timedelta(0))
+            total_duration += duration
+            entry_duration[entry] = total_duration
+
+        sorted_entries = sorted(entry_duration.items(),
+                                key=lambda e: e[1],
+                                reverse=True)
+        result = [e[0] for e in sorted_entries]
+        return result
+
+    def top_days_worked(self, entries):
+        entry_days = {}
+        for start, stop, duration, entry in entries:
+            day = virtual_day(start, self.virtual_midnight)
+            entry_days.setdefault(entry, set()).add(day)
+        sorted_entries = sorted(entry_days.items(),
+                                key=lambda e: len(e[1]),
+                                reverse=True)
+        result = [e[0] for e in sorted_entries]
+        return result
+
+    def generate(self):
+        """Generate the task list from time log."""
+        virtual_tomorrow = virtual_day(
+            datetime.datetime.now() + datetime.timedelta(1),
+            self.virtual_midnight)
+
+        dt_max = datetime.datetime.combine(virtual_tomorrow, self.virtual_midnight)
+        dt_min = dt_max - datetime.timedelta(self.recent_days)
+
+        time_window = TimeWindow(
+            self.timelog_filename, dt_min, dt_max,
+            self.virtual_midnight)
+
+        # XXX: load to memory... ouch.
+        all_entries = list(time_window.all_entries())
+
+        top_recent = self.top_recent(all_entries)
+        if self.max_top_recent:
+            top_recent = top_recent[:self.max_top_recent]
+        top_duration = self.top_duration(all_entries)
+        if self.max_top_duration:
+            top_duration = top_duration[:self.max_top_duration]
+        top_days_worked =  self.top_days_worked(all_entries)
+        if self.max_top_days_worked:
+            top_days_worked = top_days_worked[:self.max_top_days_worked]
+
+        recent = []
+        for entries in itertools.izip_longest(top_recent,
+                                              top_duration,
+                                              top_days_worked):
+            for entry in filter(None, entries):
+                if ': ' in entry:
+                    cat_task = tuple([s.strip() for s in entry.split(': ', 1)])
+                else:
+                    cat_task = ('Other', entry.strip())
+                if cat_task not in recent:
+                    recent.append(cat_task)
+
+        recent = recent[:self.max_total_tasks]
+
+        by_category = {}
+        for category, task in recent:
+            by_category.setdefault(category, []).append(task)
+        for category in by_category:
+            tasks = by_category[category]
+            tasks = tasks[:self.max_category_tasks]
+            by_category[category] = tasks
+
+        separator = '#..%s..#' % '...x...'.join([str(d) for d in range(1, 7)])
+        f = open(self.filename, "w")
+        for category in sorted(by_category):
+            tasks = by_category[category]
+            print >> f, separator
+            print >> f
+            for task in tasks:
+                print >> f, '%s: %s' % (category, task)
+            print >> f
+        f.close()
+
+    def reload(self):
+        self.generate()
+        self.load()
+
+
 class IconChooser(object):
 
     @property
@@ -1796,6 +1967,23 @@
     if settings.task_list_url:
         tasks = RemoteTaskList(settings.task_list_url,
                                os.path.join(configdir, 'remote-tasks.txt'))
+    elif settings.recent_task_days:
+        tasks = RecentTaskList(
+            os.path.join(configdir, 'recent-tasks.txt'),
+            os.path.join(configdir, 'timelog.txt'),
+            recent_days=settings.recent_task_days,
+            max_category_tasks=settings.max_recent_category_tasks,
+            max_total_tasks=settings.max_total_recent_tasks,
+            max_top_recent=settings.max_top_recent_tasks,
+            max_top_duration=settings.max_top_duration_tasks,
+            max_top_days_worked=settings.max_top_days_worked_tasks,
+            virtual_midnight=settings.virtual_midnight)
+        try:
+            if (os.stat(tasks.filename).st_mtime <
+                os.stat(settings_file).st_mtime):
+                tasks.reload()
+        except OSError:
+            pass
     else:
         tasks = TaskList(os.path.join(configdir, 'tasks.txt'))
     main_window = MainWindow(timelog, settings, tasks)