Merge pull request #25

develop

Author: 56kyle

hooks/post_gen_project.py

@@ -8,9 +8,13 @@
 
 
 REMOVE_PATHS: list[str] = [
-    "{% if cookiecutter.platform_provider != github %}.github{% endif %}",
-    "{% if cookiecutter.platform_provider != gitlab %}.gitlab-ci.yml{% endif %}",
-    "{% if cookiecutter.platform_provider != bitbucket %}.bitbucket-pipelines.yml{% endif %}",
+    "{% if not cookiecutter.add_rust_extension %}rust{% endif %}",
+    "{% if not cookiecutter.add_rust_extension %}.github/workflows/lint-rust.yml{% endif %}",
+    "{% if not cookiecutter.add_rust_extension %}.github/workflows/build-rust.yml{% endif %}",
+    "{% if not cookiecutter.add_rust_extension %}.github/workflows/test-rust.yml{% endif %}",
+    "{% if cookiecutter.repository_provider != 'github' %}.github{% endif %}",
+    "{% if cookiecutter.repository_provider != 'gitlab' %}.gitlab-ci.yml{% endif %}",
+    "{% if cookiecutter.repository_provider != 'bitbucket' %}bitbucket-pipelines.yml{% endif %}",
 ]
 
 
@@ -50,7 +54,7 @@ def remove_undesired_files() -> None:
         if path.is_dir():
             shutil.rmtree(path, onerror=remove_readonly)
         else:
-            path.unlink()
+            path.unlink(missing_ok=True)
 
 
 def remove_readonly(func: Callable[[str], Any], path: str, _: Any) -> None:
@@ -63,4 +67,4 @@ def remove_readonly(func: Callable[[str], Any], path: str, _: Any) -> None:
 
 
 if __name__ == "__main__":
-    reindent_cookiecutter_json()
+    post_gen_project()

noxfile.py

@@ -122,7 +122,7 @@ def test(session: Session) -> None:
     session.run("pytest", "tests")
 
 
-@nox.parametrize(arg_names="add_rust_extension", arg_values_list=[False], ids=["no-rust"])
+@nox.parametrize(arg_names="add_rust_extension", arg_values_list=[False, True], ids=["no-rust", "rust"])
 @nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION, name="update-demo")
 def update_demo(session: Session, add_rust_extension: bool) -> None:
     session.log("Installing script dependencies for updating generated project demos...")

scripts/lint-from-demo.py

@@ -1,4 +1,3 @@
-import sys
 from pathlib import Path
 from typing import Annotated
 
@@ -9,6 +8,14 @@
 from util import git
 from util import FolderOption
 from util import in_new_demo
+from util import require_clean_and_up_to_date_repo
+
+
+# These still may need linted, but retrocookie shouldn't be used on them
+IGNORED_FILES: list[str] = [
+    "pyproject.toml",
+    "uv.lock",
+]
 
 
 cli: typer.Typer = typer.Typer()
@@ -21,20 +28,22 @@ def lint_from_demo(
     no_cache: Annotated[bool, typer.Option("--no-cache", "-n")] = False
 ) -> None:
     """Runs precommit in a generated project and matches the template to the results."""
-    try:
-        with in_new_demo(
-            demos_cache_folder=demos_cache_folder,
-            add_rust_extension=add_rust_extension,
-            no_cache=no_cache
-        ) as demo_path:
-            pre_commit.main.main(["run", "--all-files", "--hook-stage=manual", "--show-diff-on-failure"])
-        try:
-            retrocookie(instance_path=demo_path, commits=["HEAD"])
-        finally:
-            git("checkout", "HEAD", "--", "{{cookiecutter.project_name}}/pyproject.toml")
-    except Exception as error:
-        typer.secho(f"error: {error}", fg="red")
-        sys.exit(1)
+    with in_new_demo(
+        demos_cache_folder=demos_cache_folder,
+        add_rust_extension=add_rust_extension,
+        no_cache=no_cache
+    ) as demo_path:
+        require_clean_and_up_to_date_repo()
+        git("checkout", "develop")
+        git("branch", "-D", "temp/lint-from-demo", ignore_error=True)
+        git("checkout", "-b", "temp/lint-from-demo", "develop")
+        pre_commit.main.main(["run", "--all-files", "--show-diff-on-failure"])
+
+        for path in IGNORED_FILES:
+            git("checkout", "HEAD", "--", path)
+        git("add", ".")
+        git("commit", "-m", "meta: lint-from-demo", "--no-verify")
+    retrocookie(instance_path=demo_path, commits=["develop..temp/lint-from-demo"])
 
 
 if __name__ == '__main__':

