mirror of
https://github.com/google/blockly.git
synced 2026-01-08 01:20:12 +01:00
ce22f42868
* chore(deps): Add pretter-plugin-organize-imports * chore: Remove insignificant blank lines in import sections Since prettier-plugin-organize-imports sorts imports within sections separated by blank lines, but preserves the section divisions, remove any blank lines that are not dividing imports into meaningful sections. Do not remove blank lines separating side-effect-only imports from main imports. * chore: Remove unneded eslint-disable directives * chore: Organise imports
451 lines
16 KiB
JavaScript
451 lines
16 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import {assert} from '../../node_modules/chai/chai.js';
|
|
import {
|
|
sharedTestSetup,
|
|
sharedTestTeardown,
|
|
} from './test_helpers/setup_teardown.js';
|
|
import {createKeyDownEvent} from './test_helpers/user_input.js';
|
|
|
|
suite('Keyboard Shortcut Registry Test', function () {
|
|
setup(function () {
|
|
sharedTestSetup.call(this);
|
|
this.registry = Blockly.ShortcutRegistry.registry;
|
|
this.registry.reset();
|
|
Blockly.ShortcutItems.registerDefaultShortcuts();
|
|
});
|
|
teardown(function () {
|
|
sharedTestTeardown.call(this);
|
|
});
|
|
|
|
suite('Registering', function () {
|
|
test('Registering a shortcut', function () {
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
this.registry.register(testShortcut, true);
|
|
const shortcut = this.registry.getRegistry()['test_shortcut'];
|
|
assert.equal(shortcut.name, 'test_shortcut');
|
|
});
|
|
test('Registers shortcut with same name', function () {
|
|
const registry = this.registry;
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
|
|
registry.register(testShortcut);
|
|
|
|
const shouldThrow = function () {
|
|
registry.register(testShortcut);
|
|
};
|
|
assert.throws(
|
|
shouldThrow,
|
|
Error,
|
|
'Shortcut named "test_shortcut" already exists.',
|
|
);
|
|
});
|
|
test('Registers shortcut with same name opt_allowOverrides=true', function () {
|
|
const registry = this.registry;
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
const otherShortcut = {
|
|
'name': 'test_shortcut',
|
|
'callback': function () {},
|
|
};
|
|
|
|
registry.register(testShortcut);
|
|
|
|
const shouldNotThrow = function () {
|
|
registry.register(otherShortcut, true);
|
|
};
|
|
assert.doesNotThrow(shouldNotThrow);
|
|
assert.exists(registry.getRegistry()['test_shortcut'].callback);
|
|
});
|
|
test('Registering a shortcut with keycodes', function () {
|
|
const shiftA = this.registry.createSerializedKey('65', [
|
|
Blockly.ShortcutRegistry.modifierKeys.Shift,
|
|
]);
|
|
const testShortcut = {
|
|
'name': 'test_shortcut',
|
|
'keyCodes': ['65', 66, shiftA],
|
|
};
|
|
this.registry.register(testShortcut, true);
|
|
assert.lengthOf(this.registry.getKeyMap()[shiftA], 1);
|
|
assert.lengthOf(this.registry.getKeyMap()['65'], 1);
|
|
assert.lengthOf(this.registry.getKeyMap()['66'], 1);
|
|
});
|
|
test('Registering a shortcut with allowCollision', function () {
|
|
const testShortcut = {
|
|
'name': 'test_shortcut',
|
|
'keyCodes': ['65'],
|
|
};
|
|
const duplicateShortcut = {
|
|
'name': 'duplicate_shortcut',
|
|
'keyCodes': ['65'],
|
|
'allowCollision': true,
|
|
};
|
|
this.registry.register(testShortcut);
|
|
const registry = this.registry;
|
|
const shouldNotThrow = function () {
|
|
registry.register(duplicateShortcut);
|
|
};
|
|
assert.doesNotThrow(shouldNotThrow);
|
|
});
|
|
});
|
|
|
|
suite('Unregistering', function () {
|
|
test('Unregistering a shortcut', function () {
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
this.registry.register(testShortcut);
|
|
assert.isOk(this.registry.getRegistry()['test_shortcut']);
|
|
this.registry.unregister('test_shortcut');
|
|
assert.isUndefined(this.registry.getRegistry()['test_shortcut']);
|
|
});
|
|
test('Unregistering a nonexistent shortcut', function () {
|
|
const consoleStub = sinon.stub(console, 'warn');
|
|
assert.isUndefined(this.registry.getRegistry['test']);
|
|
|
|
const registry = this.registry;
|
|
assert.isFalse(registry.unregister('test'));
|
|
sinon.assert.calledOnceWithExactly(
|
|
consoleStub,
|
|
'Keyboard shortcut named "test" not found.',
|
|
);
|
|
});
|
|
test('Unregistering a shortcut with key mappings', function () {
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
this.registry.register(testShortcut);
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut');
|
|
|
|
this.registry.unregister('test_shortcut');
|
|
|
|
const shortcut = this.registry.getRegistry()['test_shortcut'];
|
|
const keyMappings = this.registry.getKeyMap()['keyCode'];
|
|
assert.isUndefined(shortcut);
|
|
assert.isUndefined(keyMappings);
|
|
});
|
|
test('Unregistering a shortcut with colliding key mappings', function () {
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
const otherShortcut = {'name': 'other_shortcut'};
|
|
this.registry.register(testShortcut);
|
|
this.registry.register(otherShortcut);
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut');
|
|
this.registry.addKeyMapping('keyCode', 'other_shortcut', true);
|
|
|
|
this.registry.unregister('test_shortcut');
|
|
|
|
const shortcut = this.registry.getRegistry()['test_shortcut'];
|
|
const keyMappings = this.registry.getKeyMap()['keyCode'];
|
|
assert.lengthOf(keyMappings, 1);
|
|
assert.isUndefined(shortcut);
|
|
});
|
|
});
|
|
|
|
suite('addKeyMapping', function () {
|
|
test('Adds a key mapping', function () {
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
this.registry.register(testShortcut);
|
|
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut');
|
|
|
|
const shortcutNames = this.registry.getKeyMap()['keyCode'];
|
|
assert.lengthOf(shortcutNames, 1);
|
|
assert.equal(shortcutNames[0], 'test_shortcut');
|
|
});
|
|
test('Adds a colliding key mapping - opt_allowCollision=true', function () {
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
const testShortcut2 = {'name': 'test_shortcut_2'};
|
|
this.registry.register(testShortcut);
|
|
this.registry.register(testShortcut2);
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut_2');
|
|
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut', true);
|
|
|
|
const shortcutNames = this.registry.getKeyMap()['keyCode'];
|
|
assert.lengthOf(shortcutNames, 2);
|
|
assert.equal(shortcutNames[0], 'test_shortcut');
|
|
assert.equal(shortcutNames[1], 'test_shortcut_2');
|
|
});
|
|
test('Adds a colliding key mapping - opt_allowCollision=false', function () {
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
const testShortcut2 = {'name': 'test_shortcut_2'};
|
|
this.registry.register(testShortcut);
|
|
this.registry.register(testShortcut2);
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut_2');
|
|
|
|
const registry = this.registry;
|
|
const shouldThrow = function () {
|
|
registry.addKeyMapping('keyCode', 'test_shortcut');
|
|
};
|
|
assert.throws(
|
|
shouldThrow,
|
|
Error,
|
|
'Shortcut named "test_shortcut" collides with shortcuts "test_shortcut_2"',
|
|
);
|
|
});
|
|
});
|
|
|
|
suite('removeKeyMapping', function () {
|
|
test('Removes a key mapping', function () {
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
const testShortcut2 = {'name': 'test_shortcut_2'};
|
|
this.registry.register(testShortcut);
|
|
this.registry.register(testShortcut2);
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut_2');
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut', true);
|
|
|
|
const isRemoved = this.registry.removeKeyMapping(
|
|
'keyCode',
|
|
'test_shortcut',
|
|
);
|
|
|
|
const shortcutNames = this.registry.getKeyMap()['keyCode'];
|
|
assert.lengthOf(shortcutNames, 1);
|
|
assert.equal(shortcutNames[0], 'test_shortcut_2');
|
|
assert.isTrue(isRemoved);
|
|
});
|
|
test('Removes last key mapping for a key', function () {
|
|
const testShortcut = {'name': 'test_shortcut'};
|
|
this.registry.register(testShortcut);
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut');
|
|
|
|
this.registry.removeKeyMapping('keyCode', 'test_shortcut');
|
|
|
|
const shortcutNames = this.registry.getKeyMap()['keyCode'];
|
|
assert.isUndefined(shortcutNames);
|
|
});
|
|
test('Removes a key map that does not exist opt_quiet=false', function () {
|
|
const consoleStub = sinon.stub(console, 'warn');
|
|
const testShortcut = {'name': 'test_shortcut_2'};
|
|
this.registry.register(testShortcut);
|
|
this.registry.addKeyMapping('keyCode', 'test_shortcut_2');
|
|
|
|
const isRemoved = this.registry.removeKeyMapping(
|
|
'keyCode',
|
|
'test_shortcut',
|
|
);
|
|
|
|
assert.isFalse(isRemoved);
|
|
sinon.assert.calledOnceWithExactly(
|
|
consoleStub,
|
|
'No keyboard shortcut named "test_shortcut" registered with key code "keyCode"',
|
|
);
|
|
});
|
|
test('Removes a key map that does not exist from empty key mapping opt_quiet=false', function () {
|
|
const consoleStub = sinon.stub(console, 'warn');
|
|
|
|
const isRemoved = this.registry.removeKeyMapping(
|
|
'keyCode',
|
|
'test_shortcut',
|
|
);
|
|
|
|
assert.isFalse(isRemoved);
|
|
sinon.assert.calledOnceWithExactly(
|
|
consoleStub,
|
|
'No keyboard shortcut named "test_shortcut" registered with key code "keyCode"',
|
|
);
|
|
});
|
|
});
|
|
|
|
suite('Setters/Getters', function () {
|
|
test('Sets the key map', function () {
|
|
this.registry.setKeyMap({'keyCode': ['test_shortcut']});
|
|
assert.equal(Object.keys(this.registry.getKeyMap()).length, 1);
|
|
assert.equal(this.registry.getKeyMap()['keyCode'][0], 'test_shortcut');
|
|
});
|
|
test('Gets a copy of the key map', function () {
|
|
this.registry.setKeyMap({'keyCode': ['a']});
|
|
const keyMapCopy = this.registry.getKeyMap();
|
|
keyMapCopy['keyCode'] = ['b'];
|
|
assert.equal(this.registry.getKeyMap()['keyCode'][0], 'a');
|
|
});
|
|
test('Gets a copy of the registry', function () {
|
|
const shortcut = {'name': 'shortcutName'};
|
|
this.registry.register(shortcut);
|
|
const registrycopy = this.registry.getRegistry();
|
|
registrycopy['shortcutName']['name'] = 'shortcutName1';
|
|
assert.equal(
|
|
this.registry.getRegistry()['shortcutName']['name'],
|
|
'shortcutName',
|
|
);
|
|
});
|
|
test('Gets keyboard shortcuts from a key code', function () {
|
|
this.registry.setKeyMap({'keyCode': ['shortcutName']});
|
|
const shortcutNames = this.registry.getShortcutNamesByKeyCode('keyCode');
|
|
assert.equal(shortcutNames[0], 'shortcutName');
|
|
});
|
|
test('Gets keycodes by shortcut name', function () {
|
|
this.registry.setKeyMap({
|
|
'keyCode': ['shortcutName'],
|
|
'keyCode1': ['shortcutName'],
|
|
});
|
|
const shortcutNames =
|
|
this.registry.getKeyCodesByShortcutName('shortcutName');
|
|
assert.lengthOf(shortcutNames, 2);
|
|
assert.equal(shortcutNames[0], 'keyCode');
|
|
assert.equal(shortcutNames[1], 'keyCode1');
|
|
});
|
|
});
|
|
|
|
suite('onKeyDown', function () {
|
|
function addShortcut(registry, shortcut, keyCode, returns) {
|
|
registry.register(shortcut, true);
|
|
registry.addKeyMapping(keyCode, shortcut.name, true);
|
|
return sinon.stub(shortcut, 'callback').returns(returns);
|
|
}
|
|
|
|
setup(function () {
|
|
this.testShortcut = {
|
|
'name': 'test_shortcut',
|
|
'callback': function () {
|
|
return true;
|
|
},
|
|
'precondition': function () {
|
|
return true;
|
|
},
|
|
};
|
|
this.callBackStub = addShortcut(
|
|
this.registry,
|
|
this.testShortcut,
|
|
Blockly.utils.KeyCodes.C,
|
|
true,
|
|
);
|
|
});
|
|
test('Execute a shortcut from event', function () {
|
|
const event = createKeyDownEvent(Blockly.utils.KeyCodes.C);
|
|
assert.isTrue(this.registry.onKeyDown(this.workspace, event));
|
|
sinon.assert.calledOnce(this.callBackStub);
|
|
});
|
|
test('No shortcut executed from event', function () {
|
|
const event = createKeyDownEvent(Blockly.utils.KeyCodes.D);
|
|
assert.isFalse(this.registry.onKeyDown(this.workspace, event));
|
|
});
|
|
test('No precondition available - execute callback', function () {
|
|
delete this.testShortcut['precondition'];
|
|
const event = createKeyDownEvent(Blockly.utils.KeyCodes.C);
|
|
assert.isTrue(this.registry.onKeyDown(this.workspace, event));
|
|
sinon.assert.calledOnce(this.callBackStub);
|
|
});
|
|
test('Execute all shortcuts in list', function () {
|
|
const event = createKeyDownEvent(Blockly.utils.KeyCodes.C);
|
|
const testShortcut2 = {
|
|
'name': 'test_shortcut_2',
|
|
'callback': function () {
|
|
return false;
|
|
},
|
|
'precondition': function () {
|
|
return false;
|
|
},
|
|
};
|
|
const testShortcut2Stub = addShortcut(
|
|
this.registry,
|
|
testShortcut2,
|
|
Blockly.utils.KeyCodes.C,
|
|
false,
|
|
);
|
|
assert.isTrue(this.registry.onKeyDown(this.workspace, event));
|
|
sinon.assert.calledOnce(testShortcut2Stub);
|
|
sinon.assert.calledOnce(this.callBackStub);
|
|
});
|
|
test('Stop executing shortcut when event is handled', function () {
|
|
const event = createKeyDownEvent(Blockly.utils.KeyCodes.C);
|
|
const testShortcut2 = {
|
|
'name': 'test_shortcut_2',
|
|
'callback': function () {
|
|
return false;
|
|
},
|
|
'precondition': function () {
|
|
return false;
|
|
},
|
|
};
|
|
const testShortcut2Stub = addShortcut(
|
|
this.registry,
|
|
testShortcut2,
|
|
Blockly.utils.KeyCodes.C,
|
|
true,
|
|
);
|
|
assert.isTrue(this.registry.onKeyDown(this.workspace, event));
|
|
sinon.assert.calledOnce(testShortcut2Stub);
|
|
sinon.assert.notCalled(this.callBackStub);
|
|
});
|
|
});
|
|
|
|
suite('createSerializedKey', function () {
|
|
test('Serialize key', function () {
|
|
const serializedKey = this.registry.createSerializedKey(
|
|
Blockly.utils.KeyCodes.A,
|
|
);
|
|
assert.equal(serializedKey, '65');
|
|
});
|
|
|
|
test('Serialize key code and modifier', function () {
|
|
const serializedKey = this.registry.createSerializedKey(
|
|
Blockly.utils.KeyCodes.A,
|
|
[Blockly.utils.KeyCodes.CTRL],
|
|
);
|
|
assert.equal(serializedKey, 'Control+65');
|
|
});
|
|
test('Serialize only a modifier', function () {
|
|
const serializedKey = this.registry.createSerializedKey(null, [
|
|
Blockly.utils.KeyCodes.CTRL,
|
|
]);
|
|
assert.equal(serializedKey, 'Control');
|
|
});
|
|
test('Serialize multiple modifiers', function () {
|
|
const serializedKey = this.registry.createSerializedKey(null, [
|
|
Blockly.utils.KeyCodes.CTRL,
|
|
Blockly.utils.KeyCodes.SHIFT,
|
|
]);
|
|
assert.equal(serializedKey, 'Shift+Control');
|
|
});
|
|
test('Order of modifiers should result in same serialized key', function () {
|
|
const serializedKey = this.registry.createSerializedKey(null, [
|
|
Blockly.utils.KeyCodes.CTRL,
|
|
Blockly.utils.KeyCodes.SHIFT,
|
|
]);
|
|
assert.equal(serializedKey, 'Shift+Control');
|
|
const serializedKeyNewOrder = this.registry.createSerializedKey(null, [
|
|
Blockly.utils.KeyCodes.SHIFT,
|
|
Blockly.utils.KeyCodes.CTRL,
|
|
]);
|
|
assert.equal(serializedKeyNewOrder, 'Shift+Control');
|
|
});
|
|
});
|
|
|
|
suite('serializeKeyEvent', function () {
|
|
test('Serialize key', function () {
|
|
const mockEvent = createKeyDownEvent(Blockly.utils.KeyCodes.A);
|
|
const serializedKey = this.registry.serializeKeyEvent_(mockEvent);
|
|
assert.equal(serializedKey, '65');
|
|
});
|
|
test('Serialize key code and modifier', function () {
|
|
const mockEvent = createKeyDownEvent(Blockly.utils.KeyCodes.A, [
|
|
Blockly.utils.KeyCodes.CTRL,
|
|
]);
|
|
const serializedKey = this.registry.serializeKeyEvent_(mockEvent);
|
|
assert.equal(serializedKey, 'Control+65');
|
|
});
|
|
test('Serialize only a modifier', function () {
|
|
const mockEvent = createKeyDownEvent(null, [Blockly.utils.KeyCodes.CTRL]);
|
|
const serializedKey = this.registry.serializeKeyEvent_(mockEvent);
|
|
assert.equal(serializedKey, 'Control');
|
|
});
|
|
test('Serialize multiple modifiers', function () {
|
|
const mockEvent = createKeyDownEvent(null, [
|
|
Blockly.utils.KeyCodes.CTRL,
|
|
Blockly.utils.KeyCodes.SHIFT,
|
|
]);
|
|
const serializedKey = this.registry.serializeKeyEvent_(mockEvent);
|
|
assert.equal(serializedKey, 'Shift+Control');
|
|
});
|
|
test('Throw error when incorrect modifier', function () {
|
|
const registry = this.registry;
|
|
const shouldThrow = function () {
|
|
registry.createSerializedKey(Blockly.utils.KeyCodes.K, ['s']);
|
|
};
|
|
assert.throws(shouldThrow, Error, 's is not a valid modifier key.');
|
|
});
|
|
});
|
|
|
|
teardown(function () {});
|
|
});
|