fix: merge data dictionary when including (#347)

oldium · web-flow · commit c0cd1dbb8e9a · 2025-11-12T14:45:20.000-07:00
* fix: allow running tests on Windows with path backslashes

Signed-off-by: Oldřich Jedlička &lt;oldium.pro@gmail.com&gt;

* fix: merge data dictionary when including templates

* fix: use __eta argument prefix to allow varName to be data

---------

Signed-off-by: Oldřich Jedlička &lt;oldium.pro@gmail.com&gt;
diff --git a/src/compile-string.ts b/src/compile-string.ts
@@ -20,8 +20,8 @@ export function compileToString(
 
   // note: when the include function passes through options, the only parameter that matters is the filepath parameter
   let res = `${config.functionHeader}
-let include = (template, data) => this.render(template, data, options);
-let includeAsync = (template, data) => this.renderAsync(template, data, options);
+let include = (__eta_t, __eta_d) => this.render(__eta_t, {...${config.varName}, ...(__eta_d ?? {})}, options);
+let includeAsync = (__eta_t, __eta_d) => this.renderAsync(__eta_t, {...${config.varName}, ...(__eta_d ?? {})}, options);
 
 let __eta = {res: "", e: this.config.escapeFunction, f: this.config.filterFunction${
     config.debug
diff --git a/test/compile-string.spec.ts b/test/compile-string.spec.ts
@@ -14,8 +14,8 @@ describe("Compile to String test", () => {
   it("compiles a simple template", () => {
     const str = eta.compileToString("hi <%= it.name %>");
     expect(str).toEqual(`
-let include = (template, data) => this.render(template, data, options);
-let includeAsync = (template, data) => this.renderAsync(template, data, options);
+let include = (__eta_t, __eta_d) => this.render(__eta_t, {...it, ...(__eta_d ?? {})}, options);
+let includeAsync = (__eta_t, __eta_d) => this.renderAsync(__eta_t, {...it, ...(__eta_d ?? {})}, options);
 
 let __eta = {res: "", e: this.config.escapeFunction, f: this.config.filterFunction};
 
@@ -40,8 +40,8 @@ return __eta.res;
   it("compiles a simple template with a raw tag", () => {
     const str = eta.compileToString("hi <%~ it.name %>");
     expect(str).toEqual(`
-let include = (template, data) => this.render(template, data, options);
-let includeAsync = (template, data) => this.renderAsync(template, data, options);
+let include = (__eta_t, __eta_d) => this.render(__eta_t, {...it, ...(__eta_d ?? {})}, options);
+let includeAsync = (__eta_t, __eta_d) => this.renderAsync(__eta_t, {...it, ...(__eta_d ?? {})}, options);
 
 let __eta = {res: "", e: this.config.escapeFunction, f: this.config.filterFunction};
 
@@ -68,8 +68,8 @@ return __eta.res;
       "hi\n<%- = it.firstname-%>\n<%_ = it.lastname_%>",
     );
     expect(str).toEqual(`
-let include = (template, data) => this.render(template, data, options);
-let includeAsync = (template, data) => this.renderAsync(template, data, options);
+let include = (__eta_t, __eta_d) => this.render(__eta_t, {...it, ...(__eta_d ?? {})}, options);
+let includeAsync = (__eta_t, __eta_d) => this.renderAsync(__eta_t, {...it, ...(__eta_d ?? {})}, options);
 
 let __eta = {res: "", e: this.config.escapeFunction, f: this.config.filterFunction};
 
@@ -95,8 +95,8 @@ return __eta.res;
   it("compiles complex template", () => {
     const str = eta.compileToString(complexTemplate);
     expect(str).toEqual(`
-let include = (template, data) => this.render(template, data, options);
-let includeAsync = (template, data) => this.renderAsync(template, data, options);
+let include = (__eta_t, __eta_d) => this.render(__eta_t, {...it, ...(__eta_d ?? {})}, options);
+let includeAsync = (__eta_t, __eta_d) => this.renderAsync(__eta_t, {...it, ...(__eta_d ?? {})}, options);
 
 let __eta = {res: "", e: this.config.escapeFunction, f: this.config.filterFunction};
 
diff --git a/test/file-handling.spec.ts b/test/file-handling.spec.ts
@@ -27,13 +27,13 @@ Hi Test Runner`,
     // Filepath caching is based on the premise that given the same path, includer filename, root directory, and views directory (or directories)
     // the getPath function will always return the same result (assuming that caching is enabled and we're not expecting the templates to change)
 
-    const pathToPartial = `{"filename":"${viewsDir}/has-include.eta","path":"./partial","views":"${viewsDir}"}`;
+    const pathToPartial = `{"filename":${JSON.stringify(path.join(viewsDir, "has-include.eta"))},"path":"./partial","views":${JSON.stringify(viewsDir)}}`;
 
-    const pathToSimple = `{"filename":"${viewsDir}/partial.eta","path":"./simple","views":"${viewsDir}"}`;
+    const pathToSimple = `{"filename":${JSON.stringify(path.join(viewsDir, "partial.eta"))},"path":"./simple","views":${JSON.stringify(viewsDir)}}`;
 
     expect(eta.filepathCache).toEqual({
-      [pathToPartial]: `${viewsDir}/partial.eta`,
-      [pathToSimple]: `${viewsDir}/simple.eta`,
+      [pathToPartial]: path.join(viewsDir, "partial.eta"),
+      [pathToSimple]: path.join(viewsDir, "simple.eta"),
     });
   });
 });
diff --git a/test/render.spec.ts b/test/render.spec.ts
@@ -4,6 +4,7 @@ import { describe, expect, it } from "vitest";
 import { Eta } from "../src/index";
 
 interface SimpleEtaTemplate {
+  greeting?: string;
   name: string;
 }
 
@@ -171,3 +172,83 @@ describe("file rendering", () => {
 HI FROM ASYNC`);
   });
 });
+
+describe("import values merging", () => {
+  const eta = new Eta({ views: path.join(__dirname, "templates") });
+  eta.loadTemplate("@simple", "<%= it.greeting ?? 'Hi' %> <%= it.name %>");
+  eta.loadTemplate("@partial", "This is a partial.\n<%~ include('@simple', {name: 'Test Runner'}) %>\n");
+  eta.loadTemplate("@partial-merge", "This is a partial.\n<%~ include('@simple', {greeting: 'Hello'}) %>\n");
+  eta.loadTemplate("@partial-pass-data", "This is a partial.\n<%~ include('@simple') %>");
+
+  it("can override value", () => {
+    const res = eta.render<SimpleEtaTemplate>("@partial", { greeting: "Hello", name: "friend" });
+
+    expect(res).toEqual("This is a partial.\nHello Test Runner");
+  });
+
+  it("merges values", () => {
+    const res = eta.render<SimpleEtaTemplate>("@partial-merge", { name: "friend" });
+
+    expect(res).toEqual("This is a partial.\nHello friend");
+  });
+
+  it("passes original values", () => {
+    const res = eta.render<SimpleEtaTemplate>("@partial-pass-data", { greeting: "Hello", name: "friend" });
+
+    expect(res).toEqual("This is a partial.\nHello friend");
+  });
+});
+
+describe("import values merging with varName data", () => {
+  const eta = new Eta({ varName: "data", views: path.join(__dirname, "templates") });
+
+  eta.loadTemplate("@simple", "<%= data.greeting ?? 'Hi' %> <%= data.name %>");
+  eta.loadTemplate("@partial", "This is a partial.\n<%~ include('@simple', {name: 'Test Runner'}) %>\n");
+  eta.loadTemplate("@partial-merge", "This is a partial.\n<%~ include('@simple', {greeting: 'Hello'}) %>\n");
+  eta.loadTemplate("@partial-pass-data", "This is a partial.\n<%~ include('@simple') %>");
+
+  it("can override value", () => {
+    const res = eta.render<SimpleEtaTemplate>("@partial", { greeting: "Hello", name: "friend" });
+
+    expect(res).toEqual("This is a partial.\nHello Test Runner");
+  });
+
+  it("merges values", () => {
+    const res = eta.render<SimpleEtaTemplate>("@partial-merge", { name: "friend" });
+
+    expect(res).toEqual("This is a partial.\nHello friend");
+  });
+
+  it("passes original values", () => {
+    const res = eta.render<SimpleEtaTemplate>("@partial-pass-data", { greeting: "Hello", name: "friend" });
+
+    expect(res).toEqual("This is a partial.\nHello friend");
+  });
+});
+
+describe("import values merging with the useWith", () => {
+  const eta = new Eta({ useWith: true, views: path.join(__dirname, "templates") });
+
+  eta.loadTemplate("@simple", "<%= typeof greeting !== 'undefined' ? greeting : 'Hi' %> <%= name %>");
+  eta.loadTemplate("@partial", "This is a partial.\n<%~ include('@simple', {name: 'Test Runner'}) %>\n");
+  eta.loadTemplate("@partial-merge", "This is a partial.\n<%~ include('@simple', {greeting: 'Hello'}) %>\n");
+  eta.loadTemplate("@partial-pass-data", "This is a partial.\n<%~ include('@simple') %>");
+
+  it("can override value", () => {
+    const res = eta.render<SimpleEtaTemplate>("@partial", { greeting: "Hello", name: "friend" });
+
+    expect(res).toEqual("This is a partial.\nHello Test Runner");
+  });
+
+  it("merges values", () => {
+    const res = eta.render<SimpleEtaTemplate>("@partial-merge", { name: "friend" });
+
+    expect(res).toEqual("This is a partial.\nHello friend");
+  });
+
+  it("passes original values", () => {
+    const res = eta.render<SimpleEtaTemplate>("@partial-pass-data", { greeting: "Hello", name: "friend" });
+
+    expect(res).toEqual("This is a partial.\nHello friend");
+  });
+});
