decouplededitor.js 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document, setTimeout */
  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 log from '@ckeditor/ckeditor5-utils/src/log';
  17. import { describeMemoryUsage, testMemoryUsage } from '@ckeditor/ckeditor5-core/tests/_utils/memory';
  18. import ArticlePluginSet from '@ckeditor/ckeditor5-core/tests/_utils/articlepluginset';
  19. const editorData = '<p><strong>foo</strong> bar</p>';
  20. describe( 'DecoupledEditor', () => {
  21. let editor;
  22. testUtils.createSinonSandbox();
  23. beforeEach( () => {
  24. testUtils.sinon.stub( log, '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. it( 'throws if initial data is passed in Editor#create and config.initialData is also used', done => {
  99. DecoupledEditor.create( '<p>Hello world!</p>', {
  100. initialData: '<p>I am evil!</p>',
  101. plugins: [ Paragraph ]
  102. } ).catch( () => {
  103. done();
  104. } );
  105. } );
  106. function test( getElementOrData ) {
  107. it( 'creates an instance which inherits from the DecoupledEditor', () => {
  108. return DecoupledEditor
  109. .create( getElementOrData(), {
  110. plugins: [ Paragraph, Bold ]
  111. } )
  112. .then( newEditor => {
  113. expect( newEditor ).to.be.instanceof( DecoupledEditor );
  114. return newEditor.destroy();
  115. } );
  116. } );
  117. it( 'loads the initial data', () => {
  118. return DecoupledEditor
  119. .create( getElementOrData(), {
  120. plugins: [ Paragraph, Bold ]
  121. } )
  122. .then( newEditor => {
  123. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  124. return newEditor.destroy();
  125. } );
  126. } );
  127. it( 'should not require config object', () => {
  128. // Just being safe with `builtinPlugins` static property.
  129. class CustomDecoupledEditor extends DecoupledEditor {}
  130. CustomDecoupledEditor.builtinPlugins = [ Paragraph, Bold ];
  131. return CustomDecoupledEditor.create( getElementOrData() )
  132. .then( newEditor => {
  133. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  134. return newEditor.destroy();
  135. } );
  136. } );
  137. // https://github.com/ckeditor/ckeditor5-editor-classic/issues/53
  138. it( 'creates an instance of a DecoupledEditor child class', () => {
  139. class CustomDecoupledEditor extends DecoupledEditor {}
  140. return CustomDecoupledEditor
  141. .create( getElementOrData(), {
  142. plugins: [ Paragraph, Bold ]
  143. } )
  144. .then( newEditor => {
  145. expect( newEditor ).to.be.instanceof( CustomDecoupledEditor );
  146. expect( newEditor ).to.be.instanceof( DecoupledEditor );
  147. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  148. return newEditor.destroy();
  149. } );
  150. } );
  151. // https://github.com/ckeditor/ckeditor5-editor-decoupled/issues/3
  152. it( 'initializes the data controller', () => {
  153. let dataInitSpy;
  154. class DataInitAssertPlugin extends Plugin {
  155. constructor( editor ) {
  156. super();
  157. this.editor = editor;
  158. }
  159. init() {
  160. dataInitSpy = sinon.spy( this.editor.data, 'init' );
  161. }
  162. }
  163. return DecoupledEditor
  164. .create( getElementOrData(), {
  165. plugins: [ Paragraph, Bold, DataInitAssertPlugin ]
  166. } )
  167. .then( newEditor => {
  168. sinon.assert.calledOnce( dataInitSpy );
  169. return newEditor.destroy();
  170. } );
  171. } );
  172. describe( 'events', () => {
  173. it( 'fires all events in the right order', () => {
  174. const fired = [];
  175. function spy( evt ) {
  176. fired.push( `${ evt.name }-${ evt.source.constructor.name.toLowerCase() }` );
  177. }
  178. class EventWatcher extends Plugin {
  179. init() {
  180. this.editor.ui.on( 'ready', spy );
  181. this.editor.data.on( 'ready', spy );
  182. this.editor.on( 'ready', spy );
  183. }
  184. }
  185. return DecoupledEditor
  186. .create( getElementOrData(), {
  187. plugins: [ EventWatcher ]
  188. } )
  189. .then( newEditor => {
  190. expect( fired ).to.deep.equal( [
  191. 'ready-decouplededitorui',
  192. 'ready-datacontroller',
  193. 'ready-decouplededitor'
  194. ] );
  195. return newEditor.destroy();
  196. } );
  197. } );
  198. it( 'fires ready once UI is rendered', () => {
  199. let isReady;
  200. class EventWatcher extends Plugin {
  201. init() {
  202. this.editor.ui.on( 'ready', () => {
  203. isReady = this.editor.ui.view.isRendered;
  204. } );
  205. }
  206. }
  207. return DecoupledEditor
  208. .create( getElementOrData(), {
  209. plugins: [ EventWatcher ]
  210. } )
  211. .then( newEditor => {
  212. expect( isReady ).to.be.true;
  213. return newEditor.destroy();
  214. } );
  215. } );
  216. } );
  217. }
  218. } );
  219. describe( 'destroy', () => {
  220. describe( 'editor with data', () => {
  221. beforeEach( function() {
  222. return DecoupledEditor
  223. .create( editorData, { plugins: [ Paragraph ] } )
  224. .then( newEditor => {
  225. editor = newEditor;
  226. } );
  227. } );
  228. test( () => editorData );
  229. } );
  230. describe( 'editor with editable element', () => {
  231. let editableElement;
  232. beforeEach( function() {
  233. editableElement = document.createElement( 'div' );
  234. editableElement.innerHTML = editorData;
  235. return DecoupledEditor
  236. .create( editableElement, { plugins: [ Paragraph ] } )
  237. .then( newEditor => {
  238. editor = newEditor;
  239. } );
  240. } );
  241. it( 'sets data back to the element', () => {
  242. editor.setData( '<p>foo</p>' );
  243. return editor.destroy()
  244. .then( () => {
  245. expect( editableElement.innerHTML ).to.equal( '<p>foo</p>' );
  246. } );
  247. } );
  248. test( () => editableElement );
  249. } );
  250. function test() {
  251. it( 'destroys the UI', () => {
  252. const spy = sinon.spy( editor.ui, 'destroy' );
  253. return editor.destroy()
  254. .then( () => {
  255. sinon.assert.calledOnce( spy );
  256. } );
  257. } );
  258. }
  259. } );
  260. describeMemoryUsage( () => {
  261. testMemoryUsage(
  262. 'should not grow on multiple create/destroy',
  263. () => DecoupledEditor
  264. .create( document.querySelector( '#mem-editor' ), {
  265. plugins: [ ArticlePluginSet ],
  266. toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote' ],
  267. image: {
  268. toolbar: [ 'imageStyle:full', 'imageStyle:side', '|', 'imageTextAlternative' ]
  269. }
  270. } ) );
  271. } );
  272. } );