downcast-converters.js 57 KB

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