Merge lp:~moea/mutant/amp-dialog-api-change into lp:mutant

[Moe Aboulkheir]

[Glyph Lefkowitz (glyph)]

review: Approve

=== modified file 'mutant/amp_login_dialog.py'
--- mutant/amp_login_dialog.py	2009-05-26 13:29:56 +0000
+++ mutant/amp_login_dialog.py	2009-06-01 20:59:15 +0000
@@ -15,19 +15,22 @@
 
 
 
+class NoAMPCredentials(Exception):
+    """
+    L{Exception} indicating that no credentials were supplied to
+    L{AMPLoginDialog} before it was closed.
+    """
+
+
+
 class AMPLoginDialog:
     """
     Object responsible for responding to events generated by the
     C{loginDialog} in C{login.glade}.
-
-    @ivar credentialsDeferred: Deferred firing with a 3-tuple of (username,
-        password, host), once the I{Login} button has been clicked, or C{None}
-        if the dialog is cancelled or deleted.
-    @type credentialsDeferred: L{Deferred}
     """
     def __init__(self):
         self.widget = GladeLoginDialog.load(self)
-        self.credentialsDeferred = Deferred()
+        self.deferreds = []
 
 
     def show(self):
@@ -37,11 +40,35 @@
         self.widget.loginDialog.show_all()
 
 
+    def _callback(self, result):
+        while self.deferreds:
+            self.deferreds.pop().callback(result)
+
+
+    def _errback(self, result):
+        while self.deferreds:
+            self.deferreds.pop().errback(result)
+
+
+    def onComplete(self):
+        """
+        Return a Deferred which will fire once the dialog has completed.
+
+        @return: Deferred firing with a 3-tuple of (username, password, host),
+            once the I{Login} button has been clicked, or with
+            L{NoAMPCredentials} if the dialog is closed/deleted.
+        @rtype: L{Deferred}
+        """
+        d = Deferred()
+        self.deferreds.append(d)
+        return d
+
+
     def widget_dialogDeleted(self, dialog, event):
         """
         Called when a I{delete_event} fires for C{loginDialog}.
         """
-        self.credentialsDeferred.callback(None)
+        self._errback(NoAMPCredentials())
         return True
 
 
@@ -54,7 +81,7 @@
         password = self.widget.password.get_text()
         hostname = self.widget.hostname.get_text()
         self.widget.loginDialog.destroy()
-        self.credentialsDeferred.callback((username, password, hostname))
+        self._callback((username, password, hostname))
 
 
     def widget_cancelButtonClicked(self, button):
@@ -62,4 +89,4 @@
         Called when the I{Cancel} button is clicked.  Destroys C{loginDialog}.
         """
         self.widget.loginDialog.destroy()
-        self.credentialsDeferred.callback(None)
+        self._errback(NoAMPCredentials())

=== modified file 'mutant/test/test_amp_login_dialog.py'
--- mutant/test/test_amp_login_dialog.py	2009-05-26 13:29:56 +0000
+++ mutant/test/test_amp_login_dialog.py	2009-06-01 20:59:15 +0000
@@ -4,7 +4,7 @@
 
 from twisted.trial.unittest import TestCase
 
-from mutant.amp_login_dialog import AMPLoginDialog
+from mutant.amp_login_dialog import AMPLoginDialog, NoAMPCredentials
 
 
 class AMPLoginDialogTests(TestCase):
@@ -19,7 +19,7 @@
     def test_loginButtonClicked(self):
         """
         L{AMPLoginDialog.widget_loginButtonClicked} should fire
-        L{AMPLoginDialog.credentialsDeferred} with the correct values.
+        L{AMPLoginDialog.onComplete} with the correct values.
         """
         dialog = AMPLoginDialog()
         widget = dialog.widget
@@ -30,9 +30,10 @@
             self.assertEqual(username, self.USERNAME)
             self.assertEqual(password, self.PASSWORD)
             self.assertEqual(hostname, self.HOSTNAME)
-        dialog.credentialsDeferred.addCallback(cbCredentials)
+        onComplete = dialog.onComplete()
+        onComplete.addCallback(cbCredentials)
         dialog.widget_loginButtonClicked(None)
-        return dialog.credentialsDeferred
+        return onComplete
 
 
     def test_cancelButtonClicked(self):
@@ -41,6 +42,7 @@
         C{loginDialog}.
         """
         dialog = AMPLoginDialog()
+        onComplete = dialog.onComplete()
         widget = dialog.widget
 
         def destroyed(widget):
@@ -51,21 +53,23 @@
         dialog.widget_cancelButtonClicked(False)
         self.assertTrue(destroyed.destroyed)
 
-        dialog.credentialsDeferred.addCallback(
-            self.assertIdentical, None)
-        return dialog.credentialsDeferred
+        onComplete.addCallbacks(
+            self.fail, lambda f: f.trap(NoAMPCredentials))
+        return onComplete
 
 
     def test_dialogDeleted(self):
         """
         L{AMPLoginDialog.widget_dialogDeleted} should fire
-        L{AMPLoginDialog.credentialsDeferred}.
+        L{AMPLoginDialog.onComplete}.
         """
         dialog = AMPLoginDialog()
+        onComplete = dialog.onComplete()
         self.assertTrue(dialog.widget_dialogDeleted(None, None))
-        dialog.credentialsDeferred.addCallback(
-            self.assertIdentical, None)
-        return dialog.credentialsDeferred
+        onComplete.addCallbacks(
+            self.fail,
+            lambda f: f.trap(NoAMPCredentials))
+        return onComplete
 
 
     def test_dialogDeletedCalled(self):