deleteobserver.js 5.3 KB

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