downcasthelpers.js 93 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056
  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;
  35. beforeEach( () => {
  36. model = new Model();
  37. const modelDoc = model.document;
  38. modelRoot = modelDoc.createRoot();
  39. controller = new EditingController( model, new StylesProcessor() );
  40. // Set name of view root the same as dom root.
  41. // This is a mock of attaching view root to dom root.
  42. controller.view.document.getRoot()._name = 'div';
  43. viewRoot = controller.view.document.getRoot();
  44. downcastHelpers = new DowncastHelpers( [ controller.downcastDispatcher ] );
  45. modelRootStart = model.createPositionAt( modelRoot, 0 );
  46. } );
  47. describe( 'elementToElement()', () => {
  48. it( 'should be chainable', () => {
  49. expect( downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } ) ).to.equal( downcastHelpers );
  50. } );
  51. it( 'config.view is a string', () => {
  52. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  53. model.change( writer => {
  54. writer.insertElement( 'paragraph', modelRoot, 0 );
  55. } );
  56. expectResult( '<p></p>' );
  57. } );
  58. it( 'can be overwritten using converterPriority', () => {
  59. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  60. downcastHelpers.elementToElement( { model: 'paragraph', view: 'foo', converterPriority: 'high' } );
  61. model.change( writer => {
  62. writer.insertElement( 'paragraph', modelRoot, 0 );
  63. } );
  64. expectResult( '<foo></foo>' );
  65. } );
  66. it( 'config.view is a view element definition', () => {
  67. downcastHelpers.elementToElement( {
  68. model: 'fancyParagraph',
  69. view: {
  70. name: 'p',
  71. classes: 'fancy'
  72. }
  73. } );
  74. model.change( writer => {
  75. writer.insertElement( 'fancyParagraph', modelRoot, 0 );
  76. } );
  77. expectResult( '<p class="fancy"></p>' );
  78. } );
  79. it( 'config.view is a function', () => {
  80. downcastHelpers.elementToElement( {
  81. model: 'heading',
  82. view: ( modelElement, { writer } ) => writer.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) )
  83. } );
  84. model.change( writer => {
  85. writer.insertElement( 'heading', { level: 2 }, modelRoot, 0 );
  86. } );
  87. expectResult( '<h2></h2>' );
  88. } );
  89. describe( 'config.triggerBy', () => {
  90. describe( 'with simple block view structure', () => {
  91. beforeEach( () => {
  92. model.schema.register( 'simpleBlock', {
  93. allowIn: '$root',
  94. allowAttributes: [ 'toStyle', 'toClass' ]
  95. } );
  96. downcastHelpers.elementToElement( {
  97. model: 'simpleBlock',
  98. view: ( modelElement, { writer } ) => {
  99. return writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
  100. },
  101. triggerBy: [
  102. 'attribute:toStyle:simpleBlock',
  103. 'attribute:toClass:simpleBlock'
  104. ]
  105. } );
  106. } );
  107. it( 'should convert on insert', () => {
  108. model.change( writer => {
  109. writer.insertElement( 'simpleBlock', modelRoot, 0 );
  110. } );
  111. expectResult( '<div></div>' );
  112. } );
  113. it( 'should converter on attribute set', () => {
  114. setModelData( model, '<simpleBlock></simpleBlock>' );
  115. model.change( writer => {
  116. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  117. } );
  118. expectResult( '<div style="display:block"></div>' );
  119. } );
  120. it( 'should converter on attribute change', () => {
  121. setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
  122. model.change( writer => {
  123. writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
  124. } );
  125. expectResult( '<div style="display:inline"></div>' );
  126. } );
  127. it( 'should convert on attribute remove', () => {
  128. setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
  129. model.change( writer => {
  130. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  131. } );
  132. expectResult( '<div></div>' );
  133. } );
  134. it( 'should convert on one attribute add and other remove', () => {
  135. setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
  136. model.change( writer => {
  137. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  138. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  139. } );
  140. expectResult( '<div class="is-classy"></div>' );
  141. } );
  142. it( 'should do nothing if other attribute changed', () => {
  143. setModelData( model, '<simpleBlock></simpleBlock>' );
  144. model.change( writer => {
  145. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  146. } );
  147. expectResult( '<div></div>' );
  148. } );
  149. } );
  150. describe.skip( 'with complex view structure', () => {
  151. beforeEach( () => {
  152. model.schema.register( 'complex', {
  153. allowIn: '$root',
  154. allowAttributes: [ 'toStyle', 'toClass' ]
  155. } );
  156. downcastHelpers.elementToElement( {
  157. model: 'complex',
  158. view: ( modelElement, conversionApi ) => {
  159. const { writer, mapper } = conversionApi;
  160. const outter = writer.createContainerElement( 'c-outter' );
  161. mapper.bindElements( modelElement, outter );
  162. const inner = writer.createContainerElement( 'c-inner', getViewAttributes( modelElement ) );
  163. writer.insert( writer.createPositionAt( outter, 0 ), inner );
  164. mapper.bindSlotElements( modelElement, inner );
  165. return outter;
  166. },
  167. triggerBy: [
  168. 'attribute:toStyle:complex',
  169. 'attribute:toClass:complex'
  170. ]
  171. } );
  172. model.schema.register( 'paragraph', {
  173. inheritAllFrom: '$block',
  174. allowIn: 'complex'
  175. } );
  176. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  177. } );
  178. it( 'should convert to view on insert', () => {
  179. model.change( writer => {
  180. writer.insertElement( 'complex', modelRoot, 0 );
  181. } );
  182. expectResult( '<c-outter><c-inner></c-inner></c-outter>' );
  183. } );
  184. it( 'should use main converter for attribute set', () => {
  185. setModelData( model, '<complex></complex>' );
  186. model.change( writer => {
  187. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  188. } );
  189. expectResult( '<c-outter><c-inner style="display:block"></c-inner></c-outter>' );
  190. } );
  191. it( 'should use main converter for attribute remove', () => {
  192. setModelData( model, '<complex toStyle="display:block"></complex>' );
  193. model.change( writer => {
  194. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  195. } );
  196. expectResult( '<c-outter><c-inner></c-inner></c-outter>' );
  197. } );
  198. it( 'should use main converter for attribute add & remove', () => {
  199. setModelData( model, '<complex toStyle="display:block"></complex>' );
  200. model.change( writer => {
  201. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  202. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  203. } );
  204. expectResult( '<c-outter><c-inner class="is-classy"></c-inner></c-outter>' );
  205. } );
  206. it( 'should do nothing if other attribute changed', () => {
  207. setModelData( model, '<complex></complex>' );
  208. model.change( writer => {
  209. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  210. } );
  211. expectResult( '<c-outter><c-inner></c-inner></c-outter>' );
  212. } );
  213. describe( 'memoization', () => {
  214. it( 'should create new element on re-converting element', () => {
  215. setModelData( model, '<complex></complex>' );
  216. const renderedView = viewRoot.getChild( 0 );
  217. model.change( writer => {
  218. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  219. } );
  220. const viewAfterReRender = viewRoot.getChild( 0 );
  221. expect( viewAfterReRender ).to.not.equal( renderedView );
  222. } );
  223. it( 'should not re-create child elements on re-converting element', () => {
  224. setModelData( model, '<complex><paragraph>Foo bar baz</paragraph></complex>' );
  225. expectResult( '<c-outter><c-inner><p>Foo bar baz</p></c-inner></c-outter>' );
  226. const renderedViewView = viewRoot.getChild( 0 ).getChild( 0 );
  227. model.change( writer => {
  228. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  229. } );
  230. const viewAfterReRender = viewRoot.getChild( 0 ).getChild( 0 );
  231. expect( viewAfterReRender ).to.equal( renderedViewView );
  232. } );
  233. } );
  234. } );
  235. function getViewAttributes( modelElement ) {
  236. // TODO decide whether below is readable:
  237. const toStyle = modelElement.hasAttribute( 'toStyle' ) && { style: modelElement.getAttribute( 'toStyle' ) };
  238. const toClass = modelElement.hasAttribute( 'toClass' ) && { class: 'is-classy' };
  239. const attributes = {
  240. ...toStyle,
  241. ...toClass
  242. };
  243. return attributes;
  244. }
  245. } );
  246. } );
  247. describe( 'attributeToElement()', () => {
  248. beforeEach( () => {
  249. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  250. } );
  251. it( 'should be chainable', () => {
  252. expect( downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } ) ).to.equal( downcastHelpers );
  253. } );
  254. it( 'config.view is a string', () => {
  255. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  256. model.change( writer => {
  257. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  258. } );
  259. expectResult( '<strong>foo</strong>' );
  260. } );
  261. it( 'can be overwritten using converterPriority', () => {
  262. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  263. downcastHelpers.attributeToElement( { model: 'bold', view: 'b', converterPriority: 'high' } );
  264. model.change( writer => {
  265. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  266. } );
  267. expectResult( '<b>foo</b>' );
  268. } );
  269. it( 'config.view is a view element definition', () => {
  270. downcastHelpers.attributeToElement( {
  271. model: 'invert',
  272. view: {
  273. name: 'span',
  274. classes: [ 'font-light', 'bg-dark' ]
  275. }
  276. } );
  277. model.change( writer => {
  278. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  279. } );
  280. expectResult( '<span class="bg-dark font-light">foo</span>' );
  281. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  282. } );
  283. it( 'config.view allows specifying the element\'s priority', () => {
  284. downcastHelpers.attributeToElement( {
  285. model: 'invert',
  286. view: {
  287. name: 'span',
  288. priority: 5
  289. }
  290. } );
  291. model.change( writer => {
  292. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  293. } );
  294. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  295. } );
  296. it( 'model attribute value is enum', () => {
  297. downcastHelpers.attributeToElement( {
  298. model: {
  299. key: 'fontSize',
  300. values: [ 'big', 'small' ]
  301. },
  302. view: {
  303. big: {
  304. name: 'span',
  305. styles: {
  306. 'font-size': '1.2em'
  307. }
  308. },
  309. small: {
  310. name: 'span',
  311. styles: {
  312. 'font-size': '0.8em'
  313. },
  314. priority: 5
  315. }
  316. }
  317. } );
  318. model.change( writer => {
  319. writer.insertText( 'foo', { fontSize: 'big' }, modelRoot, 0 );
  320. } );
  321. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  322. expectResult( '<span style="font-size:1.2em">foo</span>' );
  323. model.change( writer => {
  324. writer.setAttribute( 'fontSize', 'small', modelRoot.getChild( 0 ) );
  325. } );
  326. expectResult( '<span style="font-size:0.8em">foo</span>' );
  327. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  328. model.change( writer => {
  329. writer.removeAttribute( 'fontSize', modelRoot.getChild( 0 ) );
  330. } );
  331. expectResult( 'foo' );
  332. } );
  333. it( 'config.view is a function', () => {
  334. downcastHelpers.attributeToElement( {
  335. model: 'bold',
  336. view: ( modelAttributeValue, { writer } ) => {
  337. return writer.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } );
  338. }
  339. } );
  340. model.change( writer => {
  341. writer.insertText( 'foo', { bold: '500' }, modelRoot, 0 );
  342. } );
  343. expectResult( '<span style="font-weight:500">foo</span>' );
  344. } );
  345. it( 'config.model.name is given', () => {
  346. downcastHelpers.attributeToElement( {
  347. model: {
  348. key: 'color',
  349. name: '$text'
  350. },
  351. view: ( modelAttributeValue, { writer } ) => {
  352. return writer.createAttributeElement( 'span', { style: 'color:' + modelAttributeValue } );
  353. }
  354. } );
  355. downcastHelpers.elementToElement( {
  356. model: 'smiley',
  357. view: ( modelElement, { writer } ) => {
  358. return writer.createEmptyElement( 'img', {
  359. src: 'smile.jpg',
  360. class: 'smiley'
  361. } );
  362. }
  363. } );
  364. model.change( writer => {
  365. writer.insertText( 'foo', { color: '#FF0000' }, modelRoot, 0 );
  366. writer.insertElement( 'smiley', { color: '#FF0000' }, modelRoot, 3 );
  367. } );
  368. expectResult( '<span style="color:#FF0000">foo</span><img class="smiley" src="smile.jpg"></img>' );
  369. } );
  370. it( 'should not convert if creator returned null', () => {
  371. downcastHelpers.elementToElement( { model: 'div', view: () => null } );
  372. const modelElement = new ModelElement( 'div' );
  373. model.change( writer => {
  374. writer.insert( modelElement, modelRootStart );
  375. } );
  376. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  377. } );
  378. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  379. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  380. downcastHelpers.attributeToElement( {
  381. model: 'bold',
  382. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
  383. } );
  384. model.change( writer => {
  385. writer.insert( modelElement, modelRootStart );
  386. } );
  387. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  388. model.change( writer => {
  389. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  390. } );
  391. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  392. } );
  393. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  394. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  395. downcastHelpers.attributeToElement( {
  396. model: 'style',
  397. view: ( modelAttributeValue, { writer } ) => {
  398. if ( modelAttributeValue == 'bold' ) {
  399. return writer.createAttributeElement( 'b' );
  400. }
  401. }
  402. } );
  403. model.change( writer => {
  404. writer.insert( modelElement, modelRootStart );
  405. } );
  406. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  407. model.change( writer => {
  408. writer.removeAttribute( 'style', writer.createRangeIn( modelElement ) );
  409. } );
  410. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  411. } );
  412. it( 'should update range on re-wrapping attribute (#475)', () => {
  413. const modelElement = new ModelElement( 'paragraph', null, [
  414. new ModelText( 'x' ),
  415. new ModelText( 'foo', { link: 'http://foo.com' } ),
  416. new ModelText( 'x' )
  417. ] );
  418. downcastHelpers.attributeToElement( {
  419. model: 'link',
  420. view: ( modelAttributeValue, { writer } ) => {
  421. return writer.createAttributeElement( 'a', { href: modelAttributeValue } );
  422. }
  423. } );
  424. model.change( writer => {
  425. writer.insert( modelElement, modelRootStart );
  426. } );
  427. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  428. // Set new attribute on old link but also on non-linked characters.
  429. model.change( writer => {
  430. writer.setAttribute( 'link', 'http://foobar.com', writer.createRangeIn( modelElement ) );
  431. } );
  432. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  433. } );
  434. it( 'should support unicode', () => {
  435. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  436. downcastHelpers.attributeToElement( {
  437. model: 'bold',
  438. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
  439. } );
  440. model.change( writer => {
  441. writer.insert( modelElement, modelRootStart );
  442. } );
  443. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  444. model.change( writer => {
  445. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  446. } );
  447. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  448. } );
  449. it( 'should be possible to override ', () => {
  450. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  451. downcastHelpers.attributeToElement( {
  452. model: 'bold',
  453. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
  454. } );
  455. downcastHelpers.attributeToElement( {
  456. model: 'bold',
  457. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'strong' ),
  458. converterPriority: 'high'
  459. } );
  460. model.change( writer => {
  461. writer.insert( modelElement, modelRootStart );
  462. } );
  463. expect( viewToString( viewRoot ) ).to.equal( '<div><p><strong>foobar</strong></p></div>' );
  464. } );
  465. it( 'should not convert and not consume if creator function returned null', () => {
  466. sinon.spy( controller.downcastDispatcher, 'fire' );
  467. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  468. downcastHelpers.attributeToElement( {
  469. model: 'italic',
  470. view: () => null
  471. } );
  472. const spy = sinon.spy();
  473. controller.downcastDispatcher.on( 'attribute:italic', spy );
  474. model.change( writer => {
  475. writer.insert( modelElement, modelRootStart );
  476. } );
  477. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  478. expect( controller.downcastDispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  479. expect( spy.called ).to.be.true;
  480. } );
  481. } );
  482. describe( 'attributeToAttribute()', () => {
  483. testUtils.createSinonSandbox();
  484. beforeEach( () => {
  485. downcastHelpers.elementToElement( { model: 'image', view: 'img' } );
  486. downcastHelpers.elementToElement( {
  487. model: 'paragraph',
  488. view: ( modelItem, { writer } ) => writer.createContainerElement( 'p' )
  489. } );
  490. downcastHelpers.attributeToAttribute( {
  491. model: 'class',
  492. view: 'class'
  493. } );
  494. } );
  495. it( 'should be chainable', () => {
  496. expect( downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } ) ).to.equal( downcastHelpers );
  497. } );
  498. it( 'config.view is a string', () => {
  499. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } );
  500. model.change( writer => {
  501. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  502. } );
  503. expectResult( '<img src="foo.jpg"></img>' );
  504. model.change( writer => {
  505. writer.removeAttribute( 'source', modelRoot.getChild( 0 ) );
  506. } );
  507. expectResult( '<img></img>' );
  508. } );
  509. it( 'can be overwritten using converterPriority', () => {
  510. downcastHelpers.attributeToAttribute( { model: 'source', view: 'href' } );
  511. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src', converterPriority: 'high' } );
  512. model.change( writer => {
  513. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  514. } );
  515. expectResult( '<img src="foo.jpg"></img>' );
  516. } );
  517. it( 'model element name specified', () => {
  518. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  519. downcastHelpers.attributeToAttribute( {
  520. model: {
  521. name: 'image',
  522. key: 'source'
  523. },
  524. view: 'src'
  525. } );
  526. model.change( writer => {
  527. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  528. } );
  529. expectResult( '<img src="foo.jpg"></img>' );
  530. model.change( writer => {
  531. writer.rename( modelRoot.getChild( 0 ), 'paragraph' );
  532. } );
  533. expectResult( '<p></p>' );
  534. } );
  535. it( 'config.view is an object, model attribute value is enum', () => {
  536. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  537. downcastHelpers.attributeToAttribute( {
  538. model: {
  539. key: 'styled',
  540. values: [ 'dark', 'light' ]
  541. },
  542. view: {
  543. dark: {
  544. key: 'class',
  545. value: [ 'styled', 'styled-dark' ]
  546. },
  547. light: {
  548. key: 'class',
  549. value: [ 'styled', 'styled-light' ]
  550. }
  551. }
  552. } );
  553. model.change( writer => {
  554. writer.insertElement( 'paragraph', { styled: 'dark' }, modelRoot, 0 );
  555. } );
  556. expectResult( '<p class="styled styled-dark"></p>' );
  557. model.change( writer => {
  558. writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) );
  559. } );
  560. expectResult( '<p class="styled styled-light"></p>' );
  561. model.change( writer => {
  562. writer.removeAttribute( 'styled', modelRoot.getChild( 0 ) );
  563. } );
  564. expectResult( '<p></p>' );
  565. } );
  566. it( 'config.view is an object, model attribute value is enum, view has style', () => {
  567. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  568. downcastHelpers.attributeToAttribute( {
  569. model: {
  570. key: 'align',
  571. values: [ 'right', 'center' ]
  572. },
  573. view: {
  574. right: {
  575. key: 'style',
  576. value: {
  577. 'text-align': 'right'
  578. }
  579. },
  580. center: {
  581. key: 'style',
  582. value: {
  583. 'text-align': 'center'
  584. }
  585. }
  586. }
  587. } );
  588. model.change( writer => {
  589. writer.insertElement( 'paragraph', { align: 'right' }, modelRoot, 0 );
  590. } );
  591. expectResult( '<p style="text-align:right"></p>' );
  592. model.change( writer => {
  593. writer.setAttribute( 'align', 'center', modelRoot.getChild( 0 ) );
  594. } );
  595. expectResult( '<p style="text-align:center"></p>' );
  596. model.change( writer => {
  597. writer.removeAttribute( 'align', modelRoot.getChild( 0 ) );
  598. } );
  599. expectResult( '<p></p>' );
  600. } );
  601. it( 'config.view is an object, only name and key are provided', () => {
  602. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  603. downcastHelpers.attributeToAttribute( {
  604. model: {
  605. name: 'paragraph',
  606. key: 'class'
  607. },
  608. view: {
  609. name: 'paragraph',
  610. key: 'class'
  611. }
  612. } );
  613. model.change( writer => {
  614. writer.insertElement( 'paragraph', { class: 'dark' }, modelRoot, 0 );
  615. } );
  616. expectResult( '<p class="dark"></p>' );
  617. model.change( writer => {
  618. writer.setAttribute( 'class', 'light', modelRoot.getChild( 0 ) );
  619. } );
  620. expectResult( '<p class="light"></p>' );
  621. model.change( writer => {
  622. writer.removeAttribute( 'class', modelRoot.getChild( 0 ) );
  623. } );
  624. expectResult( '<p></p>' );
  625. } );
  626. it( 'config.view is a function', () => {
  627. downcastHelpers.attributeToAttribute( {
  628. model: 'styled',
  629. view: ( attributeValue, conversionApi ) => {
  630. // To ensure conversion API is provided.
  631. expect( conversionApi.writer ).to.instanceof( DowncastWriter );
  632. return { key: 'class', value: 'styled-' + attributeValue };
  633. }
  634. } );
  635. model.change( writer => {
  636. writer.insertElement( 'image', { styled: 'pull-out' }, modelRoot, 0 );
  637. } );
  638. expectResult( '<img class="styled-pull-out"></img>' );
  639. } );
  640. // #1587
  641. it( 'config.view and config.model as strings in generic conversion (elements only)', () => {
  642. const consoleWarnStub = testUtils.sinon.stub( console, 'warn' );
  643. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  644. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  645. model.change( writer => {
  646. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 0 );
  647. writer.insertElement( 'paragraph', { test: '2' }, modelRoot, 1 );
  648. } );
  649. expectResult( '<p test="1"></p><p test="2"></p>' );
  650. expect( consoleWarnStub.callCount ).to.equal( 0 );
  651. model.change( writer => {
  652. writer.removeAttribute( 'test', modelRoot.getChild( 1 ) );
  653. } );
  654. expectResult( '<p test="1"></p><p></p>' );
  655. } );
  656. // #1587
  657. it( 'config.view and config.model as strings in generic conversion (elements + text)', () => {
  658. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  659. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  660. expectToThrowCKEditorError( () => {
  661. model.change( writer => {
  662. writer.insertElement( 'paragraph', modelRoot, 0 );
  663. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 1 );
  664. writer.insertText( 'Foo', { test: '2' }, modelRoot.getChild( 0 ), 0 );
  665. writer.insertText( 'Bar', { test: '3' }, modelRoot.getChild( 1 ), 0 );
  666. } );
  667. }, /^conversion-attribute-to-attribute-on-text/ );
  668. } );
  669. it( 'should convert attribute insert/change/remove on a model node', () => {
  670. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  671. model.change( writer => {
  672. writer.insert( modelElement, modelRootStart );
  673. } );
  674. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  675. model.change( writer => {
  676. writer.setAttribute( 'class', 'bar', modelElement );
  677. } );
  678. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  679. model.change( writer => {
  680. writer.removeAttribute( 'class', modelElement );
  681. } );
  682. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  683. } );
  684. it( 'should be possible to override setAttribute', () => {
  685. downcastHelpers.attributeToAttribute( {
  686. model: 'class',
  687. view: ( evt, data, conversionApi ) => {
  688. conversionApi.consumable.consume( data.item, 'attribute:class' );
  689. },
  690. converterPriority: 'high'
  691. } );
  692. model.change( writer => {
  693. const modelElement = new ModelElement( 'paragraph', { classes: 'foo' }, new ModelText( 'foobar' ) );
  694. writer.insert( modelElement, modelRootStart );
  695. } );
  696. // No attribute set.
  697. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  698. } );
  699. it( 'should not convert or consume if element creator returned null', () => {
  700. const callback = sinon.stub().returns( null );
  701. downcastHelpers.attributeToAttribute( {
  702. model: 'class',
  703. view: callback,
  704. converterPriority: 'high'
  705. } );
  706. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  707. model.change( writer => {
  708. writer.insert( modelElement, modelRootStart );
  709. } );
  710. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  711. sinon.assert.called( callback );
  712. } );
  713. } );
  714. describe( 'markerToElement()', () => {
  715. let modelText, modelElement, range;
  716. it( 'should be chainable', () => {
  717. expect( downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } ) ).to.equal( downcastHelpers );
  718. } );
  719. it( 'config.view is a string', () => {
  720. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  721. model.change( writer => {
  722. writer.insertText( 'foo', modelRoot, 0 );
  723. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  724. writer.addMarker( 'search', { range, usingOperation: false } );
  725. } );
  726. expectResult( 'f<marker-search></marker-search>o<marker-search></marker-search>o' );
  727. } );
  728. it( 'can be overwritten using converterPriority', () => {
  729. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  730. downcastHelpers.markerToElement( { model: 'search', view: 'search', converterPriority: 'high' } );
  731. model.change( writer => {
  732. writer.insertText( 'foo', modelRoot, 0 );
  733. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  734. writer.addMarker( 'search', { range, usingOperation: false } );
  735. } );
  736. expectResult( 'f<search></search>o<search></search>o' );
  737. } );
  738. it( 'config.view is a view element definition', () => {
  739. downcastHelpers.markerToElement( {
  740. model: 'search',
  741. view: {
  742. name: 'span',
  743. attributes: {
  744. 'data-marker': 'search'
  745. }
  746. }
  747. } );
  748. model.change( writer => {
  749. writer.insertText( 'foo', modelRoot, 0 );
  750. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  751. writer.addMarker( 'search', { range, usingOperation: false } );
  752. } );
  753. expectResult( 'f<span data-marker="search"></span>o<span data-marker="search"></span>o' );
  754. } );
  755. it( 'config.view is a function', () => {
  756. downcastHelpers.markerToElement( {
  757. model: 'search',
  758. view: ( data, { writer } ) => {
  759. return writer.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } );
  760. }
  761. } );
  762. model.change( writer => {
  763. writer.insertText( 'foo', modelRoot, 0 );
  764. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  765. writer.addMarker( 'search', { range, usingOperation: false } );
  766. } );
  767. expectResult( 'f<span data-marker="search" data-start="true"></span>o<span data-marker="search" data-start="false"></span>o' );
  768. } );
  769. describe( 'collapsed range', () => {
  770. beforeEach( () => {
  771. modelText = new ModelText( 'foobar' );
  772. modelElement = new ModelElement( 'paragraph', null, modelText );
  773. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  774. model.change( writer => {
  775. writer.insert( modelElement, modelRootStart );
  776. } );
  777. range = model.createRange( model.createPositionAt( modelElement, 3 ), model.createPositionAt( modelElement, 3 ) );
  778. } );
  779. it( 'should insert and remove ui element', () => {
  780. downcastHelpers.markerToElement( {
  781. model: 'marker',
  782. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  783. } );
  784. model.change( writer => {
  785. writer.addMarker( 'marker', { range, usingOperation: false } );
  786. } );
  787. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  788. model.change( writer => {
  789. writer.removeMarker( 'marker' );
  790. } );
  791. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  792. } );
  793. it( 'should not convert if consumable was consumed', () => {
  794. sinon.spy( controller.downcastDispatcher, 'fire' );
  795. downcastHelpers.markerToElement( {
  796. model: 'marker',
  797. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  798. } );
  799. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  800. conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
  801. }, { priority: 'high' } );
  802. model.change( writer => {
  803. writer.addMarker( 'marker', { range, usingOperation: false } );
  804. } );
  805. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  806. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  807. } );
  808. it( 'should not convert if creator returned null', () => {
  809. downcastHelpers.markerToElement( {
  810. model: 'marker',
  811. view: () => null
  812. } );
  813. model.change( writer => {
  814. writer.addMarker( 'marker', { range, usingOperation: false } );
  815. } );
  816. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  817. model.change( writer => {
  818. writer.removeMarker( 'marker' );
  819. } );
  820. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  821. } );
  822. } );
  823. describe( 'non-collapsed range', () => {
  824. beforeEach( () => {
  825. modelText = new ModelText( 'foobar' );
  826. modelElement = new ModelElement( 'paragraph', null, modelText );
  827. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  828. model.change( writer => {
  829. writer.insert( modelElement, modelRootStart );
  830. } );
  831. range = model.createRange( model.createPositionAt( modelElement, 2 ), model.createPositionAt( modelElement, 5 ) );
  832. } );
  833. it( 'should insert and remove ui element - element as a creator', () => {
  834. downcastHelpers.markerToElement( {
  835. model: 'marker',
  836. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  837. } );
  838. model.change( writer => {
  839. writer.addMarker( 'marker', { range, usingOperation: false } );
  840. } );
  841. expect( viewToString( viewRoot ) )
  842. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  843. model.change( writer => {
  844. writer.removeMarker( 'marker' );
  845. } );
  846. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  847. } );
  848. it( 'should insert and remove ui element - function as a creator', () => {
  849. downcastHelpers.markerToElement( {
  850. model: 'marker',
  851. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': data.markerName } )
  852. } );
  853. model.change( writer => {
  854. writer.addMarker( 'marker', { range, usingOperation: false } );
  855. } );
  856. expect( viewToString( viewRoot ) )
  857. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  858. model.change( writer => {
  859. writer.removeMarker( 'marker' );
  860. } );
  861. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  862. } );
  863. it( 'should insert and remove different opening and ending element', () => {
  864. downcastHelpers.markerToElement( {
  865. model: 'marker',
  866. view: ( data, { writer } ) => {
  867. if ( data.isOpening ) {
  868. return writer.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  869. }
  870. return writer.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  871. }
  872. } );
  873. model.change( writer => {
  874. writer.addMarker( 'marker', { range, usingOperation: false } );
  875. } );
  876. expect( viewToString( viewRoot ) ).to.equal(
  877. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  878. );
  879. model.change( writer => {
  880. writer.removeMarker( 'marker' );
  881. } );
  882. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  883. } );
  884. it( 'should not convert if consumable was consumed', () => {
  885. sinon.spy( controller.downcastDispatcher, 'fire' );
  886. downcastHelpers.markerToElement( {
  887. model: 'marker',
  888. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  889. } );
  890. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  891. conversionApi.consumable.consume( data.item, 'addMarker:marker' );
  892. }, { priority: 'high' } );
  893. model.change( writer => {
  894. writer.addMarker( 'marker', { range, usingOperation: false } );
  895. } );
  896. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  897. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  898. } );
  899. } );
  900. } );
  901. describe( 'markerToData()', () => {
  902. let root;
  903. beforeEach( () => {
  904. root = model.document.getRoot();
  905. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  906. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  907. } );
  908. it( 'should be chainable', () => {
  909. expect( downcastHelpers.markerToData( { model: 'search' } ) ).to.equal( downcastHelpers );
  910. } );
  911. it( 'default conversion, inside text, non-collapsed, no name', () => {
  912. downcastHelpers.markerToData( { model: 'search' } );
  913. setModelData( model, '<paragraph>Fo[ob]ar</paragraph>' );
  914. model.change( writer => {
  915. writer.addMarker( 'search', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  916. } );
  917. expectResult( '<p>Fo<search-start></search-start>ob<search-end></search-end>ar</p>' );
  918. model.change( writer => {
  919. writer.removeMarker( 'search' );
  920. } );
  921. expectResult( '<p>Foobar</p>' );
  922. } );
  923. it( 'default conversion, inside text, non-collapsed, name', () => {
  924. downcastHelpers.markerToData( { model: 'group' } );
  925. setModelData( model, '<paragraph>Fo[ob]ar</paragraph>' );
  926. model.change( writer => {
  927. writer.addMarker( 'group:foo:bar:baz', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  928. } );
  929. expectResult( '<p>Fo<group-start name="foo:bar:baz"></group-start>ob<group-end name="foo:bar:baz"></group-end>ar</p>' );
  930. model.change( writer => {
  931. writer.removeMarker( 'group:foo:bar:baz' );
  932. } );
  933. expectResult( '<p>Foobar</p>' );
  934. } );
  935. it( 'default conversion, inside text, collapsed, no name', () => {
  936. downcastHelpers.markerToData( { model: 'search' } );
  937. setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
  938. model.change( writer => {
  939. writer.addMarker( 'search', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  940. } );
  941. expectResult( '<p>Foo<search-start></search-start><search-end></search-end>bar</p>' );
  942. model.change( writer => {
  943. writer.removeMarker( 'search' );
  944. } );
  945. expectResult( '<p>Foobar</p>' );
  946. } );
  947. it( 'default conversion, inside text, collapsed, multiple markers, no name', () => {
  948. downcastHelpers.markerToData( { model: 'group' } );
  949. setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
  950. model.change( writer => {
  951. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  952. writer.addMarker( 'group:abc', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  953. } );
  954. expectResult(
  955. '<p>' +
  956. 'Foo' +
  957. '<group-start name="abc"></group-start><group-end name="abc"></group-end>' +
  958. '<group-start name="foo"></group-start><group-end name="foo"></group-end>' +
  959. 'bar' +
  960. '</p>'
  961. );
  962. model.change( writer => {
  963. writer.removeMarker( 'group:foo' );
  964. writer.removeMarker( 'group:abc' );
  965. } );
  966. expectResult( '<p>Foobar</p>' );
  967. } );
  968. it( 'default conversion, on two elements, no name', () => {
  969. downcastHelpers.markerToData( { model: 'search' } );
  970. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  971. model.change( writer => {
  972. const range = writer.createRangeIn( root );
  973. writer.addMarker( 'search', { range, usingOperation: false } );
  974. } );
  975. expectResult( '<p data-search-start-before="">Foo</p><p data-search-end-after="">Bar</p>' );
  976. model.change( writer => {
  977. writer.removeMarker( 'search' );
  978. } );
  979. expectResult( '<p>Foo</p><p>Bar</p>' );
  980. } );
  981. it( 'default conversion, on two elements, name', () => {
  982. downcastHelpers.markerToData( { model: 'group' } );
  983. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  984. model.change( writer => {
  985. const range = writer.createRangeIn( root );
  986. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  987. } );
  988. expectResult( '<p data-group-start-before="foo:bar:baz">Foo</p><p data-group-end-after="foo:bar:baz">Bar</p>' );
  989. model.change( writer => {
  990. writer.removeMarker( 'group:foo:bar:baz' );
  991. } );
  992. expectResult( '<p>Foo</p><p>Bar</p>' );
  993. } );
  994. it( 'default conversion, on one element, name', () => {
  995. downcastHelpers.markerToData( { model: 'group' } );
  996. setModelData( model, '<paragraph>Foobar</paragraph>' );
  997. model.change( writer => {
  998. const range = writer.createRangeIn( root );
  999. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1000. } );
  1001. expectResult( '<p data-group-end-after="foo:bar:baz" data-group-start-before="foo:bar:baz">Foobar</p>' );
  1002. model.change( writer => {
  1003. writer.removeMarker( 'group:foo:bar:baz' );
  1004. } );
  1005. expectResult( '<p>Foobar</p>' );
  1006. } );
  1007. it( 'default conversion, collapsed before element, name', () => {
  1008. downcastHelpers.markerToData( { model: 'group' } );
  1009. setModelData( model, '<paragraph>Foobar</paragraph>' );
  1010. model.change( writer => {
  1011. // Collapsed before <paragraph>.
  1012. const range = writer.createRange(
  1013. writer.createPositionFromPath( root, [ 0 ] )
  1014. );
  1015. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1016. } );
  1017. expectResult( '<p data-group-end-before="foo:bar:baz" data-group-start-before="foo:bar:baz">Foobar</p>' );
  1018. model.change( writer => {
  1019. writer.removeMarker( 'group:foo:bar:baz' );
  1020. } );
  1021. expectResult( '<p>Foobar</p>' );
  1022. } );
  1023. it( 'default conversion, collapsed after element, name', () => {
  1024. downcastHelpers.markerToData( { model: 'group' } );
  1025. setModelData( model, '<paragraph>Foobar</paragraph>' );
  1026. model.change( writer => {
  1027. // Collapsed before <paragraph>.
  1028. const range = writer.createRange(
  1029. writer.createPositionFromPath( root, [ 1 ] )
  1030. );
  1031. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1032. } );
  1033. expectResult( '<p data-group-end-after="foo:bar:baz" data-group-start-after="foo:bar:baz">Foobar</p>' );
  1034. model.change( writer => {
  1035. writer.removeMarker( 'group:foo:bar:baz' );
  1036. } );
  1037. expectResult( '<p>Foobar</p>' );
  1038. } );
  1039. it( 'default conversion, mixed, multiple markers, name', () => {
  1040. downcastHelpers.markerToData( { model: 'group' } );
  1041. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1042. model.change( writer => {
  1043. const range = writer.createRange(
  1044. writer.createPositionFromPath( root, [ 0 ] ),
  1045. writer.createPositionFromPath( root, [ 1, 2 ] )
  1046. );
  1047. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1048. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1049. } );
  1050. expectResult(
  1051. '<p data-group-start-before="abc:xyz,foo:bar">Foo</p>' +
  1052. '<p>Ba<group-end name="abc:xyz"></group-end><group-end name="foo:bar"></group-end>r</p>'
  1053. );
  1054. model.change( writer => {
  1055. writer.removeMarker( 'group:foo:bar' );
  1056. writer.removeMarker( 'group:abc:xyz' );
  1057. } );
  1058. expectResult( '<p>Foo</p><p>Bar</p>' );
  1059. } );
  1060. it( 'default conversion, mixed #2, multiple markers, name', () => {
  1061. downcastHelpers.markerToData( { model: 'group' } );
  1062. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1063. model.change( writer => {
  1064. const range = writer.createRange(
  1065. writer.createPositionFromPath( root, [ 0, 1 ] ),
  1066. writer.createPositionFromPath( root, [ 2 ] )
  1067. );
  1068. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1069. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1070. } );
  1071. expectResult(
  1072. '<p>F<group-start name="abc:xyz"></group-start><group-start name="foo:bar"></group-start>oo</p>' +
  1073. '<p data-group-end-after="abc:xyz,foo:bar">Bar</p>'
  1074. );
  1075. model.change( writer => {
  1076. writer.removeMarker( 'group:foo:bar' );
  1077. writer.removeMarker( 'group:abc:xyz' );
  1078. } );
  1079. expectResult( '<p>Foo</p><p>Bar</p>' );
  1080. } );
  1081. it( 'default conversion, mixed #3, multiple markers, name', () => {
  1082. downcastHelpers.markerToData( { model: 'group' } );
  1083. setModelData( model, '<paragraph>Foo</paragraph>' );
  1084. model.change( writer => {
  1085. const range = writer.createRange(
  1086. writer.createPositionFromPath( root, [ 0 ] ),
  1087. writer.createPositionFromPath( root, [ 0, 2 ] )
  1088. );
  1089. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1090. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1091. } );
  1092. expectResult(
  1093. '<p data-group-start-before="abc:xyz,foo:bar">' +
  1094. 'Fo<group-end name="abc:xyz"></group-end><group-end name="foo:bar"></group-end>o' +
  1095. '</p>'
  1096. );
  1097. model.change( writer => {
  1098. writer.removeMarker( 'group:foo:bar' );
  1099. writer.removeMarker( 'group:abc:xyz' );
  1100. } );
  1101. expectResult( '<p>Foo</p>' );
  1102. } );
  1103. it( 'default conversion, mixed #4, multiple markers, name', () => {
  1104. downcastHelpers.markerToData( { model: 'group' } );
  1105. setModelData( model, '<paragraph>Foo</paragraph>' );
  1106. model.change( writer => {
  1107. const range = writer.createRange(
  1108. writer.createPositionFromPath( root, [ 0, 2 ] ),
  1109. writer.createPositionFromPath( root, [ 1 ] )
  1110. );
  1111. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1112. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1113. } );
  1114. expectResult(
  1115. '<p data-group-end-after="abc:xyz,foo:bar">' +
  1116. 'Fo<group-start name="abc:xyz"></group-start><group-start name="foo:bar"></group-start>o' +
  1117. '</p>'
  1118. );
  1119. model.change( writer => {
  1120. writer.removeMarker( 'group:foo:bar' );
  1121. writer.removeMarker( 'group:abc:xyz' );
  1122. } );
  1123. expectResult( '<p>Foo</p>' );
  1124. } );
  1125. it( 'conversion callback, mixed, multiple markers, name', () => {
  1126. const customData = {
  1127. foo: 'bar',
  1128. abc: 'xyz'
  1129. };
  1130. downcastHelpers.markerToData( {
  1131. model: 'group',
  1132. view: ( markerName, conversionApi ) => {
  1133. const namePart = markerName.split( ':' )[ 1 ];
  1134. // To ensure conversion API is provided.
  1135. expect( conversionApi.writer ).to.instanceof( DowncastWriter );
  1136. return {
  1137. group: 'g',
  1138. name: namePart + '_' + customData[ namePart ]
  1139. };
  1140. }
  1141. } );
  1142. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1143. model.change( writer => {
  1144. const range = writer.createRange(
  1145. writer.createPositionFromPath( root, [ 0 ] ),
  1146. writer.createPositionFromPath( root, [ 1, 2 ] )
  1147. );
  1148. writer.addMarker( 'group:foo', { range, usingOperation: false } );
  1149. writer.addMarker( 'group:abc', { range, usingOperation: false } );
  1150. } );
  1151. expectResult(
  1152. '<p data-g-start-before="abc_xyz,foo_bar">Foo</p>' +
  1153. '<p>Ba<g-end name="abc_xyz"></g-end><g-end name="foo_bar"></g-end>r</p>'
  1154. );
  1155. model.change( writer => {
  1156. writer.removeMarker( 'group:foo' );
  1157. writer.removeMarker( 'group:abc' );
  1158. } );
  1159. expectResult( '<p>Foo</p><p>Bar</p>' );
  1160. } );
  1161. it( 'conversion callback, mixed #2, multiple markers, name', () => {
  1162. const customData = {
  1163. foo: 'bar',
  1164. abc: 'xyz'
  1165. };
  1166. downcastHelpers.markerToData( {
  1167. model: 'group',
  1168. view: markerName => {
  1169. const namePart = markerName.split( ':' )[ 1 ];
  1170. return {
  1171. group: 'g',
  1172. name: namePart + '_' + customData[ namePart ]
  1173. };
  1174. }
  1175. } );
  1176. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1177. model.change( writer => {
  1178. const range = writer.createRange(
  1179. writer.createPositionFromPath( root, [ 0, 1 ] ),
  1180. writer.createPositionFromPath( root, [ 2 ] )
  1181. );
  1182. writer.addMarker( 'group:foo', { range, usingOperation: false } );
  1183. writer.addMarker( 'group:abc', { range, usingOperation: false } );
  1184. } );
  1185. expectResult(
  1186. '<p>F<g-start name="abc_xyz"></g-start><g-start name="foo_bar"></g-start>oo</p>' +
  1187. '<p data-g-end-after="abc_xyz,foo_bar">Bar</p>'
  1188. );
  1189. model.change( writer => {
  1190. writer.removeMarker( 'group:foo' );
  1191. writer.removeMarker( 'group:abc' );
  1192. } );
  1193. expectResult( '<p>Foo</p><p>Bar</p>' );
  1194. } );
  1195. it( 'can be overwritten using converterPriority', () => {
  1196. downcastHelpers.markerToData( {
  1197. model: 'group'
  1198. } );
  1199. downcastHelpers.markerToData( {
  1200. model: 'group',
  1201. view: markerName => {
  1202. const name = markerName.split( ':' )[ 1 ];
  1203. return {
  1204. group: 'g',
  1205. name
  1206. };
  1207. },
  1208. converterPriority: 'high'
  1209. } );
  1210. setModelData( model, '<paragraph>F[ooba]r</paragraph>' );
  1211. model.change( writer => {
  1212. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1213. } );
  1214. expectResult(
  1215. '<p>F<g-start name="foo"></g-start>ooba<g-end name="foo"></g-end>r</p>'
  1216. );
  1217. model.change( writer => {
  1218. writer.removeMarker( 'group:foo' );
  1219. } );
  1220. expectResult( '<p>Foobar</p>' );
  1221. } );
  1222. it( 'can be overwritten by custom callback', () => {
  1223. downcastHelpers.markerToData( {
  1224. model: 'group'
  1225. } );
  1226. downcastHelpers.add( dispatcher => {
  1227. dispatcher.on( 'addMarker:group', ( evt, data, conversionApi ) => {
  1228. conversionApi.consumable.consume( data.markerRange, evt.name );
  1229. }, { priority: 'high' } );
  1230. } );
  1231. setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
  1232. model.change( writer => {
  1233. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1234. } );
  1235. expectResult( '<p>Foobar</p>' );
  1236. model.change( writer => {
  1237. writer.removeMarker( 'group:foo' );
  1238. } );
  1239. expectResult( '<p>Foobar</p>' );
  1240. } );
  1241. it( 'should not perform conversion if the callback returned falsy value', () => {
  1242. downcastHelpers.markerToData( {
  1243. model: 'group',
  1244. view: () => false
  1245. } );
  1246. setModelData( model, '<paragraph>F[ooba]r</paragraph>' );
  1247. model.change( writer => {
  1248. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1249. } );
  1250. expectResult( '<p>Foobar</p>' );
  1251. model.change( writer => {
  1252. writer.removeMarker( 'group:foo' );
  1253. } );
  1254. expectResult( '<p>Foobar</p>' );
  1255. } );
  1256. } );
  1257. describe( 'markerToHighlight()', () => {
  1258. it( 'should be chainable', () => {
  1259. expect( downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } ) ).to.equal( downcastHelpers );
  1260. } );
  1261. it( 'config.view is a highlight descriptor', () => {
  1262. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  1263. model.change( writer => {
  1264. writer.insertText( 'foo', modelRoot, 0 );
  1265. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  1266. writer.addMarker( 'comment', { range, usingOperation: false } );
  1267. } );
  1268. expectResult( '<span class="comment">foo</span>' );
  1269. } );
  1270. it( 'can be overwritten using converterPriority', () => {
  1271. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  1272. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'new-comment' }, converterPriority: 'high' } );
  1273. model.change( writer => {
  1274. writer.insertText( 'foo', modelRoot, 0 );
  1275. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  1276. writer.addMarker( 'comment', { range, usingOperation: false } );
  1277. } );
  1278. expectResult( '<span class="new-comment">foo</span>' );
  1279. } );
  1280. it( 'config.view is a function', () => {
  1281. downcastHelpers.markerToHighlight( {
  1282. model: 'comment',
  1283. view: ( data, conversionApi ) => {
  1284. const commentType = data.markerName.split( ':' )[ 1 ];
  1285. // To ensure conversion API is provided.
  1286. expect( conversionApi.writer ).to.instanceof( DowncastWriter );
  1287. return {
  1288. classes: [ 'comment', 'comment-' + commentType ]
  1289. };
  1290. }
  1291. } );
  1292. model.change( writer => {
  1293. writer.insertText( 'foo', modelRoot, 0 );
  1294. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  1295. writer.addMarker( 'comment:abc', { range, usingOperation: false } );
  1296. } );
  1297. expectResult( '<span class="comment comment-abc">foo</span>' );
  1298. } );
  1299. describe( 'highlight', () => {
  1300. const highlightConfig = {
  1301. model: 'marker',
  1302. view: {
  1303. classes: 'highlight-class',
  1304. attributes: { title: 'title' }
  1305. },
  1306. converterPriority: 7
  1307. };
  1308. describe( 'on text', () => {
  1309. let markerRange;
  1310. beforeEach( () => {
  1311. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1312. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  1313. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  1314. model.change( writer => {
  1315. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  1316. } );
  1317. markerRange = model.createRangeIn( modelRoot );
  1318. } );
  1319. it( 'should wrap and unwrap text nodes', () => {
  1320. downcastHelpers.markerToHighlight( highlightConfig );
  1321. model.change( writer => {
  1322. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1323. } );
  1324. expect( viewToString( viewRoot ) ).to.equal(
  1325. '<div>' +
  1326. '<p>' +
  1327. '<span class="highlight-class" title="title">foo</span>' +
  1328. '</p>' +
  1329. '<p>' +
  1330. '<span class="highlight-class" title="title">bar</span>' +
  1331. '</p>' +
  1332. '</div>'
  1333. );
  1334. model.change( writer => {
  1335. writer.removeMarker( 'marker' );
  1336. } );
  1337. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1338. } );
  1339. it( 'should be possible to overwrite', () => {
  1340. downcastHelpers.markerToHighlight( highlightConfig );
  1341. downcastHelpers.markerToHighlight( {
  1342. model: 'marker',
  1343. view: { classes: 'override-class' },
  1344. converterPriority: 'high'
  1345. } );
  1346. model.change( writer => {
  1347. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1348. } );
  1349. expect( viewToString( viewRoot ) ).to.equal(
  1350. '<div>' +
  1351. '<p>' +
  1352. '<span class="override-class">foo</span>' +
  1353. '</p>' +
  1354. '<p>' +
  1355. '<span class="override-class">bar</span>' +
  1356. '</p>' +
  1357. '</div>'
  1358. );
  1359. model.change( writer => {
  1360. writer.removeMarker( 'marker' );
  1361. } );
  1362. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1363. } );
  1364. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  1365. downcastHelpers.markerToHighlight( {
  1366. model: 'marker',
  1367. view: () => null,
  1368. converterPriority: 'high'
  1369. } );
  1370. model.change( writer => {
  1371. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1372. } );
  1373. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1374. model.change( writer => {
  1375. writer.removeMarker( 'marker' );
  1376. } );
  1377. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1378. } );
  1379. it( 'should do nothing if collapsed marker is converted', () => {
  1380. downcastHelpers.markerToHighlight( {
  1381. model: 'marker',
  1382. view: { classes: 'foo' },
  1383. converterPriority: 'high'
  1384. } );
  1385. markerRange = model.createRange( model.createPositionAt( modelRoot, 0 ), model.createPositionAt( modelRoot, 0 ) );
  1386. model.change( writer => {
  1387. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1388. } );
  1389. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1390. model.change( () => {
  1391. model.markers._remove( 'marker' );
  1392. } );
  1393. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1394. } );
  1395. it( 'should correctly wrap and unwrap multiple, intersecting markers', () => {
  1396. downcastHelpers.markerToHighlight( {
  1397. model: 'markerFoo',
  1398. view: { classes: 'foo' }
  1399. } );
  1400. downcastHelpers.markerToHighlight( {
  1401. model: 'markerBar',
  1402. view: { classes: 'bar' }
  1403. } );
  1404. downcastHelpers.markerToHighlight( {
  1405. model: 'markerXyz',
  1406. view: { classes: 'xyz' }
  1407. } );
  1408. const p1 = modelRoot.getChild( 0 );
  1409. const p2 = modelRoot.getChild( 1 );
  1410. model.change( writer => {
  1411. const range = writer.createRange( writer.createPositionAt( p1, 0 ), writer.createPositionAt( p1, 3 ) );
  1412. writer.addMarker( 'markerFoo', { range, usingOperation: false } );
  1413. } );
  1414. expect( viewToString( viewRoot ) ).to.equal(
  1415. '<div>' +
  1416. '<p>' +
  1417. '<span class="foo">foo</span>' +
  1418. '</p>' +
  1419. '<p>bar</p>' +
  1420. '</div>'
  1421. );
  1422. model.change( writer => {
  1423. const range = writer.createRange( writer.createPositionAt( p1, 1 ), writer.createPositionAt( p2, 2 ) );
  1424. writer.addMarker( 'markerBar', { range, usingOperation: false } );
  1425. } );
  1426. expect( viewToString( viewRoot ) ).to.equal(
  1427. '<div>' +
  1428. '<p>' +
  1429. '<span class="foo">f</span>' +
  1430. '<span class="bar">' +
  1431. '<span class="foo">oo</span>' +
  1432. '</span>' +
  1433. '</p>' +
  1434. '<p>' +
  1435. '<span class="bar">ba</span>' +
  1436. 'r' +
  1437. '</p>' +
  1438. '</div>'
  1439. );
  1440. model.change( writer => {
  1441. const range = writer.createRange( writer.createPositionAt( p1, 2 ), writer.createPositionAt( p2, 3 ) );
  1442. writer.addMarker( 'markerXyz', { range, usingOperation: false } );
  1443. } );
  1444. expect( viewToString( viewRoot ) ).to.equal(
  1445. '<div>' +
  1446. '<p>' +
  1447. '<span class="foo">f</span>' +
  1448. '<span class="bar">' +
  1449. '<span class="foo">' +
  1450. 'o' +
  1451. '<span class="xyz">o</span>' +
  1452. '</span>' +
  1453. '</span>' +
  1454. '</p>' +
  1455. '<p>' +
  1456. '<span class="bar">' +
  1457. '<span class="xyz">ba</span>' +
  1458. '</span>' +
  1459. '<span class="xyz">r</span>' +
  1460. '</p>' +
  1461. '</div>'
  1462. );
  1463. model.change( writer => {
  1464. writer.removeMarker( 'markerBar' );
  1465. } );
  1466. expect( viewToString( viewRoot ) ).to.equal(
  1467. '<div>' +
  1468. '<p>' +
  1469. '<span class="foo">' +
  1470. 'fo' +
  1471. '<span class="xyz">o</span>' +
  1472. '</span>' +
  1473. '</p>' +
  1474. '<p>' +
  1475. '<span class="xyz">bar</span>' +
  1476. '</p>' +
  1477. '</div>'
  1478. );
  1479. model.change( writer => {
  1480. writer.removeMarker( 'markerFoo' );
  1481. } );
  1482. expect( viewToString( viewRoot ) ).to.equal(
  1483. '<div>' +
  1484. '<p>' +
  1485. 'fo' +
  1486. '<span class="xyz">o</span>' +
  1487. '</p>' +
  1488. '<p>' +
  1489. '<span class="xyz">bar</span>' +
  1490. '</p>' +
  1491. '</div>'
  1492. );
  1493. model.change( writer => {
  1494. writer.removeMarker( 'markerXyz' );
  1495. } );
  1496. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1497. } );
  1498. it( 'should do nothing if marker is applied and removed on empty-ish range', () => {
  1499. downcastHelpers.markerToHighlight( highlightConfig );
  1500. const p1 = modelRoot.getChild( 0 );
  1501. const p2 = modelRoot.getChild( 1 );
  1502. const markerRange = model.createRange( model.createPositionAt( p1, 3 ), model.createPositionAt( p2, 0 ) );
  1503. model.change( writer => {
  1504. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1505. } );
  1506. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1507. model.change( writer => {
  1508. writer.removeMarker( 'marker', { range: markerRange, usingOperation: false } );
  1509. } );
  1510. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1511. } );
  1512. } );
  1513. describe( 'on element', () => {
  1514. const highlightConfig = {
  1515. model: 'marker',
  1516. view: {
  1517. classes: 'highlight-class',
  1518. attributes: { title: 'title' },
  1519. id: 'customId'
  1520. },
  1521. converterPriority: 7
  1522. };
  1523. let markerRange, viewDocument;
  1524. beforeEach( () => {
  1525. viewDocument = new ViewDocument( new StylesProcessor() );
  1526. downcastHelpers.elementToElement( {
  1527. model: 'div',
  1528. view: () => {
  1529. const viewContainer = new ViewContainerElement( viewDocument, 'div' );
  1530. viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => {
  1531. writer.addClass( descriptor.classes, element );
  1532. } );
  1533. viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => {
  1534. writer.setAttribute( 'class', '', element );
  1535. } );
  1536. return viewContainer;
  1537. }
  1538. } );
  1539. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  1540. model.change( writer => {
  1541. writer.insert( modelElement, modelRootStart );
  1542. } );
  1543. markerRange = model.createRangeOn( modelElement );
  1544. downcastHelpers.markerToHighlight( highlightConfig );
  1545. } );
  1546. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  1547. model.change( writer => {
  1548. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1549. } );
  1550. expect( viewToString( viewRoot ) ).to.equal(
  1551. '<div>' +
  1552. '<div class="highlight-class">' +
  1553. 'foo' +
  1554. '</div>' +
  1555. '</div>'
  1556. );
  1557. model.change( writer => {
  1558. writer.removeMarker( 'marker' );
  1559. } );
  1560. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1561. } );
  1562. it( 'should be possible to override', () => {
  1563. downcastHelpers.markerToHighlight( {
  1564. model: 'marker',
  1565. view: { classes: 'override-class' },
  1566. converterPriority: 'high'
  1567. } );
  1568. model.change( writer => {
  1569. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1570. } );
  1571. expect( viewToString( viewRoot ) ).to.equal(
  1572. '<div>' +
  1573. '<div class="override-class">' +
  1574. 'foo' +
  1575. '</div>' +
  1576. '</div>'
  1577. );
  1578. model.change( writer => {
  1579. writer.removeMarker( 'marker' );
  1580. } );
  1581. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1582. } );
  1583. it( 'should use default priority and id if not provided', () => {
  1584. const viewDiv = viewRoot.getChild( 0 );
  1585. downcastHelpers.markerToHighlight( {
  1586. model: 'marker2',
  1587. view: () => null,
  1588. converterPriority: 'high'
  1589. } );
  1590. viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  1591. expect( descriptor.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1592. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  1593. } );
  1594. viewDiv._setCustomProperty( 'removeHighlight', ( element, id ) => {
  1595. expect( id ).to.equal( 'marker:foo-bar-baz' );
  1596. } );
  1597. model.change( writer => {
  1598. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  1599. } );
  1600. } );
  1601. it( 'should do nothing if descriptor is not provided', () => {
  1602. downcastHelpers.markerToHighlight( {
  1603. model: 'marker2',
  1604. view: () => null
  1605. } );
  1606. model.change( writer => {
  1607. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  1608. } );
  1609. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1610. model.change( writer => {
  1611. writer.removeMarker( 'marker2' );
  1612. } );
  1613. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1614. } );
  1615. } );
  1616. } );
  1617. } );
  1618. function expectResult( string ) {
  1619. expect( stringifyView( viewRoot, null, { ignoreRoot: true } ) ).to.equal( string );
  1620. }
  1621. } );
  1622. describe( 'downcast converters', () => {
  1623. let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model;
  1624. beforeEach( () => {
  1625. model = new Model();
  1626. modelDoc = model.document;
  1627. modelRoot = modelDoc.createRoot();
  1628. controller = new EditingController( model, new StylesProcessor() );
  1629. viewRoot = controller.view.document.getRoot();
  1630. // Set name of view root the same as dom root.
  1631. // This is a mock of attaching view root to dom root.
  1632. controller.view.document.getRoot()._name = 'div';
  1633. dispatcher = controller.downcastDispatcher;
  1634. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1635. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1636. modelRootStart = model.createPositionAt( modelRoot, 0 );
  1637. } );
  1638. describe( 'insertText()', () => {
  1639. it( 'should downcast text', () => {
  1640. model.change( writer => {
  1641. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  1642. } );
  1643. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  1644. } );
  1645. it( 'should support unicode', () => {
  1646. model.change( writer => {
  1647. writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
  1648. } );
  1649. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  1650. } );
  1651. it( 'should be possible to override it', () => {
  1652. dispatcher.on( 'insert:$text', ( evt, data, conversionApi ) => {
  1653. conversionApi.consumable.consume( data.item, 'insert' );
  1654. }, { converterPriority: 'high' } );
  1655. model.change( writer => {
  1656. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  1657. } );
  1658. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  1659. } );
  1660. } );
  1661. // Remove converter is by default already added in `EditingController` instance.
  1662. describe( 'remove()', () => {
  1663. let viewDocument;
  1664. beforeEach( () => {
  1665. viewDocument = new ViewDocument( new StylesProcessor() );
  1666. } );
  1667. it( 'should remove items from view accordingly to changes in model #1', () => {
  1668. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  1669. model.change( writer => {
  1670. writer.insert( modelElement, modelRootStart );
  1671. } );
  1672. model.change( writer => {
  1673. writer.remove(
  1674. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  1675. );
  1676. } );
  1677. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  1678. } );
  1679. it( 'should be possible to overwrite', () => {
  1680. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  1681. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  1682. model.change( writer => {
  1683. writer.insert( modelElement, modelRootStart );
  1684. } );
  1685. model.change( writer => {
  1686. writer.remove(
  1687. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  1688. );
  1689. } );
  1690. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1691. } );
  1692. it( 'should support unicode', () => {
  1693. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  1694. model.change( writer => {
  1695. writer.insert( modelElement, modelRootStart );
  1696. } );
  1697. model.change( writer => {
  1698. writer.remove(
  1699. writer.createRange( writer.createPositionAt( modelElement, 0 ), writer.createPositionAt( modelElement, 6 ) )
  1700. );
  1701. } );
  1702. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  1703. } );
  1704. it( 'should not remove view ui elements that are placed next to removed content', () => {
  1705. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  1706. viewRoot._appendChild( [
  1707. new ViewText( viewDocument, 'foz' ),
  1708. new ViewUIElement( viewDocument, 'span' ),
  1709. new ViewText( viewDocument, 'bar' )
  1710. ] );
  1711. // Remove 'b'.
  1712. model.change( writer => {
  1713. writer.remove(
  1714. writer.createRange( writer.createPositionAt( modelRoot, 3 ), writer.createPositionAt( modelRoot, 4 ) )
  1715. );
  1716. } );
  1717. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  1718. // Remove 'z'.
  1719. model.change( writer => {
  1720. writer.remove(
  1721. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 3 ) )
  1722. );
  1723. } );
  1724. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  1725. } );
  1726. it( 'should remove correct amount of text when it is split by view ui element', () => {
  1727. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  1728. viewRoot._appendChild( [
  1729. new ViewText( viewDocument, 'foz' ),
  1730. new ViewUIElement( viewDocument, 'span' ),
  1731. new ViewText( viewDocument, 'bar' )
  1732. ] );
  1733. // Remove 'z<span></span>b'.
  1734. model.change( writer => {
  1735. writer.remove(
  1736. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 4 ) )
  1737. );
  1738. } );
  1739. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  1740. } );
  1741. it( 'should unbind elements', () => {
  1742. const modelElement = new ModelElement( 'paragraph' );
  1743. model.change( writer => {
  1744. writer.insert( modelElement, modelRootStart );
  1745. } );
  1746. const viewElement = controller.mapper.toViewElement( modelElement );
  1747. expect( viewElement ).not.to.be.undefined;
  1748. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  1749. model.change( writer => {
  1750. writer.remove( modelElement );
  1751. } );
  1752. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  1753. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  1754. } );
  1755. it( 'should not break when remove() is used as part of unwrapping', () => {
  1756. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  1757. const modelWidget = new ModelElement( 'widget', null, modelP );
  1758. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1759. downcastHelpers.elementToElement( { model: 'widget', view: 'widget' } );
  1760. model.change( writer => {
  1761. writer.insert( modelWidget, modelRootStart );
  1762. } );
  1763. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  1764. const viewP = controller.mapper.toViewElement( modelP );
  1765. expect( viewP ).not.to.be.undefined;
  1766. model.change( writer => {
  1767. writer.unwrap( modelWidget );
  1768. } );
  1769. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  1770. // `modelP` is now bound with newly created view element.
  1771. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  1772. // `viewP` is no longer bound with model element.
  1773. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  1774. // View element from view root is bound to `modelP`.
  1775. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  1776. } );
  1777. it( 'should work correctly if container element after ui element is removed', () => {
  1778. // Prepare a model and view structure.
  1779. // This is done outside of conversion to put view ui elements inside easily.
  1780. const modelP1 = new ModelElement( 'paragraph' );
  1781. const modelP2 = new ModelElement( 'paragraph' );
  1782. const viewP1 = new ViewContainerElement( viewDocument, 'p' );
  1783. const viewUi1 = new ViewUIElement( viewDocument, 'span' );
  1784. const viewUi2 = new ViewUIElement( viewDocument, 'span' );
  1785. const viewP2 = new ViewContainerElement( viewDocument, 'p' );
  1786. modelRoot._appendChild( [ modelP1, modelP2 ] );
  1787. viewRoot._appendChild( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  1788. controller.mapper.bindElements( modelP1, viewP1 );
  1789. controller.mapper.bindElements( modelP2, viewP2 );
  1790. // Remove second paragraph element.
  1791. model.change( writer => {
  1792. writer.remove( writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) ) );
  1793. } );
  1794. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  1795. } );
  1796. it( 'should work correctly if container element after text node is removed', () => {
  1797. const modelText = new ModelText( 'foo' );
  1798. const modelP = new ModelElement( 'paragraph' );
  1799. model.change( writer => {
  1800. writer.insert( [ modelText, modelP ], modelRootStart );
  1801. } );
  1802. model.change( writer => {
  1803. writer.remove( modelP );
  1804. } );
  1805. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  1806. } );
  1807. } );
  1808. describe( 'createViewElementFromHighlightDescriptor()', () => {
  1809. let viewWriter;
  1810. beforeEach( () => {
  1811. viewWriter = new DowncastWriter( controller.view.document );
  1812. } );
  1813. it( 'should return attribute element from descriptor object', () => {
  1814. const descriptor = {
  1815. classes: 'foo-class',
  1816. attributes: { one: '1', two: '2' },
  1817. priority: 7
  1818. };
  1819. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1820. expect( element.is( 'attributeElement' ) ).to.be.true;
  1821. expect( element.name ).to.equal( 'span' );
  1822. expect( element.priority ).to.equal( 7 );
  1823. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1824. for ( const key of Object.keys( descriptor.attributes ) ) {
  1825. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1826. }
  1827. } );
  1828. it( 'should return attribute element from descriptor object - array with classes', () => {
  1829. const descriptor = {
  1830. classes: [ 'foo-class', 'bar-class' ],
  1831. attributes: { one: '1', two: '2' },
  1832. priority: 7
  1833. };
  1834. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1835. expect( element.is( 'attributeElement' ) ).to.be.true;
  1836. expect( element.name ).to.equal( 'span' );
  1837. expect( element.priority ).to.equal( 7 );
  1838. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1839. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  1840. for ( const key of Object.keys( descriptor.attributes ) ) {
  1841. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1842. }
  1843. } );
  1844. it( 'should create element without class', () => {
  1845. const descriptor = {
  1846. attributes: { one: '1', two: '2' },
  1847. priority: 7
  1848. };
  1849. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1850. expect( element.is( 'attributeElement' ) ).to.be.true;
  1851. expect( element.name ).to.equal( 'span' );
  1852. expect( element.priority ).to.equal( 7 );
  1853. for ( const key of Object.keys( descriptor.attributes ) ) {
  1854. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1855. }
  1856. } );
  1857. it( 'should create element without priority', () => {
  1858. const descriptor = {
  1859. classes: 'foo-class',
  1860. attributes: { one: '1', two: '2' }
  1861. };
  1862. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1863. expect( element.is( 'attributeElement' ) ).to.be.true;
  1864. expect( element.name ).to.equal( 'span' );
  1865. expect( element.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1866. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1867. for ( const key of Object.keys( descriptor.attributes ) ) {
  1868. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1869. }
  1870. } );
  1871. it( 'should create element without attributes', () => {
  1872. const descriptor = {
  1873. classes: 'foo-class',
  1874. priority: 7
  1875. };
  1876. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1877. expect( element.is( 'attributeElement' ) ).to.be.true;
  1878. expect( element.name ).to.equal( 'span' );
  1879. expect( element.priority ).to.equal( 7 );
  1880. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1881. } );
  1882. } );
  1883. } );
  1884. describe( 'downcast selection converters', () => {
  1885. let dispatcher, mapper, model, view, modelDoc, modelRoot, docSelection, viewDoc, viewRoot, viewSelection, downcastHelpers;
  1886. beforeEach( () => {
  1887. model = new Model();
  1888. modelDoc = model.document;
  1889. modelRoot = modelDoc.createRoot();
  1890. docSelection = modelDoc.selection;
  1891. model.schema.extend( '$text', { allowIn: '$root' } );
  1892. view = new View( new StylesProcessor() );
  1893. viewDoc = view.document;
  1894. viewRoot = createViewRoot( viewDoc );
  1895. viewSelection = viewDoc.selection;
  1896. mapper = new Mapper();
  1897. mapper.bindElements( modelRoot, viewRoot );
  1898. dispatcher = new DowncastDispatcher( { mapper, viewSelection } );
  1899. dispatcher.on( 'insert:$text', insertText() );
  1900. downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1901. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  1902. downcastHelpers.markerToHighlight( { model: 'marker', view: { classes: 'marker' }, converterPriority: 1 } );
  1903. // Default selection converters.
  1904. dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
  1905. dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  1906. dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  1907. } );
  1908. afterEach( () => {
  1909. view.destroy();
  1910. } );
  1911. describe( 'default converters', () => {
  1912. describe( 'range selection', () => {
  1913. it( 'in same container', () => {
  1914. testSelection(
  1915. [ 1, 4 ],
  1916. 'foobar',
  1917. 'f{oob}ar'
  1918. );
  1919. } );
  1920. it( 'in same container with unicode characters', () => {
  1921. testSelection(
  1922. [ 2, 6 ],
  1923. 'நிலைக்கு',
  1924. 'நி{லைக்}கு'
  1925. );
  1926. } );
  1927. it( 'in same container, over attribute', () => {
  1928. testSelection(
  1929. [ 1, 5 ],
  1930. 'fo<$text bold="true">ob</$text>ar',
  1931. 'f{o<strong>ob</strong>a}r'
  1932. );
  1933. } );
  1934. it( 'in same container, next to attribute', () => {
  1935. testSelection(
  1936. [ 1, 2 ],
  1937. 'fo<$text bold="true">ob</$text>ar',
  1938. 'f{o}<strong>ob</strong>ar'
  1939. );
  1940. } );
  1941. it( 'in same attribute', () => {
  1942. testSelection(
  1943. [ 2, 4 ],
  1944. 'f<$text bold="true">ooba</$text>r',
  1945. 'f<strong>o{ob}a</strong>r'
  1946. );
  1947. } );
  1948. it( 'in same attribute, selection same as attribute', () => {
  1949. testSelection(
  1950. [ 2, 4 ],
  1951. 'fo<$text bold="true">ob</$text>ar',
  1952. 'fo{<strong>ob</strong>}ar'
  1953. );
  1954. } );
  1955. it( 'starts in text node, ends in attribute #1', () => {
  1956. testSelection(
  1957. [ 1, 3 ],
  1958. 'fo<$text bold="true">ob</$text>ar',
  1959. 'f{o<strong>o}b</strong>ar'
  1960. );
  1961. } );
  1962. it( 'starts in text node, ends in attribute #2', () => {
  1963. testSelection(
  1964. [ 1, 4 ],
  1965. 'fo<$text bold="true">ob</$text>ar',
  1966. 'f{o<strong>ob</strong>}ar'
  1967. );
  1968. } );
  1969. it( 'starts in attribute, ends in text node', () => {
  1970. testSelection(
  1971. [ 3, 5 ],
  1972. 'fo<$text bold="true">ob</$text>ar',
  1973. 'fo<strong>o{b</strong>a}r'
  1974. );
  1975. } );
  1976. it( 'consumes consumable values properly', () => {
  1977. // Add callback that will fire before default ones.
  1978. // This should prevent default callback doing anything.
  1979. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  1980. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  1981. }, { priority: 'high' } );
  1982. // Similar test case as the first in this suite.
  1983. testSelection(
  1984. [ 1, 4 ],
  1985. 'foobar',
  1986. 'foobar' // No selection in view.
  1987. );
  1988. } );
  1989. it( 'should convert backward selection', () => {
  1990. testSelection(
  1991. [ 1, 3, 'backward' ],
  1992. 'foobar',
  1993. 'f{oo}bar'
  1994. );
  1995. expect( viewSelection.focus.offset ).to.equal( 1 );
  1996. } );
  1997. } );
  1998. describe( 'collapsed selection', () => {
  1999. let marker, viewDocument;
  2000. beforeEach( () => {
  2001. viewDocument = new ViewDocument( new StylesProcessor() );
  2002. } );
  2003. it( 'in container', () => {
  2004. testSelection(
  2005. [ 1, 1 ],
  2006. 'foobar',
  2007. 'f{}oobar'
  2008. );
  2009. } );
  2010. it( 'in attribute', () => {
  2011. testSelection(
  2012. [ 3, 3 ],
  2013. 'f<$text bold="true">ooba</$text>r',
  2014. 'f<strong>oo{}ba</strong>r'
  2015. );
  2016. } );
  2017. it( 'in attribute and marker', () => {
  2018. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  2019. model.change( writer => {
  2020. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2021. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  2022. writer.setSelection( modelRoot, 3 );
  2023. } );
  2024. // Remove view children manually (without firing additional conversion).
  2025. viewRoot._removeChildren( 0, viewRoot.childCount );
  2026. // Convert model to view.
  2027. view.change( writer => {
  2028. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2029. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2030. dispatcher.convertSelection( docSelection, model.markers, writer );
  2031. } );
  2032. // Stringify view and check if it is same as expected.
  2033. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  2034. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  2035. );
  2036. } );
  2037. it( 'in attribute and marker - no attribute', () => {
  2038. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  2039. model.change( writer => {
  2040. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2041. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  2042. writer.setSelection( modelRoot, 3 );
  2043. writer.removeSelectionAttribute( 'bold' );
  2044. } );
  2045. // Remove view children manually (without firing additional conversion).
  2046. viewRoot._removeChildren( 0, viewRoot.childCount );
  2047. // Convert model to view.
  2048. view.change( writer => {
  2049. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2050. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2051. dispatcher.convertSelection( docSelection, model.markers, writer );
  2052. } );
  2053. // Stringify view and check if it is same as expected.
  2054. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2055. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  2056. } );
  2057. it( 'in marker - using highlight descriptor creator', () => {
  2058. downcastHelpers.markerToHighlight( {
  2059. model: 'marker2',
  2060. view: data => ( { classes: data.markerName } )
  2061. } );
  2062. setModelData( model, 'foobar' );
  2063. model.change( writer => {
  2064. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2065. marker = writer.addMarker( 'marker2', { range, usingOperation: false } );
  2066. writer.setSelection( modelRoot, 3 );
  2067. } );
  2068. // Remove view children manually (without firing additional conversion).
  2069. viewRoot._removeChildren( 0, viewRoot.childCount );
  2070. // Convert model to view.
  2071. view.change( writer => {
  2072. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2073. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2074. dispatcher.convertSelection( docSelection, model.markers, writer );
  2075. } );
  2076. // Stringify view and check if it is same as expected.
  2077. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2078. .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
  2079. } );
  2080. it( 'should do nothing if creator return null', () => {
  2081. downcastHelpers.markerToHighlight( {
  2082. model: 'marker3',
  2083. view: () => null
  2084. } );
  2085. setModelData( model, 'foobar' );
  2086. model.change( writer => {
  2087. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2088. marker = writer.addMarker( 'marker3', { range, usingOperation: false } );
  2089. writer.setSelection( modelRoot, 3 );
  2090. } );
  2091. // Remove view children manually (without firing additional conversion).
  2092. viewRoot._removeChildren( 0, viewRoot.childCount );
  2093. // Convert model to view.
  2094. view.change( writer => {
  2095. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2096. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2097. dispatcher.convertSelection( docSelection, model.markers, writer );
  2098. } );
  2099. // Stringify view and check if it is same as expected.
  2100. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2101. .to.equal( '<div>foo{}bar</div>' );
  2102. } );
  2103. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  2104. it( 'selection with attribute before ui element - no non-ui children', () => {
  2105. setModelData( model, '' );
  2106. // Add two ui elements to view.
  2107. viewRoot._appendChild( [
  2108. new ViewUIElement( viewDocument, 'span' ),
  2109. new ViewUIElement( viewDocument, 'span' )
  2110. ] );
  2111. model.change( writer => {
  2112. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 0 ] ) ) );
  2113. writer.setSelectionAttribute( 'bold', true );
  2114. } );
  2115. // Convert model to view.
  2116. view.change( writer => {
  2117. dispatcher.convertSelection( docSelection, model.markers, writer );
  2118. } );
  2119. // Stringify view and check if it is same as expected.
  2120. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2121. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  2122. } );
  2123. // #1072.
  2124. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  2125. setModelData( model, 'x' );
  2126. model.change( writer => {
  2127. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  2128. writer.setSelectionAttribute( 'bold', true );
  2129. } );
  2130. // Convert model to view.
  2131. view.change( writer => {
  2132. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2133. // Add ui element to view.
  2134. const uiElement = new ViewUIElement( viewDocument, 'span' );
  2135. viewRoot._insertChild( 1, uiElement );
  2136. dispatcher.convertSelection( docSelection, model.markers, writer );
  2137. } );
  2138. // Stringify view and check if it is same as expected.
  2139. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2140. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  2141. } );
  2142. // #1072.
  2143. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  2144. setModelData( model, '<$text bold="true">x</$text>y' );
  2145. model.change( writer => {
  2146. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  2147. writer.setSelectionAttribute( 'bold', true );
  2148. } );
  2149. // Convert model to view.
  2150. view.change( writer => {
  2151. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2152. // Add ui element to view.
  2153. const uiElement = new ViewUIElement( viewDocument, 'span' );
  2154. viewRoot._insertChild( 1, uiElement, writer );
  2155. dispatcher.convertSelection( docSelection, model.markers, writer );
  2156. } );
  2157. // Stringify view and check if it is same as expected.
  2158. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2159. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  2160. } );
  2161. it( 'consumes consumable values properly', () => {
  2162. // Add callbacks that will fire before default ones.
  2163. // This should prevent default callbacks doing anything.
  2164. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  2165. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  2166. }, { priority: 'high' } );
  2167. dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => {
  2168. expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
  2169. }, { priority: 'high' } );
  2170. // Similar test case as above.
  2171. testSelection(
  2172. [ 3, 3 ],
  2173. 'f<$text bold="true">ooba</$text>r',
  2174. 'foobar' // No selection in view and no attribute.
  2175. );
  2176. } );
  2177. } );
  2178. } );
  2179. describe( 'clean-up', () => {
  2180. describe( 'convertRangeSelection', () => {
  2181. it( 'should remove all ranges before adding new range', () => {
  2182. testSelection(
  2183. [ 0, 2 ],
  2184. 'foobar',
  2185. '{fo}obar'
  2186. );
  2187. testSelection(
  2188. [ 3, 5 ],
  2189. 'foobar',
  2190. 'foo{ba}r'
  2191. );
  2192. expect( viewSelection.rangeCount ).to.equal( 1 );
  2193. } );
  2194. } );
  2195. describe( 'convertCollapsedSelection', () => {
  2196. it( 'should remove all ranges before adding new range', () => {
  2197. testSelection(
  2198. [ 2, 2 ],
  2199. 'foobar',
  2200. 'fo{}obar'
  2201. );
  2202. testSelection(
  2203. [ 3, 3 ],
  2204. 'foobar',
  2205. 'foo{}bar'
  2206. );
  2207. expect( viewSelection.rangeCount ).to.equal( 1 );
  2208. } );
  2209. } );
  2210. describe( 'clearAttributes', () => {
  2211. it( 'should remove all ranges before adding new range', () => {
  2212. testSelection(
  2213. [ 3, 3 ],
  2214. 'foobar',
  2215. 'foo<strong>[]</strong>bar',
  2216. { bold: 'true' }
  2217. );
  2218. view.change( writer => {
  2219. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  2220. model.change( writer => {
  2221. writer.setSelection( modelRange );
  2222. } );
  2223. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  2224. } );
  2225. expect( viewSelection.rangeCount ).to.equal( 1 );
  2226. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  2227. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  2228. } );
  2229. it( 'should do nothing if the attribute element had been already removed', () => {
  2230. testSelection(
  2231. [ 3, 3 ],
  2232. 'foobar',
  2233. 'foo<strong>[]</strong>bar',
  2234. { bold: 'true' }
  2235. );
  2236. view.change( writer => {
  2237. // Remove <strong></strong> manually.
  2238. writer.mergeAttributes( viewSelection.getFirstPosition() );
  2239. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  2240. model.change( writer => {
  2241. writer.setSelection( modelRange );
  2242. } );
  2243. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  2244. } );
  2245. expect( viewSelection.rangeCount ).to.equal( 1 );
  2246. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  2247. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  2248. } );
  2249. it( 'should clear fake selection', () => {
  2250. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  2251. view.change( writer => {
  2252. writer.setSelection( modelRange, { fake: true } );
  2253. dispatcher.convertSelection( docSelection, model.markers, writer );
  2254. } );
  2255. expect( viewSelection.isFake ).to.be.false;
  2256. } );
  2257. } );
  2258. } );
  2259. describe( 'table cell selection converter', () => {
  2260. beforeEach( () => {
  2261. model.schema.register( 'table', { isLimit: true } );
  2262. model.schema.register( 'tr', { isLimit: true } );
  2263. model.schema.register( 'td', { isLimit: true } );
  2264. model.schema.extend( 'table', { allowIn: '$root' } );
  2265. model.schema.extend( 'tr', { allowIn: 'table' } );
  2266. model.schema.extend( 'td', { allowIn: 'tr' } );
  2267. model.schema.extend( '$text', { allowIn: 'td' } );
  2268. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  2269. // "Universal" converter to convert table structure.
  2270. downcastHelpers.elementToElement( { model: 'table', view: 'table' } );
  2271. downcastHelpers.elementToElement( { model: 'tr', view: 'tr' } );
  2272. downcastHelpers.elementToElement( { model: 'td', view: 'td' } );
  2273. // Special converter for table cells.
  2274. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  2275. const selection = data.selection;
  2276. if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  2277. return;
  2278. }
  2279. for ( const range of selection.getRanges() ) {
  2280. const node = range.start.parent;
  2281. if ( !!node && node.is( 'element', 'td' ) ) {
  2282. conversionApi.consumable.consume( selection, 'selection' );
  2283. const viewNode = conversionApi.mapper.toViewElement( node );
  2284. conversionApi.writer.addClass( 'selected', viewNode );
  2285. }
  2286. }
  2287. }, { priority: 'high' } );
  2288. } );
  2289. it( 'should not be used to convert selection that is not on table cell', () => {
  2290. testSelection(
  2291. [ 1, 5 ],
  2292. 'f{o<$text bold="true">ob</$text>a}r',
  2293. 'f{o<strong>ob</strong>a}r'
  2294. );
  2295. } );
  2296. it( 'should add a class to the selected table cell', () => {
  2297. testSelection(
  2298. // table tr#0 td#0 [foo, table tr#0 td#0 bar]
  2299. [ [ 0, 0, 0, 0 ], [ 0, 0, 0, 3 ] ],
  2300. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  2301. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  2302. );
  2303. } );
  2304. it( 'should not be used if selection contains more than just a table cell', () => {
  2305. testSelection(
  2306. // table tr td#1 f{oo bar, table tr#2 bar]
  2307. [ [ 0, 0, 0, 1 ], [ 0, 0, 1, 3 ] ],
  2308. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  2309. '[<table><tr><td>foo</td><td>bar</td></tr></table>]'
  2310. );
  2311. } );
  2312. } );
  2313. // Tests if the selection got correctly converted.
  2314. // Because `setData` might use selection converters itself to set the selection, we can't use it
  2315. // to set the selection (because then we would test converters using converters).
  2316. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  2317. // that are offsets or paths of selection positions in root element.
  2318. function testSelection( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  2319. // Parse passed `modelInput` string and set it as current model.
  2320. setModelData( model, modelInput );
  2321. // Manually set selection ranges using passed `selectionPaths`.
  2322. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  2323. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  2324. const startPos = model.createPositionFromPath( modelRoot, startPath );
  2325. const endPos = model.createPositionFromPath( modelRoot, endPath );
  2326. const isBackward = selectionPaths[ 2 ] === 'backward';
  2327. model.change( writer => {
  2328. writer.setSelection( writer.createRange( startPos, endPos ), { backward: isBackward } );
  2329. // And add or remove passed attributes.
  2330. for ( const key in selectionAttributes ) {
  2331. const value = selectionAttributes[ key ];
  2332. if ( value ) {
  2333. writer.setSelectionAttribute( key, value );
  2334. } else {
  2335. writer.removeSelectionAttribute( key );
  2336. }
  2337. }
  2338. } );
  2339. // Remove view children manually (without firing additional conversion).
  2340. viewRoot._removeChildren( 0, viewRoot.childCount );
  2341. // Convert model to view.
  2342. view.change( writer => {
  2343. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2344. dispatcher.convertSelection( docSelection, model.markers, writer );
  2345. } );
  2346. // Stringify view and check if it is same as expected.
  2347. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  2348. }
  2349. } );
  2350. function viewToString( item ) {
  2351. let result = '';
  2352. if ( item instanceof ViewText ) {
  2353. result = item.data;
  2354. } else {
  2355. // ViewElement or ViewDocumentFragment.
  2356. for ( const child of item.getChildren() ) {
  2357. result += viewToString( child );
  2358. }
  2359. if ( item instanceof ViewElement ) {
  2360. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  2361. }
  2362. }
  2363. return result;
  2364. }
  2365. function viewAttributesToString( item ) {
  2366. let result = '';
  2367. for ( const key of item.getAttributeKeys() ) {
  2368. const value = item.getAttribute( key );
  2369. if ( value ) {
  2370. result += ' ' + key + '="' + value + '"';
  2371. }
  2372. }
  2373. return result;
  2374. }