editingcontroller.js 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  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 ModelDocumentFragment from 'ckeditor5/engine/model/documentfragment.js';
  16. import createElement from 'ckeditor5/utils/dom/createelement.js';
  17. import { parse, getData as getModelData } from 'ckeditor5/engine/dev-utils/model.js';
  18. import { getData as getViewData } from 'ckeditor5/engine/dev-utils/view.js';
  19. describe( 'EditingController', () => {
  20. describe( 'constructor()', () => {
  21. it( 'should create controller with properties', () => {
  22. const model = new ModelDocument();
  23. const editing = new EditingController( model );
  24. expect( editing ).to.have.property( 'model' ).that.equals( model );
  25. expect( editing ).to.have.property( 'view' ).that.is.instanceof( ViewDocument );
  26. expect( editing ).to.have.property( 'mapper' ).that.is.instanceof( Mapper );
  27. expect( editing ).to.have.property( 'modelToView' ).that.is.instanceof( ModelConversionDispatcher );
  28. editing.destroy();
  29. } );
  30. } );
  31. describe( 'createRoot', () => {
  32. let model, modelRoot, editing;
  33. beforeEach( () => {
  34. model = new ModelDocument();
  35. modelRoot = model.createRoot();
  36. model.createRoot( '$root', 'header' );
  37. editing = new EditingController( model );
  38. } );
  39. afterEach( () => {
  40. editing.destroy();
  41. } );
  42. it( 'should create root', () => {
  43. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  44. const viewRoot = editing.createRoot( domRoot );
  45. expect( viewRoot ).to.equal( editing.view.getRoot() );
  46. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  47. expect( editing.view.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domRoot );
  48. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  49. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( modelRoot );
  50. expect( editing.mapper.toViewElement( modelRoot ) ).to.equal( viewRoot );
  51. } );
  52. it( 'should create root with given name', () => {
  53. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  54. const viewRoot = editing.createRoot( domRoot, 'header' );
  55. expect( viewRoot ).to.equal( editing.view.getRoot( 'header' ) );
  56. expect( domRoot ).to.equal( editing.view.getDomRoot( 'header' ) );
  57. expect( editing.view.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domRoot );
  58. expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  59. expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( model.getRoot( 'header' ) );
  60. expect( editing.mapper.toViewElement( model.getRoot( 'header' ) ) ).to.equal( viewRoot );
  61. } );
  62. it( 'should be possible to attach DOM element later', () => {
  63. const domRoot = createElement( document, 'div', null, createElement( document, 'p' ) );
  64. const viewRoot = editing.createRoot( 'div' );
  65. expect( viewRoot ).to.equal( editing.view.getRoot() );
  66. expect( editing.view.getDomRoot() ).to.be.undefined;
  67. editing.view.attachDomRoot( domRoot );
  68. expect( domRoot ).to.equal( editing.view.getDomRoot() );
  69. expect( editing.view.domConverter.getCorrespondingDom( 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. } );
  75. describe( 'conversion', () => {
  76. let model, modelRoot, viewRoot, domRoot, editing, listener;
  77. before( () => {
  78. listener = Object.create( EmitterMixin );
  79. model = new ModelDocument();
  80. modelRoot = model.createRoot();
  81. editing = new EditingController( model );
  82. domRoot = document.createElement( 'div' );
  83. document.body.appendChild( domRoot );
  84. viewRoot = editing.createRoot( domRoot );
  85. model.schema.registerItem( 'paragraph', '$block' );
  86. model.schema.registerItem( 'div', '$block' );
  87. buildModelConverter().for( editing.modelToView ).fromElement( 'paragraph' ).toElement( 'p' );
  88. buildModelConverter().for( editing.modelToView ).fromElement( 'div' ).toElement( 'div' );
  89. } );
  90. after( () => {
  91. document.body.removeChild( domRoot );
  92. listener.stopListening();
  93. editing.destroy();
  94. } );
  95. beforeEach( () => {
  96. // Note: The below code is highly overcomplicated due to #455.
  97. model.selection.removeAllRanges();
  98. modelRoot.removeChildren( 0, modelRoot.childCount );
  99. viewRoot.removeChildren( 0, viewRoot.childCount );
  100. const modelData = new ModelDocumentFragment( parse(
  101. '<paragraph>foo</paragraph>' +
  102. '<paragraph></paragraph>' +
  103. '<paragraph>bar</paragraph>',
  104. model.schema
  105. )._children );
  106. model.enqueueChanges( () => {
  107. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  108. model.selection.addRange( ModelRange.createFromParentsAndOffsets(
  109. modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 ) );
  110. } );
  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. } );
  193. describe( 'destroy', () => {
  194. it( 'should remove listenters', () => {
  195. let model, editing;
  196. model = new ModelDocument();
  197. model.createRoot();
  198. model.schema.registerItem( 'paragraph', '$block' );
  199. editing = new EditingController( model );
  200. const spy = sinon.spy();
  201. editing.modelToView.on( 'insert:$element', spy );
  202. editing.destroy();
  203. model.enqueueChanges( () => {
  204. const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
  205. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  206. } );
  207. expect( spy.called ).to.be.false;
  208. editing.destroy();
  209. } );
  210. it( 'should destroy view', () => {
  211. let model, editing;
  212. model = new ModelDocument();
  213. model.createRoot();
  214. model.schema.registerItem( 'paragraph', '$block' );
  215. editing = new EditingController( model );
  216. const spy = sinon.spy( editing.view, 'destroy' );
  217. editing.destroy();
  218. expect( spy.called ).to.be.true;
  219. } );
  220. } );
  221. } );