model-to-view-converters.js 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876
  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. wrapRange,
  27. unwrapRange,
  28. remove,
  29. removeUIElement
  30. } from '../../src/conversion/model-to-view-converters';
  31. import { createRangeOnElementOnly } from '../../tests/model/_utils/utils';
  32. describe( 'model-to-view-converters', () => {
  33. let dispatcher, modelDoc, modelRoot, mapper, viewRoot;
  34. beforeEach( () => {
  35. modelDoc = new ModelDocument();
  36. modelRoot = modelDoc.createRoot();
  37. viewRoot = new ViewContainerElement( 'div' );
  38. mapper = new Mapper();
  39. mapper.bindElements( modelRoot, viewRoot );
  40. dispatcher = new ModelConversionDispatcher( modelDoc, { mapper } );
  41. } );
  42. function viewAttributesToString( item ) {
  43. let result = '';
  44. for ( let key of item.getAttributeKeys() ) {
  45. let value = item.getAttribute( key );
  46. if ( value ) {
  47. result += ' ' + key + '="' + value + '"';
  48. }
  49. }
  50. return result;
  51. }
  52. function viewToString( item ) {
  53. let result = '';
  54. if ( item instanceof ViewText ) {
  55. result = item.data;
  56. } else {
  57. // ViewElement or ViewDocumentFragment.
  58. for ( let child of item.getChildren() ) {
  59. result += viewToString( child );
  60. }
  61. if ( item instanceof ViewElement ) {
  62. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  63. }
  64. }
  65. return result;
  66. }
  67. describe( 'insertText', () => {
  68. it( 'should convert text insertion in model to view text', () => {
  69. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  70. dispatcher.on( 'insert:$text', insertText() );
  71. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  72. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  73. } );
  74. it( 'should support unicode', () => {
  75. modelRoot.appendChildren( new ModelText( 'நிலைக்கு' ) );
  76. dispatcher.on( 'insert:$text', insertText() );
  77. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  78. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  79. } );
  80. it( 'should be possible to override it', () => {
  81. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  82. dispatcher.on( 'insert:$text', insertText() );
  83. dispatcher.on( 'insert:$text', ( evt, data, consumable ) => {
  84. consumable.consume( data.item, 'insert' );
  85. }, { priority: 'high' } );
  86. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  87. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  88. } );
  89. } );
  90. describe( 'insertElement', () => {
  91. it( 'should convert element insertion in model to and map positions for future converting', () => {
  92. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  93. const viewElement = new ViewContainerElement( 'p' );
  94. modelRoot.appendChildren( modelElement );
  95. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  96. dispatcher.on( 'insert:$text', insertText() );
  97. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  98. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  99. } );
  100. it( 'should take view element function generator as a parameter', () => {
  101. const elementGenerator = ( data, consumable ) => {
  102. if ( consumable.consume( data.item, 'addAttribute:nice' ) ) {
  103. return new ViewContainerElement( 'div' );
  104. } else {
  105. return new ViewContainerElement( 'p' );
  106. }
  107. };
  108. const niceP = new ModelElement( 'myParagraph', { nice: true }, new ModelText( 'foo' ) );
  109. const badP = new ModelElement( 'myParagraph', null, new ModelText( 'bar' ) );
  110. modelRoot.appendChildren( [ niceP, badP ] );
  111. dispatcher.on( 'insert:myParagraph', insertElement( elementGenerator ) );
  112. dispatcher.on( 'insert:$text', insertText() );
  113. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  114. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
  115. } );
  116. it( 'should not convert and not consume if creator function returned null', () => {
  117. const elementGenerator = () => null;
  118. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  119. modelRoot.appendChildren( [ modelP ] );
  120. sinon.spy( dispatcher, 'fire' );
  121. dispatcher.on( 'insert:paragraph', insertElement( elementGenerator ) );
  122. dispatcher.on( 'insert:paragraph', ( evt, data, consumable ) => {
  123. expect( consumable.test( data.item, 'insert' ) ).to.be.true;
  124. } );
  125. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  126. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  127. expect( dispatcher.fire.calledWith( 'insert:paragraph' ) ).to.be.true;
  128. } );
  129. } );
  130. describe( 'setAttribute/removeAttribute', () => {
  131. it( 'should convert attribute insert/change/remove on a model node', () => {
  132. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  133. const viewElement = new ViewContainerElement( 'p' );
  134. modelRoot.appendChildren( modelElement );
  135. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  136. dispatcher.on( 'insert:$text', insertText() );
  137. dispatcher.on( 'addAttribute:class', setAttribute() );
  138. dispatcher.on( 'changeAttribute:class', setAttribute() );
  139. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  140. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  141. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  142. modelElement.setAttribute( 'class', 'bar' );
  143. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'foo', 'bar' );
  144. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  145. modelElement.removeAttribute( 'class' );
  146. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  147. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  148. } );
  149. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  150. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  151. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  152. const themeConverter = ( value, key, data ) => {
  153. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  154. value += ' ' + 'fix-content';
  155. }
  156. return { key: 'class', value };
  157. };
  158. modelRoot.appendChildren( [ modelParagraph, modelDiv ] );
  159. dispatcher.on( 'insert:paragraph', insertElement( new ViewContainerElement( 'p' ) ) );
  160. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  161. dispatcher.on( 'insert:$text', insertText() );
  162. dispatcher.on( 'addAttribute:theme', setAttribute( themeConverter ) );
  163. dispatcher.on( 'changeAttribute:theme', setAttribute( themeConverter ) );
  164. dispatcher.on( 'removeAttribute:theme', removeAttribute( themeConverter ) );
  165. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  166. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  167. modelParagraph.setAttribute( 'theme', 'awesome' );
  168. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'nice', 'awesome' );
  169. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  170. modelParagraph.removeAttribute( 'theme' );
  171. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'awesome', null );
  172. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  173. } );
  174. it( 'should be possible to override setAttribute', () => {
  175. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  176. const viewElement = new ViewContainerElement( 'p' );
  177. modelRoot.appendChildren( modelElement );
  178. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  179. dispatcher.on( 'insert:$text', insertText() );
  180. dispatcher.on( 'addAttribute:class', setAttribute() );
  181. dispatcher.on( 'addAttribute:class', ( evt, data, consumable ) => {
  182. consumable.consume( data.item, 'addAttribute:class' );
  183. }, { priority: 'high' } );
  184. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  185. // No attribute set.
  186. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  187. } );
  188. it( 'should be possible to override removeAttribute', () => {
  189. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  190. const viewElement = new ViewContainerElement( 'p' );
  191. modelRoot.appendChildren( modelElement );
  192. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  193. dispatcher.on( 'insert:$text', insertText() );
  194. dispatcher.on( 'addAttribute:class', setAttribute() );
  195. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  196. dispatcher.on( 'removeAttribute:class', ( evt, data, consumable ) => {
  197. consumable.consume( data.item, 'removeAttribute:class' );
  198. }, { priority: 'high' } );
  199. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  200. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  201. modelElement.removeAttribute( 'class' );
  202. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  203. // Nothing changed.
  204. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  205. } );
  206. } );
  207. describe( 'wrap/unwrap', () => {
  208. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  209. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  210. const viewP = new ViewContainerElement( 'p' );
  211. const viewB = new ViewAttributeElement( 'b' );
  212. modelRoot.appendChildren( modelElement );
  213. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  214. dispatcher.on( 'insert:$text', insertText() );
  215. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  216. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  217. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  218. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  219. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  220. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  221. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  222. } );
  223. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  224. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  225. const viewP = new ViewContainerElement( 'p' );
  226. const elementGenerator = ( value ) => {
  227. if ( value == 'bold' ) {
  228. return new ViewAttributeElement( 'b' );
  229. }
  230. };
  231. modelRoot.appendChildren( modelElement );
  232. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  233. dispatcher.on( 'insert:$text', insertText() );
  234. dispatcher.on( 'addAttribute:style', wrapItem( elementGenerator ) );
  235. dispatcher.on( 'removeAttribute:style', unwrapItem( elementGenerator ) );
  236. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  237. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  238. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'style' );
  239. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'style', 'bold', null );
  240. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  241. } );
  242. it( 'should update range on re-wrapping attribute (#475)', () => {
  243. const modelElement = new ModelElement( 'paragraph', null, [
  244. new ModelText( 'x' ),
  245. new ModelText( 'foo', { link: 'http://foo.com' } ),
  246. new ModelText( 'x' )
  247. ] );
  248. const viewP = new ViewContainerElement( 'p' );
  249. const elementGenerator = ( href ) => new ViewAttributeElement( 'a', { href } );
  250. modelRoot.appendChildren( modelElement );
  251. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  252. dispatcher.on( 'insert:$text', insertText() );
  253. dispatcher.on( 'addAttribute:link', wrapItem( elementGenerator ) );
  254. dispatcher.on( 'changeAttribute:link', wrapItem( elementGenerator ) );
  255. dispatcher.convertInsertion(
  256. ModelRange.createIn( modelRoot )
  257. );
  258. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  259. modelWriter.setAttribute( ModelRange.createIn( modelElement ), 'link', 'http://foobar.com' );
  260. dispatcher.convertAttribute(
  261. 'changeAttribute',
  262. ModelRange.createIn( modelElement ),
  263. 'link',
  264. 'http://foo.com',
  265. 'http://foobar.com'
  266. );
  267. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  268. } );
  269. it( 'should support unicode', () => {
  270. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { 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', wrapItem( viewB ) );
  277. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  278. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  279. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  280. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  281. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  282. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  283. } );
  284. it( 'should be possible to override wrap', () => {
  285. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  286. const viewP = new ViewContainerElement( 'p' );
  287. const viewB = new ViewAttributeElement( 'b' );
  288. modelRoot.appendChildren( modelElement );
  289. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  290. dispatcher.on( 'insert:$text', insertText() );
  291. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  292. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  293. consumable.consume( data.item, 'addAttribute:bold' );
  294. }, { priority: 'high' } );
  295. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  296. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  297. } );
  298. it( 'should be possible to override unwrap', () => {
  299. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  300. const viewP = new ViewContainerElement( 'p' );
  301. const viewB = new ViewAttributeElement( 'b' );
  302. modelRoot.appendChildren( modelElement );
  303. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  304. dispatcher.on( 'insert:$text', insertText() );
  305. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  306. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  307. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  308. consumable.consume( data.item, 'removeAttribute:bold' );
  309. }, { priority: 'high' } );
  310. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  311. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  312. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  313. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  314. // Nothing changed.
  315. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  316. } );
  317. it( 'should not convert and not consume if creator function returned null', () => {
  318. const elementGenerator = () => null;
  319. const modelText = new ModelText( 'foo', { bold: true } );
  320. modelRoot.appendChildren( [ modelText ] );
  321. sinon.spy( dispatcher, 'fire' );
  322. dispatcher.on( 'insert:$text', insertText() );
  323. dispatcher.on( 'addAttribute:bold', wrapItem( elementGenerator ) );
  324. dispatcher.on( 'removeAttribute:bold', unwrapItem( elementGenerator ) );
  325. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  326. expect( consumable.test( data.item, 'addAttribute:bold' ) ).to.be.true;
  327. } );
  328. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  329. expect( consumable.test( data.item, 'removeAttribute:bold' ) ).to.be.true;
  330. } );
  331. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  332. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  333. expect( dispatcher.fire.calledWith( 'addAttribute:bold:$text' ) ).to.be.true;
  334. modelText.removeAttribute( 'bold' );
  335. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null );
  336. expect( dispatcher.fire.calledWith( 'removeAttribute:bold:$text' ) ).to.be.true;
  337. } );
  338. } );
  339. describe( 'wrapRange/unwrapRange', () => {
  340. let modelText, range, modelElement;
  341. beforeEach( () => {
  342. modelText = new ModelText( 'foobar' );
  343. modelElement = new ModelElement( 'paragraph', null, modelText );
  344. modelRoot.appendChildren( modelElement );
  345. const viewText = new ViewText( 'foobar' );
  346. const viewElement = new ViewContainerElement( 'p', null, viewText );
  347. viewRoot.appendChildren( viewElement );
  348. mapper.bindElements( modelElement, viewElement );
  349. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 );
  350. } );
  351. it( 'should convert adding/removing of marker into wrapping element in a view', () => {
  352. const viewSpan = new ViewAttributeElement( 'span', { class: 'name' } );
  353. dispatcher.on( 'addMarker:name', wrapRange( viewSpan ) );
  354. dispatcher.on( 'removeMarker:name', unwrapRange( viewSpan ) );
  355. dispatcher.convertMarker( 'addMarker', 'name', range );
  356. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="name">ob</span>ar</p></div>' );
  357. dispatcher.convertMarker( 'removeMarker', 'name', range );
  358. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  359. } );
  360. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  361. const converterCallback = ( data ) => {
  362. const name = data.name.split( ':' )[ 1 ];
  363. return new ViewAttributeElement( 'span', { class: name } );
  364. };
  365. dispatcher.on( 'addMarker:name', wrapRange( converterCallback ) );
  366. dispatcher.on( 'removeMarker:name', unwrapRange( converterCallback ) );
  367. dispatcher.convertMarker( 'addMarker', 'name:john', range );
  368. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="john">ob</span>ar</p></div>' );
  369. dispatcher.convertMarker( 'removeMarker', 'name:john', range );
  370. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  371. } );
  372. it( 'should support non-flat markers', () => {
  373. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( '22' ) );
  374. modelRoot.appendChildren( modelElement2 );
  375. const modelElement3 = new ModelElement( 'paragraph', null, new ModelText( '333' ) );
  376. modelRoot.appendChildren( modelElement3 );
  377. const viewElement2 = new ViewContainerElement( 'p', null, new ViewText( '22' ) );
  378. viewRoot.appendChildren( viewElement2 );
  379. const viewElement3 = new ViewContainerElement( 'p', null, new ViewText( '333' ) );
  380. viewRoot.appendChildren( viewElement3 );
  381. mapper.bindElements( modelElement2, viewElement2 );
  382. mapper.bindElements( modelElement3, viewElement3 );
  383. const range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement3, 1 );
  384. const viewSpan = new ViewAttributeElement( 'span', { class: 'name' } );
  385. dispatcher.on( 'addMarker:name', wrapRange( viewSpan ) );
  386. dispatcher.on( 'removeMarker:name', unwrapRange( viewSpan ) );
  387. dispatcher.convertMarker( 'addMarker', 'name', range );
  388. expect( viewToString( viewRoot ) ).to.equal(
  389. '<div><p>fo<span class="name">obar</span></p><p><span class="name">22</span></p><p><span class="name">3</span>33</p></div>'
  390. );
  391. dispatcher.convertMarker( 'removeMarker', 'name', range );
  392. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><p>22</p><p>333</p></div>' );
  393. } );
  394. it( 'should be possible to override wrapRange', () => {
  395. const converterCallback = ( data ) => {
  396. const name = data.name.split( ':' )[ 1 ];
  397. return new ViewAttributeElement( 'span', { class: name } );
  398. };
  399. dispatcher.on( 'addMarker:name', wrapRange( converterCallback ) );
  400. dispatcher.on( 'addMarker:name:john', ( evt, data, consumable ) => {
  401. consumable.consume( data.range, 'addMarker' );
  402. }, { priority: 'high' } );
  403. dispatcher.convertMarker( 'addMarker', 'name:john', range );
  404. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  405. } );
  406. it( 'should be possible to override unwrapRange', () => {
  407. const converterCallback = ( data ) => {
  408. const name = data.name.split( ':' )[ 1 ];
  409. return new ViewAttributeElement( 'span', { class: name } );
  410. };
  411. dispatcher.on( 'addMarker:name', wrapRange( converterCallback ) );
  412. dispatcher.on( 'removeMarker:name', unwrapRange( converterCallback ) );
  413. dispatcher.on( 'removeMarker:name:john', ( evt, data, consumable ) => {
  414. consumable.consume( data.range, 'removeMarker' );
  415. }, { priority: 'high' } );
  416. dispatcher.convertMarker( 'addMarker', 'name:john', range );
  417. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="john">ob</span>ar</p></div>' );
  418. dispatcher.convertMarker( 'removeMarker', 'name:john', range );
  419. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="john">ob</span>ar</p></div>' );
  420. } );
  421. it( 'should not convert or consume if view element is not returned by element generating function', () => {
  422. const converterCallback = () => null;
  423. sinon.spy( dispatcher, 'fire' );
  424. dispatcher.on( 'addMarker:name', wrapRange( converterCallback ) );
  425. dispatcher.on( 'addMarker:name', ( evt, data, consumable ) => {
  426. // Check whether value was not consumed from `consumable`.
  427. expect( consumable.test( data.range, 'addMarker' ) ).to.be.true;
  428. } );
  429. dispatcher.on( 'removeMarker:name', unwrapRange( converterCallback ) );
  430. dispatcher.on( 'removeMarker:name', ( evt, data, consumable ) => {
  431. // Check whether value was not consumed from `consumable`.
  432. expect( consumable.test( data.range, 'removeMarker' ) ).to.be.true;
  433. } );
  434. dispatcher.convertMarker( 'addMarker', 'name', range );
  435. expect( dispatcher.fire.calledWith( 'addMarker:name' ) ).to.be.true;
  436. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  437. dispatcher.convertMarker( 'removeMarker', 'name', range );
  438. expect( dispatcher.fire.calledWith( 'removeMarker:name' ) ).to.be.true;
  439. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  440. } );
  441. it( 'multiple overlapping non-collapsed markers', () => {
  442. const converterCallbackName = ( data ) => {
  443. const name = data.name.split( ':' )[ 1 ];
  444. const element = new ViewAttributeElement( 'span', { class: name } );
  445. element.priority = name.charCodeAt( 0 );
  446. return element;
  447. };
  448. const converterCallbackSearch = () => new ViewAttributeElement( 'em', { class: 'search' } );
  449. dispatcher.on( 'addMarker:name', wrapRange( converterCallbackName ) );
  450. dispatcher.on( 'removeMarker:name', unwrapRange( converterCallbackName ) );
  451. dispatcher.on( 'addMarker:search', wrapRange( converterCallbackSearch ) );
  452. dispatcher.on( 'removeMarker:search', unwrapRange( converterCallbackSearch ) );
  453. dispatcher.convertMarker( 'addMarker', 'name:a', range );
  454. dispatcher.convertMarker( 'addMarker', 'name:b', range );
  455. dispatcher.convertMarker( 'addMarker', 'search', range );
  456. expect( viewToString( viewRoot ) ).to.equal(
  457. '<div><p>fo<em class="search"><span class="a"><span class="b">ob</span></span></em>ar</p></div>'
  458. );
  459. dispatcher.convertMarker( 'removeMarker', 'name:b', range );
  460. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<em class="search"><span class="a">ob</span></em>ar</p></div>' );
  461. dispatcher.convertMarker( 'removeMarker', 'search', range );
  462. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="a">ob</span>ar</p></div>' );
  463. dispatcher.convertMarker( 'removeMarker', 'name:a', range );
  464. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  465. } );
  466. it( 'multiple overlapping non-collapsed markers intersecting with same priority', () => {
  467. const converterCallbackSearch = () => new ViewAttributeElement( 'em', { class: 'search' } );
  468. dispatcher.on( 'addMarker:search', wrapRange( converterCallbackSearch ) );
  469. dispatcher.on( 'removeMarker:search', unwrapRange( converterCallbackSearch ) );
  470. const range1 = ModelRange.createFromParentsAndOffsets( modelElement, 1, modelElement, 3 );
  471. const range2 = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 );
  472. const range3 = ModelRange.createFromParentsAndOffsets( modelElement, 4, modelElement, 6 );
  473. dispatcher.convertMarker( 'addMarker', 'search', range1 );
  474. dispatcher.convertMarker( 'addMarker', 'search', range2 );
  475. expect( viewToString( viewRoot ) ).to.equal( '<div><p>f<em class="search">oob</em>ar</p></div>' );
  476. dispatcher.convertMarker( 'addMarker', 'search', range3 );
  477. expect( viewToString( viewRoot ) ).to.equal( '<div><p>f<em class="search">oobar</em></p></div>' );
  478. dispatcher.convertMarker( 'removeMarker', 'search', range2 );
  479. expect( viewToString( viewRoot ) ).to.equal( '<div><p>f<em class="search">o</em>ob<em class="search">ar</em></p></div>' );
  480. dispatcher.convertMarker( 'removeMarker', 'search', range3 );
  481. expect( viewToString( viewRoot ) ).to.equal( '<div><p>f<em class="search">o</em>obar</p></div>' );
  482. dispatcher.convertMarker( 'removeMarker', 'search', range1 );
  483. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  484. } );
  485. } );
  486. describe( 'insertUIElement/removeUIElement', () => {
  487. let modelText, range, modelElement;
  488. beforeEach( () => {
  489. modelText = new ModelText( 'foobar' );
  490. modelElement = new ModelElement( 'paragraph', null, modelText );
  491. modelRoot.appendChildren( modelElement );
  492. const viewText = new ViewText( 'foobar' );
  493. const viewElement = new ViewContainerElement( 'p', null, viewText );
  494. viewRoot.appendChildren( viewElement );
  495. mapper.bindElements( modelElement, viewElement );
  496. range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
  497. } );
  498. it( 'should insert and remove ui element - element as a creator', () => {
  499. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  500. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  501. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  502. dispatcher.convertMarker( 'addMarker', 'marker', range );
  503. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  504. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  505. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  506. } );
  507. it( 'should insert and remove ui element - function as a creator', () => {
  508. const viewUi = ( data ) => new ViewUIElement( 'span', { 'class': data.name } );
  509. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  510. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  511. dispatcher.convertMarker( 'addMarker', 'marker', range );
  512. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  513. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  514. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  515. } );
  516. it( 'should not convert or consume if generator function returned null', () => {
  517. const viewUi = () => null;
  518. sinon.spy( dispatcher, 'fire' );
  519. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  520. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  521. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  522. expect( consumable.test( data.range, 'addMarker' ) ).to.be.true;
  523. } );
  524. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  525. expect( consumable.test( data.range, 'removeMarker' ) ).to.be.true;
  526. } );
  527. dispatcher.convertMarker( 'addMarker', 'marker', range );
  528. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  529. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  530. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  531. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  532. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  533. } );
  534. it( 'should be possible to overwrite', () => {
  535. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  536. sinon.spy( dispatcher, 'fire' );
  537. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  538. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  539. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  540. consumable.consume( data.range, 'addMarker' );
  541. }, { priority: 'high' } );
  542. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  543. consumable.consume( data.range, 'removeMarker' );
  544. }, { priority: 'high' } );
  545. dispatcher.convertMarker( 'addMarker', 'marker', range );
  546. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  547. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  548. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  549. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  550. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  551. } );
  552. } );
  553. describe( 'remove', () => {
  554. it( 'should remove items from view accordingly to changes in model', () => {
  555. const modelDiv = new ModelElement( 'div', null, [
  556. new ModelText( 'foo' ),
  557. new ModelElement( 'image' ),
  558. new ModelText( 'bar' )
  559. ] );
  560. modelRoot.appendChildren( modelDiv );
  561. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  562. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  563. dispatcher.on( 'insert:$text', insertText() );
  564. dispatcher.on( 'remove', remove() );
  565. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  566. const removedNodes = modelDiv.removeChildren( 0, 2 );
  567. modelDoc.graveyard.insertChildren( 0, removedNodes );
  568. dispatcher.convertRemove(
  569. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  570. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 4 )
  571. );
  572. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div></div>' );
  573. } );
  574. it( 'should not execute if value was already consumed', () => {
  575. const modelDiv = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  576. modelRoot.appendChildren( modelDiv );
  577. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  578. dispatcher.on( 'insert:$text', insertText() );
  579. dispatcher.on( 'remove', remove() );
  580. dispatcher.on( 'remove', ( evt, data, consumable ) => {
  581. consumable.consume( data.item, 'remove' );
  582. }, { priority: 'high' } );
  583. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  584. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  585. const removedNodes = modelDiv.removeChildren( 0, 1 );
  586. modelDoc.graveyard.insertChildren( 0, removedNodes );
  587. dispatcher.convertRemove(
  588. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  589. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 3 )
  590. );
  591. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  592. } );
  593. it( 'should support unicode', () => {
  594. const modelDiv = new ModelElement( 'div', null, 'நிலைக்கு' );
  595. modelRoot.appendChildren( modelDiv );
  596. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  597. dispatcher.on( 'insert:$text', insertText() );
  598. dispatcher.on( 'remove', remove() );
  599. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  600. modelWriter.move(
  601. ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ),
  602. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  603. );
  604. dispatcher.convertRemove(
  605. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  606. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 6 )
  607. );
  608. expect( viewToString( viewRoot ) ).to.equal( '<div><div>கு</div></div>' );
  609. } );
  610. it( 'should not remove view ui elements that are placed next to removed content', () => {
  611. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  612. viewRoot.appendChildren( [
  613. new ViewText( 'foo' ),
  614. new ViewUIElement( 'span' ),
  615. new ViewText( 'bar' )
  616. ] );
  617. dispatcher.on( 'remove', remove() );
  618. // Remove 'b'.
  619. modelWriter.move(
  620. ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ),
  621. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  622. );
  623. dispatcher.convertRemove(
  624. ModelPosition.createFromParentAndOffset( modelRoot, 3 ),
  625. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 1 )
  626. );
  627. expect( viewToString( viewRoot ) ).to.equal( '<div>foo<span></span>ar</div>' );
  628. } );
  629. } );
  630. } );