Package clean up

.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Unit tests
+
+env:
+  NPM_TOKEN: ${{secrets.NPM_TOKEN}}
+on:
+  pull_request:
+    branches:
+      - "*"
+jobs:
+  test:
+    name: Run Test Suite
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://npm.pkg.github.com/
+          scope: "@flatlify"
+      - run: sudo apt-get update
+      - run: npm i
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - run: npm run test

.npmrc

@@ -1,2 +1,2 @@
-registry=https://npm.pkg.github.com/flatlify
-//npm.pkg.github.com/:_authToken=TOKEN
+@flatlify:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=${NPM_TOKEN}

jest.config.js

@@ -1,4 +1,5 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
+  modulePathIgnorePatterns: ['lib'],
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flatlify/gitdb",
-  "version": "0.1.6",
+  "version": "0.1.9",
   "description": "A simple, robust and performant git-based database",
   "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",
@@ -10,10 +10,10 @@
   "scripts": {
     "build": "rimraf ./lib && tsc",
     "test:watch": "jest --watch",
-    "lint": "eslint . --ext .ts",
+    "lint": "eslint .  --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
     "prettier": "prettier --config .prettierrc 'src/**/*.ts' --write",
-    "test": "jest"
+    "test": "npm run lint && jest"
   },
   "repository": {
     "type": "git",
@@ -38,11 +38,14 @@
     "registry": "https://npm.pkg.github.com/"
   },
   "devDependencies": {
+    "@types/fs-extra": "^9.0.1",
     "@types/jest": "^25.2.1",
     "@types/node": "^13.13.6",
+    "@types/uuid": "^8.0.0",
     "@typescript-eslint/eslint-plugin": "^2.30.0",
     "@typescript-eslint/parser": "^2.30.0",
     "eslint": "^6.8.0",
+    "eslint-config-airbnb": "^18.2.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-jest": "^23.8.2",
     "eslint-plugin-prettier": "^3.1.3",
@@ -54,9 +57,6 @@
     "typescript": "^3.8.3"
   },
   "dependencies": {
-    "@types/fs-extra": "^9.0.0",
-    "@types/uuid": "^8.0.0",
-    "eslint-config-airbnb": "^18.2.0",
     "find-git-root": "^1.0.4",
     "fs-extra": "^9.0.0",
     "isomorphic-git": "^1.4.0",

src/Collection/Collection.test.ts

@@ -1,11 +1,12 @@
 // import fsWithCallbacks from 'fs';
 import Collection from './Collection';
-import FileStrategy from '../FileStrategy/FileStrategy';
-import MemoryStrategy from '../MemoryStrategy/MemoryStrategy';
-import { createMockDB } from '../helpers/testHelpers';
+import { FileStrategy } from '../CollectionStrategies/FileStrategy';
+import { MemoryStrategy } from '../CollectionStrategies/MemoryStrategy';
+import { createMockDB } from '../utils/createMockDB';
+import * as fileDependency from '../utils/file';
 
-jest.mock('../FileStrategy/FileStrategy');
-jest.mock('../MemoryStrategy/MemoryStrategy');
+jest.mock('../CollectionStrategies/FileStrategy');
+jest.mock('../CollectionStrategies/MemoryStrategy');
 
 beforeEach(() => {
   // Clear all instances and calls to constructor and all methods:
@@ -15,15 +16,18 @@ beforeEach(() => {
   MemoryStrategy.mockClear();
 });
 
-const DB_DIR = '/dbDir';
-
 describe('constructor', () => {
   test('Works', async () => {
     const gitDB = await createMockDB();
     const fileStrategy = new FileStrategy('path');
     const memoryStrategy = new MemoryStrategy([]);
 
-    const collection = new Collection(gitDB, fileStrategy, memoryStrategy);
+    const collection = new Collection(
+      gitDB,
+      'name',
+      fileStrategy,
+      memoryStrategy,
+    );
 
     expect(collection instanceof Collection).toBe(true);
   });
@@ -37,7 +41,7 @@ describe('getAll', () => {
     //@ts-ignore
     const mockFileStrategyInstance = FileStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy);
+    const collection = new Collection(gitDB, 'name', fileStrategy);
 
     await collection.getAll();
 
@@ -54,7 +58,12 @@ describe('getAll', () => {
     //@ts-ignore
     const mockMemoryStrategyInstance = MemoryStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy, memoryStrategy);
+    const collection = new Collection(
+      gitDB,
+      'name',
+      fileStrategy,
+      memoryStrategy,
+    );
 
     await collection.getAll();
 
@@ -71,7 +80,7 @@ describe('getData', () => {
     //@ts-ignore
     const mockFileStrategyInstance = FileStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy);
+    const collection = new Collection(gitDB, 'name', fileStrategy);
 
     await collection.getAll();
 
@@ -88,7 +97,12 @@ describe('getData', () => {
     //@ts-ignore
     const mockMemoryStrategyInstance = MemoryStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy, memoryStrategy);
+    const collection = new Collection(
+      gitDB,
+      'name',
+      fileStrategy,
+      memoryStrategy,
+    );
 
     await collection.getData(() => true);
 
@@ -105,29 +119,43 @@ describe('insert', () => {
     //@ts-ignore
     const mockFileStrategyInstance = FileStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy);
+    const mockOutputJson = jest.spyOn(fileDependency, 'outputJson');
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    mockOutputJson.mockImplementation(async () => {});
+
+    const collection = new Collection(gitDB, 'name', fileStrategy);
 
     await collection.getAll();
 
+    mockOutputJson.mockClear();
     expect(mockFileStrategyInstance.getAll).toBeCalledTimes(1);
   });
 
   test('Works with memoryStrategy', async () => {
     const gitDB = await createMockDB();
-    const fileStrategy = new FileStrategy('path');
+    // const fileStrategy = new FileStrategy('path');
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    const fileStrategy = { insert: () => ({}) };
     const memoryStrategy = new MemoryStrategy([]);
 
-    //@ts-ignore
-    const mockFileStrategyInstance = FileStrategy.mock.instances[0];
+    const mockOutputJson = jest.spyOn(fileDependency, 'outputJson');
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    mockOutputJson.mockImplementation(async () => {});
     //@ts-ignore
     const mockMemoryStrategyInstance = MemoryStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy, memoryStrategy);
+    const collection = new Collection(
+      gitDB,
+      'name',
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (fileStrategy as unknown) as FileStrategy<any>,
+      memoryStrategy,
+    );
 
-    await collection.insert(() => true);
+    await collection.insert(() => ({}));
 
+    mockOutputJson.mockClear();
     expect(mockMemoryStrategyInstance.insert).toBeCalledTimes(1);
-    expect(mockFileStrategyInstance.insert).toBeCalledTimes(1);
   });
 });
 
@@ -139,7 +167,7 @@ describe('update', () => {
     //@ts-ignore
     const mockFileStrategyInstance = FileStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy);
+    const collection = new Collection(gitDB, 'name', fileStrategy);
 
     await collection.getAll();
 
@@ -148,23 +176,28 @@ describe('update', () => {
 
   test('Works with memoryStrategy', async () => {
     const gitDB = await createMockDB();
-    const fileStrategy = new FileStrategy('path');
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    const fileStrategy = { update: () => [] };
     const memoryStrategy = new MemoryStrategy([]);
 
     //@ts-ignore
-    const mockFileStrategyInstance = FileStrategy.mock.instances[0];
     //@ts-ignore
     const mockMemoryStrategyInstance = MemoryStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy, memoryStrategy);
+    const collection = new Collection(
+      gitDB,
+      'name',
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (fileStrategy as unknown) as FileStrategy<any>,
+      memoryStrategy,
+    );
 
     await collection.update(
       () => true,
       (e) => e,
     );
 
     expect(mockMemoryStrategyInstance.update).toBeCalledTimes(1);
-    expect(mockFileStrategyInstance.update).toBeCalledTimes(1);
   });
 });
 
@@ -176,7 +209,7 @@ describe('delete', () => {
     //@ts-ignore
     const mockFileStrategyInstance = FileStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy);
+    const collection = new Collection(gitDB, 'name', fileStrategy);
 
     await collection.getAll();
 
@@ -185,19 +218,23 @@ describe('delete', () => {
 
   test('Works with memoryStrategy', async () => {
     const gitDB = await createMockDB();
-    const fileStrategy = new FileStrategy('path');
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    const fileStrategy = { delete: () => [] };
     const memoryStrategy = new MemoryStrategy([]);
 
-    //@ts-ignore
-    const mockFileStrategyInstance = FileStrategy.mock.instances[0];
     //@ts-ignore
     const mockMemoryStrategyInstance = MemoryStrategy.mock.instances[0];
 
-    const collection = new Collection(gitDB, fileStrategy, memoryStrategy);
+    const collection = new Collection(
+      gitDB,
+      'name',
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (fileStrategy as unknown) as FileStrategy<any>,
+      memoryStrategy,
+    );
 
     await collection.delete(() => true);
 
     expect(mockMemoryStrategyInstance.delete).toBeCalledTimes(1);
-    expect(mockFileStrategyInstance.delete).toBeCalledTimes(1);
   });
 });

src/Collection/Collection.ts

@@ -1,8 +1,13 @@
 import GitDB from '../GitDB/GitDB';
 import { v4 as uuidv4 } from 'uuid';
-import FileStrategy from '../FileStrategy/FileStrategy';
-import MemoryStrategy from '../MemoryStrategy/MemoryStrategy';
-import { Filter, SetCallback } from '../CollectionStrategy/collectionStrategy';
+import {
+  FileStrategy,
+  MemoryStrategy,
+  Filter,
+  SetCallback,
+  CollectionStrategy,
+} from '../CollectionStrategies';
+import path from 'path';
 export interface DBRecord {
   id: string;
 }
@@ -16,15 +21,18 @@ enum gitStagingAreaStatus {
  */
 export class Collection<T extends DBRecord> {
   private db: GitDB;
-  fileStrategy: FileStrategy<T>;
-  memoryStrategy?: MemoryStrategy<T>;
+  private name: string;
+  fileStrategy: CollectionStrategy<T>;
+  memoryStrategy?: CollectionStrategy<T>;
 
   constructor(
     gitDb: GitDB,
+    name: string,
     fileStrategy: FileStrategy<T>,
     memoryStrategy?: MemoryStrategy<T>,
   ) {
     this.db = gitDb;
+    this.name = name;
     this.fileStrategy = fileStrategy;
     this.memoryStrategy = memoryStrategy;
   }
@@ -46,8 +54,12 @@ export class Collection<T extends DBRecord> {
 
   public async insert(documentData: Omit<T, 'id'>): Promise<T> {
     const newDocument: T = { id: uuidv4(), ...documentData } as T;
-    const filePath = await this.fileStrategy.insert(newDocument);
-
+    const document = await this.fileStrategy.insert(newDocument);
+    const filePath = path.resolve(
+      this.db.config.dbDir,
+      this.name,
+      `${document.id}.json`,
+    );
     if (this.memoryStrategy) {
       this.memoryStrategy.insert(newDocument);
     }
@@ -57,27 +69,33 @@ export class Collection<T extends DBRecord> {
   }
 
   public async update<K extends T>(
-    filter: Filter<K>,
-    modifier: SetCallback<T>,
-  ): Promise<string[]> {
-    const filePaths = await this.fileStrategy.update(filter, modifier);
+    filter: Filter<T>,
+    modifier: SetCallback<K, T>,
+  ): Promise<K[]> {
+    const documents = await this.fileStrategy.update(filter, modifier);
 
     if (this.memoryStrategy) {
       this.memoryStrategy.update(filter, modifier);
     }
+    const filePaths = documents.map((document) =>
+      path.resolve(this.db.config.dbDir, this.name, `${document.id}.json`),
+    );
     await this.checkForAutoCommit(filePaths, gitStagingAreaStatus.add);
-    return filePaths;
+    return documents;
   }
 
-  public async delete(filter: Filter<T>): Promise<string[]> {
-    const filePaths = await this.fileStrategy.delete(filter);
+  public async delete(filter: Filter<T>): Promise<T[]> {
+    const documents = await this.fileStrategy.delete(filter);
 
     if (this.memoryStrategy) {
       this.memoryStrategy.delete(filter);
     }
+    const filePaths = documents.map((document) =>
+      path.resolve(this.db.config.dbDir, this.name, `${document.id}.json`),
+    );
     await this.checkForAutoCommit(filePaths, gitStagingAreaStatus.remove);
 
-    return filePaths;
+    return documents;
   }
 
   private async checkForAutoCommit(