downcasthelpers.js 55 KB

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