indentcommand.js 10 KB

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