clipboardobserver.js 7.5 KB

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