import { createElement } from 'react'; import ReactDomServer from 'react-dom/server'; import i18n, { translate } from '..'; import data from './data'; /** * Pass in a react-generated html string to remove react-specific attributes * to make it easier to compare to expected html structure * @param {string} string React-generated html string * @returns {string} html with react attributes removed */ function stripReactAttributes( string ) { return string.replace( /\sdata-(reactid|react-checksum)="[^"]+"/g, '' ); } describe( 'I18n', function () { beforeEach( function () { i18n.setLocale( data.locale ); } ); afterEach( function () { jest.clearAllMocks(); i18n.configure(); // ensure everything is reset } ); describe( 'setLocale()', function () { it( 'should emit a change event', () => { const callback = jest.fn(); i18n.subscribe( callback ); i18n.setLocale(); expect( callback ).toHaveBeenCalled(); } ); describe( 'adding a new locale source from the same language', function () { beforeEach( function () { i18n.setLocale( { '': data.locale[ '' ], test1: [ 'translation1-1' ], test2: [ 'translation2' ], 'new translation': [ 'Neue Übersetzung' ], } ); } ); it( 'should make the new translations available', function () { expect( translate( 'new translation' ) ).toBe( 'Neue Übersetzung' ); } ); it( 'should keep the original translations available as well', function () { expect( translate( 'Activate' ) ).toBe( 'Aktivieren' ); } ); it( 'should replace existing translations with the new version', function () { expect( translate( 'test1' ) ).toBe( 'translation1-1' ); expect( translate( 'test2' ) ).toBe( 'translation2' ); } ); } ); describe( 'adding a new locale source from a different language', function () { beforeEach( function () { i18n.setLocale( { '': Object.assign( {}, data.locale[ '' ], { localeSlug: 'fr', 'Plural-Forms': 'nplurals=2; plural=n > 1;', } ), test1: [ 'traduction1' ], test2: [ 'traduction2' ], 'new translation': [ 'nouvelle traduction' ], } ); } ); it( 'should make replace previous locale translations', function () { expect( translate( 'test1' ) ).not.toBe( 'translation1' ); expect( translate( 'test1' ) ).toBe( 'traduction1' ); } ); it( 'should make old translations unavailable', function () { expect( translate( 'Activate' ) ).toBe( 'Activate' ); } ); it( 'should make new translations available', function () { expect( translate( 'new translation' ) ).toBe( 'nouvelle traduction' ); } ); } ); } ); describe( 'translate()', function () { describe( 'passing a string', function () { it( 'should find a simple translation', function () { expect( translate( 'test1' ) ).toBe( 'translation1' ); } ); it( 'should fall back to original string if translation is missing', function () { expect( translate( 'test2' ) ).toBe( 'test2' ); } ); it( "should fall back to original if translation isn't even null in locale file", function () { expect( translate( 'nonexisting-string' ) ).toBe( 'nonexisting-string' ); } ); } ); describe( 'translate with context', function () { it( 'should find a string with context', function () { expect( translate( { original: 'test3', context: 'thecontext' } ) ).toBe( 'translation3' ); } ); it( 'should allow original text as options attribute or initial argument', function () { expect( translate( 'test3', { context: 'thecontext' } ) ).toBe( 'translation3' ); } ); } ); describe( 'translate with comments', function () { it( 'should find a string with comment', function () { expect( translate( { original: 'test4', comment: 'thecomment' } ) ).toBe( 'translation4' ); } ); it( 'should allow original text as options attribute or initial argument', function () { expect( translate( 'test4', { comment: 'thecomment' } ) ).toBe( 'translation4' ); } ); } ); describe( 'plural translation', function () { it( 'should use the singular form for one item', function () { expect( translate( { original: { single: 'plural-test', plural: 'plural-test pl key', count: 1 }, } ) ).toBe( 'plural-test singular translation' ); } ); it( 'should use the plural form for > one items', function () { expect( translate( { original: { single: 'plural-test', plural: 'plural-test pl key', count: 2 }, } ) ).toBe( 'plural-test multiple translation' ); } ); it( 'should honor the new plural translation syntax (singular test)', function () { expect( translate( 'plural-test new syntax', 'plural-test new syntaxes', { count: 1 } ) ).toBe( 'plural-test new syntax translated, single' ); } ); it( 'should honor the new plural translation syntax (plural test)', function () { expect( translate( 'plural-test new syntax', 'plural-test new syntaxes', { count: 2, } ) ).toBe( 'plural-test new syntax translated, plural' ); } ); } ); describe( 'sprintf-style value interpolation', function () { it( 'should substitute a string', function () { expect( translate( 'foo %(test)s', { args: { test: 'bar' } } ) ).toBe( 'foo bar' ); } ); it( 'should substitute a number', function () { expect( translate( 'foo %(test)d', { args: { test: 1 } } ) ).toBe( 'foo 1' ); } ); it( 'should substitute floats', function () { expect( translate( 'foo %(test)f', { args: { test: 1.005 } } ) ).toBe( 'foo 1.005' ); } ); it( 'should allow passing an array of arguments', function () { expect( translate( 'test1 %1$s test3 %2$s', { args: [ 'test2', 'test4' ] } ) ).toBe( 'test1 test2 test3 test4' ); } ); it( 'should allow passing a single argument', function () { expect( translate( 'test1 %s test3', { args: 'test2' } ) ).toBe( 'test1 test2 test3' ); } ); it( 'should not throw when passed a circular object', function () { const obj = { foo: 'bar', toString: function () { return 'baz'; }, }; obj.obj = obj; expect( translate( 'test1 %s', { args: obj } ) ).toBe( 'test1 baz' ); } ); } ); describe( 'with mixed components', function () { it( 'should handle sprintf and component interpolation together', function () { const input = createElement( 'input' ); const expectedResultString = 'foo bar'; const placeholder = 'bar'; const translatedComponent = translate( 'foo {{ input /}} %(placeholder)s', { components: { input: input, }, args: { placeholder: placeholder, }, } ); const instance = createElement( 'span', null, translatedComponent ); expect( stripReactAttributes( ReactDomServer.renderToStaticMarkup( instance ) ) ).toBe( expectedResultString ); } ); } ); describe( 'adding new translations', function () { it( 'should find a new translation after it has been added', function () { i18n.addTranslations( { 'test-does-not-exist': [ 'translation3' ], } ); expect( translate( 'test-does-not-exist' ) ).toBe( 'translation3' ); } ); it( 'should return the new translation if it has been overwritten', function () { i18n.addTranslations( { 'test-will-overwrite': [ 'not-translation1' ], } ); expect( translate( 'test-will-overwrite' ) ).toBe( 'not-translation1' ); } ); it( 'should emit a change event', () => { const callback = jest.fn(); i18n.subscribe( callback ); i18n.addTranslations( {} ); expect( callback ).toHaveBeenCalled(); } ); } ); } ); describe( 'getBrowserSafeLocale()', function () { it( 'should return locale without variant when localeVariant is set with underscore _', function () { i18n.setLocale( { '': { localeVariant: 'de_AT', localeSlug: 'de', }, } ); expect( i18n.getBrowserSafeLocale() ).toBe( 'de' ); } ); it( 'should return locale with region code when localeVariant is set with dash -', function () { i18n.setLocale( { '': { localeVariant: 'en-US', localeSlug: 'en', }, } ); expect( i18n.getBrowserSafeLocale() ).toBe( 'en-US' ); } ); it( 'should return localeSlug when localeVariant is not set', function () { i18n.setLocale( { '': { localeVariant: undefined, localeSlug: 'en', }, } ); expect( i18n.getBrowserSafeLocale() ).toBe( 'en' ); } ); it( 'should return localeSlug when localeVariant is null', function () { i18n.setLocale( { '': { localeVariant: null, localeSlug: 'fr', }, } ); expect( i18n.getBrowserSafeLocale() ).toBe( 'fr' ); } ); } ); describe( 'emitChange()', () => { it( 'should call all subscribed callbacks', () => { const callback1 = jest.fn(); const callback2 = jest.fn(); i18n.subscribe( callback1 ); i18n.subscribe( callback2 ); i18n.emitChange(); expect( callback1 ).toHaveBeenCalled(); expect( callback2 ).toHaveBeenCalled(); } ); it( 'should not call unsubscribed callbacks', () => { const callback1 = jest.fn(); const callback2 = jest.fn(); const callback3 = jest.fn(); i18n.subscribe( callback1 ); const unsubscribe2 = i18n.subscribe( callback2 ); i18n.subscribe( callback3 ); unsubscribe2(); i18n.emitChange(); expect( callback1 ).toHaveBeenCalled(); expect( callback2 ).not.toHaveBeenCalled(); expect( callback3 ).toHaveBeenCalled(); } ); } ); describe( 'reRenderTranslations()', () => { it( 'should call subscriber callback', () => { const callback = jest.fn(); i18n.subscribe( callback ); i18n.reRenderTranslations(); expect( callback ).toHaveBeenCalled(); } ); } ); describe( 'subscribe()', () => { it( 'should return an unsubscribe function', () => { const callback = jest.fn(); const unsubscribe = i18n.subscribe( callback ); unsubscribe(); i18n.setLocale(); expect( callback ).not.toHaveBeenCalled(); } ); } ); describe( 'hashed locale data', function () { it( 'should find keys when looked up by simple hash', function () { i18n.setLocale( { '': { localeSlug: 'xx-pig-latin', 'key-hash': 'sha1', }, '0f7d0d088b6ea936fb25b477722d734706fe8b40': [ 'implesa' ], } ); expect( translate( 'simple' ) ).toBe( 'implesa' ); } ); it( 'should find keys when looked up by single length hash', function () { i18n.setLocale( { '': { localeSlug: 'xx-pig-latin', 'key-hash': 'sha1-1', }, 0: [ 'implesa' ], } ); expect( translate( 'simple' ) ).toBe( 'implesa' ); } ); it( 'should find keys when looked up by multi length hash', function () { i18n.setLocale( { '': { localeSlug: 'xx-pig-latin', 'key-hash': 'sha1-1-2', }, 0: [ 'implesa' ], 6: [ 'cursus' ], // green with context `color` has a sha1 of 68d206ad95bc23f27ee157e826d2cae41c5bdd71 78: [ 'edra' ], // red has a sha1 of 78988010b890ce6f4d2136481f392787ec6d6106 '7d': [ 'reyga' ], // grey has a sha1 of 7d1f8f911da92c0ea535cad461fd773281a79638 } ); expect( translate( 'simple' ) ).toBe( 'implesa' ); expect( translate( 'red' ) ).toBe( 'edra' ); expect( translate( 'grey' ) ).toBe( 'reyga' ); expect( translate( 'green', { context: 'color' } ) ).toBe( 'cursus' ); } ); } ); describe( 'fixMe', () => { let originalHasTranslation; beforeEach( () => { originalHasTranslation = i18n.hasTranslation; } ); afterEach( () => { i18n.hasTranslation = originalHasTranslation; } ); it( 'should return null if text is missing or wrong type', () => { const result = i18n.fixMe( {} ); expect( result ).toBe( null ); } ); it( 'should return newCopy if locale is en', () => { i18n.getLocaleSlug = jest.fn().mockReturnValue( 'en' ); const result = i18n.fixMe( { text: 'hello', newCopy: 'hello', oldCopy: 'hi', } ); expect( result ).toBe( 'hello' ); } ); it( 'should return newCopy if locale is en-gb', () => { i18n.getLocaleSlug = jest.fn().mockReturnValue( 'en-gb' ); const result = i18n.fixMe( { text: 'hello', newCopy: 'hello', oldCopy: 'hi', } ); expect( result ).toBe( 'hello' ); } ); it( 'should return newCopy if text has a translation', () => { i18n.hasTranslation = jest.fn().mockReturnValue( true ); const result = i18n.fixMe( { text: 'hello', newCopy: 'bonjour', oldCopy: 'hi', } ); expect( result ).toBe( 'bonjour' ); } ); it( 'should return oldCopy if text does not have a translation and locale is not English', () => { i18n.getLocaleSlug = jest.fn().mockReturnValue( 'fr' ); i18n.hasTranslation = jest.fn().mockReturnValue( false ); const result = i18n.fixMe( { text: 'hello', newCopy: 'bonjour', oldCopy: 'hi', } ); expect( result ).toBe( 'hi' ); } ); it( 'should return newCopy if text has a translation with context', function () { const result = i18n.fixMe( { text: 'test3', newCopy: 'translation3', oldCopy: 'not test 3', translationOptions: { context: 'thecontext', }, } ); expect( result ).toBe( 'translation3' ); } ); it( 'should return oldCopy if text does not have a translation with this context', function () { const result = i18n.fixMe( { text: 'test3', newCopy: 'translation3', oldCopy: 'not test 3', translationOptions: { context: 'notthecontext', }, } ); expect( result ).toBe( 'not test 3' ); } ); } ); } );