refactor: begin switch to templating class

Author: THEGOLDENPRO

suap/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.0-alpha.1"
+__version__ = "0.1.0-alpha.2"

suap/commands/packaging/nsis.py

@@ -4,12 +4,10 @@
 from typer import Exit
 from pathlib import Path
 
-# just so we can get the root path of our library
-import suap
-
 from ...mime_type import MimeType
 from ...projects import ProjectData
 from ...formats import make_nsis_installer
+from ...templating import Template, Key
 
 __all__ = (
     "format_config_and_make_nsis_installer",
@@ -38,56 +36,62 @@ def format_config_and_make_nsis_installer(
     temp_folder_path.mkdir(exist_ok = True)
     nsis_installer_script_path = temp_folder_path.joinpath("nsis_installer.nsi")
 
-    templates_path = Path(suap.__file__).parent.joinpath("templates")
-    installer_script_template_path = templates_path.joinpath("nsis_installer_script.nsi")
+    installer_script_template = Template("nsis_installer_script.nsi")
 
-    logger.debug(
-        f"Opening and reading NSIS template installer script at '{installer_script_template_path}'..."
-    )
+    semver = project_data.version
 
-    with open(installer_script_template_path, mode = "r") as file:
-        installer_script_string = file.read()
+    binary_name_key = Key(name = "binary-name", value = binary_name)
 
-    logger.debug("Formatting template and creating custom install script...")
+    display_name_key = Key(
+        name = "display-name",
+        value = display_name if display_name is not None else project_data.name
+    )
 
-    semver = project_data.version
-    display_name = display_name if display_name is not None else project_data.name
-
-    replace_map: dict[str, str] = {
-        "suap-binary-name": binary_name,
-        "suap-binary-path": str(binary_path.absolute()),
-        "suap-binary-dist-path": str(binary_dist_path.absolute()),
-        "suap-display-name": display_name,
-        "suap-icon-path": str(icon_path.absolute()),
-        "suap-icon-file-name": icon_path.name,
-
-        "suap-project-name": project_data.name,
-        "suap-project-version": f"{semver.major}.{semver.minor}.{semver.patch}" \
-            f".{semver.prerelease.split('.')[-1] if semver.prerelease is not None else 0}",
-        "suap-project-description": project_data.description,
-
-        "suap-app-capabilities-macro": generate_app_capabilities_macro(
-            mime_types,
-            templates_path,
-            binary_name,
-            display_name,
-            icon_path,
-            project_data,
-            uninstall = False,
-        ),
-        "suap-app-capabilities-uni-macro": generate_app_capabilities_macro(
-            mime_types,
-            templates_path,
-            binary_name,
-            display_name,
-            icon_path,
-            project_data,
-            uninstall = True,
-        ),
-    }
-
-    for (suap_key, value) in replace_map.items():
-        installer_script_string = installer_script_string.replace(f"{{{suap_key}}}", value)
+    icon_file_name_key = Key(name = "icon-file-name", value = icon_path.name)
+
+    installer_script_string = installer_script_template.format(
+        keys = (
+            binary_name_key,
+            Key(name = "binary-path", value = str(binary_path.absolute())),
+            Key(name = "binary-dist-path", value = str(binary_dist_path.absolute())),
+
+            display_name_key,
+
+            Key(name = "icon-path", value = str(icon_path.absolute())),
+            icon_file_name_key,
+
+            Key(name = "project-name", value = project_data.name),
+            Key(
+                name = "project-version",
+                value = f"{semver.major}.{semver.minor}.{semver.patch}" \
+                    f".{semver.prerelease.split('.')[-1] if semver.prerelease is not None else 0}"
+            ),
+            Key(name = "project-description", value = project_data.description),
+
+            Key(
+                name = "app-capabilities-macro",
+                value = generate_app_capabilities_macro(
+                    mime_types,
+                    binary_name_key,
+                    display_name_key,
+                    icon_file_name_key,
+                    project_data,
+                    uninstall = False,
+                )
+            ),
+            Key(
+                name = "app-capabilities-uni-macro",
+                value = generate_app_capabilities_macro(
+                    mime_types,
+                    binary_name_key,
+                    display_name_key,
+                    icon_file_name_key,
+                    project_data,
+                    uninstall = True,
+                )
+            ),
+        )
+    )
 
     logger.debug(
         f"Creating and writing to custom NSIS installer script at '{nsis_installer_script_path}'..."
@@ -103,22 +107,21 @@ def format_config_and_make_nsis_installer(
 
 def generate_app_capabilities_macro(
     mime_types: list[MimeType],
-    templates_path: Path,
-    binary_name: str,
-    display_name: str,
-    icon_path: Path,
+    binary_name_key: Key,
+    display_name_key: Key,
+    icon_file_name_key: Key,
     project_data: ProjectData,
     uninstall: bool,
 ) -> str:
     if len(mime_types) == 0:
         return ""
 
-    app_capabilities_template_path = templates_path.joinpath(
-        "nsis_app_capabilities_uni_macro.nsi" if uninstall else "nsis_app_capabilities_macro.nsi"
-    )
+    template_name = "nsis_app_capabilities_macro.nsi"
+
+    if uninstall:
+        template_name = "nsis_app_capabilities_uni_macro.nsi"
 
-    with open(app_capabilities_template_path, mode = "r") as file:
-        app_capabilities_macro_string = file.read()
+    app_capabilities_template = Template(template_name)
 
     file_associations_and_types_lines = []
 
@@ -133,7 +136,7 @@ def generate_app_capabilities_macro(
 
         if not uninstall:
             file_associations_and_types_lines.append(
-                f'WriteRegStr HKCR "Applications\\{binary_name}.exe\\SupportedTypes" "{file_extension}" ""'
+                f'WriteRegStr HKCR "Applications\\{binary_name_key.name}.exe\\SupportedTypes" "{file_extension}" ""'
             )
 
             file_associations_and_types_lines.append(
@@ -146,28 +149,23 @@ def generate_app_capabilities_macro(
 
         else:
             file_associations_and_types_lines.append(
-                f'DeleteRegValue HKCR "Applications\\{binary_name}.exe\\SupportedTypes" "{file_extension}"'
+                f'DeleteRegValue HKCR "Applications\\{binary_name_key.name}.exe\\SupportedTypes" "{file_extension}"'
             )
 
             file_associations_and_types_lines.append(
                 f'DeleteRegValue HKCR "{file_extension}\\OpenWithProgIds" "Cloudy.{project_name}.1"'
             )
 
-    replace_map: dict[str, str] = {
-        "suap-binary-name": binary_name,
-        "suap-display-name": display_name,
-        "suap-icon-file-name": icon_path.name,
-
-        "suap-project-name": project_data.name,
-        "suap-project-description": project_data.description,
-
-        "suap-file-associations-and-types-macro": "\n".join(file_associations_and_types_lines),
-    }
-
-    for (suap_key, value) in replace_map.items():
-        app_capabilities_macro_string = app_capabilities_macro_string.replace(
-            f"{{{suap_key}}}", value
+    app_capabilities_macro_string = app_capabilities_template.format(
+        keys = (
+            binary_name_key,
+            display_name_key,
+            icon_file_name_key,
+            Key("project-name", project_data.name),
+            Key("project-description", project_data.description),
+            Key("file-associations-and-types-macro", value = "\n".join(file_associations_and_types_lines)),
         )
+    )
 
     formatted_macro_string = "".join([
         f"    {line}" for line in app_capabilities_macro_string.splitlines(keepends = True)

suap/templating.py

@@ -0,0 +1,67 @@
+import re
+import logging
+from pathlib import Path
+from dataclasses import dataclass
+
+__all__ = ()
+
+logger = logging.getLogger(__name__)
+
+@dataclass
+class Key:
+    name: str
+    value: str
+
+class TemplateKeysRemainingError(Exception):
+    def __init__(self, remaining_keys: set[str]):
+        super().__init__(
+            "There are keys defined in the template " \
+                f"that were not formatted! Remaining Keys: {remaining_keys}"
+        )
+
+class Template():
+    def __init__(self, template_name: str):
+        self.__template_string = self.__get_template_contents(template_name)
+
+        # NOTE: Help improving this would be cool, I'm not good at regex
+        defined_suap_keys_list = re.findall(
+            "{suap-(.*?)}", self.__template_string, re.DOTALL
+        )
+
+        self.__defined_suap_keys: set[str] = set(defined_suap_keys_list)
+
+        print(f"--> {self.__defined_suap_keys}")
+
+    def format(self, keys: tuple[Key, ...]) -> str:
+        formatted_string = self.__template_string
+
+        remaining_keys = self.__defined_suap_keys
+
+        for key in keys:
+            key_name = key.name
+
+            if key_name in remaining_keys:
+                logger.debug(f"Formatting template key '{key_name}'...")
+
+                remaining_keys.remove(key_name)
+
+                formatted_string.replace(
+                    f"{{suap-{key_name}}}", str(key.value)
+                )
+
+        if len(remaining_keys) > 0:
+            raise TemplateKeysRemainingError(remaining_keys)
+
+        return formatted_string
+
+    def __get_template_contents(self, template_name: str) -> str:
+        specific_template_path = Path(__file__).parent.joinpath("templates", template_name)
+
+        logger.debug(
+            f"Opening and reading '{template_name}' template at '{specific_template_path}'..."
+        )
+
+        with open(specific_template_path, mode = "r") as file:
+            template_contents = file.read()
+
+        return template_contents