Merge lp:~mardy/accounts-qml-module/applications into lp:accounts-qml-module

[Alberto Mardegan]

Add ApplicationModel

Add ApplicationModel

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:29
http://jenkins.qa.ubuntu.com/job/accounts-qml-module-ci/14/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/accounts-qml-module-saucy-amd64-ci/4

Click here to trigger a rebuild:
http://s-jenkins:8080/job/accounts-qml-module-ci/14/rebuild

review: Approve (continuous-integration)

[Ken VanDine (ken-vandine)]

review: Approve

=== added file 'src/application-model.cpp'
--- src/application-model.cpp	1970-01-01 00:00:00 +0000
+++ src/application-model.cpp	2013-06-13 08:40:35 +0000
@@ -0,0 +1,156 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd.
+ *
+ * Contact: Alberto Mardegan <[e-mail]>
+ *
+ * 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
+ * the Free Software Foundation; version 2.1.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "debug.h"
+#include "application-model.h"
+#include "application.h"
+
+#include <Accounts/Manager>
+
+using namespace OnlineAccounts;
+
+/*!
+ * \qmltype ApplicationModel
+ * \inqmlmodule Ubuntu.OnlineAccounts 0.1
+ * \ingroup Ubuntu
+ *
+ * \brief A model of the applications using online accounts.
+ *
+ * The ApplicationModel is a model representing the applications using online
+ * accounts installed on the system.
+ *
+ * In the current implementation, the model is valid only if its \l
+ * ApplicationModel::service property is set to a valid service ID.
+ *
+ * The model defines the following roles:
+ * \list
+ * \li \c applicationId is the unique identifier of the application
+ * \li \c displayName is the application display name
+ * \li \c iconName is the name of the application icon
+ * \li \c serviceUsage is a description of how the application uses the
+ *     service; this is set to a valid value only if the \l
+ *     ApplicationModel::service property is set to a valid service ID.
+ * \li \c application is the Application object
+ * \endlist
+ */
+
+ApplicationModel::ApplicationModel(QObject *parent):
+    QAbstractListModel(parent),
+    manager(SharedManager::instance())
+{
+}
+
+ApplicationModel::~ApplicationModel()
+{
+}
+
+/*
+ * \qmlproperty int ApplicationModel::count
+ * The number of items in the model.
+ */
+int ApplicationModel::rowCount(const QModelIndex &parent) const
+{
+    Q_UNUSED(parent);
+    return applications.count();
+}
+
+/*!
+ * \qmlproperty string ApplicationModel::service
+ * If set, the model will list only those accounts services for this
+ * specific service.
+ */
+void ApplicationModel::setService(const QString &serviceId)
+{
+    if (serviceId == m_service.name()) return;
+    m_service = manager->service(serviceId);
+
+    beginResetModel();
+    qDeleteAll(applications);
+    applications.clear();
+
+    computeApplicationList();
+    endResetModel();
+    Q_EMIT serviceChanged();
+}
+
+QString ApplicationModel::service() const
+{
+    return m_service.name();
+}
+
+/*
+ * \qmlmethod variant ApplicationModel::get(int row, string roleName)
+ *
+ * Returns the data at \a row for the role \a roleName.
+ */
+QVariant ApplicationModel::get(int row, const QString &roleName) const
+{
+    int role = roleNames().key(roleName.toLatin1(), -1);
+    return data(index(row), role);
+}
+
+QVariant ApplicationModel::data(const QModelIndex &index, int role) const
+{
+    if (index.row() < 0 || index.row() >= applications.count())
+        return QVariant();
+
+    Application *application = applications.at(index.row());
+    QVariant ret;
+
+    switch (role) {
+    case Qt::DisplayRole:
+    case ApplicationIdRole:
+        ret = application->name();
+        break;
+    case DisplayNameRole:
+    case IconNameRole:
+        // FIXME: implement when libaccounts-qt 1.8 is released
+        break;
+    case ServiceUsageRole:
+        ret = application->serviceUsage(m_service);
+        break;
+    case ApplicationRole:
+        ret = QVariant::fromValue<QObject*>(application);
+        break;
+    }
+
+    return ret;
+}
+
+QHash<int, QByteArray> ApplicationModel::roleNames() const
+{
+    static QHash<int, QByteArray> roles;
+    if (roles.isEmpty()) {
+        roles[ApplicationIdRole] = "applicationId";
+        roles[DisplayNameRole] = "displayName";
+        roles[IconNameRole] = "iconName";
+        roles[ServiceUsageRole] = "serviceUsage";
+        roles[ApplicationRole] = "application";
+    }
+    return roles;
+}
+
+void ApplicationModel::computeApplicationList()
+{
+    if (!m_service.isValid()) return;
+
+    Q_FOREACH(const Accounts::Application &app,
+              manager->applicationList(m_service)) {
+        applications.append(new Application(app, this));
+    }
+}
 
