8
0
Просмотр исходного кода

Tests: Added tests fro the isSafeKeystroke() helper.

Aleksander Nowodzinski 5 лет назад
Родитель
Сommit
33e9b37c38

+ 8 - 7
packages/ckeditor5-typing/src/utils/injectunsafekeystrokeshandling.js

@@ -154,13 +154,14 @@ for ( let code = 112; code <= 135; code++ ) {
 	safeKeycodes.push( code );
 }
 
-// Returns `true` if a keystroke should not cause any content change caused by "typing".
-//
-// Note: This implementation is very simple and will need to be refined with time.
-//
-// @private
-// @param {engine.view.observer.keyObserver.KeyEventData} keyData
-// @returns {Boolean}
+/**
+ * Returns `true` if a keystroke will not result in "typing".
+ *
+ * Note: This implementation is very simple and will need to be refined with time.
+ *
+ * @param {module:engine/view/observer/keyobserver~KeyEventData} keyData
+ * @returns {Boolean}
+ */
 export function isSafeKeystroke( keyData ) {
 	// Keystrokes which contain Ctrl don't represent typing.
 	if ( keyData.ctrlKey ) {

+ 85 - 0
packages/ckeditor5-typing/tests/utils/injectunsafekeystrokeshandling.js

@@ -0,0 +1,85 @@
+/**
+ * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import {
+	keyCodes
+} from '@ckeditor/ckeditor5-utils/src/keyboard';
+import { isSafeKeystroke } from '../../src/utils/injectunsafekeystrokeshandling';
+
+describe( 'unsafe keystroke handling utils', () => {
+	describe( 'isSafeKeystroke()', () => {
+		it( 'should return "true" for any keystroke with the Ctrl key', () => {
+			expect( isSafeKeystroke( { keyCode: keyCodes.a, ctrlKey: true } ), 'Ctrl+a' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: keyCodes[ 48 ], ctrlKey: true } ), 'Ctrk+0' ).to.be.true;
+		} );
+
+		it( 'should return "true" for all arrow keys', () => {
+			expect( isSafeKeystroke( { keyCode: keyCodes.arrowup } ), 'arrow up' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: keyCodes.arrowdown } ), 'arrow down' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: keyCodes.arrowleft } ), 'arrow left' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: keyCodes.arrowright } ), 'arrow right' ).to.be.true;
+		} );
+
+		it( 'should return "true" for function (Fn) keystrokes', () => {
+			expect( isSafeKeystroke( { keyCode: 112 } ), 'F1' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 113 } ), 'F2' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 114 } ), 'F3' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 115 } ), 'F4' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 116 } ), 'F5' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 117 } ), 'F6' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 118 } ), 'F7' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 119 } ), 'F8' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 120 } ), 'F9' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 121 } ), 'F10' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 122 } ), 'F11' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 123 } ), 'F12' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 124 } ), 'F13' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 125 } ), 'F14' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 126 } ), 'F15' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 127 } ), 'F16' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 128 } ), 'F17' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 129 } ), 'F18' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 130 } ), 'F19' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 131 } ), 'F20' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 132 } ), 'F21' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 133 } ), 'F22' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 134 } ), 'F23' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 135 } ), 'F24' ).to.be.true;
+		} );
+
+		it( 'should return "true" for other safe keystrokes', () => {
+			expect( isSafeKeystroke( { keyCode: 9 } ), 'Tab' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 16 } ), 'Shift' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 17 } ), 'Ctrl' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 18 } ), 'Alt' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 19 } ), 'Pause' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 20 } ), 'CapsLock' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 27 } ), 'Escape' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 33 } ), 'PageUp' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 34 } ), 'PageDown' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 35 } ), 'Home' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 36 } ), 'End,' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 45 } ), 'Insert' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 91 } ), 'Windows' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 93 } ), 'Menu key' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 144 } ), 'NumLock' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 145 } ), 'ScrollLock' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 173 } ), 'Mute/Unmute' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 174 } ), 'Volume up' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 175 } ), 'Volume down' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 176 } ), 'Next song' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 177 } ), 'Previous song' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 178 } ), 'Stop' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 179 } ), 'Play/Pause' ).to.be.true;
+			expect( isSafeKeystroke( { keyCode: 255 } ), 'Display brightness (increase and decrease)' ).to.be.true;
+		} );
+
+		it( 'should return "false" for the keystrokes that result in typing', () => {
+			expect( isSafeKeystroke( { keyCode: keyCodes.a } ), 'a' ).to.be.false;
+			expect( isSafeKeystroke( { keyCode: keyCodes[ 48 ] } ), '0' ).to.be.false;
+			expect( isSafeKeystroke( { keyCode: keyCodes.a, altKey: true } ), 'Alt+a' ).to.be.false;
+		} );
+	} );
+} );