Adding ability to disable src cache

projects/ngx-avatar/src/lib/avatar-config.service.spec.ts

@@ -1,7 +1,7 @@
 import { AvatarConfigService } from './avatar-config.service';
 import { AvatarSource } from './sources/avatar-source.enum';
 import { AvatarConfig } from './avatar-config';
-import { defaultSources, defaultColors } from './avatar.service';
+import { defaultSources, defaultColors, defaultDisableSrcCache } from './avatar.service';
 
 describe('AvatarConfigService', () => {
  describe('AvatarSources', () => {
@@ -104,4 +104,27 @@ describe('AvatarConfigService', () => {
  );
  });
  });
+
+ describe('AvatarDisableCache', () => {
+ it('should return the user\'s disable custom source cache settings when provided in the avatar configuration', () => {
+ const userDisableSrcCache = true;
+ const userConfig: AvatarConfig = {
+ disableSrcCache: userDisableSrcCache
+ };
+
+ const avatarConfigService = new AvatarConfigService(userConfig);
+
+ expect(avatarConfigService.getDisableSrcCache(defaultDisableSrcCache)).toBe(
+ userDisableSrcCache
+ );
+ });
+
+ it('should return the default disable custom source cache settings when no settings are provided in the avatar configuration', () => {
+ const avatarConfigService = new AvatarConfigService({});
+
+ expect(avatarConfigService.getDisableSrcCache(defaultDisableSrcCache)).toBe(
+ defaultDisableSrcCache
+ );
+ });
+ });
 });

projects/ngx-avatar/src/lib/avatar-config.service.ts

@@ -39,4 +39,9 @@ export class AvatarConfigService {
  defaultColors
  );
  }
+
+ public getDisableSrcCache(defaultDisableSrcCache: boolean): boolean {
+ if (this.userConfig.disableSrcCache === undefined) return defaultDisableSrcCache;
+ return this.userConfig.disableSrcCache;
+ }
 }

projects/ngx-avatar/src/lib/avatar-config.ts

@@ -13,4 +13,9 @@ export interface AvatarConfig {
  * The order in which the avatar sources will be used.
  */
  sourcePriorityOrder?: AvatarSource[];
+
+ /**
+ * Disable custom source (for custom images) cache.
+ */
+ disableSrcCache?: boolean;
 }

projects/ngx-avatar/src/lib/avatar.service.ts

@@ -38,6 +38,11 @@ export const defaultColors = [
  '#7f8c8d'
 ];
 
+/**
+ * Default disable custom source cache settings
+ */
+export const defaultDisableSrcCache = false;
+
 /**
  * Provides utilities methods related to Avatar component
  */

projects/ngx-avatar/src/lib/sources/custom-no-cache.ts

@@ -0,0 +1,18 @@
+import { Source } from './source';
+import { AvatarSource } from './avatar-source.enum';
+/**
+ * Custom source implementation (with no cache).
+ * return custom image as an avatar
+ *
+ */
+export class CustomNoCache implements Source {
+ readonly sourceType: AvatarSource = AvatarSource.CUSTOM;
+
+ constructor(public sourceId: string) {}
+
+ public getAvatar(): string {
+ const urlSuffix = Math.random();
+ const sourceId = `${this.sourceId}${this.sourceId.indexOf('?') > -1 ? '&' : '?'}_=${urlSuffix}`;
+ return sourceId;
+ }
+}

projects/ngx-avatar/src/lib/sources/source.factory.ts

@@ -13,6 +13,9 @@ import { Vkontakte } from './vkontakte';
 import { Github } from './github';
 import { SourceCreator } from './source.creator';
 import { AvatarSource } from './avatar-source.enum';
+import { AvatarConfigService } from '../avatar-config.service';
+import { defaultDisableSrcCache } from '../avatar.service';
+import { CustomNoCache } from './custom-no-cache';
 
 /**
  * Factory class that implements factory method pattern.
@@ -23,14 +26,16 @@ import { AvatarSource } from './avatar-source.enum';
 export class SourceFactory {
  private sources: { [key: string]: SourceCreator } = {};
 
- constructor() {
+ constructor(avatarConfigService: AvatarConfigService) {
+ const disableSrcCache = avatarConfigService.getDisableSrcCache(defaultDisableSrcCache);
+
  this.sources[AvatarSource.FACEBOOK] = Facebook;
  this.sources[AvatarSource.TWITTER] = Twitter;
  this.sources[AvatarSource.GOOGLE] = Google;
  this.sources[AvatarSource.INSTAGRAM] = Instagram;
  this.sources[AvatarSource.SKYPE] = Skype;
  this.sources[AvatarSource.GRAVATAR] = Gravatar;
- this.sources[AvatarSource.CUSTOM] = Custom;
+ this.sources[AvatarSource.CUSTOM] = disableSrcCache ? CustomNoCache : Custom;
  this.sources[AvatarSource.INITIALS] = Initials;
  this.sources[AvatarSource.VALUE] = Value;
  this.sources[AvatarSource.VKONTAKTE] = Vkontakte;