Merge lp:~rockstar/laika/foolin into lp:laika

[Paul Hummer]

This branch just refactors some of the functionality of laika into a Report class. It's just moving code around really. I haven't changed any of the functionality of laika itself. It's merely contained in a class instance now.

[Alex Chiang (achiang)]

Commit #5 in your branch was a little large for my taste, but I did review it and verify that there was not really any functional change.

Thanks for the patches; they're awesome!

review: Approve

=== modified file 'laika.py'
--- laika.py	2010-05-24 22:24:25 +0000
+++ laika.py	2010-07-16 16:33:22 +0000
@@ -7,14 +7,18 @@
 # http://en.wikipedia.org/wiki/Laika
 #
 # Copyright 2010 Alex Chiang <[e-mail]>
-# 
+#
 # This program is distributed under the terms of the
 # GNU General Public License version 2.
 
+import datetime
+import getopt
 import os
 import re
 import sys
-import datetime
+
+from launchpadlib.launchpad import Launchpad
+
 
 # Number of days prior to search for Launchpad activity
 window = 8
@@ -23,144 +27,155 @@
 now = datetime.datetime.utcnow()
 my_bugs = {}
 
-def print_header(header):
-	print "==", header, "=="
-
-# Here be side-effects. Using this interface adds the bug to global bug list.
-def print_bugid(task):
-	ago = ""
-	my_bugs[task.bug.id] = 1
-	delta = now - task.bug.date_last_updated.replace(tzinfo=None)
-	if delta.days > 0:
-		ago = "%d day%s" % (delta.days, "s" if delta.days > 1 else "")
-
-	hours = delta.seconds / 3600
-	if hours > 0:
-		ago += ", " if ago else ""
-		ago += "%d hour%s" % (hours, "s" if hours > 1 else "")
-	
-	minutes = (delta.seconds - (hours * 3600)) / 60
-	if minutes > 0:
-		ago += ", " if ago else ""
-		ago += "%d minute%s" % (minutes, "s" if minutes > 1 else "")
-
-	print task.title
-	print "https://launchpad.net/bugs/" + str(task.bug.id)
-	print "last updated", ago, "ago"
-
-# heh.
-# 	Timezones do not exist, all datetime objects have to be naive.
-# 	aware means broken.
-# http://www.enricozini.org/2009/debian/using-python-datetime/
-def in_window(date):
-	win = datetime.timedelta(window)
-	date = date.replace(tzinfo=None)
-	delta = now - date
-	return delta <= win
-
-def my_assignments(me):
-	statuses = ['closed', 'fix_released', 'fix_committed',
-		    'in_progress', 'triaged', 'confirmed', 'created']
-
-	tasks = me.searchTasks(assignee=me)
-	print_header("Assigned Bugs")
-
-	for t in tasks:
-		if my_bugs.has_key(t.bug.id):
-			continue
-		updates = []
-		for s in statuses:
-			attr = 'date_' + s
-			date = getattr(t, attr)
-			if not date:
-				continue
-			if in_window(date):
-				updates.append("\t" + s + ": " + re.sub("\s.*$", "", str(date)))
-
-		if updates:
-			print_bugid(t)
-			for u in updates:
-				print u
-			print
-	print
-
-def my_comments(me):
-	tasks = me.searchTasks(bug_commenter=me)
-	print_header("Commented Bugs")
-	for t in tasks:
-		if my_bugs.has_key(t.bug.id):
-			continue
-		for m in t.bug.messages:
-			if m.owner_link != me.self_link:
-				continue
-			if in_window(m.date_created):
-				print_bugid(t)
-				print
-				break
-	print
-
-def my_reported(me):
-	tasks = me.searchTasks(bug_reporter=me)
-	print_header("Reported Bugs")
-	for t in tasks:
-		if my_bugs.has_key(t.bug.id):
-			continue
-		if in_window(t.bug.date_created):
-			print_bugid(t)
-			print
-
-# In order of decreasing importance, search and display activity on
-# bugs assigned to me, then on bugs that I actually commented upon,
-# and finally bugs that I just opened, but did nothing further with.
-#
-# Avoids duplication of activity. So if the status was changed on
-# a bug assigned to you and you also commented on it, only report the
-# status change.
-def launch(lp):
-	me = lp.me
-	my_assignments(me)
-	my_comments(me)
-	my_reported(me)
+
+class Report(object):
+    '''An activity report for a specified Launchpad user.
+
+    In order of decreasing importance, search and display activity on
+    bugs assigned to me, then on bugs that I actually commented upon,
+    and finally bugs that I just opened, but did nothing further with.
+
+    Avoids duplication of activity. So if the status was changed on
+    a bug assigned to you and you also commented on it, only report the
+    status change.
+    '''
+
+    def __init__(self, user):
+        self.user = user
+
+    def print_header(self, header):
+        print "==", header, "=="
+
+    def in_window(self, date):
+        '''Timezones do not exist, all datetime objects have to be naive.
+
+        Time zone aware means broken.
+        http://www.enricozini.org/2009/debian/using-python-datetime/
+        '''
+        win = datetime.timedelta(window)
+        date = date.replace(tzinfo=None)
+        delta = now - date
+        return delta <= win
+
+    def print_bugid(self, task):
+        '''Using this interface adds the bug to global bug list.'''
+        ago = ""
+        my_bugs[task.bug.id] = 1
+        delta = now - task.bug.date_last_updated.replace(tzinfo=None)
+        if delta.days > 0:
+            ago = "%d day%s" % (delta.days, "s" if delta.days > 1 else "")
+
+        hours = delta.seconds / 3600
+        if hours > 0:
+            ago += ", " if ago else ""
+            ago += "%d hour%s" % (hours, "s" if hours > 1 else "")
+
+        minutes = (delta.seconds - (hours * 3600)) / 60
+        if minutes > 0:
+            ago += ", " if ago else ""
+            ago += "%d minute%s" % (minutes, "s" if minutes > 1 else "")
+
+        print task.title
+        print "https://launchpad.net/bugs/" + str(task.bug.id)
+        print "last updated", ago, "ago"
+
+    def print_assignments(self):
+        statuses = ['closed', 'fix_released', 'fix_committed',
+                'in_progress', 'triaged', 'confirmed', 'created']
+
+        tasks = self.user.searchTasks(assignee=self.user)
+        self.print_header("Assigned Bugs")
+
+        for t in tasks:
+            if my_bugs.has_key(t.bug.id):
+                continue
+            updates = []
+            for s in statuses:
+                attr = 'date_' + s
+                date = getattr(t, attr)
+                if not date:
+                    continue
+                if self.in_window(date):
+                    updates.append(
+                        "\t" + s + ": " + re.sub("\s.*$", "", str(date)))
+
+            if updates:
+                self.print_bugid(t)
+                for u in updates:
+                    print u
+                print
+        print
+
+    def print_comments(self):
+        tasks = self.user.searchTasks(bug_commenter=self.user)
+        self.print_header("Commented Bugs")
+        for t in tasks:
+            if my_bugs.has_key(t.bug.id):
+                continue
+            for m in t.bug.messages:
+                if m.owner_link != self.user.self_link:
+                    continue
+                if self.in_window(m.date_created):
+                    self.print_bugid(t)
+                    print
+                    break
+        print
+
+    def print_reported(self):
+        tasks = self.user.searchTasks(bug_reporter=self.user)
+        self.print_header("Reported Bugs")
+        for t in tasks:
+            if my_bugs.has_key(t.bug.id):
+                continue
+            if self.in_window(t.bug.date_created):
+                self.print_bugid(t)
+                print
+
+    def render(self):
+        self.print_assignments()
+        self.print_comments()
+        self.print_reported()
+
 
 def usage():
