indentcommand.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
  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. // #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. it( 'should be false if selection starts in first list item of top level list with different type than previous list', () => {
  68. setData(
  69. doc,
  70. '<listItem indent="0" type="bulleted">a</listItem>' +
  71. '<listItem indent="0" type="numbered">[]b</listItem>'
  72. );
  73. expect( command.isEnabled ).to.be.false;
  74. } );
  75. it( 'should be false if selection starts in a list item that has bigger indent than it\'s previous sibling', () => {
  76. doc.enqueueChanges( () => {
  77. doc.selection.collapse( root.getChild( 2 ) );
  78. } );
  79. expect( command.isEnabled ).to.be.false;
  80. } );
  81. // Edge case but may happen that some other blocks will also use the indent attribute
  82. // and before we fixed it the command was enabled in such a case.
  83. it( 'should be false if selection starts in a paragraph with indent attribute', () => {
  84. doc.schema.allow( { name: 'paragraph', attributes: [ 'indent' ], inside: '$root' } );
  85. setData( doc, '<listItem indent="0">a</listItem><paragraph indent="0">b[]</paragraph>' );
  86. expect( command.isEnabled ).to.be.false;
  87. } );
  88. } );
  89. describe( '_doExecute', () => {
  90. it( 'should increment indent attribute by 1', () => {
  91. doc.enqueueChanges( () => {
  92. doc.selection.collapse( root.getChild( 5 ) );
  93. } );
  94. command._doExecute();
  95. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  96. '<listItem indent="0" type="bulleted">a</listItem>' +
  97. '<listItem indent="0" type="bulleted">b</listItem>' +
  98. '<listItem indent="1" type="bulleted">c</listItem>' +
  99. '<listItem indent="2" type="bulleted">d</listItem>' +
  100. '<listItem indent="2" type="bulleted">e</listItem>' +
  101. '<listItem indent="2" type="bulleted">f</listItem>' +
  102. '<listItem indent="0" type="bulleted">g</listItem>'
  103. );
  104. } );
  105. it( 'should increment indent of all sub-items of indented item', () => {
  106. doc.enqueueChanges( () => {
  107. doc.selection.collapse( root.getChild( 1 ) );
  108. } );
  109. command._doExecute();
  110. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  111. '<listItem indent="0" type="bulleted">a</listItem>' +
  112. '<listItem indent="1" type="bulleted">b</listItem>' +
  113. '<listItem indent="2" type="bulleted">c</listItem>' +
  114. '<listItem indent="3" type="bulleted">d</listItem>' +
  115. '<listItem indent="3" type="bulleted">e</listItem>' +
  116. '<listItem indent="2" type="bulleted">f</listItem>' +
  117. '<listItem indent="0" type="bulleted">g</listItem>'
  118. );
  119. } );
  120. it( 'should increment indent of all selected item when multiple items are selected', () => {
  121. doc.enqueueChanges( () => {
  122. doc.selection.setRanges( [ new Range(
  123. new Position( root.getChild( 1 ), [ 0 ] ),
  124. new Position( root.getChild( 3 ), [ 0 ] )
  125. ) ] );
  126. } );
  127. command._doExecute();
  128. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  129. '<listItem indent="0" type="bulleted">a</listItem>' +
  130. '<listItem indent="1" type="bulleted">b</listItem>' +
  131. '<listItem indent="2" type="bulleted">c</listItem>' +
  132. '<listItem indent="3" type="bulleted">d</listItem>' +
  133. '<listItem indent="2" type="bulleted">e</listItem>' +
  134. '<listItem indent="1" type="bulleted">f</listItem>' +
  135. '<listItem indent="0" type="bulleted">g</listItem>'
  136. );
  137. } );
  138. it( 'should fix list type when item is intended #1', () => {
  139. setData(
  140. doc,
  141. '<listItem indent="0" type="bulleted">a</listItem>' +
  142. '<listItem indent="1" type="bulleted">b</listItem>' +
  143. '<listItem indent="2" type="numbered">c</listItem>' +
  144. '<listItem indent="1" type="bulleted">[]d</listItem>'
  145. );
  146. command._doExecute();
  147. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  148. '<listItem indent="0" type="bulleted">a</listItem>' +
  149. '<listItem indent="1" type="bulleted">b</listItem>' +
  150. '<listItem indent="2" type="numbered">c</listItem>' +
  151. '<listItem indent="2" type="numbered">d</listItem>'
  152. );
  153. } );
  154. // Not only boundary list items has to be fixed, but also items in the middle of selection.
  155. it( 'should fix list type when item is intended #2', () => {
  156. setData(
  157. doc,
  158. '<listItem indent="0" type="bulleted">a</listItem>' +
  159. '<listItem indent="1" type="numbered">b</listItem>' +
  160. '<listItem indent="1" type="numbered">[c</listItem>' +
  161. '<listItem indent="0" type="bulleted">d</listItem>' +
  162. '<listItem indent="1" type="numbered">e]</listItem>' +
  163. '<listItem indent="0" type="bulleted">f</listItem>'
  164. );
  165. command._doExecute();
  166. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  167. '<listItem indent="0" type="bulleted">a</listItem>' +
  168. '<listItem indent="1" type="numbered">b</listItem>' +
  169. '<listItem indent="2" type="numbered">c</listItem>' +
  170. '<listItem indent="1" type="numbered">d</listItem>' +
  171. '<listItem indent="2" type="numbered">e</listItem>' +
  172. '<listItem indent="0" type="bulleted">f</listItem>'
  173. );
  174. } );
  175. } );
  176. } );
  177. describe( 'IndentCommand - backward (outdent)', () => {
  178. let command;
  179. beforeEach( () => {
  180. command = new IndentCommand( editor, 'backward' );
  181. } );
  182. afterEach( () => {
  183. command.destroy();
  184. } );
  185. describe( 'isEnabled', () => {
  186. it( 'should be true if selection starts in list item', () => {
  187. doc.enqueueChanges( () => {
  188. doc.selection.collapse( root.getChild( 5 ) );
  189. } );
  190. expect( command.isEnabled ).to.be.true;
  191. } );
  192. it( 'should be true if selection starts in first list item', () => {
  193. // This is in contrary to forward indent command.
  194. doc.enqueueChanges( () => {
  195. doc.selection.collapse( root.getChild( 0 ) );
  196. } );
  197. expect( command.isEnabled ).to.be.true;
  198. } );
  199. it( 'should be true if selection starts in a list item that has bigger indent than it\'s previous sibling', () => {
  200. // This is in contrary to forward indent command.
  201. doc.enqueueChanges( () => {
  202. doc.selection.collapse( root.getChild( 2 ) );
  203. } );
  204. expect( command.isEnabled ).to.be.true;
  205. } );
  206. } );
  207. describe( '_doExecute', () => {
  208. it( 'should decrement indent attribute by 1 (if it is bigger than 0)', () => {
  209. doc.enqueueChanges( () => {
  210. doc.selection.collapse( root.getChild( 5 ) );
  211. } );
  212. command._doExecute();
  213. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  214. '<listItem indent="0" type="bulleted">a</listItem>' +
  215. '<listItem indent="0" type="bulleted">b</listItem>' +
  216. '<listItem indent="1" type="bulleted">c</listItem>' +
  217. '<listItem indent="2" type="bulleted">d</listItem>' +
  218. '<listItem indent="2" type="bulleted">e</listItem>' +
  219. '<listItem indent="0" type="bulleted">f</listItem>' +
  220. '<listItem indent="0" type="bulleted">g</listItem>'
  221. );
  222. } );
  223. it( 'should rename listItem to paragraph (if indent is equal to 0)', () => {
  224. doc.enqueueChanges( () => {
  225. doc.selection.collapse( root.getChild( 0 ) );
  226. } );
  227. command._doExecute();
  228. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  229. '<paragraph indent="0" type="bulleted">a</paragraph>' +
  230. '<listItem indent="0" type="bulleted">b</listItem>' +
  231. '<listItem indent="1" type="bulleted">c</listItem>' +
  232. '<listItem indent="2" type="bulleted">d</listItem>' +
  233. '<listItem indent="2" type="bulleted">e</listItem>' +
  234. '<listItem indent="1" type="bulleted">f</listItem>' +
  235. '<listItem indent="0" type="bulleted">g</listItem>'
  236. );
  237. } );
  238. it( 'should decrement indent of all sub-items of outdented item', () => {
  239. doc.enqueueChanges( () => {
  240. doc.selection.collapse( root.getChild( 1 ) );
  241. } );
  242. command._doExecute();
  243. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  244. '<listItem indent="0" type="bulleted">a</listItem>' +
  245. '<paragraph indent="0" type="bulleted">b</paragraph>' +
  246. '<listItem indent="0" type="bulleted">c</listItem>' +
  247. '<listItem indent="1" type="bulleted">d</listItem>' +
  248. '<listItem indent="1" type="bulleted">e</listItem>' +
  249. '<listItem indent="0" type="bulleted">f</listItem>' +
  250. '<listItem indent="0" type="bulleted">g</listItem>'
  251. );
  252. } );
  253. it( 'should outdent all selected item when multiple items are selected', () => {
  254. doc.enqueueChanges( () => {
  255. doc.selection.setRanges( [ new Range(
  256. new Position( root.getChild( 1 ), [ 0 ] ),
  257. new Position( root.getChild( 3 ), [ 0 ] )
  258. ) ] );
  259. } );
  260. command._doExecute();
  261. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  262. '<listItem indent="0" type="bulleted">a</listItem>' +
  263. '<paragraph indent="0" type="bulleted">b</paragraph>' +
  264. '<listItem indent="0" type="bulleted">c</listItem>' +
  265. '<listItem indent="1" type="bulleted">d</listItem>' +
  266. '<listItem indent="2" type="bulleted">e</listItem>' +
  267. '<listItem indent="1" type="bulleted">f</listItem>' +
  268. '<listItem indent="0" type="bulleted">g</listItem>'
  269. );
  270. } );
  271. it( 'should fix list type when item is outdented #1', () => {
  272. setData(
  273. doc,
  274. '<listItem indent="0" type="bulleted">a</listItem>' +
  275. '<listItem indent="1" type="bulleted">b</listItem>' +
  276. '<listItem indent="2" type="numbered">[]c</listItem>'
  277. );
  278. command._doExecute();
  279. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  280. '<listItem indent="0" type="bulleted">a</listItem>' +
  281. '<listItem indent="1" type="bulleted">b</listItem>' +
  282. '<listItem indent="1" type="bulleted">c</listItem>'
  283. );
  284. } );
  285. // Look at next siblings if, after outdenting, a list item is a first item in it's list (list item "c").
  286. it( 'should fix list type when item is outdented #2', () => {
  287. setData(
  288. doc,
  289. '<listItem indent="0" type="bulleted">a</listItem>' +
  290. '<listItem indent="1" type="numbered">[]b</listItem>' +
  291. '<listItem indent="2" type="bulleted">c</listItem>' +
  292. '<listItem indent="1" type="numbered">d</listItem>'
  293. );
  294. command._doExecute();
  295. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  296. '<listItem indent="0" type="bulleted">a</listItem>' +
  297. '<listItem indent="0" type="bulleted">b</listItem>' +
  298. '<listItem indent="1" type="numbered">c</listItem>' +
  299. '<listItem indent="1" type="numbered">d</listItem>'
  300. );
  301. } );
  302. it( 'should fix list type when item is outdented to top level (if needed)', () => {
  303. setData(
  304. doc,
  305. '<listItem indent="0" type="bulleted">a</listItem>' +
  306. '<listItem indent="1" type="numbered">[]b</listItem>' +
  307. '<listItem indent="0" type="numbered">c</listItem>'
  308. );
  309. command._doExecute();
  310. // Another possible behaviour would be that "b" list item becomes first list item of a top level
  311. // numbered list (so it does not change it's type) but it seems less correct from UX standpoint.
  312. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  313. '<listItem indent="0" type="bulleted">a</listItem>' +
  314. '<listItem indent="0" type="bulleted">b</listItem>' +
  315. '<listItem indent="0" type="numbered">c</listItem>'
  316. );
  317. } );
  318. it( 'should not fix nested list items\' type when not needed', () => {
  319. // There was a bug that the nested sub-list changed it's type because for a while, it was on same indent
  320. // level as the originally outdented element.
  321. setData(
  322. doc,
  323. '<listItem indent="0" type="bulleted">a</listItem>' +
  324. '<listItem indent="1" type="numbered">b</listItem>' +
  325. '<listItem indent="1" type="numbered">[]c</listItem>' +
  326. '<listItem indent="2" type="bulleted">d</listItem>' +
  327. '<listItem indent="2" type="bulleted">e</listItem>'
  328. );
  329. command._doExecute();
  330. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  331. '<listItem indent="0" type="bulleted">a</listItem>' +
  332. '<listItem indent="1" type="numbered">b</listItem>' +
  333. '<listItem indent="0" type="bulleted">c</listItem>' +
  334. '<listItem indent="1" type="bulleted">d</listItem>' +
  335. '<listItem indent="1" type="bulleted">e</listItem>'
  336. );
  337. } );
  338. } );
  339. } );
  340. } );