From 999cf66b27a5b58a03e02e3dd85a0495c71d52c9 Mon Sep 17 00:00:00 2001
From: Nick O'Leary <nick.oleary@gmail.com>
Date: Fri, 10 Jul 2015 19:49:31 +0100
Subject: [PATCH] Add editor events component and migrate to it

---
 Gruntfile.js               |  5 ++--
 editor/js/events.js        | 48 ++++++++++++++++++++++++++++++++++++++
 editor/js/nodes.js         | 24 +------------------
 editor/js/ui/clipboard.js  |  2 +-
 editor/js/ui/deploy.js     |  3 ++-
 editor/js/ui/library.js    |  2 +-
 editor/js/ui/sidebar.js    | 28 ++++------------------
 editor/js/ui/subflow.js    |  2 +-
 editor/js/ui/tab-info.js   |  2 +-
 editor/js/ui/view.js       | 26 ++-------------------
 editor/js/ui/workspaces.js | 26 ++-------------------
 11 files changed, 66 insertions(+), 102 deletions(-)
 create mode 100644 editor/js/events.js

diff --git a/Gruntfile.js b/Gruntfile.js
index 04273c683..ad46baee9 100644
--- a/Gruntfile.js
+++ b/Gruntfile.js
@@ -93,6 +93,7 @@ module.exports = function(grunt) {
                   // Ensure editor source files are concatenated in
                   // the right order
                   "editor/js/main.js",
+                  "editor/js/events.js",
                   "editor/js/i18n.js",
                   "editor/js/settings.js",
                   "editor/js/user.js",
@@ -301,7 +302,7 @@ module.exports = function(grunt) {
                 mode: '755'
             },
             release: {
-                // Target-specific file/dir lists and/or options go here. 
+                // Target-specific file/dir lists and/or options go here.
                 src: [
                     path.resolve('<%= paths.dist %>/node-red-<%= pkg.version %>/nodes/core/hardware/nrgpio*')
                 ]
@@ -332,7 +333,7 @@ module.exports = function(grunt) {
     grunt.loadNpmTasks('grunt-contrib-copy');
     grunt.loadNpmTasks('grunt-chmod');
     grunt.loadNpmTasks('grunt-jsonlint');
-    
+
     grunt.registerMultiTask('attachCopyright', function() {
         var files = this.data.src;
         var copyright = "/**\n"+
diff --git a/editor/js/events.js b/editor/js/events.js
new file mode 100644
index 000000000..804027af9
--- /dev/null
+++ b/editor/js/events.js
@@ -0,0 +1,48 @@
+/**
+ * Copyright 2015 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+ RED.events = (function() {
+     var handlers = {};
+
+     function on(evt,func) {
+         handlers[evt] = handlers[evt]||[];
+         handlers[evt].push(func);
+     }
+     function off(evt,func) {
+         var handler = handlers[evt];
+         if (handler) {
+             for (var i=0;i<handler.length;i++) {
+                 if (handler[i] === func) {
+                     handler.splice(i,1);
+                     return;
+                 }
+             }
+         }
+     }
+     function emit(evt,arg) {
+         if (handlers[evt]) {
+             for (var i=0;i<handlers[evt].length;i++) {
+                 handlers[evt][i](arg);
+             }
+
+         }
+     }
+     return {
+         on: on,
+         off: off,
+         emit: emit
+     }
+ })();
diff --git a/editor/js/nodes.js b/editor/js/nodes.js
index 6878a8cc2..ed1101ed0 100644
--- a/editor/js/nodes.js
+++ b/editor/js/nodes.js
@@ -27,7 +27,7 @@ RED.nodes = (function() {
 
     function setDirty(d) {
         dirty = d;
-        eventHandler.emit("change",{dirty:dirty});
+        RED.events.emit("nodes:change",{dirty:dirty});
     }
 
     var registry = (function() {
@@ -894,29 +894,7 @@ RED.nodes = (function() {
         return result;
     }
 
-    // TODO: DRY
-    var eventHandler = (function() {
-        var handlers = {};
-
-        return {
-            on: function(evt,func) {
-                handlers[evt] = handlers[evt]||[];
-                handlers[evt].push(func);
-            },
-            emit: function(evt,arg) {
-                if (handlers[evt]) {
-                    for (var i=0;i<handlers[evt].length;i++) {
-                        handlers[evt][i](arg);
-                    }
-
-                }
-            }
-        }
-    })();
-
     return {
-        on: eventHandler.on,
-
         registry:registry,
         setNodeList: registry.setNodeList,
 
diff --git a/editor/js/ui/clipboard.js b/editor/js/ui/clipboard.js
index d95e5bc38..a779378fb 100644
--- a/editor/js/ui/clipboard.js
+++ b/editor/js/ui/clipboard.js
@@ -141,7 +141,7 @@ RED.clipboard = (function() {
     return {
         init: function() {
             setupDialogs();
-            RED.view.on("selection-changed",function(selection) {
+            RED.events.on("view:selection-changed",function(selection) {
                 if (!selection.nodes) {
                     RED.menu.setDisabled("menu-item-export",true);
                     RED.menu.setDisabled("menu-item-export-clipboard",true);
diff --git a/editor/js/ui/deploy.js b/editor/js/ui/deploy.js
index 09b71b22f..1c350f0ea 100644
--- a/editor/js/ui/deploy.js
+++ b/editor/js/ui/deploy.js
@@ -111,7 +111,7 @@ RED.deploy = (function() {
                 }
         });
 
-        RED.nodes.on('change',function(state) {
+        RED.events.on('nodes:change',function(state) {
             if (state.dirty) {
                 window.onbeforeunload = function() {
                     return RED._("deploy.confirm.undeployedChanges");
@@ -233,6 +233,7 @@ RED.deploy = (function() {
                 // Once deployed, cannot undo back to a clean state
                 RED.history.markAllDirty();
                 RED.view.redraw();
+                RED.events.emit("deploy");
             }).fail(function(xhr,textStatus,err) {
                 RED.nodes.dirty(true);
                 if (xhr.responseText) {
diff --git a/editor/js/ui/library.js b/editor/js/ui/library.js
index af36da8cb..302e89cc1 100644
--- a/editor/js/ui/library.js
+++ b/editor/js/ui/library.js
@@ -390,7 +390,7 @@ RED.library = (function() {
 
     return {
         init: function() {
-            RED.view.on("selection-changed",function(selection) {
+            RED.events.on("view:selection-changed",function(selection) {
                 if (!selection.nodes) {
                     RED.menu.setDisabled("menu-item-export",true);
                     RED.menu.setDisabled("menu-item-export-clipboard",true);
diff --git a/editor/js/ui/sidebar.js b/editor/js/ui/sidebar.js
index b2f8ce6ff..f38093296 100644
--- a/editor/js/ui/sidebar.js
+++ b/editor/js/ui/sidebar.js
@@ -102,7 +102,7 @@ RED.sidebar = (function() {
                     $("#chart-zoom-controls").css("right",newChartRight+20);
                     $("#sidebar").width(0);
                     RED.menu.setSelected("menu-item-sidebar",true);
-                    eventHandler.emit("resize");
+                    RED.events.emit("sidebar:resize");
                 }
                 sidebarSeparator.width = $("#sidebar").width();
             },
@@ -142,7 +142,7 @@ RED.sidebar = (function() {
                 $("#sidebar").width(newSidebarWidth);
 
                 sidebar_tabs.resize();
-                eventHandler.emit("resize");
+                RED.events.emit("sidebar:resize");
             },
             stop:function(event,ui) {
                 if (sidebarSeparator.closing) {
@@ -156,7 +156,7 @@ RED.sidebar = (function() {
                 }
                 $("#sidebar-separator").css("left","auto");
                 $("#sidebar-separator").css("right",($("#sidebar").width()+13)+"px");
-                eventHandler.emit("resize");
+                RED.events.emit("sidebar:resize");
             }
     });
 
@@ -167,7 +167,7 @@ RED.sidebar = (function() {
             $("#main-container").removeClass("sidebar-closed");
             sidebar_tabs.resize();
         }
-        eventHandler.emit("resize");
+        RED.events.emit("sidebar:resize");
     }
 
     function showSidebar(id) {
@@ -195,25 +195,6 @@ RED.sidebar = (function() {
         if ($(window).width() < 600) { toggleSidebar(); }
     }
 
-    var eventHandler = (function() {
-        var handlers = {};
-
-        return {
-            on: function(evt,func) {
-                handlers[evt] = handlers[evt]||[];
-                handlers[evt].push(func);
-            },
-            emit: function(evt,arg) {
-                if (handlers[evt]) {
-                    for (var i=0;i<handlers[evt].length;i++) {
-                        handlers[evt][i](arg);
-                    }
-
-                }
-            }
-        }
-    })();
-
     return {
         init: init,
         addTab: addTab,
@@ -221,7 +202,6 @@ RED.sidebar = (function() {
         show: showSidebar,
         containsTab: containsTab,
         toggleSidebar: toggleSidebar,
-        on: eventHandler.on
     }
 
 })();
diff --git a/editor/js/ui/subflow.js b/editor/js/ui/subflow.js
index fb8ddec59..2cf6a45f3 100644
--- a/editor/js/ui/subflow.js
+++ b/editor/js/ui/subflow.js
@@ -179,7 +179,7 @@ RED.subflow = (function() {
             RED.view.redraw();
         });
 
-        RED.view.on("selection-changed",function(selection) {
+        RED.events.on("view:selection-changed",function(selection) {
             if (!selection.nodes) {
                 RED.menu.setDisabled("menu-item-subflow-convert",true);
             } else {
diff --git a/editor/js/ui/tab-info.js b/editor/js/ui/tab-info.js
index af120f58d..e088536fa 100644
--- a/editor/js/ui/tab-info.js
+++ b/editor/js/ui/tab-info.js
@@ -169,7 +169,7 @@ RED.sidebar.info = (function() {
         $("#tab-info").html("");
     }
 
-    RED.view.on("selection-changed",function(selection) {
+    RED.events.on("view:selection-changed",function(selection) {
         if (selection.nodes) {
             if (selection.nodes.length == 1) {
                 var node = selection.nodes[0];
diff --git a/editor/js/ui/view.js b/editor/js/ui/view.js
index 52138f4ba..d6b01eb99 100644
--- a/editor/js/ui/view.js
+++ b/editor/js/ui/view.js
@@ -243,7 +243,7 @@ RED.view = (function() {
     }
 
     function init() {
-        RED.workspaces.on("change",function(event) {
+        RED.events.on("workspace:change",function(event) {
             var chart = $("#chart");
             if (event.old !== 0) {
                 workspaceScrollPositions[event.old] = {
@@ -700,8 +700,7 @@ RED.view = (function() {
         if (selected_link != null) {
             selection.link = selected_link;
         }
-
-        eventHandler.emit("selection-changed",selection);
+        RED.events.emit("view:selection-changed",selection);
     }
 
     function endKeyboardMove() {
@@ -1775,29 +1774,8 @@ RED.view = (function() {
         }
     }
 
-    // TODO: DRY
-    var eventHandler = (function() {
-        var handlers = {};
-
-        return {
-            on: function(evt,func) {
-                handlers[evt] = handlers[evt]||[];
-                handlers[evt].push(func);
-            },
-            emit: function(evt,arg) {
-                if (handlers[evt]) {
-                    for (var i=0;i<handlers[evt].length;i++) {
-                        handlers[evt][i](arg);
-                    }
-
-                }
-            }
-        }
-    })();
-
     return {
         init: init,
-        on: eventHandler.on,
         state:function(state) {
             if (state == null) {
                 return mouse_mode
diff --git a/editor/js/ui/workspaces.js b/editor/js/ui/workspaces.js
index 71168e6ec..5eeac88ee 100644
--- a/editor/js/ui/workspaces.js
+++ b/editor/js/ui/workspaces.js
@@ -94,8 +94,7 @@ RED.workspaces = (function() {
                 }
                 activeWorkspace = tab.id;
                 event.workspace = activeWorkspace;
-
-                eventHandler.emit("change",event);
+                RED.events.emit("workspace:change",event);
             },
             ondblclick: function(tab) {
                 if (tab.type != "subflow") {
@@ -200,33 +199,13 @@ RED.workspaces = (function() {
     function init() {
         createWorkspaceTabs();
         $('#btn-workspace-add-tab').on("click",function(e) {addWorkspace(); e.preventDefault()});
-        RED.sidebar.on("resize",workspace_tabs.resize);
+        RED.events.on("sidebar:resize",workspace_tabs.resize);
 
         RED.menu.setAction('menu-item-workspace-delete',function() {
             deleteWorkspace(RED.nodes.workspace(activeWorkspace));
         });
     }
 
-    // TODO: DRY
-    var eventHandler = (function() {
-        var handlers = {};
-
-        return {
-            on: function(evt,func) {
-                handlers[evt] = handlers[evt]||[];
-                handlers[evt].push(func);
-            },
-            emit: function(evt,arg) {
-                if (handlers[evt]) {
-                    for (var i=0;i<handlers[evt].length;i++) {
-                        handlers[evt][i](arg);
-                    }
-
-                }
-            }
-        }
-    })();
-
     function removeWorkspace(ws) {
         if (!ws) {
             deleteWorkspace(RED.nodes.workspace(activeWorkspace));
@@ -238,7 +217,6 @@ RED.workspaces = (function() {
     }
     return {
         init: init,
-        on: eventHandler.on,
         add: addWorkspace,
         remove: removeWorkspace,