Skip to content

Commit

Permalink
fix(MissingTranslationHandler): revert of the breaking change release…
Browse files Browse the repository at this point in the history 
…d as a minor instead of major
  • Loading branch information
@ocombe
ocombe committed Nov 3, 2016
1 parent 481365d commit c843d91
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 79 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -258,10 +258,10 @@ Just don't forget that it will be called synchronously from the `instant` method
##### Example:
Create a Missing Translation Handler
```ts
import {MissingTranslationHandler, MissingTranslationHandlerParams} from 'ng2-translate';
import {MissingTranslationHandler} from 'ng2-translate';
export class MyMissingTranslationHandler implements MissingTranslationHandler {
handle(params: MissingTranslationHandlerParams) {
handle(key: string) {
return 'some value';
}
}
Expand Down
37 changes: 4 additions & 33 deletions src/translate.service.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,6 @@ export interface LangChangeEvent {
translations: any;
}

export interface MissingTranslationHandlerParams {
/**
* the key that's missing in translation files
*
* @type {string}
*/
key: string;

/**
* an instance of the service that was unable to translate the key.
*
* @type {TranslateService}
*/
translateService: TranslateService;

/**
* interpolation params that were passed along for translating the given key.
*
* @type {Object}
*/
interpolateParams?: Object;
}

declare interface Window {
navigator: any;
}
Expand All @@ -51,15 +28,13 @@ declare var window: Window;
export abstract class MissingTranslationHandler {
/**
* A function that handles missing translations.
*
* @abstract
* @param {MissingTranslationHandlerParams} the context for resolving a missing translation
* @param key the missing key
* @returns {any} a value or an observable
* If it returns a value, then this value is used.
* If it return an observable, the value returned by this observable will be used (except if the method was "instant").
* If it doesn't return then the key will be used as a value
*/
abstract handle(params: MissingTranslationHandlerParams): any;
abstract handle(key: string): any;
}

export abstract class TranslateLoader {
Expand Down Expand Up @@ -277,12 +252,8 @@ export class TranslateService {
res = this.parser.interpolate(this.parser.getValue(this.translations[this.defaultLang], key), interpolateParams);
}

if (!res && this.missingTranslationHandler) {
let params: MissingTranslationHandlerParams = { key, translateService: this };
if (typeof interpolateParams !== 'undefined') {
params.interpolateParams = interpolateParams;
}
res = this.missingTranslationHandler.handle(params);
if(!res && this.missingTranslationHandler) {
res = this.missingTranslationHandler.handle(key);
}

return res !== undefined ? res : key;
Expand Down
54 changes: 10 additions & 44 deletions tests/translate.service.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import {MockBackend, MockConnection} from "@angular/http/testing";
import {
TranslateService,
MissingTranslationHandler,
MissingTranslationHandlerParams,
TranslateLoader,
TranslateStaticLoader,
LangChangeEvent,
Expand Down Expand Up @@ -311,23 +310,23 @@ describe('MissingTranslationHandler', () => {
let missingTranslationHandler: MissingTranslationHandler;

class Missing implements MissingTranslationHandler {
handle(params: MissingTranslationHandlerParams) {
handle(key: string) {
return "handled";
}
}

class MissingObs implements MissingTranslationHandler {
handle(params: MissingTranslationHandlerParams): Observable<any> {
return Observable.of(`handled: ${params.key}`);
handle(key: string): Observable<any> {
return Observable.of(`handled: ${key}`);
}
}

let prepare = ((handlerClass: Function) => {
TestBed.configureTestingModule({
imports: [HttpModule, TranslateModule.forRoot()],
providers: [
{ provide: MissingTranslationHandler, useClass: handlerClass },
{ provide: XHRBackend, useClass: MockBackend }
{provide: MissingTranslationHandler, useClass: handlerClass},
{provide: XHRBackend, useClass: MockBackend}
]
});
injector = getTestBed();
Expand All @@ -352,40 +351,7 @@ describe('MissingTranslationHandler', () => {
spyOn(missingTranslationHandler, 'handle').and.callThrough();

translate.get('nonExistingKey').subscribe((res: string) => {
expect(missingTranslationHandler.handle).toHaveBeenCalledWith(jasmine.objectContaining({ key: 'nonExistingKey' }));
//test that the instance of the last called argument is string
expect(res).toEqual('handled');
});

// mock response after the xhr request, otherwise it will be undefined
mockBackendResponse(connection, '{"TEST": "This is a test"}');
});

it('should propagate interpolation params when the key does not exist', () => {
prepare(Missing);
translate.use('en');
spyOn(missingTranslationHandler, 'handle').and.callThrough();
let interpolateParams = { some: 'params' };

translate.get('nonExistingKey', interpolateParams).subscribe((res: string) => {
expect(missingTranslationHandler.handle).toHaveBeenCalledWith(jasmine.objectContaining({ interpolateParams: interpolateParams }));
//test that the instance of the last called argument is string
expect(res).toEqual('handled');
});

// mock response after the xhr request, otherwise it will be undefined
mockBackendResponse(connection, '{"TEST": "This is a test"}');
});

it('should propagate TranslationService params when the key does not exist', () => {
prepare(Missing);
translate.use('en');
spyOn(missingTranslationHandler, 'handle').and.callThrough();
let interpolateParams = { some: 'params' };

translate.get('nonExistingKey', interpolateParams).subscribe((res: string) => {
expect(missingTranslationHandler.handle).toHaveBeenCalledWith(jasmine.objectContaining({ translateService: translate }));
//test that the instance of the last called argument is string
expect(missingTranslationHandler.handle).toHaveBeenCalledWith('nonExistingKey');
expect(res).toEqual('handled');
});

Expand All @@ -395,7 +361,7 @@ describe('MissingTranslationHandler', () => {

it('should return the key when using MissingTranslationHandler & the handler returns nothing', () => {
class MissingUndef implements MissingTranslationHandler {
handle(params: MissingTranslationHandlerParams) {
handle(key: string) {
}
}

Expand All @@ -404,7 +370,7 @@ describe('MissingTranslationHandler', () => {
spyOn(missingTranslationHandler, 'handle').and.callThrough();

translate.get('nonExistingKey').subscribe((res: string) => {
expect(missingTranslationHandler.handle).toHaveBeenCalledWith(jasmine.objectContaining({ key: 'nonExistingKey' }));
expect(missingTranslationHandler.handle).toHaveBeenCalledWith('nonExistingKey');
expect(res).toEqual('nonExistingKey');
});

Expand All @@ -431,7 +397,7 @@ describe('MissingTranslationHandler', () => {
spyOn(missingTranslationHandler, 'handle').and.callThrough();

expect(translate.instant('nonExistingKey')).toEqual('handled');
expect(missingTranslationHandler.handle).toHaveBeenCalledWith(jasmine.objectContaining({ key: 'nonExistingKey' }));
expect(missingTranslationHandler.handle).toHaveBeenCalledWith('nonExistingKey');
});

it('should wait for the MissingTranslationHandler when it returns an observable & we use get', () => {
Expand All @@ -440,7 +406,7 @@ describe('MissingTranslationHandler', () => {
spyOn(missingTranslationHandler, 'handle').and.callThrough();

translate.get('nonExistingKey').subscribe((res: string) => {
expect(missingTranslationHandler.handle).toHaveBeenCalledWith(jasmine.objectContaining({ key: 'nonExistingKey' }));
expect(missingTranslationHandler.handle).toHaveBeenCalledWith('nonExistingKey');
expect(res).toEqual('handled: nonExistingKey');
});

Expand Down

0 comments on commit c843d91

Please sign in to comment.