| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474 |
- /**
- * @license Copyright (c) 2003-2020, 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';
- import ShiftEnter from '@ckeditor/ckeditor5-enter/src/shiftenter';
- import TableEditing from '@ckeditor/ckeditor5-table/src/tableediting';
- import env from '@ckeditor/ckeditor5-utils/src/env';
- // Delay related to word-count throttling.
- const DELAY = 255;
- describe( 'WordCount', () => {
- testUtils.createSinonSandbox();
- let wordCountPlugin, editor, model;
- beforeEach( () => {
- return VirtualTestEditor.create( {
- plugins: [ WordCount, Paragraph, ShiftEnter, TableEditing ]
- } )
- .then( _editor => {
- editor = _editor;
- model = editor.model;
- wordCountPlugin = editor.plugins.get( 'WordCount' );
- model.schema.extend( '$text', { allowAttributes: 'foo' } );
- } );
- } );
- describe( 'constructor()', () => {
- describe( '#words property', () => {
- it( 'is defined', () => {
- expect( wordCountPlugin.words ).to.equal( 0 );
- } );
- it( 'returns the number of words right away', () => {
- setModelData( model, '<paragraph><$text foo="true">Hello</$text> world.</paragraph>' );
- expect( wordCountPlugin.words ).to.equal( 2 );
- setModelData( model, '<paragraph><$text foo="true">Hello</$text> world</paragraph>' );
- expect( wordCountPlugin.words ).to.equal( 2 );
- setModelData( model, '<paragraph><$text foo="true">Hello</$text></paragraph>' );
- expect( wordCountPlugin.words ).to.equal( 1 );
- setModelData( model, '' );
- expect( wordCountPlugin.words ).to.equal( 0 );
- } );
- it( 'is observable', done => {
- const spy = sinon.spy();
- wordCountPlugin.on( 'change:words', spy );
- setModelData( model, '<paragraph><$text foo="true">Hello</$text> world.</paragraph>' );
- setModelData( model, '<paragraph><$text foo="true">Hello</$text></paragraph>' );
- setTimeout( () => {
- // The #update event fired once because it is throttled.
- sinon.assert.calledOnce( spy );
- expect( spy.firstCall.args[ 2 ] ).to.equal( 1 );
- done();
- }, DELAY );
- } );
- } );
- describe( '#characters property', () => {
- it( 'is defined', () => {
- expect( wordCountPlugin.characters ).to.equal( 0 );
- } );
- it( 'returns the number of characters right away', () => {
- setModelData( model, '<paragraph><$text foo="true">Hello</$text> world.</paragraph>' );
- expect( wordCountPlugin.characters ).to.equal( 12 );
- setModelData( model, '<paragraph><$text foo="true">Hello</$text> world</paragraph>' );
- expect( wordCountPlugin.characters ).to.equal( 11 );
- setModelData( model, '<paragraph><$text foo="true">Hello</$text></paragraph>' );
- expect( wordCountPlugin.characters ).to.equal( 5 );
- setModelData( model, '' );
- expect( wordCountPlugin.characters ).to.equal( 0 );
- } );
- it( 'is observable', done => {
- const spy = sinon.spy();
- wordCountPlugin.on( 'change:characters', spy );
- setModelData( model, '<paragraph><$text foo="true">Hello</$text> world.</paragraph>' );
- setModelData( model, '<paragraph><$text foo="true">Hello</$text></paragraph>' );
- setTimeout( () => {
- // The #update event fired once because it is throttled.
- sinon.assert.calledOnce( spy );
- expect( spy.firstCall.args[ 2 ] ).to.equal( 5 );
- done();
- }, DELAY );
- } );
- } );
- it( 'has a name', () => {
- expect( WordCount.pluginName ).to.equal( 'WordCount' );
- } );
- } );
- describe( 'functionality', () => {
- it( 'counts words', () => {
- expect( wordCountPlugin.words ).to.equal( 0 );
- setModelData( model, '<paragraph>Foo(bar)baz</paragraph>' +
- '<paragraph><$text foo="true">Hello</$text> world.</paragraph>' +
- '<paragraph>1234</paragraph>' +
- '<paragraph>(@#$%^*())</paragraph>' );
- wordCountPlugin._refreshStats();
- expect( wordCountPlugin.words ).to.equal( 6 );
- } );
- it( 'counts characters', () => {
- setModelData( model, '<paragraph><$text foo="true">Hello</$text> world.</paragraph>' );
- wordCountPlugin._refreshStats();
- expect( wordCountPlugin.characters ).to.equal( 12 );
- } );
- it( 'should not count enter as a character', () => {
- expect( wordCountPlugin.characters ).to.equal( 0 );
- setModelData( model, '<paragraph>Fo<softBreak></softBreak>o</paragraph>' +
- '<paragraph>Foo</paragraph>' +
- '<table>' +
- '<tableRow>' +
- '<tableCell></tableCell><tableCell></tableCell><tableCell></tableCell>' +
- '</tableRow>' +
- '<tableRow>' +
- '<tableCell></tableCell><tableCell><paragraph>foo</paragraph></tableCell><tableCell></tableCell>' +
- '</tableRow>' +
- '<tableRow>' +
- '<tableCell></tableCell><tableCell></tableCell><tableCell></tableCell>' +
- '</tableRow>' +
- '</table>' );
- wordCountPlugin._refreshStats();
- expect( wordCountPlugin.characters ).to.equal( 9 );
- } );
- it( 'should count international words', function() {
- if ( !env.features.isRegExpUnicodePropertySupported ) {
- this.skip();
- }
- expect( wordCountPlugin.words ).to.equal( 0 );
- setModelData( model, '<paragraph>שמש 太陽 ดวงอาทิตย์ شمس ਸੂਰਜ słońce</paragraph>' );
- wordCountPlugin._refreshStats();
- expect( wordCountPlugin.words ).to.equal( 6 );
- } );
- describe( 'ES2018 RegExp Unicode property fallback', () => {
- const originalPropertiesSupport = env.features.isRegExpUnicodePropertySupported;
- before( () => {
- env.features.isRegExpUnicodePropertySupported = false;
- } );
- after( () => {
- env.features.isRegExpUnicodePropertySupported = originalPropertiesSupport;
- } );
- it( 'should use different regexp when unicode properties are not supported', () => {
- expect( wordCountPlugin.words ).to.equal( 0 );
- setModelData( model, '<paragraph>hello world.</paragraph>' );
- wordCountPlugin._refreshStats();
- expect( wordCountPlugin.words ).to.equal( 2 );
- } );
- } );
- describe( '#update event', () => {
- it( 'fires with the actual number of characters and words', () => {
- const fake = sinon.fake();
- wordCountPlugin.on( 'update', fake );
- wordCountPlugin._refreshStats();
- sinon.assert.calledOnce( fake );
- sinon.assert.calledWithExactly( fake, sinon.match.any, { words: 0, characters: 0 } );
- // _refreshStats is throttled, so for this test case is run manually
- setModelData( model, '<paragraph><$text foo="true">Hello</$text> world.</paragraph>' );
- wordCountPlugin._refreshStats();
- sinon.assert.calledTwice( fake );
- sinon.assert.calledWithExactly( fake, sinon.match.any, { words: 2, characters: 12 } );
- } );
- it( 'should be fired after editor initialization', () => {
- const fake = sinon.fake();
- return VirtualTestEditor.create( {
- plugins: [ WordCount, Paragraph, ShiftEnter, TableEditing ],
- wordCount: {
- onUpdate: fake
- }
- } )
- .then( () => {
- sinon.assert.calledOnce( fake );
- } );
- } );
- } );
- } );
- 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, '<paragraph>Foo(bar)baz</paragraph>' +
- '<paragraph><$text foo="true">Hello</$text> world.</paragraph>' );
- wordCountPlugin._refreshStats();
- expect( container.innerText ).to.equal( 'Words: 5Characters: 23' );
- } );
- 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( '_refreshStats 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, '<paragraph>Hello world.</paragraph>' );
- 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, '<paragraph>Hello world</paragraph>' );
- setModelData( model, '<paragraph>Hello worl</paragraph>' );
- setModelData( model, '<paragraph>Hello wor</paragraph>' );
- } );
- it( 'is not update after selection change', done => {
- setModelData( model, '<paragraph>Hello[] world.</paragraph>' );
- 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', () => {
- return 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' );
- } );
- } );
- it( 'displayCharacters = false', () => {
- return 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' );
- } );
- } );
- 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, '<paragraph>Foo Bar</paragraph>' );
- } )
- .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', () => {
- return 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' );
- } );
- } );
- } );
- } );
|