Merge lp:~stolowski/unity-api/scope-activate-action into lp:unity-api

[Paweł Stołowski]

New method for in-card actions. Remove obsolete special categories.

New method for in-card actions. Remove obsolete special categories.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:181
http://jenkins.qa.ubuntu.com/job/unity-api-ci/350/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-amd64-ci/38
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/39
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/39/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-i386-ci/38
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-amd64-ci/49
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/49
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-wily-armhf-ci/49/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-wily-i386-ci/49

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-api-ci/350/rebuild

review: Approve (continuous-integration)

[Albert Astals Cid (aacid)]

Looks good.

review: Approve

[lp:~stolowski/unity-api/scope-activate-action]

182. By Paweł Stołowski on 2015-11-02

Bump

183. By Paweł Stołowski on 2015-11-02

Merged trunk

=== modified file 'debian/changelog'
--- debian/changelog	2015-10-21 11:48:38 +0000
+++ debian/changelog	2015-11-02 10:10:49 +0000
@@ -1,3 +1,9 @@
+unity-api (7.102-0ubuntu1) UNRELEASED; urgency=medium
+
+  * New method for in-card actions.
+
+ -- Pawel Stolowski <[e-mail]>  Tue, 06 Oct 2015 18:06:37 +0200
+
 unity-api (7.101+15.10.20151021-0ubuntu1) wily; urgency=medium
 
   [ Daniel d'Andrada ]

=== modified file 'include/unity/shell/scopes/CMakeLists.txt'
--- include/unity/shell/scopes/CMakeLists.txt	2015-09-15 09:15:11 +0000
+++ include/unity/shell/scopes/CMakeLists.txt	2015-11-02 10:10:49 +0000
@@ -7,7 +7,7 @@
 
 set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
 
-set(VERSION 7)
+set(VERSION 8)
 set(PKGCONFIG_NAME "unity-shell-scopes")
 set(PKGCONFIG_DESCRIPTION "Unity shell Scopes APIs")
 set(PKGCONFIG_REQUIRES "Qt5Core")

=== modified file 'include/unity/shell/scopes/CategoriesInterface.h'
--- include/unity/shell/scopes/CategoriesInterface.h	2014-07-08 11:02:23 +0000
+++ include/unity/shell/scopes/CategoriesInterface.h	2015-11-02 10:10:49 +0000
@@ -69,16 +69,6 @@
      */
     Q_INVOKABLE virtual bool overrideCategoryJson(QString const& categoryId, QString const& json) = 0;
 
-    /**
-     * @brief Allows the shell to define a special category that isn't provided by
-     * the scope.
-     *
-     * Allows the shell to use specialized renderers for certain categories.
-     * The plugin implementation should prepend the category before any others
-     * provided by the scope.
-     */
-    Q_INVOKABLE virtual void addSpecialCategory(QString const& categoryId, QString const& name, QString const& icon, QString const& rawTemplate, QObject* countObject) = 0;
-
     // @cond
     QHash<int, QByteArray> roleNames() const override
     {

=== modified file 'include/unity/shell/scopes/ResultsModelInterface.h'
--- include/unity/shell/scopes/ResultsModelInterface.h	2014-07-18 12:15:05 +0000
+++ include/unity/shell/scopes/ResultsModelInterface.h	2015-11-02 10:10:49 +0000
@@ -61,6 +61,7 @@
         RoleCategoryId,
         RoleDndUri,
         RoleResult,
+        RoleQuickPreviewData, ///< Data for UI quick previewing. In case of audio should contain uri and duration
         // card components
         RoleTitle,
         RoleArt,
@@ -84,6 +85,7 @@
         roles[RoleUri] = "uri";
         roles[RoleCategoryId] = "categoryId";
         roles[RoleDndUri] = "dndUri";
+        roles[RoleQuickPreviewData] = "quickPreviewData";
         roles[RoleResult] = "result";
         roles[RoleTitle] = "title";
         roles[RoleArt] = "art";

=== modified file 'include/unity/shell/scopes/ScopeInterface.h'
--- include/unity/shell/scopes/ScopeInterface.h	2015-09-15 09:15:11 +0000
+++ include/unity/shell/scopes/ScopeInterface.h	2015-11-02 10:10:49 +0000
@@ -243,6 +243,11 @@
      */
     Q_INVOKABLE virtual void refresh() = 0;
 
+    /**
+     * @brief Method used to activate an action of a result.
+     */
+    Q_INVOKABLE virtual void activateAction(QVariant const& result, QString const& categoryId, QString const& actionId) = 0;
+
 Q_SIGNALS:
     // @cond
     void idChanged();

=== modified file 'test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockCategories.cpp'
--- test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockCategories.cpp	2014-07-08 11:02:23 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockCategories.cpp	2015-11-02 10:10:49 +0000
@@ -29,25 +29,7 @@
 
 int MockCategories::rowCount(const QModelIndex& /*parent*/) const
 {
-    return m_category_count + m_specialCategories.count();
-}
-
-void MockCategories::addSpecialCategory(QString const& categoryId, QString const& name, QString const& icon, QString const& rawTemplate, QObject* countObject)
-{
-    CategoryData catData;
-    catData.categoryId = categoryId;
-    catData.name = name;
-    catData.icon = icon;
-    catData.rawTemplate = rawTemplate;
-    catData.countObject = countObject;
-
-    beginInsertRows(QModelIndex(), 0, 0);
-    m_specialCategories.prepend(catData);
-    endInsertRows();
-
-    if (countObject) {
-        connect(countObject, SIGNAL(countChanged()), this, SLOT(countChanged()));
-    }
+    return m_category_count;
 }
 
 bool MockCategories::overrideCategoryJson(QString const& , QString const& )
@@ -56,23 +38,6 @@
     return false;
 }
 
-void MockCategories::countChanged()
-{
-    QObject* countObject = sender();
-
-    for (int i = 0; i < m_specialCategories.count(); ++i) {
-        const CategoryData &catData = m_specialCategories.at(i);
-        if (catData.countObject == countObject) {
-            QVector<int> roles;
-            roles.append(RoleCount);
-
-            QModelIndex changedIndex(index(i));
-            dataChanged(changedIndex, changedIndex, roles);
-            break;
-        }
-    }
-}
-
 QVariant
 MockCategories::data(const QModelIndex& index, int role) const
 {
@@ -85,78 +50,39 @@
         resultsModel = new MockResultsModel(15, index.row());
         m_resultsModels[index.row()] = resultsModel;
     }
-    if (index.row() < m_specialCategories.count()) {
-        const CategoryData &catData = m_specialCategories.at(index.row());
-        switch (role) {
-            case RoleCategoryId:
-                return catData.categoryId;
-            case RoleName:
-                return catData.name;
-            case RoleIcon:
-                return catData.icon;
-            case RoleRawRendererTemplate:
-                return catData.rawTemplate;
-            case RoleRenderer:
-            {
-                QVariantMap map;
-                map["category-layout"] = index.row() % 2 == 0 ? "grid" : "carousel";
-                map["card-size"] = "small";
-                return map;
-            }
-            case RoleComponents:
-            {
-                QVariantMap map, artMap;
-                artMap["aspect-ratio"] = "1.0";
-                artMap["field"] = "art";
-                map["art"] = artMap;
-                map["title"] = "HOLA";
-                return map;
-            }
-            case RoleHeaderLink:
-                return QString();
-            case RoleResults:
-                return QVariant();
-            case RoleCount:
-                return catData.countObject->property("count");
-            default:
-                qFatal("Using un-implemented Categories role");
-                return QVariant();
-        }
-    } else {
-        switch (role) {
-            case RoleCategoryId:
-                return QString("%1").arg(index.row());
-            case RoleName:
-                return QString("Category %1").arg(index.row());
-            case RoleIcon:
-                return "gtk-apply";
-            case RoleRawRendererTemplate:
-                return QString();
-            case RoleRenderer:
-            {
-                QVariantMap map;
-                map["category-layout"] = index.row() % 2 == 0 ? "grid" : "carousel";
-                map["card-size"] = "small";
-                return map;
-            }
-            case RoleComponents:
-            {
-                QVariantMap map, artMap;
-                artMap["aspect-ratio"] = "1.0";
-                artMap["field"] = "art";
-                map["art"] = artMap;
-                map["title"] = "HOLA";
-                return map;
-            }
-            case RoleHeaderLink:
-                return QString();
-            case RoleResults:
-                return QVariant::fromValue(resultsModel);
-            case RoleCount:
-                return resultsModel->rowCount();
-            default:
-                qFatal("Using un-implemented Categories role");
-                return QVariant();
-        }
+    switch (role) {
+        case RoleCategoryId:
+            return QString("%1").arg(index.row());
+        case RoleName:
+            return QString("Category %1").arg(index.row());
+        case RoleIcon:
+            return "gtk-apply";
+        case RoleRawRendererTemplate:
+            return QString();
+        case RoleRenderer:
+        {
+            QVariantMap map;
+            map["category-layout"] = index.row() % 2 == 0 ? "grid" : "carousel";
+            map["card-size"] = "small";
+            return map;
+        }
+        case RoleComponents:
+        {
+            QVariantMap map, artMap;
+            artMap["aspect-ratio"] = "1.0";
+            artMap["field"] = "art";
+            map["art"] = artMap;
+            map["title"] = "HOLA";
+            return map;
+        }
+        case RoleHeaderLink:
+            return QString();
+        case RoleResults:
+            return QVariant::fromValue(resultsModel);
+        case RoleCount:
+            return resultsModel->rowCount();
+        default:
+            qFatal("Using un-implemented Categories role");
+            return QVariant();
     }
 }

=== modified file 'test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockCategories.h'
--- test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockCategories.h	2014-05-13 13:52:12 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockCategories.h	2015-11-02 10:10:49 +0000
@@ -34,25 +34,11 @@
     QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;
     int rowCount(const QModelIndex& parent = QModelIndex()) const override;
 
-    Q_INVOKABLE void addSpecialCategory(QString const& categoryId, QString const& name, QString const& icon, QString const& rawTemplate, QObject* countObject) override;
     Q_INVOKABLE bool overrideCategoryJson(QString const& categoryId, QString const& json) override;
 
-private Q_SLOTS:
-    void countChanged();
-
 private:
     mutable QHash<int, MockResultsModel*> m_resultsModels;
     int m_category_count;
-
-    struct CategoryData {
-        QString categoryId;
-        QString name;
-        QString icon;
-        QString rawTemplate;
-        QObject* countObject;
-    };
-
-    QList<CategoryData> m_specialCategories;
 };
 
 #endif

