@urso/core 0.5.12 → 0.6.0

package/src/js/lib/objectPool.js

@@ -1,55 +1,204 @@
-class ObjectPoolMember {
-    free = true;
-    data = null;
-
-    constructor(data) {
-        this.data = data
-    }
-}
-
-class LibObjectPool {
-    pool = {};
-    resetFunction = () => { }
-    constructorFunction = () => { }
-
-    constructor(constructorFunction, resetFunction = (obj) => obj, initialSize = 0) { //todo initialSize
-        this.resetFunction = resetFunction;
-        this.constructorFunction = constructorFunction;
-    }
-
-    getElement(key = 'default', additionalCreateArguments) {
-        this._checkPoolKey(key);
-        const poolArray = this.pool[key];
-
-
-        for (let i = 0; i < poolArray.length; i++) {
-            if (poolArray[i].free) {
-                poolArray[i].free = false;
-                return poolArray[i];
-            }
-        }
-
-        const newObj = this._createElement(key, additionalCreateArguments);
-        newObj.free = false;
-        return newObj;
-    }
-
-    putElement(element) {
-        element.free = true;
-        this.resetFunction(element.data);
-    }
-
-    _createElement(key, additionalCreateArguments = null) {
-        const newObj = this.resetFunction(this.constructorFunction(key, additionalCreateArguments));
-        const poolMember = new ObjectPoolMember(newObj);
-        this.pool[key].push(poolMember);
-        return poolMember;
-    }
-
-    _checkPoolKey(key) {
-        if (!this.pool[key])
-            this.pool[key] = [];
-    }
-}
-
+class ObjectPoolMember {
+
+    free = true;
+    putCacheTimeKey = 0;
+    key = null; //element branch;
+    branchKey = 0; //element branch key
+    data = null;
+
+    constructor(data, key, branchKey) {
+        this.data = data;
+        this.key = key;
+        this.branchKey = branchKey;
+    }
+}
+
+
+/**
+ * @param {Function} constructorFunction - function to constract element
+ * @param {Function} constructorFunction - function to reset element when put back to pool
+ * @param {Number} [initialSize] - initial pool size. Use only if you not using keys when constract
+ * @param {Number} [maxSize] - max pool size. Old elements will be removed from pool
+ */
+class LibObjectPool {
+
+    _pool = {};
+    resetFunction = () => { };
+    constructorFunction = () => { };
+    _maxSize = 0;
+
+    _lastBranchKeys = {};
+    _putTimeCache = {};
+
+    constructor(constructorFunction, resetFunction = (obj) => obj, initialSize = 0, maxSize = 0) {
+        this.resetFunction = resetFunction;
+        this.constructorFunction = constructorFunction;
+        this._maxSize = maxSize;
+
+        this._createInitial(initialSize);
+    }
+
+    /**
+     * get element from pool
+     * @param {String | Number} key - element key to get
+     * @param {mixed} [additionalCreateArguments] - additional create Arguments
+     * @returns {ObjectPoolMember}
+     */
+    getElement(key = 'default', additionalCreateArguments) {
+        this._checkPoolKey(key);
+        const poolBranch = this._pool[key];
+
+        for (const poolObject of Object.values(poolBranch)) {
+            if (poolObject.free) {
+                poolObject.free = false;
+
+                //remove from putTimeCache
+                if (poolObject.putCacheTimeKey) {
+                    delete this._putTimeCache[poolObject.putCacheTimeKey];
+                    poolObject.putCacheTimeKey = 0;
+                }
+
+                return poolObject;
+            }
+        }
+
+        const newObj = this._createElement(key, additionalCreateArguments);
+        newObj.free = false;
+        return newObj;
+    }
+
+    /**
+     * put element back to pool (resetFunction will call)
+     * @param {ObjectPoolMember} element
+     */
+    putElement(element) {
+        element.free = true;
+        this.resetFunction(element.data);
+
+        if (this._maxSize) {
+            //lets write put time cache
+            const putCacheTimeKey = this._getElementBranchKey('_putTimeCache', this._putTimeCache);
+            this._putTimeCache[putCacheTimeKey] = element;
+            element.putCacheTimeKey = putCacheTimeKey;
+        }
+
+        this._checkMaxSize();
+    }
+
+    /**
+     * check max pool size
+     */
+    _checkMaxSize() {
+        if (!this._maxSize)
+            return;
+
+        //remove oldest inactive element
+        const poolSize = this._getPoolSize();
+
+        if (poolSize > this._maxSize) {
+            this._removeOldestInactiveElement();
+        }
+
+    }
+
+    /**
+     * remove oldest inactive element
+     */
+    _removeOldestInactiveElement() {
+        const keyToRemove = Object.keys(this._putTimeCache)[0];
+        const element = this._putTimeCache[keyToRemove];
+
+        //remove from pool
+        delete this._pool[element.key][element.branchKey];
+
+        //reset element
+        element.free = false;
+        element.putCacheTimeKey = 0;
+        element.key = null;
+        element.branchKey = 0;
+        element.data = null;
+
+        //remove from putTimeCache
+        delete this._putTimeCache[keyToRemove];
+    }
+
+    /**
+     * pool size (all branches)
+     */
+    _getPoolSize() {
+        let size = 0;
+
+        for (const branch of Object.values(this._pool)) {
+            size += Object.keys(branch).length;
+        }
+
+        return size;
+    }
+
+    /**
+     * create new element for pool
+     * @param {String | Number} key - element key to create
+     * @param {mixed} [additionalCreateArguments] - additional create Arguments
+     * @returns {ObjectPoolMember}
+     */
+    _createElement(key, additionalCreateArguments = null) {
+        const newObj = this.resetFunction(this.constructorFunction(key, additionalCreateArguments));
+        const branchKey = this._getElementBranchKey(key, this._pool[key]);
+        const poolMember = new ObjectPoolMember(newObj, key, branchKey);
+        this._pool[key][branchKey] = poolMember;
+        return poolMember;
+    }
+
+    /**
+     * get element branch key
+     * @param {String | Number} key - element key to get
+     * @returns {Nymber}
+     */
+    _getElementBranchKey(key, poolBranch) {
+        let branchKey = Urso.time.get();
+
+        //prevent duplicates
+        if (poolBranch[branchKey]) {
+            branchKey = this._lastBranchKeys[key] + 1;
+        }
+
+        this._lastBranchKeys[key] = branchKey;
+        return branchKey;
+    }
+
+    /**
+     * create initial pool objects
+     * @param {Number} initialSize
+     */
+    _createInitial(initialSize) {
+        if (!initialSize)
+            return;
+
+        let newObjectsArray = [];
+
+        for (let index = 0; index < initialSize; index++) {
+            newObjectsArray.push(this.getElement());
+        }
+
+        newObjectsArray.forEach(newObject => { this.putElement(newObject); });
+    }
+
+    /**
+     * check exist key namespace
+     * @param {String | Number} key - element key
+     */
+    _checkPoolKey(key) {
+        if (!this._pool[key])
+            this._pool[key] = {};
+    }
+
+    /**
+     * debug get pool data
+     * @returns {Array}
+     */
+    _debugGetPoolData() {
+        return this._pool;
+    }
+}
+
 module.exports = LibObjectPool;

