Skip to content

Commit

Permalink
Added tests for MultipleLanguageTranslationService.
Browse files Browse the repository at this point in the history
  • Loading branch information
@ma2ciek
ma2ciek committed Nov 15, 2017
1 parent e7a11f7 commit 70acef0
Show file tree
Hide file tree
Showing 4 changed files with 336 additions and 6 deletions.
7 changes: 2 additions & 5 deletions packages/ckeditor5-dev-utils/lib/translations/multiplelanguagetranslationservice.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ module.exports = class MultipleLanguageTranslationService extends EventEmitter {
* @returns {String}
*/
translateSource( source ) {
const { output, errors } = translateSource( source, originalString => this._translateString( originalString ) );
const { output, errors } = translateSource( source, originalString => this._getId( originalString ) );

for ( const error of errors ) {
this.emit( 'error', error );
Expand Down Expand Up @@ -83,7 +83,7 @@ module.exports = class MultipleLanguageTranslationService extends EventEmitter {
* @param {String} [param0.outputDirectory]
* @returns {Array.<Object>}
*/
getAssets( { outputDirectory = 'lang' } ) {
getAssets( { outputDirectory = 'lang' } = {} ) {
return this._languages.map( language => {
const translatedStrings = this._getIdToTranslatedStringDictionary( language );

Expand Down Expand Up @@ -141,15 +141,12 @@ module.exports = class MultipleLanguageTranslationService extends EventEmitter {
const dictionary = this._dictionary[ language ];

for ( const translationKey in parsedTranslationFile ) {
// TODO: ensure that translation files can't use the same translationKey.
dictionary[ translationKey ] = parsedTranslationFile[ translationKey ];
}
}

// Translate all t() call found in source text to the target language.
_getId( originalString ) {
// TODO - log when translation is missing.

let id = this._translationIdsDictionary[ originalString ];

if ( !id ) {
Expand Down
324 changes: 324 additions & 0 deletions packages/ckeditor5-dev-utils/tests/translations/multiplelanguagetranslationservice.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,324 @@
/**
* @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/

'use strict';

const { expect } = require( 'chai' );
const sinon = require( 'sinon' );
const path = require( 'path' );
const proxyquire = require( 'proxyquire' );

describe( 'translations', () => {
describe( 'MultipleLanguageTranslationService', () => {
let MultipleLanguageTranslationService, stubs, files, fileContents, sandbox;

beforeEach( () => {
sandbox = sinon.sandbox.create();

stubs = {
fs: {
existsSync: path => files.includes( path ),
readFileSync: path => fileContents[ path ]
}
};

MultipleLanguageTranslationService = proxyquire( '../../lib/translations/multiplelanguagetranslationservice', {
'fs': stubs.fs
} );
} );

afterEach( () => {
sandbox.restore();
} );

describe( 'constructor()', () => {
it( 'should initialize `SingleLanguageTranslationService`', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'de' ] );

expect( translationService ).to.be.instanceof( MultipleLanguageTranslationService );
} );
} );

describe( 'loadPackage()', () => {
it( 'should load po file from the package and load translations', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'de' ] );
const pathToPlTranslations = path.join( 'pathToPackage', 'lang', 'translations', 'pl.po' );
const pathToDeTranslations = path.join( 'pathToPackage', 'lang', 'translations', 'de.po' );

files = [ pathToPlTranslations, pathToDeTranslations ];

fileContents = {
[ pathToPlTranslations ]: [
'msgctxt "Label for the Save button."',
'msgid "Save"',
'msgstr "Zapisz"',
''
].join( '\n' ),
[ pathToDeTranslations ]: [
'msgctxt "Label for the Save button."',
'msgid "Save"',
'msgstr "Speichern"',
''
].join( '\n' )
};

translationService.loadPackage( 'pathToPackage' );

expect( translationService._dictionary ).to.deep.equal( {
pl: {
'Save': 'Zapisz'
},
de: {
'Save': 'Speichern'
}
} );
} );

it( 'should do nothing if the po file does not exist', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'de' ] );

files = [];
fileContents = {};

translationService.loadPackage( 'pathToPackage' );

expect( translationService._dictionary ).to.deep.equal( {} );
} );

it( 'should load po file from the package only once per language', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'de' ] );
const loadPoFileSpy = sandbox.stub( translationService, '_loadPoFile' );

translationService.loadPackage( 'pathToPackage' );
translationService.loadPackage( 'pathToPackage' );
translationService.loadPackage( 'pathToPackage' );

sinon.assert.calledTwice( loadPoFileSpy );
} );
} );

describe( 'translateSource()', () => {
it( 'should replace t() call params with the translation id, starting with `a`', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'de' ] );
const source = 't( \'Cancel\' ), t( \'Save\' );';

const result = translationService.translateSource( source );

expect( result ).to.equal( 't(\'a\'), t(\'b\');' );
expect( translationService._translationIdsDictionary ).to.deep.equal( {
Cancel: 'a',
Save: 'b'
} );
} );

it( 'should return original source if there is no t() calls in the code', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'de' ] );
const source = 'translate( \'Cancel\' )';

const result = translationService.translateSource( source );

expect( result ).to.equal( 'translate( \'Cancel\' )' );

expect( translationService._translationIdsDictionary ).to.deep.equal( {} );
} );
} );

describe( 'getAssets()', () => {
it( 'should return an array of assets', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'en' ] );

translationService._translationIdsDictionary = {
Cancel: 'a',
Save: 'b'
};

translationService._dictionary = {
pl: {
Cancel: 'Anuluj',
Save: 'Zapisz',
},
en: {
Cancel: 'Cancel',
Save: 'Save'
}
};

const assets = translationService.getAssets();

expect( assets ).to.deep.equal( [
{
outputPath: path.join( 'lang', 'pl.js' ),
outputBody: 'CKEDITOR_TRANSLATIONS.add(\'pl\',{a:"Anuluj",b:"Zapisz"})'
},
{
outputPath: path.join( 'lang', 'en.js' ),
outputBody: 'CKEDITOR_TRANSLATIONS.add(\'en\',{a:"Cancel",b:"Save"})'
}
] );
} );

it( 'should emit an error if the language is not present in language list', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'xxx' ] );
const spy = sandbox.spy();

translationService.on( 'error', spy );

translationService._translationIdsDictionary = {
Cancel: 'a',
Save: 'b'
};

translationService._dictionary = {
pl: {
Cancel: 'Anuluj',
Save: 'Zapisz',
}
};

translationService.getAssets();

sinon.assert.calledThrice( spy );
sinon.assert.calledWithExactly( spy, 'No translation found for xxx language.' );
sinon.assert.calledWithExactly( spy, 'Missing translation for Cancel for xxx language.' );
sinon.assert.calledWithExactly( spy, 'Missing translation for Save for xxx language.' );
} );

it( 'should feed missing translation with the translation key if the translated string is missing', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'xxx' ] );
const spy = sandbox.spy();

translationService.on( 'error', spy );

translationService._translationIdsDictionary = {
Cancel: 'a',
Save: 'b'
};

translationService._dictionary = {
pl: {
Cancel: 'Anuluj',
Save: 'Zapisz',
}
};

const assets = translationService.getAssets();

expect( assets ).to.deep.equal( [
{
outputPath: path.join( 'lang', 'pl.js' ),
outputBody: 'CKEDITOR_TRANSLATIONS.add(\'pl\',{a:"Anuluj",b:"Zapisz"})'
},
{
outputPath: path.join( 'lang', 'xxx.js' ),
outputBody: 'CKEDITOR_TRANSLATIONS.add(\'xxx\',{a:"Cancel",b:"Save"})'
}
] );
} );

it( 'should bound to assets only used translations', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl' ] );
const spy = sandbox.spy();

translationService.on( 'error', spy );

translationService._translationIdsDictionary = {
Cancel: 'a',
Save: 'b'
};

translationService._dictionary = {
pl: {
Cancel: 'Anuluj',
Save: 'Zapisz',
Close: 'Zamknij',
}
};

const assets = translationService.getAssets();

// Note that the last translation from the above dictionary is skipped.
expect( assets ).to.deep.equal( [
{
outputPath: path.join( 'lang', 'pl.js' ),
outputBody: 'CKEDITOR_TRANSLATIONS.add(\'pl\',{a:"Anuluj",b:"Zapisz"})'
}
] );
} );
} );

describe( '_getPathToPackage', () => {
it( 'should be overridable to enable providing custom path to translation files', () => {
class CustomTranslationService extends MultipleLanguageTranslationService {
_getPathToPoFile( pathToPackage, languageCode ) {
return path.join( 'custom', 'path', 'to', pathToPackage, languageCode + '.PO' );
}
}

const translationService = new CustomTranslationService( [ 'en' ] );

const pathToTranslations = path.join( 'custom', 'path', 'to', 'pathToPackage', 'en.PO' );

files = [ pathToTranslations ];

fileContents = {
[ pathToTranslations ]: [
'msgctxt "Label for the Save button."',
'msgid "Save"',
'msgstr "Save"',
''
].join( '\n' )
};

translationService.loadPackage( 'pathToPackage' );

expect( translationService._dictionary ).to.deep.equal( {
en: {
'Save': 'Save'
}
} );
} );
} );

describe( 'integration test', () => {
it( 'test #1', () => {
const translationService = new MultipleLanguageTranslationService( [ 'pl', 'de' ] );
const pathToPlTranslations = path.join( 'pathToPackage', 'lang', 'translations', 'pl.po' );
const pathToDeTranslations = path.join( 'pathToPackage', 'lang', 'translations', 'de.po' );

files = [ pathToPlTranslations, pathToDeTranslations ];

fileContents = {
[ pathToPlTranslations ]: [
'msgctxt "Label for the Save button."',
'msgid "Save"',
'msgstr "Zapisz"',
''
].join( '\n' ),
[ pathToDeTranslations ]: [
'msgctxt "Label for the Save button."',
'msgid "Save"',
'msgstr "Speichern"',
''
].join( '\n' )
};

translationService.loadPackage( 'pathToPackage' );
translationService.translateSource( 't( \'Save\' );' );
const assets = translationService.getAssets();

expect( assets ).to.deep.equal( [
{
outputPath: path.join( 'lang', 'pl.js' ),
outputBody: 'CKEDITOR_TRANSLATIONS.add(\'pl\',{a:"Zapisz"})'
},
{
outputPath: path.join( 'lang', 'de.js' ),
outputBody: 'CKEDITOR_TRANSLATIONS.add(\'de\',{a:"Speichern"})'
}
] );
} );
} );
} );
} );
9 changes: 9 additions & 0 deletions packages/ckeditor5-dev-utils/tests/translations/singlelanguagetranslationservice.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,5 +133,14 @@ describe( 'translations', () => {
sinon.assert.calledWithExactly( spy, 'First t() call argument should be a string literal.' );
} );
} );

describe( 'getAssets()', () => {
it( 'should return an empty array', () => {
const translationService = new SingleLanguageTranslationService( [ 'pl', 'de' ] );
const assets = translationService.getAssets();

expect( assets ).to.deep.equal( [] );
} );
} );
} );
} );
2 changes: 1 addition & 1 deletion packages/ckeditor5-dev-utils/tests/translations/translatesource.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const sinon = require( 'sinon' );
const translateSource = require( '../../lib/translations/translatesource' );

describe( 'translations', () => {
describe( 'translateSource', () => {
describe( 'translateSource()', () => {
let sandbox, translations;
const translateString = translationKey => translations[ translationKey ];

Expand Down

0 comments on commit 70acef0

Please sign in to comment.