8
0

decouplededitor.js 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  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 */
  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. it( 'throws error if it is initialized in textarea', done => {
  107. DecoupledEditor.create( document.createElement( 'textarea' ) )
  108. .then(
  109. () => {
  110. expect.fail( 'Decoupled editor should throw an error when is initialized in textarea.' );
  111. },
  112. err => {
  113. expect( err ).to.be.an( 'error' ).with.property( 'message' ).and
  114. .match( /^editor-wrong-element: This type of editor cannot be initialized inside <textarea> element\./ );
  115. }
  116. )
  117. .then( done )
  118. .catch( done );
  119. } );
  120. function test( getElementOrData ) {
  121. it( 'creates an instance which inherits from the DecoupledEditor', () => {
  122. return DecoupledEditor
  123. .create( getElementOrData(), {
  124. plugins: [ Paragraph, Bold ]
  125. } )
  126. .then( newEditor => {
  127. expect( newEditor ).to.be.instanceof( DecoupledEditor );
  128. return newEditor.destroy();
  129. } );
  130. } );
  131. it( 'loads the initial data', () => {
  132. return DecoupledEditor
  133. .create( getElementOrData(), {
  134. plugins: [ Paragraph, Bold ]
  135. } )
  136. .then( newEditor => {
  137. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  138. return newEditor.destroy();
  139. } );
  140. } );
  141. it( 'should not require config object', () => {
  142. // Just being safe with `builtinPlugins` static property.
  143. class CustomDecoupledEditor extends DecoupledEditor {}
  144. CustomDecoupledEditor.builtinPlugins = [ Paragraph, Bold ];
  145. return CustomDecoupledEditor.create( getElementOrData() )
  146. .then( newEditor => {
  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-classic/issues/53
  152. it( 'creates an instance of a DecoupledEditor child class', () => {
  153. class CustomDecoupledEditor extends DecoupledEditor {}
  154. return CustomDecoupledEditor
  155. .create( getElementOrData(), {
  156. plugins: [ Paragraph, Bold ]
  157. } )
  158. .then( newEditor => {
  159. expect( newEditor ).to.be.instanceof( CustomDecoupledEditor );
  160. expect( newEditor ).to.be.instanceof( DecoupledEditor );
  161. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  162. return newEditor.destroy();
  163. } );
  164. } );
  165. // https://github.com/ckeditor/ckeditor5-editor-decoupled/issues/3
  166. it( 'initializes the data controller', () => {
  167. let dataInitSpy;
  168. class DataInitAssertPlugin extends Plugin {
  169. constructor( editor ) {
  170. super();
  171. this.editor = editor;
  172. }
  173. init() {
  174. dataInitSpy = sinon.spy( this.editor.data, 'init' );
  175. }
  176. }
  177. return DecoupledEditor
  178. .create( getElementOrData(), {
  179. plugins: [ Paragraph, Bold, DataInitAssertPlugin ]
  180. } )
  181. .then( newEditor => {
  182. sinon.assert.calledOnce( dataInitSpy );
  183. return newEditor.destroy();
  184. } );
  185. } );
  186. describe( 'events', () => {
  187. it( 'fires all events in the right order', () => {
  188. const fired = [];
  189. function spy( evt ) {
  190. fired.push( `${ evt.name }-${ evt.source.constructor.name.toLowerCase() }` );
  191. }
  192. class EventWatcher extends Plugin {
  193. init() {
  194. this.editor.ui.on( 'ready', spy );
  195. this.editor.data.on( 'ready', spy );
  196. this.editor.on( 'ready', spy );
  197. }
  198. }
  199. return DecoupledEditor
  200. .create( getElementOrData(), {
  201. plugins: [ EventWatcher ]
  202. } )
  203. .then( newEditor => {
  204. expect( fired ).to.deep.equal( [
  205. 'ready-decouplededitorui',
  206. 'ready-datacontroller',
  207. 'ready-decouplededitor'
  208. ] );
  209. return newEditor.destroy();
  210. } );
  211. } );
  212. it( 'fires ready once UI is rendered', () => {
  213. let isReady;
  214. class EventWatcher extends Plugin {
  215. init() {
  216. this.editor.ui.on( 'ready', () => {
  217. isReady = this.editor.ui.view.isRendered;
  218. } );
  219. }
  220. }
  221. return DecoupledEditor
  222. .create( getElementOrData(), {
  223. plugins: [ EventWatcher ]
  224. } )
  225. .then( newEditor => {
  226. expect( isReady ).to.be.true;
  227. return newEditor.destroy();
  228. } );
  229. } );
  230. } );
  231. }
  232. } );
  233. describe( 'destroy', () => {
  234. describe( 'editor with data', () => {
  235. beforeEach( function() {
  236. return DecoupledEditor
  237. .create( editorData, { plugins: [ Paragraph ] } )
  238. .then( newEditor => {
  239. editor = newEditor;
  240. } );
  241. } );
  242. test( () => editorData );
  243. } );
  244. describe( 'editor with editable element', () => {
  245. let editableElement;
  246. beforeEach( function() {
  247. editableElement = document.createElement( 'div' );
  248. editableElement.innerHTML = editorData;
  249. return DecoupledEditor
  250. .create( editableElement, { plugins: [ Paragraph ] } )
  251. .then( newEditor => {
  252. editor = newEditor;
  253. } );
  254. } );
  255. it( 'sets data back to the element', () => {
  256. editor.setData( '<p>foo</p>' );
  257. return editor.destroy()
  258. .then( () => {
  259. expect( editableElement.innerHTML ).to.equal( '<p>foo</p>' );
  260. } );
  261. } );
  262. test( () => editableElement );
  263. } );
  264. function test() {
  265. it( 'destroys the UI', () => {
  266. const spy = sinon.spy( editor.ui, 'destroy' );
  267. return editor.destroy()
  268. .then( () => {
  269. sinon.assert.calledOnce( spy );
  270. } );
  271. } );
  272. }
  273. } );
  274. describeMemoryUsage( () => {
  275. testMemoryUsage(
  276. 'should not grow on multiple create/destroy',
  277. () => DecoupledEditor
  278. .create( document.querySelector( '#mem-editor' ), {
  279. plugins: [ ArticlePluginSet ],
  280. toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote' ],
  281. image: {
  282. toolbar: [ 'imageStyle:full', 'imageStyle:side', '|', 'imageTextAlternative' ]
  283. }
  284. } ) );
  285. } );
  286. } );