package/src/js/lib/time.js

@@ -1,19 +1,19 @@
-class LibTime {
-
-    get(foo) {
-        if (!foo)
-            foo = new Date();
-
-        return foo.getTime();
-    }
-
-    getUnixtime(foo) {
-        if (!foo)
-            foo = new Date();
-
-        var unixtime_ms = foo.getTime();
-        return ~~(unixtime_ms / 1e3);
-    }
-}
-
+class LibTime {
+
+    get(foo) {
+        if (!foo)
+            foo = new Date();
+
+        return foo.getTime();
+    }
+
+    getUnixtime(foo) {
+        if (!foo)
+            foo = new Date();
+
+        var unixtime_ms = foo.getTime();
+        return ~~(unixtime_ms / 1e3);
+    }
+}
+
 module.exports = LibTime;

package/src/js/lib/tween.js

@@ -1,148 +1,148 @@
-class LibTween {
-    constructor() {
-        this.singleton = true;
-
-        this._tweenIndex = 0;
-        this._tweens = {};
-    }
-
-    removeAll() {
-        for (let k in this._tweens)
-            this._tweens[k].stop();
-
-        this._tweens = {};
-    };
-
-    add(object) {
-        const key = this._keyGenerate();
-
-        const tl = gsap.timeline({
-            repeat: 1,
-            onComplete: () => { this._onCompleteHandler(key) },
-            onUpdate: () => { this._onUpdateHandler(key) }
-        });
-
-        const tween = {
-            id: key,
-            isRunning: false,
-            target: object,
-            to: this._to,
-            start: this._start,
-            pause: this._pause,
-            resume: this._resume,
-            stop: this._stop,
-
-            _timeScale: 1,
-            get timeScale() {
-                return this._timeScale;
-            }, set timeScale(a) {
-                return this._timeScale;
-            },
-            _timeline: tl,
-            _complete: false,
-            _paused: true,
-            _functions: {
-                onStart: [],
-                onUpdate: [],
-                onComplete: []
-            }
-        };
-
-        //need to add some functions
-        tween.onComplete = {
-            add: (f) => {
-                tween._functions.onComplete.push(f);
-                return tween;
-            }
-        };
-
-        tween.onStart = {
-            add: (f) => {
-                tween._functions.onStart.push(f);
-                return tween;
-            }
-        };
-
-        tween.onUpdate = {
-            add: (f) => {
-                tween._functions.onUpdate.push(f);
-                return tween;
-            }
-        };
-
-        this._tweens[key] = tween;
-
-        return tween;
-    };
-
-    _keyGenerate() {
-        this._tweenIndex++;
-        return (new Date()).getTime() + '_' + this._tweenIndex;
-    };
-
-    //todo easing
-    _to(propsTo, duration, easing = undefined, autostart = false, startDelay = 0) {
-        const params = Urso.helper.objectClone(propsTo, 10);
-        params.duration = duration / 1000;
-        params.easing = easing;
-        params.delay = startDelay;
-
-        this._timeline.to(this.target, params);
-        //this.pause();
-
-        if (autostart)
-            this.start();
-
-        return this;
-    };
-
-    _start() {
-        for (let i = 0; i < this._functions.onStart.length; i++)
-            this._functions.onStart[i]();
-
-        this.resume();
-        return this;
-    };
-
-    _pause() {
-        this._paused = true;
-        this.isRunning = false;
-        this._timeline.pause();
-
-        return this;
-    };
-
-    _resume() {
-        this._paused = false;
-        this.isRunning = true;
-        this._timeline.resume();
-
-        return this;
-    };
-
-    _stop() {
-        this.pause();
-        this._timeline.kill();
-        this._complete = true;
-
-        return this;
-    };
-
-    _onUpdateHandler(tweenKey) {
-        const tween = this._tweens[tweenKey];
-        const percentage = ~~(tween._timeline.progress() * 100);
-
-        for (let i = 0; i < tween._functions.onUpdate.length; i++)
-            tween._functions.onUpdate[i](tween, percentage);
-    }
-
-    _onCompleteHandler(tweenKey) {
-        const tween = this._tweens[tweenKey];
-        const onComplete = tween._functions.onComplete;
-
-        for (let i = 0; i < onComplete.length; i++)
-            onComplete[i]();
-    }
-}
-
+class LibTween {
+    constructor() {
+        this.singleton = true;
+
+        this._tweenIndex = 0;
+        this._tweens = {};
+    }
+
+    removeAll() {
+        for (let k in this._tweens)
+            this._tweens[k].stop();
+
+        this._tweens = {};
+    };
+
+    add(object) {
+        const key = this._keyGenerate();
+
+        const tl = gsap.timeline({
+            repeat: 1,
+            onComplete: () => { this._onCompleteHandler(key) },
+            onUpdate: () => { this._onUpdateHandler(key) }
+        });
+
+        const tween = {
+            id: key,
+            isRunning: false,
+            target: object,
+            to: this._to,
+            start: this._start,
+            pause: this._pause,
+            resume: this._resume,
+            stop: this._stop,
+
+            _timeScale: 1,
+            get timeScale() {
+                return this._timeScale;
+            }, set timeScale(a) {
+                return this._timeScale;
+            },
+            _timeline: tl,
+            _complete: false,
+            _paused: true,
+            _functions: {
+                onStart: [],
+                onUpdate: [],
+                onComplete: []
+            }
+        };
+
+        //need to add some functions
+        tween.onComplete = {
+            add: (f) => {
+                tween._functions.onComplete.push(f);
+                return tween;
+            }
+        };
+
+        tween.onStart = {
+            add: (f) => {
+                tween._functions.onStart.push(f);
+                return tween;
+            }
+        };
+
+        tween.onUpdate = {
+            add: (f) => {
+                tween._functions.onUpdate.push(f);
+                return tween;
+            }
+        };
+
+        this._tweens[key] = tween;
+
+        return tween;
+    };
+
+    _keyGenerate() {
+        this._tweenIndex++;
+        return (new Date()).getTime() + '_' + this._tweenIndex;
+    };
+
+    //todo easing
+    _to(propsTo, duration, easing = undefined, autostart = false, startDelay = 0) {
+        const params = Urso.helper.objectClone(propsTo, 10);
+        params.duration = duration / 1000;
+        params.easing = easing;
+        params.delay = startDelay;
+
+        this._timeline.to(this.target, params);
+        //this.pause();
+
+        if (autostart)
+            this.start();
+
+        return this;
+    };
+
+    _start() {
+        for (let i = 0; i < this._functions.onStart.length; i++)
+            this._functions.onStart[i]();
+
+        this.resume();
+        return this;
+    };
+
+    _pause() {
+        this._paused = true;
+        this.isRunning = false;
+        this._timeline.pause();
+
+        return this;
+    };
+
+    _resume() {
+        this._paused = false;
+        this.isRunning = true;
+        this._timeline.resume();
+
+        return this;
+    };
+
+    _stop() {
+        this.pause();
+        this._timeline.kill();
+        this._complete = true;
+
+        return this;
+    };
+
+    _onUpdateHandler(tweenKey) {
+        const tween = this._tweens[tweenKey];
+        const percentage = ~~(tween._timeline.progress() * 100);
+
+        for (let i = 0; i < tween._functions.onUpdate.length; i++)
+            tween._functions.onUpdate[i](tween, percentage);
+    }
+
+    _onCompleteHandler(tweenKey) {
+        const tween = this._tweens[tweenKey];
+        const onComplete = tween._functions.onComplete;
+
+        for (let i = 0; i < onComplete.length; i++)
+            onComplete[i]();
+    }
+}
+
 module.exports = LibTween;

