feat: note rules not followed in ruff description

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

src/sp_repo_review/families.py

@@ -1,7 +1,11 @@
 from __future__ import annotations
 
 import typing
-from typing import Any
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
 
 __all__ = ["Family", "get_families"]
 
@@ -16,23 +20,74 @@ class Family(typing.TypedDict, total=False):
     description: str  # Defaults to empty
 
 
-def get_families(pyproject: dict[str, Any]) -> dict[str, Family]:
-    pyproject_description = f"- Detected build backend: `{pyproject.get('build-system', {}).get('build-backend', 'MISSING')}`"
-    if isinstance(license := pyproject.get("project", {}).get("license", {}), str):
-        pyproject_description += f"\n- SPDX license expression: `{license}`"
-    elif classifiers := pyproject.get("project", {}).get("classifiers", []):
-        licenses = [
-            c.removeprefix("License :: ").removeprefix("OSI Approved :: ")
-            for c in classifiers
-            if c.startswith("License :: ")
-        ]
-        if licenses:
-            pyproject_description += f"\n- Detected license(s): {', '.join(licenses)}"
+def general_description(pyproject: dict[str, Any]) -> Generator[str, None, None]:
+    yield f"- Detected build backend: `{pyproject.get('build-system', {}).get('build-backend', 'MISSING')}`"
+    match pyproject:
+        case {"project": {"license": str() as license}}:
+            yield f"- SPDX license expression: `{license}`"
+        case {"project": {"classifiers": classifiers}}:
+            licenses = [
+                c.removeprefix("License :: ").removeprefix("OSI Approved :: ")
+                for c in classifiers
+                if c.startswith("License :: ")
+            ]
+            if licenses:
+                yield f"- Detected license(s): {', '.join(licenses)}"
+
+
+def ruff_description(ruff: dict[str, Any]) -> str:
+    common = {
+        "ARG",
+        "B",
+        "C4",
+        "DTZ",
+        "EM",
+        "EXE",
+        "FA",
+        "FURB",
+        "G",
+        "I",
+        "ICN",
+        "NPY",
+        "PD",
+        "PERF",
+        "PGH",
+        "PIE",
+        "PL",
+        "PT",
+        "PTH",
+        "PYI",
+        "RET",
+        "RUF",
+        "SIM",
+        "SLOT",
+        "T20",
+        "TC",
+        "UP",
+        "YTT",
+    }
+
+    match ruff:
+        case (
+            {"lint": {"select": x} | {"extend-select": x}}
+            | {"select": x}
+            | {"extend-select": x}
+        ):
+            selected = set(x)
+            known = common - selected
+            if not known or "ALL" in selected:
+                return "All mentioned rules selected"
+            rulelist = ", ".join(f'"{r}"' for r in known)
+            return f"Rules mentioned in guide but not here: `{rulelist}`"
+    return ""
+
+
+def get_families(pyproject: dict[str, Any], ruff: dict[str, Any]) -> dict[str, Family]:
     return {
         "general": Family(
             name="General",
             order=-3,
-            description=pyproject_description,
+            description="\n".join(general_description(pyproject)),
         ),
         "pyproject": Family(
             name="PyProject",
@@ -49,6 +104,7 @@ def get_families(pyproject: dict[str, Any]) -> dict[str, Family]:
         ),
         "ruff": Family(
             name="Ruff",
+            description=ruff_description(ruff),
         ),
         "docs": Family(
             name="Documentation",

tests/test_families.py

@@ -8,7 +8,7 @@ def test_backend():
             "build-backend": "setuptools.build_meta",
         },
     }
-    families = get_families(pyproject)
+    families = get_families(pyproject, {})
     assert families["general"].get("description") == (
         "- Detected build backend: `setuptools.build_meta`"
     )
@@ -24,7 +24,7 @@ def test_spdx_license():
             ],
         },
     }
-    families = get_families(pyproject)
+    families = get_families(pyproject, {})
     assert families["general"].get("description") == (
         "- Detected build backend: `MISSING`\n- SPDX license expression: `MIT`"
     )
@@ -40,7 +40,7 @@ def test_classic_license():
             ],
         },
     }
-    families = get_families(pyproject)
+    families = get_families(pyproject, {})
     assert families["general"].get("description") == (
         "- Detected build backend: `MISSING`\n"
         "- Detected license(s): MIT License, BSD License"