-	print "Usage:"
-	print "\tlaika [-u <login>] [-w <window>] [-h]"
-	print
-	print "\t-u <login>"
-	print "\t\tSpecify your Launchpad user id."
-	print "\t\tIf not specified, defaults to: %s." % (user)
-	print
-	print "\t-w <num>"
-	print "\t\tLook for activity within the past <num> days."
-	print "\t\tIf not specified, defaults to %d." % (window)
-	print
-	print "\t-h"
-	print "\t\tDisplay this message."
+    print "Usage:"
+    print "\tlaika [-u <login>] [-w <window>] [-h]"
+    print
+    print "\t-u <login>"
+    print "\t\tSpecify your Launchpad user id."
+    print "\t\tIf not specified, defaults to: %s." % (user)
+    print
+    print "\t-w <num>"
+    print "\t\tLook for activity within the past <num> days."
+    print "\t\tIf not specified, defaults to %d." % (window)
+    print
+    print "\t-h"
+    print "\t\tDisplay this message."
 
 def main(argv):
-	import getopt
-	from launchpadlib.launchpad import Launchpad
-
-	try:
-		opts, args = getopt.getopt(argv, "hu:w:")
-	except getopt.GetoptError:
-		usage()
-		sys.exit(2)
-	
-	for opt, arg in opts:
-		if opt == '-h':
-			usage()
-			sys.exit()
-		elif opt == '-u':
-			global user
-			user = arg
-		elif opt == '-w':
-			global window
-			window = int(arg)
-	
-	cachedir = "/home/" + user + "/.launchpadlib/cache/"
-	lp = Launchpad.login_with('laika', 'production', cachedir)
-	launch(lp)
+
+    try:
+        opts, args = getopt.getopt(argv, "hu:w:")
+    except getopt.GetoptError:
+        usage()
+        sys.exit(2)
+
+    for opt, arg in opts:
+        if opt == '-h':
+            usage()
+            sys.exit()
+        elif opt == '-u':
+            global user
+            user = arg
+        elif opt == '-w':
+            global window
+            window = int(arg)
+
+    cachedir = "/home/" + user + "/.launchpadlib/cache/"
+    lp = Launchpad.login_with('laika', 'production', cachedir)
+
+    report = Report(lp.me)
+    report.render()
 
 if __name__ == "__main__":
-	main(sys.argv[1:])
+    main(sys.argv[1:])