Merge lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/i18nctag into lp:ubuntu-ui-toolkit/staging

[Christian Dywan]

Implement and unit-test i18n.(c)tag

[Pete Woods (pete-woods)]

Sorry to mess you around, but I think David wanted the function called noop as opposed to tag.

I don't have strong views either way, but it's probably worth checking which one to go for..

[Christian Dywan (kalikiana)]

No sweat, nothing is carved in stone yet, I went for this as I only saw the new suggestion after I wrote the unit tests for it :-)

[Tim Peeters (tpeeters)]

I will try to figure out the use case for this. It is not immediately clear to me. Perhaps this can be fixed by adding to the documentation of the methods?

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1395
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1405/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1103
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/132
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/135
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/135/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/132/console
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/981
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1101
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1101/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17669

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1405/rebuild

review: Needs Fixing (continuous-integration)

[lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/i18nctag]

1396. By Christian Dywan on 2015-02-03

Add QML example of UserMetrics to i18n.tag documentation

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1396
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1409/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1126
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/136
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/139
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/139/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/136
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1004
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1124
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1124/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17697

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1409/rebuild

review: Needs Fixing (continuous-integration)

[Tim Peeters (tpeeters)]

please use function overloading of tag() for the context instead of tag() and ctag(), as we have in the API proposal for tr() in https://docs.google.com/a/canonical.com/document/d/1qDcfbu9aAj7uU9qzjXCOJn8zGexBnXwZCgO8pLDsO5M/edit#

We currently do have a ctr() implementation, but that should be deprecated as per https://bugs.launchpad.net/ubuntu/+source/ubuntu-ui-toolkit/+bug/1417680

[lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/i18nctag]

1397. By Christian Dywan on 2015-02-03

There's no need for a ctag, tag can be overloaded'

[Tim Peeters (tpeeters)]

Below I copy&pasted parts of the IRC discussion that cleared up some issues for me:

<timp> in https://code.launchpad.net/~unity-team/music-app/infographics-translations/+merge/248251 why not use the string i18n.tr("Songs played today: ") + "<b>%1</b>"

<ahayzen> timp, RTL and LTR languages
<kalikiana> timp: never ever do string manipulation in context of localization, this is unrelated to tag, tr or plurals
<dpm> timp, as per the question: i18n.tr("Songs played today: ") + "<b>%1</b>" would for example break for RTL languages

-- and --

 <timp> why would i18n.dtr("metric", "Songs played today: %1") instead of i18n.tag("Songs played today: %1") not work?
<kalikiana> timp: because the string is displayed in the lockscreen and the language can be changed when the app isn't running
<timp> kalikiana: ah, so the string does not even exist in the list of translateable strings for the metrics?
<kalikiana> timp: the string is in the app's .mo files, and the domain is set in the metrics API
<timp> kalikiana: so the metrics somewhere call i18n.dtr("music-app", "Songs played today: %1")?
<kalikiana> timp: yes

review: Approve

[Tim Peeters (tpeeters)]

How do we ensure the tagged strings are added to the pot files? Is this automatic on launchpad? We did not add it to po/update-pot.sh (but ctr() functions which we have now are not in there either).

review: Needs Information

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1397
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1411/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1145
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/138
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/141
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/141/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/138
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1016
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1143
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1143/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17733

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1411/rebuild

review: Approve (continuous-integration)

[lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/i18nctag]

1398. By Christian Dywan on 2015-02-04

Add tag keyword to update-pot.sh

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1398
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1413/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1160
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/140
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/143
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/143/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/140
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1023
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1158
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1158/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17749

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1413/rebuild

review: Approve (continuous-integration)

[Tim Peeters (tpeeters)]

