crapkit 0.4.3__tar.gz → 0.4.4__tar.gz

{crapkit-0.4.3/src/crapkit.egg-info → crapkit-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crapkit
-Version: 0.4.3
+Version: 0.4.4
 Summary: Scores every function on complexity times uncovered risk, ranks the worst, and blocks commits that add more.
 Author: Jean-Francois Gagne
 License: MIT
@@ -29,6 +29,8 @@ Provides-Extra: dev
 Requires-Dist: pytest>=8; extra == "dev"
 Requires-Dist: pytest-cov>=5; extra == "dev"
 Requires-Dist: pytest-xdist>=3; extra == "dev"
+Provides-Extra: py
+Requires-Dist: pytest-cov>=5; extra == "py"
 Dynamic: license-file
 
 # crapkit
@@ -93,7 +95,10 @@ the repo can get better and never worse while you burn it down.
 out to your own test runner, and the runner needs its coverage package installed:
 `pytest-cov` for pytest, `@vitest/coverage-v8` (pinned to your vitest major) for vitest.
 Without it the lane produces no artifact and `coverage` exits 5 quoting the runner's own
-error. The two quickstarts below walk a real repo end to end.
+error. For pytest, `init` probes the python its lane will run and prints the install
+command when `pytest_cov` is missing; `pip install 'crapkit[py]'` pulls the plugin
+alongside crapkit when the two share a venv. The two quickstarts below walk a real repo
+end to end.
 
 ## Install
 
@@ -116,7 +121,7 @@ changing crapkit.
 
 ```
 $ crapkit --version
-crapkit 0.4.3
+crapkit 0.4.4
 ```
 
 `python -m crapkit` works identically to the console script and is what to use from a
@@ -263,7 +268,7 @@ crapkit ships a `.pre-commit-hooks.yaml` declaring `id: crapkit-gate`. In your
 repos:
   - repo: https://github.com/JeanFrancoisGagne/crapkit
     # crapkit's release step rewrites this line to the tag it just cut
-    rev: v0.4.3
+    rev: v0.4.4
     hooks:
       - id: crapkit-gate
 ```
@@ -505,6 +510,10 @@ writes runs `pytest --cov` and those flags come from `pytest-cov`:
 pip install pytest-cov
 ```
 
+(or `pip install 'crapkit[py]'` to pull both at once, when crapkit lives in the same venv
+as the suite — skip it and `init` prints this same fix when its probe finds the plugin
+missing).
+
 ### 1. Scaffold the config
 
 ```

{crapkit-0.4.3 → crapkit-0.4.4}/README.md

@@ -60,7 +60,10 @@ the repo can get better and never worse while you burn it down.
 out to your own test runner, and the runner needs its coverage package installed:
 `pytest-cov` for pytest, `@vitest/coverage-v8` (pinned to your vitest major) for vitest.
 Without it the lane produces no artifact and `coverage` exits 5 quoting the runner's own
-error. The two quickstarts below walk a real repo end to end.
+error. For pytest, `init` probes the python its lane will run and prints the install
+command when `pytest_cov` is missing; `pip install 'crapkit[py]'` pulls the plugin
+alongside crapkit when the two share a venv. The two quickstarts below walk a real repo
+end to end.
 
 ## Install
 
@@ -83,7 +86,7 @@ changing crapkit.
 
 ```
 $ crapkit --version
-crapkit 0.4.3
+crapkit 0.4.4
 ```
 
 `python -m crapkit` works identically to the console script and is what to use from a
@@ -230,7 +233,7 @@ crapkit ships a `.pre-commit-hooks.yaml` declaring `id: crapkit-gate`. In your
 repos:
   - repo: https://github.com/JeanFrancoisGagne/crapkit
     # crapkit's release step rewrites this line to the tag it just cut
-    rev: v0.4.3
+    rev: v0.4.4
     hooks:
       - id: crapkit-gate
 ```
@@ -472,6 +475,10 @@ writes runs `pytest --cov` and those flags come from `pytest-cov`:
 pip install pytest-cov
 ```
 
+(or `pip install 'crapkit[py]'` to pull both at once, when crapkit lives in the same venv
+as the suite — skip it and `init` prints this same fix when its probe finds the plugin
+missing).
+
 ### 1. Scaffold the config
 
 ```

{crapkit-0.4.3 → crapkit-0.4.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "crapkit"
-version = "0.4.3"
+version = "0.4.4"
 description = "Scores every function on complexity times uncovered risk, ranks the worst, and blocks commits that add more."
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { text = "MIT" }
@@ -53,6 +53,11 @@ Source = "https://github.com/JeanFrancoisGagne/crapkit"
 # without it. Left out of this list it took down 31 e2e tests on every one of
 # the six CI test jobs (run 33225190806), ubuntu and windows alike.
 dev = ["pytest>=8", "pytest-cov>=5", "pytest-xdist>=3"]
+# The py lane's runtime half, for installs that share the suite's venv: the
+# lane init writes runs `pytest --cov`, and those flags come from pytest-cov.
+# An install elsewhere (pipx, uv tool) still needs pytest-cov beside the SUITE;
+# init probes for that and prints the fix.
+py = ["pytest-cov>=5"]
 
 [project.scripts]
 crapkit = "crapkit.cli:main"

{crapkit-0.4.3 → crapkit-0.4.4}/src/crapkit/__init__.py

@@ -1,2 +1,2 @@
 """crapkit: deterministic CRAP-score framework."""
-__version__ = "0.4.3"
+__version__ = "0.4.4"

{crapkit-0.4.3 → crapkit-0.4.4}/src/crapkit/churn_cache.py

@@ -5,10 +5,12 @@ git diffing every commit's tree, and worklist, next-item and coupling each paid
 it in full on every invocation, at an unmoved HEAD. Every one of them reaches
 git through this module, so `.crapkit/churn-cache.json` has exactly one writer.
 
-The key is (HEAD sha, window months, UTC date). The sha pins the history; the
-window pins the command; the date is there because `--since=N months ago` is
-evaluated against the wall clock, so yesterday's cache describes a window one
-day wider than today's. Anything else is a miss, and a miss rebuilds.
+The key is (HEAD sha, window months, UTC date, path format). The sha pins the
+history; the window pins the command; the date is there because `--since=N
+months ago` is evaluated against the wall clock, so yesterday's cache describes
+a window one day wider than today's; the format marker retires maps whose
+paths predate `git log --relative`. Anything else is a miss, and a miss
+rebuilds.
 
 A cache is disposable: unreadable, corrupt or unkeyable content reads as cold,
 never as a crash. Uncommitted work is invisible to churn either way. The one
@@ -23,7 +25,7 @@ from datetime import datetime, timezone
 from pathlib import Path
 
 from .churn import FileChurn, parse_git_log_lines
-from .churn_log import has_cache, log_lines
+from .churn_log import RELATIVE_PATHS, has_cache, log_lines
 from .errors import GitError
 from .gitio import churn_log_lines, head_commit
 
@@ -64,7 +66,10 @@ def _cache_key(root: Path, months: int) -> dict | None:
         head = head_commit(root)
     except GitError:
         return None
-    return {"head": head, "months": months, "date": _utc_date()}
+    # `paths` marks the format, not a question: maps built before --relative
+    # hold top-relative paths in a subdirectory root, and must read as cold.
+    return {"head": head, "months": months, "date": _utc_date(),
+            "paths": RELATIVE_PATHS}
 
 
 def _read_cache(path: Path, key: dict | None) -> dict[str, FileChurn] | None:

{crapkit-0.4.3 → crapkit-0.4.4}/src/crapkit/churn_log.py

@@ -42,6 +42,11 @@ from .gitio import _git_lines, head_commit, is_ancestor
 LOG_NAME = "churn-log.z"
 LOG_FORMAT = "--format=%x01%an%x02%at%x02%ct"
 CHUNK = 1 << 20
+# The key's format marker: these logs hold root-relative paths (--relative),
+# the only kind that joins against ls-files rows when the root sits below the
+# repo top. A key without it names a top-relative log, and that one is cold —
+# served OR refreshed, it would feed every consumer paths that match nothing.
+RELATIVE_PATHS = "root-relative"
 
 
 def log_lines(root: Path, months: int) -> Iterator[str]:
@@ -103,7 +108,8 @@ def _cache_key(root: Path, months: int) -> dict | None:
         head = head_commit(root)
     except GitError:
         return None
-    return {"head": head, "months": months, "date": _utc_date()}
+    return {"head": head, "months": months, "date": _utc_date(),
+            "paths": RELATIVE_PATHS}
 
 
 def _key_path(path: Path) -> Path:
@@ -119,7 +125,7 @@ def _read_key(path: Path) -> dict | None:
 
 
 def _key_fields(doc: dict) -> dict:
-    return {field: doc.get(field) for field in ("head", "months", "date")}
+    return {field: doc.get(field) for field in ("head", "months", "date", "paths")}
 
 
 def _cached(path: Path, key: dict | None) -> Iterator[str] | None:
@@ -173,9 +179,12 @@ def _refreshed(root: Path, months: int, path: Path, key: dict | None) -> Iterato
 
 
 def _refreshable(root: Path, stored: dict | None, key: dict) -> bool:
-    """True only for a cached log this HEAD grew from: same window, and behind us."""
+    """True only for a cached log this HEAD grew from: same window, same path
+    format, and behind us."""
     if stored is None or stored.get("months") != key["months"]:
         return False
+    if stored.get("paths") != key["paths"]:
+        return False  # a top-relative log: prepending would stack fresh commits on wrong paths
     if stored.get("head") == key["head"]:
         return True
     return is_ancestor(root, str(stored.get("head")), key["head"])
@@ -262,13 +271,16 @@ def _keep(part: BinaryIO, path: Path, key: dict | None) -> None:
 
 
 def _window_log(root: Path, months: int) -> Iterator[str]:
-    """The whole window, from git. The expensive one."""
-    return _git_lines(root, "log", f"--since={months} months ago", LOG_FORMAT, "--name-only")
+    """The whole window, from git. The expensive one. --relative for the same
+    reason gitio.churn_log_lines carries it: consumers join these paths against
+    root-relative rows, and a root below the repo top matched nothing without it."""
+    return _git_lines(root, "log", "--relative", f"--since={months} months ago",
+                      LOG_FORMAT, "--name-only")
 
 
 def _range_log(root: Path, base: str, head: str) -> Iterator[str]:
     """Only what HEAD added on top of the cached log."""
-    return _git_lines(root, "log", f"{base}..{head}", LOG_FORMAT, "--name-only")
+    return _git_lines(root, "log", "--relative", f"{base}..{head}", LOG_FORMAT, "--name-only")
 
 
 def _window_cutoff(root: Path, months: int) -> int | None:

{crapkit-0.4.3 → crapkit-0.4.4}/src/crapkit/cli/__init__.py

@@ -204,6 +204,7 @@ _OWNER = {
     "_prune_renames": "ratchet_cmds",
     "_pruned": "ratchet_cmds",
     "_pushdown_floor": "queue",
+    "_pytest_cov_probe": "admin",
     "_range_lines": "analyses",
     "_rankable": "queue",
     "_ratchet_entries": "_shared",
@@ -287,6 +288,7 @@ _OWNER = {
     "_version_line": "parser",
     "_version_report": "admin",
     "_warn_diff_uncovered": "verifying",
+    "_warn_missing_pytest_cov": "admin",
     "_warn_suite_shrink": "verifying",
     "_warn_untracked": "scoring",
     "_watch_banner": "admin",

{crapkit-0.4.3 → crapkit-0.4.4}/src/crapkit/cli/admin.py

@@ -6,12 +6,13 @@ what moved)."""
 from __future__ import annotations
 
 import argparse
+import os
 import sys
 from dataclasses import dataclass, field
 from pathlib import Path
 
 from .. import __version__
-from ..config import load_config_text
+from ..config import load_config_text, shell_words
 from ..doctor import Finding
 from ..errors import ConfigError, ToolError
 from ..gitio import ls_files
@@ -82,6 +83,51 @@ def _no_scopes_reason(root: Path) -> str:
             f"run `git add` first ({len(untracked)} untracked source file(s) found)")
 
 
+def _pytest_cov_probe(command: str) -> bool:
+    """Can the interpreter this lane names import pytest_cov? The probe runs
+    through the same shell as the lane, so a bare `python` resolves to the one
+    the lane will get (a .bat shim included), not the one CreateProcess finds.
+    True too when the probe cannot run — only a clean "no" earns the warning,
+    and a missing interpreter is doctor's finding, not this one's."""
+    import shutil
+    import subprocess
+
+    words = shell_words(command)
+    if not words or shutil.which(words[0]) is None:
+        return True
+    probe = f'{_shell_quote(words[0])} -c "import pytest_cov"'
+    try:
+        return subprocess.run(probe, shell=True, capture_output=True,
+                              timeout=15).returncode == 0
+    except (OSError, subprocess.TimeoutExpired):
+        return True
+
+
+def _shell_quote(word: str) -> str:
+    """One word, quoted for the shell the lane runs under."""
+    import shlex
+
+    if os.name != "nt":
+        return shlex.quote(word)
+    return f'"{word}"' if " " in word else word
+
+
+def _warn_missing_pytest_cov(lanes: tuple) -> None:
+    """The first-run trap, caught where it starts. The py lane shells out to
+    `pytest --cov`, and the --cov flags come from pytest-cov — a package of the
+    REPO's interpreter, so a crapkit dependency could only ever cover installs
+    sharing the suite's venv. Probe the python the lane will actually run and
+    say the fix now, instead of `coverage` exiting 5 with a lane log the first
+    run has to decode."""
+    for lane in lanes:
+        if lane.parser == "coveragepy" and "--cov" in lane.command \
+                and not _pytest_cov_probe(lane.command):
+            print(f"note: lane {lane.name!r} runs `pytest --cov`, and this python cannot "
+                  "import pytest_cov — pip install pytest-cov where the suite runs "
+                  "(pip install 'crapkit[py]' when that is crapkit's own environment), "
+                  "then `crapkit coverage`", file=sys.stderr)
+
+
 def _extend_gitignore(root: Path, lanes: tuple) -> None:
     """Ignore what adopting crapkit will write: the store, and each lane's
     artifact. Without this the consumer's next `git status` is a wall of
@@ -115,6 +161,7 @@ def cmd_init(args: argparse.Namespace) -> int:
     load_config_text(text)  # self-check: never write a config crapkit cannot read back
     toml_path.write_text(text, encoding="utf-8", newline="\n")
     _print_init_summary(scopes, lanes)
+    _warn_missing_pytest_cov(live_lanes(lanes, scopes))
     _extend_gitignore(root, live_lanes(lanes, scopes))
     return 0
 

{crapkit-0.4.3 → crapkit-0.4.4}/src/crapkit/config.py

@@ -1,6 +1,8 @@
 """crapkit.toml parsing. Pure: text in, Config out; every rejection is a ConfigError (exit 3)."""
 from __future__ import annotations
 
+import os
+import shlex
 import tomllib
 from typing import NamedTuple
 
@@ -62,6 +64,49 @@ _PYTEST_VALUE_FLAGS = frozenset({
 })
 
 
+# Lane commands run under shell=True: sh on POSIX, cmd.exe on Windows. The two
+# read a command line differently, and the guard has to read it like the one
+# that will run it, or it accepts a lane cmd.exe breaks and refuses one it runs.
+SHELL_IS_CMD = os.name == "nt"
+
+
+def shell_words(command: str, cmd: bool | None = None) -> list[str]:
+    """The words the shell hands the runner. `-m "not live and not perf"` is one
+    argument there and must be one token here — a whitespace split reads four
+    positionals into it. A command the shell would refuse (an unbalanced quote)
+    gets the whitespace read instead: a rough lint beats a crash at config load."""
+    cmd = SHELL_IS_CMD if cmd is None else cmd
+    try:
+        return _cmd_words(command) if cmd else shlex.split(command)
+    except ValueError:
+        return command.split()
+
+
+def _cmd_words(command: str) -> list[str]:
+    """cmd.exe's reading: a double-quoted phrase is one word and loses its
+    quotes; a single quote is an ordinary character, so `'not live'` is two
+    words; a backslash separates path components and escapes nothing."""
+    lexer = shlex.shlex(command, posix=False)
+    lexer.whitespace_split = True
+    lexer.quotes = '"'
+    lexer.commenters = ""
+    return [_strip_double_quotes(word) for word in lexer]
+
+
+def _strip_double_quotes(word: str) -> str:
+    if len(word) >= 2 and word[0] == word[-1] == '"':
+        return word[1:-1]
+    return word
+
+
+def _quote_hint(command: str) -> str:
+    """The usual reason a Windows lane trips the guard: a value in single
+    quotes, which cmd.exe hands the runner one word per space."""
+    if SHELL_IS_CMD and "'" in command:
+        return " (cmd.exe does not treat ' as a quote: write the value in double quotes)"
+    return ""
+
+
 def _looks_like_a_test_path(tok: str) -> bool:
     """The shapes a pytest positional actually takes: a path or a node id."""
     return "/" in tok or "\\" in tok or "::" in tok or tok.endswith(".py")
@@ -105,14 +150,14 @@ def _validate_coveragepy_command(name: str, command: str) -> None:
     # Subset coverage under a suite with cross-file pollution is run-order-dependent;
     # a full-suite lane refuses positional narrowing. Scoped suites opt out with
     # full_suite = false, an explicit and reviewable decision.
-    tokens = command.split()
+    tokens = shell_words(command)
     if "pytest" not in " ".join(tokens):
         return
     for tok in _narrowing_arguments(_tokens_after_pytest(tokens)):
         raise ConfigError(
-            f"lane {name!r}: positional argument {tok!r} narrows a full-suite coverage run; "
+            f"lane {name!r}: positional argument '{tok}' narrows a full-suite coverage run; "
             f"drop it, attach it to the flag it belongs to (-n8, --numprocesses=8), "
-            f"or set full_suite = false deliberately")
+            f"or set full_suite = false deliberately{_quote_hint(command)}")
 
 
 def _asks_for_coverage(tokens: list[str]) -> bool:
@@ -131,8 +176,11 @@ def _first_filter_position(tokens: list[str]) -> int:
 # a filter here has to end in a source suffix already, so guessing that an unknown
 # flag swallows one would retire the check instead of sharpening it.
 _VITEST_VALUE_FLAGS = frozenset({
-    "-c", "--config", "--dir", "--environment", "--exclude", "--outputFile",
-    "--pool", "--project", "--reporter", "--root", "--shard",
+    "-c", "-t", "--config", "--coverage.exclude", "--coverage.include",
+    "--coverage.provider", "--coverage.reporter", "--coverage.reportsDirectory",
+    "--dir", "--environment", "--exclude", "--globalSetup", "--outputFile",
+    "--pool", "--project", "--reporter", "--root", "--setupFiles", "--shard",
+    "--testNamePattern",
 })
 
 
@@ -148,13 +196,13 @@ def _validate_istanbul_command(name: str, command: str) -> None:
     # The measured vitest trap: any file filter passed beside --coverage silently
     # narrows the coverage include set. A lane command is fixed configuration, so
     # the combination is a config error, not a runtime surprise.
-    tokens = command.split()
+    tokens = shell_words(command)
     if not _asks_for_coverage(tokens):
         return
     for i in range(_first_filter_position(tokens), len(tokens)):
         if _is_file_filter(tokens[i], tokens[i - 1]):
             raise ConfigError(
-                f"lane {name!r}: file filter {tokens[i]!r} combined with --coverage silently narrows "
+                f"lane {name!r}: file filter '{tokens[i]}' combined with --coverage silently narrows "
                 f"the coverage include set; drop the filter or use a dedicated config")
 
 

{crapkit-0.4.3 → crapkit-0.4.4}/src/crapkit/gitio.py

@@ -338,8 +338,14 @@ def file_log_patches(root: Path, rel_path: str) -> list[tuple[int, str]]:
 
 def churn_log_lines(root: Path, months: int) -> Iterator[str]:
     """The churn window's log, streamed. On a big repo this is 21 MB of text and
-    the single most expensive call crapkit makes, so it is never held whole."""
-    return _git_lines(root, "log", f"--since={months} months ago",
+    the single most expensive call crapkit makes, so it is never held whole.
+
+    --relative, because every consumer joins these paths against root-relative
+    ls-files rows: log --name-only answers relative to the repo top, so a root
+    one directory down (a monorepo member, a project nested in a worktree)
+    read every scored file as zero-churn. At the top the flag changes nothing.
+    """
+    return _git_lines(root, "log", "--relative", f"--since={months} months ago",
                       "--format=%x01%an%x02%at", "--name-only")
 
 

{crapkit-0.4.3 → crapkit-0.4.4/src/crapkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crapkit
-Version: 0.4.3
+Version: 0.4.4
 Summary: Scores every function on complexity times uncovered risk, ranks the worst, and blocks commits that add more.
 Author: Jean-Francois Gagne
 License: MIT
@@ -29,6 +29,8 @@ Provides-Extra: dev
 Requires-Dist: pytest>=8; extra == "dev"
 Requires-Dist: pytest-cov>=5; extra == "dev"
 Requires-Dist: pytest-xdist>=3; extra == "dev"
+Provides-Extra: py
+Requires-Dist: pytest-cov>=5; extra == "py"
 Dynamic: license-file
 
 # crapkit
@@ -93,7 +95,10 @@ the repo can get better and never worse while you burn it down.
 out to your own test runner, and the runner needs its coverage package installed:
 `pytest-cov` for pytest, `@vitest/coverage-v8` (pinned to your vitest major) for vitest.
 Without it the lane produces no artifact and `coverage` exits 5 quoting the runner's own
-error. The two quickstarts below walk a real repo end to end.
+error. For pytest, `init` probes the python its lane will run and prints the install
+command when `pytest_cov` is missing; `pip install 'crapkit[py]'` pulls the plugin
+alongside crapkit when the two share a venv. The two quickstarts below walk a real repo
+end to end.
 
 ## Install
 
@@ -116,7 +121,7 @@ changing crapkit.
 
 ```
 $ crapkit --version
-crapkit 0.4.3
+crapkit 0.4.4
 ```
 
 `python -m crapkit` works identically to the console script and is what to use from a
@@ -263,7 +268,7 @@ crapkit ships a `.pre-commit-hooks.yaml` declaring `id: crapkit-gate`. In your
 repos:
   - repo: https://github.com/JeanFrancoisGagne/crapkit
     # crapkit's release step rewrites this line to the tag it just cut
-    rev: v0.4.3
+    rev: v0.4.4
     hooks:
       - id: crapkit-gate
 ```
@@ -505,6 +510,10 @@ writes runs `pytest --cov` and those flags come from `pytest-cov`:
 pip install pytest-cov
 ```
 
+(or `pip install 'crapkit[py]'` to pull both at once, when crapkit lives in the same venv
+as the suite — skip it and `init` prints this same fix when its probe finds the plugin
+missing).
+
 ### 1. Scaffold the config
 
 ```

{crapkit-0.4.3 → crapkit-0.4.4}/src/crapkit.egg-info/requires.txt

@@ -4,3 +4,6 @@ lizard>=1.24.0
 pytest>=8
 pytest-cov>=5
 pytest-xdist>=3
+
+[py]
+pytest-cov>=5