downcasthelpers.js 56 KB

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