MC-3305: Architectural Review for MC-1416

Move events out to separate module and use camel case

Author: danmooney2

lib/web/mage/adminhtml/wysiwyg/events.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+define([], function () {
+    'use strict';
+
+    return {
+        afterInitialization: 'afterInitialization',
+        afterChangeContent: 'afterChangeContent',
+        afterUndo: 'afterUndo',
+        afterPaste: 'afterPaste',
+        beforeSetContent: 'beforeSetContent',
+        afterSetContent: 'afterSetContent',
+        afterSave: 'afterSave',
+        afterOpenFileBrowser: 'afterOpenFileBrowser',
+        afterFormSubmit: 'afterFormSubmit',
+        afterBlur: 'afterBlur',
+        afterFocus: 'afterFocus'
+    };
+});

lib/web/mage/adminhtml/wysiwyg/tiny_mce/tinymce4Adapter.js

@@ -10,28 +10,16 @@ define([
     'underscore',
     'tinymce4',
     'mage/adminhtml/events',
+    'mage/adminhtml/wysiwyg/events',
     'mage/translate',
     'prototype',
     'jquery/ui'
-], function (jQuery, _, tinyMCE4, varienGlobalEvents) {
+], function (jQuery, _, tinyMCE4, varienGlobalEvents, wysiwygEvents) {
     'use strict';
 
     var tinyMce4Wysiwyg = Class.create();
 
     tinyMce4Wysiwyg.prototype = {
-        EVENT: {
-            AFTER_INITIALIZATION: 'wysiwygEditorInitialized',
-            AFTER_CONTENT_CHANGE: 'tinymceChange',
-            AFTER_UNDO: 'tinymceUndo',
-            AFTER_PASTE: 'tinymcePaste',
-            BEFORE_SET_CONTENT: 'tinymceBeforeSetContent',
-            AFTER_SET_CONTENT: 'tinymceSetContent',
-            AFTER_SAVE: 'tinymceSaveContent',
-            AFTER_OPEN_FILE_BROWSER: 'open_browser_callback',
-            AFTER_FORM_SUBMIT: 'formSubmit',
-            AFTER_BLUR: 'tinymceBlur',
-            AFTER_FOCUS: 'tinymceFocus'
-        },
         mediaBrowserOpener: null,
         mediaBrowserTargetElementId: null,
         magentoVariablesPlugin: null,
@@ -55,13 +43,12 @@ define([
                 'onUndo'
             );
 
-            varienGlobalEvents.attachEventHandler(this.EVENT.AFTER_CONTENT_CHANGE, this.onChangeContent);
-            varienGlobalEvents.attachEventHandler(this.EVENT.BEFORE_SET_CONTENT, this.beforeSetContent);
-            varienGlobalEvents.attachEventHandler(this.EVENT.AFTER_SET_CONTENT, this.updateTextArea);
-            varienGlobalEvents.attachEventHandler(this.EVENT.AFTER_SAVE, this.saveContent);
-            varienGlobalEvents.attachEventHandler(this.EVENT.AFTER_UNDO, this.onUndo);
-            varienGlobalEvents.attachEventHandler(this.EVENT.AFTER_OPEN_FILE_BROWSER, this.openFileBrowser);
-            varienGlobalEvents.attachEventHandler(this.EVENT.AFTER_FORM_SUBMIT, this.onFormValidation);
+            varienGlobalEvents.attachEventHandler('tinymceChange', this.onChangeContent);
+            varienGlobalEvents.attachEventHandler('tinymceBeforeSetContent', this.beforeSetContent);
+            varienGlobalEvents.attachEventHandler('tinymceSetContent', this.updateTextArea);
+            varienGlobalEvents.attachEventHandler('tinymceSaveContent', this.saveContent);
+            varienGlobalEvents.attachEventHandler('tinymceUndo', this.onUndo);
+            varienGlobalEvents.attachEventHandler('open_browser_callback', this.openFileBrowser);
 
             if (typeof tinyMceEditors === 'undefined') {
                 window.tinyMceEditors = $H({});
@@ -124,7 +111,7 @@ define([
                     tinyMCE4.ui.FloatPanel.zIndex = settings.toolbarZIndex;
                 }
 
-                varienGlobalEvents.removeEventHandler(this.EVENT.AFTER_CONTENT_CHANGE, this.onChangeContent);
+                varienGlobalEvents.removeEventHandler('tinymceChange', this.onChangeContent);
             }
 
             jQuery.when.apply(jQuery, deferreds).done(function () {
@@ -186,8 +173,7 @@ define([
          */
         getSettings: function () {
             var settings,
-                eventBus = this.eventBus,
-                wysiwygAdapter = this;
+                eventBus = this.eventBus;
 
             settings = {
                 selector: '#' + this.getId(),
@@ -208,44 +194,44 @@ define([
                     var onChange;
 
                     editor.on('BeforeSetContent', function (evt) {
-                        varienGlobalEvents.fireEvent(wysiwygAdapter.EVENT.BEFORE_SET_CONTENT, evt);
-                        eventBus.fireEvent(wysiwygAdapter.EVENT.BEFORE_SET_CONTENT);
+                        varienGlobalEvents.fireEvent('tinymceBeforeSetContent', evt);
+                        eventBus.fireEvent(wysiwygEvents.beforeSetContent);
                     });
 
                     editor.on('SaveContent', function (evt) {
-                        varienGlobalEvents.fireEvent(wysiwygAdapter.EVENT.AFTER_SAVE, evt);
-                        eventBus.fireEvent(wysiwygAdapter.EVENT.AFTER_SAVE);
+                        varienGlobalEvents.fireEvent('tinymceSaveContent', evt);
+                        eventBus.fireEvent(wysiwygEvents.afterSave);
                     });
 
                     editor.on('paste', function (evt) {
-                        varienGlobalEvents.fireEvent(wysiwygAdapter.EVENT.AFTER_PASTE, evt);
-                        eventBus.fireEvent(wysiwygAdapter.EVENT.AFTER_PASTE);
+                        varienGlobalEvents.fireEvent('tinymcePaste', evt);
+                        eventBus.fireEvent(wysiwygEvents.afterPaste);
                     });
 
                     editor.on('PostProcess', function (evt) {
-                        varienGlobalEvents.fireEvent(wysiwygAdapter.EVENT.AFTER_SAVE, evt);
-                        eventBus.fireEvent(wysiwygAdapter.EVENT.AFTER_SAVE);
+                        varienGlobalEvents.fireEvent('tinymceSaveContent', evt);
+                        eventBus.fireEvent(wysiwygEvents.afterSave);
                     });
 
                     editor.on('undo', function (evt) {
-                        varienGlobalEvents.fireEvent(wysiwygAdapter.EVENT.AFTER_UNDO, evt);
-                        eventBus.fireEvent(wysiwygAdapter.EVENT.AFTER_UNDO);
+                        varienGlobalEvents.fireEvent('tinymceUndo', evt);
+                        eventBus.fireEvent(wysiwygEvents.afterUndo);
                     });
 
                     editor.on('focus', function () {
-                        eventBus.fireEvent(wysiwygAdapter.EVENT.AFTER_FOCUS);
+                        eventBus.fireEvent(wysiwygEvents.afterFocus);
                     });
 
                     editor.on('blur', function () {
-                        eventBus.fireEvent(wysiwygAdapter.EVENT.AFTER_BLUR);
+                        eventBus.fireEvent(wysiwygEvents.afterBlur);
                     });
 
                     /**
                      * @param {*} evt
                      */
                     onChange = function (evt) {
-                        varienGlobalEvents.fireEvent(wysiwygAdapter.EVENT.AFTER_CONTENT_CHANGE, evt);
-                        eventBus.fireEvent(wysiwygAdapter.EVENT.AFTER_CONTENT_CHANGE);
+                        varienGlobalEvents.fireEvent('tinymceChange', evt);
+                        eventBus.fireEvent(wysiwygEvents.afterChangeContent);
                     };
 
                     editor.on('Change', onChange);
@@ -256,8 +242,8 @@ define([
                     });
 
                     editor.on('init', function (args) {
-                        varienGlobalEvents.fireEvent(wysiwygAdapter.EVENT.AFTER_INITIALIZATION, args.target);
-                        eventBus.fireEvent(wysiwygAdapter.EVENT.AFTER_INITIALIZATION);
+                        varienGlobalEvents.fireEvent('wysiwygEditorInitialized', args.target);
+                        eventBus.fireEvent(wysiwygEvents.afterInitialization);
                     });
                 }
             };
@@ -278,12 +264,12 @@ define([
                  * @param {*} w
                  */
                 settings['file_browser_callback'] = function (fieldName, url, objectType, w) {
-                    varienGlobalEvents.fireEvent(this.EVENT.AFTER_OPEN_FILE_BROWSER, {
+                    varienGlobalEvents.fireEvent('open_browser_callback', {
                         win: w,
                         type: objectType,
                         field: fieldName
                     });
-                }.bind(this);
+                };
             }
 
             if (this.config.width) {