8
0

model-to-view-converters.js 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import ModelDocument from '../../src/model/document';
  6. import ModelElement from '../../src/model/element';
  7. import ModelText from '../../src/model/text';
  8. import ModelRange from '../../src/model/range';
  9. import ModelPosition from '../../src/model/position';
  10. import modelWriter from '../../src/model/writer';
  11. import ViewElement from '../../src/view/element';
  12. import ViewContainerElement from '../../src/view/containerelement';
  13. import ViewAttributeElement from '../../src/view/attributeelement';
  14. import ViewUIElement from '../../src/view/uielement';
  15. import ViewText from '../../src/view/text';
  16. import Mapper from '../../src/conversion/mapper';
  17. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  18. import {
  19. insertElement,
  20. insertText,
  21. insertUIElement,
  22. setAttribute,
  23. removeAttribute,
  24. wrapItem,
  25. unwrapItem,
  26. remove,
  27. removeUIElement
  28. } from '../../src/conversion/model-to-view-converters';
  29. import { createRangeOnElementOnly } from '../../tests/model/_utils/utils';
  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( modelDoc, { mapper } );
  39. } );
  40. function viewAttributesToString( item ) {
  41. let result = '';
  42. for ( const key of item.getAttributeKeys() ) {
  43. const 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 ( const 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. it( 'should not convert and not consume if creator function returned null', () => {
  115. const elementGenerator = () => null;
  116. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  117. modelRoot.appendChildren( [ modelP ] );
  118. sinon.spy( dispatcher, 'fire' );
  119. dispatcher.on( 'insert:paragraph', insertElement( elementGenerator ) );
  120. dispatcher.on( 'insert:paragraph', ( evt, data, consumable ) => {
  121. expect( consumable.test( data.item, 'insert' ) ).to.be.true;
  122. } );
  123. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  124. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  125. expect( dispatcher.fire.calledWith( 'insert:paragraph' ) ).to.be.true;
  126. } );
  127. } );
  128. describe( 'setAttribute/removeAttribute', () => {
  129. it( 'should convert attribute insert/change/remove on a model node', () => {
  130. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  131. const viewElement = new ViewContainerElement( 'p' );
  132. modelRoot.appendChildren( modelElement );
  133. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  134. dispatcher.on( 'insert:$text', insertText() );
  135. dispatcher.on( 'addAttribute:class', setAttribute() );
  136. dispatcher.on( 'changeAttribute:class', setAttribute() );
  137. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  138. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  139. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  140. modelElement.setAttribute( 'class', 'bar' );
  141. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'foo', 'bar' );
  142. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  143. modelElement.removeAttribute( 'class' );
  144. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  145. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  146. } );
  147. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  148. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  149. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  150. const themeConverter = ( value, key, data ) => {
  151. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  152. value += ' fix-content';
  153. }
  154. return { key: 'class', value };
  155. };
  156. modelRoot.appendChildren( [ modelParagraph, modelDiv ] );
  157. dispatcher.on( 'insert:paragraph', insertElement( new ViewContainerElement( 'p' ) ) );
  158. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  159. dispatcher.on( 'insert:$text', insertText() );
  160. dispatcher.on( 'addAttribute:theme', setAttribute( themeConverter ) );
  161. dispatcher.on( 'changeAttribute:theme', setAttribute( themeConverter ) );
  162. dispatcher.on( 'removeAttribute:theme', removeAttribute( themeConverter ) );
  163. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  164. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  165. modelParagraph.setAttribute( 'theme', 'awesome' );
  166. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'nice', 'awesome' );
  167. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  168. modelParagraph.removeAttribute( 'theme' );
  169. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'awesome', null );
  170. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  171. } );
  172. it( 'should be possible to override setAttribute', () => {
  173. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  174. const viewElement = new ViewContainerElement( 'p' );
  175. modelRoot.appendChildren( modelElement );
  176. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  177. dispatcher.on( 'insert:$text', insertText() );
  178. dispatcher.on( 'addAttribute:class', setAttribute() );
  179. dispatcher.on( 'addAttribute:class', ( evt, data, consumable ) => {
  180. consumable.consume( data.item, 'addAttribute:class' );
  181. }, { priority: 'high' } );
  182. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  183. // No attribute set.
  184. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  185. } );
  186. it( 'should be possible to override removeAttribute', () => {
  187. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  188. const viewElement = new ViewContainerElement( 'p' );
  189. modelRoot.appendChildren( modelElement );
  190. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  191. dispatcher.on( 'insert:$text', insertText() );
  192. dispatcher.on( 'addAttribute:class', setAttribute() );
  193. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  194. dispatcher.on( 'removeAttribute:class', ( evt, data, consumable ) => {
  195. consumable.consume( data.item, 'removeAttribute:class' );
  196. }, { priority: 'high' } );
  197. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  198. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  199. modelElement.removeAttribute( 'class' );
  200. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  201. // Nothing changed.
  202. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  203. } );
  204. } );
  205. describe( 'wrap/unwrap', () => {
  206. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  207. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  208. const viewP = new ViewContainerElement( 'p' );
  209. const viewB = new ViewAttributeElement( 'b' );
  210. modelRoot.appendChildren( modelElement );
  211. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  212. dispatcher.on( 'insert:$text', insertText() );
  213. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  214. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  215. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  216. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  217. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  218. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  219. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  220. } );
  221. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  222. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  223. const viewP = new ViewContainerElement( 'p' );
  224. const elementGenerator = value => {
  225. if ( value == 'bold' ) {
  226. return new ViewAttributeElement( 'b' );
  227. }
  228. };
  229. modelRoot.appendChildren( modelElement );
  230. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  231. dispatcher.on( 'insert:$text', insertText() );
  232. dispatcher.on( 'addAttribute:style', wrapItem( elementGenerator ) );
  233. dispatcher.on( 'removeAttribute:style', unwrapItem( elementGenerator ) );
  234. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  235. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  236. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'style' );
  237. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'style', 'bold', null );
  238. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  239. } );
  240. it( 'should update range on re-wrapping attribute (#475)', () => {
  241. const modelElement = new ModelElement( 'paragraph', null, [
  242. new ModelText( 'x' ),
  243. new ModelText( 'foo', { link: 'http://foo.com' } ),
  244. new ModelText( 'x' )
  245. ] );
  246. const viewP = new ViewContainerElement( 'p' );
  247. const elementGenerator = href => new ViewAttributeElement( 'a', { href } );
  248. modelRoot.appendChildren( modelElement );
  249. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  250. dispatcher.on( 'insert:$text', insertText() );
  251. dispatcher.on( 'addAttribute:link', wrapItem( elementGenerator ) );
  252. dispatcher.on( 'changeAttribute:link', wrapItem( elementGenerator ) );
  253. dispatcher.convertInsertion(
  254. ModelRange.createIn( modelRoot )
  255. );
  256. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  257. modelWriter.setAttribute( ModelRange.createIn( modelElement ), 'link', 'http://foobar.com' );
  258. dispatcher.convertAttribute(
  259. 'changeAttribute',
  260. ModelRange.createIn( modelElement ),
  261. 'link',
  262. 'http://foo.com',
  263. 'http://foobar.com'
  264. );
  265. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  266. } );
  267. it( 'should support unicode', () => {
  268. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  269. const viewP = new ViewContainerElement( 'p' );
  270. const viewB = new ViewAttributeElement( 'b' );
  271. modelRoot.appendChildren( modelElement );
  272. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  273. dispatcher.on( 'insert:$text', insertText() );
  274. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  275. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  276. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  277. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  278. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  279. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  280. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  281. } );
  282. it( 'should be possible to override wrap', () => {
  283. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  284. const viewP = new ViewContainerElement( 'p' );
  285. const viewB = new ViewAttributeElement( 'b' );
  286. modelRoot.appendChildren( modelElement );
  287. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  288. dispatcher.on( 'insert:$text', insertText() );
  289. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  290. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  291. consumable.consume( data.item, 'addAttribute:bold' );
  292. }, { priority: 'high' } );
  293. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  294. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  295. } );
  296. it( 'should be possible to override unwrap', () => {
  297. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  298. const viewP = new ViewContainerElement( 'p' );
  299. const viewB = new ViewAttributeElement( 'b' );
  300. modelRoot.appendChildren( modelElement );
  301. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  302. dispatcher.on( 'insert:$text', insertText() );
  303. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  304. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  305. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  306. consumable.consume( data.item, 'removeAttribute:bold' );
  307. }, { priority: 'high' } );
  308. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  309. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  310. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  311. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  312. // Nothing changed.
  313. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  314. } );
  315. it( 'should not convert and not consume if creator function returned null', () => {
  316. const elementGenerator = () => null;
  317. const modelText = new ModelText( 'foo', { bold: true } );
  318. modelRoot.appendChildren( [ modelText ] );
  319. sinon.spy( dispatcher, 'fire' );
  320. dispatcher.on( 'insert:$text', insertText() );
  321. dispatcher.on( 'addAttribute:bold', wrapItem( elementGenerator ) );
  322. dispatcher.on( 'removeAttribute:bold', unwrapItem( elementGenerator ) );
  323. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  324. expect( consumable.test( data.item, 'addAttribute:bold' ) ).to.be.true;
  325. } );
  326. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  327. expect( consumable.test( data.item, 'removeAttribute:bold' ) ).to.be.true;
  328. } );
  329. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  330. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  331. expect( dispatcher.fire.calledWith( 'addAttribute:bold:$text' ) ).to.be.true;
  332. modelText.removeAttribute( 'bold' );
  333. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null );
  334. expect( dispatcher.fire.calledWith( 'removeAttribute:bold:$text' ) ).to.be.true;
  335. } );
  336. } );
  337. describe( 'insertUIElement/removeUIElement', () => {
  338. let modelText, range, modelElement;
  339. beforeEach( () => {
  340. modelText = new ModelText( 'foobar' );
  341. modelElement = new ModelElement( 'paragraph', null, modelText );
  342. modelRoot.appendChildren( modelElement );
  343. const viewText = new ViewText( 'foobar' );
  344. const viewElement = new ViewContainerElement( 'p', null, viewText );
  345. viewRoot.appendChildren( viewElement );
  346. mapper.bindElements( modelElement, viewElement );
  347. range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
  348. } );
  349. it( 'should insert and remove ui element - element as a creator', () => {
  350. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  351. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  352. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  353. dispatcher.convertMarker( 'addMarker', 'marker', range );
  354. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  355. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  356. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  357. } );
  358. it( 'should insert and remove ui element - function as a creator', () => {
  359. const viewUi = data => new ViewUIElement( 'span', { 'class': data.name } );
  360. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  361. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  362. dispatcher.convertMarker( 'addMarker', 'marker', range );
  363. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  364. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  365. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  366. } );
  367. it( 'should not convert or consume if generator function returned null', () => {
  368. const viewUi = () => null;
  369. sinon.spy( dispatcher, 'fire' );
  370. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  371. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  372. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  373. expect( consumable.test( data.range, 'addMarker:marker' ) ).to.be.true;
  374. } );
  375. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  376. expect( consumable.test( data.range, 'removeMarker:marker' ) ).to.be.true;
  377. } );
  378. dispatcher.convertMarker( 'addMarker', 'marker', range );
  379. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  380. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  381. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  382. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  383. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  384. } );
  385. it( 'should be possible to overwrite', () => {
  386. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  387. sinon.spy( dispatcher, 'fire' );
  388. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  389. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  390. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  391. consumable.consume( data.range, 'addMarker:marker' );
  392. }, { priority: 'high' } );
  393. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  394. consumable.consume( data.range, 'removeMarker:marker' );
  395. }, { priority: 'high' } );
  396. dispatcher.convertMarker( 'addMarker', 'marker', range );
  397. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  398. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  399. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  400. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  401. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  402. } );
  403. it( 'should not convert or consume if generator function returned null', () => {
  404. const viewUi = () => null;
  405. sinon.spy( dispatcher, 'fire' );
  406. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  407. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  408. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  409. expect( consumable.test( data.range, 'addMarker:marker' ) ).to.be.true;
  410. } );
  411. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  412. expect( consumable.test( data.range, 'removeMarker:marker' ) ).to.be.true;
  413. } );
  414. dispatcher.convertMarker( 'addMarker', 'marker', range );
  415. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  416. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  417. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  418. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  419. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  420. } );
  421. it( 'should be possible to overwrite', () => {
  422. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  423. sinon.spy( dispatcher, 'fire' );
  424. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  425. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  426. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  427. consumable.consume( data.range, 'addMarker:marker' );
  428. }, { priority: 'high' } );
  429. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  430. consumable.consume( data.range, 'removeMarker:marker' );
  431. }, { priority: 'high' } );
  432. dispatcher.convertMarker( 'addMarker', 'marker', range );
  433. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  434. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  435. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  436. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  437. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  438. } );
  439. describe( 'non-collapsed range', () => {
  440. beforeEach( () => {
  441. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 5 );
  442. } );
  443. it( 'should insert and remove ui element - element as a creator', () => {
  444. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  445. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  446. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  447. dispatcher.convertMarker( 'addMarker', 'marker', range );
  448. expect( viewToString( viewRoot ) )
  449. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  450. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  451. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  452. } );
  453. it( 'should insert and remove ui element - function as a creator', () => {
  454. const viewUi = data => new ViewUIElement( 'span', { 'class': data.name } );
  455. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  456. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  457. dispatcher.convertMarker( 'addMarker', 'marker', range );
  458. expect( viewToString( viewRoot ) )
  459. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  460. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  461. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  462. } );
  463. it( 'should insert and remove different opening and ending element', () => {
  464. function creator( data ) {
  465. if ( data.isOpening ) {
  466. return new ViewUIElement( 'span', { 'class': data.name, 'data-start': true } );
  467. }
  468. return new ViewUIElement( 'span', { 'class': data.name, 'data-end': true } );
  469. }
  470. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  471. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  472. dispatcher.convertMarker( 'addMarker', 'marker', range );
  473. expect( viewToString( viewRoot ) ).to.equal(
  474. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  475. );
  476. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  477. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  478. } );
  479. } );
  480. } );
  481. describe( 'remove', () => {
  482. it( 'should remove items from view accordingly to changes in model #1', () => {
  483. const modelDiv = new ModelElement( 'div', null, [
  484. new ModelText( 'foo' ),
  485. new ModelElement( 'image' ),
  486. new ModelText( 'bar' )
  487. ] );
  488. modelRoot.appendChildren( modelDiv );
  489. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  490. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  491. dispatcher.on( 'insert:$text', insertText() );
  492. dispatcher.on( 'remove', remove() );
  493. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  494. const removedNodes = modelDiv.removeChildren( 0, 2 );
  495. modelDoc.graveyard.insertChildren( 0, removedNodes );
  496. dispatcher.convertRemove(
  497. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  498. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 4 )
  499. );
  500. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div></div>' );
  501. } );
  502. it( 'should not execute if value was already consumed', () => {
  503. const modelDiv = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  504. modelRoot.appendChildren( modelDiv );
  505. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  506. dispatcher.on( 'insert:$text', insertText() );
  507. dispatcher.on( 'remove', remove() );
  508. dispatcher.on( 'remove', ( evt, data, consumable ) => {
  509. consumable.consume( data.item, 'remove' );
  510. }, { priority: 'high' } );
  511. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  512. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  513. const removedNodes = modelDiv.removeChildren( 0, 1 );
  514. modelDoc.graveyard.insertChildren( 0, removedNodes );
  515. dispatcher.convertRemove(
  516. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  517. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 3 )
  518. );
  519. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  520. } );
  521. it( 'should support unicode', () => {
  522. const modelDiv = new ModelElement( 'div', null, 'நிலைக்கு' );
  523. modelRoot.appendChildren( modelDiv );
  524. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  525. dispatcher.on( 'insert:$text', insertText() );
  526. dispatcher.on( 'remove', remove() );
  527. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  528. modelWriter.move(
  529. ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ),
  530. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  531. );
  532. dispatcher.convertRemove(
  533. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  534. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 6 )
  535. );
  536. expect( viewToString( viewRoot ) ).to.equal( '<div><div>கு</div></div>' );
  537. } );
  538. it( 'should not remove view ui elements that are placed next to removed content', () => {
  539. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  540. viewRoot.appendChildren( [
  541. new ViewText( 'foo' ),
  542. new ViewUIElement( 'span' ),
  543. new ViewText( 'bar' )
  544. ] );
  545. dispatcher.on( 'remove', remove() );
  546. // Remove 'b'.
  547. modelWriter.move(
  548. ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ),
  549. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  550. );
  551. dispatcher.convertRemove(
  552. ModelPosition.createFromParentAndOffset( modelRoot, 3 ),
  553. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 1 )
  554. );
  555. expect( viewToString( viewRoot ) ).to.equal( '<div>foo<span></span>ar</div>' );
  556. } );
  557. it( 'should remove correct amount of text when it is split by view ui element', () => {
  558. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  559. viewRoot.appendChildren( [
  560. new ViewText( 'foo' ),
  561. new ViewUIElement( 'span' ),
  562. new ViewText( 'bar' )
  563. ] );
  564. dispatcher.on( 'remove', remove() );
  565. // Remove 'o<span></span>b'.
  566. modelWriter.move(
  567. ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ),
  568. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  569. );
  570. dispatcher.convertRemove(
  571. ModelPosition.createFromParentAndOffset( modelRoot, 2 ),
  572. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 2 )
  573. );
  574. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  575. } );
  576. it( 'should not unbind element that has not been moved to graveyard', () => {
  577. const modelElement = new ModelElement( 'a' );
  578. const viewElement = new ViewElement( 'a' );
  579. modelRoot.appendChildren( [ modelElement, new ModelText( 'b' ) ] );
  580. viewRoot.appendChildren( [ viewElement, new ViewText( 'b' ) ] );
  581. mapper.bindElements( modelElement, viewElement );
  582. dispatcher.on( 'remove', remove() );
  583. // Move <a></a> after "b". Can be e.g. a part of an unwrap delta (move + remove).
  584. modelWriter.move(
  585. ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ),
  586. ModelPosition.createAt( modelRoot, 'end' )
  587. );
  588. dispatcher.convertRemove(
  589. ModelPosition.createFromParentAndOffset( modelRoot, 0 ),
  590. ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 )
  591. );
  592. expect( viewToString( viewRoot ) ).to.equal( '<div>b</div>' );
  593. expect( mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  594. expect( mapper.toViewElement( modelElement ) ).to.equal( viewElement );
  595. } );
  596. it( 'should unbind elements if model element was moved to graveyard', () => {
  597. const modelElement = new ModelElement( 'a' );
  598. const viewElement = new ViewElement( 'a' );
  599. modelRoot.appendChildren( [ modelElement, new ModelText( 'b' ) ] );
  600. viewRoot.appendChildren( [ viewElement, new ViewText( 'b' ) ] );
  601. mapper.bindElements( modelElement, viewElement );
  602. dispatcher.on( 'remove', remove() );
  603. // Move <a></a> to graveyard.
  604. modelWriter.move(
  605. ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ),
  606. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  607. );
  608. dispatcher.convertRemove(
  609. ModelPosition.createFromParentAndOffset( modelRoot, 0 ),
  610. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 1 )
  611. );
  612. expect( viewToString( viewRoot ) ).to.equal( '<div>b</div>' );
  613. expect( mapper.toModelElement( viewElement ) ).to.be.undefined;
  614. expect( mapper.toViewElement( modelElement ) ).to.be.undefined;
  615. } );
  616. // TODO move to conversion/integration.js one day.
  617. it( 'should not break when remove() is used as part of unwrapping', () => {
  618. // The whole process looks like this:
  619. // <w><a></a></w> => <a></a><w><a></a></w> => <a></a><w></w> => <a></a>
  620. // The <a> is duplicated for a while in the view.
  621. const modelAElement = new ModelElement( 'a' );
  622. const modelWElement = new ModelElement( 'w' );
  623. const viewAElement = new ViewContainerElement( 'a' );
  624. const viewA2Element = new ViewContainerElement( 'a2' );
  625. const viewWElement = new ViewContainerElement( 'w' );
  626. modelRoot.appendChildren( modelWElement );
  627. viewRoot.appendChildren( viewWElement );
  628. modelWElement.appendChildren( modelAElement );
  629. viewWElement.appendChildren( viewAElement );
  630. mapper.bindElements( modelWElement, viewWElement );
  631. mapper.bindElements( modelAElement, viewAElement );
  632. dispatcher.on( 'remove', remove() );
  633. dispatcher.on( 'insert', insertElement( () => viewA2Element ) );
  634. modelDoc.on( 'change', ( evt, type, changes ) => {
  635. dispatcher.convertChange( type, changes );
  636. } );
  637. modelDoc.batch().unwrap( modelWElement );
  638. expect( viewToString( viewRoot ) ).to.equal( '<div><a2></a2></div>' );
  639. expect( mapper.toModelElement( viewA2Element ) ).to.equal( modelAElement );
  640. expect( mapper.toViewElement( modelAElement ) ).to.equal( viewA2Element );
  641. // This is a bit unfortunate, but we think we can live with this.
  642. // The viewAElement is not in the tree and there's a high chance that all reference to it are gone.
  643. expect( mapper.toModelElement( viewAElement ) ).to.equal( modelAElement );
  644. expect( mapper.toModelElement( viewWElement ) ).to.be.undefined;
  645. expect( mapper.toViewElement( modelWElement ) ).to.be.undefined;
  646. } );
  647. } );
  648. } );