/**
* @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
import InlineAutoformatEngine from '../src/inlineautoformatengine';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
import Enter from '@ckeditor/ckeditor5-enter/src/enter';
import { setData, getData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
testUtils.createSinonSandbox();
describe( 'InlineAutoformatEngine', () => {
let editor, model, doc;
beforeEach( () => {
return VirtualTestEditor
.create( {
plugins: [ Enter, Paragraph ]
} )
.then( newEditor => {
editor = newEditor;
model = editor.model;
doc = model.document;
model.schema.allow( { name: '$inline', attributes: [ 'testAttribute' ] } );
} );
} );
describe( 'attribute', () => {
it( 'should stop early if there are less than 3 capture groups', () => {
new InlineAutoformatEngine( editor, /(\*)(.+?)\*/g, 'testAttribute' ); // eslint-disable-line no-new
setData( model, '*foobar[]' );
model.change( writer => {
writer.insertText( '*', doc.selection.getFirstPosition() );
} );
expect( getData( model ) ).to.equal( '*foobar*[]' );
} );
it( 'should apply an attribute when the pattern is matched', () => {
new InlineAutoformatEngine( editor, /(\*)(.+?)(\*)/g, 'testAttribute' ); // eslint-disable-line no-new
setData( model, '*foobar[]' );
model.change( writer => {
writer.insertText( '*', doc.selection.getFirstPosition() );
} );
expect( getData( model ) ).to.equal( '<$text testAttribute="true">foobar$text>[]' );
} );
it( 'should not apply an attribute when changes are in transparent batch', () => {
new InlineAutoformatEngine( editor, /(\*)(.+?)(\*)/g, 'testAttribute' ); // eslint-disable-line no-new
setData( model, '*foobar[]' );
model.enqueueChange( 'transparent', writer => {
writer.insertText( '*', doc.selection.getFirstPosition() );
} );
expect( getData( model ) ).to.equal( '*foobar*[]' );
} );
it( 'should stop early if selection is not collapsed', () => {
new InlineAutoformatEngine( editor, /(\*)(.+?)\*/g, 'testAttribute' ); // eslint-disable-line no-new
setData( model, '*foob[ar]' );
model.change( writer => {
writer.insertText( '*', doc.selection.getFirstPosition() );
} );
expect( getData( model ) ).to.equal( '*foob*[ar]' );
} );
} );
describe( 'Callback', () => {
it( 'should not run a callback when changes are in transparent batch', () => {
const spy = testUtils.sinon.spy();
new InlineAutoformatEngine( editor, /(\*)(.+?)(\*)/g, spy ); // eslint-disable-line no-new
setData( model, '*foobar[]' );
model.enqueueChange( 'transparent', writer => {
writer.insertText( '*', doc.selection.getFirstPosition() );
} );
sinon.assert.notCalled( spy );
} );
it( 'should stop when there are no format ranges returned from testCallback', () => {
const formatSpy = testUtils.sinon.spy();
const testStub = testUtils.sinon.stub().returns( {
format: [ [] ],
remove: []
} );
new InlineAutoformatEngine( editor, testStub, formatSpy ); // eslint-disable-line no-new
setData( model, '*[]' );
model.change( writer => {
writer.insertText( ' ', doc.selection.getFirstPosition() );
} );
sinon.assert.notCalled( formatSpy );
} );
it( 'should stop when there are no remove ranges returned from testCallback', () => {
const formatSpy = testUtils.sinon.spy();
const testStub = testUtils.sinon.stub().returns( {
format: [],
remove: [ [] ]
} );
new InlineAutoformatEngine( editor, testStub, formatSpy ); // eslint-disable-line no-new
setData( model, '*[]' );
model.change( writer => {
writer.insertText( ' ', doc.selection.getFirstPosition() );
} );
sinon.assert.notCalled( formatSpy );
} );
it( 'should stop early when there is no text', () => {
const formatSpy = testUtils.sinon.spy();
const testStub = testUtils.sinon.stub().returns( {
format: [],
remove: [ [] ]
} );
new InlineAutoformatEngine( editor, testStub, formatSpy ); // eslint-disable-line no-new
setData( model, '[]' );
model.change( writer => {
writer.insertText( ' ', doc.selection.getFirstPosition() );
} );
sinon.assert.notCalled( formatSpy );
} );
it( 'should detach removed ranges', () => {
const detachSpies = [];
const callback = fixBatch => testUtils.sinon.stub( fixBatch, 'remove' ).callsFake( saveDetachSpy );
testUtils.sinon.stub( editor.model.schema, 'getValidRanges' )
.callThrough()
.callsFake( ranges => ranges.map( saveDetachSpy ) );
new InlineAutoformatEngine( editor, /(\*)(.+?)(\*)/g, callback ); // eslint-disable-line no-new
setData( model, '*foobar[]' );
model.change( writer => {
writer.insertText( '*', doc.selection.getFirstPosition() );
} );
// There should be two removed ranges and one range used to apply autoformat.
expect( detachSpies ).to.have.length( 3 );
for ( const spy of detachSpies ) {
testUtils.sinon.assert.calledOnce( spy );
}
function saveDetachSpy( range ) {
detachSpies.push( testUtils.sinon.spy( range, 'detach' ) );
}
} );
} );
} );