Merge lp:~stolowski/unity-scopes-shell/no-unlimited-categories into lp:unity-scopes-shell

[Paweł Stołowski]

Remove excess empty categories.

Remove excess empty categories.

Automated test for this change is hard to implement because scope harness abstracts away the low-level aspects of the models. I've tested manually (it's in silo 24) - after several refreshes of 'NearBy' scope (which currently produces categories with unique ids on every search) one can see the following debug message in dash log:

Purging unused category: "wn1:declared:first_result:surface_template::surface21.10.2015_10:29:46:113"
Purging unused category: "yelp1:declared:first_result:surface_template::surface21.10.2015_10:29:46:110"
Purging unused category: "yelp1_landmarks:declared:first_result:surface_template::surface21.10.2015_10:29:46:105"

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:264
http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-ci/396/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-vivid-amd64-ci/90
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-vivid-armhf-ci/90
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-vivid-armhf-ci/90/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-vivid-i386-ci/90
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-wily-amd64-ci/53
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-wily-armhf-ci/53
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-wily-armhf-ci/53/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-wily-i386-ci/53

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-shell-ci/396/rebuild

review: Approve (continuous-integration)

[Marcus Tomlinson (marcustomlinson)]

Looks good.

review: Approve

=== modified file 'src/Unity/categories.cpp'
--- src/Unity/categories.cpp	2015-09-08 12:32:05 +0000
+++ src/Unity/categories.cpp	2015-10-20 13:31:45 +0000
@@ -38,6 +38,8 @@
 
 namespace scopes_ng {
 
+const int MAX_NUMBER_OF_CATEGORIES = 32; // when reached, any excess categories which have no results will be removed
+
 // FIXME: this should be in a common place
 #define CATEGORY_JSON_DEFAULTS R"({"schema-version":1,"template": {"category-layout":"grid","card-layout":"vertical","card-size":"small","overlay-mode":null,"collapsed-rows":2}, "components": { "title":null, "art": { "aspect-ratio":1.0 }, "subtitle":null, "mascot":null, "emblem":null, "summary":null, "attributes": { "max-count":2 }, "background":null, "overlay-color":null }, "resources":{}})"
 
@@ -403,6 +405,26 @@
 
         endInsertRows();
     }
+
+    if (m_categories.count() >= MAX_NUMBER_OF_CATEGORIES) {
+        // we register one category at a time, so there can be one excess category at most
+        const int index = m_categories.count() - 1;
+        auto it = m_categories.begin() + index;
+        if ((*it)->resultsModelCount() == 0) {
+            qDebug() << "Purging unused category:" << (*it)->categoryId();
+            beginRemoveRows(QModelIndex(), index, index);
+            m_categoryResults.remove((*it)->categoryId().toStdString());
+            for (auto kv = m_countObjects.begin(); kv != m_countObjects.end(); ++kv) {
+                if (kv.value() == (*it)->categoryId()) {
+                    kv.key()->deleteLater();
+                    m_countObjects.erase(kv);
+                    break;
+                }
+            }
+            m_categories.erase(it);
+            endRemoveRows();
+        }
+    }
 }
 
 void Categories::updateResultCount(const QSharedPointer<ResultsModel>& resultsModel)