@dotinc/ogre 0.4.0 → 0.5.0

package/README.md

@@ -1,7 +1,7 @@
 # ogre
 
 An in-memory git-like repository for objects for when you need to
-keep the history around for a bit longer.
+keep the history around for a bit longer. The library uses json-patch RFC6902 for representing diffs.
 
 ## Features
 
@@ -9,9 +9,11 @@ keep the history around for a bit longer.
 - Branch
 - Tags
 - Checkout
+- Reset (soft and hard)
+- Diff
 - Visualization via `@dotinc/ogre-react`
 - Merge
-  - fast-forward
+    - fast-forward
 
 ## Usage
 
@@ -49,5 +51,5 @@ repo.checkout(init);
 ## TODO
 
 - [ ] Merge
-  - [ ] recursive
-  - [ ] octopus
+    - [ ] recursive
+    - [ ] octopus

package/lib/repository.d.ts

@@ -32,6 +32,12 @@ export interface RepositoryObject<T extends {
      */
     branch(): string;
     tag(tag: string): string;
+    /**
+     * Moves the HEAD and the branch to a specific shaish (commit or tag)
+     * @param mode hard - discard changes
+     * @param shaish
+     */
+    reset(mode?: "soft" | "hard", shaish?: string): void;
 }
 /**
  * A repository recording and managing the state transitions of an object
@@ -46,6 +52,7 @@ export declare class Repository<T extends {
     private readonly refs;
     private readonly commits;
     private moveTo;
+    reset(mode?: "soft" | "hard" | undefined, shaish?: string | undefined): void;
     branch(): string;
     diff(shaishFrom: string, shaishTo?: string): Operation[];
     checkout(shaish: string, createBranch?: boolean): void;

package/lib/repository.js

@@ -30,6 +30,13 @@ class Repository {
                 ],
             ]);
         this.commits = (_d = (_c = options.history) === null || _c === void 0 ? void 0 : _c.commits) !== null && _d !== void 0 ? _d : [];
+        if (options.history) {
+            const commit = this.commitAtHead();
+            if (!commit) {
+                return;
+            }
+            this.moveTo(commit);
+        }
     }
     moveTo(commit) {
         const targetTree = treeToObject(commit.tree);
@@ -41,6 +48,22 @@ class Repository {
         patchToTarget.reduce(fast_json_patch_1.applyReducer, this.data);
         this.observer = (0, fast_json_patch_1.observe)(this.data);
     }
+    reset(mode = "hard", shaish = exports.REFS_HEAD_KEY) {
+        if (mode === "hard") {
+            (0, fast_json_patch_1.unobserve)(this.data, this.observer);
+        }
+        const [commit] = shaishToCommit(shaish, this.refs, this.commits);
+        this.moveTo(commit);
+        const refs = refsAtCommit(this.refs, commit);
+        // reset only moves heads and not tags
+        const moveableRefs = refs.filter((r) => r.name.startsWith(headsRefPathPrefix));
+        for (const ref of moveableRefs) {
+            this.moveRef(ref.name, commit);
+        }
+        if (mode === "hard") {
+            this.observer = (0, fast_json_patch_1.observe)(this.data);
+        }
+    }
     branch() {
         const currentHeadRef = this.refs.get(exports.REFS_HEAD_KEY);
         if (!currentHeadRef) {
@@ -353,6 +376,15 @@ const commitAtRefIn = (ref, references, commitsList) => {
     }
     return undefined;
 };
+const refsAtCommit = (references, commit) => {
+    const list = [];
+    for (const [name, ref] of references.entries()) {
+        if (ref.value === commit.hash) {
+            list.push(ref);
+        }
+    }
+    return list;
+};
 /**
  * Accepts a shaish expression (e.g. refs (branches, tags), commitSha) and returns
  * - a commit of type Commit

package/lib/test.utils.d.ts

@@ -1,15 +1,15 @@
 import { RepositoryObject } from "./repository";
 import { Commit } from "./commit";
-export declare class NestedObject {
-    name: string | undefined;
-    uuid: string | undefined;
-}
-export declare class ComplexObject {
-    uuid: string | undefined;
-    name: string | undefined;
-    description: string | undefined;
+export declare type NestedObject = {
+    name?: string;
+    uuid?: string;
+};
+export declare type ComplexObject = {
+    uuid?: string;
+    name?: string;
+    description?: string;
     nested: NestedObject[];
-}
+};
 export declare const testAuthor = "User name <name@domain.com>";
 export declare function getBaseline(): Promise<[
     RepositoryObject<ComplexObject>,

package/lib/test.utils.js

@@ -1,20 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sumChanges = exports.addOneStep = exports.updateHeaderData = exports.getBaseline = exports.testAuthor = exports.ComplexObject = exports.NestedObject = void 0;
+exports.sumChanges = exports.addOneStep = exports.updateHeaderData = exports.getBaseline = exports.testAuthor = void 0;
 const uuid_1 = require("uuid");
 const repository_1 = require("./repository");
-class NestedObject {
-}
-exports.NestedObject = NestedObject;
-class ComplexObject {
-    constructor() {
-        this.nested = [];
-    }
-}
-exports.ComplexObject = ComplexObject;
 exports.testAuthor = "User name <name@domain.com>";
 async function getBaseline() {
-    const co = new ComplexObject();
+    const co = {
+        uuid: undefined,
+        name: undefined,
+        description: undefined,
+        nested: [],
+    };
     const repo = new repository_1.Repository(co, {});
     return [repo, co];
 }
@@ -27,7 +23,7 @@ function updateHeaderData(wrapped) {
 }
 exports.updateHeaderData = updateHeaderData;
 function addOneStep(wrapped) {
-    const pe = new NestedObject();
+    const pe = {};
     pe.uuid = (0, uuid_1.v4)();
     pe.name = "first name";
     wrapped.nested.push(pe);

package/package.json

@@ -4,44 +4,32 @@
     "type": "git",
     "url": "https://github.com/dotindustries/ogre.git"
   },
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Git-like repository for in-memory object versioning",
   "private": false,
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "test": "nyc --reporter=lcov ava",
-    "test.watch": "ava --watch",
+    "test": "nyc --reporter=lcov tap --coverage-report=none --allow-incomplete-coverage",
+    "test:node": "node --import tsx --test src/**/*.test.ts",
     "coverage:html": "nyc report --reporter=html"
   },
