8
0

deleteobserver.js 6.8 KB

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