LRUResize example code

Author: yusufshakeel

index.html

@@ -1552,6 +1552,41 @@ <h4><code>LRUGet(name, key)</code></h4>
 
             <hr>
 
+            <!-- LRUResize() -->
+            <a name="LRUResize"></a>
+            <h4><code>LRUResize(name, size)</code></h4>
+
+            <p>This will resize the LRU object
+                referred by <code>name</code> in the cache.</p>
+
+            <p>If <code>size</code> is not mentioned then LRU object is resized to 3.</p>
+
+            <p>If new <code>size</code> is less than the current size then,
+                first 'size'-th key is kept in the queue and data set and rest of the keys are removed.</p>
+
+            <p>For example, if current size is 10 and new size is 4,
+                then first 4 key is retained in the data set and queue while the
+                remaining keys are removed.</p>
+
+            <p>Returns <code>true</code> on success, <code>false</code> otherwise.</p>
+
+            <pre><code>obj.LRUResize('myLRU', 2);</code></pre>
+
+            <div>
+                <a class="btn btn-primary"
+                   role="button"
+                   data-toggle="collapse"
+                   href="#collapse-LRUResize"
+                   aria-expanded="false"
+                   aria-controls="collapse-LRUResize">Output</a>
+            </div>
+            <div class="collapse" id="collapse-LRUResize">
+            </div>
+
+            <!-- LRUResize() ends here -->
+
+            <hr>
+
             <!-- LRUPurge() -->
             <a name="LRUPurge"></a>
             <h4><code>LRUPurge(name)</code></h4>

src/js/index-page-example.js

@@ -50,7 +50,7 @@ outputJSON(obj, 'collapse-set');
 
 // set('user', { username: 'yusufshakeel', points: 10 });
 output("Adding a <code>user</code> key having string value <code>{ username: 'yusufshakeel', points: 10 }</code>.", 'collapse-set');
-obj.set('user', { username: 'yusufshakeel', points: 10 });
+obj.set('user', {username: 'yusufshakeel', points: 10});
 outputJSON(obj, 'collapse-set');
 
 // set('arr', [1, 2, 3]);
@@ -116,7 +116,7 @@ outputJSON(obj, 'collapse-arrPush');
 
 // arrMPush();
 output("Push multiple values in an array referred by <code>users</code> key in the cache from the right", 'collapse-arrMPush');
-obj.arrMPush('users', [100, 'superman', ['a1', 'b2', 200], { id: 10, points: 20}]);
+obj.arrMPush('users', [100, 'superman', ['a1', 'b2', 200], {id: 10, points: 20}]);
 output("Content of the cache.", 'collapse-arrMPush');
 outputJSON(obj, 'collapse-arrMPush');
 
@@ -128,7 +128,7 @@ outputJSON(obj, 'collapse-arrLPush');
 
 // arrMLPush();
 output("Push multiple values in an array referred by <code>users</code> key in the cache from the left", 'collapse-arrMLPush');
-obj.arrMLPush('users', [1, 'hi', [1, 3], { m: 1 }]);
+obj.arrMLPush('users', [1, 'hi', [1, 3], {m: 1}]);
 output("Content of the cache.", 'collapse-arrMLPush');
 outputJSON(obj, 'collapse-arrMLPush');
 
@@ -169,13 +169,16 @@ outputJSON(obj.arrGet('users'), 'collapse-arrInsertAt');
 
 // arrMInsertAt();
 output("Insert multiple values at given <code>index</code> in a array referred by key <code>users</code> in the cache.", 'collapse-arrMInsertAt');
-outputJSON(obj.arrMInsertAt('users', 1, [ {id: 9999, name: 'yusufshakeel'}, 10, 'happy', [100] ]), 'collapse-arrMInsertAt');
+outputJSON(obj.arrMInsertAt('users', 1, [{
+    id: 9999,
+    name: 'yusufshakeel'
+}, 10, 'happy', [100]]), 'collapse-arrMInsertAt');
 output("Fetch all the elements of the array referred by <code>users</code> key in the cache.", 'collapse-arrMInsertAt');
 outputJSON(obj.arrGet('users'), 'collapse-arrMInsertAt');
 
 // arrUpdateElem();
 output("Update value of an element at index 0 in the array referred by key <code>users</code> in the cache.", 'collapse-arrUpdateElem');
-outputJSON(obj.arrUpdateElem('users', 0, { username: 'tintin', points: 50 }), 'collapse-arrUpdateElem');
+outputJSON(obj.arrUpdateElem('users', 0, {username: 'tintin', points: 50}), 'collapse-arrUpdateElem');
 output("Fetch all the elements of the array referred by <code>users</code> key in the cache.", 'collapse-arrUpdateElem');
 outputJSON(obj.arrGet('users'), 'collapse-arrUpdateElem');
 
@@ -210,11 +213,11 @@ outputJSON(obj, 'collapse-oInit');
 
 // oSet();
 output("This will add <code>p1</code> oKey having value <code>{ id: 'p1', username: 'yusufshakeel' }</code> in the key <code>players</code> of the cache.", 'collapse-oSet');
