Merge lp:~renatofilho/telephony-service/phonenumber-format into lp:telephony-service

[Renato Araujo Oliveira Filho]

Implemented PhoneNumber.format.

PhoneNumber.format can be used to format any string into a phone number formatted value.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:848
http://jenkins.qa.ubuntu.com/job/telephony-service-ci/253/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-amd64-ci/69/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-armhf-ci/69/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-i386-ci/70/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/telephony-service-ci/253/rebuild

review: Needs Fixing (continuous-integration)

[lp:~renatofilho/telephony-service/phonenumber-format]

849. By Renato Araujo Oliveira Filho on 2014-07-12

Added missing license header.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:849
http://jenkins.qa.ubuntu.com/job/telephony-service-ci/254/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-amd64-ci/70
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-armhf-ci/70
        deb: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-armhf-ci/70/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-i386-ci/71

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/telephony-service-ci/254/rebuild

review: Approve (continuous-integration)

[lp:~renatofilho/telephony-service/phonenumber-format]

850. By Renato Araujo Oliveira Filho on 2014-07-12

[PhoneNumber] Does not try format phone numbers starting with "*" or "#"

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:850
http://jenkins.qa.ubuntu.com/job/telephony-service-ci/255/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-amd64-ci/71
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-armhf-ci/71
        deb: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-armhf-ci/71/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-utopic-i386-ci/72

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/telephony-service-ci/255/rebuild

review: Approve (continuous-integration)

[Renato Araujo Oliveira Filho (renatofilho)]

Are there any related MPs required for this MP to build/function as expected? NO

Is your branch in sync with latest trunk? YES

Did you perform an exploratory manual test run of your code change and any related functionality on device or emulator? YES

Did you successfully run all tests found in your component's Test Plan on device or emulator? YES

If you changed the UI, was the change specified/approved by design? NO UI CHANGE

If you changed the packaging (debian), did you add a core-dev as a reviewer to this MP? NO PACKAGE CHANGE

[Gustavo Pichorim Boiko (boiko)]

Did you perform an exploratory manual test run of the code change and any related functionality on device or emulator?
Yes

Did CI run pass? If not, please explain why.
Yes

Have you checked that submitter has accurately filled out the submitter checklist and has taken no shortcut?
Yes

Code looks good and works as expected!

review: Approve

=== modified file 'Ubuntu/Telephony/PhoneNumber/CMakeLists.txt'
--- Ubuntu/Telephony/PhoneNumber/CMakeLists.txt	2014-07-04 17:16:59 +0000
+++ Ubuntu/Telephony/PhoneNumber/CMakeLists.txt	2014-07-12 13:26:42 +0000
@@ -1,6 +1,8 @@
 set(PHONENUMBER_SRCS
     phonenumber.h
     phonenumber.cpp
+    phoneutils.h
+    phoneutils.cpp
     asyoutypeformatter.h
     asyoutypeformatter.cpp
     )

=== modified file 'Ubuntu/Telephony/PhoneNumber/phonenumber.cpp'
--- Ubuntu/Telephony/PhoneNumber/phonenumber.cpp	2014-04-23 20:55:13 +0000
+++ Ubuntu/Telephony/PhoneNumber/phonenumber.cpp	2014-07-12 13:26:42 +0000
@@ -22,10 +22,19 @@
 
 #include "phonenumber.h"
 #include "asyoutypeformatter.h"
+#include "phoneutils.h"
 
 #include <QQmlEngine>
 #include <qqml.h>
 
