tablewalker.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492
  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. import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  6. import ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor';
  7. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  8. import { defaultConversion, defaultSchema, modelTable } from './_utils/utils';
  9. import TableWalker from '../src/tablewalker';
  10. describe( 'TableWalker', () => {
  11. let editor, model, doc, root;
  12. beforeEach( () => {
  13. return ModelTestEditor.create()
  14. .then( newEditor => {
  15. editor = newEditor;
  16. model = editor.model;
  17. doc = model.document;
  18. root = doc.getRoot( 'main' );
  19. defaultSchema( model.schema );
  20. defaultConversion( editor.conversion );
  21. } );
  22. } );
  23. function testWalker( tableData, expected, options, skip ) {
  24. setData( model, modelTable( tableData ) );
  25. const walker = new TableWalker( root.getChild( 0 ), options );
  26. if ( skip !== undefined ) {
  27. walker.skipRow( skip );
  28. }
  29. const result = [ ...walker ];
  30. const formattedResult = result.map( ( { cell, row, column, isAnchor, cellWidth, cellHeight, cellIndex, ...anchor } ) => ( {
  31. row,
  32. column,
  33. data: cell && cell.getChild( 0 ).getChild( 0 ).data,
  34. index: cellIndex,
  35. ...( anchor.cellAnchorRow != row ? { anchorRow: anchor.cellAnchorRow } : null ),
  36. ...( anchor.cellAnchorColumn != column ? { anchorColumn: anchor.cellAnchorColumn } : null ),
  37. ...( isAnchor ? { isAnchor } : null ),
  38. ...( cellWidth > 1 ? { width: cellWidth } : null ),
  39. ...( cellHeight > 1 ? { height: cellHeight } : null )
  40. } ) );
  41. expect( formattedResult ).to.deep.equal( expected );
  42. }
  43. it( 'should iterate over a table', () => {
  44. // +----+----+
  45. // | 00 | 01 |
  46. // +----+----+
  47. // | 10 | 11 |
  48. // +----+----+
  49. testWalker( [
  50. [ '00', '01' ],
  51. [ '10', '11' ]
  52. ], [
  53. { row: 0, column: 0, index: 0, data: '00', isAnchor: true },
  54. { row: 0, column: 1, index: 1, data: '01', isAnchor: true },
  55. { row: 1, column: 0, index: 0, data: '10', isAnchor: true },
  56. { row: 1, column: 1, index: 1, data: '11', isAnchor: true }
  57. ] );
  58. } );
  59. it( 'should properly output column indexes of a table that has colspans', () => {
  60. // +----+----+----+
  61. // | 00 | 13 |
  62. // +----+----+----+
  63. testWalker( [
  64. [ { colspan: 2, contents: '00' }, '13' ]
  65. ], [
  66. { row: 0, column: 0, index: 0, data: '00', isAnchor: true, width: 2 },
  67. { row: 0, column: 2, index: 1, data: '13', isAnchor: true }
  68. ] );
  69. } );
  70. it( 'should properly output column indexes of a table that has rowspans', () => {
  71. // +----+----+----+
  72. // | 00 | 02 |
  73. // + +----+
  74. // | | 12 |
  75. // + +----+
  76. // | | 22 |
  77. // +----+----+----+
  78. // | 30 | 31 | 32 |
  79. // +----+----+----+
  80. testWalker( [
  81. [ { colspan: 2, rowspan: 3, contents: '00' }, '02' ],
  82. [ '12' ],
  83. [ '22' ],
  84. [ '30', '31', '32' ]
  85. ], [
  86. { row: 0, column: 0, index: 0, data: '00', isAnchor: true, width: 2, height: 3 },
  87. { row: 0, column: 2, index: 1, data: '02', isAnchor: true },
  88. { row: 1, column: 2, index: 0, data: '12', isAnchor: true },
  89. { row: 2, column: 2, index: 0, data: '22', isAnchor: true },
  90. { row: 3, column: 0, index: 0, data: '30', isAnchor: true },
  91. { row: 3, column: 1, index: 1, data: '31', isAnchor: true },
  92. { row: 3, column: 2, index: 2, data: '32', isAnchor: true }
  93. ] );
  94. } );
  95. it( 'should properly output column indexes of a table that has multiple rowspans', () => {
  96. // +----+----+----+
  97. // | 11 | 12 | 13 |
  98. // + +----+----+
  99. // | | 22 | 23 |
  100. // + + +----+
  101. // | | | 33 |
  102. // +----+----+----+
  103. // | 41 | 42 | 43 |
  104. // +----+----+----+
  105. testWalker( [
  106. [ { rowspan: 3, contents: '11' }, '12', '13' ],
  107. [ { rowspan: 2, contents: '22' }, '23' ],
  108. [ '33' ],
  109. [ '41', '42', '43' ]
  110. ], [
  111. { row: 0, column: 0, index: 0, data: '11', isAnchor: true, height: 3 },
  112. { row: 0, column: 1, index: 1, data: '12', isAnchor: true },
  113. { row: 0, column: 2, index: 2, data: '13', isAnchor: true },
  114. { row: 1, column: 1, index: 0, data: '22', isAnchor: true, height: 2 },
  115. { row: 1, column: 2, index: 1, data: '23', isAnchor: true },
  116. { row: 2, column: 2, index: 0, data: '33', isAnchor: true },
  117. { row: 3, column: 0, index: 0, data: '41', isAnchor: true },
  118. { row: 3, column: 1, index: 1, data: '42', isAnchor: true },
  119. { row: 3, column: 2, index: 2, data: '43', isAnchor: true }
  120. ] );
  121. } );
  122. describe( 'option.startRow', () => {
  123. it( 'should start iterating from given row but with cell spans properly calculated', () => {
  124. // +----+----+----+
  125. // | 11 | 13 |
  126. // + +----+
  127. // | | 23 |
  128. // + +----+
  129. // | | 33 |
  130. // +----+----+----+
  131. // | 41 | 42 | 43 |
  132. // +----+----+----+
  133. testWalker( [
  134. [ { colspan: 2, rowspan: 3, contents: '11' }, '13' ],
  135. [ '23' ],
  136. [ '33' ],
  137. [ '41', '42', '43' ]
  138. ], [
  139. { row: 2, column: 2, index: 0, data: '33', isAnchor: true },
  140. { row: 3, column: 0, index: 0, data: '41', isAnchor: true },
  141. { row: 3, column: 1, index: 1, data: '42', isAnchor: true },
  142. { row: 3, column: 2, index: 2, data: '43', isAnchor: true }
  143. ], { startRow: 2 } );
  144. } );
  145. } );
  146. describe( 'option.endRow', () => {
  147. it( 'should stop iterating after given row but with cell spans properly calculated', () => {
  148. // +----+----+----+
  149. // | 11 | 13 |
  150. // + +----+
  151. // | | 23 |
  152. // + +----+
  153. // | | 33 |
  154. // +----+----+----+
  155. // | 41 | 42 | 43 |
  156. // +----+----+----+
  157. testWalker( [
  158. [ { colspan: 2, rowspan: 3, contents: '11' }, '13' ],
  159. [ '23' ],
  160. [ '33' ],
  161. [ '41', '42', '43' ]
  162. ], [
  163. { row: 0, column: 0, index: 0, data: '11', isAnchor: true, width: 2, height: 3 },
  164. { row: 0, column: 2, index: 1, data: '13', isAnchor: true },
  165. { row: 1, column: 2, index: 0, data: '23', isAnchor: true },
  166. { row: 2, column: 2, index: 0, data: '33', isAnchor: true }
  167. ], { endRow: 2 } );
  168. } );
  169. it( 'should iterate over given row only', () => {
  170. // +----+----+----+
  171. // | 11 | 13 |
  172. // + +----+
  173. // | | 23 |
  174. // + +----+
  175. // | | 33 |
  176. // +----+----+----+
  177. // | 41 | 42 | 43 |
  178. // +----+----+----+
  179. testWalker( [
  180. [ { colspan: 2, rowspan: 3, contents: '11' }, '13' ],
  181. [ '23' ],
  182. [ '33' ],
  183. [ '41', '42', '43' ]
  184. ], [
  185. { row: 0, column: 0, index: 0, data: '11', isAnchor: true, width: 2, height: 3 },
  186. { row: 0, column: 2, index: 1, data: '13', isAnchor: true }
  187. ], { endRow: 0 } );
  188. } );
  189. } );
  190. describe( 'options.startColumn', () => {
  191. it( 'should not return the slots before startColumn', () => {
  192. // +----+----+----+
  193. // | 00 | 02 |
  194. // + +----+
  195. // | | 12 |
  196. // + +----+
  197. // | | 22 |
  198. // +----+----+----+
  199. // | 30 | 31 | 32 |
  200. // +----+----+----+
  201. testWalker( [
  202. [ { colspan: 2, rowspan: 3, contents: '00' }, '02' ],
  203. [ '12' ],
  204. [ '22' ],
  205. [ '30', '31', '32' ]
  206. ], [
  207. { row: 0, column: 2, index: 1, data: '02', isAnchor: true },
  208. { row: 1, column: 2, index: 0, data: '12', isAnchor: true },
  209. { row: 2, column: 2, index: 0, data: '22', isAnchor: true },
  210. { row: 3, column: 1, index: 1, data: '31', isAnchor: true },
  211. { row: 3, column: 2, index: 2, data: '32', isAnchor: true }
  212. ], { startColumn: 1 } );
  213. } );
  214. it( 'should not return the slots before startColumn, includeAllSlots = true', () => {
  215. // +----+----+----+
  216. // | 00 | 02 |
  217. // + +----+
  218. // | | 12 |
  219. // + +----+
  220. // | | 22 |
  221. // +----+----+----+
  222. // | 30 | 31 | 32 |
  223. // +----+----+----+
  224. testWalker( [
  225. [ { colspan: 2, rowspan: 3, contents: '00' }, '02' ],
  226. [ '12' ],
  227. [ '22' ],
  228. [ '30', '31', '32' ]
  229. ], [
  230. { row: 0, column: 1, index: 0, data: '00', width: 2, height: 3, anchorColumn: 0 },
  231. { row: 0, column: 2, index: 1, data: '02', isAnchor: true },
  232. { row: 1, column: 1, index: 0, data: '00', width: 2, height: 3, anchorColumn: 0, anchorRow: 0 },
  233. { row: 1, column: 2, index: 0, data: '12', isAnchor: true },
  234. { row: 2, column: 1, index: 0, data: '00', width: 2, height: 3, anchorColumn: 0, anchorRow: 0 },
  235. { row: 2, column: 2, index: 0, data: '22', isAnchor: true },
  236. { row: 3, column: 1, index: 1, data: '31', isAnchor: true },
  237. { row: 3, column: 2, index: 2, data: '32', isAnchor: true }
  238. ], { startColumn: 1, includeAllSlots: true } );
  239. } );
  240. } );
  241. describe( 'options.endColumn', () => {
  242. it( 'should not return the slots after endColumn', () => {
  243. // +----+----+----+
  244. // | 00 | 02 |
  245. // + +----+
  246. // | | 12 |
  247. // + +----+
  248. // | | 22 |
  249. // +----+----+----+
  250. // | 30 | 31 | 32 |
  251. // +----+----+----+
  252. testWalker( [
  253. [ { colspan: 2, rowspan: 3, contents: '00' }, '02' ],
  254. [ '12' ],
  255. [ '22' ],
  256. [ '30', '31', '32' ]
  257. ], [
  258. { row: 0, column: 0, index: 0, data: '00', isAnchor: true, width: 2, height: 3 },
  259. { row: 3, column: 0, index: 0, data: '30', isAnchor: true },
  260. { row: 3, column: 1, index: 1, data: '31', isAnchor: true }
  261. ], { endColumn: 1 } );
  262. } );
  263. it( 'should not return the slots after endColumn, includeAllSlots = true', () => {
  264. // +----+----+----+
  265. // | 00 | 02 |
  266. // + +----+
  267. // | | 12 |
  268. // + +----+
  269. // | | 22 |
  270. // +----+----+----+
  271. // | 30 | 31 | 32 |
  272. // +----+----+----+
  273. testWalker( [
  274. [ { colspan: 2, rowspan: 3, contents: '00' }, '02' ],
  275. [ '12' ],
  276. [ '22' ],
  277. [ '30', '31', '32' ]
  278. ], [
  279. { row: 0, column: 0, index: 0, data: '00', width: 2, height: 3, isAnchor: true },
  280. { row: 0, column: 1, index: 0, data: '00', width: 2, height: 3, anchorColumn: 0 },
  281. { row: 1, column: 0, index: 0, data: '00', width: 2, height: 3, anchorRow: 0 },
  282. { row: 1, column: 1, index: 0, data: '00', width: 2, height: 3, anchorColumn: 0, anchorRow: 0 },
  283. { row: 2, column: 0, index: 0, data: '00', width: 2, height: 3, anchorRow: 0 },
  284. { row: 2, column: 1, index: 0, data: '00', width: 2, height: 3, anchorColumn: 0, anchorRow: 0 },
  285. { row: 3, column: 0, index: 0, data: '30', isAnchor: true },
  286. { row: 3, column: 1, index: 1, data: '31', isAnchor: true }
  287. ], { endColumn: 1, includeAllSlots: true } );
  288. } );
  289. } );
  290. describe( 'option.includeAllSlots', () => {
  291. it( 'should output spanned cells at the end of a table', () => {
  292. // +----+----+
  293. // | 00 | 01 |
  294. // +----+ +
  295. // | 10 | |
  296. // +----+----+
  297. testWalker( [
  298. [ '00', { rowspan: 2, contents: '01' } ],
  299. [ '10' ]
  300. ], [
  301. { row: 0, column: 0, index: 0, data: '00', isAnchor: true },
  302. { row: 0, column: 1, index: 1, data: '01', isAnchor: true, height: 2 },
  303. { row: 1, column: 0, index: 0, data: '10', isAnchor: true },
  304. { row: 1, column: 1, index: 1, data: '01', anchorRow: 0, height: 2 }
  305. ], { includeAllSlots: true } );
  306. } );
  307. it( 'should output spanned cells', () => {
  308. // +----+----+----+
  309. // | 00 | 02 |
  310. // + +----+
  311. // | | 12 |
  312. // + +----+
  313. // | | 22 |
  314. // +----+----+----+
  315. // | 30 | 31 |
  316. // +----+----+----+
  317. testWalker( [
  318. [ { colspan: 2, rowspan: 3, contents: '00' }, '02' ],
  319. [ '12' ],
  320. [ '22' ],
  321. [ '30', { colspan: 2, contents: '31' } ]
  322. ], [
  323. { row: 0, column: 0, index: 0, data: '00', width: 2, height: 3, isAnchor: true },
  324. { row: 0, column: 1, index: 0, data: '00', width: 2, height: 3, anchorColumn: 0 },
  325. { row: 0, column: 2, index: 1, data: '02', isAnchor: true },
  326. { row: 1, column: 0, index: 0, data: '00', width: 2, height: 3, anchorRow: 0 },
  327. { row: 1, column: 1, index: 0, data: '00', width: 2, height: 3, anchorRow: 0, anchorColumn: 0 },
  328. { row: 1, column: 2, index: 0, data: '12', isAnchor: true },
  329. { row: 2, column: 0, index: 0, data: '00', width: 2, height: 3, anchorRow: 0 },
  330. { row: 2, column: 1, index: 0, data: '00', width: 2, height: 3, anchorRow: 0, anchorColumn: 0 },
  331. { row: 2, column: 2, index: 0, data: '22', isAnchor: true },
  332. { row: 3, column: 0, index: 0, data: '30', isAnchor: true },
  333. { row: 3, column: 1, index: 1, data: '31', width: 2, isAnchor: true },
  334. { row: 3, column: 2, index: 1, data: '31', width: 2, anchorColumn: 1 }
  335. ], { includeAllSlots: true } );
  336. } );
  337. it( 'should output rowspanned cells at the end of a table row', () => {
  338. // +----+----+
  339. // | 00 | 01 |
  340. // +----+ +
  341. // | 10 | |
  342. // +----+----+
  343. testWalker( [
  344. [ '00', { rowspan: 2, contents: '01' } ],
  345. [ '10' ]
  346. ], [
  347. { row: 0, column: 0, index: 0, data: '00', isAnchor: true },
  348. { row: 0, column: 1, index: 1, data: '01', isAnchor: true, height: 2 },
  349. { row: 1, column: 0, index: 0, data: '10', isAnchor: true },
  350. { row: 1, column: 1, index: 1, data: '01', anchorRow: 0, height: 2 }
  351. ], { includeAllSlots: true } );
  352. } );
  353. it( 'should work with startRow & endRow options', () => {
  354. // +----+----+----+
  355. // | 00 | 02 |
  356. // + +----+
  357. // | | 12 |
  358. // + +----+
  359. // | | 22 |
  360. // +----+----+----+
  361. // | 30 | 31 | 32 |
  362. // +----+----+----+
  363. testWalker( [
  364. [ { colspan: 2, rowspan: 3, contents: '00' }, '02' ],
  365. [ '12' ],
  366. [ '22' ],
  367. [ '30', '31', '32' ]
  368. ], [
  369. { row: 1, column: 0, index: 0, data: '00', anchorRow: 0, width: 2, height: 3 },
  370. { row: 1, column: 1, index: 0, data: '00', anchorRow: 0, width: 2, height: 3, anchorColumn: 0 },
  371. { row: 1, column: 2, index: 0, data: '12', isAnchor: true },
  372. { row: 2, column: 0, index: 0, data: '00', anchorRow: 0, width: 2, height: 3 },
  373. { row: 2, column: 1, index: 0, data: '00', anchorRow: 0, width: 2, height: 3, anchorColumn: 0 },
  374. { row: 2, column: 2, index: 0, data: '22', isAnchor: true }
  375. ], { includeAllSlots: true, startRow: 1, endRow: 2 } );
  376. } );
  377. it( 'should output rowspanned cells at the end of a table row with startRow & endRow options', () => {
  378. // +----+----+
  379. // | 00 | 01 |
  380. // +----+ +
  381. // | 10 | |
  382. // +----+----+
  383. // | 20 | 21 |
  384. // +----+----+
  385. testWalker( [
  386. [ '00', { rowspan: 2, contents: '01' } ],
  387. [ '10' ],
  388. [ '20', '21' ]
  389. ], [
  390. { row: 0, column: 0, index: 0, data: '00', isAnchor: true },
  391. { row: 0, column: 1, index: 1, data: '01', isAnchor: true, height: 2 },
  392. { row: 1, column: 0, index: 0, data: '10', isAnchor: true },
  393. { row: 1, column: 1, index: 1, data: '01', anchorRow: 0, height: 2 }
  394. ], { startRow: 0, endRow: 1, includeAllSlots: true } );
  395. } );
  396. } );
  397. describe( '#skipRow()', () => {
  398. it( 'should skip row', () => {
  399. // +----+----+----+
  400. // | 00 | 02 |
  401. // + +----+
  402. // | | 12 |
  403. // + +----+
  404. // | | 22 |
  405. // +----+----+----+
  406. // | 30 | 31 | 32 |
  407. // +----+----+----+
  408. testWalker( [
  409. [ { colspan: 2, rowspan: 3, contents: '00' }, '02' ],
  410. [ '12' ],
  411. [ '22' ],
  412. [ '30', '31', '32' ]
  413. ], [
  414. { row: 0, column: 0, index: 0, data: '00', isAnchor: true, width: 2, height: 3 },
  415. { row: 0, column: 2, index: 1, data: '02', isAnchor: true },
  416. { row: 2, column: 2, index: 0, data: '22', isAnchor: true },
  417. { row: 3, column: 0, index: 0, data: '30', isAnchor: true },
  418. { row: 3, column: 1, index: 1, data: '31', isAnchor: true },
  419. { row: 3, column: 2, index: 2, data: '32', isAnchor: true }
  420. ], {}, 1 );
  421. } );
  422. it( 'should skip row, includeAllSlots = true', () => {
  423. // +----+----+----+
  424. // | 00 | 02 |
  425. // + +----+
  426. // | | 12 |
  427. // + +----+
  428. // | | 22 |
  429. // +----+----+----+
  430. // | 30 | 31 | 32 |
  431. // +----+----+----+
  432. testWalker( [
  433. [ { colspan: 2, rowspan: 3, contents: '00' }, '02' ],
  434. [ '12' ],
  435. [ '22' ],
  436. [ '30', '31', '32' ]
  437. ], [
  438. { row: 0, column: 0, index: 0, data: '00', width: 2, height: 3, isAnchor: true },
  439. { row: 0, column: 1, index: 0, data: '00', width: 2, height: 3, anchorColumn: 0 },
  440. { row: 0, column: 2, index: 1, data: '02', isAnchor: true },
  441. { row: 2, column: 0, index: 0, data: '00', width: 2, height: 3, anchorRow: 0 },
  442. { row: 2, column: 1, index: 0, data: '00', width: 2, height: 3, anchorRow: 0, anchorColumn: 0 },
  443. { row: 2, column: 2, index: 0, data: '22', isAnchor: true },
  444. { row: 3, column: 0, index: 0, data: '30', isAnchor: true },
  445. { row: 3, column: 1, index: 1, data: '31', isAnchor: true },
  446. { row: 3, column: 2, index: 2, data: '32', isAnchor: true }
  447. ], { includeAllSlots: true }, 1 );
  448. } );
  449. } );
  450. it( 'should throw error if walker value old api used', () => {
  451. setData( model, modelTable( [
  452. [ 'a' ]
  453. ] ) );
  454. const walker = new TableWalker( root.getChild( 0 ) );
  455. const { value } = walker.next();
  456. expect( () => value.isSpanned ).to.throw( CKEditorError, 'improper-api-usage' );
  457. expect( () => value.colspan ).to.throw( CKEditorError, 'improper-api-usage' );
  458. expect( () => value.rowspan ).to.throw( CKEditorError, 'improper-api-usage' );
  459. } );
  460. } );