downcast-converters.js 57 KB

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