editingcontroller.js 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* globals setTimeout, document */
  6. import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
  7. import EditingController from '../../src/controller/editingcontroller';
  8. import View from '../../src/view/view';
  9. import Mapper from '../../src/conversion/mapper';
  10. import DowncastDispatcher from '../../src/conversion/downcastdispatcher';
  11. import DowncastHelpers from '../../src/conversion/downcasthelpers';
  12. import Model from '../../src/model/model';
  13. import ModelPosition from '../../src/model/position';
  14. import ModelRange from '../../src/model/range';
  15. import ModelDocumentFragment from '../../src/model/documentfragment';
  16. import { getData as getModelData, parse } from '../../src/dev-utils/model';
  17. import { getData as getViewData } from '../../src/dev-utils/view';
  18. import { StylesProcessor } from '../../src/view/stylesmap';
  19. describe( 'EditingController', () => {
  20. describe( 'constructor()', () => {
  21. let model, editing;
  22. beforeEach( () => {
  23. model = new Model();
  24. editing = new EditingController( model, new StylesProcessor() );
  25. } );
  26. afterEach( () => {
  27. editing.destroy();
  28. } );
  29. it( 'should create controller with properties', () => {
  30. expect( editing ).to.have.property( 'model' ).that.equals( model );
  31. expect( editing ).to.have.property( 'view' ).that.is.instanceof( View );
  32. expect( editing ).to.have.property( 'mapper' ).that.is.instanceof( Mapper );
  33. expect( editing ).to.have.property( 'downcastDispatcher' ).that.is.instanceof( DowncastDispatcher );
  34. editing.destroy();
  35. } );
  36. it( 'should be observable', () => {
  37. const spy = sinon.spy();
  38. editing.on( 'change:foo', spy );
  39. editing.set( 'foo', 'bar' );
  40. sinon.assert.calledOnce( spy );
  41. } );
  42. it( 'should bind view roots to model roots', () => {
  43. expect( model.document.roots ).to.length( 1 ); // $graveyard
  44. expect( editing.view.document.roots ).to.length( 0 );
  45. const modelRoot = model.document.createRoot();
  46. expect( model.document.roots ).to.length( 2 );
  47. expect( editing.view.document.roots ).to.length( 1 );
  48. expect( editing.view.document.getRoot().document ).to.equal( editing.view.document );
  49. expect( editing.view.document.getRoot().name ).to.equal( modelRoot.name ).to.equal( '$root' );
  50. } );
  51. } );
  52. describe( 'conversion', () => {
  53. let model, modelRoot, viewRoot, domRoot, editing, listener;
  54. beforeEach( () => {
  55. listener = Object.create( EmitterMixin );
  56. model = new Model();
  57. modelRoot = model.document.createRoot();
  58. editing = new EditingController( model, new StylesProcessor() );
  59. domRoot = document.createElement( 'div' );
  60. domRoot.contentEditable = true;
  61. document.body.appendChild( domRoot );
  62. viewRoot = editing.view.document.getRoot();
  63. editing.view.attachDomRoot( domRoot );
  64. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  65. model.schema.register( 'div', { inheritAllFrom: '$block' } );
  66. const downcastHelpers = new DowncastHelpers( [ editing.downcastDispatcher ] );
  67. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  68. downcastHelpers.elementToElement( { model: 'div', view: 'div' } );
  69. downcastHelpers.markerToHighlight( { model: 'marker', view: {} } );
  70. // Note: The below code is highly overcomplicated due to #455.
  71. model.change( writer => {
  72. writer.setSelection( null );
  73. } );
  74. modelRoot._removeChildren( 0, modelRoot.childCount );
  75. viewRoot._removeChildren( 0, viewRoot.childCount );
  76. const modelData = new ModelDocumentFragment( parse(
  77. '<paragraph>foo</paragraph>' +
  78. '<paragraph></paragraph>' +
  79. '<paragraph>bar</paragraph>',
  80. model.schema
  81. )._children );
  82. model.change( writer => {
  83. writer.insert( modelData, model.document.getRoot() );
  84. writer.setSelection( writer.createRange(
  85. writer.createPositionAt( modelRoot.getChild( 0 ), 1 ),
  86. writer.createPositionAt( modelRoot.getChild( 0 ), 1 )
  87. ) );
  88. } );
  89. } );
  90. afterEach( () => {
  91. document.body.removeChild( domRoot );
  92. listener.stopListening();
  93. editing.destroy();
  94. } );
  95. it( 'should convert insertion', () => {
  96. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  97. } );
  98. it( 'should convert split', () => {
  99. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  100. model.change( writer => {
  101. writer.split( model.document.selection.getFirstPosition() );
  102. writer.setSelection( writer.createRange(
  103. writer.createPositionAt( modelRoot.getChild( 1 ), 0 ),
  104. writer.createPositionAt( modelRoot.getChild( 1 ), 0 )
  105. ) );
  106. } );
  107. expect( getViewData( editing.view ) ).to.equal( '<p>f</p><p>{}oo</p><p></p><p>bar</p>' );
  108. } );
  109. it( 'should convert rename', () => {
  110. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  111. model.change( writer => {
  112. writer.rename( modelRoot.getChild( 0 ), 'div' );
  113. } );
  114. expect( getViewData( editing.view ) ).to.equal( '<div>f{}oo</div><p></p><p>bar</p>' );
  115. } );
  116. it( 'should convert delete', () => {
  117. model.change( writer => {
  118. writer.remove(
  119. ModelRange._createFromPositionAndShift( model.document.selection.getFirstPosition(), 1 )
  120. );
  121. writer.setSelection( writer.createRange(
  122. writer.createPositionAt( modelRoot.getChild( 0 ), 1 ),
  123. writer.createPositionAt( modelRoot.getChild( 0 ), 1 )
  124. ) );
  125. } );
  126. expect( getViewData( editing.view ) ).to.equal( '<p>f{}o</p><p></p><p>bar</p>' );
  127. } );
  128. it( 'should convert selection from view to model', done => {
  129. listener.listenTo( editing.view.document, 'selectionChange', () => {
  130. setTimeout( () => {
  131. expect( getModelData( model ) ).to.equal(
  132. '<paragraph>foo</paragraph>' +
  133. '<paragraph></paragraph>' +
  134. '<paragraph>b[a]r</paragraph>'
  135. );
  136. done();
  137. }, 1 );
  138. } );
  139. editing.view.document.isFocused = true;
  140. editing.view.forceRender();
  141. const domSelection = document.getSelection();
  142. domSelection.removeAllRanges();
  143. const domBar = domRoot.childNodes[ 2 ].childNodes[ 0 ];
  144. const domRange = document.createRange();
  145. domRange.setStart( domBar, 1 );
  146. domRange.setEnd( domBar, 2 );
  147. domSelection.addRange( domRange );
  148. } );
  149. it( 'should convert collapsed selection', () => {
  150. model.change( writer => {
  151. writer.setSelection( writer.createRange(
  152. writer.createPositionAt( modelRoot.getChild( 2 ), 1 ),
  153. writer.createPositionAt( modelRoot.getChild( 2 ), 1 )
  154. ) );
  155. } );
  156. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  157. } );
  158. it( 'should convert not collapsed selection', () => {
  159. model.change( writer => {
  160. writer.setSelection( writer.createRange(
  161. writer.createPositionAt( modelRoot.getChild( 2 ), 1 ),
  162. writer.createPositionAt( modelRoot.getChild( 2 ), 2 )
  163. ) );
  164. } );
  165. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{a}r</p>' );
  166. } );
  167. it( 'should clear previous selection', () => {
  168. model.change( writer => {
  169. writer.setSelection( writer.createRange(
  170. writer.createPositionAt( modelRoot.getChild( 2 ), 1 ),
  171. writer.createPositionAt( modelRoot.getChild( 2 ), 1 )
  172. ) );
  173. } );
  174. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  175. model.change( writer => {
  176. writer.setSelection( writer.createRange(
  177. writer.createPositionAt( modelRoot.getChild( 2 ), 2 ),
  178. writer.createPositionAt( modelRoot.getChild( 2 ), 2 )
  179. ) );
  180. } );
  181. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>ba{}r</p>' );
  182. } );
  183. it( 'should convert adding marker', () => {
  184. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  185. model.change( writer => {
  186. writer.addMarker( 'marker', { range, usingOperation: false } );
  187. } );
  188. expect( getViewData( editing.view, { withoutSelection: true } ) )
  189. .to.equal( '<p>f<span>oo</span></p><p></p><p><span>ba</span>r</p>' );
  190. } );
  191. it( 'should convert removing marker', () => {
  192. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  193. model.change( writer => {
  194. writer.addMarker( 'marker', { range, usingOperation: false } );
  195. } );
  196. model.change( writer => {
  197. writer.removeMarker( 'marker' );
  198. } );
  199. expect( getViewData( editing.view, { withoutSelection: true } ) )
  200. .to.equal( '<p>foo</p><p></p><p>bar</p>' );
  201. } );
  202. it( 'should convert changing marker', () => {
  203. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  204. model.change( writer => {
  205. writer.addMarker( 'marker', { range, usingOperation: false } );
  206. } );
  207. const range2 = new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 2 ] ) );
  208. model.change( writer => {
  209. writer.updateMarker( 'marker', { range: range2 } );
  210. } );
  211. expect( getViewData( editing.view, { withoutSelection: true } ) )
  212. .to.equal( '<p><span>fo</span>o</p><p></p><p>bar</p>' );
  213. } );
  214. it( 'should convert insertion into marker', () => {
  215. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  216. model.change( writer => {
  217. writer.addMarker( 'marker', { range, usingOperation: false } );
  218. writer.insertText( 'xyz', new ModelPosition( modelRoot, [ 1, 0 ] ) );
  219. } );
  220. expect( getViewData( editing.view, { withoutSelection: true } ) )
  221. .to.equal( '<p>f<span>oo</span></p><p><span>xyz</span></p><p><span>ba</span>r</p>' );
  222. } );
  223. it( 'should convert move to marker', () => {
  224. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  225. model.change( writer => {
  226. writer.addMarker( 'marker', { range, usingOperation: false } );
  227. } );
  228. model.change( writer => {
  229. writer.move(
  230. new ModelRange( new ModelPosition( modelRoot, [ 2, 2 ] ), new ModelPosition( modelRoot, [ 2, 3 ] ) ),
  231. new ModelPosition( modelRoot, [ 0, 3 ] )
  232. );
  233. } );
  234. expect( getViewData( editing.view, { withoutSelection: true } ) )
  235. .to.equal( '<p>f<span>oor</span></p><p></p><p><span>ba</span></p>' );
  236. } );
  237. it( 'should convert move from marker', () => {
  238. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  239. model.change( writer => {
  240. writer.addMarker( 'marker', { range, usingOperation: false } );
  241. } );
  242. model.change( writer => {
  243. writer.move(
  244. new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) ),
  245. new ModelPosition( modelRoot, [ 2, 3 ] )
  246. );
  247. } );
  248. expect( getViewData( editing.view, { withoutSelection: true } ) )
  249. .to.equal( '<p>f</p><p></p><p><span>ba</span>roo</p>' );
  250. } );
  251. it( 'should convert the whole marker move', () => {
  252. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) );
  253. model.change( writer => {
  254. writer.addMarker( 'marker', { range, usingOperation: false } );
  255. } );
  256. model.change( writer => {
  257. writer.move(
  258. new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) ),
  259. new ModelPosition( modelRoot, [ 1, 0 ] )
  260. );
  261. } );
  262. expect( getViewData( editing.view, { withoutSelection: true } ) )
  263. .to.equal( '<p></p><p>f<span>oo</span></p><p>bar</p>' );
  264. } );
  265. describe( 'preventing rendering while in the model.change() block', () => {
  266. let renderSpy;
  267. beforeEach( () => {
  268. renderSpy = sinon.spy();
  269. editing.view.on( 'render', renderSpy );
  270. } );
  271. it( 'should not call render in the model.change() block', () => {
  272. model.change( writer => {
  273. executeSomeModelChange( writer );
  274. expect( renderSpy.called ).to.be.false;
  275. } );
  276. expect( renderSpy.called ).to.be.true;
  277. } );
  278. it( 'should not call render in the model.change() block even if view.change() was called', () => {
  279. model.change( writer => {
  280. executeSomeModelChange( writer );
  281. editing.view.change( writer => executeSomeViewChange( writer ) );
  282. expect( renderSpy.called ).to.be.false;
  283. } );
  284. expect( renderSpy.called ).to.be.true;
  285. } );
  286. it( 'should not call render in enqueued changes', () => {
  287. model.enqueueChange( writer => {
  288. executeSomeModelChange( writer );
  289. expect( renderSpy.called ).to.be.false;
  290. model.enqueueChange( writer => {
  291. executeSomeOtherModelChange( writer );
  292. expect( renderSpy.called ).to.be.false;
  293. } );
  294. expect( renderSpy.called ).to.be.false;
  295. } );
  296. expect( renderSpy.called ).to.be.true;
  297. } );
  298. it( 'should not call render if some model changes were executed in the post fixer', () => {
  299. const postfixerSpy = sinon.spy();
  300. model.document.registerPostFixer( () => {
  301. model.change( writer => executeSomeOtherModelChange( writer ) );
  302. expect( renderSpy.called ).to.be.false;
  303. postfixerSpy();
  304. } );
  305. model.change( writer => {
  306. executeSomeModelChange( writer );
  307. expect( renderSpy.called ).to.be.false;
  308. } );
  309. expect( renderSpy.called ).to.be.true;
  310. expect( postfixerSpy.calledOnce ).to.be.true;
  311. } );
  312. it( 'should not call render if some view changes were executed in the change listener', () => {
  313. const changeListenerSpy = sinon.spy();
  314. model.document.on( 'change', () => {
  315. editing.view.change( writer => executeSomeViewChange( writer ) );
  316. expect( renderSpy.called ).to.be.false;
  317. changeListenerSpy();
  318. } );
  319. model.change( writer => {
  320. executeSomeModelChange( writer );
  321. expect( renderSpy.called ).to.be.false;
  322. } );
  323. expect( renderSpy.called ).to.be.true;
  324. expect( changeListenerSpy.calledOnce ).to.be.true;
  325. } );
  326. it( 'should call view post-fixers once for model.change() block', () => {
  327. const postfixerSpy = sinon.spy();
  328. editing.view.document.registerPostFixer( postfixerSpy );
  329. model.change( writer => {
  330. executeSomeModelChange( writer );
  331. editing.view.change( writer => {
  332. executeSomeViewChange( writer );
  333. } );
  334. } );
  335. sinon.assert.calledOnce( postfixerSpy );
  336. } );
  337. function executeSomeModelChange( writer ) {
  338. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  339. writer.addMarker( 'marker1', { range, usingOperation: true } );
  340. }
  341. function executeSomeOtherModelChange( writer ) {
  342. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  343. writer.addMarker( 'marker2', { range, usingOperation: true } );
  344. }
  345. function executeSomeViewChange( writer ) {
  346. writer.addClass( 'foo', editing.view.document.getRoot() );
  347. }
  348. } );
  349. } );
  350. describe( 'destroy()', () => {
  351. it( 'should remove listenters', () => {
  352. const model = new Model();
  353. model.document.createRoot();
  354. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  355. const editing = new EditingController( model, new StylesProcessor() );
  356. const spy = sinon.spy();
  357. editing.downcastDispatcher.on( 'insert:$element', spy );
  358. editing.destroy();
  359. model.change( writer => {
  360. const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
  361. writer.insert( modelData, model.document.getRoot() );
  362. } );
  363. expect( spy.called ).to.be.false;
  364. editing.destroy();
  365. } );
  366. it( 'should destroy view', () => {
  367. const model = new Model();
  368. model.document.createRoot();
  369. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  370. const editing = new EditingController( model, new StylesProcessor() );
  371. const spy = sinon.spy( editing.view, 'destroy' );
  372. editing.destroy();
  373. expect( spy.called ).to.be.true;
  374. } );
  375. } );
  376. } );