=== added file 'src/application-model.h'
--- src/application-model.h	1970-01-01 00:00:00 +0000
+++ src/application-model.h	2013-06-13 08:40:35 +0000
@@ -0,0 +1,76 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd.
+ *
+ * Contact: Alberto Mardegan <[e-mail]>
+ *
+ * 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
+ * the Free Software Foundation; version 2.1.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef ONLINE_ACCOUNTS_APPLICATION_MODEL_H
+#define ONLINE_ACCOUNTS_APPLICATION_MODEL_H
+
+#include "manager.h"
+#include <Accounts/Service>
+#include <QAbstractListModel>
+#include <QList>
+#include <QSharedPointer>
+
+namespace OnlineAccounts {
+
+class Application;
+
+class ApplicationModel: public QAbstractListModel
+{
+    Q_OBJECT
+    Q_PROPERTY(int count READ rowCount NOTIFY countChanged)
+    Q_PROPERTY(QString service READ service WRITE setService \
+               NOTIFY serviceChanged)
+
+public:
+    ApplicationModel(QObject *parent = 0);
+    ~ApplicationModel();
+
+    enum Roles {
+        ApplicationIdRole = Qt::UserRole + 1,
+        DisplayNameRole,
+        IconNameRole,
+        ServiceUsageRole,
+        ApplicationRole,
+    };
+
+    void setService(const QString &serviceId);
+    QString service() const;
+
+    Q_INVOKABLE QVariant get(int row, const QString &roleName) const;
+
+    // reimplemented virtual methods
+    int rowCount(const QModelIndex &parent = QModelIndex()) const;
+    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
+    QHash<int, QByteArray> roleNames() const;
+
+Q_SIGNALS:
+    void countChanged();
+    void serviceChanged();
+
+private:
+    void computeApplicationList();
+
+private:
+    QSharedPointer<Accounts::Manager> manager;
+    QList<Application*> applications;
+    Accounts::Service m_service;
+};
+
+}; // namespace
+
+#endif // ONLINE_ACCOUNTS_APPLICATION_MODEL_H
 
=== added file 'src/application.cpp'
--- src/application.cpp	1970-01-01 00:00:00 +0000
+++ src/application.cpp	2013-06-13 08:40:35 +0000
@@ -0,0 +1,66 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd.
+ *
+ * Contact: Alberto Mardegan <[e-mail]>
+ *
+ * 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
+ * the Free Software Foundation; version 2.1.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#include "application.h"
+#include "debug.h"
+
+using namespace OnlineAccounts;
+
+/*!
+ * \qmltype Account
+ * \inqmlmodule Ubuntu.OnlineAccounts 0.1
+ * \ingroup Ubuntu
+ *
+ * \brief Represents an instance of an online account.
+ *
+ * The Account element represents an online account. Currently, instances of
+ * this object cannot be created directly, but are instantiated by the \l
+ * ApplicationModel element.
+ */
+Application::Application(const Accounts::Application &application,
+                         QObject *parent):
+    QObject(parent),
+    Accounts::Application(application)
+{
+}
+
+Application::~Application()
+{
+}
+
+/*!
+ * \qmlproperty string Application::applicationId
+ * Unique identifier for this application.
+ */
+
+/*!
+ * \qmlproperty string Application::description
+ * Description of the application.
+ */
+
+/*!
+ * \qmlmethod string Application::serviceUsage(Service service)
+ *
+ * Returns a textual description of how the application can make use of \a
+ * service.
+ */
+QString Application::serviceUsage(const Accounts::Service &service)
+{
+    return Accounts::Application::serviceUsage(service);
+}
 
