downcasthelpers.js 90 KB

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