@dotinc/ogre 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+# v0.3.0 (Sun Mar 13 2022)
+
+#### 🚀 Enhancement
+
+- Implement tags [#6](https://github.com/dotindustries/ogre/pull/6) ([@nadilas](https://github.com/nadilas))
+- feat: implement tags ([@nadilas](https://github.com/nadilas))
+
+#### 🐛 Bug Fix
+
+- doc: update README.md ([@nadilas](https://github.com/nadilas))
+
+#### Authors: 1
+
+- [@nadilas](https://github.com/nadilas)
+
+---
+
 # v0.2.0 (Sun Mar 13 2022)
 
 #### 🚀 Enhancement

package/README.md

@@ -7,7 +7,9 @@ keep the history around for a bit longer.
 
 - Commit
 - Branch
+- Tags
 - Checkout
+- Visualization via `@dotinc/ogre-react`
 - Merge
     - fast-forward
 
@@ -35,6 +37,7 @@ repo.data.name = 'a fancier name'
   await repo.commit('change name', 'author <author@test.com>')
   repo.checkout('main')
   repo.merge('add_details')
+  repo.tag('v1.0.0')
 
 // or b) discard change and go back
   // by using the branch name 
@@ -45,7 +48,6 @@ repo.data.name = 'a fancier name'
 
 ## TODO
 
-- [ ] Visualization
 - [ ] Merge
     - [ ] recursive
     - [ ] octopus

package/lib/repository.d.ts

@@ -16,6 +16,7 @@ export interface RepositoryObject<T> {
     createBranch(name: string): string;
     merge(source: string | RepositoryObject<T> | History): string;
     branch(): string;
+    tag(tag: string): string;
 }
 export interface RespositoryObjectType {
     new <T>(obj: T, options: RepositoryOptions<T>): RepositoryObject<T>;
@@ -28,7 +29,9 @@ 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 tagToRef: (tag: string) => string;
 export declare const validateBranchName: (name: string) => void;
+export declare const validateRef: (name: string, oneLevel?: boolean) => void;
 /**
  * Prints the underlying changelog of a repository
  * @param repository

package/lib/repository.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.printChangeLog = exports.validateBranchName = exports.brancheNameToRef = exports.cleanRefValue = exports.isTagRef = exports.createHeadRefValue = exports.Repository = exports.REFS_MAIN_KEY = exports.REFS_HEAD_KEY = void 0;
+exports.printChangeLog = exports.validateRef = exports.validateBranchName = exports.tagToRef = 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 hash_1 = require("./hash");
@@ -256,9 +256,7 @@ exports.Repository = function (obj, options) {
             moveRef(exports.REFS_HEAD_KEY, isRef && refKey !== undefined ? refKey : commit);
         }
     };
-    this.createBranch = (name) => {
-        (0, exports.validateBranchName)(name);
-        const refName = (0, exports.brancheNameToRef)(name);
+    const saveNewRef = (refKey, name) => {
         const headCommit = commitAtHead();
         if (!headCommit) {
             const headRef = this.head();
@@ -267,8 +265,31 @@ exports.Repository = function (obj, options) {
             }
             throw new Error(`fatal: not a valid object name: '${getLastItem(headRef)}'`);
         }
-        refs.set(refName, { name: name, value: headCommit.hash });
-        return refName;
+        refs.set(refKey, { name: name, value: headCommit.hash });
+    };
+    this.createBranch = (name) => {
+        (0, exports.validateBranchName)(name);
+        const branchRef = (0, exports.brancheNameToRef)(name);
+        saveNewRef(branchRef, name);
+        return branchRef;
+    };
+    this.tag = tag => {
+        try {
+            (0, exports.validateRef)(tag);
+        }
+        catch (e) {
+            throw new Error(`fatal: '${tag}' is not a valid tag name`);
+        }
+        const tagRef = (0, exports.tagToRef)(tag);
+        try {
+            saveNewRef(tagRef, tag);
+        }
+        catch (e) {
+            // because git has to make it weird and show a different error
+            //   unlike when creating a branch on a HEAD pointing to a ref which does not exist yet
+            throw new Error(`fatal: failed to resolve 'HEAD' as a valid ref.`);
+        }
+        return tagRef;
     };
     const moveRef = (refName, value) => {
         let ref = refs.get(refName);
@@ -442,12 +463,22 @@ const brancheNameToRef = (name) => {
     return `${headsRefPathPrefix}${name}`;
 };
 exports.brancheNameToRef = brancheNameToRef;
+const tagToRef = (tag) => {
+    return `${tagRefPathPrefix}${tag}`;
+};
+exports.tagToRef = tagToRef;
 const validateBranchName = (name) => {
     if (!(0, ref_1.validBranch)(name)) {
         throw new Error(`invalid ref name`);
     }
 };
 exports.validateBranchName = validateBranchName;
+const validateRef = (name, oneLevel = true) => {
+    if (!(0, ref_1.validRef)(name, oneLevel)) {
+        throw new Error(`invalid ref name`);
+    }
+};
+exports.validateRef = validateRef;
 /**
  * Prints the underlying changelog of a repository
  * @param repository

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/dotindustries/ogre.git"
   },
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Git-like repository for in-memory object versioning",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -45,5 +45,5 @@
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
-  "gitHead": "fb4343e4c5f6cc2b87eb9204a643b6cd632ada69"
+  "gitHead": "ac487e2d4fc3b1a18dd02b20edc89cf0503c3a98"
 }

package/src/repository.ts

@@ -1,6 +1,6 @@
 import { Change, History, Reference } from './interfaces'
 import { calculateCommitHash, Commit } from './commit'
-import { validBranch } from './ref'
+import {validBranch, validRef} from './ref'
 import {digest} from './hash'
 
 const tagRefPathPrefix = 'refs/tags/'
@@ -38,6 +38,7 @@ export interface RepositoryObject<T> {
 
   branch(): string
 
+  tag(tag: string): string
 }
 
 export interface RespositoryObjectType {
@@ -312,9 +313,7 @@ export const Repository = function <T extends { [k: PropertyKey]: any }>(
       moveRef(REFS_HEAD_KEY, isRef && refKey !== undefined ? refKey : commit)
     }
   }
-  this.createBranch = (name) => {
-    validateBranchName(name)
-    const refName = brancheNameToRef(name)
+  const saveNewRef = (refKey: string, name: string) => {
     const headCommit = commitAtHead()
     if (!headCommit) {
       const headRef = this.head()
@@ -323,8 +322,29 @@ export const Repository = function <T extends { [k: PropertyKey]: any }>(
       }
       throw new Error(`fatal: not a valid object name: '${getLastItem(headRef)}'`)
     }
-    refs.set(refName, { name: name, value: headCommit.hash })
-    return refName
+    refs.set(refKey, { name: name, value: headCommit.hash })
+  }
+  this.createBranch = (name) => {
+    validateBranchName(name)
+    const branchRef = brancheNameToRef(name)
+    saveNewRef(branchRef, name)
+    return branchRef
+  }
+  this.tag = tag => {
+    try {
+      validateRef(tag)
+    } catch (e) {
+      throw new Error(`fatal: '${tag}' is not a valid tag name`)
+    }
+    const tagRef = tagToRef(tag)
+    try {
+      saveNewRef(tagRef, tag)
+    } catch (e) {
+      // because git has to make it weird and show a different error
+      //   unlike when creating a branch on a HEAD pointing to a ref which does not exist yet
+      throw new Error(`fatal: failed to resolve 'HEAD' as a valid ref.`)
+    }
+    return tagRef
   }
   const moveRef = (refName: string, value: string | Commit) => {
     let ref = refs.get(refName)
@@ -510,12 +530,22 @@ export const brancheNameToRef = (name: string) => {
   return `${headsRefPathPrefix}${name}`
 }
 
+export const tagToRef = (tag: string) => {
+  return `${tagRefPathPrefix}${tag}`
+}
+
 export const validateBranchName = (name: string) => {
   if (!validBranch(name)) {
     throw new Error(`invalid ref name`)
   }
 }
 
+export const validateRef = (name: string, oneLevel: boolean = true) => {
+  if (!validRef(name, oneLevel)) {
+    throw new Error(`invalid ref name`)
+  }
+}
+
 /**
  * Prints the underlying changelog of a repository
  * @param repository

package/src/tag.test.ts

@@ -0,0 +1,36 @@
+import test from 'ava'
+import {getBaseline, testAuthor} from './test.utils'
+
+test('cannot tag on an empty repo', async t => {
+  const [repo] = await getBaseline()
+
+  t.throws(() => {
+    repo.tag('v1.0.0')
+  }, {message: `fatal: failed to resolve 'HEAD' as a valid ref.`})
+})
+
+test('can create simple tag pointing to HEAD', async t => {
+  const [repo] = await getBaseline()
+  repo.data.name = 'name'
+  const commit = await repo.commit('initial commit', testAuthor)
+  const tag = 'v1.0.0'
+
+  const tagRef = repo.tag(tag)
+
+  let expectedRefKey = `refs/tags/${tag}`
+  t.is(tagRef, expectedRefKey)
+  t.is(repo.ref(tagRef), commit, 'tag is not pointing to expected commit')
+  const {refs} = repo.getHistory()
+  t.true(refs.has(expectedRefKey), 'reference was not present in history')
+})
+
+test('cannot create tag with whitespace', async t => {
+  const [repo] = await getBaseline()
+  repo.data.name = 'name'
+  await repo.commit('initial commit', testAuthor)
+  const tag = 'first release'
+
+  t.throws(() => {
+    repo.tag(tag)
+  }, {message: `fatal: '${tag}' is not a valid tag name`})
+})