package/src/js/modules/_info.js

@@ -1,12 +1,12 @@
-Urso.Core.Modules = {};
-require('./assets/_info.js');
-require('./i18n/_info.js');
-require('./instances/_info.js');
-require('./logic/_info.js');
-require('./objects/_info.js');
-require('./observer/_info.js');
-require('./scenes/_info.js');
-require('./soundManager/_info.js');
-require('./statesManager/_info.js');
-require('./template/_info.js');
-require('./transport/_info.js');
+Urso.Core.Modules = {};
+require('./assets/_info.js');
+require('./i18n/_info.js');
+require('./instances/_info.js');
+require('./logic/_info.js');
+require('./objects/_info.js');
+require('./observer/_info.js');
+require('./scenes/_info.js');
+require('./soundManager/_info.js');
+require('./statesManager/_info.js');
+require('./template/_info.js');
+require('./transport/_info.js');

package/src/js/modules/assets/_info.js

@@ -1,7 +1,7 @@
-Urso.Core.Modules.Assets = {
-    BaseModel: require('./baseModel.js'),
-    Config: require('./config.js'),
-    Controller: require('./controller.js'),
-    Service: require('./service.js')
-};
-require('./models/_info.js');
+Urso.Core.Modules.Assets = {
+    BaseModel: require('./baseModel.js'),
+    Config: require('./config.js'),
+    Controller: require('./controller.js'),
+    Service: require('./service.js')
+};
+require('./models/_info.js');

