/** * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license */ /* global HTMLElement, setTimeout, document */ import WordCount from '../src/wordcount'; import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor'; import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils'; import { setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; import { add as addTranslations, _clear as clearTranslations } from '@ckeditor/ckeditor5-utils/src/translation-service'; import Position from '@ckeditor/ckeditor5-engine/src/model/position'; // Delay related to word-count throttling. const DELAY = 255; describe( 'WordCount', () => { testUtils.createSinonSandbox(); let wordCountPlugin, editor, model; beforeEach( () => { return VirtualTestEditor.create( { plugins: [ WordCount, Paragraph ] } ) .then( _editor => { editor = _editor; model = editor.model; wordCountPlugin = editor.plugins.get( 'WordCount' ); model.schema.extend( '$text', { allowAttributes: 'foo' } ); } ); } ); describe( 'constructor()', () => { it( 'has defined "words" property', () => { expect( wordCountPlugin.words ).to.equal( 0 ); } ); it( 'has defined "characters" property', () => { expect( wordCountPlugin.characters ).to.equal( 0 ); } ); it( 'has "WordCount" plugin name', () => { expect( WordCount.pluginName ).to.equal( 'WordCount' ); } ); } ); describe( 'functionality', () => { it( 'counts words', () => { expect( wordCountPlugin.words ).to.equal( 0 ); setModelData( model, 'Foo(bar)baz' + '<$text foo="true">Hello world.' + '1234' + '(-@#$%^*())' ); wordCountPlugin._calculateWordsAndCharacters(); expect( wordCountPlugin.words ).to.equal( 6 ); } ); it( 'counts characters', () => { setModelData( model, '<$text foo="true">Hello world.' ); wordCountPlugin._calculateWordsAndCharacters(); expect( wordCountPlugin.characters ).to.equal( 12 ); } ); describe( 'update event', () => { it( 'fires update event with actual amount of characters and words', () => { const fake = sinon.fake(); wordCountPlugin.on( 'update', fake ); wordCountPlugin._calculateWordsAndCharacters(); sinon.assert.calledOnce( fake ); sinon.assert.calledWithExactly( fake, sinon.match.any, { words: 0, characters: 0 } ); // _calculateWordsAndCharacters is throttled, so for this test case is run manually setModelData( model, '<$text foo="true">Hello world.' ); wordCountPlugin._calculateWordsAndCharacters(); sinon.assert.calledTwice( fake ); sinon.assert.calledWithExactly( fake, sinon.match.any, { words: 2, characters: 12 } ); } ); } ); } ); describe( 'self-updating element', () => { let container; beforeEach( () => { container = wordCountPlugin.wordCountContainer; } ); it( 'provides html element', () => { expect( container ).to.be.instanceof( HTMLElement ); } ); it( 'provided element has proper structure', () => { expect( container.tagName ).to.equal( 'DIV' ); expect( container.classList.contains( 'ck' ) ).to.be.true; expect( container.classList.contains( 'ck-word-count' ) ).to.be.true; const children = Array.from( container.children ); expect( children.length ).to.equal( 2 ); expect( children[ 0 ].tagName ).to.equal( 'DIV' ); expect( children[ 0 ].innerHTML ).to.equal( 'Words: 0' ); expect( children[ 1 ].tagName ).to.equal( 'DIV' ); expect( children[ 1 ].innerHTML ).to.equal( 'Characters: 0' ); } ); it( 'updates container content', () => { expect( container.innerText ).to.equal( 'Words: 0Characters: 0' ); setModelData( model, 'Foo(bar)baz' + '<$text foo="true">Hello world.' ); wordCountPlugin._calculateWordsAndCharacters(); // There is \n between paragraph which has to be included into calculations expect( container.innerText ).to.equal( 'Words: 5Characters: 24' ); } ); it( 'subsequent calls provides the same element', () => { const newContainer = wordCountPlugin.wordCountContainer; expect( container ).to.equal( newContainer ); } ); describe( 'destroy()', () => { it( 'html element is removed', done => { const frag = document.createDocumentFragment(); frag.appendChild( container ); expect( frag.querySelector( '*' ) ).to.be.instanceof( HTMLElement ); editor.destroy() .then( () => { expect( frag.querySelector( '*' ) ).to.be.null; } ) .then( done ) .catch( done ); } ); it( 'method is called', done => { const spy = sinon.spy( wordCountPlugin, 'destroy' ); editor.destroy() .then( () => { sinon.assert.calledOnce( spy ); } ) .then( done ) .catch( done ); } ); it( 'should not throw an error if container is not specified', () => { return VirtualTestEditor.create( { plugins: [ WordCount, Paragraph ] } ) .then( editor => { return editor.destroy(); } ); } ); } ); } ); describe( '_calculateWordsAndCharacters and throttle', () => { beforeEach( done => { // We need to flush initial throttle value after editor's initialization setTimeout( done, DELAY ); } ); it( 'gets update after model data change', done => { const fake = sinon.fake(); wordCountPlugin.on( 'update', fake ); // Initial change in model should be immediately reflected in word-count setModelData( model, 'Hello world.' ); sinon.assert.calledOnce( fake ); sinon.assert.calledWith( fake, sinon.match.any, { words: 2, characters: 12 } ); // Subsequent updates should be throttle and run with last parameters setTimeout( () => { sinon.assert.calledTwice( fake ); sinon.assert.calledWith( fake, sinon.match.any, { words: 2, characters: 9 } ); done(); }, DELAY ); setModelData( model, 'Hello world' ); setModelData( model, 'Hello worl' ); setModelData( model, 'Hello wor' ); } ); it( 'is not update after selection change', done => { setModelData( model, 'Hello[] world.' ); const fake = sinon.fake(); const fakeSelectionChange = sinon.fake(); wordCountPlugin.on( 'update', fake ); model.document.on( 'change', fakeSelectionChange ); model.change( writer => { const range = writer.createRange( new Position( model.document.getRoot(), [ 0, 1 ] ) ); writer.setSelection( range ); } ); model.change( writer => { const range = writer.createRange( new Position( model.document.getRoot(), [ 0, 10 ] ) ); writer.setSelection( range ); } ); setTimeout( () => { sinon.assert.notCalled( fake ); sinon.assert.called( fakeSelectionChange ); done(); }, DELAY ); } ); } ); describe( 'custom config options', () => { it( 'displayWords = false', done => { VirtualTestEditor.create( { plugins: [ WordCount, Paragraph ], wordCount: { displayWords: false } } ) .then( editor => { const wordCountPlugin = editor.plugins.get( 'WordCount' ); const container = wordCountPlugin.wordCountContainer; expect( container.innerText ).to.equal( 'Characters: 0' ); } ) .then( done ) .catch( done ); } ); it( 'displayCharacters = false', done => { VirtualTestEditor.create( { plugins: [ WordCount, Paragraph ], wordCount: { displayCharacters: false } } ) .then( editor => { const wordCountPlugin = editor.plugins.get( 'WordCount' ); const container = wordCountPlugin.wordCountContainer; expect( container.innerText ).to.equal( 'Words: 0' ); } ) .then( done ) .catch( done ); } ); it( 'should call function registered under config.wordCount.onUpdate', () => { const fake = sinon.fake(); return VirtualTestEditor.create( { plugins: [ WordCount, Paragraph ], wordCount: { onUpdate: fake } } ) .then( editor => { sinon.assert.calledWithExactly( fake, { words: 0, characters: 0 } ); setModelData( editor.model, 'Foo Bar' ); } ) .then( () => new Promise( resolve => { setTimeout( resolve, DELAY ); } ) ) .then( () => { sinon.assert.calledWithExactly( fake, { words: 2, characters: 7 } ); } ); } ); it( 'should append word count container in element referenced in config.wordCount.container', () => { const element = document.createElement( 'div' ); expect( element.children.length ).to.equal( 0 ); return VirtualTestEditor.create( { plugins: [ WordCount, Paragraph ], wordCount: { container: element } } ) .then( editor => { expect( element.children.length ).to.equal( 1 ); const wordCountPlugin = editor.plugins.get( 'WordCount' ); expect( element.firstElementChild ).to.equal( wordCountPlugin.wordCountContainer ); } ); } ); } ); describe( 'translations', () => { before( () => { addTranslations( 'pl', { 'Words: %0': 'Słowa: %0', 'Characters: %0': 'Znaki: %0' } ); addTranslations( 'en', { 'Words: %0': 'Words: %0', 'Characters: %0': 'Characters: %0' } ); } ); after( () => { clearTranslations(); } ); it( 'applies proper language translations', done => { VirtualTestEditor.create( { plugins: [ WordCount, Paragraph ], language: 'pl' } ) .then( editor => { const wordCountPlugin = editor.plugins.get( 'WordCount' ); const container = wordCountPlugin.wordCountContainer; expect( container.innerText ).to.equal( 'Słowa: 0Znaki: 0' ); } ) .then( done ) .catch( done ); } ); } ); } );