Rename 'new' command to 'template render'

Author: bbugyi200

README.md

@@ -62,7 +62,7 @@ print("```", stdout.decode().strip(), "```", sep="\n")
 ```
 usage: zorg [-h] [-c CONFIG_FILE] [-L [FILE[:LEVEL][@FORMAT]]] [-v]
             [--version] [-d ZETTEL_DIR]
-            {edit,new} ...
+            {edit,template} ...
 
 The zettel note manager of the future.
 
@@ -92,11 +92,11 @@ options:
   --version             show program's version number and exit
 
 subcommands:
-  {edit,new}
+  {edit,template}
     edit                Generate new day logs from templates and open the main
                         day log in your system's editor. This is the default
                         subcommand.
-    new                 Render a new .zo file using a .zot template.
+    template            Commands for managing .zot templates.
 ```
 <!-- [[[[[end]]]]] -->
 

src/zorg/config.py

@@ -14,7 +14,7 @@
 from .types import FileGroupMapType
 
 
-Command = Literal["edit", "new"]
+Command = Literal["edit", "render"]
 
 logger = Logger(__name__)
 
@@ -44,10 +44,10 @@ class EditConfig(Config):
     edit_day_log: bool = True
 
 
-class NewConfig(Config):
-    """Clack config for the 'new' command."""
+class TemplateRenderConfig(Config):
+    """Clack config for the 'template' command."""
 
-    command: Literal["new"]
+    command: Literal["render"]
 
     # ----- ARGUMENTS
     template: Path
@@ -104,15 +104,20 @@ def clack_parser(argv: Sequence[str]) -> dict[str, Any]:
         ),
     )
 
-    new_parser = new_command(
-        "new", help="Render a new .zo file using a .zot template."
+    template_parser = new_command(
+        "template", help="Commands for managing .zot templates."
     )
-    new_parser.add_argument(
+    new_template_command = clack.new_command_factory(template_parser)
+    template_render_parser = new_template_command(
+        "render", help="Render a new .zo file using a .zot template."
+    )
+    template_render_parser.add_argument(
         "template", type=Path, help="Path to the .zot template."
     )
-    new_parser.add_argument(
+    template_render_parser.add_argument(
         "variables",
-        help="A list of comma-separated variable specs of the form key=value.",
+        nargs="*",
+        help="A list of variable specs of the form of key=value.",
     )
 
     args = parser.parse_args(argv[1:])
@@ -137,7 +142,7 @@ def _process_zo_paths(kwargs: dict[str, Any]) -> None:
 def _convert_variables_to_var_map(kwargs: dict[str, Any]) -> None:
     if "variables" in kwargs:
         var_map = {}
-        for var_spec in kwargs["variables"].split(","):
+        for var_spec in kwargs["variables"]:
             k, v = var_spec.split("=")
             var_map[k] = v
         var_map = common.process_var_map(var_map)

src/zorg/runners.py

@@ -14,7 +14,7 @@
 import vimala
 
 from . import common
-from .config import Config, EditConfig, NewConfig
+from .config import Config, EditConfig, TemplateRenderConfig
 from .file_groups import expand_file_group_paths
 
 
@@ -108,8 +108,8 @@ def _process_vim_commands(
 
 
 @runner
-def run_new(cfg: NewConfig) -> int:
-    """Runner for the 'new' command."""
+def run_template_render(cfg: TemplateRenderConfig) -> int:
+    """Runner for the 'template' command."""
     tmpl_manager = _ZorgTemplateManager(cfg)
     print(tmpl_manager.render(cfg.template, cfg.var_map))
     return 0

tests/__snapshots__/test_new_cmd.ambr renamed to tests/__snapshots__/test_template_cmd.ambr

@@ -1,5 +1,5 @@
 # serializer version: 1
-# name: test_new[YAMLConfigFile]
+# name: test_template_render[YAMLConfigFile]
   '''
   # 1991-03-04.Mon
   #

tests/test_config.py

@@ -6,7 +6,7 @@
 from clack import clack_envvars_set
 from clack.types import ClackConfig
 
-from zorg.config import EditConfig, NewConfig, clack_parser
+from zorg.config import EditConfig, TemplateRenderConfig, clack_parser
 
 
 def test_defaultToEdit_whenNoCommandIsGiven() -> None:
@@ -33,6 +33,7 @@ def test_defaultToEdit_whenFileGroupNameIsFirstArg() -> None:
 def wrapped_clack_parser(argv: Sequence[str]) -> dict[str, Any]:
     """Thin wrapper around clack_parser()."""
     with clack_envvars_set(
-        "zorg", cast(list[type[ClackConfig]], [EditConfig, NewConfig])
+        "zorg",
+        cast(list[type[ClackConfig]], [EditConfig, TemplateRenderConfig]),
     ):
         return clack_parser(argv)

tests/test_new_cmd.py renamed to tests/test_template_cmd.py

@@ -1,4 +1,4 @@
-"""Tests for the zorg project's 'new' CLI command."""
+"""Tests for the zorg project's 'template' CLI command."""
 
 from __future__ import annotations
 
@@ -10,26 +10,28 @@
 from . import common as c
 
 
-def test_new(
+def test_template_render(
     main: c.MainType,
     capsys: CaptureFixture,
     tmp_path: Path,
     snapshot: Snapshot,
 ) -> None:
-    """Test the 'new' subcommand."""
+    """Test the 'template render' subcommand."""
     zettel_dir = tmp_path / "org"
-    template_path: Path = zettel_dir / "day_log_tmpl.zo"
+    zot_basename = "day_log_tmpl.zo"
+    template_path: Path = zettel_dir / zot_basename
     template_path.parent.mkdir(parents=True, exist_ok=True)
     test_data_template_path = Path(__file__).parent / Path(
-        "data/day_log_tmpl.zo"
+        f"data/{zot_basename}"
     )
     template_path.write_text(test_data_template_path.read_text())
 
     argv = [
         "--dir",
         str(zettel_dir),
-        "new",
-        "day_log_tmpl.zo",
+        "template",
+        "render",
+        zot_basename,
         "date=19910304",
     ]
     assert main(*argv) == 0