8
0

editingcontroller.js 16 KB

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