clipboardobserver.js 7.4 KB

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