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

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