editingcontroller.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  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 ModelRange from 'ckeditor5/engine/model/range.js';
  15. import ModelLiveRange from 'ckeditor5/engine/model/liverange.js';
  16. import ModelDocumentFragment from 'ckeditor5/engine/model/documentfragment.js';
  17. import createElement from 'ckeditor5/utils/dom/createelement.js';
  18. import { parse, getData as getModelData } from 'ckeditor5/engine/dev-utils/model.js';
  19. import { getData as getViewData } from 'ckeditor5/engine/dev-utils/view.js';
  20. describe( 'EditingController', () => {
  21. describe( 'constructor()', () => {
  22. it( 'should create controller with properties', () => {
  23. const model = new ModelDocument();
  24. const editing = new EditingController( model );
  25. expect( editing ).to.have.property( 'model' ).that.equals( model );
  26. expect( editing ).to.have.property( 'view' ).that.is.instanceof( ViewDocument );
  27. expect( editing ).to.have.property( 'mapper' ).that.is.instanceof( Mapper );
  28. expect( editing ).to.have.property( 'modelToView' ).that.is.instanceof( ModelConversionDispatcher );
  29. editing.destroy();
  30. } );
  31. } );
  32. describe( 'createRoot', () => {
  33. let model, modelRoot, editing;
  34. beforeEach( () => {
  35. model = new ModelDocument();
  36. modelRoot = model.createRoot();
  37. model.createRoot( '$root', 'header' );
  38. editing = new EditingController( model );
  39. } );
  40. afterEach( () => {
  41. editing.destroy();
  42. } );
  43. it( 'should create root', () => {
  44. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  45. const viewRoot = editing.createRoot( domRoot );
  46. expect( viewRoot ).to.equal( editing.view.getRoot() );
  47. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  48. expect( editing.view.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domRoot );
  49. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  50. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( modelRoot );
  51. expect( editing.mapper.toViewElement( modelRoot ) ).to.equal( viewRoot );
  52. } );
  53. it( 'should create root with given name', () => {
  54. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  55. const viewRoot = editing.createRoot( domRoot, 'header' );
  56. expect( viewRoot ).to.equal( editing.view.getRoot( 'header' ) );
  57. expect( domRoot ).to.equal( editing.view.getDomRoot( 'header' ) );
  58. expect( editing.view.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domRoot );
  59. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  60. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( model.getRoot( 'header' ) );
  61. expect( editing.mapper.toViewElement( model.getRoot( 'header' ) ) ).to.equal( viewRoot );
  62. } );
  63. it( 'should be possible to attach DOM element later', () => {
  64. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  65. const viewRoot = editing.createRoot( 'div' );
  66. expect( viewRoot ).to.equal( editing.view.getRoot() );
  67. expect( editing.view.getDomRoot() ).to.be.undefined;
  68. editing.view.attachDomRoot( domRoot );
  69. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  70. expect( editing.view.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domRoot );
  71. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  72. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( modelRoot );
  73. expect( editing.mapper.toViewElement( modelRoot ) ).to.equal( viewRoot );
  74. } );
  75. } );
  76. describe( 'conversion', () => {
  77. let model, modelRoot, viewRoot, domRoot, editing, listener;
  78. before( () => {
  79. listener = Object.create( EmitterMixin );
  80. model = new ModelDocument();
  81. modelRoot = model.createRoot();
  82. editing = new EditingController( model );
  83. domRoot = document.createElement( 'div' );
  84. document.body.appendChild( domRoot );
  85. viewRoot = editing.createRoot( domRoot );
  86. model.schema.registerItem( 'paragraph', '$block' );
  87. model.schema.registerItem( 'div', '$block' );
  88. buildModelConverter().for( editing.modelToView ).fromElement( 'paragraph' ).toElement( 'p' );
  89. buildModelConverter().for( editing.modelToView ).fromElement( 'div' ).toElement( 'div' );
  90. } );
  91. after( () => {
  92. document.body.removeChild( domRoot );
  93. listener.stopListening();
  94. editing.destroy();
  95. } );
  96. beforeEach( () => {
  97. // Note: The below code is highly overcomplicated due to #455.
  98. model.selection.removeAllRanges();
  99. modelRoot.removeChildren( 0, modelRoot.childCount );
  100. viewRoot.removeChildren( 0, viewRoot.childCount );
  101. const modelData = new ModelDocumentFragment( parse(
  102. '<paragraph>foo</paragraph>' +
  103. '<paragraph></paragraph>' +
  104. '<paragraph>bar</paragraph>',
  105. model.schema
  106. )._children );
  107. model.enqueueChanges( () => {
  108. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  109. model.selection.addRange( ModelRange.createFromParentsAndOffsets(
  110. modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 ) );
  111. } );
  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 = new Range();
  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. sinon.spy( editing.modelToView, 'convertMarker' );
  196. model.markers.fire( 'addMarker', range, 'name' );
  197. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', range, 'name' ) ).to.be.true;
  198. model.markers.fire( 'removeMarker', range, 'name' );
  199. expect( editing.modelToView.convertMarker.calledWithExactly( 'removeMarker', range, 'name' ) ).to.be.true;
  200. editing.modelToView.convertMarker.restore();
  201. } );
  202. it( 'should forward add marker event if content is inserted into a marker range', () => {
  203. const markerRange = ModelLiveRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  204. const innerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 );
  205. model.markers.addRange( markerRange, 'name' );
  206. sinon.spy( editing.modelToView, 'convertMarker' );
  207. editing.modelToView.fire( 'insert', {
  208. range: innerRange
  209. } );
  210. expect( editing.modelToView.convertMarker.calledWithExactly( 'addMarker', 'name', innerRange ) ).to.be.true;
  211. editing.modelToView.convertMarker.restore();
  212. } );
  213. it( 'should forward remove marker event if part of marker range is moved', () => {
  214. const markerRange = ModelLiveRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 );
  215. const consumableMock = {
  216. consume: () => true,
  217. test: () => true
  218. };
  219. model.markers.addRange( markerRange, 'name' );
  220. sinon.spy( editing.modelToView, 'convertMarker' );
  221. editing.modelToView.fire( 'move', {
  222. sourcePosition: ModelPosition.createAt( modelRoot, 1 ),
  223. targetPosition: ModelPosition.createAt( modelRoot, 2 ),
  224. item: modelRoot.getChild( 2 )
  225. }, consumableMock, { mapper: editing.mapper } );
  226. expect( editing.modelToView.convertMarker.calledWith( 'removeMarker', 'name' ) ).to.be.true;
  227. editing.modelToView.convertMarker.restore();
  228. } );
  229. it( 'should forward add marker event if content is moved into a marker range', () => {
  230. const markerRange = ModelLiveRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  231. const consumableMock = {
  232. consume: () => true,
  233. test: () => true
  234. };
  235. model.markers.addRange( markerRange, 'name' );
  236. sinon.spy( editing.modelToView, 'convertMarker' );
  237. editing.modelToView.fire( 'move', {
  238. sourcePosition: ModelPosition.createAt( modelRoot, 2 ),
  239. targetPosition: ModelPosition.createAt( modelRoot, 1 ),
  240. item: modelRoot.getChild( 1 )
  241. }, consumableMock, { mapper: editing.mapper } );
  242. expect( editing.modelToView.convertMarker.calledWith( 'addMarker', 'name' ) ).to.be.true;
  243. editing.modelToView.convertMarker.restore();
  244. } );
  245. } );
  246. describe( 'destroy', () => {
  247. it( 'should remove listenters', () => {
  248. let model, editing;
  249. model = new ModelDocument();
  250. model.createRoot();
  251. model.schema.registerItem( 'paragraph', '$block' );
  252. editing = new EditingController( model );
  253. const spy = sinon.spy();
  254. editing.modelToView.on( 'insert:$element', spy );
  255. editing.destroy();
  256. model.enqueueChanges( () => {
  257. const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
  258. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  259. } );
  260. expect( spy.called ).to.be.false;
  261. editing.destroy();
  262. } );
  263. it( 'should destroy view', () => {
  264. let model, editing;
  265. model = new ModelDocument();
  266. model.createRoot();
  267. model.schema.registerItem( 'paragraph', '$block' );
  268. editing = new EditingController( model );
  269. const spy = sinon.spy( editing.view, 'destroy' );
  270. editing.destroy();
  271. expect( spy.called ).to.be.true;
  272. } );
  273. } );
  274. } );