8
0

model-to-view-converters.js 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: conversion */
  6. import ModelDocument from 'ckeditor5/engine/model/document.js';
  7. import ModelElement from 'ckeditor5/engine/model/element.js';
  8. import ModelText from 'ckeditor5/engine/model/text.js';
  9. import ModelRange from 'ckeditor5/engine/model/range.js';
  10. import ModelPosition from 'ckeditor5/engine/model/position.js';
  11. import modelWriter from 'ckeditor5/engine/model/writer.js';
  12. import ViewElement from 'ckeditor5/engine/view/element.js';
  13. import ViewContainerElement from 'ckeditor5/engine/view/containerelement.js';
  14. import ViewAttributeElement from 'ckeditor5/engine/view/attributeelement.js';
  15. import ViewText from 'ckeditor5/engine/view/text.js';
  16. import Mapper from 'ckeditor5/engine/conversion/mapper.js';
  17. import ModelConversionDispatcher from 'ckeditor5/engine/conversion/modelconversiondispatcher.js';
  18. import {
  19. insertElement,
  20. insertText,
  21. setAttribute,
  22. removeAttribute,
  23. wrap,
  24. unwrap,
  25. move,
  26. remove,
  27. rename
  28. } from 'ckeditor5/engine/conversion/model-to-view-converters.js';
  29. import { createRangeOnElementOnly } from 'tests/engine/model/_utils/utils.js';
  30. describe( 'model-to-view-converters', () => {
  31. let dispatcher, modelDoc, modelRoot, mapper, viewRoot;
  32. beforeEach( () => {
  33. modelDoc = new ModelDocument();
  34. modelRoot = modelDoc.createRoot();
  35. viewRoot = new ViewContainerElement( 'div' );
  36. mapper = new Mapper();
  37. mapper.bindElements( modelRoot, viewRoot );
  38. dispatcher = new ModelConversionDispatcher( { mapper } );
  39. } );
  40. function viewAttributesToString( item ) {
  41. let result = '';
  42. for ( let key of item.getAttributeKeys() ) {
  43. let value = item.getAttribute( key );
  44. if ( value ) {
  45. result += ' ' + key + '="' + value + '"';
  46. }
  47. }
  48. return result;
  49. }
  50. function viewToString( item ) {
  51. let result = '';
  52. if ( item instanceof ViewText ) {
  53. result = item.data;
  54. } else {
  55. // ViewElement or ViewDocumentFragment.
  56. for ( let child of item.getChildren() ) {
  57. result += viewToString( child );
  58. }
  59. if ( item instanceof ViewElement ) {
  60. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  61. }
  62. }
  63. return result;
  64. }
  65. describe( 'insertText', () => {
  66. it( 'should convert text insertion in model to view text', () => {
  67. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  68. dispatcher.on( 'insert:$text', insertText() );
  69. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  70. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  71. } );
  72. it( 'should support unicode', () => {
  73. modelRoot.appendChildren( new ModelText( 'நிலைக்கு' ) );
  74. dispatcher.on( 'insert:$text', insertText() );
  75. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  76. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  77. } );
  78. it( 'should be possible to override it', () => {
  79. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  80. dispatcher.on( 'insert:$text', insertText() );
  81. dispatcher.on( 'insert:$text', ( evt, data, consumable ) => {
  82. consumable.consume( data.item, 'insert' );
  83. }, { priority: 'high' } );
  84. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  85. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  86. } );
  87. } );
  88. describe( 'insertElement', () => {
  89. it( 'should convert element insertion in model to and map positions for future converting', () => {
  90. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  91. const viewElement = new ViewContainerElement( 'p' );
  92. modelRoot.appendChildren( modelElement );
  93. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  94. dispatcher.on( 'insert:$text', insertText() );
  95. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  96. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  97. } );
  98. it( 'should take view element function generator as a parameter', () => {
  99. const elementGenerator = ( data, consumable ) => {
  100. if ( consumable.consume( data.item, 'addAttribute:nice' ) ) {
  101. return new ViewContainerElement( 'div' );
  102. } else {
  103. return new ViewContainerElement( 'p' );
  104. }
  105. };
  106. const niceP = new ModelElement( 'myParagraph', { nice: true }, new ModelText( 'foo' ) );
  107. const badP = new ModelElement( 'myParagraph', null, new ModelText( 'bar' ) );
  108. modelRoot.appendChildren( [ niceP, badP ] );
  109. dispatcher.on( 'insert:myParagraph', insertElement( elementGenerator ) );
  110. dispatcher.on( 'insert:$text', insertText() );
  111. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  112. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
  113. } );
  114. } );
  115. describe( 'setAttribute/removeAttribute', () => {
  116. it( 'should convert attribute insert/change/remove on a model node', () => {
  117. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  118. const viewElement = new ViewContainerElement( 'p' );
  119. modelRoot.appendChildren( modelElement );
  120. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  121. dispatcher.on( 'insert:$text', insertText() );
  122. dispatcher.on( 'addAttribute:class', setAttribute() );
  123. dispatcher.on( 'changeAttribute:class', setAttribute() );
  124. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  125. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  126. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  127. modelElement.setAttribute( 'class', 'bar' );
  128. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'foo', 'bar' );
  129. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  130. modelElement.removeAttribute( 'class' );
  131. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  132. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  133. } );
  134. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  135. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  136. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  137. const themeConverter = ( value, key, data ) => {
  138. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  139. value += ' ' + 'fix-content';
  140. }
  141. return { key: 'class', value };
  142. };
  143. modelRoot.appendChildren( [ modelParagraph, modelDiv ] );
  144. dispatcher.on( 'insert:paragraph', insertElement( new ViewContainerElement( 'p' ) ) );
  145. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  146. dispatcher.on( 'insert:$text', insertText() );
  147. dispatcher.on( 'addAttribute:theme', setAttribute( themeConverter ) );
  148. dispatcher.on( 'changeAttribute:theme', setAttribute( themeConverter ) );
  149. dispatcher.on( 'removeAttribute:theme', removeAttribute( themeConverter ) );
  150. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  151. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  152. modelParagraph.setAttribute( 'theme', 'awesome' );
  153. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'nice', 'awesome' );
  154. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  155. modelParagraph.removeAttribute( 'theme' );
  156. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'awesome', null );
  157. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  158. } );
  159. it( 'should be possible to override setAttribute', () => {
  160. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  161. const viewElement = new ViewContainerElement( 'p' );
  162. modelRoot.appendChildren( modelElement );
  163. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  164. dispatcher.on( 'insert:$text', insertText() );
  165. dispatcher.on( 'addAttribute:class', setAttribute() );
  166. dispatcher.on( 'addAttribute:class', ( evt, data, consumable ) => {
  167. consumable.consume( data.item, 'addAttribute:class' );
  168. }, { priority: 'high' } );
  169. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  170. // No attribute set.
  171. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  172. } );
  173. it( 'should be possible to override removeAttribute', () => {
  174. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  175. const viewElement = new ViewContainerElement( 'p' );
  176. modelRoot.appendChildren( modelElement );
  177. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  178. dispatcher.on( 'insert:$text', insertText() );
  179. dispatcher.on( 'addAttribute:class', setAttribute() );
  180. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  181. dispatcher.on( 'removeAttribute:class', ( evt, data, consumable ) => {
  182. consumable.consume( data.item, 'removeAttribute:class' );
  183. }, { priority: 'high' } );
  184. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  185. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  186. modelElement.removeAttribute( 'class' );
  187. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  188. // Nothing changed.
  189. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  190. } );
  191. } );
  192. describe( 'wrap/unwrap', () => {
  193. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  194. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  195. const viewP = new ViewContainerElement( 'p' );
  196. const viewB = new ViewAttributeElement( 'b' );
  197. modelRoot.appendChildren( modelElement );
  198. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  199. dispatcher.on( 'insert:$text', insertText() );
  200. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  201. dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
  202. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  203. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  204. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  205. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  206. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  207. } );
  208. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  209. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  210. const viewP = new ViewContainerElement( 'p' );
  211. const elementGenerator = ( value ) => {
  212. if ( value == 'bold' ) {
  213. return new ViewAttributeElement( 'b' );
  214. }
  215. };
  216. modelRoot.appendChildren( modelElement );
  217. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  218. dispatcher.on( 'insert:$text', insertText() );
  219. dispatcher.on( 'addAttribute:style', wrap( elementGenerator ) );
  220. dispatcher.on( 'removeAttribute:style', unwrap( elementGenerator ) );
  221. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  222. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  223. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'style' );
  224. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'style', 'bold', null );
  225. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  226. } );
  227. it( 'should update range on re-wrapping attribute (#475)', () => {
  228. const modelElement = new ModelElement( 'paragraph', null, [
  229. new ModelText( 'x' ),
  230. new ModelText( 'foo', { link: 'http://foo.com' } ),
  231. new ModelText( 'x' )
  232. ] );
  233. const viewP = new ViewContainerElement( 'p' );
  234. const elementGenerator = ( href ) => new ViewAttributeElement( 'a', { href } );
  235. modelRoot.appendChildren( modelElement );
  236. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  237. dispatcher.on( 'insert:$text', insertText() );
  238. dispatcher.on( 'addAttribute:link', wrap( elementGenerator ) );
  239. dispatcher.on( 'changeAttribute:link', wrap( elementGenerator ) );
  240. dispatcher.convertInsertion(
  241. ModelRange.createIn( modelRoot )
  242. );
  243. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  244. modelWriter.setAttribute( ModelRange.createIn( modelElement ), 'link', 'http://foobar.com' );
  245. dispatcher.convertAttribute(
  246. 'changeAttribute',
  247. ModelRange.createIn( modelElement ),
  248. 'link',
  249. 'http://foo.com',
  250. 'http://foobar.com'
  251. );
  252. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  253. } );
  254. it( 'should support unicode', () => {
  255. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  256. const viewP = new ViewContainerElement( 'p' );
  257. const viewB = new ViewAttributeElement( 'b' );
  258. modelRoot.appendChildren( modelElement );
  259. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  260. dispatcher.on( 'insert:$text', insertText() );
  261. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  262. dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
  263. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  264. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  265. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  266. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  267. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  268. } );
  269. it( 'should be possible to override wrap', () => {
  270. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  271. const viewP = new ViewContainerElement( 'p' );
  272. const viewB = new ViewAttributeElement( 'b' );
  273. modelRoot.appendChildren( modelElement );
  274. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  275. dispatcher.on( 'insert:$text', insertText() );
  276. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  277. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  278. consumable.consume( data.item, 'addAttribute:bold' );
  279. }, { priority: 'high' } );
  280. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  281. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  282. } );
  283. it( 'should be possible to override unwrap', () => {
  284. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  285. const viewP = new ViewContainerElement( 'p' );
  286. const viewB = new ViewAttributeElement( 'b' );
  287. modelRoot.appendChildren( modelElement );
  288. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  289. dispatcher.on( 'insert:$text', insertText() );
  290. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  291. dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
  292. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  293. consumable.consume( data.item, 'removeAttribute:bold' );
  294. }, { priority: 'high' } );
  295. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  296. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  297. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  298. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  299. // Nothing changed.
  300. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  301. } );
  302. } );
  303. describe( 'move', () => {
  304. it( 'should move items in view accordingly to changes in model', () => {
  305. const modelDivA = new ModelElement( 'div', null, [
  306. new ModelText( 'foo' ),
  307. new ModelElement( 'image' ),
  308. new ModelText( 'bar' )
  309. ] );
  310. const modelDivB = new ModelElement( 'div', null, new ModelText( 'xxyy' ) );
  311. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  312. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  313. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  314. dispatcher.on( 'insert:$text', insertText() );
  315. dispatcher.on( 'move', move() );
  316. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  317. const removedNodes = modelDivA.removeChildren( 0, 2 );
  318. modelDivB.insertChildren( 0, removedNodes );
  319. dispatcher.convertMove(
  320. ModelPosition.createFromParentAndOffset( modelDivA, 0 ),
  321. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 4 )
  322. );
  323. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div><div>foo<img></img>xxyy</div></div>' );
  324. } );
  325. it( 'should not execute if value was already consumed', () => {
  326. const modelDivA = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  327. const modelDivB = new ModelElement( 'div', null, new ModelText( 'xxyy' ) );
  328. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  329. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  330. dispatcher.on( 'insert:$text', insertText() );
  331. dispatcher.on( 'move', move() );
  332. dispatcher.on( 'move', ( evt, data, consumable ) => {
  333. consumable.consume( data.item, 'move' );
  334. }, { priority: 'high' } );
  335. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  336. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><div>xxyy</div></div>' );
  337. const removedNodes = modelDivA.removeChildren( 0, 1 );
  338. modelDivB.insertChildren( 0, removedNodes );
  339. dispatcher.convertMove(
  340. ModelPosition.createFromParentAndOffset( modelDivA, 0 ),
  341. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 3 )
  342. );
  343. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><div>xxyy</div></div>' );
  344. } );
  345. it( 'should support unicode', () => {
  346. const modelDivA = new ModelElement( 'div', null, 'நிலைக்கு' );
  347. const modelDivB = new ModelElement( 'div' );
  348. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  349. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  350. dispatcher.on( 'insert:$text', insertText() );
  351. dispatcher.on( 'move', move() );
  352. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  353. modelWriter.move(
  354. ModelRange.createFromParentsAndOffsets( modelDivA, 2, modelDivA, 6 ),
  355. ModelPosition.createAt( modelDivB, 'end' )
  356. );
  357. dispatcher.convertMove(
  358. ModelPosition.createFromParentAndOffset( modelDivA, 2 ),
  359. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 4 )
  360. );
  361. expect( viewToString( viewRoot ) ).to.equal( '<div><div>நிகு</div><div>லைக்</div></div>' );
  362. } );
  363. } );
  364. describe( 'remove', () => {
  365. it( 'should remove items from view accordingly to changes in model', () => {
  366. const modelDiv = new ModelElement( 'div', null, [
  367. new ModelText( 'foo' ),
  368. new ModelElement( 'image' ),
  369. new ModelText( 'bar' )
  370. ] );
  371. modelRoot.appendChildren( modelDiv );
  372. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  373. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  374. dispatcher.on( 'insert:$text', insertText() );
  375. dispatcher.on( 'remove', remove() );
  376. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  377. const removedNodes = modelDiv.removeChildren( 0, 2 );
  378. modelDoc.graveyard.insertChildren( 0, removedNodes );
  379. dispatcher.convertRemove(
  380. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  381. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 4 )
  382. );
  383. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div></div>' );
  384. } );
  385. it( 'should not execute if value was already consumed', () => {
  386. const modelDiv = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  387. modelRoot.appendChildren( modelDiv );
  388. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  389. dispatcher.on( 'insert:$text', insertText() );
  390. dispatcher.on( 'remove', remove() );
  391. dispatcher.on( 'remove', ( evt, data, consumable ) => {
  392. consumable.consume( data.item, 'remove' );
  393. }, { priority: 'high' } );
  394. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  395. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  396. const removedNodes = modelDiv.removeChildren( 0, 1 );
  397. modelDoc.graveyard.insertChildren( 0, removedNodes );
  398. dispatcher.convertRemove(
  399. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  400. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 3 )
  401. );
  402. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  403. } );
  404. it( 'should support unicode', () => {
  405. const modelDiv = new ModelElement( 'div', null, 'நிலைக்கு' );
  406. modelRoot.appendChildren( modelDiv );
  407. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  408. dispatcher.on( 'insert:$text', insertText() );
  409. dispatcher.on( 'remove', remove() );
  410. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  411. modelWriter.move(
  412. ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ),
  413. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  414. );
  415. dispatcher.convertRemove(
  416. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  417. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 6 )
  418. );
  419. expect( viewToString( viewRoot ) ).to.equal( '<div><div>கு</div></div>' );
  420. } );
  421. } );
  422. describe( 'rename', () => {
  423. const oldName = 'oldName';
  424. const newName = 'newName';
  425. let element, converters;
  426. beforeEach( () => {
  427. converters = {
  428. insertText: insertText(),
  429. insert: insertElement( ( data ) => new ViewContainerElement( data.item.name ) ),
  430. move: move(),
  431. remove: remove(),
  432. rename: rename()
  433. };
  434. sinon.spy( converters, 'insert' );
  435. sinon.spy( converters, 'move' );
  436. sinon.spy( converters, 'remove' );
  437. element = new ModelElement( oldName, null, new ModelText( 'foo' ) );
  438. modelRoot.appendChildren( element );
  439. dispatcher.on( 'insert:$text', converters.insertText );
  440. dispatcher.on( 'insert', converters.insert );
  441. dispatcher.on( 'move', converters.move );
  442. dispatcher.on( 'remove', converters.remove );
  443. dispatcher.on( 'rename', converters.rename );
  444. dispatcher.convertInsertion( ModelRange.createOn( element ) );
  445. element.name = newName;
  446. } );
  447. afterEach( () => {
  448. converters.insert.restore();
  449. converters.move.restore();
  450. converters.remove.restore();
  451. } );
  452. it( 'should enable default rename conversion, that uses already registered callbacks', () => {
  453. const insertCallCount = converters.insert.callCount;
  454. expect( viewRoot.getChild( 0 ).name ).to.equal( 'oldName' );
  455. dispatcher.convertRename( element, oldName );
  456. expect( converters.insert.callCount - insertCallCount ).to.equal( 1 );
  457. expect( converters.move.calledOnce ).to.be.true;
  458. expect( converters.remove.calledOnce ).to.be.true;
  459. expect( viewRoot.getChild( 0 ).name ).to.equal( 'newName' );
  460. expect( viewRoot.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  461. } );
  462. it( 'should not execute if converted value was already consumed', () => {
  463. dispatcher.on( 'rename', ( evt, data, consumable ) => {
  464. consumable.consume( data.element, 'rename' );
  465. }, { priority: 'high' } );
  466. dispatcher.on( 'rename', ( evt, data ) => {
  467. expect( data.fakeElement ).to.be.undefined;
  468. } );
  469. dispatcher.convertRename( element, oldName );
  470. } );
  471. } );
  472. } );