Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Merge 30671da into 139989c
Browse files Browse the repository at this point in the history
  • Loading branch information
@panr
panr committed Jan 28, 2020
2 parents 139989c + 30671da commit 6d41ba7
Show file tree
Hide file tree
Showing 5 changed files with 177 additions and 12 deletions.
1 change: 1 addition & 0 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"@ckeditor/ckeditor5-list": "^16.0.0",
"@ckeditor/ckeditor5-paragraph": "^16.0.0",
"@ckeditor/ckeditor5-undo": "^16.0.0",
"@ckeditor/ckeditor5-code-block": "^16.0.0",
"eslint": "^5.5.0",
"eslint-config-ckeditor5": "^2.0.0",
"husky": "^1.3.1",
Expand Down
26 changes: 24 additions & 2 deletions src/texttransformation.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,31 @@ export default class TextTransformation extends Plugin {
include: DEFAULT_TRANSFORMATIONS
}
} );

this.editor = editor;
}

/**
* @inheritDoc
*/
init() {
const model = this.editor.model;
const modelSelection = model.document.selection;

modelSelection.on( 'change:range', () => {
// Disable plugin when selection is inside a code block.
this.isEnabled = !modelSelection.anchor.parent.is( 'codeBlock' );
} );

this._enableTransformationWatchers();
}

/**
* Create new set of TextWatchers listening to the editor for typing and selection events.
*
* @private
*/
_enableTransformationWatchers() {
const editor = this.editor;
const model = editor.model;
const input = editor.plugins.get( 'Input' );
Expand All @@ -110,7 +129,7 @@ export default class TextTransformation extends Plugin {

const watcher = new TextWatcher( editor.model, text => from.test( text ) );

watcher.on( 'matched:data', ( evt, data ) => {
const watcherCallback = ( evt, data ) => {
if ( !input.isInput( data.batch ) ) {
return;
}
Expand Down Expand Up @@ -142,7 +161,10 @@ export default class TextTransformation extends Plugin {
changeIndex += replaceWith.length;
}
} );
} );
};

watcher.on( 'matched:data', watcherCallback );
watcher.bind( 'isEnabled' ).to( this );
}
}
}
Expand Down
20 changes: 16 additions & 4 deletions src/textwatcher.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

import mix from '@ckeditor/ckeditor5-utils/src/mix';
import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
import getLastTextLine from './utils/getlasttextline';

