test/spec/EditorOptionHandlers-test.js - master - githubmirror/brackets

test/spec/EditorOptionHandlers-test.js
476 строк19 KB
Martin Zagora
fix unit tests because of new sticky flag
22 фев 2017, 04:22
22 фев 2017, 04:22c590f02
/*
 * Copyright (c) 2013 - present Adobe Systems Incorporated. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

/*global describe, afterEach, it, runs, expect, waitsForDone, beforeFirst, afterLast */

define(function (require, exports, module) {
    "use strict";

    // Load dependent modules
    var CommandManager,      // loaded from brackets.test
        Commands,            // loaded from brackets.test
        EditorManager,       // loaded from brackets.test
        DocumentManager,     // loaded from brackets.test
        FileViewController,
        SpecRunnerUtils     = require("spec/SpecRunnerUtils");


    describe("EditorOptionHandlers", function () {
        this.category = "integration";

        var testPath = SpecRunnerUtils.getTestPath("/spec/EditorOptionHandlers-test-files"),
            testWindow;

        var CSS_FILE  = testPath + "/test.css",
            HTML_FILE = testPath + "/test.html",
            JS_FILE   = testPath + "/test.js";

        var OPEN_BRACKET  = 91,
            CLOSE_BRACKET = 93,
            SINGLE_QUOTE  = 39,
            BACKSPACE     = 8;


        beforeFirst(function () {
            // Create a new window that will be shared by ALL tests in this spec.
            SpecRunnerUtils.createTestWindowAndRun(this, function (w) {
                testWindow = w;

                // Load module instances from brackets.test
                CommandManager      = testWindow.brackets.test.CommandManager;
                Commands            = testWindow.brackets.test.Commands;
                EditorManager       = testWindow.brackets.test.EditorManager;
                DocumentManager     = testWindow.brackets.test.DocumentManager;
                FileViewController  = testWindow.brackets.test.FileViewController;

                SpecRunnerUtils.loadProjectInTestWindow(testPath);
            });
        });

        afterLast(function () {
            testWindow          = null;
            CommandManager      = null;
            Commands            = null;
            EditorManager       = null;
            DocumentManager     = null;
            FileViewController  = null;
            SpecRunnerUtils.closeTestWindow();
        });


        afterEach(function () {
            testWindow.closeAllFiles();
        });

        // Helper functions for testing cursor position / selection range
        function fixPos(pos) {
            if (!("sticky" in pos)) {
                pos.sticky = null;
            }
            return pos;
        }
        function fixSel(sel) {
            fixPos(sel.start);
            fixPos(sel.end);
            if (!("reversed" in sel)) {
                sel.reversed = false;
            }
            return sel;
        }

        function checkLineWrapping(editor, firstPos, secondPos, shouldWrap) {
            runs(function () {
                var firstLineBottom, nextLineBottom;

                expect(editor).toBeTruthy();

                editor.setCursorPos(firstPos);
                firstLineBottom = editor._codeMirror.cursorCoords(null, "local").bottom;

                editor.setCursorPos(secondPos);
                nextLineBottom = editor._codeMirror.cursorCoords(null, "local").bottom;

                if (shouldWrap) {
                    expect(firstLineBottom).toBeLessThan(nextLineBottom);
                } else {
                    expect(firstLineBottom).toEqual(nextLineBottom);
                }
            });
        }

        function checkActiveLine(editor, line, shouldShow) {
            runs(function () {
                var lineInfo;

                expect(editor).toBeTruthy();
                editor.setCursorPos({line: line, ch: 0});
                lineInfo = editor._codeMirror.lineInfo(line);

                if (shouldShow) {
                    expect(lineInfo.wrapClass).toBe("CodeMirror-activeline");
                } else {
                    expect(lineInfo.wrapClass).toBeUndefined();
                }
            });
        }

        function checkActiveLineOption(editor, shouldBe) {
            runs(function () {
                expect(editor).toBeTruthy();
                expect(editor._codeMirror.getOption("styleActiveLine")).toBe(shouldBe);
            });
        }

        function checkLineNumbers(editor, shouldShow) {
            runs(function () {
                var gutterElement, $lineNumbers;

                expect(editor).toBeTruthy();
                gutterElement = editor._codeMirror.getGutterElement();
                $lineNumbers = $(gutterElement).find(".CodeMirror-linenumbers");

                if (shouldShow) {
                    expect($lineNumbers.length).toNotBe(0);
                } else {
                    expect($lineNumbers.length).toBe(0);
                }
            });
        }

        function checkCloseBraces(editor, startSel, endSel, keyCode, expectedText) {
            runs(function () {
                var input, line;

                expect(editor).toBeTruthy();
                input = editor._codeMirror.getInputField();

                if (endSel) {
                    editor.setSelection(startSel, endSel);
                } else {
                    editor.setCursorPos(startSel);
                }

                SpecRunnerUtils.simulateKeyEvent(keyCode, keyCode === BACKSPACE ? "keydown" : "keypress", input);

                line = editor._codeMirror.getLine(startSel.line);
                expect(line).toBe(expectedText);
            });
        }


        // Helper functions to open editors / toggle options
        function openEditor(fullPath) {
            runs(function () {
                var promise = CommandManager.execute(Commands.CMD_ADD_TO_WORKINGSET_AND_OPEN, {fullPath: fullPath});
                waitsForDone(promise, "Open into working set");
            });
        }

        function openAnotherEditor(fullpath) {
            runs(function () {
                // Open another document and bring it to the front
                waitsForDone(FileViewController.openAndSelectDocument(fullpath, FileViewController.PROJECT_MANAGER),
                             "FILE_OPEN on file timeout", 1000);
            });
        }

        function openInlineEditor(toggleEditorAt) {
            toggleEditorAt = toggleEditorAt || {line: 8, ch: 11};
            openEditor(HTML_FILE);

            runs(function () {
                // Open inline editor onto test.css's ".testClass" rule
                var promise = SpecRunnerUtils.toggleQuickEditAtOffset(EditorManager.getCurrentFullEditor(), toggleEditorAt);
                waitsForDone(promise, "Open inline editor");
            });
        }

        function toggleOption(commandID, text) {
            runs(function () {
                var promise = CommandManager.execute(commandID);
                waitsForDone(promise, text);
            });
        }


        describe("Toggle Word Wrap", function () {
            it("should wrap long lines in main editor by default", function () {
                openEditor(HTML_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();

                    // Use two cursor positions to detect line wrapping. First position at
                    // the beginning of a long line and the second position to be
                    // somewhere on the long line that will be part of an extra line
                    // created by word-wrap and get its bottom coordinate.
                    checkLineWrapping(editor, {line: 8, ch: 0}, {line: 8, ch: 320}, true);
                });
            });

            it("should also wrap long lines in inline editor by default", function () {
                openInlineEditor();

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor().getInlineWidgets()[0].editor;
                    checkLineWrapping(editor, {line: 0, ch: 0}, {line: 0, ch: 320}, true);
                });
            });

            it("should NOT wrap the long lines after turning off word-wrap", function () {
                // Turn off word-wrap
                toggleOption(Commands.TOGGLE_WORD_WRAP, "Toggle word-wrap");
                openEditor(CSS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkLineWrapping(editor, {line: 0, ch: 1}, {line: 0, ch: 180}, false);
                });
            });

            it("should NOT wrap the long lines in another document when word-wrap off", function () {
                openEditor(CSS_FILE);
                openAnotherEditor(HTML_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkLineWrapping(editor, {line: 8, ch: 0}, {line: 8, ch: 210}, false);
                });
            });
        });


        describe("Toggle Active Line", function () {
            it("should NOT show active line in main editor by default", function () {
                openEditor(HTML_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkActiveLine(editor, 5, false);
                });
            });

            it("should NOT show active line in inline editor by default", function () {
                openInlineEditor();

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor().getInlineWidgets()[0].editor;
                    checkActiveLine(editor, 0, false);
                });
            });

            it("should style active line after turning it on", function () {
                // Turn on show active line
                toggleOption(Commands.TOGGLE_ACTIVE_LINE, "Toggle active line");
                openEditor(CSS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkActiveLine(editor, 0, true);
                });
            });

            it("should have the active line option be FALSE when the editor has a selection", function () {
                openEditor(CSS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    editor.setSelection({line: 0, ch: 0}, {line: 0, ch: 1});
                    checkActiveLineOption(editor, false);
                });
            });

            it("should style the active line when opening another document with show active line on", function () {
                openEditor(CSS_FILE);
                openAnotherEditor(HTML_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkActiveLine(editor, 3, true);
                });
            });
        });


        describe("Toggle Line Numbers", function () {
            it("should show line numbers in main editor by default", function () {
                openEditor(HTML_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkLineNumbers(editor, true);
                });
            });

            it("should also show line numbers in inline editor by default", function () {
                openInlineEditor();

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor().getInlineWidgets()[0].editor;
                    checkLineNumbers(editor, true);
                });
            });

            it("should NOT show line numbers in main editor after turning it off", function () {
                // Turn off show line numbers
                toggleOption(Commands.TOGGLE_LINE_NUMBERS, "Toggle line numbers");
                openEditor(CSS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkLineNumbers(editor, false);
                });
            });

            it("should NOT show line numbers in inline editor after turning it off", function () {
                openInlineEditor();

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor().getInlineWidgets()[0].editor;
                    checkLineNumbers(editor, false);
                });
            });

            it("should NOT show line numbers when opening another document with show line numbers off", function () {
                openEditor(CSS_FILE);
                openAnotherEditor(HTML_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkLineNumbers(editor, false);
                });
            });
        });


        describe("Toggle Auto Close Braces", function () {
            it("should auto close braces in main editor by default", function () {
                openEditor(JS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkCloseBraces(editor, {line: 0, ch: 35}, null, OPEN_BRACKET, "var myContent = \"This is awesome!\";[]");
                });
            });

            it("should auto close braces in inline editor by default", function () {
                openInlineEditor({line: 9, ch: 11});

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor().getInlineWidgets()[0].editor;
                    checkCloseBraces(editor, {line: 1, ch: 32}, null, OPEN_BRACKET, ".shortLineClass { color: red; }[]");
                });
            });

            it("should NOT auto close braces in the main editor after turning it on", function () {
                // Turn off auto close braces
                toggleOption(Commands.TOGGLE_CLOSE_BRACKETS, "Toggle auto close braces");
                openEditor(JS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkCloseBraces(editor, {line: 0, ch: 35}, null, OPEN_BRACKET, "var myContent = \"This is awesome!\";");
                });
            });

            it("should NOT auto close braces in inline editor after turning it on", function () {
                openInlineEditor({line: 9, ch: 11});

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor().getInlineWidgets()[0].editor;
                    checkCloseBraces(editor, {line: 1, ch: 15}, null, OPEN_BRACKET, ".shortLineClass { color: red; }");
                });
            });

            it("should auto close braces when opening another document with auto close braces on", function () {
                toggleOption(Commands.TOGGLE_CLOSE_BRACKETS, "Toggle auto close braces");
                openEditor(CSS_FILE);
                openAnotherEditor(JS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkCloseBraces(editor, {line: 0, ch: 35}, null, OPEN_BRACKET, "var myContent = \"This is awesome!\";[]");
                });
            });

            it("should only auto close braces before spaces, closing braces or end of lines", function () {
                openEditor(JS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkCloseBraces(editor, {line: 0, ch: 0}, null, OPEN_BRACKET, "var myContent = \"This is awesome!\";");
                    checkCloseBraces(editor, {line: 0, ch: 15}, null, OPEN_BRACKET, "var myContent =[] \"This is awesome!\";");
                    checkCloseBraces(editor, {line: 0, ch: 16}, null, OPEN_BRACKET, "var myContent =[[]] \"This is awesome!\";");
                    checkCloseBraces(editor, {line: 0, ch: 39}, null, OPEN_BRACKET, "var myContent =[[]] \"This is awesome!\";[]");
                });
            });

            it("should overwrite a close brace when writing a close brace before the same close brace", function () {
                openEditor(JS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkCloseBraces(editor, {line: 0, ch: 15}, null, OPEN_BRACKET, "var myContent =[] \"This is awesome!\";");
                    checkCloseBraces(editor, {line: 0, ch: 16}, null, CLOSE_BRACKET, "var myContent =[] \"This is awesome!\";");

                    runs(function () {
                        expect(fixPos(editor.getCursorPos())).toEqual(fixPos({line: 0, ch: 17}));
                    });
                });
            });

            it("should wrap a selection between braces", function () {
                openEditor(JS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkCloseBraces(editor, {line: 0, ch: 16}, {line: 0, ch: 34}, OPEN_BRACKET, "var myContent = [\"This is awesome!\"];");

                    runs(function () {
                        expect(fixSel(editor.getSelection())).toEqual(fixSel({start: {line: 0, ch: 17}, end: {line: 0, ch: 35}}));
                    });
                });
            });

            it("should delete both open and close braces when both are together and backspacing", function () {
                openEditor(JS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkCloseBraces(editor, {line: 0, ch: 15}, null, OPEN_BRACKET, "var myContent =[] \"This is awesome!\";");
                    checkCloseBraces(editor, {line: 0, ch: 16}, null, BACKSPACE, "var myContent = \"This is awesome!\";");
                });
            });

            it("should NOT auto close single quotes inside comments", function () {
                openEditor(JS_FILE);

                runs(function () {
                    var editor = EditorManager.getCurrentFullEditor();
                    checkCloseBraces(editor, {line: 0, ch: 15}, null, SINGLE_QUOTE, "var myContent ='' \"This is awesome!\";");
                    checkCloseBraces(editor, {line: 1, ch: 7}, null, SINGLE_QUOTE, "// Yes, it is!");
                });
            });
        });
    });
});