model-selection-to-view-converters.js 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Model from '../../src/model/model';
  6. import ModelElement from '../../src/model/element';
  7. import ModelRange from '../../src/model/range';
  8. import ModelPosition from '../../src/model/position';
  9. import View from '../../src/view/view';
  10. import ViewContainerElement from '../../src/view/containerelement';
  11. import ViewAttributeElement from '../../src/view/attributeelement';
  12. import ViewUIElement from '../../src/view/uielement';
  13. import Mapper from '../../src/conversion/mapper';
  14. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  15. import {
  16. convertRangeSelection,
  17. convertCollapsedSelection,
  18. convertSelectionAttribute,
  19. convertSelectionMarker,
  20. clearAttributes,
  21. clearFakeSelection
  22. } from '../../src/conversion/model-selection-to-view-converters';
  23. import {
  24. insertElement,
  25. insertText,
  26. wrap,
  27. highlightElement,
  28. highlightText,
  29. removeHighlight
  30. } from '../../src/conversion/model-to-view-converters';
  31. import createViewRoot from '../view/_utils/createroot';
  32. import { stringify as stringifyView } from '../../src/dev-utils/view';
  33. import { setData as setModelData } from '../../src/dev-utils/model';
  34. describe( 'model-selection-to-view-converters', () => {
  35. let dispatcher, mapper, model, view, modelDoc, modelRoot, modelSelection, viewDoc, viewRoot, viewSelection, highlightDescriptor;
  36. beforeEach( () => {
  37. model = new Model();
  38. modelDoc = model.document;
  39. modelRoot = modelDoc.createRoot();
  40. modelSelection = modelDoc.selection;
  41. model.schema.extend( '$text', { allowIn: '$root' } );
  42. view = new View();
  43. viewDoc = view.document;
  44. viewRoot = createViewRoot( viewDoc );
  45. viewSelection = viewDoc.selection;
  46. mapper = new Mapper();
  47. mapper.bindElements( modelRoot, viewRoot );
  48. highlightDescriptor = { class: 'marker', priority: 1 };
  49. dispatcher = new ModelConversionDispatcher( model, { mapper, viewSelection } );
  50. dispatcher.on( 'insert:$text', insertText() );
  51. dispatcher.on( 'attribute:bold', wrap( new ViewAttributeElement( 'strong' ) ) );
  52. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  53. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  54. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  55. // Default selection converters.
  56. dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
  57. dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  58. dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  59. } );
  60. afterEach( () => {
  61. view.destroy();
  62. } );
  63. describe( 'default converters', () => {
  64. beforeEach( () => {
  65. // Selection converters for selection attributes.
  66. dispatcher.on( 'selectionAttribute:bold', convertSelectionAttribute( new ViewAttributeElement( 'strong' ) ) );
  67. dispatcher.on( 'selectionAttribute:italic', convertSelectionAttribute( new ViewAttributeElement( 'em' ) ) );
  68. dispatcher.on( 'selectionMarker:marker', convertSelectionMarker( highlightDescriptor ) );
  69. } );
  70. describe( 'range selection', () => {
  71. it( 'in same container', () => {
  72. test(
  73. [ 1, 4 ],
  74. 'foobar',
  75. 'f{oob}ar'
  76. );
  77. } );
  78. it( 'in same container with unicode characters', () => {
  79. test(
  80. [ 2, 6 ],
  81. 'நிலைக்கு',
  82. 'நி{லைக்}கு'
  83. );
  84. } );
  85. it( 'in same container, over attribute', () => {
  86. test(
  87. [ 1, 5 ],
  88. 'fo<$text bold="true">ob</$text>ar',
  89. 'f{o<strong>ob</strong>a}r'
  90. );
  91. } );
  92. it( 'in same container, next to attribute', () => {
  93. test(
  94. [ 1, 2 ],
  95. 'fo<$text bold="true">ob</$text>ar',
  96. 'f{o}<strong>ob</strong>ar'
  97. );
  98. } );
  99. it( 'in same attribute', () => {
  100. test(
  101. [ 2, 4 ],
  102. 'f<$text bold="true">ooba</$text>r',
  103. 'f<strong>o{ob}a</strong>r'
  104. );
  105. } );
  106. it( 'in same attribute, selection same as attribute', () => {
  107. test(
  108. [ 2, 4 ],
  109. 'fo<$text bold="true">ob</$text>ar',
  110. 'fo{<strong>ob</strong>}ar'
  111. );
  112. } );
  113. it( 'starts in text node, ends in attribute #1', () => {
  114. test(
  115. [ 1, 3 ],
  116. 'fo<$text bold="true">ob</$text>ar',
  117. 'f{o<strong>o}b</strong>ar'
  118. );
  119. } );
  120. it( 'starts in text node, ends in attribute #2', () => {
  121. test(
  122. [ 1, 4 ],
  123. 'fo<$text bold="true">ob</$text>ar',
  124. 'f{o<strong>ob</strong>}ar'
  125. );
  126. } );
  127. it( 'starts in attribute, ends in text node', () => {
  128. test(
  129. [ 3, 5 ],
  130. 'fo<$text bold="true">ob</$text>ar',
  131. 'fo<strong>o{b</strong>a}r'
  132. );
  133. } );
  134. it( 'consumes consumable values properly', () => {
  135. // Add callback that will fire before default ones.
  136. // This should prevent default callback doing anything.
  137. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  138. expect( consumable.consume( data.selection, 'selection' ) ).to.be.true;
  139. }, { priority: 'high' } );
  140. // Similar test case as the first in this suite.
  141. test(
  142. [ 1, 4 ],
  143. 'foobar',
  144. 'foobar' // No selection in view.
  145. );
  146. } );
  147. it( 'should convert backward selection', () => {
  148. test(
  149. [ 1, 3, 'backward' ],
  150. 'foobar',
  151. 'f{oo}bar'
  152. );
  153. expect( viewSelection.focus.offset ).to.equal( 1 );
  154. } );
  155. } );
  156. describe( 'collapsed selection', () => {
  157. it( 'in container', () => {
  158. test(
  159. [ 1, 1 ],
  160. 'foobar',
  161. 'f{}oobar'
  162. );
  163. } );
  164. it( 'in attribute', () => {
  165. test(
  166. [ 3, 3 ],
  167. 'f<$text bold="true">ooba</$text>r',
  168. 'f<strong>oo{}ba</strong>r'
  169. );
  170. } );
  171. it( 'in container with extra attributes', () => {
  172. test(
  173. [ 1, 1 ],
  174. 'foobar',
  175. 'f<em>[]</em>oobar',
  176. { italic: true }
  177. );
  178. } );
  179. it( 'in attribute with extra attributes', () => {
  180. test(
  181. [ 3, 3 ],
  182. 'f<$text bold="true">ooba</$text>r',
  183. 'f<strong>oo</strong><em><strong>[]</strong></em><strong>ba</strong>r',
  184. { italic: true }
  185. );
  186. } );
  187. it( 'in attribute and marker', () => {
  188. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  189. const marker = model.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  190. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  191. // Update selection attributes according to model.
  192. modelSelection.refreshAttributes();
  193. // Remove view children manually (without firing additional conversion).
  194. viewRoot.removeChildren( 0, viewRoot.childCount );
  195. // Convert model to view.
  196. view.change( writer => {
  197. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  198. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  199. dispatcher.convertSelection( modelSelection, writer );
  200. } );
  201. // Stringify view and check if it is same as expected.
  202. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  203. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  204. );
  205. } );
  206. it( 'in attribute and marker - no attribute', () => {
  207. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  208. const marker = model.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  209. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  210. // Update selection attributes according to model.
  211. modelSelection.refreshAttributes();
  212. modelSelection.removeAttribute( 'bold' );
  213. // Remove view children manually (without firing additional conversion).
  214. viewRoot.removeChildren( 0, viewRoot.childCount );
  215. // Convert model to view.
  216. view.change( writer => {
  217. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  218. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  219. dispatcher.convertSelection( modelSelection, writer );
  220. } );
  221. // Stringify view and check if it is same as expected.
  222. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  223. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  224. } );
  225. it( 'in marker - using highlight descriptor creator', () => {
  226. dispatcher.on( 'selectionMarker:marker2', convertSelectionMarker(
  227. data => ( { 'class': data.markerName } )
  228. ) );
  229. setModelData( model, 'foobar' );
  230. const marker = model.markers.set( 'marker2', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  231. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  232. // Remove view children manually (without firing additional conversion).
  233. viewRoot.removeChildren( 0, viewRoot.childCount );
  234. // Convert model to view.
  235. view.change( writer => {
  236. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  237. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  238. dispatcher.convertSelection( modelSelection, writer );
  239. } );
  240. // Stringify view and check if it is same as expected.
  241. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  242. .to.equal( '<div>foo<span class="marker2">[]</span>bar</div>' );
  243. } );
  244. it( 'in marker - should merge with the rest of attribute elements', () => {
  245. dispatcher.on( 'addMarker:marker2', highlightText( data => ( { 'class': data.markerName } ) ) );
  246. dispatcher.on( 'addMarker:marker2', highlightElement( data => ( { 'class': data.markerName } ) ) );
  247. dispatcher.on( 'selectionMarker:marker2', convertSelectionMarker( data => ( { 'class': data.markerName } ) ) );
  248. setModelData( model, 'foobar' );
  249. const marker = model.markers.set( 'marker2', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  250. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  251. // Remove view children manually (without firing additional conversion).
  252. viewRoot.removeChildren( 0, viewRoot.childCount );
  253. // Convert model to view.
  254. view.change( writer => {
  255. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  256. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  257. dispatcher.convertSelection( modelSelection, writer );
  258. } );
  259. // Stringify view and check if it is same as expected.
  260. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  261. .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
  262. } );
  263. it( 'should do nothing if creator return null', () => {
  264. dispatcher.on( 'selectionMarker:marker3', convertSelectionMarker( () => {
  265. } ) );
  266. setModelData( model, 'foobar' );
  267. const marker = model.markers.set( 'marker3', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  268. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  269. // Remove view children manually (without firing additional conversion).
  270. viewRoot.removeChildren( 0, viewRoot.childCount );
  271. // Convert model to view.
  272. view.change( writer => {
  273. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  274. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  275. dispatcher.convertSelection( modelSelection, writer );
  276. } );
  277. // Stringify view and check if it is same as expected.
  278. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  279. .to.equal( '<div>foo{}bar</div>' );
  280. } );
  281. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  282. it( 'selection with attribute before ui element - no non-ui children', () => {
  283. setModelData( model, '' );
  284. // Add two ui elements to view.
  285. viewRoot.appendChildren( [
  286. new ViewUIElement( 'span' ),
  287. new ViewUIElement( 'span' )
  288. ] );
  289. modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 0 ] ) ) ] );
  290. modelSelection.setAttribute( 'bold', true );
  291. // Convert model to view.
  292. view.change( writer => {
  293. dispatcher.convertSelection( modelSelection, writer );
  294. } );
  295. // Stringify view and check if it is same as expected.
  296. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  297. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  298. } );
  299. // #1072.
  300. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  301. setModelData( model, 'x' );
  302. modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) ] );
  303. modelSelection.setAttribute( 'bold', true );
  304. // Convert model to view.
  305. view.change( writer => {
  306. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  307. // Add ui element to view.
  308. const uiElement = new ViewUIElement( 'span' );
  309. viewRoot.insertChildren( 1, uiElement );
  310. dispatcher.convertSelection( modelSelection, writer );
  311. } );
  312. // Stringify view and check if it is same as expected.
  313. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  314. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  315. } );
  316. // #1072.
  317. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  318. setModelData( model, '<$text bold="true">x</$text>y' );
  319. modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) ] );
  320. modelSelection.setAttribute( 'bold', true );
  321. // Convert model to view.
  322. view.change( writer => {
  323. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  324. // Add ui element to view.
  325. const uiElement = new ViewUIElement( 'span' );
  326. viewRoot.insertChildren( 1, uiElement, writer );
  327. dispatcher.convertSelection( modelSelection, writer );
  328. } );
  329. // Stringify view and check if it is same as expected.
  330. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  331. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  332. } );
  333. it( 'consumes consumable values properly', () => {
  334. // Add callbacks that will fire before default ones.
  335. // This should prevent default callbacks doing anything.
  336. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  337. expect( consumable.consume( data.selection, 'selection' ) ).to.be.true;
  338. }, { priority: 'high' } );
  339. dispatcher.on( 'selectionAttribute:bold', ( evt, data, consumable ) => {
  340. expect( consumable.consume( data.selection, 'selectionAttribute:bold' ) ).to.be.true;
  341. }, { priority: 'high' } );
  342. // Similar test case as above.
  343. test(
  344. [ 3, 3 ],
  345. 'f<$text bold="true">ooba</$text>r',
  346. 'f<strong>ooba</strong>r' // No selection in view.
  347. );
  348. } );
  349. } );
  350. } );
  351. describe( 'clean-up', () => {
  352. describe( 'convertRangeSelection', () => {
  353. it( 'should remove all ranges before adding new range', () => {
  354. test(
  355. [ 0, 2 ],
  356. 'foobar',
  357. '{fo}obar'
  358. );
  359. test(
  360. [ 3, 5 ],
  361. 'foobar',
  362. 'foo{ba}r'
  363. );
  364. expect( viewSelection.rangeCount ).to.equal( 1 );
  365. } );
  366. } );
  367. describe( 'convertCollapsedSelection', () => {
  368. it( 'should remove all ranges before adding new range', () => {
  369. test(
  370. [ 2, 2 ],
  371. 'foobar',
  372. 'fo{}obar'
  373. );
  374. test(
  375. [ 3, 3 ],
  376. 'foobar',
  377. 'foo{}bar'
  378. );
  379. expect( viewSelection.rangeCount ).to.equal( 1 );
  380. } );
  381. } );
  382. describe( 'clearAttributes', () => {
  383. it( 'should remove all ranges before adding new range', () => {
  384. dispatcher.on( 'selectionAttribute:bold', convertSelectionAttribute( new ViewAttributeElement( 'b' ) ) );
  385. dispatcher.on( 'attribute:style', wrap( new ViewAttributeElement( 'b' ) ) );
  386. test(
  387. [ 3, 3 ],
  388. 'foobar',
  389. 'foo<b>[]</b>bar',
  390. { bold: 'true' }
  391. );
  392. view.change( writer => {
  393. const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 );
  394. modelDoc.selection.setRanges( [ modelRange ] );
  395. dispatcher.convertSelection( modelDoc.selection, writer );
  396. } );
  397. expect( viewSelection.rangeCount ).to.equal( 1 );
  398. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  399. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  400. } );
  401. it( 'should do nothing if the attribute element had been already removed', () => {
  402. dispatcher.on( 'selectionAttribute:bold', convertSelectionAttribute( new ViewAttributeElement( 'b' ) ) );
  403. dispatcher.on( 'attribute:style', wrap( new ViewAttributeElement( 'b' ) ) );
  404. test(
  405. [ 3, 3 ],
  406. 'foobar',
  407. 'foo<b>[]</b>bar',
  408. { bold: 'true' }
  409. );
  410. view.change( writer => {
  411. // Remove <b></b> manually.
  412. writer.mergeAttributes( viewSelection.getFirstPosition() );
  413. const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 );
  414. modelDoc.selection.setRanges( [ modelRange ] );
  415. dispatcher.convertSelection( modelDoc.selection, writer );
  416. } );
  417. expect( viewSelection.rangeCount ).to.equal( 1 );
  418. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  419. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  420. } );
  421. } );
  422. describe( 'clearFakeSelection', () => {
  423. it( 'should clear fake selection', () => {
  424. dispatcher.on( 'selection', clearFakeSelection() );
  425. view.change( writer => {
  426. viewSelection.setFake( true );
  427. dispatcher.convertSelection( modelSelection, writer );
  428. } );
  429. expect( viewSelection.isFake ).to.be.false;
  430. } );
  431. } );
  432. } );
  433. describe( 'using element creator for attributes conversion', () => {
  434. beforeEach( () => {
  435. function themeElementCreator( themeValue ) {
  436. if ( themeValue == 'important' ) {
  437. return new ViewAttributeElement( 'strong', { style: 'text-transform:uppercase' } );
  438. } else if ( themeValue == 'gold' ) {
  439. return new ViewAttributeElement( 'span', { style: 'color:yellow' } );
  440. }
  441. }
  442. dispatcher.on( 'selectionAttribute:theme', convertSelectionAttribute( themeElementCreator ) );
  443. dispatcher.on( 'attribute:theme', wrap( themeElementCreator ) );
  444. dispatcher.on( 'selectionAttribute:italic', convertSelectionAttribute( new ViewAttributeElement( 'em' ) ) );
  445. } );
  446. describe( 'range selection', () => {
  447. it( 'in same container, over attribute', () => {
  448. test(
  449. [ 1, 5 ],
  450. 'fo<$text theme="gold">ob</$text>ar',
  451. 'f{o<span style="color:yellow">ob</span>a}r'
  452. );
  453. } );
  454. it( 'in same attribute', () => {
  455. test(
  456. [ 2, 4 ],
  457. 'f<$text theme="gold">ooba</$text>r',
  458. 'f<span style="color:yellow">o{ob}a</span>r'
  459. );
  460. } );
  461. it( 'in same attribute, selection same as attribute', () => {
  462. test(
  463. [ 2, 4 ],
  464. 'fo<$text theme="important">ob</$text>ar',
  465. 'fo{<strong style="text-transform:uppercase">ob</strong>}ar'
  466. );
  467. } );
  468. it( 'starts in attribute, ends in text node', () => {
  469. test(
  470. [ 3, 5 ],
  471. 'fo<$text theme="important">ob</$text>ar',
  472. 'fo<strong style="text-transform:uppercase">o{b</strong>a}r'
  473. );
  474. } );
  475. } );
  476. describe( 'collapsed selection', () => {
  477. it( 'in attribute', () => {
  478. test(
  479. [ 3, 3 ],
  480. 'f<$text theme="gold">ooba</$text>r',
  481. 'f<span style="color:yellow">oo{}ba</span>r'
  482. );
  483. } );
  484. it( 'in container with theme attribute', () => {
  485. test(
  486. [ 1, 1 ],
  487. 'foobar',
  488. 'f<strong style="text-transform:uppercase">[]</strong>oobar',
  489. { theme: 'important' }
  490. );
  491. } );
  492. it( 'in theme attribute with extra attributes #1', () => {
  493. test(
  494. [ 3, 3 ],
  495. 'f<$text theme="gold">ooba</$text>r',
  496. 'f<span style="color:yellow">oo</span>' +
  497. '<em><span style="color:yellow">[]</span></em>' +
  498. '<span style="color:yellow">ba</span>r',
  499. { italic: true }
  500. );
  501. } );
  502. it( 'in theme attribute with extra attributes #2', () => {
  503. // In contrary to test above, we don't have strong + span on the selection.
  504. // This is because strong and span are both created by the same attribute.
  505. // Since style="important" overwrites style="gold" on selection, we have only strong element.
  506. // In example above, selection has both style and italic attribute.
  507. test(
  508. [ 3, 3 ],
  509. 'f<$text theme="gold">ooba</$text>r',
  510. 'f<span style="color:yellow">oo</span>' +
  511. '<strong style="text-transform:uppercase">[]</strong>' +
  512. '<span style="color:yellow">ba</span>r',
  513. { theme: 'important' }
  514. );
  515. } );
  516. it( 'convertSelectionAttribute should do nothing if creator return null', () => {
  517. dispatcher.on( 'selectionAttribute:bold', convertSelectionAttribute( () => {
  518. } ) );
  519. test(
  520. [ 3, 3 ],
  521. 'foobar',
  522. 'foo{}bar',
  523. { bold: 'true' }
  524. );
  525. } );
  526. } );
  527. } );
  528. describe( 'table cell selection converter', () => {
  529. beforeEach( () => {
  530. model.schema.register( 'table' );
  531. model.schema.register( 'tr' );
  532. model.schema.register( 'td' );
  533. model.schema.extend( 'table', { allowIn: '$root' } );
  534. model.schema.extend( 'tr', { allowIn: 'table' } );
  535. model.schema.extend( 'td', { allowIn: 'tr' } );
  536. model.schema.extend( '$text', { allowIn: 'td' } );
  537. // "Universal" converter to convert table structure.
  538. const tableConverter = insertElement( data => new ViewContainerElement( data.item.name ) );
  539. dispatcher.on( 'insert:table', tableConverter );
  540. dispatcher.on( 'insert:tr', tableConverter );
  541. dispatcher.on( 'insert:td', tableConverter );
  542. // Special converter for table cells.
  543. dispatcher.on( 'selection', ( evt, data, consumable, conversionApi ) => {
  544. const selection = data.selection;
  545. if ( !consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  546. return;
  547. }
  548. for ( const range of selection.getRanges() ) {
  549. const node = range.start.nodeAfter;
  550. if ( node == range.end.nodeBefore && node instanceof ModelElement && node.name == 'td' ) {
  551. consumable.consume( selection, 'selection' );
  552. const viewNode = conversionApi.mapper.toViewElement( node );
  553. viewNode.addClass( 'selected' );
  554. }
  555. }
  556. } );
  557. } );
  558. it( 'should not be used to convert selection that is not on table cell', () => {
  559. test(
  560. [ 1, 5 ],
  561. 'f{o<$text bold="true">ob</$text>a}r',
  562. 'f{o<strong>ob</strong>a}r'
  563. );
  564. } );
  565. it( 'should add a class to the selected table cell', () => {
  566. test(
  567. // table tr#0 |td#0, table tr#0 td#0|
  568. [ [ 0, 0, 0 ], [ 0, 0, 1 ] ],
  569. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  570. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  571. );
  572. } );
  573. it( 'should not be used if selection contains more than just a table cell', () => {
  574. test(
  575. // table tr td#1, table tr#2
  576. [ [ 0, 0, 0, 1 ], [ 0, 0, 2 ] ],
  577. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  578. '<table><tr><td>f{oo</td><td>bar</td>]</tr></table>'
  579. );
  580. } );
  581. } );
  582. // Tests if the selection got correctly converted.
  583. // Because `setData` might use selection converters itself to set the selection, we can't use it
  584. // to set the selection (because then we would test converters using converters).
  585. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  586. // that are offsets or paths of selection positions in root element.
  587. function test( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  588. // Parse passed `modelInput` string and set it as current model.
  589. setModelData( model, modelInput );
  590. // Manually set selection ranges using passed `selectionPaths`.
  591. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  592. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  593. const startPos = new ModelPosition( modelRoot, startPath );
  594. const endPos = new ModelPosition( modelRoot, endPath );
  595. const isBackward = selectionPaths[ 2 ] === 'backward';
  596. modelSelection.setRanges( [ new ModelRange( startPos, endPos ) ], isBackward );
  597. // Update selection attributes according to model.
  598. modelSelection.refreshAttributes();
  599. // And add or remove passed attributes.
  600. for ( const key in selectionAttributes ) {
  601. const value = selectionAttributes[ key ];
  602. if ( value ) {
  603. modelSelection.setAttribute( key, value );
  604. } else {
  605. modelSelection.removeAttribute( key );
  606. }
  607. }
  608. // Remove view children manually (without firing additional conversion).
  609. viewRoot.removeChildren( 0, viewRoot.childCount );
  610. // Convert model to view.
  611. view.change( writer => {
  612. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  613. dispatcher.convertSelection( modelSelection, writer );
  614. } );
  615. // Stringify view and check if it is same as expected.
  616. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  617. }
  618. } );