=== modified file 'test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.cpp'
--- test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.cpp	2015-09-15 09:15:11 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.cpp	2015-11-02 10:10:49 +0000
@@ -165,6 +165,13 @@
     Q_UNUSED(categoryId);
 }
 
+void MockScope::activateAction(QVariant const& result, QString const& categoryId, QString const& actionId)
+{
+    Q_UNUSED(result);
+    Q_UNUSED(categoryId);
+    Q_UNUSED(actionId);
+}
+
 unity::shell::scopes::PreviewStackInterface* MockScope::preview(QVariant const& result, QString const& categoryId)
 {
     Q_UNUSED(result);

=== modified file 'test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.h'
--- test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.h	2015-09-15 09:15:11 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.h	2015-11-02 10:10:49 +0000
@@ -58,6 +58,7 @@
     void setFavorite(const bool) override;
 
     Q_INVOKABLE void activate(QVariant const& result, QString const& categoryId) override;
+    Q_INVOKABLE void activateAction(QVariant const& result, QString const& categoryId, QString const& actionId) override;
     Q_INVOKABLE unity::shell::scopes::PreviewStackInterface* preview(QVariant const& result, QString const& categoryId) override;
     Q_INVOKABLE void cancelActivation() override;
     Q_INVOKABLE void closeScope(unity::shell::scopes::ScopeInterface* scope) override;

=== modified file 'test/qmltest/unity/shell/scopes/tst_Scopes.qml'
--- test/qmltest/unity/shell/scopes/tst_Scopes.qml	2015-09-15 09:15:11 +0000
+++ test/qmltest/unity/shell/scopes/tst_Scopes.qml	2015-11-02 10:10:49 +0000
@@ -215,8 +215,7 @@
 
         function test_categories_methods_data() {
             return [
-                { tag: "Model.methods[overrideCategoryJson]", method: "overrideCategoryJson" },
-                { tag: "Model.methods[addSpecialCategory]", method: "addSpecialCategory" }
+                { tag: "Model.methods[overrideCategoryJson]", method: "overrideCategoryJson" }
             ];
         }