downcasthelpers.js 74 KB

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