Merge pull request #1 from IuryPiva/master

Update dependencies, remove `--unstable` flag, add deno fmt and replace deprecated methods

.github/workflows/deno.yml

@@ -6,8 +6,8 @@ jobs:
 
     strategy:
       matrix:
-        deno: [1.6.1, 1.5.1]
-    name: Test with Deno ${{ matrix.deno }} 
+        deno: [1.16.4]
+    name: Test with Deno ${{ matrix.deno }}
 
     steps:
       - uses: actions/checkout@master
@@ -17,16 +17,11 @@ jobs:
         with:
           deno-version: ${{ matrix.deno }}
 
-      - name: Setup Node
-        uses: actions/setup-node@master
-        with:
-          node-version: 12
-
       - name: Print deno version
         run: deno --version
 
-      #- name: Check format
-      #  run: deno fmt --check **/*.ts
+      - name: Check format
+        run: deno fmt --check
 
       - name: Run tests
-        run: deno test --unstable --allow-read --allow-write
+        run: deno test --allow-read --allow-write

.gitignore

@@ -1,2 +1 @@
-.vscode/
 .dsddb/

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
-    "deno.enable": true,
-    "deno.import_intellisense_origins": {
-        "https://deno.land": true
-    },
-}
+  "deno.enable": true,
+  "deno.suggest.imports.hosts": {
+    "https://deno.land": true
+  }
+}

README.md

@@ -1,15 +1,14 @@
-
 <!-- PROJECT LOGO -->
 <br />
 <p align="center">
   <a href="https://github.com/MaximilianHeidenreich/DsDDB">
     <img src="https://deno.land/images/deno_matrix.png" alt="Deno Logo" width="80" height="80">
   </a>
 
-  <h2 align="center">DsDDB</h2>
+<h2 align="center">DsDDB</h2>
 
-  <p align="center">
-    A lightweight, develoepr friendly, key-value persistant storage solution for Deno projects</a>.
+<p align="center">
+    A lightweight, developer friendly, key-value persistant storage solution for Deno projects</a>.
     <br />
     <a href="https://doc.deno.land/https/deno.land/x/dsddb/mod.ts"><strong>Explore the docs »</strong></a>
     <br />
@@ -21,12 +20,17 @@
 </p>
 
 <br><br>
+
 <!-- ABOUT THE PROJECT -->
+
 ## About The Project
 
-I created this project because I needed a super simple key-value database which could store data between script restarts. This is the result of that attempt.
+I created this project because I needed a super simple key-value database which
+could store data between script restarts. This is the result of that attempt.
 
-Obviously it can't hold up with "real" databases but if you are just starting out developing a new project and you want a dead simple way to store data, this probably is the solution for you.
+Obviously it can't hold up with "real" databases but if you are just starting
+out developing a new project and you want a dead simple way to store data, this
+probably is the solution for you.
 
 If you want to use it, please check out the docs for the project.
 
@@ -41,15 +45,19 @@ If you want to use it, please check out the docs for the project.
 <br>
 
 <!-- USAGE -->
+
 ## Usage
 
-This is the most basic example to get DsDDB up and running within your project. For further infroamtion check out the [API Documentation](https://doc.deno.land/https/deno.land/x/dsddb/mod.ts).
+This is the most basic example to get DsDDB up and running within your project.
+For further information check out the
+[API Documentation](https://doc.deno.land/https/deno.land/x/dsddb/mod.ts).
 
-> ! Note: If you are using the load() and write() methods, you need to run your Deno program with the "--unstable --allow-read --allow-write" flags.
+> ! Note: If you are using the load() and write() methods, you need to run your
+> Deno program with the "--allow-read --allow-write" flags.
 
 ```TypeScript
 // 1. Import DsDDB
-import { DsDDB } from "https://deno.land/x/dsddb@v2.0.0/mod.ts";
+import { DsDDB } from "https://deno.land/x/dsddb@v2.1.0/mod.ts";
 
 // 2. Create new DsDDB instance
 const database = new DsDDB();
@@ -58,34 +66,33 @@ const database = new DsDDB();
 await database.load();
 
 // 4. Use database
-database.set("key1", "value 1")                 // Always override value.
-database.set("myKey", "Hello World", false);    // Never  override value.
+database.set("key1", "value 1"); // Always override value.
+database.set("myKey", "Hello World", false); // Never  override value.
 
 console.log(database.get("myKey"));
 
 // 5. Write data to disk
 await database.write();
 ```
 
-
 If you want to store custom data structures, there's a solution to that as well.
 
 ```TypeScript
 // 1. Import DsDDB
-import { DsDDB } from "https://deno.land/x/dsddb@v2.0.0/mod.ts";
+import { DsDDB } from "https://deno.land/x/dsddb@v2.1.0/mod.ts";
 
 // 2. Define your data structure.
 interface IDino {
-    name: string;
-    size: number;
-    birthday: Date;
+  name: string;
+  size: number;
+  birthday: Date;
 }
 
 // 3. Define your data.
 let data1: IDino = {
-    name: "Deno",
-    size: 69,
-    birthday: new Date()
+  name: "Deno",
+  size: 69,
+  birthday: new Date(),
 };
 
 // 4. Create new DsDDB instance
@@ -95,10 +102,10 @@ const database = new DsDDB<IDino>();
 await database.load();
 
 // 6. Use database
-database.set("deno", data1)
+database.set("deno", data1);
 
 console.log(database.get("deno"));
 
 // 7. Write data to disk
 await database.write();
-```
+```

deps.ts

@@ -1,2 +1 @@
-export { createHash } from "https://deno.land/[email protected]/hash/mod.ts";
-export { exists } from "https://deno.land/[email protected]/fs/mod.ts";
+export { Md5 } from "https://deno.land/[email protected]/hash/md5.ts";

mod.test.ts

@@ -0,0 +1,36 @@
+import { DsDDB } from "./mod.ts";
+import { assertExists, assertThrows } from "./test_deps.ts";
+
+Deno.test("Empty DB", async () => {
+  let db = new DsDDB();
+  await db.load();
+  await db.write();
+
+  assertThrows(() => Deno.readFileSync(db.storePath));
+});
+
+Deno.test("Simple Numer DB", async () => {
+  let db = new DsDDB();
+  await db.load();
+
+  db.set("number1", 5);
+  db.set("number2", 10);
+
+  await db.write();
+
+  assertExists(Deno.readFileSync(db.storePath));
+  await Deno.remove(db.storePath);
+});
+
+Deno.test("DB delete store", async () => {
+  let db = new DsDDB();
+  await db.load();
+
+  db.set("number1", 5);
+  db.set("number2", 10);
+
+  await db.write();
+  assertExists(Deno.readFileSync(db.storePath));
+  await db.deleteStore();
+  assertThrows(() => Deno.readFileSync(db.storePath));
+});

mod.ts

@@ -1 +1 @@
-export * from "./src/dsddb.ts";
+export * from "./src/dsddb.ts";