8
0

editingcontroller.js 16 KB

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