package/src/js/modules/assets/baseModel.js

@@ -1,19 +1,19 @@
-class ModulesAssetsBaseModel {
-    constructor(params) {
-        this.setupParams(params);
-        this._templatePath = false;
-    }
-
-    setupParams(params) {
-        this.id = Urso.helper.recursiveGet('id', params, false);
-        this.type = Urso.helper.recursiveGet('type', params, null);
-        this.key = Urso.helper.recursiveGet('key', params, false);
-        this.path = Urso.helper.recursiveGet('path', params, false);
-        this.useBinPath = Urso.helper.recursiveGet('useBinPath', params, false) || Urso.config.mode !== 'development'; //or true if we want to use asset from assetsBin
-        //lazy load params
-        this.loadingGroup = Urso.helper.recursiveGet('loadingGroup', params, false); //initial or some extra name
-        this.placeHolder = Urso.helper.recursiveGet('placeHolder', params, false); //placeHolder assets model //TODO
-    }
-}
-
+class ModulesAssetsBaseModel {
+    constructor(params) {
+        this.setupParams(params);
+        this._templatePath = false;
+    }
+
+    setupParams(params) {
+        this.id = Urso.helper.recursiveGet('id', params, false);
+        this.type = Urso.helper.recursiveGet('type', params, null);
+        this.key = Urso.helper.recursiveGet('key', params, false);
+        this.path = Urso.helper.recursiveGet('path', params, false);
+        this.useBinPath = Urso.helper.recursiveGet('useBinPath', params, false) || Urso.config.mode !== 'development'; //or true if we want to use asset from assetsBin
+        //lazy load params
+        this.loadingGroup = Urso.helper.recursiveGet('loadingGroup', params, false); //initial or some extra name
+        this.placeHolder = Urso.helper.recursiveGet('placeHolder', params, false); //placeHolder assets model //TODO
+    }
+}
+
 module.exports = ModulesAssetsBaseModel;