editingcontroller.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439
  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. model.batch()
  114. )._children );
  115. model.enqueueChanges( () => {
  116. model.batch().insert( modelData, model.getRoot() );
  117. model.selection.addRange( ModelRange.createFromParentsAndOffsets(
  118. modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 ) );
  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.enqueueChanges( () => {
  132. model.batch().split( model.selection.getFirstPosition() );
  133. model.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.enqueueChanges( () => {
  142. model.batch().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.enqueueChanges( () => {
  148. model.batch().remove(
  149. ModelRange.createFromPositionAndShift( model.selection.getFirstPosition(), 1 )
  150. );
  151. model.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. done();
  165. } );
  166. } );
  167. editing.view.isFocused = true;
  168. const domSelection = document.getSelection();
  169. domSelection.removeAllRanges();
  170. const domBar = domRoot.childNodes[ 2 ].childNodes[ 0 ];
  171. const domRange = document.createRange();
  172. domRange.setStart( domBar, 1 );
  173. domRange.setEnd( domBar, 2 );
  174. domSelection.addRange( domRange );
  175. } );
  176. it( 'should convert collapsed selection', () => {
  177. model.enqueueChanges( () => {
  178. model.selection.setRanges( [
  179. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  180. ] );
  181. } );
  182. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  183. } );
  184. it( 'should convert not collapsed selection', () => {
  185. model.enqueueChanges( () => {
  186. model.selection.setRanges( [
  187. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 2 )
  188. ] );
  189. } );
  190. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{a}r</p>' );
  191. } );
  192. it( 'should clear previous selection', () => {
  193. model.enqueueChanges( () => {
  194. model.selection.setRanges( [
  195. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  196. ] );
  197. } );
  198. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  199. model.enqueueChanges( () => {
  200. model.selection.setRanges( [
  201. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 2, modelRoot.getChild( 2 ), 2 )
  202. ] );
  203. } );
  204. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>ba{}r</p>' );
  205. } );
  206. it( 'should forward marker events to model conversion dispatcher', () => {
  207. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 );
  208. const markerStub = {
  209. name: 'name',
  210. getRange: () => range
  211. };
  212. sinon.spy( editing.modelToView, 'convertMarker' );
  213. model.markers.fire( 'add', markerStub );
  214. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', range ) ).to.be.true;
  215. model.markers.fire( 'remove', markerStub );
  216. expect( editing.modelToView.convertMarker.calledWithExactly( 'removeMarker', 'name', range ) ).to.be.true;
  217. editing.modelToView.convertMarker.restore();
  218. } );
  219. it( 'should forward add marker event if content is inserted into a marker range', () => {
  220. const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  221. const innerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 );
  222. model.markers.set( 'name', markerRange );
  223. sinon.spy( editing.modelToView, 'convertMarker' );
  224. editing.modelToView.convertInsertion( innerRange );
  225. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', innerRange ) ).to.be.true;
  226. editing.modelToView.convertMarker.restore();
  227. } );
  228. describe( 'should forward add marker event if inserted content has a marker', () => {
  229. let element, outerRange;
  230. beforeEach( () => {
  231. element = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  232. modelRoot.appendChildren( element );
  233. outerRange = ModelRange.createOn( element );
  234. sinon.spy( editing.modelToView, 'convertMarker' );
  235. } );
  236. afterEach( () => {
  237. editing.modelToView.convertMarker.restore();
  238. } );
  239. it( 'marker strictly contained', () => {
  240. const markerRange = ModelRange.createFromParentsAndOffsets( element, 1, element, 2 );
  241. model.markers.set( 'name', markerRange );
  242. editing.modelToView.convertInsertion( outerRange );
  243. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  244. } );
  245. it( 'marker starts at same position', () => {
  246. const markerRange = ModelRange.createFromParentsAndOffsets( element, 0, element, 2 );
  247. model.markers.set( 'name', markerRange );
  248. editing.modelToView.convertInsertion( outerRange );
  249. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  250. } );
  251. it( 'marker ends at same position', () => {
  252. const markerRange = ModelRange.createFromParentsAndOffsets( element, 1, element, 3 );
  253. model.markers.set( 'name', markerRange );
  254. editing.modelToView.convertInsertion( outerRange );
  255. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  256. } );
  257. it( 'marker is same as range', () => {
  258. const markerRange = ModelRange.createFromParentsAndOffsets( element, 0, element, 3 );
  259. model.markers.set( 'name', markerRange );
  260. editing.modelToView.convertInsertion( outerRange );
  261. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  262. } );
  263. } );
  264. it( 'should not start marker conversion if content is not inserted into any marker range', () => {
  265. const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  266. const insertRange = ModelRange.createFromParentsAndOffsets( modelRoot, 6, modelRoot, 8 );
  267. const consumableMock = {
  268. consume: () => true,
  269. test: () => true
  270. };
  271. model.markers.set( 'name', markerRange );
  272. sinon.spy( editing.modelToView, 'convertMarker' );
  273. editing.modelToView.fire( 'insert', {
  274. range: insertRange
  275. }, consumableMock, { dispatcher: editing.modelToView } );
  276. expect( editing.modelToView.convertMarker.called ).to.be.false;
  277. editing.modelToView.convertMarker.restore();
  278. } );
  279. it( 'should forward add marker event if content is moved into a marker range', () => {
  280. model.enqueueChanges( () => {
  281. model.batch().appendElement( 'paragraph', model.getRoot() );
  282. } );
  283. const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  284. model.markers.set( 'name', markerRange );
  285. sinon.spy( editing.modelToView, 'convertMarker' );
  286. editing.modelToView.convertMove(
  287. ModelPosition.createAt( modelRoot, 3 ),
  288. ModelRange.createOn( modelRoot.getChild( 1 ) )
  289. );
  290. expect( editing.modelToView.convertMarker.calledWith( 'addMarker', 'name' ) ).to.be.true;
  291. editing.modelToView.convertMarker.restore();
  292. } );
  293. } );
  294. describe( 'destroy()', () => {
  295. it( 'should remove listenters', () => {
  296. const model = new ModelDocument();
  297. model.createRoot();
  298. model.schema.registerItem( 'paragraph', '$block' );
  299. const editing = new EditingController( model );
  300. const spy = sinon.spy();
  301. editing.modelToView.on( 'insert:$element', spy );
  302. editing.destroy();
  303. const batch = model.batch();
  304. model.enqueueChanges( () => {
  305. const modelData = parse( '<paragraph>foo</paragraph>', model.schema, batch ).getChild( 0 );
  306. batch.insert( modelData, model.getRoot() );
  307. } );
  308. expect( spy.called ).to.be.false;
  309. editing.destroy();
  310. } );
  311. it( 'should destroy view', () => {
  312. const model = new ModelDocument();
  313. model.createRoot();
  314. model.schema.registerItem( 'paragraph', '$block' );
  315. const editing = new EditingController( model );
  316. const spy = sinon.spy( editing.view, 'destroy' );
  317. editing.destroy();
  318. expect( spy.called ).to.be.true;
  319. } );
  320. } );
  321. } );