8
0

editingcontroller.js 15 KB

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