refactor: ensure CollieRepository always uses an absolute path

Author: JohannesRudolph

src/commands/init.command.ts

@@ -23,7 +23,7 @@ export function registerInitCommand(program: TopLevelCommand) {
 
         // we would like to create the CollieRepository after git has been initialized
         // but we need it to build git
-        const kit = new CollieRepository(directory);
+        const kit = CollieRepository.uninitialized(directory);
         const logger = new Logger(kit, opts);
 
         // ensure git is initialized

src/commands/kit/import.command.ts

@@ -79,7 +79,7 @@ export function registerImportCmd(program: TopLevelCommand) {
 
 async function promptForKitModuleId(logger: Logger, hubRepoDir: string) {
   // note: the hub is a standard collie repository for the most part, so we can just parse it with the same code
-  const repo = new CollieRepository(hubRepoDir);
+  const repo = await CollieRepository.load(hubRepoDir);
   const validator = new ModelValidator(logger);
 
   const moduleRepo = await KitModuleRepository.load(repo, validator, logger);

src/model/CollieRepository.test.ts

@@ -1,9 +1,16 @@
-import { assertEquals } from "std/testing/assert";
+import { assertEquals, assertNotEquals } from "std/testing/assert";
 import { CollieRepository } from "./CollieRepository.ts";
 
 Deno.test("relativePath calculates paths relative to repository root", () => {
-  const sut = new CollieRepository("/tmp/test");
+  const sut = CollieRepository.uninitialized("/tmp/test");
 
   const result = sut.relativePath("/tmp/test/123");
   assertEquals(result, "123");
 });
+
+Deno.test("relativePath does not work with paths that are already relative", () => {
+  const sut = CollieRepository.uninitialized("/tmp/test");
+
+  const result = sut.relativePath("123");
+  assertNotEquals(result, "123");
+});

src/model/CollieRepository.ts

@@ -2,7 +2,13 @@ import * as fs from "std/fs";
 import * as path from "std/path";
 
 export class CollieRepository {
-  constructor(private readonly repoDir: string) {}
+  private constructor(private readonly repoDir: string) {
+    if (!path.isAbsolute(repoDir)) {
+      throw new Error(
+        `Tried to load CollieRepository with an invalid path. '${repoDir}' is not an absolute path.`,
+      );
+    }
+  }
 
   /**
    * Resolve a path relative to the kit repository
@@ -11,7 +17,10 @@ export class CollieRepository {
     return path.resolve(this.repoDir, ...pathSegments);
   }
 
-  /** */
+  /**
+   * Calculate a relative path between the repoDir
+   * @param toPath an absolute path
+   */
   relativePath(toPath: string) {
     return path.relative(this.repoDir, toPath);
   }
@@ -55,4 +64,10 @@ export class CollieRepository {
 
     return new CollieRepository(absolutePath);
   }
+
+  static uninitialized(dir: string) {
+    const absolutePath = path.resolve(dir);
+
+    return new CollieRepository(absolutePath);
+  }
 }

src/model/schemas/ModelValidator.test.ts

@@ -6,7 +6,7 @@ import { ModelValidator } from "./ModelValidator.ts";
 import { assertEquals } from "std/testing/assert";
 
 Deno.test("can validate FoundationConfig", () => {
-  const collie = new CollieRepository("./");
+  const collie = CollieRepository.uninitialized("./");
   const logger = new Logger(collie, {
     debug: false,
     verbose: false,