/**
Expand All @@ -31,6 +32,8 @@ export default class TextWatcher {
this.testCallback = testCallback;
this.hasMatch = false;

this.set( 'isEnabled', true );

this._startListening();
}

Expand All @@ -43,7 +46,12 @@ export default class TextWatcher {
const model = this.model;
const document = model.document;

document.selection.on( 'change:range', ( evt, { directChange } ) => {
this.listenTo( document.selection, 'change:range', ( evt, { directChange } ) => {
// Evaluate text before a selection only when TextWatcher is enabled.
if ( !this.isEnabled ) {
return;
}

// Indirect changes (i.e. when the user types or external changes are applied) are handled in the document's change event.
if ( !directChange ) {
return;
Expand All @@ -62,7 +70,12 @@ export default class TextWatcher {
this._evaluateTextBeforeSelection( 'selection' );
} );

document.on( 'change:data', ( evt, batch ) => {
this.listenTo( document, 'change:data', ( evt, batch ) => {
// Evaluate text before a selection only when TextWatcher is enabled.
if ( !this.isEnabled ) {
return;
}

if ( batch.type == 'transparent' ) {
return;
}
Expand Down Expand Up @@ -127,5 +140,4 @@ export default class TextWatcher {
}
}

mix( TextWatcher, EmitterMixin );

mix( TextWatcher, EmitterMixin, ObservableMixin );
37 changes: 32 additions & 5 deletions tests/texttransformation.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import TextTransformation from '../src/texttransformation';
import { getData, setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
import CodeBlock from '@ckeditor/ckeditor5-code-block/src/codeblock';

describe( 'Text transformation feature', () => {
let editorElement, editor, model, doc;
Expand Down Expand Up @@ -40,6 +41,24 @@ describe( 'Text transformation feature', () => {
} );
} );

describe( '#isEnabled', () => {
let plugin;

beforeEach( () => {
return createEditorInstance().then( () => {
plugin = editor.plugins.get( TextTransformation );
} );
} );

afterEach( () => {
plugin.destroy();
} );

it( 'should be enabled after initialization', () => {
expect( plugin.isEnabled ).to.be.true;
} );
} );

describe( 'transformations', () => {
beforeEach( createEditorInstance );

Expand Down Expand Up @@ -155,6 +174,18 @@ describe( 'Text transformation feature', () => {
.to.equal( '<paragraph>"Foo <softBreak></softBreak>“Bar”</paragraph>' );
} );

it( 'should be disabled inside code blocks', () => {
setData( model, '<codeBlock language="plaintext">some [] code</codeBlock>' );

simulateTyping( '1/2' );

const plugin = editor.plugins.get( 'TextTransformation' );

expect( plugin.isEnabled ).to.be.false;
expect( getData( model, { withoutSelection: true } ) )
.to.equal( '<codeBlock language="plaintext">some 1/2 code</codeBlock>' );
} );

function testTransformation( transformFrom, transformTo, textInParagraph = 'A foo' ) {
it( `should transform "${ transformFrom }" to "${ transformTo }"`, () => {
setData( model, `<paragraph>${ textInParagraph }[]</paragraph>` );
Expand Down Expand Up @@ -355,18 +386,14 @@ describe( 'Text transformation feature', () => {
function createEditorInstance( additionalConfig = {} ) {
return ClassicTestEditor
.create( editorElement, Object.assign( {
plugins: [ Typing, Paragraph, Bold, TextTransformation ]
plugins: [ Typing, Paragraph, Bold, TextTransformation, CodeBlock ]
}, additionalConfig ) )
.then( newEditor => {
editor = newEditor;

model = editor.model;
doc = model.document;

model.schema.register( 'softBreak', {
allowWhere: '$text',
isInline: true
} );
editor.conversion.elementToElement( {
model: 'softBreak',
view: 'br'
Expand Down
105 changes: 104 additions & 1 deletion tests/textwatcher.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,25 @@ describe( 'TextWatcher', () => {

afterEach( () => {
sinon.restore();
watcher.off();

if ( editor ) {
return editor.destroy();
}
} );

describe( '#isEnabled', () => {
it( 'should be enabled after initialization', () => {
expect( watcher.isEnabled ).to.be.true;
} );

it( 'should be disabled after setting #isEnabled to false', () => {
watcher.isEnabled = false;

expect( watcher.isEnabled ).to.be.false;
} );
} );

describe( 'testCallback', () => {
it( 'should evaluate text before caret for data changes', () => {
model.change( writer => {
Expand Down Expand Up @@ -97,6 +110,35 @@ describe( 'TextWatcher', () => {

sinon.assert.notCalled( testCallbackStub );
} );

it( 'should not evaluate text when watcher is disabled', () => {
watcher.isEnabled = false;

model.change( writer => {
writer.insertText( '@', doc.selection.getFirstPosition() );
} );

sinon.assert.notCalled( testCallbackStub );
} );

it( 'should evaluate text when watcher is enabled again', () => {
watcher.isEnabled = false;

model.change( writer => {
writer.insertText( '@', doc.selection.getFirstPosition() );
} );

sinon.assert.notCalled( testCallbackStub );

watcher.isEnabled = true;

model.change( writer => {
writer.insertText( '@', doc.selection.getFirstPosition() );
} );

sinon.assert.calledOnce( testCallbackStub );
sinon.assert.calledWithExactly( testCallbackStub, 'foo @@' );
} );
} );

describe( 'events', () => {
Expand All @@ -113,6 +155,22 @@ describe( 'TextWatcher', () => {
sinon.assert.notCalled( unmatchedSpy );
} );

it( 'should not fire "matched:data" event when watcher is disabled' +
' (even when test callback returns true for model data changes)', () => {
watcher.isEnabled = false;

testCallbackStub.returns( true );

model.change( writer => {
writer.insertText( '@', doc.selection.getFirstPosition() );
} );

sinon.assert.notCalled( testCallbackStub );
sinon.assert.notCalled( matchedDataSpy );
sinon.assert.notCalled( matchedSelectionSpy );
sinon.assert.notCalled( unmatchedSpy );
} );

it( 'should fire "matched:selection" event when test callback returns true for model data changes', () => {
testCallbackStub.returns( true );

Expand All @@ -130,6 +188,26 @@ describe( 'TextWatcher', () => {
sinon.assert.notCalled( unmatchedSpy );
} );

it( 'should not fire "matched:selection" event when when watcher is disabled' +
' (even when test callback returns true for model data changes)', () => {
watcher.isEnabled = false;

testCallbackStub.returns( true );

model.enqueueChange( 'transparent', writer => {
writer.insertText( '@', doc.selection.getFirstPosition() );
} );

model.change( writer => {
writer.setSelection( doc.getRoot().getChild( 0 ), 0 );
} );

sinon.assert.notCalled( testCallbackStub );
sinon.assert.notCalled( matchedDataSpy );
sinon.assert.notCalled( matchedSelectionSpy );
sinon.assert.notCalled( unmatchedSpy );
} );

it( 'should not fire "matched" event when test callback returns false', () => {
testCallbackStub.returns( false );

Expand Down Expand Up @@ -188,6 +266,31 @@ describe( 'TextWatcher', () => {
sinon.assert.notCalled( matchedSelectionSpy );
sinon.assert.calledOnce( unmatchedSpy );
} );

it( 'should not fire "umatched" event when selection is expanded if watcher is disabled', () => {
watcher.isEnabled = false;

testCallbackStub.returns( true );

model.change( writer => {
writer.insertText( '@', doc.selection.getFirstPosition() );
} );

sinon.assert.notCalled( testCallbackStub );
sinon.assert.notCalled( matchedDataSpy );
sinon.assert.notCalled( matchedSelectionSpy );
sinon.assert.notCalled( unmatchedSpy );

model.change( writer => {
const start = writer.createPositionAt( doc.getRoot().getChild( 0 ), 0 );

writer.setSelection( writer.createRange( start, start.getShiftedBy( 1 ) ) );
} );

sinon.assert.notCalled( testCallbackStub );
sinon.assert.notCalled( matchedDataSpy );
sinon.assert.notCalled( matchedSelectionSpy );
sinon.assert.notCalled( unmatchedSpy );
} );
} );
} );

0 comments on commit 6d41ba7

Please sign in to comment.