-obj.oSet('players', 'p1', { id: 'p1', username: 'yusufshakeel' });
+obj.oSet('players', 'p1', {id: 'p1', username: 'yusufshakeel'});
 output("Content of the cache.", 'collapse-oSet');
 outputJSON(obj, 'collapse-oSet');
 output("This will add <code>p2</code> oKey having value <code>{ id: 'p2', username: 'dawoodshakeel' }</code> in the key <code>players</code> of the cache.", 'collapse-oSet');
-obj.oSet('players', 'p2', { id: 'p2', username: 'dawoodshakeel' });
+obj.oSet('players', 'p2', {id: 'p2', username: 'dawoodshakeel'});
 output("Content of the cache.", 'collapse-oSet');
 outputJSON(obj, 'collapse-oSet');
 
@@ -272,7 +275,7 @@ obj.stackPush('myStack', 'Yusuf Shakeel');
 output("Push array value in stack referred by key <code>myStack</code> in the cache.", 'collapse-stackPush');
 obj.stackPush('myStack', [1, 2]);
 output("Push object value in stack referred by key <code>myStack</code> in the cache.", 'collapse-stackPush');
-obj.stackPush('myStack', { a:10 });
+obj.stackPush('myStack', {a: 10});
 output("Content of the cache.", 'collapse-stackPush');
 outputJSON(obj, 'collapse-stackPush');
 
@@ -329,7 +332,7 @@ obj.enqueue('myQueue', 'Yusuf Shakeel');
 output("Enqueue array value from the right side in queue referred by key <code>myQueue</code> in the cache.", 'collapse-enqueue');
 obj.enqueue('myQueue', [1, 2]);
 output("Enqueue object value from the right side in queue referred by key <code>myQueue</code> in the cache.", 'collapse-enqueue');
-obj.enqueue('myQueue', { a:10 });
+obj.enqueue('myQueue', {a: 10});
 output("Content of the cache.", 'collapse-enqueue');
 outputJSON(obj, 'collapse-enqueue');
 
@@ -401,6 +404,13 @@ output("Content of the cache after <code>LRUGet</code> operation.", 'collapse-LR
 outputJSON(obj, 'collapse-LRUGet');
 output("Note! 'k1' is moved from last index to 0th index in the queue after <code>LRUGet</code> operation.", 'collapse-LRUGet');
 
+// LRUResize();
+output("Content of the cache before <code>LRUResize</code> operation.", 'collapse-LRUResize');
+outputJSON(obj, 'collapse-LRUResize');
+obj.LRUResize('myLRU', 2);
+output("Content of the cache after <code>LRUResize</code> operation.", 'collapse-LRUResize');
+outputJSON(obj, 'collapse-LRUResize');
+
 // LRUPurge();
 output("Content of the cache before <code>LRUPurge</code> operation.", 'collapse-LRUPurge');
 outputJSON(obj, 'collapse-LRUPurge');

src/js/test.web.js

@@ -1302,6 +1302,80 @@ describe('Testing dyCacheJS', function () {
 
         });
 
+        describe('Testing LRUResize()', () => {
+
+            it('should return false when resizing LRU that does not exists in the cache', function () {
+
+                let result = obj.LRUResize("unknownLRU", 10);
+                assert.isFalse(result);
+
+            });
+
+            it('should return true when resizing LRU referred by myLRU in the cache', function () {
+
+                obj.LRUInit('myLRU', 3);
+                let result = obj.LRUResize("myLRU", 20);
+                assert.isTrue(result);
+
+            });
+
+            it('should resize LRU from size 3 to size 10 referred by myLRU in the cache', function () {
+
+                let expected = {
+                    "myLRU": {
+                        "_size": 10,
+                        "_data": {},
+                        "_queue": []
+                    }
+                };
+
+                // init
+                obj.LRUInit('myLRU', 3);
+
+                // resize
+                obj.LRUResize('myLRU', 10);
+
+                assert.deepEqual(obj._cache, expected);
+
+            });
+
+            it('should resize LRU from size 5 to size 3 referred by myLRU in the cache', function () {
+
+                let expected = {
+                    "myLRU": {
+                        "_size": 3,
+                        "_data": {
+                            "k3": 30,
+                            "k4": 40,
+                            "k5": 50
+                        },
+                        "_queue": [
+                            "k5",
+                            "k4",
+                            "k3"
+                        ]
+                    }
+                };
+
+                // init
+                obj.LRUInit('myLRU', 5);
+
+                // set
+                obj.LRUSet('myLRU', 'k1', 10);
+                obj.LRUSet('myLRU', 'k2', 20);
+                obj.LRUSet('myLRU', 'k3', 30);
+                obj.LRUSet('myLRU', 'k4', 40);
+                obj.LRUSet('myLRU', 'k5', 50);
+
+                // resize
+                obj.LRUResize('myLRU', 3);
+
+                assert.deepEqual(obj._cache, expected);
+
+            });
+
+        });
+
     });
 
 });