downcast-converters.js 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import EditingController from '../../src/controller/editingcontroller';
  6. import Conversion from '../../src/conversion/conversion';
  7. import Model from '../../src/model/model';
  8. import ModelElement from '../../src/model/element';
  9. import ModelText from '../../src/model/text';
  10. import ModelRange from '../../src/model/range';
  11. import ModelPosition from '../../src/model/position';
  12. import ViewElement from '../../src/view/element';
  13. import ViewAttributeElement from '../../src/view/attributeelement';
  14. import ViewContainerElement from '../../src/view/containerelement';
  15. import ViewUIElement from '../../src/view/uielement';
  16. import ViewText from '../../src/view/text';
  17. import {
  18. downcastElementToElement, downcastAttributeToElement, downcastAttributeToAttribute, downcastMarkerToElement, downcastMarkerToHighlight,
  19. insertElement, insertUIElement, changeAttribute, wrap, removeUIElement,
  20. highlightElement, highlightText, removeHighlight, createViewElementFromHighlightDescriptor
  21. } from '../../src/conversion/downcast-converters';
  22. import { stringify } from '../../src/dev-utils/view';
  23. describe( 'downcast-helpers', () => {
  24. let conversion, model, modelRoot, viewRoot;
  25. beforeEach( () => {
  26. model = new Model();
  27. const modelDoc = model.document;
  28. modelRoot = modelDoc.createRoot();
  29. const controller = new EditingController( model );
  30. // Set name of view root the same as dom root.
  31. // This is a mock of attaching view root to dom root.
  32. controller.view.document.getRoot()._name = 'div';
  33. viewRoot = controller.view.document.getRoot();
  34. conversion = new Conversion();
  35. conversion.register( 'downcast', [ controller.downcastDispatcher ] );
  36. } );
  37. describe( 'downcastElementToElement', () => {
  38. it( 'config.view is a string', () => {
  39. const helper = downcastElementToElement( { model: 'paragraph', view: 'p' } );
  40. conversion.for( 'downcast' ).add( helper );
  41. model.change( writer => {
  42. writer.insertElement( 'paragraph', modelRoot, 0 );
  43. } );
  44. expectResult( '<p></p>' );
  45. } );
  46. it( 'can be overwritten using converterPriority', () => {
  47. const helperA = downcastElementToElement( { model: 'paragraph', view: 'p' } );
  48. const helperB = downcastElementToElement( { model: 'paragraph', view: 'foo', converterPriority: 'high' } );
  49. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  50. model.change( writer => {
  51. writer.insertElement( 'paragraph', modelRoot, 0 );
  52. } );
  53. expectResult( '<foo></foo>' );
  54. } );
  55. it( 'config.view is a view element definition', () => {
  56. const helper = downcastElementToElement( {
  57. model: 'fancyParagraph',
  58. view: {
  59. name: 'p',
  60. classes: 'fancy'
  61. }
  62. } );
  63. conversion.for( 'downcast' ).add( helper );
  64. model.change( writer => {
  65. writer.insertElement( 'fancyParagraph', modelRoot, 0 );
  66. } );
  67. expectResult( '<p class="fancy"></p>' );
  68. } );
  69. it( 'config.view is a function', () => {
  70. const helper = downcastElementToElement( {
  71. model: 'heading',
  72. view: ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) )
  73. } );
  74. conversion.for( 'downcast' ).add( helper );
  75. model.change( writer => {
  76. writer.insertElement( 'heading', { level: 2 }, modelRoot, 0 );
  77. } );
  78. expectResult( '<h2></h2>' );
  79. } );
  80. } );
  81. describe( 'downcastAttributeToElement', () => {
  82. it( 'config.view is a string', () => {
  83. const helper = downcastAttributeToElement( { model: 'bold', view: 'strong' } );
  84. conversion.for( 'downcast' ).add( helper );
  85. model.change( writer => {
  86. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  87. } );
  88. expectResult( '<strong>foo</strong>' );
  89. } );
  90. it( 'can be overwritten using converterPriority', () => {
  91. const helperA = downcastAttributeToElement( { model: 'bold', view: 'strong' } );
  92. const helperB = downcastAttributeToElement( { model: 'bold', view: 'b', converterPriority: 'high' } );
  93. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  94. model.change( writer => {
  95. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  96. } );
  97. expectResult( '<b>foo</b>' );
  98. } );
  99. it( 'config.view is a view element definition', () => {
  100. const helper = downcastAttributeToElement( {
  101. model: 'invert',
  102. view: {
  103. name: 'span',
  104. classes: [ 'font-light', 'bg-dark' ]
  105. }
  106. } );
  107. conversion.for( 'downcast' ).add( helper );
  108. model.change( writer => {
  109. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  110. } );
  111. expectResult( '<span class="bg-dark font-light">foo</span>' );
  112. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  113. } );
  114. it( 'config.view allows specifying the element\'s priority', () => {
  115. const helper = downcastAttributeToElement( {
  116. model: 'invert',
  117. view: {
  118. name: 'span',
  119. priority: 5
  120. }
  121. } );
  122. conversion.for( 'downcast' ).add( helper );
  123. model.change( writer => {
  124. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  125. } );
  126. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  127. } );
  128. it( 'model attribute value is enum', () => {
  129. const helper = downcastAttributeToElement( {
  130. model: {
  131. key: 'fontSize',
  132. values: [ 'big', 'small' ]
  133. },
  134. view: {
  135. big: {
  136. name: 'span',
  137. styles: {
  138. 'font-size': '1.2em'
  139. }
  140. },
  141. small: {
  142. name: 'span',
  143. styles: {
  144. 'font-size': '0.8em'
  145. },
  146. priority: 5
  147. }
  148. }
  149. } );
  150. conversion.for( 'downcast' ).add( helper );
  151. model.change( writer => {
  152. writer.insertText( 'foo', { fontSize: 'big' }, modelRoot, 0 );
  153. } );
  154. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  155. expectResult( '<span style="font-size:1.2em">foo</span>' );
  156. model.change( writer => {
  157. writer.setAttribute( 'fontSize', 'small', modelRoot.getChild( 0 ) );
  158. } );
  159. expectResult( '<span style="font-size:0.8em">foo</span>' );
  160. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  161. model.change( writer => {
  162. writer.removeAttribute( 'fontSize', modelRoot.getChild( 0 ) );
  163. } );
  164. expectResult( 'foo' );
  165. } );
  166. it( 'config.view is a function', () => {
  167. const helper = downcastAttributeToElement( {
  168. model: 'bold',
  169. view: ( modelAttributeValue, viewWriter ) => {
  170. return viewWriter.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } );
  171. }
  172. } );
  173. conversion.for( 'downcast' ).add( helper );
  174. model.change( writer => {
  175. writer.insertText( 'foo', { bold: '500' }, modelRoot, 0 );
  176. } );
  177. expectResult( '<span style="font-weight:500">foo</span>' );
  178. } );
  179. it( 'config.model.name is given', () => {
  180. const helper = downcastAttributeToElement( {
  181. model: {
  182. key: 'color',
  183. name: '$text'
  184. },
  185. view: ( modelAttributeValue, viewWriter ) => {
  186. return viewWriter.createAttributeElement( 'span', { style: 'color:' + modelAttributeValue } );
  187. }
  188. } );
  189. conversion.for( 'downcast' )
  190. .add( helper )
  191. .add( downcastElementToElement( {
  192. model: 'smiley',
  193. view: ( modelElement, viewWriter ) => {
  194. return viewWriter.createEmptyElement( 'img', {
  195. src: 'smile.jpg',
  196. class: 'smiley'
  197. } );
  198. }
  199. } ) );
  200. model.change( writer => {
  201. writer.insertText( 'foo', { color: '#FF0000' }, modelRoot, 0 );
  202. writer.insertElement( 'smiley', { color: '#FF0000' }, modelRoot, 3 );
  203. } );
  204. expectResult( '<span style="color:#FF0000">foo</span><img class="smiley" src="smile.jpg"></img>' );
  205. } );
  206. } );
  207. describe( 'downcastAttributeToAttribute', () => {
  208. beforeEach( () => {
  209. conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'image', view: 'img' } ) );
  210. } );
  211. it( 'config.view is a string', () => {
  212. const helper = downcastAttributeToAttribute( { model: 'source', view: 'src' } );
  213. conversion.for( 'downcast' ).add( helper );
  214. model.change( writer => {
  215. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  216. } );
  217. expectResult( '<img src="foo.jpg"></img>' );
  218. model.change( writer => {
  219. writer.removeAttribute( 'source', modelRoot.getChild( 0 ) );
  220. } );
  221. expectResult( '<img></img>' );
  222. } );
  223. it( 'can be overwritten using converterPriority', () => {
  224. const helperA = downcastAttributeToAttribute( { model: 'source', view: 'href' } );
  225. const helperB = downcastAttributeToAttribute( { model: 'source', view: 'src', converterPriority: 'high' } );
  226. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  227. model.change( writer => {
  228. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  229. } );
  230. expectResult( '<img src="foo.jpg"></img>' );
  231. } );
  232. it( 'model element name specified', () => {
  233. conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
  234. const helper = downcastAttributeToAttribute( {
  235. model: {
  236. name: 'image',
  237. key: 'source'
  238. },
  239. view: 'src'
  240. } );
  241. conversion.for( 'downcast' ).add( helper );
  242. model.change( writer => {
  243. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  244. } );
  245. expectResult( '<img src="foo.jpg"></img>' );
  246. model.change( writer => {
  247. writer.rename( modelRoot.getChild( 0 ), 'paragraph' );
  248. } );
  249. expectResult( '<p></p>' );
  250. } );
  251. it( 'config.view is an object, model attribute value is enum', () => {
  252. conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
  253. const helper = downcastAttributeToAttribute( {
  254. model: {
  255. key: 'styled',
  256. values: [ 'dark', 'light' ]
  257. },
  258. view: {
  259. dark: {
  260. key: 'class',
  261. value: [ 'styled', 'styled-dark' ]
  262. },
  263. light: {
  264. key: 'class',
  265. value: [ 'styled', 'styled-light' ]
  266. }
  267. }
  268. } );
  269. conversion.for( 'downcast' ).add( helper );
  270. model.change( writer => {
  271. writer.insertElement( 'paragraph', { styled: 'dark' }, modelRoot, 0 );
  272. } );
  273. expectResult( '<p class="styled styled-dark"></p>' );
  274. model.change( writer => {
  275. writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) );
  276. } );
  277. expectResult( '<p class="styled styled-light"></p>' );
  278. model.change( writer => {
  279. writer.removeAttribute( 'styled', modelRoot.getChild( 0 ) );
  280. } );
  281. expectResult( '<p></p>' );
  282. } );
  283. it( 'config.view is an object, model attribute value is enum, view has style', () => {
  284. conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
  285. const helper = downcastAttributeToAttribute( {
  286. model: {
  287. key: 'align',
  288. values: [ 'right', 'center' ]
  289. },
  290. view: {
  291. right: {
  292. key: 'style',
  293. value: {
  294. 'text-align': 'right'
  295. }
  296. },
  297. center: {
  298. key: 'style',
  299. value: {
  300. 'text-align': 'center'
  301. }
  302. }
  303. }
  304. } );
  305. conversion.for( 'downcast' ).add( helper );
  306. model.change( writer => {
  307. writer.insertElement( 'paragraph', { align: 'right' }, modelRoot, 0 );
  308. } );
  309. expectResult( '<p style="text-align:right"></p>' );
  310. model.change( writer => {
  311. writer.setAttribute( 'align', 'center', modelRoot.getChild( 0 ) );
  312. } );
  313. expectResult( '<p style="text-align:center"></p>' );
  314. model.change( writer => {
  315. writer.removeAttribute( 'align', modelRoot.getChild( 0 ) );
  316. } );
  317. expectResult( '<p></p>' );
  318. } );
  319. it( 'config.view is an object, only name and key are provided', () => {
  320. conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
  321. const helper = downcastAttributeToAttribute( {
  322. model: {
  323. name: 'paragraph',
  324. key: 'class'
  325. },
  326. view: {
  327. name: 'paragraph',
  328. key: 'class'
  329. }
  330. } );
  331. conversion.for( 'downcast' ).add( helper );
  332. model.change( writer => {
  333. writer.insertElement( 'paragraph', { class: 'dark' }, modelRoot, 0 );
  334. } );
  335. expectResult( '<p class="dark"></p>' );
  336. model.change( writer => {
  337. writer.setAttribute( 'class', 'light', modelRoot.getChild( 0 ) );
  338. } );
  339. expectResult( '<p class="light"></p>' );
  340. model.change( writer => {
  341. writer.removeAttribute( 'class', modelRoot.getChild( 0 ) );
  342. } );
  343. expectResult( '<p></p>' );
  344. } );
  345. it( 'config.view is a function', () => {
  346. const helper = downcastAttributeToAttribute( {
  347. model: 'styled',
  348. view: attributeValue => ( { key: 'class', value: 'styled-' + attributeValue } )
  349. } );
  350. conversion.for( 'downcast' ).add( helper );
  351. model.change( writer => {
  352. writer.insertElement( 'image', { styled: 'pull-out' }, modelRoot, 0 );
  353. } );
  354. expectResult( '<img class="styled-pull-out"></img>' );
  355. } );
  356. } );
  357. describe( 'downcastMarkerToElement', () => {
  358. it( 'config.view is a string', () => {
  359. const helper = downcastMarkerToElement( { model: 'search', view: 'marker-search' } );
  360. conversion.for( 'downcast' ).add( helper );
  361. model.change( writer => {
  362. writer.insertText( 'foo', modelRoot, 0 );
  363. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 );
  364. writer.addMarker( 'search', { range, usingOperation: false } );
  365. } );
  366. expectResult( 'f<marker-search></marker-search>o<marker-search></marker-search>o' );
  367. } );
  368. it( 'can be overwritten using converterPriority', () => {
  369. const helperA = downcastMarkerToElement( { model: 'search', view: 'marker-search' } );
  370. const helperB = downcastMarkerToElement( { model: 'search', view: 'search', converterPriority: 'high' } );
  371. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  372. model.change( writer => {
  373. writer.insertText( 'foo', modelRoot, 0 );
  374. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 );
  375. writer.addMarker( 'search', { range, usingOperation: false } );
  376. } );
  377. expectResult( 'f<search></search>o<search></search>o' );
  378. } );
  379. it( 'config.view is a view element definition', () => {
  380. const helper = downcastMarkerToElement( {
  381. model: 'search',
  382. view: {
  383. name: 'span',
  384. attributes: {
  385. 'data-marker': 'search'
  386. }
  387. }
  388. } );
  389. conversion.for( 'downcast' ).add( helper );
  390. model.change( writer => {
  391. writer.insertText( 'foo', modelRoot, 0 );
  392. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 );
  393. writer.addMarker( 'search', { range, usingOperation: false } );
  394. } );
  395. expectResult( 'f<span data-marker="search"></span>o<span data-marker="search"></span>o' );
  396. } );
  397. it( 'config.view is a function', () => {
  398. const helper = downcastMarkerToElement( {
  399. model: 'search',
  400. view: ( data, viewWriter ) => {
  401. return viewWriter.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } );
  402. }
  403. } );
  404. conversion.for( 'downcast' ).add( helper );
  405. model.change( writer => {
  406. writer.insertText( 'foo', modelRoot, 0 );
  407. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 );
  408. writer.addMarker( 'search', { range, usingOperation: false } );
  409. } );
  410. expectResult( 'f<span data-marker="search" data-start="true"></span>o<span data-marker="search" data-start="false"></span>o' );
  411. } );
  412. } );
  413. describe( 'downcastMarkerToHighlight', () => {
  414. it( 'config.view is a highlight descriptor', () => {
  415. const helper = downcastMarkerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  416. conversion.for( 'downcast' ).add( helper );
  417. model.change( writer => {
  418. writer.insertText( 'foo', modelRoot, 0 );
  419. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  420. writer.addMarker( 'comment', { range, usingOperation: false } );
  421. } );
  422. expectResult( '<span class="comment">foo</span>' );
  423. } );
  424. it( 'can be overwritten using converterPriority', () => {
  425. const helperA = downcastMarkerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  426. const helperB = downcastMarkerToHighlight( { model: 'comment', view: { classes: 'new-comment' }, converterPriority: 'high' } );
  427. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  428. model.change( writer => {
  429. writer.insertText( 'foo', modelRoot, 0 );
  430. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  431. writer.addMarker( 'comment', { range, usingOperation: false } );
  432. } );
  433. expectResult( '<span class="new-comment">foo</span>' );
  434. } );
  435. it( 'config.view is a function', () => {
  436. const helper = downcastMarkerToHighlight( {
  437. model: 'comment',
  438. view: data => {
  439. const commentType = data.markerName.split( ':' )[ 1 ];
  440. return {
  441. classes: [ 'comment', 'comment-' + commentType ]
  442. };
  443. }
  444. } );
  445. conversion.for( 'downcast' ).add( helper );
  446. model.change( writer => {
  447. writer.insertText( 'foo', modelRoot, 0 );
  448. const range = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 );
  449. writer.addMarker( 'comment:abc', { range, usingOperation: false } );
  450. } );
  451. expectResult( '<span class="comment comment-abc">foo</span>' );
  452. } );
  453. } );
  454. function expectResult( string ) {
  455. expect( stringify( viewRoot, null, { ignoreRoot: true } ) ).to.equal( string );
  456. }
  457. } );
  458. describe( 'downcast-converters', () => {
  459. let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model;
  460. beforeEach( () => {
  461. model = new Model();
  462. modelDoc = model.document;
  463. modelRoot = modelDoc.createRoot();
  464. controller = new EditingController( model );
  465. viewRoot = controller.view.document.getRoot();
  466. // Set name of view root the same as dom root.
  467. // This is a mock of attaching view root to dom root.
  468. controller.view.document.getRoot()._name = 'div';
  469. dispatcher = controller.downcastDispatcher;
  470. dispatcher.on(
  471. 'insert:paragraph',
  472. insertElement(
  473. ( modelItem, viewWriter ) => viewWriter.createContainerElement( 'p' )
  474. )
  475. );
  476. dispatcher.on( 'attribute:class', changeAttribute() );
  477. modelRootStart = ModelPosition.createAt( modelRoot, 0 );
  478. } );
  479. function viewAttributesToString( item ) {
  480. let result = '';
  481. for ( const key of item.getAttributeKeys() ) {
  482. const value = item.getAttribute( key );
  483. if ( value ) {
  484. result += ' ' + key + '="' + value + '"';
  485. }
  486. }
  487. return result;
  488. }
  489. function viewToString( item ) {
  490. let result = '';
  491. if ( item instanceof ViewText ) {
  492. result = item.data;
  493. } else {
  494. // ViewElement or ViewDocumentFragment.
  495. for ( const child of item.getChildren() ) {
  496. result += viewToString( child );
  497. }
  498. if ( item instanceof ViewElement ) {
  499. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  500. }
  501. }
  502. return result;
  503. }
  504. describe( 'insertText', () => {
  505. it( 'should downcast text', () => {
  506. model.change( writer => {
  507. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  508. } );
  509. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  510. } );
  511. it( 'should support unicode', () => {
  512. model.change( writer => {
  513. writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
  514. } );
  515. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  516. } );
  517. it( 'should be possible to override it', () => {
  518. dispatcher.on( 'insert:$text', ( evt, data, conversionApi ) => {
  519. conversionApi.consumable.consume( data.item, 'insert' );
  520. }, { converterPriority: 'high' } );
  521. model.change( writer => {
  522. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  523. } );
  524. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  525. } );
  526. } );
  527. describe( 'insertElement', () => {
  528. it( 'should convert element insertion in model', () => {
  529. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  530. model.change( writer => {
  531. writer.insert( modelElement, modelRootStart );
  532. } );
  533. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  534. } );
  535. it( 'should not convert if creator returned null', () => {
  536. dispatcher.on( 'insert:div', insertElement( () => null ) );
  537. const modelElement = new ModelElement( 'div' );
  538. model.change( writer => {
  539. writer.insert( modelElement, modelRootStart );
  540. } );
  541. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  542. } );
  543. } );
  544. describe( 'changeAttribute', () => {
  545. it( 'should convert attribute insert/change/remove on a model node', () => {
  546. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  547. model.change( writer => {
  548. writer.insert( modelElement, modelRootStart );
  549. } );
  550. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  551. model.change( writer => {
  552. writer.setAttribute( 'class', 'bar', modelElement );
  553. } );
  554. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  555. model.change( writer => {
  556. writer.removeAttribute( 'class', modelElement );
  557. } );
  558. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  559. } );
  560. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  561. const themeConverter = ( value, data ) => {
  562. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  563. value += ' fix-content';
  564. }
  565. return { key: 'class', value };
  566. };
  567. dispatcher.on( 'insert:div', insertElement( ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'div' ) ) );
  568. dispatcher.on( 'attribute:theme', changeAttribute( themeConverter ) );
  569. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  570. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  571. model.change( writer => {
  572. writer.insert( [ modelParagraph, modelDiv ], modelRootStart );
  573. } );
  574. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  575. model.change( writer => {
  576. writer.setAttribute( 'theme', 'awesome', modelParagraph );
  577. } );
  578. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  579. model.change( writer => {
  580. writer.removeAttribute( 'theme', modelParagraph );
  581. } );
  582. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  583. } );
  584. it( 'should be possible to override setAttribute', () => {
  585. const modelElement = new ModelElement( 'paragraph', { classes: 'foo' }, new ModelText( 'foobar' ) );
  586. dispatcher.on( 'attribute:class', ( evt, data, conversionApi ) => {
  587. conversionApi.consumable.consume( data.item, 'attribute:class' );
  588. }, { converterPriority: 'high' } );
  589. model.change( writer => {
  590. writer.insert( modelElement, modelRootStart );
  591. } );
  592. // No attribute set.
  593. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  594. } );
  595. it( 'should not convert or consume if element creator returned null', () => {
  596. const callback = sinon.stub().returns( null );
  597. dispatcher.on( 'attribute:class', changeAttribute( callback ) );
  598. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  599. model.change( writer => {
  600. writer.insert( modelElement, modelRootStart );
  601. } );
  602. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  603. sinon.assert.called( callback );
  604. } );
  605. } );
  606. describe( 'wrap', () => {
  607. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  608. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  609. const creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' );
  610. dispatcher.on( 'attribute:bold', wrap( creator ) );
  611. model.change( writer => {
  612. writer.insert( modelElement, modelRootStart );
  613. } );
  614. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  615. model.change( writer => {
  616. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  617. } );
  618. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  619. } );
  620. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  621. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  622. const elementGenerator = ( modelAttributeValue, viewWriter ) => {
  623. if ( modelAttributeValue == 'bold' ) {
  624. return viewWriter.createAttributeElement( 'b' );
  625. }
  626. };
  627. dispatcher.on( 'attribute:style', wrap( elementGenerator ) );
  628. model.change( writer => {
  629. writer.insert( modelElement, modelRootStart );
  630. } );
  631. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  632. model.change( writer => {
  633. writer.removeAttribute( 'style', ModelRange.createIn( modelElement ) );
  634. } );
  635. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  636. } );
  637. it( 'should update range on re-wrapping attribute (#475)', () => {
  638. const modelElement = new ModelElement( 'paragraph', null, [
  639. new ModelText( 'x' ),
  640. new ModelText( 'foo', { link: 'http://foo.com' } ),
  641. new ModelText( 'x' )
  642. ] );
  643. const elementGenerator = ( modelAttributeValue, viewWriter ) => {
  644. return viewWriter.createAttributeElement( 'a', { href: modelAttributeValue } );
  645. };
  646. dispatcher.on( 'attribute:link', wrap( elementGenerator ) );
  647. model.change( writer => {
  648. writer.insert( modelElement, modelRootStart );
  649. } );
  650. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  651. // Set new attribute on old link but also on non-linked characters.
  652. model.change( writer => {
  653. writer.setAttribute( 'link', 'http://foobar.com', ModelRange.createIn( modelElement ) );
  654. } );
  655. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  656. } );
  657. it( 'should support unicode', () => {
  658. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  659. const creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' );
  660. dispatcher.on( 'attribute:bold', wrap( creator ) );
  661. model.change( writer => {
  662. writer.insert( modelElement, modelRootStart );
  663. } );
  664. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  665. model.change( writer => {
  666. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  667. } );
  668. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  669. } );
  670. it( 'should be possible to override wrap', () => {
  671. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  672. dispatcher.on( 'attribute:bold', wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' ) ) );
  673. dispatcher.on(
  674. 'attribute:bold',
  675. wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' ) ),
  676. { priority: 'high' }
  677. );
  678. model.change( writer => {
  679. writer.insert( modelElement, modelRootStart );
  680. } );
  681. expect( viewToString( viewRoot ) ).to.equal( '<div><p><strong>foobar</strong></p></div>' );
  682. } );
  683. it( 'should not convert and not consume if creator function returned null', () => {
  684. const elementGenerator = () => null;
  685. sinon.spy( dispatcher, 'fire' );
  686. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  687. dispatcher.on( 'attribute:italic', wrap( elementGenerator ) );
  688. const spy = sinon.spy();
  689. dispatcher.on( 'attribute:italic', spy );
  690. model.change( writer => {
  691. writer.insert( modelElement, modelRootStart );
  692. } );
  693. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  694. expect( dispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  695. expect( spy.called ).to.be.true;
  696. } );
  697. } );
  698. describe( 'insertUIElement/removeUIElement', () => {
  699. let modelText, modelElement, range;
  700. beforeEach( () => {
  701. modelText = new ModelText( 'foobar' );
  702. modelElement = new ModelElement( 'paragraph', null, modelText );
  703. model.change( writer => {
  704. writer.insert( modelElement, modelRootStart );
  705. } );
  706. } );
  707. describe( 'collapsed range', () => {
  708. beforeEach( () => {
  709. range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
  710. } );
  711. it( 'should insert and remove ui element', () => {
  712. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
  713. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  714. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  715. model.change( writer => {
  716. writer.addMarker( 'marker', { range, usingOperation: false } );
  717. } );
  718. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  719. model.change( writer => {
  720. writer.removeMarker( 'marker' );
  721. } );
  722. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  723. } );
  724. it( 'should not convert if consumable was consumed', () => {
  725. sinon.spy( dispatcher, 'fire' );
  726. dispatcher.on( 'addMarker:marker', insertUIElement(
  727. ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } ) )
  728. );
  729. dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  730. conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
  731. }, { priority: 'high' } );
  732. model.change( writer => {
  733. writer.addMarker( 'marker', { range, usingOperation: false } );
  734. } );
  735. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  736. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  737. } );
  738. it( 'should not convert if creator returned null', () => {
  739. dispatcher.on( 'addMarker:marker', insertUIElement( () => null ) );
  740. dispatcher.on( 'removeMarker:marker', removeUIElement( () => null ) );
  741. model.change( writer => {
  742. writer.addMarker( 'marker', { range, usingOperation: false } );
  743. } );
  744. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  745. model.change( writer => {
  746. writer.removeMarker( 'marker' );
  747. } );
  748. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  749. } );
  750. } );
  751. describe( 'non-collapsed range', () => {
  752. beforeEach( () => {
  753. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 5 );
  754. } );
  755. it( 'should insert and remove ui element - element as a creator', () => {
  756. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
  757. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  758. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  759. model.change( writer => {
  760. writer.addMarker( 'marker', { range, usingOperation: false } );
  761. } );
  762. expect( viewToString( viewRoot ) )
  763. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  764. model.change( writer => {
  765. writer.removeMarker( 'marker' );
  766. } );
  767. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  768. } );
  769. it( 'should insert and remove ui element - function as a creator', () => {
  770. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': data.markerName } );
  771. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  772. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  773. model.change( writer => {
  774. writer.addMarker( 'marker', { range, usingOperation: false } );
  775. } );
  776. expect( viewToString( viewRoot ) )
  777. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  778. model.change( writer => {
  779. writer.removeMarker( 'marker' );
  780. } );
  781. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  782. } );
  783. it( 'should insert and remove different opening and ending element', () => {
  784. function creator( data, viewWriter ) {
  785. if ( data.isOpening ) {
  786. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  787. }
  788. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  789. }
  790. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  791. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  792. model.change( writer => {
  793. writer.addMarker( 'marker', { range, usingOperation: false } );
  794. } );
  795. expect( viewToString( viewRoot ) ).to.equal(
  796. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  797. );
  798. model.change( writer => {
  799. writer.removeMarker( 'marker' );
  800. } );
  801. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  802. } );
  803. it( 'should not convert if consumable was consumed', () => {
  804. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
  805. sinon.spy( dispatcher, 'fire' );
  806. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  807. dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  808. conversionApi.consumable.consume( data.item, 'addMarker:marker' );
  809. }, { priority: 'high' } );
  810. model.change( writer => {
  811. writer.addMarker( 'marker', { range, usingOperation: false } );
  812. } );
  813. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  814. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  815. } );
  816. } );
  817. } );
  818. // Remove converter is by default already added in `EditingController` instance.
  819. describe( 'remove', () => {
  820. it( 'should remove items from view accordingly to changes in model #1', () => {
  821. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  822. model.change( writer => {
  823. writer.insert( modelElement, modelRootStart );
  824. } );
  825. model.change( writer => {
  826. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  827. } );
  828. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  829. } );
  830. it( 'should be possible to overwrite', () => {
  831. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  832. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  833. model.change( writer => {
  834. writer.insert( modelElement, modelRootStart );
  835. } );
  836. model.change( writer => {
  837. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  838. } );
  839. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  840. } );
  841. it( 'should support unicode', () => {
  842. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  843. model.change( writer => {
  844. writer.insert( modelElement, modelRootStart );
  845. } );
  846. model.change( writer => {
  847. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 0, modelElement, 6 ) );
  848. } );
  849. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  850. } );
  851. it( 'should not remove view ui elements that are placed next to removed content', () => {
  852. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  853. viewRoot._appendChild( [
  854. new ViewText( 'foz' ),
  855. new ViewUIElement( 'span' ),
  856. new ViewText( 'bar' )
  857. ] );
  858. // Remove 'b'.
  859. model.change( writer => {
  860. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) );
  861. } );
  862. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  863. // Remove 'z'.
  864. model.change( writer => {
  865. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 3 ) );
  866. } );
  867. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  868. } );
  869. it( 'should remove correct amount of text when it is split by view ui element', () => {
  870. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  871. viewRoot._appendChild( [
  872. new ViewText( 'foz' ),
  873. new ViewUIElement( 'span' ),
  874. new ViewText( 'bar' )
  875. ] );
  876. // Remove 'z<span></span>b'.
  877. model.change( writer => {
  878. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ) );
  879. } );
  880. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  881. } );
  882. it( 'should unbind elements', () => {
  883. const modelElement = new ModelElement( 'paragraph' );
  884. model.change( writer => {
  885. writer.insert( modelElement, modelRootStart );
  886. } );
  887. const viewElement = controller.mapper.toViewElement( modelElement );
  888. expect( viewElement ).not.to.be.undefined;
  889. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  890. model.change( writer => {
  891. writer.remove( modelElement );
  892. } );
  893. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  894. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  895. } );
  896. it( 'should not break when remove() is used as part of unwrapping', () => {
  897. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  898. const modelWidget = new ModelElement( 'widget', null, modelP );
  899. dispatcher.on( 'insert:widget', insertElement(
  900. ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'widget' ) )
  901. );
  902. model.change( writer => {
  903. writer.insert( modelWidget, modelRootStart );
  904. } );
  905. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  906. const viewP = controller.mapper.toViewElement( modelP );
  907. expect( viewP ).not.to.be.undefined;
  908. model.change( writer => {
  909. writer.unwrap( modelWidget );
  910. } );
  911. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  912. // `modelP` is now bound with newly created view element.
  913. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  914. // `viewP` is no longer bound with model element.
  915. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  916. // View element from view root is bound to `modelP`.
  917. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  918. } );
  919. it( 'should work correctly if container element after ui element is removed', () => {
  920. // Prepare a model and view structure.
  921. // This is done outside of conversion to put view ui elements inside easily.
  922. const modelP1 = new ModelElement( 'paragraph' );
  923. const modelP2 = new ModelElement( 'paragraph' );
  924. const viewP1 = new ViewContainerElement( 'p' );
  925. const viewUi1 = new ViewUIElement( 'span' );
  926. const viewUi2 = new ViewUIElement( 'span' );
  927. const viewP2 = new ViewContainerElement( 'p' );
  928. modelRoot._appendChild( [ modelP1, modelP2 ] );
  929. viewRoot._appendChild( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  930. controller.mapper.bindElements( modelP1, viewP1 );
  931. controller.mapper.bindElements( modelP2, viewP2 );
  932. // Remove second paragraph element.
  933. model.change( writer => {
  934. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
  935. } );
  936. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  937. } );
  938. it( 'should work correctly if container element after text node is removed', () => {
  939. const modelText = new ModelText( 'foo' );
  940. const modelP = new ModelElement( 'paragraph' );
  941. model.change( writer => {
  942. writer.insert( [ modelText, modelP ], modelRootStart );
  943. } );
  944. model.change( writer => {
  945. writer.remove( modelP );
  946. } );
  947. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  948. } );
  949. } );
  950. describe( 'highlight', () => {
  951. describe( 'on text', () => {
  952. const highlightDescriptor = {
  953. classes: 'highlight-class',
  954. priority: 7,
  955. attributes: { title: 'title' }
  956. };
  957. let markerRange;
  958. beforeEach( () => {
  959. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  960. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  961. model.change( writer => {
  962. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  963. } );
  964. markerRange = ModelRange.createIn( modelRoot );
  965. } );
  966. it( 'should wrap and unwrap text nodes', () => {
  967. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  968. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  969. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  970. model.change( writer => {
  971. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  972. } );
  973. expect( viewToString( viewRoot ) ).to.equal(
  974. '<div>' +
  975. '<p>' +
  976. '<span class="highlight-class" title="title">foo</span>' +
  977. '</p>' +
  978. '<p>' +
  979. '<span class="highlight-class" title="title">bar</span>' +
  980. '</p>' +
  981. '</div>'
  982. );
  983. model.change( writer => {
  984. writer.removeMarker( 'marker' );
  985. } );
  986. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  987. } );
  988. it( 'should be possible to overwrite', () => {
  989. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  990. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  991. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  992. const newDescriptor = { classes: 'override-class' };
  993. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  994. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  995. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  996. model.change( writer => {
  997. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  998. } );
  999. expect( viewToString( viewRoot ) ).to.equal(
  1000. '<div>' +
  1001. '<p>' +
  1002. '<span class="override-class">foo</span>' +
  1003. '</p>' +
  1004. '<p>' +
  1005. '<span class="override-class">bar</span>' +
  1006. '</p>' +
  1007. '</div>'
  1008. );
  1009. model.change( writer => {
  1010. writer.removeMarker( 'marker' );
  1011. } );
  1012. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1013. } );
  1014. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  1015. dispatcher.on( 'addMarker:marker', highlightText( () => null ), { priority: 'high' } );
  1016. dispatcher.on( 'addMarker:marker', highlightElement( () => null ), { priority: 'high' } );
  1017. dispatcher.on( 'removeMarker:marker', removeHighlight( () => null ), { priority: 'high' } );
  1018. model.change( writer => {
  1019. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1020. } );
  1021. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1022. model.change( writer => {
  1023. writer.removeMarker( 'marker' );
  1024. } );
  1025. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1026. } );
  1027. it( 'should do nothing if collapsed marker is converted', () => {
  1028. const descriptor = { classes: 'foo' };
  1029. dispatcher.on( 'addMarker:marker', highlightText( descriptor ), { priority: 'high' } );
  1030. dispatcher.on( 'addMarker:marker', highlightElement( descriptor ), { priority: 'high' } );
  1031. dispatcher.on( 'removeMarker:marker', removeHighlight( descriptor ), { priority: 'high' } );
  1032. markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 0 );
  1033. model.change( writer => {
  1034. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1035. } );
  1036. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1037. model.change( () => {
  1038. model.markers._remove( 'marker' );
  1039. } );
  1040. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1041. } );
  1042. it( 'should correctly wrap and unwrap multiple, intersecting markers', () => {
  1043. const descriptorFoo = { classes: 'foo' };
  1044. const descriptorBar = { classes: 'bar' };
  1045. const descriptorXyz = { classes: 'xyz' };
  1046. dispatcher.on( 'addMarker:markerFoo', highlightText( descriptorFoo ) );
  1047. dispatcher.on( 'addMarker:markerBar', highlightText( descriptorBar ) );
  1048. dispatcher.on( 'addMarker:markerXyz', highlightText( descriptorXyz ) );
  1049. dispatcher.on( 'removeMarker:markerFoo', removeHighlight( descriptorFoo ) );
  1050. dispatcher.on( 'removeMarker:markerBar', removeHighlight( descriptorBar ) );
  1051. dispatcher.on( 'removeMarker:markerXyz', removeHighlight( descriptorXyz ) );
  1052. const p1 = modelRoot.getChild( 0 );
  1053. const p2 = modelRoot.getChild( 1 );
  1054. model.change( writer => {
  1055. const range = ModelRange.createFromParentsAndOffsets( p1, 0, p1, 3 );
  1056. writer.addMarker( 'markerFoo', { range, usingOperation: false } );
  1057. } );
  1058. expect( viewToString( viewRoot ) ).to.equal(
  1059. '<div>' +
  1060. '<p>' +
  1061. '<span class="foo">foo</span>' +
  1062. '</p>' +
  1063. '<p>bar</p>' +
  1064. '</div>'
  1065. );
  1066. model.change( writer => {
  1067. const range = ModelRange.createFromParentsAndOffsets( p1, 1, p2, 2 );
  1068. writer.addMarker( 'markerBar', { range, usingOperation: false } );
  1069. } );
  1070. expect( viewToString( viewRoot ) ).to.equal(
  1071. '<div>' +
  1072. '<p>' +
  1073. '<span class="foo">f</span>' +
  1074. '<span class="bar">' +
  1075. '<span class="foo">oo</span>' +
  1076. '</span>' +
  1077. '</p>' +
  1078. '<p>' +
  1079. '<span class="bar">ba</span>' +
  1080. 'r' +
  1081. '</p>' +
  1082. '</div>'
  1083. );
  1084. model.change( writer => {
  1085. const range = ModelRange.createFromParentsAndOffsets( p1, 2, p2, 3 );
  1086. writer.addMarker( 'markerXyz', { range, usingOperation: false } );
  1087. } );
  1088. expect( viewToString( viewRoot ) ).to.equal(
  1089. '<div>' +
  1090. '<p>' +
  1091. '<span class="foo">f</span>' +
  1092. '<span class="bar">' +
  1093. '<span class="foo">' +
  1094. 'o' +
  1095. '<span class="xyz">o</span>' +
  1096. '</span>' +
  1097. '</span>' +
  1098. '</p>' +
  1099. '<p>' +
  1100. '<span class="bar">' +
  1101. '<span class="xyz">ba</span>' +
  1102. '</span>' +
  1103. '<span class="xyz">r</span>' +
  1104. '</p>' +
  1105. '</div>'
  1106. );
  1107. model.change( writer => {
  1108. writer.removeMarker( 'markerBar' );
  1109. } );
  1110. expect( viewToString( viewRoot ) ).to.equal(
  1111. '<div>' +
  1112. '<p>' +
  1113. '<span class="foo">' +
  1114. 'fo' +
  1115. '<span class="xyz">o</span>' +
  1116. '</span>' +
  1117. '</p>' +
  1118. '<p>' +
  1119. '<span class="xyz">bar</span>' +
  1120. '</p>' +
  1121. '</div>'
  1122. );
  1123. model.change( writer => {
  1124. writer.removeMarker( 'markerFoo' );
  1125. } );
  1126. expect( viewToString( viewRoot ) ).to.equal(
  1127. '<div>' +
  1128. '<p>' +
  1129. 'fo' +
  1130. '<span class="xyz">o</span>' +
  1131. '</p>' +
  1132. '<p>' +
  1133. '<span class="xyz">bar</span>' +
  1134. '</p>' +
  1135. '</div>'
  1136. );
  1137. model.change( writer => {
  1138. writer.removeMarker( 'markerXyz' );
  1139. } );
  1140. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1141. } );
  1142. it( 'should do nothing if marker is applied and removed on empty-ish range', () => {
  1143. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  1144. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  1145. const p1 = modelRoot.getChild( 0 );
  1146. const p2 = modelRoot.getChild( 1 );
  1147. const markerRange = ModelRange.createFromParentsAndOffsets( p1, 3, p2, 0 );
  1148. model.change( writer => {
  1149. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1150. } );
  1151. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1152. model.change( writer => {
  1153. writer.removeMarker( 'marker', { range: markerRange, usingOperation: false } );
  1154. } );
  1155. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1156. } );
  1157. } );
  1158. describe( 'on element', () => {
  1159. const highlightDescriptor = {
  1160. classes: 'highlight-class',
  1161. priority: 7,
  1162. attributes: { title: 'title' },
  1163. id: 'customId'
  1164. };
  1165. let markerRange;
  1166. beforeEach( () => {
  1167. // Provide converter for div element. View div element will have custom highlight handling.
  1168. dispatcher.on( 'insert:div', insertElement( () => {
  1169. const viewContainer = new ViewContainerElement( 'div' );
  1170. viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => {
  1171. writer.addClass( descriptor.classes, element );
  1172. } );
  1173. viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => {
  1174. writer.setAttribute( 'class', '', element );
  1175. } );
  1176. return viewContainer;
  1177. } ) );
  1178. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  1179. model.change( writer => {
  1180. writer.insert( modelElement, modelRootStart );
  1181. } );
  1182. markerRange = ModelRange.createOn( modelElement );
  1183. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  1184. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  1185. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  1186. } );
  1187. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  1188. model.change( writer => {
  1189. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1190. } );
  1191. expect( viewToString( viewRoot ) ).to.equal(
  1192. '<div>' +
  1193. '<div class="highlight-class">' +
  1194. 'foo' +
  1195. '</div>' +
  1196. '</div>'
  1197. );
  1198. model.change( writer => {
  1199. writer.removeMarker( 'marker' );
  1200. } );
  1201. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1202. } );
  1203. it( 'should be possible to override', () => {
  1204. const newDescriptor = { classes: 'override-class' };
  1205. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  1206. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  1207. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  1208. model.change( writer => {
  1209. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1210. } );
  1211. expect( viewToString( viewRoot ) ).to.equal(
  1212. '<div>' +
  1213. '<div class="override-class">' +
  1214. 'foo' +
  1215. '</div>' +
  1216. '</div>'
  1217. );
  1218. model.change( writer => {
  1219. writer.removeMarker( 'marker' );
  1220. } );
  1221. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1222. } );
  1223. it( 'should use default priority and id if not provided', () => {
  1224. const viewDiv = viewRoot.getChild( 0 );
  1225. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  1226. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  1227. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  1228. viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  1229. expect( descriptor.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1230. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  1231. } );
  1232. viewDiv._setCustomProperty( 'removeHighlight', ( element, id ) => {
  1233. expect( id ).to.equal( 'marker:foo-bar-baz' );
  1234. } );
  1235. model.change( writer => {
  1236. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  1237. } );
  1238. } );
  1239. it( 'should do nothing if descriptor is not provided', () => {
  1240. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  1241. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  1242. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  1243. model.change( writer => {
  1244. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  1245. } );
  1246. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1247. model.change( writer => {
  1248. writer.removeMarker( 'marker2' );
  1249. } );
  1250. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1251. } );
  1252. } );
  1253. } );
  1254. describe( 'createViewElementFromHighlightDescriptor()', () => {
  1255. it( 'should return attribute element from descriptor object', () => {
  1256. const descriptor = {
  1257. classes: 'foo-class',
  1258. attributes: { one: '1', two: '2' },
  1259. priority: 7,
  1260. };
  1261. const element = createViewElementFromHighlightDescriptor( descriptor );
  1262. expect( element.is( 'attributeElement' ) ).to.be.true;
  1263. expect( element.name ).to.equal( 'span' );
  1264. expect( element.priority ).to.equal( 7 );
  1265. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1266. for ( const key of Object.keys( descriptor.attributes ) ) {
  1267. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1268. }
  1269. } );
  1270. it( 'should return attribute element from descriptor object - array with classes', () => {
  1271. const descriptor = {
  1272. classes: [ 'foo-class', 'bar-class' ],
  1273. attributes: { one: '1', two: '2' },
  1274. priority: 7,
  1275. };
  1276. const element = createViewElementFromHighlightDescriptor( descriptor );
  1277. expect( element.is( 'attributeElement' ) ).to.be.true;
  1278. expect( element.name ).to.equal( 'span' );
  1279. expect( element.priority ).to.equal( 7 );
  1280. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1281. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  1282. for ( const key of Object.keys( descriptor.attributes ) ) {
  1283. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1284. }
  1285. } );
  1286. it( 'should create element without class', () => {
  1287. const descriptor = {
  1288. attributes: { one: '1', two: '2' },
  1289. priority: 7,
  1290. };
  1291. const element = createViewElementFromHighlightDescriptor( descriptor );
  1292. expect( element.is( 'attributeElement' ) ).to.be.true;
  1293. expect( element.name ).to.equal( 'span' );
  1294. expect( element.priority ).to.equal( 7 );
  1295. for ( const key of Object.keys( descriptor.attributes ) ) {
  1296. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1297. }
  1298. } );
  1299. it( 'should create element without priority', () => {
  1300. const descriptor = {
  1301. classes: 'foo-class',
  1302. attributes: { one: '1', two: '2' },
  1303. };
  1304. const element = createViewElementFromHighlightDescriptor( descriptor );
  1305. expect( element.is( 'attributeElement' ) ).to.be.true;
  1306. expect( element.name ).to.equal( 'span' );
  1307. expect( element.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1308. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1309. for ( const key of Object.keys( descriptor.attributes ) ) {
  1310. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1311. }
  1312. } );
  1313. it( 'should create element without attributes', () => {
  1314. const descriptor = {
  1315. classes: 'foo-class',
  1316. priority: 7
  1317. };
  1318. const element = createViewElementFromHighlightDescriptor( descriptor );
  1319. expect( element.is( 'attributeElement' ) ).to.be.true;
  1320. expect( element.name ).to.equal( 'span' );
  1321. expect( element.priority ).to.equal( 7 );
  1322. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1323. } );
  1324. } );
  1325. } );