8
0

editingcontroller.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals setTimeout, Range, document */
  6. import EmitterMixin from 'ckeditor5/utils/emittermixin.js';
  7. import EditingController from 'ckeditor5/engine/controller/editingcontroller.js';
  8. import ViewDocument from 'ckeditor5/engine/view/document.js';
  9. import Mapper from 'ckeditor5/engine/conversion/mapper.js';
  10. import ModelConversionDispatcher from 'ckeditor5/engine/conversion/modelconversiondispatcher.js';
  11. import buildModelConverter from 'ckeditor5/engine/conversion/buildmodelconverter.js';
  12. import ModelDocument from 'ckeditor5/engine/model/document.js';
  13. import ModelPosition from 'ckeditor5/engine/model/position.js';
  14. import ModelElement from 'ckeditor5/engine/model/element.js';
  15. import ModelRange from 'ckeditor5/engine/model/range.js';
  16. import ModelLiveRange from 'ckeditor5/engine/model/liverange.js';
  17. import ModelDocumentFragment from 'ckeditor5/engine/model/documentfragment.js';
  18. import createElement from 'ckeditor5/utils/dom/createelement.js';
  19. import { parse, getData as getModelData } from 'ckeditor5/engine/dev-utils/model.js';
  20. import { getData as getViewData } from 'ckeditor5/engine/dev-utils/view.js';
  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. } );
  44. it( 'should create root', () => {
  45. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  46. const viewRoot = editing.createRoot( domRoot );
  47. expect( viewRoot ).to.equal( editing.view.getRoot() );
  48. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  49. expect( editing.view.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domRoot );
  50. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  51. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( modelRoot );
  52. expect( editing.mapper.toViewElement( modelRoot ) ).to.equal( viewRoot );
  53. } );
  54. it( 'should create root with given name', () => {
  55. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  56. const viewRoot = editing.createRoot( domRoot, 'header' );
  57. expect( viewRoot ).to.equal( editing.view.getRoot( 'header' ) );
  58. expect( domRoot ).to.equal( editing.view.getDomRoot( 'header' ) );
  59. expect( editing.view.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domRoot );
  60. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  61. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( model.getRoot( 'header' ) );
  62. expect( editing.mapper.toViewElement( model.getRoot( 'header' ) ) ).to.equal( viewRoot );
  63. } );
  64. it( 'should be possible to attach DOM element later', () => {
  65. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  66. const viewRoot = editing.createRoot( 'div' );
  67. expect( viewRoot ).to.equal( editing.view.getRoot() );
  68. expect( editing.view.getDomRoot() ).to.be.undefined;
  69. editing.view.attachDomRoot( domRoot );
  70. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  71. expect( editing.view.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domRoot );
  72. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  73. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( modelRoot );
  74. expect( editing.mapper.toViewElement( modelRoot ) ).to.equal( viewRoot );
  75. } );
  76. } );
  77. describe( 'conversion', () => {
  78. let model, modelRoot, viewRoot, domRoot, editing, listener;
  79. beforeEach( () => {
  80. listener = Object.create( EmitterMixin );
  81. model = new ModelDocument();
  82. modelRoot = model.createRoot();
  83. editing = new EditingController( model );
  84. domRoot = document.createElement( 'div' );
  85. document.body.appendChild( domRoot );
  86. viewRoot = editing.createRoot( domRoot );
  87. model.schema.registerItem( 'paragraph', '$block' );
  88. model.schema.registerItem( 'div', '$block' );
  89. buildModelConverter().for( editing.modelToView ).fromElement( 'paragraph' ).toElement( 'p' );
  90. buildModelConverter().for( editing.modelToView ).fromElement( 'div' ).toElement( 'div' );
  91. // Note: The below code is highly overcomplicated due to #455.
  92. model.selection.removeAllRanges();
  93. modelRoot.removeChildren( 0, modelRoot.childCount );
  94. viewRoot.removeChildren( 0, viewRoot.childCount );
  95. const modelData = new ModelDocumentFragment( parse(
  96. '<paragraph>foo</paragraph>' +
  97. '<paragraph></paragraph>' +
  98. '<paragraph>bar</paragraph>',
  99. model.schema
  100. )._children );
  101. model.enqueueChanges( () => {
  102. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  103. model.selection.addRange( ModelRange.createFromParentsAndOffsets(
  104. modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 ) );
  105. } );
  106. } );
  107. afterEach( () => {
  108. document.body.removeChild( domRoot );
  109. listener.stopListening();
  110. editing.destroy();
  111. } );
  112. it( 'should convert insertion', () => {
  113. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  114. } );
  115. it( 'should convert split', () => {
  116. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  117. model.enqueueChanges( () => {
  118. model.batch().split( model.selection.getFirstPosition() );
  119. model.selection.setRanges( [
  120. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 1 ), 0, modelRoot.getChild( 1 ), 0 )
  121. ] );
  122. } );
  123. expect( getViewData( editing.view ) ).to.equal( '<p>f</p><p>{}oo</p><p></p><p>bar</p>' );
  124. } );
  125. it( 'should convert rename', () => {
  126. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  127. model.enqueueChanges( () => {
  128. model.batch().rename( modelRoot.getChild( 0 ), 'div' );
  129. } );
  130. expect( getViewData( editing.view ) ).to.equal( '<div>f{}oo</div><p></p><p>bar</p>' );
  131. } );
  132. it( 'should convert delete', () => {
  133. model.enqueueChanges( () => {
  134. model.batch().remove(
  135. ModelRange.createFromPositionAndShift( model.selection.getFirstPosition(), 1 )
  136. );
  137. model.selection.setRanges( [
  138. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 )
  139. ] );
  140. } );
  141. expect( getViewData( editing.view ) ).to.equal( '<p>f{}o</p><p></p><p>bar</p>' );
  142. } );
  143. it( 'should convert selection from view to model', ( done ) => {
  144. listener.listenTo( editing.view, 'selectionChange', () => {
  145. setTimeout( () => {
  146. expect( getModelData( model ) ).to.equal(
  147. '<paragraph>foo</paragraph>' +
  148. '<paragraph></paragraph>' +
  149. '<paragraph>b[a]r</paragraph>' );
  150. done();
  151. } );
  152. } );
  153. editing.view.isFocused = true;
  154. const domSelection = document.getSelection();
  155. domSelection.removeAllRanges();
  156. const domBar = domRoot.childNodes[ 2 ].childNodes[ 0 ];
  157. const domRange = new Range();
  158. domRange.setStart( domBar, 1 );
  159. domRange.setEnd( domBar, 2 );
  160. domSelection.addRange( domRange );
  161. } );
  162. it( 'should convert collapsed selection', () => {
  163. model.enqueueChanges( () => {
  164. model.selection.setRanges( [
  165. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  166. ] );
  167. } );
  168. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  169. } );
  170. it( 'should convert not collapsed selection', () => {
  171. model.enqueueChanges( () => {
  172. model.selection.setRanges( [
  173. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 2 )
  174. ] );
  175. } );
  176. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{a}r</p>' );
  177. } );
  178. it( 'should clear previous selection', () => {
  179. model.enqueueChanges( () => {
  180. model.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. model.enqueueChanges( () => {
  186. model.selection.setRanges( [
  187. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 2, modelRoot.getChild( 2 ), 2 )
  188. ] );
  189. } );
  190. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>ba{}r</p>' );
  191. } );
  192. it( 'should forward marker events to model conversion dispatcher', () => {
  193. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 );
  194. sinon.spy( editing.modelToView, 'convertMarker' );
  195. model.markers.fire( 'add', range, 'name' );
  196. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', range, 'name' ) ).to.be.true;
  197. model.markers.fire( 'remove', range, 'name' );
  198. expect( editing.modelToView.convertMarker.calledWithExactly( 'removeMarker', range, 'name' ) ).to.be.true;
  199. editing.modelToView.convertMarker.restore();
  200. } );
  201. it( 'should forward add marker event if content is inserted into a marker range', () => {
  202. const markerRange = ModelLiveRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  203. const innerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 );
  204. const consumableMock = {
  205. consume: () => true,
  206. test: () => true
  207. };
  208. model.markers.add( 'name', markerRange );
  209. sinon.spy( editing.modelToView, 'convertMarker' );
  210. editing.modelToView.fire( 'insert', {
  211. range: innerRange
  212. }, consumableMock, { dispatcher: editing.modelToView } );
  213. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', innerRange ) ).to.be.true;
  214. editing.modelToView.convertMarker.restore();
  215. } );
  216. it( 'should not start marker conversion if content is not inserted into any marker range', () => {
  217. const markerRange = ModelLiveRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  218. const insertRange = ModelRange.createFromParentsAndOffsets( modelRoot, 6, modelRoot, 8 );
  219. const consumableMock = {
  220. consume: () => true,
  221. test: () => true
  222. };
  223. model.markers.add( 'name', markerRange );
  224. sinon.spy( editing.modelToView, 'convertMarker' );
  225. editing.modelToView.fire( 'insert', {
  226. range: insertRange
  227. }, consumableMock, { dispatcher: editing.modelToView } );
  228. expect( editing.modelToView.convertMarker.called ).to.be.false;
  229. editing.modelToView.convertMarker.restore();
  230. } );
  231. it( 'should forward remove marker event if part of marker range is moved - intersecting', () => {
  232. const markerRange = ModelLiveRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 );
  233. const consumableMock = {
  234. consume: () => true,
  235. test: () => true
  236. };
  237. model.markers.add( 'name', markerRange );
  238. sinon.spy( editing.modelToView, 'convertMarker' );
  239. editing.modelToView.fire( 'move', {
  240. sourcePosition: ModelPosition.createAt( modelRoot, 1 ),
  241. targetPosition: ModelPosition.createAt( modelRoot, 2 ),
  242. item: modelRoot.getChild( 2 )
  243. }, consumableMock, { dispatcher: editing.modelToView, mapper: editing.mapper } );
  244. expect( editing.modelToView.convertMarker.calledWith( 'removeMarker', 'name' ) ).to.be.true;
  245. editing.modelToView.convertMarker.restore();
  246. } );
  247. it( 'should forward remove marker event if part of marker range is moved - inside', () => {
  248. model.enqueueChanges( () => {
  249. model.batch().insert( ModelPosition.createAt( model.getRoot(), 'end' ), new ModelElement( 'paragraph' ) );
  250. } );
  251. const markerRange = ModelLiveRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 2 );
  252. const consumableMock = {
  253. consume: () => true,
  254. test: () => true
  255. };
  256. model.markers.add( 'name', markerRange );
  257. sinon.spy( editing.modelToView, 'convertMarker' );
  258. editing.modelToView.fire( 'move', {
  259. sourcePosition: ModelPosition.createAt( modelRoot, 1 ),
  260. targetPosition: ModelPosition.createAt( modelRoot, 3 ),
  261. item: modelRoot.getChild( 3 )
  262. }, consumableMock, { dispatcher: editing.modelToView, mapper: editing.mapper } );
  263. expect( editing.modelToView.convertMarker.calledWith( 'removeMarker', 'name' ) ).to.be.true;
  264. editing.modelToView.convertMarker.restore();
  265. } );
  266. it( 'should forward add marker event if content is moved into a marker range', () => {
  267. model.enqueueChanges( () => {
  268. model.batch().insert( ModelPosition.createAt( model.getRoot(), 'end' ), new ModelElement( 'paragraph' ) );
  269. } );
  270. const markerRange = ModelLiveRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  271. const consumableMock = {
  272. consume: () => true,
  273. test: () => true
  274. };
  275. model.markers.add( 'name', markerRange );
  276. sinon.spy( editing.modelToView, 'convertMarker' );
  277. editing.modelToView.fire( 'move', {
  278. sourcePosition: ModelPosition.createAt( modelRoot, 3 ),
  279. targetPosition: ModelPosition.createAt( modelRoot, 1 ),
  280. item: modelRoot.getChild( 1 )
  281. }, consumableMock, { dispatcher: editing.modelToView, mapper: editing.mapper } );
  282. expect( editing.modelToView.convertMarker.calledWith( 'addMarker', 'name' ) ).to.be.true;
  283. editing.modelToView.convertMarker.restore();
  284. } );
  285. it( 'should not start marker conversion if moved content does not affect the marker', () => {
  286. const markerRange = ModelLiveRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 );
  287. const consumableMock = {
  288. consume: () => true,
  289. test: () => true
  290. };
  291. model.markers.add( 'name', markerRange );
  292. sinon.spy( editing.modelToView, 'convertMarker' );
  293. editing.modelToView.fire( 'move', {
  294. sourcePosition: ModelPosition.createAt( modelRoot, 2 ),
  295. targetPosition: ModelPosition.createAt( modelRoot, 0 ),
  296. item: modelRoot.getChild( 2 )
  297. }, consumableMock, { dispatcher: editing.modelToView, mapper: editing.mapper } );
  298. expect( editing.modelToView.convertMarker.called ).to.be.false;
  299. editing.modelToView.convertMarker.restore();
  300. } );
  301. } );
  302. describe( 'destroy', () => {
  303. it( 'should remove listenters', () => {
  304. let model, editing;
  305. model = new ModelDocument();
  306. model.createRoot();
  307. model.schema.registerItem( 'paragraph', '$block' );
  308. editing = new EditingController( model );
  309. const spy = sinon.spy();
  310. editing.modelToView.on( 'insert:$element', spy );
  311. editing.destroy();
  312. model.enqueueChanges( () => {
  313. const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
  314. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  315. } );
  316. expect( spy.called ).to.be.false;
  317. editing.destroy();
  318. } );
  319. it( 'should destroy view', () => {
  320. let model, editing;
  321. model = new ModelDocument();
  322. model.createRoot();
  323. model.schema.registerItem( 'paragraph', '$block' );
  324. editing = new EditingController( model );
  325. const spy = sinon.spy( editing.view, 'destroy' );
  326. editing.destroy();
  327. expect( spy.called ).to.be.true;
  328. } );
  329. } );
  330. } );