editingcontroller.js 15 KB

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