Elements in HTML

import { describe, expect, test } from "vite-plus/test";
import { renderElements, type Host } from "../../src/elements/elements.ts";
import { FileError } from "../../src/elements/errors.ts";
import { readElement, templateModule, type ElementFile } from "../../src/elements/file.ts";

const scope = ["page"];
const elements = new Map<string, ElementFile>();
function element(name: string, source: string) {
  elements.set(name, readElement(`/site/code/@${name}.html`, scope, source));
}

element("site-note", "<template><aside><b>Note</b><slot></slot></aside></template>");
element("site-plain", "<template><hr></template>");
element("site-empty", "<template><p><slot>Nothing yet.</slot></p></template>");
element(
  "site-box",
  "<template><div data-attrs=${Object.keys(attrs).join()} data-url=${page.url}><slot></slot></div></template>",
);
element(
  "site-card",
  '<template>\n<script>\nconst count = (rows) => rows?.split(",").length ?? 0;\n</script>\n<h2>${attrs.title}</h2><site-note>${count(attrs.data)} rows</site-note>\n</template>',
);
element("site-a", "<template><site-b></site-b></template>");
element("site-b", "<template><site-a></site-a></template>");
element("site-bare", "<template><p>No place.</p></template>");
element("site-twice", "<template><slot></slot>${html`<slot></slot>`}</template>");
element("site-wait", "<template>${Promise.resolve(1)}</template>");
element("site-only", "<script>export default () => {};</script>");

/** A template module, imported from a data URL, with `html` from its source. */
const htmlModule = new URL("../../src/elements/html.ts", import.meta.url).href;
const evaluate = (element: ElementFile): Promise<Record<string, unknown>> =>
  import(`data:text/javascript,${encodeURIComponent(templateModule(element, scope, htmlModule))}`);

const host: Host = {
  elements,
  load: evaluate,
  context: { page: { url: "/about/" } },
};
const render = (source: string) => renderElements(host, source, "/site/code/index.html", []);
const fails = async (source: string) => {
  try {
    await render(source);
  } catch (error) {
    if (error instanceof FileError) return error;
    throw error;
  }
  throw new Error("expected a FileError");
};

describe("renderElements", () => {
  test("writes an element around what its template writes, with its attributes", async () => {
    expect(await render('<main><site-plain class="x" hidden></site-plain></main>')).toBe(
      '<main><site-plain class="x" hidden><hr></site-plain></main>',
    );
  });

  test("puts an element's content where its slot is, and its template gets attrs and the host's context", async () => {
    expect(
      await render('<site-note><site-box id="b" page="p"><em>hi</em></site-box></site-note>'),
    ).toBe(
      '<site-note><aside><b>Note</b><site-box id="b" page="p"><div data-attrs="id,page" data-url="/about/"><em>hi</em></div></site-box></aside></site-note>',
    );
  });

  test("shows a slot's fallback only when the element has no content", async () => {
    expect(await render("<site-empty></site-empty>")).toBe(
      "<site-empty><p>Nothing yet.</p></site-empty>",
    );
    expect(await render("<site-empty>Done.</site-empty>")).toBe(
      "<site-empty><p>Done.</p></site-empty>",
    );
  });

  test("renders what an element writes, with a data attribute as a plain string, for the elements in it", async () => {
    expect(await render('<site-card title="Cards" data="a,b,c" />')).toBe(
      '<site-card title="Cards" data="a,b,c"><h2>Cards</h2><site-note><aside><b>Note</b>3 rows</aside></site-note></site-card>',
    );
  });

  test("renders content once, so an element in an element of the same name is its own", async () => {
    expect(await render("<site-note><site-note>x</site-note></site-note>")).toBe(
      "<site-note><aside><b>Note</b><site-note><aside><b>Note</b>x</aside></site-note></aside></site-note>",
    );
  });

  test("leaves plain tags, comments and scripts as they are, but renders what a plain tag holds", async () => {
    expect(
      await render(
        '<!-- <site-plain></site-plain> --><site-plain-tag><site-plain></site-plain></site-plain-tag><script>"<site-plain>"</script>',
      ),
    ).toBe(
      '<!-- <site-plain></site-plain> --><site-plain-tag><site-plain><hr></site-plain></site-plain-tag><script>"<site-plain>"</script>',
    );
  });

  test("writes the content of an element with no template as it is", async () => {
    expect(await render("<site-only><b>x</b></site-only>")).toBe("<site-only><b>x</b></site-only>");
  });

  test("fails on an element that is never closed, naming the file", async () => {
    const error = await fails("<main><site-note>text</main>");
    expect(error.file).toBe("/site/code/index.html");
    expect(error.id).toBe("error-element-unclosed");
    expect(error.message).toBe(
      "<site-note> is never closed. Write </site-note> after its content, or <site-note /> if it has none.",
    );
  });

  test("fails on an element that ends up inside itself, naming the chain and the file that wrote it", async () => {
    const error = await fails("<site-a></site-a>");
    expect(error.file).toBe("/site/code/@site-b.html");
    expect(error.id).toBe("error-element-inside-itself");
    expect(error.message).toBe(
      "this writes <site-a>, which ends up inside itself: <site-a> → <site-b> → <site-a>. Remove one of them, or the element would never finish.",
    );
  });

  test("fails on content with no slot, on two slots, and on a promise", async () => {
    expect((await fails("<site-bare>x</site-bare>")).id).toBe("error-slot-missing");
    expect((await fails("<site-bare>x</site-bare>")).message).toBe(
      "<site-bare> is given content, and its template has no <slot></slot> for it. Write one where the content goes.",
    );
    expect(await render("<site-bare></site-bare>")).toBe("<site-bare><p>No place.</p></site-bare>");
    expect((await fails("<site-twice></site-twice>")).message).toMatch(/writes 2 slots/);
    expect((await fails("<site-twice></site-twice>")).id).toBe("error-slot-two");
    const error = await fails("<site-wait></site-wait>");
    expect(error.file).toBe("/site/code/@site-wait.html");
    expect(error.message).toMatch(/^a template holds a promise/);
  });
});