utils.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451
  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 ViewContainerElement from '@ckeditor/ckeditor5-engine/src/view/containerelement';
  6. import ViewDowncastWriter from '@ckeditor/ckeditor5-engine/src/view/downcastwriter';
  7. import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  8. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  9. import ListEditing from '../src/listediting';
  10. import ListStyleEditing from '../src/liststyleediting';
  11. import { createViewListItemElement, getSiblingListItem, getSiblingNodes } from '../src/utils';
  12. describe( 'utils', () => {
  13. let writer;
  14. beforeEach( () => {
  15. writer = new ViewDowncastWriter( {} );
  16. } );
  17. describe( 'createViewListItemElement()', () => {
  18. it( 'should create ViewContainerElement', () => {
  19. const item = createViewListItemElement( writer );
  20. expect( item ).to.be.instanceof( ViewContainerElement );
  21. } );
  22. it( 'should have li name', () => {
  23. const item = createViewListItemElement( writer );
  24. expect( item.name ).to.equal( 'li' );
  25. } );
  26. describe( 'getFillerOffset', () => {
  27. it( 'should return 0 if item is empty', () => {
  28. const item = createViewListItemElement( writer );
  29. expect( item.getFillerOffset() ).to.equal( 0 );
  30. } );
  31. it( 'should return 0 if item has only lists as children', () => {
  32. const innerListItem1 = createViewListItemElement( writer );
  33. writer.insert(
  34. writer.createPositionAt( innerListItem1, 0 ),
  35. writer.createText( 'foo' )
  36. );
  37. const innerListItem2 = createViewListItemElement( writer );
  38. writer.insert(
  39. writer.createPositionAt( innerListItem2, 0 ),
  40. writer.createText( 'bar' )
  41. );
  42. const innerList = writer.createContainerElement( 'ul' );
  43. writer.insert( writer.createPositionAt( innerList, 0 ), innerListItem1 );
  44. writer.insert( writer.createPositionAt( innerList, 0 ), innerListItem2 );
  45. const outerListItem = createViewListItemElement( writer );
  46. writer.insert( writer.createPositionAt( outerListItem, 0 ), innerList );
  47. expect( outerListItem.getFillerOffset() ).to.equal( 0 );
  48. } );
  49. it( 'should return null if item has non-list contents', () => {
  50. const item = createViewListItemElement( writer );
  51. writer.insert(
  52. writer.createPositionAt( item, 0 ),
  53. writer.createText( 'foo' )
  54. );
  55. expect( item.getFillerOffset() ).to.be.null;
  56. } );
  57. // Block filler is required after the `<br>` element if the element is the last child in the container.
  58. // See: https://github.com/ckeditor/ckeditor5/issues/1312#issuecomment-436669045.
  59. describe( 'for <br> elements in container', () => {
  60. it( 'returns offset of the last child which is the <br> element (1)', () => {
  61. const item = createViewListItemElement( writer );
  62. writer.insert( writer.createPositionAt( item, 0 ), writer.createEmptyElement( 'br' ) );
  63. expect( item.getFillerOffset() ).to.equal( 1 );
  64. } );
  65. it( 'returns offset of the last child which is the <br> element (2)', () => {
  66. const item = createViewListItemElement( writer );
  67. writer.insert( writer.createPositionAt( item, 0 ), writer.createEmptyElement( 'br' ) );
  68. writer.insert( writer.createPositionAt( item, 1 ), writer.createEmptyElement( 'br' ) );
  69. expect( item.getFillerOffset() ).to.equal( 2 );
  70. } );
  71. it( 'always returns the last <br> element in the container', () => {
  72. const item = createViewListItemElement( writer );
  73. writer.insert( writer.createPositionAt( item, 0 ), writer.createText( 'foo' ) );
  74. writer.insert( writer.createPositionAt( item, 1 ), writer.createEmptyElement( 'br' ) );
  75. writer.insert( writer.createPositionAt( item, 2 ), writer.createEmptyElement( 'br' ) );
  76. expect( item.getFillerOffset() ).to.equal( 3 );
  77. } );
  78. it( 'works fine with non-empty container with multi <br> elements', () => {
  79. const item = createViewListItemElement( writer );
  80. writer.insert( writer.createPositionAt( item, 0 ), writer.createText( 'foo' ) );
  81. writer.insert( writer.createPositionAt( item, 1 ), writer.createEmptyElement( 'br' ) );
  82. writer.insert( writer.createPositionAt( item, 2 ), writer.createText( 'bar' ) );
  83. writer.insert( writer.createPositionAt( item, 3 ), writer.createEmptyElement( 'br' ) );
  84. expect( item.getFillerOffset() ).to.equal( 4 );
  85. } );
  86. it( 'ignores the ui elements', () => {
  87. const item = createViewListItemElement( writer );
  88. writer.insert( writer.createPositionAt( item, 0 ), writer.createUIElement( 'span' ) );
  89. writer.insert( writer.createPositionAt( item, 1 ), writer.createEmptyElement( 'br' ) );
  90. expect( item.getFillerOffset() ).to.equal( 2 );
  91. } );
  92. it( 'empty element must be the <br> element', () => {
  93. const item = createViewListItemElement( writer );
  94. writer.insert(
  95. writer.createPositionAt( item, 0 ),
  96. writer.createEmptyElement( 'img' )
  97. );
  98. expect( item.getFillerOffset() ).to.be.null;
  99. } );
  100. } );
  101. } );
  102. } );
  103. describe( 'getSiblingListItem()', () => {
  104. let editor, model, document;
  105. beforeEach( () => {
  106. return VirtualTestEditor.create( { plugins: [ ListEditing ] } )
  107. .then( newEditor => {
  108. editor = newEditor;
  109. model = editor.model;
  110. document = model.document;
  111. } );
  112. } );
  113. afterEach( () => {
  114. return editor.destroy();
  115. } );
  116. it( 'should return the passed element if it matches the criteria (sameIndent, listIndent=0)', () => {
  117. setData( model,
  118. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  119. '<listItem listType="bulleted" listIndent="0">1.</listItem>' + // Starting item, wanted item.
  120. '<listItem listType="bulleted" listIndent="0">2.</listItem>'
  121. );
  122. const listItem = document.getRoot().getChild( 1 );
  123. const foundElement = getSiblingListItem( listItem, {
  124. sameIndent: true,
  125. listIndent: 0
  126. } );
  127. expect( foundElement ).to.equal( document.getRoot().getChild( 1 ) );
  128. } );
  129. it( 'should return the passed element if it matches the criteria (sameIndent, listIndent=0, direction="forward")', () => {
  130. setData( model,
  131. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  132. '<listItem listType="bulleted" listIndent="0">1.</listItem>' + // Starting item, wanted item.
  133. '<listItem listType="bulleted" listIndent="0">2.</listItem>'
  134. );
  135. const listItem = document.getRoot().getChild( 1 );
  136. const foundElement = getSiblingListItem( listItem, {
  137. sameIndent: true,
  138. listIndent: 0,
  139. direction: 'forward'
  140. } );
  141. expect( foundElement ).to.equal( document.getRoot().getChild( 1 ) );
  142. } );
  143. it( 'should return the first listItem that matches criteria (sameIndent, listIndent=1)', () => {
  144. setData( model,
  145. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  146. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  147. '<listItem listType="bulleted" listIndent="1">1.1</listItem>' +
  148. '<listItem listType="bulleted" listIndent="1">1.2</listItem>' + // Wanted item.
  149. '<listItem listType="bulleted" listIndent="0">2.</listItem>' + // Starting item.
  150. '<listItem listType="bulleted" listIndent="1">2.1.</listItem>' +
  151. '<listItem listType="bulleted" listIndent="1">2.2.</listItem>'
  152. );
  153. const listItem = document.getRoot().getChild( 5 );
  154. const foundElement = getSiblingListItem( listItem.previousSibling, {
  155. sameIndent: true,
  156. listIndent: 1
  157. } );
  158. expect( foundElement ).to.equal( document.getRoot().getChild( 3 ) );
  159. } );
  160. it( 'should return the first listItem that matches criteria (sameIndent, listIndent=1, direction="forward")', () => {
  161. setData( model,
  162. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  163. '<listItem listType="bulleted" listIndent="0">1.</listItem>' + // Starting item.
  164. '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
  165. '<listItem listType="bulleted" listIndent="1">2.1.</listItem>' + // Wanted item.
  166. '<listItem listType="bulleted" listIndent="1">2.2.</listItem>'
  167. );
  168. const listItem = document.getRoot().getChild( 1 );
  169. const foundElement = getSiblingListItem( listItem.nextSibling, {
  170. sameIndent: true,
  171. listIndent: 1,
  172. direction: 'forward'
  173. } );
  174. expect( foundElement ).to.equal( document.getRoot().getChild( 3 ) );
  175. } );
  176. it( 'should return the first listItem that matches criteria (smallerIndent, listIndent=1)', () => {
  177. setData( model,
  178. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  179. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  180. '<listItem listType="bulleted" listIndent="0">2.</listItem>' + // Wanted item.
  181. '<listItem listType="bulleted" listIndent="1">2.1.</listItem>' + // Starting item.
  182. '<listItem listType="bulleted" listIndent="1">2.2.</listItem>'
  183. );
  184. const listItem = document.getRoot().getChild( 4 );
  185. const foundElement = getSiblingListItem( listItem, {
  186. smallerIndent: true,
  187. listIndent: 1
  188. } );
  189. expect( foundElement ).to.equal( document.getRoot().getChild( 2 ) );
  190. } );
  191. it( 'should return the first listItem that matches criteria (smallerIndent, listIndent=1, direction="forward")', () => {
  192. setData( model,
  193. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  194. '<listItem listType="bulleted" listIndent="1">0.1.</listItem>' + // Starting item.
  195. '<listItem listType="bulleted" listIndent="1">0.2.</listItem>' +
  196. '<listItem listType="bulleted" listIndent="1">0.3.</listItem>' +
  197. '<listItem listType="bulleted" listIndent="0">1.</listItem>' // Wanted item.
  198. );
  199. const listItem = document.getRoot().getChild( 1 );
  200. const foundElement = getSiblingListItem( listItem, {
  201. smallerIndent: true,
  202. listIndent: 1,
  203. direction: 'forward'
  204. } );
  205. expect( foundElement ).to.equal( document.getRoot().getChild( 4 ) );
  206. } );
  207. } );
  208. describe( 'getSiblingNodes()', () => {
  209. let editor, model, document;
  210. beforeEach( () => {
  211. return VirtualTestEditor.create( { plugins: [ ListStyleEditing ] } )
  212. .then( newEditor => {
  213. editor = newEditor;
  214. model = editor.model;
  215. document = model.document;
  216. } );
  217. } );
  218. afterEach( () => {
  219. return editor.destroy();
  220. } );
  221. it( 'should return all listItems above the current selection position (direction="backward")', () => {
  222. setData( model,
  223. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  224. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  225. '<listItem listType="bulleted" listIndent="0">[]2.</listItem>' +
  226. '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
  227. '<listItem listType="bulleted" listIndent="0">4.</listItem>'
  228. );
  229. expect( getSiblingNodes( document.selection.getFirstPosition(), 'backward' ) ).to.deep.equal( [
  230. document.getRoot().getChild( 0 ),
  231. document.getRoot().getChild( 1 ),
  232. document.getRoot().getChild( 2 )
  233. ] );
  234. } );
  235. it( 'should return all listItems below the current selection position (direction="forward")', () => {
  236. setData( model,
  237. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  238. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  239. '<listItem listType="bulleted" listIndent="0">[]2.</listItem>' +
  240. '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
  241. '<listItem listType="bulleted" listIndent="0">4.</listItem>'
  242. );
  243. expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
  244. document.getRoot().getChild( 3 ),
  245. document.getRoot().getChild( 4 )
  246. ] );
  247. } );
  248. it( 'should break searching when spotted a non-listItem element (direction="backward")', () => {
  249. setData( model,
  250. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  251. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  252. '<paragraph>Foo</paragraph>' +
  253. '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
  254. '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
  255. '<listItem listType="bulleted" listIndent="0">4.[].</listItem>'
  256. );
  257. expect( getSiblingNodes( document.selection.getFirstPosition(), 'backward' ) ).to.deep.equal( [
  258. document.getRoot().getChild( 3 ),
  259. document.getRoot().getChild( 4 ),
  260. document.getRoot().getChild( 5 )
  261. ] );
  262. } );
  263. it( 'should break searching when spotted a non-listItem element (direction="forward")', () => {
  264. setData( model,
  265. '<listItem listType="bulleted" listIndent="0">[]0.</listItem>' +
  266. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  267. '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
  268. '<paragraph>Foo</paragraph>' +
  269. '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
  270. '<listItem listType="bulleted" listIndent="0">4.</listItem>'
  271. );
  272. expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
  273. document.getRoot().getChild( 1 ),
  274. document.getRoot().getChild( 2 )
  275. ] );
  276. } );
  277. it( 'should break searching when spotted a different value for the `listType` attribute (direction="backward")', () => {
  278. setData( model,
  279. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  280. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  281. '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
  282. '<listItem listType="numbered" listIndent="0">Numbered item.</listItem>' +
  283. '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
  284. '<listItem listType="bulleted" listIndent="0">[]4.</listItem>'
  285. );
  286. expect( getSiblingNodes( document.selection.getFirstPosition(), 'backward' ) ).to.deep.equal( [
  287. document.getRoot().getChild( 4 ),
  288. document.getRoot().getChild( 5 )
  289. ] );
  290. } );
  291. it( 'should break searching when spotted a different value for the `listType` attribute (direction="forward")', () => {
  292. setData( model,
  293. '<listItem listType="bulleted" listIndent="0">[]0.</listItem>' +
  294. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  295. '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
  296. '<listItem listType="numbered" listIndent="0">Numbered item.</listItem>' +
  297. '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
  298. '<listItem listType="bulleted" listIndent="0">4.</listItem>'
  299. );
  300. expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
  301. document.getRoot().getChild( 1 ),
  302. document.getRoot().getChild( 2 )
  303. ] );
  304. } );
  305. it( 'should break searching when spotted a different value for the `listStyle` attribute (direction="backward")', () => {
  306. setData( model,
  307. '<listItem listType="bulleted" listStyle="disc" listIndent="0">0.</listItem>' +
  308. '<listItem listType="bulleted" listStyle="disc" listIndent="0">1.</listItem>' +
  309. '<listItem listType="bulleted" listStyle="disc" listIndent="0">2.</listItem>' +
  310. '<listItem listType="bulleted" listStyle="square" listIndent="0">Broken item.</listItem>' +
  311. '<listItem listType="bulleted" listStyle="disc" listIndent="0">3.</listItem>' +
  312. '<listItem listType="bulleted" listStyle="disc" listIndent="0">[]4.</listItem>'
  313. );
  314. expect( getSiblingNodes( document.selection.getFirstPosition(), 'backward' ) ).to.deep.equal( [
  315. document.getRoot().getChild( 4 ),
  316. document.getRoot().getChild( 5 )
  317. ] );
  318. } );
  319. it( 'should break searching when spotted a different value for the `listStyle` attribute (direction="forward")', () => {
  320. setData( model,
  321. '<listItem listType="bulleted" listStyle="disc" listIndent="0">[]0.</listItem>' +
  322. '<listItem listType="bulleted" listStyle="disc" listIndent="0">1.</listItem>' +
  323. '<listItem listType="bulleted" listStyle="disc" listIndent="0">2.</listItem>' +
  324. '<listItem listType="bulleted" listStyle="square" listIndent="0">Broken item.</listItem>' +
  325. '<listItem listType="bulleted" listStyle="disc" listIndent="0">3.</listItem>' +
  326. '<listItem listType="bulleted" listStyle="disc" listIndent="0">4.</listItem>'
  327. );
  328. expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
  329. document.getRoot().getChild( 1 ),
  330. document.getRoot().getChild( 2 )
  331. ] );
  332. } );
  333. it( 'should ignore nested items (looking for listIndent=0)', () => {
  334. setData( model,
  335. '<listItem listType="bulleted" listIndent="0">[]0.</listItem>' +
  336. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  337. '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
  338. '<listItem listType="bulleted" listIndent="1">2.1.</listItem>' +
  339. '<listItem listType="bulleted" listIndent="1">2.2.</listItem>' +
  340. '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
  341. '<listItem listType="bulleted" listIndent="1">3.1.</listItem>' +
  342. '<listItem listType="bulleted" listIndent="2">3.1.1.</listItem>' +
  343. '<listItem listType="bulleted" listIndent="0">4.</listItem>'
  344. );
  345. expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
  346. document.getRoot().getChild( 1 ),
  347. document.getRoot().getChild( 2 ),
  348. document.getRoot().getChild( 5 ),
  349. document.getRoot().getChild( 8 )
  350. ] );
  351. } );
  352. it( 'should break when spotted an outer list (looking for listIndent=1)', () => {
  353. setData( model,
  354. '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
  355. '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
  356. '<listItem listType="bulleted" listIndent="1">[]1.1.</listItem>' +
  357. '<listItem listType="bulleted" listIndent="1">1.2.</listItem>' +
  358. '<listItem listType="bulleted" listIndent="1">1.3.</listItem>' +
  359. '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
  360. '<listItem listType="bulleted" listIndent="0">3.</listItem>'
  361. );
  362. expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
  363. document.getRoot().getChild( 3 ),
  364. document.getRoot().getChild( 4 )
  365. ] );
  366. } );
  367. } );
  368. } );