Thanks, happroving.

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2015-01-20 11:04:34 +0000
+++ .bzrignore	2015-02-04 12:11:25 +0000
@@ -16,3 +16,4 @@
 tests/unit/tst_i18n/locale/en/LC_MESSAGES/*.mo
 tests/launcher/launcher
 build_paths.inc
+tests/unit/tst_i18n/localizedApp/share/locale/en/LC_MESSAGES/localizedApp.mo

=== modified file 'components.api'
--- components.api	2015-01-26 22:19:11 +0000
+++ components.api	2015-02-04 12:11:25 +0000
@@ -1048,6 +1048,13 @@
     Parameter { name: "domain"; type: "string" }
     Parameter { name: "context"; type: "string" }
     Parameter { name: "text"; type: "string" }
+    Method {
+    name: "tag"
+    Parameter { name: "text"; type: "string" }
+    Method {
+    name: "tag"
+    Parameter { name: "context"; type: "string" }
+    Parameter { name: "text"; type: "string" }
     name: "ULConditionalLayout"
     prototype: "QObject"
     exports: ["ConditionalLayout 0.1", "ConditionalLayout 1.0"]

=== modified file 'modules/Ubuntu/Components/plugin/i18n.cpp'
--- modules/Ubuntu/Components/plugin/i18n.cpp	2014-11-21 11:13:54 +0000
+++ modules/Ubuntu/Components/plugin/i18n.cpp	2015-02-04 12:11:25 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012 Canonical Ltd.
+ * Copyright 2012-2015 Canonical Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -213,3 +213,42 @@
         return QString::fromUtf8(C::g_dpgettext2(domain.toUtf8(), context.toUtf8(), text.toUtf8()));
     }
 }
+
+/*!
+ * \qmlmethod string i18n::tag(string text)
+ * Mark \a text for translation at a later point. Typically this allows an API
+ * to take the original string and pass it to dtr (or dgettext).
+ *
+ * \qml
+ * import QtQuick 2.0
+ * import UserMetrics 0.1
+ *
+ * Metric {
+ *     name: "distance"
+ *     format: i18n.tag("Distance covered today: %1 km")
+ *     emptyFormat: i18n.tag("No running today")
+ *     domain: "runner.forest"
+ * }
+ * \endqml
+ *
+ * The strings tagged for localzation above are passed to the implementation
+ * of UserMetrics verbatim, as well as the domain of the app. Display and
+ * translation of the strings will happen in the lockscreen, where the same
+ * strings will be passed to i18n.tr.
+ */
+QString UbuntuI18n::tag(const QString& text)
+{
+    return text;
+}
+
+/*!
+ * \qmlmethod string i18n::tag(string context, string text)
+ * Mark \a text for translation at a later point. Typically this allows an API
+ * to take the original string and pass it to dctr (or g_dpgettext2).
+ * \a context is only visible to the translator and helps disambiguating for very short texts
+ */
+QString UbuntuI18n::tag(const QString& context, const QString& text)
+{
+    Q_UNUSED(context);
+    return text;
+}

=== modified file 'modules/Ubuntu/Components/plugin/i18n.h'
--- modules/Ubuntu/Components/plugin/i18n.h	2014-11-21 10:48:24 +0000
+++ modules/Ubuntu/Components/plugin/i18n.h	2015-02-04 12:11:25 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012 Canonical Ltd.
+ * Copyright 2012-2015 Canonical Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -48,6 +48,8 @@
     Q_INVOKABLE QString dtr(const QString& domain, const QString& singular, const QString& plural, int n);
     Q_INVOKABLE QString ctr(const QString& context, const QString& text);
     Q_INVOKABLE QString dctr(const QString& domain, const QString& context, const QString& text);
+    Q_INVOKABLE QString tag(const QString& text);
+    Q_INVOKABLE QString tag(const QString& context, const QString& text);
 
     // getter
     QString domain() const;

=== modified file 'po/update-pot.sh'
--- po/update-pot.sh	2014-09-01 17:02:40 +0000
+++ po/update-pot.sh	2015-02-04 12:11:25 +0000
@@ -50,7 +50,8 @@
     --keyword=tr:1,2 \
     --keyword=dtr:2 \
     --keyword=dtr:2,3 \
-    --package-name $DOMAIN \
+    --keyword=tag \
+    --keyword=tag:1,2 \
     --package-name $DOMAIN \
     --copyright-holder "Canonical Ltd"
 

=== modified file 'tests/unit/tst_i18n/po/en_US.po'
--- tests/unit/tst_i18n/po/en_US.po	2014-11-21 10:48:24 +0000
+++ tests/unit/tst_i18n/po/en_US.po	2015-02-04 12:11:25 +0000
@@ -16,6 +16,9 @@
 msgid "Count the kilometres"
 msgstr "Count the clicks"
 
+msgid "Count the kittens"
+msgstr "Contar los gatitos"
+
 msgctxt "All Contacts"
 msgid "All"
 msgstr "Todos"
@@ -23,3 +26,7 @@
 msgctxt "All Calls"
 msgid "All"
 msgstr "Todas"
