| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273 |
- /**
- * @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 VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import PageBreakEditing from '../src/pagebreakediting';
- import PageBreakCommand from '../src/pagebreakcommand';
- import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
- import { isWidget } from '@ckeditor/ckeditor5-widget/src/utils';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- describe( 'PageBreakEditing', () => {
- let editor, model, view, viewDocument;
- testUtils.createSinonSandbox();
- beforeEach( () => {
- return VirtualTestEditor
- .create( {
- plugins: [ PageBreakEditing ]
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- view = editor.editing.view;
- viewDocument = view.document;
- } );
- } );
- it( 'should have pluginName', () => {
- expect( PageBreakEditing.pluginName ).to.equal( 'PageBreakEditing' );
- } );
- it( 'should be loaded', () => {
- expect( editor.plugins.get( PageBreakEditing ) ).to.be.instanceOf( PageBreakEditing );
- } );
- it( 'should set proper schema rules', () => {
- expect( model.schema.checkChild( [ '$root' ], 'pageBreak' ) ).to.be.true;
- expect( model.schema.isObject( 'pageBreak' ) ).to.be.true;
- expect( model.schema.checkChild( [ '$root', 'pageBreak' ], '$text' ) ).to.be.false;
- expect( model.schema.checkChild( [ '$root', '$block' ], 'pageBreak' ) ).to.be.false;
- } );
- it( 'should register imageInsert command', () => {
- expect( editor.commands.get( 'pageBreak' ) ).to.be.instanceOf( PageBreakCommand );
- } );
- describe( 'conversion in data pipeline', () => {
- describe( 'model to view', () => {
- it( 'should convert', () => {
- setModelData( model, '<pageBreak></pageBreak>' );
- expect( editor.getData() ).to.equal(
- '<div class="page-break" style="page-break-after:always;"><span style="display:none;"> </span></div>'
- );
- } );
- } );
- describe( 'view to model', () => {
- it( 'should convert the page break code element without `.page-break` class', () => {
- editor.setData(
- '<div style="page-break-after:always;">' +
- '<span style="display:none;"> </span>' +
- '</div>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<pageBreak></pageBreak>' );
- } );
- it( 'should convert the page break code element with `.page-break` class', () => {
- editor.setData(
- '<div class="page-break" style="page-break-after:always;">' +
- '<span style="display:none;"> </span>' +
- '</div>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<pageBreak></pageBreak>' );
- } );
- it( 'should not convert in wrong context', () => {
- model.schema.register( 'div', { inheritAllFrom: '$block' } );
- model.schema.addChildCheck( ( ctx, childDef ) => {
- if ( ctx.endsWith( '$root' ) && childDef.name == 'pageBreak' ) {
- return false;
- }
- } );
- editor.conversion.elementToElement( { model: 'div', view: 'div' } );
- editor.setData(
- '<div>' +
- '<div class="page-break" style="page-break-after:always;">' +
- '<span style="display:none;"> </span>' +
- '</div>' +
- '</div>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<div> </div>' );
- } );
- it( 'should not convert if outer div has wrong styles', () => {
- editor.setData( '<div class="page-break" style="page-break-after:auto;"><span style="display:none;"> </span></div>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should convert if outer div has no children', () => {
- editor.setData( '<div class="page-break" style="page-break-after:always;"></div>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<pageBreak></pageBreak>' );
- } );
- it( 'should convert if outer div has page-break-before style', () => {
- editor.setData( '<div class="page-break" style="page-break-before:always;"></div>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<pageBreak></pageBreak>' );
- } );
- it( 'should convert if outer div has page-break-after style', () => {
- editor.setData( '<div class="page-break" style="page-break-after:always;"></div>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<pageBreak></pageBreak>' );
- } );
- it( 'should convert if page-break-after style is on br element', () => {
- editor.setData( '<br style="page-break-after:always;"/>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<pageBreak></pageBreak>' );
- } );
- it( 'should convert if page-break-before style is on br element', () => {
- editor.setData( '<br style="page-break-after:always;"/>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<pageBreak></pageBreak>' );
- } );
- it( 'should not convert if outer div has too many children', () => {
- editor.setData(
- '<div class="page-break" style="page-break-after:always;">' +
- '<span style="display:none;"> </span>' +
- '<span style="display:none;"> </span>' +
- '</div>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if inner span has wrong styles', () => {
- editor.setData(
- '<div class="page-break" style="page-break-after:always;">' +
- '<span style="display:inline-block;"> </span>' +
- '</div>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if inner span has any children', () => {
- editor.setData(
- '<div class="page-break" style="page-break-after:always;">' +
- '<span style="display:none;">' +
- '<span>Foo</span>' +
- '</span>' +
- '</div>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if inner span has text', () => {
- editor.setData(
- '<div class="page-break" style="page-break-after:always;">' +
- '<span style="display:none;">Foo</span>' +
- '</div>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert inner span if outer div was already consumed', () => {
- model.schema.register( 'section', { inheritAllFrom: '$block' } );
- editor.conversion.elementToElement( { model: 'section', view: 'section' } );
- model.schema.register( 'span', { inheritAllFrom: '$block' } );
- editor.model.schema.extend( '$text', { allowAttributes: 'foo' } );
- editor.conversion.attributeToElement( {
- model: 'foo',
- view: {
- name: 'span',
- styles: {
- display: 'none'
- }
- }
- } );
- editor.setData(
- '<section>' +
- '<div class="page-break" style="page-break-after:always;">' +
- '<span style="display:none;"> </span>' +
- '</div>' +
- '<span style="display:none;">Foo</span>' +
- '</section>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<pageBreak></pageBreak><section><$text foo="true">Foo</$text></section>' );
- } );
- it( 'should not convert if inner span has no children', () => {
- editor.setData( '<div class="page-break" style="page-break-after:always;"><span style="display:none;"></span></div>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- it( 'should not convert if inner span has other element as a child', () => {
- editor.setData(
- '<div class="page-break" style="page-break-after:always;">' +
- '<span style="display:none;">' +
- '<span></span>' +
- '</span>' +
- '</div>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '' );
- } );
- } );
- } );
- describe( 'conversion in editing pipeline', () => {
- describe( 'model to view', () => {
- it( 'should convert', () => {
- setModelData( model, '<pageBreak></pageBreak>' );
- expect( getViewData( view, { withoutSelection: true } ) ).to.equal(
- '<div class="ck-widget page-break" contenteditable="false"><span class="page-break__label">Page break</span></div>'
- );
- } );
- it( 'converted element should be widgetized', () => {
- setModelData( model, '<pageBreak></pageBreak>' );
- const widget = viewDocument.getRoot().getChild( 0 );
- expect( widget.name ).to.equal( 'div' );
- expect( isPageBreakWidget( widget ) ).to.be.true;
- } );
- } );
- } );
- function isPageBreakWidget( viewElement ) {
- return !!viewElement.getCustomProperty( 'pageBreak' ) && isWidget( viewElement );
- }
- } );
|