editingcontroller.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441
  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 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 Model();
  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 Model();
  49. modelRoot = model.document.createRoot();
  50. model.document.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.document.getRoot( 'header' ) );
  75. expect( editing.mapper.toViewElement( model.document.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 Model();
  95. modelRoot = model.document.createRoot();
  96. editing = new EditingController( model );
  97. domRoot = document.createElement( 'div' );
  98. domRoot.contentEditable = true;
  99. document.body.appendChild( domRoot );
  100. viewRoot = editing.createRoot( domRoot );
  101. model.schema.registerItem( 'paragraph', '$block' );
  102. model.schema.registerItem( 'div', '$block' );
  103. buildModelConverter().for( editing.modelToView ).fromElement( 'paragraph' ).toElement( 'p' );
  104. buildModelConverter().for( editing.modelToView ).fromElement( 'div' ).toElement( 'div' );
  105. // Note: The below code is highly overcomplicated due to #455.
  106. model.document.selection.removeAllRanges();
  107. modelRoot.removeChildren( 0, modelRoot.childCount );
  108. viewRoot.removeChildren( 0, viewRoot.childCount );
  109. const modelData = new ModelDocumentFragment( parse(
  110. '<paragraph>foo</paragraph>' +
  111. '<paragraph></paragraph>' +
  112. '<paragraph>bar</paragraph>',
  113. model.schema
  114. )._children );
  115. model.enqueueChange( writer => {
  116. writer.insert( modelData, model.document.getRoot() );
  117. model.document.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.enqueueChange( 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.enqueueChange( 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.enqueueChange( 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.enqueueChange( () => {
  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.enqueueChange( () => {
  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.enqueueChange( () => {
  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.enqueueChange( () => {
  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 forward marker events to model conversion dispatcher', () => {
  209. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 );
  210. const markerStub = {
  211. name: 'name',
  212. getRange: () => range
  213. };
  214. sinon.spy( editing.modelToView, 'convertMarker' );
  215. model.markers.fire( 'add', markerStub );
  216. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', range ) ).to.be.true;
  217. model.markers.fire( 'remove', markerStub );
  218. expect( editing.modelToView.convertMarker.calledWithExactly( 'removeMarker', 'name', range ) ).to.be.true;
  219. editing.modelToView.convertMarker.restore();
  220. } );
  221. it( 'should forward add marker event if content is inserted into a marker range', () => {
  222. const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  223. const innerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 );
  224. model.markers.set( 'name', markerRange );
  225. sinon.spy( editing.modelToView, 'convertMarker' );
  226. editing.modelToView.convertInsertion( innerRange );
  227. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', innerRange ) ).to.be.true;
  228. editing.modelToView.convertMarker.restore();
  229. } );
  230. describe( 'should forward add marker event if inserted content has a marker', () => {
  231. let element, outerRange;
  232. beforeEach( () => {
  233. element = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  234. modelRoot.appendChildren( element );
  235. outerRange = ModelRange.createOn( element );
  236. sinon.spy( editing.modelToView, 'convertMarker' );
  237. } );
  238. afterEach( () => {
  239. editing.modelToView.convertMarker.restore();
  240. } );
  241. it( 'marker strictly contained', () => {
  242. const markerRange = ModelRange.createFromParentsAndOffsets( element, 1, element, 2 );
  243. model.markers.set( 'name', markerRange );
  244. editing.modelToView.convertInsertion( outerRange );
  245. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  246. } );
  247. it( 'marker starts at same position', () => {
  248. const markerRange = ModelRange.createFromParentsAndOffsets( element, 0, element, 2 );
  249. model.markers.set( 'name', markerRange );
  250. editing.modelToView.convertInsertion( outerRange );
  251. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  252. } );
  253. it( 'marker ends at same position', () => {
  254. const markerRange = ModelRange.createFromParentsAndOffsets( element, 1, element, 3 );
  255. model.markers.set( 'name', markerRange );
  256. editing.modelToView.convertInsertion( outerRange );
  257. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  258. } );
  259. it( 'marker is same as range', () => {
  260. const markerRange = ModelRange.createFromParentsAndOffsets( element, 0, element, 3 );
  261. model.markers.set( 'name', markerRange );
  262. editing.modelToView.convertInsertion( outerRange );
  263. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', markerRange ) ).to.be.true;
  264. } );
  265. } );
  266. it( 'should not start marker conversion if content is not inserted into any marker range', () => {
  267. const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  268. const insertRange = ModelRange.createFromParentsAndOffsets( modelRoot, 6, modelRoot, 8 );
  269. const consumableMock = {
  270. consume: () => true,
  271. test: () => true
  272. };
  273. model.markers.set( 'name', markerRange );
  274. sinon.spy( editing.modelToView, 'convertMarker' );
  275. editing.modelToView.fire( 'insert', {
  276. range: insertRange
  277. }, consumableMock, { dispatcher: editing.modelToView } );
  278. expect( editing.modelToView.convertMarker.called ).to.be.false;
  279. editing.modelToView.convertMarker.restore();
  280. } );
  281. it( 'should forward add marker event if content is moved into a marker range', () => {
  282. model.enqueueChange( writer => {
  283. writer.appendElement( 'paragraph', model.document.getRoot() );
  284. } );
  285. const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  286. model.markers.set( 'name', markerRange );
  287. sinon.spy( editing.modelToView, 'convertMarker' );
  288. editing.modelToView.convertMove(
  289. ModelPosition.createAt( modelRoot, 3 ),
  290. ModelRange.createOn( modelRoot.getChild( 1 ) )
  291. );
  292. expect( editing.modelToView.convertMarker.calledWith( 'addMarker', 'name' ) ).to.be.true;
  293. editing.modelToView.convertMarker.restore();
  294. } );
  295. } );
  296. describe( 'destroy()', () => {
  297. it( 'should remove listenters', () => {
  298. const model = new Model();
  299. model.document.createRoot();
  300. model.schema.registerItem( 'paragraph', '$block' );
  301. const editing = new EditingController( model );
  302. const spy = sinon.spy();
  303. editing.modelToView.on( 'insert:$element', spy );
  304. editing.destroy();
  305. model.enqueueChange( writer => {
  306. const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
  307. writer.insert( modelData, model.document.getRoot() );
  308. } );
  309. expect( spy.called ).to.be.false;
  310. editing.destroy();
  311. } );
  312. it( 'should destroy view', () => {
  313. const model = new Model();
  314. model.document.createRoot();
  315. model.schema.registerItem( 'paragraph', '$block' );
  316. const editing = new EditingController( model );
  317. const spy = sinon.spy( editing.view, 'destroy' );
  318. editing.destroy();
  319. expect( spy.called ).to.be.true;
  320. } );
  321. } );
  322. } );