Merge lp:~m982/unity-js-scopes/add-activation-response-update-preview-support into lp:unity-js-scopes

[Michael Weimann]

Adds support for ActivationResponse with the status UpdatePreview. To detect an UpdatePreview the ActivationResponse constructor tests for an Array argument. If it's an Array it maps it to a real ActivationResponse with a PreviewWidgetList.

How to test: Run the soundcloud example scope. You'll find an "Update" action on the preview. Sadly I didn't find unit tests to extend to cover this.

[Alexandre Abreu (abreu-alexandre)]

Good code & feature update ! Thank you, +1

review: Approve

=== modified file 'examples/soundcloud/soundcloud.js'
--- examples/soundcloud/soundcloud.js	2016-02-13 16:01:06 +0000
+++ examples/soundcloud/soundcloud.js	2016-02-15 20:51:32 +0000
@@ -140,7 +140,7 @@
                     "",
                     "",
                     category_renderer);
-            
+
             var query_string =
                 canned_query.query_string().trim();
 
@@ -186,11 +186,15 @@
             var r = this.result();
 
             var layout1col = new scopes.lib.ColumnLayout(1)
-            layout1col.add_column(["imageId", "headerId", "actionsId"])
+            layout1col.add_column([
+                "imageId",
+                "headerId",
+                "actionsId",
+                "updatePreviewActionsId"])
 
             var layout2col = new scopes.lib.ColumnLayout(2)
             layout2col.add_column(["imageId"])
-            layout2col.add_column(["headerId", "actionsId"])
+            layout2col.add_column(["headerId", "actionsId", "updatePreviewActionsId"])
 
             preview_reply.register_layout([layout1col, layout2col]);
 
@@ -201,6 +205,9 @@
             var art_widget = new scopes.lib.PreviewWidget("imageId", "image");
             art_widget.add_attribute_mapping("source", "art");
 
+            var update_preview_button_widget = 
+                createUpdatePreviewActionsIdWidget("Update");
+
             var actions_widget = new scopes.lib.PreviewWidget("actionsId", "actions");
             actions_widget.add_attribute_value(
                 "actions",
@@ -220,8 +227,15 @@
                     }
                 ]
             );
-            preview_reply.push([header_widget, art_widget, actions_widget])
-            preview_reply.finished()
+
+            preview_reply.push([
+                header_widget,
+                art_widget,
+                actions_widget,
+                update_preview_button_widget
+            ]);
+
+            preview_reply.finished();
         },
         // cancelled
         function() {
@@ -254,10 +268,20 @@
                 action_id,
                 // activate
                 function() {
-                    console.log('activate called')
-                    
-                    return new scopes.lib.ActivationResponse(
-                        scopes.defs.ActivationResponseStatus.NotHandled);
+                    console.log('activate called');
+
+                    var result;
+                    switch (action_id) {
+                        case 'updateId':
+                            result = activateUpdatePreview();
+                            break;
+                        default:
+                            result = new scopes.lib.ActivationResponse(
+                                scopes.defs.ActivationResponseStatus.NotHandled);
+                            break;
+                    }
+
+                    return result;
                 },
                 // cancelled
                 function() {
@@ -266,3 +290,31 @@
         }
     }
 );
+
+/**
+ * Updates the "updatePreviewActionsId" widget:
+ * Sets the widget's label to "Updated !".
+ */
+function activateUpdatePreview(result) {
+    var widgets = [];
+    var update_preview_button_widget =
+        createUpdatePreviewActionsIdWidget("Updated !");
+    widgets.push(update_preview_button_widget);
+    return new scopes.lib.ActivationResponse(widgets);
+}
+
+function createUpdatePreviewActionsIdWidget(label) {
+    var update_preview_button_widget =
+        new scopes.lib.PreviewWidget("updatePreviewActionsId", "actions");
+    update_preview_button_widget.add_attribute_value(
+        "actions",
+        [
+            {
+                id: "updateId",
+                label: label
+            }
+        ]
+    );
+    return update_preview_button_widget;
+}
+

=== modified file 'src/bindings/src/activation-response.cc'
--- src/bindings/src/activation-response.cc	2016-02-13 20:54:36 +0000
+++ src/bindings/src/activation-response.cc	2016-02-15 20:51:32 +0000
@@ -17,6 +17,7 @@
  */
 
 #include "activation-response.h"
+#include "preview-widget.h"
 
 #include "event_queue.h"
 
@@ -34,6 +35,21 @@
         new unity::scopes::ActivationResponse(
             static_cast<unity::scopes::ActivationResponse::Status>(
                 status)));
+  } else if (arg->IsArray()) {
+    // assume UpdatePreview
+    std::vector<std::shared_ptr<PreviewWidget>> const& widgets =
+            v8cpp::from_v8<std::vector<std::shared_ptr<PreviewWidget>>>(
+                v8::Isolate::GetCurrent(),
+                arg);
+
+    unity::scopes::PreviewWidgetList widgets_list;
+    for (auto const& widget : widgets)
+    {
+      widgets_list.push_back(widget->preview_widget());
+    }
+
+    activation_response_.reset(
+        new unity::scopes::ActivationResponse(widgets_list));
   } else {
     auto query =
         v8cpp::from_v8<std::shared_ptr<CannedQuery>>(

=== modified file 'src/bindings/src/activation-response.h'
--- src/bindings/src/activation-response.h	2016-02-13 20:54:36 +0000
+++ src/bindings/src/activation-response.h	2016-02-15 20:51:32 +0000
@@ -41,7 +41,7 @@
 --doc:constructor
  *
  * @constructor
- * @param status|query ActivationResponseStatus to create a response with given status or CannedQuery to create an ActivationResponse with status defs.ActivationResponseStatus.PerformQuery and a search query to be executed
+ * @param status|query|{Array of PreviewWidget} ActivationResponseStatus to create a response with given status OR CannedQuery to create an ActivationResponse with status defs.ActivationResponseStatus.PerformQuery and a search query to be executed OR an array of PreviewWidgets to create an ActivationResponse with status defs.ActivationResponseStatus.UpdatePreview to update the given widgets
 --/doc:constructor
 
 --doc:prototype ActivationResponse