Merge pull request #213 from ckeditor/t/208

Feature: Introduced `Input#isInput()`. Closes #214. Fixed the `TextTransformation` feature so it willl trigger only for typing changes. Closes #208.

src/input.js

@@ -40,4 +40,27 @@ export default class Input extends Plugin {
 		injectUnsafeKeystrokesHandling( editor );
 		injectTypingMutationsHandling( editor );
 	}
+
+	/**
+	 * Checks batch if it is a result of user input - e.g. typing.
+	 *
+	 *		const input = editor.plugins.get( 'Input' );
+	 *
+	 *		editor.model.document.on( 'change:data', ( evt, batch ) => {
+	 *			if ( input.isTyping( batch ) ) {
+	 *				console.log( 'The user typed something...' );
+	 *			}
+	 *		} );
+	 *
+	 * **Note:** This method checks if the batch was created using {@link module:typing/inputcommand~InputCommand 'input'}
+	 * command as typing changes coming from user input are inserted to the document using that command.
+	 *
+	 * @param {module:engine/model/batch~Batch} batch A batch to check.
+	 * @returns {Boolean}
+	 */
+	isInput( batch ) {
+		const inputCommand = this.editor.commands.get( 'input' );
+
+		return inputCommand._batches.has( batch );
+	}
 }

src/inputcommand.js

@@ -35,6 +35,15 @@ export default class InputCommand extends Command {
 		 * @member {module:typing/utils/changebuffer~ChangeBuffer} #_buffer
 		 */
 		this._buffer = new ChangeBuffer( editor.model, undoStepSize );
+
+		/**
+		 * Stores batches created by the input command. The batches are used to differentiate input batches from other batches using
+		 * {@link module:typing/input~Input#isInput} method.
+		 *
+		 * @type {WeakSet<module:engine/model/batch~Batch>}
+		 * @protected
+		 */
+		this._batches = new WeakSet();
 	}
 
 	/**
@@ -98,6 +107,9 @@ export default class InputCommand extends Command {
 			this._buffer.unlock();
 
 			this._buffer.input( textInsertions );
+
+			// Store the batch as an 'input' batch for the Input.isInput( batch ) check.
+			this._batches.add( this._buffer.batch );
 		} );
 	}
 }

src/texttransformation.js

@@ -100,6 +100,7 @@ export default class TextTransformation extends Plugin {
 	init() {
 		const editor = this.editor;
 		const model = editor.model;
+		const input = editor.plugins.get( 'Input' );
 
 		const configuredTransformations = getConfiguredTransformations( editor.config.get( 'typing.transformations' ) );
 
@@ -110,6 +111,10 @@ export default class TextTransformation extends Plugin {
 			const watcher = new TextWatcher( editor.model, text => from.test( text ) );
 
 			watcher.on( 'matched:data', ( evt, data ) => {
+				if ( !input.isInput( data.batch ) ) {
+					return;
+				}
+
 				const matches = from.exec( data.text );
 				const replaces = to( matches.slice( 1 ) );
 

src/textwatcher.js

@@ -66,7 +66,7 @@ export default class TextWatcher {
 				return;
 			}
 
-			this._evaluateTextBeforeSelection( 'data' );
+			this._evaluateTextBeforeSelection( 'data', { batch } );
 		} );
 	}
 
@@ -79,8 +79,9 @@ export default class TextWatcher {
 	 *
 	 * @private
 	 * @param {'data'|'selection'} suffix Suffix used for generating event name.
+	 * @param {Object} data Data object for event.
 	 */
-	_evaluateTextBeforeSelection( suffix ) {
+	_evaluateTextBeforeSelection( suffix, data = {} ) {
 		const text = this._getText();
 
 		const textHasMatch = this.testCallback( text );
@@ -97,18 +98,24 @@ export default class TextWatcher {
 		this.hasMatch = textHasMatch;
 
 		if ( textHasMatch ) {
+			const eventData = Object.assign( data, { text } );
+
 			/**
 			 * Fired whenever the text watcher found a match for data changes.
 			 *
 			 * @event matched:data
+			 * @param {Object} data Event data.
+			 * @param {String} data.text The full text before selection.
+			 * @param {module:engine/model/batch~Batch} data.batch A batch associated with a change.
 			 */
-
 			/**
 			 * Fired whenever the text watcher found a match for selection changes.
 			 *
 			 * @event matched:selection
+			 * @param {Object} data Event data.
+			 * @param {String} data.text The full text before selection.
 			 */
-			this.fire( `matched:${ suffix }`, { text } );
+			this.fire( `matched:${ suffix }`, eventData );
 		}
 	}
 

tests/input.js

@@ -70,6 +70,29 @@ describe( 'Input feature', () => {
 		return editor.destroy();
 	} );
 
+	describe( 'isInput()', () => {
+		let input;
+
+		beforeEach( () => {
+			input = editor.plugins.get( 'Input' );
+		} );
+
+		it( 'returns true for batch created using "input" command', done => {
+			model.document.once( 'change:data', ( evt, batch ) => {
+				expect( input.isInput( batch ) ).to.be.true;
+				done();
+			} );
+
+			editor.execute( 'input', { text: 'foo' } );
+		} );
+
+		it( 'returns false for batch not created using "input" command', () => {
+			const batch = model.createBatch();
+
+			expect( input.isInput( batch ) ).to.be.false;
+		} );
+	} );
+
 	describe( 'mutations handling', () => {
 		it( 'should handle text mutation', () => {
 			viewDocument.fire( 'mutations', [

tests/texttransformation-integration.js

@@ -12,6 +12,7 @@ import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictest
 import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
 
 import TextTransformation from '../src/texttransformation';
+import Typing from '../src/typing';
 
 describe( 'Text transformation feature - integration', () => {
 	let editorElement, editor, model, doc;
@@ -32,7 +33,7 @@ describe( 'Text transformation feature - integration', () => {
 	describe( 'with undo', () => {
 		beforeEach( () => {
 			return ClassicTestEditor
-				.create( editorElement, { plugins: [ Paragraph, TextTransformation, UndoEditing ] } )
+				.create( editorElement, { plugins: [ Typing, Paragraph, TextTransformation, UndoEditing ] } )
 				.then( newEditor => {
 					editor = newEditor;
 					model = editor.model;
@@ -48,10 +49,7 @@ describe( 'Text transformation feature - integration', () => {
 				writer.insertText( '(c', doc.selection.focus );
 			} );
 
-			model.enqueueChange( model.createBatch(), writer => {
-				writer.setSelection( doc.getRoot().getChild( 0 ), 'end' );
-				writer.insertText( ')', doc.selection.focus );
-			} );
+			editor.execute( 'input', { text: ')' } );
 
 			expect( editor.getData(), 'inserted text' ).to.equal( '<p>foo©</p>' );
 
@@ -72,10 +70,8 @@ describe( 'Text transformation feature - integration', () => {
 				writer.insertText( 'foo bar baz(c', doc.selection.focus );
 			} );
 
-			model.enqueueChange( model.createBatch(), writer => {
-				writer.setSelection( doc.getRoot().getChild( 0 ), 'end' );
-				writer.insertText( ')', doc.selection.focus );
-			} );
+			editor.execute( 'input', { text: ')' } );
+
 			expect( editor.getData() ).to.equal( '<p>foo bar baz©</p>' );
 
 			editor.execute( 'undo' );