editingcontroller.js 16 KB

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