indentcommand.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Editor from '@ckeditor/ckeditor5-core/src/editor/editor';
  6. import Document from '@ckeditor/ckeditor5-engine/src/model/document';
  7. import IndentCommand from '../src/indentcommand';
  8. import Range from '@ckeditor/ckeditor5-engine/src/model/range';
  9. import Position from '@ckeditor/ckeditor5-engine/src/model/position';
  10. import { setData, getData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  11. describe( 'IndentCommand', () => {
  12. let editor, doc, root;
  13. beforeEach( () => {
  14. editor = new Editor();
  15. editor.document = new Document();
  16. doc = editor.document;
  17. root = doc.createRoot();
  18. doc.schema.registerItem( 'listItem', '$block' );
  19. doc.schema.registerItem( 'paragraph', '$block' );
  20. doc.schema.allow( { name: '$block', inside: '$root' } );
  21. doc.schema.allow( { name: 'listItem', attributes: [ 'type', 'indent' ], inside: '$root' } );
  22. doc.schema.allow( { name: 'paragraph', inside: '$root' } );
  23. setData(
  24. doc,
  25. '<listItem indent="0" type="bulleted">a</listItem>' +
  26. '<listItem indent="0" type="bulleted">b</listItem>' +
  27. '<listItem indent="1" type="bulleted">c</listItem>' +
  28. '<listItem indent="2" type="bulleted">d</listItem>' +
  29. '<listItem indent="2" type="bulleted">e</listItem>' +
  30. '<listItem indent="1" type="bulleted">f</listItem>' +
  31. '<listItem indent="0" type="bulleted">g</listItem>'
  32. );
  33. } );
  34. describe( 'IndentCommand', () => {
  35. let command;
  36. beforeEach( () => {
  37. command = new IndentCommand( editor, 'forward' );
  38. } );
  39. afterEach( () => {
  40. command.destroy();
  41. } );
  42. describe( 'isEnabled', () => {
  43. it( 'should be true if selection starts in list item', () => {
  44. doc.enqueueChanges( () => {
  45. doc.selection.collapse( root.getChild( 5 ) );
  46. } );
  47. expect( command.isEnabled ).to.be.true;
  48. } );
  49. it( 'should be false if selection starts in first list item', () => {
  50. doc.enqueueChanges( () => {
  51. doc.selection.collapse( root.getChild( 0 ) );
  52. } );
  53. expect( command.isEnabled ).to.be.false;
  54. } );
  55. // Reported in PR #53.
  56. it( 'should be false if selection starts in first list item #2', () => {
  57. setData(
  58. doc,
  59. '<listItem indent="0" type="bulleted">a</listItem>' +
  60. '<listItem indent="1" type="bulleted">b</listItem>' +
  61. '<listItem indent="0" type="bulleted">c</listItem>' +
  62. '<listItem indent="1" type="bulleted">[]d</listItem>' +
  63. '<listItem indent="2" type="bulleted">e</listItem>'
  64. );
  65. expect( command.isEnabled ).to.be.false;
  66. } );
  67. // Reported in PR #53.
  68. it( 'should be false if selection starts in first list item #3', () => {
  69. setData(
  70. doc,
  71. '<listItem indent="0" type="bulleted">a</listItem>' +
  72. '<listItem indent="1" type="bulleted">b</listItem>' +
  73. '<listItem indent="0" type="numbered">c</listItem>' +
  74. '<listItem indent="1" type="bulleted">d</listItem>' +
  75. '<listItem indent="0" type="bulleted">[]e</listItem>'
  76. );
  77. expect( command.isEnabled ).to.be.false;
  78. } );
  79. it( 'should be false if selection starts in first list item of top level list with different type than previous list', () => {
  80. setData(
  81. doc,
  82. '<listItem indent="0" type="bulleted">a</listItem>' +
  83. '<listItem indent="0" type="numbered">[]b</listItem>'
  84. );
  85. expect( command.isEnabled ).to.be.false;
  86. } );
  87. it( 'should be false if selection starts in a list item that has bigger indent than it\'s previous sibling', () => {
  88. doc.enqueueChanges( () => {
  89. doc.selection.collapse( root.getChild( 2 ) );
  90. } );
  91. expect( command.isEnabled ).to.be.false;
  92. } );
  93. // Edge case but may happen that some other blocks will also use the indent attribute
  94. // and before we fixed it the command was enabled in such a case.
  95. it( 'should be false if selection starts in a paragraph with indent attribute', () => {
  96. doc.schema.allow( { name: 'paragraph', attributes: [ 'indent' ], inside: '$root' } );
  97. setData( doc, '<listItem indent="0">a</listItem><paragraph indent="0">b[]</paragraph>' );
  98. expect( command.isEnabled ).to.be.false;
  99. } );
  100. } );
  101. describe( 'execute()', () => {
  102. it( 'should increment indent attribute by 1', () => {
  103. doc.enqueueChanges( () => {
  104. doc.selection.collapse( root.getChild( 5 ) );
  105. } );
  106. command.execute();
  107. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  108. '<listItem indent="0" type="bulleted">a</listItem>' +
  109. '<listItem indent="0" type="bulleted">b</listItem>' +
  110. '<listItem indent="1" type="bulleted">c</listItem>' +
  111. '<listItem indent="2" type="bulleted">d</listItem>' +
  112. '<listItem indent="2" type="bulleted">e</listItem>' +
  113. '<listItem indent="2" type="bulleted">f</listItem>' +
  114. '<listItem indent="0" type="bulleted">g</listItem>'
  115. );
  116. } );
  117. it( 'should increment indent of all sub-items of indented item', () => {
  118. doc.enqueueChanges( () => {
  119. doc.selection.collapse( root.getChild( 1 ) );
  120. } );
  121. command.execute();
  122. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  123. '<listItem indent="0" type="bulleted">a</listItem>' +
  124. '<listItem indent="1" type="bulleted">b</listItem>' +
  125. '<listItem indent="2" type="bulleted">c</listItem>' +
  126. '<listItem indent="3" type="bulleted">d</listItem>' +
  127. '<listItem indent="3" type="bulleted">e</listItem>' +
  128. '<listItem indent="2" type="bulleted">f</listItem>' +
  129. '<listItem indent="0" type="bulleted">g</listItem>'
  130. );
  131. } );
  132. it( 'should increment indent of all selected item when multiple items are selected', () => {
  133. doc.enqueueChanges( () => {
  134. doc.selection.setRanges( [ new Range(
  135. new Position( root.getChild( 1 ), [ 0 ] ),
  136. new Position( root.getChild( 3 ), [ 0 ] )
  137. ) ] );
  138. } );
  139. command.execute();
  140. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  141. '<listItem indent="0" type="bulleted">a</listItem>' +
  142. '<listItem indent="1" type="bulleted">b</listItem>' +
  143. '<listItem indent="2" type="bulleted">c</listItem>' +
  144. '<listItem indent="3" type="bulleted">d</listItem>' +
  145. '<listItem indent="2" type="bulleted">e</listItem>' +
  146. '<listItem indent="1" type="bulleted">f</listItem>' +
  147. '<listItem indent="0" type="bulleted">g</listItem>'
  148. );
  149. } );
  150. it( 'should fix list type when item is intended #1', () => {
  151. setData(
  152. doc,
  153. '<listItem indent="0" type="bulleted">a</listItem>' +
  154. '<listItem indent="1" type="bulleted">b</listItem>' +
  155. '<listItem indent="2" type="numbered">c</listItem>' +
  156. '<listItem indent="1" type="bulleted">[]d</listItem>'
  157. );
  158. command.execute();
  159. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  160. '<listItem indent="0" type="bulleted">a</listItem>' +
  161. '<listItem indent="1" type="bulleted">b</listItem>' +
  162. '<listItem indent="2" type="numbered">c</listItem>' +
  163. '<listItem indent="2" type="numbered">d</listItem>'
  164. );
  165. } );
  166. // Not only boundary list items has to be fixed, but also items in the middle of selection.
  167. it( 'should fix list type when item is intended #2', () => {
  168. setData(
  169. doc,
  170. '<listItem indent="0" type="bulleted">a</listItem>' +
  171. '<listItem indent="1" type="numbered">b</listItem>' +
  172. '<listItem indent="1" type="numbered">[c</listItem>' +
  173. '<listItem indent="0" type="bulleted">d</listItem>' +
  174. '<listItem indent="1" type="numbered">e]</listItem>' +
  175. '<listItem indent="0" type="bulleted">f</listItem>'
  176. );
  177. command.execute();
  178. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  179. '<listItem indent="0" type="bulleted">a</listItem>' +
  180. '<listItem indent="1" type="numbered">b</listItem>' +
  181. '<listItem indent="2" type="numbered">c</listItem>' +
  182. '<listItem indent="1" type="numbered">d</listItem>' +
  183. '<listItem indent="2" type="numbered">e</listItem>' +
  184. '<listItem indent="0" type="bulleted">f</listItem>'
  185. );
  186. } );
  187. } );
  188. } );
  189. describe( 'IndentCommand - backward (outdent)', () => {
  190. let command;
  191. beforeEach( () => {
  192. command = new IndentCommand( editor, 'backward' );
  193. } );
  194. afterEach( () => {
  195. command.destroy();
  196. } );
  197. describe( 'isEnabled', () => {
  198. it( 'should be true if selection starts in list item', () => {
  199. doc.enqueueChanges( () => {
  200. doc.selection.collapse( root.getChild( 5 ) );
  201. } );
  202. expect( command.isEnabled ).to.be.true;
  203. } );
  204. it( 'should be true if selection starts in first list item', () => {
  205. // This is in contrary to forward indent command.
  206. doc.enqueueChanges( () => {
  207. doc.selection.collapse( root.getChild( 0 ) );
  208. } );
  209. expect( command.isEnabled ).to.be.true;
  210. } );
  211. it( 'should be true if selection starts in a list item that has bigger indent than it\'s previous sibling', () => {
  212. // This is in contrary to forward indent command.
  213. doc.enqueueChanges( () => {
  214. doc.selection.collapse( root.getChild( 2 ) );
  215. } );
  216. expect( command.isEnabled ).to.be.true;
  217. } );
  218. } );
  219. describe( 'execute()', () => {
  220. it( 'should decrement indent attribute by 1 (if it is bigger than 0)', () => {
  221. doc.enqueueChanges( () => {
  222. doc.selection.collapse( root.getChild( 5 ) );
  223. } );
  224. command.execute();
  225. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  226. '<listItem indent="0" type="bulleted">a</listItem>' +
  227. '<listItem indent="0" type="bulleted">b</listItem>' +
  228. '<listItem indent="1" type="bulleted">c</listItem>' +
  229. '<listItem indent="2" type="bulleted">d</listItem>' +
  230. '<listItem indent="2" type="bulleted">e</listItem>' +
  231. '<listItem indent="0" type="bulleted">f</listItem>' +
  232. '<listItem indent="0" type="bulleted">g</listItem>'
  233. );
  234. } );
  235. it( 'should rename listItem to paragraph (if indent is equal to 0)', () => {
  236. doc.enqueueChanges( () => {
  237. doc.selection.collapse( root.getChild( 0 ) );
  238. } );
  239. command.execute();
  240. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  241. '<paragraph indent="0" type="bulleted">a</paragraph>' +
  242. '<listItem indent="0" type="bulleted">b</listItem>' +
  243. '<listItem indent="1" type="bulleted">c</listItem>' +
  244. '<listItem indent="2" type="bulleted">d</listItem>' +
  245. '<listItem indent="2" type="bulleted">e</listItem>' +
  246. '<listItem indent="1" type="bulleted">f</listItem>' +
  247. '<listItem indent="0" type="bulleted">g</listItem>'
  248. );
  249. } );
  250. it( 'should decrement indent of all sub-items of outdented item', () => {
  251. doc.enqueueChanges( () => {
  252. doc.selection.collapse( root.getChild( 1 ) );
  253. } );
  254. command.execute();
  255. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  256. '<listItem indent="0" type="bulleted">a</listItem>' +
  257. '<paragraph indent="0" type="bulleted">b</paragraph>' +
  258. '<listItem indent="0" type="bulleted">c</listItem>' +
  259. '<listItem indent="1" type="bulleted">d</listItem>' +
  260. '<listItem indent="1" type="bulleted">e</listItem>' +
  261. '<listItem indent="0" type="bulleted">f</listItem>' +
  262. '<listItem indent="0" type="bulleted">g</listItem>'
  263. );
  264. } );
  265. it( 'should outdent all selected item when multiple items are selected', () => {
  266. doc.enqueueChanges( () => {
  267. doc.selection.setRanges( [ new Range(
  268. new Position( root.getChild( 1 ), [ 0 ] ),
  269. new Position( root.getChild( 3 ), [ 0 ] )
  270. ) ] );
  271. } );
  272. command.execute();
  273. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  274. '<listItem indent="0" type="bulleted">a</listItem>' +
  275. '<paragraph indent="0" type="bulleted">b</paragraph>' +
  276. '<listItem indent="0" type="bulleted">c</listItem>' +
  277. '<listItem indent="1" type="bulleted">d</listItem>' +
  278. '<listItem indent="2" type="bulleted">e</listItem>' +
  279. '<listItem indent="1" type="bulleted">f</listItem>' +
  280. '<listItem indent="0" type="bulleted">g</listItem>'
  281. );
  282. } );
  283. it( 'should fix list type when item is outdented #1', () => {
  284. setData(
  285. doc,
  286. '<listItem indent="0" type="bulleted">a</listItem>' +
  287. '<listItem indent="1" type="bulleted">b</listItem>' +
  288. '<listItem indent="2" type="numbered">[]c</listItem>'
  289. );
  290. command.execute();
  291. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  292. '<listItem indent="0" type="bulleted">a</listItem>' +
  293. '<listItem indent="1" type="bulleted">b</listItem>' +
  294. '<listItem indent="1" type="bulleted">c</listItem>'
  295. );
  296. } );
  297. // Look at next siblings if, after outdenting, a list item is a first item in it's list (list item "c").
  298. it( 'should fix list type when item is outdented #2', () => {
  299. setData(
  300. doc,
  301. '<listItem indent="0" type="bulleted">a</listItem>' +
  302. '<listItem indent="1" type="numbered">[]b</listItem>' +
  303. '<listItem indent="2" type="bulleted">c</listItem>' +
  304. '<listItem indent="1" type="numbered">d</listItem>'
  305. );
  306. command.execute();
  307. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  308. '<listItem indent="0" type="bulleted">a</listItem>' +
  309. '<listItem indent="0" type="bulleted">b</listItem>' +
  310. '<listItem indent="1" type="numbered">c</listItem>' +
  311. '<listItem indent="1" type="numbered">d</listItem>'
  312. );
  313. } );
  314. // Reported in #53.
  315. it( 'should fix list type when item is outdented #3', () => {
  316. setData(
  317. doc,
  318. '<listItem indent="0" type="bulleted">a</listItem>' +
  319. '<listItem indent="1" type="numbered">[b</listItem>' +
  320. '<listItem indent="1" type="numbered">c</listItem>' +
  321. '<listItem indent="1" type="numbered">d]</listItem>'
  322. );
  323. command.execute();
  324. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  325. '<listItem indent="0" type="bulleted">a</listItem>' +
  326. '<listItem indent="0" type="bulleted">b</listItem>' +
  327. '<listItem indent="0" type="bulleted">c</listItem>' +
  328. '<listItem indent="0" type="bulleted">d</listItem>'
  329. );
  330. } );
  331. it( 'should fix list type when item is outdented to top level (if needed)', () => {
  332. setData(
  333. doc,
  334. '<listItem indent="0" type="bulleted">a</listItem>' +
  335. '<listItem indent="1" type="numbered">[]b</listItem>' +
  336. '<listItem indent="0" type="numbered">c</listItem>'
  337. );
  338. command.execute();
  339. // Another possible behaviour would be that "b" list item becomes first list item of a top level
  340. // numbered list (so it does not change it's type) but it seems less correct from UX standpoint.
  341. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  342. '<listItem indent="0" type="bulleted">a</listItem>' +
  343. '<listItem indent="0" type="bulleted">b</listItem>' +
  344. '<listItem indent="0" type="numbered">c</listItem>'
  345. );
  346. } );
  347. it( 'should not fix nested list items\' type when not needed', () => {
  348. // There was a bug that the nested sub-list changed it's type because for a while, it was on same indent
  349. // level as the originally outdented element.
  350. setData(
  351. doc,
  352. '<listItem indent="0" type="bulleted">a</listItem>' +
  353. '<listItem indent="1" type="numbered">b</listItem>' +
  354. '<listItem indent="1" type="numbered">[]c</listItem>' +
  355. '<listItem indent="2" type="bulleted">d</listItem>' +
  356. '<listItem indent="2" type="bulleted">e</listItem>'
  357. );
  358. command.execute();
  359. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  360. '<listItem indent="0" type="bulleted">a</listItem>' +
  361. '<listItem indent="1" type="numbered">b</listItem>' +
  362. '<listItem indent="0" type="bulleted">c</listItem>' +
  363. '<listItem indent="1" type="bulleted">d</listItem>' +
  364. '<listItem indent="1" type="bulleted">e</listItem>'
  365. );
  366. } );
  367. } );
  368. } );
  369. } );