| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- import Paragraph from '../src/paragraph';
- import ParagraphCommand from '../src/paragraphcommand';
- import InsertParagraphCommand from '../src/insertparagraphcommand';
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import {
- getData as getModelData,
- setData as setModelData,
- stringify as stringifyModel
- } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
- import ModelDocumentFragment from '@ckeditor/ckeditor5-engine/src/model/documentfragment';
- import ModelText from '@ckeditor/ckeditor5-engine/src/model/text';
- describe( 'Paragraph feature', () => {
- let model, editor, doc, root;
- beforeEach( () => {
- return VirtualTestEditor
- .create( { plugins: [ Paragraph ] } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- doc = model.document;
- root = doc.getRoot();
- } );
- } );
- it( 'should be loaded', () => {
- expect( editor.plugins.get( Paragraph ) ).to.be.instanceOf( Paragraph );
- } );
- it( 'should set proper schema rules', () => {
- expect( model.schema.isRegistered( 'paragraph' ) ).to.be.true;
- expect( model.schema.checkChild( [ '$root' ], 'paragraph' ) ).to.be.true;
- expect( model.schema.checkChild( [ 'paragraph' ], '$text' ) ).to.be.true;
- } );
- it( 'should have a static paragraphLikeElements property', () => {
- expect( Paragraph ).to.have.property( 'paragraphLikeElements' );
- } );
- describe( 'data pipeline conversions', () => {
- it( 'should convert paragraph', () => {
- editor.setData( '<p>foobar</p>' );
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal( '<paragraph>foobar</paragraph>' );
- expect( editor.getData() ).to.equal( '<p>foobar</p>' );
- } );
- it( 'should convert paragraph only', () => {
- editor.setData( '<p>foo<b>baz</b>bar</p>' );
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal( '<paragraph>foobazbar</paragraph>' );
- expect( editor.getData() ).to.equal( '<p>foobazbar</p>' );
- } );
- it( 'should convert multiple paragraphs', () => {
- editor.setData( '<p>foo</p><p>baz</p>' );
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal( '<paragraph>foo</paragraph><paragraph>baz</paragraph>' );
- expect( editor.getData() ).to.equal( '<p>foo</p><p>baz</p>' );
- } );
- describe( 'generic text converter (text autoparagraphing)', () => {
- it( 'should autoparagraph text', () => {
- editor.setData( 'foo' );
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal( '<paragraph>foo</paragraph>' );
- expect( editor.getData() ).to.equal( '<p>foo</p>' );
- } );
- it( 'should autoparagraph any inline element', () => {
- editor.model.schema.register( 'inline', { allowWhere: '$text' } );
- editor.model.schema.extend( '$text', { allowIn: 'inline' } );
- editor.conversion.for( 'downcast' ).elementToElement( { model: 'inline', view: 'span' } );
- editor.conversion.for( 'upcast' ).elementToElement( { model: 'inline', view: 'span' } );
- editor.setData( '<span>foo</span>' );
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal( '<paragraph><inline>foo</inline></paragraph>' );
- expect( editor.getData() ).to.equal( '<p><span>foo</span></p>' );
- } );
- it( 'should autoparagraph any inline element with children', () => {
- editor.model.schema.register( 'inline', { allowWhere: '$text' } );
- editor.model.schema.extend( '$text', { allowIn: 'inline' } );
- editor.conversion.for( 'downcast' ).elementToElement( { model: 'inline', view: 'span' } );
- editor.conversion.for( 'upcast' ).elementToElement( { model: 'inline', view: 'span' } );
- editor.setData( '<span>f<b>123</b>oo</span>' );
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal( '<paragraph><inline>f123oo</inline></paragraph>' );
- expect( editor.getData() ).to.equal( '<p><span>f123oo</span></p>' );
- } );
- it( 'should not autoparagraph text (in clipboard holder)', () => {
- const modelFragment = editor.data.parse( 'foo', [ '$clipboardHolder' ] );
- expect( stringifyModel( modelFragment ) )
- .to.equal( 'foo' );
- } );
- it( 'should not autoparagraph text (in a context which does not allow paragraphs', () => {
- model.schema.register( 'specialRoot' );
- const modelFragment = editor.data.parse( 'foo', [ 'specialRoot' ] );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '' );
- } );
- it( 'should autoparagraph text next to allowed element', () => {
- model.schema.register( 'heading1', { inheritAllFrom: '$block' } );
- editor.conversion.for( 'upcast' ).elementToElement( { model: 'heading1', view: 'h1' } );
- const modelFragment = editor.data.parse( '<h1>foo</h1>bar<p>bom</p>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<heading1>foo</heading1><paragraph>bar</paragraph><paragraph>bom</paragraph>' );
- } );
- it( 'should autoparagraph 3 inline nodes into one paragraph', () => {
- const modelFragment = editor.data.parse( 'foo<b>bar</b>bom' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>foobarbom</paragraph>' );
- } );
- it( 'should not autoparagraph 3 inline nodes (in clipboardHolder)', () => {
- const modelFragment = editor.data.parse( 'foo<b>bar</b>bom', [ '$clipboardHolder' ] );
- expect( stringifyModel( modelFragment ) )
- .to.equal( 'foobarbom' );
- } );
- it( 'should autoparagraph text inside converted container', () => {
- model.schema.register( 'div' );
- model.schema.extend( 'div', { allowIn: '$root' } );
- model.schema.extend( 'paragraph', { allowIn: 'div' } );
- editor.conversion.for( 'upcast' ).elementToElement( { model: 'div', view: 'div' } );
- const modelFragment = editor.data.parse( '<div>foo</div><div>bom<p>bim</p></div>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal(
- '<div><paragraph>foo</paragraph></div>' +
- '<div><paragraph>bom</paragraph><paragraph>bim</paragraph></div>'
- );
- } );
- it( 'should autoparagraph text inside disallowed element next to allowed element', () => {
- model.schema.register( 'heading1', { inheritAllFrom: '$block' } );
- editor.conversion.for( 'upcast' ).elementToElement( { model: 'heading1', view: 'h1' } );
- const modelFragment = editor.data.parse( '<div><h1>foo</h1>bar</div>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<heading1>foo</heading1><paragraph>bar</paragraph>' );
- } );
- it( 'should not autoparagraph text in disallowed element', () => {
- model.schema.register( 'heading1', { inheritAllFrom: '$block' } );
- editor.conversion.for( 'upcast' ).elementToElement( { model: 'heading1', view: 'h1' } );
- const modelFragment = editor.data.parse( '<h1><b>foo</b>bar</h1>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<heading1>foobar</heading1>' );
- } );
- it( 'should not fail when text is not allowed in paragraph', () => {
- model.schema.addChildCheck( ( ctx, childDef ) => {
- if ( ctx.endsWith( '$root paragraph' ) && childDef.name == '$text' ) {
- return false;
- }
- } );
- const modelFragment = editor.data.parse( 'foo' );
- expect( stringifyModel( modelFragment ) ).to.equal( '' );
- } );
- it( 'creates normalized model', () => {
- const modelFragment = editor.data.parse( 'foo<b>bar</b>bom' );
- expect( modelFragment ).to.be.instanceof( ModelDocumentFragment );
- expect( modelFragment.getChild( 0 ).childCount ).to.equal( 1 );
- expect( modelFragment.getChild( 0 ).getChild( 0 ) ).to.be.instanceOf( ModelText );
- } );
- // This test was taken from the list package.
- it( 'does not break when some converter returns nothing', () => {
- editor.data.upcastDispatcher.on( 'element:li', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.viewItem, { name: true } );
- }, { priority: 'highest' } );
- const modelFragment = editor.data.parse( '<ul><li></li></ul>' );
- expect( stringifyModel( modelFragment ) ).to.equal( '' );
- } );
- describe( 'should not strip attribute elements when autoparagraphing texts', () => {
- beforeEach( () => {
- model.schema.extend( '$text', { allowAttributes: 'bold' } );
- editor.conversion.for( 'upcast' ).elementToAttribute( { view: 'b', model: 'bold' } );
- } );
- it( 'inside document fragment', () => {
- const modelFragment = editor.data.parse( 'foo<b>bar</b>bom' );
- expect( stringifyModel( modelFragment ) ).to.equal( '<paragraph>foo<$text bold="true">bar</$text>bom</paragraph>' );
- } );
- it( 'inside converted element', () => {
- model.schema.register( 'blockQuote', { allowIn: '$root' } );
- model.schema.extend( '$block', { allowIn: 'blockQuote' } );
- editor.conversion.for( 'upcast' ).elementToElement( { model: 'blockQuote', view: 'blockquote' } );
- const modelFragment = editor.data.parse( '<blockquote>foo<b>bar</b>bom</blockquote>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<blockQuote><paragraph>foo<$text bold="true">bar</$text>bom</paragraph></blockQuote>' );
- } );
- it( 'inside paragraph-like element', () => {
- const modelFragment = editor.data.parse( '<h1>foo</h1><h2><b>bar</b>bom</h2>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>foo</paragraph><paragraph><$text bold="true">bar</$text>bom</paragraph>' );
- } );
- } );
- } );
- describe( 'generic block converter (paragraph-like element handling)', () => {
- it( 'should convert h1+h2', () => {
- const modelFragment = editor.data.parse( '<h1>foo</h1><h2>bar</h2>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>foo</paragraph><paragraph>bar</paragraph>' );
- } );
- it( 'should convert h1+h2 (in clipboard holder)', () => {
- const modelFragment = editor.data.parse( '<h1>foo</h1><h2>bar</h2>', [ '$clipboardHolder' ] );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>foo</paragraph><paragraph>bar</paragraph>' );
- } );
- it( 'should not convert h1+h2 (in a context which does not allow paragraphs)', () => {
- model.schema.register( 'div' );
- model.schema.register( 'specialRoot' );
- model.schema.extend( 'div', { allowIn: 'specialRoot' } );
- model.schema.extend( '$text', { allowIn: 'div' } );
- editor.conversion.for( 'upcast' ).elementToElement( { model: 'div', view: 'div' } );
- const modelFragment = editor.data.parse( '<h1>foo</h1><h2>bar</h2><div>bom</div>', [ 'specialRoot' ] );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<div>bom</div>' );
- } );
- it( 'should convert ul,ol>li', () => {
- const modelFragment = editor.data.parse( '<ul><li>a</li><li>b</li></ul><ol><li>c</li></ol>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>a</paragraph><paragraph>b</paragraph><paragraph>c</paragraph>' );
- } );
- it( 'should convert ul,ol>li (in clipboard holder)', () => {
- const modelFragment = editor.data.parse( '<ul><li>a</li><li>b</li></ul><ol><li>c</li></ol>', [ '$clipboardHolder' ] );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>a</paragraph><paragraph>b</paragraph><paragraph>c</paragraph>' );
- } );
- it( 'should convert ul>li>ul>li+li', () => {
- const modelFragment = editor.data.parse( '<ul><li>a<ul><li>b</li><li>c</li></ul></li></ul>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>a</paragraph><paragraph>b</paragraph><paragraph>c</paragraph>' );
- } );
- // "b" is not autoparagraphed because clipboard holder allows text nodes.
- // There's a similar integrational test what's going to happen when pasting in paragraph-integration.js.
- it( 'should convert ul>li>ul>li+li (in clipboard holder)', () => {
- const modelFragment = editor.data.parse( '<ul><li>a<ul><li>b</li><li>c</li></ul></li></ul>', [ '$clipboardHolder' ] );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>a</paragraph><paragraph>b</paragraph><paragraph>c</paragraph>' );
- } );
- it( 'should convert ul>li>p,text', () => {
- const modelFragment = editor.data.parse( '<ul><li><p>a</p>b</li></ul>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>a</paragraph><paragraph>b</paragraph>' );
- } );
- it( 'should convert ul>li>p,text (in clipboard holder)', () => {
- const modelFragment = editor.data.parse( '<ul><li><p>a</p>b</li></ul>', [ '$clipboardHolder' ] );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>a</paragraph><paragraph>b</paragraph>' );
- } );
- it( 'should convert td', () => {
- const modelFragment = editor.data.parse(
- '<table><tr><td>a</td><td>b</td></tr><tr><td>c</td><td>d</td></tr></table>'
- );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>a</paragraph><paragraph>b</paragraph><paragraph>c</paragraph><paragraph>d</paragraph>' );
- } );
- it( 'should convert td (in clipboardHolder)', () => {
- const modelFragment = editor.data.parse(
- '<table><tr><td>a</td><td>b</td></tr><tr><td>c</td><td>d</td></tr></table>',
- [ '$clipboardHolder' ]
- );
- expect( stringifyModel( modelFragment ) )
- .to.equal( '<paragraph>a</paragraph><paragraph>b</paragraph><paragraph>c</paragraph><paragraph>d</paragraph>' );
- } );
- it( 'should convert li inside converted container', () => {
- model.schema.register( 'div' );
- model.schema.extend( 'div', { allowIn: '$root' } );
- model.schema.extend( 'paragraph', { allowIn: 'div' } );
- editor.conversion.for( 'upcast' ).elementToElement( { model: 'div', view: 'div' } );
- const modelFragment = editor.data.parse( '<div><ul><li>foo</li><li>bar</li></ul></div><div>bom<p>bim</p></div>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal(
- '<div><paragraph>foo</paragraph><paragraph>bar</paragraph></div>' +
- '<div><paragraph>bom</paragraph><paragraph>bim</paragraph></div>'
- );
- } );
- it( 'should convert li inside disallowed container', () => {
- const modelFragment = editor.data.parse( '<div><ul><li>foo</li><li>bar</li></ul></div><div>bom<p>bim</p></div>' );
- expect( stringifyModel( modelFragment ) )
- .to.equal(
- '<paragraph>foo</paragraph><paragraph>bar</paragraph>' +
- '<paragraph>bom</paragraph><paragraph>bim</paragraph>'
- );
- } );
- it( 'creates normalized model', () => {
- const modelFragment = editor.data.parse( '<h1><span>foo</span><span>bar</span>' );
- expect( stringifyModel( modelFragment ) ).to.equal( '<paragraph>foobar</paragraph>' );
- expect( modelFragment ).to.be.instanceof( ModelDocumentFragment );
- expect( modelFragment.getChild( 0 ).childCount ).to.equal( 1 );
- expect( modelFragment.getChild( 0 ).getChild( 0 ) ).to.be.instanceOf( ModelText );
- } );
- it( 'should not convert empty elements', () => {
- const modelFragment = editor.data.parse( '<ul><li></li><ul>' );
- expect( stringifyModel( modelFragment ) ).to.equal( '' );
- } );
- } );
- } );
- describe( 'editing pipeline conversion', () => {
- it( 'should convert paragraph', () => {
- setModelData( model, '<paragraph>foo</paragraph><paragraph>bar</paragraph>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal( '<p>foo</p><p>bar</p>' );
- } );
- } );
- describe( 'autoparagraphing on data load', () => {
- it( 'wraps text and place selection at the beginning of that paragraph', () => {
- editor.setData( 'foo' );
- expect( getModelData( model ) ).to.equal( '<paragraph>[]foo</paragraph>' );
- } );
- } );
- describe( 'post-fixing empty roots', () => {
- it( 'should fix empty roots after editor is initialised', () => {
- expect( doc.getRoot().childCount ).to.equal( 1 );
- expect( doc.getRoot().getChild( 0 ).is( 'element', 'paragraph' ) ).to.be.true;
- } );
- it( 'should fix root if it becomes empty', () => {
- editor.setData( '<p>Foobar</p>' );
- // Since `setData` first removes all contents from editor and then sets content during same enqueue
- // change block, the line below checks whether fixing empty roots does not kick too early and does not
- // fix root if it is not needed.
- expect( editor.getData() ).to.equal( '<p>Foobar</p>' );
- model.change( writer => {
- writer.remove( writer.createRangeIn( root ) );
- } );
- expect( doc.getRoot().childCount ).to.equal( 1 );
- expect( doc.getRoot().getChild( 0 ).is( 'element', 'paragraph' ) ).to.be.true;
- } );
- it( 'should not fix root which does not allow paragraph', () => {
- model.schema.addChildCheck( ( ctx, childDef ) => {
- if ( ctx.endsWith( '$root' ) && childDef.name == 'paragraph' ) {
- return false;
- }
- } );
- model.change( writer => {
- writer.remove( writer.createRangeIn( root ) );
- } );
- expect( editor.getData() ).to.equal( '' );
- } );
- it( 'should fix empty roots in the right batch', () => {
- let removeBatch, attributeBatch;
- model.enqueueChange( writer => {
- removeBatch = writer.batch;
- writer.remove( writer.createRangeIn( root ) );
- model.enqueueChange( writer => {
- attributeBatch = writer.batch;
- writer.setAttribute( 'foo', 'bar', root );
- } );
- } );
- expect( Array.from( removeBatch.operations, operation => operation.type ) ).to.include.members( [ 'insert' ] );
- expect( Array.from( attributeBatch.operations, operation => operation.type ) ).to.not.include.members( [ 'insert' ] );
- } );
- } );
- describe( 'commands', () => {
- it( '"paragraph" command should be registered in the editor', () => {
- expect( editor.commands.get( 'paragraph' ) ).to.be.instanceof( ParagraphCommand );
- } );
- it( '"insertParagraph" command should be registered in the editor', () => {
- expect( editor.commands.get( 'insertParagraph' ) ).to.be.instanceof( InsertParagraphCommand );
- } );
- } );
- } );
|