=== added file 'src/application.h'
--- src/application.h	1970-01-01 00:00:00 +0000
+++ src/application.h	2013-06-13 08:40:35 +0000
@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd.
+ *
+ * Contact: Alberto Mardegan <[e-mail]>
+ *
+ * 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
+ * the Free Software Foundation; version 2.1.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef ONLINE_ACCOUNTS_APPLICATION_H
+#define ONLINE_ACCOUNTS_APPLICATION_H
+
+#include <QObject>
+
+#include <Accounts/Application>
+
+namespace OnlineAccounts {
+
+class Application: public QObject, public Accounts::Application
+{
+    Q_OBJECT
+    Q_PROPERTY(QString applicationId READ name CONSTANT)
+    Q_PROPERTY(QString description READ description CONSTANT)
+
+public:
+    Application(const Accounts::Application &application, QObject *parent = 0);
+    ~Application();
+
+    Q_INVOKABLE QString serviceUsage(const Accounts::Service &service);
+};
+
+}; // namespace
+
+#endif // ONLINE_ACCOUNTS_APPLICATION_H
 
=== modified file 'src/plugin.cpp'
--- src/plugin.cpp	2013-05-31 06:46:13 +0000
+++ src/plugin.cpp	2013-06-13 08:40:35 +0000
@@ -19,6 +19,7 @@
 #include "account-service-model.h"
 #include "account-service.h"
 #include "account.h"
+#include "application-model.h"
 #include "credentials.h"
 #include "manager.h"
 #include "plugin.h"
@@ -43,6 +44,7 @@
     qmlRegisterType<AccountServiceModel>(uri, 0, 1, "AccountServiceModel");
     qmlRegisterType<AccountService>(uri, 0, 1, "AccountService");
     qmlRegisterType<Account>(uri, 0, 1, "Account");
+    qmlRegisterType<ApplicationModel>(uri, 0, 1, "ApplicationModel");
     qmlRegisterType<Credentials>(uri, 0, 1, "Credentials");
     qmlRegisterType<ProviderModel>(uri, 0, 1, "ProviderModel");
     qmlRegisterSingletonType<Manager>(uri, 0, 1, "Manager", createManager);
 
=== modified file 'src/src.pro'
--- src/src.pro	2013-06-03 10:30:40 +0000
+++ src/src.pro	2013-06-13 08:40:35 +0000
@@ -30,6 +30,8 @@
     account-service-model.cpp \
     account-service.cpp \
     account.cpp \
+    application-model.cpp \
+    application.cpp \
     credentials.cpp \
     manager.cpp \
     plugin.cpp \
@@ -39,6 +41,8 @@
     account-service-model.h \
     account-service.h \
     account.h \
+    application-model.h \
+    application.h \
     credentials.h \
     debug.h \
     manager.h \
 
=== added file 'tests/data/mailer.application'
--- tests/data/mailer.application	1970-01-01 00:00:00 +0000
+++ tests/data/mailer.application	2013-06-13 08:40:35 +0000
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<application id="mailer">
+  <description>Mailer application</description>
+  <translations>mailer-catalog</translations>
+
+  <service-types>
+		<service-type id="e-mail">
+			<description>Mailer can retrieve your e-mails</description>
+		</service-type>
+  </service-types>
+
+</application>
 
