feat: Module export make consistent between multiple bundles (jmdobry#29)

Author: Delagen

README.md

@@ -28,7 +28,7 @@ bower install --save cachefactory
 ## Quick Start
 
 ```js
-import CacheFactory from 'cachefactory';
+import {CacheFactory} from 'cachefactory';
 
 const cacheFactory = new CacheFactory();
 let cache;

build_examples/browserify/app.js

@@ -1,5 +1,5 @@
 // normally this would be var CacheFactory = require('cachefactory');
-var CacheFactory = require('../../');
+var CacheFactory = require('../../').CacheFactory;
 
 var cacheFactory = new CacheFactory();
 var cache = cacheFactory.createCache('my-cache');

build_examples/r.js/app.js

@@ -1,6 +1,6 @@
 define('app', [
   'cachefactory'
-], function (CacheFactory) {
-  var cacheFactory = new CacheFactory();
+], function (CacheFactoryModule) {
+  var cacheFactory = new CacheFactoryModule.CacheFactory();
   return cacheFactory.createCache('my-cache');
 });

build_examples/webpack/app.js

@@ -1,5 +1,5 @@
 // normally this would be var CacheFactory = require('cachefactory');
-var CacheFactory = require('../../');
+var CacheFactory = require('../../').CacheFactory;
 
 var cacheFactory = new CacheFactory();
 var cache = cacheFactory.createCache('my-cache');

build_examples/webpack_es6/app.js

@@ -1,5 +1,5 @@
 // normally this would be var import CacheFactory from 'cachefactory'
-import CacheFactory from '../../';
+import {CacheFactory} from '../../';
 
 const cacheFactory = new CacheFactory();
 let cache = cacheFactory.createCache('my-cache');

dist/cachefactory.d.ts

@@ -1,11 +1,9 @@
-declare class CacheFactory {
-	static defaults: CacheFactory.CacheOptions;
-	static utils: CacheFactory.Utils;
+export class CacheFactory {
 	clearAll(): void;
-	createCache(id: string, options?: CacheFactory.CacheOptions): CacheFactory.Cache;
+	createCache(id: string, options?: CacheOptions): Cache;
 	exists(id: string): boolean;
-	get(id: string): CacheFactory.Cache;
-	info(): CacheFactory.CacheFactoryInfo;
+	get(id: string): Cache;
+	info(): CacheFactoryInfo;
 	destroy(id: string): void;
 	destroyAll(): void;
 	disableAll(): void;
@@ -16,91 +14,90 @@ declare class CacheFactory {
 	touchAll(): void;
 }
 
-declare namespace CacheFactory {
-	export class Cache {
-		id: string;
-		destroy(): void;
-		disable(): void;
-		enable(): void;
-		get(key: string|number, options?: GetPutOptions): any;
-		info(key: string|number): CacheInfo|ItemInfo;
-		keys(): (string|number)[];
-		keySet(): {[key: string]: string|number};
-		put(key: string|number, value: any, options?: GetPutOptions): any;
-		remove(key: string|number): any;
-		removeAll(): void;
-		removeExpired(): {[key: string]: any};
-		setCacheFlushInterval(cacheFlushInterval: number): void;
-		setCapacity(capacity: number): void;
-		setDeleteOnExpire(deleteOnExpire: DeleteOnExpire, setRecycleFreq?: boolean): void;
-		setMaxAge(maxAge: number): void;
-		setOnExpire(onExpire: Function): any;
-		setOptions(cacheOptions: CacheOptions, strict?: boolean): void;
-		setRecycleFreq(recycleFreq: boolean): void;
-		setStorageMode(storageMode: StorageMode, storageImpl?: StorageImpl): void;
-		touch(key: string|number): void;
-		values(): any[];
-	}
-	export type DeleteOnExpire = "none"|"passive"|"aggressive";
-	export type StorageMode = "memory"|"localStorage"|"sessionStorage";
-	export interface StorageImpl {
-		setItem(key: string|number, value: any): void;
-		getItem(key: string|number): any;
-		removeItem(key: string|number): void;
-	}
-	export class BinaryHeap {
-		constructor(weightFunc?: Function, compareFunc?: Function);
-		peek(): any;
-		pop(): any;
-		push(node: any): void;
-		remove(node: any): void;
-		removeAll(): void;
-		size(): number;
-	}
-	export interface Utils {
-		equals(a: any, b: any): boolean;
-		fromJson(value: string): any;
-		isFunction(value: any): boolean;
-		isNumber(value: any): boolean;
-		isObject(value: any): boolean;
-		isString(value: any): boolean;
-		Promise?: PromiseConstructor;
-	}
-	export type OnExpireCallback=(key:string, value:any, done?:Function)=>void;
-	export interface CacheOptions {
-		cacheFlushInterval?: number;
-		capacity?: number;
-		deleteOnExpire?: DeleteOnExpire;
-		enable?: boolean;
-		maxAge?: number;
-		onExpire?: OnExpireCallback;
-		recycleFreq?: number;
-		storageMode?: StorageMode;
-		storageImpl?: StorageImpl;
-		storagePrefix?: string;
-		storeOnResolve?: boolean;
-		storeOnReject?: boolean;
-	}
-	export interface ItemInfo {
-		accessed?: number;
-		created?: number;
-		expires?: number;
-		isExpired?: boolean;
-	}
-	export interface GetPutOptions extends ItemInfo {
-		maxAge?: number;
-		onExpire?: OnExpireCallback;
-		storeOnResolve?: boolean;
-		storeOnReject?: boolean;
-	}
-	export interface CacheInfo extends CacheOptions {
-		id: string;
-		size: number;
-	}
-	export interface CacheFactoryInfo extends CacheOptions {
-		size: number;
-		caches: {[id: string]: CacheInfo};
-	}
+export class Cache {
+	id: string;
+	destroy(): void;
+	disable(): void;
+	enable(): void;
+	get(key: string|number, options?: GetPutOptions): any;
+	info(key: string|number): CacheInfo|ItemInfo;
+	keys(): (string|number)[];
+	keySet(): {[key: string]: string|number};
+	put(key: string|number, value: any, options?: GetPutOptions): any;
+	remove(key: string|number): any;
+	removeAll(): void;
+	removeExpired(): {[key: string]: any};
+	setCacheFlushInterval(cacheFlushInterval: number): void;
+	setCapacity(capacity: number): void;
+	setDeleteOnExpire(deleteOnExpire: DeleteOnExpire, setRecycleFreq?: boolean): void;
+	setMaxAge(maxAge: number): void;
+	setOnExpire(onExpire: Function): any;
+	setOptions(cacheOptions: CacheOptions, strict?: boolean): void;
+	setRecycleFreq(recycleFreq: boolean): void;
+	setStorageMode(storageMode: StorageMode, storageImpl?: StorageImpl): void;
+	touch(key: string|number): void;
+	values(): any[];
+}
+export type DeleteOnExpire = "none"|"passive"|"aggressive";
+export type StorageMode = "memory"|"localStorage"|"sessionStorage";
+export interface StorageImpl {
+	setItem(key: string|number, value: any): void;
+	getItem(key: string|number): any;
+	removeItem(key: string|number): void;
+}
+export class BinaryHeap {
+	constructor(weightFunc?: Function, compareFunc?: Function);
+	peek(): any;
+	pop(): any;
+	push(node: any): void;
+	remove(node: any): void;
+	removeAll(): void;
+	size(): number;
+}
+export interface Utils {
+	equals(a: any, b: any): boolean;
+	fromJson(value: string): any;
+	isFunction(value: any): boolean;
+	isNumber(value: any): boolean;
+	isObject(value: any): boolean;
+	isString(value: any): boolean;
+	Promise?: PromiseConstructor;
+}
+export type OnExpireCallback=(key: string, value: any, done?: Function) => void;
+export interface CacheOptions {
+	cacheFlushInterval?: number;
+	capacity?: number;
+	deleteOnExpire?: DeleteOnExpire;
+	enable?: boolean;
+	maxAge?: number;
+	onExpire?: OnExpireCallback;
+	recycleFreq?: number;
+	storageMode?: StorageMode;
+	storageImpl?: StorageImpl;
+	storagePrefix?: string;
+	storeOnResolve?: boolean;
+	storeOnReject?: boolean;
+}
+export interface ItemInfo {
+	accessed?: number;
+	created?: number;
+	expires?: number;
+	isExpired?: boolean;
+}
+export interface GetPutOptions extends ItemInfo {
+	maxAge?: number;
+	onExpire?: OnExpireCallback;
+	storeOnResolve?: boolean;
+	storeOnReject?: boolean;
+}
+export interface CacheInfo extends CacheOptions {
+	id: string;
+	size: number;
+}
+export interface CacheFactoryInfo extends CacheOptions {
+	size: number;
+	caches: {[id: string]: CacheInfo};
 }
 
-export = CacheFactory;
+export const defaults: CacheOptions;
+export const utils: Utils;

karma.conf.js

@@ -4,7 +4,7 @@ module.exports = function (config) {
     frameworks: ['mocha', 'chai', 'sinon'],
     browsers: ['PhantomJS'],
     files: [
-      'node_modules/es6-promise/dist/es6-promise.js',
+      'node_modules/es6-promise/dist/es6-promise.auto.js',
       'node_modules/yabh/src/index.js',
       'src/utils.js',
       'src/defaults.js',

src/CacheFactory.js

@@ -1,3 +1,4 @@
+import defaults from './defaults'
 /**
  * A instance of `CacheFactory` holds multiple caches, and provides methods for
  * manipulating all of the caches at once.
@@ -182,8 +183,8 @@ export default class CacheFactory {
     keys.forEach((cacheId) => {
       info.caches[cacheId] = this.get(cacheId).info()
     })
-    Object.keys(CacheFactory.defaults).forEach((key, value) => {
-      info[key] = CacheFactory.defaults[key]
+    Object.keys(defaults).forEach((key, value) => {
+      info[key] = defaults[key]
     })
     return info
   }

src/index.js

@@ -22,7 +22,7 @@ import utils from './utils'
  * @example <caption>Load into your app via AMD</caption>
  * define('myApp', ['cachefactory'], function (CacheFactory) { ... })
  */
-export default CacheFactory
+export {CacheFactory}
 
 /**
  * The `BinaryHeap` constructor function.
@@ -36,7 +36,7 @@ export default CacheFactory
  * @see https://github.com/jmdobry/yabh
  * @type {function}
  */
-CacheFactory.BinaryHeap = BinaryHeap
+export {BinaryHeap}
 
 /**
  * The {@link Cache} constructor function.
@@ -51,6 +51,7 @@ CacheFactory.BinaryHeap = BinaryHeap
  * @type {function}
  */
 CacheFactory.Cache = Cache
+export {Cache}
 
 /**
  * The default cache values. Modify this object to change the default values.
@@ -68,7 +69,7 @@ CacheFactory.Cache = Cache
  * @see Cache
  * @type {object}
  */
-CacheFactory.defaults = defaults
+export {defaults}
 
 /**
  * Utility functions used throughout this library.
@@ -85,4 +86,4 @@ CacheFactory.defaults = defaults
  * @memberof module:cachefactory
  * @type {object}
  */
-CacheFactory.utils = utils
+export {utils}

test/_setup.js

@@ -1,5 +1,5 @@
 import { assert } from 'chai'
-import CacheFactory from '../src/index'
+import { Cache, CacheFactory } from '../src/index'
 import sinon from 'sinon'
 
 window.pp = function pp (obj) {
@@ -29,6 +29,7 @@ assert.fail = function (msg) {
 // Setup global data once
 export {
   assert,
+  Cache,
   CacheFactory,
   sinon
 }

test/unit/Cache/Cache.test.js

@@ -1,12 +1,10 @@
 import {
   assert,
-  CacheFactory,
+  Cache,
   CACHE_DEFAULTS,
   TYPES_EXCEPT_STRING
 } from '../../_setup'
 
-const { Cache } = CacheFactory
-
 describe('Cache', function () {
   it('should construct an instance of Cache', function () {
     const cache = new Cache(this.testId)

test/unit/Cache/destroy.test.js

@@ -1,10 +1,8 @@
 import {
   assert,
-  CacheFactory
+  Cache
 } from '../../_setup'
 
-const { Cache } = CacheFactory
-
 describe('Cache#destroy', function () {
   it('should destroy the cache', function () {
     const mock = {

test/unit/Cache/disable.test.js

@@ -1,10 +1,8 @@
 import {
   assert,
-  CacheFactory
+  Cache
 } from '../../_setup'
 
-const { Cache } = CacheFactory
-
 describe('Cache#disable', function () {
   it('should disable the cache', function () {
     const cache = new Cache(this.testId)

test/unit/Cache/enable.test.js

@@ -1,10 +1,8 @@
 import {
   assert,
-  CacheFactory
+  Cache
 } from '../../_setup'
 
-const { Cache } = CacheFactory
-
 describe('Cache#enable', function () {
   it('should enable the cache', function () {
     const cache = new Cache(this.testId, {

test/unit/Cache/get.test.js

@@ -1,13 +1,11 @@
 import {
   assert,
-  CacheFactory,
+  Cache,
   TYPES_EXCEPT_STRING_OR_ARRAY_OR_NUMBER,
   TYPES_EXCEPT_OBJECT,
   TYPES_EXCEPT_FUNCTION
 } from '../../_setup'
 
-const { Cache } = CacheFactory
-
 describe('Cache#get', function () {
   it('should do nothing if the cache is disabled', function () {
     const cache = new Cache(this.testId)

test/unit/Cache/info.test.js

@@ -1,10 +1,8 @@
 import {
   assert,
-  CacheFactory
+  Cache
 } from '../../_setup'
 
-const { Cache } = CacheFactory
-
 describe('Cache#info', function () {
   it('should return the correct values.', function () {
     const onExpire = function () {}