8
0

indentcodeblockcommand.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import CodeBlockEditing from '../src/codeblockediting';
  6. import IndentCodeBlockCommand from '../src/indentcodeblockcommand';
  7. import AlignmentEditing from '@ckeditor/ckeditor5-alignment/src/alignmentediting';
  8. import BoldEditing from '@ckeditor/ckeditor5-basic-styles/src/bold/boldediting';
  9. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  10. import BlockQuoteEditing from '@ckeditor/ckeditor5-block-quote/src/blockquoteediting';
  11. import ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor';
  12. import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  13. describe.only( 'IndentCodeBlockCommand', () => {
  14. let editor, model, indentCommand, outdentCommand;
  15. beforeEach( () => {
  16. return ModelTestEditor
  17. .create( {
  18. plugins: [ CodeBlockEditing, Paragraph, BlockQuoteEditing, AlignmentEditing, BoldEditing ]
  19. } )
  20. .then( newEditor => {
  21. editor = newEditor;
  22. model = editor.model;
  23. indentCommand = new IndentCodeBlockCommand( editor, 'forward' );
  24. outdentCommand = new IndentCodeBlockCommand( editor, 'backward' );
  25. } );
  26. } );
  27. afterEach( () => {
  28. return editor.destroy();
  29. } );
  30. describe( 'Forward (indent) command', () => {
  31. describe( '#isEnabled', () => {
  32. it( 'should be true when the first selected block is a codeBlock #1', () => {
  33. setModelData( model, '<codeBlock language="foo">f[]oo</codeBlock>' );
  34. expect( indentCommand.isEnabled ).to.be.true;
  35. } );
  36. it( 'should be true when the first selected block is a codeBlock #2', () => {
  37. setModelData( model, '<codeBlock language="foo">f[oo</codeBlock><paragraph>ba]r</paragraph>' );
  38. expect( indentCommand.isEnabled ).to.be.true;
  39. } );
  40. it( 'should be false when there is no code block in the selection', () => {
  41. setModelData( model, '<paragraph>foo[]</paragraph>' );
  42. expect( indentCommand.isEnabled ).to.be.false;
  43. } );
  44. it( 'should be false when the selection is not anchored in the code block', () => {
  45. setModelData( model, '<paragraph>f[oo</paragraph><codeBlock language="foo">bar</codeBlock><paragraph>ba]z</paragraph>' );
  46. expect( indentCommand.isEnabled ).to.be.false;
  47. } );
  48. describe( 'config.codeBlock.indentSequence', () => {
  49. it( 'should disable the command when the config is not set', () => {
  50. return ModelTestEditor
  51. .create( {
  52. plugins: [ CodeBlockEditing, Paragraph, BlockQuoteEditing, AlignmentEditing, BoldEditing ],
  53. codeBlock: {
  54. indentSequence: false
  55. }
  56. } )
  57. .then( newEditor => {
  58. const editor = newEditor;
  59. const model = editor.model;
  60. const indentCommand = new IndentCodeBlockCommand( editor, 'forward' );
  61. setModelData( model, '<codeBlock language="foo">[]foo</codeBlock>' );
  62. expect( indentCommand.isEnabled ).to.be.false;
  63. return editor.destroy();
  64. } );
  65. } );
  66. } );
  67. } );
  68. describe( 'execute()', () => {
  69. it( 'should indent when a selection is collapsed in an empty code block', () => {
  70. setModelData( model, '<codeBlock language="foo">[]</codeBlock>' );
  71. indentCommand.execute();
  72. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo"> []</codeBlock>' );
  73. } );
  74. it( 'should indent when a selection is collapsed', () => {
  75. setModelData( model, '<codeBlock language="foo">f[]oo</codeBlock>' );
  76. indentCommand.execute();
  77. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo">f []oo</codeBlock>' );
  78. } );
  79. it( 'should indent a whole line when a selection is expanded', () => {
  80. setModelData( model, '<codeBlock language="foo">f[o]o</codeBlock>' );
  81. indentCommand.execute();
  82. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo"> f[o]o</codeBlock>' );
  83. } );
  84. it( 'should indent multiple lines when a selection is expanded', () => {
  85. setModelData( model, '<codeBlock language="foo">f[oo<softBreak></softBreak>b]ar</codeBlock>' );
  86. indentCommand.execute();
  87. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo"> f[oo<softBreak></softBreak> b]ar</codeBlock>' );
  88. } );
  89. it( 'should append the indentation to the line\'s leading white spaces (#1)', () => {
  90. setModelData( model, '<codeBlock language="foo">[]foo</codeBlock>' );
  91. // <codeBlock language="foo"> []foo</codeBlock>
  92. model.change( writer => {
  93. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  94. } );
  95. indentCommand.execute();
  96. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo"> []foo</codeBlock>' );
  97. } );
  98. it( 'should append the indentation to the line\'s leading white spaces (#2)', () => {
  99. setModelData( model, '<codeBlock language="foo">f[oo<softBreak></softBreak>b]ar</codeBlock>' );
  100. // <codeBlock language="foo"> f[oo<softBreak></softBreak> b]ar</codeBlock>
  101. model.change( writer => {
  102. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 4 );
  103. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  104. } );
  105. indentCommand.execute();
  106. expect( getModelData( model ) ).to.equal(
  107. '<codeBlock language="foo"> f[oo<softBreak></softBreak> b]ar</codeBlock>' );
  108. } );
  109. describe( 'config.codeBlock.indentSequence', () => {
  110. it( 'should be used when indenting', () => {
  111. return ModelTestEditor
  112. .create( {
  113. plugins: [ CodeBlockEditing, Paragraph, BlockQuoteEditing, AlignmentEditing, BoldEditing ],
  114. codeBlock: {
  115. indentSequence: ' '
  116. }
  117. } )
  118. .then( newEditor => {
  119. const editor = newEditor;
  120. const model = editor.model;
  121. const indentCommand = new IndentCodeBlockCommand( editor, 'forward' );
  122. setModelData( model, '<codeBlock language="foo">f[o]o</codeBlock>' );
  123. indentCommand.execute();
  124. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo"> f[o]o</codeBlock>' );
  125. return editor.destroy();
  126. } );
  127. } );
  128. } );
  129. } );
  130. } );
  131. describe( 'Backward (outdent) command', () => {
  132. describe( '#isEnabled', () => {
  133. it( 'should be true when the selection is in a line containing the indent sequence', () => {
  134. setModelData( model, '<codeBlock language="foo">f[]oo</codeBlock>' );
  135. // <codeBlock language="foo"> f[]oo</codeBlock>
  136. model.change( writer => {
  137. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  138. } );
  139. expect( outdentCommand.isEnabled ).to.be.true;
  140. } );
  141. it( 'should be true when any line in the selection contains more than the indent sequence', () => {
  142. setModelData( model, '<codeBlock language="foo">f[oo</codeBlock><paragraph>ba]r</paragraph>' );
  143. // <codeBlock language="foo"> f[oo</codeBlock><paragraph>ba]r</paragraph>
  144. model.change( writer => {
  145. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  146. } );
  147. expect( outdentCommand.isEnabled ).to.be.true;
  148. } );
  149. it( 'should be true when any line in the selection contains the indent sequence', () => {
  150. setModelData( model, '<codeBlock language="foo">f[oo</codeBlock><codeBlock language="foo">ba]r</codeBlock>' );
  151. // <codeBlock language="foo">f[oo</codeBlock><codeBlock language="foo"> ba]r</codeBlock>
  152. model.change( writer => {
  153. writer.insertText( ' ', model.document.getRoot().getChild( 1 ) );
  154. } );
  155. expect( outdentCommand.isEnabled ).to.be.true;
  156. } );
  157. it( 'should be false when the indent sequence is in other element', () => {
  158. setModelData( model, '<paragraph>foo[]</paragraph>' );
  159. // <paragraph> foo[]</paragraph>
  160. model.change( writer => {
  161. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  162. } );
  163. expect( outdentCommand.isEnabled ).to.be.false;
  164. } );
  165. it( 'should be false when there is no indent sequence in the line (#1)', () => {
  166. setModelData( model, '<codeBlock language="foo">f[]oo</codeBlock>' );
  167. expect( outdentCommand.isEnabled ).to.be.false;
  168. } );
  169. it( 'should be false when there is no indent sequence in the line (#2)', () => {
  170. setModelData( model, '<codeBlock language="foo">[]</codeBlock>' );
  171. expect( outdentCommand.isEnabled ).to.be.false;
  172. } );
  173. it( 'should be false when there is no indent sequence in the line (#3)', () => {
  174. setModelData( model, '<codeBlock language="foo">foo[]</codeBlock>' );
  175. expect( outdentCommand.isEnabled ).to.be.false;
  176. } );
  177. it( 'should be false when there is no corrent sequence in the line', () => {
  178. setModelData( model, '<codeBlock language="foo">foo[]</codeBlock>' );
  179. // <codeBlock language="foo"> foo[]</codeBlock>
  180. model.change( writer => {
  181. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  182. } );
  183. expect( outdentCommand.isEnabled ).to.be.false;
  184. } );
  185. it( 'should be false when the sequence is not in leading characters of the line (#1)', () => {
  186. setModelData( model, '<codeBlock language="foo">barfoo[]</codeBlock>' );
  187. // <codeBlock language="foo">bar foo[]</codeBlock>
  188. model.change( writer => {
  189. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 3 );
  190. } );
  191. expect( outdentCommand.isEnabled ).to.be.false;
  192. } );
  193. it( 'should be false when the sequence is not in leading characters of the line (#2)', () => {
  194. setModelData( model, '<codeBlock language="foo">foo[]</codeBlock>' );
  195. // <codeBlock language="foo">foo[]</codeBlock>
  196. model.change( writer => {
  197. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  198. } );
  199. expect( outdentCommand.isEnabled ).to.be.false;
  200. } );
  201. describe( 'config.codeBlock.indentSequence', () => {
  202. it( 'should be respected (#1)', () => {
  203. return ModelTestEditor
  204. .create( {
  205. plugins: [ CodeBlockEditing, Paragraph, BlockQuoteEditing, AlignmentEditing, BoldEditing ],
  206. codeBlock: {
  207. indentSequence: ' '
  208. }
  209. } )
  210. .then( newEditor => {
  211. const editor = newEditor;
  212. const model = editor.model;
  213. const outdentCommand = new IndentCodeBlockCommand( editor, 'backward' );
  214. setModelData( model, '<codeBlock language="foo">foo[]</codeBlock>' );
  215. // <codeBlock language="foo"> foo[]</codeBlock>
  216. model.change( writer => {
  217. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  218. } );
  219. expect( outdentCommand.isEnabled ).to.be.true;
  220. return editor.destroy();
  221. } );
  222. } );
  223. it( 'should be respected (#2)', () => {
  224. return ModelTestEditor
  225. .create( {
  226. plugins: [ CodeBlockEditing, Paragraph, BlockQuoteEditing, AlignmentEditing, BoldEditing ],
  227. codeBlock: {
  228. indentSequence: ' '
  229. }
  230. } )
  231. .then( newEditor => {
  232. const editor = newEditor;
  233. const model = editor.model;
  234. const outdentCommand = new IndentCodeBlockCommand( editor, 'backward' );
  235. setModelData( model, '<codeBlock language="foo"> foo[]</codeBlock>' );
  236. // <codeBlock language="foo"> foo[]</codeBlock>
  237. model.change( writer => {
  238. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  239. } );
  240. expect( outdentCommand.isEnabled ).to.be.false;
  241. return editor.destroy();
  242. } );
  243. } );
  244. it( 'should disable the command when the config is not set', () => {
  245. return ModelTestEditor
  246. .create( {
  247. plugins: [ CodeBlockEditing, Paragraph, BlockQuoteEditing, AlignmentEditing, BoldEditing ],
  248. codeBlock: {
  249. indentSequence: false
  250. }
  251. } )
  252. .then( newEditor => {
  253. const editor = newEditor;
  254. const model = editor.model;
  255. const outdentCommand = new IndentCodeBlockCommand( editor, 'backward' );
  256. setModelData( model, '<codeBlock language="foo">foo[]</codeBlock>' );
  257. // <codeBlock language="foo"> foo[]</codeBlock>
  258. model.change( writer => {
  259. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  260. } );
  261. expect( outdentCommand.isEnabled ).to.be.false;
  262. return editor.destroy();
  263. } );
  264. } );
  265. } );
  266. } );
  267. describe( 'execute()', () => {
  268. it( 'should outdent a single line', () => {
  269. setModelData( model, '<codeBlock language="foo">f[]oo</codeBlock>' );
  270. // <codeBlock language="foo"> f[]oo</codeBlock>
  271. model.change( writer => {
  272. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  273. } );
  274. outdentCommand.execute();
  275. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo">f[]oo</codeBlock>' );
  276. } );
  277. it( 'should outdent only one level in a single line', () => {
  278. setModelData( model, '<codeBlock language="foo">f[]oo</codeBlock>' );
  279. // <codeBlock language="foo"> f[]oo</codeBlock>
  280. model.change( writer => {
  281. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  282. } );
  283. outdentCommand.execute();
  284. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo"> f[]oo</codeBlock>' );
  285. } );
  286. it( 'should outdent multiple lines', () => {
  287. setModelData( model, '<codeBlock language="foo">f[oo<softBreak></softBreak>ba]r</codeBlock>' );
  288. // <codeBlock language="foo"> f[oo<softBreak></softBreak> ba]r</codeBlock>
  289. model.change( writer => {
  290. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 4 );
  291. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  292. } );
  293. outdentCommand.execute();
  294. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo">f[oo<softBreak></softBreak>ba]r</codeBlock>' );
  295. } );
  296. it( 'should outdent only one level across multiple lines', () => {
  297. setModelData( model, '<codeBlock language="foo">f[oo<softBreak></softBreak>ba]r</codeBlock>' );
  298. // <codeBlock language="foo"> f[oo<softBreak></softBreak> ba]r</codeBlock>
  299. model.change( writer => {
  300. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 4 );
  301. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  302. } );
  303. outdentCommand.execute();
  304. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo">f[oo<softBreak></softBreak> ba]r</codeBlock>' );
  305. } );
  306. it( 'should outdent some lines', () => {
  307. setModelData( model, '<codeBlock language="foo">f[oo<softBreak></softBreak>ba]r</codeBlock>' );
  308. // <codeBlock language="foo">f[oo<softBreak></softBreak> ba]r</codeBlock>
  309. model.change( writer => {
  310. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 4 );
  311. } );
  312. outdentCommand.execute();
  313. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo">f[oo<softBreak></softBreak>ba]r</codeBlock>' );
  314. } );
  315. describe( 'config.codeBlock.indentSequence', () => {
  316. it( 'should be respected', () => {
  317. return ModelTestEditor
  318. .create( {
  319. plugins: [ CodeBlockEditing, Paragraph, BlockQuoteEditing, AlignmentEditing, BoldEditing ],
  320. codeBlock: {
  321. indentSequence: ' '
  322. }
  323. } )
  324. .then( newEditor => {
  325. const editor = newEditor;
  326. const model = editor.model;
  327. const outdentCommand = new IndentCodeBlockCommand( editor, 'backward' );
  328. setModelData( model, '<codeBlock language="foo">f[]oo</codeBlock>' );
  329. // <codeBlock language="foo"> f[]oo</codeBlock>
  330. model.change( writer => {
  331. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  332. } );
  333. outdentCommand.execute();
  334. expect( getModelData( model ) ).to.equal( '<codeBlock language="foo">f[]oo</codeBlock>' );
  335. return editor.destroy();
  336. } );
  337. } );
  338. } );
  339. } );
  340. } );
  341. } );