Merge lp:~alecu/ubuntuone-client/i18n-notifications into lp:ubuntuone-client

[Alejandro J. Cura]

Make status aggregator strings translatable. LP #718171

Make status aggregator strings translatable. LP #718171

[lp:~alecu/ubuntuone-client/i18n-notifications]

882. By Alejandro J. Cura on 2011-02-22

i18n for event strings

[Natalia Bidart (nataliabidart)]

review: Approve

[Roberto Alsina (ralsina)]

review: Approve

=== modified file 'po/POTFILES.in'
--- po/POTFILES.in	2011-02-07 15:10:56 +0000
+++ po/POTFILES.in	2011-02-22 15:54:43 +0000
@@ -1,4 +1,5 @@
 ubuntuone/clientdefs.py.in
+ubuntuone/status/aggregator.py
 ubuntuone/platform/linux/credentials.py
 data/emblem-ubuntuone-downloading.icon.in
 data/emblem-ubuntuone-unsynchronized.icon.in

=== modified file 'tests/status/test_aggregator.py'
--- tests/status/test_aggregator.py	2011-02-17 13:11:11 +0000
+++ tests/status/test_aggregator.py	2011-02-22 15:54:43 +0000
@@ -874,7 +874,7 @@
             1, len(self.status_frontend.notification.notifications_shown))
         self.assertEqual(
             (aggregator.UBUNTUONE_TITLE,
-             'New cloud folder available: <%s> shared by <%s>' % (
+             "New cloud folder available: '%s' shared by %s" % (
                  'None', FAKE_SENDER), None, False),
             self.status_frontend.notification.notifications_shown[0])
         msg = self.status_frontend.messaging.messages_shown[FAKE_SENDER]
@@ -890,7 +890,7 @@
         self.assertEqual(
             1, len(self.status_frontend.notification.notifications_shown))
         self.assertEqual(
-            (aggregator.UBUNTUONE_TITLE, 'New cloud folder available: None',
+            (aggregator.UBUNTUONE_TITLE, "New cloud folder available: 'None'",
              None, False),
             self.status_frontend.notification.notifications_shown[0])
         self.assertEqual(
@@ -913,11 +913,11 @@
         self.assertEqual(
             2, len(self.status_frontend.notification.notifications_shown))
         self.assertEqual(
-            (aggregator.UBUNTUONE_TITLE, 'New cloud folder available: None',
+            (aggregator.UBUNTUONE_TITLE, "New cloud folder available: 'None'",
              None, False),
             self.status_frontend.notification.notifications_shown[0])
         self.assertEqual(
-            (aggregator.UBUNTUONE_TITLE, 'New cloud folder available: None',
+            (aggregator.UBUNTUONE_TITLE, "New cloud folder available: 'None'",
              None, False),
             self.status_frontend.notification.notifications_shown[1])
         self.assertEqual(
@@ -966,15 +966,15 @@
     """Test the status event class and children."""
 
     CLASS = aggregator.StatusEvent
-    CLASS_ARGS = ()
+    CLASS_KWARGS = {}
     status = None
 
     def setUp(self):
         """Initialize this test instance."""
         if type(self) == StatusEventTestCase:
-            self.assertRaises(AssertionError, self.CLASS, *self.CLASS_ARGS)
+            self.assertRaises(AssertionError, self.CLASS, **self.CLASS_KWARGS)
         else:
-            self.status = self.CLASS(*self.CLASS_ARGS)
+            self.status = self.CLASS(**self.CLASS_KWARGS)
 
     def test_one_message_defined(self):
         """The singular message is defined as MESSAGE_ONE."""
@@ -996,7 +996,8 @@
         if self.status:
             count = 99
             test_events = [FakeStatus(88)] * count
-            expected = self.CLASS.MESSAGE_MANY % count
+            format_args = {"event_count": count}
+            expected = self.CLASS.MESSAGE_MANY % format_args
             self.assertEqual(self.status.many(test_events), expected)
 
 
@@ -1004,11 +1005,11 @@
     """Test the file publishing status class."""
 
     CLASS = aggregator.FilePublishingStatus
-    CLASS_ARGS = ("http://fake_public/url",)
+    CLASS_KWARGS = {"new_public_url": "http://fake_public/url"}
 
     def test_one_message_built_correctly(self):
         """The message returned by one() should include the url."""
-        expected = self.CLASS.MESSAGE_ONE % self.status.args
+        expected = self.CLASS.MESSAGE_ONE % self.status.kwargs
         self.assertEqual(self.status.one(), expected)
 
 
@@ -1016,7 +1017,7 @@
     """Test the file unpublishing status class."""
 
     CLASS = aggregator.FileUnpublishingStatus
-    CLASS_ARGS = (None,)
+    CLASS_KWARGS = {"old_public_url": None}
 
 
 class ShareAvailableEventTestCase(StatusEventTestCase):
@@ -1027,12 +1028,15 @@
     SAMPLE_SHARE = Share(accepted=False, name=FOLDER_NAME,
                          other_visible_name=OTHER_USER_NAME)
     CLASS = aggregator.ShareAvailableStatus
-    CLASS_ARGS = (SAMPLE_SHARE,)
+    CLASS_KWARGS = {"share": SAMPLE_SHARE}
 
     def test_one_message_built_correctly(self):
         """one() must return the folder name and user name."""
-        params = (self.FOLDER_NAME, self.OTHER_USER_NAME)
-        expected = self.CLASS.MESSAGE_ONE % params
+        format_args = {
+            "folder_name": self.FOLDER_NAME,
+            "other_user_name": self.OTHER_USER_NAME,
+        }
+        expected = self.CLASS.MESSAGE_ONE % format_args
         self.assertEqual(self.status.one(), expected)
 
 
@@ -1042,12 +1046,12 @@
     FOLDER_NAME = "folder name"
     SAMPLE_UDF = UDF(subscribed=False, suggested_path=FOLDER_NAME)
     CLASS = aggregator.UDFAvailableStatus
-    CLASS_ARGS = (SAMPLE_UDF,)
+    CLASS_KWARGS = {'udf': SAMPLE_UDF}
 
     def test_one_message_built_correctly(self):
         """one() must return the folder name."""
-        params = (self.FOLDER_NAME,)
-        expected = self.CLASS.MESSAGE_ONE % params
+        format_args = {"folder_name": self.FOLDER_NAME}
+        expected = self.CLASS.MESSAGE_ONE % format_args
         self.assertEqual(self.status.one(), expected)
 
 
@@ -1055,7 +1059,6 @@
     """Test the event when the connection is lost."""
 
     CLASS = aggregator.ConnectionLostStatus
-    CLASS_ARGS = ()
 
     def test_many_message_built_correctly(self):
         """The message returned by many() is returned ok."""
@@ -1070,7 +1073,6 @@
     """Test the event when the connection is made."""
 
     CLASS = aggregator.ConnectionMadeStatus
-    CLASS_ARGS = ()
 
 
 class FakeStatus(aggregator.StatusEvent):
@@ -1238,10 +1240,12 @@
         """Test the message that's shown on the discovery bubble."""
         uploading = 10
         downloading = 8
+        upload_fmt = {"total_uploading_files": uploading}
+        download_fmt = {"total_downloading_files": downloading}
         self.aggregator.files_uploading.extend(range(uploading))
         self.aggregator.files_downloading.extend(range(downloading))
-        expected = (aggregator.FILES_UPLOADING % uploading + "\n" +
-                    aggregator.FILES_DOWNLOADING % downloading)
+        expected = (aggregator.FILES_UPLOADING % upload_fmt + "\n" +
+                    aggregator.FILES_DOWNLOADING % download_fmt)
         result = self.aggregator.get_discovery_message()
         self.assertEqual(expected, result)
 
@@ -1253,9 +1257,19 @@
         self.aggregator.download_total = 8
         self.aggregator.done_counter = 9
         self.aggregator.total_counter = 20
-        expected = (aggregator.FILES_UPLOADING % 10 + " " +
-                    aggregator.FILES_DOWNLOADING % 8 + " " +
-                    aggregator.PROGRESS_COMPLETED % int(100.0 * 9 / 20))
+        percentage = int(100.0 * self.aggregator.done_counter /
+                         self.aggregator.total_counter)
+        format_args = {
+            "total_uploading_files": self.aggregator.upload_total,
+            "total_downloading_files": self.aggregator.download_total,
+            "percentage_completed": percentage,
+        }
+
+        format_string = (aggregator.FILES_UPLOADING + "\n" +
+                         aggregator.FILES_DOWNLOADING + "\n" +
+                         aggregator.PROGRESS_COMPLETED)
+
+        expected = format_string % format_args
         result = self.aggregator.get_progress_message()
         self.assertEqual(expected, result)
 
@@ -1267,8 +1281,17 @@
         self.aggregator.download_total = 8
         self.aggregator.done_counter = 9
         self.aggregator.total_counter = 20
-        expected = (aggregator.FILES_DOWNLOADING % 8 + " " +
-                    aggregator.PROGRESS_COMPLETED % int(100.0 * 9 / 20))
+        percentage = int(100.0 * self.aggregator.done_counter /
+                         self.aggregator.total_counter)
+        format_args = {
+            "total_downloading_files": self.aggregator.download_total,
+            "percentage_completed": percentage,
+        }
+
+        format_string = (aggregator.FILES_DOWNLOADING + "\n" +
+                         aggregator.PROGRESS_COMPLETED)
+
+        expected = format_string % format_args
         result = self.aggregator.get_progress_message()
         self.assertEqual(expected, result)
 
@@ -1280,8 +1303,17 @@
         self.aggregator.download_total = 0
         self.aggregator.done_counter = 9
         self.aggregator.total_counter = 20
-        expected = (aggregator.FILES_UPLOADING % 10 + " " +
-                    aggregator.PROGRESS_COMPLETED % int(100.0 * 9 / 20))
+        percentage = int(100.0 * self.aggregator.done_counter /
+                         self.aggregator.total_counter)
+        format_args = {
+            "total_uploading_files": self.aggregator.upload_total,
+            "percentage_completed": percentage,
+        }
+
+        format_string = (aggregator.FILES_UPLOADING + "\n" +
+                         aggregator.PROGRESS_COMPLETED)
+
+        expected = format_string % format_args
         result = self.aggregator.get_progress_message()
         self.assertEqual(expected, result)
 
@@ -1294,9 +1326,17 @@
         """The final status message."""
         done = (5, 10)
         self.aggregator.upload_done, self.aggregator.download_done = done
-        expected = (aggregator.FINAL_COMPLETED + "\n" +
-                    aggregator.FINAL_UPLOADED % done[0] + "\n" +
-                    aggregator.FINAL_DOWNLOADED % done[1])
+
+        format_args = {
+            "total_uploaded_files": self.aggregator.upload_done,
+            "total_downloaded_files": self.aggregator.download_done,
+        }
+
+        format_string = (aggregator.FINAL_COMPLETED + "\n" +
+                         aggregator.FINAL_UPLOADED + "\n" +
+                         aggregator.FINAL_DOWNLOADED)
+
+        expected = format_string % format_args
         result = self.aggregator.get_final_status_message()
         self.assertEqual(expected, result)
 
@@ -1304,8 +1344,15 @@
         """The final status message when there were no uploads."""
         done = (0, 12)
         self.aggregator.upload_done, self.aggregator.download_done = done
-        expected = (aggregator.FINAL_COMPLETED + "\n" +
-                    aggregator.FINAL_DOWNLOADED % done[1])
+
+        format_args = {
+            "total_downloaded_files": self.aggregator.download_done,
+        }
+
+        format_string = (aggregator.FINAL_COMPLETED + "\n" +
+                         aggregator.FINAL_DOWNLOADED)
+
+        expected = format_string % format_args
         result = self.aggregator.get_final_status_message()
         self.assertEqual(expected, result)
 
@@ -1313,8 +1360,15 @@
         """The final status message when there were no downloads."""
         done = (8, 0)
         self.aggregator.upload_done, self.aggregator.download_done = done
-        expected = (aggregator.FINAL_COMPLETED + "\n" +
-                    aggregator.FINAL_UPLOADED % done[0])
+
+        format_args = {
+            "total_uploaded_files": self.aggregator.upload_done,
+        }
+
+        format_string = (aggregator.FINAL_COMPLETED + "\n" +
+                         aggregator.FINAL_UPLOADED)
+
+        expected = format_string % format_args
         result = self.aggregator.get_final_status_message()
         self.assertEqual(expected, result)
 

=== modified file 'ubuntuone/status/aggregator.py'
--- ubuntuone/status/aggregator.py	2011-02-17 13:11:11 +0000
+++ ubuntuone/status/aggregator.py	2011-02-22 15:54:43 +0000
@@ -22,12 +22,16 @@
 import os
 import sys
 
+import gettext
+
 from twisted.internet import reactor, defer
 
+from ubuntuone.clientdefs import GETTEXT_PACKAGE
 from ubuntuone.logger import basic_formatter, logging
 from ubuntuone.platform.notification import Notification
 from ubuntuone.platform.messaging import Messaging, open_volumes
 
+Q_ = lambda string: gettext.dgettext(GETTEXT_PACKAGE, string)
 LOG_LEVEL = logging.DEBUG
 logger = logging.getLogger('ubuntuone.status')
 logger.setLevel(LOG_LEVEL)
@@ -38,15 +42,18 @@
     debug_handler.setLevel(LOG_LEVEL)
     logger.addHandler(debug_handler)
 
-UBUNTUONE_TITLE = "Ubuntu One"
-NEW_UDFS_SENDER = "New cloud folder(s) available"
-FINAL_COMPLETED = "File synchronization completed."
-FINAL_UPLOADED = "%d file(s) were uploaded to your personal cloud."
-FINAL_DOWNLOADED = "%d file(s) were downloaded to your computer."
-FILES_UPLOADING = "%d file(s) are uploading to your personal cloud."
-FILES_DOWNLOADING = "%d file(s) are downloading to your computer."
-PROGRESS_UPLOADED = "Uploaded %d/%d file(s)."
-PROGRESS_COMPLETED = "%d%% completed."
+UBUNTUONE_TITLE = Q_("Ubuntu One")
+NEW_UDFS_SENDER = Q_("New cloud folder(s) available")
+FINAL_COMPLETED = Q_("File synchronization completed.")
+FINAL_UPLOADED = Q_("%(total_uploaded_files)d file(s) were uploaded to " +
+                    "your personal cloud.")
+FINAL_DOWNLOADED = Q_("%(total_downloaded_files)d file(s) were downloaded " +
+                      "to your computer.")
+FILES_UPLOADING = Q_("%(total_uploading_files)d file(s) are uploading to " +
+                     "your personal cloud.")
+FILES_DOWNLOADING = Q_("%(total_downloading_files)d file(s) are downloading " +
+                       "to your computer.")
+PROGRESS_COMPLETED = Q_("%(percentage_completed)d%% completed.")
 
 class ToggleableNotification(object):
     """A controller for notifications that can be turned off."""
@@ -94,10 +101,10 @@
     WEIGHT = 99
     DO_NOT_INSTANCE = "Do not instance this class, only children."""
 
-    def __init__(self, *args):
+    def __init__(self, **kwargs):
         """Initialize this instance."""
         assert type(self) != StatusEvent, self.DO_NOT_INSTANCE
-        self.args = args
+        self.kwargs = kwargs
 
     def one(self):
         """A message if this is the only event of this type."""
@@ -105,58 +112,63 @@
 
     def many(self, events):
         """A message if there are many events of this type."""
-        return self.MESSAGE_MANY % len(events)
+        format_args = {"event_count": len(events)}
+        return self.MESSAGE_MANY % format_args
 
 
 class FilePublishingStatus(StatusEvent):
     """Files that are made public with a url."""
 
-    MESSAGE_ONE = "A file was just made public at %s"
-    MESSAGE_MANY = "%d files were just made public"
+    MESSAGE_ONE = Q_("A file was just made public at %(new_public_url)s")
+    MESSAGE_MANY = Q_("%(event_count)d files were just made public")
     WEIGHT = 50
 
     def one(self):
         """Show the url if only one event of this type."""
-        return self.MESSAGE_ONE % self.args
+        return self.MESSAGE_ONE % self.kwargs
 
 
 class FileUnpublishingStatus(StatusEvent):
     """Files that have stopped being published."""
 
-    MESSAGE_ONE = "A file is no longer published"
-    MESSAGE_MANY = "%d files are no longer published"
+    MESSAGE_ONE = Q_("A file is no longer published")
+    MESSAGE_MANY = Q_("%(event_count)d files are no longer published")
     WEIGHT = 51
 
 
 class FolderAvailableStatus(StatusEvent):
     """Folders available for subscription."""
 
-    MESSAGE_MANY = "Found %d new cloud folders."""
+    MESSAGE_MANY = Q_("Found %(event_count)d new cloud folders.")
     WEIGHT = 60
 
 
 class ShareAvailableStatus(FolderAvailableStatus):
     """A Share is available for subscription."""
 
-    MESSAGE_ONE = "New cloud folder available: <%s> shared by <%s>"""
+    MESSAGE_ONE = Q_("New cloud folder available: '%(folder_name)s' "
+                     "shared by %(other_user_name)s")
 
     def one(self):
         """Show the folder information."""
-        volume = self.args[0]
-        params = (volume.name, volume.other_visible_name)
-        return self.MESSAGE_ONE % params
+        volume = self.kwargs["share"]
+        format_args = {
+            "folder_name": volume.name,
+            "other_user_name": volume.other_visible_name,
+        }
+        return self.MESSAGE_ONE % format_args
 
 
 class UDFAvailableStatus(FolderAvailableStatus):
     """An UDF is available for subscription."""
 
-    MESSAGE_ONE = "New cloud folder available: %s"""
+    MESSAGE_ONE = Q_("New cloud folder available: '%(folder_name)s'")
 
     def one(self):
         """Show the folder information."""
-        volume = self.args[0]
-        params = (volume.suggested_path,)
-        return self.MESSAGE_ONE % params
+        volume = self.kwargs["udf"]
+        format_args = {"folder_name": volume.suggested_path}
+        return self.MESSAGE_ONE % format_args
 
 
 class ConnectionStatusEvent(StatusEvent):
@@ -173,13 +185,13 @@
 class ConnectionLostStatus(ConnectionStatusEvent):
     """The connection to the server was lost."""
 
-    MESSAGE_ONE = "The connection to the server was lost."""
+    MESSAGE_ONE = Q_("The connection to the server was lost.")
 
 
 class ConnectionMadeStatus(ConnectionStatusEvent):
     """The connection to the server was made."""
 
-    MESSAGE_ONE = "The connection to the server was restored."""
+    MESSAGE_ONE = Q_("The connection to the server was restored.")
 
 
 class Timer(defer.Deferred):
@@ -548,11 +560,14 @@
         lines = []
 
         if len(self.files_uploading) > 0:
-            text = FILES_UPLOADING % len(self.files_uploading)
+            format_args = {"total_uploading_files": len(self.files_uploading)}
+            text = FILES_UPLOADING % format_args
             lines.append(text)
 
         if len(self.files_downloading) > 0:
-            text = FILES_DOWNLOADING % len(self.files_downloading)
+            num_files_downloading = len(self.files_downloading)
+            format_args = {"total_downloading_files": num_files_downloading}
+            text = FILES_DOWNLOADING % format_args
             lines.append(text)
 
         return "\n".join(lines)
@@ -562,21 +577,26 @@
         assert self.total_counter > 0
         parts = []
         if self.upload_total:
-            parts.append(FILES_UPLOADING % self.upload_total)
+            format_args = {"total_uploading_files": self.upload_total}
+            parts.append(FILES_UPLOADING % format_args)
         if self.download_total:
-            parts.append(FILES_DOWNLOADING % self.download_total)
+            format_args = {"total_downloading_files": self.download_total}
+            parts.append(FILES_DOWNLOADING % format_args)
         progress_percentage = 100.0 * self.done_counter / self.total_counter
-        parts.append(PROGRESS_COMPLETED % int(progress_percentage))
-        return " ".join(parts)
+        format_args = {"percentage_completed": int(progress_percentage)}
+        parts.append(PROGRESS_COMPLETED % format_args)
+        return "\n".join(parts)
 
     def get_final_status_message(self):
         """Get some lines describing all we did."""
         parts = []
         parts.append(FINAL_COMPLETED)
         if self.upload_done:
-            parts.append(FINAL_UPLOADED % self.upload_done)
+            format_args = {'total_uploaded_files': self.upload_done}
+            parts.append(FINAL_UPLOADED % format_args)
         if self.download_done:
-            parts.append(FINAL_DOWNLOADED % self.download_done)
+            format_args = {'total_downloaded_files': self.download_done}
+            parts.append(FINAL_DOWNLOADED % format_args)
         return "\n".join(parts)
 
     def restart_progress_bubble(self):
@@ -649,8 +669,9 @@
 
     def file_published(self, public_url):
         """A file was published."""
+        status_event = FilePublishingStatus(new_public_url=public_url)
         self.notification.send_notification(
-            UBUNTUONE_TITLE, FilePublishingStatus(public_url).one())
+            UBUNTUONE_TITLE, status_event.one())
 
     def file_unpublished(self, public_url):  # pylint: disable=W0613
         """A file was unpublished."""
@@ -689,7 +710,7 @@
         """A new share is available for subscription."""
         self.messaging.show_message(share.other_visible_name)
         self.notification.send_notification(
-            UBUNTUONE_TITLE, ShareAvailableStatus(share).one())
+            UBUNTUONE_TITLE, ShareAvailableStatus(share=share).one())
 
     def new_udf_available(self, udf):
         """A new udf is available for subscription."""
@@ -700,7 +721,7 @@
             NEW_UDFS_SENDER, callback=self._reset_udf_message_callback,
             message_count=1)
         self.notification.send_notification(
-            UBUNTUONE_TITLE, UDFAvailableStatus(udf).one())
+            UBUNTUONE_TITLE, UDFAvailableStatus(udf=udf).one())
 
     def _reset_udf_message_callback(self, indicator, message_time=None):
         """A callback wrapper that resets the udf_message to None."""