feat(memory-storage): move memory storage to a separate package (#63)

Author: Viatorus

CONTRIBUTING.md

@@ -140,7 +140,11 @@ The following is the list of supported scopes:
 * **local-storage**: The local storage adapter.
 * **indexed-storage**: The indexed db storage adapter.
 * **fs-storage**: The file system storage adapter.
-* **full-text-search**: The full text search engine.
+* **memory-storage**: The in-memory storage adapter.
+* **full-text-search**: The full-text search engine.
+* **full-text-search-language**: The language analyzer utility package.
+* **full-text-search-language-de**: The german language analyzer.
+* **full-text-search-language-en**: The english language analyzer.
 
 There are currently a few exceptions to the "use package name" rule:
 

README.md

@@ -33,6 +33,7 @@ Check out our interactive [documentation](https://lokijs-forge.github.io/LokiJS2
 |[@loki/fs-storage][fs-storage-npm-url]                             |  A persistence adapter which persists to node fs module storage. |
 |[@loki/local-storage][local-storage-npm-url]                       |  A persistence adapter which persists to web browser's indexed db storage. |
 |[@loki/indexed-storage][indexed-storage-npm-url]                   |  A persistence adapter which persists to web browser's local storage. |
+|[@loki/memory-storage][memory-storage-npm-url]                     |  A persistence adapter which persists to memory. |
 |[@loki/partitioning-adapter][partitioning-adapter-npm-url]         |  An adapter for adapters. Converts a non reference mode adapter into a reference mode adapter which can perform destructuring and partitioning.|
 
 <h3>Full-Text Search</h3>
@@ -61,6 +62,9 @@ Check out our interactive [documentation](https://lokijs-forge.github.io/LokiJS2
 [indexed-storage]: https://github.com/LokiJS-Forge/LokiJS2
 [indexed-storage-npm-url]: https://www.npmjs.com/package/@lokijs/indexed-storage
 
+[memory-storage]: https://github.com/LokiJS-Forge/LokiJS2
+[memory-storage-npm-url]: https://www.npmjs.com/package/@lokijs/memory-storage
+
 [partitioning-adapter]: https://github.com/LokiJS-Forge/LokiJS2
 [partitioning-adapter-npm-url]: https://www.npmjs.com/package/@lokijs/partitioning-adapter
 

config/build.js

@@ -13,6 +13,7 @@ const PACKAGES = [
   "local-storage",
   "indexed-storage",
   "fs-storage",
+  "memory-storage",
   "full-text-search",
   "full-text-search-language",
   "full-text-search-language-de",

packages/full-text-search/spec/generic/full_text_search.spec.ts

@@ -1,7 +1,7 @@
 /* global describe, ddescribe, it, expect */
 import {Loki} from "../../../loki/src/loki";
 import {QueryBuilder} from "../../src/query_builder";
-import {LokiMemoryAdapter} from "../../../loki/src/memory_adapter";
+import {MemoryStorage} from "../../../memory-storage/src/memory_storage";
 import {Collection} from "../../../loki/src/collection";
 import {FullTextSearch} from "../../src/full_text_search";
 import {Tokenizer} from "../../src/tokenizer";
@@ -143,7 +143,7 @@ describe("full-text search", () => {
   });
 
   it("save/load", (done) => {
-    const adapter = {adapter: new LokiMemoryAdapter()};
+    const adapter = {adapter: new MemoryStorage()};
     db.initializePersistence(adapter)
       .then(() => {
         return db.saveDatabase();
@@ -167,7 +167,7 @@ describe("full-text search", () => {
   });
 
   it("save/load with tokenizer", (done) => {
-    const adapter = {adapter: new LokiMemoryAdapter()};
+    const adapter = {adapter: new MemoryStorage()};
     db = new Loki("MyDB");
     const tkz = new Tokenizer();
     tkz.setSplitter("abc", (a: string) => a.split(" "));

packages/loki/spec/generic/dynamic_view.spec.ts

@@ -1,6 +1,6 @@
 /* global describe, beforeEach, it, expect */
 import {Loki} from "../../src/loki";
-import {LokiMemoryAdapter} from "../../src/memory_adapter";
+import {MemoryStorage} from "../../../memory-storage/src/memory_storage";
 import {Collection} from "../../src/collection";
 import {Doc} from "../../../common/types";
 
@@ -299,8 +299,8 @@ describe("dynamicviews", () => {
     });
 
     it("works 4", (done) => {
-      // mock persistence by using memory adapter
-      const mem = new LokiMemoryAdapter();
+      // mock persistence by using memory storage
+      const mem = new MemoryStorage();
       const db = new Loki("testCollections");
       db.initializePersistence({adapter: mem})
         .then(() => {

packages/loki/spec/generic/persistence.spec.ts

@@ -1,6 +1,6 @@
 /* global describe, beforeEach, it, expect */
 import {Loki} from "../../src/loki";
-import {LokiMemoryAdapter} from "../../src/memory_adapter";
+import {MemoryStorage} from "../../../memory-storage/src/memory_storage";
 import {Collection} from "../../src/collection";
 import SerializationMethod = Loki.SerializationMethod;
 import {StorageAdapter} from "../../../common/types";
@@ -245,8 +245,8 @@ describe("testing destructured serialization/deserialization", () => {
 });
 
 describe("testing adapter functionality", () => {
-  it("verify basic memory adapter functionality works", (done) => {
-    const memAdapter = new LokiMemoryAdapter();
+  it("verify basic memory storage functionality works", (done) => {
+    const memAdapter = new MemoryStorage();
     const ddb = new Loki("test.db");
 
     ddb.initializePersistence({adapter: memAdapter});
@@ -275,8 +275,8 @@ describe("testing adapter functionality", () => {
     dv.data();
 
     const p1 = ddb.saveDatabase().then(() => {
-      expect(memAdapter["_hashStore"].hasOwnProperty("test.db")).toEqual(true);
-      expect(memAdapter["_hashStore"]["test.db"].savecount).toEqual(1);
+      expect(memAdapter.hashStore.hasOwnProperty("test.db")).toEqual(true);
+      expect(memAdapter.hashStore["test.db"].savecount).toEqual(1);
     });
 
     const cdb = new Loki("test.db");
@@ -294,7 +294,7 @@ describe("testing adapter functionality", () => {
   });
 
   it("verify loki deleteDatabase works", (done) => {
-    const memAdapter = new LokiMemoryAdapter();
+    const memAdapter = new MemoryStorage();
     const ddb = new Loki("test.db");
     ddb.initializePersistence({adapter: memAdapter});
 
@@ -313,12 +313,12 @@ describe("testing adapter functionality", () => {
     });
 
     ddb.saveDatabase().then(() => {
-      expect(memAdapter["_hashStore"].hasOwnProperty("test.db")).toEqual(true);
-      expect(memAdapter["_hashStore"]["test.db"].savecount).toEqual(1);
+      expect(memAdapter.hashStore.hasOwnProperty("test.db")).toEqual(true);
+      expect(memAdapter.hashStore["test.db"].savecount).toEqual(1);
 
       return ddb.deleteDatabase();
     }).then(() => {
-      expect(memAdapter["_hashStore"].hasOwnProperty("test.db")).toEqual(false);
+      expect(memAdapter.hashStore.hasOwnProperty("test.db")).toEqual(false);
     }).then(done, done.fail);
   });
 
@@ -398,7 +398,7 @@ describe("testing adapter functionality", () => {
 
 describe("async adapter tests", () => {
   it("verify throttled async drain", (done) => {
-    const mem = new LokiMemoryAdapter({asyncResponses: true, asyncTimeout: 50});
+    const mem = new MemoryStorage({asyncResponses: true, asyncTimeout: 50});
     const db = new Loki("sandbox.db");
     db.initializePersistence({adapter: mem, throttledSaves: true});
 
@@ -436,7 +436,7 @@ describe("async adapter tests", () => {
 
       db2.loadDatabase().then(() => {
         // total of 2 saves should have occurred
-        expect(mem["_hashStore"]["sandbox.db"].savecount).toEqual(2);
+        expect(mem.hashStore["sandbox.db"].savecount).toEqual(2);
 
         // verify the saved database contains all expected changes
         expect(db2.getCollection<AB>("another").findOne({a: 1}).b).toEqual(3);
@@ -448,7 +448,7 @@ describe("async adapter tests", () => {
   });
 
   it("verify throttledSaveDrain with duration timeout works", (done) => {
-    const mem = new LokiMemoryAdapter({asyncResponses: true, asyncTimeout: 200});
+    const mem = new MemoryStorage({asyncResponses: true, asyncTimeout: 200});
     const db = new Loki("sandbox.db");
     db.initializePersistence({adapter: mem});
 
@@ -497,7 +497,7 @@ describe("async adapter tests", () => {
   });
 
   it("verify throttled async throttles", (done) => {
-    const mem = new LokiMemoryAdapter({asyncResponses: true, asyncTimeout: 50});
+    const mem = new MemoryStorage({asyncResponses: true, asyncTimeout: 50});
     const db = new Loki("sandbox.db");
     db.initializePersistence({adapter: mem});
 
@@ -530,7 +530,7 @@ describe("async adapter tests", () => {
     // give all async saves time to complete and then verify outcome
     setTimeout(() => {
       // total of 2 saves should have occurred
-      expect(mem["_hashStore"]["sandbox.db"].savecount).toEqual(2);
+      expect(mem.hashStore["sandbox.db"].savecount).toEqual(2);
 
       // verify the saved database contains all expected changes
       const db2 = new Loki("sandbox.db");
@@ -545,7 +545,7 @@ describe("async adapter tests", () => {
   });
 
   it("verify loadDatabase in the middle of throttled saves will wait for queue to drain first", (done) => {
-    const mem = new LokiMemoryAdapter({asyncResponses: true, asyncTimeout: 75});
+    const mem = new MemoryStorage({asyncResponses: true, asyncTimeout: 75});
     const db = new Loki("sandbox.db");
     db.initializePersistence({adapter: mem});
 
@@ -599,7 +599,7 @@ describe("async adapter tests", () => {
 
 describe("testing changesAPI", () => {
   it("verify pending changes persist across save/load cycle", (done) => {
-    const mem = new LokiMemoryAdapter();
+    const mem = new MemoryStorage();
     const db = new Loki("sandbox.db");
     let db2: Loki;
     db.initializePersistence({adapter: mem});
@@ -618,7 +618,7 @@ describe("testing changesAPI", () => {
     tyrfing.owner = "arngrim";
     items.update(tyrfing);
 
-    // memory adapter is synchronous so i will not bother with callbacks
+    // memory storage is synchronous so i will not bother with callbacks
     db.saveDatabase().then(() => {
       db2 = new Loki("sandbox.db");
       db2.initializePersistence({adapter: mem});

packages/loki/spec/generic/unique.spec.ts

@@ -1,6 +1,6 @@
 /* global describe, it, expect */
 import {Loki} from "../../src/loki";
-import {LokiMemoryAdapter} from "../../src/memory_adapter";
+import {MemoryStorage} from "../../../memory-storage/src/memory_storage";
 
 describe("Constraints", () => {
 
@@ -170,7 +170,7 @@ describe("Constraints", () => {
       name: "Jack"
     });
 
-    let mem = new LokiMemoryAdapter();
+    let mem = new MemoryStorage();
 
     expect(() => coll.insert({name: "Jack"})).toThrow();
 

packages/memory-storage/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@lokijs/memory-storage",
+  "description": "A persistence adapter which persists to memory.",
+  "author": "Various authors",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LokiJS-Forge/LokiJS2.git"
+  },
+  "main": "lokijs.memory-storage.js",
+  "types": "./types/memory-storage/src/index.d.ts",
+  "dependencies": {
+    "@lokijs/loki": "0"
+  }
+}

packages/memory-storage/spec/generic/memory_storage.spec.ts

@@ -0,0 +1,71 @@
+/* global describe, it, expect */
+import {Loki} from "../../../loki/src/loki";
+import {MemoryStorage} from "../../src/memory_storage";
+
+describe("testing memory storage", function () {
+
+  interface Name {
+    name: string;
+  }
+
+  beforeAll(() => {
+    MemoryStorage.register();
+  });
+
+  afterAll(() => {
+    MemoryStorage.deregister();
+  });
+
+  it("LokiMemoryStorage", function (done) {
+    const db = new Loki("myTestApp");
+    const adapter = {adapter: new MemoryStorage()};
+    db.initializePersistence(adapter)
+      .then(() => {
+        db.addCollection<Name>("myColl").insert({name: "Hello World"});
+        return db.saveDatabase();
+      })
+      .then(() => {
+        const db2 = new Loki("myTestApp");
+        return db2.initializePersistence(adapter)
+          .then(() => {
+            return db2.loadDatabase();
+          }).then(() => {
+            expect(db2.getCollection<Name>("myColl").find()[0].name).toEqual("Hello World");
+          });
+      })
+      .then(() => {
+        const db2 = new Loki("myTestApp");
+        return db2.initializePersistence(adapter)
+          .then(() => {
+            return db2.loadDatabase();
+          }).then(() => {
+            expect(db2.getCollection<Name>("myColl").find()[0].name).toEqual("Hello World");
+          });
+      })
+      .then(() => {
+        const db3 = new Loki("other");
+        return db3.initializePersistence(adapter)
+          .then(() => {
+            return db3.loadDatabase();
+          }).then(() => {
+            expect(false).toEqual(true);
+          }, () => {
+            expect(true).toEqual(true);
+          });
+      })
+      .then(() => {
+        return db.deleteDatabase();
+      })
+      .then(() => {
+        return db.loadDatabase()
+          .then(() => {
+            expect(db.getCollection<Name>("myColl").find()[0].name).toEqual("Hello World");
+            expect(false).toEqual(true);
+            done();
+          }, () => {
+            expect(true).toEqual(true);
+            done();
+          });
+      });
+  });
+});

packages/memory-storage/src/index.ts

@@ -0,0 +1,4 @@
+import {MemoryStorage} from "./memory_storage";
+
+export {MemoryStorage};
+export default MemoryStorage;