8
0

indentcommand.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  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. it( 'should be false if selection starts in first list item of top level list with different type than previous list', () => {
  56. setData(
  57. doc,
  58. '<listItem indent="0" type="bulleted">a</listItem>' +
  59. '<listItem indent="0" type="numbered">[]b</listItem>'
  60. );
  61. expect( command.isEnabled ).to.be.false;
  62. } );
  63. it( 'should be false if selection starts in a list item that has bigger indent than it\'s previous sibling', () => {
  64. doc.enqueueChanges( () => {
  65. doc.selection.collapse( root.getChild( 2 ) );
  66. } );
  67. expect( command.isEnabled ).to.be.false;
  68. } );
  69. // Edge case but may happen that some other blocks will also use the indent attribute
  70. // and before we fixed it the command was enabled in such a case.
  71. it( 'should be false if selection starts in a paragraph with indent attribute', () => {
  72. doc.schema.allow( { name: 'paragraph', attributes: [ 'indent' ], inside: '$root' } );
  73. setData( doc, '<listItem indent="0">a</listItem><paragraph indent="0">b[]</paragraph>' );
  74. expect( command.isEnabled ).to.be.false;
  75. } );
  76. } );
  77. describe( '_doExecute', () => {
  78. it( 'should increment indent attribute by 1', () => {
  79. doc.enqueueChanges( () => {
  80. doc.selection.collapse( root.getChild( 5 ) );
  81. } );
  82. command._doExecute();
  83. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  84. '<listItem indent="0" type="bulleted">a</listItem>' +
  85. '<listItem indent="0" type="bulleted">b</listItem>' +
  86. '<listItem indent="1" type="bulleted">c</listItem>' +
  87. '<listItem indent="2" type="bulleted">d</listItem>' +
  88. '<listItem indent="2" type="bulleted">e</listItem>' +
  89. '<listItem indent="2" type="bulleted">f</listItem>' +
  90. '<listItem indent="0" type="bulleted">g</listItem>'
  91. );
  92. } );
  93. it( 'should increment indent of all sub-items of indented item', () => {
  94. doc.enqueueChanges( () => {
  95. doc.selection.collapse( root.getChild( 1 ) );
  96. } );
  97. command._doExecute();
  98. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  99. '<listItem indent="0" type="bulleted">a</listItem>' +
  100. '<listItem indent="1" type="bulleted">b</listItem>' +
  101. '<listItem indent="2" type="bulleted">c</listItem>' +
  102. '<listItem indent="3" type="bulleted">d</listItem>' +
  103. '<listItem indent="3" type="bulleted">e</listItem>' +
  104. '<listItem indent="2" type="bulleted">f</listItem>' +
  105. '<listItem indent="0" type="bulleted">g</listItem>'
  106. );
  107. } );
  108. it( 'should increment indent of all selected item when multiple items are selected', () => {
  109. doc.enqueueChanges( () => {
  110. doc.selection.setRanges( [ new Range(
  111. new Position( root.getChild( 1 ), [ 0 ] ),
  112. new Position( root.getChild( 3 ), [ 0 ] )
  113. ) ] );
  114. } );
  115. command._doExecute();
  116. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  117. '<listItem indent="0" type="bulleted">a</listItem>' +
  118. '<listItem indent="1" type="bulleted">b</listItem>' +
  119. '<listItem indent="2" type="bulleted">c</listItem>' +
  120. '<listItem indent="3" type="bulleted">d</listItem>' +
  121. '<listItem indent="2" type="bulleted">e</listItem>' +
  122. '<listItem indent="1" type="bulleted">f</listItem>' +
  123. '<listItem indent="0" type="bulleted">g</listItem>'
  124. );
  125. } );
  126. it( 'should fix list type when item is intended (if needed)', () => {
  127. setData(
  128. doc,
  129. '<listItem indent="0" type="bulleted">a</listItem>' +
  130. '<listItem indent="1" type="bulleted">b</listItem>' +
  131. '<listItem indent="2" type="numbered">c</listItem>' +
  132. '<listItem indent="1" type="bulleted">[]d</listItem>'
  133. );
  134. command._doExecute();
  135. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  136. '<listItem indent="0" type="bulleted">a</listItem>' +
  137. '<listItem indent="1" type="bulleted">b</listItem>' +
  138. '<listItem indent="2" type="numbered">c</listItem>' +
  139. '<listItem indent="2" type="numbered">d</listItem>'
  140. );
  141. } );
  142. } );
  143. } );
  144. describe( 'IndentCommand - backward (outdent)', () => {
  145. let command;
  146. beforeEach( () => {
  147. command = new IndentCommand( editor, 'backward' );
  148. } );
  149. afterEach( () => {
  150. command.destroy();
  151. } );
  152. describe( 'isEnabled', () => {
  153. it( 'should be true if selection starts in list item', () => {
  154. doc.enqueueChanges( () => {
  155. doc.selection.collapse( root.getChild( 5 ) );
  156. } );
  157. expect( command.isEnabled ).to.be.true;
  158. } );
  159. it( 'should be true if selection starts in first list item', () => {
  160. // This is in contrary to forward indent command.
  161. doc.enqueueChanges( () => {
  162. doc.selection.collapse( root.getChild( 0 ) );
  163. } );
  164. expect( command.isEnabled ).to.be.true;
  165. } );
  166. it( 'should be true if selection starts in a list item that has bigger indent than it\'s previous sibling', () => {
  167. // This is in contrary to forward indent command.
  168. doc.enqueueChanges( () => {
  169. doc.selection.collapse( root.getChild( 2 ) );
  170. } );
  171. expect( command.isEnabled ).to.be.true;
  172. } );
  173. } );
  174. describe( '_doExecute', () => {
  175. it( 'should decrement indent attribute by 1 (if it is bigger than 0)', () => {
  176. doc.enqueueChanges( () => {
  177. doc.selection.collapse( root.getChild( 5 ) );
  178. } );
  179. command._doExecute();
  180. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  181. '<listItem indent="0" type="bulleted">a</listItem>' +
  182. '<listItem indent="0" type="bulleted">b</listItem>' +
  183. '<listItem indent="1" type="bulleted">c</listItem>' +
  184. '<listItem indent="2" type="bulleted">d</listItem>' +
  185. '<listItem indent="2" type="bulleted">e</listItem>' +
  186. '<listItem indent="0" type="bulleted">f</listItem>' +
  187. '<listItem indent="0" type="bulleted">g</listItem>'
  188. );
  189. } );
  190. it( 'should rename listItem to paragraph (if indent is equal to 0)', () => {
  191. doc.enqueueChanges( () => {
  192. doc.selection.collapse( root.getChild( 0 ) );
  193. } );
  194. command._doExecute();
  195. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  196. '<paragraph indent="0" type="bulleted">a</paragraph>' +
  197. '<listItem indent="0" type="bulleted">b</listItem>' +
  198. '<listItem indent="1" type="bulleted">c</listItem>' +
  199. '<listItem indent="2" type="bulleted">d</listItem>' +
  200. '<listItem indent="2" type="bulleted">e</listItem>' +
  201. '<listItem indent="1" type="bulleted">f</listItem>' +
  202. '<listItem indent="0" type="bulleted">g</listItem>'
  203. );
  204. } );
  205. it( 'should decrement indent of all sub-items of outdented item', () => {
  206. doc.enqueueChanges( () => {
  207. doc.selection.collapse( root.getChild( 1 ) );
  208. } );
  209. command._doExecute();
  210. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  211. '<listItem indent="0" type="bulleted">a</listItem>' +
  212. '<paragraph indent="0" type="bulleted">b</paragraph>' +
  213. '<listItem indent="0" type="bulleted">c</listItem>' +
  214. '<listItem indent="1" type="bulleted">d</listItem>' +
  215. '<listItem indent="1" type="bulleted">e</listItem>' +
  216. '<listItem indent="0" type="bulleted">f</listItem>' +
  217. '<listItem indent="0" type="bulleted">g</listItem>'
  218. );
  219. } );
  220. it( 'should outdent all selected item when multiple items are selected', () => {
  221. doc.enqueueChanges( () => {
  222. doc.selection.setRanges( [ new Range(
  223. new Position( root.getChild( 1 ), [ 0 ] ),
  224. new Position( root.getChild( 3 ), [ 0 ] )
  225. ) ] );
  226. } );
  227. command._doExecute();
  228. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  229. '<listItem indent="0" type="bulleted">a</listItem>' +
  230. '<paragraph indent="0" type="bulleted">b</paragraph>' +
  231. '<listItem indent="0" type="bulleted">c</listItem>' +
  232. '<listItem indent="1" 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 fix list type when item is outdented (if needed)', () => {
  239. setData(
  240. doc,
  241. '<listItem indent="0" type="bulleted">a</listItem>' +
  242. '<listItem indent="1" type="bulleted">b</listItem>' +
  243. '<listItem indent="2" type="numbered">[]c</listItem>'
  244. );
  245. command._doExecute();
  246. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  247. '<listItem indent="0" type="bulleted">a</listItem>' +
  248. '<listItem indent="1" type="bulleted">b</listItem>' +
  249. '<listItem indent="1" type="bulleted">c</listItem>'
  250. );
  251. } );
  252. it( 'should fix list type when item is outdented to top level (if needed)', () => {
  253. setData(
  254. doc,
  255. '<listItem indent="0" type="bulleted">a</listItem>' +
  256. '<listItem indent="1" type="numbered">[]b</listItem>' +
  257. '<listItem indent="0" type="numbered">c</listItem>'
  258. );
  259. command._doExecute();
  260. // Another possible behaviour would be that "b" list item becomes first list item of a top level
  261. // numbered list (so it does not change it's type) but it seems less correct from UX standpoint.
  262. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  263. '<listItem indent="0" type="bulleted">a</listItem>' +
  264. '<listItem indent="0" type="bulleted">b</listItem>' +
  265. '<listItem indent="0" type="numbered">c</listItem>'
  266. );
  267. } );
  268. } );
  269. } );
  270. } );