Merge lp:~jamesh/unity-scope-scopes/category-renderer into lp:unity-scope-scopes

[James Henstridge]

Use a custom category renderer, and update the preview to show the scope icon.

Add a custom category renderer to the scopes scope: rather than showing large artwork, use a mascot to the left of the description.

I've also updated the preview code to use add_component() to bind widget attributes to the result, and shown the scope icon in the preview as the header mascot.

[lp:~jamesh/unity-scope-scopes/category-renderer]

13. By James Henstridge on 2014-02-13

Fix widget type for art, and rename it from "screenshot" to "art", to
match the terminology in the scope metadata.

14. By James Henstridge on 2014-02-13

Add "publisher" key to result, and use it as subtitle in the category
renderer and preview header. Currently it is hard coded to "Canonical
Ltd", but should eventually come from scope metadata.

15. By James Henstridge on 2014-02-13

Rename publisher to author, as discussed on IRC.

16. By James Henstridge on 2014-02-13

Remove empty Icon and Art metadata keys.

[Michal Hruby (mhr3)]

+1

review: Approve

=== modified file 'src/scopes-scope.cpp'
--- src/scopes-scope.cpp	2014-02-13 11:25:18 +0000
+++ src/scopes-scope.cpp	2014-02-13 11:25:18 +0000
@@ -29,6 +29,22 @@
 
 using namespace unity::scopes;
 
+static const char MISSING_ICON[] = "/usr/share/icons/unity-icon-theme/places/svg/service-generic.svg";
+static const char SCOPES_CATEGORY_DEFINITION[] = R"(
+{
+  "schema-version": 1,
+  "template": {
+    "category-layout": "grid",
+    "card-size": "medium"
+  },
+  "components": {
+    "title": "title",
+    "subtitle": "author",
+    "mascot":  "icon"
+  }
+}
+)";
+
 int ScopesScope::start(std::string const&, RegistryProxy const &registry) {
     this->registry = registry;
     return VERSION;
@@ -73,7 +89,8 @@
 }
 
 void ScopesQuery::run(SearchReplyProxy const &reply) {
-    auto cat = reply->register_category("scopes", "Scopes", "");
+    CategoryRenderer renderer(SCOPES_CATEGORY_DEFINITION);
+    auto cat = reply->register_category("scopes", "Scopes", "", renderer);
 
     std::string term = lowercase(query.query_string());
     const auto matches = scope.registry->list_if(
@@ -102,19 +119,18 @@
             result.set_title(item.scope_name());
         }
         try {
-            result.set_art(item.icon());
+            result.set_art(item.art());
         } catch (NotFoundException &e) {
         }
-        if (result.art().empty()) {
-            result.set_art("/usr/share/icons/unity-icon-theme/places/svg/service-generic.svg");
-        }
         result.set_dnd_uri(uri);
         result["scope_name"] = item.scope_name();
+        // FIXME: this should be provided by the scope metadata
+        result["author"] = "Canonical Ltd";
         result["description"] = item.description();
         try {
-            result["screenshot"] = item.art();
+            result["icon"] = item.icon();
         } catch (NotFoundException &e) {
-            result["screenshot"] = "";
+            result["icon"] = MISSING_ICON;
         }
         reply->push(result);
     }
@@ -129,24 +145,26 @@
 
 void ScopesPreview::run(PreviewReplyProxy const &reply) {
     ColumnLayout layout1col(1), layout2col(2), layout3col(3);
-    layout1col.add_column({"screenshot", "header", "actions", "description"});
-
-    layout2col.add_column({"screenshot", "header"});
-    layout2col.add_column({"actions", "description"});
-
-    layout3col.add_column({"screenshot", "header"});
-    layout3col.add_column({"actions", "description"});
+    layout1col.add_column({"art", "header", "actions", "description"});
+
+    layout2col.add_column({"art"});
+    layout2col.add_column({"header", "actions", "description"});
+
+    layout3col.add_column({"art"});
+    layout3col.add_column({"header", "actions", "description"});
     layout3col.add_column({});
     reply->register_layout({layout1col, layout2col, layout3col});
 
     PreviewWidget header("header", "header");
-    header.add_attribute("title", Variant(result.title()));
+    header.add_component("title", "title");
+    header.add_component("subtitle", "author");
+    header.add_component("mascot", "icon");
 
-    PreviewWidget screenshot("screenshot", "img");
-    screenshot.add_attribute("source", result["screenshot"]);
+    PreviewWidget art("art", "image");
+    art.add_component("source", "art");
 
     PreviewWidget description("description", "text");
-    description.add_attribute("text", result["description"]);
+    description.add_component("text", "description");
 
     PreviewWidget actions("actions", "actions");
     {
@@ -158,7 +176,7 @@
         actions.add_attribute("actions", builder.end());
     }
 
-    reply->push({header, screenshot, description, actions});
+    reply->push({art, header, actions, description});
 }
 
 ScopesActivation::ScopesActivation(Result const &result)

=== modified file 'src/scopes.ini'
--- src/scopes.ini	2014-02-06 04:39:29 +0000
+++ src/scopes.ini	2014-02-13 11:25:18 +0000
@@ -1,7 +1,5 @@
 [ScopeConfig]
 DisplayName = Scopes
 Description = This is an Ubuntu search plugin that enables information from available search plugins to be searched and displayed in the Dash underneath the Dash plugins header. If you do not wish to search this content source, you can disable this search plugin.
-Art =
-Icon =
 SearchHint = Search for scopes
 HotKey =