decouplededitor.js 10.0 KB

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