editingcontroller.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  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 Model from '../../src/model/model';
  13. import ModelPosition from '../../src/model/position';
  14. import ModelRange from '../../src/model/range';
  15. import ModelDocumentFragment from '../../src/model/documentfragment';
  16. import { parse, getData as getModelData } from '../../src/dev-utils/model';
  17. import { getData as getViewData } from '../../src/dev-utils/view';
  18. describe( 'EditingController', () => {
  19. describe( 'constructor()', () => {
  20. let model, editing;
  21. beforeEach( () => {
  22. model = new Model();
  23. editing = new EditingController( model );
  24. } );
  25. afterEach( () => {
  26. editing.destroy();
  27. } );
  28. it( 'should create controller with properties', () => {
  29. expect( editing ).to.have.property( 'model' ).that.equals( model );
  30. expect( editing ).to.have.property( 'view' ).that.is.instanceof( ViewDocument );
  31. expect( editing ).to.have.property( 'mapper' ).that.is.instanceof( Mapper );
  32. expect( editing ).to.have.property( 'modelToView' ).that.is.instanceof( ModelConversionDispatcher );
  33. editing.destroy();
  34. } );
  35. it( 'should be observable', () => {
  36. const spy = sinon.spy();
  37. editing.on( 'change:foo', spy );
  38. editing.set( 'foo', 'bar' );
  39. sinon.assert.calledOnce( spy );
  40. } );
  41. it( 'should bind view roots to model roots', () => {
  42. expect( model.document.roots ).to.length( 1 ); // $graveyard
  43. expect( editing.view.roots ).to.length( 0 );
  44. const modelRoot = model.document.createRoot();
  45. expect( model.document.roots ).to.length( 2 );
  46. expect( editing.view.roots ).to.length( 1 );
  47. expect( editing.view.getRoot().name ).to.equal( modelRoot.name ).to.equal( '$root' );
  48. } );
  49. } );
  50. describe( 'conversion', () => {
  51. let model, modelRoot, viewRoot, domRoot, editing, listener;
  52. beforeEach( () => {
  53. listener = Object.create( EmitterMixin );
  54. model = new Model();
  55. modelRoot = model.document.createRoot();
  56. editing = new EditingController( model );
  57. domRoot = document.createElement( 'div' );
  58. domRoot.contentEditable = true;
  59. document.body.appendChild( domRoot );
  60. viewRoot = editing.view.getRoot();
  61. editing.view.attachDomRoot( domRoot );
  62. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  63. model.schema.register( 'div', { inheritAllFrom: '$block' } );
  64. buildModelConverter().for( editing.modelToView ).fromElement( 'paragraph' ).toElement( 'p' );
  65. buildModelConverter().for( editing.modelToView ).fromElement( 'div' ).toElement( 'div' );
  66. buildModelConverter().for( editing.modelToView ).fromMarker( 'marker' ).toHighlight( {} );
  67. // Note: The below code is highly overcomplicated due to #455.
  68. model.document.selection.removeAllRanges();
  69. modelRoot.removeChildren( 0, modelRoot.childCount );
  70. viewRoot.removeChildren( 0, viewRoot.childCount );
  71. const modelData = new ModelDocumentFragment( parse(
  72. '<paragraph>foo</paragraph>' +
  73. '<paragraph></paragraph>' +
  74. '<paragraph>bar</paragraph>',
  75. model.schema
  76. )._children );
  77. model.change( writer => {
  78. writer.insert( modelData, model.document.getRoot() );
  79. model.document.selection.addRange( ModelRange.createFromParentsAndOffsets(
  80. modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 )
  81. );
  82. } );
  83. } );
  84. afterEach( () => {
  85. document.body.removeChild( domRoot );
  86. listener.stopListening();
  87. editing.destroy();
  88. } );
  89. it( 'should convert insertion', () => {
  90. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  91. } );
  92. it( 'should convert split', () => {
  93. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  94. model.change( writer => {
  95. writer.split( model.document.selection.getFirstPosition() );
  96. model.document.selection.setRanges( [
  97. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 1 ), 0, modelRoot.getChild( 1 ), 0 )
  98. ] );
  99. } );
  100. expect( getViewData( editing.view ) ).to.equal( '<p>f</p><p>{}oo</p><p></p><p>bar</p>' );
  101. } );
  102. it( 'should convert rename', () => {
  103. expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
  104. model.change( writer => {
  105. writer.rename( modelRoot.getChild( 0 ), 'div' );
  106. } );
  107. expect( getViewData( editing.view ) ).to.equal( '<div>f{}oo</div><p></p><p>bar</p>' );
  108. } );
  109. it( 'should convert delete', () => {
  110. model.change( writer => {
  111. writer.remove(
  112. ModelRange.createFromPositionAndShift( model.document.selection.getFirstPosition(), 1 )
  113. );
  114. model.document.selection.setRanges( [
  115. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 )
  116. ] );
  117. } );
  118. expect( getViewData( editing.view ) ).to.equal( '<p>f{}o</p><p></p><p>bar</p>' );
  119. } );
  120. it( 'should convert selection from view to model', done => {
  121. listener.listenTo( editing.view, 'selectionChange', () => {
  122. setTimeout( () => {
  123. expect( getModelData( model ) ).to.equal(
  124. '<paragraph>foo</paragraph>' +
  125. '<paragraph></paragraph>' +
  126. '<paragraph>b[a]r</paragraph>'
  127. );
  128. done();
  129. } );
  130. } );
  131. editing.view.isFocused = true;
  132. editing.view.render();
  133. const domSelection = document.getSelection();
  134. domSelection.removeAllRanges();
  135. const domBar = domRoot.childNodes[ 2 ].childNodes[ 0 ];
  136. const domRange = document.createRange();
  137. domRange.setStart( domBar, 1 );
  138. domRange.setEnd( domBar, 2 );
  139. domSelection.addRange( domRange );
  140. } );
  141. it( 'should convert collapsed selection', () => {
  142. model.change( () => {
  143. model.document.selection.setRanges( [
  144. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  145. ] );
  146. } );
  147. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  148. } );
  149. it( 'should convert not collapsed selection', () => {
  150. model.change( () => {
  151. model.document.selection.setRanges( [
  152. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 2 )
  153. ] );
  154. } );
  155. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{a}r</p>' );
  156. } );
  157. it( 'should clear previous selection', () => {
  158. model.change( () => {
  159. model.document.selection.setRanges( [
  160. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 )
  161. ] );
  162. } );
  163. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
  164. model.change( () => {
  165. model.document.selection.setRanges( [
  166. ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 2, modelRoot.getChild( 2 ), 2 )
  167. ] );
  168. } );
  169. expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>ba{}r</p>' );
  170. } );
  171. it( 'should convert adding marker', () => {
  172. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  173. model.change( () => {
  174. model.markers.set( 'marker', range );
  175. } );
  176. expect( getViewData( editing.view, { withoutSelection: true } ) )
  177. .to.equal( '<p>f<span>oo</span></p><p></p><p><span>ba</span>r</p>' );
  178. } );
  179. it( 'should convert removing marker', () => {
  180. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  181. model.change( () => {
  182. model.markers.set( 'marker', range );
  183. } );
  184. model.change( () => {
  185. model.markers.remove( 'marker' );
  186. } );
  187. expect( getViewData( editing.view, { withoutSelection: true } ) )
  188. .to.equal( '<p>foo</p><p></p><p>bar</p>' );
  189. } );
  190. it( 'should convert changing marker', () => {
  191. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  192. model.change( () => {
  193. model.markers.set( 'marker', range );
  194. } );
  195. const range2 = new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 2 ] ) );
  196. model.change( () => {
  197. model.markers.set( 'marker', range2 );
  198. } );
  199. expect( getViewData( editing.view, { withoutSelection: true } ) )
  200. .to.equal( '<p><span>fo</span>o</p><p></p><p>bar</p>' );
  201. } );
  202. it( 'should convert insertion into marker', () => {
  203. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  204. model.change( () => {
  205. model.markers.set( 'marker', range );
  206. } );
  207. model.change( writer => {
  208. writer.insertText( 'xyz', new ModelPosition( modelRoot, [ 1, 0 ] ) );
  209. } );
  210. expect( getViewData( editing.view, { withoutSelection: true } ) )
  211. .to.equal( '<p>f<span>oo</span></p><p><span>xyz</span></p><p><span>ba</span>r</p>' );
  212. } );
  213. it( 'should convert move to marker', () => {
  214. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  215. model.change( () => {
  216. model.markers.set( 'marker', range );
  217. } );
  218. model.change( writer => {
  219. writer.move(
  220. new ModelRange( new ModelPosition( modelRoot, [ 2, 2 ] ), new ModelPosition( modelRoot, [ 2, 3 ] ) ),
  221. new ModelPosition( modelRoot, [ 0, 3 ] )
  222. );
  223. } );
  224. expect( getViewData( editing.view, { withoutSelection: true } ) )
  225. .to.equal( '<p>f<span>oor</span></p><p></p><p><span>ba</span></p>' );
  226. } );
  227. it( 'should convert move from marker', () => {
  228. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
  229. model.change( () => {
  230. model.markers.set( 'marker', range );
  231. } );
  232. model.change( writer => {
  233. writer.move(
  234. new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) ),
  235. new ModelPosition( modelRoot, [ 2, 3 ] )
  236. );
  237. } );
  238. expect( getViewData( editing.view, { withoutSelection: true } ) )
  239. .to.equal( '<p>f</p><p></p><p><span>ba</span>roo</p>' );
  240. } );
  241. it( 'should convert the whole marker move', () => {
  242. const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) );
  243. model.change( () => {
  244. model.markers.set( 'marker', range );
  245. } );
  246. model.change( writer => {
  247. writer.move(
  248. new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) ),
  249. new ModelPosition( modelRoot, [ 1, 0 ] )
  250. );
  251. } );
  252. expect( getViewData( editing.view, { withoutSelection: true } ) )
  253. .to.equal( '<p></p><p>f<span>oo</span></p><p>bar</p>' );
  254. } );
  255. } );
  256. describe( 'destroy()', () => {
  257. it( 'should remove listenters', () => {
  258. const model = new Model();
  259. model.document.createRoot();
  260. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  261. const editing = new EditingController( model );
  262. const spy = sinon.spy();
  263. editing.modelToView.on( 'insert:$element', spy );
  264. editing.destroy();
  265. model.change( writer => {
  266. const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
  267. writer.insert( modelData, model.document.getRoot() );
  268. } );
  269. expect( spy.called ).to.be.false;
  270. editing.destroy();
  271. } );
  272. it( 'should destroy view', () => {
  273. const model = new Model();
  274. model.document.createRoot();
  275. model.schema.register( 'paragraph', { inheritAllFrom: '$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. } );