@dotinc/ogre 0.1.0 → 0.2.0-canary.4f08867.0

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+# v0.1.2 (Fri Mar 11 2022)
+
+#### 🐛 Bug Fix
+
+- fix: main package file ([@nadilas](https://github.com/nadilas))
+- fix: move tslib to dependencies ([@nadilas](https://github.com/nadilas))
+
+#### ⚠️ Pushed to `main`
+
+- chore: clean published packaage ([@nadilas](https://github.com/nadilas))
+
+#### Authors: 1
+
+- [@nadilas](https://github.com/nadilas)
+
+---
+
+# v0.1.1 (Fri Mar 11 2022)
+
+#### ⚠️ Pushed to `main`
+
+- Merge remote-tracking branch 'origin/main' ([@nadilas](https://github.com/nadilas))
+- doc: add LICENSE and README.md ([@nadilas](https://github.com/nadilas))
+
+#### Authors: 1
+
+- [@nadilas](https://github.com/nadilas)
+
+---
+
 # v0.1.0 (Fri Mar 11 2022)
 
 #### 🚀 Enhancement

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 dot Industries, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+# ogre
+
+An in-memory git-like repository for objects for when you need to
+keep the history around for a bit longer.
+
+## Features
+
+- Commit
+- Branch
+- Checkout
+- Merge
+    - fast-forward
+
+## Usage
+
+```typescript
+const repo = new Repository(new ComplexObject())
+
+// apply changes
+repo.data.name = 'my name'
+repo.data.description = 'now we have a description'
+
+// commit changes 
+const init = await repo.commit('initial commit', 'author <author@test.com>')
+// create a branch named savepoint pointing to the last commit
+repo.createBranch('savepoint')
+
+// switch to new branch
+repo.checkout('add_details', true)
+
+// apply changes
+repo.data.name = 'a fancier name'
+
+// a) commit & merge
+  await repo.commit('change name', 'author <author@test.com>')
+  repo.checkout('main')
+  repo.merge('add_details')
+
+// or b) discard change and go back
+  // by using the branch name 
+  repo.checkout('main')
+  // by using the commit hash in a detached state
+  repo.checkout(init)
+```
+
+## TODO
+
+- [ ] Visualization
+- [ ] Merge
+    - [ ] recursive
+    - [ ] octopus

package/lib/commit.d.ts

@@ -1,6 +1,7 @@
 import { Change } from './interfaces';
 export interface Commit {
     hash: string;
+    tree: string;
     message: string | undefined;
     author: string;
     parent: string | undefined;
@@ -8,11 +9,11 @@ export interface Commit {
     timestamp: Date;
     to: number;
 }
-export interface HashContent {
+export interface CommitHashContent {
     message: string;
     author: string;
     parentRef: string | undefined;
     changes: Change[];
     timestamp: Date;
 }
-export declare function calculateHash(content: HashContent): Promise<string>;
+export declare function calculateCommitHash(content: CommitHashContent): Promise<string>;

package/lib/commit.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateHash = void 0;
+exports.calculateCommitHash = void 0;
 const hash_1 = require("./hash");
-function calculateHash(content) {
+function calculateCommitHash(content) {
     return (0, hash_1.digest)(content);
 }
-exports.calculateHash = calculateHash;
+exports.calculateCommitHash = calculateCommitHash;

package/lib/index.d.ts

@@ -3,3 +3,4 @@ export * from './repository';
 export { Commit } from './commit';
 export * from './ref';
 export * from './size';
+export * from './utils';

package/lib/index.js

@@ -5,3 +5,4 @@ tslib_1.__exportStar(require("./interfaces"), exports);
 tslib_1.__exportStar(require("./repository"), exports);
 tslib_1.__exportStar(require("./ref"), exports);
 tslib_1.__exportStar(require("./size"), exports);
+tslib_1.__exportStar(require("./utils"), exports);

package/lib/repository.d.ts

@@ -1,5 +1,7 @@
 import { History } from './interfaces';
 import { Commit } from './commit';
+export declare const REFS_HEAD_KEY = "HEAD";
+export declare const REFS_MAIN_KEY: string;
 export interface RepositoryOptions<T> {
     history?: History;
 }
@@ -22,6 +24,11 @@ export interface RespositoryObjectType {
  * A repository recording and managing the state transitions of an object
  */
 export declare const Repository: RespositoryObjectType;
+export declare const createHeadRefValue: (refKey: string) => string;
+export declare const isTagRef: (refKey: string) => boolean;
+export declare const cleanRefValue: (ref: string) => string;
+export declare const brancheNameToRef: (name: string) => string;
+export declare const validateBranchName: (name: string) => void;
 /**
  * Prints the underlying changelog of a repository
  * @param repository

package/lib/repository.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.printChangeLog = exports.Repository = void 0;
+exports.printChangeLog = exports.validateBranchName = exports.brancheNameToRef = exports.cleanRefValue = exports.isTagRef = exports.createHeadRefValue = exports.Repository = exports.REFS_MAIN_KEY = exports.REFS_HEAD_KEY = void 0;
 const commit_1 = require("./commit");
 const ref_1 = require("./ref");
-const REFS_HEAD = 'HEAD';
-const REFS_MAIN = 'refs/heads/main';
-const refPrefix = 'ref: ';
+const hash_1 = require("./hash");
+const tagRefPathPrefix = 'refs/tags/';
+const headsRefPathPrefix = 'refs/heads/';
+const headValueRefPrefix = 'ref: ';
+exports.REFS_HEAD_KEY = 'HEAD';
+exports.REFS_MAIN_KEY = `${headsRefPathPrefix}main`;
 /**
  * A repository recording and managing the state transitions of an object
  */
@@ -13,9 +16,9 @@ exports.Repository = function (obj, options) {
     var _a, _b, _c, _d;
     let savedLength;
     let version = 0;
-    const refs = (_b = (_a = options.history) === null || _a === void 0 ? void 0 : _a.refs) !== null && _b !== void 0 ? _b : new Map([[REFS_HEAD, {
-                name: REFS_HEAD,
-                value: `ref: ${REFS_MAIN}`
+    const refs = (_b = (_a = options.history) === null || _a === void 0 ? void 0 : _a.refs) !== null && _b !== void 0 ? _b : new Map([[exports.REFS_HEAD_KEY, {
+                name: exports.REFS_HEAD_KEY,
+                value: `ref: ${exports.REFS_MAIN_KEY}`
             }]]);
     const changeLog = [];
     const targets = [];
@@ -105,28 +108,28 @@ exports.Repository = function (obj, options) {
     this.data = new Proxy(obj, handler);
     // region Read state read
     this.head = () => {
-        const ref = refs.get(REFS_HEAD);
+        const ref = refs.get(exports.REFS_HEAD_KEY);
         if (!ref) {
             throw new Error(`unreachable: HEAD is not present`);
         }
-        return cleanRefValue(ref.value);
+        return (0, exports.cleanRefValue)(ref.value);
     };
     this.ref = (reference) => {
         var _a;
         const ref = (_a = refs.get(reference)) === null || _a === void 0 ? void 0 : _a.value;
-        return ref ? cleanRefValue(ref) : undefined;
+        return ref ? (0, exports.cleanRefValue)(ref) : undefined;
     };
     this.branch = () => {
-        const currentHeadRef = refs.get(REFS_HEAD);
+        const currentHeadRef = refs.get(exports.REFS_HEAD_KEY);
         if (!currentHeadRef) {
             throw new Error('unreachable: ref HEAD not available');
         }
-        if (currentHeadRef.value.includes(refPrefix)) {
-            const refName = cleanRefValue(currentHeadRef.value);
+        if (currentHeadRef.value.includes(headValueRefPrefix)) {
+            const refName = (0, exports.cleanRefValue)(currentHeadRef.value);
             if (refs.has(refName))
                 return getLastItem(refName);
         }
-        return REFS_HEAD; // detached state
+        return exports.REFS_HEAD_KEY; // detached state
     };
     // endregion
     // region History functions
@@ -176,7 +179,7 @@ exports.Repository = function (obj, options) {
     };
     // region Commit lookups
     const commitAtHead = () => {
-        return commitAtHeadIn(REFS_HEAD, refs, commits);
+        return commitAtRefIn(exports.REFS_HEAD_KEY, refs, commits);
     };
     const mustCommitAtHead = () => {
         const commitHead = commitAtHead();
@@ -202,13 +205,14 @@ exports.Repository = function (obj, options) {
         }
         const timestamp = new Date();
         const changes = [...changesSinceLastCommit];
-        const sha = await (0, commit_1.calculateHash)({
+        const sha = await (0, commit_1.calculateCommitHash)({
             message,
             author,
             changes,
             parentRef: parent === null || parent === void 0 ? void 0 : parent.hash,
             timestamp
         });
+        const treeHash = await (0, hash_1.digest)(obj);
         const commit = {
             hash: sha,
             message,
@@ -216,7 +220,8 @@ exports.Repository = function (obj, options) {
             changes: changes,
             parent: parent === null || parent === void 0 ? void 0 : parent.hash,
             timestamp,
-            to: version
+            to: version,
+            tree: treeHash
         };
         if (amend) {
             const idx = commits.findIndex(c => c === parent);
@@ -230,30 +235,30 @@ exports.Repository = function (obj, options) {
         }
         else {
             // move detached HEAD to new commit
-            moveRef(REFS_HEAD, commit);
+            moveRef(exports.REFS_HEAD_KEY, commit);
         }
         return sha;
     };
     // region Graph manipulation
     this.checkout = (shaish, createBranch = false) => {
         if (createBranch) {
-            validateBranchName(shaish);
-            let branchRef = brancheNameToRef(shaish);
+            (0, exports.validateBranchName)(shaish);
+            let branchRef = (0, exports.brancheNameToRef)(shaish);
             const commit = commitAtHead();
             if (commit) {
                 moveRef(branchRef, commit);
             }
-            moveRef(REFS_HEAD, branchRef);
+            moveRef(exports.REFS_HEAD_KEY, branchRef);
         }
         else {
             const [commit, isRef, refKey] = shaishToCommit(shaish, refs, commits);
             rebuildChangeLog(commit);
-            moveRef(REFS_HEAD, isRef && refKey !== undefined ? refKey : commit);
+            moveRef(exports.REFS_HEAD_KEY, isRef && refKey !== undefined ? refKey : commit);
         }
     };
     this.createBranch = (name) => {
-        validateBranchName(name);
-        const refName = brancheNameToRef(name);
+        (0, exports.validateBranchName)(name);
+        const refName = (0, exports.brancheNameToRef)(name);
         const headCommit = commitAtHead();
         if (!headCommit) {
             const headRef = this.head();
@@ -267,7 +272,7 @@ exports.Repository = function (obj, options) {
     };
     const moveRef = (refName, value) => {
         let ref = refs.get(refName);
-        const val = typeof value === 'string' ? `${refPrefix}${value}` : value.hash;
+        const val = typeof value === 'string' ? (0, exports.createHeadRefValue)(value) : value.hash;
         if (!ref) {
             ref = { name: getLastItem(refName), value: val };
         }
@@ -283,7 +288,7 @@ exports.Repository = function (obj, options) {
         //   for fancier merge tree
         //   https://github.com/isomorphic-git/isomorphic-git/blob/a623133345a5d8b6bb7a8352ea9702ce425d8266/src/utils/mergeTree.js#L33
         if (typeof source !== 'string') {
-            // const srcHead = commitAtHeadIn(REFS_HEAD, src.refs, src.commits)
+            // const srcHead = commitAtRefIn(REFS_HEAD, src.refs, src.commits)
             throw new Error(`fatal: source type (${source instanceof exports.Repository ? 'Repository' : 'History'}) not implemented`);
         }
         const [srcCommit] = shaishToCommit(source, refs, commits);
@@ -331,15 +336,6 @@ exports.Repository = function (obj, options) {
     }
 };
 const getLastItem = (thePath) => thePath.substring(thePath.lastIndexOf('/') + 1);
-const cleanRefValue = (ref) => ref.replace(refPrefix, '');
-const brancheNameToRef = (name) => {
-    return `refs/heads/${name}`;
-};
-const validateBranchName = (name) => {
-    if (!(0, ref_1.validBranch)(name)) {
-        throw new Error(`invalid ref name`);
-    }
-};
 /**
  * Traverses the commit tree backwards and reassembles the changelog
  * @param commit
@@ -370,14 +366,14 @@ const mapPath = (from, to, commits) => {
  * @param references
  * @param commitsList
  */
-const commitAtHeadIn = (ref, references, commitsList) => {
+const commitAtRefIn = (ref, references, commitsList) => {
     const reference = references.get(ref);
     if (!reference) {
         throw new Error(`unreachable: '${ref}' is not present`);
     }
     let commitHash;
-    if (reference.value.includes(refPrefix)) {
-        const refKey = cleanRefValue(reference.value);
+    if (reference.value.includes(headValueRefPrefix)) {
+        const refKey = (0, exports.cleanRefValue)(reference.value);
         const targetRef = references.get(refKey);
         if (!targetRef) {
             // target branch may not have been saved yet
@@ -412,9 +408,9 @@ const shaishToCommit = (shaish, references, commitsList) => {
             isRef = true;
             refKey = name;
             sha = ref.value;
-            if (sha.includes(refPrefix)) {
-                const cleanedRef = cleanRefValue(sha);
-                const c = commitAtHeadIn(cleanedRef, references, commitsList);
+            if (sha.includes(headValueRefPrefix)) {
+                const cleanedRef = (0, exports.cleanRefValue)(sha);
+                const c = commitAtRefIn(cleanedRef, references, commitsList);
                 if (!c) {
                     throw new Error(`${cleanedRef} points to non-existing commit`);
                 }
@@ -434,6 +430,24 @@ const shaishToCommit = (shaish, references, commitsList) => {
     }
     return [found[0], isRef, refKey];
 };
+const createHeadRefValue = (refKey) => {
+    return `${headValueRefPrefix}${refKey}`;
+};
+exports.createHeadRefValue = createHeadRefValue;
+const isTagRef = (refKey) => refKey.indexOf(tagRefPathPrefix) > -1;
+exports.isTagRef = isTagRef;
+const cleanRefValue = (ref) => ref.replace(headValueRefPrefix, '');
+exports.cleanRefValue = cleanRefValue;
+const brancheNameToRef = (name) => {
+    return `${headsRefPathPrefix}${name}`;
+};
+exports.brancheNameToRef = brancheNameToRef;
+const validateBranchName = (name) => {
+    if (!(0, ref_1.validBranch)(name)) {
+        throw new Error(`invalid ref name`);
+    }
+};
+exports.validateBranchName = validateBranchName;
 /**
  * Prints the underlying changelog of a repository
  * @param repository
@@ -442,7 +456,7 @@ const printChangeLog = (repository) => {
     console.log('----------------------------------------------------------');
     console.log(`Changelog at ${repository.head()}`);
     const history = repository.getHistory();
-    const head = commitAtHeadIn(repository.head(), history.refs, history.commits);
+    const head = commitAtRefIn(repository.head(), history.refs, history.commits);
     if (!head) {
         throw new Error(`fatal: HEAD is not defined`);
     }

package/lib/utils.d.ts

@@ -0,0 +1 @@
+export declare const cleanAuthor: (author: string) => [name: string, email: string];

package/lib/utils.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanAuthor = void 0;
+// [RFC5322](https://www.ietf.org/rfc/rfc5322.txt)
+const emailRegex = /(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])/;
+const cleanAuthor = (author) => {
+    if (author === '') {
+        throw new Error(`author not provided`);
+    }
+    // author name <email>
+    let strings = author.split(' <');
+    if (strings.length > 1) {
+        return [strings[0], strings[1].replace('>', '')];
+    }
+    // author name @handle
+    strings = author.split(' @');
+    if (strings.length > 1) {
+        return [strings[0], `@${strings[1]}`];
+    }
+    // email@domain.com
+    if (emailRegex.test(author)) {
+        return ['', author];
+    }
+    // unrecognized format
+    return [author, ''];
+};
+exports.cleanAuthor = cleanAuthor;

package/package.json

@@ -4,9 +4,9 @@
     "type": "git",
     "url": "https://github.com/dotindustries/ogre.git"
   },
-  "version": "0.1.0",
+  "version": "0.2.0-canary.4f08867.0",
   "description": "Git-like repository for in-memory object versioning",
-  "main": "lib/index.ts",
+  "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
@@ -28,16 +28,16 @@
   },
   "author": "János Veres @nadilas",
   "license": "MIT",
+  "dependencies": {
+    "tslib": "^2.3.1"
+  },
   "devDependencies": {
     "@ava/typescript": "^3.0.1",
     "@types/node": "^17.0.21",
     "@types/uuid": "^8.3.4",
     "ava": "^4.0.1",
-    "coveralls": "^3.1.1",
     "nyc": "^15.1.0",
     "ts-node": "^10.7.0",
-    "tslib": "^2.3.1",
-    "turbo": "^1.1.5",
     "typescript": "^4.5.5",
     "uuid": "^8.3.2"
   },
@@ -45,5 +45,5 @@
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
-  "gitHead": "d1ea04300335cd7618f4cf66251123f489d17b1c"
+  "gitHead": "4f08867076b586c0be8dbfe673194ca89c8283d9"
 }

package/src/commit.test.ts

@@ -32,6 +32,16 @@ test('no commit without changes after recent commit', async t => {
     return await repo.commit('baseline', testAuthor)
   }, { message: 'no changes to commit' })
 })
+
+test('treeHash of commit is matching content', async t => {
+  const [repo] = await getBaseline()
+  repo.data.name = 'new name'
+  await repo.commit('baseline', testAuthor)
+  const {commits} = repo.getHistory()
+  t.is(commits.length, 1)
+  t.not(commits[0].tree, '', 'tree hash mismatch')
+})
+
 test('no commit --amend without commit', async t => {
   const [repo] = await getBaseline()
   repo.data.name = 'new name'

package/src/commit.ts

@@ -10,6 +10,7 @@ export interface Commit {
   // - author commit timestamp with timezone
   // - commit message
   hash: string
+  tree: string
 
   message: string | undefined
   author: string
@@ -32,7 +33,7 @@ export interface Commit {
   to: number;
 }
 
-export interface HashContent {
+export interface CommitHashContent {
   message: string
   author: string
   parentRef: string | undefined
@@ -40,6 +41,6 @@ export interface HashContent {
   timestamp: Date
 }
 
-export function calculateHash(content: HashContent) {
+export function calculateCommitHash(content: CommitHashContent) {
   return digest(content)
 }

package/src/index.ts

@@ -3,3 +3,4 @@ export * from './repository'
 export {Commit} from './commit'
 export * from './ref'
 export * from './size'
+export * from './utils'

package/src/repository.test.ts

@@ -24,3 +24,15 @@ test('reconstruction', async t => {
   t.is(history2.commits.length, 2, 'incorrect # of commits')
   t.is(sumChanges(history2.commits), changeEntries, 'incorrect # of changelog entries')
 })
+
+test('history contains HEAD ref', async t => {
+  const [repo] = await getBaseline()
+
+  t.is(repo.head(), 'refs/heads/main')
+
+  const history = repo.getHistory()
+  let headRef = history.refs.get('HEAD')
+  t.not(headRef, undefined)
+  t.is(headRef!.name, 'HEAD')
+  t.is(headRef!.value, 'ref: refs/heads/main')
+})