editingcontroller.js 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  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. /* bender-tags: view */
  7. import EmitterMixin from 'ckeditor5/utils/emittermixin.js';
  8. import EditingController from 'ckeditor5/engine/controller/editingcontroller.js';
  9. import ViewDocument from 'ckeditor5/engine/view/document.js';
  10. import Mapper from 'ckeditor5/engine/conversion/mapper.js';
  11. import ModelConversionDispatcher from 'ckeditor5/engine/conversion/modelconversiondispatcher.js';
  12. import buildModelConverter from 'ckeditor5/engine/conversion/buildmodelconverter.js';
  13. import ModelDocument from 'ckeditor5/engine/model/document.js';
  14. import ModelPosition from 'ckeditor5/engine/model/position.js';
  15. import ModelRange from 'ckeditor5/engine/model/range.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. let model, editing;
  23. beforeEach( () => {
  24. model = new ModelDocument();
  25. editing = new EditingController( model );
  26. } );
  27. it( 'should create controller with properties', () => {
  28. expect( editing ).to.have.property( 'model' ).that.equals( model );
  29. expect( editing ).to.have.property( 'view' ).that.is.instanceof( ViewDocument );
  30. expect( editing ).to.have.property( 'mapper' ).that.is.instanceof( Mapper );
  31. expect( editing ).to.have.property( 'modelToView' ).that.is.instanceof( ModelConversionDispatcher );
  32. } );
  33. } );
  34. describe( 'createRoot', () => {
  35. let model, modelRoot, editing;
  36. beforeEach( () => {
  37. model = new ModelDocument();
  38. modelRoot = model.createRoot();
  39. model.createRoot( '$root', 'header' );
  40. editing = new EditingController( model );
  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. } );
  94. beforeEach( () => {
  95. // Note: The below code is highly overcomplicated due to #455.
  96. model.selection.removeAllRanges();
  97. modelRoot.removeChildren( 0, modelRoot.childCount );
  98. viewRoot.removeChildren( 0, viewRoot.childCount );
  99. const modelData = new ModelDocumentFragment( parse(
  100. '<paragraph>foo</paragraph>' +
  101. '<paragraph></paragraph>' +
  102. '<paragraph>bar</paragraph>',
  103. model.schema
  104. )._children );
  105. model.enqueueChanges( () => {
  106. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  107. model.selection.addRange( ModelRange.createFromParentsAndOffsets(
  108. modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 ) );
  109. } );
  110. } );
  111. it( 'should convert insertion', () => {
  112. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  113. } );
  114. it( 'should convert split', () => {
  115. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  116. model.enqueueChanges( () => {
  117. model.batch().split( model.selection.getFirstPosition() );
  118. model.selection.setRanges( [
  119. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 1 ), 0, modelRoot.getChild( 1 ), 0 )
  120. ] );
  121. } );
  122. expect( getViewData( editing.view ) ).to.equal( '<p>f</p><p>{}oo</p><p></p><p>bar</p>' );
  123. } );
  124. it( 'should convert rename', () => {
  125. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  126. model.enqueueChanges( () => {
  127. model.batch().rename( modelRoot.getChild( 0 ), 'div' );
  128. } );
  129. expect( getViewData( editing.view ) ).to.equal( '<div>f{}oo</div><p></p><p>bar</p>' );
  130. } );
  131. it( 'should convert delete', () => {
  132. model.enqueueChanges( () => {
  133. model.batch().remove(
  134. ModelRange.createFromPositionAndShift( model.selection.getFirstPosition(), 1 )
  135. );
  136. model.selection.setRanges( [
  137. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 )
  138. ] );
  139. } );
  140. expect( getViewData( editing.view ) ).to.equal( '<p>f{}o</p><p></p><p>bar</p>' );
  141. } );
  142. it( 'should convert selection from view to model', ( done ) => {
  143. listener.listenTo( editing.view, 'selectionChange', () => {
  144. setTimeout( () => {
  145. expect( getModelData( model ) ).to.equal(
  146. '<paragraph>foo</paragraph>' +
  147. '<paragraph></paragraph>' +
  148. '<paragraph>b[a]r</paragraph>' );
  149. done();
  150. } );
  151. } );
  152. editing.view.isFocused = true;
  153. const domSelection = document.getSelection();
  154. domSelection.removeAllRanges();
  155. const domBar = domRoot.childNodes[ 2 ].childNodes[ 0 ];
  156. const domRange = new Range();
  157. domRange.setStart( domBar, 1 );
  158. domRange.setEnd( domBar, 2 );
  159. domSelection.addRange( domRange );
  160. } );
  161. it( 'should convert collapsed selection', () => {
  162. model.enqueueChanges( () => {
  163. model.selection.setRanges( [
  164. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  165. ] );
  166. } );
  167. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  168. } );
  169. it( 'should convert not collapsed selection', () => {
  170. model.enqueueChanges( () => {
  171. model.selection.setRanges( [
  172. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 2 )
  173. ] );
  174. } );
  175. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{a}r</p>' );
  176. } );
  177. it( 'should clear previous selection', () => {
  178. model.enqueueChanges( () => {
  179. model.selection.setRanges( [
  180. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  181. ] );
  182. } );
  183. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  184. model.enqueueChanges( () => {
  185. model.selection.setRanges( [
  186. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 2, modelRoot.getChild( 2 ), 2 )
  187. ] );
  188. } );
  189. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>ba{}r</p>' );
  190. } );
  191. } );
  192. describe( 'destroy', () => {
  193. it( 'should remove listenters', () => {
  194. let model, editing;
  195. model = new ModelDocument();
  196. model.createRoot();
  197. model.schema.registerItem( 'paragraph', '$block' );
  198. editing = new EditingController( model );
  199. const spy = sinon.spy();
  200. editing.modelToView.on( 'insert:$element', spy );
  201. editing.destroy();
  202. model.enqueueChanges( () => {
  203. const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
  204. model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData );
  205. } );
  206. expect( spy.called ).to.be.false;
  207. } );
  208. } );
  209. } );