codeblockediting.js 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056
  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. /* global document */
  6. import CodeBlockEditing from '../src/codeblockediting';
  7. import CodeBlockCommand from '../src/codeblockcommand';
  8. import IndentCodeBlockCommand from '../src/indentcodeblockcommand';
  9. import OutdentCodeBlockCommand from '../src/outdentcodeblockcommand';
  10. import AlignmentEditing from '@ckeditor/ckeditor5-alignment/src/alignmentediting';
  11. import BoldEditing from '@ckeditor/ckeditor5-basic-styles/src/bold/boldediting';
  12. import Enter from '@ckeditor/ckeditor5-enter/src/enter';
  13. import ShiftEnter from '@ckeditor/ckeditor5-enter/src/shiftenter';
  14. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  15. import Undo from '@ckeditor/ckeditor5-undo/src/undo';
  16. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  17. import IndentEditing from '@ckeditor/ckeditor5-indent/src/indentediting';
  18. import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  19. import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
  20. import { getData as getModelData, setData as setModelData, stringify } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  21. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  22. import { _clear as clearTranslations, add as addTranslations } from '@ckeditor/ckeditor5-utils/src/translation-service';
  23. describe( 'CodeBlockEditing', () => {
  24. let editor, element, model, view, viewDoc;
  25. before( () => {
  26. addTranslations( 'en', {
  27. 'Plain text': 'Plain text'
  28. } );
  29. addTranslations( 'pl', {
  30. 'Plain text': 'Zwykły tekst'
  31. } );
  32. } );
  33. after( () => {
  34. clearTranslations();
  35. } );
  36. beforeEach( () => {
  37. element = document.createElement( 'div' );
  38. document.body.appendChild( element );
  39. return ClassicTestEditor
  40. .create( element, {
  41. language: 'en',
  42. plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph, Undo ]
  43. } )
  44. .then( newEditor => {
  45. editor = newEditor;
  46. model = editor.model;
  47. view = editor.editing.view;
  48. viewDoc = view.document;
  49. } );
  50. } );
  51. afterEach( () => {
  52. return editor.destroy().then( () => element.remove() );
  53. } );
  54. it( 'defines plugin name', () => {
  55. expect( CodeBlockEditing.pluginName ).to.equal( 'CodeBlockEditing' );
  56. } );
  57. it( 'defines plugin dependencies', () => {
  58. expect( CodeBlockEditing.requires ).to.have.members( [ ShiftEnter ] );
  59. } );
  60. describe( 'config', () => {
  61. describe( 'languages', () => {
  62. describe( 'default value', () => {
  63. it( 'should be set', () => {
  64. expect( editor.config.get( 'codeBlock.languages' ) ).to.deep.equal( [
  65. { class: 'language-plaintext', label: 'Plain text' },
  66. { class: 'language-c', label: 'C' },
  67. { class: 'language-cs', label: 'C#' },
  68. { class: 'language-cpp', label: 'C++' },
  69. { class: 'language-css', label: 'CSS' },
  70. { class: 'language-diff', label: 'Diff' },
  71. { class: 'language-xml', label: 'HTML/XML' },
  72. { class: 'language-java', label: 'Java' },
  73. { class: 'language-javascript', label: 'JavaScript' },
  74. { class: 'language-php', label: 'PHP' },
  75. { class: 'language-python', label: 'Python' },
  76. { class: 'language-ruby', label: 'Ruby' },
  77. { class: 'language-typescript', label: 'TypeScript' }
  78. ] );
  79. } );
  80. } );
  81. it( 'should be recognized when loading data', () => {
  82. return ClassicTestEditor.create(
  83. '<pre><code class="language-foo">bar</code></pre>' +
  84. '<pre><code class="language-bar">baz</code></pre>',
  85. {
  86. plugins: [ CodeBlockEditing ],
  87. codeBlock: {
  88. languages: [
  89. { class: 'language-foo', label: 'Foo' },
  90. { class: 'language-bar', label: 'Bar' },
  91. ]
  92. }
  93. } )
  94. .then( editor => {
  95. model = editor.model;
  96. expect( getModelData( model ) ).to.equal(
  97. '<codeBlock language="language-foo">[]bar</codeBlock>' +
  98. '<codeBlock language="language-bar">baz</codeBlock>'
  99. );
  100. return editor.destroy();
  101. } );
  102. } );
  103. it( 'should use the first if the code in data has no language', () => {
  104. return ClassicTestEditor
  105. .create( '<pre><code>bar</code></pre>', {
  106. plugins: [ CodeBlockEditing ],
  107. codeBlock: {
  108. languages: [
  109. { class: 'language-foo', label: 'Foo' },
  110. { class: 'language-bar', label: 'Bar' }
  111. ]
  112. }
  113. } )
  114. .then( editor => {
  115. model = editor.model;
  116. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-foo">[]bar</codeBlock>' );
  117. return editor.destroy();
  118. } );
  119. } );
  120. it( 'should use the first if the code in data has an invalid language', () => {
  121. return ClassicTestEditor
  122. .create( '<pre><code class="baz">bar</code></pre>', {
  123. plugins: [ CodeBlockEditing ],
  124. codeBlock: {
  125. languages: [
  126. { class: 'language-foo', label: 'Foo' },
  127. { class: 'language-bar', label: 'Bar' }
  128. ]
  129. }
  130. } )
  131. .then( editor => {
  132. model = editor.model;
  133. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-foo">[]bar</codeBlock>' );
  134. return editor.destroy();
  135. } );
  136. } );
  137. } );
  138. describe( 'indentSequence', () => {
  139. describe( 'default value', () => {
  140. it( 'should be set', () => {
  141. expect( editor.config.get( 'codeBlock.indentSequence' ) ).to.equal( ' ' );
  142. } );
  143. } );
  144. } );
  145. } );
  146. it( 'adds a "codeBlock" command', () => {
  147. expect( editor.commands.get( 'codeBlock' ) ).to.be.instanceOf( CodeBlockCommand );
  148. } );
  149. it( 'adds an "indentCodeBlock" command', () => {
  150. expect( editor.commands.get( 'indentCodeBlock' ) ).to.be.instanceOf( IndentCodeBlockCommand );
  151. } );
  152. it( 'adds an "outdentCodeBlock" command', () => {
  153. expect( editor.commands.get( 'outdentCodeBlock' ) ).to.be.instanceOf( OutdentCodeBlockCommand );
  154. } );
  155. it( 'allows for codeBlock in the $root', () => {
  156. expect( model.schema.checkChild( [ '$root' ], 'codeBlock' ) ).to.be.true;
  157. } );
  158. it( 'disallows for codeBlock in the other codeBlock', () => {
  159. expect( model.schema.checkChild( [ '$root', 'codeBlock' ], 'codeBlock' ) ).to.be.false;
  160. } );
  161. it( 'allows only for $text in codeBlock', () => {
  162. expect( model.schema.checkChild( [ '$root', 'codeBlock' ], '$text' ) ).to.equal( true );
  163. expect( model.schema.checkChild( [ '$root', 'codeBlock' ], '$block' ) ).to.equal( false );
  164. expect( model.schema.checkChild( [ '$root', 'codeBlock' ], 'codeBlock' ) ).to.equal( false );
  165. } );
  166. it( 'disallows all attributes (except "language") for codeBlock', () => {
  167. setModelData( model, '<codeBlock language="language-css">f[o]o</codeBlock>' );
  168. editor.execute( 'alignment', { value: 'right' } );
  169. editor.execute( 'bold' );
  170. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-css">f[o]o</codeBlock>' );
  171. } );
  172. describe( 'tab key handling', () => {
  173. let domEvtDataStub;
  174. beforeEach( () => {
  175. domEvtDataStub = {
  176. keyCode: getCode( 'Tab' ),
  177. preventDefault: sinon.spy(),
  178. stopPropagation: sinon.spy()
  179. };
  180. sinon.spy( editor, 'execute' );
  181. } );
  182. afterEach( () => {
  183. editor.execute.restore();
  184. } );
  185. it( 'should execute indentCodeBlock command on tab key', () => {
  186. setModelData( model, '<codeBlock language="language-plaintext">[]foo</codeBlock>' );
  187. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  188. sinon.assert.calledOnce( editor.execute );
  189. sinon.assert.calledWithExactly( editor.execute, 'indentCodeBlock' );
  190. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  191. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  192. } );
  193. it( 'should execute outdentCodeBlock command on Shift+Tab keystroke', () => {
  194. domEvtDataStub.keyCode += getCode( 'Shift' );
  195. setModelData( model, '<codeBlock language="language-plaintext">[]foo</codeBlock>' );
  196. // '<codeBlock language="language-plaintext"> []foo</codeBlock>
  197. model.change( writer => {
  198. writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
  199. } );
  200. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  201. sinon.assert.calledOnce( editor.execute );
  202. sinon.assert.calledWithExactly( editor.execute, 'outdentCodeBlock' );
  203. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  204. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  205. } );
  206. it( 'should not indent if command is disabled', () => {
  207. setModelData( model, '<paragraph>[]foo</paragraph>' );
  208. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  209. expect( editor.execute.called ).to.be.false;
  210. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  211. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  212. } );
  213. it( 'should not indent or outdent if alt+tab is pressed', () => {
  214. domEvtDataStub.keyCode += getCode( 'alt' );
  215. setModelData( model, '<codeBlock language="language-plaintext">[]foo</codeBlock>' );
  216. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  217. expect( editor.execute.called ).to.be.false;
  218. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  219. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  220. } );
  221. } );
  222. describe( 'enter key handling', () => {
  223. it( 'should force shiftEnter command when pressing enter inside a codeBlock', () => {
  224. const enterCommand = editor.commands.get( 'enter' );
  225. const shiftEnterCommand = editor.commands.get( 'shiftEnter' );
  226. sinon.spy( enterCommand, 'execute' );
  227. sinon.spy( shiftEnterCommand, 'execute' );
  228. setModelData( model, '<codeBlock>foo[]bar</codeBlock>' );
  229. viewDoc.fire( 'enter', getEvent() );
  230. expect( getModelData( model ) ).to.equal( '<codeBlock>foo<softBreak></softBreak>[]bar</codeBlock>' );
  231. sinon.assert.calledOnce( shiftEnterCommand.execute );
  232. sinon.assert.notCalled( enterCommand.execute );
  233. } );
  234. it( 'should execute enter command when pressing enter out of codeBlock', () => {
  235. const enterCommand = editor.commands.get( 'enter' );
  236. const shiftEnterCommand = editor.commands.get( 'shiftEnter' );
  237. sinon.spy( enterCommand, 'execute' );
  238. sinon.spy( shiftEnterCommand, 'execute' );
  239. setModelData( model, '<paragraph>foo[]bar</paragraph>' );
  240. viewDoc.fire( 'enter', getEvent() );
  241. expect( getModelData( model ) ).to.equal( '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>' );
  242. sinon.assert.calledOnce( enterCommand.execute );
  243. sinon.assert.notCalled( shiftEnterCommand.execute );
  244. } );
  245. describe( 'indentation retention', () => {
  246. it( 'should work when indentation is with spaces', () => {
  247. setModelData( model, '<codeBlock language="language-css">foo[]</codeBlock>' );
  248. model.change( writer => {
  249. // <codeBlock language="language-css"> foo[]</codeBlock>
  250. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  251. } );
  252. viewDoc.fire( 'enter', getEvent() );
  253. expect( getModelData( model ) ).to.equal(
  254. '<codeBlock language="language-css"> foo<softBreak></softBreak> []</codeBlock>' );
  255. editor.execute( 'undo' );
  256. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-css"> foo[]</codeBlock>' );
  257. } );
  258. it( 'should work when indentation is with tabs', () => {
  259. setModelData( model, '<codeBlock language="language-css">foo[]</codeBlock>' );
  260. model.change( writer => {
  261. // <codeBlock language="language-css"> foo[]</codeBlock>
  262. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  263. } );
  264. viewDoc.fire( 'enter', getEvent() );
  265. expect( getModelData( model ) ).to.equal(
  266. '<codeBlock language="language-css"> foo<softBreak></softBreak> []</codeBlock>' );
  267. editor.execute( 'undo' );
  268. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-css"> foo[]</codeBlock>' );
  269. } );
  270. it( 'should retain only the last line', () => {
  271. setModelData( model, '<codeBlock language="language-css">foo<softBreak></softBreak>bar[]</codeBlock>' );
  272. model.change( writer => {
  273. // <codeBlock language="language-css"> foo<softBreak></softBreak> bar[]</codeBlock>
  274. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 4 );
  275. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  276. } );
  277. viewDoc.fire( 'enter', getEvent() );
  278. expect( getModelData( model ) ).to.equal(
  279. '<codeBlock language="language-css"> foo<softBreak></softBreak> bar<softBreak></softBreak> []</codeBlock>' );
  280. editor.execute( 'undo' );
  281. expect( getModelData( model ) ).to.equal(
  282. '<codeBlock language="language-css"> foo<softBreak></softBreak> bar[]</codeBlock>' );
  283. } );
  284. it( 'should retain when the selection is non–collapsed', () => {
  285. setModelData( model, '<codeBlock language="language-css">f[o]o</codeBlock>' );
  286. model.change( writer => {
  287. // <codeBlock language="language-css"> f[o]o</codeBlock>
  288. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  289. } );
  290. viewDoc.fire( 'enter', getEvent() );
  291. expect( getModelData( model ) ).to.equal(
  292. '<codeBlock language="language-css"> f<softBreak></softBreak> []o</codeBlock>' );
  293. editor.execute( 'undo' );
  294. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-css"> f[o]o</codeBlock>' );
  295. } );
  296. it( 'should consider only leading white-spaces', () => {
  297. setModelData( model, '<codeBlock language="language-css">foo[]</codeBlock>' );
  298. model.change( writer => {
  299. // <codeBlock language="language-css"> foo []</codeBlock>
  300. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 3 );
  301. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  302. } );
  303. viewDoc.fire( 'enter', getEvent() );
  304. expect( getModelData( model ) ).to.equal(
  305. '<codeBlock language="language-css"> foo <softBreak></softBreak> []</codeBlock>' );
  306. editor.execute( 'undo' );
  307. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-css"> foo []</codeBlock>' );
  308. } );
  309. it( 'should not work when there is some non-whitespace character', () => {
  310. setModelData( model, '<codeBlock language="language-css">foo[]</codeBlock>' );
  311. model.change( writer => {
  312. // <codeBlock language="language-css">foo []</codeBlock>
  313. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 3 );
  314. } );
  315. viewDoc.fire( 'enter', getEvent() );
  316. expect( getModelData( model ) ).to.equal(
  317. '<codeBlock language="language-css">foo <softBreak></softBreak>[]</codeBlock>' );
  318. } );
  319. } );
  320. describe( 'leaving block using the enter key', () => {
  321. describe( 'leaving the block end', () => {
  322. it( 'should leave the block when pressed twice at the end', () => {
  323. const spy = sinon.spy( editor.editing.view, 'scrollToTheSelection' );
  324. setModelData( model, '<codeBlock language="language-css">foo[]</codeBlock>' );
  325. viewDoc.fire( 'enter', getEvent() );
  326. expect( getModelData( model ) ).to.equal(
  327. '<codeBlock language="language-css">foo<softBreak></softBreak>[]</codeBlock>' );
  328. viewDoc.fire( 'enter', getEvent() );
  329. expect( getModelData( model ) ).to.equal(
  330. '<codeBlock language="language-css">foo</codeBlock>' +
  331. '<paragraph>[]</paragraph>'
  332. );
  333. sinon.assert.calledOnce( spy );
  334. editor.execute( 'undo' );
  335. expect( getModelData( model ) ).to.equal(
  336. '<codeBlock language="language-css">foo<softBreak></softBreak>[]</codeBlock>' );
  337. editor.execute( 'undo' );
  338. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-css">foo[]</codeBlock>' );
  339. } );
  340. it( 'should not leave the block when the selection is not collapsed', () => {
  341. setModelData( model, '<codeBlock language="language-css">f[oo<softBreak></softBreak>]</codeBlock>' );
  342. viewDoc.fire( 'enter', getEvent() );
  343. expect( getModelData( model ) ).to.equal(
  344. '<codeBlock language="language-css">f<softBreak></softBreak>[]</codeBlock>' );
  345. } );
  346. it( 'should not leave the block when pressed twice when in the middle of the code', () => {
  347. setModelData( model, '<codeBlock language="language-css">fo[]o</codeBlock>' );
  348. viewDoc.fire( 'enter', getEvent() );
  349. expect( getModelData( model ) ).to.equal(
  350. '<codeBlock language="language-css">fo<softBreak></softBreak>[]o</codeBlock>' );
  351. viewDoc.fire( 'enter', getEvent() );
  352. expect( getModelData( model ) ).to.equal(
  353. '<codeBlock language="language-css">fo<softBreak></softBreak><softBreak></softBreak>[]o</codeBlock>' );
  354. } );
  355. it( 'should not leave the block when pressed twice at the beginning of the code', () => {
  356. setModelData( model, '<codeBlock language="language-css">[]foo</codeBlock>' );
  357. viewDoc.fire( 'enter', getEvent() );
  358. expect( getModelData( model ) ).to.equal(
  359. '<codeBlock language="language-css"><softBreak></softBreak>[]foo</codeBlock>' );
  360. viewDoc.fire( 'enter', getEvent() );
  361. expect( getModelData( model ) ).to.equal(
  362. '<codeBlock language="language-css"><softBreak></softBreak><softBreak></softBreak>[]foo</codeBlock>' );
  363. } );
  364. it( 'should not leave the block when pressed shift+enter twice at the end of the code', () => {
  365. setModelData( model, '<codeBlock language="language-css">foo<softBreak></softBreak>[]</codeBlock>' );
  366. viewDoc.fire( 'enter', getEvent( { isSoft: true } ) );
  367. expect( getModelData( model ) ).to.equal(
  368. '<codeBlock language="language-css">foo<softBreak></softBreak><softBreak></softBreak>[]</codeBlock>' );
  369. } );
  370. it( 'should clean up the last line if has white–space characters only', () => {
  371. setModelData( model, '<codeBlock language="language-css">foo<softBreak></softBreak>[]</codeBlock>' );
  372. model.change( writer => {
  373. // <codeBlock language="language-css">foo<softBreak></softBreak> []</codeBlock>
  374. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 4 );
  375. } );
  376. viewDoc.fire( 'enter', getEvent() );
  377. expect( getModelData( model ) ).to.equal(
  378. '<codeBlock language="language-css">foo</codeBlock><paragraph>[]</paragraph>' );
  379. } );
  380. } );
  381. describe( 'leaving the block at the beginning', () => {
  382. it( 'should leave the block when pressed at the beginning in a new line', () => {
  383. const spy = sinon.spy( editor.editing.view, 'scrollToTheSelection' );
  384. setModelData( model, '<codeBlock language="language-css">[]<softBreak></softBreak>foo</codeBlock>' );
  385. viewDoc.fire( 'enter', getEvent() );
  386. expect( getModelData( model ) ).to.equal(
  387. '<paragraph>[]</paragraph>' +
  388. '<codeBlock language="language-css">foo</codeBlock>'
  389. );
  390. sinon.assert.calledOnce( spy );
  391. editor.execute( 'undo' );
  392. expect( getModelData( model ) ).to.equal(
  393. '<codeBlock language="language-css">[]<softBreak></softBreak>foo</codeBlock>' );
  394. } );
  395. it( 'should not leave the block when the selection is not collapsed (#1)', () => {
  396. setModelData( model, '<codeBlock language="language-css">[f]<softBreak></softBreak>oo</codeBlock>' );
  397. viewDoc.fire( 'enter', getEvent() );
  398. expect( getModelData( model ) ).to.equal(
  399. '<codeBlock language="language-css"><softBreak></softBreak>[]<softBreak></softBreak>oo</codeBlock>' );
  400. } );
  401. it( 'should not leave the block when the selection is not collapsed (#2)', () => {
  402. setModelData( model, '<codeBlock language="language-css">[<softBreak></softBreak>oo]</codeBlock>' );
  403. viewDoc.fire( 'enter', getEvent() );
  404. expect( getModelData( model ) ).to.equal(
  405. '<codeBlock language="language-css"><softBreak></softBreak>[]</codeBlock>' );
  406. } );
  407. it( 'should not leave the block when pressed shift+enter at the beginning of the code', () => {
  408. setModelData( model, '<codeBlock language="language-css">[]<softBreak></softBreak>foo</codeBlock>' );
  409. viewDoc.fire( 'enter', getEvent( { isSoft: true } ) );
  410. expect( getModelData( model ) ).to.equal(
  411. '<codeBlock language="language-css"><softBreak></softBreak>[]<softBreak></softBreak>foo</codeBlock>' );
  412. } );
  413. it( 'should not leave the block when there is some text after the selection', () => {
  414. setModelData( model, '<codeBlock language="language-css">[]foo<softBreak></softBreak>foo</codeBlock>' );
  415. viewDoc.fire( 'enter', getEvent() );
  416. expect( getModelData( model ) ).to.equal(
  417. '<codeBlock language="language-css"><softBreak></softBreak>[]foo<softBreak></softBreak>foo</codeBlock>' );
  418. } );
  419. it( 'should not leave the block when there is some text before the selection', () => {
  420. setModelData( model, '<codeBlock language="language-css">[]<softBreak></softBreak>foo</codeBlock>' );
  421. // <codeBlock language="language-css"> []<softBreak></softBreak>foo</codeBlock>
  422. model.change( writer => {
  423. writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
  424. } );
  425. viewDoc.fire( 'enter', getEvent() );
  426. // Extra spaces before "[]" come from the indentation retention mechanism.
  427. expect( getModelData( model ) ).to.equal(
  428. '<codeBlock language="language-css"> <softBreak></softBreak> []<softBreak></softBreak>foo</codeBlock>' );
  429. } );
  430. } );
  431. } );
  432. function getEvent( data = {} ) {
  433. return new DomEventData( viewDoc, {
  434. preventDefault: sinon.spy()
  435. }, data );
  436. }
  437. } );
  438. describe( 'indent plugin integration', () => {
  439. it( 'should add indent code block command to indent command', () => {
  440. const element = document.createElement( 'div' );
  441. document.body.appendChild( element );
  442. return ClassicTestEditor
  443. .create( element, {
  444. plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph, Undo, IndentEditing ]
  445. } )
  446. .then( newEditor => {
  447. const editor = newEditor;
  448. const indentCodeBlockCommand = editor.commands.get( 'indentCodeBlock' );
  449. const indentCommand = editor.commands.get( 'indent' );
  450. const spy = sinon.spy( indentCodeBlockCommand, 'execute' );
  451. indentCodeBlockCommand.isEnabled = true;
  452. indentCommand.execute();
  453. sinon.assert.calledOnce( spy );
  454. element.remove();
  455. return editor.destroy();
  456. } );
  457. } );
  458. it( 'should add outdent code block command to outdent command', () => {
  459. return ClassicTestEditor
  460. .create( element, {
  461. plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph, Undo, IndentEditing ]
  462. } )
  463. .then( newEditor => {
  464. const editor = newEditor;
  465. const outdentCodeBlockCommand = editor.commands.get( 'outdentCodeBlock' );
  466. const outdentCommand = editor.commands.get( 'outdent' );
  467. const spy = sinon.spy( outdentCodeBlockCommand, 'execute' );
  468. outdentCodeBlockCommand.isEnabled = true;
  469. outdentCommand.execute();
  470. sinon.assert.calledOnce( spy );
  471. element.remove();
  472. return editor.destroy();
  473. } );
  474. } );
  475. } );
  476. describe( 'editing pipeline m -> v', () => {
  477. it( 'should convert empty codeBlock to empty pre tag', () => {
  478. setModelData( model, '<codeBlock language="language-plaintext"></codeBlock>' );
  479. expect( getViewData( view ) ).to.equal( '<pre data-language="Plain text"><code class="language-plaintext">[]</code></pre>' );
  480. } );
  481. it( 'should convert non-empty codeBlock to pre tag', () => {
  482. setModelData( model, '<codeBlock language="language-plaintext">Foo</codeBlock>' );
  483. expect( getViewData( view ) ).to.equal( '<pre data-language="Plain text"><code class="language-plaintext">{}Foo</code></pre>' );
  484. } );
  485. it( 'should convert codeBlock with softBreaks to pre tag #1', () => {
  486. setModelData( model,
  487. '<codeBlock language="language-plaintext">' +
  488. 'Foo<softBreak></softBreak>' +
  489. 'Bar<softBreak></softBreak>' +
  490. 'Biz' +
  491. '</codeBlock>'
  492. );
  493. expect( getViewData( view ) ).to.equal(
  494. '<pre data-language="Plain text">' +
  495. '<code class="language-plaintext">{}Foo<br></br>Bar<br></br>Biz</code>' +
  496. '</pre>' );
  497. } );
  498. it( 'should convert codeBlock with softBreaks to pre tag #2', () => {
  499. setModelData( model,
  500. '<codeBlock language="language-plaintext">' +
  501. '<softBreak></softBreak>' +
  502. '<softBreak></softBreak>' +
  503. 'Foo' +
  504. '<softBreak></softBreak>' +
  505. '<softBreak></softBreak>' +
  506. '</codeBlock>'
  507. );
  508. expect( getViewData( view ) ).to.equal(
  509. '<pre data-language="Plain text">' +
  510. '<code class="language-plaintext">[]<br></br><br></br>Foo<br></br><br></br></code>' +
  511. '</pre>' );
  512. } );
  513. it( 'should use localized "Plain text" label', () => {
  514. const element = document.createElement( 'div' );
  515. document.body.appendChild( element );
  516. return ClassicTestEditor
  517. .create( element, {
  518. language: 'pl',
  519. plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph ]
  520. } )
  521. .then( newEditor => {
  522. const editor = newEditor;
  523. const model = editor.model;
  524. const view = editor.editing.view;
  525. setModelData( model,
  526. '<codeBlock language="language-plaintext">foo</codeBlock>'
  527. );
  528. expect( getViewData( view ) ).to.equal(
  529. '<pre data-language="Zwykły tekst">' +
  530. '<code class="language-plaintext">{}foo</code>' +
  531. '</pre>' );
  532. element.remove();
  533. return editor.destroy();
  534. } );
  535. } );
  536. } );
  537. describe( 'data pipeline m -> v conversion ', () => {
  538. it( 'should convert empty codeBlock to empty pre tag', () => {
  539. setModelData( model, '<codeBlock language="language-plaintext"></codeBlock>' );
  540. expect( editor.getData( { trim: 'none' } ) ).to.equal( '<pre><code class="language-plaintext">&nbsp;</code></pre>' );
  541. } );
  542. it( 'should convert non-empty codeBlock to pre tag', () => {
  543. setModelData( model, '<codeBlock language="language-plaintext">Foo</codeBlock>' );
  544. expect( editor.getData() ).to.equal( '<pre><code class="language-plaintext">Foo</code></pre>' );
  545. } );
  546. it( 'should convert codeBlock with softBreaks to pre tag #1', () => {
  547. setModelData( model,
  548. '<codeBlock language="language-plaintext">' +
  549. 'Foo<softBreak></softBreak>' +
  550. 'Bar<softBreak></softBreak>' +
  551. 'Biz' +
  552. '</codeBlock>' +
  553. '<paragraph>A<softBreak></softBreak>B</paragraph>'
  554. );
  555. expect( editor.getData() ).to.equal( '<pre><code class="language-plaintext">Foo\nBar\nBiz</code></pre><p>A<br>B</p>' );
  556. } );
  557. it( 'should convert codeBlock with softBreaks to pre tag #2', () => {
  558. setModelData( model,
  559. '<codeBlock language="language-plaintext">' +
  560. '<softBreak></softBreak>' +
  561. '<softBreak></softBreak>' +
  562. 'Foo' +
  563. '<softBreak></softBreak>' +
  564. '<softBreak></softBreak>' +
  565. '</codeBlock>'
  566. );
  567. expect( editor.getData() ).to.equal( '<pre><code class="language-plaintext">\n\nFoo\n\n</code></pre>' );
  568. } );
  569. it( 'should convert codeBlock with html content', () => {
  570. setModelData( model, '<codeBlock language="language-plaintext">[]</codeBlock>' );
  571. model.change( writer => writer.insertText( '<div><p>Foo</p></div>', model.document.selection.getFirstPosition() ) );
  572. expect( editor.getData() ).to.equal(
  573. '<pre>' +
  574. '<code class="language-plaintext">&lt;div&gt;&lt;p&gt;Foo&lt;/p&gt;&lt;/div&gt;</code>' +
  575. '</pre>' );
  576. } );
  577. it( 'should be overridable', () => {
  578. editor.data.downcastDispatcher.on( 'insert:codeBlock', ( evt, data, api ) => {
  579. const targetViewPosition = api.mapper.toViewPosition( model.createPositionBefore( data.item ) );
  580. const code = api.writer.createContainerElement( 'code' );
  581. api.consumable.consume( data.item, 'insert' );
  582. api.writer.insert( targetViewPosition, code );
  583. api.mapper.bindElements( data.item, code );
  584. }, { priority: 'high' } );
  585. editor.data.downcastDispatcher.on( 'insert:softBreak', ( evt, data, api ) => {
  586. const position = api.mapper.toViewPosition( model.createPositionBefore( data.item ) );
  587. api.consumable.consume( data.item, 'insert' );
  588. api.writer.insert( position, api.writer.createText( '\n' ) );
  589. }, { priority: 'highest' } );
  590. setModelData( model, '<codeBlock language="language-plaintext">Foo<softBreak></softBreak>Bar</codeBlock>' );
  591. expect( editor.getData() ).to.equal( '<code>Foo\nBar</code>' );
  592. } );
  593. } );
  594. describe( 'data pipeline v -> m conversion ', () => {
  595. it( 'should not convert empty pre tag to code block', () => {
  596. editor.setData( '<pre></pre>' );
  597. expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph>' );
  598. } );
  599. it( 'should not convert pre with no code child to code block', () => {
  600. editor.setData( '<pre><samp></samp></pre>' );
  601. expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph>' );
  602. } );
  603. it( 'should convert pre > code to code block', () => {
  604. editor.setData( '<pre><code></code></pre>' );
  605. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-plaintext">[]</codeBlock>' );
  606. } );
  607. it( 'should convert pre > code with multi-line text to code block #1', () => {
  608. editor.setData( '<pre><code>foo\nbar</code></pre>' );
  609. expect( getModelData( model ) ).to.equal(
  610. '<codeBlock language="language-plaintext">[]' +
  611. 'foo' +
  612. '<softBreak></softBreak>' +
  613. 'bar' +
  614. '</codeBlock>'
  615. );
  616. } );
  617. it( 'should convert pre > code with multi-line text to code block #2', () => {
  618. editor.setData( '<pre><code>\n\nfoo\n\n</code></pre>' );
  619. expect( getModelData( model ) ).to.equal(
  620. '<codeBlock language="language-plaintext">[]' +
  621. '<softBreak></softBreak>' +
  622. '<softBreak></softBreak>' +
  623. 'foo' +
  624. '<softBreak></softBreak>' +
  625. '<softBreak></softBreak>' +
  626. '</codeBlock>'
  627. );
  628. } );
  629. it( 'should convert pre > code with HTML inside', () => {
  630. editor.setData( '<pre><code><p>Foo</p>\n<p>Bar</p></code></pre>' );
  631. expect( getModelData( model ) ).to.equal(
  632. '<codeBlock language="language-plaintext">[]' +
  633. '<p>Foo</p>' +
  634. '<softBreak></softBreak>' +
  635. '<p>Bar</p>' +
  636. '</codeBlock>'
  637. );
  638. } );
  639. it( 'should convert pre > code tag with HTML and nested pre > code tag', () => {
  640. editor.setData( '<pre><code><p>Foo</p><pre>Bar</pre><p>Biz</p></code></pre>' );
  641. expect( getModelData( model ) ).to.equal(
  642. '<codeBlock language="language-plaintext">[]<p>Foo</p><pre>Bar</pre><p>Biz</p></codeBlock>' );
  643. } );
  644. it( 'should convert pre > code tag with escaped html content', () => {
  645. editor.setData( '<pre><code>&lt;div&gt;&lt;p&gt;Foo&lt;/p&gt;&lt;/div&gt;</code></pre>' );
  646. expect( getModelData( model ) ).to.equal( '<codeBlock language="language-plaintext">[]<div><p>Foo</p></div></codeBlock>' );
  647. } );
  648. it( 'should be overridable', () => {
  649. editor.data.upcastDispatcher.on( 'element:pre', ( evt, data, api ) => {
  650. const modelItem = api.writer.createElement( 'codeBlock' );
  651. api.writer.appendText( 'Hello World!', modelItem );
  652. api.writer.insert( modelItem, data.modelCursor );
  653. api.consumable.consume( data.viewItem, { name: true } );
  654. data.modelCursor = api.writer.createPositionAfter( modelItem );
  655. data.modelRange = api.writer.createRangeOn( modelItem );
  656. }, { priority: 'high' } );
  657. editor.setData( '<pre><code>Foo Bar</code></pre>' );
  658. expect( getModelData( model ) ).to.equal( '<codeBlock>[]Hello World!</codeBlock>' );
  659. } );
  660. it( 'should split parents to correctly upcast the code block', () => {
  661. editor.setData( '<p>foo<pre><code>x</code></pre>bar</p>' );
  662. // Note: The empty <paragraph> should not be here. It's a conversion/auto–paragraphing bug.
  663. expect( getModelData( model ) ).to.equal(
  664. '<paragraph>[]foo</paragraph>' +
  665. '<codeBlock language="language-plaintext">x</codeBlock>' +
  666. '<paragraph>bar</paragraph>' +
  667. '<paragraph></paragraph>' );
  668. } );
  669. it( 'should upcast two code blocks in a row (#1)', () => {
  670. editor.setData( '<pre><code>foo</code></pre><pre><code>bar</code></pre>' );
  671. expect( getModelData( model ) ).to.equal(
  672. '<codeBlock language="language-plaintext">[]foo</codeBlock><codeBlock language="language-plaintext">bar</codeBlock>' );
  673. } );
  674. it( 'should upcast two code blocks in a row (#2)', () => {
  675. editor.setData( `<pre><code>foo</code></pre>
  676. <pre><code>bar</code></pre>` );
  677. // Note: The empty <paragraph> in between should not be here. It's a conversion/auto–paragraphing bug.
  678. expect( getModelData( model ) ).to.equal(
  679. '<codeBlock language="language-plaintext">[]foo</codeBlock>' +
  680. '<paragraph> </paragraph>' +
  681. '<codeBlock language="language-plaintext">bar</codeBlock>' );
  682. } );
  683. it( 'should not convert when modelCursor and its ancestors disallow to insert codeBlock', () => {
  684. model.document.createRoot( '$title', 'title' );
  685. model.schema.register( '$title', {
  686. disallow: '$block',
  687. allow: 'inline'
  688. } );
  689. editor.data.set( { title: '<pre><code>foo</code></pre>' } );
  690. expect( getModelData( model, { rootName: 'title', withoutSelection: true } ) ).to.equal( '' );
  691. } );
  692. } );
  693. describe( 'clipboard integration', () => {
  694. it( 'should not intercept input when selection anchored outside any code block', () => {
  695. setModelData( model, '<paragraph>f[]oo</paragraph>' );
  696. const dataTransferMock = {
  697. getData: sinon.stub().withArgs( 'text/plain' ).returns( 'bar' )
  698. };
  699. viewDoc.fire( 'clipboardInput', {
  700. dataTransfer: dataTransferMock,
  701. stop: sinon.spy()
  702. } );
  703. expect( getModelData( model ) ).to.equal( '<paragraph>f[]oo</paragraph>' );
  704. sinon.assert.notCalled( dataTransferMock.getData );
  705. } );
  706. it( 'should intercept input when selection anchored in the code block', () => {
  707. setModelData( model, '<codeBlock language="language-css">f[o]o</codeBlock>' );
  708. const dataTransferMock = {
  709. getData: sinon.stub().withArgs( 'text/plain' ).returns( 'bar\nbaz\n' )
  710. };
  711. viewDoc.fire( 'clipboardInput', {
  712. dataTransfer: dataTransferMock,
  713. stop: sinon.spy()
  714. } );
  715. expect( getModelData( model ) ).to.equal(
  716. '<codeBlock language="language-css">' +
  717. 'fbar' +
  718. '<softBreak></softBreak>' +
  719. 'baz' +
  720. '<softBreak></softBreak>' +
  721. '[]o' +
  722. '</codeBlock>' );
  723. sinon.assert.calledOnce( dataTransferMock.getData );
  724. } );
  725. describe( 'getSelectedContent()', () => {
  726. it( 'should not engage when there is nothing selected', () => {
  727. setModelData( model, '<codeBlock language="language-css">fo[]o<softBreak></softBreak>bar</codeBlock>' );
  728. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal( '' );
  729. } );
  730. it( 'should wrap a partial multi-line selection into a code block (#1)', () => {
  731. setModelData( model, '<codeBlock language="language-css">fo[o<softBreak></softBreak>b]ar</codeBlock>' );
  732. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
  733. '<codeBlock language="language-css">o<softBreak></softBreak>b</codeBlock>'
  734. );
  735. } );
  736. it( 'should wrap a partial multi-line selection into a code block (#2)', () => {
  737. setModelData( model, '<codeBlock language="language-css">fo[o<softBreak></softBreak>]bar</codeBlock>' );
  738. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
  739. '<codeBlock language="language-css">o<softBreak></softBreak></codeBlock>'
  740. );
  741. } );
  742. it( 'should wrap a partial multi-line selection into a code block (#3)', () => {
  743. setModelData( model, '<codeBlock language="language-css">[foo<softBreak></softBreak>bar]</codeBlock>' );
  744. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
  745. '<codeBlock language="language-css">foo<softBreak></softBreak>bar</codeBlock>'
  746. );
  747. } );
  748. it( 'should wrap a complete single-line selection into a code block', () => {
  749. setModelData( model, '<codeBlock language="language-css">[foo]</codeBlock>' );
  750. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
  751. '<codeBlock language="language-css">foo</codeBlock>'
  752. );
  753. } );
  754. it( 'should wrap a partial single-line selection into an inline code (#1)', () => {
  755. model.schema.extend( '$text', {
  756. allowAttributes: 'code'
  757. } );
  758. setModelData( model, '<codeBlock language="language-css">[fo]o<softBreak></softBreak>bar</codeBlock>' );
  759. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
  760. '<$text code="true">fo</$text>'
  761. );
  762. } );
  763. it( 'should wrap a partial single-line selection into an inline code (#2)', () => {
  764. model.schema.extend( '$text', {
  765. allowAttributes: 'code'
  766. } );
  767. setModelData( model, '<codeBlock language="language-css">foo<softBreak></softBreak>b[a]r</codeBlock>' );
  768. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
  769. '<$text code="true">a</$text>'
  770. );
  771. } );
  772. it( 'should now wrap a partial single-line selection into an inline code when the attribute is disallowed', () => {
  773. setModelData( model, '<codeBlock language="language-css">foo<softBreak></softBreak>b[a]r</codeBlock>' );
  774. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal( 'a' );
  775. } );
  776. it( 'should preserve a code block in a cross-selection (#1)', () => {
  777. setModelData( model,
  778. '<paragraph>[x</paragraph><codeBlock language="language-css">fo]o<softBreak></softBreak>bar</codeBlock>' );
  779. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
  780. '<paragraph>x</paragraph><codeBlock language="language-css">fo</codeBlock>'
  781. );
  782. } );
  783. it( 'should preserve a code block in a cross-selection (#2)', () => {
  784. setModelData( model,
  785. '<paragraph>[x</paragraph><codeBlock language="language-css">foo<softBreak></softBreak>b]ar</codeBlock>' );
  786. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
  787. '<paragraph>x</paragraph><codeBlock language="language-css">foo<softBreak></softBreak>b</codeBlock>'
  788. );
  789. } );
  790. it( 'should preserve a code block in a cross-selection (#3)', () => {
  791. setModelData( model,
  792. '<codeBlock language="language-css">foo<softBreak></softBreak>b[ar</codeBlock><paragraph>x]</paragraph>' );
  793. expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
  794. '<codeBlock language="language-css">ar</codeBlock><paragraph>x</paragraph>'
  795. );
  796. } );
  797. } );
  798. } );
  799. } );