8
0

editingcontroller.js 13 KB

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