From 95491e733fbc37028771e74752ff05f428fa4934 Mon Sep 17 00:00:00 2001
From: Rhet Turnbull <rturnbull@gmail.com>
Date: Sat, 3 Feb 2024 21:34:26 -0800
Subject: [PATCH] fixed templates for user scripts

---
 README.md                    |  6 ++++++
 applecrate/cli.py            | 33 ++++++++++-----------------------
 applecrate/template_utils.py | 10 ++++++++++
 3 files changed, 26 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 87bcaa6..eff7bc6 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,12 @@ applecrate build \
 
 This will create a native macOS installer for the tool `dist/mytool` which will install it to `/usr/local/bin/mytool-1.0.0`. The installer will create a symlink to the tool at `/usr/local/bin/mytool` and will also create an uninstaller to remove the tool.
 
+## How It Works
+
+AppleCrate is a Python application that uses the `pkgbuild` and `productbuild` command line tools to create a macOS installer package. AppleCrate does not do anything that you couldn't do yourself with these tools, but it automates the process and provide a simple command line interface. Creating a macOS installer package is a multi-step process that requires the generation of multiple files such as HTML files for the welcome screen, pre and post install scripts, Distribution XML file, etc. AppleCrate takes care of all of this for you but also allows you to customize the installer by providing your own files for these steps.
+
+AppleCrate uses [Jinja2](https://jinja.palletsprojects.com/en/3.0.x/) templates to generate the files required for the installer. This allows you to use template variables in your files or command line parameters to customize the installer. For example, you can use `{{ app }}` and `{{ version }}` in your files to refer to the app name and version you provide on the command line.
+
 ## Usage
 
 <!--[[[cog
diff --git a/applecrate/cli.py b/applecrate/cli.py
index 45dc4f1..e611e90 100644
--- a/applecrate/cli.py
+++ b/applecrate/cli.py
@@ -21,7 +21,7 @@
     create_build_dirs,
     stage_install_files,
 )
-from .template_utils import create_html_file, get_template, render_template
+from .template_utils import create_html_file, get_template, render_template, render_template_from_file
 from .utils import copy_and_create_parents, set_from_defaults
 
 
@@ -120,15 +120,13 @@ def cli():
     "--pre-install",
     "-p",
     type=click.Path(dir_okay=False, exists=True),
-    help="Path to pre-install shell script; "
-    "if not provided, a pre-install script will be created for you.",
+    help="Path to pre-install shell script; " "if not provided, a pre-install script will be created for you.",
 )
 @click.option(
     "--post-install",
     "-P",
     type=click.Path(dir_okay=False, exists=True),
-    help="Path to post-install shell script; "
-    "if not provided, a post-install script will be created for you.",
+    help="Path to post-install shell script; " "if not provided, a post-install script will be created for you.",
 )
 def build(**kwargs):
     """applecrate: A Python package for creating macOS installer packages."""
@@ -184,13 +182,10 @@ def build(**kwargs):
 
     # Render the welcome and conclusion templates
     echo("Creating welcome.html")
-    create_html_file(
-        welcome, BUILD_DIR / "Resources" / "welcome.html", data, "welcome.md"
-    )
+    create_html_file(welcome, BUILD_DIR / "Resources" / "welcome.html", data, "welcome.md")
+
     echo("Creating conclusion.html")
-    create_html_file(
-        conclusion, BUILD_DIR / "Resources" / "conclusion.html", data, "conclusion.md"
-    )
+    create_html_file(conclusion, BUILD_DIR / "Resources" / "conclusion.html", data, "conclusion.md")
 
     echo("Copying license file")
     copy_and_create_parents(license, BUILD_DIR / "Resources" / "LICENSE.txt")
@@ -202,17 +197,9 @@ def build(**kwargs):
     # Render the uninstall script
     if not no_uninstall:
         echo("Creating uninstall script")
-        target = (
-            BUILD_DIR
-            / "darwinpkg"
-            / "Library"
-            / "Application Support"
-            / app
-            / version
-            / "uninstall.sh"
-        )
+        target = BUILD_DIR / "darwinpkg" / "Library" / "Application Support" / app / version / "uninstall.sh"
         if uninstall:
-            copy_and_create_parents(uninstall, target)
+            render_template(uninstall, data, target)
         else:
             template = get_template("uninstall.sh")
             render_template(template, data, target)
@@ -241,13 +228,13 @@ def build(**kwargs):
 
     if pre_install:
         target = BUILD_DIR / "scripts" / "custom_preinstall"
-        copy_and_create_parents(pre_install, target)
+        render_template_from_file(pre_install, data, target)
         pathlib.Path(target).chmod(0o755)
         echo(f"Created {target}")
 
     if post_install:
         target = BUILD_DIR / "scripts" / "custom_postinstall"
-        copy_and_create_parents(post_install, target)
+        render_template_from_file(post_install, data, target)
         pathlib.Path(target).chmod(0o755)
         echo(f"Created {target}")
 
diff --git a/applecrate/template_utils.py b/applecrate/template_utils.py
index ad46be0..58ac03b 100644
--- a/applecrate/template_utils.py
+++ b/applecrate/template_utils.py
@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import os
 import pathlib
 
 import markdown2
@@ -46,6 +47,15 @@ def render_template(template: Template, data: dict[str, str], output: pathlib.Pa
         file.write(rendered)
 
 
+def render_template_from_file(filepath: str | os.PathLike, data: dict[str, str], output: pathlib.Path):
+    """Render and save a Jinja2 template to a file."""
+    template = load_template_from_file(filepath)
+    rendered = template.render(**data)
+    output.parent.mkdir(parents=True, exist_ok=True)
+    with open(output, "w") as file:
+        file.write(rendered)
+
+
 def create_html_file(
     input_path: pathlib.Path | None,
     output_path: pathlib.Path,