Merge lp:~henninge/launchpad/recife-gettext-check-messages into lp:~launchpad/launchpad/recife

[Henning Eggers]

== Details ==

Updates the gettext-check-messages script to use "upstream" and "ubuntu" instead of "imported" and "current" and also make the treatment of both symmetric. The essence of the latter is that both the is_current_upstream flag and the is_current_ubuntu flag are unset if the message has an error whereas before "imported" messages where left unchanged.

== Test ==

bin/test -vvm lp.translations -t gettext-check-messages

== Lint ==

Lint complains about Moin headers in the test but that should be fixed in devel or even the test converted to a uinttest.

[Henning Eggers (henninge)]

Some background for the non-translations reviewer:
One of the main changes in the recife feature branch is that the concept of "imported" and "current" translations was replaced by "upstream" and "ubuntu" translations. Thus the "is_imported" flag on a TranslationMessage was renamed to "is_current_upstream" and the "is_current" flag to "is_current_ubuntu". The semantics around these flags were also changed as the one refers to a project while the other to the ubuntu package that this project is linked to.

[Gavin Panella (allenap)]

review: Approve

=== modified file 'lib/lp/translations/doc/gettext-check-messages.txt'
--- lib/lp/translations/doc/gettext-check-messages.txt	2010-09-06 10:40:54 +0000
+++ lib/lp/translations/doc/gettext-check-messages.txt	2010-11-18 15:04:11 +0000
@@ -51,8 +51,8 @@
 
     >>> UTC = timezone('UTC')
 
-    >>> nl_file = factory.makePOFile('nl')
-    >>> template = nl_file.potemplate
+    >>> pofile = factory.makePOFile()
+    >>> template = pofile.potemplate
 
 A sample translatable message is flagged as containing a C-style format
 string.  This means that any "%d" sequences and such are significant.
@@ -65,24 +65,24 @@
     >>> potmsgset.flags
     [u'c-format']
 
-The sample message has an imported translation, and a current
-translation in Launchpad that differs from the imported one.
+The sample message has an upstream translation, and an Ubuntu
+in Launchpad that differs from the upstream one.
 
