indentcommand.js 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  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. } );
  107. } );
  108. describe( 'IndentCommand - backward (outdent)', () => {
  109. let command;
  110. beforeEach( () => {
  111. command = new IndentCommand( editor, 'backward' );
  112. } );
  113. afterEach( () => {
  114. command.destroy();
  115. } );
  116. describe( 'isEnabled', () => {
  117. it( 'should be true if selection starts in list item', () => {
  118. doc.selection.collapse( root.getChild( 5 ) );
  119. expect( command.isEnabled ).to.be.true;
  120. } );
  121. it( 'should be true if selection starts in first list item', () => {
  122. // This is in contrary to forward indent command.
  123. doc.selection.collapse( root.getChild( 0 ) );
  124. expect( command.isEnabled ).to.be.true;
  125. } );
  126. it( 'should be true if selection starts in a list item that has bigger indent than it\'s previous sibling', () => {
  127. // This is in contrary to forward indent command.
  128. doc.selection.collapse( root.getChild( 2 ) );
  129. expect( command.isEnabled ).to.be.true;
  130. } );
  131. } );
  132. describe( '_doExecute', () => {
  133. it( 'should decrement indent attribute by 1 (if it is bigger than 0)', () => {
  134. doc.selection.collapse( root.getChild( 5 ) );
  135. command._doExecute();
  136. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  137. '<listItem indent="0" type="bulleted">a</listItem>' +
  138. '<listItem indent="0" type="bulleted">b</listItem>' +
  139. '<listItem indent="1" type="bulleted">c</listItem>' +
  140. '<listItem indent="2" type="bulleted">d</listItem>' +
  141. '<listItem indent="2" type="bulleted">e</listItem>' +
  142. '<listItem indent="0" type="bulleted">f</listItem>' +
  143. '<listItem indent="0" type="bulleted">g</listItem>'
  144. );
  145. } );
  146. it( 'should rename listItem to paragraph (if indent is equal to 0)', () => {
  147. doc.selection.collapse( root.getChild( 0 ) );
  148. command._doExecute();
  149. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  150. '<paragraph indent="0" type="bulleted">a</paragraph>' +
  151. '<listItem indent="0" type="bulleted">b</listItem>' +
  152. '<listItem indent="1" type="bulleted">c</listItem>' +
  153. '<listItem indent="2" type="bulleted">d</listItem>' +
  154. '<listItem indent="2" type="bulleted">e</listItem>' +
  155. '<listItem indent="1" type="bulleted">f</listItem>' +
  156. '<listItem indent="0" type="bulleted">g</listItem>'
  157. );
  158. } );
  159. it( 'should decrement indent of all sub-items of outdented item', () => {
  160. doc.selection.collapse( root.getChild( 1 ) );
  161. command._doExecute();
  162. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  163. '<listItem indent="0" type="bulleted">a</listItem>' +
  164. '<paragraph indent="0" type="bulleted">b</paragraph>' +
  165. '<listItem indent="0" type="bulleted">c</listItem>' +
  166. '<listItem indent="1" type="bulleted">d</listItem>' +
  167. '<listItem indent="1" type="bulleted">e</listItem>' +
  168. '<listItem indent="0" type="bulleted">f</listItem>' +
  169. '<listItem indent="0" type="bulleted">g</listItem>'
  170. );
  171. } );
  172. it( 'should outdent all selected item when multiple items are selected', () => {
  173. doc.selection.setRanges( [ new Range(
  174. new Position( root.getChild( 1 ), [ 0 ] ),
  175. new Position( root.getChild( 3 ), [ 0 ] )
  176. ) ] );
  177. command._doExecute();
  178. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  179. '<listItem indent="0" type="bulleted">a</listItem>' +
  180. '<paragraph indent="0" type="bulleted">b</paragraph>' +
  181. '<listItem indent="0" type="bulleted">c</listItem>' +
  182. '<listItem indent="1" type="bulleted">d</listItem>' +
  183. '<listItem indent="2" type="bulleted">e</listItem>' +
  184. '<listItem indent="1" type="bulleted">f</listItem>' +
  185. '<listItem indent="0" type="bulleted">g</listItem>'
  186. );
  187. } );
  188. it( 'should fix list type if item is outdented', () => {
  189. setData(
  190. doc,
  191. '<listItem indent="0" type="bulleted">a</listItem>' +
  192. '<listItem indent="1" type="bulleted">b</listItem>' +
  193. '<listItem indent="2" type="numbered">c</listItem>'
  194. );
  195. doc.selection.setRanges( [ new Range(
  196. new Position( root.getChild( 2 ), [ 0 ] )
  197. ) ] );
  198. command._doExecute();
  199. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  200. '<listItem indent="0" type="bulleted">a</listItem>' +
  201. '<listItem indent="1" type="bulleted">b</listItem>' +
  202. '<listItem indent="1" type="bulleted">c</listItem>'
  203. );
  204. } );
  205. it( 'should not fix list type if item is outdented to top level', () => {
  206. setData(
  207. doc,
  208. '<listItem indent="0" type="bulleted">a</listItem>' +
  209. '<listItem indent="1" type="numbered">b</listItem>'
  210. );
  211. doc.selection.setRanges( [ new Range(
  212. new Position( root.getChild( 1 ), [ 0 ] )
  213. ) ] );
  214. command._doExecute();
  215. expect( getData( doc, { withoutSelection: true } ) ).to.equal(
  216. '<listItem indent="0" type="bulleted">a</listItem>' +
  217. '<listItem indent="0" type="numbered">b</listItem>'
  218. );
  219. } );
  220. } );
  221. } );
  222. } );