editingcontroller.js 14 KB

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