editingcontroller.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436
  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 ModelDocument from '../../src/model/document';
  13. import ModelPosition from '../../src/model/position';
  14. import ModelElement from '../../src/model/element';
  15. import ModelText from '../../src/model/text';
  16. import ModelRange from '../../src/model/range';
  17. import ModelDocumentFragment from '../../src/model/documentfragment';
  18. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  19. import { parse, getData as getModelData } from '../../src/dev-utils/model';
  20. import { getData as getViewData } from '../../src/dev-utils/view';
  21. describe( 'EditingController', () => {
  22. describe( 'constructor()', () => {
  23. let model, editing;
  24. beforeEach( () => {
  25. model = new ModelDocument();
  26. editing = new EditingController( model );
  27. } );
  28. afterEach( () => {
  29. editing.destroy();
  30. } );
  31. it( 'should create controller with properties', () => {
  32. expect( editing ).to.have.property( 'model' ).that.equals( model );
  33. expect( editing ).to.have.property( 'view' ).that.is.instanceof( ViewDocument );
  34. expect( editing ).to.have.property( 'mapper' ).that.is.instanceof( Mapper );
  35. expect( editing ).to.have.property( 'modelToView' ).that.is.instanceof( ModelConversionDispatcher );
  36. editing.destroy();
  37. } );
  38. it( 'should be observable', () => {
  39. const spy = sinon.spy();
  40. editing.on( 'change:foo', spy );
  41. editing.set( 'foo', 'bar' );
  42. sinon.assert.calledOnce( spy );
  43. } );
  44. } );
  45. describe( 'createRoot()', () => {
  46. let model, modelRoot, editing;
  47. beforeEach( () => {
  48. model = new ModelDocument();
  49. modelRoot = model.createRoot();
  50. model.createRoot( '$root', 'header' );
  51. editing = new EditingController( model );
  52. } );
  53. afterEach( () => {
  54. editing.destroy();
  55. model.markers.destroy();
  56. } );
  57. it( 'should create root', () => {
  58. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  59. const viewRoot = editing.createRoot( domRoot );
  60. expect( viewRoot ).to.equal( editing.view.getRoot() );
  61. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  62. expect( editing.view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domRoot );
  63. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  64. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( modelRoot );
  65. expect( editing.mapper.toViewElement( modelRoot ) ).to.equal( viewRoot );
  66. } );
  67. it( 'should create root with given name', () => {
  68. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  69. const viewRoot = editing.createRoot( domRoot, 'header' );
  70. expect( viewRoot ).to.equal( editing.view.getRoot( 'header' ) );
  71. expect( domRoot ).to.equal( editing.view.getDomRoot( 'header' ) );
  72. expect( editing.view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domRoot );
  73. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  74. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( model.getRoot( 'header' ) );
  75. expect( editing.mapper.toViewElement( model.getRoot( 'header' ) ) ).to.equal( viewRoot );
  76. } );
  77. it( 'should be possible to attach DOM element later', () => {
  78. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  79. const viewRoot = editing.createRoot( 'div' );
  80. expect( viewRoot ).to.equal( editing.view.getRoot() );
  81. expect( editing.view.getDomRoot() ).to.be.undefined;
  82. editing.view.attachDomRoot( domRoot );
  83. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  84. expect( editing.view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domRoot );
  85. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  86. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( modelRoot );
  87. expect( editing.mapper.toViewElement( modelRoot ) ).to.equal( viewRoot );
  88. } );
  89. } );
  90. describe( 'conversion', () => {
  91. let model, modelRoot, viewRoot, domRoot, editing, listener;
  92. beforeEach( () => {
  93. listener = Object.create( EmitterMixin );
  94. model = new ModelDocument();
  95. modelRoot = model.createRoot();
  96. editing = new EditingController( model );
  97. domRoot = document.createElement( 'div' );
  98. document.body.appendChild( domRoot );
  99. viewRoot = editing.createRoot( domRoot );
  100. model.schema.registerItem( 'paragraph', '$block' );
  101. model.schema.registerItem( 'div', '$block' );
  102. buildModelConverter().for( editing.modelToView ).fromElement( 'paragraph' ).toElement( 'p' );
  103. buildModelConverter().for( editing.modelToView ).fromElement( 'div' ).toElement( 'div' );
  104. // Note: The below code is highly overcomplicated due to #455.
  105. model.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.enqueueChanges( () => {
  115. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  116. model.selection.addRange( ModelRange.createFromParentsAndOffsets(
  117. modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 ) );
  118. } );
  119. } );
  120. afterEach( () => {
  121. document.body.removeChild( domRoot );
  122. listener.stopListening();
  123. editing.destroy();
  124. } );
  125. it( 'should convert insertion', () => {
  126. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  127. } );
  128. it( 'should convert split', () => {
  129. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  130. model.enqueueChanges( () => {
  131. model.batch().split( model.selection.getFirstPosition() );
  132. model.selection.setRanges( [
  133. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 1 ), 0, modelRoot.getChild( 1 ), 0 )
  134. ] );
  135. } );
  136. expect( getViewData( editing.view ) ).to.equal( '<p>f</p><p>{}oo</p><p></p><p>bar</p>' );
  137. } );
  138. it( 'should convert rename', () => {
  139. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  140. model.enqueueChanges( () => {
  141. model.batch().rename( modelRoot.getChild( 0 ), 'div' );
  142. } );
  143. expect( getViewData( editing.view ) ).to.equal( '<div>f{}oo</div><p></p><p>bar</p>' );
  144. } );
  145. it( 'should convert delete', () => {
  146. model.enqueueChanges( () => {
  147. model.batch().remove(
  148. ModelRange.createFromPositionAndShift( model.selection.getFirstPosition(), 1 )
  149. );
  150. model.selection.setRanges( [
  151. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 )
  152. ] );
  153. } );
  154. expect( getViewData( editing.view ) ).to.equal( '<p>f{}o</p><p></p><p>bar</p>' );
  155. } );
  156. it( 'should convert selection from view to model', done => {
  157. listener.listenTo( editing.view, 'selectionChange', () => {
  158. setTimeout( () => {
  159. expect( getModelData( model ) ).to.equal(
  160. '<paragraph>foo</paragraph>' +
  161. '<paragraph></paragraph>' +
  162. '<paragraph>b[a]r</paragraph>' );
  163. done();
  164. } );
  165. } );
  166. editing.view.isFocused = true;
  167. const domSelection = document.getSelection();
  168. domSelection.removeAllRanges();
  169. const domBar = domRoot.childNodes[ 2 ].childNodes[ 0 ];
  170. const domRange = document.createRange();
  171. domRange.setStart( domBar, 1 );
  172. domRange.setEnd( domBar, 2 );
  173. domSelection.addRange( domRange );
  174. } );
  175. it( 'should convert collapsed selection', () => {
  176. model.enqueueChanges( () => {
  177. model.selection.setRanges( [
  178. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  179. ] );
  180. } );
  181. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  182. } );
  183. it( 'should convert not collapsed selection', () => {
  184. model.enqueueChanges( () => {
  185. model.selection.setRanges( [
  186. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 2 )
  187. ] );
  188. } );
  189. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{a}r</p>' );
  190. } );
  191. it( 'should clear previous selection', () => {
  192. model.enqueueChanges( () => {
  193. model.selection.setRanges( [
  194. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  195. ] );
  196. } );
  197. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  198. model.enqueueChanges( () => {
  199. model.selection.setRanges( [
  200. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 2, modelRoot.getChild( 2 ), 2 )
  201. ] );
  202. } );
  203. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>ba{}r</p>' );
  204. } );
  205. it( 'should forward marker events to model conversion dispatcher', () => {
  206. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 );
  207. const markerStub = {
  208. name: 'name',
  209. getRange: () => range
  210. };
  211. sinon.spy( editing.modelToView, 'convertMarker' );
  212. model.markers.fire( 'add', markerStub );
  213. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', range ) ).to.be.true;
  214. model.markers.fire( 'remove', markerStub );
  215. expect( editing.modelToView.convertMarker.calledWithExactly( 'removeMarker', 'name', range ) ).to.be.true;
  216. editing.modelToView.convertMarker.restore();
  217. } );
  218. it( 'should forward add marker event if content is inserted into a marker range', () => {
  219. const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  220. const innerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 );
  221. model.markers.set( 'name', markerRange );
  222. sinon.spy( editing.modelToView, 'convertMarker' );
  223. editing.modelToView.convertInsertion( innerRange );
  224. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', innerRange ) ).to.be.true;
  225. editing.modelToView.convertMarker.restore();
  226. } );
  227. describe( 'should forward add marker event if inserted content has a marker', () => {
  228. let element, outerRange;
  229. beforeEach( () => {
  230. element = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  231. modelRoot.appendChildren( element );
  232. outerRange = ModelRange.createOn( element );
  233. sinon.spy( editing.modelToView, 'convertMarker' );
  234. } );
  235. afterEach( () => {
  236. editing.modelToView.convertMarker.restore();
  237. } );
  238. it( 'marker strictly contained', () => {
  239. const markerRange = ModelRange.createFromParentsAndOffsets( element, 1, element, 2 );
  240. model.markers.set( 'name', markerRange );
  241. editing.modelToView.convertInsertion( outerRange );
  242. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  243. } );
  244. it( 'marker starts at same position', () => {
  245. const markerRange = ModelRange.createFromParentsAndOffsets( element, 0, element, 2 );
  246. model.markers.set( 'name', markerRange );
  247. editing.modelToView.convertInsertion( outerRange );
  248. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  249. } );
  250. it( 'marker ends at same position', () => {
  251. const markerRange = ModelRange.createFromParentsAndOffsets( element, 1, element, 3 );
  252. model.markers.set( 'name', markerRange );
  253. editing.modelToView.convertInsertion( outerRange );
  254. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  255. } );
  256. it( 'marker is same as range', () => {
  257. const markerRange = ModelRange.createFromParentsAndOffsets( element, 0, element, 3 );
  258. model.markers.set( 'name', markerRange );
  259. editing.modelToView.convertInsertion( outerRange );
  260. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  261. } );
  262. } );
  263. it( 'should not start marker conversion if content is not inserted into any marker range', () => {
  264. const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  265. const insertRange = ModelRange.createFromParentsAndOffsets( modelRoot, 6, modelRoot, 8 );
  266. const consumableMock = {
  267. consume: () => true,
  268. test: () => true
  269. };
  270. model.markers.set( 'name', markerRange );
  271. sinon.spy( editing.modelToView, 'convertMarker' );
  272. editing.modelToView.fire( 'insert', {
  273. range: insertRange
  274. }, consumableMock, { dispatcher: editing.modelToView } );
  275. expect( editing.modelToView.convertMarker.called ).to.be.false;
  276. editing.modelToView.convertMarker.restore();
  277. } );
  278. it( 'should forward add marker event if content is moved into a marker range', () => {
  279. model.enqueueChanges( () => {
  280. model.batch().insert( ModelPosition.createAt( model.getRoot(), 'end' ), new ModelElement( 'paragraph' ) );
  281. } );
  282. const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  283. model.markers.set( 'name', markerRange );
  284. sinon.spy( editing.modelToView, 'convertMarker' );
  285. editing.modelToView.convertMove(
  286. ModelPosition.createAt( modelRoot, 3 ),
  287. ModelRange.createOn( modelRoot.getChild( 1 ) )
  288. );
  289. expect( editing.modelToView.convertMarker.calledWith( 'addMarker', 'name' ) ).to.be.true;
  290. editing.modelToView.convertMarker.restore();
  291. } );
  292. } );
  293. describe( 'destroy()', () => {
  294. it( 'should remove listenters', () => {
  295. const model = new ModelDocument();
  296. model.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.enqueueChanges( () => {
  303. const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
  304. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  305. } );
  306. expect( spy.called ).to.be.false;
  307. editing.destroy();
  308. } );
  309. it( 'should destroy view', () => {
  310. const model = new ModelDocument();
  311. model.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. } );