clipboard.js 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  6. import Clipboard from '../src/clipboard';
  7. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  8. import ClipboardObserver from '../src/clipboardobserver';
  9. import { stringify as stringifyView } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  10. import {
  11. stringify as stringifyModel,
  12. setData as setModelData,
  13. getData as getModelData
  14. } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  15. import ViewDocumentFragment from '@ckeditor/ckeditor5-engine/src/view/documentfragment';
  16. import ViewText from '@ckeditor/ckeditor5-engine/src/view/text';
  17. describe( 'Clipboard feature', () => {
  18. let editor, editingView;
  19. beforeEach( () => {
  20. return VirtualTestEditor.create( {
  21. plugins: [ Clipboard, Paragraph ]
  22. } )
  23. .then( ( newEditor ) => {
  24. editor = newEditor;
  25. editingView = editor.editing.view;
  26. } );
  27. } );
  28. describe( 'constructor()', () => {
  29. it( 'registers ClipboardObserver', () => {
  30. expect( editingView.getObserver( ClipboardObserver ) ).to.be.instanceOf( ClipboardObserver );
  31. } );
  32. } );
  33. describe( 'clipboard paste pipeline', () => {
  34. it( 'takes HTML data from the dataTransfer', ( done ) => {
  35. const dataTransferMock = createDataTransfer( { 'text/html': '<p>x</p>', 'text/plain': 'y' } );
  36. const preventDefaultSpy = sinon.spy();
  37. editingView.on( 'clipboardInput', ( evt, data ) => {
  38. expect( preventDefaultSpy.calledOnce ).to.be.true;
  39. expect( data.dataTransfer ).to.equal( dataTransferMock );
  40. expect( data.content ).is.instanceOf( ViewDocumentFragment );
  41. expect( stringifyView( data.content ) ).to.equal( '<p>x</p>' );
  42. done();
  43. } );
  44. editingView.fire( 'paste', {
  45. dataTransfer: dataTransferMock,
  46. preventDefault: preventDefaultSpy
  47. } );
  48. } );
  49. it( 'takes plain text data from the dataTransfer if there is no HTML', ( done ) => {
  50. const dataTransferMock = createDataTransfer( { 'text/plain': 'x\n\ny z' } );
  51. const preventDefaultSpy = sinon.spy();
  52. editingView.on( 'clipboardInput', ( evt, data ) => {
  53. expect( preventDefaultSpy.calledOnce ).to.be.true;
  54. expect( data.dataTransfer ).to.equal( dataTransferMock );
  55. expect( data.content ).is.instanceOf( ViewDocumentFragment );
  56. expect( stringifyView( data.content ) ).to.equal( '<p>x</p><p>y z</p>' );
  57. done();
  58. } );
  59. editingView.fire( 'paste', {
  60. dataTransfer: dataTransferMock,
  61. preventDefault: preventDefaultSpy
  62. } );
  63. } );
  64. it( 'fires clipboardInput event with empty data if there is no HTML nor plain text', ( done ) => {
  65. const dataTransferMock = createDataTransfer( {} );
  66. const preventDefaultSpy = sinon.spy();
  67. editingView.on( 'clipboardInput', ( evt, data ) => {
  68. expect( preventDefaultSpy.calledOnce ).to.be.true;
  69. expect( data.dataTransfer ).to.equal( dataTransferMock );
  70. expect( data.content ).is.instanceOf( ViewDocumentFragment );
  71. expect( stringifyView( data.content ) ).to.equal( '' );
  72. done();
  73. } );
  74. editingView.fire( 'paste', {
  75. dataTransfer: dataTransferMock,
  76. preventDefault: preventDefaultSpy
  77. } );
  78. } );
  79. it( 'uses low priority observer for the paste event', () => {
  80. const dataTransferMock = createDataTransfer( { 'text/html': 'x' } );
  81. const spy = sinon.spy();
  82. editingView.on( 'paste', ( evt ) => {
  83. evt.stop();
  84. } );
  85. editingView.on( 'clipboardInput', spy );
  86. editingView.fire( 'paste', {
  87. dataTransfer: dataTransferMock,
  88. preventDefault() {}
  89. } );
  90. expect( spy.callCount ).to.equal( 0 );
  91. } );
  92. it( 'inserts content to the editor', () => {
  93. const dataTransferMock = createDataTransfer( { 'text/html': '<p>x</p>', 'text/plain': 'y' } );
  94. const spy = sinon.stub( editor.data, 'insertContent' );
  95. editingView.fire( 'paste', {
  96. dataTransfer: dataTransferMock,
  97. preventDefault() {}
  98. } );
  99. expect( spy.calledOnce ).to.be.true;
  100. expect( stringifyModel( spy.args[ 0 ][ 0 ] ) ).to.equal( '<paragraph>x</paragraph>' );
  101. } );
  102. it( 'converts content in an "all allowed" context', () => {
  103. // It's enough if we check this here with a text node and paragraph because if the conversion was made
  104. // in a normal root, then text or paragraph wouldn't be allowed here.
  105. const dataTransferMock = createDataTransfer( { 'text/html': 'x<p>y</p>', 'text/plain': 'z' } );
  106. const spy = sinon.stub( editor.data, 'insertContent' );
  107. editingView.fire( 'paste', {
  108. dataTransfer: dataTransferMock,
  109. preventDefault() {}
  110. } );
  111. expect( spy.calledOnce ).to.be.true;
  112. expect( stringifyModel( spy.args[ 0 ][ 0 ] ) ).to.equal( 'x<paragraph>y</paragraph>' );
  113. } );
  114. it( 'does nothing when pasted content is empty', () => {
  115. const dataTransferMock = createDataTransfer( { 'text/plain': '' } );
  116. const spy = sinon.stub( editor.data, 'insertContent' );
  117. editingView.fire( 'clipboardInput', {
  118. dataTransfer: dataTransferMock,
  119. content: new ViewDocumentFragment()
  120. } );
  121. expect( spy.callCount ).to.equal( 0 );
  122. } );
  123. it( 'uses low priority observer for the clipboardInput event', () => {
  124. const dataTransferMock = createDataTransfer( { 'text/html': 'x' } );
  125. const spy = sinon.stub( editor.data, 'insertContent' );
  126. editingView.on( 'clipboardInput', ( evt ) => {
  127. evt.stop();
  128. } );
  129. editingView.fire( 'paste', {
  130. dataTransfer: dataTransferMock,
  131. preventDefault() {}
  132. } );
  133. expect( spy.callCount ).to.equal( 0 );
  134. } );
  135. function createDataTransfer( data ) {
  136. return {
  137. getData( type ) {
  138. return data[ type ];
  139. }
  140. };
  141. }
  142. } );
  143. describe( 'clipboard copy/cut pipeline', () => {
  144. it( 'fires clipboardOutput for copy with the selected content and correct method', ( done ) => {
  145. const dataTransferMock = createDataTransfer();
  146. const preventDefaultSpy = sinon.spy();
  147. setModelData( editor.document, '<paragraph>a[bc</paragraph><paragraph>de]f</paragraph>' );
  148. editingView.on( 'clipboardOutput', ( evt, data ) => {
  149. expect( preventDefaultSpy.calledOnce ).to.be.true;
  150. expect( data.method ).to.equal( 'copy' );
  151. expect( data.dataTransfer ).to.equal( dataTransferMock );
  152. expect( data.content ).is.instanceOf( ViewDocumentFragment );
  153. expect( stringifyView( data.content ) ).to.equal( '<p>bc</p><p>de</p>' );
  154. done();
  155. } );
  156. editingView.fire( 'copy', {
  157. dataTransfer: dataTransferMock,
  158. preventDefault: preventDefaultSpy
  159. } );
  160. } );
  161. it( 'fires clipboardOutput for cut with the selected content and correct method', ( done ) => {
  162. const dataTransferMock = createDataTransfer();
  163. const preventDefaultSpy = sinon.spy();
  164. setModelData( editor.document, '<paragraph>a[bc</paragraph><paragraph>de]f</paragraph>' );
  165. editingView.on( 'clipboardOutput', ( evt, data ) => {
  166. expect( data.method ).to.equal( 'cut' );
  167. done();
  168. } );
  169. editingView.fire( 'cut', {
  170. dataTransfer: dataTransferMock,
  171. preventDefault: preventDefaultSpy
  172. } );
  173. } );
  174. it( 'uses low priority observer for the copy event', () => {
  175. const dataTransferMock = createDataTransfer();
  176. const spy = sinon.spy();
  177. editingView.on( 'copy', ( evt ) => {
  178. evt.stop();
  179. } );
  180. editingView.on( 'clipboardOutput', spy );
  181. editingView.fire( 'copy', {
  182. dataTransfer: dataTransferMock,
  183. preventDefault() {}
  184. } );
  185. expect( spy.callCount ).to.equal( 0 );
  186. } );
  187. it( 'sets clipboard HTML data', () => {
  188. const dataTransferMock = createDataTransfer();
  189. setModelData( editor.document, '<paragraph>f[o]o</paragraph>' );
  190. editingView.fire( 'clipboardOutput', {
  191. dataTransfer: dataTransferMock,
  192. content: new ViewDocumentFragment( [ new ViewText( 'abc' ) ] ),
  193. method: 'copy'
  194. } );
  195. expect( dataTransferMock.getData( 'text/html' ) ).to.equal( 'abc' );
  196. expect( getModelData( editor.document ) ).to.equal( '<paragraph>f[o]o</paragraph>' );
  197. } );
  198. it( 'does not set clipboard HTML data if content is empty', () => {
  199. const dataTransferMock = createDataTransfer();
  200. editingView.fire( 'clipboardOutput', {
  201. dataTransfer: dataTransferMock,
  202. content: new ViewDocumentFragment(),
  203. method: 'copy'
  204. } );
  205. expect( dataTransferMock.getData( 'text/html' ) ).to.be.undefined;
  206. } );
  207. it( 'deletes selected content in case of cut', () => {
  208. const dataTransferMock = createDataTransfer();
  209. setModelData( editor.document, '<paragraph>f[o</paragraph><paragraph>x]o</paragraph>' );
  210. editingView.fire( 'clipboardOutput', {
  211. dataTransfer: dataTransferMock,
  212. content: new ViewDocumentFragment(),
  213. method: 'cut'
  214. } );
  215. expect( getModelData( editor.document ) ).to.equal( '<paragraph>f[]o</paragraph>' );
  216. } );
  217. it( 'uses low priority observer for the clipboardOutput event', () => {
  218. const dataTransferMock = createDataTransfer();
  219. editingView.on( 'clipboardOutput', ( evt ) => {
  220. evt.stop();
  221. } );
  222. editingView.fire( 'copy', {
  223. dataTransfer: dataTransferMock,
  224. content: new ViewDocumentFragment( [ new ViewText( 'abc' ) ] ),
  225. preventDefault() {}
  226. } );
  227. expect( dataTransferMock.getData( 'text/html' ) ).to.be.undefined;
  228. } );
  229. function createDataTransfer() {
  230. const store = new Map();
  231. return {
  232. setData( type, data ) {
  233. store.set( type, data );
  234. },
  235. getData( type ) {
  236. return store.get( type );
  237. }
  238. };
  239. }
  240. } );
  241. } );