scripts/update-demo.py

@@ -10,6 +10,7 @@
 from util import git
 from util import FolderOption
 from util import REPO_FOLDER
+from util import require_clean_and_up_to_date_repo
 
 
 cli: typer.Typer = typer.Typer()
@@ -26,7 +27,8 @@ def update_demo(
         demo_path: Path = demos_cache_folder / demo_name
         typer.secho(f"Updating demo project at {demo_path=}.", fg="yellow")
         with work_in(demo_path):
-            git("status", "--porcelain")
+            require_clean_and_up_to_date_repo()
+            git("checkout", "develop")
             cruft.update(
                 project_dir=demo_path,
                 template_path=REPO_FOLDER,

scripts/util.py

@@ -10,11 +10,13 @@
 from typing import Any
 from typing import Callable
 from typing import Generator
+from typing import Literal
+from typing import Optional
+from typing import overload
 
 import cruft
 import typer
 from cookiecutter.utils import work_in
-from pygments.lexers import q
 from typer.models import OptionInfo
 
 
@@ -35,12 +37,24 @@ def remove_readonly(func: Callable[[str], Any], path: str, _: Any) -> None:
     func(path)
 
 
-def run_command(command: str, *args: str) -> subprocess.CompletedProcess:
+@overload
+def run_command(command: str, *args: str, ignore_error: Literal[True]) -> Optional[subprocess.CompletedProcess]:
+    ...
+
+
+@overload
+def run_command(command: str, *args: str, ignore_error: Literal[False] = ...) -> subprocess.CompletedProcess:
+    ...
+
+
+def run_command(command: str, *args: str, ignore_error: bool = False) -> Optional[subprocess.CompletedProcess]:
     """Runs the provided command in a subprocess."""
     try:
         process = subprocess.run([command, *args], check=True, capture_output=True, text=True)
         return process
     except subprocess.CalledProcessError as error:
+        if ignore_error:
+            return None
         print(error.stdout, end="")
         print(error.stderr, end="", file=sys.stderr)
         raise
@@ -50,6 +64,28 @@ def run_command(command: str, *args: str) -> subprocess.CompletedProcess:
 uv: partial[subprocess.CompletedProcess] = partial(run_command, "uv")
 
 
+def require_clean_and_up_to_date_repo() -> None:
+    """Checks if the repo is clean and up to date with any important branches."""
+    git("fetch")
+    git("status", "--porcelain")
+    if not is_branch_synced_with_remote("develop"):
+        raise ValueError("develop is not synced with origin/develop")
+    if not is_branch_synced_with_remote("main"):
+        raise ValueError("main is not synced with origin/main")
+    if not is_ancestor("main", "develop"):
+        raise ValueError("main is not an ancestor of develop")
+
+
+def is_branch_synced_with_remote(branch: str) -> bool:
+    """Checks if the branch is synced with its remote."""
+    return is_ancestor(branch, f"origin/{branch}") and is_ancestor(f"origin/{branch}", branch)
+
+
+def is_ancestor(ancestor: str, descendent: str) -> bool:
+    """Checks if the branch is synced with its remote."""
+    return git("merge-base", "--is-ancestor", ancestor, descendent).returncode == 0
+
+
 @contextmanager
 def in_new_demo(
     demos_cache_folder: Path,

tests/conftest.py

@@ -3,6 +3,7 @@
 import subprocess
 from pathlib import Path
 from typing import Any
+from typing import Literal
 
 import pytest
 import toml
@@ -84,10 +85,15 @@ def robust_demo__name(robust_demo__add_rust_extension: str, robust_demo__is_setu
 
 
 @pytest.fixture(scope="session")
-def robust_demo__extra_context(robust_demo__name: str, robust_demo__add_rust_extension: bool) -> dict[str, Any]:
+def robust_demo__extra_context(
+    robust_demo__name: str,
+    robust_demo__add_rust_extension: bool,
+    robust_demo__repository_provider: Literal["github", "gitlab", "bitbucket"]
+) -> dict[str, Any]:
     return {
         "project_name": robust_demo__name,
-        "add_rust_extension": robust_demo__add_rust_extension
+        "add_rust_extension": robust_demo__add_rust_extension,
+        "repository_provider": robust_demo__repository_provider,
     }
 
 
@@ -96,6 +102,11 @@ def robust_demo__add_rust_extension(request: FixtureRequest) -> bool:
     return getattr(request, "param", False)
 
 
+@pytest.fixture(scope="session")
+def robust_demo__repository_provider(request: FixtureRequest) -> Literal["github", "gitlab", "bitbucket"]:
+    return getattr(request, "param", "github")
+
+
 @pytest.fixture(scope="session")
 def robust_demo__is_setup(request: FixtureRequest) -> bool:
     return getattr(request, "param", True)

tests/unit_tests/test_post_gen_hook.py

@@ -0,0 +1,70 @@
+from pathlib import Path
+
+import pytest
+
+
+@pytest.mark.parametrize(
+    argnames="removed_relative_path",
+    argvalues=[".gitlab-ci.yml", "bitbucket-pipelines.yml"]
+)
+@pytest.mark.parametrize(
+    argnames="robust_demo__repository_provider",
+    argvalues=["github"],
+    indirect=True
+)
+def test_files_removed_for_github(robust_demo: Path, removed_relative_path: str) -> None:
+    path: Path = robust_demo / removed_relative_path
+    assert not path.exists()
+
+
+@pytest.mark.parametrize(
+    argnames="removed_relative_path",
+    argvalues=[".github", "bitbucket-pipelines.yml"]
+)
+@pytest.mark.parametrize(
+    argnames="robust_demo__repository_provider",
+    argvalues=["gitlab"],
+    indirect=True
+)
+def test_files_removed_for_gitlab(robust_demo: Path, removed_relative_path: str) -> None:
+    path: Path = robust_demo / removed_relative_path
+    assert not path.exists()
+
+
+@pytest.mark.parametrize(
+    argnames="removed_relative_path",
+    argvalues=[".github", ".gitlab-ci.yml"]
+)
+@pytest.mark.parametrize(
+    argnames="robust_demo__repository_provider",
+    argvalues=["bitbucket"],
+    indirect=True
+)
+def test_files_removed_for_bitbucket(robust_demo: Path, removed_relative_path: str) -> None:
+    path: Path = robust_demo / removed_relative_path
+    assert not path.exists()
+
+
+@pytest.mark.parametrize(
+    argnames="removed_relative_path",
+    argvalues=[
+        "rust",
+        ".github/workflows/lint-rust.yml",
+        ".github/workflows/build-rust.yml",
+        ".github/workflows/test-rust.yml"
+    ]
+)
+@pytest.mark.parametrize(
+    argnames="robust_demo__add_rust_extension",
+    argvalues=[False],
+    indirect=True,
+    ids=["no-rust"]
+)
+@pytest.mark.parametrize(
+    argnames="robust_demo__repository_provider",
+    argvalues=["github"],
+    indirect=True,
+)
+def test_files_removed_for_no_rust_extension(robust_demo: Path, removed_relative_path: str) -> None:
+    path: Path = robust_demo / removed_relative_path
+    assert not path.exists()

{{cookiecutter.project_name}}/.github/workflows/build-docs.yml

@@ -11,8 +11,8 @@ on:
       - "noxfile.py"
       - "pyproject.toml"
       - ".github/workflows/build-docs.yml"
-      - ".ruff.toml"  # Affects docstrings via linting
-      - "pyrightconfig.json"  # Affects type hints in docs
+      - ".ruff.toml" # Affects docstrings via linting
+      - "pyrightconfig.json" # Affects type hints in docs
 
   push:
     branches:

…ion == 'y' %} lint-rust.yml {%- endif %} …t_name}}/.github/workflows/lint-rust.yml{{cookiecutter.project_name}}/.github/workflows/{% if cookiecutter.add_rust_extension == 'y' %} lint-rust.yml {%- endif %} renamed to {{cookiecutter.project_name}}/.github/workflows/lint-rust.yml {{cookiecutter.project_name}}/.github/workflows/{% if cookiecutter.add_rust_extension == 'y' %} lint-rust.yml {%- endif %} renamed to {{cookiecutter.project_name}}/.github/workflows/lint-rust.yml

@@ -1,4 +1,3 @@
-
 name: Lint Rust Code
 
 on:

{{cookiecutter.project_name}}/.github/workflows/release-python.yml

@@ -33,7 +33,6 @@ jobs:
         id: current_version
         run: echo "CURRENT_VERSION=v$(uvx --from commitizen cz version -p)" >> $GITHUB_OUTPUT
 
-
   build_and_testpypi:
     name: Build & Publish to TestPyPI
     runs-on: ubuntu-latest