8
0

deleteobserver.js 6.1 KB

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