codeblockediting.js 37 KB

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