-  "ava": {
-    "timeout": "60s",
-    "files": [
-      "./src/**/*.test.ts"
-    ],
-    "extensions": [
-      "ts"
-    ],
-    "require": [
-      "ts-node/register"
-    ]
-  },
   "author": "János Veres @nadilas",
   "license": "MIT",
   "dependencies": {
     "fast-json-patch": "^3.1.1",
     "fflate": "^0.8.2",
     "immutable-json-patch": "^6.0.1",
-    "tslib": "^2.3.1"
+    "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@ava/typescript": "^3.0.1",
-    "@types/node": "^17.0.38",
+    "@types/node": "^17.0.45",
     "@types/uuid": "^8.3.4",
-    "ava": "^4.3.0",
     "nyc": "^15.1.0",
+    "tap": "^18.7.0",
     "ts-node": "^10.8.1",
+    "tsx": "^4.7.1",
     "typescript": "^4.7.4",
     "uuid": "^8.3.2"
   },
@@ -49,5 +37,5 @@
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
-  "gitHead": "f95719f3f9a333c332fed909e82de60715076a4f"
+  "gitHead": "c6bad3ae8bf832cd9f9f9186cd3c37cf96420a46"
 }

package/src/branch.test.ts

@@ -1,10 +1,10 @@
-import test from "ava";
+import { test } from "tap";
 import { getBaseline, sumChanges, testAuthor } from "./test.utils";
 
 test("current branch on empty repo is HEAD", async (t) => {
   const [repo] = await getBaseline();
 
-  t.is(repo.branch(), "HEAD", "invalid current branch");
+  t.equal(repo.branch(), "HEAD", "invalid current branch");
 });
 
 test("first commit goes onto default 'main' branch", async (t) => {
@@ -12,18 +12,18 @@ test("first commit goes onto default 'main' branch", async (t) => {
   repo.data.name = "new name";
   await repo.commit("initial commit", testAuthor);
 
-  t.is(repo.branch(), "main", "invalid current branch");
-  t.is(repo.head(), "refs/heads/main", "invalid HEAD");
+  t.equal(repo.branch(), "main", "invalid current branch");
+  t.equal(repo.head(), "refs/heads/main", "invalid HEAD");
 });
 
 test("fails to create a branch with empty repo", async (t) => {
   const [repo] = await getBaseline();
   let history = repo.getHistory();
-  t.is(history.commits.length, 0, "incorrect # of commits");
-  t.is(
+  t.equal(history.commits.length, 0, "incorrect # of commits");
+  t.equal(
     sumChanges(history?.commits),
     0,
-    "new branch w/ incorrect # of changelog entries"
+    "new branch w/ incorrect # of changelog entries",
   );
 
   t.throws(
@@ -31,7 +31,7 @@ test("fails to create a branch with empty repo", async (t) => {
       // cannot point new branch to nothing on empty repo
       repo.createBranch("new_feature");
     },
-    { message: "fatal: not a valid object name: 'main'" }
+    { message: "fatal: not a valid object name: 'main'" },
   );
 });
 
@@ -39,20 +39,20 @@ test("checkout new branch with empty repo", async (t) => {
   const [repo] = await getBaseline();
 
   repo.checkout("new_feature", true);
-  t.is(
+  t.equal(
     repo.head(),
     "refs/heads/new_feature",
-    "HEAD did not move to new branch"
+    "HEAD did not move to new branch",
   );
-  t.is(
+  t.equal(
     repo.ref("/refs/heads/main"),
     undefined,
-    "main should not be pointing to anything"
+    "main should not be pointing to anything",
   );
-  t.is(
+  t.equal(
     repo.ref("refs/heads/new_feature"),
     undefined,
-    "new_feature should not be pointing to anything"
+    "new_feature should not be pointing to anything",
   );
 });
 
@@ -61,8 +61,8 @@ test("creating a valid branch on a baseline", async (t) => {
   repo.data.name = "new name";
   const commit = await repo.commit("simple change", testAuthor);
   const ref = repo.createBranch("new_feature");
-  t.is(ref, "refs/heads/new_feature", "invalid branch ref created");
-  t.is(repo.ref(ref), commit, "new branch is pointing to wrong commit");
+  t.equal(ref, "refs/heads/new_feature", "invalid branch ref created");
+  t.equal(repo.ref(ref), commit, "new branch is pointing to wrong commit");
 });
 
 test("cannot create new branch with invalid name", async (t) => {
@@ -73,7 +73,7 @@ test("cannot create new branch with invalid name", async (t) => {
       () => {
         repo.createBranch(name);
       },
-      { message: "invalid ref name" }
+      { message: "invalid ref name" },
     );
   }
 });

package/src/checkout.test.ts

@@ -1,4 +1,4 @@
-import test from "ava";
+import { test } from "tap";
 import {
   addOneStep,
   ComplexObject,
@@ -21,14 +21,14 @@ test("checkout prev commit", async (t) => {
   repo.checkout(headerDataHash);
   const head = repo.head();
   const history = repo.getHistory();
-  t.is(sumChanges(history.commits), 3, `incorrect # of changelog entries`);
-  t.is(history.commits.length, 1, "incorrect # of commits");
-  t.is(head, headerDataHash, `points to wrong commit`);
-  t.is(repo.branch(), "HEAD", "repo is not in detached state");
-  t.deepEqual(
+  t.equal(sumChanges(history.commits), 3, `incorrect # of changelog entries`);
+  t.equal(history.commits.length, 1, "incorrect # of commits");
+  t.equal(head, headerDataHash, `points to wrong commit`);
+  t.equal(repo.branch(), "HEAD", "repo is not in detached state");
+  t.equal(
     obj.nested.length,
     0,
-    `has a nested object when it shouldn't: ${JSON.stringify(obj)}`
+    `has a nested object when it shouldn't: ${JSON.stringify(obj)}`,
   );
 });
 
@@ -39,7 +39,7 @@ test("checkout new branch with simple name", async (t) => {
 
   const ref = repo.createBranch("new_feature");
   repo.checkout("new_feature");
-  t.is(repo.head(), ref, "HEAD is not moved to target branch");
+  t.equal(repo.head(), ref, "HEAD is not moved to target branch");
 });
 
 test("checkout new branch with full ref name", async (t) => {
@@ -49,7 +49,7 @@ test("checkout new branch with full ref name", async (t) => {
 
   const ref = repo.createBranch("new_feature");
   repo.checkout(ref);
-  t.is(repo.head(), ref, "HEAD is not moved to target branch");
+  t.equal(repo.head(), ref, "HEAD is not moved to target branch");
 });
 
 test("checkout commit which has two refs pointing leaves HEAD detached", async (t) => {
@@ -59,14 +59,14 @@ test("checkout commit which has two refs pointing leaves HEAD detached", async (
 
   repo.createBranch("new_feature");
   repo.checkout(commit);
-  t.is(repo.ref("refs/heads/main"), commit, "main does not point to commit");
-  t.is(
+  t.equal(repo.ref("refs/heads/main"), commit, "main does not point to commit");
+  t.equal(
     repo.ref("refs/heads/new_feature"),
     commit,
-    "new_feature does not point to commit"
+    "new_feature does not point to commit",
   );
-  t.is(repo.branch(), "HEAD", "HEAD is not detached at commit");
-  t.is(repo.head(), commit, "HEAD is not pointing to commit");
+  t.equal(repo.branch(), "HEAD", "HEAD is not detached at commit");
+  t.equal(repo.head(), commit, "HEAD is not pointing to commit");
 });
 
 test("checkout new branch moves head to new branch", async (t) => {
@@ -76,19 +76,19 @@ test("checkout new branch moves head to new branch", async (t) => {
 
   const ref = repo.createBranch("new_feature");
   repo.checkout("new_feature");
-  t.is(repo.head(), ref, "HEAD is not moved to target branch");
+  t.equal(repo.head(), ref, "HEAD is not moved to target branch");
 });
 
 test("checkout and create new branch on empty main", async (t) => {
   const [repo] = await getBaseline();
 
   repo.checkout("new_feature", true);
-  t.is(
+  t.equal(
     repo.head(),
     "refs/heads/new_feature",
-    "HEAD should point to empty branch"
+    "HEAD should point to empty branch",
   );
-  t.is(repo.branch(), "HEAD", "branch still should be empty");
+  t.equal(repo.branch(), "HEAD", "branch still should be empty");
 });
 
 test("checkout and create new branch with at least 1 commit", async (t) => {
@@ -97,29 +97,32 @@ test("checkout and create new branch with at least 1 commit", async (t) => {
   const commit = await repo.commit("simple change", testAuthor);
 
   repo.checkout("new_feature", true);
-  t.is(
+  t.equal(
     repo.head(),
     "refs/heads/new_feature",
-    "HEAD should point to new branch"
+    "HEAD should point to new branch",
   );
-  t.is(
+  t.equal(
     repo.ref("refs/heads/new_feature"),
     commit,
-    "branch is not pointing to last HEAD commit"
+    "branch is not pointing to last HEAD commit",
   );
 });
 
 test("replacing default branch on empty master removes main", async (t) => {
-  const repo = new Repository(new ComplexObject(), {});
+  const cx: ComplexObject = {
+    nested: [],
+  };
+  const repo = new Repository(cx, {});
 
   // replacing default main branch by moving HEAD to new branch
   // is OK even on empty repo
   repo.checkout("new_feature", true);
   const history = repo.getHistory();
-  t.is(
+  t.equal(
     sumChanges(history?.commits),
     0,
-    "new branch w/ incorrect # of changelog entries"
+    "new branch w/ incorrect # of changelog entries",
   );
 
   repo.data.name = "name changed";
@@ -130,6 +133,6 @@ test("replacing default branch on empty master removes main", async (t) => {
     () => {
       repo.checkout("main");
     },
-    { message: `pathspec 'main' did not match any known refs` }
+    { message: `pathspec 'main' did not match any known refs` },
   );
 });