+
+static QObject *phoneUtilsProvider(QQmlEngine *engine, QJSEngine *scriptEngine)
+{
+    Q_UNUSED(engine)
+    Q_UNUSED(scriptEngine)
+    return new PhoneUtils;
+}
+
 void PhoneNumber::initializeEngine(QQmlEngine *engine, const char *uri)
 {
     Q_UNUSED(engine);
@@ -36,4 +45,5 @@
 {
     // @uri Telephony.PhoneNumber
     qmlRegisterType<AsYouTypeFormatter>(uri, 0, 1, "AsYouTypeFormatter");
+    qmlRegisterSingletonType<PhoneUtils>(uri, 0, 1, "PhoneUtils", phoneUtilsProvider);
 }

=== added file 'Ubuntu/Telephony/PhoneNumber/phoneutils.cpp'
--- Ubuntu/Telephony/PhoneNumber/phoneutils.cpp	1970-01-01 00:00:00 +0000
+++ Ubuntu/Telephony/PhoneNumber/phoneutils.cpp	2014-07-12 13:26:42 +0000
@@ -0,0 +1,84 @@
+/*
+ * Copyright (C) 2014 Canonical, Ltd.
+ *
+ * Authors:
+ *  Renato Araujo Oliveira Filho <[e-mail]>
+ *
+ * This file is part of telephony-service.
+ *
+ * telephony-service is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * telephony-service is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "phoneutils.h"
+
+#include <QtCore/QDebug>
+#include <phonenumbers/phonenumberutil.h>
+
+
+PhoneUtils::PhoneUtils(QObject *parent)
+    : QObject(parent)
+{
+}
+
+PhoneUtils::~PhoneUtils()
+{
+}
+
+QString PhoneUtils::format(const QString &phoneNumber, const QString &defaultRegion,  PhoneUtils::PhoneNumberFormat format)
+{
+    std::string formattedNumber;
+    i18n::phonenumbers::PhoneNumberUtil::PhoneNumberFormat pNFormat;
+    if (format == PhoneUtils::Auto) {
+        // skip if it is a special number or a command
+        if (phoneNumber.startsWith("#") || phoneNumber.startsWith("*")) {
+            return phoneNumber;
+        } else if (phoneNumber.startsWith("+")) {
+            pNFormat = i18n::phonenumbers::PhoneNumberUtil::INTERNATIONAL;
+        } else {
+            pNFormat = i18n::phonenumbers::PhoneNumberUtil::NATIONAL;
+        }
+    } else {
+        pNFormat = static_cast<i18n::phonenumbers::PhoneNumberUtil::PhoneNumberFormat>(format);
+    }
+
+
+    i18n::phonenumbers::PhoneNumberUtil *phonenumberUtil = i18n::phonenumbers::PhoneNumberUtil::GetInstance();
+
+    i18n::phonenumbers::PhoneNumber number;
+    i18n::phonenumbers::PhoneNumberUtil::ErrorType error;
+    error = phonenumberUtil->Parse(phoneNumber.toStdString(), defaultRegion.toStdString(), &number);
+
+    switch(error) {
+    case i18n::phonenumbers::PhoneNumberUtil::INVALID_COUNTRY_CODE_ERROR:
+        qWarning() << "Invalid coutry code for:" << phoneNumber;
+        return "";
+    case i18n::phonenumbers::PhoneNumberUtil::NOT_A_NUMBER:
+        qWarning() << "The phone number is not a valid number:" << phoneNumber;
+        return "";
+    case i18n::phonenumbers::PhoneNumberUtil::TOO_SHORT_AFTER_IDD:
+    case i18n::phonenumbers::PhoneNumberUtil::TOO_SHORT_NSN:
+    case i18n::phonenumbers::PhoneNumberUtil::TOO_LONG_NSN:
+        qWarning() << "Invalid phone number" << phoneNumber;
+        return "";
+    default:
+        break;
+    }
+
+
+    phonenumberUtil->Format(number,
+                            pNFormat,
+                            &formattedNumber);
+    return QString::fromStdString(formattedNumber);
+}
+
+

=== added file 'Ubuntu/Telephony/PhoneNumber/phoneutils.h'
--- Ubuntu/Telephony/PhoneNumber/phoneutils.h	1970-01-01 00:00:00 +0000
+++ Ubuntu/Telephony/PhoneNumber/phoneutils.h	2014-07-12 13:26:42 +0000
@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2014 Canonical, Ltd.
+ *
+ * Authors:
+ *  Renato Araujo Oliveira Filho <[e-mail]>
+ *
+ * This file is part of telephony-service.
+ *
+ * telephony-service is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * telephony-service is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef TELEPHONY_PHONEUTILS_H
+#define TELEPHONY_PHONEUTILS_H
+
+#include <QtCore/QObject>
+
+class PhoneUtils : public QObject
+{
+    Q_OBJECT
+public:
+    enum PhoneNumberFormat {
+        E164 = 0,
+        International,
+        National,
+        RFC3966,
+        Auto
+    };
+
+    PhoneUtils(QObject *parent = 0);
+    ~PhoneUtils();
+
+    Q_INVOKABLE QString format(const QString &phoneNumber, const QString &defaultRegion, PhoneNumberFormat format = Auto);
+};
+
+#endif

=== modified file 'Ubuntu/Telephony/tests/CMakeLists.txt'
--- Ubuntu/Telephony/tests/CMakeLists.txt	2014-07-04 17:16:59 +0000
+++ Ubuntu/Telephony/tests/CMakeLists.txt	2014-07-12 13:26:42 +0000
@@ -14,19 +14,23 @@
     endforeach(test)
 endmacro(generate_tests)
 
+macro(DECLARE_QML_TEST TST_NAME TST_QML_FILE)
+    add_test(NAME ${TST_NAME}
+        WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+        COMMAND xvfb-run -a -s "-screen 0 1024x768x24" qmltestrunner -import ${CMAKE_BINARY_DIR} -input ${CMAKE_CURRENT_SOURCE_DIR}/${TST_QML_FILE}
+    )
+endmacro()
+
 
 generate_tests(
     ContactWatcherTest
     )
 
+declare_qml_test("context_properties" tst_contextProperties.qml)
+declare_qml_test("phonenumber_field" tst_PhoneNumberField.qml)
+declare_qml_test("phonenumber_input" tst_PhoneNumberInput.qml)
+declare_qml_test("phonenumber_utils" tst_PhoneNumberPhoneUtils.qml)
+
+# make the files visible on qtcreator
 file(GLOB QML_TESTS *.qml *.js)
-
-# make the files visible on qtcreator
 add_custom_target(telephonyservice_QMLTESTS ALL SOURCES ${QML_TESTS})
-
-# FIXME: those tests are disabled because qmltestrunner is crashing on armhf.
-# They should be re-enabled once the problem is found and fixed.
-add_test(NAME qmltestrunner
-         WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
-         COMMAND xvfb-run -a -s "-screen 0 1024x768x24" qmltestrunner -import ${CMAKE_BINARY_DIR} -input ${CMAKE_CURRENT_SOURCE_DIR}
-)

=== added file 'Ubuntu/Telephony/tests/tst_PhoneNumberPhoneUtils.qml'
--- Ubuntu/Telephony/tests/tst_PhoneNumberPhoneUtils.qml	1970-01-01 00:00:00 +0000
+++ Ubuntu/Telephony/tests/tst_PhoneNumberPhoneUtils.qml	2014-07-12 13:26:42 +0000
@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2014 Canonical, Ltd.
+ *
+ * This file is part of telephony-service.
+ *
+ * telephony-service is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * telephony-service is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import QtTest 1.0
+import Ubuntu.Telephony.PhoneNumber 0.1 as PhoneNumber
+
+TestCase {
+    id: phoneNumberPhoneUtils
+    name: "phoneNumberPhoneUtils"
+
+    function test_formatPhone_data()
+    {
+        var data = [];
+        data.push({input: "6681800", expectedOutput: "668-1800"})                    // Local number
+        data.push({input: "7327572923", expectedOutput: "[phone]"})           // Coutry number
+        data.push({input: "[phone]", expectedOutput: "[phone]"})      // International number
+        data.push({input: "55555555555", expectedOutput: "55555555555"})             // Ivalid number
+        data.push({input: "*144", expectedOutput: "*144"})                           // Special number
+        data.push({input: "#123#", expectedOutput: "#123#"})                         // Operators command
+        return data
+    }
+
+    function test_formatPhone(data)
+    {
+        var formatted = PhoneNumber.PhoneUtils.format(data.input, "US")
+        compare(formatted, data.expectedOutput)
+    }
+}