8
0

downcasthelpers.js 74 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* globals console */
  6. import EditingController from '../../src/controller/editingcontroller';
  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 ViewDocument from '../../src/view/document';
  16. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  17. import DowncastHelpers, {
  18. clearAttributes,
  19. convertCollapsedSelection,
  20. convertRangeSelection,
  21. createViewElementFromHighlightDescriptor,
  22. insertText
  23. } from '../../src/conversion/downcasthelpers';
  24. import Mapper from '../../src/conversion/mapper';
  25. import DowncastDispatcher from '../../src/conversion/downcastdispatcher';
  26. import { stringify as stringifyView } from '../../src/dev-utils/view';
  27. import View from '../../src/view/view';
  28. import createViewRoot from '../view/_utils/createroot';
  29. import { setData as setModelData } from '../../src/dev-utils/model';
  30. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  31. import { StylesProcessor } from '../../src/view/stylesmap';
  32. import DowncastWriter from '../../src/view/downcastwriter';
  33. describe( 'DowncastHelpers', () => {
  34. let model, modelRoot, viewRoot, downcastHelpers, controller, modelRootStart, stylesProcessor;
  35. beforeEach( () => {
  36. stylesProcessor = new StylesProcessor();
  37. model = new Model();
  38. const modelDoc = model.document;
  39. modelRoot = modelDoc.createRoot();
  40. controller = new EditingController( model, stylesProcessor );
  41. // Set name of view root the same as dom root.
  42. // This is a mock of attaching view root to dom root.
  43. controller.view.document.getRoot()._name = 'div';
  44. viewRoot = controller.view.document.getRoot();
  45. downcastHelpers = new DowncastHelpers( [ controller.downcastDispatcher ] );
  46. modelRootStart = model.createPositionAt( modelRoot, 0 );
  47. } );
  48. describe( 'elementToElement()', () => {
  49. it( 'should be chainable', () => {
  50. expect( downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } ) ).to.equal( downcastHelpers );
  51. } );
  52. it( 'config.view is a string', () => {
  53. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  54. model.change( writer => {
  55. writer.insertElement( 'paragraph', modelRoot, 0 );
  56. } );
  57. expectResult( '<p></p>' );
  58. } );
  59. it( 'can be overwritten using converterPriority', () => {
  60. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  61. downcastHelpers.elementToElement( { model: 'paragraph', view: 'foo', converterPriority: 'high' } );
  62. model.change( writer => {
  63. writer.insertElement( 'paragraph', modelRoot, 0 );
  64. } );
  65. expectResult( '<foo></foo>' );
  66. } );
  67. it( 'config.view is a view element definition', () => {
  68. downcastHelpers.elementToElement( {
  69. model: 'fancyParagraph',
  70. view: {
  71. name: 'p',
  72. classes: 'fancy'
  73. }
  74. } );
  75. model.change( writer => {
  76. writer.insertElement( 'fancyParagraph', modelRoot, 0 );
  77. } );
  78. expectResult( '<p class="fancy"></p>' );
  79. } );
  80. it( 'config.view is a function', () => {
  81. downcastHelpers.elementToElement( {
  82. model: 'heading',
  83. view: ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) )
  84. } );
  85. model.change( writer => {
  86. writer.insertElement( 'heading', { level: 2 }, modelRoot, 0 );
  87. } );
  88. expectResult( '<h2></h2>' );
  89. } );
  90. } );
  91. describe( 'attributeToElement()', () => {
  92. beforeEach( () => {
  93. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  94. } );
  95. it( 'should be chainable', () => {
  96. expect( downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } ) ).to.equal( downcastHelpers );
  97. } );
  98. it( 'config.view is a string', () => {
  99. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  100. model.change( writer => {
  101. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  102. } );
  103. expectResult( '<strong>foo</strong>' );
  104. } );
  105. it( 'can be overwritten using converterPriority', () => {
  106. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  107. downcastHelpers.attributeToElement( { model: 'bold', view: 'b', converterPriority: 'high' } );
  108. model.change( writer => {
  109. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  110. } );
  111. expectResult( '<b>foo</b>' );
  112. } );
  113. it( 'config.view is a view element definition', () => {
  114. downcastHelpers.attributeToElement( {
  115. model: 'invert',
  116. view: {
  117. name: 'span',
  118. classes: [ 'font-light', 'bg-dark' ]
  119. }
  120. } );
  121. model.change( writer => {
  122. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  123. } );
  124. expectResult( '<span class="bg-dark font-light">foo</span>' );
  125. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  126. } );
  127. it( 'config.view allows specifying the element\'s priority', () => {
  128. downcastHelpers.attributeToElement( {
  129. model: 'invert',
  130. view: {
  131. name: 'span',
  132. priority: 5
  133. }
  134. } );
  135. model.change( writer => {
  136. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  137. } );
  138. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  139. } );
  140. it( 'model attribute value is enum', () => {
  141. downcastHelpers.attributeToElement( {
  142. model: {
  143. key: 'fontSize',
  144. values: [ 'big', 'small' ]
  145. },
  146. view: {
  147. big: {
  148. name: 'span',
  149. styles: {
  150. 'font-size': '1.2em'
  151. }
  152. },
  153. small: {
  154. name: 'span',
  155. styles: {
  156. 'font-size': '0.8em'
  157. },
  158. priority: 5
  159. }
  160. }
  161. } );
  162. model.change( writer => {
  163. writer.insertText( 'foo', { fontSize: 'big' }, modelRoot, 0 );
  164. } );
  165. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  166. expectResult( '<span style="font-size:1.2em">foo</span>' );
  167. model.change( writer => {
  168. writer.setAttribute( 'fontSize', 'small', modelRoot.getChild( 0 ) );
  169. } );
  170. expectResult( '<span style="font-size:0.8em">foo</span>' );
  171. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  172. model.change( writer => {
  173. writer.removeAttribute( 'fontSize', modelRoot.getChild( 0 ) );
  174. } );
  175. expectResult( 'foo' );
  176. } );
  177. it( 'config.view is a function', () => {
  178. downcastHelpers.attributeToElement( {
  179. model: 'bold',
  180. view: ( modelAttributeValue, viewWriter ) => {
  181. return viewWriter.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } );
  182. }
  183. } );
  184. model.change( writer => {
  185. writer.insertText( 'foo', { bold: '500' }, modelRoot, 0 );
  186. } );
  187. expectResult( '<span style="font-weight:500">foo</span>' );
  188. } );
  189. it( 'config.model.name is given', () => {
  190. downcastHelpers.attributeToElement( {
  191. model: {
  192. key: 'color',
  193. name: '$text'
  194. },
  195. view: ( modelAttributeValue, viewWriter ) => {
  196. return viewWriter.createAttributeElement( 'span', { style: 'color:' + modelAttributeValue } );
  197. }
  198. } );
  199. downcastHelpers.elementToElement( {
  200. model: 'smiley',
  201. view: ( modelElement, viewWriter ) => {
  202. return viewWriter.createEmptyElement( 'img', {
  203. src: 'smile.jpg',
  204. class: 'smiley'
  205. } );
  206. }
  207. } );
  208. model.change( writer => {
  209. writer.insertText( 'foo', { color: '#FF0000' }, modelRoot, 0 );
  210. writer.insertElement( 'smiley', { color: '#FF0000' }, modelRoot, 3 );
  211. } );
  212. expectResult( '<span style="color:#FF0000">foo</span><img class="smiley" src="smile.jpg"></img>' );
  213. } );
  214. it( 'should not convert if creator returned null', () => {
  215. downcastHelpers.elementToElement( { model: 'div', view: () => null } );
  216. const modelElement = new ModelElement( 'div' );
  217. model.change( writer => {
  218. writer.insert( modelElement, modelRootStart );
  219. } );
  220. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  221. } );
  222. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  223. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  224. downcastHelpers.attributeToElement( {
  225. model: 'bold',
  226. view: ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' )
  227. } );
  228. model.change( writer => {
  229. writer.insert( modelElement, modelRootStart );
  230. } );
  231. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  232. model.change( writer => {
  233. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  234. } );
  235. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  236. } );
  237. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  238. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  239. downcastHelpers.attributeToElement( {
  240. model: 'style',
  241. view: ( modelAttributeValue, viewWriter ) => {
  242. if ( modelAttributeValue == 'bold' ) {
  243. return viewWriter.createAttributeElement( 'b' );
  244. }
  245. }
  246. } );
  247. model.change( writer => {
  248. writer.insert( modelElement, modelRootStart );
  249. } );
  250. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  251. model.change( writer => {
  252. writer.removeAttribute( 'style', writer.createRangeIn( modelElement ) );
  253. } );
  254. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  255. } );
  256. it( 'should update range on re-wrapping attribute (#475)', () => {
  257. const modelElement = new ModelElement( 'paragraph', null, [
  258. new ModelText( 'x' ),
  259. new ModelText( 'foo', { link: 'http://foo.com' } ),
  260. new ModelText( 'x' )
  261. ] );
  262. downcastHelpers.attributeToElement( {
  263. model: 'link',
  264. view: ( modelAttributeValue, viewWriter ) => {
  265. return viewWriter.createAttributeElement( 'a', { href: modelAttributeValue } );
  266. }
  267. } );
  268. model.change( writer => {
  269. writer.insert( modelElement, modelRootStart );
  270. } );
  271. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  272. // Set new attribute on old link but also on non-linked characters.
  273. model.change( writer => {
  274. writer.setAttribute( 'link', 'http://foobar.com', writer.createRangeIn( modelElement ) );
  275. } );
  276. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  277. } );
  278. it( 'should support unicode', () => {
  279. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  280. downcastHelpers.attributeToElement( {
  281. model: 'bold',
  282. view: ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' )
  283. } );
  284. model.change( writer => {
  285. writer.insert( modelElement, modelRootStart );
  286. } );
  287. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  288. model.change( writer => {
  289. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  290. } );
  291. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  292. } );
  293. it( 'should be possible to override ', () => {
  294. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  295. downcastHelpers.attributeToElement( {
  296. model: 'bold',
  297. view: ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' )
  298. } );
  299. downcastHelpers.attributeToElement( {
  300. model: 'bold',
  301. view: ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' ),
  302. converterPriority: 'high'
  303. } );
  304. model.change( writer => {
  305. writer.insert( modelElement, modelRootStart );
  306. } );
  307. expect( viewToString( viewRoot ) ).to.equal( '<div><p><strong>foobar</strong></p></div>' );
  308. } );
  309. it( 'should not convert and not consume if creator function returned null', () => {
  310. sinon.spy( controller.downcastDispatcher, 'fire' );
  311. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  312. downcastHelpers.attributeToElement( {
  313. model: 'italic',
  314. view: () => null
  315. } );
  316. const spy = sinon.spy();
  317. controller.downcastDispatcher.on( 'attribute:italic', spy );
  318. model.change( writer => {
  319. writer.insert( modelElement, modelRootStart );
  320. } );
  321. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  322. expect( controller.downcastDispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  323. expect( spy.called ).to.be.true;
  324. } );
  325. } );
  326. describe( 'attributeToAttribute()', () => {
  327. testUtils.createSinonSandbox();
  328. beforeEach( () => {
  329. downcastHelpers.elementToElement( { model: 'image', view: 'img' } );
  330. downcastHelpers.elementToElement( {
  331. model: 'paragraph',
  332. view: ( modelItem, viewWriter ) => viewWriter.createContainerElement( 'p' )
  333. } );
  334. downcastHelpers.attributeToAttribute( {
  335. model: 'class',
  336. view: 'class'
  337. } );
  338. } );
  339. it( 'should be chainable', () => {
  340. expect( downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } ) ).to.equal( downcastHelpers );
  341. } );
  342. it( 'config.view is a string', () => {
  343. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } );
  344. model.change( writer => {
  345. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  346. } );
  347. expectResult( '<img src="foo.jpg"></img>' );
  348. model.change( writer => {
  349. writer.removeAttribute( 'source', modelRoot.getChild( 0 ) );
  350. } );
  351. expectResult( '<img></img>' );
  352. } );
  353. it( 'can be overwritten using converterPriority', () => {
  354. downcastHelpers.attributeToAttribute( { model: 'source', view: 'href' } );
  355. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src', converterPriority: 'high' } );
  356. model.change( writer => {
  357. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  358. } );
  359. expectResult( '<img src="foo.jpg"></img>' );
  360. } );
  361. it( 'model element name specified', () => {
  362. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  363. downcastHelpers.attributeToAttribute( {
  364. model: {
  365. name: 'image',
  366. key: 'source'
  367. },
  368. view: 'src'
  369. } );
  370. model.change( writer => {
  371. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  372. } );
  373. expectResult( '<img src="foo.jpg"></img>' );
  374. model.change( writer => {
  375. writer.rename( modelRoot.getChild( 0 ), 'paragraph' );
  376. } );
  377. expectResult( '<p></p>' );
  378. } );
  379. it( 'config.view is an object, model attribute value is enum', () => {
  380. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  381. downcastHelpers.attributeToAttribute( {
  382. model: {
  383. key: 'styled',
  384. values: [ 'dark', 'light' ]
  385. },
  386. view: {
  387. dark: {
  388. key: 'class',
  389. value: [ 'styled', 'styled-dark' ]
  390. },
  391. light: {
  392. key: 'class',
  393. value: [ 'styled', 'styled-light' ]
  394. }
  395. }
  396. } );
  397. model.change( writer => {
  398. writer.insertElement( 'paragraph', { styled: 'dark' }, modelRoot, 0 );
  399. } );
  400. expectResult( '<p class="styled styled-dark"></p>' );
  401. model.change( writer => {
  402. writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) );
  403. } );
  404. expectResult( '<p class="styled styled-light"></p>' );
  405. model.change( writer => {
  406. writer.removeAttribute( 'styled', modelRoot.getChild( 0 ) );
  407. } );
  408. expectResult( '<p></p>' );
  409. } );
  410. it( 'config.view is an object, model attribute value is enum, view has style', () => {
  411. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  412. downcastHelpers.attributeToAttribute( {
  413. model: {
  414. key: 'align',
  415. values: [ 'right', 'center' ]
  416. },
  417. view: {
  418. right: {
  419. key: 'style',
  420. value: {
  421. 'text-align': 'right'
  422. }
  423. },
  424. center: {
  425. key: 'style',
  426. value: {
  427. 'text-align': 'center'
  428. }
  429. }
  430. }
  431. } );
  432. model.change( writer => {
  433. writer.insertElement( 'paragraph', { align: 'right' }, modelRoot, 0 );
  434. } );
  435. expectResult( '<p style="text-align:right"></p>' );
  436. model.change( writer => {
  437. writer.setAttribute( 'align', 'center', modelRoot.getChild( 0 ) );
  438. } );
  439. expectResult( '<p style="text-align:center"></p>' );
  440. model.change( writer => {
  441. writer.removeAttribute( 'align', modelRoot.getChild( 0 ) );
  442. } );
  443. expectResult( '<p></p>' );
  444. } );
  445. it( 'config.view is an object, only name and key are provided', () => {
  446. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  447. downcastHelpers.attributeToAttribute( {
  448. model: {
  449. name: 'paragraph',
  450. key: 'class'
  451. },
  452. view: {
  453. name: 'paragraph',
  454. key: 'class'
  455. }
  456. } );
  457. model.change( writer => {
  458. writer.insertElement( 'paragraph', { class: 'dark' }, modelRoot, 0 );
  459. } );
  460. expectResult( '<p class="dark"></p>' );
  461. model.change( writer => {
  462. writer.setAttribute( 'class', 'light', modelRoot.getChild( 0 ) );
  463. } );
  464. expectResult( '<p class="light"></p>' );
  465. model.change( writer => {
  466. writer.removeAttribute( 'class', modelRoot.getChild( 0 ) );
  467. } );
  468. expectResult( '<p></p>' );
  469. } );
  470. it( 'config.view is a function', () => {
  471. downcastHelpers.attributeToAttribute( {
  472. model: 'styled',
  473. view: attributeValue => ( { key: 'class', value: 'styled-' + attributeValue } )
  474. } );
  475. model.change( writer => {
  476. writer.insertElement( 'image', { styled: 'pull-out' }, modelRoot, 0 );
  477. } );
  478. expectResult( '<img class="styled-pull-out"></img>' );
  479. } );
  480. // #1587
  481. it( 'config.view and config.model as strings in generic conversion (elements only)', () => {
  482. const consoleWarnStub = testUtils.sinon.stub( console, 'warn' );
  483. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  484. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  485. model.change( writer => {
  486. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 0 );
  487. writer.insertElement( 'paragraph', { test: '2' }, modelRoot, 1 );
  488. } );
  489. expectResult( '<p test="1"></p><p test="2"></p>' );
  490. expect( consoleWarnStub.callCount ).to.equal( 0 );
  491. model.change( writer => {
  492. writer.removeAttribute( 'test', modelRoot.getChild( 1 ) );
  493. } );
  494. expectResult( '<p test="1"></p><p></p>' );
  495. } );
  496. // #1587
  497. it( 'config.view and config.model as strings in generic conversion (elements + text)', () => {
  498. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  499. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  500. expectToThrowCKEditorError( () => {
  501. model.change( writer => {
  502. writer.insertElement( 'paragraph', modelRoot, 0 );
  503. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 1 );
  504. writer.insertText( 'Foo', { test: '2' }, modelRoot.getChild( 0 ), 0 );
  505. writer.insertText( 'Bar', { test: '3' }, modelRoot.getChild( 1 ), 0 );
  506. } );
  507. }, /^conversion-attribute-to-attribute-on-text/ );
  508. } );
  509. it( 'should convert attribute insert/change/remove on a model node', () => {
  510. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  511. model.change( writer => {
  512. writer.insert( modelElement, modelRootStart );
  513. } );
  514. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  515. model.change( writer => {
  516. writer.setAttribute( 'class', 'bar', modelElement );
  517. } );
  518. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  519. model.change( writer => {
  520. writer.removeAttribute( 'class', modelElement );
  521. } );
  522. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  523. } );
  524. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  525. downcastHelpers.elementToElement( { model: 'div', view: 'div' } );
  526. downcastHelpers.attributeToAttribute( {
  527. model: 'theme',
  528. view: ( value, data ) => {
  529. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  530. value += ' fix-content';
  531. }
  532. return { key: 'class', value };
  533. }
  534. } );
  535. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  536. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  537. model.change( writer => {
  538. writer.insert( [ modelParagraph, modelDiv ], modelRootStart );
  539. } );
  540. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  541. model.change( writer => {
  542. writer.setAttribute( 'theme', 'awesome', modelParagraph );
  543. } );
  544. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  545. model.change( writer => {
  546. writer.removeAttribute( 'theme', modelParagraph );
  547. } );
  548. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  549. } );
  550. it( 'should be possible to override setAttribute', () => {
  551. downcastHelpers.attributeToAttribute( {
  552. model: 'class',
  553. view: ( evt, data, conversionApi ) => {
  554. conversionApi.consumable.consume( data.item, 'attribute:class' );
  555. },
  556. converterPriority: 'high'
  557. } );
  558. model.change( writer => {
  559. const modelElement = new ModelElement( 'paragraph', { classes: 'foo' }, new ModelText( 'foobar' ) );
  560. writer.insert( modelElement, modelRootStart );
  561. } );
  562. // No attribute set.
  563. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  564. } );
  565. it( 'should not convert or consume if element creator returned null', () => {
  566. const callback = sinon.stub().returns( null );
  567. downcastHelpers.attributeToAttribute( {
  568. model: 'class',
  569. view: callback,
  570. converterPriority: 'high'
  571. } );
  572. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  573. model.change( writer => {
  574. writer.insert( modelElement, modelRootStart );
  575. } );
  576. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  577. sinon.assert.called( callback );
  578. } );
  579. } );
  580. describe( 'markerToElement()', () => {
  581. let modelText, modelElement, range;
  582. it( 'should be chainable', () => {
  583. expect( downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } ) ).to.equal( downcastHelpers );
  584. } );
  585. it( 'config.view is a string', () => {
  586. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  587. model.change( writer => {
  588. writer.insertText( 'foo', modelRoot, 0 );
  589. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  590. writer.addMarker( 'search', { range, usingOperation: false } );
  591. } );
  592. expectResult( 'f<marker-search></marker-search>o<marker-search></marker-search>o' );
  593. } );
  594. it( 'can be overwritten using converterPriority', () => {
  595. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  596. downcastHelpers.markerToElement( { model: 'search', view: 'search', converterPriority: 'high' } );
  597. model.change( writer => {
  598. writer.insertText( 'foo', modelRoot, 0 );
  599. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  600. writer.addMarker( 'search', { range, usingOperation: false } );
  601. } );
  602. expectResult( 'f<search></search>o<search></search>o' );
  603. } );
  604. it( 'config.view is a view element definition', () => {
  605. downcastHelpers.markerToElement( {
  606. model: 'search',
  607. view: {
  608. name: 'span',
  609. attributes: {
  610. 'data-marker': 'search'
  611. }
  612. }
  613. } );
  614. model.change( writer => {
  615. writer.insertText( 'foo', modelRoot, 0 );
  616. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  617. writer.addMarker( 'search', { range, usingOperation: false } );
  618. } );
  619. expectResult( 'f<span data-marker="search"></span>o<span data-marker="search"></span>o' );
  620. } );
  621. it( 'config.view is a function', () => {
  622. downcastHelpers.markerToElement( {
  623. model: 'search',
  624. view: ( data, viewWriter ) => {
  625. return viewWriter.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } );
  626. }
  627. } );
  628. model.change( writer => {
  629. writer.insertText( 'foo', modelRoot, 0 );
  630. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  631. writer.addMarker( 'search', { range, usingOperation: false } );
  632. } );
  633. expectResult( 'f<span data-marker="search" data-start="true"></span>o<span data-marker="search" data-start="false"></span>o' );
  634. } );
  635. describe( 'collapsed range', () => {
  636. beforeEach( () => {
  637. modelText = new ModelText( 'foobar' );
  638. modelElement = new ModelElement( 'paragraph', null, modelText );
  639. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  640. model.change( writer => {
  641. writer.insert( modelElement, modelRootStart );
  642. } );
  643. range = model.createRange( model.createPositionAt( modelElement, 3 ), model.createPositionAt( modelElement, 3 ) );
  644. } );
  645. it( 'should insert and remove ui element', () => {
  646. downcastHelpers.markerToElement( {
  647. model: 'marker',
  648. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } )
  649. } );
  650. model.change( writer => {
  651. writer.addMarker( 'marker', { range, usingOperation: false } );
  652. } );
  653. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  654. model.change( writer => {
  655. writer.removeMarker( 'marker' );
  656. } );
  657. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  658. } );
  659. it( 'should not convert if consumable was consumed', () => {
  660. sinon.spy( controller.downcastDispatcher, 'fire' );
  661. downcastHelpers.markerToElement( {
  662. model: 'marker',
  663. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } )
  664. } );
  665. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  666. conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
  667. }, { priority: 'high' } );
  668. model.change( writer => {
  669. writer.addMarker( 'marker', { range, usingOperation: false } );
  670. } );
  671. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  672. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  673. } );
  674. it( 'should not convert if creator returned null', () => {
  675. downcastHelpers.markerToElement( {
  676. model: 'marker',
  677. view: () => null
  678. } );
  679. model.change( writer => {
  680. writer.addMarker( 'marker', { range, usingOperation: false } );
  681. } );
  682. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  683. model.change( writer => {
  684. writer.removeMarker( 'marker' );
  685. } );
  686. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  687. } );
  688. } );
  689. describe( 'non-collapsed range', () => {
  690. beforeEach( () => {
  691. modelText = new ModelText( 'foobar' );
  692. modelElement = new ModelElement( 'paragraph', null, modelText );
  693. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  694. model.change( writer => {
  695. writer.insert( modelElement, modelRootStart );
  696. } );
  697. range = model.createRange( model.createPositionAt( modelElement, 2 ), model.createPositionAt( modelElement, 5 ) );
  698. } );
  699. it( 'should insert and remove ui element - element as a creator', () => {
  700. downcastHelpers.markerToElement( {
  701. model: 'marker',
  702. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } )
  703. } );
  704. model.change( writer => {
  705. writer.addMarker( 'marker', { range, usingOperation: false } );
  706. } );
  707. expect( viewToString( viewRoot ) )
  708. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  709. model.change( writer => {
  710. writer.removeMarker( 'marker' );
  711. } );
  712. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  713. } );
  714. it( 'should insert and remove ui element - function as a creator', () => {
  715. downcastHelpers.markerToElement( {
  716. model: 'marker',
  717. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': data.markerName } )
  718. } );
  719. model.change( writer => {
  720. writer.addMarker( 'marker', { range, usingOperation: false } );
  721. } );
  722. expect( viewToString( viewRoot ) )
  723. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  724. model.change( writer => {
  725. writer.removeMarker( 'marker' );
  726. } );
  727. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  728. } );
  729. it( 'should insert and remove different opening and ending element', () => {
  730. downcastHelpers.markerToElement( {
  731. model: 'marker',
  732. view: ( data, viewWriter ) => {
  733. if ( data.isOpening ) {
  734. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  735. }
  736. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  737. }
  738. } );
  739. model.change( writer => {
  740. writer.addMarker( 'marker', { range, usingOperation: false } );
  741. } );
  742. expect( viewToString( viewRoot ) ).to.equal(
  743. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  744. );
  745. model.change( writer => {
  746. writer.removeMarker( 'marker' );
  747. } );
  748. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  749. } );
  750. it( 'should not convert if consumable was consumed', () => {
  751. sinon.spy( controller.downcastDispatcher, 'fire' );
  752. downcastHelpers.markerToElement( {
  753. model: 'marker',
  754. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } )
  755. } );
  756. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  757. conversionApi.consumable.consume( data.item, 'addMarker:marker' );
  758. }, { priority: 'high' } );
  759. model.change( writer => {
  760. writer.addMarker( 'marker', { range, usingOperation: false } );
  761. } );
  762. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  763. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  764. } );
  765. } );
  766. } );
  767. describe( 'markerToHighlight()', () => {
  768. it( 'should be chainable', () => {
  769. expect( downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } ) ).to.equal( downcastHelpers );
  770. } );
  771. it( 'config.view is a highlight descriptor', () => {
  772. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  773. model.change( writer => {
  774. writer.insertText( 'foo', modelRoot, 0 );
  775. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  776. writer.addMarker( 'comment', { range, usingOperation: false } );
  777. } );
  778. expectResult( '<span class="comment">foo</span>' );
  779. } );
  780. it( 'can be overwritten using converterPriority', () => {
  781. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  782. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'new-comment' }, converterPriority: 'high' } );
  783. model.change( writer => {
  784. writer.insertText( 'foo', modelRoot, 0 );
  785. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  786. writer.addMarker( 'comment', { range, usingOperation: false } );
  787. } );
  788. expectResult( '<span class="new-comment">foo</span>' );
  789. } );
  790. it( 'config.view is a function', () => {
  791. downcastHelpers.markerToHighlight( {
  792. model: 'comment',
  793. view: data => {
  794. const commentType = data.markerName.split( ':' )[ 1 ];
  795. return {
  796. classes: [ 'comment', 'comment-' + commentType ]
  797. };
  798. }
  799. } );
  800. model.change( writer => {
  801. writer.insertText( 'foo', modelRoot, 0 );
  802. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  803. writer.addMarker( 'comment:abc', { range, usingOperation: false } );
  804. } );
  805. expectResult( '<span class="comment comment-abc">foo</span>' );
  806. } );
  807. describe( 'highlight', () => {
  808. const highlightConfig = {
  809. model: 'marker',
  810. view: {
  811. classes: 'highlight-class',
  812. attributes: { title: 'title' }
  813. },
  814. converterPriority: 7
  815. };
  816. describe( 'on text', () => {
  817. let markerRange;
  818. beforeEach( () => {
  819. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  820. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  821. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  822. model.change( writer => {
  823. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  824. } );
  825. markerRange = model.createRangeIn( modelRoot );
  826. } );
  827. it( 'should wrap and unwrap text nodes', () => {
  828. downcastHelpers.markerToHighlight( highlightConfig );
  829. model.change( writer => {
  830. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  831. } );
  832. expect( viewToString( viewRoot ) ).to.equal(
  833. '<div>' +
  834. '<p>' +
  835. '<span class="highlight-class" title="title">foo</span>' +
  836. '</p>' +
  837. '<p>' +
  838. '<span class="highlight-class" title="title">bar</span>' +
  839. '</p>' +
  840. '</div>'
  841. );
  842. model.change( writer => {
  843. writer.removeMarker( 'marker' );
  844. } );
  845. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  846. } );
  847. it( 'should be possible to overwrite', () => {
  848. downcastHelpers.markerToHighlight( highlightConfig );
  849. downcastHelpers.markerToHighlight( {
  850. model: 'marker',
  851. view: { classes: 'override-class' },
  852. converterPriority: 'high'
  853. } );
  854. model.change( writer => {
  855. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  856. } );
  857. expect( viewToString( viewRoot ) ).to.equal(
  858. '<div>' +
  859. '<p>' +
  860. '<span class="override-class">foo</span>' +
  861. '</p>' +
  862. '<p>' +
  863. '<span class="override-class">bar</span>' +
  864. '</p>' +
  865. '</div>'
  866. );
  867. model.change( writer => {
  868. writer.removeMarker( 'marker' );
  869. } );
  870. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  871. } );
  872. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  873. downcastHelpers.markerToHighlight( {
  874. model: 'marker',
  875. view: () => null,
  876. converterPriority: 'high'
  877. } );
  878. model.change( writer => {
  879. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  880. } );
  881. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  882. model.change( writer => {
  883. writer.removeMarker( 'marker' );
  884. } );
  885. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  886. } );
  887. it( 'should do nothing if collapsed marker is converted', () => {
  888. downcastHelpers.markerToHighlight( {
  889. model: 'marker',
  890. view: { classes: 'foo' },
  891. converterPriority: 'high'
  892. } );
  893. markerRange = model.createRange( model.createPositionAt( modelRoot, 0 ), model.createPositionAt( modelRoot, 0 ) );
  894. model.change( writer => {
  895. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  896. } );
  897. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  898. model.change( () => {
  899. model.markers._remove( 'marker' );
  900. } );
  901. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  902. } );
  903. it( 'should correctly wrap and unwrap multiple, intersecting markers', () => {
  904. downcastHelpers.markerToHighlight( {
  905. model: 'markerFoo',
  906. view: { classes: 'foo' }
  907. } );
  908. downcastHelpers.markerToHighlight( {
  909. model: 'markerBar',
  910. view: { classes: 'bar' }
  911. } );
  912. downcastHelpers.markerToHighlight( {
  913. model: 'markerXyz',
  914. view: { classes: 'xyz' }
  915. } );
  916. const p1 = modelRoot.getChild( 0 );
  917. const p2 = modelRoot.getChild( 1 );
  918. model.change( writer => {
  919. const range = writer.createRange( writer.createPositionAt( p1, 0 ), writer.createPositionAt( p1, 3 ) );
  920. writer.addMarker( 'markerFoo', { range, usingOperation: false } );
  921. } );
  922. expect( viewToString( viewRoot ) ).to.equal(
  923. '<div>' +
  924. '<p>' +
  925. '<span class="foo">foo</span>' +
  926. '</p>' +
  927. '<p>bar</p>' +
  928. '</div>'
  929. );
  930. model.change( writer => {
  931. const range = writer.createRange( writer.createPositionAt( p1, 1 ), writer.createPositionAt( p2, 2 ) );
  932. writer.addMarker( 'markerBar', { range, usingOperation: false } );
  933. } );
  934. expect( viewToString( viewRoot ) ).to.equal(
  935. '<div>' +
  936. '<p>' +
  937. '<span class="foo">f</span>' +
  938. '<span class="bar">' +
  939. '<span class="foo">oo</span>' +
  940. '</span>' +
  941. '</p>' +
  942. '<p>' +
  943. '<span class="bar">ba</span>' +
  944. 'r' +
  945. '</p>' +
  946. '</div>'
  947. );
  948. model.change( writer => {
  949. const range = writer.createRange( writer.createPositionAt( p1, 2 ), writer.createPositionAt( p2, 3 ) );
  950. writer.addMarker( 'markerXyz', { range, usingOperation: false } );
  951. } );
  952. expect( viewToString( viewRoot ) ).to.equal(
  953. '<div>' +
  954. '<p>' +
  955. '<span class="foo">f</span>' +
  956. '<span class="bar">' +
  957. '<span class="foo">' +
  958. 'o' +
  959. '<span class="xyz">o</span>' +
  960. '</span>' +
  961. '</span>' +
  962. '</p>' +
  963. '<p>' +
  964. '<span class="bar">' +
  965. '<span class="xyz">ba</span>' +
  966. '</span>' +
  967. '<span class="xyz">r</span>' +
  968. '</p>' +
  969. '</div>'
  970. );
  971. model.change( writer => {
  972. writer.removeMarker( 'markerBar' );
  973. } );
  974. expect( viewToString( viewRoot ) ).to.equal(
  975. '<div>' +
  976. '<p>' +
  977. '<span class="foo">' +
  978. 'fo' +
  979. '<span class="xyz">o</span>' +
  980. '</span>' +
  981. '</p>' +
  982. '<p>' +
  983. '<span class="xyz">bar</span>' +
  984. '</p>' +
  985. '</div>'
  986. );
  987. model.change( writer => {
  988. writer.removeMarker( 'markerFoo' );
  989. } );
  990. expect( viewToString( viewRoot ) ).to.equal(
  991. '<div>' +
  992. '<p>' +
  993. 'fo' +
  994. '<span class="xyz">o</span>' +
  995. '</p>' +
  996. '<p>' +
  997. '<span class="xyz">bar</span>' +
  998. '</p>' +
  999. '</div>'
  1000. );
  1001. model.change( writer => {
  1002. writer.removeMarker( 'markerXyz' );
  1003. } );
  1004. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1005. } );
  1006. it( 'should do nothing if marker is applied and removed on empty-ish range', () => {
  1007. downcastHelpers.markerToHighlight( highlightConfig );
  1008. const p1 = modelRoot.getChild( 0 );
  1009. const p2 = modelRoot.getChild( 1 );
  1010. const markerRange = model.createRange( model.createPositionAt( p1, 3 ), model.createPositionAt( p2, 0 ) );
  1011. model.change( writer => {
  1012. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1013. } );
  1014. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1015. model.change( writer => {
  1016. writer.removeMarker( 'marker', { range: markerRange, usingOperation: false } );
  1017. } );
  1018. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1019. } );
  1020. } );
  1021. describe( 'on element', () => {
  1022. const highlightConfig = {
  1023. model: 'marker',
  1024. view: {
  1025. classes: 'highlight-class',
  1026. attributes: { title: 'title' },
  1027. id: 'customId'
  1028. },
  1029. converterPriority: 7
  1030. };
  1031. let markerRange, viewDocument;
  1032. beforeEach( () => {
  1033. viewDocument = new ViewDocument( stylesProcessor );
  1034. downcastHelpers.elementToElement( {
  1035. model: 'div',
  1036. view: () => {
  1037. const viewContainer = new ViewContainerElement( viewDocument, 'div' );
  1038. viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => {
  1039. writer.addClass( descriptor.classes, element );
  1040. } );
  1041. viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => {
  1042. writer.setAttribute( 'class', '', element );
  1043. } );
  1044. return viewContainer;
  1045. }
  1046. } );
  1047. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  1048. model.change( writer => {
  1049. writer.insert( modelElement, modelRootStart );
  1050. } );
  1051. markerRange = model.createRangeOn( modelElement );
  1052. downcastHelpers.markerToHighlight( highlightConfig );
  1053. } );
  1054. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  1055. model.change( writer => {
  1056. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1057. } );
  1058. expect( viewToString( viewRoot ) ).to.equal(
  1059. '<div>' +
  1060. '<div class="highlight-class">' +
  1061. 'foo' +
  1062. '</div>' +
  1063. '</div>'
  1064. );
  1065. model.change( writer => {
  1066. writer.removeMarker( 'marker' );
  1067. } );
  1068. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1069. } );
  1070. it( 'should be possible to override', () => {
  1071. downcastHelpers.markerToHighlight( {
  1072. model: 'marker',
  1073. view: { classes: 'override-class' },
  1074. converterPriority: 'high'
  1075. } );
  1076. model.change( writer => {
  1077. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1078. } );
  1079. expect( viewToString( viewRoot ) ).to.equal(
  1080. '<div>' +
  1081. '<div class="override-class">' +
  1082. 'foo' +
  1083. '</div>' +
  1084. '</div>'
  1085. );
  1086. model.change( writer => {
  1087. writer.removeMarker( 'marker' );
  1088. } );
  1089. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1090. } );
  1091. it( 'should use default priority and id if not provided', () => {
  1092. const viewDiv = viewRoot.getChild( 0 );
  1093. downcastHelpers.markerToHighlight( {
  1094. model: 'marker2',
  1095. view: () => null,
  1096. converterPriority: 'high'
  1097. } );
  1098. viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  1099. expect( descriptor.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1100. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  1101. } );
  1102. viewDiv._setCustomProperty( 'removeHighlight', ( element, id ) => {
  1103. expect( id ).to.equal( 'marker:foo-bar-baz' );
  1104. } );
  1105. model.change( writer => {
  1106. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  1107. } );
  1108. } );
  1109. it( 'should do nothing if descriptor is not provided', () => {
  1110. downcastHelpers.markerToHighlight( {
  1111. model: 'marker2',
  1112. view: () => null
  1113. } );
  1114. model.change( writer => {
  1115. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  1116. } );
  1117. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1118. model.change( writer => {
  1119. writer.removeMarker( 'marker2' );
  1120. } );
  1121. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1122. } );
  1123. } );
  1124. } );
  1125. } );
  1126. function expectResult( string ) {
  1127. expect( stringifyView( viewRoot, null, { ignoreRoot: true } ) ).to.equal( string );
  1128. }
  1129. } );
  1130. describe( 'downcast converters', () => {
  1131. let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model, stylesProcessor;
  1132. beforeEach( () => {
  1133. stylesProcessor = new StylesProcessor();
  1134. model = new Model();
  1135. modelDoc = model.document;
  1136. modelRoot = modelDoc.createRoot();
  1137. controller = new EditingController( model, stylesProcessor );
  1138. viewRoot = controller.view.document.getRoot();
  1139. // Set name of view root the same as dom root.
  1140. // This is a mock of attaching view root to dom root.
  1141. controller.view.document.getRoot()._name = 'div';
  1142. dispatcher = controller.downcastDispatcher;
  1143. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1144. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1145. modelRootStart = model.createPositionAt( modelRoot, 0 );
  1146. } );
  1147. describe( 'insertText()', () => {
  1148. it( 'should downcast text', () => {
  1149. model.change( writer => {
  1150. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  1151. } );
  1152. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  1153. } );
  1154. it( 'should support unicode', () => {
  1155. model.change( writer => {
  1156. writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
  1157. } );
  1158. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  1159. } );
  1160. it( 'should be possible to override it', () => {
  1161. dispatcher.on( 'insert:$text', ( evt, data, conversionApi ) => {
  1162. conversionApi.consumable.consume( data.item, 'insert' );
  1163. }, { converterPriority: 'high' } );
  1164. model.change( writer => {
  1165. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  1166. } );
  1167. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  1168. } );
  1169. } );
  1170. // Remove converter is by default already added in `EditingController` instance.
  1171. describe( 'remove()', () => {
  1172. let viewDocument;
  1173. beforeEach( () => {
  1174. viewDocument = new ViewDocument( stylesProcessor );
  1175. } );
  1176. it( 'should remove items from view accordingly to changes in model #1', () => {
  1177. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  1178. model.change( writer => {
  1179. writer.insert( modelElement, modelRootStart );
  1180. } );
  1181. model.change( writer => {
  1182. writer.remove(
  1183. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  1184. );
  1185. } );
  1186. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  1187. } );
  1188. it( 'should be possible to overwrite', () => {
  1189. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  1190. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  1191. model.change( writer => {
  1192. writer.insert( modelElement, modelRootStart );
  1193. } );
  1194. model.change( writer => {
  1195. writer.remove(
  1196. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  1197. );
  1198. } );
  1199. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1200. } );
  1201. it( 'should support unicode', () => {
  1202. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  1203. model.change( writer => {
  1204. writer.insert( modelElement, modelRootStart );
  1205. } );
  1206. model.change( writer => {
  1207. writer.remove(
  1208. writer.createRange( writer.createPositionAt( modelElement, 0 ), writer.createPositionAt( modelElement, 6 ) )
  1209. );
  1210. } );
  1211. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  1212. } );
  1213. it( 'should not remove view ui elements that are placed next to removed content', () => {
  1214. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  1215. viewRoot._appendChild( [
  1216. new ViewText( viewDocument, 'foz' ),
  1217. new ViewUIElement( viewDocument, 'span' ),
  1218. new ViewText( viewDocument, 'bar' )
  1219. ] );
  1220. // Remove 'b'.
  1221. model.change( writer => {
  1222. writer.remove(
  1223. writer.createRange( writer.createPositionAt( modelRoot, 3 ), writer.createPositionAt( modelRoot, 4 ) )
  1224. );
  1225. } );
  1226. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  1227. // Remove 'z'.
  1228. model.change( writer => {
  1229. writer.remove(
  1230. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 3 ) )
  1231. );
  1232. } );
  1233. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  1234. } );
  1235. it( 'should remove correct amount of text when it is split by view ui element', () => {
  1236. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  1237. viewRoot._appendChild( [
  1238. new ViewText( viewDocument, 'foz' ),
  1239. new ViewUIElement( viewDocument, 'span' ),
  1240. new ViewText( viewDocument, 'bar' )
  1241. ] );
  1242. // Remove 'z<span></span>b'.
  1243. model.change( writer => {
  1244. writer.remove(
  1245. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 4 ) )
  1246. );
  1247. } );
  1248. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  1249. } );
  1250. it( 'should unbind elements', () => {
  1251. const modelElement = new ModelElement( 'paragraph' );
  1252. model.change( writer => {
  1253. writer.insert( modelElement, modelRootStart );
  1254. } );
  1255. const viewElement = controller.mapper.toViewElement( modelElement );
  1256. expect( viewElement ).not.to.be.undefined;
  1257. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  1258. model.change( writer => {
  1259. writer.remove( modelElement );
  1260. } );
  1261. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  1262. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  1263. } );
  1264. it( 'should not break when remove() is used as part of unwrapping', () => {
  1265. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  1266. const modelWidget = new ModelElement( 'widget', null, modelP );
  1267. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1268. downcastHelpers.elementToElement( { model: 'widget', view: 'widget' } );
  1269. model.change( writer => {
  1270. writer.insert( modelWidget, modelRootStart );
  1271. } );
  1272. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  1273. const viewP = controller.mapper.toViewElement( modelP );
  1274. expect( viewP ).not.to.be.undefined;
  1275. model.change( writer => {
  1276. writer.unwrap( modelWidget );
  1277. } );
  1278. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  1279. // `modelP` is now bound with newly created view element.
  1280. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  1281. // `viewP` is no longer bound with model element.
  1282. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  1283. // View element from view root is bound to `modelP`.
  1284. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  1285. } );
  1286. it( 'should work correctly if container element after ui element is removed', () => {
  1287. // Prepare a model and view structure.
  1288. // This is done outside of conversion to put view ui elements inside easily.
  1289. const modelP1 = new ModelElement( 'paragraph' );
  1290. const modelP2 = new ModelElement( 'paragraph' );
  1291. const viewP1 = new ViewContainerElement( viewDocument, 'p' );
  1292. const viewUi1 = new ViewUIElement( viewDocument, 'span' );
  1293. const viewUi2 = new ViewUIElement( viewDocument, 'span' );
  1294. const viewP2 = new ViewContainerElement( viewDocument, 'p' );
  1295. modelRoot._appendChild( [ modelP1, modelP2 ] );
  1296. viewRoot._appendChild( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  1297. controller.mapper.bindElements( modelP1, viewP1 );
  1298. controller.mapper.bindElements( modelP2, viewP2 );
  1299. // Remove second paragraph element.
  1300. model.change( writer => {
  1301. writer.remove( writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) ) );
  1302. } );
  1303. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  1304. } );
  1305. it( 'should work correctly if container element after text node is removed', () => {
  1306. const modelText = new ModelText( 'foo' );
  1307. const modelP = new ModelElement( 'paragraph' );
  1308. model.change( writer => {
  1309. writer.insert( [ modelText, modelP ], modelRootStart );
  1310. } );
  1311. model.change( writer => {
  1312. writer.remove( modelP );
  1313. } );
  1314. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  1315. } );
  1316. } );
  1317. describe( 'createViewElementFromHighlightDescriptor()', () => {
  1318. let viewWriter;
  1319. beforeEach( () => {
  1320. viewWriter = new DowncastWriter( controller.view.document );
  1321. } );
  1322. it( 'should return attribute element from descriptor object', () => {
  1323. const descriptor = {
  1324. classes: 'foo-class',
  1325. attributes: { one: '1', two: '2' },
  1326. priority: 7
  1327. };
  1328. const element = createViewElementFromHighlightDescriptor( viewWriter, 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. for ( const key of Object.keys( descriptor.attributes ) ) {
  1334. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1335. }
  1336. } );
  1337. it( 'should return attribute element from descriptor object - array with classes', () => {
  1338. const descriptor = {
  1339. classes: [ 'foo-class', 'bar-class' ],
  1340. attributes: { one: '1', two: '2' },
  1341. priority: 7
  1342. };
  1343. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1344. expect( element.is( 'attributeElement' ) ).to.be.true;
  1345. expect( element.name ).to.equal( 'span' );
  1346. expect( element.priority ).to.equal( 7 );
  1347. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1348. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  1349. for ( const key of Object.keys( descriptor.attributes ) ) {
  1350. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1351. }
  1352. } );
  1353. it( 'should create element without class', () => {
  1354. const descriptor = {
  1355. attributes: { one: '1', two: '2' },
  1356. priority: 7
  1357. };
  1358. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1359. expect( element.is( 'attributeElement' ) ).to.be.true;
  1360. expect( element.name ).to.equal( 'span' );
  1361. expect( element.priority ).to.equal( 7 );
  1362. for ( const key of Object.keys( descriptor.attributes ) ) {
  1363. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1364. }
  1365. } );
  1366. it( 'should create element without priority', () => {
  1367. const descriptor = {
  1368. classes: 'foo-class',
  1369. attributes: { one: '1', two: '2' }
  1370. };
  1371. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1372. expect( element.is( 'attributeElement' ) ).to.be.true;
  1373. expect( element.name ).to.equal( 'span' );
  1374. expect( element.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1375. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1376. for ( const key of Object.keys( descriptor.attributes ) ) {
  1377. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1378. }
  1379. } );
  1380. it( 'should create element without attributes', () => {
  1381. const descriptor = {
  1382. classes: 'foo-class',
  1383. priority: 7
  1384. };
  1385. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1386. expect( element.is( 'attributeElement' ) ).to.be.true;
  1387. expect( element.name ).to.equal( 'span' );
  1388. expect( element.priority ).to.equal( 7 );
  1389. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1390. } );
  1391. } );
  1392. } );
  1393. describe( 'downcast selection converters', () => {
  1394. let dispatcher, mapper, model, view, modelDoc, modelRoot, docSelection, viewDoc, viewRoot, viewSelection, downcastHelpers;
  1395. let stylesProcessor;
  1396. beforeEach( () => {
  1397. stylesProcessor = new StylesProcessor();
  1398. model = new Model();
  1399. modelDoc = model.document;
  1400. modelRoot = modelDoc.createRoot();
  1401. docSelection = modelDoc.selection;
  1402. model.schema.extend( '$text', { allowIn: '$root' } );
  1403. view = new View( stylesProcessor );
  1404. viewDoc = view.document;
  1405. viewRoot = createViewRoot( viewDoc );
  1406. viewSelection = viewDoc.selection;
  1407. mapper = new Mapper();
  1408. mapper.bindElements( modelRoot, viewRoot );
  1409. dispatcher = new DowncastDispatcher( { mapper, viewSelection } );
  1410. dispatcher.on( 'insert:$text', insertText() );
  1411. downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1412. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  1413. downcastHelpers.markerToHighlight( { model: 'marker', view: { classes: 'marker' }, converterPriority: 1 } );
  1414. // Default selection converters.
  1415. dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
  1416. dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  1417. dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  1418. } );
  1419. afterEach( () => {
  1420. view.destroy();
  1421. } );
  1422. describe( 'default converters', () => {
  1423. describe( 'range selection', () => {
  1424. it( 'in same container', () => {
  1425. test(
  1426. [ 1, 4 ],
  1427. 'foobar',
  1428. 'f{oob}ar'
  1429. );
  1430. } );
  1431. it( 'in same container with unicode characters', () => {
  1432. test(
  1433. [ 2, 6 ],
  1434. 'நிலைக்கு',
  1435. 'நி{லைக்}கு'
  1436. );
  1437. } );
  1438. it( 'in same container, over attribute', () => {
  1439. test(
  1440. [ 1, 5 ],
  1441. 'fo<$text bold="true">ob</$text>ar',
  1442. 'f{o<strong>ob</strong>a}r'
  1443. );
  1444. } );
  1445. it( 'in same container, next to attribute', () => {
  1446. test(
  1447. [ 1, 2 ],
  1448. 'fo<$text bold="true">ob</$text>ar',
  1449. 'f{o}<strong>ob</strong>ar'
  1450. );
  1451. } );
  1452. it( 'in same attribute', () => {
  1453. test(
  1454. [ 2, 4 ],
  1455. 'f<$text bold="true">ooba</$text>r',
  1456. 'f<strong>o{ob}a</strong>r'
  1457. );
  1458. } );
  1459. it( 'in same attribute, selection same as attribute', () => {
  1460. test(
  1461. [ 2, 4 ],
  1462. 'fo<$text bold="true">ob</$text>ar',
  1463. 'fo{<strong>ob</strong>}ar'
  1464. );
  1465. } );
  1466. it( 'starts in text node, ends in attribute #1', () => {
  1467. test(
  1468. [ 1, 3 ],
  1469. 'fo<$text bold="true">ob</$text>ar',
  1470. 'f{o<strong>o}b</strong>ar'
  1471. );
  1472. } );
  1473. it( 'starts in text node, ends in attribute #2', () => {
  1474. test(
  1475. [ 1, 4 ],
  1476. 'fo<$text bold="true">ob</$text>ar',
  1477. 'f{o<strong>ob</strong>}ar'
  1478. );
  1479. } );
  1480. it( 'starts in attribute, ends in text node', () => {
  1481. test(
  1482. [ 3, 5 ],
  1483. 'fo<$text bold="true">ob</$text>ar',
  1484. 'fo<strong>o{b</strong>a}r'
  1485. );
  1486. } );
  1487. it( 'consumes consumable values properly', () => {
  1488. // Add callback that will fire before default ones.
  1489. // This should prevent default callback doing anything.
  1490. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  1491. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  1492. }, { priority: 'high' } );
  1493. // Similar test case as the first in this suite.
  1494. test(
  1495. [ 1, 4 ],
  1496. 'foobar',
  1497. 'foobar' // No selection in view.
  1498. );
  1499. } );
  1500. it( 'should convert backward selection', () => {
  1501. test(
  1502. [ 1, 3, 'backward' ],
  1503. 'foobar',
  1504. 'f{oo}bar'
  1505. );
  1506. expect( viewSelection.focus.offset ).to.equal( 1 );
  1507. } );
  1508. } );
  1509. describe( 'collapsed selection', () => {
  1510. let marker, viewDocument;
  1511. beforeEach( () => {
  1512. viewDocument = new ViewDocument( stylesProcessor );
  1513. } );
  1514. it( 'in container', () => {
  1515. test(
  1516. [ 1, 1 ],
  1517. 'foobar',
  1518. 'f{}oobar'
  1519. );
  1520. } );
  1521. it( 'in attribute', () => {
  1522. test(
  1523. [ 3, 3 ],
  1524. 'f<$text bold="true">ooba</$text>r',
  1525. 'f<strong>oo{}ba</strong>r'
  1526. );
  1527. } );
  1528. it( 'in attribute and marker', () => {
  1529. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  1530. model.change( writer => {
  1531. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  1532. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  1533. writer.setSelection( modelRoot, 3 );
  1534. } );
  1535. // Remove view children manually (without firing additional conversion).
  1536. viewRoot._removeChildren( 0, viewRoot.childCount );
  1537. // Convert model to view.
  1538. view.change( writer => {
  1539. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1540. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  1541. dispatcher.convertSelection( docSelection, model.markers, writer );
  1542. } );
  1543. // Stringify view and check if it is same as expected.
  1544. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  1545. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  1546. );
  1547. } );
  1548. it( 'in attribute and marker - no attribute', () => {
  1549. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  1550. model.change( writer => {
  1551. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  1552. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  1553. writer.setSelection( modelRoot, 3 );
  1554. writer.removeSelectionAttribute( 'bold' );
  1555. } );
  1556. // Remove view children manually (without firing additional conversion).
  1557. viewRoot._removeChildren( 0, viewRoot.childCount );
  1558. // Convert model to view.
  1559. view.change( writer => {
  1560. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1561. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  1562. dispatcher.convertSelection( docSelection, model.markers, writer );
  1563. } );
  1564. // Stringify view and check if it is same as expected.
  1565. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1566. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  1567. } );
  1568. it( 'in marker - using highlight descriptor creator', () => {
  1569. downcastHelpers.markerToHighlight( {
  1570. model: 'marker2',
  1571. view: data => ( { classes: data.markerName } )
  1572. } );
  1573. setModelData( model, 'foobar' );
  1574. model.change( writer => {
  1575. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  1576. marker = writer.addMarker( 'marker2', { range, usingOperation: false } );
  1577. writer.setSelection( modelRoot, 3 );
  1578. } );
  1579. // Remove view children manually (without firing additional conversion).
  1580. viewRoot._removeChildren( 0, viewRoot.childCount );
  1581. // Convert model to view.
  1582. view.change( writer => {
  1583. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1584. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  1585. dispatcher.convertSelection( docSelection, model.markers, writer );
  1586. } );
  1587. // Stringify view and check if it is same as expected.
  1588. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1589. .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
  1590. } );
  1591. it( 'should do nothing if creator return null', () => {
  1592. downcastHelpers.markerToHighlight( {
  1593. model: 'marker3',
  1594. view: () => null
  1595. } );
  1596. setModelData( model, 'foobar' );
  1597. model.change( writer => {
  1598. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  1599. marker = writer.addMarker( 'marker3', { range, usingOperation: false } );
  1600. writer.setSelection( modelRoot, 3 );
  1601. } );
  1602. // Remove view children manually (without firing additional conversion).
  1603. viewRoot._removeChildren( 0, viewRoot.childCount );
  1604. // Convert model to view.
  1605. view.change( writer => {
  1606. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1607. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  1608. dispatcher.convertSelection( docSelection, model.markers, writer );
  1609. } );
  1610. // Stringify view and check if it is same as expected.
  1611. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1612. .to.equal( '<div>foo{}bar</div>' );
  1613. } );
  1614. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  1615. it( 'selection with attribute before ui element - no non-ui children', () => {
  1616. setModelData( model, '' );
  1617. // Add two ui elements to view.
  1618. viewRoot._appendChild( [
  1619. new ViewUIElement( viewDocument, 'span' ),
  1620. new ViewUIElement( viewDocument, 'span' )
  1621. ] );
  1622. model.change( writer => {
  1623. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 0 ] ) ) );
  1624. writer.setSelectionAttribute( 'bold', true );
  1625. } );
  1626. // Convert model to view.
  1627. view.change( writer => {
  1628. dispatcher.convertSelection( docSelection, model.markers, writer );
  1629. } );
  1630. // Stringify view and check if it is same as expected.
  1631. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1632. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  1633. } );
  1634. // #1072.
  1635. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  1636. setModelData( model, 'x' );
  1637. model.change( writer => {
  1638. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  1639. writer.setSelectionAttribute( 'bold', true );
  1640. } );
  1641. // Convert model to view.
  1642. view.change( writer => {
  1643. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1644. // Add ui element to view.
  1645. const uiElement = new ViewUIElement( viewDocument, 'span' );
  1646. viewRoot._insertChild( 1, uiElement );
  1647. dispatcher.convertSelection( docSelection, model.markers, writer );
  1648. } );
  1649. // Stringify view and check if it is same as expected.
  1650. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1651. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  1652. } );
  1653. // #1072.
  1654. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  1655. setModelData( model, '<$text bold="true">x</$text>y' );
  1656. model.change( writer => {
  1657. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  1658. writer.setSelectionAttribute( 'bold', true );
  1659. } );
  1660. // Convert model to view.
  1661. view.change( writer => {
  1662. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1663. // Add ui element to view.
  1664. const uiElement = new ViewUIElement( viewDocument, 'span' );
  1665. viewRoot._insertChild( 1, uiElement, writer );
  1666. dispatcher.convertSelection( docSelection, model.markers, writer );
  1667. } );
  1668. // Stringify view and check if it is same as expected.
  1669. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1670. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  1671. } );
  1672. it( 'consumes consumable values properly', () => {
  1673. // Add callbacks that will fire before default ones.
  1674. // This should prevent default callbacks doing anything.
  1675. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  1676. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  1677. }, { priority: 'high' } );
  1678. dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => {
  1679. expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
  1680. }, { priority: 'high' } );
  1681. // Similar test case as above.
  1682. test(
  1683. [ 3, 3 ],
  1684. 'f<$text bold="true">ooba</$text>r',
  1685. 'foobar' // No selection in view and no attribute.
  1686. );
  1687. } );
  1688. } );
  1689. } );
  1690. describe( 'clean-up', () => {
  1691. describe( 'convertRangeSelection', () => {
  1692. it( 'should remove all ranges before adding new range', () => {
  1693. test(
  1694. [ 0, 2 ],
  1695. 'foobar',
  1696. '{fo}obar'
  1697. );
  1698. test(
  1699. [ 3, 5 ],
  1700. 'foobar',
  1701. 'foo{ba}r'
  1702. );
  1703. expect( viewSelection.rangeCount ).to.equal( 1 );
  1704. } );
  1705. } );
  1706. describe( 'convertCollapsedSelection', () => {
  1707. it( 'should remove all ranges before adding new range', () => {
  1708. test(
  1709. [ 2, 2 ],
  1710. 'foobar',
  1711. 'fo{}obar'
  1712. );
  1713. test(
  1714. [ 3, 3 ],
  1715. 'foobar',
  1716. 'foo{}bar'
  1717. );
  1718. expect( viewSelection.rangeCount ).to.equal( 1 );
  1719. } );
  1720. } );
  1721. describe( 'clearAttributes', () => {
  1722. it( 'should remove all ranges before adding new range', () => {
  1723. test(
  1724. [ 3, 3 ],
  1725. 'foobar',
  1726. 'foo<strong>[]</strong>bar',
  1727. { bold: 'true' }
  1728. );
  1729. view.change( writer => {
  1730. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  1731. model.change( writer => {
  1732. writer.setSelection( modelRange );
  1733. } );
  1734. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  1735. } );
  1736. expect( viewSelection.rangeCount ).to.equal( 1 );
  1737. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  1738. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  1739. } );
  1740. it( 'should do nothing if the attribute element had been already removed', () => {
  1741. test(
  1742. [ 3, 3 ],
  1743. 'foobar',
  1744. 'foo<strong>[]</strong>bar',
  1745. { bold: 'true' }
  1746. );
  1747. view.change( writer => {
  1748. // Remove <strong></strong> manually.
  1749. writer.mergeAttributes( viewSelection.getFirstPosition() );
  1750. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  1751. model.change( writer => {
  1752. writer.setSelection( modelRange );
  1753. } );
  1754. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  1755. } );
  1756. expect( viewSelection.rangeCount ).to.equal( 1 );
  1757. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  1758. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  1759. } );
  1760. it( 'should clear fake selection', () => {
  1761. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  1762. view.change( writer => {
  1763. writer.setSelection( modelRange, { fake: true } );
  1764. dispatcher.convertSelection( docSelection, model.markers, writer );
  1765. } );
  1766. expect( viewSelection.isFake ).to.be.false;
  1767. } );
  1768. } );
  1769. } );
  1770. describe( 'table cell selection converter', () => {
  1771. beforeEach( () => {
  1772. model.schema.register( 'table', { isLimit: true } );
  1773. model.schema.register( 'tr', { isLimit: true } );
  1774. model.schema.register( 'td', { isLimit: true } );
  1775. model.schema.extend( 'table', { allowIn: '$root' } );
  1776. model.schema.extend( 'tr', { allowIn: 'table' } );
  1777. model.schema.extend( 'td', { allowIn: 'tr' } );
  1778. model.schema.extend( '$text', { allowIn: 'td' } );
  1779. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1780. // "Universal" converter to convert table structure.
  1781. downcastHelpers.elementToElement( { model: 'table', view: 'table' } );
  1782. downcastHelpers.elementToElement( { model: 'tr', view: 'tr' } );
  1783. downcastHelpers.elementToElement( { model: 'td', view: 'td' } );
  1784. // Special converter for table cells.
  1785. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  1786. const selection = data.selection;
  1787. if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  1788. return;
  1789. }
  1790. for ( const range of selection.getRanges() ) {
  1791. const node = range.start.parent;
  1792. if ( !!node && node.is( 'td' ) ) {
  1793. conversionApi.consumable.consume( selection, 'selection' );
  1794. const viewNode = conversionApi.mapper.toViewElement( node );
  1795. conversionApi.writer.addClass( 'selected', viewNode );
  1796. }
  1797. }
  1798. }, { priority: 'high' } );
  1799. } );
  1800. it( 'should not be used to convert selection that is not on table cell', () => {
  1801. test(
  1802. [ 1, 5 ],
  1803. 'f{o<$text bold="true">ob</$text>a}r',
  1804. 'f{o<strong>ob</strong>a}r'
  1805. );
  1806. } );
  1807. it( 'should add a class to the selected table cell', () => {
  1808. test(
  1809. // table tr#0 td#0 [foo, table tr#0 td#0 bar]
  1810. [ [ 0, 0, 0, 0 ], [ 0, 0, 0, 3 ] ],
  1811. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  1812. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  1813. );
  1814. } );
  1815. it( 'should not be used if selection contains more than just a table cell', () => {
  1816. test(
  1817. // table tr td#1 f{oo bar, table tr#2 bar]
  1818. [ [ 0, 0, 0, 1 ], [ 0, 0, 1, 3 ] ],
  1819. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  1820. '[<table><tr><td>foo</td><td>bar</td></tr></table>]'
  1821. );
  1822. } );
  1823. } );
  1824. // Tests if the selection got correctly converted.
  1825. // Because `setData` might use selection converters itself to set the selection, we can't use it
  1826. // to set the selection (because then we would test converters using converters).
  1827. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  1828. // that are offsets or paths of selection positions in root element.
  1829. function test( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  1830. // Parse passed `modelInput` string and set it as current model.
  1831. setModelData( model, modelInput );
  1832. // Manually set selection ranges using passed `selectionPaths`.
  1833. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  1834. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  1835. const startPos = model.createPositionFromPath( modelRoot, startPath );
  1836. const endPos = model.createPositionFromPath( modelRoot, endPath );
  1837. const isBackward = selectionPaths[ 2 ] === 'backward';
  1838. model.change( writer => {
  1839. writer.setSelection( writer.createRange( startPos, endPos ), { backward: isBackward } );
  1840. // And add or remove passed attributes.
  1841. for ( const key in selectionAttributes ) {
  1842. const value = selectionAttributes[ key ];
  1843. if ( value ) {
  1844. writer.setSelectionAttribute( key, value );
  1845. } else {
  1846. writer.removeSelectionAttribute( key );
  1847. }
  1848. }
  1849. } );
  1850. // Remove view children manually (without firing additional conversion).
  1851. viewRoot._removeChildren( 0, viewRoot.childCount );
  1852. // Convert model to view.
  1853. view.change( writer => {
  1854. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1855. dispatcher.convertSelection( docSelection, model.markers, writer );
  1856. } );
  1857. // Stringify view and check if it is same as expected.
  1858. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  1859. }
  1860. } );
  1861. function viewToString( item ) {
  1862. let result = '';
  1863. if ( item instanceof ViewText ) {
  1864. result = item.data;
  1865. } else {
  1866. // ViewElement or ViewDocumentFragment.
  1867. for ( const child of item.getChildren() ) {
  1868. result += viewToString( child );
  1869. }
  1870. if ( item instanceof ViewElement ) {
  1871. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  1872. }
  1873. }
  1874. return result;
  1875. }
  1876. function viewAttributesToString( item ) {
  1877. let result = '';
  1878. for ( const key of item.getAttributeKeys() ) {
  1879. const value = item.getAttribute( key );
  1880. if ( value ) {
  1881. result += ' ' + key + '="' + value + '"';
  1882. }
  1883. }
  1884. return result;
  1885. }