refactor mock editors into SpecRunnerUtils

Author: jasonsanjose

test/spec/Editor-test.js

@@ -35,26 +35,18 @@ define(function (require, exports, module) {
 
     describe("Editor", function () {
         var defaultContent = 'Brackets is going to be awesome!\n';
-        var myDocument, myEditor, $editorHolder;
+        var myDocument, myEditor;
 
         function createTestEditor(content, mode) {
-            // Initialize EditorManager
-            $editorHolder = $("<div id='editor-holder'/>");
-            EditorManager._init();
-            EditorManager.setEditorHolder($editorHolder);
-            $("body").append($editorHolder);
-            
-            // create dummy Document for the Editor
-            myDocument = SpecRunnerUtils.createMockDocument(content);
-            
-            // create Editor instance
-            myEditor = new Editor(myDocument, true, mode, $editorHolder.get(0), {});
+            // create dummy Document and Editor
+            var mocks = SpecRunnerUtils.createMockEditor(content, mode);
+            myDocument = mocks.doc;
+            myEditor = mocks.editor;
         }
 
         afterEach(function () {
             if (myEditor) {
-                EditorManager._destroyEditorIfUnneeded(myDocument);
-                $editorHolder.remove();
+                SpecRunnerUtils.destroyMockEditor(myDocument);
                 myEditor = null;
                 myDocument = null;
             }

test/spec/EditorCommandHandlers-test.js

@@ -46,25 +46,18 @@ define(function (require, exports, module) {
                              "\n" +
                              "}";
 
-        var myDocument, myEditor, $editorHolder;
+        var myDocument, myEditor;
         beforeEach(function () {
-            // Initialize EditorManager
-            $editorHolder = $("<div id='editor-holder'/>");
-            EditorManager._init();
-            EditorManager.setEditorHolder($editorHolder);
-            $("body").append($editorHolder);
-
-            // create dummy Document for the Editor
-            myDocument = SpecRunnerUtils.createMockDocument(defaultContent);
-
-            // create Editor instance (containing a CodeMirror instance)
-            myEditor = new Editor(myDocument, true, "javascript", $editorHolder.get(0), {});
+            // create dummy Document and Editor
+            var mocks = SpecRunnerUtils.createMockEditor(defaultContent, "javascript");
+            myDocument = mocks.doc;
+            myEditor = mocks.editor;
+            
             myEditor.focus();
         });
 
         afterEach(function () {
-            EditorManager._destroyEditorIfUnneeded(myDocument);
-            $editorHolder.remove();
+            SpecRunnerUtils.destroyMockEditor(myDocument);
             myEditor = null;
             myDocument = null;
         });

test/spec/MultiRangeInlineEditor-test.js

@@ -43,19 +43,14 @@ define(function (require, exports, module) {
             doc;
 
         beforeEach(function () {
-            // init Editor instance (containing a CodeMirror instance)
-            $editorHolder = $("<div id='editor-holder'/>");
-            EditorManager._init();
-            EditorManager.setEditorHolder($editorHolder);
-            $("body").append($editorHolder);
-            
-            doc = SpecRunnerUtils.createMockDocument("hostEditor");
-            hostEditor = new Editor(doc, true, "", $editorHolder.get(0), {});
+            // create dummy Document and Editor
+            var mocks = SpecRunnerUtils.createMockEditor("hostEditor", "");
+            doc = mocks.doc;
+            hostEditor = mocks.editor;
         });
 
         afterEach(function () {
-            EditorManager._destroyEditorIfUnneeded(doc);
-            $editorHolder.remove();
+            SpecRunnerUtils.destroyMockEditor(doc);
             hostEditor = null;
         });
 

test/spec/SpecRunnerUtils.js

@@ -32,6 +32,8 @@ define(function (require, exports, module) {
         FileUtils           = require("file/FileUtils"),
         Async               = require("utils/Async"),
         DocumentManager     = require("document/DocumentManager"),
+        Editor              = require("editor/Editor").Editor,
+        EditorManager       = require("editor/EditorManager"),
         UrlParams           = require("utils/UrlParams").UrlParams;
 
     var TEST_PREFERENCES_KEY    = "com.adobe.brackets.test.preferences",
@@ -90,12 +92,11 @@ define(function (require, exports, module) {
         }, "failure " + operationName, 1000);
     };
 
-    
     /**
      * Returns a Document suitable for use with an Editor in isolation: i.e., a Document that will
      * never be set as the currentDocument or added to the working set.
      */
-    function createMockDocument(initialContent) {
+    function createMockDocument(initialContent, createEditor) {
         // Use unique filename to avoid collissions in open documents list
         var dummyFile = new NativeFileSystem.FileEntry("_unitTestDummyFile_.js");
 
@@ -120,6 +121,39 @@ define(function (require, exports, module) {
         };
         return docToShim;
     }
+    
+    /**
+     * Returns a Document and Editor suitable for use with an Editor in
+     * isolation: i.e., a Document that will never be set as the
+     * currentDocument or added to the working set.
+     * @return {!{doc:{Document}, editor:{Editor}}}
+     */
+    function createMockEditor(initialContent, mode) {
+        mode = mode || "";
+        
+        // Initialize EditorManager
+        var $editorHolder = $("<div id='mock-editor-holder'/>");
+        EditorManager._init();
+        EditorManager.setEditorHolder($editorHolder);
+        $("body").append($editorHolder);
+        
+        // create dummy Document for the Editor
+        var doc = createMockDocument(initialContent);
+        
+        // create Editor instance
+        var editor = new Editor(doc, true, mode, $editorHolder.get(0), {});
+        
+        return { doc: doc, editor: editor };
+    }
+    
+    /**
+     * Destroy the Editor instance for a given mock Document.
+     * @param {!Document} doc
+     */
+    function destroyMockEditor(doc) {
+        EditorManager._destroyEditorIfUnneeded(doc);
+        $("#mock-editor-holder").remove();
+    }
 
     function createTestWindowAndRun(spec, callback) {
         runs(function () {
@@ -554,9 +588,11 @@ define(function (require, exports, module) {
     exports.getBracketsSourceRoot           = getBracketsSourceRoot;
     exports.makeAbsolute                    = makeAbsolute;
     exports.createMockDocument              = createMockDocument;
+    exports.createMockEditor                = createMockEditor;
     exports.createTestWindowAndRun          = createTestWindowAndRun;
     exports.closeTestWindow                 = closeTestWindow;
     exports.clickDialogButton               = clickDialogButton;
+    exports.destroyMockEditor               = destroyMockEditor;
     exports.loadProjectInTestWindow         = loadProjectInTestWindow;
     exports.openProjectFiles                = openProjectFiles;
     exports.toggleQuickEditAtOffset         = toggleQuickEditAtOffset;