+
+msgctxt "All Cats"
+msgid "All"
+msgstr "Cada"

=== modified file 'tests/unit/tst_i18n/src/LocalizedApp.qml'
--- tests/unit/tst_i18n/src/LocalizedApp.qml	2014-11-21 10:48:24 +0000
+++ tests/unit/tst_i18n/src/LocalizedApp.qml	2015-02-04 12:11:25 +0000
@@ -32,10 +32,17 @@
             text: i18n.tr('Count the kilometres')
             width: units.gu(15)
         }
+        Button {
+            id: button2
+            objectName: 'button2'
+            anchors.top: button.bottom
+            text: i18n.tag('Count the kittens')
+            width: units.gu(15)
+        }
         Label {
             id: all1
             objectName: 'all1'
-            anchors.top: button.bottom
+            anchors.top: button2.bottom
             anchors.horizontalCenter: button.horizontalCenter
             text: i18n.ctr('All Contacts', 'All')
         }
@@ -46,5 +53,12 @@
             anchors.horizontalCenter: all1.horizontalCenter
             text: i18n.ctr('All Calls', 'All')
         }
+        Label {
+            id: all3
+            objectName: 'all3'
+            anchors.top: all2.bottom
+            anchors.horizontalCenter: all2.horizontalCenter
+            text: i18n.tag('All Cats', 'All')
+        }
     }
 }

=== modified file 'tests/unit/tst_i18n/src/tst_i18n.cpp'
--- tests/unit/tst_i18n/src/tst_i18n.cpp	2014-12-01 11:03:48 +0000
+++ tests/unit/tst_i18n/src/tst_i18n.cpp	2015-02-04 12:11:25 +0000
@@ -169,12 +169,25 @@
         QCOMPARE(button->property("text").toString(), QString("Count the clicks"));
         QCOMPARE(all1->property("text").toString(), QString("Todos"));
         QCOMPARE(all2->property("text").toString(), QString("Todas"));
+        // Only tagged, not actually translated
+        QQuickItem* button2(testItem(page, "button2"));
+        QVERIFY(button2);
+        QCOMPARE(button2->property("text").toString(), QString("Count the kittens"));
+        QQuickItem* all3(testItem(page, "all3"));
+        QVERIFY(all3);
+        QCOMPARE(all3->property("text").toString(), QString("All"));
 
         // Translate in C++
         QCOMPARE(i18n->dtr(i18n->domain(), QString("Welcome")), QString("Greets"));
         QCOMPARE(i18n->tr(QString("Count the kilometres")), QString("Count the clicks"));
         QCOMPARE(i18n->ctr(QString("All Contacts"), QString("All")), QString("Todos"));
         QCOMPARE(i18n->ctr(QString("All Calls"), QString("All")), QString("Todas"));
+        // Only tagged, not actually translated
+        QCOMPARE(i18n->tag(QString("All kittens")), QString("All kittens"));
+        QCOMPARE(i18n->tag(QString("All Cats"), QString("All")), QString("All"));
+        // Sanity-check that the test strings would otherwise work and not no-op by accident
+        QCOMPARE(i18n->tr(QString("Count the kittens")), QString("Contar los gatitos"));
+        QCOMPARE(i18n->ctr(QString("All Cats"), QString("All")), QString("Cada"));
     }
 };
 

=== modified file 'tests/unit/tst_i18n/tst_i18n.pro'
--- tests/unit/tst_i18n/tst_i18n.pro	2014-11-25 09:58:33 +0000
+++ tests/unit/tst_i18n/tst_i18n.pro	2015-02-04 12:11:25 +0000
@@ -2,7 +2,13 @@
 QT += gui
 DEFINES += SRCDIR=\\\"$$PWD/\\\"
 
-system(msgfmt po/en_US.po -o localizedApp/share/locale/en/LC_MESSAGES/localizedApp.mo)
+DOMAIN = localizedApp
+mo.target = mo
+mo.commands = set -e;
+mo.commands += echo Generating localization for $$DOMAIN;
+mo.commands += msgfmt po/en_US.po -o $${DOMAIN}/share/locale/en/LC_MESSAGES/$${DOMAIN}.mo;
+QMAKE_EXTRA_TARGETS += mo
+PRE_TARGETDEPS += mo
 
 SOURCES += \
     src/tst_i18n.cpp