editingcontroller.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  1. /**
  2. * @license Copyright (c) 2003-2017, 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 ViewDocument from '../../src/view/document';
  9. import Mapper from '../../src/conversion/mapper';
  10. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  11. import buildModelConverter from '../../src/conversion/buildmodelconverter';
  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 createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  17. import { parse, getData as getModelData } from '../../src/dev-utils/model';
  18. import { getData as getViewData } from '../../src/dev-utils/view';
  19. describe( 'EditingController', () => {
  20. describe( 'constructor()', () => {
  21. let model, editing;
  22. beforeEach( () => {
  23. model = new Model();
  24. editing = new EditingController( model );
  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( ViewDocument );
  32. expect( editing ).to.have.property( 'mapper' ).that.is.instanceof( Mapper );
  33. expect( editing ).to.have.property( 'modelToView' ).that.is.instanceof( ModelConversionDispatcher );
  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. } );
  43. describe( 'createRoot()', () => {
  44. let model, modelRoot, editing;
  45. beforeEach( () => {
  46. model = new Model();
  47. modelRoot = model.document.createRoot();
  48. model.document.createRoot( '$root', 'header' );
  49. editing = new EditingController( model );
  50. } );
  51. afterEach( () => {
  52. editing.destroy();
  53. model.markers.destroy();
  54. } );
  55. it( 'should create root', () => {
  56. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  57. const viewRoot = editing.createRoot( domRoot );
  58. expect( viewRoot ).to.equal( editing.view.getRoot() );
  59. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  60. expect( editing.view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domRoot );
  61. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  62. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( modelRoot );
  63. expect( editing.mapper.toViewElement( modelRoot ) ).to.equal( viewRoot );
  64. } );
  65. it( 'should create root with given name', () => {
  66. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  67. const viewRoot = editing.createRoot( domRoot, 'header' );
  68. expect( viewRoot ).to.equal( editing.view.getRoot( 'header' ) );
  69. expect( domRoot ).to.equal( editing.view.getDomRoot( 'header' ) );
  70. expect( editing.view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domRoot );
  71. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  72. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( model.document.getRoot( 'header' ) );
  73. expect( editing.mapper.toViewElement( model.document.getRoot( 'header' ) ) ).to.equal( viewRoot );
  74. } );
  75. it( 'should be possible to attach DOM element later', () => {
  76. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  77. const viewRoot = editing.createRoot( 'div' );
  78. expect( viewRoot ).to.equal( editing.view.getRoot() );
  79. expect( editing.view.getDomRoot() ).to.be.undefined;
  80. editing.view.attachDomRoot( domRoot );
  81. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  82. expect( editing.view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domRoot );
  83. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  84. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( modelRoot );
  85. expect( editing.mapper.toViewElement( modelRoot ) ).to.equal( viewRoot );
  86. } );
  87. } );
  88. describe( 'conversion', () => {
  89. let model, modelRoot, viewRoot, domRoot, editing, listener;
  90. beforeEach( () => {
  91. listener = Object.create( EmitterMixin );
  92. model = new Model();
  93. modelRoot = model.document.createRoot();
  94. editing = new EditingController( model );
  95. domRoot = document.createElement( 'div' );
  96. domRoot.contentEditable = true;
  97. document.body.appendChild( domRoot );
  98. viewRoot = editing.createRoot( domRoot );
  99. model.schema.registerItem( 'paragraph', '$block' );
  100. model.schema.registerItem( 'div', '$block' );
  101. buildModelConverter().for( editing.modelToView ).fromElement( 'paragraph' ).toElement( 'p' );
  102. buildModelConverter().for( editing.modelToView ).fromElement( 'div' ).toElement( 'div' );
  103. buildModelConverter().for( editing.modelToView ).fromMarker( 'marker' ).toHighlight( {} );
  104. // Note: The below code is highly overcomplicated due to #455.
  105. model.document.selection.removeAllRanges();
  106. modelRoot.removeChildren( 0, modelRoot.childCount );
  107. viewRoot.removeChildren( 0, viewRoot.childCount );
  108. const modelData = new ModelDocumentFragment( parse(
  109. '<paragraph>foo</paragraph>' +
  110. '<paragraph></paragraph>' +
  111. '<paragraph>bar</paragraph>',
  112. model.schema
  113. )._children );
  114. model.change( writer => {
  115. writer.insert( modelData, model.document.getRoot() );
  116. model.document.selection.addRange( ModelRange.createFromParentsAndOffsets(
  117. modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 )
  118. );
  119. } );
  120. } );
  121. afterEach( () => {
  122. document.body.removeChild( domRoot );
  123. listener.stopListening();
  124. editing.destroy();
  125. } );
  126. it( 'should convert insertion', () => {
  127. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  128. } );
  129. it( 'should convert split', () => {
  130. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  131. model.change( writer => {
  132. writer.split( model.document.selection.getFirstPosition() );
  133. model.document.selection.setRanges( [
  134. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 1 ), 0, modelRoot.getChild( 1 ), 0 )
  135. ] );
  136. } );
  137. expect( getViewData( editing.view ) ).to.equal( '<p>f</p><p>{}oo</p><p></p><p>bar</p>' );
  138. } );
  139. it( 'should convert rename', () => {
  140. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  141. model.change( writer => {
  142. writer.rename( modelRoot.getChild( 0 ), 'div' );
  143. } );
  144. expect( getViewData( editing.view ) ).to.equal( '<div>f{}oo</div><p></p><p>bar</p>' );
  145. } );
  146. it( 'should convert delete', () => {
  147. model.change( writer => {
  148. writer.remove(
  149. ModelRange.createFromPositionAndShift( model.document.selection.getFirstPosition(), 1 )
  150. );
  151. model.document.selection.setRanges( [
  152. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 )
  153. ] );
  154. } );
  155. expect( getViewData( editing.view ) ).to.equal( '<p>f{}o</p><p></p><p>bar</p>' );
  156. } );
  157. it( 'should convert selection from view to model', done => {
  158. listener.listenTo( editing.view, 'selectionChange', () => {
  159. setTimeout( () => {
  160. expect( getModelData( model ) ).to.equal(
  161. '<paragraph>foo</paragraph>' +
  162. '<paragraph></paragraph>' +
  163. '<paragraph>b[a]r</paragraph>'
  164. );
  165. done();
  166. } );
  167. } );
  168. editing.view.isFocused = true;
  169. editing.view.render();
  170. const domSelection = document.getSelection();
  171. domSelection.removeAllRanges();
  172. const domBar = domRoot.childNodes[ 2 ].childNodes[ 0 ];
  173. const domRange = document.createRange();
  174. domRange.setStart( domBar, 1 );
  175. domRange.setEnd( domBar, 2 );
  176. domSelection.addRange( domRange );
  177. } );
  178. it( 'should convert collapsed selection', () => {
  179. model.change( () => {
  180. model.document.selection.setRanges( [
  181. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  182. ] );
  183. } );
  184. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  185. } );
  186. it( 'should convert not collapsed selection', () => {
  187. model.change( () => {
  188. model.document.selection.setRanges( [
  189. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 2 )
  190. ] );
  191. } );
  192. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{a}r</p>' );
  193. } );
  194. it( 'should clear previous selection', () => {
  195. model.change( () => {
  196. model.document.selection.setRanges( [
  197. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  198. ] );
  199. } );
  200. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  201. model.change( () => {
  202. model.document.selection.setRanges( [
  203. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 2, modelRoot.getChild( 2 ), 2 )
  204. ] );
  205. } );
  206. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>ba{}r</p>' );
  207. } );
  208. it( 'should convert adding marker', () => {
  209. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  210. model.change( () => {
  211. model.markers.set( 'marker', range );
  212. } );
  213. expect( getViewData( editing.view, { withoutSelection: true } ) )
  214. .to.equal( '<p>f<span>oo</span></p><p></p><p><span>ba</span>r</p>' );
  215. } );
  216. it( 'should convert removing marker', () => {
  217. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  218. model.change( () => {
  219. model.markers.set( 'marker', range );
  220. } );
  221. model.change( () => {
  222. model.markers.remove( 'marker' );
  223. } );
  224. expect( getViewData( editing.view, { withoutSelection: true } ) )
  225. .to.equal( '<p>foo</p><p></p><p>bar</p>' );
  226. } );
  227. it( 'should convert changing marker', () => {
  228. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  229. model.change( () => {
  230. model.markers.set( 'marker', range );
  231. } );
  232. const range2 = new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 2 ] ) );
  233. model.change( () => {
  234. model.markers.set( 'marker', range2 );
  235. } );
  236. expect( getViewData( editing.view, { withoutSelection: true } ) )
  237. .to.equal( '<p><span>fo</span>o</p><p></p><p>bar</p>' );
  238. } );
  239. it( 'should convert insertion into marker', () => {
  240. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  241. model.change( () => {
  242. model.markers.set( 'marker', range );
  243. } );
  244. model.change( writer => {
  245. writer.insertText( 'xyz', new ModelPosition( modelRoot, [ 1, 0 ] ) );
  246. } );
  247. expect( getViewData( editing.view, { withoutSelection: true } ) )
  248. .to.equal( '<p>f<span>oo</span></p><p><span>xyz</span></p><p><span>ba</span>r</p>' );
  249. } );
  250. it( 'should convert move to marker', () => {
  251. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  252. model.change( () => {
  253. model.markers.set( 'marker', range );
  254. } );
  255. model.change( writer => {
  256. writer.move(
  257. new ModelRange( new ModelPosition( modelRoot, [ 2, 2 ] ), new ModelPosition( modelRoot, [ 2, 3 ] ) ),
  258. new ModelPosition( modelRoot, [ 0, 3 ] )
  259. );
  260. } );
  261. expect( getViewData( editing.view, { withoutSelection: true } ) )
  262. .to.equal( '<p>f<span>oor</span></p><p></p><p><span>ba</span></p>' );
  263. } );
  264. it( 'should convert move from marker', () => {
  265. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  266. model.change( () => {
  267. model.markers.set( 'marker', range );
  268. } );
  269. model.change( writer => {
  270. writer.move(
  271. new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) ),
  272. new ModelPosition( modelRoot, [ 2, 3 ] )
  273. );
  274. } );
  275. expect( getViewData( editing.view, { withoutSelection: true } ) )
  276. .to.equal( '<p>f</p><p></p><p><span>ba</span>roo</p>' );
  277. } );
  278. it( 'should convert the whole marker move', () => {
  279. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) );
  280. model.change( () => {
  281. model.markers.set( 'marker', range );
  282. } );
  283. model.change( writer => {
  284. writer.move(
  285. new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) ),
  286. new ModelPosition( modelRoot, [ 1, 0 ] )
  287. );
  288. } );
  289. expect( getViewData( editing.view, { withoutSelection: true } ) )
  290. .to.equal( '<p></p><p>f<span>oo</span></p><p>bar</p>' );
  291. } );
  292. } );
  293. describe( 'destroy()', () => {
  294. it( 'should remove listenters', () => {
  295. const model = new Model();
  296. model.document.createRoot();
  297. model.schema.registerItem( 'paragraph', '$block' );
  298. const editing = new EditingController( model );
  299. const spy = sinon.spy();
  300. editing.modelToView.on( 'insert:$element', spy );
  301. editing.destroy();
  302. model.change( writer => {
  303. const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
  304. writer.insert( modelData, model.document.getRoot() );
  305. } );
  306. expect( spy.called ).to.be.false;
  307. editing.destroy();
  308. } );
  309. it( 'should destroy view', () => {
  310. const model = new Model();
  311. model.document.createRoot();
  312. model.schema.registerItem( 'paragraph', '$block' );
  313. const editing = new EditingController( model );
  314. const spy = sinon.spy( editing.view, 'destroy' );
  315. editing.destroy();
  316. expect( spy.called ).to.be.true;
  317. } );
  318. } );
  319. } );