downcast-converters.js 55 KB

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