Extend cli with possibility to specify directories for: templates, challenges solutions, and data

Author: nekeal

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- Extend cli with possibility to specify directories for: templates, challenges solutions, and data
+
 ### Fixed
 - Fixed typing in cli module
 - Adapt ruff config for a newer version

src/aoc/main.py

@@ -2,7 +2,7 @@
 import shutil
 from datetime import datetime
 from pathlib import Path
-from typing import Literal
+from typing import Annotated, Literal
 
 import aocd
 import pytest
@@ -136,7 +136,8 @@ def verify(
             )
             raise typer.Exit(1)
         del locals()["module"]
-        pytest_args.append(module.__file__)
+        pytest_args.append(module.__path__[0])
+        print(pytest_args)
     pytest.main(pytest_args)
 
 
@@ -191,26 +192,50 @@ def submit(
 
 @app.command()
 def new_day(
-    day: int = typer.Argument(help="Day for which to create a directory."),
-    year: int = typer.Option(
-        get_current_aoc_year(),
-        "--year",
-        "-y",
-        help="Year for which to get the puzzle data",
-    ),
-    force: bool = typer.Option(
-        False,
-        "--force",
-        "-f",
-        help="Force creation of directory even if it already exists.",
-    ),
+    day: Annotated[int, typer.Argument(help="Day for which to create a directory.")],
+    year: Annotated[
+        int,
+        typer.Option(
+            "-y",
+            "--year",
+            help="Year for which to get the puzzle data",
+        ),
+    ] = get_current_aoc_year(),
+    directory: Annotated[
+        Path,
+        typer.Option(
+            ...,
+            "-d",
+            "--directory",
+            help="Path to a directory with challenges",
+        ),
+    ] = "src/aoc",
+    data_directory: Annotated[
+        Path,
+        typer.Option(help="Path to a directory with data."),
+    ] = "data",
+    template_directory: Annotated[
+        Path,
+        typer.Option(
+            "--template-directory",
+            help="Path to a template directory for a single day challenge.",
+        ),
+    ] = Path(__file__).parent / "templates/day_template",
+    force: Annotated[
+        bool,
+        typer.Option(
+            "--force",
+            "-f",
+            help="Force creation of directory even if it already exists.",
+        ),
+    ] = False,
 ):
     """Create a directory for a new day challenge."""
     puzzle = get_puzzle_object(year, day)
     if day < 1 or day > 25:
         typer.echo(typer.style("Day must be between 1 and 25.", fg=typer.colors.RED))
         raise typer.Exit(1)
-    destination = Path(f"src/aoc/day_{day:02}")
+    destination = directory.joinpath(f"day_{day:02}")
     if destination.exists() and not force:
         typer.echo(
             typer.style(
@@ -219,14 +244,13 @@ def new_day(
             )
         )
         raise typer.Exit(1)
-    shutil.copytree(
-        "templates/day_template", f"src/aoc/day_{day:02}", dirs_exist_ok=force
-    )
+    shutil.copytree(template_directory, destination, dirs_exist_ok=force)
     typer.echo(
         typer.style(f"Created solution directory for day {day}.", fg=typer.colors.GREEN)
     )
+    data_directory.mkdir(exist_ok=True)
     if (
-        real_input_data := Path(f"data/{day:02}_input.txt")
+        real_input_data := data_directory.joinpath(f"{day:02}_input.txt")
     ).exists() and real_input_data.stat().st_size:
         typer.echo(
             typer.style(
@@ -241,7 +265,7 @@ def new_day(
             typer.style(f"Created input data for day {day}.", fg=typer.colors.GREEN)
         )
     if (
-        test_input_data := Path(f"data/{day:02}_test_input.txt")
+        test_input_data := data_directory.joinpath(Path(f"{day:02}_test_input.txt"))
     ).exists() and test_input_data.stat().st_size:
         typer.echo(
             typer.style(

templates/day_template/__init__.py renamed to src/aoc/templates/day_template/__init__.py

@@ -0,0 +1,9 @@
+from aoc.base_tests import BaseTestChallenge, Empty
+
+from . import Challenge
+
+
+class TestChallenge(BaseTestChallenge):
+    challenge_class = Challenge
+    expected_results_from_test_data = (Empty, Empty)
+    expected_results_from_real_data = (Empty, Empty)

src/aoc/templates/day_template/test_solution.py

@@ -0,0 +1,42 @@
+from pathlib import Path
+from unittest import mock
+
+import pytest
+from aoc.main import app
+from aocd.models import Puzzle
+from typer.testing import CliRunner
+
+runner = CliRunner()
+
+
+@pytest.fixture(autouse=True)
+def m_aocd_puzzle(monkeypatch):
+    m_puzzle = mock.Mock(spec=Puzzle)
+    m_puzzle.input_data = "1"
+    m_puzzle.examples = [mock.Mock(input_data="2")]
+    monkeypatch.setattr("aoc.main.get_puzzle_object", mock.Mock(return_value=m_puzzle))
+    return m_puzzle
+
+
+class TestSettingUpNewDay:
+    def test_setting_up_new_day_creates_directories_in_configured_places(
+        self, tmp_path: Path
+    ):
+        result = runner.invoke(
+            app,
+            [
+                "new-day",
+                "11",
+                "--data-directory",
+                str(tmp_path / "data"),
+                "--directory",
+                str(tmp_path / "src"),
+            ],
+        )
+        if result.exception:
+            raise result.exception
+        assert result.exit_code == 0, result.exc_info
+
+        assert (tmp_path / "data" / "11_input.txt").read_text() == "1"
+        assert (tmp_path / "data" / "11_test_input.txt").read_text() == "2"
+        assert (tmp_path / "src" / "day_11").exists()