Merge lp:~mvo/software-center/lp941361 into lp:software-center

[Michael Vogt]

Small branch that adds a general make_string_from_list() helper to build (somewhat) i18n friendly human readable strings easily.

[Gary Lasker (gary-lasker)]

Thanks mvo! Nice test too! :)

review: Approve

=== modified file 'softwarecenter/ui/gtk3/review_gui_helper.py'
--- softwarecenter/ui/gtk3/review_gui_helper.py	2012-02-04 16:34:50 +0000
+++ softwarecenter/ui/gtk3/review_gui_helper.py	2012-03-05 15:34:23 +0000
@@ -62,7 +62,7 @@
 from softwarecenter.ui.gtk3.SimpleGtkbuilderApp import SimpleGtkbuilderApp
 from softwarecenter.ui.gtk3.dialogs import SimpleGtkbuilderDialog
 from softwarecenter.ui.gtk3.widgets.stars import ReactiveStar
-
+from softwarecenter.utils import make_string_from_list
 
 from softwarecenter.backend.piston.rnrclient import RatingsAndReviewsAPI
 from softwarecenter.backend.piston.rnrclient_pristine import ReviewRequest
@@ -1051,27 +1051,19 @@
         for account in failed_accounts:
             failed_services.append("%s (@%s)" % (account['service'].capitalize(), account['username']))
         
-        failed = len(failed_services)
-        
-        #sets first part of failed services string to first account in list
-        failed_services_string = failed_services[0]
-        
-        #if more than 1 failed account in list, continues to add service strings to the failed_service_string
-        if failed > 1:
-            #comma separates services for all accounts in list up to the last one, if there is 3 or more
-            if failed > 2:
-                for i in range(1,failed-1):
-                    # Translators: this is the second part of "There was a problem posting this review to %s, %s and %s"
-                    failed_services_string = failed_services_string + (_(", %s") % failed_services[i])
-            #final account in list is added to end of string with 'and'
-            # Translators: this is the last part of "There was a problem posting this review to %s, %s and %s"
-            failed_services_string = failed_services_string + (_(" and %s") % failed_services[failed-1])
-            
         glade_dialog = SimpleGtkbuilderDialog(self.datadir, domain="software-center")
         dialog = glade_dialog.dialog_gwibber_error
         dialog.set_transient_for(self.submit_window)
-        # Translators: this is the first part of "There was a problem posting this review to %s, %s and %s"
-        dialog.set_markup(_("There was a problem posting this review to %s.") % failed_services_string)
+        # build the failure string
+        # TRANSLATORS: the part in %s can either be a single entry
+        #              like "facebook" or a string like 
+        #              "factbook and twister"
+        error_str = gettext.ngettext(
+            "There was a problem posting this review to %s.",
+            "There was a problem posting this review to %s.",
+            len(failed_services))
+        error_str = make_string_from_list(error_str, failed_services)
+        dialog.set_markup(error_str)
         dialog.format_secondary_text(error)
         result = dialog.run()
         dialog.destroy()

=== modified file 'softwarecenter/utils.py'
--- softwarecenter/utils.py	2012-02-12 20:21:51 +0000
+++ softwarecenter/utils.py	2012-03-05 15:34:23 +0000
@@ -706,7 +706,26 @@
         self.emit('file-download-complete', self.dest_file_path)
 
 
-
+def make_string_from_list(base_str, item_list):
+    """ This function takes a list of items and builds a nice human readable
+        string with it of the form. Note that the base string needs a "%s".
+        Example return:
+          The base string with the list items a,b and c in it.
+        Note that base_str needs to be a ngettext string already, so the
+        example usage is:
+         l = ["foo", "bar"]
+         base_str = ngettext("This list: %s.", "This list: %s", len(l))
+         s = make_string_from_list(base_string, l)
+    """
+    list_str = item_list[0]
+    if len(item_list) > 1:
+        # TRANSLATORS: this is a generic list delimit char, e.g. "foo, bar"
+        list_str = _(", ").join(item_list[:-1])
+        # TRANSLATORS: this is the last part of a list, e.g. "foo, bar and baz"
+        list_str = _("%s and %s") % (list_str,
+                                     item_list[-1])
+    s = base_str % list_str
+    return s
 
 
 # those helpers are packaging system specific

=== modified file 'test/test_utils.py'
--- test/test_utils.py	2012-03-01 11:32:37 +0000
+++ test/test_utils.py	2012-03-05 15:34:23 +0000
@@ -124,6 +124,31 @@
         uuid = get_uuid()
         self.assertTrue(uuid and len(uuid) > 0)
 
+    def test_make_string_from_list(self):
+        from softwarecenter.utils import make_string_from_list
+        base = "There was a problem posting this review to %s (omg!)"
+        # test the various forms
+        l = ["twister"]
+        self.assertEqual(
+            make_string_from_list(base, l),
+            "There was a problem posting this review to twister (omg!)")
+        # two
+        l = ["twister", "factbook"]
+        self.assertEqual(
+            make_string_from_list(base, l),
+            "There was a problem posting this review to twister and factbook (omg!)")
+        # three
+        l = ["twister", "factbook", "identi.catz"]
+        self.assertEqual(
+            make_string_from_list(base, l),
+            "There was a problem posting this review to twister, factbook and identi.catz (omg!)")
+        # four
+        l = ["twister", "factbook", "identi.catz", "baz"]
+        self.assertEqual(
+            make_string_from_list(base, l),
+            "There was a problem posting this review to twister, factbook, identi.catz and baz (omg!)")
+        
+
 class TestExpungeCache(unittest.TestCase):
 
     def test_expunge_cache(self):
@@ -161,6 +186,7 @@
         self.assertTrue(os.path.exists(os.path.join(dirname, "foo-random")))
 
 
+
 if __name__ == "__main__":
     import logging
     logging.basicConfig(level=logging.DEBUG)