Merge lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/i18ntagRTM into lp:ubuntu-ui-toolkit/rtm

[Christian Dywan]

Implement i18n.tag function and unit tests

[Tim Peeters (tpeeters)]

Same change as for changing, but without the context parameter.

review: Approve

[Tim Peeters (tpeeters)]

*Same change as for _staging_, but without the context parameter.

review: Approve

=== modified file 'components.api'
--- components.api	2014-11-27 13:40:49 +0000
+++ components.api	2015-02-11 16:53:22 +0000
@@ -1058,6 +1058,9 @@
     Parameter { name: "singular"; type: "string" }
     Parameter { name: "plural"; type: "string" }
     Parameter { name: "n"; type: "int" }
+    Method {
+    name: "tag"
+    Parameter { name: "text"; type: "string" }
     prototype: "QObject"
     name: "Haptics"
     exports: ["Haptics -1.-1"]

=== modified file 'modules/Ubuntu/Components/plugin/i18n.cpp'
--- modules/Ubuntu/Components/plugin/i18n.cpp	2014-05-27 11:44:09 +0000
+++ modules/Ubuntu/Components/plugin/i18n.cpp	2015-02-11 16:53:22 +0000
@@ -187,3 +187,30 @@
         return QString::fromUtf8(C::dngettext(domain.toUtf8(), singular.toUtf8(), plural.toUtf8(), n));
     }
 }
+
+/*!
+ * \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;
+}

=== modified file 'modules/Ubuntu/Components/plugin/i18n.h'
--- modules/Ubuntu/Components/plugin/i18n.h	2013-10-29 10:57:08 +0000
+++ modules/Ubuntu/Components/plugin/i18n.h	2015-02-11 16:53:22 +0000
@@ -46,6 +46,7 @@
     Q_INVOKABLE QString tr(const QString& singular, const QString& plural, int n);
     Q_INVOKABLE QString dtr(const QString& domain, const QString& text);
     Q_INVOKABLE QString dtr(const QString& domain, const QString& singular, const QString& plural, int n);
+    Q_INVOKABLE QString tag(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-11 16:53:22 +0000
@@ -50,7 +50,7 @@
     --keyword=tr:1,2 \
     --keyword=dtr:2 \
     --keyword=dtr:2,3 \
-    --package-name $DOMAIN \
+    --keyword=tag \
     --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	2013-10-04 18:41:28 +0000
+++ tests/unit/tst_i18n/po/en_US.po	2015-02-11 16:53:22 +0000
@@ -15,3 +15,6 @@
 
 msgid "Count the kilometres"
 msgstr "Count the clicks"
+
+msgid "Count the kittens"
+msgstr "Contar los gatitos"

=== modified file 'tests/unit/tst_i18n/src/LocalizedApp.qml'
--- tests/unit/tst_i18n/src/LocalizedApp.qml	2014-10-02 13:03:22 +0000
+++ tests/unit/tst_i18n/src/LocalizedApp.qml	2015-02-11 16:53:22 +0000
@@ -31,5 +31,12 @@
             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)
+        }
     }
 }

=== modified file 'tests/unit/tst_i18n/src/tst_i18n.cpp'
--- tests/unit/tst_i18n/src/tst_i18n.cpp	2014-05-14 10:19:17 +0000
+++ tests/unit/tst_i18n/src/tst_i18n.cpp	2015-02-11 16:53:22 +0000
@@ -151,10 +151,18 @@
         QQuickItem* button(testItem(page, "button"));
         QVERIFY(button);
         QCOMPARE(button->property("text").toString(), QString("Count the clicks"));
-
+        // Only tagged, not actually translated
+        QQuickItem* button2(testItem(page, "button2"));
+        QVERIFY(button2);
+        QCOMPARE(button2->property("text").toString(), QString("Count the kittens"));
+ 
         // Translate in C++
         QCOMPARE(i18n->dtr(i18n->domain(), QString("Welcome")), QString("Greets"));
         QCOMPARE(i18n->tr(QString("Count the kilometres")), QString("Count the clicks"));
+        // Only tagged, not actually translated
+        QCOMPARE(i18n->tag(QString("Count the kittens")), QString("Count the kittens"));
+        // 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"));
     }
 };
 

=== modified file 'tests/unit/tst_i18n/tst_i18n.pro'
--- tests/unit/tst_i18n/tst_i18n.pro	2014-05-14 10:19:17 +0000
+++ tests/unit/tst_i18n/tst_i18n.pro	2015-02-11 16:53:22 +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