8
0

clipboardobserver.js 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267
  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 ClipboardObserver from '../src/clipboardobserver';
  7. import Document from '@ckeditor/ckeditor5-engine/src/view/document';
  8. import Element from '@ckeditor/ckeditor5-engine/src/view/element';
  9. import Range from '@ckeditor/ckeditor5-engine/src/view/range';
  10. import Position from '@ckeditor/ckeditor5-engine/src/view/position';
  11. import DataTransfer from '../src/datatransfer';
  12. describe( 'ClipboardObserver', () => {
  13. let doc, observer, root, el, range, eventSpy, preventDefaultSpy;
  14. beforeEach( () => {
  15. doc = new Document();
  16. root = doc.createRoot( 'div' );
  17. // Create view and DOM structures.
  18. el = new Element( 'p' );
  19. root.appendChildren( el );
  20. doc.domConverter.viewToDom( root, document, { withChildren: true, bind: true } );
  21. doc.selection.setCollapsedAt( el );
  22. range = new Range( new Position( root, 1 ) );
  23. // Just making sure that the following tests will check anything.
  24. expect( range.isEqual( doc.selection.getFirstRange() ) ).to.be.false;
  25. observer = doc.addObserver( ClipboardObserver );
  26. eventSpy = sinon.spy();
  27. preventDefaultSpy = sinon.spy();
  28. } );
  29. it( 'should define domEventType', () => {
  30. expect( observer.domEventType ).to.deep.equal( [ 'paste', 'copy', 'cut', 'drop', 'dragover' ] );
  31. } );
  32. describe( 'paste event', () => {
  33. it( 'should be fired with the right event data', () => {
  34. const dataTransfer = mockDomDataTransfer();
  35. const targetElement = mockDomTargetElement( {} );
  36. doc.on( 'paste', eventSpy );
  37. observer.onDomEvent( {
  38. type: 'paste',
  39. target: targetElement,
  40. clipboardData: dataTransfer,
  41. preventDefault: preventDefaultSpy
  42. } );
  43. expect( eventSpy.calledOnce ).to.be.true;
  44. const data = eventSpy.args[ 0 ][ 1 ];
  45. expect( data.domTarget ).to.equal( targetElement );
  46. expect( data.dataTransfer ).to.be.instanceOf( DataTransfer );
  47. expect( data.dataTransfer.getData( 'x/y' ) ).to.equal( 'foo:x/y' );
  48. expect( preventDefaultSpy.calledOnce ).to.be.true;
  49. } );
  50. } );
  51. describe( 'drop event', () => {
  52. it( 'should be fired with the right event data - basics', () => {
  53. const dataTransfer = mockDomDataTransfer();
  54. const targetElement = mockDomTargetElement( {} );
  55. doc.on( 'drop', eventSpy );
  56. observer.onDomEvent( {
  57. type: 'drop',
  58. target: targetElement,
  59. dataTransfer,
  60. preventDefault: preventDefaultSpy
  61. } );
  62. expect( eventSpy.calledOnce ).to.be.true;
  63. const data = eventSpy.args[ 0 ][ 1 ];
  64. expect( data.domTarget ).to.equal( targetElement );
  65. expect( data.dataTransfer ).to.be.instanceOf( DataTransfer );
  66. expect( data.dataTransfer.getData( 'x/y' ) ).to.equal( 'foo:x/y' );
  67. expect( data.dropRange.isEqual( doc.selection.getFirstRange() ) ).to.be.true;
  68. expect( preventDefaultSpy.calledOnce ).to.be.true;
  69. } );
  70. it( 'should be fired with the right event data – dropRange (when no info about it in the drop event)', () => {
  71. const dataTransfer = mockDomDataTransfer();
  72. const targetElement = mockDomTargetElement( {} );
  73. doc.on( 'drop', eventSpy );
  74. observer.onDomEvent( {
  75. type: 'drop',
  76. target: targetElement,
  77. dataTransfer,
  78. preventDefault() {}
  79. } );
  80. expect( eventSpy.calledOnce ).to.be.true;
  81. const data = eventSpy.args[ 0 ][ 1 ];
  82. expect( data.dropRange.isEqual( doc.selection.getFirstRange() ) ).to.be.true;
  83. } );
  84. it( 'should be fired with the right event data – dropRange (when document.caretRangeFromPoint present)', () => {
  85. let caretRangeFromPointCalledWith;
  86. const domRange = doc.domConverter.viewRangeToDom( range );
  87. const dataTransfer = mockDomDataTransfer();
  88. const targetElement = mockDomTargetElement( {
  89. caretRangeFromPoint( x, y ) {
  90. caretRangeFromPointCalledWith = [ x, y ];
  91. return domRange;
  92. }
  93. } );
  94. doc.on( 'drop', eventSpy );
  95. observer.onDomEvent( {
  96. type: 'drop',
  97. target: targetElement,
  98. dataTransfer,
  99. clientX: 10,
  100. clientY: 20,
  101. preventDefault() {}
  102. } );
  103. expect( eventSpy.calledOnce ).to.be.true;
  104. const data = eventSpy.args[ 0 ][ 1 ];
  105. expect( data.dropRange.isEqual( range ) ).to.be.true;
  106. expect( caretRangeFromPointCalledWith ).to.deep.equal( [ 10, 20 ] );
  107. } );
  108. it( 'should be fired with the right event data – dropRange (when evt.rangeParent|Offset present)', () => {
  109. const domRange = doc.domConverter.viewRangeToDom( range );
  110. const dataTransfer = mockDomDataTransfer();
  111. const targetElement = mockDomTargetElement( {
  112. createRange() {
  113. return document.createRange();
  114. }
  115. } );
  116. doc.on( 'drop', eventSpy );
  117. observer.onDomEvent( {
  118. type: 'drop',
  119. target: targetElement,
  120. dataTransfer,
  121. rangeParent: domRange.startContainer,
  122. rangeOffset: domRange.startOffset,
  123. preventDefault() {}
  124. } );
  125. expect( eventSpy.calledOnce ).to.be.true;
  126. const data = eventSpy.args[ 0 ][ 1 ];
  127. expect( data.dropRange.isEqual( range ) ).to.be.true;
  128. } );
  129. } );
  130. describe( 'clipboardInput event', () => {
  131. it( 'should be fired on paste', () => {
  132. const dataTransfer = new DataTransfer( mockDomDataTransfer() );
  133. const normalPrioritySpy = sinon.spy();
  134. doc.on( 'clipboardInput', eventSpy );
  135. doc.on( 'paste', normalPrioritySpy );
  136. doc.fire( 'paste', {
  137. dataTransfer,
  138. preventDefault: preventDefaultSpy
  139. } );
  140. expect( eventSpy.calledOnce ).to.be.true;
  141. expect( preventDefaultSpy.calledOnce ).to.be.true;
  142. const data = eventSpy.args[ 0 ][ 1 ];
  143. expect( data.dataTransfer ).to.equal( dataTransfer );
  144. expect( data.targetRanges ).to.have.length( 1 );
  145. expect( data.targetRanges[ 0 ].isEqual( doc.selection.getFirstRange() ) ).to.be.true;
  146. expect( sinon.assert.callOrder( normalPrioritySpy, eventSpy ) );
  147. } );
  148. it( 'should be fired on drop', () => {
  149. const dataTransfer = new DataTransfer( mockDomDataTransfer() );
  150. const normalPrioritySpy = sinon.spy();
  151. doc.on( 'clipboardInput', eventSpy );
  152. doc.on( 'drop', normalPrioritySpy );
  153. doc.fire( 'drop', {
  154. dataTransfer,
  155. preventDefault: preventDefaultSpy,
  156. dropRange: range
  157. } );
  158. expect( eventSpy.calledOnce ).to.be.true;
  159. expect( preventDefaultSpy.calledOnce ).to.be.true;
  160. const data = eventSpy.args[ 0 ][ 1 ];
  161. expect( data.dataTransfer ).to.equal( dataTransfer );
  162. expect( data.targetRanges ).to.have.length( 1 );
  163. expect( data.targetRanges[ 0 ].isEqual( range ) ).to.be.true;
  164. expect( sinon.assert.callOrder( normalPrioritySpy, eventSpy ) );
  165. } );
  166. } );
  167. describe( 'dragover event', () => {
  168. it( 'should fire when a file is dragging over the document', () => {
  169. const targetElement = mockDomTargetElement( {} );
  170. const dataTransfer = mockDomDataTransfer();
  171. doc.on( 'dragover', eventSpy );
  172. observer.onDomEvent( {
  173. type: 'dragover',
  174. target: targetElement,
  175. dataTransfer
  176. } );
  177. expect( eventSpy.calledOnce ).to.equal( true );
  178. const data = eventSpy.args[ 0 ][ 1 ];
  179. expect( data.document ).to.equal( doc );
  180. expect( data.domTarget ).to.equal( targetElement );
  181. expect( data.domEvent.type ).to.equal( 'dragover' );
  182. expect( data.dataTransfer.files ).to.deep.equal( dataTransfer.files );
  183. } );
  184. } );
  185. } );
  186. // Returns a super simple mock of HTMLElement (we use only ownerDocument from it).
  187. function mockDomTargetElement( documentMock ) {
  188. return {
  189. ownerDocument: documentMock
  190. };
  191. }
  192. function mockDomDataTransfer() {
  193. return {
  194. files: [],
  195. getData( type ) {
  196. return 'foo:' + type;
  197. }
  198. };
  199. }