Merge cd364e1 into 139989c

package.json

@@ -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",

src/texttransformation.js

@@ -92,12 +92,44 @@ export default class TextTransformation extends Plugin {
 				include: DEFAULT_TRANSFORMATIONS
 			}
 		} );
+
+		this.editor = editor;
 	}
 
 	/**
 	 * @inheritDoc
 	 */
 	init() {
+		const model = this.editor.model;
+		const modelDocument = model.document;
+		const modelSelection = modelDocument.selection;
+
+		/**
+		 * Holds a set of active {@link module:typing/textwatcher~TextWatcher}
+		 *
+		 * @type {Set.<TextWatcher>}
+		 * @private
+		 */
+		this._watchersStack = new Set();
+
+		this.on( 'change:isEnabled', () => {
+			this.isEnabled ? this._enableTransformationWatchers() : this._disableTransformationWatchers();
+		} );
+
+		this._enableTransformationWatchers();
+
+		this.listenTo( modelDocument, 'change:data', () => {
+			// Disable plugin when typing in code block.
+			this.isEnabled = !modelSelection.anchor.parent.is( 'codeBlock' );
+		} );
+	}
+
+	/**
+	 * 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' );
@@ -110,7 +142,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;
 				}
@@ -142,9 +174,26 @@ export default class TextTransformation extends Plugin {
 						changeIndex += replaceWith.length;
 					}
 				} );
-			} );
+			};
+
+			this._watchersStack.add( watcher );
+
+			watcher.on( 'matched:data', watcherCallback );
 		}
 	}
+
+	/**
+	 * Disable each running TextWatcher and clear the set of enabled watchers after all.
+	 *
+	 * @private
+	 */
+	_disableTransformationWatchers() {
+		this._watchersStack.forEach( watcher => {
+			watcher.stopListening();
+		} );
+
+		this._watchersStack.clear();
+	}
 }
 
 // Normalizes the configuration `from` parameter value.

src/textwatcher.js

@@ -43,7 +43,7 @@ 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 } ) => {
 			// Indirect changes (i.e. when the user types or external changes are applied) are handled in the document's change event.
 			if ( !directChange ) {
 				return;
@@ -62,7 +62,7 @@ export default class TextWatcher {
 			this._evaluateTextBeforeSelection( 'selection' );
 		} );
 
-		document.on( 'change:data', ( evt, batch ) => {
+		this.listenTo( document, 'change:data', ( evt, batch ) => {
 			if ( batch.type == 'transparent' ) {
 				return;
 			}
@@ -128,4 +128,3 @@ export default class TextWatcher {
 }
 
 mix( TextWatcher, EmitterMixin );
-

tests/texttransformation.js

@@ -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;
@@ -40,6 +41,54 @@ describe( 'Text transformation feature', () => {
 		} );
 	} );
 
+	describe( 'plugin', () => {
+		let TextTransformationPlugin, enableWatchersSpy, disableWatchersSpy;
+
+		beforeEach( () => {
+			TextTransformationPlugin = new TextTransformation( editor );
+			enableWatchersSpy = sinon.spy( TextTransformationPlugin, '_enableTransformationWatchers' );
+			disableWatchersSpy = sinon.spy( TextTransformationPlugin, '_disableTransformationWatchers' );
+
+			TextTransformationPlugin.init();
+		} );
+
+		it( 'should be enabled after initialization', () => {
+			expect( TextTransformationPlugin.isEnabled ).to.be.true;
+		} );
+
+		it( 'should initialize watchers after initialization', () => {
+			sinon.assert.calledOnce( enableWatchersSpy );
+		} );
+
+		it( 'should initialize watchers again when is enabled', () => {
+			sinon.assert.calledOnce( enableWatchersSpy );
+
+			TextTransformationPlugin.isEnabled = false;
+			TextTransformationPlugin.isEnabled = true;
+
+			sinon.assert.calledTwice( enableWatchersSpy );
+			expect( TextTransformationPlugin._watchersStack.size ).to.be.at.least( 1 );
+		} );
+
+		it( 'should disable watchers when is disabled', () => {
+			TextTransformationPlugin.isEnabled = false;
+
+			sinon.assert.calledOnce( disableWatchersSpy );
+		} );
+
+		it( 'should have active watchers when is enabled', () => {
+			expect( TextTransformationPlugin.isEnabled ).to.be.true;
+			expect( TextTransformationPlugin._watchersStack.size ).to.be.at.least( 1 );
+		} );
+
+		it( 'should not have active watchers when is disabled', () => {
+			TextTransformationPlugin.isEnabled = false;
+
+			expect( TextTransformationPlugin.isEnabled ).to.be.false;
+			expect( TextTransformationPlugin._watchersStack.size ).to.be.equal( 0 );
+		} );
+	} );
+
 	describe( 'transformations', () => {
 		beforeEach( createEditorInstance );
 
@@ -155,6 +204,19 @@ 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( plugin._watchersStack.size ).to.be.equal( 0 );
+			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>` );
@@ -355,18 +417,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'