fakeselectionobserver.js 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* globals document */
  6. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  7. import FakeSelectionObserver from '../../../src/view/observer/fakeselectionobserver';
  8. import View from '../../../src/view/view';
  9. import DomEventData from '../../../src/view/observer/domeventdata';
  10. import createViewRoot from '../_utils/createroot';
  11. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  12. import { setData, stringify } from '../../../src/dev-utils/view';
  13. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  14. describe( 'FakeSelectionObserver', () => {
  15. let observer, view, viewDocument, root, domRoot;
  16. testUtils.createSinonSandbox();
  17. before( () => {
  18. domRoot = createElement( document, 'div', {
  19. contenteditable: 'true'
  20. } );
  21. document.body.appendChild( domRoot );
  22. } );
  23. after( () => {
  24. domRoot.parentElement.removeChild( domRoot );
  25. } );
  26. beforeEach( () => {
  27. view = new View();
  28. viewDocument = view.document;
  29. root = createViewRoot( viewDocument );
  30. view.attachDomRoot( domRoot );
  31. observer = view.getObserver( FakeSelectionObserver );
  32. viewDocument.selection._setTo( null, { fake: true } );
  33. } );
  34. afterEach( () => {
  35. view.destroy();
  36. } );
  37. it( 'should do nothing if selection is not fake', () => {
  38. viewDocument.selection._setTo( null, { fake: false } );
  39. return checkEventPrevention( keyCodes.arrowleft, false );
  40. } );
  41. it( 'should do nothing if is disabled', () => {
  42. observer.disable();
  43. return checkEventPrevention( keyCodes.arrowleft, false );
  44. } );
  45. it( 'should prevent default for left arrow key', ( ) => {
  46. return checkEventPrevention( keyCodes.arrowleft );
  47. } );
  48. it( 'should prevent default for right arrow key', ( ) => {
  49. return checkEventPrevention( keyCodes.arrowright );
  50. } );
  51. it( 'should prevent default for up arrow key', ( ) => {
  52. return checkEventPrevention( keyCodes.arrowup );
  53. } );
  54. it( 'should prevent default for down arrow key', ( ) => {
  55. return checkEventPrevention( keyCodes.arrowdown );
  56. } );
  57. it( 'should fire selectionChange event with new selection when left arrow key is pressed', () => {
  58. return checkSelectionChange(
  59. '<container:p>foo[<strong>bar</strong>]baz</container:p>',
  60. keyCodes.arrowleft,
  61. '<container:p>foo[]<strong>bar</strong>baz</container:p>'
  62. );
  63. } );
  64. it( 'should fire selectionChange event with new selection when right arrow key is pressed', () => {
  65. return checkSelectionChange(
  66. '<container:p>foo[<strong>bar</strong>]baz</container:p>',
  67. keyCodes.arrowright,
  68. '<container:p>foo<strong>bar</strong>[]baz</container:p>'
  69. );
  70. } );
  71. it( 'should fire selectionChange event with new selection when up arrow key is pressed', () => {
  72. return checkSelectionChange(
  73. '<container:p>foo[<strong>bar</strong>]baz</container:p>',
  74. keyCodes.arrowup,
  75. '<container:p>foo[]<strong>bar</strong>baz</container:p>'
  76. );
  77. } );
  78. it( 'should fire selectionChange event with new selection when down arrow key is pressed', () => {
  79. return checkSelectionChange(
  80. '<container:p>foo[<strong>bar</strong>]baz</container:p>',
  81. keyCodes.arrowdown,
  82. '<container:p>foo<strong>bar</strong>[]baz</container:p>'
  83. );
  84. } );
  85. it( 'should fire `selectionChangeDone` event after selection stop changing', () => {
  86. const clock = testUtils.sinon.useFakeTimers();
  87. const spy = sinon.spy();
  88. viewDocument.on( 'selectionChangeDone', spy );
  89. // Change selection.
  90. changeFakeSelectionPressing( keyCodes.arrowdown );
  91. // Wait 100ms.
  92. clock.tick( 100 );
  93. // Check if spy was called.
  94. sinon.assert.notCalled( spy );
  95. // Change selection one more time.
  96. changeFakeSelectionPressing( keyCodes.arrowdown );
  97. // Wait 210ms (debounced function should be called).
  98. clock.tick( 210 );
  99. sinon.assert.calledOnce( spy );
  100. } );
  101. it( 'should not fire `selectionChangeDone` event when observer will be destroyed', () => {
  102. const clock = testUtils.sinon.useFakeTimers();
  103. const spy = sinon.spy();
  104. viewDocument.on( 'selectionChangeDone', spy );
  105. // Change selection.
  106. changeFakeSelectionPressing( keyCodes.arrowdown );
  107. // Wait 100ms.
  108. clock.tick( 100 );
  109. // And destroy observer.
  110. observer.destroy();
  111. // Wait another 110ms.
  112. clock.tick( 110 );
  113. // Check that event won't be called.
  114. sinon.assert.notCalled( spy );
  115. } );
  116. // Checks if preventDefault method was called by FakeSelectionObserver for specified key code.
  117. //
  118. // @param {Number} keyCode
  119. // @param {Boolean} shouldPrevent If set to true method checks if event was prevented.
  120. // @returns {Promise}
  121. function checkEventPrevention( keyCode, shouldPrevent = true ) {
  122. return new Promise( resolve => {
  123. const data = {
  124. keyCode,
  125. preventDefault: sinon.spy(),
  126. };
  127. viewDocument.once( 'keydown', () => {
  128. if ( shouldPrevent ) {
  129. sinon.assert.calledOnce( data.preventDefault );
  130. } else {
  131. sinon.assert.notCalled( data.preventDefault );
  132. }
  133. resolve();
  134. }, { priority: 'lowest' } );
  135. viewDocument.fire( 'keydown', new DomEventData( viewDocument, { target: document.body }, data ) );
  136. } );
  137. }
  138. // Checks if proper selectionChange event is fired by FakeSelectionObserver for specified key.
  139. //
  140. // @param {String} initialData
  141. // @param {Number} keyCode
  142. // @param {String} output
  143. // @returns {Promise}
  144. function checkSelectionChange( initialData, keyCode, output ) {
  145. return new Promise( resolve => {
  146. viewDocument.once( 'selectionChange', ( eventInfo, data ) => {
  147. expect( stringify( root.getChild( 0 ), data.newSelection, { showType: true } ) ).to.equal( output );
  148. resolve();
  149. } );
  150. setData( view, initialData );
  151. changeFakeSelectionPressing( keyCode );
  152. } );
  153. }
  154. // Sets fake selection to the document and fire `keydown` event what cause `selectionChange` event.
  155. //
  156. // @param {Number} keyCode
  157. function changeFakeSelectionPressing( keyCode ) {
  158. viewDocument.selection._setTo( viewDocument.selection.getRanges(), {
  159. backward: viewDocument.selection.isBackward,
  160. fake: true
  161. } );
  162. const data = {
  163. keyCode,
  164. preventDefault: sinon.spy(),
  165. };
  166. viewDocument.fire( 'keydown', new DomEventData( viewDocument, { target: document.body }, data ) );
  167. }
  168. } );