| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* global document */
- import CodeBlockEditing from '../src/codeblockediting';
- import CodeBlockCommand from '../src/codeblockcommand';
- import IndentCodeBlockCommand from '../src/indentcodeblockcommand';
- import OutdentCodeBlockCommand from '../src/outdentcodeblockcommand';
- import AlignmentEditing from '@ckeditor/ckeditor5-alignment/src/alignmentediting';
- import BoldEditing from '@ckeditor/ckeditor5-basic-styles/src/bold/boldediting';
- import Enter from '@ckeditor/ckeditor5-enter/src/enter';
- import ShiftEnter from '@ckeditor/ckeditor5-enter/src/shiftenter';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import Undo from '@ckeditor/ckeditor5-undo/src/undo';
- import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
- import IndentEditing from '@ckeditor/ckeditor5-indent/src/indentediting';
- import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
- import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import { getData as getModelData, setData as setModelData, stringify } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
- import { _clear as clearTranslations, add as addTranslations } from '@ckeditor/ckeditor5-utils/src/translation-service';
- describe( 'CodeBlockEditing', () => {
- let editor, element, model, view, viewDoc;
- before( () => {
- addTranslations( 'en', {
- 'Plain text': 'Plain text'
- } );
- addTranslations( 'pl', {
- 'Plain text': 'Zwykły tekst'
- } );
- } );
- after( () => {
- clearTranslations();
- } );
- beforeEach( () => {
- element = document.createElement( 'div' );
- document.body.appendChild( element );
- return ClassicTestEditor
- .create( element, {
- language: 'en',
- plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph, Undo ]
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- view = editor.editing.view;
- viewDoc = view.document;
- } );
- } );
- afterEach( () => {
- return editor.destroy().then( () => element.remove() );
- } );
- it( 'defines plugin name', () => {
- expect( CodeBlockEditing.pluginName ).to.equal( 'CodeBlockEditing' );
- } );
- it( 'defines plugin dependencies', () => {
- expect( CodeBlockEditing.requires ).to.have.members( [ ShiftEnter ] );
- } );
- describe( 'config', () => {
- describe( 'languages', () => {
- describe( 'default value', () => {
- it( 'should be set', () => {
- expect( editor.config.get( 'codeBlock.languages' ) ).to.deep.equal( [
- { language: 'plaintext', label: 'Plain text' },
- { language: 'c', label: 'C' },
- { language: 'cs', label: 'C#' },
- { language: 'cpp', label: 'C++' },
- { language: 'css', label: 'CSS' },
- { language: 'diff', label: 'Diff' },
- { language: 'html', label: 'HTML' },
- { language: 'java', label: 'Java' },
- { language: 'javascript', label: 'JavaScript' },
- { language: 'php', label: 'PHP' },
- { language: 'python', label: 'Python' },
- { language: 'ruby', label: 'Ruby' },
- { language: 'typescript', label: 'TypeScript' },
- { language: 'xml', label: 'XML' }
- ] );
- } );
- } );
- } );
- describe( 'indentSequence', () => {
- describe( 'default value', () => {
- it( 'should be set', () => {
- expect( editor.config.get( 'codeBlock.indentSequence' ) ).to.equal( ' ' );
- } );
- } );
- } );
- } );
- it( 'adds a "codeBlock" command', () => {
- expect( editor.commands.get( 'codeBlock' ) ).to.be.instanceOf( CodeBlockCommand );
- } );
- it( 'adds an "indentCodeBlock" command', () => {
- expect( editor.commands.get( 'indentCodeBlock' ) ).to.be.instanceOf( IndentCodeBlockCommand );
- } );
- it( 'adds an "outdentCodeBlock" command', () => {
- expect( editor.commands.get( 'outdentCodeBlock' ) ).to.be.instanceOf( OutdentCodeBlockCommand );
- } );
- it( 'allows for codeBlock in the $root', () => {
- expect( model.schema.checkChild( [ '$root' ], 'codeBlock' ) ).to.be.true;
- } );
- it( 'disallows for codeBlock in the other codeBlock', () => {
- expect( model.schema.checkChild( [ '$root', 'codeBlock' ], 'codeBlock' ) ).to.be.false;
- } );
- it( 'allows only for $text in codeBlock', () => {
- expect( model.schema.checkChild( [ '$root', 'codeBlock' ], '$text' ) ).to.equal( true );
- expect( model.schema.checkChild( [ '$root', 'codeBlock' ], '$block' ) ).to.equal( false );
- expect( model.schema.checkChild( [ '$root', 'codeBlock' ], 'codeBlock' ) ).to.equal( false );
- } );
- it( 'disallows all attributes (except "language") for codeBlock', () => {
- setModelData( model, '<codeBlock language="css">f[o]o</codeBlock>' );
- editor.execute( 'alignment', { value: 'right' } );
- editor.execute( 'bold' );
- expect( getModelData( model ) ).to.equal( '<codeBlock language="css">f[o]o</codeBlock>' );
- } );
- describe( 'tab key handling', () => {
- let domEvtDataStub;
- beforeEach( () => {
- domEvtDataStub = {
- keyCode: getCode( 'Tab' ),
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- sinon.spy( editor, 'execute' );
- } );
- afterEach( () => {
- editor.execute.restore();
- } );
- it( 'should execute indentCodeBlock command on tab key', () => {
- setModelData( model, '<codeBlock language="plaintext">[]foo</codeBlock>' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( editor.execute );
- sinon.assert.calledWithExactly( editor.execute, 'indentCodeBlock' );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- } );
- it( 'should execute outdentCodeBlock command on Shift+Tab keystroke', () => {
- domEvtDataStub.keyCode += getCode( 'Shift' );
- setModelData( model, '<codeBlock language="plaintext">[]foo</codeBlock>' );
- // '<codeBlock language="plaintext"> []foo</codeBlock>
- model.change( writer => {
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ) );
- } );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( editor.execute );
- sinon.assert.calledWithExactly( editor.execute, 'outdentCodeBlock' );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- } );
- it( 'should not indent if command is disabled', () => {
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- expect( editor.execute.called ).to.be.false;
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- } );
- it( 'should not indent or outdent if alt+tab is pressed', () => {
- domEvtDataStub.keyCode += getCode( 'alt' );
- setModelData( model, '<codeBlock language="plaintext">[]foo</codeBlock>' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- expect( editor.execute.called ).to.be.false;
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- } );
- } );
- describe( 'enter key handling', () => {
- it( 'should force shiftEnter command when pressing enter inside a codeBlock', () => {
- const enterCommand = editor.commands.get( 'enter' );
- const shiftEnterCommand = editor.commands.get( 'shiftEnter' );
- sinon.spy( enterCommand, 'execute' );
- sinon.spy( shiftEnterCommand, 'execute' );
- setModelData( model, '<codeBlock>foo[]bar</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal( '<codeBlock>foo<softBreak></softBreak>[]bar</codeBlock>' );
- sinon.assert.calledOnce( shiftEnterCommand.execute );
- sinon.assert.notCalled( enterCommand.execute );
- } );
- it( 'should execute enter command when pressing enter out of codeBlock', () => {
- const enterCommand = editor.commands.get( 'enter' );
- const shiftEnterCommand = editor.commands.get( 'shiftEnter' );
- sinon.spy( enterCommand, 'execute' );
- sinon.spy( shiftEnterCommand, 'execute' );
- setModelData( model, '<paragraph>foo[]bar</paragraph>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal( '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>' );
- sinon.assert.calledOnce( enterCommand.execute );
- sinon.assert.notCalled( shiftEnterCommand.execute );
- } );
- describe( 'indentation retention', () => {
- it( 'should work when indentation is with spaces', () => {
- setModelData( model, '<codeBlock language="css">foo[]</codeBlock>' );
- model.change( writer => {
- // <codeBlock language="css"> foo[]</codeBlock>
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
- } );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"> foo<softBreak></softBreak> []</codeBlock>' );
- editor.execute( 'undo' );
- expect( getModelData( model ) ).to.equal( '<codeBlock language="css"> foo[]</codeBlock>' );
- } );
- it( 'should work when indentation is with tabs', () => {
- setModelData( model, '<codeBlock language="css">foo[]</codeBlock>' );
- model.change( writer => {
- // <codeBlock language="css"> foo[]</codeBlock>
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
- } );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"> foo<softBreak></softBreak> []</codeBlock>' );
- editor.execute( 'undo' );
- expect( getModelData( model ) ).to.equal( '<codeBlock language="css"> foo[]</codeBlock>' );
- } );
- it( 'should retain only the last line', () => {
- setModelData( model, '<codeBlock language="css">foo<softBreak></softBreak>bar[]</codeBlock>' );
- model.change( writer => {
- // <codeBlock language="css"> foo<softBreak></softBreak> bar[]</codeBlock>
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 4 );
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
- } );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"> foo<softBreak></softBreak> bar<softBreak></softBreak> []</codeBlock>' );
- editor.execute( 'undo' );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"> foo<softBreak></softBreak> bar[]</codeBlock>' );
- } );
- it( 'should retain when the selection is non–collapsed', () => {
- setModelData( model, '<codeBlock language="css">f[o]o</codeBlock>' );
- model.change( writer => {
- // <codeBlock language="css"> f[o]o</codeBlock>
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
- } );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"> f<softBreak></softBreak> []o</codeBlock>' );
- editor.execute( 'undo' );
- expect( getModelData( model ) ).to.equal( '<codeBlock language="css"> f[o]o</codeBlock>' );
- } );
- it( 'should consider only leading white-spaces', () => {
- setModelData( model, '<codeBlock language="css">foo[]</codeBlock>' );
- model.change( writer => {
- // <codeBlock language="css"> foo []</codeBlock>
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 3 );
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
- } );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"> foo <softBreak></softBreak> []</codeBlock>' );
- editor.execute( 'undo' );
- expect( getModelData( model ) ).to.equal( '<codeBlock language="css"> foo []</codeBlock>' );
- } );
- it( 'should not work when there is some non-whitespace character', () => {
- setModelData( model, '<codeBlock language="css">foo[]</codeBlock>' );
- model.change( writer => {
- // <codeBlock language="css">foo []</codeBlock>
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 3 );
- } );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">foo <softBreak></softBreak>[]</codeBlock>' );
- } );
- } );
- describe( 'leaving block using the enter key', () => {
- describe( 'leaving the block end', () => {
- it( 'should leave the block when pressed twice at the end', () => {
- const spy = sinon.spy( editor.editing.view, 'scrollToTheSelection' );
- setModelData( model, '<codeBlock language="css">foo[]</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">foo<softBreak></softBreak>[]</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">foo</codeBlock>' +
- '<paragraph>[]</paragraph>'
- );
- sinon.assert.calledOnce( spy );
- editor.execute( 'undo' );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">foo<softBreak></softBreak>[]</codeBlock>' );
- editor.execute( 'undo' );
- expect( getModelData( model ) ).to.equal( '<codeBlock language="css">foo[]</codeBlock>' );
- } );
- it( 'should not leave the block when the selection is not collapsed', () => {
- setModelData( model, '<codeBlock language="css">f[oo<softBreak></softBreak>]</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">f<softBreak></softBreak>[]</codeBlock>' );
- } );
- it( 'should not leave the block when pressed twice when in the middle of the code', () => {
- setModelData( model, '<codeBlock language="css">fo[]o</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">fo<softBreak></softBreak>[]o</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">fo<softBreak></softBreak><softBreak></softBreak>[]o</codeBlock>' );
- } );
- it( 'should not leave the block when pressed twice at the beginning of the code', () => {
- setModelData( model, '<codeBlock language="css">[]foo</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"><softBreak></softBreak>[]foo</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"><softBreak></softBreak><softBreak></softBreak>[]foo</codeBlock>' );
- } );
- it( 'should not leave the block when pressed shift+enter twice at the end of the code', () => {
- setModelData( model, '<codeBlock language="css">foo<softBreak></softBreak>[]</codeBlock>' );
- viewDoc.fire( 'enter', getEvent( { isSoft: true } ) );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">foo<softBreak></softBreak><softBreak></softBreak>[]</codeBlock>' );
- } );
- it( 'should clean up the last line if has white–space characters only', () => {
- setModelData( model, '<codeBlock language="css">foo<softBreak></softBreak>[]</codeBlock>' );
- model.change( writer => {
- // <codeBlock language="css">foo<softBreak></softBreak> []</codeBlock>
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 4 );
- } );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">foo</codeBlock><paragraph>[]</paragraph>' );
- } );
- } );
- describe( 'leaving the block at the beginning', () => {
- it( 'should leave the block when pressed at the beginning in a new line', () => {
- const spy = sinon.spy( editor.editing.view, 'scrollToTheSelection' );
- setModelData( model, '<codeBlock language="css">[]<softBreak></softBreak>foo</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<paragraph>[]</paragraph>' +
- '<codeBlock language="css">foo</codeBlock>'
- );
- sinon.assert.calledOnce( spy );
- editor.execute( 'undo' );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">[]<softBreak></softBreak>foo</codeBlock>' );
- } );
- it( 'should not leave the block when the selection is not collapsed (#1)', () => {
- setModelData( model, '<codeBlock language="css">[f]<softBreak></softBreak>oo</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"><softBreak></softBreak>[]<softBreak></softBreak>oo</codeBlock>' );
- } );
- it( 'should not leave the block when the selection is not collapsed (#2)', () => {
- setModelData( model, '<codeBlock language="css">[<softBreak></softBreak>oo]</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"><softBreak></softBreak>[]</codeBlock>' );
- } );
- it( 'should not leave the block when pressed shift+enter at the beginning of the code', () => {
- setModelData( model, '<codeBlock language="css">[]<softBreak></softBreak>foo</codeBlock>' );
- viewDoc.fire( 'enter', getEvent( { isSoft: true } ) );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"><softBreak></softBreak>[]<softBreak></softBreak>foo</codeBlock>' );
- } );
- it( 'should not leave the block when there is some text after the selection', () => {
- setModelData( model, '<codeBlock language="css">[]foo<softBreak></softBreak>foo</codeBlock>' );
- viewDoc.fire( 'enter', getEvent() );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"><softBreak></softBreak>[]foo<softBreak></softBreak>foo</codeBlock>' );
- } );
- it( 'should not leave the block when there is some text before the selection', () => {
- setModelData( model, '<codeBlock language="css">[]<softBreak></softBreak>foo</codeBlock>' );
- // <codeBlock language="css"> []<softBreak></softBreak>foo</codeBlock>
- model.change( writer => {
- writer.insertText( ' ', model.document.getRoot().getChild( 0 ), 0 );
- } );
- viewDoc.fire( 'enter', getEvent() );
- // Extra spaces before "[]" come from the indentation retention mechanism.
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css"> <softBreak></softBreak> []<softBreak></softBreak>foo</codeBlock>' );
- } );
- } );
- } );
- function getEvent( data = {} ) {
- return new DomEventData( viewDoc, {
- preventDefault: sinon.spy()
- }, data );
- }
- } );
- describe( 'indent plugin integration', () => {
- it( 'should add indent code block command to indent command', () => {
- const element = document.createElement( 'div' );
- document.body.appendChild( element );
- return ClassicTestEditor
- .create( element, {
- plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph, Undo, IndentEditing ]
- } )
- .then( newEditor => {
- const editor = newEditor;
- const indentCodeBlockCommand = editor.commands.get( 'indentCodeBlock' );
- const indentCommand = editor.commands.get( 'indent' );
- const spy = sinon.spy( indentCodeBlockCommand, 'execute' );
- indentCodeBlockCommand.isEnabled = true;
- indentCommand.execute();
- sinon.assert.calledOnce( spy );
- element.remove();
- return editor.destroy();
- } );
- } );
- it( 'should add outdent code block command to outdent command', () => {
- return ClassicTestEditor
- .create( element, {
- plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph, Undo, IndentEditing ]
- } )
- .then( newEditor => {
- const editor = newEditor;
- const outdentCodeBlockCommand = editor.commands.get( 'outdentCodeBlock' );
- const outdentCommand = editor.commands.get( 'outdent' );
- const spy = sinon.spy( outdentCodeBlockCommand, 'execute' );
- outdentCodeBlockCommand.isEnabled = true;
- outdentCommand.execute();
- sinon.assert.calledOnce( spy );
- element.remove();
- return editor.destroy();
- } );
- } );
- // See #5910.
- it( 'should allow to indent an entire code block with at least two lines', () => {
- const element = document.createElement( 'div' );
- document.body.appendChild( element );
- return ClassicTestEditor
- .create( element, {
- plugins: [ CodeBlockEditing, AlignmentEditing, IndentEditing ]
- } )
- .then( newEditor => {
- const editor = newEditor;
- editor.setData( '<pre><code class="language-css">\t\tx\n\tx</code></pre>' );
- editor.model.change( writer => {
- writer.setSelection( editor.model.document.getRoot().getChild( 0 ), 'on' );
- } );
- editor.execute( 'indent' );
- expect( getModelData( editor.model ) ).to.equal(
- '<codeBlock language="css">[\t\t\tx<softBreak></softBreak>\t\tx]</codeBlock>'
- );
- element.remove();
- return editor.destroy();
- } );
- } );
- } );
- describe( 'editing pipeline m -> v', () => {
- it( 'should convert empty codeBlock to empty pre tag', () => {
- setModelData( model, '<codeBlock language="plaintext"></codeBlock>' );
- expect( getViewData( view ) ).to.equal(
- '<pre data-language="Plain text" spellcheck="false">' +
- '<code class="language-plaintext">[]</code>' +
- '</pre>' );
- } );
- it( 'should convert non-empty codeBlock to pre tag', () => {
- setModelData( model, '<codeBlock language="plaintext">Foo</codeBlock>' );
- expect( getViewData( view ) ).to.equal(
- '<pre data-language="Plain text" spellcheck="false">' +
- '<code class="language-plaintext">{}Foo</code>' +
- '</pre>' );
- } );
- it( 'should convert codeBlock with softBreaks to pre tag #1', () => {
- setModelData( model,
- '<codeBlock language="plaintext">' +
- 'Foo<softBreak></softBreak>' +
- 'Bar<softBreak></softBreak>' +
- 'Biz' +
- '</codeBlock>'
- );
- expect( getViewData( view ) ).to.equal(
- '<pre data-language="Plain text" spellcheck="false">' +
- '<code class="language-plaintext">{}Foo<br></br>Bar<br></br>Biz</code>' +
- '</pre>' );
- } );
- it( 'should convert codeBlock with softBreaks to pre tag #2', () => {
- setModelData( model,
- '<codeBlock language="plaintext">' +
- '<softBreak></softBreak>' +
- '<softBreak></softBreak>' +
- 'Foo' +
- '<softBreak></softBreak>' +
- '<softBreak></softBreak>' +
- '</codeBlock>'
- );
- expect( getViewData( view ) ).to.equal(
- '<pre data-language="Plain text" spellcheck="false">' +
- '<code class="language-plaintext">[]<br></br><br></br>Foo<br></br><br></br></code>' +
- '</pre>' );
- } );
- it( 'should use localized "Plain text" label', () => {
- const element = document.createElement( 'div' );
- document.body.appendChild( element );
- return ClassicTestEditor
- .create( element, {
- language: 'pl',
- plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph ]
- } )
- .then( newEditor => {
- const editor = newEditor;
- const model = editor.model;
- const view = editor.editing.view;
- setModelData( model,
- '<codeBlock language="plaintext">foo</codeBlock>'
- );
- expect( getViewData( view ) ).to.equal(
- '<pre data-language="Zwykły tekst" spellcheck="false">' +
- '<code class="language-plaintext">{}foo</code>' +
- '</pre>' );
- element.remove();
- return editor.destroy();
- } );
- } );
- it( 'should not set the class on the <code> if it was configured so', () => {
- const element = document.createElement( 'div' );
- document.body.appendChild( element );
- return ClassicTestEditor
- .create( element, {
- plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph ],
- codeBlock: {
- languages: [
- { language: 'cpp', label: 'C++', class: '' }
- ]
- }
- } )
- .then( newEditor => {
- const editor = newEditor;
- const model = editor.model;
- const view = editor.editing.view;
- setModelData( model, '<codeBlock language="cpp">foo</codeBlock>' );
- expect( getViewData( view ) ).to.equal(
- '<pre data-language="C++" spellcheck="false">' +
- '<code>{}foo</code>' +
- '</pre>' );
- element.remove();
- return editor.destroy();
- } );
- } );
- } );
- describe( 'data pipeline m -> v conversion ', () => {
- it( 'should convert empty codeBlock to empty pre tag', () => {
- setModelData( model, '<codeBlock language="plaintext"></codeBlock>' );
- expect( editor.getData( { trim: 'none' } ) ).to.equal( '<pre><code class="language-plaintext"> </code></pre>' );
- } );
- it( 'should convert non-empty codeBlock to pre tag', () => {
- setModelData( model, '<codeBlock language="plaintext">Foo</codeBlock>' );
- expect( editor.getData() ).to.equal( '<pre><code class="language-plaintext">Foo</code></pre>' );
- } );
- it( 'should convert codeBlock with softBreaks to pre tag #1', () => {
- setModelData( model,
- '<codeBlock language="plaintext">' +
- 'Foo<softBreak></softBreak>' +
- 'Bar<softBreak></softBreak>' +
- 'Biz' +
- '</codeBlock>' +
- '<paragraph>A<softBreak></softBreak>B</paragraph>'
- );
- expect( editor.getData() ).to.equal( '<pre><code class="language-plaintext">Foo\nBar\nBiz</code></pre><p>A<br>B</p>' );
- } );
- it( 'should convert codeBlock with softBreaks to pre tag #2', () => {
- setModelData( model,
- '<codeBlock language="plaintext">' +
- '<softBreak></softBreak>' +
- '<softBreak></softBreak>' +
- 'Foo' +
- '<softBreak></softBreak>' +
- '<softBreak></softBreak>' +
- '</codeBlock>'
- );
- expect( editor.getData() ).to.equal( '<pre><code class="language-plaintext">\n\nFoo\n\n</code></pre>' );
- } );
- it( 'should convert codeBlock with html content', () => {
- setModelData( model, '<codeBlock language="plaintext">[]</codeBlock>' );
- model.change( writer => writer.insertText( '<div><p>Foo</p></div>', model.document.selection.getFirstPosition() ) );
- expect( editor.getData() ).to.equal(
- '<pre>' +
- '<code class="language-plaintext"><div><p>Foo</p></div></code>' +
- '</pre>' );
- } );
- it( 'should be overridable', () => {
- editor.data.downcastDispatcher.on( 'insert:codeBlock', ( evt, data, api ) => {
- const targetViewPosition = api.mapper.toViewPosition( model.createPositionBefore( data.item ) );
- const code = api.writer.createContainerElement( 'code' );
- api.consumable.consume( data.item, 'insert' );
- api.writer.insert( targetViewPosition, code );
- api.mapper.bindElements( data.item, code );
- }, { priority: 'high' } );
- editor.data.downcastDispatcher.on( 'insert:softBreak', ( evt, data, api ) => {
- const position = api.mapper.toViewPosition( model.createPositionBefore( data.item ) );
- api.consumable.consume( data.item, 'insert' );
- api.writer.insert( position, api.writer.createText( '\n' ) );
- }, { priority: 'highest' } );
- setModelData( model, '<codeBlock language="plaintext">Foo<softBreak></softBreak>Bar</codeBlock>' );
- expect( editor.getData() ).to.equal( '<code>Foo\nBar</code>' );
- } );
- it( 'should not set the class on the <code> if it was configured so', () => {
- const element = document.createElement( 'div' );
- document.body.appendChild( element );
- return ClassicTestEditor
- .create( element, {
- plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph ],
- codeBlock: {
- languages: [
- { language: 'cpp', label: 'C++', class: '' }
- ]
- }
- } )
- .then( newEditor => {
- const editor = newEditor;
- const model = editor.model;
- setModelData( model, '<codeBlock language="cpp">foo</codeBlock>' );
- expect( editor.getData() ).to.equal( '<pre><code>foo</code></pre>' );
- element.remove();
- return editor.destroy();
- } );
- } );
- it( 'should set multiple classes on the <code> if it was configured so', () => {
- const element = document.createElement( 'div' );
- document.body.appendChild( element );
- return ClassicTestEditor
- .create( element, {
- plugins: [ CodeBlockEditing, AlignmentEditing, BoldEditing, Enter, Paragraph ],
- codeBlock: {
- languages: [
- { language: 'javascript', label: 'JavaScript', class: 'language-js' },
- { language: 'swift', label: 'Swift', class: 'swift ios-code' }
- ]
- }
- } )
- .then( editor => {
- const model = editor.model;
- setModelData( model,
- '<codeBlock language="swift">foo</codeBlock>' +
- '<codeBlock language="javascript">foo</codeBlock>'
- );
- expect( editor.getData() ).to.equal(
- '<pre><code class="swift ios-code">foo</code></pre>' +
- '<pre><code class="language-js">foo</code></pre>'
- );
- element.remove();
- return editor.destroy();
- } );
- } );
- } );
- describe( 'data pipeline v -> m conversion ', () => {
- it( 'should not convert empty pre tag to code block', () => {
- editor.setData( '<pre></pre>' );
- expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph>' );
- } );
- it( 'should not convert pre with no code child to code block', () => {
- editor.setData( '<pre><samp></samp></pre>' );
- expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph>' );
- } );
- it( 'should convert pre > code to code block', () => {
- editor.setData( '<pre><code></code></pre>' );
- expect( getModelData( model ) ).to.equal( '<codeBlock language="plaintext">[]</codeBlock>' );
- } );
- it( 'should convert pre > code with multi-line text to code block #1', () => {
- editor.setData( '<pre><code>foo\nbar</code></pre>' );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="plaintext">[]' +
- 'foo' +
- '<softBreak></softBreak>' +
- 'bar' +
- '</codeBlock>'
- );
- } );
- it( 'should convert pre > code with multi-line text to code block #2', () => {
- editor.setData( '<pre><code>\n\nfoo\n\n</code></pre>' );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="plaintext">[]' +
- '<softBreak></softBreak>' +
- '<softBreak></softBreak>' +
- 'foo' +
- '<softBreak></softBreak>' +
- '<softBreak></softBreak>' +
- '</codeBlock>'
- );
- } );
- it( 'should convert pre > code with HTML inside', () => {
- editor.setData( '<pre><code><p>Foo</p>\n<p>Bar</p></code></pre>' );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="plaintext">[]' +
- '<p>Foo</p>' +
- '<softBreak></softBreak>' +
- '<p>Bar</p>' +
- '</codeBlock>'
- );
- } );
- it( 'should convert pre > code tag with HTML and nested pre > code tag', () => {
- editor.setData( '<pre><code><p>Foo</p><pre>Bar</pre><p>Biz</p></code></pre>' );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="plaintext">[]<p>Foo</p><pre>Bar</pre><p>Biz</p></codeBlock>' );
- } );
- it( 'should convert pre > code tag with escaped html content', () => {
- editor.setData( '<pre><code><div><p>Foo</p></div></code></pre>' );
- expect( getModelData( model ) ).to.equal( '<codeBlock language="plaintext">[]<div><p>Foo</p></div></codeBlock>' );
- } );
- it( 'should be overridable', () => {
- editor.data.upcastDispatcher.on( 'element:pre', ( evt, data, api ) => {
- const modelItem = api.writer.createElement( 'codeBlock' );
- api.writer.appendText( 'Hello World!', modelItem );
- api.writer.insert( modelItem, data.modelCursor );
- api.consumable.consume( data.viewItem, { name: true } );
- data.modelCursor = api.writer.createPositionAfter( modelItem );
- data.modelRange = api.writer.createRangeOn( modelItem );
- }, { priority: 'high' } );
- editor.setData( '<pre><code>Foo Bar</code></pre>' );
- expect( getModelData( model ) ).to.equal( '<codeBlock>[]Hello World!</codeBlock>' );
- } );
- it( 'should split parents to correctly upcast the code block', () => {
- editor.setData( '<p>foo<pre><code>x</code></pre>bar</p>' );
- // Note: The empty <paragraph> should not be here. It's a conversion/auto–paragraphing bug.
- expect( getModelData( model ) ).to.equal(
- '<paragraph>[]foo</paragraph>' +
- '<codeBlock language="plaintext">x</codeBlock>' +
- '<paragraph>bar</paragraph>' +
- '<paragraph></paragraph>' );
- } );
- it( 'should upcast two code blocks in a row (#1)', () => {
- editor.setData( '<pre><code>foo</code></pre><pre><code>bar</code></pre>' );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="plaintext">[]foo</codeBlock><codeBlock language="plaintext">bar</codeBlock>' );
- } );
- it( 'should upcast two code blocks in a row (#2)', () => {
- editor.setData( `<pre><code>foo</code></pre>
- <pre><code>bar</code></pre>` );
- // Note: The empty <paragraph> in between should not be here. It's a conversion/auto–paragraphing bug.
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="plaintext">[]foo</codeBlock>' +
- '<paragraph> </paragraph>' +
- '<codeBlock language="plaintext">bar</codeBlock>' );
- } );
- it( 'should not convert when modelCursor and its ancestors disallow to insert codeBlock', () => {
- model.document.createRoot( '$title', 'title' );
- model.schema.register( '$title', {
- disallow: '$block',
- allow: 'inline'
- } );
- editor.data.set( { title: '<pre><code>foo</code></pre>' } );
- expect( getModelData( model, { rootName: 'title', withoutSelection: true } ) ).to.equal( '' );
- } );
- describe( 'config.codeBlock.languages', () => {
- it( 'should be respected when upcasting', () => {
- return ClassicTestEditor.create(
- '<pre><code class="language-foo">bar</code></pre>' +
- '<pre><code class="language-bar">baz</code></pre>' +
- '<pre><code class="qux">qux</code></pre>',
- {
- plugins: [ CodeBlockEditing ],
- codeBlock: {
- languages: [
- { language: 'foo', label: 'Foo' },
- { language: 'bar', label: 'Bar' },
- { language: 'qux', label: 'Qux', class: 'qux' }
- ]
- }
- } )
- .then( editor => {
- model = editor.model;
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="foo">[]bar</codeBlock>' +
- '<codeBlock language="bar">baz</codeBlock>' +
- '<codeBlock language="qux">qux</codeBlock>'
- );
- return editor.destroy();
- } );
- } );
- it( 'should be respected when upcasting and a language has an empty class configured', () => {
- return ClassicTestEditor.create(
- '<pre><code class="language-foo">bar</code></pre>' +
- '<pre><code class="language-bar">baz</code></pre>' +
- '<pre><code>qux</code></pre>',
- {
- plugins: [ CodeBlockEditing ],
- codeBlock: {
- languages: [
- { language: 'foo', label: 'Foo' },
- { language: 'bar', label: 'Bar' },
- { language: 'qux', label: 'Qux', class: '' }
- ]
- }
- } )
- .then( editor => {
- model = editor.model;
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="foo">[]bar</codeBlock>' +
- '<codeBlock language="bar">baz</codeBlock>' +
- '<codeBlock language="qux">qux</codeBlock>'
- );
- return editor.destroy();
- } );
- } );
- it( 'should upcast using the first language if the code in data has no language', () => {
- return ClassicTestEditor
- .create( '<pre><code>bar</code></pre>', {
- plugins: [ CodeBlockEditing ],
- codeBlock: {
- languages: [
- { language: 'foo', label: 'Foo' },
- { language: 'bar', label: 'Bar' }
- ]
- }
- } )
- .then( editor => {
- model = editor.model;
- expect( getModelData( model ) ).to.equal( '<codeBlock language="foo">[]bar</codeBlock>' );
- return editor.destroy();
- } );
- } );
- it( 'should upast using the first language if the code in data has an invalid language', () => {
- return ClassicTestEditor
- .create( '<pre><code class="baz">bar</code></pre>', {
- plugins: [ CodeBlockEditing ],
- codeBlock: {
- languages: [
- { language: 'foo', label: 'Foo' },
- { language: 'bar', label: 'Bar' }
- ]
- }
- } )
- .then( editor => {
- model = editor.model;
- expect( getModelData( model ) ).to.equal( '<codeBlock language="foo">[]bar</codeBlock>' );
- return editor.destroy();
- } );
- } );
- // https://github.com/ckeditor/ckeditor5/issues/5924
- it( 'should upcast using only the first class from config as a defining language class', () => {
- // "baz" is the first class configured for the "baz" language.
- return ClassicTestEditor.create( '<pre><code class="baz">foo</code></pre>', {
- plugins: [ CodeBlockEditing ],
- codeBlock: {
- languages: [
- { language: 'foo', label: 'Foo', class: 'foo' },
- { language: 'baz', label: 'Baz', class: 'baz bar' },
- { language: 'qux', label: 'Qux', class: 'qux' }
- ]
- }
- } ).then( editor => {
- model = editor.model;
- expect( getModelData( model ) ).to.equal( '<codeBlock language="baz">[]foo</codeBlock>' );
- return editor.destroy();
- } );
- } );
- // https://github.com/ckeditor/ckeditor5/issues/5924
- it( 'should not upcast if the class is not the first (defining) language class', () => {
- // "bar" is the second class configured for the "baz" language.
- return ClassicTestEditor.create( '<pre><code class="bar">foo</code></pre>', {
- plugins: [ CodeBlockEditing ],
- codeBlock: {
- languages: [
- { language: 'foo', label: 'Foo', class: 'foo' },
- { language: 'baz', label: 'Baz', class: 'baz bar' },
- { language: 'qux', label: 'Qux', class: 'qux' }
- ]
- }
- } ).then( editor => {
- model = editor.model;
- expect( getModelData( model ) ).to.equal( '<codeBlock language="foo">[]foo</codeBlock>' );
- return editor.destroy();
- } );
- } );
- } );
- } );
- describe( 'clipboard integration', () => {
- it( 'should not intercept input when selection anchored outside any code block', () => {
- setModelData( model, '<paragraph>f[]oo</paragraph>' );
- const dataTransferMock = {
- getData: sinon.stub().withArgs( 'text/plain' ).returns( 'bar' )
- };
- viewDoc.fire( 'clipboardInput', {
- dataTransfer: dataTransferMock,
- stop: sinon.spy()
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph>f[]oo</paragraph>' );
- sinon.assert.notCalled( dataTransferMock.getData );
- } );
- it( 'should intercept input when selection anchored in the code block', () => {
- setModelData( model, '<codeBlock language="css">f[o]o</codeBlock>' );
- const dataTransferMock = {
- getData: sinon.stub().withArgs( 'text/plain' ).returns( 'bar\nbaz\n' )
- };
- viewDoc.fire( 'clipboardInput', {
- dataTransfer: dataTransferMock,
- stop: sinon.spy()
- } );
- expect( getModelData( model ) ).to.equal(
- '<codeBlock language="css">' +
- 'fbar' +
- '<softBreak></softBreak>' +
- 'baz' +
- '<softBreak></softBreak>' +
- '[]o' +
- '</codeBlock>' );
- sinon.assert.calledOnce( dataTransferMock.getData );
- } );
- describe( 'getSelectedContent()', () => {
- it( 'should not engage when there is nothing selected', () => {
- setModelData( model, '<codeBlock language="css">fo[]o<softBreak></softBreak>bar</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal( '' );
- } );
- it( 'should wrap a partial multi-line selection into a code block (#1)', () => {
- setModelData( model, '<codeBlock language="css">fo[o<softBreak></softBreak>b]ar</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
- '<codeBlock language="css">o<softBreak></softBreak>b</codeBlock>'
- );
- } );
- it( 'should wrap a partial multi-line selection into a code block (#2)', () => {
- setModelData( model, '<codeBlock language="css">fo[o<softBreak></softBreak>]bar</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
- '<codeBlock language="css">o<softBreak></softBreak></codeBlock>'
- );
- } );
- it( 'should wrap a partial multi-line selection into a code block (#3)', () => {
- setModelData( model, '<codeBlock language="css">[foo<softBreak></softBreak>bar]</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
- '<codeBlock language="css">foo<softBreak></softBreak>bar</codeBlock>'
- );
- } );
- it( 'should wrap a complete single-line selection into a code block', () => {
- setModelData( model, '<codeBlock language="css">[foo]</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
- '<codeBlock language="css">foo</codeBlock>'
- );
- } );
- it( 'should wrap a partial single-line selection into an inline code (#1)', () => {
- model.schema.extend( '$text', {
- allowAttributes: 'code'
- } );
- setModelData( model, '<codeBlock language="css">[fo]o<softBreak></softBreak>bar</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
- '<$text code="true">fo</$text>'
- );
- } );
- it( 'should wrap a partial single-line selection into an inline code (#2)', () => {
- model.schema.extend( '$text', {
- allowAttributes: 'code'
- } );
- setModelData( model, '<codeBlock language="css">foo<softBreak></softBreak>b[a]r</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
- '<$text code="true">a</$text>'
- );
- } );
- it( 'should now wrap a partial single-line selection into an inline code when the attribute is disallowed', () => {
- setModelData( model, '<codeBlock language="css">foo<softBreak></softBreak>b[a]r</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal( 'a' );
- } );
- it( 'should preserve a code block in a cross-selection (#1)', () => {
- setModelData( model,
- '<paragraph>[x</paragraph><codeBlock language="css">fo]o<softBreak></softBreak>bar</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
- '<paragraph>x</paragraph><codeBlock language="css">fo</codeBlock>'
- );
- } );
- it( 'should preserve a code block in a cross-selection (#2)', () => {
- setModelData( model,
- '<paragraph>[x</paragraph><codeBlock language="css">foo<softBreak></softBreak>b]ar</codeBlock>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
- '<paragraph>x</paragraph><codeBlock language="css">foo<softBreak></softBreak>b</codeBlock>'
- );
- } );
- it( 'should preserve a code block in a cross-selection (#3)', () => {
- setModelData( model,
- '<codeBlock language="css">foo<softBreak></softBreak>b[ar</codeBlock><paragraph>x]</paragraph>' );
- expect( stringify( model.getSelectedContent( model.document.selection ) ) ).to.equal(
- '<codeBlock language="css">ar</codeBlock><paragraph>x</paragraph>'
- );
- } );
- } );
- } );
- } );
|