decouplededitor.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* globals document, setTimeout, console */
  6. import DecoupledEditorUI from '../src/decouplededitorui';
  7. import DecoupledEditorUIView from '../src/decouplededitoruiview';
  8. import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/htmldataprocessor';
  9. import DecoupledEditor from '../src/decouplededitor';
  10. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  11. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  12. import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
  13. import DataApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/dataapimixin';
  14. import RootElement from '@ckeditor/ckeditor5-engine/src/model/rootelement';
  15. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  16. import { describeMemoryUsage, testMemoryUsage } from '@ckeditor/ckeditor5-core/tests/_utils/memory';
  17. import ArticlePluginSet from '@ckeditor/ckeditor5-core/tests/_utils/articlepluginset';
  18. import { assertCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  19. const editorData = '<p><strong>foo</strong> bar</p>';
  20. describe( 'DecoupledEditor', () => {
  21. let editor;
  22. testUtils.createSinonSandbox();
  23. beforeEach( () => {
  24. testUtils.sinon.stub( console, 'warn' ).callsFake( () => {} );
  25. } );
  26. describe( 'constructor()', () => {
  27. beforeEach( () => {
  28. editor = new DecoupledEditor();
  29. } );
  30. it( 'uses HTMLDataProcessor', () => {
  31. expect( editor.data.processor ).to.be.instanceof( HtmlDataProcessor );
  32. } );
  33. it( 'has a Data Interface', () => {
  34. expect( testUtils.isMixed( DecoupledEditor, DataApiMixin ) ).to.be.true;
  35. } );
  36. it( 'creates main root element', () => {
  37. expect( editor.model.document.getRoot( 'main' ) ).to.instanceof( RootElement );
  38. } );
  39. describe( 'ui', () => {
  40. it( 'is created', () => {
  41. editor.ui.init();
  42. expect( editor.ui ).to.be.instanceof( DecoupledEditorUI );
  43. expect( editor.ui.view ).to.be.instanceof( DecoupledEditorUIView );
  44. editor.ui.destroy();
  45. } );
  46. } );
  47. } );
  48. describe( 'create()', () => {
  49. it( 'should properly handled async data initialization', done => {
  50. const spy = sinon.spy();
  51. let resolver;
  52. class AsyncDataInit extends Plugin {
  53. init() {
  54. this.editor.data.on( 'ready', () => spy( 'ready' ) );
  55. this.editor.data.on( 'init', evt => {
  56. evt.stop();
  57. evt.return = new Promise( resolve => {
  58. resolver = () => {
  59. spy( 'asyncInit' );
  60. // Since we stop `init` event, `data#ready` needs to be fired manually.
  61. this.editor.data.fire( 'ready' );
  62. resolve();
  63. };
  64. } );
  65. }, { priority: 'high' } );
  66. }
  67. }
  68. DecoupledEditor.create( '<p>foo bar</p>', {
  69. plugins: [ Paragraph, Bold, AsyncDataInit ]
  70. } ).then( editor => {
  71. sinon.assert.calledWith( spy.firstCall, 'asyncInit' );
  72. sinon.assert.calledWith( spy.secondCall, 'ready' );
  73. editor.destroy().then( done );
  74. } );
  75. // Resolve init promise in next cycle to hold data initialization.
  76. setTimeout( () => resolver() );
  77. } );
  78. describe( 'editor with data', () => {
  79. test( () => editorData );
  80. } );
  81. describe( 'editor with editable element', () => {
  82. let editableElement;
  83. beforeEach( () => {
  84. editableElement = document.createElement( 'div' );
  85. editableElement.innerHTML = editorData;
  86. } );
  87. test( () => editableElement );
  88. } );
  89. it( 'initializes with config.initialData', () => {
  90. return DecoupledEditor.create( document.createElement( 'div' ), {
  91. initialData: '<p>Hello world!</p>',
  92. plugins: [ Paragraph ]
  93. } ).then( editor => {
  94. expect( editor.getData() ).to.equal( '<p>Hello world!</p>' );
  95. editor.destroy();
  96. } );
  97. } );
  98. // See: https://github.com/ckeditor/ckeditor5/issues/746
  99. it( 'should throw when trying to create the editor using the same source element more than once', done => {
  100. const sourceElement = document.createElement( 'div' );
  101. // eslint-disable-next-line no-new
  102. new DecoupledEditor( sourceElement );
  103. DecoupledEditor.create( sourceElement )
  104. .then(
  105. () => {
  106. expect.fail( 'Decoupled editor should not initialize on an element already used by other instance.' );
  107. },
  108. err => {
  109. assertCKEditorError( err, /^editor-source-element-already-used/ );
  110. }
  111. )
  112. .then( done )
  113. .catch( done );
  114. } );
  115. it( 'throws if initial data is passed in Editor#create and config.initialData is also used', done => {
  116. DecoupledEditor.create( '<p>Hello world!</p>', {
  117. initialData: '<p>I am evil!</p>',
  118. plugins: [ Paragraph ]
  119. } )
  120. .then(
  121. () => {
  122. expect.fail( 'Decoupled editor should throw an error when both initial data are passed' );
  123. },
  124. err => {
  125. assertCKEditorError( err,
  126. // eslint-disable-next-line max-len
  127. /^editor-create-initial-data: The config\.initialData option cannot be used together with initial data passed in Editor\.create\(\)\./,
  128. null
  129. );
  130. }
  131. )
  132. .then( done )
  133. .catch( done );
  134. } );
  135. it( 'throws error if it is initialized in textarea', done => {
  136. DecoupledEditor.create( document.createElement( 'textarea' ) )
  137. .then(
  138. () => {
  139. expect.fail( 'Decoupled editor should throw an error when is initialized in textarea.' );
  140. },
  141. err => {
  142. assertCKEditorError( err,
  143. /^editor-wrong-element: This type of editor cannot be initialized inside <textarea> element\./,
  144. null
  145. );
  146. }
  147. )
  148. .then( done )
  149. .catch( done );
  150. } );
  151. function test( getElementOrData ) {
  152. it( 'creates an instance which inherits from the DecoupledEditor', () => {
  153. return DecoupledEditor
  154. .create( getElementOrData(), {
  155. plugins: [ Paragraph, Bold ]
  156. } )
  157. .then( newEditor => {
  158. expect( newEditor ).to.be.instanceof( DecoupledEditor );
  159. return newEditor.destroy();
  160. } );
  161. } );
  162. it( 'loads the initial data', () => {
  163. return DecoupledEditor
  164. .create( getElementOrData(), {
  165. plugins: [ Paragraph, Bold ]
  166. } )
  167. .then( newEditor => {
  168. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  169. return newEditor.destroy();
  170. } );
  171. } );
  172. it( 'should not require config object', () => {
  173. // Just being safe with `builtinPlugins` static property.
  174. class CustomDecoupledEditor extends DecoupledEditor {}
  175. CustomDecoupledEditor.builtinPlugins = [ Paragraph, Bold ];
  176. return CustomDecoupledEditor.create( getElementOrData() )
  177. .then( newEditor => {
  178. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  179. return newEditor.destroy();
  180. } );
  181. } );
  182. // https://github.com/ckeditor/ckeditor5-editor-classic/issues/53
  183. it( 'creates an instance of a DecoupledEditor child class', () => {
  184. class CustomDecoupledEditor extends DecoupledEditor {}
  185. return CustomDecoupledEditor
  186. .create( getElementOrData(), {
  187. plugins: [ Paragraph, Bold ]
  188. } )
  189. .then( newEditor => {
  190. expect( newEditor ).to.be.instanceof( CustomDecoupledEditor );
  191. expect( newEditor ).to.be.instanceof( DecoupledEditor );
  192. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  193. return newEditor.destroy();
  194. } );
  195. } );
  196. // https://github.com/ckeditor/ckeditor5-editor-decoupled/issues/3
  197. it( 'initializes the data controller', () => {
  198. let dataInitSpy;
  199. class DataInitAssertPlugin extends Plugin {
  200. constructor( editor ) {
  201. super();
  202. this.editor = editor;
  203. }
  204. init() {
  205. dataInitSpy = sinon.spy( this.editor.data, 'init' );
  206. }
  207. }
  208. return DecoupledEditor
  209. .create( getElementOrData(), {
  210. plugins: [ Paragraph, Bold, DataInitAssertPlugin ]
  211. } )
  212. .then( newEditor => {
  213. sinon.assert.calledOnce( dataInitSpy );
  214. return newEditor.destroy();
  215. } );
  216. } );
  217. describe( 'events', () => {
  218. it( 'fires all events in the right order', () => {
  219. const fired = [];
  220. function spy( evt ) {
  221. fired.push( `${ evt.name }-${ evt.source.constructor.name.toLowerCase() }` );
  222. }
  223. class EventWatcher extends Plugin {
  224. init() {
  225. this.editor.ui.on( 'ready', spy );
  226. this.editor.data.on( 'ready', spy );
  227. this.editor.on( 'ready', spy );
  228. }
  229. }
  230. return DecoupledEditor
  231. .create( getElementOrData(), {
  232. plugins: [ EventWatcher ]
  233. } )
  234. .then( newEditor => {
  235. expect( fired ).to.deep.equal( [
  236. 'ready-decouplededitorui',
  237. 'ready-datacontroller',
  238. 'ready-decouplededitor'
  239. ] );
  240. return newEditor.destroy();
  241. } );
  242. } );
  243. it( 'fires ready once UI is rendered', () => {
  244. let isReady;
  245. class EventWatcher extends Plugin {
  246. init() {
  247. this.editor.ui.on( 'ready', () => {
  248. isReady = this.editor.ui.view.isRendered;
  249. } );
  250. }
  251. }
  252. return DecoupledEditor
  253. .create( getElementOrData(), {
  254. plugins: [ EventWatcher ]
  255. } )
  256. .then( newEditor => {
  257. expect( isReady ).to.be.true;
  258. return newEditor.destroy();
  259. } );
  260. } );
  261. } );
  262. }
  263. } );
  264. describe( 'destroy', () => {
  265. describe( 'editor with data', () => {
  266. beforeEach( function() {
  267. return DecoupledEditor
  268. .create( editorData, { plugins: [ Paragraph ] } )
  269. .then( newEditor => {
  270. editor = newEditor;
  271. } );
  272. } );
  273. test( () => editorData );
  274. } );
  275. describe( 'editor with editable element', () => {
  276. let editableElement;
  277. beforeEach( function() {
  278. editableElement = document.createElement( 'div' );
  279. editableElement.innerHTML = editorData;
  280. return DecoupledEditor
  281. .create( editableElement, { plugins: [ Paragraph ] } )
  282. .then( newEditor => {
  283. editor = newEditor;
  284. } );
  285. } );
  286. it( 'sets data back to the element', () => {
  287. editor.setData( '<p>foo</p>' );
  288. return editor.destroy()
  289. .then( () => {
  290. expect( editableElement.innerHTML ).to.equal( '<p>foo</p>' );
  291. } );
  292. } );
  293. test( () => editableElement );
  294. } );
  295. function test() {
  296. it( 'destroys the UI', () => {
  297. const spy = sinon.spy( editor.ui, 'destroy' );
  298. return editor.destroy()
  299. .then( () => {
  300. sinon.assert.calledOnce( spy );
  301. } );
  302. } );
  303. }
  304. } );
  305. describeMemoryUsage( () => {
  306. testMemoryUsage(
  307. 'should not grow on multiple create/destroy',
  308. () => DecoupledEditor
  309. .create( document.querySelector( '#mem-editor' ), {
  310. plugins: [ ArticlePluginSet ],
  311. toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote' ],
  312. image: {
  313. toolbar: [ 'imageStyle:full', 'imageStyle:side', '|', 'imageTextAlternative' ]
  314. }
  315. } ) );
  316. } );
  317. } );