-    >>> current_message = factory.makeTranslationMessage(
-    ...     pofile=nl_file, potmsgset=potmsgset, translator=template.owner,
+    >>> ubuntu_message = factory.makeTranslationMessage(
+    ...     pofile=pofile, potmsgset=potmsgset, translator=template.owner,
     ...     reviewer=template.owner, translations=[u'%d c'])
-    >>> current_message = removeSecurityProxy(current_message)
+    >>> ubuntu_message = removeSecurityProxy(ubuntu_message)
 
-    >>> imported_message = factory.makeTranslationMessage(
-    ...     pofile=nl_file, potmsgset=potmsgset, translator=template.owner,
+    >>> upstream_message = factory.makeTranslationMessage(
+    ...     pofile=pofile, potmsgset=potmsgset, translator=template.owner,
     ...     reviewer=template.owner, translations=[u'%d i'],
     ...     lock_timestamp=datetime.now(UTC))
-    >>> imported_message = removeSecurityProxy(imported_message)
+    >>> upstream_message = removeSecurityProxy(upstream_message)
 
-    >>> imported_message.is_current_ubuntu = False
-    >>> current_message.is_current_upstream = False
-    >>> imported_message.is_current_upstream = True
-    >>> current_message.is_current_ubuntu = True
+    >>> upstream_message.is_current_ubuntu = False
+    >>> ubuntu_message.is_current_upstream = False
+    >>> upstream_message.is_current_upstream = True
+    >>> ubuntu_message.is_current_ubuntu = True
 
 
 == Basic operation ==
@@ -91,7 +91,7 @@
 and re-does the gettext check.  Which messages it checks is specified as
 a plain SQL WHERE clause.
 
-    >>> run_checker(['-vv', "-w id=%s" % quote(current_message.id)])
+    >>> run_checker(['-vv', "-w id=%s" % quote(ubuntu_message.id)])
     DEBUG Checking messages matching:  id=...
     DEBUG Checking message ...
     DEBUG Commit point.
@@ -108,15 +108,15 @@
 If a translation fails to validate against its potmsgset, the script
 detects the problem when it checks that message.
 
-    >>> current_message.is_current_ubuntu
+    >>> ubuntu_message.is_current_ubuntu
     True
 
-    >>> current_message.translations = [u'%s c']
+    >>> ubuntu_message.translations = [u'%s c']
 
-    >>> run_checker(["-w id=%s" % quote(current_message.id)])
+    >>> run_checker(["-w id=%s" % quote(ubuntu_message.id)])
     DEBUG Checking messages matching:  id=...
     DEBUG Checking message ...
-    INFO ... (current): format specifications ... are not the same
+    INFO ... (ubuntu): format specifications ... are not the same
     DEBUG Commit point.
     COMMIT
     DEBUG Commit point.
@@ -129,17 +129,17 @@
 
 The failed message is demoted to a mere suggestion.
 
-    >>> current_message.is_current_ubuntu
+    >>> ubuntu_message.is_current_ubuntu
     False
 
 
 == Output ==
 
-Besides current messages, the script's output also distinguishes
-imported ones, and ones that are completely unused. The imported message
+Besides Ubuntu messages, the script's output also distinguishes
+upstream ones, and ones that are completely unused. The upstream message
 happens to produce validation errors.
 
-    >>> imported_message.translations = [u'%s %s i']
+    >>> upstream_message.translations = [u'%s %s i']
 
 In this example we'd like to see a nicely predictable ordering, so we
 add a sort order using the -o option.
@@ -151,39 +151,35 @@
     DEBUG Commit point.
     COMMIT
     DEBUG Checking message ...
-    INFO ... (imported): number of format specifications ... does not match...
+    INFO ... (upstream): number of format specifications ... does not match...
     DEBUG Commit point.
     COMMIT
     INFO Done.
     INFO Messages checked: 2
     INFO Validation errors: 2
-    INFO Messages disabled: 0
+    INFO Messages disabled: 1
     INFO Commit points: 2
 
-In this case the imported message is checked twice: once all by itself
-and once as a potential alternative to the current message.  That's why
-the number of validation errors is greater than the number of messages
-checked.
-
-The script also notes when a message is both current and imported.
-
-    >>> imported_message.is_current_ubuntu = True
-    >>> run_checker(["-w id=%s" % quote(imported_message.id)])
+The script also notes when a message is shared between upstream and Ubuntu.
+
+    >>> upstream_message.is_current_ubuntu = True
+    >>> upstream_message.is_current_upstream = True
+    >>> run_checker(["-w id=%s" % quote(upstream_message.id)])
     DEBUG ...
-    INFO ... (current, imported): number of format specifications ...
+    INFO ... (ubuntu, upstream): number of format specifications ...
 
 
 == Dry runs ==
 
 The --dry-run option makes the script abort all its database changes.
 
-    >>> current_message.is_current_ubuntu = True
+    >>> ubuntu_message.is_current_ubuntu = True
 
-    >>> run_checker(["-w id=%s" % quote(current_message.id), '--dry-run'])
+    >>> run_checker(["-w id=%s" % quote(ubuntu_message.id), '--dry-run'])
     INFO Dry run.  Not making any changes.
     DEBUG Checking messages matching:  id=...
     DEBUG Checking message ...
-    INFO ... (current): format specifications ... are not the same
+    INFO ... (ubuntu): format specifications ... are not the same
     DEBUG Commit point.
     ABORT
     DEBUG Commit point.

=== modified file 'lib/lp/translations/scripts/gettext_check_messages.py'
--- lib/lp/translations/scripts/gettext_check_messages.py	2010-09-28 14:06:50 +0000
+++ lib/lp/translations/scripts/gettext_check_messages.py	2010-11-18 15:04:11 +0000
@@ -37,8 +37,7 @@
 
     This script takes a given set of messages (specified as an SQL
     "WHERE" clause) and checks each of them.  Messages that are found
-    faulty are deactivated, and where appropriate, imported messages
-    they were overriding are activated instead.
+    faulty are deactivated.
     """
 
     _check_count = 0
@@ -80,9 +79,9 @@
         """Report gettext validation error for active message."""
         currency_markers = []
         if bad_message.is_current_ubuntu:
-            currency_markers.append('current')
+            currency_markers.append('ubuntu')
         if bad_message.is_current_upstream:
-            currency_markers.append('imported')
+            currency_markers.append('upstream')
         if currency_markers == []:
             currency_markers.append('unused')
         currency = ', '.join(currency_markers)
@@ -117,8 +116,12 @@
         # instead of the bad one.
 
         self._log_bad_message(translationmessage, error)
-        if translationmessage.is_current_ubuntu:
+        is_current_anywhere = (
+            translationmessage.is_current_ubuntu or
+            translationmessage.is_current_upstream)
+        if is_current_anywhere:
             translationmessage.is_current_ubuntu = False
+            translationmessage.is_current_upstream = False
             self._disable_count += 1
 
     def _do_commit(self):