model-to-view-converters.js 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* global document */
  6. import Model from '../../src/model/model';
  7. import ModelElement from '../../src/model/element';
  8. import ModelText from '../../src/model/text';
  9. import ModelRange from '../../src/model/range';
  10. import ModelPosition from '../../src/model/position';
  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 {
  17. insertElement,
  18. insertUIElement,
  19. changeAttribute,
  20. wrap,
  21. removeUIElement,
  22. highlightElement,
  23. highlightText,
  24. removeHighlight,
  25. createViewElementFromHighlightDescriptor
  26. } from '../../src/conversion/model-to-view-converters';
  27. import EditingController from '../../src/controller/editingcontroller';
  28. describe( 'model-to-view-converters', () => {
  29. let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model;
  30. beforeEach( () => {
  31. model = new Model();
  32. modelDoc = model.document;
  33. modelRoot = modelDoc.createRoot();
  34. controller = new EditingController( model );
  35. controller.view.attachDomRoot( document.createElement( 'div' ) );
  36. viewRoot = controller.view.getRoot();
  37. dispatcher = controller.modelToView;
  38. dispatcher.on( 'insert:paragraph', insertElement( () => new ViewContainerElement( 'p' ) ) );
  39. dispatcher.on( 'attribute:class', changeAttribute() );
  40. modelRootStart = ModelPosition.createAt( modelRoot, 0 );
  41. } );
  42. function viewAttributesToString( item ) {
  43. let result = '';
  44. for ( const key of item.getAttributeKeys() ) {
  45. const 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 ( const 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. model.change( writer => {
  70. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  71. } );
  72. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  73. } );
  74. it( 'should support unicode', () => {
  75. model.change( writer => {
  76. writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
  77. } );
  78. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  79. } );
  80. it( 'should be possible to override it', () => {
  81. dispatcher.on( 'insert:$text', ( evt, data, consumable ) => {
  82. consumable.consume( data.item, 'insert' );
  83. }, { priority: 'high' } );
  84. model.change( writer => {
  85. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  86. } );
  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. model.change( writer => {
  94. writer.insert( modelElement, modelRootStart );
  95. } );
  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, 'attribute:nice' ) ) {
  101. return new ViewContainerElement( 'div' );
  102. }
  103. // Test if default converter will be fired for paragraph, if `null` is returned and consumable was not consumed.
  104. return null;
  105. };
  106. dispatcher.on( 'insert:paragraph', insertElement( elementGenerator ), { priority: 'high' } );
  107. const niceP = new ModelElement( 'paragraph', { nice: true }, new ModelText( 'foo' ) );
  108. const badP = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  109. model.change( writer => {
  110. writer.insert( [ niceP, badP ], modelRootStart );
  111. } );
  112. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
  113. } );
  114. } );
  115. describe( 'setAttribute', () => {
  116. it( 'should convert attribute insert/change/remove on a model node', () => {
  117. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  118. model.change( writer => {
  119. writer.insert( modelElement, modelRootStart );
  120. } );
  121. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  122. model.change( writer => {
  123. writer.setAttribute( 'class', 'bar', modelElement );
  124. } );
  125. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  126. model.change( writer => {
  127. writer.removeAttribute( 'class', modelElement );
  128. } );
  129. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  130. } );
  131. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  132. const themeConverter = ( value, key, data ) => {
  133. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  134. value += ' fix-content';
  135. }
  136. return { key: 'class', value };
  137. };
  138. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  139. dispatcher.on( 'attribute:theme', changeAttribute( themeConverter ) );
  140. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  141. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  142. model.change( writer => {
  143. writer.insert( [ modelParagraph, modelDiv ], modelRootStart );
  144. } );
  145. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  146. model.change( writer => {
  147. writer.setAttribute( 'theme', 'awesome', modelParagraph );
  148. } );
  149. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  150. model.change( writer => {
  151. writer.removeAttribute( 'theme', modelParagraph );
  152. } );
  153. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  154. } );
  155. it( 'should be possible to override setAttribute', () => {
  156. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  157. dispatcher.on( 'attribute:class', ( evt, data, consumable ) => {
  158. consumable.consume( data.item, 'attribute:class' );
  159. }, { priority: 'high' } );
  160. model.change( writer => {
  161. writer.insert( modelElement, modelRootStart );
  162. } );
  163. // No attribute set.
  164. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  165. } );
  166. } );
  167. describe( 'wrap', () => {
  168. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  169. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  170. const viewB = new ViewAttributeElement( 'b' );
  171. dispatcher.on( 'attribute:bold', wrap( viewB ) );
  172. model.change( writer => {
  173. writer.insert( modelElement, modelRootStart );
  174. } );
  175. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  176. model.change( writer => {
  177. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  178. } );
  179. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  180. } );
  181. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  182. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  183. const elementGenerator = value => {
  184. if ( value == 'bold' ) {
  185. return new ViewAttributeElement( 'b' );
  186. }
  187. };
  188. dispatcher.on( 'attribute:style', wrap( elementGenerator ) );
  189. model.change( writer => {
  190. writer.insert( modelElement, modelRootStart );
  191. } );
  192. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  193. model.change( writer => {
  194. writer.removeAttribute( 'style', ModelRange.createIn( modelElement ) );
  195. } );
  196. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  197. } );
  198. it( 'should update range on re-wrapping attribute (#475)', () => {
  199. const modelElement = new ModelElement( 'paragraph', null, [
  200. new ModelText( 'x' ),
  201. new ModelText( 'foo', { link: 'http://foo.com' } ),
  202. new ModelText( 'x' )
  203. ] );
  204. const elementGenerator = href => new ViewAttributeElement( 'a', { href } );
  205. dispatcher.on( 'attribute:link', wrap( elementGenerator ) );
  206. model.change( writer => {
  207. writer.insert( modelElement, modelRootStart );
  208. } );
  209. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  210. // Set new attribute on old link but also on non-linked characters.
  211. model.change( writer => {
  212. writer.setAttribute( 'link', 'http://foobar.com', ModelRange.createIn( modelElement ) );
  213. } );
  214. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  215. } );
  216. it( 'should support unicode', () => {
  217. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  218. const viewB = new ViewAttributeElement( 'b' );
  219. dispatcher.on( 'attribute:bold', wrap( viewB ) );
  220. model.change( writer => {
  221. writer.insert( modelElement, modelRootStart );
  222. } );
  223. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  224. model.change( writer => {
  225. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  226. } );
  227. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  228. } );
  229. it( 'should be possible to override wrap', () => {
  230. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  231. const viewB = new ViewAttributeElement( 'b' );
  232. dispatcher.on( 'attribute:bold', wrap( viewB ) );
  233. dispatcher.on( 'attribute:bold', ( evt, data, consumable ) => {
  234. consumable.consume( data.item, 'attribute:bold' );
  235. }, { priority: 'high' } );
  236. model.change( writer => {
  237. writer.insert( modelElement, modelRootStart );
  238. } );
  239. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  240. } );
  241. it( 'should not convert and not consume if creator function returned null', () => {
  242. const elementGenerator = () => null;
  243. sinon.spy( dispatcher, 'fire' );
  244. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  245. dispatcher.on( 'attribute:italic', wrap( elementGenerator ) );
  246. dispatcher.on( 'attribute:italic', ( evt, data, consumable ) => {
  247. expect( consumable.test( data.item, 'attribute:italic' ) ).to.be.true;
  248. } );
  249. model.change( writer => {
  250. writer.insert( modelElement, modelRootStart );
  251. } );
  252. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  253. expect( dispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  254. } );
  255. } );
  256. describe( 'insertUIElement/removeUIElement', () => {
  257. let modelText, modelElement, range;
  258. beforeEach( () => {
  259. modelText = new ModelText( 'foobar' );
  260. modelElement = new ModelElement( 'paragraph', null, modelText );
  261. model.change( writer => {
  262. writer.insert( modelElement, modelRootStart );
  263. } );
  264. } );
  265. describe( 'collapsed range', () => {
  266. beforeEach( () => {
  267. range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
  268. } );
  269. it( 'should insert and remove ui element - element as a creator', () => {
  270. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  271. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  272. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  273. model.change( () => {
  274. model.markers.set( 'marker', range );
  275. } );
  276. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  277. model.change( () => {
  278. model.markers.remove( 'marker' );
  279. } );
  280. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  281. } );
  282. it( 'should insert and remove ui element - function as a creator', () => {
  283. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  284. dispatcher.on( 'addMarker:marker', insertUIElement( () => viewUi ) );
  285. dispatcher.on( 'removeMarker:marker', removeUIElement( () => viewUi ) );
  286. model.change( () => {
  287. model.markers.set( 'marker', range );
  288. } );
  289. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  290. model.change( () => {
  291. model.markers.remove( 'marker' );
  292. } );
  293. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  294. } );
  295. it( 'should not convert if consumable was consumed', () => {
  296. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  297. sinon.spy( dispatcher, 'fire' );
  298. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  299. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  300. consumable.consume( data.markerRange, 'addMarker:marker' );
  301. }, { priority: 'high' } );
  302. dispatcher.convertMarkerAdd( 'marker', range );
  303. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  304. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  305. } );
  306. it( 'should not convert if creator returned null', () => {
  307. dispatcher.on( 'addMarker:marker', insertUIElement( () => null ) );
  308. dispatcher.on( 'removeMarker:marker', removeUIElement( () => null ) );
  309. model.change( () => {
  310. model.markers.set( 'marker', range );
  311. } );
  312. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  313. model.change( () => {
  314. model.markers.remove( 'marker' );
  315. } );
  316. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  317. } );
  318. } );
  319. describe( 'non-collapsed range', () => {
  320. beforeEach( () => {
  321. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 5 );
  322. } );
  323. it( 'should insert and remove ui element - element as a creator', () => {
  324. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  325. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  326. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  327. model.change( () => {
  328. model.markers.set( 'marker', range );
  329. } );
  330. expect( viewToString( viewRoot ) )
  331. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  332. model.change( () => {
  333. model.markers.remove( 'marker' );
  334. } );
  335. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  336. } );
  337. it( 'should insert and remove ui element - function as a creator', () => {
  338. const viewUi = data => new ViewUIElement( 'span', { 'class': data.markerName } );
  339. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  340. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  341. model.change( () => {
  342. model.markers.set( 'marker', range );
  343. } );
  344. expect( viewToString( viewRoot ) )
  345. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  346. model.change( () => {
  347. model.markers.remove( 'marker' );
  348. } );
  349. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  350. } );
  351. it( 'should insert and remove different opening and ending element', () => {
  352. function creator( data ) {
  353. if ( data.isOpening ) {
  354. return new ViewUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  355. }
  356. return new ViewUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  357. }
  358. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  359. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  360. model.change( () => {
  361. model.markers.set( 'marker', range );
  362. } );
  363. expect( viewToString( viewRoot ) ).to.equal(
  364. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  365. );
  366. model.change( () => {
  367. model.markers.remove( 'marker' );
  368. } );
  369. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  370. } );
  371. it( 'should not convert if consumable was consumed', () => {
  372. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  373. sinon.spy( dispatcher, 'fire' );
  374. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  375. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  376. consumable.consume( data.item, 'addMarker:marker' );
  377. }, { priority: 'high' } );
  378. dispatcher.convertMarkerAdd( 'marker', range );
  379. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  380. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  381. } );
  382. } );
  383. } );
  384. // Remove converter is by default already added in `EditingController` instance.
  385. describe( 'remove', () => {
  386. it( 'should remove items from view accordingly to changes in model #1', () => {
  387. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  388. model.change( writer => {
  389. writer.insert( modelElement, modelRootStart );
  390. } );
  391. model.change( writer => {
  392. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  393. } );
  394. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  395. } );
  396. it( 'should be possible to overwrite', () => {
  397. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  398. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  399. model.change( writer => {
  400. writer.insert( modelElement, modelRootStart );
  401. } );
  402. model.change( writer => {
  403. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  404. } );
  405. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  406. } );
  407. it( 'should support unicode', () => {
  408. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  409. model.change( writer => {
  410. writer.insert( modelElement, modelRootStart );
  411. } );
  412. model.change( writer => {
  413. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 0, modelElement, 6 ) );
  414. } );
  415. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  416. } );
  417. it( 'should not remove view ui elements that are placed next to removed content', () => {
  418. modelRoot.appendChildren( new ModelText( 'fozbar' ) );
  419. viewRoot.appendChildren( [
  420. new ViewText( 'foz' ),
  421. new ViewUIElement( 'span' ),
  422. new ViewText( 'bar' )
  423. ] );
  424. // Remove 'b'.
  425. model.change( writer => {
  426. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) );
  427. } );
  428. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  429. // Remove 'z'.
  430. model.change( writer => {
  431. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 3 ) );
  432. } );
  433. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  434. } );
  435. it( 'should remove correct amount of text when it is split by view ui element', () => {
  436. modelRoot.appendChildren( new ModelText( 'fozbar' ) );
  437. viewRoot.appendChildren( [
  438. new ViewText( 'foz' ),
  439. new ViewUIElement( 'span' ),
  440. new ViewText( 'bar' )
  441. ] );
  442. // Remove 'z<span></span>b'.
  443. model.change( writer => {
  444. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ) );
  445. } );
  446. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  447. } );
  448. it( 'should unbind elements', () => {
  449. const modelElement = new ModelElement( 'paragraph' );
  450. model.change( writer => {
  451. writer.insert( modelElement, modelRootStart );
  452. } );
  453. const viewElement = controller.mapper.toViewElement( modelElement );
  454. expect( viewElement ).not.to.be.undefined;
  455. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  456. model.change( writer => {
  457. writer.remove( modelElement );
  458. } );
  459. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  460. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  461. } );
  462. it( 'should not break when remove() is used as part of unwrapping', () => {
  463. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  464. const modelWidget = new ModelElement( 'widget', null, modelP );
  465. dispatcher.on( 'insert:widget', insertElement( () => new ViewContainerElement( 'widget' ) ) );
  466. model.change( writer => {
  467. writer.insert( modelWidget, modelRootStart );
  468. } );
  469. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  470. const viewP = controller.mapper.toViewElement( modelP );
  471. expect( viewP ).not.to.be.undefined;
  472. model.change( writer => {
  473. writer.unwrap( modelWidget );
  474. } );
  475. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  476. // `modelP` is now bound with newly created view element.
  477. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  478. // `viewP` is no longer bound with model element.
  479. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  480. // View element from view root is bound to `modelP`.
  481. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  482. } );
  483. it( 'should work correctly if container element after ui element is removed', () => {
  484. // Prepare a model and view structure.
  485. // This is done outside of conversion to put view ui elements inside easily.
  486. const modelP1 = new ModelElement( 'paragraph' );
  487. const modelP2 = new ModelElement( 'paragraph' );
  488. const viewP1 = new ViewContainerElement( 'p' );
  489. const viewUi1 = new ViewUIElement( 'span' );
  490. const viewUi2 = new ViewUIElement( 'span' );
  491. const viewP2 = new ViewContainerElement( 'p' );
  492. modelRoot.appendChildren( [ modelP1, modelP2 ] );
  493. viewRoot.appendChildren( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  494. controller.mapper.bindElements( modelP1, viewP1 );
  495. controller.mapper.bindElements( modelP2, viewP2 );
  496. // Remove second paragraph element.
  497. model.change( writer => {
  498. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
  499. } );
  500. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  501. } );
  502. it( 'should work correctly if container element after text node is removed', () => {
  503. const modelText = new ModelText( 'foo' );
  504. const modelP = new ModelElement( 'paragraph' );
  505. model.change( writer => {
  506. writer.insert( [ modelText, modelP ], modelRootStart );
  507. } );
  508. model.change( writer => {
  509. writer.remove( modelP );
  510. } );
  511. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  512. } );
  513. } );
  514. describe( 'highlight', () => {
  515. describe( 'on text', () => {
  516. const highlightDescriptor = {
  517. class: 'highlight-class',
  518. priority: 7,
  519. attributes: { title: 'title' }
  520. };
  521. let markerRange;
  522. beforeEach( () => {
  523. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  524. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  525. model.change( writer => {
  526. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  527. } );
  528. markerRange = ModelRange.createIn( modelRoot );
  529. } );
  530. it( 'should wrap and unwrap text nodes', () => {
  531. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  532. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  533. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  534. model.change( () => {
  535. model.markers.set( 'marker', markerRange );
  536. } );
  537. expect( viewToString( viewRoot ) ).to.equal(
  538. '<div>' +
  539. '<p>' +
  540. '<span class="highlight-class" title="title">foo</span>' +
  541. '</p>' +
  542. '<p>' +
  543. '<span class="highlight-class" title="title">bar</span>' +
  544. '</p>' +
  545. '</div>'
  546. );
  547. model.change( () => {
  548. model.markers.remove( 'marker' );
  549. } );
  550. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  551. } );
  552. it( 'should be possible to overwrite', () => {
  553. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  554. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  555. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  556. const newDescriptor = { class: 'override-class' };
  557. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  558. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  559. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  560. model.change( () => {
  561. model.markers.set( 'marker', markerRange );
  562. } );
  563. expect( viewToString( viewRoot ) ).to.equal(
  564. '<div>' +
  565. '<p>' +
  566. '<span class="override-class">foo</span>' +
  567. '</p>' +
  568. '<p>' +
  569. '<span class="override-class">bar</span>' +
  570. '</p>' +
  571. '</div>'
  572. );
  573. model.change( () => {
  574. model.markers.remove( 'marker' );
  575. } );
  576. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  577. } );
  578. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  579. dispatcher.on( 'addMarker:marker', highlightText( () => null ), { priority: 'high' } );
  580. dispatcher.on( 'addMarker:marker', highlightElement( () => null ), { priority: 'high' } );
  581. dispatcher.on( 'removeMarker:marker', removeHighlight( () => null ), { priority: 'high' } );
  582. model.change( () => {
  583. model.markers.set( 'marker', markerRange );
  584. } );
  585. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  586. model.change( () => {
  587. model.markers.remove( 'marker' );
  588. } );
  589. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  590. } );
  591. } );
  592. describe( 'on element', () => {
  593. const highlightDescriptor = {
  594. class: 'highlight-class',
  595. priority: 7,
  596. attributes: { title: 'title' },
  597. id: 'customId'
  598. };
  599. let markerRange;
  600. beforeEach( () => {
  601. // Provide converter for div element. View div element will have custom highlight handling.
  602. dispatcher.on( 'insert:div', insertElement( () => {
  603. const viewContainer = new ViewContainerElement( 'div' );
  604. viewContainer.setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  605. element.addClass( descriptor.class );
  606. } );
  607. viewContainer.setCustomProperty( 'removeHighlight', element => {
  608. element.setAttribute( 'class', '' );
  609. } );
  610. return viewContainer;
  611. } ) );
  612. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  613. model.change( writer => {
  614. writer.insert( modelElement, modelRootStart );
  615. } );
  616. markerRange = ModelRange.createOn( modelElement );
  617. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  618. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  619. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  620. } );
  621. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  622. model.change( () => {
  623. model.markers.set( 'marker', markerRange );
  624. } );
  625. expect( viewToString( viewRoot ) ).to.equal(
  626. '<div>' +
  627. '<div class="highlight-class">' +
  628. 'foo' +
  629. '</div>' +
  630. '</div>'
  631. );
  632. model.change( () => {
  633. model.markers.remove( 'marker' );
  634. } );
  635. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  636. } );
  637. it( 'should be possible to override', () => {
  638. const newDescriptor = { class: 'override-class' };
  639. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  640. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  641. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  642. model.change( () => {
  643. model.markers.set( 'marker', markerRange );
  644. } );
  645. expect( viewToString( viewRoot ) ).to.equal(
  646. '<div>' +
  647. '<div class="override-class">' +
  648. 'foo' +
  649. '</div>' +
  650. '</div>'
  651. );
  652. model.change( () => {
  653. model.markers.remove( 'marker' );
  654. } );
  655. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  656. } );
  657. it( 'should use default priority and id if not provided', () => {
  658. const viewDiv = viewRoot.getChild( 0 );
  659. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  660. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  661. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  662. viewDiv.setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  663. expect( descriptor.priority ).to.equal( 10 );
  664. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  665. } );
  666. viewDiv.setCustomProperty( 'removeHighlight', ( element, id ) => {
  667. expect( id ).to.equal( 'marker:foo-bar-baz' );
  668. } );
  669. model.change( () => {
  670. model.markers.set( 'marker2', markerRange );
  671. } );
  672. } );
  673. it( 'should do nothing if descriptor is not provided', () => {
  674. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  675. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  676. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  677. model.change( () => {
  678. model.markers.set( 'marker2', markerRange );
  679. } );
  680. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  681. model.change( () => {
  682. model.markers.remove( 'marker2' );
  683. } );
  684. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  685. } );
  686. } );
  687. } );
  688. describe( 'createViewElementFromHighlightDescriptor()', () => {
  689. it( 'should return attribute element from descriptor object', () => {
  690. const descriptor = {
  691. class: 'foo-class',
  692. attributes: { one: 1, two: 2 },
  693. priority: 7,
  694. };
  695. const element = createViewElementFromHighlightDescriptor( descriptor );
  696. expect( element.is( 'attributeElement' ) ).to.be.true;
  697. expect( element.name ).to.equal( 'span' );
  698. expect( element.priority ).to.equal( 7 );
  699. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  700. for ( const key of Object.keys( descriptor.attributes ) ) {
  701. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  702. }
  703. } );
  704. it( 'should return attribute element from descriptor object - array with classes', () => {
  705. const descriptor = {
  706. class: [ 'foo-class', 'bar-class' ],
  707. attributes: { one: 1, two: 2 },
  708. priority: 7,
  709. };
  710. const element = createViewElementFromHighlightDescriptor( descriptor );
  711. expect( element.is( 'attributeElement' ) ).to.be.true;
  712. expect( element.name ).to.equal( 'span' );
  713. expect( element.priority ).to.equal( 7 );
  714. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  715. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  716. for ( const key of Object.keys( descriptor.attributes ) ) {
  717. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  718. }
  719. } );
  720. it( 'should create element without class', () => {
  721. const descriptor = {
  722. attributes: { one: 1, two: 2 },
  723. priority: 7,
  724. };
  725. const element = createViewElementFromHighlightDescriptor( descriptor );
  726. expect( element.is( 'attributeElement' ) ).to.be.true;
  727. expect( element.name ).to.equal( 'span' );
  728. expect( element.priority ).to.equal( 7 );
  729. for ( const key of Object.keys( descriptor.attributes ) ) {
  730. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  731. }
  732. } );
  733. it( 'should create element without priority', () => {
  734. const descriptor = {
  735. class: 'foo-class',
  736. attributes: { one: 1, two: 2 },
  737. };
  738. const element = createViewElementFromHighlightDescriptor( descriptor );
  739. expect( element.is( 'attributeElement' ) ).to.be.true;
  740. expect( element.name ).to.equal( 'span' );
  741. expect( element.priority ).to.equal( 10 );
  742. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  743. for ( const key of Object.keys( descriptor.attributes ) ) {
  744. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  745. }
  746. } );
  747. it( 'should create element without attributes', () => {
  748. const descriptor = {
  749. class: 'foo-class',
  750. priority: 7
  751. };
  752. const element = createViewElementFromHighlightDescriptor( descriptor );
  753. expect( element.is( 'attributeElement' ) ).to.be.true;
  754. expect( element.name ).to.equal( 'span' );
  755. expect( element.priority ).to.equal( 7 );
  756. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  757. } );
  758. it( 'should create similar elements if they are created using same descriptor id', () => {
  759. const a = createViewElementFromHighlightDescriptor( {
  760. id: 'id',
  761. class: 'classA',
  762. priority: 1
  763. } );
  764. const b = createViewElementFromHighlightDescriptor( {
  765. id: 'id',
  766. class: 'classB',
  767. priority: 2
  768. } );
  769. expect( a.isSimilar( b ) ).to.be.true;
  770. } );
  771. it( 'should create non-similar elements if they have different descriptor id', () => {
  772. const a = createViewElementFromHighlightDescriptor( {
  773. id: 'a',
  774. class: 'foo',
  775. priority: 1
  776. } );
  777. const b = createViewElementFromHighlightDescriptor( {
  778. id: 'b',
  779. class: 'foo',
  780. priority: 1
  781. } );
  782. expect( a.isSimilar( b ) ).to.be.false;
  783. } );
  784. } );
  785. } );