gitmole 0.6.3__tar.gz → 0.6.4__tar.gz

{gitmole-0.6.3 → gitmole-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitmole
-Version: 0.6.3
+Version: 0.6.4
 Summary: Offline git repository analysis with a terminal report: hotspots, coupling, ownership, code age, secrets, repo health.
 License: MIT
 Project-URL: Homepage, https://github.com/antvinni/gitmole

{gitmole-0.6.3 → gitmole-0.6.4}/gitmole/__init__.py

@@ -1,3 +1,3 @@
 """gitmole: offline git repository analysis with a terminal report."""
 
-__version__ = "0.6.3"
+__version__ = "0.6.4"

gitmole-0.6.4/gitmole/coupling.py

@@ -0,0 +1,55 @@
+"""Change-coupling pairs grouped into clusters: a directory whose files all change together (generated
+tables, one-per-version data files) is one fact, not a page of pairs."""
+from __future__ import annotations
+
+import os
+from collections import defaultdict
+
+ROOT = "(root files)"
+
+
+def _dir(path: str) -> str:
+    head = os.path.dirname(path)
+    return head + "/" if head else ROOT
+
+
+def _components(pairs: list) -> list:
+    """Connected groups of files among `pairs` (union-find), each as the list of its pairs."""
+    parent = {}
+
+    def find(x):
+        parent.setdefault(x, x)
+        while parent[x] != x:
+            parent[x] = parent[parent[x]]
+            x = parent[x]
+        return x
+
+    for p in pairs:
+        parent[find(p["entity"])] = find(p["coupled"])
+    groups = defaultdict(list)
+    for p in pairs:
+        groups[find(p["entity"])].append(p)
+    return list(groups.values())
+
+
+def clusters(pairs: list, min_files: int = 4) -> tuple:
+    """Split `pairs` into (groups, rest). Pairs whose two files share a directory are gathered per
+    directory and then into connected groups; a group touching at least `min_files` distinct files
+    becomes one cluster with the file and pair counts, the weakest degree and the mean of the pairs'
+    average revisions. Every other pair comes back unchanged, in its original order. Two unrelated
+    pairs in one directory are not a cluster. Clusters are largest first."""
+    by_dir = defaultdict(list)
+    for p in pairs:
+        if _dir(p["entity"]) == _dir(p["coupled"]):
+            by_dir[_dir(p["entity"])].append(p)
+    groups, taken = [], set()
+    for directory, ps in by_dir.items():
+        for component in _components(ps):
+            files = {p["entity"] for p in component} | {p["coupled"] for p in component}
+            if len(files) < min_files:
+                continue
+            groups.append({"dir": directory, "files": len(files), "pairs": len(component), "degree": min(p["degree"] for p in component),
+                           "average-revs": round(sum(p["average-revs"] for p in component) / len(component))})
+            taken.update(id(p) for p in component)
+    groups.sort(key=lambda g: (-g["files"], -g["degree"], g["dir"]))
+    return groups, [p for p in pairs if id(p) not in taken]

{gitmole-0.6.3 → gitmole-0.6.4}/gitmole/filetypes.py

@@ -65,6 +65,24 @@ def is_doc_path(path: str) -> bool:
     return bool(_DOC_PATH.search(path))
 
 
+_SAMPLE_PATH = re.compile(r"(^|/)(examples?|samples?|fixtures?|testdata|demos?|rules)(/|$)", re.I)
+
+
+def is_sample_path(path: str) -> bool:
+    """Example, sample, fixture, demo and rule directories: a value there is a specimen (a language
+    sample, a scanner's own rule definitions), not a credential in use."""
+    return bool(_SAMPLE_PATH.search(path))
+
+
+_VENDOR_PATH = re.compile(r"(^|/)(_?vendor|node_modules|third_?party|external)(/|$)", re.I)
+
+
+def is_vendor_path(path: str) -> bool:
+    """Vendored and third-party trees: somebody else's code, so its complexity and its single
+    importer are not this repository's risk."""
+    return bool(_VENDOR_PATH.search(path))
+
+
 def key(path: str) -> str:
     """The lowercased extension, or the whole lowercased name when there is none."""
     name = path.rsplit("/", 1)[-1].lower()

{gitmole-0.6.3 → gitmole-0.6.4}/gitmole/findings.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 
 import re
 
-from . import filetypes, hotspots, knowledge, leaks, loss, textfmt, trend
+from . import coupling, filetypes, hotspots, knowledge, leaks, loss, textfmt, trend
 
 SEVERITIES = ["critical", "warning", "info"]
 
@@ -40,13 +40,14 @@ def _secret_statement(groups: list) -> str:
 
 def secrets_found(report: dict) -> list:
     """Secrets grouped by value. A value anywhere in source is critical; one that only ever appears in
-    test files (fixtures, saved pages) or documentation (templates, samples) is a warning, so a
-    critical gate does not trip on test data or a planning document. Version strings, template markers
-    and key blocks without key material were flagged as placeholders and are not a finding."""
+    test files (fixtures, saved pages), example or rule directories (language samples, a scanner's own
+    rules) or documentation (templates) is a warning, so a critical gate does not trip on test data or a
+    planning document. Version strings, template markers and key blocks without key material were
+    flagged as placeholders and are not a finding."""
     groups = leaks.group(report.get("secrets") or [])
 
     def in_source(g):
-        return any(not (filetypes.is_test_path(f) or filetypes.is_doc_path(f)) for f in g["files"])
+        return any(not (filetypes.is_test_path(f) or filetypes.is_doc_path(f) or filetypes.is_sample_path(f)) for f in g["files"])
     source = [g for g in groups if in_source(g)]
     aside = [g for g in groups if not in_source(g)]
     ignore = "Add the fingerprint of any false positive from secrets.json to .betterleaksignore in the repository."
@@ -55,7 +56,7 @@ def secrets_found(report: dict) -> list:
         out.append(_f("critical", f"{len(source)} secret(s) in history", _secret_statement(source),
                       f"Rotate them; deleting the file does not remove them from git. {ignore}"))
     if aside:
-        out.append(_f("warning", f"{len(aside)} secret(s) only in test or documentation files", _secret_statement(aside),
+        out.append(_f("warning", f"{len(aside)} secret(s) only in test, example or documentation files", _secret_statement(aside),
                       f"Confirm they are fixtures or templates, not live keys. {ignore}"))
     return out
 
@@ -93,9 +94,10 @@ def placeholder_identity(report: dict, min_share: float = 0.01) -> list:
 
 
 def _source_ownership(report: dict) -> list:
-    """Ownership rows for source files. Test files are left out of every rule that names a next
-    step: owning the tests is not the knowledge risk. The default tables leave them out too."""
-    return [r for r in report.get("ownership") or [] if not filetypes.is_test_path(r["entity"])]
+    """Ownership rows for source files. Test files and vendored trees are left out of every rule that
+    names a next step: owning the tests is not the knowledge risk, and whoever imported vendor/ did
+    not write it. The default tables leave test files out too."""
+    return [r for r in report.get("ownership") or [] if not (filetypes.is_test_path(r["entity"]) or filetypes.is_vendor_path(r["entity"]))]
 
 
 def bus_factor(report: dict, threshold: float = 0.7, min_lines: int = 200) -> list:
@@ -183,11 +185,21 @@ def tight_coupling(report: dict, min_degree: int = 80, min_revs: int = 5) -> lis
     if not pairs:
         return []
     pairs.sort(key=lambda p: (-p["degree"], -p["average-revs"]))
+    groups, pairs = coupling.clusters(pairs)
+    when = f"together at least {min_degree}% of the time"
     top = "; ".join(f"{p['entity']} + {p['coupled']} ({p['degree']}%)" for p in pairs[:3])
+    if groups:
+        # a directory of files that change as one is a generator or a shared layout, said once
+        named = ", ".join(f"{g['files']} files in {g['dir']}" for g in groups[:2]) + (f" and {len(groups) - 2} more directories" if len(groups) > 2 else "")
+        rest = (f", and {_plural(len(pairs), 'more pair')} {'does' if len(pairs) == 1 else 'do'}: {top}." if pairs
+                else f", {_plural(sum(g['pairs'] for g in groups), 'pair')} in all.")
+        first = groups[0]
+        return [_f("info", "Files that always change together", f"{named} change {when}{rest}",
+                   f"Review {first['dir']} first: {first['files']} files change as one; a generator or a shared layout links them.")]
     count = f"{len(pairs)} pair changes" if len(pairs) == 1 else f"{len(pairs)} pairs change"
     first = pairs[0]
     return [_f("info", "Files that always change together",
-               f"{count} together at least {min_degree}% of the time, e.g. {top}.",
+               f"{count} {when}, e.g. {top}.",
                f"Review {first['entity']} and {first['coupled']} first: a shared layout or a hidden dependency links them.")]
 
 
@@ -363,8 +375,10 @@ def _partial_functions(report: dict) -> str:
 
 
 def brain_methods(report: dict, min_ccn: int = 15, min_lines: int = 100) -> list:
-    """Functions that are both long and complex, in source files. A warning when one sits in a hotspot."""
-    big = [f for f in report.get("functions") or [] if f["ccn"] >= min_ccn and f["nloc"] >= min_lines and not filetypes.is_test_path(f["file"])]
+    """Functions that are both long and complex, in this repository's own source files: test files and
+    vendored code are left out. A warning when one sits in a hotspot."""
+    big = [f for f in report.get("functions") or [] if f["ccn"] >= min_ccn and f["nloc"] >= min_lines
+           and not (filetypes.is_test_path(f["file"]) or filetypes.is_vendor_path(f["file"]))]
     if not big:
         return []
     big.sort(key=lambda f: (-f["ccn"], -f["nloc"], f["file"], f["function"], f["start"]))

{gitmole-0.6.3 → gitmole-0.6.4}/gitmole/render.py

@@ -13,7 +13,7 @@ from rich.panel import Panel
 from rich.table import Table
 from rich.text import Text
 
-from . import filetypes, hotspots, identity, knowledge, leaks, loss, textfmt, trend, watch
+from . import coupling, filetypes, hotspots, identity, knowledge, leaks, loss, textfmt, trend, watch
 
 SEVERITY_STYLE = {"critical": "bold red", "warning": "yellow", "info": "cyan"}
 
@@ -78,8 +78,11 @@ def _more(total: int, limit) -> str:
     return f"and {total - limit} more" if limit is not None and total > limit else None
 
 
-def _hide_tests(rows: list, path_of, full, noun="test file", plural=None) -> tuple:
-    """Drop rows whose path (or any of whose paths) is a test path, unless `full` is True.
+HIDDEN_SUFFIX = "; --full shows them"
+
+
+def _hide_rows(rows: list, path_of, full, pred, noun: str, plural=None) -> tuple:
+    """Drop rows whose path (or any of whose paths) satisfies `pred`, unless `full` is True.
     `path_of(row)` returns a single path or a tuple of paths to check. `noun` names one hidden row
     and `plural` names several, `noun + "s"` by default (a multi-word noun gives its own plural:
     "function in a test file" -> "functions in test files"). Returns (rows, note), `note` being
@@ -90,14 +93,41 @@ def _hide_tests(rows: list, path_of, full, noun="test file", plural=None) -> tup
     for row in rows:
         paths = path_of(row)
         paths = (paths,) if isinstance(paths, str) else paths
-        if any(filetypes.is_test_path(p) for p in paths):
+        if any(pred(p) for p in paths):
             hidden += 1
         else:
             kept.append(row)
-    note = f"{hidden} {noun if hidden == 1 else plural or noun + 's'} hidden; --full shows them" if hidden else None
+    note = f"{hidden} {noun if hidden == 1 else plural or noun + 's'} hidden{HIDDEN_SUFFIX}" if hidden else None
     return kept, note
 
 
+def _hide_tests(rows: list, path_of, full, noun="test file", plural=None) -> tuple:
+    """Test files: they change with every fix, so they are not a signal on their own."""
+    return _hide_rows(rows, path_of, full, filetypes.is_test_path, noun, plural)
+
+
+def _hide_vendor(rows: list, path_of, full, noun="file in vendored code", plural="files in vendored code") -> tuple:
+    """Vendored trees: somebody else's code, not this repository's risk."""
+    return _hide_rows(rows, path_of, full, filetypes.is_vendor_path, noun, plural)
+
+
+def _join_hidden(*notes) -> str:
+    """Several hidden-row notes as one caption phrase: 'A hidden; B hidden; --full shows them'."""
+    parts = [n[:-len(HIDDEN_SUFFIX)] if n.endswith(HIDDEN_SUFFIX) else n for n in notes if n]
+    return "; ".join(parts) + HIDDEN_SUFFIX if parts else None
+
+
+def _hide_deleted(rows: list, report: dict, full) -> tuple:
+    """Drop hotspot rows for files no longer in the tree, unless `full` is True or there is no tree
+    listing to judge by: a deleted file's churn is history. Returns (rows, note) like _hide_tests."""
+    tree = (report.get("size") or {}).get("files") or {}
+    if full is True or not tree:
+        return rows, None
+    kept = [h for h in rows if h["code"] is not None]
+    hidden = len(rows) - len(kept)
+    return kept, (f"{hidden} deleted file{'s' if hidden != 1 else ''} hidden{HIDDEN_SUFFIX}" if hidden else None)
+
+
 def _hide_gone(pairs: list, report: dict, full) -> tuple:
     """Drop coupled pairs where either file is no longer in the tree, unless `full` is True: they
     describe a layout that no longer exists. Returns (pairs, note) like _hide_tests."""
@@ -345,6 +375,8 @@ def hotspots_section(report: dict, full: bool = True, width=None) -> dict:
     fixes = {f["entity"]: f["n-fixes"] for f in report.get("fixes") or []}
     scored = hotspots.ranked(report)
     scored, hidden_note = _hide_tests(scored, lambda h: h["entity"], full)
+    scored, deleted_note = _hide_deleted(scored, report, full)
+    hidden_note = _join_hidden(hidden_note, deleted_note)
     title = "Hotspots (score = revisions × lines of code)" if full is True else "Hotspots"
     limit = _limit("Hotspots", full)
     series = (report.get("trend") or {}).get("files") or {}
@@ -376,9 +408,18 @@ def coupling_section(report: dict, full: bool = True, width=None) -> dict:
     pairs = sorted((p for p in report.get("coupling") or [] if p["average-revs"] >= 5), key=lambda p: (-p["degree"], -p["average-revs"]))
     pairs, hidden_note = _hide_tests(pairs, lambda p: (p["entity"], p["coupled"]), full, noun="test pair")
     pairs, gone_note = _hide_gone(pairs, report, full)
-    hidden_note = "; ".join(n for n in (hidden_note, gone_note) if n) or None
+    groups, cluster_note = [], None
+    if full is not True:
+        # a directory whose files all change together is one row; --full lists every pair
+        groups, pairs = coupling.clusters(pairs)
+        if groups:
+            n_pairs, n_dirs = sum(g["pairs"] for g in groups), len(groups)
+            cluster_note = (f"{n_pairs} pairs in {n_dirs} director{'y' if n_dirs == 1 else 'ies'} shown as "
+                            f"{'one row' if n_dirs == 1 else 'one row each'}{HIDDEN_SUFFIX}")
+    hidden_note = _join_hidden(hidden_note, gone_note, cluster_note)
     limit = _limit("Change coupling", full)
-    rows = [(p["entity"], p["coupled"], f"{p['degree']}%", p["average-revs"]) for p in pairs[:limit]]
+    rows = [(f"{g['dir']} ({g['files']} files)", "each other", f"≥{g['degree']}%", g["average-revs"]) for g in groups]
+    rows += [(p["entity"], p["coupled"], f"{p['degree']}%", p["average-revs"]) for p in pairs[:max(limit - len(groups), 0) if limit else None]]
     columns = [("file", PATH), ("changes with", PATH), ("degree", RIGHT), ("avg revs", RIGHT)]
     if full is not True:
         columns, rows = _keep(columns, rows, ["file", "changes with", "degree"])
@@ -432,6 +473,8 @@ def functions_section(report: dict, full: bool = True, width=None) -> dict:
     measured = report.get("functions") or []
     funcs = sorted((f for f in measured if f["ccn"] >= CCN_FLOOR), key=lambda f: (-f["ccn"], -f["nloc"], f["file"], f["function"], f["start"]))
     funcs, hidden_note = _hide_tests(funcs, lambda f: f["file"], full, noun="function in a test file", plural="functions in test files")
+    funcs, vendor_note = _hide_vendor(funcs, lambda f: f["file"], full, noun="function in vendored code", plural="functions in vendored code")
+    hidden_note = _join_hidden(hidden_note, vendor_note)
     limit = _limit("Complex functions", full)
     rows = [(f["function"], f["file"], f["ccn"], f["nloc"], f["params"]) for f in funcs[:limit]]
     columns = [("function", {"overflow": "fold"}), ("file", PATH), ("ccn", RIGHT), ("lines", RIGHT), ("params", RIGHT)]

{gitmole-0.6.3 → gitmole-0.6.4}/gitmole.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitmole
-Version: 0.6.3
+Version: 0.6.4
 Summary: Offline git repository analysis with a terminal report: hotspots, coupling, ownership, code age, secrets, repo health.
 License: MIT
 Project-URL: Homepage, https://github.com/antvinni/gitmole

{gitmole-0.6.3 → gitmole-0.6.4}/gitmole.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ gitmole/banner.py
 gitmole/blame.py
 gitmole/clean.py
 gitmole/cli.py
+gitmole/coupling.py
 gitmole/filetypes.py
 gitmole/findings.py
 gitmole/functions.py
@@ -34,6 +35,7 @@ tests/test_banner.py
 tests/test_blame.py
 tests/test_clean.py
 tests/test_cli.py
+tests/test_coupling.py
 tests/test_filetypes.py
 tests/test_findings.py
 tests/test_functions.py

gitmole-0.6.4/tests/test_coupling.py

@@ -0,0 +1,52 @@
+import unittest
+
+from gitmole import coupling
+
+
+def pair(a, b, degree=100, revs=10):
+    return {"entity": a, "coupled": b, "degree": degree, "average-revs": revs}
+
+
+def clique(directory, names, degree=100, revs=10):
+    files = [f"{directory}/{n}" if directory else n for n in names]
+    return [pair(a, b, degree, revs) for i, a in enumerate(files) for b in files[i + 1:]]
+
+
+class Clusters(unittest.TestCase):
+    def test_a_directory_of_four_or_more_files_becomes_one_cluster(self):
+        pairs = clique("rich/_unicode_data", ["u10.py", "u11.py", "u12.py", "u13.py"]) + [pair("a.py", "b.py", 90)]
+        groups, rest = coupling.clusters(pairs)
+        self.assertEqual(groups, [{"dir": "rich/_unicode_data/", "files": 4, "pairs": 6, "degree": 100, "average-revs": 10}])
+        self.assertEqual(rest, [pair("a.py", "b.py", 90)])
+
+    def test_the_cluster_degree_is_the_weakest_pair(self):
+        pairs = clique("d", ["a", "b", "c", "e"], degree=100)
+        pairs[2]["degree"] = 83
+        pairs[4]["average-revs"] = 40
+        [g], _ = coupling.clusters(pairs)
+        self.assertEqual(g["degree"], 83)
+        self.assertEqual(g["average-revs"], 15)   # the mean of the pairs' averages, rounded
+
+    def test_three_files_stay_as_pairs(self):
+        pairs = clique("d", ["a", "b", "c"])
+        groups, rest = coupling.clusters(pairs)
+        self.assertEqual(groups, [])
+        self.assertEqual(rest, pairs)
+
+    def test_pairs_across_directories_never_cluster(self):
+        pairs = [pair("x/a", "y/b"), pair("x/c", "y/d"), pair("x/e", "y/f"), pair("x/g", "y/h")]
+        groups, rest = coupling.clusters(pairs)
+        self.assertEqual(groups, [])
+        self.assertEqual(len(rest), 4)
+
+    def test_root_files_cluster_under_their_own_label_and_largest_cluster_first(self):
+        pairs = clique("", ["a", "b", "c", "d"]) + clique("lib", ["p", "q", "r", "s", "t"], degree=90)
+        groups, rest = coupling.clusters(pairs)
+        self.assertEqual([g["dir"] for g in groups], ["lib/", "(root files)"])
+        self.assertEqual(rest, [])
+
+    def test_a_partial_clique_counts_the_files_it_touches(self):
+        pairs = [pair("d/a", "d/b"), pair("d/b", "d/c"), pair("d/c", "d/e")]   # 4 files, 3 pairs, not every pair present
+        [g], rest = coupling.clusters(pairs)
+        self.assertEqual((g["files"], g["pairs"]), (4, 3))
+        self.assertEqual(rest, [])

{gitmole-0.6.3 → gitmole-0.6.4}/tests/test_filetypes.py

@@ -97,6 +97,20 @@ class TestPaths(unittest.TestCase):
         for path in ("app/settings.py", "static/index.html", "docsite/app.js", "mdx/a.py", "config.yaml"):
             self.assertFalse(filetypes.is_doc_path(path), path)
 
+    def test_example_fixture_and_rule_directories(self):
+        for path in ("examples/language/bru.bru", "example/app.py", "samples/x.json", "sample/x.json", "fixtures/keys.pem",
+                     "src/fixture/a.txt", "pkg/testdata/creds.yaml", "demo/x.py", "demos/x.py", "config/generate/rules/slack.go"):
+            self.assertTrue(filetypes.is_sample_path(path), path)
+        for path in ("app/settings.py", "examplesite/app.py", "src/rulesets/a.go", "sampler/x.py", "config/betterleaks.toml"):
+            self.assertFalse(filetypes.is_sample_path(path), path)
+
+    def test_vendored_trees(self):
+        for path in ("vendor/github.com/x/y.go", "web/node_modules/a/index.js", "third_party/z/a.c", "thirdparty/a.c", "_vendor/a.py",
+                     "external/lib/a.cpp"):
+            self.assertTrue(filetypes.is_vendor_path(path), path)
+        for path in ("vendors.py", "src/vendoring/a.py", "node/a.js", "externals.txt", "app/main.go"):
+            self.assertFalse(filetypes.is_vendor_path(path), path)
+
 
 if __name__ == "__main__":
     unittest.main()

{gitmole-0.6.3 → gitmole-0.6.4}/tests/test_findings.py

@@ -47,7 +47,7 @@ class SecretsFound(unittest.TestCase):
         self.assertIn("1 distinct value in 2 places: generic-api-key in app/settings.py (c1, c2)", crit["detail"])
         self.assertIn("Rotate", crit["advice"])
         self.assertIn(".betterleaksignore", crit["advice"])
-        self.assertEqual(warn["title"], "2 secret(s) only in test or documentation files")
+        self.assertEqual(warn["title"], "2 secret(s) only in test, example or documentation files")
         self.assertIn("2 distinct values in 3 places", warn["detail"])
         self.assertIn("tests/data/a.html and 1 other file", warn["detail"])
         self.assertIn(".betterleaksignore", warn["advice"])
@@ -56,11 +56,21 @@ class SecretsFound(unittest.TestCase):
         r = report(secrets=[self.row("h3", "tests/t.py")])
         self.assertEqual([f["severity"] for f in findings.secrets_found(r)], ["warning"])
 
+    def test_a_value_only_in_an_example_fixture_or_rules_directory_is_a_warning(self):
+        r = report(secrets=[self.row("h1", "examples/language/bru.bru", "57d82e9", rule="generic-password"),
+                            self.row("h2", "config/generate/rules/slack.go", "04bdee4", rule="slack-bot-token"),
+                            self.row("h3", "pkg/testdata/creds.yaml", "c3")])
+        f = findings.secrets_found(r)
+        self.assertEqual([x["severity"] for x in f], ["warning"])
+        self.assertEqual(f[0]["title"], "3 secret(s) only in test, example or documentation files")
+        r = report(secrets=[self.row("h1", "examples/app.py", "c1"), self.row("h1", "app/config.py", "c2")])
+        self.assertEqual([x["severity"] for x in findings.secrets_found(r)], ["critical"], "the same value in source is a leak")
+
     def test_a_value_only_in_documentation_is_a_warning_that_says_template(self):
         r = report(secrets=[self.row("h1", "docs/GA4-API-INTEGRATION.md", "e8c0508")])
         f = findings.secrets_found(r)
         self.assertEqual([x["severity"] for x in f], ["warning"])
-        self.assertEqual(f[0]["title"], "1 secret(s) only in test or documentation files")
+        self.assertEqual(f[0]["title"], "1 secret(s) only in test, example or documentation files")
         self.assertIn("fixtures or templates", f[0]["advice"])
         r = report(secrets=[self.row("h1", "docs/GA4-API-INTEGRATION.md", "e8c0508"), self.row("h1", "app/config.py", "c2")])
         self.assertEqual([x["severity"] for x in findings.secrets_found(r)], ["critical"], "the same value in source is a leak")
@@ -135,6 +145,13 @@ class BusFactor(unittest.TestCase):
         self.assertEqual(findings.bus_factor(r)[0]["advice"], "Pair someone with Ann on core/ first; it is 95% theirs since 2025-01-01.",
                          "ownership is windowed while the headline share is not")
 
+    def test_vendored_trees_are_not_named_in_the_advice(self):
+        own = [{"entity": "vendor/github.com/x/a.go", "author": "Ann", "added": 500000, "deleted": 0},
+               {"entity": "core/a.py", "author": "Ann", "added": 900, "deleted": 0},
+               {"entity": "core/b.py", "author": "Bob", "added": 50, "deleted": 0}]
+        f = findings.bus_factor(report(theseus_authors={"Ann": 79, "Bob": 21}, ownership=own))
+        self.assertEqual(f[0]["advice"], "Pair someone with Ann on core/ first; it is 95% theirs.")
+
     def test_nothing_when_spread(self):
         self.assertEqual(findings.bus_factor(report()), [])
 
@@ -234,6 +251,17 @@ class TightCoupling(unittest.TestCase):
         f = findings.tight_coupling(report(coupling=pairs))
         self.assertIn("1 pair changes together", f[0]["detail"])
 
+    def test_a_directory_of_files_that_change_as_one_is_one_cluster(self):
+        files = [f"rich/_unicode_data/unicode{n}.py" for n in ("10", "11", "12", "13")]
+        pairs = [{"entity": a, "coupled": b, "degree": 100, "average-revs": 5} for i, a in enumerate(files) for b in files[i + 1:]]
+        pairs.append({"entity": "rich/a.py", "coupled": "rich/b.py", "degree": 90, "average-revs": 8})
+        f = findings.tight_coupling(report(coupling=pairs))
+        self.assertIn("4 files in rich/_unicode_data/ change together at least 80% of the time, and 1 more pair does: rich/a.py + rich/b.py (90%).", f[0]["detail"])
+        self.assertNotIn("unicode10", f[0]["detail"])
+        self.assertTrue(f[0]["detail"].endswith("Review rich/_unicode_data/ first: 4 files change as one; a generator or a shared layout links them."), f[0]["detail"])
+        f = findings.tight_coupling(report(coupling=pairs[:-1]))
+        self.assertIn("4 files in rich/_unicode_data/ change together at least 80% of the time, 6 pairs in all.", f[0]["detail"])
+
     def test_nothing_when_no_tight_pairs(self):
         self.assertEqual(findings.tight_coupling(report()), [])
 
@@ -338,6 +366,14 @@ class BrainMethods(unittest.TestCase):
         self.assertNotIn("test_all", f[0]["detail"])
         self.assertEqual(findings.brain_methods(report(functions=fns[:1])), [])
 
+    def test_vendored_functions_are_not_brain_methods(self):
+        fns = [{"file": "vendor/github.com/google/jsonschema-go/jsonschema/validate.go", "function": "validate", "ccn": 179, "nloc": 424, "params": 3, "start": 1, "end": 424},
+               {"file": "processor/workers.go", "function": "countLoopGeneric", "ccn": 56, "nloc": 164, "params": 8, "start": 1, "end": 164}]
+        f = findings.brain_methods(report(functions=fns))
+        self.assertEqual(f[0]["advice"], "Split countLoopGeneric in processor/workers.go first, before the next change lands there.")
+        self.assertNotIn("vendor/", f[0]["detail"])
+        self.assertEqual(findings.brain_methods(report(functions=fns[:1])), [])
+
     def test_a_partial_run_says_there_may_be_more(self):
         r = report(functions=self.FUNCS)
         self.assertNotIn("part way", findings.brain_methods(r)[0]["detail"])
@@ -402,6 +438,16 @@ class KnowledgeIslands(unittest.TestCase):
         self.assertEqual(f[0]["advice"], "Pair someone with Bob on core/ first; it is the largest at 300 lines.")
         self.assertNotIn("tests/", f[0]["detail"])
 
+    def test_vendored_trees_are_not_islands(self):
+        own = [{"entity": "vendor/github.com/x/a.go", "author": "Ann", "added": 500000, "deleted": 0},
+               {"entity": "web/node_modules/y/b.js", "author": "Ann", "added": 90000, "deleted": 0},
+               {"entity": "core/a.py", "author": "Bob", "added": 300, "deleted": 0}]
+        f = findings.knowledge_islands(report(ownership=own))
+        self.assertEqual(f[0]["advice"], "Pair someone with Bob on core/ first; it is the largest at 300 lines.")
+        self.assertNotIn("vendor/", f[0]["detail"])
+        self.assertNotIn("web/", f[0]["detail"])
+        self.assertIn("100% of all lines added", f[0]["detail"], "vendored lines are not in the denominator either")
+
     def test_nothing_when_shared(self):
         self.assertEqual(findings.knowledge_islands(report(ownership=self.OWN[2:])), [])
         self.assertEqual(findings.knowledge_islands(report()), [])

{gitmole-0.6.3 → gitmole-0.6.4}/tests/test_render.py

@@ -244,6 +244,7 @@ class Report(unittest.TestCase):
         self.assertEqual(caption(r, True), "trend sampled for the top 10 hotspots")
         self.assertIsNone(caption(r, False), "the tight report keeps its captions short")
         r["revisions"] = [{"entity": f"f{i}.py", "n-revs": 100 - i} for i in range(60)]
+        r["size"]["files"].update({f"f{i}.py": {"code": 10, "complexity": 0} for i in range(60)})   # in the tree, so not hidden as deleted
         self.assertEqual(caption(r, "markdown"), "and 10 more; trend sampled for the top 10 hotspots")
 
     def test_watch_list_caption_reports_the_backtest_or_why_not(self):
@@ -289,10 +290,10 @@ class Report(unittest.TestCase):
     def test_default_coupling_hides_test_pairs_and_says_so(self):
         r = sample_report()
         r["coupling"].append({"entity": "static/tax.html", "coupled": "tests/test_tax.py", "degree": 100, "average-revs": 11})
-        text = rendered(r, [])
+        text = rendered(r, [], width=200)
         coupling = text[text.index("Change coupling"):]
         self.assertNotIn("tests/test_tax.py", coupling)
-        self.assertIn("1 test pair hidden; --full shows them", coupling)
+        self.assertIn("1 test pair hidden; 1 historical pair hidden; --full shows them", coupling, "one suffix for every hidden count")
         full_text = rendered(r, [], full=True)
         self.assertIn("tests/test_tax.py", full_text[full_text.index("Change coupling"):])
 
@@ -306,6 +307,16 @@ class Report(unittest.TestCase):
         full_text = rendered(r, [], full=True)
         self.assertIn("tests/test_a.py", full_text[full_text.index("Complex functions"):])
 
+    def test_default_complex_functions_hide_vendored_code_and_say_so(self):
+        r = sample_report()
+        r["functions"].append({"file": "vendor/github.com/x/y.go", "function": "validate", "ccn": 179, "nloc": 424, "params": 3, "start": 1, "end": 424})
+        r["functions"].append({"file": "tests/test_a.py", "function": "test_thing", "ccn": 40, "nloc": 50, "params": 0, "start": 1, "end": 50})
+        fn = _section_text(rendered(r, [], width=200), "Complex functions")
+        self.assertNotIn("vendor/", fn)
+        self.assertIn("1 function in a test file hidden; 1 function in vendored code hidden; --full shows them", fn)
+        full = _section_text(rendered(r, [], width=200, full=True), "Complex functions")
+        self.assertIn("vendor/github.com/x/y.go", full)
+
     def test_hotspots_with_only_test_files_say_what_was_hidden(self):
         r = sample_report()
         r["revisions"] = [{"entity": "tests/test_a.py", "n-revs": 200}]
@@ -325,6 +336,41 @@ class Report(unittest.TestCase):
         self.assertIn("static/tax.html", full)
         self.assertNotIn("hidden", full)
 
+    def test_default_hotspots_hide_deleted_files_and_say_so(self):
+        r = sample_report()   # the tree holds static/index.html and static/apps-metadata.json only
+        r["revisions"].append({"entity": "src/sizes/old.go", "n-revs": 40})
+        hot = _section_text(rendered(r, [], width=200), "◆ Hotspots")
+        self.assertNotIn("src/sizes/old.go", hot)
+        self.assertIn("1 deleted file hidden; --full shows them", hot)
+        full = _section_text(rendered(r, [], width=200, full=True), "◆ Hotspots")
+        self.assertIn("src/sizes/old.go", full)
+        self.assertNotIn("hidden", full)
+
+    def test_hotspots_without_a_tree_listing_hide_nothing(self):
+        r = sample_report()
+        r["size"]["files"] = {}
+        hot = _section_text(rendered(r, [], width=200), "◆ Hotspots")
+        self.assertIn("static/index.html", hot)
+        self.assertNotIn("deleted", hot)
+
+    def test_default_coupling_collapses_a_directory_that_changes_as_one(self):
+        r = sample_report()
+        files = [f"rich/_unicode_data/unicode{n}.py" for n in ("10", "11", "12", "13")]
+        for f in files:
+            r["size"]["files"][f] = {"code": 600, "complexity": 0}
+        r["coupling"] = [{"entity": a, "coupled": b, "degree": 100, "average-revs": 5} for i, a in enumerate(files) for b in files[i + 1:]]
+        r["coupling"].append({"entity": "static/index.html", "coupled": "static/apps-metadata.json", "degree": 90, "average-revs": 11})
+        coupling = _section_text(rendered(r, [], width=200), "Change coupling")
+        self.assertIn("rich/_unicode_data/ (4 files)", coupling)
+        self.assertIn("each other", coupling)
+        self.assertIn("≥100%", coupling)
+        self.assertNotIn("unicode10", coupling)
+        self.assertIn("static/index.html", coupling)
+        self.assertIn("6 pairs in 1 directory shown as one row; --full shows them", coupling)
+        full = _section_text(rendered(r, [], width=200, full=True), "Change coupling")
+        self.assertIn("unicode10", full)
+        self.assertNotIn("each other", full)
+
     def test_coupling_with_only_test_pairs_says_what_was_hidden(self):
         r = sample_report()
         r["coupling"] = [{"entity": "static/tax.html", "coupled": "tests/test_tax.py", "degree": 100, "average-revs": 11}]
@@ -866,6 +912,7 @@ class Markdown(unittest.TestCase):
         r = sample_report()
         r["coupling"] = []
         r["revisions"] = [{"entity": "weird|name.py", "n-revs": 3}]
+        r["size"]["files"]["weird|name.py"] = {"code": 5, "complexity": 0}   # in the tree, so not hidden as deleted
         md = render.markdown(r, [])
         self.assertIn("weird\\|name.py", md)
         self.assertIn("_no pairs with 5+ shared revisions_", md)