indentcommand.js 16 KB

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