=== modified file 'tests/tst_plugin.cpp'
--- tests/tst_plugin.cpp	2013-06-03 10:30:40 +0000
+++ tests/tst_plugin.cpp	2013-06-13 08:40:35 +0000
@@ -54,6 +54,7 @@
     void testAccountCredentialsRemoval_data();
     void testAccountCredentialsRemoval();
     void testAccountServiceCredentials();
+    void testApplicationModel();
 
 private:
     void clearDb();
@@ -84,6 +85,7 @@
 {
     qputenv("QML2_IMPORT_PATH", "../src");
     qputenv("ACCOUNTS", "/tmp/");
+    qputenv("AG_APPLICATIONS", APPLICATIONS_DIR);
     qputenv("AG_SERVICES", SERVICES_DIR);
     qputenv("AG_SERVICE_TYPES", SERVICE_TYPES_DIR);
     qputenv("AG_PROVIDERS", PROVIDERS_DIR);
@@ -1278,5 +1280,53 @@
     delete accountService;
 }
 
+void PluginTest::testApplicationModel()
+{
+    QQmlEngine engine;
+    QQmlComponent component(&engine);
+    component.setData("import Ubuntu.OnlineAccounts 0.1\n"
+                      "ApplicationModel {}",
+                      QUrl());
+    QObject *qmlModel = component.create();
+    QVERIFY(qmlModel != 0);
+    QAbstractListModel *model = qobject_cast<QAbstractListModel*>(qmlModel);
+    QVERIFY(model != 0);
+
+    QCOMPARE(model->rowCount(), 0);
+    /* Retrieve a couple of invalid indexes */
+    QVERIFY(!get(model, 0, "applicationId").isValid());
+    QVERIFY(!get(model, -1, "applicationId").isValid());
+
+    /* Set a valid service on the model */
+    qmlModel->setProperty("service", QString("badmail"));
+    QCOMPARE(model->property("service").toString(), QString("badmail"));
+
+    QCOMPARE(model->rowCount(), 1);
+    QCOMPARE(model->property("count").toInt(), 1);
+
+    QCOMPARE(get(model, 0, "applicationId").toString(), QString("mailer"));
+    QCOMPARE(get(model, 0, "serviceUsage").toString(),
+             QString("Mailer can retrieve your e-mails"));
+
+
+    QVariant value;
+    QVERIFY(QMetaObject::invokeMethod(model, "get",
+                                      Q_RETURN_ARG(QVariant, value),
+                                      Q_ARG(int, 0),
+                                      Q_ARG(QString, "applicationId")));
+    QCOMPARE(value.toString(), QString("mailer"));
+
+    /* Get an Application from the model */
+    QObject *application = get(model, 0, "application").value<QObject*>();
+    QCOMPARE(application->metaObject()->className(),
+             "OnlineAccounts::Application");
+
+    /* Reset the model to an invalid service */
+    qmlModel->setProperty("service", QString());
+    QCOMPARE(model->rowCount(), 0);
+
+    delete qmlModel;
+}
+
 QTEST_MAIN(PluginTest);
 #include "tst_plugin.moc"
 
=== modified file 'tests/tst_plugin.pro'
--- tests/tst_plugin.pro	2013-04-10 11:42:03 +0000
+++ tests/tst_plugin.pro	2013-06-13 08:40:35 +0000
@@ -25,6 +25,7 @@
 DATA_PATH = $${TOP_SRC_DIR}/tests/data/
 
 DEFINES += \
+    APPLICATIONS_DIR=\\\"$$DATA_PATH\\\" \
     SERVICES_DIR=\\\"$$DATA_PATH\\\" \
     SERVICE_TYPES_DIR=\\\"$$DATA_PATH\\\" \
     PROVIDERS_DIR=\\\"$$DATA_PATH\\\"