8
0

downcasthelpers.js 125 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041
  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. import { toWidget } from '@ckeditor/ckeditor5-widget/src/utils';
  34. describe( 'DowncastHelpers', () => {
  35. let model, modelRoot, viewRoot, downcastHelpers, controller, modelRootStart;
  36. beforeEach( () => {
  37. model = new Model();
  38. const modelDoc = model.document;
  39. modelRoot = modelDoc.createRoot();
  40. controller = new EditingController( model, new StylesProcessor() );
  41. // Set name of view root the same as dom root.
  42. // This is a mock of attaching view root to dom root.
  43. controller.view.document.getRoot()._name = 'div';
  44. viewRoot = controller.view.document.getRoot();
  45. downcastHelpers = new DowncastHelpers( [ controller.downcastDispatcher ] );
  46. modelRootStart = model.createPositionAt( modelRoot, 0 );
  47. } );
  48. describe( 'elementToElement()', () => {
  49. it( 'should be chainable', () => {
  50. expect( downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } ) ).to.equal( downcastHelpers );
  51. } );
  52. it( 'config.view is a string', () => {
  53. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  54. model.change( writer => {
  55. writer.insertElement( 'paragraph', modelRoot, 0 );
  56. } );
  57. expectResult( '<p></p>' );
  58. } );
  59. it( 'can be overwritten using converterPriority', () => {
  60. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  61. downcastHelpers.elementToElement( { model: 'paragraph', view: 'foo', converterPriority: 'high' } );
  62. model.change( writer => {
  63. writer.insertElement( 'paragraph', modelRoot, 0 );
  64. } );
  65. expectResult( '<foo></foo>' );
  66. } );
  67. it( 'config.view is a view element definition', () => {
  68. downcastHelpers.elementToElement( {
  69. model: 'fancyParagraph',
  70. view: {
  71. name: 'p',
  72. classes: 'fancy'
  73. }
  74. } );
  75. model.change( writer => {
  76. writer.insertElement( 'fancyParagraph', modelRoot, 0 );
  77. } );
  78. expectResult( '<p class="fancy"></p>' );
  79. } );
  80. it( 'config.view is a function', () => {
  81. downcastHelpers.elementToElement( {
  82. model: 'heading',
  83. view: ( modelElement, { writer } ) => writer.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) )
  84. } );
  85. model.change( writer => {
  86. writer.insertElement( 'heading', { level: 2 }, modelRoot, 0 );
  87. } );
  88. expectResult( '<h2></h2>' );
  89. } );
  90. describe( 'config.triggerBy', () => {
  91. describe( 'with simple block view structure (without children)', () => {
  92. beforeEach( () => {
  93. model.schema.register( 'simpleBlock', {
  94. allowIn: '$root',
  95. allowAttributes: [ 'toStyle', 'toClass' ]
  96. } );
  97. downcastHelpers.elementToElement( {
  98. model: 'simpleBlock',
  99. view: ( modelElement, { writer } ) => {
  100. return writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
  101. },
  102. triggerBy: {
  103. attributes: [ 'toStyle', 'toClass' ]
  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 convert on attribute set', () => {
  114. setModelData( model, '<simpleBlock></simpleBlock>' );
  115. const [ viewBefore ] = getNodes();
  116. model.change( writer => {
  117. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  118. } );
  119. const [ viewAfter ] = getNodes();
  120. expectResult( '<div style="display:block"></div>' );
  121. expect( viewAfter ).to.not.equal( viewBefore );
  122. } );
  123. it( 'should convert on attribute change', () => {
  124. setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
  125. const [ viewBefore ] = getNodes();
  126. model.change( writer => {
  127. writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
  128. } );
  129. const [ viewAfter ] = getNodes();
  130. expectResult( '<div style="display:inline"></div>' );
  131. expect( viewAfter ).to.not.equal( viewBefore );
  132. } );
  133. it( 'should convert on attribute remove', () => {
  134. setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
  135. model.change( writer => {
  136. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  137. } );
  138. expectResult( '<div></div>' );
  139. } );
  140. it( 'should convert on one attribute add and other remove', () => {
  141. setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
  142. model.change( writer => {
  143. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  144. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  145. } );
  146. expectResult( '<div class="is-classy"></div>' );
  147. } );
  148. it( 'should properly re-bind mapper', () => {
  149. downcastHelpers.elementToElement( {
  150. model: 'simpleBlock',
  151. view: ( modelElement, { writer } ) => {
  152. const viewElement = writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
  153. return toWidget( viewElement, writer );
  154. },
  155. triggerBy: {
  156. attributes: [ 'toStyle', 'toClass' ]
  157. },
  158. converterPriority: 'high'
  159. } );
  160. const mapper = controller.mapper;
  161. downcastHelpers.markerToHighlight( {
  162. model: 'myMarker',
  163. view: { classes: 'foo' }
  164. } );
  165. setModelData( model, '<simpleBlock></simpleBlock>' );
  166. const modelElement = modelRoot.getChild( 0 );
  167. const [ viewBefore ] = getNodes();
  168. model.change( writer => {
  169. writer.addMarker( 'myMarker', { range: writer.createRangeOn( modelElement ), usingOperation: false } );
  170. } );
  171. expect( mapper.toViewElement( modelElement ) ).to.equal( viewBefore );
  172. expect( mapper.toModelElement( viewBefore ) ).to.equal( modelElement );
  173. expect( mapper.markerNameToElements( 'myMarker' ).has( viewBefore ) ).to.be.true;
  174. model.change( writer => {
  175. writer.setAttribute( 'toStyle', 'display:block', modelElement );
  176. } );
  177. const [ viewAfter ] = getNodes();
  178. expect( mapper.toViewElement( modelElement ) ).to.equal( viewAfter );
  179. expect( mapper.toModelElement( viewBefore ) ).to.be.undefined;
  180. expect( mapper.toModelElement( viewAfter ) ).to.equal( modelElement );
  181. expect( mapper.markerNameToElements( 'myMarker' ).has( viewAfter ) ).to.be.true;
  182. expect( mapper.markerNameToElements( 'myMarker' ).has( viewBefore ) ).to.be.false;
  183. } );
  184. it( 'should do nothing if non-triggerBy attribute has changed', () => {
  185. setModelData( model, '<simpleBlock></simpleBlock>' );
  186. const [ viewBefore ] = getNodes();
  187. model.change( writer => {
  188. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  189. } );
  190. const [ viewAfter ] = getNodes();
  191. expectResult( '<div></div>' );
  192. expect( viewAfter ).to.equal( viewBefore );
  193. } );
  194. } );
  195. describe( 'with simple block view structure (with children)', () => {
  196. beforeEach( () => {
  197. model.schema.register( 'simpleBlock', {
  198. allowIn: '$root',
  199. allowAttributes: [ 'toStyle', 'toClass' ]
  200. } );
  201. downcastHelpers.elementToElement( {
  202. model: 'simpleBlock',
  203. view: ( modelElement, { writer } ) => {
  204. return writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
  205. },
  206. triggerBy: {
  207. attributes: [ 'toStyle', 'toClass' ]
  208. }
  209. } );
  210. model.schema.register( 'paragraph', {
  211. inheritAllFrom: '$block',
  212. allowIn: 'simpleBlock'
  213. } );
  214. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  215. } );
  216. it( 'should convert on insert', () => {
  217. model.change( writer => {
  218. const simpleBlock = writer.createElement( 'simpleBlock' );
  219. const paragraph = writer.createElement( 'paragraph' );
  220. writer.insert( simpleBlock, modelRoot, 0 );
  221. writer.insert( paragraph, simpleBlock, 0 );
  222. writer.insertText( 'foo', paragraph, 0 );
  223. } );
  224. expectResult( '<div><p>foo</p></div>' );
  225. } );
  226. it( 'should convert on attribute set', () => {
  227. setModelData( model, '<simpleBlock><paragraph>foo</paragraph></simpleBlock>' );
  228. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  229. model.change( writer => {
  230. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  231. } );
  232. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  233. expectResult( '<div style="display:block"><p>foo</p></div>' );
  234. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  235. expect( paraAfter, 'para' ).to.equal( paraBefore );
  236. expect( textAfter, 'text' ).to.equal( textBefore );
  237. } );
  238. it( 'should convert on attribute change', () => {
  239. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  240. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  241. model.change( writer => {
  242. writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
  243. } );
  244. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  245. expectResult( '<div style="display:inline"><p>foo</p></div>' );
  246. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  247. expect( paraAfter, 'para' ).to.equal( paraBefore );
  248. expect( textAfter, 'text' ).to.equal( textBefore );
  249. } );
  250. it( 'should convert on attribute remove', () => {
  251. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  252. model.change( writer => {
  253. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  254. } );
  255. expectResult( '<div><p>foo</p></div>' );
  256. } );
  257. it( 'should convert on one attribute add and other remove', () => {
  258. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  259. model.change( writer => {
  260. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  261. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  262. } );
  263. expectResult( '<div class="is-classy"><p>foo</p></div>' );
  264. } );
  265. it( 'should do nothing if non-triggerBy attribute has changed', () => {
  266. setModelData( model, '<simpleBlock><paragraph>foo</paragraph></simpleBlock>' );
  267. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  268. model.change( writer => {
  269. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  270. } );
  271. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  272. expectResult( '<div><p>foo</p></div>' );
  273. expect( viewAfter, 'simpleBlock' ).to.equal( viewBefore );
  274. expect( paraAfter, 'para' ).to.equal( paraBefore );
  275. // TODO - is text always re-converted?
  276. expect( textAfter, 'text' ).to.equal( textBefore );
  277. } );
  278. } );
  279. describe( 'with simple block view structure (with children - reconvert on child add)', () => {
  280. beforeEach( () => {
  281. model.schema.register( 'simpleBlock', {
  282. allowIn: '$root'
  283. } );
  284. downcastHelpers.elementToElement( {
  285. model: 'simpleBlock',
  286. view: 'div',
  287. triggerBy: {
  288. children: [ 'paragraph' ]
  289. }
  290. } );
  291. model.schema.register( 'paragraph', {
  292. inheritAllFrom: '$block',
  293. allowIn: 'simpleBlock'
  294. } );
  295. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  296. } );
  297. it( 'should convert on insert', () => {
  298. model.change( writer => {
  299. const simpleBlock = writer.createElement( 'simpleBlock' );
  300. const paragraph = writer.createElement( 'paragraph' );
  301. writer.insert( simpleBlock, modelRoot, 0 );
  302. writer.insert( paragraph, simpleBlock, 0 );
  303. writer.insertText( 'foo', paragraph, 0 );
  304. } );
  305. expectResult( '<div><p>foo</p></div>' );
  306. } );
  307. it( 'should convert on adding a child (at the beginning)', () => {
  308. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  309. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  310. model.change( writer => {
  311. const paragraph = writer.createElement( 'paragraph' );
  312. const text = writer.createText( 'bar' );
  313. writer.insert( paragraph, modelRoot.getChild( 0 ), 0 );
  314. writer.insert( text, paragraph, 0 );
  315. } );
  316. const [ viewAfter, /* insertedPara */, /* insertedText */, paraAfter, textAfter ] = getNodes();
  317. expectResult( '<div><p>bar</p><p>foo</p></div>' );
  318. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  319. expect( paraAfter, 'para' ).to.equal( paraBefore );
  320. expect( textAfter, 'text' ).to.equal( textBefore );
  321. } );
  322. it( 'should convert on adding a child (in the middle)', () => {
  323. setModelData( model,
  324. '<simpleBlock toStyle="display:block">' +
  325. '<paragraph>foo</paragraph><paragraph>bar</paragraph>' +
  326. '</simpleBlock>' );
  327. const [ viewBefore, paraFooBefore, textFooBefore, paraBarBefore, textBarBefore ] = getNodes();
  328. model.change( writer => {
  329. const paragraph = writer.createElement( 'paragraph' );
  330. const text = writer.createText( 'baz' );
  331. writer.insert( paragraph, modelRoot.getChild( 0 ), 1 );
  332. writer.insert( text, paragraph, 0 );
  333. } );
  334. const [ viewAfter,
  335. paraFooAfter, textFooAfter, /* insertedPara */, /* insertedText */, paraBarAfter, textBarAfter
  336. ] = getNodes();
  337. expectResult( '<div><p>foo</p><p>baz</p><p>bar</p></div>' );
  338. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  339. expect( paraFooAfter, 'para foo' ).to.equal( paraFooBefore );
  340. expect( textFooAfter, 'text foo' ).to.equal( textFooBefore );
  341. expect( paraBarAfter, 'para bar' ).to.equal( paraBarBefore );
  342. expect( textBarAfter, 'text bar' ).to.equal( textBarBefore );
  343. } );
  344. it( 'should convert on adding a child (at the end)', () => {
  345. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  346. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  347. model.change( writer => {
  348. const paragraph = writer.createElement( 'paragraph' );
  349. const text = writer.createText( 'bar' );
  350. writer.insert( paragraph, modelRoot.getChild( 0 ), 1 );
  351. writer.insert( text, paragraph, 0 );
  352. } );
  353. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  354. expectResult( '<div><p>foo</p><p>bar</p></div>' );
  355. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  356. expect( paraAfter, 'para' ).to.equal( paraBefore );
  357. expect( textAfter, 'text' ).to.equal( textBefore );
  358. } );
  359. it( 'should convert on removing a child', () => {
  360. setModelData( model,
  361. '<simpleBlock><paragraph>foo</paragraph><paragraph>bar</paragraph></simpleBlock>' );
  362. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  363. model.change( writer => {
  364. writer.remove( modelRoot.getNodeByPath( [ 0, 1 ] ) );
  365. } );
  366. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  367. expectResult( '<div><p>foo</p></div>' );
  368. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  369. expect( paraAfter, 'para' ).to.equal( paraBefore );
  370. expect( textAfter, 'text' ).to.equal( textBefore );
  371. } );
  372. } );
  373. describe( 'with complex view structure - no children allowed', () => {
  374. beforeEach( () => {
  375. model.schema.register( 'complex', {
  376. allowIn: '$root',
  377. allowAttributes: [ 'toStyle', 'toClass' ]
  378. } );
  379. downcastHelpers.elementToElement( {
  380. model: 'complex',
  381. view: ( modelElement, { writer } ) => {
  382. const outer = writer.createContainerElement( 'div', { class: 'complex-outer' } );
  383. const inner = writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
  384. writer.insert( writer.createPositionAt( outer, 0 ), inner );
  385. return outer;
  386. },
  387. triggerBy: {
  388. attributes: [ 'toStyle', 'toClass' ]
  389. }
  390. } );
  391. } );
  392. it( 'should convert on insert', () => {
  393. model.change( writer => {
  394. writer.insertElement( 'complex', modelRoot, 0 );
  395. } );
  396. expectResult( '<div class="complex-outer"><div></div></div>' );
  397. } );
  398. it( 'should convert on attribute set', () => {
  399. setModelData( model, '<complex></complex>' );
  400. const [ outerDivBefore, innerDivBefore ] = getNodes();
  401. model.change( writer => {
  402. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  403. } );
  404. const [ outerDivAfter, innerDivAfter ] = getNodes();
  405. expectResult( '<div class="complex-outer"><div style="display:block"></div></div>' );
  406. expect( outerDivAfter, 'outer div' ).to.not.equal( outerDivBefore );
  407. expect( innerDivAfter, 'inner div' ).to.not.equal( innerDivBefore );
  408. } );
  409. it( 'should convert on attribute change', () => {
  410. setModelData( model, '<complex toStyle="display:block"></complex>' );
  411. model.change( writer => {
  412. writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
  413. } );
  414. expectResult( '<div class="complex-outer"><div style="display:inline"></div></div>' );
  415. } );
  416. it( 'should convert on attribute remove', () => {
  417. setModelData( model, '<complex toStyle="display:block"></complex>' );
  418. model.change( writer => {
  419. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  420. } );
  421. expectResult( '<div class="complex-outer"><div></div></div>' );
  422. } );
  423. it( 'should convert on one attribute add and other remove', () => {
  424. setModelData( model, '<complex toStyle="display:block"></complex>' );
  425. model.change( writer => {
  426. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  427. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  428. } );
  429. expectResult( '<div class="complex-outer"><div class="is-classy"></div></div>' );
  430. } );
  431. it( 'should do nothing if non-triggerBy attribute has changed', () => {
  432. setModelData( model, '<complex></complex>' );
  433. const [ outerDivBefore, innerDivBefore ] = getNodes();
  434. model.change( writer => {
  435. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  436. } );
  437. const [ outerDivAfter, innerDivAfter ] = getNodes();
  438. expectResult( '<div class="complex-outer"><div></div></div>' );
  439. expect( outerDivAfter, 'outer div' ).to.equal( outerDivBefore );
  440. expect( innerDivAfter, 'inner div' ).to.equal( innerDivBefore );
  441. } );
  442. } );
  443. describe( 'with complex view structure (without slots)', () => {
  444. beforeEach( () => {
  445. model.schema.register( 'complex', {
  446. allowIn: '$root',
  447. allowAttributes: [ 'toStyle', 'toClass' ]
  448. } );
  449. downcastHelpers.elementToElement( {
  450. model: 'complex',
  451. view: ( modelElement, { writer, mapper } ) => {
  452. const outer = writer.createContainerElement( 'c-outer' );
  453. const inner = writer.createContainerElement( 'c-inner', getViewAttributes( modelElement ) );
  454. writer.insert( writer.createPositionAt( outer, 0 ), inner );
  455. mapper.bindElements( modelElement, outer ); // Need for nested mapping
  456. mapper.bindElements( modelElement, inner );
  457. return outer;
  458. },
  459. triggerBy: {
  460. attributes: [ 'toStyle', 'toClass' ]
  461. }
  462. } );
  463. model.schema.register( 'paragraph', {
  464. inheritAllFrom: '$block',
  465. allowIn: 'complex'
  466. } );
  467. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  468. } );
  469. it( 'should convert on insert', () => {
  470. model.change( writer => {
  471. writer.insertElement( 'complex', modelRoot, 0 );
  472. } );
  473. expectResult( '<c-outer><c-inner></c-inner></c-outer>' );
  474. } );
  475. it( 'should convert on attribute set', () => {
  476. setModelData( model, '<complex></complex>' );
  477. model.change( writer => {
  478. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  479. } );
  480. expectResult( '<c-outer><c-inner style="display:block"></c-inner></c-outer>' );
  481. } );
  482. it( 'should convert on attribute remove', () => {
  483. setModelData( model, '<complex toStyle="display:block"></complex>' );
  484. model.change( writer => {
  485. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  486. } );
  487. expectResult( '<c-outer><c-inner></c-inner></c-outer>' );
  488. } );
  489. it( 'should convert on one attribute add and other remove', () => {
  490. setModelData( model, '<complex toStyle="display:block"></complex>' );
  491. model.change( writer => {
  492. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  493. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  494. } );
  495. expectResult( '<c-outer><c-inner class="is-classy"></c-inner></c-outer>' );
  496. } );
  497. it( 'should do nothing if non-triggerBy attribute has changed', () => {
  498. setModelData( model, '<complex></complex>' );
  499. model.change( writer => {
  500. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  501. } );
  502. expectResult( '<c-outer><c-inner></c-inner></c-outer>' );
  503. } );
  504. describe( 'memoization', () => {
  505. it( 'should create new element on re-converting element', () => {
  506. setModelData( model, '<complex></complex>' );
  507. const [ outerBefore, innerBefore ] = getNodes();
  508. model.change( writer => {
  509. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  510. } );
  511. const [ outerAfter, innerAfter ] = getNodes();
  512. expect( outerAfter, 'outer' ).to.not.equal( outerBefore );
  513. expect( innerAfter, 'inner' ).to.not.equal( innerBefore );
  514. } );
  515. // Skipped, as it would require two-level mapping. See https://github.com/ckeditor/ckeditor5/issues/1589.
  516. // Doable as a similar case works in table scenario for table cells (table is refreshed).
  517. it.skip( 'should not re-create child elements on re-converting element', () => {
  518. setModelData( model, '<complex><paragraph>Foo bar baz</paragraph></complex>' );
  519. expectResult( '<c-outer><c-inner><p>Foo bar baz</p></c-inner></c-outer>' );
  520. const renderedViewView = viewRoot.getChild( 0 ).getChild( 0 );
  521. model.change( writer => {
  522. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  523. } );
  524. const viewAfterReRender = viewRoot.getChild( 0 ).getChild( 0 );
  525. expect( viewAfterReRender ).to.equal( renderedViewView );
  526. } );
  527. } );
  528. } );
  529. describe( 'with complex view structure (slot conversion)', () => {
  530. beforeEach( () => {
  531. model.schema.register( 'complex', {
  532. allowIn: '$root',
  533. allowAttributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ]
  534. } );
  535. downcastHelpers.elementToElement( {
  536. model: 'complex',
  537. view: ( modelElement, { writer, mapper } ) => {
  538. const classForMain = !!modelElement.getAttribute( 'classForMain' );
  539. const classForWrap = !!modelElement.getAttribute( 'classForWrap' );
  540. const attributeToElement = !!modelElement.getAttribute( 'attributeToElement' );
  541. const outer = writer.createContainerElement( 'div', {
  542. class: `complex-slots${ classForMain ? ' with-class' : '' }`
  543. } );
  544. const inner = writer.createContainerElement( 'div', {
  545. class: `slots${ classForWrap ? ' with-class' : '' }`
  546. } );
  547. if ( attributeToElement ) {
  548. const optional = writer.createEmptyElement( 'div', { class: 'optional' } );
  549. writer.insert( writer.createPositionAt( outer, 0 ), optional );
  550. }
  551. writer.insert( writer.createPositionAt( outer, 'end' ), inner );
  552. mapper.bindElements( modelElement, inner );
  553. for ( const slot of modelElement.getChildren() ) {
  554. const viewSlot = writer.createContainerElement( 'div', { class: 'slot' } );
  555. writer.insert( writer.createPositionAt( inner, slot.index ), viewSlot );
  556. mapper.bindElements( slot, viewSlot );
  557. }
  558. return outer;
  559. },
  560. triggerBy: {
  561. attributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ],
  562. children: [ 'slot' ]
  563. }
  564. } );
  565. model.schema.register( 'slot', {
  566. allowIn: 'complex'
  567. } );
  568. model.schema.register( 'paragraph', {
  569. inheritAllFrom: '$block',
  570. allowIn: 'slot'
  571. } );
  572. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  573. } );
  574. it( 'should convert on insert', () => {
  575. model.change( writer => {
  576. writer.insertElement( 'complex', modelRoot, 0 );
  577. } );
  578. expectResult( '<div class="complex-slots"><div class="slots"></div></div>' );
  579. } );
  580. it( 'should convert on attribute set (main element)', () => {
  581. setModelData( model, '<complex></complex>' );
  582. model.change( writer => {
  583. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  584. } );
  585. expectResult( '<div class="complex-slots with-class"><div class="slots"></div></div>' );
  586. } );
  587. it( 'should convert on attribute set (other element)', () => {
  588. setModelData( model, '<complex></complex>' );
  589. model.change( writer => {
  590. writer.setAttribute( 'classForWrap', true, modelRoot.getChild( 0 ) );
  591. } );
  592. expectResult( '<div class="complex-slots"><div class="slots with-class"></div></div>' );
  593. } );
  594. it( 'should convert on attribute set (insert new view element)', () => {
  595. setModelData( model, '<complex></complex>' );
  596. model.change( writer => {
  597. writer.setAttribute( 'attributeToElement', true, modelRoot.getChild( 0 ) );
  598. } );
  599. expectResult( '<div class="complex-slots"><div class="optional"></div><div class="slots"></div></div>' );
  600. } );
  601. it( 'should convert element with slots', () => {
  602. setModelData( model,
  603. '<complex>' +
  604. '<slot><paragraph>foo</paragraph></slot>' +
  605. '<slot><paragraph>bar</paragraph></slot>' +
  606. '</complex>' );
  607. expectResult(
  608. '<div class="complex-slots">' +
  609. '<div class="slots">' +
  610. '<div class="slot"><p>foo</p></div>' +
  611. '<div class="slot"><p>bar</p></div>' +
  612. '</div>' +
  613. '</div>'
  614. );
  615. } );
  616. it( 'should convert element on adding slot', () => {
  617. setModelData( model,
  618. '<complex>' +
  619. '<slot><paragraph>foo</paragraph></slot>' +
  620. '<slot><paragraph>bar</paragraph></slot>' +
  621. '</complex>' );
  622. model.change( writer => {
  623. insertBazSlot( writer, modelRoot );
  624. } );
  625. expectResult(
  626. '<div class="complex-slots">' +
  627. '<div class="slots">' +
  628. '<div class="slot"><p>foo</p></div>' +
  629. '<div class="slot"><p>bar</p></div>' +
  630. '<div class="slot"><p>baz</p></div>' +
  631. '</div>' +
  632. '</div>'
  633. );
  634. } );
  635. it( 'should convert element on removing slot', () => {
  636. setModelData( model,
  637. '<complex>' +
  638. '<slot><paragraph>foo</paragraph></slot>' +
  639. '<slot><paragraph>bar</paragraph></slot>' +
  640. '</complex>' );
  641. model.change( writer => {
  642. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  643. } );
  644. expectResult(
  645. '<div class="complex-slots">' +
  646. '<div class="slots">' +
  647. '<div class="slot"><p>bar</p></div>' +
  648. '</div>' +
  649. '</div>'
  650. );
  651. } );
  652. it( 'should convert element on multiple triggers (remove + insert)', () => {
  653. setModelData( model,
  654. '<complex>' +
  655. '<slot><paragraph>foo</paragraph></slot>' +
  656. '<slot><paragraph>bar</paragraph></slot>' +
  657. '</complex>' );
  658. model.change( writer => {
  659. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  660. insertBazSlot( writer, modelRoot );
  661. } );
  662. expectResult(
  663. '<div class="complex-slots">' +
  664. '<div class="slots">' +
  665. '<div class="slot"><p>bar</p></div>' +
  666. '<div class="slot"><p>baz</p></div>' +
  667. '</div>' +
  668. '</div>'
  669. );
  670. } );
  671. it( 'should convert element on multiple triggers (remove + attribute)', () => {
  672. setModelData( model,
  673. '<complex>' +
  674. '<slot><paragraph>foo</paragraph></slot>' +
  675. '<slot><paragraph>bar</paragraph></slot>' +
  676. '</complex>' );
  677. model.change( writer => {
  678. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  679. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  680. } );
  681. expectResult(
  682. '<div class="complex-slots with-class">' +
  683. '<div class="slots">' +
  684. '<div class="slot"><p>bar</p></div>' +
  685. '</div>' +
  686. '</div>'
  687. );
  688. } );
  689. it( 'should convert element on multiple triggers (insert + attribute)', () => {
  690. setModelData( model,
  691. '<complex>' +
  692. '<slot><paragraph>foo</paragraph></slot>' +
  693. '<slot><paragraph>bar</paragraph></slot>' +
  694. '</complex>' );
  695. model.change( writer => {
  696. insertBazSlot( writer, modelRoot );
  697. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  698. } );
  699. expectResult(
  700. '<div class="complex-slots with-class">' +
  701. '<div class="slots">' +
  702. '<div class="slot"><p>foo</p></div>' +
  703. '<div class="slot"><p>bar</p></div>' +
  704. '<div class="slot"><p>baz</p></div>' +
  705. '</div>' +
  706. '</div>'
  707. );
  708. } );
  709. it( 'should not trigger refresh on adding a slot to an element without triggerBy conversion', () => {
  710. model.schema.register( 'other', {
  711. allowIn: '$root'
  712. } );
  713. model.schema.extend( 'slot', {
  714. allowIn: 'other'
  715. } );
  716. downcastHelpers.elementToElement( {
  717. model: 'other',
  718. view: {
  719. name: 'div',
  720. classes: 'other'
  721. }
  722. } );
  723. downcastHelpers.elementToElement( {
  724. model: 'slot',
  725. view: {
  726. name: 'div',
  727. classes: 'slot'
  728. }
  729. } );
  730. setModelData( model,
  731. '<other>' +
  732. '<slot><paragraph>foo</paragraph></slot>' +
  733. '<slot><paragraph>bar</paragraph></slot>' +
  734. '</other>'
  735. );
  736. const otherView = viewRoot.getChild( 0 );
  737. model.change( writer => {
  738. insertBazSlot( writer, modelRoot );
  739. } );
  740. expectResult(
  741. '<div class="other">' +
  742. '<div class="slot"><p>foo</p></div>' +
  743. '<div class="slot"><p>bar</p></div>' +
  744. '<div class="slot"><p>baz</p></div>' +
  745. '</div>'
  746. );
  747. const otherViewAfter = viewRoot.getChild( 0 );
  748. expect( otherView, 'the view should not be refreshed' ).to.equal( otherViewAfter );
  749. } );
  750. describe( 'memoization', () => {
  751. it( 'should create new element on re-converting element', () => {
  752. setModelData( model, '<complex>' +
  753. '<slot><paragraph>foo</paragraph></slot>' +
  754. '<slot><paragraph>bar</paragraph></slot>' +
  755. '</complex>'
  756. );
  757. const [ complexView ] = getNodes();
  758. model.change( writer => {
  759. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  760. } );
  761. const [ viewAfterReRender ] = getNodes();
  762. expect( viewAfterReRender, 'the view should be refreshed' ).to.not.equal( complexView );
  763. } );
  764. it( 'should not re-create slot\'s child elements on re-converting main element (attribute changed)', () => {
  765. setModelData( model, '<complex>' +
  766. '<slot><paragraph>foo</paragraph></slot>' +
  767. '<slot><paragraph>bar</paragraph></slot>' +
  768. '</complex>'
  769. );
  770. const [ main, /* unused */,
  771. slotOne, paraOne, textNodeOne,
  772. slotTwo, paraTwo, textNodeTwo ] = getNodes();
  773. model.change( writer => {
  774. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  775. } );
  776. const [ mainAfter, /* unused */,
  777. slotOneAfter, paraOneAfter, textNodeOneAfter,
  778. slotTwoAfter, paraTwoAfter, textNodeTwoAfter ] = getNodes();
  779. expect( mainAfter, 'main view' ).to.not.equal( main );
  780. expect( slotOneAfter, 'first slot view' ).to.not.equal( slotOne );
  781. expect( slotTwoAfter, 'second slot view' ).to.not.equal( slotTwo );
  782. expect( paraOneAfter, 'first slot paragraph view' ).to.equal( paraOne );
  783. expect( textNodeOneAfter, 'first slot text node view' ).to.equal( textNodeOne );
  784. expect( paraTwoAfter, 'second slot paragraph view' ).to.equal( paraTwo );
  785. expect( textNodeTwoAfter, 'second slot text node view' ).to.equal( textNodeTwo );
  786. } );
  787. it( 'should not re-create slot\'s child elements on re-converting main element (slot added)', () => {
  788. setModelData( model, '<complex>' +
  789. '<slot><paragraph>foo</paragraph></slot>' +
  790. '<slot><paragraph>bar</paragraph></slot>' +
  791. '</complex>'
  792. );
  793. const [ main, /* unused */,
  794. slotOne, paraOne, textNodeOne,
  795. slotTwo, paraTwo, textNodeTwo ] = getNodes();
  796. model.change( writer => {
  797. const slot = writer.createElement( 'slot' );
  798. const paragraph = writer.createElement( 'paragraph' );
  799. writer.insertText( 'baz', paragraph, 0 );
  800. writer.insert( paragraph, slot, 0 );
  801. writer.insert( slot, modelRoot.getChild( 0 ), 'end' );
  802. } );
  803. const [ mainAfter, /* unused */,
  804. slotOneAfter, paraOneAfter, textNodeOneAfter,
  805. slotTwoAfter, paraTwoAfter, textNodeTwoAfter,
  806. slotThreeAfter, paraThreeAfter, textNodeThreeAfter
  807. ] = getNodes();
  808. expect( mainAfter, 'main view' ).to.not.equal( main );
  809. expect( slotOneAfter, 'first slot view' ).to.not.equal( slotOne );
  810. expect( slotTwoAfter, 'second slot view' ).to.not.equal( slotTwo );
  811. expect( paraOneAfter, 'first slot paragraph view' ).to.equal( paraOne );
  812. expect( textNodeOneAfter, 'first slot text node view' ).to.equal( textNodeOne );
  813. expect( paraTwoAfter, 'second slot paragraph view' ).to.equal( paraTwo );
  814. expect( textNodeTwoAfter, 'second slot text node view' ).to.equal( textNodeTwo );
  815. expect( slotThreeAfter, 'third slot view' ).to.not.be.undefined;
  816. expect( paraThreeAfter, 'third slot paragraph view' ).to.not.be.undefined;
  817. expect( textNodeThreeAfter, 'third slot text node view' ).to.not.be.undefined;
  818. } );
  819. } );
  820. } );
  821. // Skipped, as it would require two-level mapping. See https://github.com/ckeditor/ckeditor5/issues/1589.
  822. describe.skip( 'with complex view structure (slot conversion atomic converters for some changes)', () => {
  823. beforeEach( () => {
  824. model.schema.register( 'complex', {
  825. allowIn: '$root',
  826. allowAttributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ]
  827. } );
  828. function createViewSlot( slot, { writer, mapper } ) {
  829. const viewSlot = writer.createContainerElement( 'div', { class: 'slot' } );
  830. mapper.bindElements( slot, viewSlot );
  831. return viewSlot;
  832. }
  833. downcastHelpers.elementToElement( {
  834. model: 'complex',
  835. view: ( modelElement, { writer, mapper, consumable } ) => {
  836. const classForMain = !!modelElement.getAttribute( 'classForMain' );
  837. const classForWrap = !!modelElement.getAttribute( 'classForWrap' );
  838. const attributeToElement = !!modelElement.getAttribute( 'attributeToElement' );
  839. const outer = writer.createContainerElement( 'div', {
  840. class: `complex-slots${ classForMain ? ' with-class' : '' }`
  841. } );
  842. const inner = writer.createContainerElement( 'div', {
  843. class: `slots${ classForWrap ? ' with-class' : '' }`
  844. } );
  845. if ( attributeToElement ) {
  846. const optional = writer.createEmptyElement( 'div', { class: 'optional' } );
  847. writer.insert( writer.createPositionAt( outer, 0 ), optional );
  848. }
  849. writer.insert( writer.createPositionAt( outer, 'end' ), inner );
  850. mapper.bindElements( modelElement, outer );
  851. mapper.bindElements( modelElement, inner );
  852. for ( const slot of modelElement.getChildren() ) {
  853. const viewSlot = createViewSlot( slot, { writer, mapper } );
  854. writer.insert( writer.createPositionAt( inner, slot.index ), viewSlot );
  855. consumable.consume( slot, 'insert' );
  856. }
  857. return outer;
  858. },
  859. triggerBy: {
  860. attributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ]
  861. // Contrary to the previous test - do not act on child changes.
  862. // children: [ 'slot' ]
  863. }
  864. } );
  865. downcastHelpers.elementToElement( {
  866. model: 'slot',
  867. view: createViewSlot
  868. } );
  869. model.schema.register( 'slot', {
  870. allowIn: 'complex'
  871. } );
  872. model.schema.register( 'paragraph', {
  873. inheritAllFrom: '$block',
  874. allowIn: 'slot'
  875. } );
  876. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  877. } );
  878. it( 'should convert on insert', () => {
  879. model.change( writer => {
  880. writer.insertElement( 'complex', modelRoot, 0 );
  881. } );
  882. expectResult( '<div class="complex-slots"><div class="slots"></div></div>' );
  883. } );
  884. it( 'should convert on attribute set (main element)', () => {
  885. setModelData( model, '<complex></complex>' );
  886. model.change( writer => {
  887. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  888. } );
  889. expectResult( '<div class="complex-slots with-class"><div class="slots"></div></div>' );
  890. } );
  891. it( 'should convert on attribute set (other element)', () => {
  892. setModelData( model, '<complex></complex>' );
  893. model.change( writer => {
  894. writer.setAttribute( 'classForWrap', true, modelRoot.getChild( 0 ) );
  895. } );
  896. expectResult( '<div class="complex-slots"><div class="slots with-class"></div></div>' );
  897. } );
  898. it( 'should convert on attribute set (insert new view element)', () => {
  899. setModelData( model, '<complex></complex>' );
  900. model.change( writer => {
  901. writer.setAttribute( 'attributeToElement', true, modelRoot.getChild( 0 ) );
  902. } );
  903. expectResult( '<div class="complex-slots"><div class="optional"></div><div class="slots"></div></div>' );
  904. } );
  905. it( 'should convert element with slots', () => {
  906. setModelData( model,
  907. '<complex>' +
  908. '<slot><paragraph>foo</paragraph></slot>' +
  909. '<slot><paragraph>bar</paragraph></slot>' +
  910. '</complex>' );
  911. expectResult(
  912. '<div class="complex-slots">' +
  913. '<div class="slots">' +
  914. '<div class="slot"><p>foo</p></div>' +
  915. '<div class="slot"><p>bar</p></div>' +
  916. '</div>' +
  917. '</div>'
  918. );
  919. } );
  920. it( 'should not convert element on adding slot', () => {
  921. setModelData( model,
  922. '<complex>' +
  923. '<slot><paragraph>foo</paragraph></slot>' +
  924. '<slot><paragraph>bar</paragraph></slot>' +
  925. '</complex>' );
  926. model.change( writer => {
  927. const slot = writer.createElement( 'slot' );
  928. const paragraph = writer.createElement( 'paragraph' );
  929. writer.insertText( 'baz', paragraph, 0 );
  930. writer.insert( paragraph, slot, 0 );
  931. writer.insert( slot, modelRoot.getChild( 0 ), 'end' );
  932. } );
  933. expectResult(
  934. '<div class="complex-slots">' +
  935. '<div class="slots">' +
  936. '<div class="slot"><p>foo</p></div>' +
  937. '<div class="slot"><p>bar</p></div>' +
  938. '<div class="slot"><p>baz</p></div>' +
  939. '</div>' +
  940. '</div>'
  941. );
  942. } );
  943. it( 'should not convert element on removing slot', () => {
  944. setModelData( model,
  945. '<complex>' +
  946. '<slot><paragraph>foo</paragraph></slot>' +
  947. '<slot><paragraph>bar</paragraph></slot>' +
  948. '</complex>' );
  949. model.change( writer => {
  950. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  951. } );
  952. expectResult(
  953. '<div class="complex-slots">' +
  954. '<div class="slots">' +
  955. '<div class="slot"><p>bar</p></div>' +
  956. '</div>' +
  957. '</div>'
  958. );
  959. } );
  960. it( 'should convert element on a trigger and block atomic converters (remove + attribute)', () => {
  961. setModelData( model,
  962. '<complex>' +
  963. '<slot><paragraph>foo</paragraph></slot>' +
  964. '<slot><paragraph>bar</paragraph></slot>' +
  965. '</complex>' );
  966. model.change( writer => {
  967. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  968. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  969. } );
  970. expectResult(
  971. '<div class="complex-slots with-class">' +
  972. '<div class="slots">' +
  973. '<div class="slot"><p>bar</p></div>' +
  974. '</div>' +
  975. '</div>'
  976. );
  977. } );
  978. it( 'should convert element on a trigger and block atomic converters (insert + attribute)', () => {
  979. setModelData( model,
  980. '<complex>' +
  981. '<slot><paragraph>foo</paragraph></slot>' +
  982. '<slot><paragraph>bar</paragraph></slot>' +
  983. '</complex>' );
  984. model.change( writer => {
  985. writer.insert( modelRoot.getChild( 0 ).getChild( 0 ) );
  986. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  987. } );
  988. expectResult(
  989. '<div class="complex-slots with-class">' +
  990. '<div class="slots">' +
  991. '<div class="slot"><p>foo</p></div>' +
  992. '<div class="slot"><p>bar</p></div>' +
  993. '<div class="slot"><p>baz</p></div>' +
  994. '</div>' +
  995. '</div>'
  996. );
  997. } );
  998. } );
  999. function getViewAttributes( modelElement ) {
  1000. const toStyle = modelElement.hasAttribute( 'toStyle' ) && { style: modelElement.getAttribute( 'toStyle' ) };
  1001. const toClass = modelElement.hasAttribute( 'toClass' ) && { class: 'is-classy' };
  1002. return {
  1003. ...toStyle,
  1004. ...toClass
  1005. };
  1006. }
  1007. function insertBazSlot( writer, modelRoot ) {
  1008. const slot = writer.createElement( 'slot' );
  1009. const paragraph = writer.createElement( 'paragraph' );
  1010. writer.insertText( 'baz', paragraph, 0 );
  1011. writer.insert( paragraph, slot, 0 );
  1012. writer.insert( slot, modelRoot.getChild( 0 ), 'end' );
  1013. }
  1014. function* getNodes() {
  1015. const main = viewRoot.getChild( 0 );
  1016. yield main;
  1017. for ( const { item } of controller.view.createRangeIn( main ) ) {
  1018. if ( item.is( 'textProxy' ) ) {
  1019. // TreeWalker always create a new instance of a TextProxy so use referenced textNode.
  1020. yield item.textNode;
  1021. } else {
  1022. yield item;
  1023. }
  1024. }
  1025. }
  1026. } );
  1027. } );
  1028. describe( 'attributeToElement()', () => {
  1029. beforeEach( () => {
  1030. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1031. } );
  1032. it( 'should be chainable', () => {
  1033. expect( downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } ) ).to.equal( downcastHelpers );
  1034. } );
  1035. it( 'config.view is a string', () => {
  1036. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  1037. model.change( writer => {
  1038. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  1039. } );
  1040. expectResult( '<strong>foo</strong>' );
  1041. } );
  1042. it( 'can be overwritten using converterPriority', () => {
  1043. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  1044. downcastHelpers.attributeToElement( { model: 'bold', view: 'b', converterPriority: 'high' } );
  1045. model.change( writer => {
  1046. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  1047. } );
  1048. expectResult( '<b>foo</b>' );
  1049. } );
  1050. it( 'config.view is a view element definition', () => {
  1051. downcastHelpers.attributeToElement( {
  1052. model: 'invert',
  1053. view: {
  1054. name: 'span',
  1055. classes: [ 'font-light', 'bg-dark' ]
  1056. }
  1057. } );
  1058. model.change( writer => {
  1059. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  1060. } );
  1061. expectResult( '<span class="bg-dark font-light">foo</span>' );
  1062. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1063. } );
  1064. it( 'config.view allows specifying the element\'s priority', () => {
  1065. downcastHelpers.attributeToElement( {
  1066. model: 'invert',
  1067. view: {
  1068. name: 'span',
  1069. priority: 5
  1070. }
  1071. } );
  1072. model.change( writer => {
  1073. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  1074. } );
  1075. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  1076. } );
  1077. it( 'model attribute value is enum', () => {
  1078. downcastHelpers.attributeToElement( {
  1079. model: {
  1080. key: 'fontSize',
  1081. values: [ 'big', 'small' ]
  1082. },
  1083. view: {
  1084. big: {
  1085. name: 'span',
  1086. styles: {
  1087. 'font-size': '1.2em'
  1088. }
  1089. },
  1090. small: {
  1091. name: 'span',
  1092. styles: {
  1093. 'font-size': '0.8em'
  1094. },
  1095. priority: 5
  1096. }
  1097. }
  1098. } );
  1099. model.change( writer => {
  1100. writer.insertText( 'foo', { fontSize: 'big' }, modelRoot, 0 );
  1101. } );
  1102. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1103. expectResult( '<span style="font-size:1.2em">foo</span>' );
  1104. model.change( writer => {
  1105. writer.setAttribute( 'fontSize', 'small', modelRoot.getChild( 0 ) );
  1106. } );
  1107. expectResult( '<span style="font-size:0.8em">foo</span>' );
  1108. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  1109. model.change( writer => {
  1110. writer.removeAttribute( 'fontSize', modelRoot.getChild( 0 ) );
  1111. } );
  1112. expectResult( 'foo' );
  1113. } );
  1114. it( 'config.view is a function', () => {
  1115. downcastHelpers.attributeToElement( {
  1116. model: 'bold',
  1117. view: ( modelAttributeValue, { writer } ) => {
  1118. return writer.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } );
  1119. }
  1120. } );
  1121. model.change( writer => {
  1122. writer.insertText( 'foo', { bold: '500' }, modelRoot, 0 );
  1123. } );
  1124. expectResult( '<span style="font-weight:500">foo</span>' );
  1125. } );
  1126. it( 'config.model.name is given', () => {
  1127. downcastHelpers.attributeToElement( {
  1128. model: {
  1129. key: 'color',
  1130. name: '$text'
  1131. },
  1132. view: ( modelAttributeValue, { writer } ) => {
  1133. return writer.createAttributeElement( 'span', { style: 'color:' + modelAttributeValue } );
  1134. }
  1135. } );
  1136. downcastHelpers.elementToElement( {
  1137. model: 'smiley',
  1138. view: ( modelElement, { writer } ) => {
  1139. return writer.createEmptyElement( 'img', {
  1140. src: 'smile.jpg',
  1141. class: 'smiley'
  1142. } );
  1143. }
  1144. } );
  1145. model.change( writer => {
  1146. writer.insertText( 'foo', { color: '#FF0000' }, modelRoot, 0 );
  1147. writer.insertElement( 'smiley', { color: '#FF0000' }, modelRoot, 3 );
  1148. } );
  1149. expectResult( '<span style="color:#FF0000">foo</span><img class="smiley" src="smile.jpg"></img>' );
  1150. } );
  1151. it( 'should not convert if creator returned null', () => {
  1152. downcastHelpers.elementToElement( { model: 'div', view: () => null } );
  1153. const modelElement = new ModelElement( 'div' );
  1154. model.change( writer => {
  1155. writer.insert( modelElement, modelRootStart );
  1156. } );
  1157. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  1158. } );
  1159. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  1160. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  1161. downcastHelpers.attributeToElement( {
  1162. model: 'bold',
  1163. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
  1164. } );
  1165. model.change( writer => {
  1166. writer.insert( modelElement, modelRootStart );
  1167. } );
  1168. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  1169. model.change( writer => {
  1170. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  1171. } );
  1172. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1173. } );
  1174. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  1175. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  1176. downcastHelpers.attributeToElement( {
  1177. model: 'style',
  1178. view: ( modelAttributeValue, { writer } ) => {
  1179. if ( modelAttributeValue == 'bold' ) {
  1180. return writer.createAttributeElement( 'b' );
  1181. }
  1182. }
  1183. } );
  1184. model.change( writer => {
  1185. writer.insert( modelElement, modelRootStart );
  1186. } );
  1187. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  1188. model.change( writer => {
  1189. writer.removeAttribute( 'style', writer.createRangeIn( modelElement ) );
  1190. } );
  1191. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1192. } );
  1193. it( 'should update range on re-wrapping attribute (#475)', () => {
  1194. const modelElement = new ModelElement( 'paragraph', null, [
  1195. new ModelText( 'x' ),
  1196. new ModelText( 'foo', { link: 'http://foo.com' } ),
  1197. new ModelText( 'x' )
  1198. ] );
  1199. downcastHelpers.attributeToElement( {
  1200. model: 'link',
  1201. view: ( modelAttributeValue, { writer } ) => {
  1202. return writer.createAttributeElement( 'a', { href: modelAttributeValue } );
  1203. }
  1204. } );
  1205. model.change( writer => {
  1206. writer.insert( modelElement, modelRootStart );
  1207. } );
  1208. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  1209. // Set new attribute on old link but also on non-linked characters.
  1210. model.change( writer => {
  1211. writer.setAttribute( 'link', 'http://foobar.com', writer.createRangeIn( modelElement ) );
  1212. } );
  1213. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  1214. } );
  1215. it( 'should support unicode', () => {
  1216. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  1217. downcastHelpers.attributeToElement( {
  1218. model: 'bold',
  1219. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
  1220. } );
  1221. model.change( writer => {
  1222. writer.insert( modelElement, modelRootStart );
  1223. } );
  1224. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  1225. model.change( writer => {
  1226. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  1227. } );
  1228. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  1229. } );
  1230. it( 'should be possible to override ', () => {
  1231. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  1232. downcastHelpers.attributeToElement( {
  1233. model: 'bold',
  1234. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
  1235. } );
  1236. downcastHelpers.attributeToElement( {
  1237. model: 'bold',
  1238. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'strong' ),
  1239. converterPriority: 'high'
  1240. } );
  1241. model.change( writer => {
  1242. writer.insert( modelElement, modelRootStart );
  1243. } );
  1244. expect( viewToString( viewRoot ) ).to.equal( '<div><p><strong>foobar</strong></p></div>' );
  1245. } );
  1246. it( 'should not convert and not consume if creator function returned null', () => {
  1247. sinon.spy( controller.downcastDispatcher, 'fire' );
  1248. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  1249. downcastHelpers.attributeToElement( {
  1250. model: 'italic',
  1251. view: () => null
  1252. } );
  1253. const spy = sinon.spy();
  1254. controller.downcastDispatcher.on( 'attribute:italic', spy );
  1255. model.change( writer => {
  1256. writer.insert( modelElement, modelRootStart );
  1257. } );
  1258. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1259. expect( controller.downcastDispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  1260. expect( spy.called ).to.be.true;
  1261. } );
  1262. } );
  1263. describe( 'attributeToAttribute()', () => {
  1264. testUtils.createSinonSandbox();
  1265. beforeEach( () => {
  1266. downcastHelpers.elementToElement( { model: 'image', view: 'img' } );
  1267. downcastHelpers.elementToElement( {
  1268. model: 'paragraph',
  1269. view: ( modelItem, { writer } ) => writer.createContainerElement( 'p' )
  1270. } );
  1271. downcastHelpers.attributeToAttribute( {
  1272. model: 'class',
  1273. view: 'class'
  1274. } );
  1275. } );
  1276. it( 'should be chainable', () => {
  1277. expect( downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } ) ).to.equal( downcastHelpers );
  1278. } );
  1279. it( 'config.view is a string', () => {
  1280. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } );
  1281. model.change( writer => {
  1282. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  1283. } );
  1284. expectResult( '<img src="foo.jpg"></img>' );
  1285. model.change( writer => {
  1286. writer.removeAttribute( 'source', modelRoot.getChild( 0 ) );
  1287. } );
  1288. expectResult( '<img></img>' );
  1289. } );
  1290. it( 'can be overwritten using converterPriority', () => {
  1291. downcastHelpers.attributeToAttribute( { model: 'source', view: 'href' } );
  1292. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src', converterPriority: 'high' } );
  1293. model.change( writer => {
  1294. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  1295. } );
  1296. expectResult( '<img src="foo.jpg"></img>' );
  1297. } );
  1298. it( 'model element name specified', () => {
  1299. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1300. downcastHelpers.attributeToAttribute( {
  1301. model: {
  1302. name: 'image',
  1303. key: 'source'
  1304. },
  1305. view: 'src'
  1306. } );
  1307. model.change( writer => {
  1308. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  1309. } );
  1310. expectResult( '<img src="foo.jpg"></img>' );
  1311. model.change( writer => {
  1312. writer.rename( modelRoot.getChild( 0 ), 'paragraph' );
  1313. } );
  1314. expectResult( '<p></p>' );
  1315. } );
  1316. it( 'config.view is an object, model attribute value is enum', () => {
  1317. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1318. downcastHelpers.attributeToAttribute( {
  1319. model: {
  1320. key: 'styled',
  1321. values: [ 'dark', 'light' ]
  1322. },
  1323. view: {
  1324. dark: {
  1325. key: 'class',
  1326. value: [ 'styled', 'styled-dark' ]
  1327. },
  1328. light: {
  1329. key: 'class',
  1330. value: [ 'styled', 'styled-light' ]
  1331. }
  1332. }
  1333. } );
  1334. model.change( writer => {
  1335. writer.insertElement( 'paragraph', { styled: 'dark' }, modelRoot, 0 );
  1336. } );
  1337. expectResult( '<p class="styled styled-dark"></p>' );
  1338. model.change( writer => {
  1339. writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) );
  1340. } );
  1341. expectResult( '<p class="styled styled-light"></p>' );
  1342. model.change( writer => {
  1343. writer.removeAttribute( 'styled', modelRoot.getChild( 0 ) );
  1344. } );
  1345. expectResult( '<p></p>' );
  1346. } );
  1347. it( 'config.view is an object, model attribute value is enum, view has style', () => {
  1348. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1349. downcastHelpers.attributeToAttribute( {
  1350. model: {
  1351. key: 'align',
  1352. values: [ 'right', 'center' ]
  1353. },
  1354. view: {
  1355. right: {
  1356. key: 'style',
  1357. value: {
  1358. 'text-align': 'right'
  1359. }
  1360. },
  1361. center: {
  1362. key: 'style',
  1363. value: {
  1364. 'text-align': 'center'
  1365. }
  1366. }
  1367. }
  1368. } );
  1369. model.change( writer => {
  1370. writer.insertElement( 'paragraph', { align: 'right' }, modelRoot, 0 );
  1371. } );
  1372. expectResult( '<p style="text-align:right"></p>' );
  1373. model.change( writer => {
  1374. writer.setAttribute( 'align', 'center', modelRoot.getChild( 0 ) );
  1375. } );
  1376. expectResult( '<p style="text-align:center"></p>' );
  1377. model.change( writer => {
  1378. writer.removeAttribute( 'align', modelRoot.getChild( 0 ) );
  1379. } );
  1380. expectResult( '<p></p>' );
  1381. } );
  1382. it( 'config.view is an object, only name and key are provided', () => {
  1383. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1384. downcastHelpers.attributeToAttribute( {
  1385. model: {
  1386. name: 'paragraph',
  1387. key: 'class'
  1388. },
  1389. view: {
  1390. name: 'paragraph',
  1391. key: 'class'
  1392. }
  1393. } );
  1394. model.change( writer => {
  1395. writer.insertElement( 'paragraph', { class: 'dark' }, modelRoot, 0 );
  1396. } );
  1397. expectResult( '<p class="dark"></p>' );
  1398. model.change( writer => {
  1399. writer.setAttribute( 'class', 'light', modelRoot.getChild( 0 ) );
  1400. } );
  1401. expectResult( '<p class="light"></p>' );
  1402. model.change( writer => {
  1403. writer.removeAttribute( 'class', modelRoot.getChild( 0 ) );
  1404. } );
  1405. expectResult( '<p></p>' );
  1406. } );
  1407. it( 'config.view is a function', () => {
  1408. downcastHelpers.attributeToAttribute( {
  1409. model: 'styled',
  1410. view: ( attributeValue, conversionApi ) => {
  1411. // To ensure conversion API is provided.
  1412. expect( conversionApi.writer ).to.instanceof( DowncastWriter );
  1413. return { key: 'class', value: 'styled-' + attributeValue };
  1414. }
  1415. } );
  1416. model.change( writer => {
  1417. writer.insertElement( 'image', { styled: 'pull-out' }, modelRoot, 0 );
  1418. } );
  1419. expectResult( '<img class="styled-pull-out"></img>' );
  1420. } );
  1421. // #1587
  1422. it( 'config.view and config.model as strings in generic conversion (elements only)', () => {
  1423. const consoleWarnStub = testUtils.sinon.stub( console, 'warn' );
  1424. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1425. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  1426. model.change( writer => {
  1427. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 0 );
  1428. writer.insertElement( 'paragraph', { test: '2' }, modelRoot, 1 );
  1429. } );
  1430. expectResult( '<p test="1"></p><p test="2"></p>' );
  1431. expect( consoleWarnStub.callCount ).to.equal( 0 );
  1432. model.change( writer => {
  1433. writer.removeAttribute( 'test', modelRoot.getChild( 1 ) );
  1434. } );
  1435. expectResult( '<p test="1"></p><p></p>' );
  1436. } );
  1437. // #1587
  1438. it( 'config.view and config.model as strings in generic conversion (elements + text)', () => {
  1439. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1440. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  1441. expectToThrowCKEditorError( () => {
  1442. model.change( writer => {
  1443. writer.insertElement( 'paragraph', modelRoot, 0 );
  1444. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 1 );
  1445. writer.insertText( 'Foo', { test: '2' }, modelRoot.getChild( 0 ), 0 );
  1446. writer.insertText( 'Bar', { test: '3' }, modelRoot.getChild( 1 ), 0 );
  1447. } );
  1448. }, /^conversion-attribute-to-attribute-on-text/ );
  1449. } );
  1450. it( 'should convert attribute insert/change/remove on a model node', () => {
  1451. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  1452. model.change( writer => {
  1453. writer.insert( modelElement, modelRootStart );
  1454. } );
  1455. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  1456. model.change( writer => {
  1457. writer.setAttribute( 'class', 'bar', modelElement );
  1458. } );
  1459. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  1460. model.change( writer => {
  1461. writer.removeAttribute( 'class', modelElement );
  1462. } );
  1463. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1464. } );
  1465. it( 'should be possible to override setAttribute', () => {
  1466. downcastHelpers.attributeToAttribute( {
  1467. model: 'class',
  1468. view: ( evt, data, conversionApi ) => {
  1469. conversionApi.consumable.consume( data.item, 'attribute:class' );
  1470. },
  1471. converterPriority: 'high'
  1472. } );
  1473. model.change( writer => {
  1474. const modelElement = new ModelElement( 'paragraph', { classes: 'foo' }, new ModelText( 'foobar' ) );
  1475. writer.insert( modelElement, modelRootStart );
  1476. } );
  1477. // No attribute set.
  1478. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1479. } );
  1480. it( 'should not convert or consume if element creator returned null', () => {
  1481. const callback = sinon.stub().returns( null );
  1482. downcastHelpers.attributeToAttribute( {
  1483. model: 'class',
  1484. view: callback,
  1485. converterPriority: 'high'
  1486. } );
  1487. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  1488. model.change( writer => {
  1489. writer.insert( modelElement, modelRootStart );
  1490. } );
  1491. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  1492. sinon.assert.called( callback );
  1493. } );
  1494. } );
  1495. describe( 'markerToElement()', () => {
  1496. let modelText, modelElement, range;
  1497. it( 'should be chainable', () => {
  1498. expect( downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } ) ).to.equal( downcastHelpers );
  1499. } );
  1500. it( 'config.view is a string', () => {
  1501. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  1502. model.change( writer => {
  1503. writer.insertText( 'foo', modelRoot, 0 );
  1504. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  1505. writer.addMarker( 'search', { range, usingOperation: false } );
  1506. } );
  1507. expectResult( 'f<marker-search></marker-search>o<marker-search></marker-search>o' );
  1508. } );
  1509. it( 'can be overwritten using converterPriority', () => {
  1510. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  1511. downcastHelpers.markerToElement( { model: 'search', view: 'search', converterPriority: 'high' } );
  1512. model.change( writer => {
  1513. writer.insertText( 'foo', modelRoot, 0 );
  1514. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  1515. writer.addMarker( 'search', { range, usingOperation: false } );
  1516. } );
  1517. expectResult( 'f<search></search>o<search></search>o' );
  1518. } );
  1519. it( 'config.view is a view element definition', () => {
  1520. downcastHelpers.markerToElement( {
  1521. model: 'search',
  1522. view: {
  1523. name: 'span',
  1524. attributes: {
  1525. 'data-marker': 'search'
  1526. }
  1527. }
  1528. } );
  1529. model.change( writer => {
  1530. writer.insertText( 'foo', modelRoot, 0 );
  1531. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  1532. writer.addMarker( 'search', { range, usingOperation: false } );
  1533. } );
  1534. expectResult( 'f<span data-marker="search"></span>o<span data-marker="search"></span>o' );
  1535. } );
  1536. it( 'config.view is a function', () => {
  1537. downcastHelpers.markerToElement( {
  1538. model: 'search',
  1539. view: ( data, { writer } ) => {
  1540. return writer.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } );
  1541. }
  1542. } );
  1543. model.change( writer => {
  1544. writer.insertText( 'foo', modelRoot, 0 );
  1545. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  1546. writer.addMarker( 'search', { range, usingOperation: false } );
  1547. } );
  1548. expectResult( 'f<span data-marker="search" data-start="true"></span>o<span data-marker="search" data-start="false"></span>o' );
  1549. } );
  1550. describe( 'collapsed range', () => {
  1551. beforeEach( () => {
  1552. modelText = new ModelText( 'foobar' );
  1553. modelElement = new ModelElement( 'paragraph', null, modelText );
  1554. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1555. model.change( writer => {
  1556. writer.insert( modelElement, modelRootStart );
  1557. } );
  1558. range = model.createRange( model.createPositionAt( modelElement, 3 ), model.createPositionAt( modelElement, 3 ) );
  1559. } );
  1560. it( 'should insert and remove ui element', () => {
  1561. downcastHelpers.markerToElement( {
  1562. model: 'marker',
  1563. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  1564. } );
  1565. model.change( writer => {
  1566. writer.addMarker( 'marker', { range, usingOperation: false } );
  1567. } );
  1568. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  1569. model.change( writer => {
  1570. writer.removeMarker( 'marker' );
  1571. } );
  1572. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1573. } );
  1574. it( 'should not convert if consumable was consumed', () => {
  1575. sinon.spy( controller.downcastDispatcher, 'fire' );
  1576. downcastHelpers.markerToElement( {
  1577. model: 'marker',
  1578. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  1579. } );
  1580. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  1581. conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
  1582. }, { priority: 'high' } );
  1583. model.change( writer => {
  1584. writer.addMarker( 'marker', { range, usingOperation: false } );
  1585. } );
  1586. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1587. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  1588. } );
  1589. it( 'should not convert if creator returned null', () => {
  1590. downcastHelpers.markerToElement( {
  1591. model: 'marker',
  1592. view: () => null
  1593. } );
  1594. model.change( writer => {
  1595. writer.addMarker( 'marker', { range, usingOperation: false } );
  1596. } );
  1597. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1598. model.change( writer => {
  1599. writer.removeMarker( 'marker' );
  1600. } );
  1601. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1602. } );
  1603. } );
  1604. describe( 'non-collapsed range', () => {
  1605. beforeEach( () => {
  1606. modelText = new ModelText( 'foobar' );
  1607. modelElement = new ModelElement( 'paragraph', null, modelText );
  1608. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1609. model.change( writer => {
  1610. writer.insert( modelElement, modelRootStart );
  1611. } );
  1612. range = model.createRange( model.createPositionAt( modelElement, 2 ), model.createPositionAt( modelElement, 5 ) );
  1613. } );
  1614. it( 'should insert and remove ui element - element as a creator', () => {
  1615. downcastHelpers.markerToElement( {
  1616. model: 'marker',
  1617. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  1618. } );
  1619. model.change( writer => {
  1620. writer.addMarker( 'marker', { range, usingOperation: false } );
  1621. } );
  1622. expect( viewToString( viewRoot ) )
  1623. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  1624. model.change( writer => {
  1625. writer.removeMarker( 'marker' );
  1626. } );
  1627. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1628. } );
  1629. it( 'should insert and remove ui element - function as a creator', () => {
  1630. downcastHelpers.markerToElement( {
  1631. model: 'marker',
  1632. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': data.markerName } )
  1633. } );
  1634. model.change( writer => {
  1635. writer.addMarker( 'marker', { range, usingOperation: false } );
  1636. } );
  1637. expect( viewToString( viewRoot ) )
  1638. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  1639. model.change( writer => {
  1640. writer.removeMarker( 'marker' );
  1641. } );
  1642. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1643. } );
  1644. it( 'should insert and remove different opening and ending element', () => {
  1645. downcastHelpers.markerToElement( {
  1646. model: 'marker',
  1647. view: ( data, { writer } ) => {
  1648. if ( data.isOpening ) {
  1649. return writer.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  1650. }
  1651. return writer.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  1652. }
  1653. } );
  1654. model.change( writer => {
  1655. writer.addMarker( 'marker', { range, usingOperation: false } );
  1656. } );
  1657. expect( viewToString( viewRoot ) ).to.equal(
  1658. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  1659. );
  1660. model.change( writer => {
  1661. writer.removeMarker( 'marker' );
  1662. } );
  1663. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1664. } );
  1665. it( 'should not convert if consumable was consumed', () => {
  1666. sinon.spy( controller.downcastDispatcher, 'fire' );
  1667. downcastHelpers.markerToElement( {
  1668. model: 'marker',
  1669. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  1670. } );
  1671. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  1672. conversionApi.consumable.consume( data.item, 'addMarker:marker' );
  1673. }, { priority: 'high' } );
  1674. model.change( writer => {
  1675. writer.addMarker( 'marker', { range, usingOperation: false } );
  1676. } );
  1677. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1678. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  1679. } );
  1680. } );
  1681. } );
  1682. describe( 'markerToData()', () => {
  1683. let root;
  1684. beforeEach( () => {
  1685. root = model.document.getRoot();
  1686. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  1687. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1688. } );
  1689. it( 'should be chainable', () => {
  1690. expect( downcastHelpers.markerToData( { model: 'search' } ) ).to.equal( downcastHelpers );
  1691. } );
  1692. it( 'default conversion, inside text, non-collapsed, no name', () => {
  1693. downcastHelpers.markerToData( { model: 'search' } );
  1694. setModelData( model, '<paragraph>Fo[ob]ar</paragraph>' );
  1695. model.change( writer => {
  1696. writer.addMarker( 'search', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1697. } );
  1698. expectResult( '<p>Fo<search-start></search-start>ob<search-end></search-end>ar</p>' );
  1699. model.change( writer => {
  1700. writer.removeMarker( 'search' );
  1701. } );
  1702. expectResult( '<p>Foobar</p>' );
  1703. } );
  1704. it( 'default conversion, inside text, non-collapsed, name', () => {
  1705. downcastHelpers.markerToData( { model: 'group' } );
  1706. setModelData( model, '<paragraph>Fo[ob]ar</paragraph>' );
  1707. model.change( writer => {
  1708. writer.addMarker( 'group:foo:bar:baz', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1709. } );
  1710. expectResult( '<p>Fo<group-start name="foo:bar:baz"></group-start>ob<group-end name="foo:bar:baz"></group-end>ar</p>' );
  1711. model.change( writer => {
  1712. writer.removeMarker( 'group:foo:bar:baz' );
  1713. } );
  1714. expectResult( '<p>Foobar</p>' );
  1715. } );
  1716. it( 'default conversion, inside text, collapsed, no name', () => {
  1717. downcastHelpers.markerToData( { model: 'search' } );
  1718. setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
  1719. model.change( writer => {
  1720. writer.addMarker( 'search', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1721. } );
  1722. expectResult( '<p>Foo<search-start></search-start><search-end></search-end>bar</p>' );
  1723. model.change( writer => {
  1724. writer.removeMarker( 'search' );
  1725. } );
  1726. expectResult( '<p>Foobar</p>' );
  1727. } );
  1728. it( 'default conversion, inside text, collapsed, multiple markers, no name', () => {
  1729. downcastHelpers.markerToData( { model: 'group' } );
  1730. setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
  1731. model.change( writer => {
  1732. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1733. writer.addMarker( 'group:abc', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1734. } );
  1735. expectResult(
  1736. '<p>' +
  1737. 'Foo' +
  1738. '<group-start name="abc"></group-start><group-end name="abc"></group-end>' +
  1739. '<group-start name="foo"></group-start><group-end name="foo"></group-end>' +
  1740. 'bar' +
  1741. '</p>'
  1742. );
  1743. model.change( writer => {
  1744. writer.removeMarker( 'group:foo' );
  1745. writer.removeMarker( 'group:abc' );
  1746. } );
  1747. expectResult( '<p>Foobar</p>' );
  1748. } );
  1749. it( 'default conversion, on two elements, no name', () => {
  1750. downcastHelpers.markerToData( { model: 'search' } );
  1751. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1752. model.change( writer => {
  1753. const range = writer.createRangeIn( root );
  1754. writer.addMarker( 'search', { range, usingOperation: false } );
  1755. } );
  1756. expectResult( '<p data-search-start-before="">Foo</p><p data-search-end-after="">Bar</p>' );
  1757. model.change( writer => {
  1758. writer.removeMarker( 'search' );
  1759. } );
  1760. expectResult( '<p>Foo</p><p>Bar</p>' );
  1761. } );
  1762. it( 'default conversion, on two elements, name', () => {
  1763. downcastHelpers.markerToData( { model: 'group' } );
  1764. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1765. model.change( writer => {
  1766. const range = writer.createRangeIn( root );
  1767. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1768. } );
  1769. expectResult( '<p data-group-start-before="foo:bar:baz">Foo</p><p data-group-end-after="foo:bar:baz">Bar</p>' );
  1770. model.change( writer => {
  1771. writer.removeMarker( 'group:foo:bar:baz' );
  1772. } );
  1773. expectResult( '<p>Foo</p><p>Bar</p>' );
  1774. } );
  1775. it( 'default conversion, on one element, name', () => {
  1776. downcastHelpers.markerToData( { model: 'group' } );
  1777. setModelData( model, '<paragraph>Foobar</paragraph>' );
  1778. model.change( writer => {
  1779. const range = writer.createRangeIn( root );
  1780. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1781. } );
  1782. expectResult( '<p data-group-end-after="foo:bar:baz" data-group-start-before="foo:bar:baz">Foobar</p>' );
  1783. model.change( writer => {
  1784. writer.removeMarker( 'group:foo:bar:baz' );
  1785. } );
  1786. expectResult( '<p>Foobar</p>' );
  1787. } );
  1788. it( 'default conversion, collapsed before element, name', () => {
  1789. downcastHelpers.markerToData( { model: 'group' } );
  1790. setModelData( model, '<paragraph>Foobar</paragraph>' );
  1791. model.change( writer => {
  1792. // Collapsed before <paragraph>.
  1793. const range = writer.createRange(
  1794. writer.createPositionFromPath( root, [ 0 ] )
  1795. );
  1796. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1797. } );
  1798. expectResult( '<p data-group-end-before="foo:bar:baz" data-group-start-before="foo:bar:baz">Foobar</p>' );
  1799. model.change( writer => {
  1800. writer.removeMarker( 'group:foo:bar:baz' );
  1801. } );
  1802. expectResult( '<p>Foobar</p>' );
  1803. } );
  1804. it( 'default conversion, collapsed after element, name', () => {
  1805. downcastHelpers.markerToData( { model: 'group' } );
  1806. setModelData( model, '<paragraph>Foobar</paragraph>' );
  1807. model.change( writer => {
  1808. // Collapsed before <paragraph>.
  1809. const range = writer.createRange(
  1810. writer.createPositionFromPath( root, [ 1 ] )
  1811. );
  1812. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1813. } );
  1814. expectResult( '<p data-group-end-after="foo:bar:baz" data-group-start-after="foo:bar:baz">Foobar</p>' );
  1815. model.change( writer => {
  1816. writer.removeMarker( 'group:foo:bar:baz' );
  1817. } );
  1818. expectResult( '<p>Foobar</p>' );
  1819. } );
  1820. it( 'default conversion, mixed, multiple markers, name', () => {
  1821. downcastHelpers.markerToData( { model: 'group' } );
  1822. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1823. model.change( writer => {
  1824. const range = writer.createRange(
  1825. writer.createPositionFromPath( root, [ 0 ] ),
  1826. writer.createPositionFromPath( root, [ 1, 2 ] )
  1827. );
  1828. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1829. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1830. } );
  1831. expectResult(
  1832. '<p data-group-start-before="abc:xyz,foo:bar">Foo</p>' +
  1833. '<p>Ba<group-end name="abc:xyz"></group-end><group-end name="foo:bar"></group-end>r</p>'
  1834. );
  1835. model.change( writer => {
  1836. writer.removeMarker( 'group:foo:bar' );
  1837. writer.removeMarker( 'group:abc:xyz' );
  1838. } );
  1839. expectResult( '<p>Foo</p><p>Bar</p>' );
  1840. } );
  1841. it( 'default conversion, mixed #2, multiple markers, name', () => {
  1842. downcastHelpers.markerToData( { model: 'group' } );
  1843. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1844. model.change( writer => {
  1845. const range = writer.createRange(
  1846. writer.createPositionFromPath( root, [ 0, 1 ] ),
  1847. writer.createPositionFromPath( root, [ 2 ] )
  1848. );
  1849. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1850. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1851. } );
  1852. expectResult(
  1853. '<p>F<group-start name="abc:xyz"></group-start><group-start name="foo:bar"></group-start>oo</p>' +
  1854. '<p data-group-end-after="abc:xyz,foo:bar">Bar</p>'
  1855. );
  1856. model.change( writer => {
  1857. writer.removeMarker( 'group:foo:bar' );
  1858. writer.removeMarker( 'group:abc:xyz' );
  1859. } );
  1860. expectResult( '<p>Foo</p><p>Bar</p>' );
  1861. } );
  1862. it( 'default conversion, mixed #3, multiple markers, name', () => {
  1863. downcastHelpers.markerToData( { model: 'group' } );
  1864. setModelData( model, '<paragraph>Foo</paragraph>' );
  1865. model.change( writer => {
  1866. const range = writer.createRange(
  1867. writer.createPositionFromPath( root, [ 0 ] ),
  1868. writer.createPositionFromPath( root, [ 0, 2 ] )
  1869. );
  1870. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1871. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1872. } );
  1873. expectResult(
  1874. '<p data-group-start-before="abc:xyz,foo:bar">' +
  1875. 'Fo<group-end name="abc:xyz"></group-end><group-end name="foo:bar"></group-end>o' +
  1876. '</p>'
  1877. );
  1878. model.change( writer => {
  1879. writer.removeMarker( 'group:foo:bar' );
  1880. writer.removeMarker( 'group:abc:xyz' );
  1881. } );
  1882. expectResult( '<p>Foo</p>' );
  1883. } );
  1884. it( 'default conversion, mixed #4, multiple markers, name', () => {
  1885. downcastHelpers.markerToData( { model: 'group' } );
  1886. setModelData( model, '<paragraph>Foo</paragraph>' );
  1887. model.change( writer => {
  1888. const range = writer.createRange(
  1889. writer.createPositionFromPath( root, [ 0, 2 ] ),
  1890. writer.createPositionFromPath( root, [ 1 ] )
  1891. );
  1892. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1893. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1894. } );
  1895. expectResult(
  1896. '<p data-group-end-after="abc:xyz,foo:bar">' +
  1897. 'Fo<group-start name="abc:xyz"></group-start><group-start name="foo:bar"></group-start>o' +
  1898. '</p>'
  1899. );
  1900. model.change( writer => {
  1901. writer.removeMarker( 'group:foo:bar' );
  1902. writer.removeMarker( 'group:abc:xyz' );
  1903. } );
  1904. expectResult( '<p>Foo</p>' );
  1905. } );
  1906. it( 'conversion callback, mixed, multiple markers, name', () => {
  1907. const customData = {
  1908. foo: 'bar',
  1909. abc: 'xyz'
  1910. };
  1911. downcastHelpers.markerToData( {
  1912. model: 'group',
  1913. view: ( markerName, conversionApi ) => {
  1914. const namePart = markerName.split( ':' )[ 1 ];
  1915. // To ensure conversion API is provided.
  1916. expect( conversionApi.writer ).to.instanceof( DowncastWriter );
  1917. return {
  1918. group: 'g',
  1919. name: namePart + '_' + customData[ namePart ]
  1920. };
  1921. }
  1922. } );
  1923. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1924. model.change( writer => {
  1925. const range = writer.createRange(
  1926. writer.createPositionFromPath( root, [ 0 ] ),
  1927. writer.createPositionFromPath( root, [ 1, 2 ] )
  1928. );
  1929. writer.addMarker( 'group:foo', { range, usingOperation: false } );
  1930. writer.addMarker( 'group:abc', { range, usingOperation: false } );
  1931. } );
  1932. expectResult(
  1933. '<p data-g-start-before="abc_xyz,foo_bar">Foo</p>' +
  1934. '<p>Ba<g-end name="abc_xyz"></g-end><g-end name="foo_bar"></g-end>r</p>'
  1935. );
  1936. model.change( writer => {
  1937. writer.removeMarker( 'group:foo' );
  1938. writer.removeMarker( 'group:abc' );
  1939. } );
  1940. expectResult( '<p>Foo</p><p>Bar</p>' );
  1941. } );
  1942. it( 'conversion callback, mixed #2, multiple markers, name', () => {
  1943. const customData = {
  1944. foo: 'bar',
  1945. abc: 'xyz'
  1946. };
  1947. downcastHelpers.markerToData( {
  1948. model: 'group',
  1949. view: markerName => {
  1950. const namePart = markerName.split( ':' )[ 1 ];
  1951. return {
  1952. group: 'g',
  1953. name: namePart + '_' + customData[ namePart ]
  1954. };
  1955. }
  1956. } );
  1957. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1958. model.change( writer => {
  1959. const range = writer.createRange(
  1960. writer.createPositionFromPath( root, [ 0, 1 ] ),
  1961. writer.createPositionFromPath( root, [ 2 ] )
  1962. );
  1963. writer.addMarker( 'group:foo', { range, usingOperation: false } );
  1964. writer.addMarker( 'group:abc', { range, usingOperation: false } );
  1965. } );
  1966. expectResult(
  1967. '<p>F<g-start name="abc_xyz"></g-start><g-start name="foo_bar"></g-start>oo</p>' +
  1968. '<p data-g-end-after="abc_xyz,foo_bar">Bar</p>'
  1969. );
  1970. model.change( writer => {
  1971. writer.removeMarker( 'group:foo' );
  1972. writer.removeMarker( 'group:abc' );
  1973. } );
  1974. expectResult( '<p>Foo</p><p>Bar</p>' );
  1975. } );
  1976. it( 'can be overwritten using converterPriority', () => {
  1977. downcastHelpers.markerToData( {
  1978. model: 'group'
  1979. } );
  1980. downcastHelpers.markerToData( {
  1981. model: 'group',
  1982. view: markerName => {
  1983. const name = markerName.split( ':' )[ 1 ];
  1984. return {
  1985. group: 'g',
  1986. name
  1987. };
  1988. },
  1989. converterPriority: 'high'
  1990. } );
  1991. setModelData( model, '<paragraph>F[ooba]r</paragraph>' );
  1992. model.change( writer => {
  1993. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1994. } );
  1995. expectResult(
  1996. '<p>F<g-start name="foo"></g-start>ooba<g-end name="foo"></g-end>r</p>'
  1997. );
  1998. model.change( writer => {
  1999. writer.removeMarker( 'group:foo' );
  2000. } );
  2001. expectResult( '<p>Foobar</p>' );
  2002. } );
  2003. it( 'can be overwritten by custom callback', () => {
  2004. downcastHelpers.markerToData( {
  2005. model: 'group'
  2006. } );
  2007. downcastHelpers.add( dispatcher => {
  2008. dispatcher.on( 'addMarker:group', ( evt, data, conversionApi ) => {
  2009. conversionApi.consumable.consume( data.markerRange, evt.name );
  2010. }, { priority: 'high' } );
  2011. } );
  2012. setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
  2013. model.change( writer => {
  2014. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  2015. } );
  2016. expectResult( '<p>Foobar</p>' );
  2017. model.change( writer => {
  2018. writer.removeMarker( 'group:foo' );
  2019. } );
  2020. expectResult( '<p>Foobar</p>' );
  2021. } );
  2022. it( 'should not perform conversion if the callback returned falsy value', () => {
  2023. downcastHelpers.markerToData( {
  2024. model: 'group',
  2025. view: () => false
  2026. } );
  2027. setModelData( model, '<paragraph>F[ooba]r</paragraph>' );
  2028. model.change( writer => {
  2029. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  2030. } );
  2031. expectResult( '<p>Foobar</p>' );
  2032. model.change( writer => {
  2033. writer.removeMarker( 'group:foo' );
  2034. } );
  2035. expectResult( '<p>Foobar</p>' );
  2036. } );
  2037. } );
  2038. describe( 'markerToHighlight()', () => {
  2039. it( 'should be chainable', () => {
  2040. expect( downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } ) ).to.equal( downcastHelpers );
  2041. } );
  2042. it( 'config.view is a highlight descriptor', () => {
  2043. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  2044. model.change( writer => {
  2045. writer.insertText( 'foo', modelRoot, 0 );
  2046. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  2047. writer.addMarker( 'comment', { range, usingOperation: false } );
  2048. } );
  2049. expectResult( '<span class="comment">foo</span>' );
  2050. } );
  2051. it( 'can be overwritten using converterPriority', () => {
  2052. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  2053. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'new-comment' }, converterPriority: 'high' } );
  2054. model.change( writer => {
  2055. writer.insertText( 'foo', modelRoot, 0 );
  2056. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  2057. writer.addMarker( 'comment', { range, usingOperation: false } );
  2058. } );
  2059. expectResult( '<span class="new-comment">foo</span>' );
  2060. } );
  2061. it( 'config.view is a function', () => {
  2062. downcastHelpers.markerToHighlight( {
  2063. model: 'comment',
  2064. view: ( data, conversionApi ) => {
  2065. const commentType = data.markerName.split( ':' )[ 1 ];
  2066. // To ensure conversion API is provided.
  2067. expect( conversionApi.writer ).to.instanceof( DowncastWriter );
  2068. return {
  2069. classes: [ 'comment', 'comment-' + commentType ]
  2070. };
  2071. }
  2072. } );
  2073. model.change( writer => {
  2074. writer.insertText( 'foo', modelRoot, 0 );
  2075. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  2076. writer.addMarker( 'comment:abc', { range, usingOperation: false } );
  2077. } );
  2078. expectResult( '<span class="comment comment-abc">foo</span>' );
  2079. } );
  2080. describe( 'highlight', () => {
  2081. const highlightConfig = {
  2082. model: 'marker',
  2083. view: {
  2084. classes: 'highlight-class',
  2085. attributes: { title: 'title' }
  2086. },
  2087. converterPriority: 7
  2088. };
  2089. describe( 'on text', () => {
  2090. let markerRange;
  2091. beforeEach( () => {
  2092. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  2093. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  2094. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  2095. model.change( writer => {
  2096. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  2097. } );
  2098. markerRange = model.createRangeIn( modelRoot );
  2099. } );
  2100. it( 'should wrap and unwrap text nodes', () => {
  2101. downcastHelpers.markerToHighlight( highlightConfig );
  2102. model.change( writer => {
  2103. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2104. } );
  2105. expect( viewToString( viewRoot ) ).to.equal(
  2106. '<div>' +
  2107. '<p>' +
  2108. '<span class="highlight-class" title="title">foo</span>' +
  2109. '</p>' +
  2110. '<p>' +
  2111. '<span class="highlight-class" title="title">bar</span>' +
  2112. '</p>' +
  2113. '</div>'
  2114. );
  2115. model.change( writer => {
  2116. writer.removeMarker( 'marker' );
  2117. } );
  2118. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2119. } );
  2120. it( 'should be possible to overwrite', () => {
  2121. downcastHelpers.markerToHighlight( highlightConfig );
  2122. downcastHelpers.markerToHighlight( {
  2123. model: 'marker',
  2124. view: { classes: 'override-class' },
  2125. converterPriority: 'high'
  2126. } );
  2127. model.change( writer => {
  2128. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2129. } );
  2130. expect( viewToString( viewRoot ) ).to.equal(
  2131. '<div>' +
  2132. '<p>' +
  2133. '<span class="override-class">foo</span>' +
  2134. '</p>' +
  2135. '<p>' +
  2136. '<span class="override-class">bar</span>' +
  2137. '</p>' +
  2138. '</div>'
  2139. );
  2140. model.change( writer => {
  2141. writer.removeMarker( 'marker' );
  2142. } );
  2143. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2144. } );
  2145. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  2146. downcastHelpers.markerToHighlight( {
  2147. model: 'marker',
  2148. view: () => null,
  2149. converterPriority: 'high'
  2150. } );
  2151. model.change( writer => {
  2152. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2153. } );
  2154. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2155. model.change( writer => {
  2156. writer.removeMarker( 'marker' );
  2157. } );
  2158. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2159. } );
  2160. it( 'should do nothing if collapsed marker is converted', () => {
  2161. downcastHelpers.markerToHighlight( {
  2162. model: 'marker',
  2163. view: { classes: 'foo' },
  2164. converterPriority: 'high'
  2165. } );
  2166. markerRange = model.createRange( model.createPositionAt( modelRoot, 0 ), model.createPositionAt( modelRoot, 0 ) );
  2167. model.change( writer => {
  2168. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2169. } );
  2170. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2171. model.change( () => {
  2172. model.markers._remove( 'marker' );
  2173. } );
  2174. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2175. } );
  2176. it( 'should correctly wrap and unwrap multiple, intersecting markers', () => {
  2177. downcastHelpers.markerToHighlight( {
  2178. model: 'markerFoo',
  2179. view: { classes: 'foo' }
  2180. } );
  2181. downcastHelpers.markerToHighlight( {
  2182. model: 'markerBar',
  2183. view: { classes: 'bar' }
  2184. } );
  2185. downcastHelpers.markerToHighlight( {
  2186. model: 'markerXyz',
  2187. view: { classes: 'xyz' }
  2188. } );
  2189. const p1 = modelRoot.getChild( 0 );
  2190. const p2 = modelRoot.getChild( 1 );
  2191. model.change( writer => {
  2192. const range = writer.createRange( writer.createPositionAt( p1, 0 ), writer.createPositionAt( p1, 3 ) );
  2193. writer.addMarker( 'markerFoo', { range, usingOperation: false } );
  2194. } );
  2195. expect( viewToString( viewRoot ) ).to.equal(
  2196. '<div>' +
  2197. '<p>' +
  2198. '<span class="foo">foo</span>' +
  2199. '</p>' +
  2200. '<p>bar</p>' +
  2201. '</div>'
  2202. );
  2203. model.change( writer => {
  2204. const range = writer.createRange( writer.createPositionAt( p1, 1 ), writer.createPositionAt( p2, 2 ) );
  2205. writer.addMarker( 'markerBar', { range, usingOperation: false } );
  2206. } );
  2207. expect( viewToString( viewRoot ) ).to.equal(
  2208. '<div>' +
  2209. '<p>' +
  2210. '<span class="foo">f</span>' +
  2211. '<span class="bar">' +
  2212. '<span class="foo">oo</span>' +
  2213. '</span>' +
  2214. '</p>' +
  2215. '<p>' +
  2216. '<span class="bar">ba</span>' +
  2217. 'r' +
  2218. '</p>' +
  2219. '</div>'
  2220. );
  2221. model.change( writer => {
  2222. const range = writer.createRange( writer.createPositionAt( p1, 2 ), writer.createPositionAt( p2, 3 ) );
  2223. writer.addMarker( 'markerXyz', { range, usingOperation: false } );
  2224. } );
  2225. expect( viewToString( viewRoot ) ).to.equal(
  2226. '<div>' +
  2227. '<p>' +
  2228. '<span class="foo">f</span>' +
  2229. '<span class="bar">' +
  2230. '<span class="foo">' +
  2231. 'o' +
  2232. '<span class="xyz">o</span>' +
  2233. '</span>' +
  2234. '</span>' +
  2235. '</p>' +
  2236. '<p>' +
  2237. '<span class="bar">' +
  2238. '<span class="xyz">ba</span>' +
  2239. '</span>' +
  2240. '<span class="xyz">r</span>' +
  2241. '</p>' +
  2242. '</div>'
  2243. );
  2244. model.change( writer => {
  2245. writer.removeMarker( 'markerBar' );
  2246. } );
  2247. expect( viewToString( viewRoot ) ).to.equal(
  2248. '<div>' +
  2249. '<p>' +
  2250. '<span class="foo">' +
  2251. 'fo' +
  2252. '<span class="xyz">o</span>' +
  2253. '</span>' +
  2254. '</p>' +
  2255. '<p>' +
  2256. '<span class="xyz">bar</span>' +
  2257. '</p>' +
  2258. '</div>'
  2259. );
  2260. model.change( writer => {
  2261. writer.removeMarker( 'markerFoo' );
  2262. } );
  2263. expect( viewToString( viewRoot ) ).to.equal(
  2264. '<div>' +
  2265. '<p>' +
  2266. 'fo' +
  2267. '<span class="xyz">o</span>' +
  2268. '</p>' +
  2269. '<p>' +
  2270. '<span class="xyz">bar</span>' +
  2271. '</p>' +
  2272. '</div>'
  2273. );
  2274. model.change( writer => {
  2275. writer.removeMarker( 'markerXyz' );
  2276. } );
  2277. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2278. } );
  2279. it( 'should do nothing if marker is applied and removed on empty-ish range', () => {
  2280. downcastHelpers.markerToHighlight( highlightConfig );
  2281. const p1 = modelRoot.getChild( 0 );
  2282. const p2 = modelRoot.getChild( 1 );
  2283. const markerRange = model.createRange( model.createPositionAt( p1, 3 ), model.createPositionAt( p2, 0 ) );
  2284. model.change( writer => {
  2285. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2286. } );
  2287. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2288. model.change( writer => {
  2289. writer.removeMarker( 'marker', { range: markerRange, usingOperation: false } );
  2290. } );
  2291. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2292. } );
  2293. } );
  2294. describe( 'on element', () => {
  2295. const highlightConfig = {
  2296. model: 'marker',
  2297. view: {
  2298. classes: 'highlight-class',
  2299. attributes: { title: 'title' },
  2300. id: 'customId'
  2301. },
  2302. converterPriority: 7
  2303. };
  2304. let markerRange, viewDocument;
  2305. beforeEach( () => {
  2306. viewDocument = new ViewDocument( new StylesProcessor() );
  2307. downcastHelpers.elementToElement( {
  2308. model: 'div',
  2309. view: () => {
  2310. const viewContainer = new ViewContainerElement( viewDocument, 'div' );
  2311. viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => {
  2312. writer.addClass( descriptor.classes, element );
  2313. } );
  2314. viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => {
  2315. writer.setAttribute( 'class', '', element );
  2316. } );
  2317. return viewContainer;
  2318. }
  2319. } );
  2320. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  2321. model.change( writer => {
  2322. writer.insert( modelElement, modelRootStart );
  2323. } );
  2324. markerRange = model.createRangeOn( modelElement );
  2325. downcastHelpers.markerToHighlight( highlightConfig );
  2326. } );
  2327. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  2328. model.change( writer => {
  2329. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2330. } );
  2331. expect( viewToString( viewRoot ) ).to.equal(
  2332. '<div>' +
  2333. '<div class="highlight-class">' +
  2334. 'foo' +
  2335. '</div>' +
  2336. '</div>'
  2337. );
  2338. model.change( writer => {
  2339. writer.removeMarker( 'marker' );
  2340. } );
  2341. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  2342. } );
  2343. it( 'should be possible to override', () => {
  2344. downcastHelpers.markerToHighlight( {
  2345. model: 'marker',
  2346. view: { classes: 'override-class' },
  2347. converterPriority: 'high'
  2348. } );
  2349. model.change( writer => {
  2350. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2351. } );
  2352. expect( viewToString( viewRoot ) ).to.equal(
  2353. '<div>' +
  2354. '<div class="override-class">' +
  2355. 'foo' +
  2356. '</div>' +
  2357. '</div>'
  2358. );
  2359. model.change( writer => {
  2360. writer.removeMarker( 'marker' );
  2361. } );
  2362. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  2363. } );
  2364. it( 'should use default priority and id if not provided', () => {
  2365. const viewDiv = viewRoot.getChild( 0 );
  2366. downcastHelpers.markerToHighlight( {
  2367. model: 'marker2',
  2368. view: () => null,
  2369. converterPriority: 'high'
  2370. } );
  2371. viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  2372. expect( descriptor.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  2373. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  2374. } );
  2375. viewDiv._setCustomProperty( 'removeHighlight', ( element, id ) => {
  2376. expect( id ).to.equal( 'marker:foo-bar-baz' );
  2377. } );
  2378. model.change( writer => {
  2379. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  2380. } );
  2381. } );
  2382. it( 'should do nothing if descriptor is not provided', () => {
  2383. downcastHelpers.markerToHighlight( {
  2384. model: 'marker2',
  2385. view: () => null
  2386. } );
  2387. model.change( writer => {
  2388. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  2389. } );
  2390. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  2391. model.change( writer => {
  2392. writer.removeMarker( 'marker2' );
  2393. } );
  2394. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  2395. } );
  2396. } );
  2397. } );
  2398. } );
  2399. function expectResult( string ) {
  2400. expect( stringifyView( viewRoot, null, { ignoreRoot: true } ) ).to.equal( string );
  2401. }
  2402. } );
  2403. describe( 'downcast converters', () => {
  2404. let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model;
  2405. beforeEach( () => {
  2406. model = new Model();
  2407. modelDoc = model.document;
  2408. modelRoot = modelDoc.createRoot();
  2409. controller = new EditingController( model, new StylesProcessor() );
  2410. viewRoot = controller.view.document.getRoot();
  2411. // Set name of view root the same as dom root.
  2412. // This is a mock of attaching view root to dom root.
  2413. controller.view.document.getRoot()._name = 'div';
  2414. dispatcher = controller.downcastDispatcher;
  2415. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  2416. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  2417. modelRootStart = model.createPositionAt( modelRoot, 0 );
  2418. } );
  2419. describe( 'insertText()', () => {
  2420. it( 'should downcast text', () => {
  2421. model.change( writer => {
  2422. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  2423. } );
  2424. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  2425. } );
  2426. it( 'should support unicode', () => {
  2427. model.change( writer => {
  2428. writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
  2429. } );
  2430. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  2431. } );
  2432. it( 'should be possible to override it', () => {
  2433. dispatcher.on( 'insert:$text', ( evt, data, conversionApi ) => {
  2434. conversionApi.consumable.consume( data.item, 'insert' );
  2435. }, { converterPriority: 'high' } );
  2436. model.change( writer => {
  2437. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  2438. } );
  2439. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  2440. } );
  2441. } );
  2442. // Remove converter is by default already added in `EditingController` instance.
  2443. describe( 'remove()', () => {
  2444. let viewDocument;
  2445. beforeEach( () => {
  2446. viewDocument = new ViewDocument( new StylesProcessor() );
  2447. } );
  2448. it( 'should remove items from view accordingly to changes in model #1', () => {
  2449. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  2450. model.change( writer => {
  2451. writer.insert( modelElement, modelRootStart );
  2452. } );
  2453. model.change( writer => {
  2454. writer.remove(
  2455. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  2456. );
  2457. } );
  2458. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  2459. } );
  2460. it( 'should be possible to overwrite', () => {
  2461. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  2462. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  2463. model.change( writer => {
  2464. writer.insert( modelElement, modelRootStart );
  2465. } );
  2466. model.change( writer => {
  2467. writer.remove(
  2468. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  2469. );
  2470. } );
  2471. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  2472. } );
  2473. it( 'should support unicode', () => {
  2474. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  2475. model.change( writer => {
  2476. writer.insert( modelElement, modelRootStart );
  2477. } );
  2478. model.change( writer => {
  2479. writer.remove(
  2480. writer.createRange( writer.createPositionAt( modelElement, 0 ), writer.createPositionAt( modelElement, 6 ) )
  2481. );
  2482. } );
  2483. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  2484. } );
  2485. it( 'should not remove view ui elements that are placed next to removed content', () => {
  2486. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  2487. viewRoot._appendChild( [
  2488. new ViewText( viewDocument, 'foz' ),
  2489. new ViewUIElement( viewDocument, 'span' ),
  2490. new ViewText( viewDocument, 'bar' )
  2491. ] );
  2492. // Remove 'b'.
  2493. model.change( writer => {
  2494. writer.remove(
  2495. writer.createRange( writer.createPositionAt( modelRoot, 3 ), writer.createPositionAt( modelRoot, 4 ) )
  2496. );
  2497. } );
  2498. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  2499. // Remove 'z'.
  2500. model.change( writer => {
  2501. writer.remove(
  2502. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 3 ) )
  2503. );
  2504. } );
  2505. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  2506. } );
  2507. it( 'should remove correct amount of text when it is split by view ui element', () => {
  2508. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  2509. viewRoot._appendChild( [
  2510. new ViewText( viewDocument, 'foz' ),
  2511. new ViewUIElement( viewDocument, 'span' ),
  2512. new ViewText( viewDocument, 'bar' )
  2513. ] );
  2514. // Remove 'z<span></span>b'.
  2515. model.change( writer => {
  2516. writer.remove(
  2517. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 4 ) )
  2518. );
  2519. } );
  2520. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  2521. } );
  2522. it( 'should unbind elements', () => {
  2523. const modelElement = new ModelElement( 'paragraph' );
  2524. model.change( writer => {
  2525. writer.insert( modelElement, modelRootStart );
  2526. } );
  2527. const viewElement = controller.mapper.toViewElement( modelElement );
  2528. expect( viewElement ).not.to.be.undefined;
  2529. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  2530. model.change( writer => {
  2531. writer.remove( modelElement );
  2532. } );
  2533. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  2534. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  2535. } );
  2536. it( 'should not break when remove() is used as part of unwrapping', () => {
  2537. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  2538. const modelWidget = new ModelElement( 'widget', null, modelP );
  2539. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  2540. downcastHelpers.elementToElement( { model: 'widget', view: 'widget' } );
  2541. model.change( writer => {
  2542. writer.insert( modelWidget, modelRootStart );
  2543. } );
  2544. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  2545. const viewP = controller.mapper.toViewElement( modelP );
  2546. expect( viewP ).not.to.be.undefined;
  2547. model.change( writer => {
  2548. writer.unwrap( modelWidget );
  2549. } );
  2550. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  2551. // `modelP` is now bound with newly created view element.
  2552. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  2553. // `viewP` is no longer bound with model element.
  2554. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  2555. // View element from view root is bound to `modelP`.
  2556. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  2557. } );
  2558. it( 'should work correctly if container element after ui element is removed', () => {
  2559. // Prepare a model and view structure.
  2560. // This is done outside of conversion to put view ui elements inside easily.
  2561. const modelP1 = new ModelElement( 'paragraph' );
  2562. const modelP2 = new ModelElement( 'paragraph' );
  2563. const viewP1 = new ViewContainerElement( viewDocument, 'p' );
  2564. const viewUi1 = new ViewUIElement( viewDocument, 'span' );
  2565. const viewUi2 = new ViewUIElement( viewDocument, 'span' );
  2566. const viewP2 = new ViewContainerElement( viewDocument, 'p' );
  2567. modelRoot._appendChild( [ modelP1, modelP2 ] );
  2568. viewRoot._appendChild( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  2569. controller.mapper.bindElements( modelP1, viewP1 );
  2570. controller.mapper.bindElements( modelP2, viewP2 );
  2571. // Remove second paragraph element.
  2572. model.change( writer => {
  2573. writer.remove( writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) ) );
  2574. } );
  2575. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  2576. } );
  2577. it( 'should work correctly if container element after text node is removed', () => {
  2578. const modelText = new ModelText( 'foo' );
  2579. const modelP = new ModelElement( 'paragraph' );
  2580. model.change( writer => {
  2581. writer.insert( [ modelText, modelP ], modelRootStart );
  2582. } );
  2583. model.change( writer => {
  2584. writer.remove( modelP );
  2585. } );
  2586. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  2587. } );
  2588. } );
  2589. describe( 'createViewElementFromHighlightDescriptor()', () => {
  2590. let viewWriter;
  2591. beforeEach( () => {
  2592. viewWriter = new DowncastWriter( controller.view.document );
  2593. } );
  2594. it( 'should return attribute element from descriptor object', () => {
  2595. const descriptor = {
  2596. classes: 'foo-class',
  2597. attributes: { one: '1', two: '2' },
  2598. priority: 7
  2599. };
  2600. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2601. expect( element.is( 'attributeElement' ) ).to.be.true;
  2602. expect( element.name ).to.equal( 'span' );
  2603. expect( element.priority ).to.equal( 7 );
  2604. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  2605. for ( const key of Object.keys( descriptor.attributes ) ) {
  2606. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  2607. }
  2608. } );
  2609. it( 'should return attribute element from descriptor object - array with classes', () => {
  2610. const descriptor = {
  2611. classes: [ 'foo-class', 'bar-class' ],
  2612. attributes: { one: '1', two: '2' },
  2613. priority: 7
  2614. };
  2615. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2616. expect( element.is( 'attributeElement' ) ).to.be.true;
  2617. expect( element.name ).to.equal( 'span' );
  2618. expect( element.priority ).to.equal( 7 );
  2619. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  2620. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  2621. for ( const key of Object.keys( descriptor.attributes ) ) {
  2622. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  2623. }
  2624. } );
  2625. it( 'should create element without class', () => {
  2626. const descriptor = {
  2627. attributes: { one: '1', two: '2' },
  2628. priority: 7
  2629. };
  2630. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2631. expect( element.is( 'attributeElement' ) ).to.be.true;
  2632. expect( element.name ).to.equal( 'span' );
  2633. expect( element.priority ).to.equal( 7 );
  2634. for ( const key of Object.keys( descriptor.attributes ) ) {
  2635. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  2636. }
  2637. } );
  2638. it( 'should create element without priority', () => {
  2639. const descriptor = {
  2640. classes: 'foo-class',
  2641. attributes: { one: '1', two: '2' }
  2642. };
  2643. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2644. expect( element.is( 'attributeElement' ) ).to.be.true;
  2645. expect( element.name ).to.equal( 'span' );
  2646. expect( element.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  2647. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  2648. for ( const key of Object.keys( descriptor.attributes ) ) {
  2649. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  2650. }
  2651. } );
  2652. it( 'should create element without attributes', () => {
  2653. const descriptor = {
  2654. classes: 'foo-class',
  2655. priority: 7
  2656. };
  2657. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2658. expect( element.is( 'attributeElement' ) ).to.be.true;
  2659. expect( element.name ).to.equal( 'span' );
  2660. expect( element.priority ).to.equal( 7 );
  2661. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  2662. } );
  2663. } );
  2664. } );
  2665. describe( 'downcast selection converters', () => {
  2666. let dispatcher, mapper, model, view, modelDoc, modelRoot, docSelection, viewDoc, viewRoot, viewSelection, downcastHelpers;
  2667. beforeEach( () => {
  2668. model = new Model();
  2669. modelDoc = model.document;
  2670. modelRoot = modelDoc.createRoot();
  2671. docSelection = modelDoc.selection;
  2672. model.schema.extend( '$text', { allowIn: '$root' } );
  2673. view = new View( new StylesProcessor() );
  2674. viewDoc = view.document;
  2675. viewRoot = createViewRoot( viewDoc );
  2676. viewSelection = viewDoc.selection;
  2677. mapper = new Mapper();
  2678. mapper.bindElements( modelRoot, viewRoot );
  2679. dispatcher = new DowncastDispatcher( { mapper, viewSelection } );
  2680. dispatcher.on( 'insert:$text', insertText() );
  2681. downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  2682. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  2683. downcastHelpers.markerToHighlight( { model: 'marker', view: { classes: 'marker' }, converterPriority: 1 } );
  2684. // Default selection converters.
  2685. dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
  2686. dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  2687. dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  2688. } );
  2689. afterEach( () => {
  2690. view.destroy();
  2691. } );
  2692. describe( 'default converters', () => {
  2693. describe( 'range selection', () => {
  2694. it( 'in same container', () => {
  2695. testSelection(
  2696. [ 1, 4 ],
  2697. 'foobar',
  2698. 'f{oob}ar'
  2699. );
  2700. } );
  2701. it( 'in same container with unicode characters', () => {
  2702. testSelection(
  2703. [ 2, 6 ],
  2704. 'நிலைக்கு',
  2705. 'நி{லைக்}கு'
  2706. );
  2707. } );
  2708. it( 'in same container, over attribute', () => {
  2709. testSelection(
  2710. [ 1, 5 ],
  2711. 'fo<$text bold="true">ob</$text>ar',
  2712. 'f{o<strong>ob</strong>a}r'
  2713. );
  2714. } );
  2715. it( 'in same container, next to attribute', () => {
  2716. testSelection(
  2717. [ 1, 2 ],
  2718. 'fo<$text bold="true">ob</$text>ar',
  2719. 'f{o}<strong>ob</strong>ar'
  2720. );
  2721. } );
  2722. it( 'in same attribute', () => {
  2723. testSelection(
  2724. [ 2, 4 ],
  2725. 'f<$text bold="true">ooba</$text>r',
  2726. 'f<strong>o{ob}a</strong>r'
  2727. );
  2728. } );
  2729. it( 'in same attribute, selection same as attribute', () => {
  2730. testSelection(
  2731. [ 2, 4 ],
  2732. 'fo<$text bold="true">ob</$text>ar',
  2733. 'fo{<strong>ob</strong>}ar'
  2734. );
  2735. } );
  2736. it( 'starts in text node, ends in attribute #1', () => {
  2737. testSelection(
  2738. [ 1, 3 ],
  2739. 'fo<$text bold="true">ob</$text>ar',
  2740. 'f{o<strong>o}b</strong>ar'
  2741. );
  2742. } );
  2743. it( 'starts in text node, ends in attribute #2', () => {
  2744. testSelection(
  2745. [ 1, 4 ],
  2746. 'fo<$text bold="true">ob</$text>ar',
  2747. 'f{o<strong>ob</strong>}ar'
  2748. );
  2749. } );
  2750. it( 'starts in attribute, ends in text node', () => {
  2751. testSelection(
  2752. [ 3, 5 ],
  2753. 'fo<$text bold="true">ob</$text>ar',
  2754. 'fo<strong>o{b</strong>a}r'
  2755. );
  2756. } );
  2757. it( 'consumes consumable values properly', () => {
  2758. // Add callback that will fire before default ones.
  2759. // This should prevent default callback doing anything.
  2760. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  2761. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  2762. }, { priority: 'high' } );
  2763. // Similar test case as the first in this suite.
  2764. testSelection(
  2765. [ 1, 4 ],
  2766. 'foobar',
  2767. 'foobar' // No selection in view.
  2768. );
  2769. } );
  2770. it( 'should convert backward selection', () => {
  2771. testSelection(
  2772. [ 1, 3, 'backward' ],
  2773. 'foobar',
  2774. 'f{oo}bar'
  2775. );
  2776. expect( viewSelection.focus.offset ).to.equal( 1 );
  2777. } );
  2778. } );
  2779. describe( 'collapsed selection', () => {
  2780. let marker, viewDocument;
  2781. beforeEach( () => {
  2782. viewDocument = new ViewDocument( new StylesProcessor() );
  2783. } );
  2784. it( 'in container', () => {
  2785. testSelection(
  2786. [ 1, 1 ],
  2787. 'foobar',
  2788. 'f{}oobar'
  2789. );
  2790. } );
  2791. it( 'in attribute', () => {
  2792. testSelection(
  2793. [ 3, 3 ],
  2794. 'f<$text bold="true">ooba</$text>r',
  2795. 'f<strong>oo{}ba</strong>r'
  2796. );
  2797. } );
  2798. it( 'in attribute and marker', () => {
  2799. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  2800. model.change( writer => {
  2801. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2802. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  2803. writer.setSelection( modelRoot, 3 );
  2804. } );
  2805. // Remove view children manually (without firing additional conversion).
  2806. viewRoot._removeChildren( 0, viewRoot.childCount );
  2807. // Convert model to view.
  2808. view.change( writer => {
  2809. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2810. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2811. dispatcher.convertSelection( docSelection, model.markers, writer );
  2812. } );
  2813. // Stringify view and check if it is same as expected.
  2814. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  2815. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  2816. );
  2817. } );
  2818. it( 'in attribute and marker - no attribute', () => {
  2819. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  2820. model.change( writer => {
  2821. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2822. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  2823. writer.setSelection( modelRoot, 3 );
  2824. writer.removeSelectionAttribute( 'bold' );
  2825. } );
  2826. // Remove view children manually (without firing additional conversion).
  2827. viewRoot._removeChildren( 0, viewRoot.childCount );
  2828. // Convert model to view.
  2829. view.change( writer => {
  2830. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2831. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2832. dispatcher.convertSelection( docSelection, model.markers, writer );
  2833. } );
  2834. // Stringify view and check if it is same as expected.
  2835. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2836. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  2837. } );
  2838. it( 'in marker - using highlight descriptor creator', () => {
  2839. downcastHelpers.markerToHighlight( {
  2840. model: 'marker2',
  2841. view: data => ( { classes: data.markerName } )
  2842. } );
  2843. setModelData( model, 'foobar' );
  2844. model.change( writer => {
  2845. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2846. marker = writer.addMarker( 'marker2', { range, usingOperation: false } );
  2847. writer.setSelection( modelRoot, 3 );
  2848. } );
  2849. // Remove view children manually (without firing additional conversion).
  2850. viewRoot._removeChildren( 0, viewRoot.childCount );
  2851. // Convert model to view.
  2852. view.change( writer => {
  2853. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2854. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2855. dispatcher.convertSelection( docSelection, model.markers, writer );
  2856. } );
  2857. // Stringify view and check if it is same as expected.
  2858. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2859. .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
  2860. } );
  2861. it( 'should do nothing if creator return null', () => {
  2862. downcastHelpers.markerToHighlight( {
  2863. model: 'marker3',
  2864. view: () => null
  2865. } );
  2866. setModelData( model, 'foobar' );
  2867. model.change( writer => {
  2868. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2869. marker = writer.addMarker( 'marker3', { range, usingOperation: false } );
  2870. writer.setSelection( modelRoot, 3 );
  2871. } );
  2872. // Remove view children manually (without firing additional conversion).
  2873. viewRoot._removeChildren( 0, viewRoot.childCount );
  2874. // Convert model to view.
  2875. view.change( writer => {
  2876. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2877. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2878. dispatcher.convertSelection( docSelection, model.markers, writer );
  2879. } );
  2880. // Stringify view and check if it is same as expected.
  2881. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2882. .to.equal( '<div>foo{}bar</div>' );
  2883. } );
  2884. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  2885. it( 'selection with attribute before ui element - no non-ui children', () => {
  2886. setModelData( model, '' );
  2887. // Add two ui elements to view.
  2888. viewRoot._appendChild( [
  2889. new ViewUIElement( viewDocument, 'span' ),
  2890. new ViewUIElement( viewDocument, 'span' )
  2891. ] );
  2892. model.change( writer => {
  2893. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 0 ] ) ) );
  2894. writer.setSelectionAttribute( 'bold', true );
  2895. } );
  2896. // Convert model to view.
  2897. view.change( writer => {
  2898. dispatcher.convertSelection( docSelection, model.markers, writer );
  2899. } );
  2900. // Stringify view and check if it is same as expected.
  2901. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2902. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  2903. } );
  2904. // #1072.
  2905. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  2906. setModelData( model, 'x' );
  2907. model.change( writer => {
  2908. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  2909. writer.setSelectionAttribute( 'bold', true );
  2910. } );
  2911. // Convert model to view.
  2912. view.change( writer => {
  2913. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2914. // Add ui element to view.
  2915. const uiElement = new ViewUIElement( viewDocument, 'span' );
  2916. viewRoot._insertChild( 1, uiElement );
  2917. dispatcher.convertSelection( docSelection, model.markers, writer );
  2918. } );
  2919. // Stringify view and check if it is same as expected.
  2920. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2921. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  2922. } );
  2923. // #1072.
  2924. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  2925. setModelData( model, '<$text bold="true">x</$text>y' );
  2926. model.change( writer => {
  2927. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  2928. writer.setSelectionAttribute( 'bold', true );
  2929. } );
  2930. // Convert model to view.
  2931. view.change( writer => {
  2932. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2933. // Add ui element to view.
  2934. const uiElement = new ViewUIElement( viewDocument, 'span' );
  2935. viewRoot._insertChild( 1, uiElement, writer );
  2936. dispatcher.convertSelection( docSelection, model.markers, writer );
  2937. } );
  2938. // Stringify view and check if it is same as expected.
  2939. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2940. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  2941. } );
  2942. it( 'consumes consumable values properly', () => {
  2943. // Add callbacks that will fire before default ones.
  2944. // This should prevent default callbacks doing anything.
  2945. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  2946. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  2947. }, { priority: 'high' } );
  2948. dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => {
  2949. expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
  2950. }, { priority: 'high' } );
  2951. // Similar test case as above.
  2952. testSelection(
  2953. [ 3, 3 ],
  2954. 'f<$text bold="true">ooba</$text>r',
  2955. 'foobar' // No selection in view and no attribute.
  2956. );
  2957. } );
  2958. } );
  2959. } );
  2960. describe( 'clean-up', () => {
  2961. describe( 'convertRangeSelection', () => {
  2962. it( 'should remove all ranges before adding new range', () => {
  2963. testSelection(
  2964. [ 0, 2 ],
  2965. 'foobar',
  2966. '{fo}obar'
  2967. );
  2968. testSelection(
  2969. [ 3, 5 ],
  2970. 'foobar',
  2971. 'foo{ba}r'
  2972. );
  2973. expect( viewSelection.rangeCount ).to.equal( 1 );
  2974. } );
  2975. } );
  2976. describe( 'convertCollapsedSelection', () => {
  2977. it( 'should remove all ranges before adding new range', () => {
  2978. testSelection(
  2979. [ 2, 2 ],
  2980. 'foobar',
  2981. 'fo{}obar'
  2982. );
  2983. testSelection(
  2984. [ 3, 3 ],
  2985. 'foobar',
  2986. 'foo{}bar'
  2987. );
  2988. expect( viewSelection.rangeCount ).to.equal( 1 );
  2989. } );
  2990. } );
  2991. describe( 'clearAttributes', () => {
  2992. it( 'should remove all ranges before adding new range', () => {
  2993. testSelection(
  2994. [ 3, 3 ],
  2995. 'foobar',
  2996. 'foo<strong>[]</strong>bar',
  2997. { bold: 'true' }
  2998. );
  2999. view.change( writer => {
  3000. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  3001. model.change( writer => {
  3002. writer.setSelection( modelRange );
  3003. } );
  3004. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  3005. } );
  3006. expect( viewSelection.rangeCount ).to.equal( 1 );
  3007. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  3008. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  3009. } );
  3010. it( 'should do nothing if the attribute element had been already removed', () => {
  3011. testSelection(
  3012. [ 3, 3 ],
  3013. 'foobar',
  3014. 'foo<strong>[]</strong>bar',
  3015. { bold: 'true' }
  3016. );
  3017. view.change( writer => {
  3018. // Remove <strong></strong> manually.
  3019. writer.mergeAttributes( viewSelection.getFirstPosition() );
  3020. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  3021. model.change( writer => {
  3022. writer.setSelection( modelRange );
  3023. } );
  3024. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  3025. } );
  3026. expect( viewSelection.rangeCount ).to.equal( 1 );
  3027. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  3028. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  3029. } );
  3030. it( 'should clear fake selection', () => {
  3031. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  3032. view.change( writer => {
  3033. writer.setSelection( modelRange, { fake: true } );
  3034. dispatcher.convertSelection( docSelection, model.markers, writer );
  3035. } );
  3036. expect( viewSelection.isFake ).to.be.false;
  3037. } );
  3038. } );
  3039. } );
  3040. describe( 'table cell selection converter', () => {
  3041. beforeEach( () => {
  3042. model.schema.register( 'table', { isLimit: true } );
  3043. model.schema.register( 'tr', { isLimit: true } );
  3044. model.schema.register( 'td', { isLimit: true } );
  3045. model.schema.extend( 'table', { allowIn: '$root' } );
  3046. model.schema.extend( 'tr', { allowIn: 'table' } );
  3047. model.schema.extend( 'td', { allowIn: 'tr' } );
  3048. model.schema.extend( '$text', { allowIn: 'td' } );
  3049. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  3050. // "Universal" converter to convert table structure.
  3051. downcastHelpers.elementToElement( { model: 'table', view: 'table' } );
  3052. downcastHelpers.elementToElement( { model: 'tr', view: 'tr' } );
  3053. downcastHelpers.elementToElement( { model: 'td', view: 'td' } );
  3054. // Special converter for table cells.
  3055. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  3056. const selection = data.selection;
  3057. if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  3058. return;
  3059. }
  3060. for ( const range of selection.getRanges() ) {
  3061. const node = range.start.parent;
  3062. if ( !!node && node.is( 'element', 'td' ) ) {
  3063. conversionApi.consumable.consume( selection, 'selection' );
  3064. const viewNode = conversionApi.mapper.toViewElement( node );
  3065. conversionApi.writer.addClass( 'selected', viewNode );
  3066. }
  3067. }
  3068. }, { priority: 'high' } );
  3069. } );
  3070. it( 'should not be used to convert selection that is not on table cell', () => {
  3071. testSelection(
  3072. [ 1, 5 ],
  3073. 'f{o<$text bold="true">ob</$text>a}r',
  3074. 'f{o<strong>ob</strong>a}r'
  3075. );
  3076. } );
  3077. it( 'should add a class to the selected table cell', () => {
  3078. testSelection(
  3079. // table tr#0 td#0 [foo, table tr#0 td#0 bar]
  3080. [ [ 0, 0, 0, 0 ], [ 0, 0, 0, 3 ] ],
  3081. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  3082. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  3083. );
  3084. } );
  3085. it( 'should not be used if selection contains more than just a table cell', () => {
  3086. testSelection(
  3087. // table tr td#1 f{oo bar, table tr#2 bar]
  3088. [ [ 0, 0, 0, 1 ], [ 0, 0, 1, 3 ] ],
  3089. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  3090. '[<table><tr><td>foo</td><td>bar</td></tr></table>]'
  3091. );
  3092. } );
  3093. } );
  3094. // Tests if the selection got correctly converted.
  3095. // Because `setData` might use selection converters itself to set the selection, we can't use it
  3096. // to set the selection (because then we would test converters using converters).
  3097. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  3098. // that are offsets or paths of selection positions in root element.
  3099. function testSelection( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  3100. // Parse passed `modelInput` string and set it as current model.
  3101. setModelData( model, modelInput );
  3102. // Manually set selection ranges using passed `selectionPaths`.
  3103. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  3104. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  3105. const startPos = model.createPositionFromPath( modelRoot, startPath );
  3106. const endPos = model.createPositionFromPath( modelRoot, endPath );
  3107. const isBackward = selectionPaths[ 2 ] === 'backward';
  3108. model.change( writer => {
  3109. writer.setSelection( writer.createRange( startPos, endPos ), { backward: isBackward } );
  3110. // And add or remove passed attributes.
  3111. for ( const key in selectionAttributes ) {
  3112. const value = selectionAttributes[ key ];
  3113. if ( value ) {
  3114. writer.setSelectionAttribute( key, value );
  3115. } else {
  3116. writer.removeSelectionAttribute( key );
  3117. }
  3118. }
  3119. } );
  3120. // Remove view children manually (without firing additional conversion).
  3121. viewRoot._removeChildren( 0, viewRoot.childCount );
  3122. // Convert model to view.
  3123. view.change( writer => {
  3124. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  3125. dispatcher.convertSelection( docSelection, model.markers, writer );
  3126. } );
  3127. // Stringify view and check if it is same as expected.
  3128. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  3129. }
  3130. } );
  3131. function viewToString( item ) {
  3132. let result = '';
  3133. if ( item instanceof ViewText ) {
  3134. result = item.data;
  3135. } else {
  3136. // ViewElement or ViewDocumentFragment.
  3137. for ( const child of item.getChildren() ) {
  3138. result += viewToString( child );
  3139. }
  3140. if ( item instanceof ViewElement ) {
  3141. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  3142. }
  3143. }
  3144. return result;
  3145. }
  3146. function viewAttributesToString( item ) {
  3147. let result = '';
  3148. for ( const key of item.getAttributeKeys() ) {
  3149. const value = item.getAttribute( key );
  3150. if ( value ) {
  3151. result += ' ' + key + '="' + value + '"';
  3152. }
  3153. }
  3154. return result;
  3155. }