8
0

deleteobserver.js 5.2 KB

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