refactor: move substitution out of source template (#241)

Author: kormide

dist/cli/index.js

@@ -19,11 +19,11 @@ import {
 import { Repository } from '../../domain/repository.js';
 import {
   SourceTemplate,
-  SubstitutableVar,
   UnsubstitutedVarsError,
 } from '../../domain/source-template.js';
 import { SourceTemplateError } from '../../domain/source-template.js';
 import { CreateEntryArgs } from './yargs.js';
+import { SubstitutableVar } from '../../domain/substitution.js';
 
 export interface CreateEntryCommandOutput {
   moduleName: string;
@@ -113,12 +113,15 @@ export class CreateEntryCommand {
       console.error(
         `Source template ${e.path} has unsubstituted variables ${Array.from(e.unsubstituted).join(',')}`
       );
-      if (e.unsubstituted.has('OWNER') || e.unsubstituted.has('REPO')) {
+      if (
+        e.unsubstituted.has(SubstitutableVar.OWNER) ||
+        e.unsubstituted.has(SubstitutableVar.REPO)
+      ) {
         console.error(
           'Did you forget to pass --github-repository to substitute the OWNER and REPO variables?'
         );
       }
-      if (e.unsubstituted.has('TAG')) {
+      if (e.unsubstituted.has(SubstitutableVar.TAG)) {
         console.error(
           'Did you forget to pass --tag to substitute the TAG variable?'
         );

src/application/cli/create-entry-command.ts

@@ -17,6 +17,7 @@ ts_project(
         "repository.ts",
         "ruleset-repository.ts",
         "source-template.ts",
+        "substitution.ts",
         "user.ts",
         "version.ts",
     ],
@@ -54,6 +55,7 @@ ts_project(
         "repository.spec.ts",
         "ruleset-repository.spec.ts",
         "source-template.spec.ts",
+        "substitution.spec.ts",
         "version.spec.ts",
     ],
     deps = [

src/domain/BUILD.bazel

@@ -1,5 +1,11 @@
 import fs from 'node:fs';
 
+import {
+  getUnsubstitutedVars,
+  SubstitutableVar,
+  substituteVars,
+} from './substitution.js';
+
 export class SourceTemplateError extends Error {
   constructor(
     public readonly path: string,
@@ -18,8 +24,6 @@ export class UnsubstitutedVarsError extends Error {
   }
 }
 
-export type SubstitutableVar = 'OWNER' | 'REPO' | 'TAG' | 'VERSION';
-
 export class SourceTemplate {
   private sourceJson: Record<string, unknown>;
 
@@ -61,7 +65,7 @@ export class SourceTemplate {
     for (const prop of ['url', 'strip_prefix'].filter(
       (prop) => prop in this.sourceJson
     )) {
-      this.sourceJson[prop] = this.replaceVariables(
+      this.sourceJson[prop] = substituteVars(
         this.sourceJson[prop] as string,
         vars
       );
@@ -71,38 +75,20 @@ export class SourceTemplate {
   }
 
   public validateFullySubstituted(): void {
-    const tempalteVars: SubstitutableVar[] = [
-      'OWNER',
-      'REPO',
-      'TAG',
-      'VERSION',
-    ];
     const unsubstituted = new Set<SubstitutableVar>();
     for (const prop of ['url', 'strip_prefix'].filter(
       (prop) => prop in this.sourceJson
     )) {
-      for (const templateVar of tempalteVars) {
-        if ((this.sourceJson[prop] as string).includes(`{${templateVar}}`)) {
-          unsubstituted.add(templateVar);
-        }
-      }
+      getUnsubstitutedVars(this.sourceJson[prop] as string).forEach((v) =>
+        unsubstituted.add(v)
+      );
     }
 
     if (unsubstituted.size > 0) {
       throw new UnsubstitutedVarsError(this.filePath, unsubstituted);
     }
   }
 
-  private replaceVariables(
-    str: string,
-    vars: Partial<Record<SubstitutableVar, string>>
-  ) {
-    for (const key of Object.keys(vars)) {
-      str = str.replaceAll(`{${key}}`, vars[key as SubstitutableVar]);
-    }
-    return str;
-  }
-
   public setIntegrityHash(integrityHash: string) {
     this.sourceJson.integrity = integrityHash;
   }

src/domain/source-template.ts

@@ -0,0 +1,69 @@
+import {
+  getUnsubstitutedVars,
+  SubstitutableVar,
+  substituteVars,
+} from './substitution';
+
+describe('substituteVars', () => {
+  test('substitutes a variable', () => {
+    const str = 'The repo is {REPO}';
+    const sub = substituteVars(str, { REPO: 'foo' });
+
+    expect(sub).toEqual('The repo is foo');
+  });
+
+  test('substitutes duplicates of a variable', () => {
+    const str = 'The repo is {REPO}. Yes, it is {REPO}.';
+    const sub = substituteVars(str, { REPO: 'foo' });
+
+    expect(sub).toEqual('The repo is foo. Yes, it is foo.');
+  });
+
+  test('substitutes multiple variables', () => {
+    const str = 'The repo is {REPO}. The owner is {OWNER}.';
+    const sub = substituteVars(str, { REPO: 'foo', OWNER: 'bar' });
+
+    expect(sub).toEqual('The repo is foo. The owner is bar.');
+  });
+
+  test('does not substitute an unknown variable', () => {
+    const str = 'The meaning of life is {UNKNOWN}.';
+    const sub = substituteVars(str, { REPO: 'foo' });
+
+    expect(sub).toEqual('The meaning of life is {UNKNOWN}.');
+  });
+});
+
+describe('getUnsubstitutedVars', () => {
+  test('gets an unsubstituted var', () => {
+    const str = 'The repo is {REPO}';
+    const vars = getUnsubstitutedVars(str);
+
+    expect(vars.size).toEqual(1);
+    expect(vars.has(SubstitutableVar.REPO)).toBe(true);
+  });
+
+  test('gets duplicated unsubstituted var', () => {
+    const str = 'The repo is {REPO}. Yes, it is {REPO}.';
+    const vars = getUnsubstitutedVars(str);
+
+    expect(vars.size).toEqual(1);
+    expect(vars.has(SubstitutableVar.REPO)).toBe(true);
+  });
+
+  test('gets an multiple ubsubstituted vars', () => {
+    const str = 'The repo is {REPO}. The owner is {OWNER}.';
+    const vars = getUnsubstitutedVars(str);
+
+    expect(vars.size).toEqual(2);
+    expect(vars.has(SubstitutableVar.REPO)).toBe(true);
+    expect(vars.has(SubstitutableVar.OWNER)).toBe(true);
+  });
+
+  test('does not get unknown vars', () => {
+    const str = 'The meaning of life is {UNKNOWN}.';
+    const vars = getUnsubstitutedVars(str);
+
+    expect(vars.size).toEqual(0);
+  });
+});

src/domain/substitution.spec.ts

@@ -0,0 +1,32 @@
+// export type SubstitutableVar = 'OWNER' | 'REPO' | 'TAG' | 'VERSION';
+
+export enum SubstitutableVar {
+  OWNER = 'OWNER',
+  REPO = 'REPO',
+  TAG = 'TAG',
+  VERSION = 'VERSION',
+}
+
+export const ALL_SUBSTITUTABLE_VARS = Object.values(SubstitutableVar);
+
+export function substituteVars(
+  str: string,
+  vars: Partial<Record<SubstitutableVar, string>>
+): string {
+  for (const key of Object.keys(vars)) {
+    str = str.replaceAll(`{${key}}`, vars[key as SubstitutableVar]);
+  }
+  return str;
+}
+
+export function getUnsubstitutedVars(str: string): Set<SubstitutableVar> {
+  const unsubstituted = new Set<SubstitutableVar>();
+
+  for (const templateVar of ALL_SUBSTITUTABLE_VARS) {
+    if (str.includes(`{${templateVar}}`)) {
+      unsubstituted.add(templateVar);
+    }
+  }
+
+  return unsubstituted;
+}