8
0

model-to-view-converters.js 34 KB

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