8
0

deleteobserver.js 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document */
  6. import DeleteObserver from '../src/deleteobserver';
  7. import View from '@ckeditor/ckeditor5-engine/src/view/view';
  8. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  9. import createViewRoot from '@ckeditor/ckeditor5-engine/tests/view/_utils/createroot';
  10. import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
  11. import env from '@ckeditor/ckeditor5-utils/src/env';
  12. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  13. describe( 'DeleteObserver', () => {
  14. let view, viewDocument;
  15. testUtils.createSinonSandbox();
  16. beforeEach( () => {
  17. view = new View();
  18. viewDocument = view.document;
  19. view.addObserver( DeleteObserver );
  20. } );
  21. afterEach( () => {
  22. view.destroy();
  23. } );
  24. // See ckeditor/ckeditor5-enter#10.
  25. it( 'can be initialized', () => {
  26. expect( () => {
  27. createViewRoot( viewDocument );
  28. view.attachDomRoot( document.createElement( 'div' ) );
  29. } ).to.not.throw();
  30. } );
  31. describe( 'delete event', () => {
  32. it( 'is fired on keydown', () => {
  33. const spy = sinon.spy();
  34. viewDocument.on( 'delete', spy );
  35. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  36. keyCode: getCode( 'delete' )
  37. } ) );
  38. expect( spy.calledOnce ).to.be.true;
  39. const data = spy.args[ 0 ][ 1 ];
  40. expect( data ).to.have.property( 'direction', 'forward' );
  41. expect( data ).to.have.property( 'unit', 'character' );
  42. expect( data ).to.have.property( 'sequence', 1 );
  43. } );
  44. it( 'is fired with a proper direction and unit (on Mac)', () => {
  45. const spy = sinon.spy();
  46. testUtils.sinon.stub( env, 'isMac' ).value( true );
  47. viewDocument.on( 'delete', spy );
  48. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  49. keyCode: getCode( 'backspace' ),
  50. altKey: true
  51. } ) );
  52. expect( spy.calledOnce ).to.be.true;
  53. const data = spy.args[ 0 ][ 1 ];
  54. expect( data ).to.have.property( 'direction', 'backward' );
  55. expect( data ).to.have.property( 'unit', 'word' );
  56. expect( data ).to.have.property( 'sequence', 1 );
  57. } );
  58. it( 'is fired with a proper direction and unit (on non-Mac)', () => {
  59. const spy = sinon.spy();
  60. testUtils.sinon.stub( env, 'isMac' ).value( false );
  61. viewDocument.on( 'delete', spy );
  62. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  63. keyCode: getCode( 'backspace' ),
  64. ctrlKey: true
  65. } ) );
  66. expect( spy.calledOnce ).to.be.true;
  67. const data = spy.args[ 0 ][ 1 ];
  68. expect( data ).to.have.property( 'direction', 'backward' );
  69. expect( data ).to.have.property( 'unit', 'word' );
  70. expect( data ).to.have.property( 'sequence', 1 );
  71. } );
  72. it( 'is not fired on keydown when keyCode does not match backspace or delete', () => {
  73. const spy = sinon.spy();
  74. viewDocument.on( 'delete', spy );
  75. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  76. keyCode: 1
  77. } ) );
  78. expect( spy.calledOnce ).to.be.false;
  79. } );
  80. it( 'is fired with a proper sequence number', () => {
  81. const spy = sinon.spy();
  82. viewDocument.on( 'delete', spy );
  83. // Simulate that a user keeps the "Delete" key.
  84. for ( let i = 0; i < 5; ++i ) {
  85. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  86. keyCode: getCode( 'delete' )
  87. } ) );
  88. }
  89. expect( spy.callCount ).to.equal( 5 );
  90. expect( spy.args[ 0 ][ 1 ] ).to.have.property( 'sequence', 1 );
  91. expect( spy.args[ 1 ][ 1 ] ).to.have.property( 'sequence', 2 );
  92. expect( spy.args[ 2 ][ 1 ] ).to.have.property( 'sequence', 3 );
  93. expect( spy.args[ 3 ][ 1 ] ).to.have.property( 'sequence', 4 );
  94. expect( spy.args[ 4 ][ 1 ] ).to.have.property( 'sequence', 5 );
  95. } );
  96. it( 'clears the sequence when the key was released', () => {
  97. const spy = sinon.spy();
  98. viewDocument.on( 'delete', spy );
  99. // Simulate that a user keeps the "Delete" key.
  100. for ( let i = 0; i < 3; ++i ) {
  101. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  102. keyCode: getCode( 'delete' )
  103. } ) );
  104. }
  105. // Then the user has released the key.
  106. viewDocument.fire( 'keyup', new DomEventData( viewDocument, getDomEvent(), {
  107. keyCode: getCode( 'delete' )
  108. } ) );
  109. // And pressed it once again.
  110. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  111. keyCode: getCode( 'delete' )
  112. } ) );
  113. expect( spy.callCount ).to.equal( 4 );
  114. expect( spy.args[ 0 ][ 1 ] ).to.have.property( 'sequence', 1 );
  115. expect( spy.args[ 1 ][ 1 ] ).to.have.property( 'sequence', 2 );
  116. expect( spy.args[ 2 ][ 1 ] ).to.have.property( 'sequence', 3 );
  117. expect( spy.args[ 3 ][ 1 ] ).to.have.property( 'sequence', 1 );
  118. } );
  119. it( 'works fine with Backspace key', () => {
  120. const spy = sinon.spy();
  121. viewDocument.on( 'delete', spy );
  122. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  123. keyCode: getCode( 'backspace' )
  124. } ) );
  125. viewDocument.fire( 'keyup', new DomEventData( viewDocument, getDomEvent(), {
  126. keyCode: getCode( 'backspace' )
  127. } ) );
  128. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  129. keyCode: getCode( 'backspace' )
  130. } ) );
  131. expect( spy.callCount ).to.equal( 2 );
  132. expect( spy.args[ 0 ][ 1 ] ).to.have.property( 'sequence', 1 );
  133. expect( spy.args[ 1 ][ 1 ] ).to.have.property( 'sequence', 1 );
  134. } );
  135. it( 'does not reset the sequence if other than Backspace or Delete key was released', () => {
  136. const spy = sinon.spy();
  137. viewDocument.on( 'delete', spy );
  138. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  139. keyCode: getCode( 'delete' )
  140. } ) );
  141. viewDocument.fire( 'keyup', new DomEventData( viewDocument, getDomEvent(), {
  142. keyCode: getCode( 'A' )
  143. } ) );
  144. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  145. keyCode: getCode( 'delete' )
  146. } ) );
  147. expect( spy.args[ 0 ][ 1 ] ).to.have.property( 'sequence', 1 );
  148. expect( spy.args[ 1 ][ 1 ] ).to.have.property( 'sequence', 2 );
  149. } );
  150. it( 'should stop keydown event when delete event is stopped', () => {
  151. const keydownSpy = sinon.spy();
  152. viewDocument.on( 'keydown', keydownSpy );
  153. viewDocument.on( 'delete', evt => evt.stop() );
  154. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  155. keyCode: getCode( 'delete' )
  156. } ) );
  157. sinon.assert.notCalled( keydownSpy );
  158. } );
  159. it( 'should not stop keydown event when delete event is not stopped', () => {
  160. const keydownSpy = sinon.spy();
  161. viewDocument.on( 'keydown', keydownSpy );
  162. viewDocument.on( 'delete', evt => evt.stop() );
  163. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  164. keyCode: getCode( 'x' )
  165. } ) );
  166. sinon.assert.calledOnce( keydownSpy );
  167. } );
  168. } );
  169. function getDomEvent() {
  170. return {
  171. preventDefault: sinon.spy()
  172. };
  173. }
  174. } );