8
0

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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590
  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. clearAttributes,
  19. clearFakeSelection
  20. } from '../../src/conversion/model-selection-to-view-converters';
  21. import {
  22. insertElement,
  23. insertText,
  24. wrap,
  25. highlightElement,
  26. highlightText,
  27. removeHighlight
  28. } from '../../src/conversion/model-to-view-converters';
  29. import createViewRoot from '../view/_utils/createroot';
  30. import { stringify as stringifyView } from '../../src/dev-utils/view';
  31. import { setData as setModelData } from '../../src/dev-utils/model';
  32. describe( 'model-selection-to-view-converters', () => {
  33. let dispatcher, mapper, model, view, modelDoc, modelRoot, modelSelection, viewDoc, viewRoot, viewSelection, highlightDescriptor;
  34. beforeEach( () => {
  35. model = new Model();
  36. modelDoc = model.document;
  37. modelRoot = modelDoc.createRoot();
  38. modelSelection = modelDoc.selection;
  39. model.schema.extend( '$text', { allowIn: '$root' } );
  40. view = new View();
  41. viewDoc = view.document;
  42. viewRoot = createViewRoot( viewDoc );
  43. viewSelection = viewDoc.selection;
  44. mapper = new Mapper();
  45. mapper.bindElements( modelRoot, viewRoot );
  46. highlightDescriptor = { class: 'marker', priority: 1 };
  47. dispatcher = new ModelConversionDispatcher( model, { mapper, viewSelection } );
  48. dispatcher.on( 'insert:$text', insertText() );
  49. dispatcher.on( 'attribute:bold', wrap( new ViewAttributeElement( 'strong' ) ) );
  50. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  51. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  52. dispatcher.on( 'removeMarker:marker', removeHighlight( 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. view.destroy();
  60. } );
  61. describe( 'default converters', () => {
  62. describe( 'range selection', () => {
  63. it( 'in same container', () => {
  64. test(
  65. [ 1, 4 ],
  66. 'foobar',
  67. 'f{oob}ar'
  68. );
  69. } );
  70. it( 'in same container with unicode characters', () => {
  71. test(
  72. [ 2, 6 ],
  73. 'நிலைக்கு',
  74. 'நி{லைக்}கு'
  75. );
  76. } );
  77. it( 'in same container, over attribute', () => {
  78. test(
  79. [ 1, 5 ],
  80. 'fo<$text bold="true">ob</$text>ar',
  81. 'f{o<strong>ob</strong>a}r'
  82. );
  83. } );
  84. it( 'in same container, next to attribute', () => {
  85. test(
  86. [ 1, 2 ],
  87. 'fo<$text bold="true">ob</$text>ar',
  88. 'f{o}<strong>ob</strong>ar'
  89. );
  90. } );
  91. it( 'in same attribute', () => {
  92. test(
  93. [ 2, 4 ],
  94. 'f<$text bold="true">ooba</$text>r',
  95. 'f<strong>o{ob}a</strong>r'
  96. );
  97. } );
  98. it( 'in same attribute, selection same as attribute', () => {
  99. test(
  100. [ 2, 4 ],
  101. 'fo<$text bold="true">ob</$text>ar',
  102. 'fo{<strong>ob</strong>}ar'
  103. );
  104. } );
  105. it( 'starts in text node, ends in attribute #1', () => {
  106. test(
  107. [ 1, 3 ],
  108. 'fo<$text bold="true">ob</$text>ar',
  109. 'f{o<strong>o}b</strong>ar'
  110. );
  111. } );
  112. it( 'starts in text node, ends in attribute #2', () => {
  113. test(
  114. [ 1, 4 ],
  115. 'fo<$text bold="true">ob</$text>ar',
  116. 'f{o<strong>ob</strong>}ar'
  117. );
  118. } );
  119. it( 'starts in attribute, ends in text node', () => {
  120. test(
  121. [ 3, 5 ],
  122. 'fo<$text bold="true">ob</$text>ar',
  123. 'fo<strong>o{b</strong>a}r'
  124. );
  125. } );
  126. it( 'consumes consumable values properly', () => {
  127. // Add callback that will fire before default ones.
  128. // This should prevent default callback doing anything.
  129. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  130. expect( consumable.consume( data.selection, 'selection' ) ).to.be.true;
  131. }, { priority: 'high' } );
  132. // Similar test case as the first in this suite.
  133. test(
  134. [ 1, 4 ],
  135. 'foobar',
  136. 'foobar' // No selection in view.
  137. );
  138. } );
  139. it( 'should convert backward selection', () => {
  140. test(
  141. [ 1, 3, 'backward' ],
  142. 'foobar',
  143. 'f{oo}bar'
  144. );
  145. expect( viewSelection.focus.offset ).to.equal( 1 );
  146. } );
  147. } );
  148. describe( 'collapsed selection', () => {
  149. it( 'in container', () => {
  150. test(
  151. [ 1, 1 ],
  152. 'foobar',
  153. 'f{}oobar'
  154. );
  155. } );
  156. it( 'in attribute', () => {
  157. test(
  158. [ 3, 3 ],
  159. 'f<$text bold="true">ooba</$text>r',
  160. 'f<strong>oo{}ba</strong>r'
  161. );
  162. } );
  163. it( 'in attribute and marker', () => {
  164. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  165. const marker = model.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  166. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  167. // Update selection attributes according to model.
  168. modelSelection.refreshAttributes();
  169. // Remove view children manually (without firing additional conversion).
  170. viewRoot.removeChildren( 0, viewRoot.childCount );
  171. // Convert model to view.
  172. view.change( writer => {
  173. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  174. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  175. dispatcher.convertSelection( modelSelection, writer );
  176. } );
  177. // Stringify view and check if it is same as expected.
  178. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  179. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  180. );
  181. } );
  182. it( 'in attribute and marker - no attribute', () => {
  183. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  184. const marker = model.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  185. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  186. // Update selection attributes according to model.
  187. modelSelection.refreshAttributes();
  188. modelSelection.removeAttribute( 'bold' );
  189. // Remove view children manually (without firing additional conversion).
  190. viewRoot.removeChildren( 0, viewRoot.childCount );
  191. // Convert model to view.
  192. view.change( writer => {
  193. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  194. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  195. dispatcher.convertSelection( modelSelection, writer );
  196. } );
  197. // Stringify view and check if it is same as expected.
  198. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  199. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  200. } );
  201. it( 'in marker - using highlight descriptor creator', () => {
  202. dispatcher.on( 'addMarker:marker2', highlightText(
  203. data => ( { 'class': data.markerName } )
  204. ) );
  205. setModelData( model, 'foobar' );
  206. const marker = model.markers.set( 'marker2', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  207. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  208. // Remove view children manually (without firing additional conversion).
  209. viewRoot.removeChildren( 0, viewRoot.childCount );
  210. // Convert model to view.
  211. view.change( writer => {
  212. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  213. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  214. dispatcher.convertSelection( modelSelection, writer );
  215. } );
  216. // Stringify view and check if it is same as expected.
  217. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  218. .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
  219. } );
  220. it( 'should do nothing if creator return null', () => {
  221. dispatcher.on( 'addMarker:marker3', highlightText( () => null ) );
  222. setModelData( model, 'foobar' );
  223. const marker = model.markers.set( 'marker3', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  224. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  225. // Remove view children manually (without firing additional conversion).
  226. viewRoot.removeChildren( 0, viewRoot.childCount );
  227. // Convert model to view.
  228. view.change( writer => {
  229. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  230. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  231. dispatcher.convertSelection( modelSelection, writer );
  232. } );
  233. // Stringify view and check if it is same as expected.
  234. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  235. .to.equal( '<div>foo{}bar</div>' );
  236. } );
  237. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  238. it( 'selection with attribute before ui element - no non-ui children', () => {
  239. setModelData( model, '' );
  240. // Add two ui elements to view.
  241. viewRoot.appendChildren( [
  242. new ViewUIElement( 'span' ),
  243. new ViewUIElement( 'span' )
  244. ] );
  245. modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 0 ] ) ) ] );
  246. modelSelection.setAttribute( 'bold', true );
  247. // Convert model to view.
  248. view.change( writer => {
  249. dispatcher.convertSelection( modelSelection, writer );
  250. } );
  251. // Stringify view and check if it is same as expected.
  252. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  253. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  254. } );
  255. // #1072.
  256. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  257. setModelData( model, 'x' );
  258. modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) ] );
  259. modelSelection.setAttribute( 'bold', true );
  260. // Convert model to view.
  261. view.change( writer => {
  262. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  263. // Add ui element to view.
  264. const uiElement = new ViewUIElement( 'span' );
  265. viewRoot.insertChildren( 1, uiElement );
  266. dispatcher.convertSelection( modelSelection, writer );
  267. } );
  268. // Stringify view and check if it is same as expected.
  269. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  270. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  271. } );
  272. // #1072.
  273. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  274. setModelData( model, '<$text bold="true">x</$text>y' );
  275. modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) ] );
  276. modelSelection.setAttribute( 'bold', true );
  277. // Convert model to view.
  278. view.change( writer => {
  279. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  280. // Add ui element to view.
  281. const uiElement = new ViewUIElement( 'span' );
  282. viewRoot.insertChildren( 1, uiElement, writer );
  283. dispatcher.convertSelection( modelSelection, writer );
  284. } );
  285. // Stringify view and check if it is same as expected.
  286. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  287. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  288. } );
  289. it( 'consumes consumable values properly', () => {
  290. // Add callbacks that will fire before default ones.
  291. // This should prevent default callbacks doing anything.
  292. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  293. expect( consumable.consume( data.selection, 'selection' ) ).to.be.true;
  294. }, { priority: 'high' } );
  295. dispatcher.on( 'attribute:bold', ( evt, data, consumable ) => {
  296. expect( consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
  297. }, { priority: 'high' } );
  298. // Similar test case as above.
  299. test(
  300. [ 3, 3 ],
  301. 'f<$text bold="true">ooba</$text>r',
  302. 'foobar' // No selection in view and no attribute.
  303. );
  304. } );
  305. } );
  306. } );
  307. describe( 'clean-up', () => {
  308. describe( 'convertRangeSelection', () => {
  309. it( 'should remove all ranges before adding new range', () => {
  310. test(
  311. [ 0, 2 ],
  312. 'foobar',
  313. '{fo}obar'
  314. );
  315. test(
  316. [ 3, 5 ],
  317. 'foobar',
  318. 'foo{ba}r'
  319. );
  320. expect( viewSelection.rangeCount ).to.equal( 1 );
  321. } );
  322. } );
  323. describe( 'convertCollapsedSelection', () => {
  324. it( 'should remove all ranges before adding new range', () => {
  325. test(
  326. [ 2, 2 ],
  327. 'foobar',
  328. 'fo{}obar'
  329. );
  330. test(
  331. [ 3, 3 ],
  332. 'foobar',
  333. 'foo{}bar'
  334. );
  335. expect( viewSelection.rangeCount ).to.equal( 1 );
  336. } );
  337. } );
  338. describe( 'clearAttributes', () => {
  339. it( 'should remove all ranges before adding new range', () => {
  340. test(
  341. [ 3, 3 ],
  342. 'foobar',
  343. 'foo<strong>[]</strong>bar',
  344. { bold: 'true' }
  345. );
  346. view.change( writer => {
  347. const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 );
  348. modelDoc.selection.setRanges( [ modelRange ] );
  349. dispatcher.convertSelection( modelDoc.selection, writer );
  350. } );
  351. expect( viewSelection.rangeCount ).to.equal( 1 );
  352. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  353. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  354. } );
  355. it( 'should do nothing if the attribute element had been already removed', () => {
  356. test(
  357. [ 3, 3 ],
  358. 'foobar',
  359. 'foo<strong>[]</strong>bar',
  360. { bold: 'true' }
  361. );
  362. view.change( writer => {
  363. // Remove <strong></strong> manually.
  364. writer.mergeAttributes( viewSelection.getFirstPosition() );
  365. const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 );
  366. modelDoc.selection.setRanges( [ modelRange ] );
  367. dispatcher.convertSelection( modelDoc.selection, writer );
  368. } );
  369. expect( viewSelection.rangeCount ).to.equal( 1 );
  370. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  371. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  372. } );
  373. } );
  374. describe( 'clearFakeSelection', () => {
  375. it( 'should clear fake selection', () => {
  376. dispatcher.on( 'selection', clearFakeSelection() );
  377. view.change( writer => {
  378. viewSelection.setFake( true );
  379. dispatcher.convertSelection( modelSelection, writer );
  380. } );
  381. expect( viewSelection.isFake ).to.be.false;
  382. } );
  383. } );
  384. } );
  385. describe( 'table cell selection converter', () => {
  386. beforeEach( () => {
  387. model.schema.register( 'table' );
  388. model.schema.register( 'tr' );
  389. model.schema.register( 'td' );
  390. model.schema.extend( 'table', { allowIn: '$root' } );
  391. model.schema.extend( 'tr', { allowIn: 'table' } );
  392. model.schema.extend( 'td', { allowIn: 'tr' } );
  393. model.schema.extend( '$text', { allowIn: 'td' } );
  394. // "Universal" converter to convert table structure.
  395. const tableConverter = insertElement( data => new ViewContainerElement( data.item.name ) );
  396. dispatcher.on( 'insert:table', tableConverter );
  397. dispatcher.on( 'insert:tr', tableConverter );
  398. dispatcher.on( 'insert:td', tableConverter );
  399. // Special converter for table cells.
  400. dispatcher.on( 'selection', ( evt, data, consumable, conversionApi ) => {
  401. const selection = data.selection;
  402. if ( !consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  403. return;
  404. }
  405. for ( const range of selection.getRanges() ) {
  406. const node = range.start.nodeAfter;
  407. if ( node == range.end.nodeBefore && node instanceof ModelElement && node.name == 'td' ) {
  408. consumable.consume( selection, 'selection' );
  409. const viewNode = conversionApi.mapper.toViewElement( node );
  410. viewNode.addClass( 'selected' );
  411. }
  412. }
  413. } );
  414. } );
  415. it( 'should not be used to convert selection that is not on table cell', () => {
  416. test(
  417. [ 1, 5 ],
  418. 'f{o<$text bold="true">ob</$text>a}r',
  419. 'f{o<strong>ob</strong>a}r'
  420. );
  421. } );
  422. it( 'should add a class to the selected table cell', () => {
  423. test(
  424. // table tr#0 |td#0, table tr#0 td#0|
  425. [ [ 0, 0, 0 ], [ 0, 0, 1 ] ],
  426. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  427. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  428. );
  429. } );
  430. it( 'should not be used if selection contains more than just a table cell', () => {
  431. test(
  432. // table tr td#1, table tr#2
  433. [ [ 0, 0, 0, 1 ], [ 0, 0, 2 ] ],
  434. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  435. '<table><tr><td>f{oo</td><td>bar</td>]</tr></table>'
  436. );
  437. } );
  438. } );
  439. // Tests if the selection got correctly converted.
  440. // Because `setData` might use selection converters itself to set the selection, we can't use it
  441. // to set the selection (because then we would test converters using converters).
  442. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  443. // that are offsets or paths of selection positions in root element.
  444. function test( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  445. // Parse passed `modelInput` string and set it as current model.
  446. setModelData( model, modelInput );
  447. // Manually set selection ranges using passed `selectionPaths`.
  448. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  449. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  450. const startPos = new ModelPosition( modelRoot, startPath );
  451. const endPos = new ModelPosition( modelRoot, endPath );
  452. const isBackward = selectionPaths[ 2 ] === 'backward';
  453. modelSelection.setRanges( [ new ModelRange( startPos, endPos ) ], isBackward );
  454. // Update selection attributes according to model.
  455. modelSelection.refreshAttributes();
  456. // And add or remove passed attributes.
  457. for ( const key in selectionAttributes ) {
  458. const value = selectionAttributes[ key ];
  459. if ( value ) {
  460. modelSelection.setAttribute( key, value );
  461. } else {
  462. modelSelection.removeAttribute( key );
  463. }
  464. }
  465. // Remove view children manually (without firing additional conversion).
  466. viewRoot.removeChildren( 0, viewRoot.childCount );
  467. // Convert model to view.
  468. view.change( writer => {
  469. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  470. dispatcher.convertSelection( modelSelection, writer );
  471. } );
  472. // Stringify view and check if it is same as expected.
  473. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  474. }
  475. } );