test: add test for editor

Author: oterral

package.json

@@ -21,6 +21,7 @@
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-prettier": "5.1.3",
     "fixpack": "4.0.0",
+    "happy-dom": "^14.10.1",
     "husky": "9.0.11",
     "is-ci": "3.0.1",
     "jsdoc": "4.0.3",

src/control/cad.js

@@ -62,7 +62,7 @@ class CadControl extends Control {
    * @param {ol.style.Style.StyleLike} [options.linesStyle] Style used for the lines layer.
    *
    */
-  constructor(options) {
+  constructor(options = {}) {
     super({
       title: 'CAD control',
       className: 'ole-control-cad',

src/editor.js

@@ -59,6 +59,8 @@ class Editor {
     if (this.options.showToolbar) {
       this.toolbar = new Toolbar(this.map, this.controls, this.options.target);
     }
+
+    this.activeStateChange = this.activeStateChange.bind(this);
   }
 
   /**
@@ -68,9 +70,7 @@ class Editor {
   addControl(control) {
     control.setMap(this.map);
     control.setEditor(this);
-
     control.addEventListener('change:active', this.activeStateChange);
-
     this.controls.push(control);
   }
 
@@ -79,13 +79,11 @@ class Editor {
    * @param {ole.Control} control The control.
    */
   removeControl(control) {
-    control.deactivate(true);
-    control.setMap(null);
-    control.setEditor(null);
-    control.removeEventListener('change:active', this.activeStateChange);
-
+    control.deactivate();
     this.controls.remove(control);
-    this.activeControls.remove(control);
+    control.removeEventListener('change:active', this.activeStateChange);
+    control.setEditor();
+    control.setMap();
   }
 
   /**
@@ -115,8 +113,9 @@ class Editor {
    * Removes the editor from the map.
    */
   remove() {
-    this.controls.forEach((c) => {
-      c.deactivate(true);
+    const controls = [...this.controls.getArray()];
+    controls.forEach((control) => {
+      control.removeControl(control);
     });
     if (this.toolbar) {
       this.toolbar.destroy();
@@ -182,8 +181,8 @@ class Editor {
    * @param {ol.control.Control} control Control.
    * @private
    */
-  activeStateChange = (e) => {
-    const ctrl = e.detail.control;
+  activeStateChange(evt) {
+    const ctrl = evt.detail.control;
     // Deactivate other controls that are not standalone
     if (ctrl.getActive() && ctrl.standalone) {
       for (let i = 0; i < this.controls.getLength(); i += 1) {
@@ -204,7 +203,7 @@ class Editor {
     } else {
       this.activeControls.remove(ctrl);
     }
-  };
+  }
 }
 
 export default Editor;

src/editor.test.js

@@ -0,0 +1,47 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import { expect, test, describe, beforeEach } from 'vitest';
+import Map from 'ol/Map';
+import Editor from './editor';
+import CAD from './control/cad';
+
+describe('editor', () => {
+  let map;
+  let editor;
+  let cad;
+
+  beforeEach(() => {
+    // In the test we use pixel as coordinates.
+    map = new Map({
+      target: document.createElement('div'),
+    });
+    editor = new Editor(map);
+    cad = new CAD();
+  });
+
+  test('adds a control', () => {
+    editor.addControl(cad);
+    expect(editor.controls.getArray()[0]).toBe(cad);
+    expect(editor.activeControls.getLength()).toBe(0);
+    expect(cad.map).toBe(map);
+    expect(cad.editor).toBe(editor);
+    expect(cad.getActive()).toBe();
+
+    cad.activate();
+    expect(cad.getActive()).toBe(true);
+    expect(editor.activeControls.getArray()[0]).toBe(cad);
+  });
+
+  test('removes a control', () => {
+    editor.addControl(cad);
+    cad.activate();
+    expect(cad.getActive()).toBe(true);
+    expect(editor.controls.getArray()[0]).toBe(cad);
+    expect(editor.activeControls.getArray()[0]).toBe(cad);
+    editor.removeControl(cad);
+    expect(editor.controls.getLength()).toBe(0);
+    expect(editor.activeControls.getLength()).toBe(0);
+    expect(cad.map).toBe();
+    expect(cad.editor).toBe();
+    expect(cad.getActive()).toBe(false);
+  });
+});

vitest.config.mjs

@@ -0,0 +1,8 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    environment: 'happy-dom',
+  },
+});

yarn.lock

@@ -1971,7 +1971,7 @@ enquirer@^2.3.6:
   dependencies:
     ansi-colors "^4.1.1"
 
-entities@^4.4.0:
+entities@^4.4.0, entities@^4.5.0:
   version "4.5.0"
   resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48"
   integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==
@@ -3032,6 +3032,15 @@ handlebars@^4.7.7:
   optionalDependencies:
     uglify-js "^3.1.4"
 
+happy-dom@^14.10.1:
+  version "14.10.1"
+  resolved "https://registry.yarnpkg.com/happy-dom/-/happy-dom-14.10.1.tgz#fd2445489722c3363223109bb9e465409a8e1cb7"
+  integrity sha512-GRbrZYIezi8+tTtffF4v2QcF8bk1h2loUTO5VYQz3GZdrL08Vk0fI+bwf/vFEBf4C/qVf/easLJ/MY1wwdhytA==
+  dependencies:
+    entities "^4.5.0"
+    webidl-conversions "^7.0.0"
+    whatwg-mimetype "^3.0.0"
+
 hard-rejection@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/hard-rejection/-/hard-rejection-2.1.0.tgz#1c6eda5c1685c63942766d79bb40ae773cecd883"
@@ -5905,6 +5914,16 @@ web-worker@^1.2.0:
   resolved "https://registry.yarnpkg.com/web-worker/-/web-worker-1.2.0.tgz#5d85a04a7fbc1e7db58f66595d7a3ac7c9c180da"
   integrity sha512-PgF341avzqyx60neE9DD+XS26MMNMoUQRz9NOZwW32nPQrF6p77f1htcnjBSEV8BGMKZ16choqUG4hyI0Hx7mA==
 
+webidl-conversions@^7.0.0:
+  version "7.0.0"
+  resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-7.0.0.tgz#256b4e1882be7debbf01d05f0aa2039778ea080a"
+  integrity sha512-VwddBukDzu71offAQR975unBIGqfKZpM+8ZX6ySk8nYhVoo5CYaZyzt3YBvYtRtO+aoGlqxPg/B87NGVZ/fu6g==
+
+whatwg-mimetype@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/whatwg-mimetype/-/whatwg-mimetype-3.0.0.tgz#5fa1a7623867ff1af6ca3dc72ad6b8a4208beba7"
+  integrity sha512-nt+N2dzIutVRxARx1nghPKGv1xHikU7HKdfafKkLNLindmPU/ch3U31NOCGGA/dmPcmb1VlofO0vnKAcsm0o/Q==
+
 which-boxed-primitive@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz#13757bc89b209b049fe5d86430e21cf40a89a8e6"